three.core.js 1.4 MB

1234567891011121314151617181920212223242526272829303132333435363738394041424344454647484950515253545556575859606162636465666768697071727374757677787980818283848586878889909192939495969798991001011021031041051061071081091101111121131141151161171181191201211221231241251261271281291301311321331341351361371381391401411421431441451461471481491501511521531541551561571581591601611621631641651661671681691701711721731741751761771781791801811821831841851861871881891901911921931941951961971981992002012022032042052062072082092102112122132142152162172182192202212222232242252262272282292302312322332342352362372382392402412422432442452462472482492502512522532542552562572582592602612622632642652662672682692702712722732742752762772782792802812822832842852862872882892902912922932942952962972982993003013023033043053063073083093103113123133143153163173183193203213223233243253263273283293303313323333343353363373383393403413423433443453463473483493503513523533543553563573583593603613623633643653663673683693703713723733743753763773783793803813823833843853863873883893903913923933943953963973983994004014024034044054064074084094104114124134144154164174184194204214224234244254264274284294304314324334344354364374384394404414424434444454464474484494504514524534544554564574584594604614624634644654664674684694704714724734744754764774784794804814824834844854864874884894904914924934944954964974984995005015025035045055065075085095105115125135145155165175185195205215225235245255265275285295305315325335345355365375385395405415425435445455465475485495505515525535545555565575585595605615625635645655665675685695705715725735745755765775785795805815825835845855865875885895905915925935945955965975985996006016026036046056066076086096106116126136146156166176186196206216226236246256266276286296306316326336346356366376386396406416426436446456466476486496506516526536546556566576586596606616626636646656666676686696706716726736746756766776786796806816826836846856866876886896906916926936946956966976986997007017027037047057067077087097107117127137147157167177187197207217227237247257267277287297307317327337347357367377387397407417427437447457467477487497507517527537547557567577587597607617627637647657667677687697707717727737747757767777787797807817827837847857867877887897907917927937947957967977987998008018028038048058068078088098108118128138148158168178188198208218228238248258268278288298308318328338348358368378388398408418428438448458468478488498508518528538548558568578588598608618628638648658668678688698708718728738748758768778788798808818828838848858868878888898908918928938948958968978988999009019029039049059069079089099109119129139149159169179189199209219229239249259269279289299309319329339349359369379389399409419429439449459469479489499509519529539549559569579589599609619629639649659669679689699709719729739749759769779789799809819829839849859869879889899909919929939949959969979989991000100110021003100410051006100710081009101010111012101310141015101610171018101910201021102210231024102510261027102810291030103110321033103410351036103710381039104010411042104310441045104610471048104910501051105210531054105510561057105810591060106110621063106410651066106710681069107010711072107310741075107610771078107910801081108210831084108510861087108810891090109110921093109410951096109710981099110011011102110311041105110611071108110911101111111211131114111511161117111811191120112111221123112411251126112711281129113011311132113311341135113611371138113911401141114211431144114511461147114811491150115111521153115411551156115711581159116011611162116311641165116611671168116911701171117211731174117511761177117811791180118111821183118411851186118711881189119011911192119311941195119611971198119912001201120212031204120512061207120812091210121112121213121412151216121712181219122012211222122312241225122612271228122912301231123212331234123512361237123812391240124112421243124412451246124712481249125012511252125312541255125612571258125912601261126212631264126512661267126812691270127112721273127412751276127712781279128012811282128312841285128612871288128912901291129212931294129512961297129812991300130113021303130413051306130713081309131013111312131313141315131613171318131913201321132213231324132513261327132813291330133113321333133413351336133713381339134013411342134313441345134613471348134913501351135213531354135513561357135813591360136113621363136413651366136713681369137013711372137313741375137613771378137913801381138213831384138513861387138813891390139113921393139413951396139713981399140014011402140314041405140614071408140914101411141214131414141514161417141814191420142114221423142414251426142714281429143014311432143314341435143614371438143914401441144214431444144514461447144814491450145114521453145414551456145714581459146014611462146314641465146614671468146914701471147214731474147514761477147814791480148114821483148414851486148714881489149014911492149314941495149614971498149915001501150215031504150515061507150815091510151115121513151415151516151715181519152015211522152315241525152615271528152915301531153215331534153515361537153815391540154115421543154415451546154715481549155015511552155315541555155615571558155915601561156215631564156515661567156815691570157115721573157415751576157715781579158015811582158315841585158615871588158915901591159215931594159515961597159815991600160116021603160416051606160716081609161016111612161316141615161616171618161916201621162216231624162516261627162816291630163116321633163416351636163716381639164016411642164316441645164616471648164916501651165216531654165516561657165816591660166116621663166416651666166716681669167016711672167316741675167616771678167916801681168216831684168516861687168816891690169116921693169416951696169716981699170017011702170317041705170617071708170917101711171217131714171517161717171817191720172117221723172417251726172717281729173017311732173317341735173617371738173917401741174217431744174517461747174817491750175117521753175417551756175717581759176017611762176317641765176617671768176917701771177217731774177517761777177817791780178117821783178417851786178717881789179017911792179317941795179617971798179918001801180218031804180518061807180818091810181118121813181418151816181718181819182018211822182318241825182618271828182918301831183218331834183518361837183818391840184118421843184418451846184718481849185018511852185318541855185618571858185918601861186218631864186518661867186818691870187118721873187418751876187718781879188018811882188318841885188618871888188918901891189218931894189518961897189818991900190119021903190419051906190719081909191019111912191319141915191619171918191919201921192219231924192519261927192819291930193119321933193419351936193719381939194019411942194319441945194619471948194919501951195219531954195519561957195819591960196119621963196419651966196719681969197019711972197319741975197619771978197919801981198219831984198519861987198819891990199119921993199419951996199719981999200020012002200320042005200620072008200920102011201220132014201520162017201820192020202120222023202420252026202720282029203020312032203320342035203620372038203920402041204220432044204520462047204820492050205120522053205420552056205720582059206020612062206320642065206620672068206920702071207220732074207520762077207820792080208120822083208420852086208720882089209020912092209320942095209620972098209921002101210221032104210521062107210821092110211121122113211421152116211721182119212021212122212321242125212621272128212921302131213221332134213521362137213821392140214121422143214421452146214721482149215021512152215321542155215621572158215921602161216221632164216521662167216821692170217121722173217421752176217721782179218021812182218321842185218621872188218921902191219221932194219521962197219821992200220122022203220422052206220722082209221022112212221322142215221622172218221922202221222222232224222522262227222822292230223122322233223422352236223722382239224022412242224322442245224622472248224922502251225222532254225522562257225822592260226122622263226422652266226722682269227022712272227322742275227622772278227922802281228222832284228522862287228822892290229122922293229422952296229722982299230023012302230323042305230623072308230923102311231223132314231523162317231823192320232123222323232423252326232723282329233023312332233323342335233623372338233923402341234223432344234523462347234823492350235123522353235423552356235723582359236023612362236323642365236623672368236923702371237223732374237523762377237823792380238123822383238423852386238723882389239023912392239323942395239623972398239924002401240224032404240524062407240824092410241124122413241424152416241724182419242024212422242324242425242624272428242924302431243224332434243524362437243824392440244124422443244424452446244724482449245024512452245324542455245624572458245924602461246224632464246524662467246824692470247124722473247424752476247724782479248024812482248324842485248624872488248924902491249224932494249524962497249824992500250125022503250425052506250725082509251025112512251325142515251625172518251925202521252225232524252525262527252825292530253125322533253425352536253725382539254025412542254325442545254625472548254925502551255225532554255525562557255825592560256125622563256425652566256725682569257025712572257325742575257625772578257925802581258225832584258525862587258825892590259125922593259425952596259725982599260026012602260326042605260626072608260926102611261226132614261526162617261826192620262126222623262426252626262726282629263026312632263326342635263626372638263926402641264226432644264526462647264826492650265126522653265426552656265726582659266026612662266326642665266626672668266926702671267226732674267526762677267826792680268126822683268426852686268726882689269026912692269326942695269626972698269927002701270227032704270527062707270827092710271127122713271427152716271727182719272027212722272327242725272627272728272927302731273227332734273527362737273827392740274127422743274427452746274727482749275027512752275327542755275627572758275927602761276227632764276527662767276827692770277127722773277427752776277727782779278027812782278327842785278627872788278927902791279227932794279527962797279827992800280128022803280428052806280728082809281028112812281328142815281628172818281928202821282228232824282528262827282828292830283128322833283428352836283728382839284028412842284328442845284628472848284928502851285228532854285528562857285828592860286128622863286428652866286728682869287028712872287328742875287628772878287928802881288228832884288528862887288828892890289128922893289428952896289728982899290029012902290329042905290629072908290929102911291229132914291529162917291829192920292129222923292429252926292729282929293029312932293329342935293629372938293929402941294229432944294529462947294829492950295129522953295429552956295729582959296029612962296329642965296629672968296929702971297229732974297529762977297829792980298129822983298429852986298729882989299029912992299329942995299629972998299930003001300230033004300530063007300830093010301130123013301430153016301730183019302030213022302330243025302630273028302930303031303230333034303530363037303830393040304130423043304430453046304730483049305030513052305330543055305630573058305930603061306230633064306530663067306830693070307130723073307430753076307730783079308030813082308330843085308630873088308930903091309230933094309530963097309830993100310131023103310431053106310731083109311031113112311331143115311631173118311931203121312231233124312531263127312831293130313131323133313431353136313731383139314031413142314331443145314631473148314931503151315231533154315531563157315831593160316131623163316431653166316731683169317031713172317331743175317631773178317931803181318231833184318531863187318831893190319131923193319431953196319731983199320032013202320332043205320632073208320932103211321232133214321532163217321832193220322132223223322432253226322732283229323032313232323332343235323632373238323932403241324232433244324532463247324832493250325132523253325432553256325732583259326032613262326332643265326632673268326932703271327232733274327532763277327832793280328132823283328432853286328732883289329032913292329332943295329632973298329933003301330233033304330533063307330833093310331133123313331433153316331733183319332033213322332333243325332633273328332933303331333233333334333533363337333833393340334133423343334433453346334733483349335033513352335333543355335633573358335933603361336233633364336533663367336833693370337133723373337433753376337733783379338033813382338333843385338633873388338933903391339233933394339533963397339833993400340134023403340434053406340734083409341034113412341334143415341634173418341934203421342234233424342534263427342834293430343134323433343434353436343734383439344034413442344334443445344634473448344934503451345234533454345534563457345834593460346134623463346434653466346734683469347034713472347334743475347634773478347934803481348234833484348534863487348834893490349134923493349434953496349734983499350035013502350335043505350635073508350935103511351235133514351535163517351835193520352135223523352435253526352735283529353035313532353335343535353635373538353935403541354235433544354535463547354835493550355135523553355435553556355735583559356035613562356335643565356635673568356935703571357235733574357535763577357835793580358135823583358435853586358735883589359035913592359335943595359635973598359936003601360236033604360536063607360836093610361136123613361436153616361736183619362036213622362336243625362636273628362936303631363236333634363536363637363836393640364136423643364436453646364736483649365036513652365336543655365636573658365936603661366236633664366536663667366836693670367136723673367436753676367736783679368036813682368336843685368636873688368936903691369236933694369536963697369836993700370137023703370437053706370737083709371037113712371337143715371637173718371937203721372237233724372537263727372837293730373137323733373437353736373737383739374037413742374337443745374637473748374937503751375237533754375537563757375837593760376137623763376437653766376737683769377037713772377337743775377637773778377937803781378237833784378537863787378837893790379137923793379437953796379737983799380038013802380338043805380638073808380938103811381238133814381538163817381838193820382138223823382438253826382738283829383038313832383338343835383638373838383938403841384238433844384538463847384838493850385138523853385438553856385738583859386038613862386338643865386638673868386938703871387238733874387538763877387838793880388138823883388438853886388738883889389038913892389338943895389638973898389939003901390239033904390539063907390839093910391139123913391439153916391739183919392039213922392339243925392639273928392939303931393239333934393539363937393839393940394139423943394439453946394739483949395039513952395339543955395639573958395939603961396239633964396539663967396839693970397139723973397439753976397739783979398039813982398339843985398639873988398939903991399239933994399539963997399839994000400140024003400440054006400740084009401040114012401340144015401640174018401940204021402240234024402540264027402840294030403140324033403440354036403740384039404040414042404340444045404640474048404940504051405240534054405540564057405840594060406140624063406440654066406740684069407040714072407340744075407640774078407940804081408240834084408540864087408840894090409140924093409440954096409740984099410041014102410341044105410641074108410941104111411241134114411541164117411841194120412141224123412441254126412741284129413041314132413341344135413641374138413941404141414241434144414541464147414841494150415141524153415441554156415741584159416041614162416341644165416641674168416941704171417241734174417541764177417841794180418141824183418441854186418741884189419041914192419341944195419641974198419942004201420242034204420542064207420842094210421142124213421442154216421742184219422042214222422342244225422642274228422942304231423242334234423542364237423842394240424142424243424442454246424742484249425042514252425342544255425642574258425942604261426242634264426542664267426842694270427142724273427442754276427742784279428042814282428342844285428642874288428942904291429242934294429542964297429842994300430143024303430443054306430743084309431043114312431343144315431643174318431943204321432243234324432543264327432843294330433143324333433443354336433743384339434043414342434343444345434643474348434943504351435243534354435543564357435843594360436143624363436443654366436743684369437043714372437343744375437643774378437943804381438243834384438543864387438843894390439143924393439443954396439743984399440044014402440344044405440644074408440944104411441244134414441544164417441844194420442144224423442444254426442744284429443044314432443344344435443644374438443944404441444244434444444544464447444844494450445144524453445444554456445744584459446044614462446344644465446644674468446944704471447244734474447544764477447844794480448144824483448444854486448744884489449044914492449344944495449644974498449945004501450245034504450545064507450845094510451145124513451445154516451745184519452045214522452345244525452645274528452945304531453245334534453545364537453845394540454145424543454445454546454745484549455045514552455345544555455645574558455945604561456245634564456545664567456845694570457145724573457445754576457745784579458045814582458345844585458645874588458945904591459245934594459545964597459845994600460146024603460446054606460746084609461046114612461346144615461646174618461946204621462246234624462546264627462846294630463146324633463446354636463746384639464046414642464346444645464646474648464946504651465246534654465546564657465846594660466146624663466446654666466746684669467046714672467346744675467646774678467946804681468246834684468546864687468846894690469146924693469446954696469746984699470047014702470347044705470647074708470947104711471247134714471547164717471847194720472147224723472447254726472747284729473047314732473347344735473647374738473947404741474247434744474547464747474847494750475147524753475447554756475747584759476047614762476347644765476647674768476947704771477247734774477547764777477847794780478147824783478447854786478747884789479047914792479347944795479647974798479948004801480248034804480548064807480848094810481148124813481448154816481748184819482048214822482348244825482648274828482948304831483248334834483548364837483848394840484148424843484448454846484748484849485048514852485348544855485648574858485948604861486248634864486548664867486848694870487148724873487448754876487748784879488048814882488348844885488648874888488948904891489248934894489548964897489848994900490149024903490449054906490749084909491049114912491349144915491649174918491949204921492249234924492549264927492849294930493149324933493449354936493749384939494049414942494349444945494649474948494949504951495249534954495549564957495849594960496149624963496449654966496749684969497049714972497349744975497649774978497949804981498249834984498549864987498849894990499149924993499449954996499749984999500050015002500350045005500650075008500950105011501250135014501550165017501850195020502150225023502450255026502750285029503050315032503350345035503650375038503950405041504250435044504550465047504850495050505150525053505450555056505750585059506050615062506350645065506650675068506950705071507250735074507550765077507850795080508150825083508450855086508750885089509050915092509350945095509650975098509951005101510251035104510551065107510851095110511151125113511451155116511751185119512051215122512351245125512651275128512951305131513251335134513551365137513851395140514151425143514451455146514751485149515051515152515351545155515651575158515951605161516251635164516551665167516851695170517151725173517451755176517751785179518051815182518351845185518651875188518951905191519251935194519551965197519851995200520152025203520452055206520752085209521052115212521352145215521652175218521952205221522252235224522552265227522852295230523152325233523452355236523752385239524052415242524352445245524652475248524952505251525252535254525552565257525852595260526152625263526452655266526752685269527052715272527352745275527652775278527952805281528252835284528552865287528852895290529152925293529452955296529752985299530053015302530353045305530653075308530953105311531253135314531553165317531853195320532153225323532453255326532753285329533053315332533353345335533653375338533953405341534253435344534553465347534853495350535153525353535453555356535753585359536053615362536353645365536653675368536953705371537253735374537553765377537853795380538153825383538453855386538753885389539053915392539353945395539653975398539954005401540254035404540554065407540854095410541154125413541454155416541754185419542054215422542354245425542654275428542954305431543254335434543554365437543854395440544154425443544454455446544754485449545054515452545354545455545654575458545954605461546254635464546554665467546854695470547154725473547454755476547754785479548054815482548354845485548654875488548954905491549254935494549554965497549854995500550155025503550455055506550755085509551055115512551355145515551655175518551955205521552255235524552555265527552855295530553155325533553455355536553755385539554055415542554355445545554655475548554955505551555255535554555555565557555855595560556155625563556455655566556755685569557055715572557355745575557655775578557955805581558255835584558555865587558855895590559155925593559455955596559755985599560056015602560356045605560656075608560956105611561256135614561556165617561856195620562156225623562456255626562756285629563056315632563356345635563656375638563956405641564256435644564556465647564856495650565156525653565456555656565756585659566056615662566356645665566656675668566956705671567256735674567556765677567856795680568156825683568456855686568756885689569056915692569356945695569656975698569957005701570257035704570557065707570857095710571157125713571457155716571757185719572057215722572357245725572657275728572957305731573257335734573557365737573857395740574157425743574457455746574757485749575057515752575357545755575657575758575957605761576257635764576557665767576857695770577157725773577457755776577757785779578057815782578357845785578657875788578957905791579257935794579557965797579857995800580158025803580458055806580758085809581058115812581358145815581658175818581958205821582258235824582558265827582858295830583158325833583458355836583758385839584058415842584358445845584658475848584958505851585258535854585558565857585858595860586158625863586458655866586758685869587058715872587358745875587658775878587958805881588258835884588558865887588858895890589158925893589458955896589758985899590059015902590359045905590659075908590959105911591259135914591559165917591859195920592159225923592459255926592759285929593059315932593359345935593659375938593959405941594259435944594559465947594859495950595159525953595459555956595759585959596059615962596359645965596659675968596959705971597259735974597559765977597859795980598159825983598459855986598759885989599059915992599359945995599659975998599960006001600260036004600560066007600860096010601160126013601460156016601760186019602060216022602360246025602660276028602960306031603260336034603560366037603860396040604160426043604460456046604760486049605060516052605360546055605660576058605960606061606260636064606560666067606860696070607160726073607460756076607760786079608060816082608360846085608660876088608960906091609260936094609560966097609860996100610161026103610461056106610761086109611061116112611361146115611661176118611961206121612261236124612561266127612861296130613161326133613461356136613761386139614061416142614361446145614661476148614961506151615261536154615561566157615861596160616161626163616461656166616761686169617061716172617361746175617661776178617961806181618261836184618561866187618861896190619161926193619461956196619761986199620062016202620362046205620662076208620962106211621262136214621562166217621862196220622162226223622462256226622762286229623062316232623362346235623662376238623962406241624262436244624562466247624862496250625162526253625462556256625762586259626062616262626362646265626662676268626962706271627262736274627562766277627862796280628162826283628462856286628762886289629062916292629362946295629662976298629963006301630263036304630563066307630863096310631163126313631463156316631763186319632063216322632363246325632663276328632963306331633263336334633563366337633863396340634163426343634463456346634763486349635063516352635363546355635663576358635963606361636263636364636563666367636863696370637163726373637463756376637763786379638063816382638363846385638663876388638963906391639263936394639563966397639863996400640164026403640464056406640764086409641064116412641364146415641664176418641964206421642264236424642564266427642864296430643164326433643464356436643764386439644064416442644364446445644664476448644964506451645264536454645564566457645864596460646164626463646464656466646764686469647064716472647364746475647664776478647964806481648264836484648564866487648864896490649164926493649464956496649764986499650065016502650365046505650665076508650965106511651265136514651565166517651865196520652165226523652465256526652765286529653065316532653365346535653665376538653965406541654265436544654565466547654865496550655165526553655465556556655765586559656065616562656365646565656665676568656965706571657265736574657565766577657865796580658165826583658465856586658765886589659065916592659365946595659665976598659966006601660266036604660566066607660866096610661166126613661466156616661766186619662066216622662366246625662666276628662966306631663266336634663566366637663866396640664166426643664466456646664766486649665066516652665366546655665666576658665966606661666266636664666566666667666866696670667166726673667466756676667766786679668066816682668366846685668666876688668966906691669266936694669566966697669866996700670167026703670467056706670767086709671067116712671367146715671667176718671967206721672267236724672567266727672867296730673167326733673467356736673767386739674067416742674367446745674667476748674967506751675267536754675567566757675867596760676167626763676467656766676767686769677067716772677367746775677667776778677967806781678267836784678567866787678867896790679167926793679467956796679767986799680068016802680368046805680668076808680968106811681268136814681568166817681868196820682168226823682468256826682768286829683068316832683368346835683668376838683968406841684268436844684568466847684868496850685168526853685468556856685768586859686068616862686368646865686668676868686968706871687268736874687568766877687868796880688168826883688468856886688768886889689068916892689368946895689668976898689969006901690269036904690569066907690869096910691169126913691469156916691769186919692069216922692369246925692669276928692969306931693269336934693569366937693869396940694169426943694469456946694769486949695069516952695369546955695669576958695969606961696269636964696569666967696869696970697169726973697469756976697769786979698069816982698369846985698669876988698969906991699269936994699569966997699869997000700170027003700470057006700770087009701070117012701370147015701670177018701970207021702270237024702570267027702870297030703170327033703470357036703770387039704070417042704370447045704670477048704970507051705270537054705570567057705870597060706170627063706470657066706770687069707070717072707370747075707670777078707970807081708270837084708570867087708870897090709170927093709470957096709770987099710071017102710371047105710671077108710971107111711271137114711571167117711871197120712171227123712471257126712771287129713071317132713371347135713671377138713971407141714271437144714571467147714871497150715171527153715471557156715771587159716071617162716371647165716671677168716971707171717271737174717571767177717871797180718171827183718471857186718771887189719071917192719371947195719671977198719972007201720272037204720572067207720872097210721172127213721472157216721772187219722072217222722372247225722672277228722972307231723272337234723572367237723872397240724172427243724472457246724772487249725072517252725372547255725672577258725972607261726272637264726572667267726872697270727172727273727472757276727772787279728072817282728372847285728672877288728972907291729272937294729572967297729872997300730173027303730473057306730773087309731073117312731373147315731673177318731973207321732273237324732573267327732873297330733173327333733473357336733773387339734073417342734373447345734673477348734973507351735273537354735573567357735873597360736173627363736473657366736773687369737073717372737373747375737673777378737973807381738273837384738573867387738873897390739173927393739473957396739773987399740074017402740374047405740674077408740974107411741274137414741574167417741874197420742174227423742474257426742774287429743074317432743374347435743674377438743974407441744274437444744574467447744874497450745174527453745474557456745774587459746074617462746374647465746674677468746974707471747274737474747574767477747874797480748174827483748474857486748774887489749074917492749374947495749674977498749975007501750275037504750575067507750875097510751175127513751475157516751775187519752075217522752375247525752675277528752975307531753275337534753575367537753875397540754175427543754475457546754775487549755075517552755375547555755675577558755975607561756275637564756575667567756875697570757175727573757475757576757775787579758075817582758375847585758675877588758975907591759275937594759575967597759875997600760176027603760476057606760776087609761076117612761376147615761676177618761976207621762276237624762576267627762876297630763176327633763476357636763776387639764076417642764376447645764676477648764976507651765276537654765576567657765876597660766176627663766476657666766776687669767076717672767376747675767676777678767976807681768276837684768576867687768876897690769176927693769476957696769776987699770077017702770377047705770677077708770977107711771277137714771577167717771877197720772177227723772477257726772777287729773077317732773377347735773677377738773977407741774277437744774577467747774877497750775177527753775477557756775777587759776077617762776377647765776677677768776977707771777277737774777577767777777877797780778177827783778477857786778777887789779077917792779377947795779677977798779978007801780278037804780578067807780878097810781178127813781478157816781778187819782078217822782378247825782678277828782978307831783278337834783578367837783878397840784178427843784478457846784778487849785078517852785378547855785678577858785978607861786278637864786578667867786878697870787178727873787478757876787778787879788078817882788378847885788678877888788978907891789278937894789578967897789878997900790179027903790479057906790779087909791079117912791379147915791679177918791979207921792279237924792579267927792879297930793179327933793479357936793779387939794079417942794379447945794679477948794979507951795279537954795579567957795879597960796179627963796479657966796779687969797079717972797379747975797679777978797979807981798279837984798579867987798879897990799179927993799479957996799779987999800080018002800380048005800680078008800980108011801280138014801580168017801880198020802180228023802480258026802780288029803080318032803380348035803680378038803980408041804280438044804580468047804880498050805180528053805480558056805780588059806080618062806380648065806680678068806980708071807280738074807580768077807880798080808180828083808480858086808780888089809080918092809380948095809680978098809981008101810281038104810581068107810881098110811181128113811481158116811781188119812081218122812381248125812681278128812981308131813281338134813581368137813881398140814181428143814481458146814781488149815081518152815381548155815681578158815981608161816281638164816581668167816881698170817181728173817481758176817781788179818081818182818381848185818681878188818981908191819281938194819581968197819881998200820182028203820482058206820782088209821082118212821382148215821682178218821982208221822282238224822582268227822882298230823182328233823482358236823782388239824082418242824382448245824682478248824982508251825282538254825582568257825882598260826182628263826482658266826782688269827082718272827382748275827682778278827982808281828282838284828582868287828882898290829182928293829482958296829782988299830083018302830383048305830683078308830983108311831283138314831583168317831883198320832183228323832483258326832783288329833083318332833383348335833683378338833983408341834283438344834583468347834883498350835183528353835483558356835783588359836083618362836383648365836683678368836983708371837283738374837583768377837883798380838183828383838483858386838783888389839083918392839383948395839683978398839984008401840284038404840584068407840884098410841184128413841484158416841784188419842084218422842384248425842684278428842984308431843284338434843584368437843884398440844184428443844484458446844784488449845084518452845384548455845684578458845984608461846284638464846584668467846884698470847184728473847484758476847784788479848084818482848384848485848684878488848984908491849284938494849584968497849884998500850185028503850485058506850785088509851085118512851385148515851685178518851985208521852285238524852585268527852885298530853185328533853485358536853785388539854085418542854385448545854685478548854985508551855285538554855585568557855885598560856185628563856485658566856785688569857085718572857385748575857685778578857985808581858285838584858585868587858885898590859185928593859485958596859785988599860086018602860386048605860686078608860986108611861286138614861586168617861886198620862186228623862486258626862786288629863086318632863386348635863686378638863986408641864286438644864586468647864886498650865186528653865486558656865786588659866086618662866386648665866686678668866986708671867286738674867586768677867886798680868186828683868486858686868786888689869086918692869386948695869686978698869987008701870287038704870587068707870887098710871187128713871487158716871787188719872087218722872387248725872687278728872987308731873287338734873587368737873887398740874187428743874487458746874787488749875087518752875387548755875687578758875987608761876287638764876587668767876887698770877187728773877487758776877787788779878087818782878387848785878687878788878987908791879287938794879587968797879887998800880188028803880488058806880788088809881088118812881388148815881688178818881988208821882288238824882588268827882888298830883188328833883488358836883788388839884088418842884388448845884688478848884988508851885288538854885588568857885888598860886188628863886488658866886788688869887088718872887388748875887688778878887988808881888288838884888588868887888888898890889188928893889488958896889788988899890089018902890389048905890689078908890989108911891289138914891589168917891889198920892189228923892489258926892789288929893089318932893389348935893689378938893989408941894289438944894589468947894889498950895189528953895489558956895789588959896089618962896389648965896689678968896989708971897289738974897589768977897889798980898189828983898489858986898789888989899089918992899389948995899689978998899990009001900290039004900590069007900890099010901190129013901490159016901790189019902090219022902390249025902690279028902990309031903290339034903590369037903890399040904190429043904490459046904790489049905090519052905390549055905690579058905990609061906290639064906590669067906890699070907190729073907490759076907790789079908090819082908390849085908690879088908990909091909290939094909590969097909890999100910191029103910491059106910791089109911091119112911391149115911691179118911991209121912291239124912591269127912891299130913191329133913491359136913791389139914091419142914391449145914691479148914991509151915291539154915591569157915891599160916191629163916491659166916791689169917091719172917391749175917691779178917991809181918291839184918591869187918891899190919191929193919491959196919791989199920092019202920392049205920692079208920992109211921292139214921592169217921892199220922192229223922492259226922792289229923092319232923392349235923692379238923992409241924292439244924592469247924892499250925192529253925492559256925792589259926092619262926392649265926692679268926992709271927292739274927592769277927892799280928192829283928492859286928792889289929092919292929392949295929692979298929993009301930293039304930593069307930893099310931193129313931493159316931793189319932093219322932393249325932693279328932993309331933293339334933593369337933893399340934193429343934493459346934793489349935093519352935393549355935693579358935993609361936293639364936593669367936893699370937193729373937493759376937793789379938093819382938393849385938693879388938993909391939293939394939593969397939893999400940194029403940494059406940794089409941094119412941394149415941694179418941994209421942294239424942594269427942894299430943194329433943494359436943794389439944094419442944394449445944694479448944994509451945294539454945594569457945894599460946194629463946494659466946794689469947094719472947394749475947694779478947994809481948294839484948594869487948894899490949194929493949494959496949794989499950095019502950395049505950695079508950995109511951295139514951595169517951895199520952195229523952495259526952795289529953095319532953395349535953695379538953995409541954295439544954595469547954895499550955195529553955495559556955795589559956095619562956395649565956695679568956995709571957295739574957595769577957895799580958195829583958495859586958795889589959095919592959395949595959695979598959996009601960296039604960596069607960896099610961196129613961496159616961796189619962096219622962396249625962696279628962996309631963296339634963596369637963896399640964196429643964496459646964796489649965096519652965396549655965696579658965996609661966296639664966596669667966896699670967196729673967496759676967796789679968096819682968396849685968696879688968996909691969296939694969596969697969896999700970197029703970497059706970797089709971097119712971397149715971697179718971997209721972297239724972597269727972897299730973197329733973497359736973797389739974097419742974397449745974697479748974997509751975297539754975597569757975897599760976197629763976497659766976797689769977097719772977397749775977697779778977997809781978297839784978597869787978897899790979197929793979497959796979797989799980098019802980398049805980698079808980998109811981298139814981598169817981898199820982198229823982498259826982798289829983098319832983398349835983698379838983998409841984298439844984598469847984898499850985198529853985498559856985798589859986098619862986398649865986698679868986998709871987298739874987598769877987898799880988198829883988498859886988798889889989098919892989398949895989698979898989999009901990299039904990599069907990899099910991199129913991499159916991799189919992099219922992399249925992699279928992999309931993299339934993599369937993899399940994199429943994499459946994799489949995099519952995399549955995699579958995999609961996299639964996599669967996899699970997199729973997499759976997799789979998099819982998399849985998699879988998999909991999299939994999599969997999899991000010001100021000310004100051000610007100081000910010100111001210013100141001510016100171001810019100201002110022100231002410025100261002710028100291003010031100321003310034100351003610037100381003910040100411004210043100441004510046100471004810049100501005110052100531005410055100561005710058100591006010061100621006310064100651006610067100681006910070100711007210073100741007510076100771007810079100801008110082100831008410085100861008710088100891009010091100921009310094100951009610097100981009910100101011010210103101041010510106101071010810109101101011110112101131011410115101161011710118101191012010121101221012310124101251012610127101281012910130101311013210133101341013510136101371013810139101401014110142101431014410145101461014710148101491015010151101521015310154101551015610157101581015910160101611016210163101641016510166101671016810169101701017110172101731017410175101761017710178101791018010181101821018310184101851018610187101881018910190101911019210193101941019510196101971019810199102001020110202102031020410205102061020710208102091021010211102121021310214102151021610217102181021910220102211022210223102241022510226102271022810229102301023110232102331023410235102361023710238102391024010241102421024310244102451024610247102481024910250102511025210253102541025510256102571025810259102601026110262102631026410265102661026710268102691027010271102721027310274102751027610277102781027910280102811028210283102841028510286102871028810289102901029110292102931029410295102961029710298102991030010301103021030310304103051030610307103081030910310103111031210313103141031510316103171031810319103201032110322103231032410325103261032710328103291033010331103321033310334103351033610337103381033910340103411034210343103441034510346103471034810349103501035110352103531035410355103561035710358103591036010361103621036310364103651036610367103681036910370103711037210373103741037510376103771037810379103801038110382103831038410385103861038710388103891039010391103921039310394103951039610397103981039910400104011040210403104041040510406104071040810409104101041110412104131041410415104161041710418104191042010421104221042310424104251042610427104281042910430104311043210433104341043510436104371043810439104401044110442104431044410445104461044710448104491045010451104521045310454104551045610457104581045910460104611046210463104641046510466104671046810469104701047110472104731047410475104761047710478104791048010481104821048310484104851048610487104881048910490104911049210493104941049510496104971049810499105001050110502105031050410505105061050710508105091051010511105121051310514105151051610517105181051910520105211052210523105241052510526105271052810529105301053110532105331053410535105361053710538105391054010541105421054310544105451054610547105481054910550105511055210553105541055510556105571055810559105601056110562105631056410565105661056710568105691057010571105721057310574105751057610577105781057910580105811058210583105841058510586105871058810589105901059110592105931059410595105961059710598105991060010601106021060310604106051060610607106081060910610106111061210613106141061510616106171061810619106201062110622106231062410625106261062710628106291063010631106321063310634106351063610637106381063910640106411064210643106441064510646106471064810649106501065110652106531065410655106561065710658106591066010661106621066310664106651066610667106681066910670106711067210673106741067510676106771067810679106801068110682106831068410685106861068710688106891069010691106921069310694106951069610697106981069910700107011070210703107041070510706107071070810709107101071110712107131071410715107161071710718107191072010721107221072310724107251072610727107281072910730107311073210733107341073510736107371073810739107401074110742107431074410745107461074710748107491075010751107521075310754107551075610757107581075910760107611076210763107641076510766107671076810769107701077110772107731077410775107761077710778107791078010781107821078310784107851078610787107881078910790107911079210793107941079510796107971079810799108001080110802108031080410805108061080710808108091081010811108121081310814108151081610817108181081910820108211082210823108241082510826108271082810829108301083110832108331083410835108361083710838108391084010841108421084310844108451084610847108481084910850108511085210853108541085510856108571085810859108601086110862108631086410865108661086710868108691087010871108721087310874108751087610877108781087910880108811088210883108841088510886108871088810889108901089110892108931089410895108961089710898108991090010901109021090310904109051090610907109081090910910109111091210913109141091510916109171091810919109201092110922109231092410925109261092710928109291093010931109321093310934109351093610937109381093910940109411094210943109441094510946109471094810949109501095110952109531095410955109561095710958109591096010961109621096310964109651096610967109681096910970109711097210973109741097510976109771097810979109801098110982109831098410985109861098710988109891099010991109921099310994109951099610997109981099911000110011100211003110041100511006110071100811009110101101111012110131101411015110161101711018110191102011021110221102311024110251102611027110281102911030110311103211033110341103511036110371103811039110401104111042110431104411045110461104711048110491105011051110521105311054110551105611057110581105911060110611106211063110641106511066110671106811069110701107111072110731107411075110761107711078110791108011081110821108311084110851108611087110881108911090110911109211093110941109511096110971109811099111001110111102111031110411105111061110711108111091111011111111121111311114111151111611117111181111911120111211112211123111241112511126111271112811129111301113111132111331113411135111361113711138111391114011141111421114311144111451114611147111481114911150111511115211153111541115511156111571115811159111601116111162111631116411165111661116711168111691117011171111721117311174111751117611177111781117911180111811118211183111841118511186111871118811189111901119111192111931119411195111961119711198111991120011201112021120311204112051120611207112081120911210112111121211213112141121511216112171121811219112201122111222112231122411225112261122711228112291123011231112321123311234112351123611237112381123911240112411124211243112441124511246112471124811249112501125111252112531125411255112561125711258112591126011261112621126311264112651126611267112681126911270112711127211273112741127511276112771127811279112801128111282112831128411285112861128711288112891129011291112921129311294112951129611297112981129911300113011130211303113041130511306113071130811309113101131111312113131131411315113161131711318113191132011321113221132311324113251132611327113281132911330113311133211333113341133511336113371133811339113401134111342113431134411345113461134711348113491135011351113521135311354113551135611357113581135911360113611136211363113641136511366113671136811369113701137111372113731137411375113761137711378113791138011381113821138311384113851138611387113881138911390113911139211393113941139511396113971139811399114001140111402114031140411405114061140711408114091141011411114121141311414114151141611417114181141911420114211142211423114241142511426114271142811429114301143111432114331143411435114361143711438114391144011441114421144311444114451144611447114481144911450114511145211453114541145511456114571145811459114601146111462114631146411465114661146711468114691147011471114721147311474114751147611477114781147911480114811148211483114841148511486114871148811489114901149111492114931149411495114961149711498114991150011501115021150311504115051150611507115081150911510115111151211513115141151511516115171151811519115201152111522115231152411525115261152711528115291153011531115321153311534115351153611537115381153911540115411154211543115441154511546115471154811549115501155111552115531155411555115561155711558115591156011561115621156311564115651156611567115681156911570115711157211573115741157511576115771157811579115801158111582115831158411585115861158711588115891159011591115921159311594115951159611597115981159911600116011160211603116041160511606116071160811609116101161111612116131161411615116161161711618116191162011621116221162311624116251162611627116281162911630116311163211633116341163511636116371163811639116401164111642116431164411645116461164711648116491165011651116521165311654116551165611657116581165911660116611166211663116641166511666116671166811669116701167111672116731167411675116761167711678116791168011681116821168311684116851168611687116881168911690116911169211693116941169511696116971169811699117001170111702117031170411705117061170711708117091171011711117121171311714117151171611717117181171911720117211172211723117241172511726117271172811729117301173111732117331173411735117361173711738117391174011741117421174311744117451174611747117481174911750117511175211753117541175511756117571175811759117601176111762117631176411765117661176711768117691177011771117721177311774117751177611777117781177911780117811178211783117841178511786117871178811789117901179111792117931179411795117961179711798117991180011801118021180311804118051180611807118081180911810118111181211813118141181511816118171181811819118201182111822118231182411825118261182711828118291183011831118321183311834118351183611837118381183911840118411184211843118441184511846118471184811849118501185111852118531185411855118561185711858118591186011861118621186311864118651186611867118681186911870118711187211873118741187511876118771187811879118801188111882118831188411885118861188711888118891189011891118921189311894118951189611897118981189911900119011190211903119041190511906119071190811909119101191111912119131191411915119161191711918119191192011921119221192311924119251192611927119281192911930119311193211933119341193511936119371193811939119401194111942119431194411945119461194711948119491195011951119521195311954119551195611957119581195911960119611196211963119641196511966119671196811969119701197111972119731197411975119761197711978119791198011981119821198311984119851198611987119881198911990119911199211993119941199511996119971199811999120001200112002120031200412005120061200712008120091201012011120121201312014120151201612017120181201912020120211202212023120241202512026120271202812029120301203112032120331203412035120361203712038120391204012041120421204312044120451204612047120481204912050120511205212053120541205512056120571205812059120601206112062120631206412065120661206712068120691207012071120721207312074120751207612077120781207912080120811208212083120841208512086120871208812089120901209112092120931209412095120961209712098120991210012101121021210312104121051210612107121081210912110121111211212113121141211512116121171211812119121201212112122121231212412125121261212712128121291213012131121321213312134121351213612137121381213912140121411214212143121441214512146121471214812149121501215112152121531215412155121561215712158121591216012161121621216312164121651216612167121681216912170121711217212173121741217512176121771217812179121801218112182121831218412185121861218712188121891219012191121921219312194121951219612197121981219912200122011220212203122041220512206122071220812209122101221112212122131221412215122161221712218122191222012221122221222312224122251222612227122281222912230122311223212233122341223512236122371223812239122401224112242122431224412245122461224712248122491225012251122521225312254122551225612257122581225912260122611226212263122641226512266122671226812269122701227112272122731227412275122761227712278122791228012281122821228312284122851228612287122881228912290122911229212293122941229512296122971229812299123001230112302123031230412305123061230712308123091231012311123121231312314123151231612317123181231912320123211232212323123241232512326123271232812329123301233112332123331233412335123361233712338123391234012341123421234312344123451234612347123481234912350123511235212353123541235512356123571235812359123601236112362123631236412365123661236712368123691237012371123721237312374123751237612377123781237912380123811238212383123841238512386123871238812389123901239112392123931239412395123961239712398123991240012401124021240312404124051240612407124081240912410124111241212413124141241512416124171241812419124201242112422124231242412425124261242712428124291243012431124321243312434124351243612437124381243912440124411244212443124441244512446124471244812449124501245112452124531245412455124561245712458124591246012461124621246312464124651246612467124681246912470124711247212473124741247512476124771247812479124801248112482124831248412485124861248712488124891249012491124921249312494124951249612497124981249912500125011250212503125041250512506125071250812509125101251112512125131251412515125161251712518125191252012521125221252312524125251252612527125281252912530125311253212533125341253512536125371253812539125401254112542125431254412545125461254712548125491255012551125521255312554125551255612557125581255912560125611256212563125641256512566125671256812569125701257112572125731257412575125761257712578125791258012581125821258312584125851258612587125881258912590125911259212593125941259512596125971259812599126001260112602126031260412605126061260712608126091261012611126121261312614126151261612617126181261912620126211262212623126241262512626126271262812629126301263112632126331263412635126361263712638126391264012641126421264312644126451264612647126481264912650126511265212653126541265512656126571265812659126601266112662126631266412665126661266712668126691267012671126721267312674126751267612677126781267912680126811268212683126841268512686126871268812689126901269112692126931269412695126961269712698126991270012701127021270312704127051270612707127081270912710127111271212713127141271512716127171271812719127201272112722127231272412725127261272712728127291273012731127321273312734127351273612737127381273912740127411274212743127441274512746127471274812749127501275112752127531275412755127561275712758127591276012761127621276312764127651276612767127681276912770127711277212773127741277512776127771277812779127801278112782127831278412785127861278712788127891279012791127921279312794127951279612797127981279912800128011280212803128041280512806128071280812809128101281112812128131281412815128161281712818128191282012821128221282312824128251282612827128281282912830128311283212833128341283512836128371283812839128401284112842128431284412845128461284712848128491285012851128521285312854128551285612857128581285912860128611286212863128641286512866128671286812869128701287112872128731287412875128761287712878128791288012881128821288312884128851288612887128881288912890128911289212893128941289512896128971289812899129001290112902129031290412905129061290712908129091291012911129121291312914129151291612917129181291912920129211292212923129241292512926129271292812929129301293112932129331293412935129361293712938129391294012941129421294312944129451294612947129481294912950129511295212953129541295512956129571295812959129601296112962129631296412965129661296712968129691297012971129721297312974129751297612977129781297912980129811298212983129841298512986129871298812989129901299112992129931299412995129961299712998129991300013001130021300313004130051300613007130081300913010130111301213013130141301513016130171301813019130201302113022130231302413025130261302713028130291303013031130321303313034130351303613037130381303913040130411304213043130441304513046130471304813049130501305113052130531305413055130561305713058130591306013061130621306313064130651306613067130681306913070130711307213073130741307513076130771307813079130801308113082130831308413085130861308713088130891309013091130921309313094130951309613097130981309913100131011310213103131041310513106131071310813109131101311113112131131311413115131161311713118131191312013121131221312313124131251312613127131281312913130131311313213133131341313513136131371313813139131401314113142131431314413145131461314713148131491315013151131521315313154131551315613157131581315913160131611316213163131641316513166131671316813169131701317113172131731317413175131761317713178131791318013181131821318313184131851318613187131881318913190131911319213193131941319513196131971319813199132001320113202132031320413205132061320713208132091321013211132121321313214132151321613217132181321913220132211322213223132241322513226132271322813229132301323113232132331323413235132361323713238132391324013241132421324313244132451324613247132481324913250132511325213253132541325513256132571325813259132601326113262132631326413265132661326713268132691327013271132721327313274132751327613277132781327913280132811328213283132841328513286132871328813289132901329113292132931329413295132961329713298132991330013301133021330313304133051330613307133081330913310133111331213313133141331513316133171331813319133201332113322133231332413325133261332713328133291333013331133321333313334133351333613337133381333913340133411334213343133441334513346133471334813349133501335113352133531335413355133561335713358133591336013361133621336313364133651336613367133681336913370133711337213373133741337513376133771337813379133801338113382133831338413385133861338713388133891339013391133921339313394133951339613397133981339913400134011340213403134041340513406134071340813409134101341113412134131341413415134161341713418134191342013421134221342313424134251342613427134281342913430134311343213433134341343513436134371343813439134401344113442134431344413445134461344713448134491345013451134521345313454134551345613457134581345913460134611346213463134641346513466134671346813469134701347113472134731347413475134761347713478134791348013481134821348313484134851348613487134881348913490134911349213493134941349513496134971349813499135001350113502135031350413505135061350713508135091351013511135121351313514135151351613517135181351913520135211352213523135241352513526135271352813529135301353113532135331353413535135361353713538135391354013541135421354313544135451354613547135481354913550135511355213553135541355513556135571355813559135601356113562135631356413565135661356713568135691357013571135721357313574135751357613577135781357913580135811358213583135841358513586135871358813589135901359113592135931359413595135961359713598135991360013601136021360313604136051360613607136081360913610136111361213613136141361513616136171361813619136201362113622136231362413625136261362713628136291363013631136321363313634136351363613637136381363913640136411364213643136441364513646136471364813649136501365113652136531365413655136561365713658136591366013661136621366313664136651366613667136681366913670136711367213673136741367513676136771367813679136801368113682136831368413685136861368713688136891369013691136921369313694136951369613697136981369913700137011370213703137041370513706137071370813709137101371113712137131371413715137161371713718137191372013721137221372313724137251372613727137281372913730137311373213733137341373513736137371373813739137401374113742137431374413745137461374713748137491375013751137521375313754137551375613757137581375913760137611376213763137641376513766137671376813769137701377113772137731377413775137761377713778137791378013781137821378313784137851378613787137881378913790137911379213793137941379513796137971379813799138001380113802138031380413805138061380713808138091381013811138121381313814138151381613817138181381913820138211382213823138241382513826138271382813829138301383113832138331383413835138361383713838138391384013841138421384313844138451384613847138481384913850138511385213853138541385513856138571385813859138601386113862138631386413865138661386713868138691387013871138721387313874138751387613877138781387913880138811388213883138841388513886138871388813889138901389113892138931389413895138961389713898138991390013901139021390313904139051390613907139081390913910139111391213913139141391513916139171391813919139201392113922139231392413925139261392713928139291393013931139321393313934139351393613937139381393913940139411394213943139441394513946139471394813949139501395113952139531395413955139561395713958139591396013961139621396313964139651396613967139681396913970139711397213973139741397513976139771397813979139801398113982139831398413985139861398713988139891399013991139921399313994139951399613997139981399914000140011400214003140041400514006140071400814009140101401114012140131401414015140161401714018140191402014021140221402314024140251402614027140281402914030140311403214033140341403514036140371403814039140401404114042140431404414045140461404714048140491405014051140521405314054140551405614057140581405914060140611406214063140641406514066140671406814069140701407114072140731407414075140761407714078140791408014081140821408314084140851408614087140881408914090140911409214093140941409514096140971409814099141001410114102141031410414105141061410714108141091411014111141121411314114141151411614117141181411914120141211412214123141241412514126141271412814129141301413114132141331413414135141361413714138141391414014141141421414314144141451414614147141481414914150141511415214153141541415514156141571415814159141601416114162141631416414165141661416714168141691417014171141721417314174141751417614177141781417914180141811418214183141841418514186141871418814189141901419114192141931419414195141961419714198141991420014201142021420314204142051420614207142081420914210142111421214213142141421514216142171421814219142201422114222142231422414225142261422714228142291423014231142321423314234142351423614237142381423914240142411424214243142441424514246142471424814249142501425114252142531425414255142561425714258142591426014261142621426314264142651426614267142681426914270142711427214273142741427514276142771427814279142801428114282142831428414285142861428714288142891429014291142921429314294142951429614297142981429914300143011430214303143041430514306143071430814309143101431114312143131431414315143161431714318143191432014321143221432314324143251432614327143281432914330143311433214333143341433514336143371433814339143401434114342143431434414345143461434714348143491435014351143521435314354143551435614357143581435914360143611436214363143641436514366143671436814369143701437114372143731437414375143761437714378143791438014381143821438314384143851438614387143881438914390143911439214393143941439514396143971439814399144001440114402144031440414405144061440714408144091441014411144121441314414144151441614417144181441914420144211442214423144241442514426144271442814429144301443114432144331443414435144361443714438144391444014441144421444314444144451444614447144481444914450144511445214453144541445514456144571445814459144601446114462144631446414465144661446714468144691447014471144721447314474144751447614477144781447914480144811448214483144841448514486144871448814489144901449114492144931449414495144961449714498144991450014501145021450314504145051450614507145081450914510145111451214513145141451514516145171451814519145201452114522145231452414525145261452714528145291453014531145321453314534145351453614537145381453914540145411454214543145441454514546145471454814549145501455114552145531455414555145561455714558145591456014561145621456314564145651456614567145681456914570145711457214573145741457514576145771457814579145801458114582145831458414585145861458714588145891459014591145921459314594145951459614597145981459914600146011460214603146041460514606146071460814609146101461114612146131461414615146161461714618146191462014621146221462314624146251462614627146281462914630146311463214633146341463514636146371463814639146401464114642146431464414645146461464714648146491465014651146521465314654146551465614657146581465914660146611466214663146641466514666146671466814669146701467114672146731467414675146761467714678146791468014681146821468314684146851468614687146881468914690146911469214693146941469514696146971469814699147001470114702147031470414705147061470714708147091471014711147121471314714147151471614717147181471914720147211472214723147241472514726147271472814729147301473114732147331473414735147361473714738147391474014741147421474314744147451474614747147481474914750147511475214753147541475514756147571475814759147601476114762147631476414765147661476714768147691477014771147721477314774147751477614777147781477914780147811478214783147841478514786147871478814789147901479114792147931479414795147961479714798147991480014801148021480314804148051480614807148081480914810148111481214813148141481514816148171481814819148201482114822148231482414825148261482714828148291483014831148321483314834148351483614837148381483914840148411484214843148441484514846148471484814849148501485114852148531485414855148561485714858148591486014861148621486314864148651486614867148681486914870148711487214873148741487514876148771487814879148801488114882148831488414885148861488714888148891489014891148921489314894148951489614897148981489914900149011490214903149041490514906149071490814909149101491114912149131491414915149161491714918149191492014921149221492314924149251492614927149281492914930149311493214933149341493514936149371493814939149401494114942149431494414945149461494714948149491495014951149521495314954149551495614957149581495914960149611496214963149641496514966149671496814969149701497114972149731497414975149761497714978149791498014981149821498314984149851498614987149881498914990149911499214993149941499514996149971499814999150001500115002150031500415005150061500715008150091501015011150121501315014150151501615017150181501915020150211502215023150241502515026150271502815029150301503115032150331503415035150361503715038150391504015041150421504315044150451504615047150481504915050150511505215053150541505515056150571505815059150601506115062150631506415065150661506715068150691507015071150721507315074150751507615077150781507915080150811508215083150841508515086150871508815089150901509115092150931509415095150961509715098150991510015101151021510315104151051510615107151081510915110151111511215113151141511515116151171511815119151201512115122151231512415125151261512715128151291513015131151321513315134151351513615137151381513915140151411514215143151441514515146151471514815149151501515115152151531515415155151561515715158151591516015161151621516315164151651516615167151681516915170151711517215173151741517515176151771517815179151801518115182151831518415185151861518715188151891519015191151921519315194151951519615197151981519915200152011520215203152041520515206152071520815209152101521115212152131521415215152161521715218152191522015221152221522315224152251522615227152281522915230152311523215233152341523515236152371523815239152401524115242152431524415245152461524715248152491525015251152521525315254152551525615257152581525915260152611526215263152641526515266152671526815269152701527115272152731527415275152761527715278152791528015281152821528315284152851528615287152881528915290152911529215293152941529515296152971529815299153001530115302153031530415305153061530715308153091531015311153121531315314153151531615317153181531915320153211532215323153241532515326153271532815329153301533115332153331533415335153361533715338153391534015341153421534315344153451534615347153481534915350153511535215353153541535515356153571535815359153601536115362153631536415365153661536715368153691537015371153721537315374153751537615377153781537915380153811538215383153841538515386153871538815389153901539115392153931539415395153961539715398153991540015401154021540315404154051540615407154081540915410154111541215413154141541515416154171541815419154201542115422154231542415425154261542715428154291543015431154321543315434154351543615437154381543915440154411544215443154441544515446154471544815449154501545115452154531545415455154561545715458154591546015461154621546315464154651546615467154681546915470154711547215473154741547515476154771547815479154801548115482154831548415485154861548715488154891549015491154921549315494154951549615497154981549915500155011550215503155041550515506155071550815509155101551115512155131551415515155161551715518155191552015521155221552315524155251552615527155281552915530155311553215533155341553515536155371553815539155401554115542155431554415545155461554715548155491555015551155521555315554155551555615557155581555915560155611556215563155641556515566155671556815569155701557115572155731557415575155761557715578155791558015581155821558315584155851558615587155881558915590155911559215593155941559515596155971559815599156001560115602156031560415605156061560715608156091561015611156121561315614156151561615617156181561915620156211562215623156241562515626156271562815629156301563115632156331563415635156361563715638156391564015641156421564315644156451564615647156481564915650156511565215653156541565515656156571565815659156601566115662156631566415665156661566715668156691567015671156721567315674156751567615677156781567915680156811568215683156841568515686156871568815689156901569115692156931569415695156961569715698156991570015701157021570315704157051570615707157081570915710157111571215713157141571515716157171571815719157201572115722157231572415725157261572715728157291573015731157321573315734157351573615737157381573915740157411574215743157441574515746157471574815749157501575115752157531575415755157561575715758157591576015761157621576315764157651576615767157681576915770157711577215773157741577515776157771577815779157801578115782157831578415785157861578715788157891579015791157921579315794157951579615797157981579915800158011580215803158041580515806158071580815809158101581115812158131581415815158161581715818158191582015821158221582315824158251582615827158281582915830158311583215833158341583515836158371583815839158401584115842158431584415845158461584715848158491585015851158521585315854158551585615857158581585915860158611586215863158641586515866158671586815869158701587115872158731587415875158761587715878158791588015881158821588315884158851588615887158881588915890158911589215893158941589515896158971589815899159001590115902159031590415905159061590715908159091591015911159121591315914159151591615917159181591915920159211592215923159241592515926159271592815929159301593115932159331593415935159361593715938159391594015941159421594315944159451594615947159481594915950159511595215953159541595515956159571595815959159601596115962159631596415965159661596715968159691597015971159721597315974159751597615977159781597915980159811598215983159841598515986159871598815989159901599115992159931599415995159961599715998159991600016001160021600316004160051600616007160081600916010160111601216013160141601516016160171601816019160201602116022160231602416025160261602716028160291603016031160321603316034160351603616037160381603916040160411604216043160441604516046160471604816049160501605116052160531605416055160561605716058160591606016061160621606316064160651606616067160681606916070160711607216073160741607516076160771607816079160801608116082160831608416085160861608716088160891609016091160921609316094160951609616097160981609916100161011610216103161041610516106161071610816109161101611116112161131611416115161161611716118161191612016121161221612316124161251612616127161281612916130161311613216133161341613516136161371613816139161401614116142161431614416145161461614716148161491615016151161521615316154161551615616157161581615916160161611616216163161641616516166161671616816169161701617116172161731617416175161761617716178161791618016181161821618316184161851618616187161881618916190161911619216193161941619516196161971619816199162001620116202162031620416205162061620716208162091621016211162121621316214162151621616217162181621916220162211622216223162241622516226162271622816229162301623116232162331623416235162361623716238162391624016241162421624316244162451624616247162481624916250162511625216253162541625516256162571625816259162601626116262162631626416265162661626716268162691627016271162721627316274162751627616277162781627916280162811628216283162841628516286162871628816289162901629116292162931629416295162961629716298162991630016301163021630316304163051630616307163081630916310163111631216313163141631516316163171631816319163201632116322163231632416325163261632716328163291633016331163321633316334163351633616337163381633916340163411634216343163441634516346163471634816349163501635116352163531635416355163561635716358163591636016361163621636316364163651636616367163681636916370163711637216373163741637516376163771637816379163801638116382163831638416385163861638716388163891639016391163921639316394163951639616397163981639916400164011640216403164041640516406164071640816409164101641116412164131641416415164161641716418164191642016421164221642316424164251642616427164281642916430164311643216433164341643516436164371643816439164401644116442164431644416445164461644716448164491645016451164521645316454164551645616457164581645916460164611646216463164641646516466164671646816469164701647116472164731647416475164761647716478164791648016481164821648316484164851648616487164881648916490164911649216493164941649516496164971649816499165001650116502165031650416505165061650716508165091651016511165121651316514165151651616517165181651916520165211652216523165241652516526165271652816529165301653116532165331653416535165361653716538165391654016541165421654316544165451654616547165481654916550165511655216553165541655516556165571655816559165601656116562165631656416565165661656716568165691657016571165721657316574165751657616577165781657916580165811658216583165841658516586165871658816589165901659116592165931659416595165961659716598165991660016601166021660316604166051660616607166081660916610166111661216613166141661516616166171661816619166201662116622166231662416625166261662716628166291663016631166321663316634166351663616637166381663916640166411664216643166441664516646166471664816649166501665116652166531665416655166561665716658166591666016661166621666316664166651666616667166681666916670166711667216673166741667516676166771667816679166801668116682166831668416685166861668716688166891669016691166921669316694166951669616697166981669916700167011670216703167041670516706167071670816709167101671116712167131671416715167161671716718167191672016721167221672316724167251672616727167281672916730167311673216733167341673516736167371673816739167401674116742167431674416745167461674716748167491675016751167521675316754167551675616757167581675916760167611676216763167641676516766167671676816769167701677116772167731677416775167761677716778167791678016781167821678316784167851678616787167881678916790167911679216793167941679516796167971679816799168001680116802168031680416805168061680716808168091681016811168121681316814168151681616817168181681916820168211682216823168241682516826168271682816829168301683116832168331683416835168361683716838168391684016841168421684316844168451684616847168481684916850168511685216853168541685516856168571685816859168601686116862168631686416865168661686716868168691687016871168721687316874168751687616877168781687916880168811688216883168841688516886168871688816889168901689116892168931689416895168961689716898168991690016901169021690316904169051690616907169081690916910169111691216913169141691516916169171691816919169201692116922169231692416925169261692716928169291693016931169321693316934169351693616937169381693916940169411694216943169441694516946169471694816949169501695116952169531695416955169561695716958169591696016961169621696316964169651696616967169681696916970169711697216973169741697516976169771697816979169801698116982169831698416985169861698716988169891699016991169921699316994169951699616997169981699917000170011700217003170041700517006170071700817009170101701117012170131701417015170161701717018170191702017021170221702317024170251702617027170281702917030170311703217033170341703517036170371703817039170401704117042170431704417045170461704717048170491705017051170521705317054170551705617057170581705917060170611706217063170641706517066170671706817069170701707117072170731707417075170761707717078170791708017081170821708317084170851708617087170881708917090170911709217093170941709517096170971709817099171001710117102171031710417105171061710717108171091711017111171121711317114171151711617117171181711917120171211712217123171241712517126171271712817129171301713117132171331713417135171361713717138171391714017141171421714317144171451714617147171481714917150171511715217153171541715517156171571715817159171601716117162171631716417165171661716717168171691717017171171721717317174171751717617177171781717917180171811718217183171841718517186171871718817189171901719117192171931719417195171961719717198171991720017201172021720317204172051720617207172081720917210172111721217213172141721517216172171721817219172201722117222172231722417225172261722717228172291723017231172321723317234172351723617237172381723917240172411724217243172441724517246172471724817249172501725117252172531725417255172561725717258172591726017261172621726317264172651726617267172681726917270172711727217273172741727517276172771727817279172801728117282172831728417285172861728717288172891729017291172921729317294172951729617297172981729917300173011730217303173041730517306173071730817309173101731117312173131731417315173161731717318173191732017321173221732317324173251732617327173281732917330173311733217333173341733517336173371733817339173401734117342173431734417345173461734717348173491735017351173521735317354173551735617357173581735917360173611736217363173641736517366173671736817369173701737117372173731737417375173761737717378173791738017381173821738317384173851738617387173881738917390173911739217393173941739517396173971739817399174001740117402174031740417405174061740717408174091741017411174121741317414174151741617417174181741917420174211742217423174241742517426174271742817429174301743117432174331743417435174361743717438174391744017441174421744317444174451744617447174481744917450174511745217453174541745517456174571745817459174601746117462174631746417465174661746717468174691747017471174721747317474174751747617477174781747917480174811748217483174841748517486174871748817489174901749117492174931749417495174961749717498174991750017501175021750317504175051750617507175081750917510175111751217513175141751517516175171751817519175201752117522175231752417525175261752717528175291753017531175321753317534175351753617537175381753917540175411754217543175441754517546175471754817549175501755117552175531755417555175561755717558175591756017561175621756317564175651756617567175681756917570175711757217573175741757517576175771757817579175801758117582175831758417585175861758717588175891759017591175921759317594175951759617597175981759917600176011760217603176041760517606176071760817609176101761117612176131761417615176161761717618176191762017621176221762317624176251762617627176281762917630176311763217633176341763517636176371763817639176401764117642176431764417645176461764717648176491765017651176521765317654176551765617657176581765917660176611766217663176641766517666176671766817669176701767117672176731767417675176761767717678176791768017681176821768317684176851768617687176881768917690176911769217693176941769517696176971769817699177001770117702177031770417705177061770717708177091771017711177121771317714177151771617717177181771917720177211772217723177241772517726177271772817729177301773117732177331773417735177361773717738177391774017741177421774317744177451774617747177481774917750177511775217753177541775517756177571775817759177601776117762177631776417765177661776717768177691777017771177721777317774177751777617777177781777917780177811778217783177841778517786177871778817789177901779117792177931779417795177961779717798177991780017801178021780317804178051780617807178081780917810178111781217813178141781517816178171781817819178201782117822178231782417825178261782717828178291783017831178321783317834178351783617837178381783917840178411784217843178441784517846178471784817849178501785117852178531785417855178561785717858178591786017861178621786317864178651786617867178681786917870178711787217873178741787517876178771787817879178801788117882178831788417885178861788717888178891789017891178921789317894178951789617897178981789917900179011790217903179041790517906179071790817909179101791117912179131791417915179161791717918179191792017921179221792317924179251792617927179281792917930179311793217933179341793517936179371793817939179401794117942179431794417945179461794717948179491795017951179521795317954179551795617957179581795917960179611796217963179641796517966179671796817969179701797117972179731797417975179761797717978179791798017981179821798317984179851798617987179881798917990179911799217993179941799517996179971799817999180001800118002180031800418005180061800718008180091801018011180121801318014180151801618017180181801918020180211802218023180241802518026180271802818029180301803118032180331803418035180361803718038180391804018041180421804318044180451804618047180481804918050180511805218053180541805518056180571805818059180601806118062180631806418065180661806718068180691807018071180721807318074180751807618077180781807918080180811808218083180841808518086180871808818089180901809118092180931809418095180961809718098180991810018101181021810318104181051810618107181081810918110181111811218113181141811518116181171811818119181201812118122181231812418125181261812718128181291813018131181321813318134181351813618137181381813918140181411814218143181441814518146181471814818149181501815118152181531815418155181561815718158181591816018161181621816318164181651816618167181681816918170181711817218173181741817518176181771817818179181801818118182181831818418185181861818718188181891819018191181921819318194181951819618197181981819918200182011820218203182041820518206182071820818209182101821118212182131821418215182161821718218182191822018221182221822318224182251822618227182281822918230182311823218233182341823518236182371823818239182401824118242182431824418245182461824718248182491825018251182521825318254182551825618257182581825918260182611826218263182641826518266182671826818269182701827118272182731827418275182761827718278182791828018281182821828318284182851828618287182881828918290182911829218293182941829518296182971829818299183001830118302183031830418305183061830718308183091831018311183121831318314183151831618317183181831918320183211832218323183241832518326183271832818329183301833118332183331833418335183361833718338183391834018341183421834318344183451834618347183481834918350183511835218353183541835518356183571835818359183601836118362183631836418365183661836718368183691837018371183721837318374183751837618377183781837918380183811838218383183841838518386183871838818389183901839118392183931839418395183961839718398183991840018401184021840318404184051840618407184081840918410184111841218413184141841518416184171841818419184201842118422184231842418425184261842718428184291843018431184321843318434184351843618437184381843918440184411844218443184441844518446184471844818449184501845118452184531845418455184561845718458184591846018461184621846318464184651846618467184681846918470184711847218473184741847518476184771847818479184801848118482184831848418485184861848718488184891849018491184921849318494184951849618497184981849918500185011850218503185041850518506185071850818509185101851118512185131851418515185161851718518185191852018521185221852318524185251852618527185281852918530185311853218533185341853518536185371853818539185401854118542185431854418545185461854718548185491855018551185521855318554185551855618557185581855918560185611856218563185641856518566185671856818569185701857118572185731857418575185761857718578185791858018581185821858318584185851858618587185881858918590185911859218593185941859518596185971859818599186001860118602186031860418605186061860718608186091861018611186121861318614186151861618617186181861918620186211862218623186241862518626186271862818629186301863118632186331863418635186361863718638186391864018641186421864318644186451864618647186481864918650186511865218653186541865518656186571865818659186601866118662186631866418665186661866718668186691867018671186721867318674186751867618677186781867918680186811868218683186841868518686186871868818689186901869118692186931869418695186961869718698186991870018701187021870318704187051870618707187081870918710187111871218713187141871518716187171871818719187201872118722187231872418725187261872718728187291873018731187321873318734187351873618737187381873918740187411874218743187441874518746187471874818749187501875118752187531875418755187561875718758187591876018761187621876318764187651876618767187681876918770187711877218773187741877518776187771877818779187801878118782187831878418785187861878718788187891879018791187921879318794187951879618797187981879918800188011880218803188041880518806188071880818809188101881118812188131881418815188161881718818188191882018821188221882318824188251882618827188281882918830188311883218833188341883518836188371883818839188401884118842188431884418845188461884718848188491885018851188521885318854188551885618857188581885918860188611886218863188641886518866188671886818869188701887118872188731887418875188761887718878188791888018881188821888318884188851888618887188881888918890188911889218893188941889518896188971889818899189001890118902189031890418905189061890718908189091891018911189121891318914189151891618917189181891918920189211892218923189241892518926189271892818929189301893118932189331893418935189361893718938189391894018941189421894318944189451894618947189481894918950189511895218953189541895518956189571895818959189601896118962189631896418965189661896718968189691897018971189721897318974189751897618977189781897918980189811898218983189841898518986189871898818989189901899118992189931899418995189961899718998189991900019001190021900319004190051900619007190081900919010190111901219013190141901519016190171901819019190201902119022190231902419025190261902719028190291903019031190321903319034190351903619037190381903919040190411904219043190441904519046190471904819049190501905119052190531905419055190561905719058190591906019061190621906319064190651906619067190681906919070190711907219073190741907519076190771907819079190801908119082190831908419085190861908719088190891909019091190921909319094190951909619097190981909919100191011910219103191041910519106191071910819109191101911119112191131911419115191161911719118191191912019121191221912319124191251912619127191281912919130191311913219133191341913519136191371913819139191401914119142191431914419145191461914719148191491915019151191521915319154191551915619157191581915919160191611916219163191641916519166191671916819169191701917119172191731917419175191761917719178191791918019181191821918319184191851918619187191881918919190191911919219193191941919519196191971919819199192001920119202192031920419205192061920719208192091921019211192121921319214192151921619217192181921919220192211922219223192241922519226192271922819229192301923119232192331923419235192361923719238192391924019241192421924319244192451924619247192481924919250192511925219253192541925519256192571925819259192601926119262192631926419265192661926719268192691927019271192721927319274192751927619277192781927919280192811928219283192841928519286192871928819289192901929119292192931929419295192961929719298192991930019301193021930319304193051930619307193081930919310193111931219313193141931519316193171931819319193201932119322193231932419325193261932719328193291933019331193321933319334193351933619337193381933919340193411934219343193441934519346193471934819349193501935119352193531935419355193561935719358193591936019361193621936319364193651936619367193681936919370193711937219373193741937519376193771937819379193801938119382193831938419385193861938719388193891939019391193921939319394193951939619397193981939919400194011940219403194041940519406194071940819409194101941119412194131941419415194161941719418194191942019421194221942319424194251942619427194281942919430194311943219433194341943519436194371943819439194401944119442194431944419445194461944719448194491945019451194521945319454194551945619457194581945919460194611946219463194641946519466194671946819469194701947119472194731947419475194761947719478194791948019481194821948319484194851948619487194881948919490194911949219493194941949519496194971949819499195001950119502195031950419505195061950719508195091951019511195121951319514195151951619517195181951919520195211952219523195241952519526195271952819529195301953119532195331953419535195361953719538195391954019541195421954319544195451954619547195481954919550195511955219553195541955519556195571955819559195601956119562195631956419565195661956719568195691957019571195721957319574195751957619577195781957919580195811958219583195841958519586195871958819589195901959119592195931959419595195961959719598195991960019601196021960319604196051960619607196081960919610196111961219613196141961519616196171961819619196201962119622196231962419625196261962719628196291963019631196321963319634196351963619637196381963919640196411964219643196441964519646196471964819649196501965119652196531965419655196561965719658196591966019661196621966319664196651966619667196681966919670196711967219673196741967519676196771967819679196801968119682196831968419685196861968719688196891969019691196921969319694196951969619697196981969919700197011970219703197041970519706197071970819709197101971119712197131971419715197161971719718197191972019721197221972319724197251972619727197281972919730197311973219733197341973519736197371973819739197401974119742197431974419745197461974719748197491975019751197521975319754197551975619757197581975919760197611976219763197641976519766197671976819769197701977119772197731977419775197761977719778197791978019781197821978319784197851978619787197881978919790197911979219793197941979519796197971979819799198001980119802198031980419805198061980719808198091981019811198121981319814198151981619817198181981919820198211982219823198241982519826198271982819829198301983119832198331983419835198361983719838198391984019841198421984319844198451984619847198481984919850198511985219853198541985519856198571985819859198601986119862198631986419865198661986719868198691987019871198721987319874198751987619877198781987919880198811988219883198841988519886198871988819889198901989119892198931989419895198961989719898198991990019901199021990319904199051990619907199081990919910199111991219913199141991519916199171991819919199201992119922199231992419925199261992719928199291993019931199321993319934199351993619937199381993919940199411994219943199441994519946199471994819949199501995119952199531995419955199561995719958199591996019961199621996319964199651996619967199681996919970199711997219973199741997519976199771997819979199801998119982199831998419985199861998719988199891999019991199921999319994199951999619997199981999920000200012000220003200042000520006200072000820009200102001120012200132001420015200162001720018200192002020021200222002320024200252002620027200282002920030200312003220033200342003520036200372003820039200402004120042200432004420045200462004720048200492005020051200522005320054200552005620057200582005920060200612006220063200642006520066200672006820069200702007120072200732007420075200762007720078200792008020081200822008320084200852008620087200882008920090200912009220093200942009520096200972009820099201002010120102201032010420105201062010720108201092011020111201122011320114201152011620117201182011920120201212012220123201242012520126201272012820129201302013120132201332013420135201362013720138201392014020141201422014320144201452014620147201482014920150201512015220153201542015520156201572015820159201602016120162201632016420165201662016720168201692017020171201722017320174201752017620177201782017920180201812018220183201842018520186201872018820189201902019120192201932019420195201962019720198201992020020201202022020320204202052020620207202082020920210202112021220213202142021520216202172021820219202202022120222202232022420225202262022720228202292023020231202322023320234202352023620237202382023920240202412024220243202442024520246202472024820249202502025120252202532025420255202562025720258202592026020261202622026320264202652026620267202682026920270202712027220273202742027520276202772027820279202802028120282202832028420285202862028720288202892029020291202922029320294202952029620297202982029920300203012030220303203042030520306203072030820309203102031120312203132031420315203162031720318203192032020321203222032320324203252032620327203282032920330203312033220333203342033520336203372033820339203402034120342203432034420345203462034720348203492035020351203522035320354203552035620357203582035920360203612036220363203642036520366203672036820369203702037120372203732037420375203762037720378203792038020381203822038320384203852038620387203882038920390203912039220393203942039520396203972039820399204002040120402204032040420405204062040720408204092041020411204122041320414204152041620417204182041920420204212042220423204242042520426204272042820429204302043120432204332043420435204362043720438204392044020441204422044320444204452044620447204482044920450204512045220453204542045520456204572045820459204602046120462204632046420465204662046720468204692047020471204722047320474204752047620477204782047920480204812048220483204842048520486204872048820489204902049120492204932049420495204962049720498204992050020501205022050320504205052050620507205082050920510205112051220513205142051520516205172051820519205202052120522205232052420525205262052720528205292053020531205322053320534205352053620537205382053920540205412054220543205442054520546205472054820549205502055120552205532055420555205562055720558205592056020561205622056320564205652056620567205682056920570205712057220573205742057520576205772057820579205802058120582205832058420585205862058720588205892059020591205922059320594205952059620597205982059920600206012060220603206042060520606206072060820609206102061120612206132061420615206162061720618206192062020621206222062320624206252062620627206282062920630206312063220633206342063520636206372063820639206402064120642206432064420645206462064720648206492065020651206522065320654206552065620657206582065920660206612066220663206642066520666206672066820669206702067120672206732067420675206762067720678206792068020681206822068320684206852068620687206882068920690206912069220693206942069520696206972069820699207002070120702207032070420705207062070720708207092071020711207122071320714207152071620717207182071920720207212072220723207242072520726207272072820729207302073120732207332073420735207362073720738207392074020741207422074320744207452074620747207482074920750207512075220753207542075520756207572075820759207602076120762207632076420765207662076720768207692077020771207722077320774207752077620777207782077920780207812078220783207842078520786207872078820789207902079120792207932079420795207962079720798207992080020801208022080320804208052080620807208082080920810208112081220813208142081520816208172081820819208202082120822208232082420825208262082720828208292083020831208322083320834208352083620837208382083920840208412084220843208442084520846208472084820849208502085120852208532085420855208562085720858208592086020861208622086320864208652086620867208682086920870208712087220873208742087520876208772087820879208802088120882208832088420885208862088720888208892089020891208922089320894208952089620897208982089920900209012090220903209042090520906209072090820909209102091120912209132091420915209162091720918209192092020921209222092320924209252092620927209282092920930209312093220933209342093520936209372093820939209402094120942209432094420945209462094720948209492095020951209522095320954209552095620957209582095920960209612096220963209642096520966209672096820969209702097120972209732097420975209762097720978209792098020981209822098320984209852098620987209882098920990209912099220993209942099520996209972099820999210002100121002210032100421005210062100721008210092101021011210122101321014210152101621017210182101921020210212102221023210242102521026210272102821029210302103121032210332103421035210362103721038210392104021041210422104321044210452104621047210482104921050210512105221053210542105521056210572105821059210602106121062210632106421065210662106721068210692107021071210722107321074210752107621077210782107921080210812108221083210842108521086210872108821089210902109121092210932109421095210962109721098210992110021101211022110321104211052110621107211082110921110211112111221113211142111521116211172111821119211202112121122211232112421125211262112721128211292113021131211322113321134211352113621137211382113921140211412114221143211442114521146211472114821149211502115121152211532115421155211562115721158211592116021161211622116321164211652116621167211682116921170211712117221173211742117521176211772117821179211802118121182211832118421185211862118721188211892119021191211922119321194211952119621197211982119921200212012120221203212042120521206212072120821209212102121121212212132121421215212162121721218212192122021221212222122321224212252122621227212282122921230212312123221233212342123521236212372123821239212402124121242212432124421245212462124721248212492125021251212522125321254212552125621257212582125921260212612126221263212642126521266212672126821269212702127121272212732127421275212762127721278212792128021281212822128321284212852128621287212882128921290212912129221293212942129521296212972129821299213002130121302213032130421305213062130721308213092131021311213122131321314213152131621317213182131921320213212132221323213242132521326213272132821329213302133121332213332133421335213362133721338213392134021341213422134321344213452134621347213482134921350213512135221353213542135521356213572135821359213602136121362213632136421365213662136721368213692137021371213722137321374213752137621377213782137921380213812138221383213842138521386213872138821389213902139121392213932139421395213962139721398213992140021401214022140321404214052140621407214082140921410214112141221413214142141521416214172141821419214202142121422214232142421425214262142721428214292143021431214322143321434214352143621437214382143921440214412144221443214442144521446214472144821449214502145121452214532145421455214562145721458214592146021461214622146321464214652146621467214682146921470214712147221473214742147521476214772147821479214802148121482214832148421485214862148721488214892149021491214922149321494214952149621497214982149921500215012150221503215042150521506215072150821509215102151121512215132151421515215162151721518215192152021521215222152321524215252152621527215282152921530215312153221533215342153521536215372153821539215402154121542215432154421545215462154721548215492155021551215522155321554215552155621557215582155921560215612156221563215642156521566215672156821569215702157121572215732157421575215762157721578215792158021581215822158321584215852158621587215882158921590215912159221593215942159521596215972159821599216002160121602216032160421605216062160721608216092161021611216122161321614216152161621617216182161921620216212162221623216242162521626216272162821629216302163121632216332163421635216362163721638216392164021641216422164321644216452164621647216482164921650216512165221653216542165521656216572165821659216602166121662216632166421665216662166721668216692167021671216722167321674216752167621677216782167921680216812168221683216842168521686216872168821689216902169121692216932169421695216962169721698216992170021701217022170321704217052170621707217082170921710217112171221713217142171521716217172171821719217202172121722217232172421725217262172721728217292173021731217322173321734217352173621737217382173921740217412174221743217442174521746217472174821749217502175121752217532175421755217562175721758217592176021761217622176321764217652176621767217682176921770217712177221773217742177521776217772177821779217802178121782217832178421785217862178721788217892179021791217922179321794217952179621797217982179921800218012180221803218042180521806218072180821809218102181121812218132181421815218162181721818218192182021821218222182321824218252182621827218282182921830218312183221833218342183521836218372183821839218402184121842218432184421845218462184721848218492185021851218522185321854218552185621857218582185921860218612186221863218642186521866218672186821869218702187121872218732187421875218762187721878218792188021881218822188321884218852188621887218882188921890218912189221893218942189521896218972189821899219002190121902219032190421905219062190721908219092191021911219122191321914219152191621917219182191921920219212192221923219242192521926219272192821929219302193121932219332193421935219362193721938219392194021941219422194321944219452194621947219482194921950219512195221953219542195521956219572195821959219602196121962219632196421965219662196721968219692197021971219722197321974219752197621977219782197921980219812198221983219842198521986219872198821989219902199121992219932199421995219962199721998219992200022001220022200322004220052200622007220082200922010220112201222013220142201522016220172201822019220202202122022220232202422025220262202722028220292203022031220322203322034220352203622037220382203922040220412204222043220442204522046220472204822049220502205122052220532205422055220562205722058220592206022061220622206322064220652206622067220682206922070220712207222073220742207522076220772207822079220802208122082220832208422085220862208722088220892209022091220922209322094220952209622097220982209922100221012210222103221042210522106221072210822109221102211122112221132211422115221162211722118221192212022121221222212322124221252212622127221282212922130221312213222133221342213522136221372213822139221402214122142221432214422145221462214722148221492215022151221522215322154221552215622157221582215922160221612216222163221642216522166221672216822169221702217122172221732217422175221762217722178221792218022181221822218322184221852218622187221882218922190221912219222193221942219522196221972219822199222002220122202222032220422205222062220722208222092221022211222122221322214222152221622217222182221922220222212222222223222242222522226222272222822229222302223122232222332223422235222362223722238222392224022241222422224322244222452224622247222482224922250222512225222253222542225522256222572225822259222602226122262222632226422265222662226722268222692227022271222722227322274222752227622277222782227922280222812228222283222842228522286222872228822289222902229122292222932229422295222962229722298222992230022301223022230322304223052230622307223082230922310223112231222313223142231522316223172231822319223202232122322223232232422325223262232722328223292233022331223322233322334223352233622337223382233922340223412234222343223442234522346223472234822349223502235122352223532235422355223562235722358223592236022361223622236322364223652236622367223682236922370223712237222373223742237522376223772237822379223802238122382223832238422385223862238722388223892239022391223922239322394223952239622397223982239922400224012240222403224042240522406224072240822409224102241122412224132241422415224162241722418224192242022421224222242322424224252242622427224282242922430224312243222433224342243522436224372243822439224402244122442224432244422445224462244722448224492245022451224522245322454224552245622457224582245922460224612246222463224642246522466224672246822469224702247122472224732247422475224762247722478224792248022481224822248322484224852248622487224882248922490224912249222493224942249522496224972249822499225002250122502225032250422505225062250722508225092251022511225122251322514225152251622517225182251922520225212252222523225242252522526225272252822529225302253122532225332253422535225362253722538225392254022541225422254322544225452254622547225482254922550225512255222553225542255522556225572255822559225602256122562225632256422565225662256722568225692257022571225722257322574225752257622577225782257922580225812258222583225842258522586225872258822589225902259122592225932259422595225962259722598225992260022601226022260322604226052260622607226082260922610226112261222613226142261522616226172261822619226202262122622226232262422625226262262722628226292263022631226322263322634226352263622637226382263922640226412264222643226442264522646226472264822649226502265122652226532265422655226562265722658226592266022661226622266322664226652266622667226682266922670226712267222673226742267522676226772267822679226802268122682226832268422685226862268722688226892269022691226922269322694226952269622697226982269922700227012270222703227042270522706227072270822709227102271122712227132271422715227162271722718227192272022721227222272322724227252272622727227282272922730227312273222733227342273522736227372273822739227402274122742227432274422745227462274722748227492275022751227522275322754227552275622757227582275922760227612276222763227642276522766227672276822769227702277122772227732277422775227762277722778227792278022781227822278322784227852278622787227882278922790227912279222793227942279522796227972279822799228002280122802228032280422805228062280722808228092281022811228122281322814228152281622817228182281922820228212282222823228242282522826228272282822829228302283122832228332283422835228362283722838228392284022841228422284322844228452284622847228482284922850228512285222853228542285522856228572285822859228602286122862228632286422865228662286722868228692287022871228722287322874228752287622877228782287922880228812288222883228842288522886228872288822889228902289122892228932289422895228962289722898228992290022901229022290322904229052290622907229082290922910229112291222913229142291522916229172291822919229202292122922229232292422925229262292722928229292293022931229322293322934229352293622937229382293922940229412294222943229442294522946229472294822949229502295122952229532295422955229562295722958229592296022961229622296322964229652296622967229682296922970229712297222973229742297522976229772297822979229802298122982229832298422985229862298722988229892299022991229922299322994229952299622997229982299923000230012300223003230042300523006230072300823009230102301123012230132301423015230162301723018230192302023021230222302323024230252302623027230282302923030230312303223033230342303523036230372303823039230402304123042230432304423045230462304723048230492305023051230522305323054230552305623057230582305923060230612306223063230642306523066230672306823069230702307123072230732307423075230762307723078230792308023081230822308323084230852308623087230882308923090230912309223093230942309523096230972309823099231002310123102231032310423105231062310723108231092311023111231122311323114231152311623117231182311923120231212312223123231242312523126231272312823129231302313123132231332313423135231362313723138231392314023141231422314323144231452314623147231482314923150231512315223153231542315523156231572315823159231602316123162231632316423165231662316723168231692317023171231722317323174231752317623177231782317923180231812318223183231842318523186231872318823189231902319123192231932319423195231962319723198231992320023201232022320323204232052320623207232082320923210232112321223213232142321523216232172321823219232202322123222232232322423225232262322723228232292323023231232322323323234232352323623237232382323923240232412324223243232442324523246232472324823249232502325123252232532325423255232562325723258232592326023261232622326323264232652326623267232682326923270232712327223273232742327523276232772327823279232802328123282232832328423285232862328723288232892329023291232922329323294232952329623297232982329923300233012330223303233042330523306233072330823309233102331123312233132331423315233162331723318233192332023321233222332323324233252332623327233282332923330233312333223333233342333523336233372333823339233402334123342233432334423345233462334723348233492335023351233522335323354233552335623357233582335923360233612336223363233642336523366233672336823369233702337123372233732337423375233762337723378233792338023381233822338323384233852338623387233882338923390233912339223393233942339523396233972339823399234002340123402234032340423405234062340723408234092341023411234122341323414234152341623417234182341923420234212342223423234242342523426234272342823429234302343123432234332343423435234362343723438234392344023441234422344323444234452344623447234482344923450234512345223453234542345523456234572345823459234602346123462234632346423465234662346723468234692347023471234722347323474234752347623477234782347923480234812348223483234842348523486234872348823489234902349123492234932349423495234962349723498234992350023501235022350323504235052350623507235082350923510235112351223513235142351523516235172351823519235202352123522235232352423525235262352723528235292353023531235322353323534235352353623537235382353923540235412354223543235442354523546235472354823549235502355123552235532355423555235562355723558235592356023561235622356323564235652356623567235682356923570235712357223573235742357523576235772357823579235802358123582235832358423585235862358723588235892359023591235922359323594235952359623597235982359923600236012360223603236042360523606236072360823609236102361123612236132361423615236162361723618236192362023621236222362323624236252362623627236282362923630236312363223633236342363523636236372363823639236402364123642236432364423645236462364723648236492365023651236522365323654236552365623657236582365923660236612366223663236642366523666236672366823669236702367123672236732367423675236762367723678236792368023681236822368323684236852368623687236882368923690236912369223693236942369523696236972369823699237002370123702237032370423705237062370723708237092371023711237122371323714237152371623717237182371923720237212372223723237242372523726237272372823729237302373123732237332373423735237362373723738237392374023741237422374323744237452374623747237482374923750237512375223753237542375523756237572375823759237602376123762237632376423765237662376723768237692377023771237722377323774237752377623777237782377923780237812378223783237842378523786237872378823789237902379123792237932379423795237962379723798237992380023801238022380323804238052380623807238082380923810238112381223813238142381523816238172381823819238202382123822238232382423825238262382723828238292383023831238322383323834238352383623837238382383923840238412384223843238442384523846238472384823849238502385123852238532385423855238562385723858238592386023861238622386323864238652386623867238682386923870238712387223873238742387523876238772387823879238802388123882238832388423885238862388723888238892389023891238922389323894238952389623897238982389923900239012390223903239042390523906239072390823909239102391123912239132391423915239162391723918239192392023921239222392323924239252392623927239282392923930239312393223933239342393523936239372393823939239402394123942239432394423945239462394723948239492395023951239522395323954239552395623957239582395923960239612396223963239642396523966239672396823969239702397123972239732397423975239762397723978239792398023981239822398323984239852398623987239882398923990239912399223993239942399523996239972399823999240002400124002240032400424005240062400724008240092401024011240122401324014240152401624017240182401924020240212402224023240242402524026240272402824029240302403124032240332403424035240362403724038240392404024041240422404324044240452404624047240482404924050240512405224053240542405524056240572405824059240602406124062240632406424065240662406724068240692407024071240722407324074240752407624077240782407924080240812408224083240842408524086240872408824089240902409124092240932409424095240962409724098240992410024101241022410324104241052410624107241082410924110241112411224113241142411524116241172411824119241202412124122241232412424125241262412724128241292413024131241322413324134241352413624137241382413924140241412414224143241442414524146241472414824149241502415124152241532415424155241562415724158241592416024161241622416324164241652416624167241682416924170241712417224173241742417524176241772417824179241802418124182241832418424185241862418724188241892419024191241922419324194241952419624197241982419924200242012420224203242042420524206242072420824209242102421124212242132421424215242162421724218242192422024221242222422324224242252422624227242282422924230242312423224233242342423524236242372423824239242402424124242242432424424245242462424724248242492425024251242522425324254242552425624257242582425924260242612426224263242642426524266242672426824269242702427124272242732427424275242762427724278242792428024281242822428324284242852428624287242882428924290242912429224293242942429524296242972429824299243002430124302243032430424305243062430724308243092431024311243122431324314243152431624317243182431924320243212432224323243242432524326243272432824329243302433124332243332433424335243362433724338243392434024341243422434324344243452434624347243482434924350243512435224353243542435524356243572435824359243602436124362243632436424365243662436724368243692437024371243722437324374243752437624377243782437924380243812438224383243842438524386243872438824389243902439124392243932439424395243962439724398243992440024401244022440324404244052440624407244082440924410244112441224413244142441524416244172441824419244202442124422244232442424425244262442724428244292443024431244322443324434244352443624437244382443924440244412444224443244442444524446244472444824449244502445124452244532445424455244562445724458244592446024461244622446324464244652446624467244682446924470244712447224473244742447524476244772447824479244802448124482244832448424485244862448724488244892449024491244922449324494244952449624497244982449924500245012450224503245042450524506245072450824509245102451124512245132451424515245162451724518245192452024521245222452324524245252452624527245282452924530245312453224533245342453524536245372453824539245402454124542245432454424545245462454724548245492455024551245522455324554245552455624557245582455924560245612456224563245642456524566245672456824569245702457124572245732457424575245762457724578245792458024581245822458324584245852458624587245882458924590245912459224593245942459524596245972459824599246002460124602246032460424605246062460724608246092461024611246122461324614246152461624617246182461924620246212462224623246242462524626246272462824629246302463124632246332463424635246362463724638246392464024641246422464324644246452464624647246482464924650246512465224653246542465524656246572465824659246602466124662246632466424665246662466724668246692467024671246722467324674246752467624677246782467924680246812468224683246842468524686246872468824689246902469124692246932469424695246962469724698246992470024701247022470324704247052470624707247082470924710247112471224713247142471524716247172471824719247202472124722247232472424725247262472724728247292473024731247322473324734247352473624737247382473924740247412474224743247442474524746247472474824749247502475124752247532475424755247562475724758247592476024761247622476324764247652476624767247682476924770247712477224773247742477524776247772477824779247802478124782247832478424785247862478724788247892479024791247922479324794247952479624797247982479924800248012480224803248042480524806248072480824809248102481124812248132481424815248162481724818248192482024821248222482324824248252482624827248282482924830248312483224833248342483524836248372483824839248402484124842248432484424845248462484724848248492485024851248522485324854248552485624857248582485924860248612486224863248642486524866248672486824869248702487124872248732487424875248762487724878248792488024881248822488324884248852488624887248882488924890248912489224893248942489524896248972489824899249002490124902249032490424905249062490724908249092491024911249122491324914249152491624917249182491924920249212492224923249242492524926249272492824929249302493124932249332493424935249362493724938249392494024941249422494324944249452494624947249482494924950249512495224953249542495524956249572495824959249602496124962249632496424965249662496724968249692497024971249722497324974249752497624977249782497924980249812498224983249842498524986249872498824989249902499124992249932499424995249962499724998249992500025001250022500325004250052500625007250082500925010250112501225013250142501525016250172501825019250202502125022250232502425025250262502725028250292503025031250322503325034250352503625037250382503925040250412504225043250442504525046250472504825049250502505125052250532505425055250562505725058250592506025061250622506325064250652506625067250682506925070250712507225073250742507525076250772507825079250802508125082250832508425085250862508725088250892509025091250922509325094250952509625097250982509925100251012510225103251042510525106251072510825109251102511125112251132511425115251162511725118251192512025121251222512325124251252512625127251282512925130251312513225133251342513525136251372513825139251402514125142251432514425145251462514725148251492515025151251522515325154251552515625157251582515925160251612516225163251642516525166251672516825169251702517125172251732517425175251762517725178251792518025181251822518325184251852518625187251882518925190251912519225193251942519525196251972519825199252002520125202252032520425205252062520725208252092521025211252122521325214252152521625217252182521925220252212522225223252242522525226252272522825229252302523125232252332523425235252362523725238252392524025241252422524325244252452524625247252482524925250252512525225253252542525525256252572525825259252602526125262252632526425265252662526725268252692527025271252722527325274252752527625277252782527925280252812528225283252842528525286252872528825289252902529125292252932529425295252962529725298252992530025301253022530325304253052530625307253082530925310253112531225313253142531525316253172531825319253202532125322253232532425325253262532725328253292533025331253322533325334253352533625337253382533925340253412534225343253442534525346253472534825349253502535125352253532535425355253562535725358253592536025361253622536325364253652536625367253682536925370253712537225373253742537525376253772537825379253802538125382253832538425385253862538725388253892539025391253922539325394253952539625397253982539925400254012540225403254042540525406254072540825409254102541125412254132541425415254162541725418254192542025421254222542325424254252542625427254282542925430254312543225433254342543525436254372543825439254402544125442254432544425445254462544725448254492545025451254522545325454254552545625457254582545925460254612546225463254642546525466254672546825469254702547125472254732547425475254762547725478254792548025481254822548325484254852548625487254882548925490254912549225493254942549525496254972549825499255002550125502255032550425505255062550725508255092551025511255122551325514255152551625517255182551925520255212552225523255242552525526255272552825529255302553125532255332553425535255362553725538255392554025541255422554325544255452554625547255482554925550255512555225553255542555525556255572555825559255602556125562255632556425565255662556725568255692557025571255722557325574255752557625577255782557925580255812558225583255842558525586255872558825589255902559125592255932559425595255962559725598255992560025601256022560325604256052560625607256082560925610256112561225613256142561525616256172561825619256202562125622256232562425625256262562725628256292563025631256322563325634256352563625637256382563925640256412564225643256442564525646256472564825649256502565125652256532565425655256562565725658256592566025661256622566325664256652566625667256682566925670256712567225673256742567525676256772567825679256802568125682256832568425685256862568725688256892569025691256922569325694256952569625697256982569925700257012570225703257042570525706257072570825709257102571125712257132571425715257162571725718257192572025721257222572325724257252572625727257282572925730257312573225733257342573525736257372573825739257402574125742257432574425745257462574725748257492575025751257522575325754257552575625757257582575925760257612576225763257642576525766257672576825769257702577125772257732577425775257762577725778257792578025781257822578325784257852578625787257882578925790257912579225793257942579525796257972579825799258002580125802258032580425805258062580725808258092581025811258122581325814258152581625817258182581925820258212582225823258242582525826258272582825829258302583125832258332583425835258362583725838258392584025841258422584325844258452584625847258482584925850258512585225853258542585525856258572585825859258602586125862258632586425865258662586725868258692587025871258722587325874258752587625877258782587925880258812588225883258842588525886258872588825889258902589125892258932589425895258962589725898258992590025901259022590325904259052590625907259082590925910259112591225913259142591525916259172591825919259202592125922259232592425925259262592725928259292593025931259322593325934259352593625937259382593925940259412594225943259442594525946259472594825949259502595125952259532595425955259562595725958259592596025961259622596325964259652596625967259682596925970259712597225973259742597525976259772597825979259802598125982259832598425985259862598725988259892599025991259922599325994259952599625997259982599926000260012600226003260042600526006260072600826009260102601126012260132601426015260162601726018260192602026021260222602326024260252602626027260282602926030260312603226033260342603526036260372603826039260402604126042260432604426045260462604726048260492605026051260522605326054260552605626057260582605926060260612606226063260642606526066260672606826069260702607126072260732607426075260762607726078260792608026081260822608326084260852608626087260882608926090260912609226093260942609526096260972609826099261002610126102261032610426105261062610726108261092611026111261122611326114261152611626117261182611926120261212612226123261242612526126261272612826129261302613126132261332613426135261362613726138261392614026141261422614326144261452614626147261482614926150261512615226153261542615526156261572615826159261602616126162261632616426165261662616726168261692617026171261722617326174261752617626177261782617926180261812618226183261842618526186261872618826189261902619126192261932619426195261962619726198261992620026201262022620326204262052620626207262082620926210262112621226213262142621526216262172621826219262202622126222262232622426225262262622726228262292623026231262322623326234262352623626237262382623926240262412624226243262442624526246262472624826249262502625126252262532625426255262562625726258262592626026261262622626326264262652626626267262682626926270262712627226273262742627526276262772627826279262802628126282262832628426285262862628726288262892629026291262922629326294262952629626297262982629926300263012630226303263042630526306263072630826309263102631126312263132631426315263162631726318263192632026321263222632326324263252632626327263282632926330263312633226333263342633526336263372633826339263402634126342263432634426345263462634726348263492635026351263522635326354263552635626357263582635926360263612636226363263642636526366263672636826369263702637126372263732637426375263762637726378263792638026381263822638326384263852638626387263882638926390263912639226393263942639526396263972639826399264002640126402264032640426405264062640726408264092641026411264122641326414264152641626417264182641926420264212642226423264242642526426264272642826429264302643126432264332643426435264362643726438264392644026441264422644326444264452644626447264482644926450264512645226453264542645526456264572645826459264602646126462264632646426465264662646726468264692647026471264722647326474264752647626477264782647926480264812648226483264842648526486264872648826489264902649126492264932649426495264962649726498264992650026501265022650326504265052650626507265082650926510265112651226513265142651526516265172651826519265202652126522265232652426525265262652726528265292653026531265322653326534265352653626537265382653926540265412654226543265442654526546265472654826549265502655126552265532655426555265562655726558265592656026561265622656326564265652656626567265682656926570265712657226573265742657526576265772657826579265802658126582265832658426585265862658726588265892659026591265922659326594265952659626597265982659926600266012660226603266042660526606266072660826609266102661126612266132661426615266162661726618266192662026621266222662326624266252662626627266282662926630266312663226633266342663526636266372663826639266402664126642266432664426645266462664726648266492665026651266522665326654266552665626657266582665926660266612666226663266642666526666266672666826669266702667126672266732667426675266762667726678266792668026681266822668326684266852668626687266882668926690266912669226693266942669526696266972669826699267002670126702267032670426705267062670726708267092671026711267122671326714267152671626717267182671926720267212672226723267242672526726267272672826729267302673126732267332673426735267362673726738267392674026741267422674326744267452674626747267482674926750267512675226753267542675526756267572675826759267602676126762267632676426765267662676726768267692677026771267722677326774267752677626777267782677926780267812678226783267842678526786267872678826789267902679126792267932679426795267962679726798267992680026801268022680326804268052680626807268082680926810268112681226813268142681526816268172681826819268202682126822268232682426825268262682726828268292683026831268322683326834268352683626837268382683926840268412684226843268442684526846268472684826849268502685126852268532685426855268562685726858268592686026861268622686326864268652686626867268682686926870268712687226873268742687526876268772687826879268802688126882268832688426885268862688726888268892689026891268922689326894268952689626897268982689926900269012690226903269042690526906269072690826909269102691126912269132691426915269162691726918269192692026921269222692326924269252692626927269282692926930269312693226933269342693526936269372693826939269402694126942269432694426945269462694726948269492695026951269522695326954269552695626957269582695926960269612696226963269642696526966269672696826969269702697126972269732697426975269762697726978269792698026981269822698326984269852698626987269882698926990269912699226993269942699526996269972699826999270002700127002270032700427005270062700727008270092701027011270122701327014270152701627017270182701927020270212702227023270242702527026270272702827029270302703127032270332703427035270362703727038270392704027041270422704327044270452704627047270482704927050270512705227053270542705527056270572705827059270602706127062270632706427065270662706727068270692707027071270722707327074270752707627077270782707927080270812708227083270842708527086270872708827089270902709127092270932709427095270962709727098270992710027101271022710327104271052710627107271082710927110271112711227113271142711527116271172711827119271202712127122271232712427125271262712727128271292713027131271322713327134271352713627137271382713927140271412714227143271442714527146271472714827149271502715127152271532715427155271562715727158271592716027161271622716327164271652716627167271682716927170271712717227173271742717527176271772717827179271802718127182271832718427185271862718727188271892719027191271922719327194271952719627197271982719927200272012720227203272042720527206272072720827209272102721127212272132721427215272162721727218272192722027221272222722327224272252722627227272282722927230272312723227233272342723527236272372723827239272402724127242272432724427245272462724727248272492725027251272522725327254272552725627257272582725927260272612726227263272642726527266272672726827269272702727127272272732727427275272762727727278272792728027281272822728327284272852728627287272882728927290272912729227293272942729527296272972729827299273002730127302273032730427305273062730727308273092731027311273122731327314273152731627317273182731927320273212732227323273242732527326273272732827329273302733127332273332733427335273362733727338273392734027341273422734327344273452734627347273482734927350273512735227353273542735527356273572735827359273602736127362273632736427365273662736727368273692737027371273722737327374273752737627377273782737927380273812738227383273842738527386273872738827389273902739127392273932739427395273962739727398273992740027401274022740327404274052740627407274082740927410274112741227413274142741527416274172741827419274202742127422274232742427425274262742727428274292743027431274322743327434274352743627437274382743927440274412744227443274442744527446274472744827449274502745127452274532745427455274562745727458274592746027461274622746327464274652746627467274682746927470274712747227473274742747527476274772747827479274802748127482274832748427485274862748727488274892749027491274922749327494274952749627497274982749927500275012750227503275042750527506275072750827509275102751127512275132751427515275162751727518275192752027521275222752327524275252752627527275282752927530275312753227533275342753527536275372753827539275402754127542275432754427545275462754727548275492755027551275522755327554275552755627557275582755927560275612756227563275642756527566275672756827569275702757127572275732757427575275762757727578275792758027581275822758327584275852758627587275882758927590275912759227593275942759527596275972759827599276002760127602276032760427605276062760727608276092761027611276122761327614276152761627617276182761927620276212762227623276242762527626276272762827629276302763127632276332763427635276362763727638276392764027641276422764327644276452764627647276482764927650276512765227653276542765527656276572765827659276602766127662276632766427665276662766727668276692767027671276722767327674276752767627677276782767927680276812768227683276842768527686276872768827689276902769127692276932769427695276962769727698276992770027701277022770327704277052770627707277082770927710277112771227713277142771527716277172771827719277202772127722277232772427725277262772727728277292773027731277322773327734277352773627737277382773927740277412774227743277442774527746277472774827749277502775127752277532775427755277562775727758277592776027761277622776327764277652776627767277682776927770277712777227773277742777527776277772777827779277802778127782277832778427785277862778727788277892779027791277922779327794277952779627797277982779927800278012780227803278042780527806278072780827809278102781127812278132781427815278162781727818278192782027821278222782327824278252782627827278282782927830278312783227833278342783527836278372783827839278402784127842278432784427845278462784727848278492785027851278522785327854278552785627857278582785927860278612786227863278642786527866278672786827869278702787127872278732787427875278762787727878278792788027881278822788327884278852788627887278882788927890278912789227893278942789527896278972789827899279002790127902279032790427905279062790727908279092791027911279122791327914279152791627917279182791927920279212792227923279242792527926279272792827929279302793127932279332793427935279362793727938279392794027941279422794327944279452794627947279482794927950279512795227953279542795527956279572795827959279602796127962279632796427965279662796727968279692797027971279722797327974279752797627977279782797927980279812798227983279842798527986279872798827989279902799127992279932799427995279962799727998279992800028001280022800328004280052800628007280082800928010280112801228013280142801528016280172801828019280202802128022280232802428025280262802728028280292803028031280322803328034280352803628037280382803928040280412804228043280442804528046280472804828049280502805128052280532805428055280562805728058280592806028061280622806328064280652806628067280682806928070280712807228073280742807528076280772807828079280802808128082280832808428085280862808728088280892809028091280922809328094280952809628097280982809928100281012810228103281042810528106281072810828109281102811128112281132811428115281162811728118281192812028121281222812328124281252812628127281282812928130281312813228133281342813528136281372813828139281402814128142281432814428145281462814728148281492815028151281522815328154281552815628157281582815928160281612816228163281642816528166281672816828169281702817128172281732817428175281762817728178281792818028181281822818328184281852818628187281882818928190281912819228193281942819528196281972819828199282002820128202282032820428205282062820728208282092821028211282122821328214282152821628217282182821928220282212822228223282242822528226282272822828229282302823128232282332823428235282362823728238282392824028241282422824328244282452824628247282482824928250282512825228253282542825528256282572825828259282602826128262282632826428265282662826728268282692827028271282722827328274282752827628277282782827928280282812828228283282842828528286282872828828289282902829128292282932829428295282962829728298282992830028301283022830328304283052830628307283082830928310283112831228313283142831528316283172831828319283202832128322283232832428325283262832728328283292833028331283322833328334283352833628337283382833928340283412834228343283442834528346283472834828349283502835128352283532835428355283562835728358283592836028361283622836328364283652836628367283682836928370283712837228373283742837528376283772837828379283802838128382283832838428385283862838728388283892839028391283922839328394283952839628397283982839928400284012840228403284042840528406284072840828409284102841128412284132841428415284162841728418284192842028421284222842328424284252842628427284282842928430284312843228433284342843528436284372843828439284402844128442284432844428445284462844728448284492845028451284522845328454284552845628457284582845928460284612846228463284642846528466284672846828469284702847128472284732847428475284762847728478284792848028481284822848328484284852848628487284882848928490284912849228493284942849528496284972849828499285002850128502285032850428505285062850728508285092851028511285122851328514285152851628517285182851928520285212852228523285242852528526285272852828529285302853128532285332853428535285362853728538285392854028541285422854328544285452854628547285482854928550285512855228553285542855528556285572855828559285602856128562285632856428565285662856728568285692857028571285722857328574285752857628577285782857928580285812858228583285842858528586285872858828589285902859128592285932859428595285962859728598285992860028601286022860328604286052860628607286082860928610286112861228613286142861528616286172861828619286202862128622286232862428625286262862728628286292863028631286322863328634286352863628637286382863928640286412864228643286442864528646286472864828649286502865128652286532865428655286562865728658286592866028661286622866328664286652866628667286682866928670286712867228673286742867528676286772867828679286802868128682286832868428685286862868728688286892869028691286922869328694286952869628697286982869928700287012870228703287042870528706287072870828709287102871128712287132871428715287162871728718287192872028721287222872328724287252872628727287282872928730287312873228733287342873528736287372873828739287402874128742287432874428745287462874728748287492875028751287522875328754287552875628757287582875928760287612876228763287642876528766287672876828769287702877128772287732877428775287762877728778287792878028781287822878328784287852878628787287882878928790287912879228793287942879528796287972879828799288002880128802288032880428805288062880728808288092881028811288122881328814288152881628817288182881928820288212882228823288242882528826288272882828829288302883128832288332883428835288362883728838288392884028841288422884328844288452884628847288482884928850288512885228853288542885528856288572885828859288602886128862288632886428865288662886728868288692887028871288722887328874288752887628877288782887928880288812888228883288842888528886288872888828889288902889128892288932889428895288962889728898288992890028901289022890328904289052890628907289082890928910289112891228913289142891528916289172891828919289202892128922289232892428925289262892728928289292893028931289322893328934289352893628937289382893928940289412894228943289442894528946289472894828949289502895128952289532895428955289562895728958289592896028961289622896328964289652896628967289682896928970289712897228973289742897528976289772897828979289802898128982289832898428985289862898728988289892899028991289922899328994289952899628997289982899929000290012900229003290042900529006290072900829009290102901129012290132901429015290162901729018290192902029021290222902329024290252902629027290282902929030290312903229033290342903529036290372903829039290402904129042290432904429045290462904729048290492905029051290522905329054290552905629057290582905929060290612906229063290642906529066290672906829069290702907129072290732907429075290762907729078290792908029081290822908329084290852908629087290882908929090290912909229093290942909529096290972909829099291002910129102291032910429105291062910729108291092911029111291122911329114291152911629117291182911929120291212912229123291242912529126291272912829129291302913129132291332913429135291362913729138291392914029141291422914329144291452914629147291482914929150291512915229153291542915529156291572915829159291602916129162291632916429165291662916729168291692917029171291722917329174291752917629177291782917929180291812918229183291842918529186291872918829189291902919129192291932919429195291962919729198291992920029201292022920329204292052920629207292082920929210292112921229213292142921529216292172921829219292202922129222292232922429225292262922729228292292923029231292322923329234292352923629237292382923929240292412924229243292442924529246292472924829249292502925129252292532925429255292562925729258292592926029261292622926329264292652926629267292682926929270292712927229273292742927529276292772927829279292802928129282292832928429285292862928729288292892929029291292922929329294292952929629297292982929929300293012930229303293042930529306293072930829309293102931129312293132931429315293162931729318293192932029321293222932329324293252932629327293282932929330293312933229333293342933529336293372933829339293402934129342293432934429345293462934729348293492935029351293522935329354293552935629357293582935929360293612936229363293642936529366293672936829369293702937129372293732937429375293762937729378293792938029381293822938329384293852938629387293882938929390293912939229393293942939529396293972939829399294002940129402294032940429405294062940729408294092941029411294122941329414294152941629417294182941929420294212942229423294242942529426294272942829429294302943129432294332943429435294362943729438294392944029441294422944329444294452944629447294482944929450294512945229453294542945529456294572945829459294602946129462294632946429465294662946729468294692947029471294722947329474294752947629477294782947929480294812948229483294842948529486294872948829489294902949129492294932949429495294962949729498294992950029501295022950329504295052950629507295082950929510295112951229513295142951529516295172951829519295202952129522295232952429525295262952729528295292953029531295322953329534295352953629537295382953929540295412954229543295442954529546295472954829549295502955129552295532955429555295562955729558295592956029561295622956329564295652956629567295682956929570295712957229573295742957529576295772957829579295802958129582295832958429585295862958729588295892959029591295922959329594295952959629597295982959929600296012960229603296042960529606296072960829609296102961129612296132961429615296162961729618296192962029621296222962329624296252962629627296282962929630296312963229633296342963529636296372963829639296402964129642296432964429645296462964729648296492965029651296522965329654296552965629657296582965929660296612966229663296642966529666296672966829669296702967129672296732967429675296762967729678296792968029681296822968329684296852968629687296882968929690296912969229693296942969529696296972969829699297002970129702297032970429705297062970729708297092971029711297122971329714297152971629717297182971929720297212972229723297242972529726297272972829729297302973129732297332973429735297362973729738297392974029741297422974329744297452974629747297482974929750297512975229753297542975529756297572975829759297602976129762297632976429765297662976729768297692977029771297722977329774297752977629777297782977929780297812978229783297842978529786297872978829789297902979129792297932979429795297962979729798297992980029801298022980329804298052980629807298082980929810298112981229813298142981529816298172981829819298202982129822298232982429825298262982729828298292983029831298322983329834298352983629837298382983929840298412984229843298442984529846298472984829849298502985129852298532985429855298562985729858298592986029861298622986329864298652986629867298682986929870298712987229873298742987529876298772987829879298802988129882298832988429885298862988729888298892989029891298922989329894298952989629897298982989929900299012990229903299042990529906299072990829909299102991129912299132991429915299162991729918299192992029921299222992329924299252992629927299282992929930299312993229933299342993529936299372993829939299402994129942299432994429945299462994729948299492995029951299522995329954299552995629957299582995929960299612996229963299642996529966299672996829969299702997129972299732997429975299762997729978299792998029981299822998329984299852998629987299882998929990299912999229993299942999529996299972999829999300003000130002300033000430005300063000730008300093001030011300123001330014300153001630017300183001930020300213002230023300243002530026300273002830029300303003130032300333003430035300363003730038300393004030041300423004330044300453004630047300483004930050300513005230053300543005530056300573005830059300603006130062300633006430065300663006730068300693007030071300723007330074300753007630077300783007930080300813008230083300843008530086300873008830089300903009130092300933009430095300963009730098300993010030101301023010330104301053010630107301083010930110301113011230113301143011530116301173011830119301203012130122301233012430125301263012730128301293013030131301323013330134301353013630137301383013930140301413014230143301443014530146301473014830149301503015130152301533015430155301563015730158301593016030161301623016330164301653016630167301683016930170301713017230173301743017530176301773017830179301803018130182301833018430185301863018730188301893019030191301923019330194301953019630197301983019930200302013020230203302043020530206302073020830209302103021130212302133021430215302163021730218302193022030221302223022330224302253022630227302283022930230302313023230233302343023530236302373023830239302403024130242302433024430245302463024730248302493025030251302523025330254302553025630257302583025930260302613026230263302643026530266302673026830269302703027130272302733027430275302763027730278302793028030281302823028330284302853028630287302883028930290302913029230293302943029530296302973029830299303003030130302303033030430305303063030730308303093031030311303123031330314303153031630317303183031930320303213032230323303243032530326303273032830329303303033130332303333033430335303363033730338303393034030341303423034330344303453034630347303483034930350303513035230353303543035530356303573035830359303603036130362303633036430365303663036730368303693037030371303723037330374303753037630377303783037930380303813038230383303843038530386303873038830389303903039130392303933039430395303963039730398303993040030401304023040330404304053040630407304083040930410304113041230413304143041530416304173041830419304203042130422304233042430425304263042730428304293043030431304323043330434304353043630437304383043930440304413044230443304443044530446304473044830449304503045130452304533045430455304563045730458304593046030461304623046330464304653046630467304683046930470304713047230473304743047530476304773047830479304803048130482304833048430485304863048730488304893049030491304923049330494304953049630497304983049930500305013050230503305043050530506305073050830509305103051130512305133051430515305163051730518305193052030521305223052330524305253052630527305283052930530305313053230533305343053530536305373053830539305403054130542305433054430545305463054730548305493055030551305523055330554305553055630557305583055930560305613056230563305643056530566305673056830569305703057130572305733057430575305763057730578305793058030581305823058330584305853058630587305883058930590305913059230593305943059530596305973059830599306003060130602306033060430605306063060730608306093061030611306123061330614306153061630617306183061930620306213062230623306243062530626306273062830629306303063130632306333063430635306363063730638306393064030641306423064330644306453064630647306483064930650306513065230653306543065530656306573065830659306603066130662306633066430665306663066730668306693067030671306723067330674306753067630677306783067930680306813068230683306843068530686306873068830689306903069130692306933069430695306963069730698306993070030701307023070330704307053070630707307083070930710307113071230713307143071530716307173071830719307203072130722307233072430725307263072730728307293073030731307323073330734307353073630737307383073930740307413074230743307443074530746307473074830749307503075130752307533075430755307563075730758307593076030761307623076330764307653076630767307683076930770307713077230773307743077530776307773077830779307803078130782307833078430785307863078730788307893079030791307923079330794307953079630797307983079930800308013080230803308043080530806308073080830809308103081130812308133081430815308163081730818308193082030821308223082330824308253082630827308283082930830308313083230833308343083530836308373083830839308403084130842308433084430845308463084730848308493085030851308523085330854308553085630857308583085930860308613086230863308643086530866308673086830869308703087130872308733087430875308763087730878308793088030881308823088330884308853088630887308883088930890308913089230893308943089530896308973089830899309003090130902309033090430905309063090730908309093091030911309123091330914309153091630917309183091930920309213092230923309243092530926309273092830929309303093130932309333093430935309363093730938309393094030941309423094330944309453094630947309483094930950309513095230953309543095530956309573095830959309603096130962309633096430965309663096730968309693097030971309723097330974309753097630977309783097930980309813098230983309843098530986309873098830989309903099130992309933099430995309963099730998309993100031001310023100331004310053100631007310083100931010310113101231013310143101531016310173101831019310203102131022310233102431025310263102731028310293103031031310323103331034310353103631037310383103931040310413104231043310443104531046310473104831049310503105131052310533105431055310563105731058310593106031061310623106331064310653106631067310683106931070310713107231073310743107531076310773107831079310803108131082310833108431085310863108731088310893109031091310923109331094310953109631097310983109931100311013110231103311043110531106311073110831109311103111131112311133111431115311163111731118311193112031121311223112331124311253112631127311283112931130311313113231133311343113531136311373113831139311403114131142311433114431145311463114731148311493115031151311523115331154311553115631157311583115931160311613116231163311643116531166311673116831169311703117131172311733117431175311763117731178311793118031181311823118331184311853118631187311883118931190311913119231193311943119531196311973119831199312003120131202312033120431205312063120731208312093121031211312123121331214312153121631217312183121931220312213122231223312243122531226312273122831229312303123131232312333123431235312363123731238312393124031241312423124331244312453124631247312483124931250312513125231253312543125531256312573125831259312603126131262312633126431265312663126731268312693127031271312723127331274312753127631277312783127931280312813128231283312843128531286312873128831289312903129131292312933129431295312963129731298312993130031301313023130331304313053130631307313083130931310313113131231313313143131531316313173131831319313203132131322313233132431325313263132731328313293133031331313323133331334313353133631337313383133931340313413134231343313443134531346313473134831349313503135131352313533135431355313563135731358313593136031361313623136331364313653136631367313683136931370313713137231373313743137531376313773137831379313803138131382313833138431385313863138731388313893139031391313923139331394313953139631397313983139931400314013140231403314043140531406314073140831409314103141131412314133141431415314163141731418314193142031421314223142331424314253142631427314283142931430314313143231433314343143531436314373143831439314403144131442314433144431445314463144731448314493145031451314523145331454314553145631457314583145931460314613146231463314643146531466314673146831469314703147131472314733147431475314763147731478314793148031481314823148331484314853148631487314883148931490314913149231493314943149531496314973149831499315003150131502315033150431505315063150731508315093151031511315123151331514315153151631517315183151931520315213152231523315243152531526315273152831529315303153131532315333153431535315363153731538315393154031541315423154331544315453154631547315483154931550315513155231553315543155531556315573155831559315603156131562315633156431565315663156731568315693157031571315723157331574315753157631577315783157931580315813158231583315843158531586315873158831589315903159131592315933159431595315963159731598315993160031601316023160331604316053160631607316083160931610316113161231613316143161531616316173161831619316203162131622316233162431625316263162731628316293163031631316323163331634316353163631637316383163931640316413164231643316443164531646316473164831649316503165131652316533165431655316563165731658316593166031661316623166331664316653166631667316683166931670316713167231673316743167531676316773167831679316803168131682316833168431685316863168731688316893169031691316923169331694316953169631697316983169931700317013170231703317043170531706317073170831709317103171131712317133171431715317163171731718317193172031721317223172331724317253172631727317283172931730317313173231733317343173531736317373173831739317403174131742317433174431745317463174731748317493175031751317523175331754317553175631757317583175931760317613176231763317643176531766317673176831769317703177131772317733177431775317763177731778317793178031781317823178331784317853178631787317883178931790317913179231793317943179531796317973179831799318003180131802318033180431805318063180731808318093181031811318123181331814318153181631817318183181931820318213182231823318243182531826318273182831829318303183131832318333183431835318363183731838318393184031841318423184331844318453184631847318483184931850318513185231853318543185531856318573185831859318603186131862318633186431865318663186731868318693187031871318723187331874318753187631877318783187931880318813188231883318843188531886318873188831889318903189131892318933189431895318963189731898318993190031901319023190331904319053190631907319083190931910319113191231913319143191531916319173191831919319203192131922319233192431925319263192731928319293193031931319323193331934319353193631937319383193931940319413194231943319443194531946319473194831949319503195131952319533195431955319563195731958319593196031961319623196331964319653196631967319683196931970319713197231973319743197531976319773197831979319803198131982319833198431985319863198731988319893199031991319923199331994319953199631997319983199932000320013200232003320043200532006320073200832009320103201132012320133201432015320163201732018320193202032021320223202332024320253202632027320283202932030320313203232033320343203532036320373203832039320403204132042320433204432045320463204732048320493205032051320523205332054320553205632057320583205932060320613206232063320643206532066320673206832069320703207132072320733207432075320763207732078320793208032081320823208332084320853208632087320883208932090320913209232093320943209532096320973209832099321003210132102321033210432105321063210732108321093211032111321123211332114321153211632117321183211932120321213212232123321243212532126321273212832129321303213132132321333213432135321363213732138321393214032141321423214332144321453214632147321483214932150321513215232153321543215532156321573215832159321603216132162321633216432165321663216732168321693217032171321723217332174321753217632177321783217932180321813218232183321843218532186321873218832189321903219132192321933219432195321963219732198321993220032201322023220332204322053220632207322083220932210322113221232213322143221532216322173221832219322203222132222322233222432225322263222732228322293223032231322323223332234322353223632237322383223932240322413224232243322443224532246322473224832249322503225132252322533225432255322563225732258322593226032261322623226332264322653226632267322683226932270322713227232273322743227532276322773227832279322803228132282322833228432285322863228732288322893229032291322923229332294322953229632297322983229932300323013230232303323043230532306323073230832309323103231132312323133231432315323163231732318323193232032321323223232332324323253232632327323283232932330323313233232333323343233532336323373233832339323403234132342323433234432345323463234732348323493235032351323523235332354323553235632357323583235932360323613236232363323643236532366323673236832369323703237132372323733237432375323763237732378323793238032381323823238332384323853238632387323883238932390323913239232393323943239532396323973239832399324003240132402324033240432405324063240732408324093241032411324123241332414324153241632417324183241932420324213242232423324243242532426324273242832429324303243132432324333243432435324363243732438324393244032441324423244332444324453244632447324483244932450324513245232453324543245532456324573245832459324603246132462324633246432465324663246732468324693247032471324723247332474324753247632477324783247932480324813248232483324843248532486324873248832489324903249132492324933249432495324963249732498324993250032501325023250332504325053250632507325083250932510325113251232513325143251532516325173251832519325203252132522325233252432525325263252732528325293253032531325323253332534325353253632537325383253932540325413254232543325443254532546325473254832549325503255132552325533255432555325563255732558325593256032561325623256332564325653256632567325683256932570325713257232573325743257532576325773257832579325803258132582325833258432585325863258732588325893259032591325923259332594325953259632597325983259932600326013260232603326043260532606326073260832609326103261132612326133261432615326163261732618326193262032621326223262332624326253262632627326283262932630326313263232633326343263532636326373263832639326403264132642326433264432645326463264732648326493265032651326523265332654326553265632657326583265932660326613266232663326643266532666326673266832669326703267132672326733267432675326763267732678326793268032681326823268332684326853268632687326883268932690326913269232693326943269532696326973269832699327003270132702327033270432705327063270732708327093271032711327123271332714327153271632717327183271932720327213272232723327243272532726327273272832729327303273132732327333273432735327363273732738327393274032741327423274332744327453274632747327483274932750327513275232753327543275532756327573275832759327603276132762327633276432765327663276732768327693277032771327723277332774327753277632777327783277932780327813278232783327843278532786327873278832789327903279132792327933279432795327963279732798327993280032801328023280332804328053280632807328083280932810328113281232813328143281532816328173281832819328203282132822328233282432825328263282732828328293283032831328323283332834328353283632837328383283932840328413284232843328443284532846328473284832849328503285132852328533285432855328563285732858328593286032861328623286332864328653286632867328683286932870328713287232873328743287532876328773287832879328803288132882328833288432885328863288732888328893289032891328923289332894328953289632897328983289932900329013290232903329043290532906329073290832909329103291132912329133291432915329163291732918329193292032921329223292332924329253292632927329283292932930329313293232933329343293532936329373293832939329403294132942329433294432945329463294732948329493295032951329523295332954329553295632957329583295932960329613296232963329643296532966329673296832969329703297132972329733297432975329763297732978329793298032981329823298332984329853298632987329883298932990329913299232993329943299532996329973299832999330003300133002330033300433005330063300733008330093301033011330123301333014330153301633017330183301933020330213302233023330243302533026330273302833029330303303133032330333303433035330363303733038330393304033041330423304333044330453304633047330483304933050330513305233053330543305533056330573305833059330603306133062330633306433065330663306733068330693307033071330723307333074330753307633077330783307933080330813308233083330843308533086330873308833089330903309133092330933309433095330963309733098330993310033101331023310333104331053310633107331083310933110331113311233113331143311533116331173311833119331203312133122331233312433125331263312733128331293313033131331323313333134331353313633137331383313933140331413314233143331443314533146331473314833149331503315133152331533315433155331563315733158331593316033161331623316333164331653316633167331683316933170331713317233173331743317533176331773317833179331803318133182331833318433185331863318733188331893319033191331923319333194331953319633197331983319933200332013320233203332043320533206332073320833209332103321133212332133321433215332163321733218332193322033221332223322333224332253322633227332283322933230332313323233233332343323533236332373323833239332403324133242332433324433245332463324733248332493325033251332523325333254332553325633257332583325933260332613326233263332643326533266332673326833269332703327133272332733327433275332763327733278332793328033281332823328333284332853328633287332883328933290332913329233293332943329533296332973329833299333003330133302333033330433305333063330733308333093331033311333123331333314333153331633317333183331933320333213332233323333243332533326333273332833329333303333133332333333333433335333363333733338333393334033341333423334333344333453334633347333483334933350333513335233353333543335533356333573335833359333603336133362333633336433365333663336733368333693337033371333723337333374333753337633377333783337933380333813338233383333843338533386333873338833389333903339133392333933339433395333963339733398333993340033401334023340333404334053340633407334083340933410334113341233413334143341533416334173341833419334203342133422334233342433425334263342733428334293343033431334323343333434334353343633437334383343933440334413344233443334443344533446334473344833449334503345133452334533345433455334563345733458334593346033461334623346333464334653346633467334683346933470334713347233473334743347533476334773347833479334803348133482334833348433485334863348733488334893349033491334923349333494334953349633497334983349933500335013350233503335043350533506335073350833509335103351133512335133351433515335163351733518335193352033521335223352333524335253352633527335283352933530335313353233533335343353533536335373353833539335403354133542335433354433545335463354733548335493355033551335523355333554335553355633557335583355933560335613356233563335643356533566335673356833569335703357133572335733357433575335763357733578335793358033581335823358333584335853358633587335883358933590335913359233593335943359533596335973359833599336003360133602336033360433605336063360733608336093361033611336123361333614336153361633617336183361933620336213362233623336243362533626336273362833629336303363133632336333363433635336363363733638336393364033641336423364333644336453364633647336483364933650336513365233653336543365533656336573365833659336603366133662336633366433665336663366733668336693367033671336723367333674336753367633677336783367933680336813368233683336843368533686336873368833689336903369133692336933369433695336963369733698336993370033701337023370333704337053370633707337083370933710337113371233713337143371533716337173371833719337203372133722337233372433725337263372733728337293373033731337323373333734337353373633737337383373933740337413374233743337443374533746337473374833749337503375133752337533375433755337563375733758337593376033761337623376333764337653376633767337683376933770337713377233773337743377533776337773377833779337803378133782337833378433785337863378733788337893379033791337923379333794337953379633797337983379933800338013380233803338043380533806338073380833809338103381133812338133381433815338163381733818338193382033821338223382333824338253382633827338283382933830338313383233833338343383533836338373383833839338403384133842338433384433845338463384733848338493385033851338523385333854338553385633857338583385933860338613386233863338643386533866338673386833869338703387133872338733387433875338763387733878338793388033881338823388333884338853388633887338883388933890338913389233893338943389533896338973389833899339003390133902339033390433905339063390733908339093391033911339123391333914339153391633917339183391933920339213392233923339243392533926339273392833929339303393133932339333393433935339363393733938339393394033941339423394333944339453394633947339483394933950339513395233953339543395533956339573395833959339603396133962339633396433965339663396733968339693397033971339723397333974339753397633977339783397933980339813398233983339843398533986339873398833989339903399133992339933399433995339963399733998339993400034001340023400334004340053400634007340083400934010340113401234013340143401534016340173401834019340203402134022340233402434025340263402734028340293403034031340323403334034340353403634037340383403934040340413404234043340443404534046340473404834049340503405134052340533405434055340563405734058340593406034061340623406334064340653406634067340683406934070340713407234073340743407534076340773407834079340803408134082340833408434085340863408734088340893409034091340923409334094340953409634097340983409934100341013410234103341043410534106341073410834109341103411134112341133411434115341163411734118341193412034121341223412334124341253412634127341283412934130341313413234133341343413534136341373413834139341403414134142341433414434145341463414734148341493415034151341523415334154341553415634157341583415934160341613416234163341643416534166341673416834169341703417134172341733417434175341763417734178341793418034181341823418334184341853418634187341883418934190341913419234193341943419534196341973419834199342003420134202342033420434205342063420734208342093421034211342123421334214342153421634217342183421934220342213422234223342243422534226342273422834229342303423134232342333423434235342363423734238342393424034241342423424334244342453424634247342483424934250342513425234253342543425534256342573425834259342603426134262342633426434265342663426734268342693427034271342723427334274342753427634277342783427934280342813428234283342843428534286342873428834289342903429134292342933429434295342963429734298342993430034301343023430334304343053430634307343083430934310343113431234313343143431534316343173431834319343203432134322343233432434325343263432734328343293433034331343323433334334343353433634337343383433934340343413434234343343443434534346343473434834349343503435134352343533435434355343563435734358343593436034361343623436334364343653436634367343683436934370343713437234373343743437534376343773437834379343803438134382343833438434385343863438734388343893439034391343923439334394343953439634397343983439934400344013440234403344043440534406344073440834409344103441134412344133441434415344163441734418344193442034421344223442334424344253442634427344283442934430344313443234433344343443534436344373443834439344403444134442344433444434445344463444734448344493445034451344523445334454344553445634457344583445934460344613446234463344643446534466344673446834469344703447134472344733447434475344763447734478344793448034481344823448334484344853448634487344883448934490344913449234493344943449534496344973449834499345003450134502345033450434505345063450734508345093451034511345123451334514345153451634517345183451934520345213452234523345243452534526345273452834529345303453134532345333453434535345363453734538345393454034541345423454334544345453454634547345483454934550345513455234553345543455534556345573455834559345603456134562345633456434565345663456734568345693457034571345723457334574345753457634577345783457934580345813458234583345843458534586345873458834589345903459134592345933459434595345963459734598345993460034601346023460334604346053460634607346083460934610346113461234613346143461534616346173461834619346203462134622346233462434625346263462734628346293463034631346323463334634346353463634637346383463934640346413464234643346443464534646346473464834649346503465134652346533465434655346563465734658346593466034661346623466334664346653466634667346683466934670346713467234673346743467534676346773467834679346803468134682346833468434685346863468734688346893469034691346923469334694346953469634697346983469934700347013470234703347043470534706347073470834709347103471134712347133471434715347163471734718347193472034721347223472334724347253472634727347283472934730347313473234733347343473534736347373473834739347403474134742347433474434745347463474734748347493475034751347523475334754347553475634757347583475934760347613476234763347643476534766347673476834769347703477134772347733477434775347763477734778347793478034781347823478334784347853478634787347883478934790347913479234793347943479534796347973479834799348003480134802348033480434805348063480734808348093481034811348123481334814348153481634817348183481934820348213482234823348243482534826348273482834829348303483134832348333483434835348363483734838348393484034841348423484334844348453484634847348483484934850348513485234853348543485534856348573485834859348603486134862348633486434865348663486734868348693487034871348723487334874348753487634877348783487934880348813488234883348843488534886348873488834889348903489134892348933489434895348963489734898348993490034901349023490334904349053490634907349083490934910349113491234913349143491534916349173491834919349203492134922349233492434925349263492734928349293493034931349323493334934349353493634937349383493934940349413494234943349443494534946349473494834949349503495134952349533495434955349563495734958349593496034961349623496334964349653496634967349683496934970349713497234973349743497534976349773497834979349803498134982349833498434985349863498734988349893499034991349923499334994349953499634997349983499935000350013500235003350043500535006350073500835009350103501135012350133501435015350163501735018350193502035021350223502335024350253502635027350283502935030350313503235033350343503535036350373503835039350403504135042350433504435045350463504735048350493505035051350523505335054350553505635057350583505935060350613506235063350643506535066350673506835069350703507135072350733507435075350763507735078350793508035081350823508335084350853508635087350883508935090350913509235093350943509535096350973509835099351003510135102351033510435105351063510735108351093511035111351123511335114351153511635117351183511935120351213512235123351243512535126351273512835129351303513135132351333513435135351363513735138351393514035141351423514335144351453514635147351483514935150351513515235153351543515535156351573515835159351603516135162351633516435165351663516735168351693517035171351723517335174351753517635177351783517935180351813518235183351843518535186351873518835189351903519135192351933519435195351963519735198351993520035201352023520335204352053520635207352083520935210352113521235213352143521535216352173521835219352203522135222352233522435225352263522735228352293523035231352323523335234352353523635237352383523935240352413524235243352443524535246352473524835249352503525135252352533525435255352563525735258352593526035261352623526335264352653526635267352683526935270352713527235273352743527535276352773527835279352803528135282352833528435285352863528735288352893529035291352923529335294352953529635297352983529935300353013530235303353043530535306353073530835309353103531135312353133531435315353163531735318353193532035321353223532335324353253532635327353283532935330353313533235333353343533535336353373533835339353403534135342353433534435345353463534735348353493535035351353523535335354353553535635357353583535935360353613536235363353643536535366353673536835369353703537135372353733537435375353763537735378353793538035381353823538335384353853538635387353883538935390353913539235393353943539535396353973539835399354003540135402354033540435405354063540735408354093541035411354123541335414354153541635417354183541935420354213542235423354243542535426354273542835429354303543135432354333543435435354363543735438354393544035441354423544335444354453544635447354483544935450354513545235453354543545535456354573545835459354603546135462354633546435465354663546735468354693547035471354723547335474354753547635477354783547935480354813548235483354843548535486354873548835489354903549135492354933549435495354963549735498354993550035501355023550335504355053550635507355083550935510355113551235513355143551535516355173551835519355203552135522355233552435525355263552735528355293553035531355323553335534355353553635537355383553935540355413554235543355443554535546355473554835549355503555135552355533555435555355563555735558355593556035561355623556335564355653556635567355683556935570355713557235573355743557535576355773557835579355803558135582355833558435585355863558735588355893559035591355923559335594355953559635597355983559935600356013560235603356043560535606356073560835609356103561135612356133561435615356163561735618356193562035621356223562335624356253562635627356283562935630356313563235633356343563535636356373563835639356403564135642356433564435645356463564735648356493565035651356523565335654356553565635657356583565935660356613566235663356643566535666356673566835669356703567135672356733567435675356763567735678356793568035681356823568335684356853568635687356883568935690356913569235693356943569535696356973569835699357003570135702357033570435705357063570735708357093571035711357123571335714357153571635717357183571935720357213572235723357243572535726357273572835729357303573135732357333573435735357363573735738357393574035741357423574335744357453574635747357483574935750357513575235753357543575535756357573575835759357603576135762357633576435765357663576735768357693577035771357723577335774357753577635777357783577935780357813578235783357843578535786357873578835789357903579135792357933579435795357963579735798357993580035801358023580335804358053580635807358083580935810358113581235813358143581535816358173581835819358203582135822358233582435825358263582735828358293583035831358323583335834358353583635837358383583935840358413584235843358443584535846358473584835849358503585135852358533585435855358563585735858358593586035861358623586335864358653586635867358683586935870358713587235873358743587535876358773587835879358803588135882358833588435885358863588735888358893589035891358923589335894358953589635897358983589935900359013590235903359043590535906359073590835909359103591135912359133591435915359163591735918359193592035921359223592335924359253592635927359283592935930359313593235933359343593535936359373593835939359403594135942359433594435945359463594735948359493595035951359523595335954359553595635957359583595935960359613596235963359643596535966359673596835969359703597135972359733597435975359763597735978359793598035981359823598335984359853598635987359883598935990359913599235993359943599535996359973599835999360003600136002360033600436005360063600736008360093601036011360123601336014360153601636017360183601936020360213602236023360243602536026360273602836029360303603136032360333603436035360363603736038360393604036041360423604336044360453604636047360483604936050360513605236053360543605536056360573605836059360603606136062360633606436065360663606736068360693607036071360723607336074360753607636077360783607936080360813608236083360843608536086360873608836089360903609136092360933609436095360963609736098360993610036101361023610336104361053610636107361083610936110361113611236113361143611536116361173611836119361203612136122361233612436125361263612736128361293613036131361323613336134361353613636137361383613936140361413614236143361443614536146361473614836149361503615136152361533615436155361563615736158361593616036161361623616336164361653616636167361683616936170361713617236173361743617536176361773617836179361803618136182361833618436185361863618736188361893619036191361923619336194361953619636197361983619936200362013620236203362043620536206362073620836209362103621136212362133621436215362163621736218362193622036221362223622336224362253622636227362283622936230362313623236233362343623536236362373623836239362403624136242362433624436245362463624736248362493625036251362523625336254362553625636257362583625936260362613626236263362643626536266362673626836269362703627136272362733627436275362763627736278362793628036281362823628336284362853628636287362883628936290362913629236293362943629536296362973629836299363003630136302363033630436305363063630736308363093631036311363123631336314363153631636317363183631936320363213632236323363243632536326363273632836329363303633136332363333633436335363363633736338363393634036341363423634336344363453634636347363483634936350363513635236353363543635536356363573635836359363603636136362363633636436365363663636736368363693637036371363723637336374363753637636377363783637936380363813638236383363843638536386363873638836389363903639136392363933639436395363963639736398363993640036401364023640336404364053640636407364083640936410364113641236413364143641536416364173641836419364203642136422364233642436425364263642736428364293643036431364323643336434364353643636437364383643936440364413644236443364443644536446364473644836449364503645136452364533645436455364563645736458364593646036461364623646336464364653646636467364683646936470364713647236473364743647536476364773647836479364803648136482364833648436485364863648736488364893649036491364923649336494364953649636497364983649936500365013650236503365043650536506365073650836509365103651136512365133651436515365163651736518365193652036521365223652336524365253652636527365283652936530365313653236533365343653536536365373653836539365403654136542365433654436545365463654736548365493655036551365523655336554365553655636557365583655936560365613656236563365643656536566365673656836569365703657136572365733657436575365763657736578365793658036581365823658336584365853658636587365883658936590365913659236593365943659536596365973659836599366003660136602366033660436605366063660736608366093661036611366123661336614366153661636617366183661936620366213662236623366243662536626366273662836629366303663136632366333663436635366363663736638366393664036641366423664336644366453664636647366483664936650366513665236653366543665536656366573665836659366603666136662366633666436665366663666736668366693667036671366723667336674366753667636677366783667936680366813668236683366843668536686366873668836689366903669136692366933669436695366963669736698366993670036701367023670336704367053670636707367083670936710367113671236713367143671536716367173671836719367203672136722367233672436725367263672736728367293673036731367323673336734367353673636737367383673936740367413674236743367443674536746367473674836749367503675136752367533675436755367563675736758367593676036761367623676336764367653676636767367683676936770367713677236773367743677536776367773677836779367803678136782367833678436785367863678736788367893679036791367923679336794367953679636797367983679936800368013680236803368043680536806368073680836809368103681136812368133681436815368163681736818368193682036821368223682336824368253682636827368283682936830368313683236833368343683536836368373683836839368403684136842368433684436845368463684736848368493685036851368523685336854368553685636857368583685936860368613686236863368643686536866368673686836869368703687136872368733687436875368763687736878368793688036881368823688336884368853688636887368883688936890368913689236893368943689536896368973689836899369003690136902369033690436905369063690736908369093691036911369123691336914369153691636917369183691936920369213692236923369243692536926369273692836929369303693136932369333693436935369363693736938369393694036941369423694336944369453694636947369483694936950369513695236953369543695536956369573695836959369603696136962369633696436965369663696736968369693697036971369723697336974369753697636977369783697936980369813698236983369843698536986369873698836989369903699136992369933699436995369963699736998369993700037001370023700337004370053700637007370083700937010370113701237013370143701537016370173701837019370203702137022370233702437025370263702737028370293703037031370323703337034370353703637037370383703937040370413704237043370443704537046370473704837049370503705137052370533705437055370563705737058370593706037061370623706337064370653706637067370683706937070370713707237073370743707537076370773707837079370803708137082370833708437085370863708737088370893709037091370923709337094370953709637097370983709937100371013710237103371043710537106371073710837109371103711137112371133711437115371163711737118371193712037121371223712337124371253712637127371283712937130371313713237133371343713537136371373713837139371403714137142371433714437145371463714737148371493715037151371523715337154371553715637157371583715937160371613716237163371643716537166371673716837169371703717137172371733717437175371763717737178371793718037181371823718337184371853718637187371883718937190371913719237193371943719537196371973719837199372003720137202372033720437205372063720737208372093721037211372123721337214372153721637217372183721937220372213722237223372243722537226372273722837229372303723137232372333723437235372363723737238372393724037241372423724337244372453724637247372483724937250372513725237253372543725537256372573725837259372603726137262372633726437265372663726737268372693727037271372723727337274372753727637277372783727937280372813728237283372843728537286372873728837289372903729137292372933729437295372963729737298372993730037301373023730337304373053730637307373083730937310373113731237313373143731537316373173731837319373203732137322373233732437325373263732737328373293733037331373323733337334373353733637337373383733937340373413734237343373443734537346373473734837349373503735137352373533735437355373563735737358373593736037361373623736337364373653736637367373683736937370373713737237373373743737537376373773737837379373803738137382373833738437385373863738737388373893739037391373923739337394373953739637397373983739937400374013740237403374043740537406374073740837409374103741137412374133741437415374163741737418374193742037421374223742337424374253742637427374283742937430374313743237433374343743537436374373743837439374403744137442374433744437445374463744737448374493745037451374523745337454374553745637457374583745937460374613746237463374643746537466374673746837469374703747137472374733747437475374763747737478374793748037481374823748337484374853748637487374883748937490374913749237493374943749537496374973749837499375003750137502375033750437505375063750737508375093751037511375123751337514375153751637517375183751937520375213752237523375243752537526375273752837529375303753137532375333753437535375363753737538375393754037541375423754337544375453754637547375483754937550375513755237553375543755537556375573755837559375603756137562375633756437565375663756737568375693757037571375723757337574375753757637577375783757937580375813758237583375843758537586375873758837589375903759137592375933759437595375963759737598375993760037601376023760337604376053760637607376083760937610376113761237613376143761537616376173761837619376203762137622376233762437625376263762737628376293763037631376323763337634376353763637637376383763937640376413764237643376443764537646376473764837649376503765137652376533765437655376563765737658376593766037661376623766337664376653766637667376683766937670376713767237673376743767537676376773767837679376803768137682376833768437685376863768737688376893769037691376923769337694376953769637697376983769937700377013770237703377043770537706377073770837709377103771137712377133771437715377163771737718377193772037721377223772337724377253772637727377283772937730377313773237733377343773537736377373773837739377403774137742377433774437745377463774737748377493775037751377523775337754377553775637757377583775937760377613776237763377643776537766377673776837769377703777137772377733777437775377763777737778377793778037781377823778337784377853778637787377883778937790377913779237793377943779537796377973779837799378003780137802378033780437805378063780737808378093781037811378123781337814378153781637817378183781937820378213782237823378243782537826378273782837829378303783137832378333783437835378363783737838378393784037841378423784337844378453784637847378483784937850378513785237853378543785537856378573785837859378603786137862378633786437865378663786737868378693787037871378723787337874378753787637877378783787937880378813788237883378843788537886378873788837889378903789137892378933789437895378963789737898378993790037901379023790337904379053790637907379083790937910379113791237913379143791537916379173791837919379203792137922379233792437925379263792737928379293793037931379323793337934379353793637937379383793937940379413794237943379443794537946379473794837949379503795137952379533795437955379563795737958379593796037961379623796337964379653796637967379683796937970379713797237973379743797537976379773797837979379803798137982379833798437985379863798737988379893799037991379923799337994379953799637997379983799938000380013800238003380043800538006380073800838009380103801138012380133801438015380163801738018380193802038021380223802338024380253802638027380283802938030380313803238033380343803538036380373803838039380403804138042380433804438045380463804738048380493805038051380523805338054380553805638057380583805938060380613806238063380643806538066380673806838069380703807138072380733807438075380763807738078380793808038081380823808338084380853808638087380883808938090380913809238093380943809538096380973809838099381003810138102381033810438105381063810738108381093811038111381123811338114381153811638117381183811938120381213812238123381243812538126381273812838129381303813138132381333813438135381363813738138381393814038141381423814338144381453814638147381483814938150381513815238153381543815538156381573815838159381603816138162381633816438165381663816738168381693817038171381723817338174381753817638177381783817938180381813818238183381843818538186381873818838189381903819138192381933819438195381963819738198381993820038201382023820338204382053820638207382083820938210382113821238213382143821538216382173821838219382203822138222382233822438225382263822738228382293823038231382323823338234382353823638237382383823938240382413824238243382443824538246382473824838249382503825138252382533825438255382563825738258382593826038261382623826338264382653826638267382683826938270382713827238273382743827538276382773827838279382803828138282382833828438285382863828738288382893829038291382923829338294382953829638297382983829938300383013830238303383043830538306383073830838309383103831138312383133831438315383163831738318383193832038321383223832338324383253832638327383283832938330383313833238333383343833538336383373833838339383403834138342383433834438345383463834738348383493835038351383523835338354383553835638357383583835938360383613836238363383643836538366383673836838369383703837138372383733837438375383763837738378383793838038381383823838338384383853838638387383883838938390383913839238393383943839538396383973839838399384003840138402384033840438405384063840738408384093841038411384123841338414384153841638417384183841938420384213842238423384243842538426384273842838429384303843138432384333843438435384363843738438384393844038441384423844338444384453844638447384483844938450384513845238453384543845538456384573845838459384603846138462384633846438465384663846738468384693847038471384723847338474384753847638477384783847938480384813848238483384843848538486384873848838489384903849138492384933849438495384963849738498384993850038501385023850338504385053850638507385083850938510385113851238513385143851538516385173851838519385203852138522385233852438525385263852738528385293853038531385323853338534385353853638537385383853938540385413854238543385443854538546385473854838549385503855138552385533855438555385563855738558385593856038561385623856338564385653856638567385683856938570385713857238573385743857538576385773857838579385803858138582385833858438585385863858738588385893859038591385923859338594385953859638597385983859938600386013860238603386043860538606386073860838609386103861138612386133861438615386163861738618386193862038621386223862338624386253862638627386283862938630386313863238633386343863538636386373863838639386403864138642386433864438645386463864738648386493865038651386523865338654386553865638657386583865938660386613866238663386643866538666386673866838669386703867138672386733867438675386763867738678386793868038681386823868338684386853868638687386883868938690386913869238693386943869538696386973869838699387003870138702387033870438705387063870738708387093871038711387123871338714387153871638717387183871938720387213872238723387243872538726387273872838729387303873138732387333873438735387363873738738387393874038741387423874338744387453874638747387483874938750387513875238753387543875538756387573875838759387603876138762387633876438765387663876738768387693877038771387723877338774387753877638777387783877938780387813878238783387843878538786387873878838789387903879138792387933879438795387963879738798387993880038801388023880338804388053880638807388083880938810388113881238813388143881538816388173881838819388203882138822388233882438825388263882738828388293883038831388323883338834388353883638837388383883938840388413884238843388443884538846388473884838849388503885138852388533885438855388563885738858388593886038861388623886338864388653886638867388683886938870388713887238873388743887538876388773887838879388803888138882388833888438885388863888738888388893889038891388923889338894388953889638897388983889938900389013890238903389043890538906389073890838909389103891138912389133891438915389163891738918389193892038921389223892338924389253892638927389283892938930389313893238933389343893538936389373893838939389403894138942389433894438945389463894738948389493895038951389523895338954389553895638957389583895938960389613896238963389643896538966389673896838969389703897138972389733897438975389763897738978389793898038981389823898338984389853898638987389883898938990389913899238993389943899538996389973899838999390003900139002390033900439005390063900739008390093901039011390123901339014390153901639017390183901939020390213902239023390243902539026390273902839029390303903139032390333903439035390363903739038390393904039041390423904339044390453904639047390483904939050390513905239053390543905539056390573905839059390603906139062390633906439065390663906739068390693907039071390723907339074390753907639077390783907939080390813908239083390843908539086390873908839089390903909139092390933909439095390963909739098390993910039101391023910339104391053910639107391083910939110391113911239113391143911539116391173911839119391203912139122391233912439125391263912739128391293913039131391323913339134391353913639137391383913939140391413914239143391443914539146391473914839149391503915139152391533915439155391563915739158391593916039161391623916339164391653916639167391683916939170391713917239173391743917539176391773917839179391803918139182391833918439185391863918739188391893919039191391923919339194391953919639197391983919939200392013920239203392043920539206392073920839209392103921139212392133921439215392163921739218392193922039221392223922339224392253922639227392283922939230392313923239233392343923539236392373923839239392403924139242392433924439245392463924739248392493925039251392523925339254392553925639257392583925939260392613926239263392643926539266392673926839269392703927139272392733927439275392763927739278392793928039281392823928339284392853928639287392883928939290392913929239293392943929539296392973929839299393003930139302393033930439305393063930739308393093931039311393123931339314393153931639317393183931939320393213932239323393243932539326393273932839329393303933139332393333933439335393363933739338393393934039341393423934339344393453934639347393483934939350393513935239353393543935539356393573935839359393603936139362393633936439365393663936739368393693937039371393723937339374393753937639377393783937939380393813938239383393843938539386393873938839389393903939139392393933939439395393963939739398393993940039401394023940339404394053940639407394083940939410394113941239413394143941539416394173941839419394203942139422394233942439425394263942739428394293943039431394323943339434394353943639437394383943939440394413944239443394443944539446394473944839449394503945139452394533945439455394563945739458394593946039461394623946339464394653946639467394683946939470394713947239473394743947539476394773947839479394803948139482394833948439485394863948739488394893949039491394923949339494394953949639497394983949939500395013950239503395043950539506395073950839509395103951139512395133951439515395163951739518395193952039521395223952339524395253952639527395283952939530395313953239533395343953539536395373953839539395403954139542395433954439545395463954739548395493955039551395523955339554395553955639557395583955939560395613956239563395643956539566395673956839569395703957139572395733957439575395763957739578395793958039581395823958339584395853958639587395883958939590395913959239593395943959539596395973959839599396003960139602396033960439605396063960739608396093961039611396123961339614396153961639617396183961939620396213962239623396243962539626396273962839629396303963139632396333963439635396363963739638396393964039641396423964339644396453964639647396483964939650396513965239653396543965539656396573965839659396603966139662396633966439665396663966739668396693967039671396723967339674396753967639677396783967939680396813968239683396843968539686396873968839689396903969139692396933969439695396963969739698396993970039701397023970339704397053970639707397083970939710397113971239713397143971539716397173971839719397203972139722397233972439725397263972739728397293973039731397323973339734397353973639737397383973939740397413974239743397443974539746397473974839749397503975139752397533975439755397563975739758397593976039761397623976339764397653976639767397683976939770397713977239773397743977539776397773977839779397803978139782397833978439785397863978739788397893979039791397923979339794397953979639797397983979939800398013980239803398043980539806398073980839809398103981139812398133981439815398163981739818398193982039821398223982339824398253982639827398283982939830398313983239833398343983539836398373983839839398403984139842398433984439845398463984739848398493985039851398523985339854398553985639857398583985939860398613986239863398643986539866398673986839869398703987139872398733987439875398763987739878398793988039881398823988339884398853988639887398883988939890398913989239893398943989539896398973989839899399003990139902399033990439905399063990739908399093991039911399123991339914399153991639917399183991939920399213992239923399243992539926399273992839929399303993139932399333993439935399363993739938399393994039941399423994339944399453994639947399483994939950399513995239953399543995539956399573995839959399603996139962399633996439965399663996739968399693997039971399723997339974399753997639977399783997939980399813998239983399843998539986399873998839989399903999139992399933999439995399963999739998399994000040001400024000340004400054000640007400084000940010400114001240013400144001540016400174001840019400204002140022400234002440025400264002740028400294003040031400324003340034400354003640037400384003940040400414004240043400444004540046400474004840049400504005140052400534005440055400564005740058400594006040061400624006340064400654006640067400684006940070400714007240073400744007540076400774007840079400804008140082400834008440085400864008740088400894009040091400924009340094400954009640097400984009940100401014010240103401044010540106401074010840109401104011140112401134011440115401164011740118401194012040121401224012340124401254012640127401284012940130401314013240133401344013540136401374013840139401404014140142401434014440145401464014740148401494015040151401524015340154401554015640157401584015940160401614016240163401644016540166401674016840169401704017140172401734017440175401764017740178401794018040181401824018340184401854018640187401884018940190401914019240193401944019540196401974019840199402004020140202402034020440205402064020740208402094021040211402124021340214402154021640217402184021940220402214022240223402244022540226402274022840229402304023140232402334023440235402364023740238402394024040241402424024340244402454024640247402484024940250402514025240253402544025540256402574025840259402604026140262402634026440265402664026740268402694027040271402724027340274402754027640277402784027940280402814028240283402844028540286402874028840289402904029140292402934029440295402964029740298402994030040301403024030340304403054030640307403084030940310403114031240313403144031540316403174031840319403204032140322403234032440325403264032740328403294033040331403324033340334403354033640337403384033940340403414034240343403444034540346403474034840349403504035140352403534035440355403564035740358403594036040361403624036340364403654036640367403684036940370403714037240373403744037540376403774037840379403804038140382403834038440385403864038740388403894039040391403924039340394403954039640397403984039940400404014040240403404044040540406404074040840409404104041140412404134041440415404164041740418404194042040421404224042340424404254042640427404284042940430404314043240433404344043540436404374043840439404404044140442404434044440445404464044740448404494045040451404524045340454404554045640457404584045940460404614046240463404644046540466404674046840469404704047140472404734047440475404764047740478404794048040481404824048340484404854048640487404884048940490404914049240493404944049540496404974049840499405004050140502405034050440505405064050740508405094051040511405124051340514405154051640517405184051940520405214052240523405244052540526405274052840529405304053140532405334053440535405364053740538405394054040541405424054340544405454054640547405484054940550405514055240553405544055540556405574055840559405604056140562405634056440565405664056740568405694057040571405724057340574405754057640577405784057940580405814058240583405844058540586405874058840589405904059140592405934059440595405964059740598405994060040601406024060340604406054060640607406084060940610406114061240613406144061540616406174061840619406204062140622406234062440625406264062740628406294063040631406324063340634406354063640637406384063940640406414064240643406444064540646406474064840649406504065140652406534065440655406564065740658406594066040661406624066340664406654066640667406684066940670406714067240673406744067540676406774067840679406804068140682406834068440685406864068740688406894069040691406924069340694406954069640697406984069940700407014070240703407044070540706407074070840709407104071140712407134071440715407164071740718407194072040721407224072340724407254072640727407284072940730407314073240733407344073540736407374073840739407404074140742407434074440745407464074740748407494075040751407524075340754407554075640757407584075940760407614076240763407644076540766407674076840769407704077140772407734077440775407764077740778407794078040781407824078340784407854078640787407884078940790407914079240793407944079540796407974079840799408004080140802408034080440805408064080740808408094081040811408124081340814408154081640817408184081940820408214082240823408244082540826408274082840829408304083140832408334083440835408364083740838408394084040841408424084340844408454084640847408484084940850408514085240853408544085540856408574085840859408604086140862408634086440865408664086740868408694087040871408724087340874408754087640877408784087940880408814088240883408844088540886408874088840889408904089140892408934089440895408964089740898408994090040901409024090340904409054090640907409084090940910409114091240913409144091540916409174091840919409204092140922409234092440925409264092740928409294093040931409324093340934409354093640937409384093940940409414094240943409444094540946409474094840949409504095140952409534095440955409564095740958409594096040961409624096340964409654096640967409684096940970409714097240973409744097540976409774097840979409804098140982409834098440985409864098740988409894099040991409924099340994409954099640997409984099941000410014100241003410044100541006410074100841009410104101141012410134101441015410164101741018410194102041021410224102341024410254102641027410284102941030410314103241033410344103541036410374103841039410404104141042410434104441045410464104741048410494105041051410524105341054410554105641057410584105941060410614106241063410644106541066410674106841069410704107141072410734107441075410764107741078410794108041081410824108341084410854108641087410884108941090410914109241093410944109541096410974109841099411004110141102411034110441105411064110741108411094111041111411124111341114411154111641117411184111941120411214112241123411244112541126411274112841129411304113141132411334113441135411364113741138411394114041141411424114341144411454114641147411484114941150411514115241153411544115541156411574115841159411604116141162411634116441165411664116741168411694117041171411724117341174411754117641177411784117941180411814118241183411844118541186411874118841189411904119141192411934119441195411964119741198411994120041201412024120341204412054120641207412084120941210412114121241213412144121541216412174121841219412204122141222412234122441225412264122741228412294123041231412324123341234412354123641237412384123941240412414124241243412444124541246412474124841249412504125141252412534125441255412564125741258412594126041261412624126341264412654126641267412684126941270412714127241273412744127541276412774127841279412804128141282412834128441285412864128741288412894129041291412924129341294412954129641297412984129941300413014130241303413044130541306413074130841309413104131141312413134131441315413164131741318413194132041321413224132341324413254132641327413284132941330413314133241333413344133541336413374133841339413404134141342413434134441345413464134741348413494135041351413524135341354413554135641357413584135941360413614136241363413644136541366413674136841369413704137141372413734137441375413764137741378413794138041381413824138341384413854138641387413884138941390413914139241393413944139541396413974139841399414004140141402414034140441405414064140741408414094141041411414124141341414414154141641417414184141941420414214142241423414244142541426414274142841429414304143141432414334143441435414364143741438414394144041441414424144341444414454144641447414484144941450414514145241453414544145541456414574145841459414604146141462414634146441465414664146741468414694147041471414724147341474414754147641477414784147941480414814148241483414844148541486414874148841489414904149141492414934149441495414964149741498414994150041501415024150341504415054150641507415084150941510415114151241513415144151541516415174151841519415204152141522415234152441525415264152741528415294153041531415324153341534415354153641537415384153941540415414154241543415444154541546415474154841549415504155141552415534155441555415564155741558415594156041561415624156341564415654156641567415684156941570415714157241573415744157541576415774157841579415804158141582415834158441585415864158741588415894159041591415924159341594415954159641597415984159941600416014160241603416044160541606416074160841609416104161141612416134161441615416164161741618416194162041621416224162341624416254162641627416284162941630416314163241633416344163541636416374163841639416404164141642416434164441645416464164741648416494165041651416524165341654416554165641657416584165941660416614166241663416644166541666416674166841669416704167141672416734167441675416764167741678416794168041681416824168341684416854168641687416884168941690416914169241693416944169541696416974169841699417004170141702417034170441705417064170741708417094171041711417124171341714417154171641717417184171941720417214172241723417244172541726417274172841729417304173141732417334173441735417364173741738417394174041741417424174341744417454174641747417484174941750417514175241753417544175541756417574175841759417604176141762417634176441765417664176741768417694177041771417724177341774417754177641777417784177941780417814178241783417844178541786417874178841789417904179141792417934179441795417964179741798417994180041801418024180341804418054180641807418084180941810418114181241813418144181541816418174181841819418204182141822418234182441825418264182741828418294183041831418324183341834418354183641837418384183941840418414184241843418444184541846418474184841849418504185141852418534185441855418564185741858418594186041861418624186341864418654186641867418684186941870418714187241873418744187541876418774187841879418804188141882418834188441885418864188741888418894189041891418924189341894418954189641897418984189941900419014190241903419044190541906419074190841909419104191141912419134191441915419164191741918419194192041921419224192341924419254192641927419284192941930419314193241933419344193541936419374193841939419404194141942419434194441945419464194741948419494195041951419524195341954419554195641957419584195941960419614196241963419644196541966419674196841969419704197141972419734197441975419764197741978419794198041981419824198341984419854198641987419884198941990419914199241993419944199541996419974199841999420004200142002420034200442005420064200742008420094201042011420124201342014420154201642017420184201942020420214202242023420244202542026420274202842029420304203142032420334203442035420364203742038420394204042041420424204342044420454204642047420484204942050420514205242053420544205542056420574205842059420604206142062420634206442065420664206742068420694207042071420724207342074420754207642077420784207942080420814208242083420844208542086420874208842089420904209142092420934209442095420964209742098420994210042101421024210342104421054210642107421084210942110421114211242113421144211542116421174211842119421204212142122421234212442125421264212742128421294213042131421324213342134421354213642137421384213942140421414214242143421444214542146421474214842149421504215142152421534215442155421564215742158421594216042161421624216342164421654216642167421684216942170421714217242173421744217542176421774217842179421804218142182421834218442185421864218742188421894219042191421924219342194421954219642197421984219942200422014220242203422044220542206422074220842209422104221142212422134221442215422164221742218422194222042221422224222342224422254222642227422284222942230422314223242233422344223542236422374223842239422404224142242422434224442245422464224742248422494225042251422524225342254422554225642257422584225942260422614226242263422644226542266422674226842269422704227142272422734227442275422764227742278422794228042281422824228342284422854228642287422884228942290422914229242293422944229542296422974229842299423004230142302423034230442305423064230742308423094231042311423124231342314423154231642317423184231942320423214232242323423244232542326423274232842329423304233142332423334233442335423364233742338423394234042341423424234342344423454234642347423484234942350423514235242353423544235542356423574235842359423604236142362423634236442365423664236742368423694237042371423724237342374423754237642377423784237942380423814238242383423844238542386423874238842389423904239142392423934239442395423964239742398423994240042401424024240342404424054240642407424084240942410424114241242413424144241542416424174241842419424204242142422424234242442425424264242742428424294243042431424324243342434424354243642437424384243942440424414244242443424444244542446424474244842449424504245142452424534245442455424564245742458424594246042461424624246342464424654246642467424684246942470424714247242473424744247542476424774247842479424804248142482424834248442485424864248742488424894249042491424924249342494424954249642497424984249942500425014250242503425044250542506425074250842509425104251142512425134251442515425164251742518425194252042521425224252342524425254252642527425284252942530425314253242533425344253542536425374253842539425404254142542425434254442545425464254742548425494255042551425524255342554425554255642557425584255942560425614256242563425644256542566425674256842569425704257142572425734257442575425764257742578425794258042581425824258342584425854258642587425884258942590425914259242593425944259542596425974259842599426004260142602426034260442605426064260742608426094261042611426124261342614426154261642617426184261942620426214262242623426244262542626426274262842629426304263142632426334263442635426364263742638426394264042641426424264342644426454264642647426484264942650426514265242653426544265542656426574265842659426604266142662426634266442665426664266742668426694267042671426724267342674426754267642677426784267942680426814268242683426844268542686426874268842689426904269142692426934269442695426964269742698426994270042701427024270342704427054270642707427084270942710427114271242713427144271542716427174271842719427204272142722427234272442725427264272742728427294273042731427324273342734427354273642737427384273942740427414274242743427444274542746427474274842749427504275142752427534275442755427564275742758427594276042761427624276342764427654276642767427684276942770427714277242773427744277542776427774277842779427804278142782427834278442785427864278742788427894279042791427924279342794427954279642797427984279942800428014280242803428044280542806428074280842809428104281142812428134281442815428164281742818428194282042821428224282342824428254282642827428284282942830428314283242833428344283542836428374283842839428404284142842428434284442845428464284742848428494285042851428524285342854428554285642857428584285942860428614286242863428644286542866428674286842869428704287142872428734287442875428764287742878428794288042881428824288342884428854288642887428884288942890428914289242893428944289542896428974289842899429004290142902429034290442905429064290742908429094291042911429124291342914429154291642917429184291942920429214292242923429244292542926429274292842929429304293142932429334293442935429364293742938429394294042941429424294342944429454294642947429484294942950429514295242953429544295542956429574295842959429604296142962429634296442965429664296742968429694297042971429724297342974429754297642977429784297942980429814298242983429844298542986429874298842989429904299142992429934299442995429964299742998429994300043001430024300343004430054300643007430084300943010430114301243013430144301543016430174301843019430204302143022430234302443025430264302743028430294303043031430324303343034430354303643037430384303943040430414304243043430444304543046430474304843049430504305143052430534305443055430564305743058430594306043061430624306343064430654306643067430684306943070430714307243073430744307543076430774307843079430804308143082430834308443085430864308743088430894309043091430924309343094430954309643097430984309943100431014310243103431044310543106431074310843109431104311143112431134311443115431164311743118431194312043121431224312343124431254312643127431284312943130431314313243133431344313543136431374313843139431404314143142431434314443145431464314743148431494315043151431524315343154431554315643157431584315943160431614316243163431644316543166431674316843169431704317143172431734317443175431764317743178431794318043181431824318343184431854318643187431884318943190431914319243193431944319543196431974319843199432004320143202432034320443205432064320743208432094321043211432124321343214432154321643217432184321943220432214322243223432244322543226432274322843229432304323143232432334323443235432364323743238432394324043241432424324343244432454324643247432484324943250432514325243253432544325543256432574325843259432604326143262432634326443265432664326743268432694327043271432724327343274432754327643277432784327943280432814328243283432844328543286432874328843289432904329143292432934329443295432964329743298432994330043301433024330343304433054330643307433084330943310433114331243313433144331543316433174331843319433204332143322433234332443325433264332743328433294333043331433324333343334433354333643337433384333943340433414334243343433444334543346433474334843349433504335143352433534335443355433564335743358433594336043361433624336343364433654336643367433684336943370433714337243373433744337543376433774337843379433804338143382433834338443385433864338743388433894339043391433924339343394433954339643397433984339943400434014340243403434044340543406434074340843409434104341143412434134341443415434164341743418434194342043421434224342343424434254342643427434284342943430434314343243433434344343543436434374343843439434404344143442434434344443445434464344743448434494345043451434524345343454434554345643457434584345943460434614346243463434644346543466434674346843469434704347143472434734347443475434764347743478434794348043481434824348343484434854348643487434884348943490434914349243493434944349543496434974349843499435004350143502435034350443505435064350743508435094351043511435124351343514435154351643517435184351943520435214352243523435244352543526435274352843529435304353143532435334353443535435364353743538435394354043541435424354343544435454354643547435484354943550435514355243553435544355543556435574355843559435604356143562435634356443565435664356743568435694357043571435724357343574435754357643577435784357943580435814358243583435844358543586435874358843589435904359143592435934359443595435964359743598435994360043601436024360343604436054360643607436084360943610436114361243613436144361543616436174361843619436204362143622436234362443625436264362743628436294363043631436324363343634436354363643637436384363943640436414364243643436444364543646436474364843649436504365143652436534365443655436564365743658436594366043661436624366343664436654366643667436684366943670436714367243673436744367543676436774367843679436804368143682436834368443685436864368743688436894369043691436924369343694436954369643697436984369943700437014370243703437044370543706437074370843709437104371143712437134371443715437164371743718437194372043721437224372343724437254372643727437284372943730437314373243733437344373543736437374373843739437404374143742437434374443745437464374743748437494375043751437524375343754437554375643757437584375943760437614376243763437644376543766437674376843769437704377143772437734377443775437764377743778437794378043781437824378343784437854378643787437884378943790437914379243793437944379543796437974379843799438004380143802438034380443805438064380743808438094381043811438124381343814438154381643817438184381943820438214382243823438244382543826438274382843829438304383143832438334383443835438364383743838438394384043841438424384343844438454384643847438484384943850438514385243853438544385543856438574385843859438604386143862438634386443865438664386743868438694387043871438724387343874438754387643877438784387943880438814388243883438844388543886438874388843889438904389143892438934389443895438964389743898438994390043901439024390343904439054390643907439084390943910439114391243913439144391543916439174391843919439204392143922439234392443925439264392743928439294393043931439324393343934439354393643937439384393943940439414394243943439444394543946439474394843949439504395143952439534395443955439564395743958439594396043961439624396343964439654396643967439684396943970439714397243973439744397543976439774397843979439804398143982439834398443985439864398743988439894399043991439924399343994439954399643997439984399944000440014400244003440044400544006440074400844009440104401144012440134401444015440164401744018440194402044021440224402344024440254402644027440284402944030440314403244033440344403544036440374403844039440404404144042440434404444045440464404744048440494405044051440524405344054440554405644057440584405944060440614406244063440644406544066440674406844069440704407144072440734407444075440764407744078440794408044081440824408344084440854408644087440884408944090440914409244093440944409544096440974409844099441004410144102441034410444105441064410744108441094411044111441124411344114441154411644117441184411944120441214412244123441244412544126441274412844129441304413144132441334413444135441364413744138441394414044141441424414344144441454414644147441484414944150441514415244153441544415544156441574415844159441604416144162441634416444165441664416744168441694417044171441724417344174441754417644177441784417944180441814418244183441844418544186441874418844189441904419144192441934419444195441964419744198441994420044201442024420344204442054420644207442084420944210442114421244213442144421544216442174421844219442204422144222442234422444225442264422744228442294423044231442324423344234442354423644237442384423944240442414424244243442444424544246442474424844249442504425144252442534425444255442564425744258442594426044261442624426344264442654426644267442684426944270442714427244273442744427544276442774427844279442804428144282442834428444285442864428744288442894429044291442924429344294442954429644297442984429944300443014430244303443044430544306443074430844309443104431144312443134431444315443164431744318443194432044321443224432344324443254432644327443284432944330443314433244333443344433544336443374433844339443404434144342443434434444345443464434744348443494435044351443524435344354443554435644357443584435944360443614436244363443644436544366443674436844369443704437144372443734437444375443764437744378443794438044381443824438344384443854438644387443884438944390443914439244393443944439544396443974439844399444004440144402444034440444405444064440744408444094441044411444124441344414444154441644417444184441944420444214442244423444244442544426444274442844429444304443144432444334443444435444364443744438444394444044441444424444344444444454444644447444484444944450444514445244453444544445544456444574445844459444604446144462444634446444465444664446744468444694447044471444724447344474444754447644477444784447944480444814448244483444844448544486444874448844489444904449144492444934449444495444964449744498444994450044501445024450344504445054450644507445084450944510445114451244513445144451544516445174451844519445204452144522445234452444525445264452744528445294453044531445324453344534445354453644537445384453944540445414454244543445444454544546445474454844549445504455144552445534455444555445564455744558445594456044561445624456344564445654456644567445684456944570445714457244573445744457544576445774457844579445804458144582445834458444585445864458744588445894459044591445924459344594445954459644597445984459944600446014460244603446044460544606446074460844609446104461144612446134461444615446164461744618446194462044621446224462344624446254462644627446284462944630446314463244633446344463544636446374463844639446404464144642446434464444645446464464744648446494465044651446524465344654446554465644657446584465944660446614466244663446644466544666446674466844669446704467144672446734467444675446764467744678446794468044681446824468344684446854468644687446884468944690446914469244693446944469544696446974469844699447004470144702447034470444705447064470744708447094471044711447124471344714447154471644717447184471944720447214472244723447244472544726447274472844729447304473144732447334473444735447364473744738447394474044741447424474344744447454474644747447484474944750447514475244753447544475544756447574475844759447604476144762447634476444765447664476744768447694477044771447724477344774447754477644777447784477944780447814478244783447844478544786447874478844789447904479144792447934479444795447964479744798447994480044801448024480344804448054480644807448084480944810448114481244813448144481544816448174481844819448204482144822448234482444825448264482744828448294483044831448324483344834448354483644837448384483944840448414484244843448444484544846448474484844849448504485144852448534485444855448564485744858448594486044861448624486344864448654486644867448684486944870448714487244873448744487544876448774487844879448804488144882448834488444885448864488744888448894489044891448924489344894448954489644897448984489944900449014490244903449044490544906449074490844909449104491144912449134491444915449164491744918449194492044921449224492344924449254492644927449284492944930449314493244933449344493544936449374493844939449404494144942449434494444945449464494744948449494495044951449524495344954449554495644957449584495944960449614496244963449644496544966449674496844969449704497144972449734497444975449764497744978449794498044981449824498344984449854498644987449884498944990449914499244993449944499544996449974499844999450004500145002450034500445005450064500745008450094501045011450124501345014450154501645017450184501945020450214502245023450244502545026450274502845029450304503145032450334503445035450364503745038450394504045041450424504345044450454504645047450484504945050450514505245053450544505545056450574505845059450604506145062450634506445065450664506745068450694507045071450724507345074450754507645077450784507945080450814508245083450844508545086450874508845089450904509145092450934509445095450964509745098450994510045101451024510345104451054510645107451084510945110451114511245113451144511545116451174511845119451204512145122451234512445125451264512745128451294513045131451324513345134451354513645137451384513945140451414514245143451444514545146451474514845149451504515145152451534515445155451564515745158451594516045161451624516345164451654516645167451684516945170451714517245173451744517545176451774517845179451804518145182451834518445185451864518745188451894519045191451924519345194451954519645197451984519945200452014520245203452044520545206452074520845209452104521145212452134521445215452164521745218452194522045221452224522345224452254522645227452284522945230452314523245233452344523545236452374523845239452404524145242452434524445245452464524745248452494525045251452524525345254452554525645257452584525945260452614526245263452644526545266452674526845269452704527145272452734527445275452764527745278452794528045281452824528345284452854528645287452884528945290452914529245293452944529545296452974529845299453004530145302453034530445305453064530745308453094531045311453124531345314453154531645317453184531945320453214532245323453244532545326453274532845329453304533145332453334533445335453364533745338453394534045341453424534345344453454534645347453484534945350453514535245353453544535545356453574535845359453604536145362453634536445365453664536745368453694537045371453724537345374453754537645377453784537945380453814538245383453844538545386453874538845389453904539145392453934539445395453964539745398453994540045401454024540345404454054540645407454084540945410454114541245413454144541545416454174541845419454204542145422454234542445425454264542745428454294543045431454324543345434454354543645437454384543945440454414544245443454444544545446454474544845449454504545145452454534545445455454564545745458454594546045461454624546345464454654546645467454684546945470454714547245473454744547545476454774547845479454804548145482454834548445485454864548745488454894549045491454924549345494454954549645497454984549945500455014550245503455044550545506455074550845509455104551145512455134551445515455164551745518455194552045521455224552345524455254552645527455284552945530455314553245533455344553545536455374553845539455404554145542455434554445545455464554745548455494555045551455524555345554455554555645557455584555945560455614556245563455644556545566455674556845569455704557145572455734557445575455764557745578455794558045581455824558345584455854558645587455884558945590455914559245593455944559545596455974559845599456004560145602456034560445605456064560745608456094561045611456124561345614456154561645617456184561945620456214562245623456244562545626456274562845629456304563145632456334563445635456364563745638456394564045641456424564345644456454564645647456484564945650456514565245653456544565545656456574565845659456604566145662456634566445665456664566745668456694567045671456724567345674456754567645677456784567945680456814568245683456844568545686456874568845689456904569145692456934569445695456964569745698456994570045701457024570345704457054570645707457084570945710457114571245713457144571545716457174571845719457204572145722457234572445725457264572745728457294573045731457324573345734457354573645737457384573945740457414574245743457444574545746457474574845749457504575145752457534575445755457564575745758457594576045761457624576345764457654576645767457684576945770457714577245773457744577545776457774577845779457804578145782457834578445785457864578745788457894579045791457924579345794457954579645797457984579945800458014580245803458044580545806458074580845809458104581145812458134581445815458164581745818458194582045821458224582345824458254582645827458284582945830458314583245833458344583545836458374583845839458404584145842458434584445845458464584745848458494585045851458524585345854458554585645857458584585945860458614586245863458644586545866458674586845869458704587145872458734587445875458764587745878458794588045881458824588345884458854588645887458884588945890458914589245893458944589545896458974589845899459004590145902459034590445905459064590745908459094591045911459124591345914459154591645917459184591945920459214592245923459244592545926459274592845929459304593145932459334593445935459364593745938459394594045941459424594345944459454594645947459484594945950459514595245953459544595545956459574595845959459604596145962459634596445965459664596745968459694597045971459724597345974459754597645977459784597945980459814598245983459844598545986459874598845989459904599145992459934599445995459964599745998459994600046001460024600346004460054600646007460084600946010460114601246013460144601546016460174601846019460204602146022460234602446025460264602746028460294603046031460324603346034460354603646037460384603946040460414604246043460444604546046460474604846049460504605146052460534605446055460564605746058460594606046061460624606346064460654606646067460684606946070460714607246073460744607546076460774607846079460804608146082460834608446085460864608746088460894609046091460924609346094460954609646097460984609946100461014610246103461044610546106461074610846109461104611146112461134611446115461164611746118461194612046121461224612346124461254612646127461284612946130461314613246133461344613546136461374613846139461404614146142461434614446145461464614746148461494615046151461524615346154461554615646157461584615946160461614616246163461644616546166461674616846169461704617146172461734617446175461764617746178461794618046181461824618346184461854618646187461884618946190461914619246193461944619546196461974619846199462004620146202462034620446205462064620746208462094621046211462124621346214462154621646217462184621946220462214622246223462244622546226462274622846229462304623146232462334623446235462364623746238462394624046241462424624346244462454624646247462484624946250462514625246253462544625546256462574625846259462604626146262462634626446265462664626746268462694627046271462724627346274462754627646277462784627946280462814628246283462844628546286462874628846289462904629146292462934629446295462964629746298462994630046301463024630346304463054630646307463084630946310463114631246313463144631546316463174631846319463204632146322463234632446325463264632746328463294633046331463324633346334463354633646337463384633946340463414634246343463444634546346463474634846349463504635146352463534635446355463564635746358463594636046361463624636346364463654636646367463684636946370463714637246373463744637546376463774637846379463804638146382463834638446385463864638746388463894639046391463924639346394463954639646397463984639946400464014640246403464044640546406464074640846409464104641146412464134641446415464164641746418464194642046421464224642346424464254642646427464284642946430464314643246433464344643546436464374643846439464404644146442464434644446445464464644746448464494645046451464524645346454464554645646457464584645946460464614646246463464644646546466464674646846469464704647146472464734647446475464764647746478464794648046481464824648346484464854648646487464884648946490464914649246493464944649546496464974649846499465004650146502465034650446505465064650746508465094651046511465124651346514465154651646517465184651946520465214652246523465244652546526465274652846529465304653146532465334653446535465364653746538465394654046541465424654346544465454654646547465484654946550465514655246553465544655546556465574655846559465604656146562465634656446565465664656746568465694657046571465724657346574465754657646577465784657946580465814658246583465844658546586465874658846589465904659146592465934659446595465964659746598465994660046601466024660346604466054660646607466084660946610466114661246613466144661546616466174661846619466204662146622466234662446625466264662746628466294663046631466324663346634466354663646637466384663946640466414664246643466444664546646466474664846649466504665146652466534665446655466564665746658466594666046661466624666346664466654666646667466684666946670466714667246673466744667546676466774667846679466804668146682466834668446685466864668746688466894669046691466924669346694466954669646697466984669946700467014670246703467044670546706467074670846709467104671146712467134671446715467164671746718467194672046721467224672346724467254672646727467284672946730467314673246733467344673546736467374673846739467404674146742467434674446745467464674746748467494675046751467524675346754467554675646757467584675946760467614676246763467644676546766467674676846769467704677146772467734677446775467764677746778467794678046781467824678346784467854678646787467884678946790467914679246793467944679546796467974679846799468004680146802468034680446805468064680746808468094681046811468124681346814468154681646817468184681946820468214682246823468244682546826468274682846829468304683146832468334683446835468364683746838468394684046841468424684346844468454684646847468484684946850468514685246853468544685546856468574685846859468604686146862468634686446865468664686746868468694687046871468724687346874468754687646877468784687946880468814688246883468844688546886468874688846889468904689146892468934689446895468964689746898468994690046901469024690346904469054690646907469084690946910469114691246913469144691546916469174691846919469204692146922469234692446925469264692746928469294693046931469324693346934469354693646937469384693946940469414694246943469444694546946469474694846949469504695146952469534695446955469564695746958469594696046961469624696346964469654696646967469684696946970469714697246973469744697546976469774697846979469804698146982469834698446985469864698746988469894699046991469924699346994469954699646997469984699947000470014700247003470044700547006470074700847009470104701147012470134701447015470164701747018470194702047021470224702347024470254702647027470284702947030470314703247033470344703547036470374703847039470404704147042470434704447045470464704747048470494705047051470524705347054470554705647057470584705947060470614706247063470644706547066470674706847069470704707147072470734707447075470764707747078470794708047081470824708347084470854708647087470884708947090470914709247093470944709547096470974709847099471004710147102471034710447105471064710747108471094711047111471124711347114471154711647117471184711947120471214712247123471244712547126471274712847129471304713147132471334713447135471364713747138471394714047141471424714347144471454714647147471484714947150471514715247153471544715547156471574715847159471604716147162471634716447165471664716747168471694717047171471724717347174471754717647177471784717947180471814718247183471844718547186471874718847189471904719147192471934719447195471964719747198471994720047201472024720347204472054720647207472084720947210472114721247213472144721547216472174721847219472204722147222472234722447225472264722747228472294723047231472324723347234472354723647237472384723947240472414724247243472444724547246472474724847249472504725147252472534725447255472564725747258472594726047261472624726347264472654726647267472684726947270472714727247273472744727547276472774727847279472804728147282472834728447285472864728747288472894729047291472924729347294472954729647297472984729947300473014730247303473044730547306473074730847309473104731147312473134731447315473164731747318473194732047321473224732347324473254732647327473284732947330473314733247333473344733547336473374733847339473404734147342473434734447345473464734747348473494735047351473524735347354473554735647357473584735947360473614736247363473644736547366473674736847369473704737147372473734737447375473764737747378473794738047381473824738347384473854738647387473884738947390473914739247393473944739547396473974739847399474004740147402474034740447405474064740747408474094741047411474124741347414474154741647417474184741947420474214742247423474244742547426474274742847429474304743147432474334743447435474364743747438474394744047441474424744347444474454744647447474484744947450474514745247453474544745547456474574745847459474604746147462474634746447465474664746747468474694747047471474724747347474474754747647477474784747947480474814748247483474844748547486474874748847489474904749147492474934749447495474964749747498474994750047501475024750347504475054750647507475084750947510475114751247513475144751547516475174751847519475204752147522475234752447525475264752747528475294753047531475324753347534475354753647537475384753947540475414754247543475444754547546475474754847549475504755147552475534755447555475564755747558475594756047561475624756347564475654756647567475684756947570475714757247573475744757547576475774757847579475804758147582475834758447585475864758747588475894759047591475924759347594475954759647597475984759947600476014760247603476044760547606476074760847609476104761147612476134761447615476164761747618476194762047621476224762347624476254762647627476284762947630476314763247633476344763547636476374763847639476404764147642476434764447645476464764747648476494765047651476524765347654476554765647657476584765947660476614766247663476644766547666476674766847669476704767147672476734767447675476764767747678476794768047681476824768347684476854768647687476884768947690476914769247693476944769547696476974769847699477004770147702477034770447705477064770747708477094771047711477124771347714477154771647717477184771947720477214772247723477244772547726477274772847729477304773147732477334773447735477364773747738477394774047741477424774347744477454774647747477484774947750477514775247753477544775547756477574775847759477604776147762477634776447765477664776747768477694777047771477724777347774477754777647777477784777947780477814778247783477844778547786477874778847789477904779147792477934779447795477964779747798477994780047801478024780347804478054780647807478084780947810478114781247813478144781547816478174781847819478204782147822478234782447825478264782747828478294783047831478324783347834478354783647837478384783947840478414784247843478444784547846478474784847849478504785147852478534785447855478564785747858478594786047861478624786347864478654786647867478684786947870478714787247873478744787547876478774787847879478804788147882478834788447885478864788747888478894789047891478924789347894478954789647897478984789947900479014790247903479044790547906479074790847909479104791147912479134791447915479164791747918479194792047921479224792347924479254792647927479284792947930479314793247933479344793547936479374793847939479404794147942479434794447945479464794747948479494795047951479524795347954479554795647957479584795947960479614796247963479644796547966479674796847969479704797147972479734797447975479764797747978479794798047981479824798347984479854798647987479884798947990479914799247993479944799547996479974799847999480004800148002480034800448005480064800748008480094801048011480124801348014480154801648017480184801948020480214802248023480244802548026480274802848029480304803148032480334803448035480364803748038480394804048041480424804348044480454804648047480484804948050480514805248053480544805548056480574805848059480604806148062480634806448065480664806748068480694807048071480724807348074480754807648077480784807948080480814808248083480844808548086480874808848089480904809148092480934809448095480964809748098480994810048101481024810348104481054810648107481084810948110481114811248113481144811548116481174811848119481204812148122481234812448125481264812748128481294813048131481324813348134481354813648137481384813948140481414814248143481444814548146481474814848149481504815148152481534815448155481564815748158481594816048161481624816348164481654816648167481684816948170481714817248173481744817548176481774817848179481804818148182481834818448185481864818748188481894819048191481924819348194481954819648197481984819948200482014820248203482044820548206482074820848209482104821148212482134821448215482164821748218482194822048221482224822348224482254822648227482284822948230482314823248233482344823548236482374823848239482404824148242482434824448245482464824748248482494825048251482524825348254482554825648257482584825948260482614826248263482644826548266482674826848269482704827148272482734827448275482764827748278482794828048281482824828348284482854828648287482884828948290482914829248293482944829548296482974829848299483004830148302483034830448305483064830748308483094831048311483124831348314483154831648317483184831948320483214832248323483244832548326483274832848329483304833148332483334833448335483364833748338483394834048341483424834348344483454834648347483484834948350483514835248353483544835548356483574835848359483604836148362483634836448365483664836748368483694837048371483724837348374483754837648377483784837948380483814838248383483844838548386483874838848389483904839148392483934839448395483964839748398483994840048401484024840348404484054840648407484084840948410484114841248413484144841548416484174841848419484204842148422484234842448425484264842748428484294843048431484324843348434484354843648437484384843948440484414844248443484444844548446484474844848449484504845148452484534845448455484564845748458484594846048461484624846348464484654846648467484684846948470484714847248473484744847548476484774847848479484804848148482484834848448485484864848748488484894849048491484924849348494484954849648497484984849948500485014850248503485044850548506485074850848509485104851148512485134851448515485164851748518485194852048521485224852348524485254852648527485284852948530485314853248533485344853548536485374853848539485404854148542485434854448545485464854748548485494855048551485524855348554485554855648557485584855948560485614856248563485644856548566485674856848569485704857148572485734857448575485764857748578485794858048581485824858348584485854858648587485884858948590485914859248593485944859548596485974859848599486004860148602486034860448605486064860748608486094861048611486124861348614486154861648617486184861948620486214862248623486244862548626486274862848629486304863148632486334863448635486364863748638486394864048641486424864348644486454864648647486484864948650486514865248653486544865548656486574865848659486604866148662486634866448665486664866748668486694867048671486724867348674486754867648677486784867948680486814868248683486844868548686486874868848689486904869148692486934869448695486964869748698486994870048701487024870348704487054870648707487084870948710487114871248713487144871548716487174871848719487204872148722487234872448725487264872748728487294873048731487324873348734487354873648737487384873948740487414874248743487444874548746487474874848749487504875148752487534875448755487564875748758487594876048761487624876348764487654876648767487684876948770487714877248773487744877548776487774877848779487804878148782487834878448785487864878748788487894879048791487924879348794487954879648797487984879948800488014880248803488044880548806488074880848809488104881148812488134881448815488164881748818488194882048821488224882348824488254882648827488284882948830488314883248833488344883548836488374883848839488404884148842488434884448845488464884748848488494885048851488524885348854488554885648857488584885948860488614886248863488644886548866488674886848869488704887148872488734887448875488764887748878488794888048881488824888348884488854888648887488884888948890488914889248893488944889548896488974889848899489004890148902489034890448905489064890748908489094891048911489124891348914489154891648917489184891948920489214892248923489244892548926489274892848929489304893148932489334893448935489364893748938489394894048941489424894348944489454894648947489484894948950489514895248953489544895548956489574895848959489604896148962489634896448965489664896748968489694897048971489724897348974489754897648977489784897948980489814898248983489844898548986489874898848989489904899148992489934899448995489964899748998489994900049001490024900349004490054900649007490084900949010490114901249013490144901549016490174901849019490204902149022490234902449025490264902749028490294903049031490324903349034490354903649037490384903949040490414904249043490444904549046490474904849049490504905149052490534905449055490564905749058490594906049061490624906349064490654906649067490684906949070490714907249073490744907549076490774907849079490804908149082490834908449085490864908749088490894909049091490924909349094490954909649097490984909949100491014910249103491044910549106491074910849109491104911149112491134911449115491164911749118491194912049121491224912349124491254912649127491284912949130491314913249133491344913549136491374913849139491404914149142491434914449145491464914749148491494915049151491524915349154491554915649157491584915949160491614916249163491644916549166491674916849169491704917149172491734917449175491764917749178491794918049181491824918349184491854918649187491884918949190491914919249193491944919549196491974919849199492004920149202492034920449205492064920749208492094921049211492124921349214492154921649217492184921949220492214922249223492244922549226492274922849229492304923149232492334923449235492364923749238492394924049241492424924349244492454924649247492484924949250492514925249253492544925549256492574925849259492604926149262492634926449265492664926749268492694927049271492724927349274492754927649277492784927949280492814928249283492844928549286492874928849289492904929149292492934929449295492964929749298492994930049301493024930349304493054930649307493084930949310493114931249313493144931549316493174931849319493204932149322493234932449325493264932749328493294933049331493324933349334493354933649337493384933949340493414934249343493444934549346493474934849349493504935149352493534935449355493564935749358493594936049361493624936349364493654936649367493684936949370493714937249373493744937549376493774937849379493804938149382493834938449385493864938749388493894939049391493924939349394493954939649397493984939949400494014940249403494044940549406494074940849409494104941149412494134941449415494164941749418494194942049421494224942349424494254942649427494284942949430494314943249433494344943549436494374943849439494404944149442494434944449445494464944749448494494945049451494524945349454494554945649457494584945949460494614946249463494644946549466494674946849469494704947149472494734947449475494764947749478494794948049481494824948349484494854948649487494884948949490494914949249493494944949549496494974949849499495004950149502495034950449505495064950749508495094951049511495124951349514495154951649517495184951949520495214952249523495244952549526495274952849529495304953149532495334953449535495364953749538495394954049541495424954349544495454954649547495484954949550495514955249553495544955549556495574955849559495604956149562495634956449565495664956749568495694957049571495724957349574495754957649577495784957949580495814958249583495844958549586495874958849589495904959149592495934959449595495964959749598495994960049601496024960349604496054960649607496084960949610496114961249613496144961549616496174961849619496204962149622496234962449625496264962749628496294963049631496324963349634496354963649637496384963949640496414964249643496444964549646496474964849649496504965149652496534965449655496564965749658496594966049661496624966349664496654966649667496684966949670496714967249673496744967549676496774967849679496804968149682496834968449685496864968749688496894969049691496924969349694496954969649697496984969949700497014970249703497044970549706497074970849709497104971149712497134971449715497164971749718497194972049721497224972349724497254972649727497284972949730497314973249733497344973549736497374973849739497404974149742497434974449745497464974749748497494975049751497524975349754497554975649757497584975949760497614976249763497644976549766497674976849769497704977149772497734977449775497764977749778497794978049781497824978349784497854978649787497884978949790497914979249793497944979549796497974979849799498004980149802498034980449805498064980749808498094981049811498124981349814498154981649817498184981949820498214982249823498244982549826498274982849829498304983149832498334983449835498364983749838498394984049841498424984349844498454984649847498484984949850498514985249853498544985549856498574985849859498604986149862498634986449865498664986749868498694987049871498724987349874498754987649877498784987949880498814988249883498844988549886498874988849889498904989149892498934989449895498964989749898498994990049901499024990349904499054990649907499084990949910499114991249913499144991549916499174991849919499204992149922499234992449925499264992749928499294993049931499324993349934499354993649937499384993949940499414994249943499444994549946499474994849949499504995149952499534995449955499564995749958499594996049961499624996349964499654996649967499684996949970499714997249973499744997549976499774997849979499804998149982499834998449985499864998749988499894999049991499924999349994499954999649997499984999950000500015000250003500045000550006500075000850009500105001150012500135001450015500165001750018500195002050021500225002350024500255002650027500285002950030500315003250033500345003550036500375003850039500405004150042500435004450045500465004750048500495005050051500525005350054500555005650057500585005950060500615006250063500645006550066500675006850069500705007150072500735007450075500765007750078500795008050081500825008350084500855008650087500885008950090500915009250093500945009550096500975009850099501005010150102501035010450105501065010750108501095011050111501125011350114501155011650117501185011950120501215012250123501245012550126501275012850129501305013150132501335013450135501365013750138501395014050141501425014350144501455014650147501485014950150501515015250153501545015550156501575015850159501605016150162501635016450165501665016750168501695017050171501725017350174501755017650177501785017950180501815018250183501845018550186501875018850189501905019150192501935019450195501965019750198501995020050201502025020350204502055020650207502085020950210502115021250213502145021550216502175021850219502205022150222502235022450225502265022750228502295023050231502325023350234502355023650237502385023950240502415024250243502445024550246502475024850249502505025150252502535025450255502565025750258502595026050261502625026350264502655026650267502685026950270502715027250273502745027550276502775027850279502805028150282502835028450285502865028750288502895029050291502925029350294502955029650297502985029950300503015030250303503045030550306503075030850309503105031150312503135031450315503165031750318503195032050321503225032350324503255032650327503285032950330503315033250333503345033550336503375033850339503405034150342503435034450345503465034750348503495035050351503525035350354503555035650357503585035950360503615036250363503645036550366503675036850369503705037150372503735037450375503765037750378503795038050381503825038350384503855038650387503885038950390503915039250393503945039550396503975039850399504005040150402504035040450405504065040750408504095041050411504125041350414504155041650417504185041950420504215042250423504245042550426504275042850429504305043150432504335043450435504365043750438504395044050441504425044350444504455044650447504485044950450504515045250453504545045550456504575045850459504605046150462504635046450465504665046750468504695047050471504725047350474504755047650477504785047950480504815048250483504845048550486504875048850489504905049150492504935049450495504965049750498504995050050501505025050350504505055050650507505085050950510505115051250513505145051550516505175051850519505205052150522505235052450525505265052750528505295053050531505325053350534505355053650537505385053950540505415054250543505445054550546505475054850549505505055150552505535055450555505565055750558505595056050561505625056350564505655056650567505685056950570505715057250573505745057550576505775057850579505805058150582505835058450585505865058750588505895059050591505925059350594505955059650597505985059950600506015060250603506045060550606506075060850609506105061150612506135061450615506165061750618506195062050621506225062350624506255062650627506285062950630506315063250633506345063550636506375063850639506405064150642506435064450645506465064750648506495065050651506525065350654506555065650657506585065950660506615066250663506645066550666506675066850669506705067150672506735067450675506765067750678506795068050681506825068350684506855068650687506885068950690506915069250693506945069550696506975069850699507005070150702507035070450705507065070750708507095071050711507125071350714507155071650717507185071950720507215072250723507245072550726507275072850729507305073150732507335073450735507365073750738507395074050741507425074350744507455074650747507485074950750507515075250753507545075550756507575075850759507605076150762507635076450765507665076750768507695077050771507725077350774507755077650777507785077950780507815078250783507845078550786507875078850789507905079150792507935079450795507965079750798507995080050801508025080350804508055080650807508085080950810508115081250813508145081550816508175081850819508205082150822508235082450825508265082750828508295083050831508325083350834508355083650837508385083950840508415084250843508445084550846508475084850849508505085150852508535085450855508565085750858508595086050861508625086350864508655086650867508685086950870508715087250873508745087550876508775087850879508805088150882508835088450885508865088750888508895089050891508925089350894508955089650897508985089950900509015090250903509045090550906509075090850909509105091150912509135091450915509165091750918509195092050921509225092350924509255092650927509285092950930509315093250933509345093550936509375093850939509405094150942509435094450945509465094750948509495095050951509525095350954509555095650957509585095950960509615096250963509645096550966509675096850969509705097150972509735097450975509765097750978509795098050981509825098350984509855098650987509885098950990509915099250993509945099550996509975099850999510005100151002510035100451005510065100751008510095101051011510125101351014510155101651017510185101951020510215102251023510245102551026510275102851029510305103151032510335103451035510365103751038510395104051041510425104351044510455104651047510485104951050510515105251053510545105551056510575105851059510605106151062510635106451065510665106751068510695107051071510725107351074510755107651077510785107951080510815108251083510845108551086510875108851089510905109151092510935109451095510965109751098510995110051101511025110351104511055110651107511085110951110511115111251113511145111551116511175111851119511205112151122511235112451125511265112751128511295113051131511325113351134511355113651137511385113951140511415114251143511445114551146511475114851149511505115151152511535115451155511565115751158511595116051161511625116351164511655116651167511685116951170511715117251173511745117551176511775117851179511805118151182511835118451185511865118751188511895119051191511925119351194511955119651197511985119951200512015120251203512045120551206512075120851209512105121151212512135121451215512165121751218512195122051221512225122351224512255122651227512285122951230512315123251233512345123551236512375123851239512405124151242512435124451245512465124751248512495125051251512525125351254512555125651257512585125951260512615126251263512645126551266512675126851269512705127151272512735127451275512765127751278512795128051281512825128351284512855128651287512885128951290512915129251293512945129551296512975129851299513005130151302513035130451305513065130751308513095131051311513125131351314513155131651317513185131951320513215132251323513245132551326513275132851329513305133151332513335133451335513365133751338513395134051341513425134351344513455134651347513485134951350513515135251353513545135551356513575135851359513605136151362513635136451365513665136751368513695137051371513725137351374513755137651377513785137951380513815138251383513845138551386513875138851389513905139151392513935139451395513965139751398513995140051401514025140351404514055140651407514085140951410514115141251413514145141551416514175141851419514205142151422514235142451425514265142751428514295143051431514325143351434514355143651437514385143951440514415144251443514445144551446514475144851449514505145151452514535145451455514565145751458514595146051461514625146351464514655146651467514685146951470514715147251473514745147551476514775147851479514805148151482514835148451485514865148751488514895149051491514925149351494514955149651497514985149951500515015150251503515045150551506515075150851509515105151151512515135151451515515165151751518515195152051521515225152351524515255152651527515285152951530515315153251533515345153551536515375153851539515405154151542515435154451545515465154751548515495155051551515525155351554515555155651557515585155951560515615156251563515645156551566515675156851569515705157151572515735157451575515765157751578515795158051581515825158351584515855158651587515885158951590515915159251593515945159551596515975159851599516005160151602516035160451605516065160751608516095161051611516125161351614516155161651617516185161951620516215162251623516245162551626516275162851629516305163151632516335163451635516365163751638516395164051641516425164351644516455164651647516485164951650516515165251653516545165551656516575165851659516605166151662516635166451665516665166751668516695167051671516725167351674516755167651677516785167951680516815168251683516845168551686516875168851689516905169151692516935169451695516965169751698516995170051701517025170351704517055170651707517085170951710517115171251713517145171551716517175171851719517205172151722517235172451725517265172751728517295173051731517325173351734517355173651737517385173951740517415174251743517445174551746517475174851749517505175151752517535175451755517565175751758517595176051761517625176351764517655176651767517685176951770517715177251773517745177551776517775177851779517805178151782517835178451785517865178751788517895179051791517925179351794517955179651797517985179951800518015180251803518045180551806518075180851809518105181151812518135181451815518165181751818518195182051821518225182351824518255182651827518285182951830518315183251833518345183551836518375183851839518405184151842518435184451845518465184751848518495185051851518525185351854518555185651857518585185951860518615186251863518645186551866518675186851869518705187151872518735187451875518765187751878518795188051881518825188351884518855188651887518885188951890518915189251893518945189551896518975189851899519005190151902519035190451905519065190751908519095191051911519125191351914519155191651917519185191951920519215192251923519245192551926519275192851929519305193151932519335193451935519365193751938519395194051941519425194351944519455194651947519485194951950519515195251953519545195551956519575195851959519605196151962519635196451965519665196751968519695197051971519725197351974519755197651977519785197951980519815198251983519845198551986519875198851989519905199151992519935199451995519965199751998519995200052001520025200352004520055200652007520085200952010520115201252013520145201552016520175201852019520205202152022520235202452025520265202752028520295203052031520325203352034520355203652037520385203952040520415204252043520445204552046520475204852049520505205152052520535205452055520565205752058520595206052061520625206352064520655206652067520685206952070520715207252073520745207552076520775207852079520805208152082520835208452085520865208752088520895209052091520925209352094520955209652097520985209952100521015210252103521045210552106521075210852109521105211152112521135211452115521165211752118521195212052121521225212352124521255212652127521285212952130521315213252133521345213552136521375213852139521405214152142521435214452145521465214752148521495215052151521525215352154521555215652157521585215952160521615216252163521645216552166521675216852169521705217152172521735217452175521765217752178521795218052181521825218352184521855218652187521885218952190521915219252193521945219552196521975219852199522005220152202522035220452205522065220752208522095221052211522125221352214522155221652217522185221952220522215222252223522245222552226522275222852229522305223152232522335223452235522365223752238522395224052241522425224352244522455224652247522485224952250522515225252253522545225552256522575225852259522605226152262522635226452265522665226752268522695227052271522725227352274522755227652277522785227952280522815228252283522845228552286522875228852289522905229152292522935229452295522965229752298522995230052301523025230352304523055230652307523085230952310523115231252313523145231552316523175231852319523205232152322523235232452325523265232752328523295233052331523325233352334523355233652337523385233952340523415234252343523445234552346523475234852349523505235152352523535235452355523565235752358523595236052361523625236352364523655236652367523685236952370523715237252373523745237552376523775237852379523805238152382523835238452385523865238752388523895239052391523925239352394523955239652397523985239952400524015240252403524045240552406524075240852409524105241152412524135241452415524165241752418524195242052421524225242352424524255242652427524285242952430524315243252433524345243552436524375243852439524405244152442524435244452445524465244752448524495245052451524525245352454524555245652457524585245952460524615246252463524645246552466524675246852469524705247152472524735247452475524765247752478524795248052481524825248352484524855248652487524885248952490524915249252493524945249552496524975249852499525005250152502525035250452505525065250752508525095251052511525125251352514525155251652517525185251952520525215252252523525245252552526525275252852529525305253152532525335253452535525365253752538525395254052541525425254352544525455254652547525485254952550525515255252553525545255552556525575255852559525605256152562525635256452565525665256752568525695257052571525725257352574525755257652577525785257952580525815258252583525845258552586525875258852589525905259152592525935259452595525965259752598525995260052601526025260352604526055260652607526085260952610526115261252613526145261552616526175261852619526205262152622526235262452625526265262752628526295263052631526325263352634526355263652637526385263952640526415264252643526445264552646526475264852649526505265152652526535265452655526565265752658526595266052661526625266352664526655266652667526685266952670526715267252673526745267552676526775267852679526805268152682526835268452685526865268752688526895269052691526925269352694526955269652697526985269952700527015270252703527045270552706527075270852709527105271152712527135271452715527165271752718527195272052721527225272352724527255272652727527285272952730527315273252733527345273552736527375273852739527405274152742527435274452745527465274752748527495275052751527525275352754527555275652757527585275952760527615276252763527645276552766527675276852769527705277152772527735277452775527765277752778527795278052781527825278352784527855278652787527885278952790527915279252793527945279552796527975279852799528005280152802528035280452805528065280752808528095281052811528125281352814528155281652817528185281952820528215282252823528245282552826528275282852829528305283152832528335283452835528365283752838528395284052841528425284352844528455284652847528485284952850528515285252853528545285552856528575285852859528605286152862528635286452865528665286752868528695287052871528725287352874528755287652877528785287952880528815288252883528845288552886528875288852889528905289152892528935289452895528965289752898528995290052901529025290352904529055290652907529085290952910529115291252913529145291552916529175291852919529205292152922529235292452925529265292752928529295293052931529325293352934529355293652937529385293952940529415294252943529445294552946529475294852949529505295152952529535295452955529565295752958529595296052961529625296352964529655296652967529685296952970529715297252973529745297552976529775297852979529805298152982529835298452985529865298752988529895299052991529925299352994529955299652997529985299953000530015300253003530045300553006530075300853009530105301153012530135301453015530165301753018530195302053021530225302353024530255302653027530285302953030530315303253033530345303553036530375303853039530405304153042530435304453045530465304753048530495305053051530525305353054530555305653057530585305953060530615306253063530645306553066530675306853069530705307153072530735307453075530765307753078530795308053081530825308353084530855308653087530885308953090530915309253093530945309553096530975309853099531005310153102531035310453105531065310753108531095311053111531125311353114531155311653117531185311953120531215312253123531245312553126531275312853129531305313153132531335313453135531365313753138531395314053141531425314353144531455314653147531485314953150531515315253153531545315553156531575315853159531605316153162531635316453165531665316753168531695317053171531725317353174531755317653177531785317953180531815318253183531845318553186531875318853189531905319153192531935319453195531965319753198531995320053201532025320353204532055320653207532085320953210532115321253213532145321553216532175321853219532205322153222532235322453225532265322753228532295323053231532325323353234532355323653237532385323953240532415324253243532445324553246532475324853249532505325153252532535325453255532565325753258532595326053261532625326353264532655326653267532685326953270532715327253273532745327553276532775327853279532805328153282532835328453285532865328753288532895329053291532925329353294532955329653297532985329953300533015330253303533045330553306533075330853309533105331153312533135331453315533165331753318533195332053321533225332353324533255332653327533285332953330533315333253333533345333553336533375333853339533405334153342533435334453345533465334753348533495335053351533525335353354533555335653357533585335953360533615336253363533645336553366533675336853369533705337153372533735337453375533765337753378533795338053381533825338353384533855338653387533885338953390533915339253393533945339553396533975339853399534005340153402534035340453405534065340753408534095341053411534125341353414534155341653417534185341953420534215342253423534245342553426534275342853429534305343153432534335343453435534365343753438534395344053441534425344353444534455344653447534485344953450534515345253453534545345553456534575345853459534605346153462534635346453465534665346753468534695347053471534725347353474534755347653477534785347953480534815348253483534845348553486534875348853489534905349153492534935349453495534965349753498534995350053501535025350353504535055350653507535085350953510535115351253513535145351553516535175351853519535205352153522535235352453525535265352753528535295353053531535325353353534535355353653537535385353953540535415354253543535445354553546535475354853549535505355153552535535355453555535565355753558535595356053561535625356353564535655356653567535685356953570535715357253573535745357553576535775357853579535805358153582535835358453585535865358753588535895359053591535925359353594535955359653597535985359953600536015360253603536045360553606536075360853609536105361153612536135361453615536165361753618536195362053621536225362353624536255362653627536285362953630536315363253633536345363553636536375363853639536405364153642536435364453645536465364753648536495365053651536525365353654536555365653657536585365953660536615366253663536645366553666536675366853669536705367153672536735367453675536765367753678536795368053681536825368353684536855368653687536885368953690536915369253693536945369553696536975369853699537005370153702537035370453705537065370753708537095371053711537125371353714537155371653717537185371953720537215372253723537245372553726537275372853729537305373153732537335373453735537365373753738537395374053741537425374353744537455374653747537485374953750537515375253753537545375553756537575375853759537605376153762537635376453765537665376753768537695377053771537725377353774537755377653777537785377953780537815378253783537845378553786537875378853789537905379153792537935379453795537965379753798537995380053801538025380353804538055380653807538085380953810538115381253813538145381553816538175381853819538205382153822538235382453825538265382753828538295383053831538325383353834538355383653837538385383953840538415384253843538445384553846538475384853849538505385153852538535385453855538565385753858538595386053861538625386353864538655386653867538685386953870538715387253873538745387553876538775387853879538805388153882538835388453885538865388753888538895389053891538925389353894538955389653897538985389953900539015390253903539045390553906539075390853909539105391153912539135391453915539165391753918539195392053921539225392353924539255392653927539285392953930539315393253933539345393553936539375393853939539405394153942539435394453945539465394753948539495395053951539525395353954539555395653957539585395953960539615396253963539645396553966539675396853969539705397153972539735397453975539765397753978539795398053981539825398353984539855398653987539885398953990539915399253993539945399553996539975399853999540005400154002540035400454005540065400754008540095401054011540125401354014540155401654017540185401954020540215402254023540245402554026540275402854029540305403154032540335403454035540365403754038540395404054041540425404354044540455404654047540485404954050540515405254053540545405554056540575405854059540605406154062540635406454065540665406754068540695407054071540725407354074540755407654077540785407954080540815408254083540845408554086540875408854089540905409154092540935409454095540965409754098540995410054101541025410354104541055410654107541085410954110541115411254113541145411554116541175411854119541205412154122541235412454125541265412754128541295413054131541325413354134541355413654137541385413954140541415414254143541445414554146541475414854149541505415154152541535415454155541565415754158541595416054161541625416354164541655416654167541685416954170541715417254173541745417554176541775417854179541805418154182541835418454185541865418754188541895419054191541925419354194541955419654197541985419954200542015420254203542045420554206542075420854209542105421154212542135421454215542165421754218542195422054221542225422354224542255422654227542285422954230542315423254233542345423554236542375423854239542405424154242542435424454245542465424754248542495425054251542525425354254542555425654257542585425954260542615426254263542645426554266542675426854269542705427154272542735427454275542765427754278542795428054281542825428354284542855428654287542885428954290542915429254293542945429554296542975429854299543005430154302543035430454305543065430754308543095431054311543125431354314543155431654317543185431954320543215432254323543245432554326543275432854329543305433154332543335433454335543365433754338543395434054341543425434354344543455434654347543485434954350543515435254353543545435554356543575435854359543605436154362543635436454365543665436754368543695437054371543725437354374543755437654377543785437954380543815438254383543845438554386543875438854389543905439154392543935439454395543965439754398543995440054401544025440354404544055440654407544085440954410544115441254413544145441554416544175441854419544205442154422544235442454425544265442754428544295443054431544325443354434544355443654437544385443954440544415444254443544445444554446544475444854449544505445154452544535445454455544565445754458544595446054461544625446354464544655446654467544685446954470544715447254473544745447554476544775447854479544805448154482544835448454485544865448754488544895449054491544925449354494544955449654497544985449954500545015450254503545045450554506545075450854509545105451154512545135451454515545165451754518545195452054521545225452354524545255452654527545285452954530545315453254533545345453554536545375453854539545405454154542545435454454545545465454754548545495455054551545525455354554545555455654557545585455954560545615456254563545645456554566545675456854569545705457154572545735457454575545765457754578545795458054581545825458354584545855458654587545885458954590545915459254593545945459554596545975459854599546005460154602546035460454605546065460754608546095461054611546125461354614546155461654617546185461954620546215462254623546245462554626546275462854629546305463154632546335463454635546365463754638546395464054641546425464354644546455464654647546485464954650546515465254653546545465554656546575465854659546605466154662546635466454665546665466754668546695467054671546725467354674546755467654677546785467954680546815468254683546845468554686546875468854689546905469154692546935469454695546965469754698546995470054701547025470354704547055470654707547085470954710547115471254713547145471554716547175471854719547205472154722547235472454725547265472754728547295473054731547325473354734547355473654737547385473954740547415474254743547445474554746547475474854749547505475154752547535475454755547565475754758547595476054761547625476354764547655476654767547685476954770547715477254773547745477554776547775477854779547805478154782547835478454785547865478754788547895479054791547925479354794547955479654797547985479954800548015480254803548045480554806548075480854809548105481154812548135481454815548165481754818548195482054821548225482354824548255482654827548285482954830548315483254833548345483554836548375483854839548405484154842548435484454845548465484754848548495485054851548525485354854548555485654857548585485954860548615486254863548645486554866548675486854869548705487154872548735487454875548765487754878548795488054881548825488354884548855488654887548885488954890548915489254893548945489554896548975489854899549005490154902549035490454905549065490754908549095491054911549125491354914549155491654917549185491954920549215492254923549245492554926549275492854929549305493154932549335493454935549365493754938549395494054941549425494354944549455494654947549485494954950549515495254953549545495554956549575495854959549605496154962549635496454965549665496754968549695497054971549725497354974549755497654977549785497954980549815498254983549845498554986549875498854989549905499154992549935499454995549965499754998549995500055001550025500355004550055500655007550085500955010550115501255013550145501555016550175501855019550205502155022550235502455025550265502755028550295503055031550325503355034550355503655037550385503955040550415504255043550445504555046550475504855049550505505155052550535505455055550565505755058550595506055061550625506355064550655506655067550685506955070550715507255073550745507555076550775507855079550805508155082550835508455085550865508755088550895509055091550925509355094550955509655097550985509955100551015510255103551045510555106551075510855109551105511155112551135511455115551165511755118551195512055121551225512355124551255512655127551285512955130551315513255133551345513555136551375513855139551405514155142551435514455145551465514755148551495515055151551525515355154551555515655157551585515955160551615516255163551645516555166551675516855169551705517155172551735517455175551765517755178551795518055181551825518355184551855518655187551885518955190551915519255193551945519555196551975519855199552005520155202552035520455205552065520755208552095521055211552125521355214552155521655217552185521955220552215522255223552245522555226552275522855229552305523155232552335523455235552365523755238552395524055241552425524355244552455524655247552485524955250552515525255253552545525555256552575525855259552605526155262552635526455265552665526755268552695527055271552725527355274552755527655277552785527955280552815528255283552845528555286552875528855289552905529155292552935529455295552965529755298552995530055301553025530355304553055530655307553085530955310553115531255313553145531555316553175531855319553205532155322553235532455325553265532755328553295533055331553325533355334553355533655337553385533955340553415534255343553445534555346553475534855349553505535155352553535535455355553565535755358553595536055361553625536355364553655536655367553685536955370553715537255373553745537555376553775537855379553805538155382553835538455385553865538755388553895539055391553925539355394553955539655397553985539955400554015540255403554045540555406554075540855409554105541155412554135541455415554165541755418554195542055421554225542355424554255542655427554285542955430554315543255433554345543555436554375543855439554405544155442554435544455445554465544755448554495545055451554525545355454554555545655457554585545955460554615546255463554645546555466554675546855469554705547155472554735547455475554765547755478554795548055481554825548355484554855548655487554885548955490554915549255493554945549555496554975549855499555005550155502555035550455505555065550755508555095551055511555125551355514555155551655517555185551955520555215552255523555245552555526555275552855529555305553155532555335553455535555365553755538555395554055541555425554355544555455554655547555485554955550555515555255553555545555555556555575555855559555605556155562555635556455565555665556755568555695557055571555725557355574555755557655577555785557955580555815558255583555845558555586555875558855589555905559155592555935559455595555965559755598555995560055601556025560355604556055560655607556085560955610556115561255613556145561555616556175561855619556205562155622556235562455625556265562755628556295563055631556325563355634556355563655637556385563955640556415564255643556445564555646556475564855649556505565155652556535565455655556565565755658556595566055661556625566355664556655566655667556685566955670556715567255673556745567555676556775567855679556805568155682556835568455685556865568755688556895569055691556925569355694556955569655697556985569955700557015570255703557045570555706557075570855709557105571155712557135571455715557165571755718557195572055721557225572355724557255572655727557285572955730557315573255733557345573555736557375573855739557405574155742557435574455745557465574755748557495575055751557525575355754557555575655757557585575955760557615576255763557645576555766557675576855769557705577155772557735577455775557765577755778557795578055781557825578355784557855578655787557885578955790557915579255793557945579555796557975579855799558005580155802558035580455805558065580755808558095581055811558125581355814558155581655817558185581955820558215582255823558245582555826558275582855829558305583155832558335583455835558365583755838558395584055841558425584355844558455584655847558485584955850558515585255853558545585555856558575585855859558605586155862558635586455865558665586755868558695587055871558725587355874558755587655877558785587955880558815588255883558845588555886558875588855889558905589155892558935589455895558965589755898558995590055901559025590355904559055590655907559085590955910559115591255913559145591555916559175591855919559205592155922559235592455925559265592755928559295593055931559325593355934559355593655937559385593955940559415594255943559445594555946559475594855949559505595155952559535595455955559565595755958559595596055961559625596355964559655596655967559685596955970559715597255973559745597555976559775597855979559805598155982559835598455985559865598755988559895599055991559925599355994559955599655997559985599956000560015600256003560045600556006560075600856009560105601156012560135601456015560165601756018560195602056021560225602356024560255602656027560285602956030560315603256033560345603556036560375603856039560405604156042560435604456045560465604756048560495605056051560525605356054560555605656057560585605956060560615606256063560645606556066560675606856069560705607156072560735607456075560765607756078560795608056081560825608356084560855608656087560885608956090560915609256093560945609556096560975609856099561005610156102561035610456105561065610756108561095611056111561125611356114561155611656117561185611956120561215612256123561245612556126561275612856129561305613156132561335613456135561365613756138561395614056141561425614356144561455614656147561485614956150561515615256153561545615556156561575615856159561605616156162561635616456165561665616756168561695617056171561725617356174561755617656177561785617956180561815618256183561845618556186561875618856189561905619156192561935619456195561965619756198561995620056201562025620356204562055620656207562085620956210562115621256213562145621556216562175621856219562205622156222562235622456225562265622756228562295623056231562325623356234562355623656237562385623956240562415624256243562445624556246562475624856249562505625156252562535625456255562565625756258562595626056261562625626356264562655626656267562685626956270562715627256273562745627556276562775627856279562805628156282562835628456285562865628756288562895629056291562925629356294562955629656297562985629956300563015630256303563045630556306563075630856309563105631156312563135631456315563165631756318563195632056321563225632356324563255632656327563285632956330563315633256333563345633556336563375633856339563405634156342563435634456345563465634756348563495635056351563525635356354563555635656357563585635956360563615636256363563645636556366563675636856369563705637156372563735637456375563765637756378563795638056381563825638356384563855638656387563885638956390563915639256393563945639556396563975639856399564005640156402564035640456405564065640756408564095641056411564125641356414564155641656417564185641956420564215642256423564245642556426564275642856429564305643156432564335643456435564365643756438564395644056441564425644356444564455644656447564485644956450564515645256453564545645556456564575645856459564605646156462564635646456465564665646756468564695647056471564725647356474564755647656477564785647956480564815648256483564845648556486564875648856489564905649156492564935649456495564965649756498564995650056501565025650356504565055650656507565085650956510565115651256513565145651556516565175651856519565205652156522565235652456525565265652756528565295653056531565325653356534565355653656537565385653956540565415654256543565445654556546565475654856549565505655156552565535655456555565565655756558565595656056561565625656356564565655656656567565685656956570565715657256573565745657556576565775657856579565805658156582565835658456585565865658756588565895659056591565925659356594565955659656597565985659956600566015660256603566045660556606566075660856609566105661156612566135661456615566165661756618566195662056621566225662356624566255662656627566285662956630566315663256633566345663556636566375663856639566405664156642566435664456645566465664756648566495665056651566525665356654566555665656657566585665956660566615666256663566645666556666566675666856669566705667156672566735667456675566765667756678566795668056681566825668356684566855668656687566885668956690566915669256693566945669556696566975669856699567005670156702567035670456705567065670756708567095671056711567125671356714567155671656717567185671956720567215672256723567245672556726567275672856729567305673156732567335673456735567365673756738567395674056741567425674356744567455674656747567485674956750567515675256753567545675556756567575675856759567605676156762567635676456765567665676756768567695677056771567725677356774567755677656777567785677956780567815678256783567845678556786567875678856789567905679156792567935679456795567965679756798567995680056801568025680356804568055680656807568085680956810568115681256813568145681556816568175681856819568205682156822568235682456825568265682756828568295683056831568325683356834568355683656837568385683956840568415684256843568445684556846568475684856849568505685156852568535685456855568565685756858568595686056861568625686356864568655686656867568685686956870568715687256873568745687556876568775687856879568805688156882568835688456885568865688756888568895689056891568925689356894568955689656897568985689956900569015690256903569045690556906569075690856909569105691156912569135691456915569165691756918569195692056921569225692356924569255692656927569285692956930569315693256933569345693556936569375693856939569405694156942569435694456945569465694756948569495695056951569525695356954569555695656957569585695956960569615696256963569645696556966569675696856969569705697156972569735697456975569765697756978569795698056981569825698356984569855698656987569885698956990569915699256993569945699556996569975699856999570005700157002570035700457005570065700757008570095701057011570125701357014570155701657017570185701957020570215702257023570245702557026570275702857029570305703157032570335703457035570365703757038570395704057041570425704357044570455704657047570485704957050570515705257053570545705557056570575705857059570605706157062570635706457065570665706757068570695707057071570725707357074570755707657077570785707957080570815708257083570845708557086570875708857089570905709157092570935709457095570965709757098570995710057101571025710357104571055710657107571085710957110571115711257113571145711557116571175711857119571205712157122571235712457125571265712757128571295713057131571325713357134571355713657137571385713957140571415714257143571445714557146571475714857149571505715157152571535715457155571565715757158571595716057161571625716357164571655716657167571685716957170571715717257173571745717557176571775717857179571805718157182571835718457185571865718757188571895719057191571925719357194571955719657197571985719957200572015720257203572045720557206572075720857209572105721157212572135721457215572165721757218572195722057221572225722357224572255722657227572285722957230572315723257233572345723557236572375723857239572405724157242572435724457245572465724757248572495725057251572525725357254572555725657257572585725957260572615726257263572645726557266572675726857269572705727157272572735727457275572765727757278572795728057281572825728357284572855728657287572885728957290572915729257293572945729557296572975729857299573005730157302573035730457305573065730757308573095731057311573125731357314573155731657317573185731957320573215732257323573245732557326573275732857329573305733157332573335733457335573365733757338573395734057341573425734357344573455734657347573485734957350573515735257353573545735557356573575735857359573605736157362573635736457365573665736757368573695737057371573725737357374573755737657377573785737957380573815738257383573845738557386573875738857389573905739157392573935739457395573965739757398573995740057401574025740357404574055740657407574085740957410574115741257413574145741557416574175741857419574205742157422574235742457425574265742757428574295743057431574325743357434574355743657437574385743957440574415744257443574445744557446574475744857449574505745157452574535745457455574565745757458574595746057461574625746357464574655746657467574685746957470574715747257473574745747557476574775747857479574805748157482574835748457485574865748757488574895749057491574925749357494574955749657497574985749957500575015750257503575045750557506575075750857509575105751157512575135751457515575165751757518575195752057521575225752357524575255752657527575285752957530575315753257533575345753557536575375753857539575405754157542575435754457545575465754757548575495755057551575525755357554575555755657557575585755957560575615756257563575645756557566575675756857569575705757157572575735757457575575765757757578575795758057581575825758357584575855758657587575885758957590575915759257593575945759557596575975759857599576005760157602576035760457605576065760757608576095761057611576125761357614576155761657617576185761957620576215762257623576245762557626576275762857629576305763157632576335763457635576365763757638576395764057641576425764357644576455764657647576485764957650576515765257653576545765557656576575765857659576605766157662576635766457665576665766757668576695767057671576725767357674576755767657677576785767957680576815768257683576845768557686576875768857689576905769157692576935769457695576965769757698576995770057701577025770357704577055770657707577085770957710577115771257713577145771557716577175771857719577205772157722577235772457725577265772757728577295773057731577325773357734577355773657737577385773957740577415774257743577445774557746577475774857749577505775157752577535775457755577565775757758577595776057761577625776357764577655776657767577685776957770577715777257773577745777557776577775777857779577805778157782577835778457785577865778757788577895779057791577925779357794577955779657797577985779957800578015780257803578045780557806578075780857809578105781157812578135781457815578165781757818578195782057821578225782357824578255782657827578285782957830578315783257833578345783557836578375783857839578405784157842578435784457845578465784757848578495785057851578525785357854578555785657857578585785957860578615786257863578645786557866578675786857869578705787157872578735787457875578765787757878578795788057881578825788357884578855788657887578885788957890578915789257893578945789557896578975789857899579005790157902579035790457905579065790757908579095791057911579125791357914579155791657917579185791957920579215792257923579245792557926579275792857929579305793157932579335793457935579365793757938579395794057941579425794357944579455794657947579485794957950579515795257953579545795557956579575795857959579605796157962579635796457965579665796757968579695797057971579725797357974579755797657977579785797957980579815798257983579845798557986579875798857989579905799157992579935799457995579965799757998579995800058001580025800358004580055800658007580085800958010580115801258013580145801558016580175801858019580205802158022580235802458025580265802758028580295803058031580325803358034580355803658037580385803958040580415804258043580445804558046580475804858049580505805158052580535805458055580565805758058580595806058061580625806358064580655806658067580685806958070580715807258073580745807558076580775807858079580805808158082580835808458085580865808758088580895809058091580925809358094580955809658097580985809958100581015810258103581045810558106581075810858109581105811158112581135811458115581165811758118581195812058121581225812358124581255812658127581285812958130581315813258133581345813558136581375813858139581405814158142581435814458145581465814758148581495815058151581525815358154581555815658157581585815958160581615816258163581645816558166581675816858169581705817158172581735817458175581765817758178581795818058181581825818358184581855818658187581885818958190581915819258193581945819558196581975819858199582005820158202582035820458205582065820758208582095821058211582125821358214582155821658217582185821958220582215822258223582245822558226582275822858229582305823158232582335823458235582365823758238582395824058241582425824358244582455824658247582485824958250582515825258253582545825558256582575825858259582605826158262582635826458265582665826758268582695827058271582725827358274582755827658277582785827958280582815828258283582845828558286582875828858289582905829158292582935829458295582965829758298582995830058301583025830358304583055830658307583085830958310583115831258313583145831558316583175831858319583205832158322583235832458325583265832758328583295833058331583325833358334583355833658337583385833958340583415834258343583445834558346583475834858349583505835158352583535835458355583565835758358583595836058361583625836358364583655836658367583685836958370583715837258373583745837558376583775837858379583805838158382583835838458385583865838758388583895839058391583925839358394583955839658397583985839958400584015840258403584045840558406584075840858409584105841158412584135841458415584165841758418584195842058421584225842358424584255842658427584285842958430584315843258433584345843558436584375843858439584405844158442584435844458445584465844758448584495845058451584525845358454584555845658457584585845958460584615846258463584645846558466584675846858469584705847158472584735847458475584765847758478584795848058481584825848358484584855848658487584885848958490584915849258493584945849558496584975849858499585005850158502585035850458505585065850758508585095851058511585125851358514585155851658517585185851958520585215852258523585245852558526585275852858529585305853158532585335853458535585365853758538585395854058541585425854358544585455854658547585485854958550585515855258553585545855558556585575855858559585605856158562585635856458565585665856758568585695857058571585725857358574585755857658577585785857958580585815858258583585845858558586585875858858589585905859158592585935859458595585965859758598585995860058601586025860358604586055860658607586085860958610586115861258613586145861558616586175861858619586205862158622586235862458625586265862758628586295863058631586325863358634586355863658637586385863958640586415864258643586445864558646586475864858649586505865158652586535865458655586565865758658586595866058661586625866358664586655866658667586685866958670586715867258673586745867558676586775867858679586805868158682586835868458685586865868758688586895869058691586925869358694586955869658697586985869958700587015870258703587045870558706587075870858709587105871158712587135871458715587165871758718587195872058721587225872358724587255872658727587285872958730587315873258733587345873558736587375873858739587405874158742587435874458745587465874758748587495875058751587525875358754587555875658757587585875958760587615876258763587645876558766587675876858769587705877158772587735877458775587765877758778587795878058781587825878358784587855878658787587885878958790587915879258793587945879558796587975879858799588005880158802588035880458805588065880758808588095881058811588125881358814588155881658817588185881958820588215882258823588245882558826588275882858829588305883158832588335883458835588365883758838588395884058841588425884358844588455884658847588485884958850588515885258853588545885558856588575885858859588605886158862588635886458865588665886758868588695887058871588725887358874588755887658877588785887958880588815888258883588845888558886588875888858889588905889158892588935889458895588965889758898588995890058901589025890358904589055890658907589085890958910589115891258913589145891558916589175891858919589205892158922589235892458925589265892758928589295893058931589325893358934589355893658937589385893958940589415894258943589445894558946589475894858949589505895158952589535895458955589565895758958589595896058961589625896358964589655896658967589685896958970589715897258973589745897558976589775897858979589805898158982589835898458985589865898758988589895899058991589925899358994589955899658997589985899959000590015900259003590045900559006590075900859009590105901159012590135901459015590165901759018590195902059021590225902359024590255902659027590285902959030590315903259033590345903559036590375903859039590405904159042590435904459045590465904759048590495905059051590525905359054590555905659057590585905959060590615906259063590645906559066590675906859069590705907159072590735907459075590765907759078590795908059081590825908359084590855908659087590885908959090590915909259093590945909559096590975909859099591005910159102591035910459105591065910759108591095911059111591125911359114591155911659117591185911959120591215912259123591245912559126591275912859129591305913159132591335913459135591365913759138591395914059141591425914359144591455914659147591485914959150591515915259153591545915559156591575915859159591605916159162591635916459165591665916759168591695917059171591725917359174591755917659177591785917959180591815918259183591845918559186591875918859189591905919159192591935919459195591965919759198591995920059201592025920359204592055920659207592085920959210592115921259213592145921559216592175921859219592205922159222592235922459225592265922759228592295923059231592325923359234592355923659237592385923959240592415924259243592445924559246592475924859249592505925159252592535925459255592565925759258592595926059261592625926359264592655926659267592685926959270592715927259273592745927559276592775927859279592805928159282592835928459285592865928759288592895929059291592925929359294592955929659297592985929959300593015930259303593045930559306593075930859309593105931159312593135931459315593165931759318593195932059321593225932359324593255932659327593285932959330593315933259333593345933559336593375933859339593405934159342593435934459345593465934759348593495935059351593525935359354593555935659357593585935959360593615936259363593645936559366593675936859369593705937159372593735937459375593765937759378593795938059381593825938359384593855938659387593885938959390593915939259393593945939559396
  1. /**
  2. * @license
  3. * Copyright 2010-2026 Three.js Authors
  4. * SPDX-License-Identifier: MIT
  5. */
  6. const REVISION = '183dev';
  7. /**
  8. * Represents mouse buttons and interaction types in context of controls.
  9. *
  10. * @type {ConstantsMouse}
  11. * @constant
  12. */
  13. const MOUSE = { LEFT: 0, MIDDLE: 1, RIGHT: 2, ROTATE: 0, DOLLY: 1, PAN: 2 };
  14. /**
  15. * Represents touch interaction types in context of controls.
  16. *
  17. * @type {ConstantsTouch}
  18. * @constant
  19. */
  20. const TOUCH = { ROTATE: 0, PAN: 1, DOLLY_PAN: 2, DOLLY_ROTATE: 3 };
  21. /**
  22. * Disables face culling.
  23. *
  24. * @type {number}
  25. * @constant
  26. */
  27. const CullFaceNone = 0;
  28. /**
  29. * Culls back faces.
  30. *
  31. * @type {number}
  32. * @constant
  33. */
  34. const CullFaceBack = 1;
  35. /**
  36. * Culls front faces.
  37. *
  38. * @type {number}
  39. * @constant
  40. */
  41. const CullFaceFront = 2;
  42. /**
  43. * Culls both front and back faces.
  44. *
  45. * @type {number}
  46. * @constant
  47. */
  48. const CullFaceFrontBack = 3;
  49. /**
  50. * Gives unfiltered shadow maps - fastest, but lowest quality.
  51. *
  52. * @type {number}
  53. * @constant
  54. */
  55. const BasicShadowMap = 0;
  56. /**
  57. * Filters shadow maps using the Percentage-Closer Filtering (PCF) algorithm.
  58. *
  59. * @type {number}
  60. * @constant
  61. */
  62. const PCFShadowMap = 1;
  63. /**
  64. * Filters shadow maps using the Percentage-Closer Filtering (PCF) algorithm with
  65. * better soft shadows especially when using low-resolution shadow maps.
  66. *
  67. * @type {number}
  68. * @constant
  69. */
  70. const PCFSoftShadowMap = 2;
  71. /**
  72. * Filters shadow maps using the Variance Shadow Map (VSM) algorithm.
  73. * When using VSMShadowMap all shadow receivers will also cast shadows.
  74. *
  75. * @type {number}
  76. * @constant
  77. */
  78. const VSMShadowMap = 3;
  79. /**
  80. * Only front faces are rendered.
  81. *
  82. * @type {number}
  83. * @constant
  84. */
  85. const FrontSide = 0;
  86. /**
  87. * Only back faces are rendered.
  88. *
  89. * @type {number}
  90. * @constant
  91. */
  92. const BackSide = 1;
  93. /**
  94. * Both front and back faces are rendered.
  95. *
  96. * @type {number}
  97. * @constant
  98. */
  99. const DoubleSide = 2;
  100. /**
  101. * No blending is performed which effectively disables
  102. * alpha transparency.
  103. *
  104. * @type {number}
  105. * @constant
  106. */
  107. const NoBlending = 0;
  108. /**
  109. * The default blending.
  110. *
  111. * @type {number}
  112. * @constant
  113. */
  114. const NormalBlending = 1;
  115. /**
  116. * Represents additive blending.
  117. *
  118. * @type {number}
  119. * @constant
  120. */
  121. const AdditiveBlending = 2;
  122. /**
  123. * Represents subtractive blending.
  124. *
  125. * @type {number}
  126. * @constant
  127. */
  128. const SubtractiveBlending = 3;
  129. /**
  130. * Represents multiply blending.
  131. *
  132. * @type {number}
  133. * @constant
  134. */
  135. const MultiplyBlending = 4;
  136. /**
  137. * Represents custom blending.
  138. *
  139. * @type {number}
  140. * @constant
  141. */
  142. const CustomBlending = 5;
  143. /**
  144. * Represents material blending.
  145. *
  146. * @type {number}
  147. * @constant
  148. */
  149. const MaterialBlending = 6;
  150. /**
  151. * A `source + destination` blending equation.
  152. *
  153. * @type {number}
  154. * @constant
  155. */
  156. const AddEquation = 100;
  157. /**
  158. * A `source - destination` blending equation.
  159. *
  160. * @type {number}
  161. * @constant
  162. */
  163. const SubtractEquation = 101;
  164. /**
  165. * A `destination - source` blending equation.
  166. *
  167. * @type {number}
  168. * @constant
  169. */
  170. const ReverseSubtractEquation = 102;
  171. /**
  172. * A blend equation that uses the minimum of source and destination.
  173. *
  174. * @type {number}
  175. * @constant
  176. */
  177. const MinEquation = 103;
  178. /**
  179. * A blend equation that uses the maximum of source and destination.
  180. *
  181. * @type {number}
  182. * @constant
  183. */
  184. const MaxEquation = 104;
  185. /**
  186. * Multiplies all colors by `0`.
  187. *
  188. * @type {number}
  189. * @constant
  190. */
  191. const ZeroFactor = 200;
  192. /**
  193. * Multiplies all colors by `1`.
  194. *
  195. * @type {number}
  196. * @constant
  197. */
  198. const OneFactor = 201;
  199. /**
  200. * Multiplies all colors by the source colors.
  201. *
  202. * @type {number}
  203. * @constant
  204. */
  205. const SrcColorFactor = 202;
  206. /**
  207. * Multiplies all colors by `1` minus each source color.
  208. *
  209. * @type {number}
  210. * @constant
  211. */
  212. const OneMinusSrcColorFactor = 203;
  213. /**
  214. * Multiplies all colors by the source alpha value.
  215. *
  216. * @type {number}
  217. * @constant
  218. */
  219. const SrcAlphaFactor = 204;
  220. /**
  221. * Multiplies all colors by 1 minus the source alpha value.
  222. *
  223. * @type {number}
  224. * @constant
  225. */
  226. const OneMinusSrcAlphaFactor = 205;
  227. /**
  228. * Multiplies all colors by the destination alpha value.
  229. *
  230. * @type {number}
  231. * @constant
  232. */
  233. const DstAlphaFactor = 206;
  234. /**
  235. * Multiplies all colors by `1` minus the destination alpha value.
  236. *
  237. * @type {number}
  238. * @constant
  239. */
  240. const OneMinusDstAlphaFactor = 207;
  241. /**
  242. * Multiplies all colors by the destination color.
  243. *
  244. * @type {number}
  245. * @constant
  246. */
  247. const DstColorFactor = 208;
  248. /**
  249. * Multiplies all colors by `1` minus each destination color.
  250. *
  251. * @type {number}
  252. * @constant
  253. */
  254. const OneMinusDstColorFactor = 209;
  255. /**
  256. * Multiplies the RGB colors by the smaller of either the source alpha
  257. * value or the value of `1` minus the destination alpha value. The alpha
  258. * value is multiplied by `1`.
  259. *
  260. * @type {number}
  261. * @constant
  262. */
  263. const SrcAlphaSaturateFactor = 210;
  264. /**
  265. * Multiplies all colors by a constant color.
  266. *
  267. * @type {number}
  268. * @constant
  269. */
  270. const ConstantColorFactor = 211;
  271. /**
  272. * Multiplies all colors by `1` minus a constant color.
  273. *
  274. * @type {number}
  275. * @constant
  276. */
  277. const OneMinusConstantColorFactor = 212;
  278. /**
  279. * Multiplies all colors by a constant alpha value.
  280. *
  281. * @type {number}
  282. * @constant
  283. */
  284. const ConstantAlphaFactor = 213;
  285. /**
  286. * Multiplies all colors by 1 minus a constant alpha value.
  287. *
  288. * @type {number}
  289. * @constant
  290. */
  291. const OneMinusConstantAlphaFactor = 214;
  292. /**
  293. * Never pass.
  294. *
  295. * @type {number}
  296. * @constant
  297. */
  298. const NeverDepth = 0;
  299. /**
  300. * Always pass.
  301. *
  302. * @type {number}
  303. * @constant
  304. */
  305. const AlwaysDepth = 1;
  306. /**
  307. * Pass if the incoming value is less than the depth buffer value.
  308. *
  309. * @type {number}
  310. * @constant
  311. */
  312. const LessDepth = 2;
  313. /**
  314. * Pass if the incoming value is less than or equal to the depth buffer value.
  315. *
  316. * @type {number}
  317. * @constant
  318. */
  319. const LessEqualDepth = 3;
  320. /**
  321. * Pass if the incoming value equals the depth buffer value.
  322. *
  323. * @type {number}
  324. * @constant
  325. */
  326. const EqualDepth = 4;
  327. /**
  328. * Pass if the incoming value is greater than or equal to the depth buffer value.
  329. *
  330. * @type {number}
  331. * @constant
  332. */
  333. const GreaterEqualDepth = 5;
  334. /**
  335. * Pass if the incoming value is greater than the depth buffer value.
  336. *
  337. * @type {number}
  338. * @constant
  339. */
  340. const GreaterDepth = 6;
  341. /**
  342. * Pass if the incoming value is not equal to the depth buffer value.
  343. *
  344. * @type {number}
  345. * @constant
  346. */
  347. const NotEqualDepth = 7;
  348. /**
  349. * Multiplies the environment map color with the surface color.
  350. *
  351. * @type {number}
  352. * @constant
  353. */
  354. const MultiplyOperation = 0;
  355. /**
  356. * Uses reflectivity to blend between the two colors.
  357. *
  358. * @type {number}
  359. * @constant
  360. */
  361. const MixOperation = 1;
  362. /**
  363. * Adds the two colors.
  364. *
  365. * @type {number}
  366. * @constant
  367. */
  368. const AddOperation = 2;
  369. /**
  370. * No tone mapping is applied.
  371. *
  372. * @type {number}
  373. * @constant
  374. */
  375. const NoToneMapping = 0;
  376. /**
  377. * Linear tone mapping.
  378. *
  379. * @type {number}
  380. * @constant
  381. */
  382. const LinearToneMapping = 1;
  383. /**
  384. * Reinhard tone mapping.
  385. *
  386. * @type {number}
  387. * @constant
  388. */
  389. const ReinhardToneMapping = 2;
  390. /**
  391. * Cineon tone mapping.
  392. *
  393. * @type {number}
  394. * @constant
  395. */
  396. const CineonToneMapping = 3;
  397. /**
  398. * ACES Filmic tone mapping.
  399. *
  400. * @type {number}
  401. * @constant
  402. */
  403. const ACESFilmicToneMapping = 4;
  404. /**
  405. * Custom tone mapping.
  406. *
  407. * Expects a custom implementation by modifying shader code of the material's fragment shader.
  408. *
  409. * @type {number}
  410. * @constant
  411. */
  412. const CustomToneMapping = 5;
  413. /**
  414. * AgX tone mapping.
  415. *
  416. * @type {number}
  417. * @constant
  418. */
  419. const AgXToneMapping = 6;
  420. /**
  421. * Neutral tone mapping.
  422. *
  423. * Implementation based on the Khronos 3D Commerce Group standard tone mapping.
  424. *
  425. * @type {number}
  426. * @constant
  427. */
  428. const NeutralToneMapping = 7;
  429. /**
  430. * The skinned mesh shares the same world space as the skeleton.
  431. *
  432. * @type {string}
  433. * @constant
  434. */
  435. const AttachedBindMode = 'attached';
  436. /**
  437. * The skinned mesh does not share the same world space as the skeleton.
  438. * This is useful when a skeleton is shared across multiple skinned meshes.
  439. *
  440. * @type {string}
  441. * @constant
  442. */
  443. const DetachedBindMode = 'detached';
  444. /**
  445. * Maps textures using the geometry's UV coordinates.
  446. *
  447. * @type {number}
  448. * @constant
  449. */
  450. const UVMapping = 300;
  451. /**
  452. * Reflection mapping for cube textures.
  453. *
  454. * @type {number}
  455. * @constant
  456. */
  457. const CubeReflectionMapping = 301;
  458. /**
  459. * Refraction mapping for cube textures.
  460. *
  461. * @type {number}
  462. * @constant
  463. */
  464. const CubeRefractionMapping = 302;
  465. /**
  466. * Reflection mapping for equirectangular textures.
  467. *
  468. * @type {number}
  469. * @constant
  470. */
  471. const EquirectangularReflectionMapping = 303;
  472. /**
  473. * Refraction mapping for equirectangular textures.
  474. *
  475. * @type {number}
  476. * @constant
  477. */
  478. const EquirectangularRefractionMapping = 304;
  479. /**
  480. * Reflection mapping for PMREM textures.
  481. *
  482. * @type {number}
  483. * @constant
  484. */
  485. const CubeUVReflectionMapping = 306;
  486. /**
  487. * The texture will simply repeat to infinity.
  488. *
  489. * @type {number}
  490. * @constant
  491. */
  492. const RepeatWrapping = 1000;
  493. /**
  494. * The last pixel of the texture stretches to the edge of the mesh.
  495. *
  496. * @type {number}
  497. * @constant
  498. */
  499. const ClampToEdgeWrapping = 1001;
  500. /**
  501. * The texture will repeats to infinity, mirroring on each repeat.
  502. *
  503. * @type {number}
  504. * @constant
  505. */
  506. const MirroredRepeatWrapping = 1002;
  507. /**
  508. * Returns the value of the texture element that is nearest (in Manhattan distance)
  509. * to the specified texture coordinates.
  510. *
  511. * @type {number}
  512. * @constant
  513. */
  514. const NearestFilter = 1003;
  515. /**
  516. * Chooses the mipmap that most closely matches the size of the pixel being textured
  517. * and uses the `NearestFilter` criterion (the texel nearest to the center of the pixel)
  518. * to produce a texture value.
  519. *
  520. * @type {number}
  521. * @constant
  522. */
  523. const NearestMipmapNearestFilter = 1004;
  524. const NearestMipMapNearestFilter = 1004; // legacy
  525. /**
  526. * Chooses the two mipmaps that most closely match the size of the pixel being textured and
  527. * uses the `NearestFilter` criterion to produce a texture value from each mipmap.
  528. * The final texture value is a weighted average of those two values.
  529. *
  530. * @type {number}
  531. * @constant
  532. */
  533. const NearestMipmapLinearFilter = 1005;
  534. const NearestMipMapLinearFilter = 1005; // legacy
  535. /**
  536. * Returns the weighted average of the four texture elements that are closest to the specified
  537. * texture coordinates, and can include items wrapped or repeated from other parts of a texture,
  538. * depending on the values of `wrapS` and `wrapT`, and on the exact mapping.
  539. *
  540. * @type {number}
  541. * @constant
  542. */
  543. const LinearFilter = 1006;
  544. /**
  545. * Chooses the mipmap that most closely matches the size of the pixel being textured and uses
  546. * the `LinearFilter` criterion (a weighted average of the four texels that are closest to the
  547. * center of the pixel) to produce a texture value.
  548. *
  549. * @type {number}
  550. * @constant
  551. */
  552. const LinearMipmapNearestFilter = 1007;
  553. const LinearMipMapNearestFilter = 1007; // legacy
  554. /**
  555. * Chooses the two mipmaps that most closely match the size of the pixel being textured and uses
  556. * the `LinearFilter` criterion to produce a texture value from each mipmap. The final texture value
  557. * is a weighted average of those two values.
  558. *
  559. * @type {number}
  560. * @constant
  561. */
  562. const LinearMipmapLinearFilter = 1008;
  563. const LinearMipMapLinearFilter = 1008; // legacy
  564. /**
  565. * An unsigned byte data type for textures.
  566. *
  567. * @type {number}
  568. * @constant
  569. */
  570. const UnsignedByteType = 1009;
  571. /**
  572. * A byte data type for textures.
  573. *
  574. * @type {number}
  575. * @constant
  576. */
  577. const ByteType = 1010;
  578. /**
  579. * A short data type for textures.
  580. *
  581. * @type {number}
  582. * @constant
  583. */
  584. const ShortType = 1011;
  585. /**
  586. * An unsigned short data type for textures.
  587. *
  588. * @type {number}
  589. * @constant
  590. */
  591. const UnsignedShortType = 1012;
  592. /**
  593. * An int data type for textures.
  594. *
  595. * @type {number}
  596. * @constant
  597. */
  598. const IntType = 1013;
  599. /**
  600. * An unsigned int data type for textures.
  601. *
  602. * @type {number}
  603. * @constant
  604. */
  605. const UnsignedIntType = 1014;
  606. /**
  607. * A float data type for textures.
  608. *
  609. * @type {number}
  610. * @constant
  611. */
  612. const FloatType = 1015;
  613. /**
  614. * A half float data type for textures.
  615. *
  616. * @type {number}
  617. * @constant
  618. */
  619. const HalfFloatType = 1016;
  620. /**
  621. * An unsigned short 4_4_4_4 (packed) data type for textures.
  622. *
  623. * @type {number}
  624. * @constant
  625. */
  626. const UnsignedShort4444Type = 1017;
  627. /**
  628. * An unsigned short 5_5_5_1 (packed) data type for textures.
  629. *
  630. * @type {number}
  631. * @constant
  632. */
  633. const UnsignedShort5551Type = 1018;
  634. /**
  635. * An unsigned int 24_8 data type for textures.
  636. *
  637. * @type {number}
  638. * @constant
  639. */
  640. const UnsignedInt248Type = 1020;
  641. /**
  642. * An unsigned int 5_9_9_9 (packed) data type for textures.
  643. *
  644. * @type {number}
  645. * @constant
  646. */
  647. const UnsignedInt5999Type = 35902;
  648. /**
  649. * An unsigned int 10_11_11 (packed) data type for textures.
  650. *
  651. * @type {number}
  652. * @constant
  653. */
  654. const UnsignedInt101111Type = 35899;
  655. /**
  656. * Discards the red, green and blue components and reads just the alpha component.
  657. *
  658. * @type {number}
  659. * @constant
  660. */
  661. const AlphaFormat = 1021;
  662. /**
  663. * Discards the alpha component and reads the red, green and blue component.
  664. *
  665. * @type {number}
  666. * @constant
  667. */
  668. const RGBFormat = 1022;
  669. /**
  670. * Reads the red, green, blue and alpha components.
  671. *
  672. * @type {number}
  673. * @constant
  674. */
  675. const RGBAFormat = 1023;
  676. /**
  677. * Reads each element as a single depth value, converts it to floating point, and clamps to the range `[0,1]`.
  678. *
  679. * @type {number}
  680. * @constant
  681. */
  682. const DepthFormat = 1026;
  683. /**
  684. * Reads each element is a pair of depth and stencil values. The depth component of the pair is interpreted as
  685. * in `DepthFormat`. The stencil component is interpreted based on the depth + stencil internal format.
  686. *
  687. * @type {number}
  688. * @constant
  689. */
  690. const DepthStencilFormat = 1027;
  691. /**
  692. * Discards the green, blue and alpha components and reads just the red component.
  693. *
  694. * @type {number}
  695. * @constant
  696. */
  697. const RedFormat = 1028;
  698. /**
  699. * Discards the green, blue and alpha components and reads just the red component. The texels are read as integers instead of floating point.
  700. *
  701. * @type {number}
  702. * @constant
  703. */
  704. const RedIntegerFormat = 1029;
  705. /**
  706. * Discards the alpha, and blue components and reads the red, and green components.
  707. *
  708. * @type {number}
  709. * @constant
  710. */
  711. const RGFormat = 1030;
  712. /**
  713. * Discards the alpha, and blue components and reads the red, and green components. The texels are read as integers instead of floating point.
  714. *
  715. * @type {number}
  716. * @constant
  717. */
  718. const RGIntegerFormat = 1031;
  719. /**
  720. * Discards the alpha component and reads the red, green and blue component. The texels are read as integers instead of floating point.
  721. *
  722. * @type {number}
  723. * @constant
  724. */
  725. const RGBIntegerFormat = 1032;
  726. /**
  727. * Reads the red, green, blue and alpha components. The texels are read as integers instead of floating point.
  728. *
  729. * @type {number}
  730. * @constant
  731. */
  732. const RGBAIntegerFormat = 1033;
  733. /**
  734. * A DXT1-compressed image in an RGB image format.
  735. *
  736. * @type {number}
  737. * @constant
  738. */
  739. const RGB_S3TC_DXT1_Format = 33776;
  740. /**
  741. * A DXT1-compressed image in an RGB image format with a simple on/off alpha value.
  742. *
  743. * @type {number}
  744. * @constant
  745. */
  746. const RGBA_S3TC_DXT1_Format = 33777;
  747. /**
  748. * A DXT3-compressed image in an RGBA image format. Compared to a 32-bit RGBA texture, it offers 4:1 compression.
  749. *
  750. * @type {number}
  751. * @constant
  752. */
  753. const RGBA_S3TC_DXT3_Format = 33778;
  754. /**
  755. * A DXT5-compressed image in an RGBA image format. It also provides a 4:1 compression, but differs to the DXT3
  756. * compression in how the alpha compression is done.
  757. *
  758. * @type {number}
  759. * @constant
  760. */
  761. const RGBA_S3TC_DXT5_Format = 33779;
  762. /**
  763. * PVRTC RGB compression in 4-bit mode. One block for each 4×4 pixels.
  764. *
  765. * @type {number}
  766. * @constant
  767. */
  768. const RGB_PVRTC_4BPPV1_Format = 35840;
  769. /**
  770. * PVRTC RGB compression in 2-bit mode. One block for each 8×4 pixels.
  771. *
  772. * @type {number}
  773. * @constant
  774. */
  775. const RGB_PVRTC_2BPPV1_Format = 35841;
  776. /**
  777. * PVRTC RGBA compression in 4-bit mode. One block for each 4×4 pixels.
  778. *
  779. * @type {number}
  780. * @constant
  781. */
  782. const RGBA_PVRTC_4BPPV1_Format = 35842;
  783. /**
  784. * PVRTC RGBA compression in 2-bit mode. One block for each 8×4 pixels.
  785. *
  786. * @type {number}
  787. * @constant
  788. */
  789. const RGBA_PVRTC_2BPPV1_Format = 35843;
  790. /**
  791. * ETC1 RGB format.
  792. *
  793. * @type {number}
  794. * @constant
  795. */
  796. const RGB_ETC1_Format = 36196;
  797. /**
  798. * ETC2 RGB format.
  799. *
  800. * @type {number}
  801. * @constant
  802. */
  803. const RGB_ETC2_Format = 37492;
  804. /**
  805. * ETC2 RGBA format.
  806. *
  807. * @type {number}
  808. * @constant
  809. */
  810. const RGBA_ETC2_EAC_Format = 37496;
  811. /**
  812. * EAC R11 UNORM format.
  813. *
  814. * @type {number}
  815. * @constant
  816. */
  817. const R11_EAC_Format = 37488; // 0x9270
  818. /**
  819. * EAC R11 SNORM format.
  820. *
  821. * @type {number}
  822. * @constant
  823. */
  824. const SIGNED_R11_EAC_Format = 37489; // 0x9271
  825. /**
  826. * EAC RG11 UNORM format.
  827. *
  828. * @type {number}
  829. * @constant
  830. */
  831. const RG11_EAC_Format = 37490; // 0x9272
  832. /**
  833. * EAC RG11 SNORM format.
  834. *
  835. * @type {number}
  836. * @constant
  837. */
  838. const SIGNED_RG11_EAC_Format = 37491; // 0x9273
  839. /**
  840. * ASTC RGBA 4x4 format.
  841. *
  842. * @type {number}
  843. * @constant
  844. */
  845. const RGBA_ASTC_4x4_Format = 37808;
  846. /**
  847. * ASTC RGBA 5x4 format.
  848. *
  849. * @type {number}
  850. * @constant
  851. */
  852. const RGBA_ASTC_5x4_Format = 37809;
  853. /**
  854. * ASTC RGBA 5x5 format.
  855. *
  856. * @type {number}
  857. * @constant
  858. */
  859. const RGBA_ASTC_5x5_Format = 37810;
  860. /**
  861. * ASTC RGBA 6x5 format.
  862. *
  863. * @type {number}
  864. * @constant
  865. */
  866. const RGBA_ASTC_6x5_Format = 37811;
  867. /**
  868. * ASTC RGBA 6x6 format.
  869. *
  870. * @type {number}
  871. * @constant
  872. */
  873. const RGBA_ASTC_6x6_Format = 37812;
  874. /**
  875. * ASTC RGBA 8x5 format.
  876. *
  877. * @type {number}
  878. * @constant
  879. */
  880. const RGBA_ASTC_8x5_Format = 37813;
  881. /**
  882. * ASTC RGBA 8x6 format.
  883. *
  884. * @type {number}
  885. * @constant
  886. */
  887. const RGBA_ASTC_8x6_Format = 37814;
  888. /**
  889. * ASTC RGBA 8x8 format.
  890. *
  891. * @type {number}
  892. * @constant
  893. */
  894. const RGBA_ASTC_8x8_Format = 37815;
  895. /**
  896. * ASTC RGBA 10x5 format.
  897. *
  898. * @type {number}
  899. * @constant
  900. */
  901. const RGBA_ASTC_10x5_Format = 37816;
  902. /**
  903. * ASTC RGBA 10x6 format.
  904. *
  905. * @type {number}
  906. * @constant
  907. */
  908. const RGBA_ASTC_10x6_Format = 37817;
  909. /**
  910. * ASTC RGBA 10x8 format.
  911. *
  912. * @type {number}
  913. * @constant
  914. */
  915. const RGBA_ASTC_10x8_Format = 37818;
  916. /**
  917. * ASTC RGBA 10x10 format.
  918. *
  919. * @type {number}
  920. * @constant
  921. */
  922. const RGBA_ASTC_10x10_Format = 37819;
  923. /**
  924. * ASTC RGBA 12x10 format.
  925. *
  926. * @type {number}
  927. * @constant
  928. */
  929. const RGBA_ASTC_12x10_Format = 37820;
  930. /**
  931. * ASTC RGBA 12x12 format.
  932. *
  933. * @type {number}
  934. * @constant
  935. */
  936. const RGBA_ASTC_12x12_Format = 37821;
  937. /**
  938. * BPTC RGBA format.
  939. *
  940. * @type {number}
  941. * @constant
  942. */
  943. const RGBA_BPTC_Format = 36492;
  944. /**
  945. * BPTC Signed RGB format.
  946. *
  947. * @type {number}
  948. * @constant
  949. */
  950. const RGB_BPTC_SIGNED_Format = 36494;
  951. /**
  952. * BPTC Unsigned RGB format.
  953. *
  954. * @type {number}
  955. * @constant
  956. */
  957. const RGB_BPTC_UNSIGNED_Format = 36495;
  958. /**
  959. * RGTC1 Red format.
  960. *
  961. * @type {number}
  962. * @constant
  963. */
  964. const RED_RGTC1_Format = 36283;
  965. /**
  966. * RGTC1 Signed Red format.
  967. *
  968. * @type {number}
  969. * @constant
  970. */
  971. const SIGNED_RED_RGTC1_Format = 36284;
  972. /**
  973. * RGTC2 Red Green format.
  974. *
  975. * @type {number}
  976. * @constant
  977. */
  978. const RED_GREEN_RGTC2_Format = 36285;
  979. /**
  980. * RGTC2 Signed Red Green format.
  981. *
  982. * @type {number}
  983. * @constant
  984. */
  985. const SIGNED_RED_GREEN_RGTC2_Format = 36286;
  986. /**
  987. * Animations are played once.
  988. *
  989. * @type {number}
  990. * @constant
  991. */
  992. const LoopOnce = 2200;
  993. /**
  994. * Animations are played with a chosen number of repetitions, each time jumping from
  995. * the end of the clip directly to its beginning.
  996. *
  997. * @type {number}
  998. * @constant
  999. */
  1000. const LoopRepeat = 2201;
  1001. /**
  1002. * Animations are played with a chosen number of repetitions, alternately playing forward
  1003. * and backward.
  1004. *
  1005. * @type {number}
  1006. * @constant
  1007. */
  1008. const LoopPingPong = 2202;
  1009. /**
  1010. * Discrete interpolation mode for keyframe tracks.
  1011. *
  1012. * @type {number}
  1013. * @constant
  1014. */
  1015. const InterpolateDiscrete = 2300;
  1016. /**
  1017. * Linear interpolation mode for keyframe tracks.
  1018. *
  1019. * @type {number}
  1020. * @constant
  1021. */
  1022. const InterpolateLinear = 2301;
  1023. /**
  1024. * Smooth interpolation mode for keyframe tracks.
  1025. *
  1026. * @type {number}
  1027. * @constant
  1028. */
  1029. const InterpolateSmooth = 2302;
  1030. /**
  1031. * Bezier interpolation mode for keyframe tracks.
  1032. *
  1033. * Uses cubic Bezier curves with explicit 2D control points.
  1034. * Requires tangent data to be set on the track.
  1035. *
  1036. * @type {number}
  1037. * @constant
  1038. */
  1039. const InterpolateBezier = 2303;
  1040. /**
  1041. * Zero curvature ending for animations.
  1042. *
  1043. * @type {number}
  1044. * @constant
  1045. */
  1046. const ZeroCurvatureEnding = 2400;
  1047. /**
  1048. * Zero slope ending for animations.
  1049. *
  1050. * @type {number}
  1051. * @constant
  1052. */
  1053. const ZeroSlopeEnding = 2401;
  1054. /**
  1055. * Wrap around ending for animations.
  1056. *
  1057. * @type {number}
  1058. * @constant
  1059. */
  1060. const WrapAroundEnding = 2402;
  1061. /**
  1062. * Default animation blend mode.
  1063. *
  1064. * @type {number}
  1065. * @constant
  1066. */
  1067. const NormalAnimationBlendMode = 2500;
  1068. /**
  1069. * Additive animation blend mode. Can be used to layer motions on top of
  1070. * each other to build complex performances from smaller re-usable assets.
  1071. *
  1072. * @type {number}
  1073. * @constant
  1074. */
  1075. const AdditiveAnimationBlendMode = 2501;
  1076. /**
  1077. * For every three vertices draw a single triangle.
  1078. *
  1079. * @type {number}
  1080. * @constant
  1081. */
  1082. const TrianglesDrawMode = 0;
  1083. /**
  1084. * For each vertex draw a triangle from the last three vertices.
  1085. *
  1086. * @type {number}
  1087. * @constant
  1088. */
  1089. const TriangleStripDrawMode = 1;
  1090. /**
  1091. * For each vertex draw a triangle from the first vertex and the last two vertices.
  1092. *
  1093. * @type {number}
  1094. * @constant
  1095. */
  1096. const TriangleFanDrawMode = 2;
  1097. /**
  1098. * The depth value is inverted (1.0 - z) for visualization purposes.
  1099. *
  1100. * @type {number}
  1101. * @constant
  1102. */
  1103. const BasicDepthPacking = 3200;
  1104. /**
  1105. * The depth value is packed into 32 bit RGBA.
  1106. *
  1107. * @type {number}
  1108. * @constant
  1109. */
  1110. const RGBADepthPacking = 3201;
  1111. /**
  1112. * The depth value is packed into 24 bit RGB.
  1113. *
  1114. * @type {number}
  1115. * @constant
  1116. */
  1117. const RGBDepthPacking = 3202;
  1118. /**
  1119. * The depth value is packed into 16 bit RG.
  1120. *
  1121. * @type {number}
  1122. * @constant
  1123. */
  1124. const RGDepthPacking = 3203;
  1125. /**
  1126. * Normal information is relative to the underlying surface.
  1127. *
  1128. * @type {number}
  1129. * @constant
  1130. */
  1131. const TangentSpaceNormalMap = 0;
  1132. /**
  1133. * Normal information is relative to the object orientation.
  1134. *
  1135. * @type {number}
  1136. * @constant
  1137. */
  1138. const ObjectSpaceNormalMap = 1;
  1139. // Color space string identifiers, matching CSS Color Module Level 4 and WebGPU names where available.
  1140. /**
  1141. * No color space.
  1142. *
  1143. * @type {string}
  1144. * @constant
  1145. */
  1146. const NoColorSpace = '';
  1147. /**
  1148. * sRGB color space.
  1149. *
  1150. * @type {string}
  1151. * @constant
  1152. */
  1153. const SRGBColorSpace = 'srgb';
  1154. /**
  1155. * sRGB-linear color space.
  1156. *
  1157. * @type {string}
  1158. * @constant
  1159. */
  1160. const LinearSRGBColorSpace = 'srgb-linear';
  1161. /**
  1162. * Linear transfer function.
  1163. *
  1164. * @type {string}
  1165. * @constant
  1166. */
  1167. const LinearTransfer = 'linear';
  1168. /**
  1169. * sRGB transfer function.
  1170. *
  1171. * @type {string}
  1172. * @constant
  1173. */
  1174. const SRGBTransfer = 'srgb';
  1175. /**
  1176. * No normal map packing.
  1177. *
  1178. * @type {string}
  1179. * @constant
  1180. */
  1181. const NoNormalPacking = '';
  1182. /**
  1183. * Normal RG packing.
  1184. *
  1185. * @type {string}
  1186. * @constant
  1187. */
  1188. const NormalRGPacking = 'rg';
  1189. /**
  1190. * Normal GA packing.
  1191. *
  1192. * @type {string}
  1193. * @constant
  1194. */
  1195. const NormalGAPacking = 'ga';
  1196. /**
  1197. * Sets the stencil buffer value to `0`.
  1198. *
  1199. * @type {number}
  1200. * @constant
  1201. */
  1202. const ZeroStencilOp = 0;
  1203. /**
  1204. * Keeps the current value.
  1205. *
  1206. * @type {number}
  1207. * @constant
  1208. */
  1209. const KeepStencilOp = 7680;
  1210. /**
  1211. * Sets the stencil buffer value to the specified reference value.
  1212. *
  1213. * @type {number}
  1214. * @constant
  1215. */
  1216. const ReplaceStencilOp = 7681;
  1217. /**
  1218. * Increments the current stencil buffer value. Clamps to the maximum representable unsigned value.
  1219. *
  1220. * @type {number}
  1221. * @constant
  1222. */
  1223. const IncrementStencilOp = 7682;
  1224. /**
  1225. * Decrements the current stencil buffer value. Clamps to `0`.
  1226. *
  1227. * @type {number}
  1228. * @constant
  1229. */
  1230. const DecrementStencilOp = 7683;
  1231. /**
  1232. * Increments the current stencil buffer value. Wraps stencil buffer value to zero when incrementing
  1233. * the maximum representable unsigned value.
  1234. *
  1235. * @type {number}
  1236. * @constant
  1237. */
  1238. const IncrementWrapStencilOp = 34055;
  1239. /**
  1240. * Decrements the current stencil buffer value. Wraps stencil buffer value to the maximum representable
  1241. * unsigned value when decrementing a stencil buffer value of `0`.
  1242. *
  1243. * @type {number}
  1244. * @constant
  1245. */
  1246. const DecrementWrapStencilOp = 34056;
  1247. /**
  1248. * Inverts the current stencil buffer value bitwise.
  1249. *
  1250. * @type {number}
  1251. * @constant
  1252. */
  1253. const InvertStencilOp = 5386;
  1254. /**
  1255. * Will never return true.
  1256. *
  1257. * @type {number}
  1258. * @constant
  1259. */
  1260. const NeverStencilFunc = 512;
  1261. /**
  1262. * Will return true if the stencil reference value is less than the current stencil value.
  1263. *
  1264. * @type {number}
  1265. * @constant
  1266. */
  1267. const LessStencilFunc = 513;
  1268. /**
  1269. * Will return true if the stencil reference value is equal to the current stencil value.
  1270. *
  1271. * @type {number}
  1272. * @constant
  1273. */
  1274. const EqualStencilFunc = 514;
  1275. /**
  1276. * Will return true if the stencil reference value is less than or equal to the current stencil value.
  1277. *
  1278. * @type {number}
  1279. * @constant
  1280. */
  1281. const LessEqualStencilFunc = 515;
  1282. /**
  1283. * Will return true if the stencil reference value is greater than the current stencil value.
  1284. *
  1285. * @type {number}
  1286. * @constant
  1287. */
  1288. const GreaterStencilFunc = 516;
  1289. /**
  1290. * Will return true if the stencil reference value is not equal to the current stencil value.
  1291. *
  1292. * @type {number}
  1293. * @constant
  1294. */
  1295. const NotEqualStencilFunc = 517;
  1296. /**
  1297. * Will return true if the stencil reference value is greater than or equal to the current stencil value.
  1298. *
  1299. * @type {number}
  1300. * @constant
  1301. */
  1302. const GreaterEqualStencilFunc = 518;
  1303. /**
  1304. * Will always return true.
  1305. *
  1306. * @type {number}
  1307. * @constant
  1308. */
  1309. const AlwaysStencilFunc = 519;
  1310. /**
  1311. * Never pass.
  1312. *
  1313. * @type {number}
  1314. * @constant
  1315. */
  1316. const NeverCompare = 512;
  1317. /**
  1318. * Pass if the incoming value is less than the texture value.
  1319. *
  1320. * @type {number}
  1321. * @constant
  1322. */
  1323. const LessCompare = 513;
  1324. /**
  1325. * Pass if the incoming value equals the texture value.
  1326. *
  1327. * @type {number}
  1328. * @constant
  1329. */
  1330. const EqualCompare = 514;
  1331. /**
  1332. * Pass if the incoming value is less than or equal to the texture value.
  1333. *
  1334. * @type {number}
  1335. * @constant
  1336. */
  1337. const LessEqualCompare = 515;
  1338. /**
  1339. * Pass if the incoming value is greater than the texture value.
  1340. *
  1341. * @type {number}
  1342. * @constant
  1343. */
  1344. const GreaterCompare = 516;
  1345. /**
  1346. * Pass if the incoming value is not equal to the texture value.
  1347. *
  1348. * @type {number}
  1349. * @constant
  1350. */
  1351. const NotEqualCompare = 517;
  1352. /**
  1353. * Pass if the incoming value is greater than or equal to the texture value.
  1354. *
  1355. * @type {number}
  1356. * @constant
  1357. */
  1358. const GreaterEqualCompare = 518;
  1359. /**
  1360. * Always pass.
  1361. *
  1362. * @type {number}
  1363. * @constant
  1364. */
  1365. const AlwaysCompare = 519;
  1366. /**
  1367. * The contents are intended to be specified once by the application, and used many
  1368. * times as the source for drawing and image specification commands.
  1369. *
  1370. * @type {number}
  1371. * @constant
  1372. */
  1373. const StaticDrawUsage = 35044;
  1374. /**
  1375. * The contents are intended to be respecified repeatedly by the application, and
  1376. * used many times as the source for drawing and image specification commands.
  1377. *
  1378. * @type {number}
  1379. * @constant
  1380. */
  1381. const DynamicDrawUsage = 35048;
  1382. /**
  1383. * The contents are intended to be specified once by the application, and used at most
  1384. * a few times as the source for drawing and image specification commands.
  1385. *
  1386. * @type {number}
  1387. * @constant
  1388. */
  1389. const StreamDrawUsage = 35040;
  1390. /**
  1391. * The contents are intended to be specified once by reading data from the 3D API, and queried
  1392. * many times by the application.
  1393. *
  1394. * @type {number}
  1395. * @constant
  1396. */
  1397. const StaticReadUsage = 35045;
  1398. /**
  1399. * The contents are intended to be respecified repeatedly by reading data from the 3D API, and queried
  1400. * many times by the application.
  1401. *
  1402. * @type {number}
  1403. * @constant
  1404. */
  1405. const DynamicReadUsage = 35049;
  1406. /**
  1407. * The contents are intended to be specified once by reading data from the 3D API, and queried at most
  1408. * a few times by the application
  1409. *
  1410. * @type {number}
  1411. * @constant
  1412. */
  1413. const StreamReadUsage = 35041;
  1414. /**
  1415. * The contents are intended to be specified once by reading data from the 3D API, and used many times as
  1416. * the source for WebGL drawing and image specification commands.
  1417. *
  1418. * @type {number}
  1419. * @constant
  1420. */
  1421. const StaticCopyUsage = 35046;
  1422. /**
  1423. * The contents are intended to be respecified repeatedly by reading data from the 3D API, and used many times
  1424. * as the source for WebGL drawing and image specification commands.
  1425. *
  1426. * @type {number}
  1427. * @constant
  1428. */
  1429. const DynamicCopyUsage = 35050;
  1430. /**
  1431. * The contents are intended to be specified once by reading data from the 3D API, and used at most a few times
  1432. * as the source for WebGL drawing and image specification commands.
  1433. *
  1434. * @type {number}
  1435. * @constant
  1436. */
  1437. const StreamCopyUsage = 35042;
  1438. /**
  1439. * GLSL 1 shader code.
  1440. *
  1441. * @type {string}
  1442. * @constant
  1443. */
  1444. const GLSL1 = '100';
  1445. /**
  1446. * GLSL 3 shader code.
  1447. *
  1448. * @type {string}
  1449. * @constant
  1450. */
  1451. const GLSL3 = '300 es';
  1452. /**
  1453. * WebGL coordinate system.
  1454. *
  1455. * @type {number}
  1456. * @constant
  1457. */
  1458. const WebGLCoordinateSystem = 2000;
  1459. /**
  1460. * WebGPU coordinate system.
  1461. *
  1462. * @type {number}
  1463. * @constant
  1464. */
  1465. const WebGPUCoordinateSystem = 2001;
  1466. /**
  1467. * Represents the different timestamp query types.
  1468. *
  1469. * @type {ConstantsTimestampQuery}
  1470. * @constant
  1471. */
  1472. const TimestampQuery = {
  1473. COMPUTE: 'compute',
  1474. RENDER: 'render'
  1475. };
  1476. /**
  1477. * Represents mouse buttons and interaction types in context of controls.
  1478. *
  1479. * @type {ConstantsInterpolationSamplingType}
  1480. * @constant
  1481. */
  1482. const InterpolationSamplingType = {
  1483. PERSPECTIVE: 'perspective',
  1484. LINEAR: 'linear',
  1485. FLAT: 'flat'
  1486. };
  1487. /**
  1488. * Represents the different interpolation sampling modes.
  1489. *
  1490. * @type {ConstantsInterpolationSamplingMode}
  1491. * @constant
  1492. */
  1493. const InterpolationSamplingMode = {
  1494. NORMAL: 'normal',
  1495. CENTROID: 'centroid',
  1496. SAMPLE: 'sample',
  1497. FIRST: 'first',
  1498. EITHER: 'either'
  1499. };
  1500. /**
  1501. * Compatibility flags for features that may not be supported across all platforms.
  1502. *
  1503. * @type {Object}
  1504. * @constant
  1505. */
  1506. const Compatibility = {
  1507. TEXTURE_COMPARE: 'depthTextureCompare'
  1508. };
  1509. /**
  1510. * This type represents mouse buttons and interaction types in context of controls.
  1511. *
  1512. * @typedef {Object} ConstantsMouse
  1513. * @property {number} MIDDLE - The left mouse button.
  1514. * @property {number} LEFT - The middle mouse button.
  1515. * @property {number} RIGHT - The right mouse button.
  1516. * @property {number} ROTATE - A rotate interaction.
  1517. * @property {number} DOLLY - A dolly interaction.
  1518. * @property {number} PAN - A pan interaction.
  1519. **/
  1520. /**
  1521. * This type represents touch interaction types in context of controls.
  1522. *
  1523. * @typedef {Object} ConstantsTouch
  1524. * @property {number} ROTATE - A rotate interaction.
  1525. * @property {number} PAN - A pan interaction.
  1526. * @property {number} DOLLY_PAN - The dolly-pan interaction.
  1527. * @property {number} DOLLY_ROTATE - A dolly-rotate interaction.
  1528. **/
  1529. /**
  1530. * This type represents the different timestamp query types.
  1531. *
  1532. * @typedef {Object} ConstantsTimestampQuery
  1533. * @property {string} COMPUTE - A `compute` timestamp query.
  1534. * @property {string} RENDER - A `render` timestamp query.
  1535. **/
  1536. /**
  1537. * Represents the different interpolation sampling types.
  1538. *
  1539. * @typedef {Object} ConstantsInterpolationSamplingType
  1540. * @property {string} PERSPECTIVE - Perspective-correct interpolation.
  1541. * @property {string} LINEAR - Linear interpolation.
  1542. * @property {string} FLAT - Flat interpolation.
  1543. */
  1544. /**
  1545. * Represents the different interpolation sampling modes.
  1546. *
  1547. * @typedef {Object} ConstantsInterpolationSamplingMode
  1548. * @property {string} NORMAL - Normal sampling mode.
  1549. * @property {string} CENTROID - Centroid sampling mode.
  1550. * @property {string} SAMPLE - Sample-specific sampling mode.
  1551. * @property {string} FIRST - Flat interpolation using the first vertex.
  1552. * @property {string} EITHER - Flat interpolation using either vertex.
  1553. */
  1554. /**
  1555. * Finds the minimum value in an array.
  1556. *
  1557. * @private
  1558. * @param {Array<number>} array - The array to search for the minimum value.
  1559. * @return {number} The minimum value in the array, or Infinity if the array is empty.
  1560. */
  1561. /**
  1562. * Checks if an array contains values that require Uint32 representation.
  1563. *
  1564. * This function determines whether the array contains any values >= 65535,
  1565. * which would require a Uint32Array rather than a Uint16Array for proper storage.
  1566. * The function iterates from the end of the array, assuming larger values are
  1567. * typically located at the end.
  1568. *
  1569. * @private
  1570. * @param {Array<number>} array - The array to check.
  1571. * @return {boolean} True if the array contains values >= 65535, false otherwise.
  1572. */
  1573. function arrayNeedsUint32( array ) {
  1574. // assumes larger values usually on last
  1575. for ( let i = array.length - 1; i >= 0; -- i ) {
  1576. if ( array[ i ] >= 65535 ) return true; // account for PRIMITIVE_RESTART_FIXED_INDEX, #24565
  1577. }
  1578. return false;
  1579. }
  1580. /**
  1581. * Map of typed array constructor names to their constructors.
  1582. * This mapping enables dynamic creation of typed arrays based on string type names.
  1583. *
  1584. * @private
  1585. * @constant
  1586. * @type {Object<string, TypedArrayConstructor>}
  1587. */
  1588. const TYPED_ARRAYS = {
  1589. Int8Array: Int8Array,
  1590. Uint8Array: Uint8Array,
  1591. Uint8ClampedArray: Uint8ClampedArray,
  1592. Int16Array: Int16Array,
  1593. Uint16Array: Uint16Array,
  1594. Int32Array: Int32Array,
  1595. Uint32Array: Uint32Array,
  1596. Float32Array: Float32Array,
  1597. Float64Array: Float64Array
  1598. };
  1599. /**
  1600. * Creates a typed array of the specified type from the given buffer.
  1601. *
  1602. * @private
  1603. * @param {string} type - The name of the typed array type (e.g., 'Float32Array', 'Uint16Array').
  1604. * @param {ArrayBuffer} buffer - The buffer to create the typed array from.
  1605. * @return {TypedArray} A new typed array of the specified type.
  1606. */
  1607. function getTypedArray( type, buffer ) {
  1608. return new TYPED_ARRAYS[ type ]( buffer );
  1609. }
  1610. /**
  1611. * Returns `true` if the given object is a typed array.
  1612. *
  1613. * @param {any} array - The object to check.
  1614. * @return {boolean} Whether the given object is a typed array.
  1615. */
  1616. function isTypedArray( array ) {
  1617. return ArrayBuffer.isView( array ) && ! ( array instanceof DataView );
  1618. }
  1619. /**
  1620. * Creates an XHTML element with the specified tag name.
  1621. *
  1622. * This function uses the XHTML namespace to create DOM elements,
  1623. * ensuring proper element creation in XML-based contexts.
  1624. *
  1625. * @private
  1626. * @param {string} name - The tag name of the element to create (e.g., 'canvas', 'div').
  1627. * @return {HTMLElement} The created XHTML element.
  1628. */
  1629. function createElementNS( name ) {
  1630. return document.createElementNS( 'http://www.w3.org/1999/xhtml', name );
  1631. }
  1632. /**
  1633. * Creates a canvas element configured for block display.
  1634. *
  1635. * This is a convenience function that creates a canvas element with
  1636. * display style set to 'block', which is commonly used in three.js
  1637. * rendering contexts to avoid inline element spacing issues.
  1638. *
  1639. * @return {HTMLCanvasElement} A canvas element with display set to 'block'.
  1640. */
  1641. function createCanvasElement() {
  1642. const canvas = createElementNS( 'canvas' );
  1643. canvas.style.display = 'block';
  1644. return canvas;
  1645. }
  1646. /**
  1647. * Internal cache for tracking warning messages to prevent duplicate warnings.
  1648. *
  1649. * @private
  1650. * @type {Object<string, boolean>}
  1651. */
  1652. const _cache = {};
  1653. /**
  1654. * Custom console function handler for intercepting log, warn, and error calls.
  1655. *
  1656. * @private
  1657. * @type {Function|null}
  1658. */
  1659. let _setConsoleFunction = null;
  1660. /**
  1661. * Sets a custom function to handle console output.
  1662. *
  1663. * This allows external code to intercept and handle console.log, console.warn,
  1664. * and console.error calls made by three.js, which is useful for custom logging,
  1665. * testing, or debugging workflows.
  1666. *
  1667. * @param {Function} fn - The function to handle console output. Should accept
  1668. * (type, message, ...params) where type is 'log', 'warn', or 'error'.
  1669. */
  1670. function setConsoleFunction( fn ) {
  1671. _setConsoleFunction = fn;
  1672. }
  1673. /**
  1674. * Gets the currently set custom console function.
  1675. *
  1676. * @return {Function|null} The custom console function, or null if not set.
  1677. */
  1678. function getConsoleFunction() {
  1679. return _setConsoleFunction;
  1680. }
  1681. /**
  1682. * Logs an informational message with the 'THREE.' prefix.
  1683. *
  1684. * If a custom console function is set via setConsoleFunction(), it will be used
  1685. * instead of the native console.log. The first parameter is treated as the
  1686. * method name and is automatically prefixed with 'THREE.'.
  1687. *
  1688. * @param {...any} params - The message components. The first param is used as
  1689. * the method name and prefixed with 'THREE.'.
  1690. */
  1691. function log( ...params ) {
  1692. const message = 'THREE.' + params.shift();
  1693. if ( _setConsoleFunction ) {
  1694. _setConsoleFunction( 'log', message, ...params );
  1695. } else {
  1696. console.log( message, ...params );
  1697. }
  1698. }
  1699. /**
  1700. * Enhances log/warn/error messages related to TSL.
  1701. *
  1702. * @param {Array<any>} params - The original message parameters.
  1703. * @returns {Array<any>} The filtered and enhanced message parameters.
  1704. */
  1705. function enhanceLogMessage( params ) {
  1706. const message = params[ 0 ];
  1707. if ( typeof message === 'string' && message.startsWith( 'TSL:' ) ) {
  1708. const stackTrace = params[ 1 ];
  1709. if ( stackTrace && stackTrace.isStackTrace ) {
  1710. params[ 0 ] += ' ' + stackTrace.getLocation();
  1711. } else {
  1712. params[ 1 ] = 'Stack trace not available. Enable "THREE.Node.captureStackTrace" to capture stack traces.';
  1713. }
  1714. }
  1715. return params;
  1716. }
  1717. /**
  1718. * Logs a warning message with the 'THREE.' prefix.
  1719. *
  1720. * If a custom console function is set via setConsoleFunction(), it will be used
  1721. * instead of the native console.warn. The first parameter is treated as the
  1722. * method name and is automatically prefixed with 'THREE.'.
  1723. *
  1724. * @param {...any} params - The message components. The first param is used as
  1725. * the method name and prefixed with 'THREE.'.
  1726. */
  1727. function warn( ...params ) {
  1728. params = enhanceLogMessage( params );
  1729. const message = 'THREE.' + params.shift();
  1730. if ( _setConsoleFunction ) {
  1731. _setConsoleFunction( 'warn', message, ...params );
  1732. } else {
  1733. const stackTrace = params[ 0 ];
  1734. if ( stackTrace && stackTrace.isStackTrace ) {
  1735. console.warn( stackTrace.getError( message ) );
  1736. } else {
  1737. console.warn( message, ...params );
  1738. }
  1739. }
  1740. }
  1741. /**
  1742. * Logs an error message with the 'THREE.' prefix.
  1743. *
  1744. * If a custom console function is set via setConsoleFunction(), it will be used
  1745. * instead of the native console.error. The first parameter is treated as the
  1746. * method name and is automatically prefixed with 'THREE.'.
  1747. *
  1748. * @param {...any} params - The message components. The first param is used as
  1749. * the method name and prefixed with 'THREE.'.
  1750. */
  1751. function error( ...params ) {
  1752. params = enhanceLogMessage( params );
  1753. const message = 'THREE.' + params.shift();
  1754. if ( _setConsoleFunction ) {
  1755. _setConsoleFunction( 'error', message, ...params );
  1756. } else {
  1757. const stackTrace = params[ 0 ];
  1758. if ( stackTrace && stackTrace.isStackTrace ) {
  1759. console.error( stackTrace.getError( message ) );
  1760. } else {
  1761. console.error( message, ...params );
  1762. }
  1763. }
  1764. }
  1765. /**
  1766. * Logs a warning message only once, preventing duplicate warnings.
  1767. *
  1768. * This function maintains an internal cache of warning messages and will only
  1769. * output each unique warning message once. Useful for warnings that may be
  1770. * triggered repeatedly but should only be shown to the user once.
  1771. *
  1772. * @param {...any} params - The warning message components.
  1773. */
  1774. function warnOnce( ...params ) {
  1775. const message = params.join( ' ' );
  1776. if ( message in _cache ) return;
  1777. _cache[ message ] = true;
  1778. warn( ...params );
  1779. }
  1780. /**
  1781. * Asynchronously probes for WebGL sync object completion.
  1782. *
  1783. * This function creates a promise that resolves when the WebGL sync object
  1784. * signals completion or rejects if the sync operation fails. It uses polling
  1785. * at the specified interval to check the sync status without blocking the
  1786. * main thread. This is useful for GPU-CPU synchronization in WebGL contexts.
  1787. *
  1788. * @private
  1789. * @param {WebGLRenderingContext|WebGL2RenderingContext} gl - The WebGL rendering context.
  1790. * @param {WebGLSync} sync - The WebGL sync object to wait for.
  1791. * @param {number} interval - The polling interval in milliseconds.
  1792. * @return {Promise<void>} A promise that resolves when the sync completes or rejects if it fails.
  1793. */
  1794. function probeAsync( gl, sync, interval ) {
  1795. return new Promise( function ( resolve, reject ) {
  1796. function probe() {
  1797. switch ( gl.clientWaitSync( sync, gl.SYNC_FLUSH_COMMANDS_BIT, 0 ) ) {
  1798. case gl.WAIT_FAILED:
  1799. reject();
  1800. break;
  1801. case gl.TIMEOUT_EXPIRED:
  1802. setTimeout( probe, interval );
  1803. break;
  1804. default:
  1805. resolve();
  1806. }
  1807. }
  1808. setTimeout( probe, interval );
  1809. } );
  1810. }
  1811. /**
  1812. * This modules allows to dispatch event objects on custom JavaScript objects.
  1813. *
  1814. * Main repository: [eventdispatcher.js](https://github.com/mrdoob/eventdispatcher.js/)
  1815. *
  1816. * Code Example:
  1817. * ```js
  1818. * class Car extends EventDispatcher {
  1819. * start() {
  1820. * this.dispatchEvent( { type: 'start', message: 'vroom vroom!' } );
  1821. * }
  1822. *};
  1823. *
  1824. * // Using events with the custom object
  1825. * const car = new Car();
  1826. * car.addEventListener( 'start', function ( event ) {
  1827. * alert( event.message );
  1828. * } );
  1829. *
  1830. * car.start();
  1831. * ```
  1832. */
  1833. class EventDispatcher {
  1834. /**
  1835. * Adds the given event listener to the given event type.
  1836. *
  1837. * @param {string} type - The type of event to listen to.
  1838. * @param {Function} listener - The function that gets called when the event is fired.
  1839. */
  1840. addEventListener( type, listener ) {
  1841. if ( this._listeners === undefined ) this._listeners = {};
  1842. const listeners = this._listeners;
  1843. if ( listeners[ type ] === undefined ) {
  1844. listeners[ type ] = [];
  1845. }
  1846. if ( listeners[ type ].indexOf( listener ) === -1 ) {
  1847. listeners[ type ].push( listener );
  1848. }
  1849. }
  1850. /**
  1851. * Returns `true` if the given event listener has been added to the given event type.
  1852. *
  1853. * @param {string} type - The type of event.
  1854. * @param {Function} listener - The listener to check.
  1855. * @return {boolean} Whether the given event listener has been added to the given event type.
  1856. */
  1857. hasEventListener( type, listener ) {
  1858. const listeners = this._listeners;
  1859. if ( listeners === undefined ) return false;
  1860. return listeners[ type ] !== undefined && listeners[ type ].indexOf( listener ) !== -1;
  1861. }
  1862. /**
  1863. * Removes the given event listener from the given event type.
  1864. *
  1865. * @param {string} type - The type of event.
  1866. * @param {Function} listener - The listener to remove.
  1867. */
  1868. removeEventListener( type, listener ) {
  1869. const listeners = this._listeners;
  1870. if ( listeners === undefined ) return;
  1871. const listenerArray = listeners[ type ];
  1872. if ( listenerArray !== undefined ) {
  1873. const index = listenerArray.indexOf( listener );
  1874. if ( index !== -1 ) {
  1875. listenerArray.splice( index, 1 );
  1876. }
  1877. }
  1878. }
  1879. /**
  1880. * Dispatches an event object.
  1881. *
  1882. * @param {Object} event - The event that gets fired.
  1883. */
  1884. dispatchEvent( event ) {
  1885. const listeners = this._listeners;
  1886. if ( listeners === undefined ) return;
  1887. const listenerArray = listeners[ event.type ];
  1888. if ( listenerArray !== undefined ) {
  1889. event.target = this;
  1890. // Make a copy, in case listeners are removed while iterating.
  1891. const array = listenerArray.slice( 0 );
  1892. for ( let i = 0, l = array.length; i < l; i ++ ) {
  1893. array[ i ].call( this, event );
  1894. }
  1895. event.target = null;
  1896. }
  1897. }
  1898. }
  1899. const _lut = [ '00', '01', '02', '03', '04', '05', '06', '07', '08', '09', '0a', '0b', '0c', '0d', '0e', '0f', '10', '11', '12', '13', '14', '15', '16', '17', '18', '19', '1a', '1b', '1c', '1d', '1e', '1f', '20', '21', '22', '23', '24', '25', '26', '27', '28', '29', '2a', '2b', '2c', '2d', '2e', '2f', '30', '31', '32', '33', '34', '35', '36', '37', '38', '39', '3a', '3b', '3c', '3d', '3e', '3f', '40', '41', '42', '43', '44', '45', '46', '47', '48', '49', '4a', '4b', '4c', '4d', '4e', '4f', '50', '51', '52', '53', '54', '55', '56', '57', '58', '59', '5a', '5b', '5c', '5d', '5e', '5f', '60', '61', '62', '63', '64', '65', '66', '67', '68', '69', '6a', '6b', '6c', '6d', '6e', '6f', '70', '71', '72', '73', '74', '75', '76', '77', '78', '79', '7a', '7b', '7c', '7d', '7e', '7f', '80', '81', '82', '83', '84', '85', '86', '87', '88', '89', '8a', '8b', '8c', '8d', '8e', '8f', '90', '91', '92', '93', '94', '95', '96', '97', '98', '99', '9a', '9b', '9c', '9d', '9e', '9f', 'a0', 'a1', 'a2', 'a3', 'a4', 'a5', 'a6', 'a7', 'a8', 'a9', 'aa', 'ab', 'ac', 'ad', 'ae', 'af', 'b0', 'b1', 'b2', 'b3', 'b4', 'b5', 'b6', 'b7', 'b8', 'b9', 'ba', 'bb', 'bc', 'bd', 'be', 'bf', 'c0', 'c1', 'c2', 'c3', 'c4', 'c5', 'c6', 'c7', 'c8', 'c9', 'ca', 'cb', 'cc', 'cd', 'ce', 'cf', 'd0', 'd1', 'd2', 'd3', 'd4', 'd5', 'd6', 'd7', 'd8', 'd9', 'da', 'db', 'dc', 'dd', 'de', 'df', 'e0', 'e1', 'e2', 'e3', 'e4', 'e5', 'e6', 'e7', 'e8', 'e9', 'ea', 'eb', 'ec', 'ed', 'ee', 'ef', 'f0', 'f1', 'f2', 'f3', 'f4', 'f5', 'f6', 'f7', 'f8', 'f9', 'fa', 'fb', 'fc', 'fd', 'fe', 'ff' ];
  1900. let _seed = 1234567;
  1901. const DEG2RAD = Math.PI / 180;
  1902. const RAD2DEG = 180 / Math.PI;
  1903. /**
  1904. * Generate a [UUID](https://en.wikipedia.org/wiki/Universally_unique_identifier)
  1905. * (universally unique identifier).
  1906. *
  1907. * @return {string} The UUID.
  1908. */
  1909. function generateUUID() {
  1910. // http://stackoverflow.com/questions/105034/how-to-create-a-guid-uuid-in-javascript/21963136#21963136
  1911. const d0 = Math.random() * 0xffffffff | 0;
  1912. const d1 = Math.random() * 0xffffffff | 0;
  1913. const d2 = Math.random() * 0xffffffff | 0;
  1914. const d3 = Math.random() * 0xffffffff | 0;
  1915. const uuid = _lut[ d0 & 0xff ] + _lut[ d0 >> 8 & 0xff ] + _lut[ d0 >> 16 & 0xff ] + _lut[ d0 >> 24 & 0xff ] + '-' +
  1916. _lut[ d1 & 0xff ] + _lut[ d1 >> 8 & 0xff ] + '-' + _lut[ d1 >> 16 & 0x0f | 0x40 ] + _lut[ d1 >> 24 & 0xff ] + '-' +
  1917. _lut[ d2 & 0x3f | 0x80 ] + _lut[ d2 >> 8 & 0xff ] + '-' + _lut[ d2 >> 16 & 0xff ] + _lut[ d2 >> 24 & 0xff ] +
  1918. _lut[ d3 & 0xff ] + _lut[ d3 >> 8 & 0xff ] + _lut[ d3 >> 16 & 0xff ] + _lut[ d3 >> 24 & 0xff ];
  1919. // .toLowerCase() here flattens concatenated strings to save heap memory space.
  1920. return uuid.toLowerCase();
  1921. }
  1922. /**
  1923. * Clamps the given value between min and max.
  1924. *
  1925. * @param {number} value - The value to clamp.
  1926. * @param {number} min - The min value.
  1927. * @param {number} max - The max value.
  1928. * @return {number} The clamped value.
  1929. */
  1930. function clamp( value, min, max ) {
  1931. return Math.max( min, Math.min( max, value ) );
  1932. }
  1933. /**
  1934. * Computes the Euclidean modulo of the given parameters that
  1935. * is `( ( n % m ) + m ) % m`.
  1936. *
  1937. * @param {number} n - The first parameter.
  1938. * @param {number} m - The second parameter.
  1939. * @return {number} The Euclidean modulo.
  1940. */
  1941. function euclideanModulo( n, m ) {
  1942. // https://en.wikipedia.org/wiki/Modulo_operation
  1943. return ( ( n % m ) + m ) % m;
  1944. }
  1945. /**
  1946. * Performs a linear mapping from range `<a1, a2>` to range `<b1, b2>`
  1947. * for the given value. `a2` must be greater than `a1`.
  1948. *
  1949. * @param {number} x - The value to be mapped.
  1950. * @param {number} a1 - Minimum value for range A.
  1951. * @param {number} a2 - Maximum value for range A.
  1952. * @param {number} b1 - Minimum value for range B.
  1953. * @param {number} b2 - Maximum value for range B.
  1954. * @return {number} The mapped value.
  1955. */
  1956. function mapLinear( x, a1, a2, b1, b2 ) {
  1957. return b1 + ( x - a1 ) * ( b2 - b1 ) / ( a2 - a1 );
  1958. }
  1959. /**
  1960. * Returns the percentage in the closed interval `[0, 1]` of the given value
  1961. * between the start and end point.
  1962. *
  1963. * @param {number} x - The start point
  1964. * @param {number} y - The end point.
  1965. * @param {number} value - A value between start and end.
  1966. * @return {number} The interpolation factor.
  1967. */
  1968. function inverseLerp( x, y, value ) {
  1969. // https://www.gamedev.net/tutorials/programming/general-and-gameplay-programming/inverse-lerp-a-super-useful-yet-often-overlooked-function-r5230/
  1970. if ( x !== y ) {
  1971. return ( value - x ) / ( y - x );
  1972. } else {
  1973. return 0;
  1974. }
  1975. }
  1976. /**
  1977. * Returns a value linearly interpolated from two known points based on the given interval -
  1978. * `t = 0` will return `x` and `t = 1` will return `y`.
  1979. *
  1980. * @param {number} x - The start point
  1981. * @param {number} y - The end point.
  1982. * @param {number} t - The interpolation factor in the closed interval `[0, 1]`.
  1983. * @return {number} The interpolated value.
  1984. */
  1985. function lerp( x, y, t ) {
  1986. return ( 1 - t ) * x + t * y;
  1987. }
  1988. /**
  1989. * Smoothly interpolate a number from `x` to `y` in a spring-like manner using a delta
  1990. * time to maintain frame rate independent movement. For details, see
  1991. * [Frame rate independent damping using lerp](http://www.rorydriscoll.com/2016/03/07/frame-rate-independent-damping-using-lerp/).
  1992. *
  1993. * @param {number} x - The current point.
  1994. * @param {number} y - The target point.
  1995. * @param {number} lambda - A higher lambda value will make the movement more sudden,
  1996. * and a lower value will make the movement more gradual.
  1997. * @param {number} dt - Delta time in seconds.
  1998. * @return {number} The interpolated value.
  1999. */
  2000. function damp( x, y, lambda, dt ) {
  2001. return lerp( x, y, 1 - Math.exp( - lambda * dt ) );
  2002. }
  2003. /**
  2004. * Returns a value that alternates between `0` and the given `length` parameter.
  2005. *
  2006. * @param {number} x - The value to pingpong.
  2007. * @param {number} [length=1] - The positive value the function will pingpong to.
  2008. * @return {number} The alternated value.
  2009. */
  2010. function pingpong( x, length = 1 ) {
  2011. // https://www.desmos.com/calculator/vcsjnyz7x4
  2012. return length - Math.abs( euclideanModulo( x, length * 2 ) - length );
  2013. }
  2014. /**
  2015. * Returns a value in the range `[0,1]` that represents the percentage that `x` has
  2016. * moved between `min` and `max`, but smoothed or slowed down the closer `x` is to
  2017. * the `min` and `max`.
  2018. *
  2019. * See [Smoothstep](http://en.wikipedia.org/wiki/Smoothstep) for more details.
  2020. *
  2021. * @param {number} x - The value to evaluate based on its position between `min` and `max`.
  2022. * @param {number} min - The min value. Any `x` value below `min` will be `0`. `min` must be lower than `max`.
  2023. * @param {number} max - The max value. Any `x` value above `max` will be `1`. `max` must be greater than `min`.
  2024. * @return {number} The alternated value.
  2025. */
  2026. function smoothstep( x, min, max ) {
  2027. if ( x <= min ) return 0;
  2028. if ( x >= max ) return 1;
  2029. x = ( x - min ) / ( max - min );
  2030. return x * x * ( 3 - 2 * x );
  2031. }
  2032. /**
  2033. * A [variation on smoothstep](https://en.wikipedia.org/wiki/Smoothstep#Variations)
  2034. * that has zero 1st and 2nd order derivatives at `x=0` and `x=1`.
  2035. *
  2036. * @param {number} x - The value to evaluate based on its position between `min` and `max`.
  2037. * @param {number} min - The min value. Any `x` value below `min` will be `0`. `min` must be lower than `max`.
  2038. * @param {number} max - The max value. Any `x` value above `max` will be `1`. `max` must be greater than `min`.
  2039. * @return {number} The alternated value.
  2040. */
  2041. function smootherstep( x, min, max ) {
  2042. if ( x <= min ) return 0;
  2043. if ( x >= max ) return 1;
  2044. x = ( x - min ) / ( max - min );
  2045. return x * x * x * ( x * ( x * 6 - 15 ) + 10 );
  2046. }
  2047. /**
  2048. * Returns a random integer from `<low, high>` interval.
  2049. *
  2050. * @param {number} low - The lower value boundary.
  2051. * @param {number} high - The upper value boundary
  2052. * @return {number} A random integer.
  2053. */
  2054. function randInt( low, high ) {
  2055. return low + Math.floor( Math.random() * ( high - low + 1 ) );
  2056. }
  2057. /**
  2058. * Returns a random float from `<low, high>` interval.
  2059. *
  2060. * @param {number} low - The lower value boundary.
  2061. * @param {number} high - The upper value boundary
  2062. * @return {number} A random float.
  2063. */
  2064. function randFloat( low, high ) {
  2065. return low + Math.random() * ( high - low );
  2066. }
  2067. /**
  2068. * Returns a random integer from `<-range/2, range/2>` interval.
  2069. *
  2070. * @param {number} range - Defines the value range.
  2071. * @return {number} A random float.
  2072. */
  2073. function randFloatSpread( range ) {
  2074. return range * ( 0.5 - Math.random() );
  2075. }
  2076. /**
  2077. * Returns a deterministic pseudo-random float in the interval `[0, 1]`.
  2078. *
  2079. * @param {number} [s] - The integer seed.
  2080. * @return {number} A random float.
  2081. */
  2082. function seededRandom( s ) {
  2083. if ( s !== undefined ) _seed = s;
  2084. // Mulberry32 generator
  2085. let t = _seed += 0x6D2B79F5;
  2086. t = Math.imul( t ^ t >>> 15, t | 1 );
  2087. t ^= t + Math.imul( t ^ t >>> 7, t | 61 );
  2088. return ( ( t ^ t >>> 14 ) >>> 0 ) / 4294967296;
  2089. }
  2090. /**
  2091. * Converts degrees to radians.
  2092. *
  2093. * @param {number} degrees - A value in degrees.
  2094. * @return {number} The converted value in radians.
  2095. */
  2096. function degToRad( degrees ) {
  2097. return degrees * DEG2RAD;
  2098. }
  2099. /**
  2100. * Converts radians to degrees.
  2101. *
  2102. * @param {number} radians - A value in radians.
  2103. * @return {number} The converted value in degrees.
  2104. */
  2105. function radToDeg( radians ) {
  2106. return radians * RAD2DEG;
  2107. }
  2108. /**
  2109. * Returns `true` if the given number is a power of two.
  2110. *
  2111. * @param {number} value - The value to check.
  2112. * @return {boolean} Whether the given number is a power of two or not.
  2113. */
  2114. function isPowerOfTwo( value ) {
  2115. return ( value & ( value - 1 ) ) === 0 && value !== 0;
  2116. }
  2117. /**
  2118. * Returns the smallest power of two that is greater than or equal to the given number.
  2119. *
  2120. * @param {number} value - The value to find a POT for. Must be greater than `0`.
  2121. * @return {number} The smallest power of two that is greater than or equal to the given number.
  2122. */
  2123. function ceilPowerOfTwo( value ) {
  2124. return Math.pow( 2, Math.ceil( Math.log( value ) / Math.LN2 ) );
  2125. }
  2126. /**
  2127. * Returns the largest power of two that is less than or equal to the given number.
  2128. *
  2129. * @param {number} value - The value to find a POT for. Must be greater than `0`.
  2130. * @return {number} The largest power of two that is less than or equal to the given number.
  2131. */
  2132. function floorPowerOfTwo( value ) {
  2133. return Math.pow( 2, Math.floor( Math.log( value ) / Math.LN2 ) );
  2134. }
  2135. /**
  2136. * Sets the given quaternion from the [Intrinsic Proper Euler Angles](https://en.wikipedia.org/wiki/Euler_angles)
  2137. * defined by the given angles and order.
  2138. *
  2139. * Rotations are applied to the axes in the order specified by order:
  2140. * rotation by angle `a` is applied first, then by angle `b`, then by angle `c`.
  2141. *
  2142. * @param {Quaternion} q - The quaternion to set.
  2143. * @param {number} a - The rotation applied to the first axis, in radians.
  2144. * @param {number} b - The rotation applied to the second axis, in radians.
  2145. * @param {number} c - The rotation applied to the third axis, in radians.
  2146. * @param {('XYX'|'XZX'|'YXY'|'YZY'|'ZXZ'|'ZYZ')} order - A string specifying the axes order.
  2147. */
  2148. function setQuaternionFromProperEuler( q, a, b, c, order ) {
  2149. const cos = Math.cos;
  2150. const sin = Math.sin;
  2151. const c2 = cos( b / 2 );
  2152. const s2 = sin( b / 2 );
  2153. const c13 = cos( ( a + c ) / 2 );
  2154. const s13 = sin( ( a + c ) / 2 );
  2155. const c1_3 = cos( ( a - c ) / 2 );
  2156. const s1_3 = sin( ( a - c ) / 2 );
  2157. const c3_1 = cos( ( c - a ) / 2 );
  2158. const s3_1 = sin( ( c - a ) / 2 );
  2159. switch ( order ) {
  2160. case 'XYX':
  2161. q.set( c2 * s13, s2 * c1_3, s2 * s1_3, c2 * c13 );
  2162. break;
  2163. case 'YZY':
  2164. q.set( s2 * s1_3, c2 * s13, s2 * c1_3, c2 * c13 );
  2165. break;
  2166. case 'ZXZ':
  2167. q.set( s2 * c1_3, s2 * s1_3, c2 * s13, c2 * c13 );
  2168. break;
  2169. case 'XZX':
  2170. q.set( c2 * s13, s2 * s3_1, s2 * c3_1, c2 * c13 );
  2171. break;
  2172. case 'YXY':
  2173. q.set( s2 * c3_1, c2 * s13, s2 * s3_1, c2 * c13 );
  2174. break;
  2175. case 'ZYZ':
  2176. q.set( s2 * s3_1, s2 * c3_1, c2 * s13, c2 * c13 );
  2177. break;
  2178. default:
  2179. warn( 'MathUtils: .setQuaternionFromProperEuler() encountered an unknown order: ' + order );
  2180. }
  2181. }
  2182. /**
  2183. * Denormalizes the given value according to the given typed array.
  2184. *
  2185. * @param {number} value - The value to denormalize.
  2186. * @param {TypedArray} array - The typed array that defines the data type of the value.
  2187. * @return {number} The denormalize (float) value in the range `[0,1]`.
  2188. */
  2189. function denormalize( value, array ) {
  2190. switch ( array.constructor ) {
  2191. case Float32Array:
  2192. return value;
  2193. case Uint32Array:
  2194. return value / 4294967295.0;
  2195. case Uint16Array:
  2196. return value / 65535.0;
  2197. case Uint8Array:
  2198. return value / 255.0;
  2199. case Int32Array:
  2200. return Math.max( value / 2147483647.0, -1 );
  2201. case Int16Array:
  2202. return Math.max( value / 32767.0, -1 );
  2203. case Int8Array:
  2204. return Math.max( value / 127.0, -1 );
  2205. default:
  2206. throw new Error( 'Invalid component type.' );
  2207. }
  2208. }
  2209. /**
  2210. * Normalizes the given value according to the given typed array.
  2211. *
  2212. * @param {number} value - The float value in the range `[0,1]` to normalize.
  2213. * @param {TypedArray} array - The typed array that defines the data type of the value.
  2214. * @return {number} The normalize value.
  2215. */
  2216. function normalize( value, array ) {
  2217. switch ( array.constructor ) {
  2218. case Float32Array:
  2219. return value;
  2220. case Uint32Array:
  2221. return Math.round( value * 4294967295.0 );
  2222. case Uint16Array:
  2223. return Math.round( value * 65535.0 );
  2224. case Uint8Array:
  2225. return Math.round( value * 255.0 );
  2226. case Int32Array:
  2227. return Math.round( value * 2147483647.0 );
  2228. case Int16Array:
  2229. return Math.round( value * 32767.0 );
  2230. case Int8Array:
  2231. return Math.round( value * 127.0 );
  2232. default:
  2233. throw new Error( 'Invalid component type.' );
  2234. }
  2235. }
  2236. /**
  2237. * @class
  2238. * @classdesc A collection of math utility functions.
  2239. * @hideconstructor
  2240. */
  2241. const MathUtils = {
  2242. DEG2RAD: DEG2RAD,
  2243. RAD2DEG: RAD2DEG,
  2244. /**
  2245. * Generate a [UUID](https://en.wikipedia.org/wiki/Universally_unique_identifier)
  2246. * (universally unique identifier).
  2247. *
  2248. * @static
  2249. * @method
  2250. * @return {string} The UUID.
  2251. */
  2252. generateUUID: generateUUID,
  2253. /**
  2254. * Clamps the given value between min and max.
  2255. *
  2256. * @static
  2257. * @method
  2258. * @param {number} value - The value to clamp.
  2259. * @param {number} min - The min value.
  2260. * @param {number} max - The max value.
  2261. * @return {number} The clamped value.
  2262. */
  2263. clamp: clamp,
  2264. /**
  2265. * Computes the Euclidean modulo of the given parameters that
  2266. * is `( ( n % m ) + m ) % m`.
  2267. *
  2268. * @static
  2269. * @method
  2270. * @param {number} n - The first parameter.
  2271. * @param {number} m - The second parameter.
  2272. * @return {number} The Euclidean modulo.
  2273. */
  2274. euclideanModulo: euclideanModulo,
  2275. /**
  2276. * Performs a linear mapping from range `<a1, a2>` to range `<b1, b2>`
  2277. * for the given value.
  2278. *
  2279. * @static
  2280. * @method
  2281. * @param {number} x - The value to be mapped.
  2282. * @param {number} a1 - Minimum value for range A.
  2283. * @param {number} a2 - Maximum value for range A.
  2284. * @param {number} b1 - Minimum value for range B.
  2285. * @param {number} b2 - Maximum value for range B.
  2286. * @return {number} The mapped value.
  2287. */
  2288. mapLinear: mapLinear,
  2289. /**
  2290. * Returns the percentage in the closed interval `[0, 1]` of the given value
  2291. * between the start and end point.
  2292. *
  2293. * @static
  2294. * @method
  2295. * @param {number} x - The start point
  2296. * @param {number} y - The end point.
  2297. * @param {number} value - A value between start and end.
  2298. * @return {number} The interpolation factor.
  2299. */
  2300. inverseLerp: inverseLerp,
  2301. /**
  2302. * Returns a value linearly interpolated from two known points based on the given interval -
  2303. * `t = 0` will return `x` and `t = 1` will return `y`.
  2304. *
  2305. * @static
  2306. * @method
  2307. * @param {number} x - The start point
  2308. * @param {number} y - The end point.
  2309. * @param {number} t - The interpolation factor in the closed interval `[0, 1]`.
  2310. * @return {number} The interpolated value.
  2311. */
  2312. lerp: lerp,
  2313. /**
  2314. * Smoothly interpolate a number from `x` to `y` in a spring-like manner using a delta
  2315. * time to maintain frame rate independent movement. For details, see
  2316. * [Frame rate independent damping using lerp](http://www.rorydriscoll.com/2016/03/07/frame-rate-independent-damping-using-lerp/).
  2317. *
  2318. * @static
  2319. * @method
  2320. * @param {number} x - The current point.
  2321. * @param {number} y - The target point.
  2322. * @param {number} lambda - A higher lambda value will make the movement more sudden,
  2323. * and a lower value will make the movement more gradual.
  2324. * @param {number} dt - Delta time in seconds.
  2325. * @return {number} The interpolated value.
  2326. */
  2327. damp: damp,
  2328. /**
  2329. * Returns a value that alternates between `0` and the given `length` parameter.
  2330. *
  2331. * @static
  2332. * @method
  2333. * @param {number} x - The value to pingpong.
  2334. * @param {number} [length=1] - The positive value the function will pingpong to.
  2335. * @return {number} The alternated value.
  2336. */
  2337. pingpong: pingpong,
  2338. /**
  2339. * Returns a value in the range `[0,1]` that represents the percentage that `x` has
  2340. * moved between `min` and `max`, but smoothed or slowed down the closer `x` is to
  2341. * the `min` and `max`.
  2342. *
  2343. * See [Smoothstep](http://en.wikipedia.org/wiki/Smoothstep) for more details.
  2344. *
  2345. * @static
  2346. * @method
  2347. * @param {number} x - The value to evaluate based on its position between min and max.
  2348. * @param {number} min - The min value. Any x value below min will be `0`.
  2349. * @param {number} max - The max value. Any x value above max will be `1`.
  2350. * @return {number} The alternated value.
  2351. */
  2352. smoothstep: smoothstep,
  2353. /**
  2354. * A [variation on smoothstep](https://en.wikipedia.org/wiki/Smoothstep#Variations)
  2355. * that has zero 1st and 2nd order derivatives at x=0 and x=1.
  2356. *
  2357. * @static
  2358. * @method
  2359. * @param {number} x - The value to evaluate based on its position between min and max.
  2360. * @param {number} min - The min value. Any x value below min will be `0`.
  2361. * @param {number} max - The max value. Any x value above max will be `1`.
  2362. * @return {number} The alternated value.
  2363. */
  2364. smootherstep: smootherstep,
  2365. /**
  2366. * Returns a random integer from `<low, high>` interval.
  2367. *
  2368. * @static
  2369. * @method
  2370. * @param {number} low - The lower value boundary.
  2371. * @param {number} high - The upper value boundary
  2372. * @return {number} A random integer.
  2373. */
  2374. randInt: randInt,
  2375. /**
  2376. * Returns a random float from `<low, high>` interval.
  2377. *
  2378. * @static
  2379. * @method
  2380. * @param {number} low - The lower value boundary.
  2381. * @param {number} high - The upper value boundary
  2382. * @return {number} A random float.
  2383. */
  2384. randFloat: randFloat,
  2385. /**
  2386. * Returns a random integer from `<-range/2, range/2>` interval.
  2387. *
  2388. * @static
  2389. * @method
  2390. * @param {number} range - Defines the value range.
  2391. * @return {number} A random float.
  2392. */
  2393. randFloatSpread: randFloatSpread,
  2394. /**
  2395. * Returns a deterministic pseudo-random float in the interval `[0, 1]`.
  2396. *
  2397. * @static
  2398. * @method
  2399. * @param {number} [s] - The integer seed.
  2400. * @return {number} A random float.
  2401. */
  2402. seededRandom: seededRandom,
  2403. /**
  2404. * Converts degrees to radians.
  2405. *
  2406. * @static
  2407. * @method
  2408. * @param {number} degrees - A value in degrees.
  2409. * @return {number} The converted value in radians.
  2410. */
  2411. degToRad: degToRad,
  2412. /**
  2413. * Converts radians to degrees.
  2414. *
  2415. * @static
  2416. * @method
  2417. * @param {number} radians - A value in radians.
  2418. * @return {number} The converted value in degrees.
  2419. */
  2420. radToDeg: radToDeg,
  2421. /**
  2422. * Returns `true` if the given number is a power of two.
  2423. *
  2424. * @static
  2425. * @method
  2426. * @param {number} value - The value to check.
  2427. * @return {boolean} Whether the given number is a power of two or not.
  2428. */
  2429. isPowerOfTwo: isPowerOfTwo,
  2430. /**
  2431. * Returns the smallest power of two that is greater than or equal to the given number.
  2432. *
  2433. * @static
  2434. * @method
  2435. * @param {number} value - The value to find a POT for.
  2436. * @return {number} The smallest power of two that is greater than or equal to the given number.
  2437. */
  2438. ceilPowerOfTwo: ceilPowerOfTwo,
  2439. /**
  2440. * Returns the largest power of two that is less than or equal to the given number.
  2441. *
  2442. * @static
  2443. * @method
  2444. * @param {number} value - The value to find a POT for.
  2445. * @return {number} The largest power of two that is less than or equal to the given number.
  2446. */
  2447. floorPowerOfTwo: floorPowerOfTwo,
  2448. /**
  2449. * Sets the given quaternion from the [Intrinsic Proper Euler Angles](https://en.wikipedia.org/wiki/Euler_angles)
  2450. * defined by the given angles and order.
  2451. *
  2452. * Rotations are applied to the axes in the order specified by order:
  2453. * rotation by angle `a` is applied first, then by angle `b`, then by angle `c`.
  2454. *
  2455. * @static
  2456. * @method
  2457. * @param {Quaternion} q - The quaternion to set.
  2458. * @param {number} a - The rotation applied to the first axis, in radians.
  2459. * @param {number} b - The rotation applied to the second axis, in radians.
  2460. * @param {number} c - The rotation applied to the third axis, in radians.
  2461. * @param {('XYX'|'XZX'|'YXY'|'YZY'|'ZXZ'|'ZYZ')} order - A string specifying the axes order.
  2462. */
  2463. setQuaternionFromProperEuler: setQuaternionFromProperEuler,
  2464. /**
  2465. * Normalizes the given value according to the given typed array.
  2466. *
  2467. * @static
  2468. * @method
  2469. * @param {number} value - The float value in the range `[0,1]` to normalize.
  2470. * @param {TypedArray} array - The typed array that defines the data type of the value.
  2471. * @return {number} The normalize value.
  2472. */
  2473. normalize: normalize,
  2474. /**
  2475. * Denormalizes the given value according to the given typed array.
  2476. *
  2477. * @static
  2478. * @method
  2479. * @param {number} value - The value to denormalize.
  2480. * @param {TypedArray} array - The typed array that defines the data type of the value.
  2481. * @return {number} The denormalize (float) value in the range `[0,1]`.
  2482. */
  2483. denormalize: denormalize
  2484. };
  2485. /**
  2486. * Class representing a 2D vector. A 2D vector is an ordered pair of numbers
  2487. * (labeled x and y), which can be used to represent a number of things, such as:
  2488. *
  2489. * - A point in 2D space (i.e. a position on a plane).
  2490. * - A direction and length across a plane. In three.js the length will
  2491. * always be the Euclidean distance(straight-line distance) from `(0, 0)` to `(x, y)`
  2492. * and the direction is also measured from `(0, 0)` towards `(x, y)`.
  2493. * - Any arbitrary ordered pair of numbers.
  2494. *
  2495. * There are other things a 2D vector can be used to represent, such as
  2496. * momentum vectors, complex numbers and so on, however these are the most
  2497. * common uses in three.js.
  2498. *
  2499. * Iterating through a vector instance will yield its components `(x, y)` in
  2500. * the corresponding order.
  2501. * ```js
  2502. * const a = new THREE.Vector2( 0, 1 );
  2503. *
  2504. * //no arguments; will be initialised to (0, 0)
  2505. * const b = new THREE.Vector2( );
  2506. *
  2507. * const d = a.distanceTo( b );
  2508. * ```
  2509. */
  2510. class Vector2 {
  2511. /**
  2512. * Constructs a new 2D vector.
  2513. *
  2514. * @param {number} [x=0] - The x value of this vector.
  2515. * @param {number} [y=0] - The y value of this vector.
  2516. */
  2517. constructor( x = 0, y = 0 ) {
  2518. /**
  2519. * This flag can be used for type testing.
  2520. *
  2521. * @type {boolean}
  2522. * @readonly
  2523. * @default true
  2524. */
  2525. Vector2.prototype.isVector2 = true;
  2526. /**
  2527. * The x value of this vector.
  2528. *
  2529. * @type {number}
  2530. */
  2531. this.x = x;
  2532. /**
  2533. * The y value of this vector.
  2534. *
  2535. * @type {number}
  2536. */
  2537. this.y = y;
  2538. }
  2539. /**
  2540. * Alias for {@link Vector2#x}.
  2541. *
  2542. * @type {number}
  2543. */
  2544. get width() {
  2545. return this.x;
  2546. }
  2547. set width( value ) {
  2548. this.x = value;
  2549. }
  2550. /**
  2551. * Alias for {@link Vector2#y}.
  2552. *
  2553. * @type {number}
  2554. */
  2555. get height() {
  2556. return this.y;
  2557. }
  2558. set height( value ) {
  2559. this.y = value;
  2560. }
  2561. /**
  2562. * Sets the vector components.
  2563. *
  2564. * @param {number} x - The value of the x component.
  2565. * @param {number} y - The value of the y component.
  2566. * @return {Vector2} A reference to this vector.
  2567. */
  2568. set( x, y ) {
  2569. this.x = x;
  2570. this.y = y;
  2571. return this;
  2572. }
  2573. /**
  2574. * Sets the vector components to the same value.
  2575. *
  2576. * @param {number} scalar - The value to set for all vector components.
  2577. * @return {Vector2} A reference to this vector.
  2578. */
  2579. setScalar( scalar ) {
  2580. this.x = scalar;
  2581. this.y = scalar;
  2582. return this;
  2583. }
  2584. /**
  2585. * Sets the vector's x component to the given value
  2586. *
  2587. * @param {number} x - The value to set.
  2588. * @return {Vector2} A reference to this vector.
  2589. */
  2590. setX( x ) {
  2591. this.x = x;
  2592. return this;
  2593. }
  2594. /**
  2595. * Sets the vector's y component to the given value
  2596. *
  2597. * @param {number} y - The value to set.
  2598. * @return {Vector2} A reference to this vector.
  2599. */
  2600. setY( y ) {
  2601. this.y = y;
  2602. return this;
  2603. }
  2604. /**
  2605. * Allows to set a vector component with an index.
  2606. *
  2607. * @param {number} index - The component index. `0` equals to x, `1` equals to y.
  2608. * @param {number} value - The value to set.
  2609. * @return {Vector2} A reference to this vector.
  2610. */
  2611. setComponent( index, value ) {
  2612. switch ( index ) {
  2613. case 0: this.x = value; break;
  2614. case 1: this.y = value; break;
  2615. default: throw new Error( 'index is out of range: ' + index );
  2616. }
  2617. return this;
  2618. }
  2619. /**
  2620. * Returns the value of the vector component which matches the given index.
  2621. *
  2622. * @param {number} index - The component index. `0` equals to x, `1` equals to y.
  2623. * @return {number} A vector component value.
  2624. */
  2625. getComponent( index ) {
  2626. switch ( index ) {
  2627. case 0: return this.x;
  2628. case 1: return this.y;
  2629. default: throw new Error( 'index is out of range: ' + index );
  2630. }
  2631. }
  2632. /**
  2633. * Returns a new vector with copied values from this instance.
  2634. *
  2635. * @return {Vector2} A clone of this instance.
  2636. */
  2637. clone() {
  2638. return new this.constructor( this.x, this.y );
  2639. }
  2640. /**
  2641. * Copies the values of the given vector to this instance.
  2642. *
  2643. * @param {Vector2} v - The vector to copy.
  2644. * @return {Vector2} A reference to this vector.
  2645. */
  2646. copy( v ) {
  2647. this.x = v.x;
  2648. this.y = v.y;
  2649. return this;
  2650. }
  2651. /**
  2652. * Adds the given vector to this instance.
  2653. *
  2654. * @param {Vector2} v - The vector to add.
  2655. * @return {Vector2} A reference to this vector.
  2656. */
  2657. add( v ) {
  2658. this.x += v.x;
  2659. this.y += v.y;
  2660. return this;
  2661. }
  2662. /**
  2663. * Adds the given scalar value to all components of this instance.
  2664. *
  2665. * @param {number} s - The scalar to add.
  2666. * @return {Vector2} A reference to this vector.
  2667. */
  2668. addScalar( s ) {
  2669. this.x += s;
  2670. this.y += s;
  2671. return this;
  2672. }
  2673. /**
  2674. * Adds the given vectors and stores the result in this instance.
  2675. *
  2676. * @param {Vector2} a - The first vector.
  2677. * @param {Vector2} b - The second vector.
  2678. * @return {Vector2} A reference to this vector.
  2679. */
  2680. addVectors( a, b ) {
  2681. this.x = a.x + b.x;
  2682. this.y = a.y + b.y;
  2683. return this;
  2684. }
  2685. /**
  2686. * Adds the given vector scaled by the given factor to this instance.
  2687. *
  2688. * @param {Vector2} v - The vector.
  2689. * @param {number} s - The factor that scales `v`.
  2690. * @return {Vector2} A reference to this vector.
  2691. */
  2692. addScaledVector( v, s ) {
  2693. this.x += v.x * s;
  2694. this.y += v.y * s;
  2695. return this;
  2696. }
  2697. /**
  2698. * Subtracts the given vector from this instance.
  2699. *
  2700. * @param {Vector2} v - The vector to subtract.
  2701. * @return {Vector2} A reference to this vector.
  2702. */
  2703. sub( v ) {
  2704. this.x -= v.x;
  2705. this.y -= v.y;
  2706. return this;
  2707. }
  2708. /**
  2709. * Subtracts the given scalar value from all components of this instance.
  2710. *
  2711. * @param {number} s - The scalar to subtract.
  2712. * @return {Vector2} A reference to this vector.
  2713. */
  2714. subScalar( s ) {
  2715. this.x -= s;
  2716. this.y -= s;
  2717. return this;
  2718. }
  2719. /**
  2720. * Subtracts the given vectors and stores the result in this instance.
  2721. *
  2722. * @param {Vector2} a - The first vector.
  2723. * @param {Vector2} b - The second vector.
  2724. * @return {Vector2} A reference to this vector.
  2725. */
  2726. subVectors( a, b ) {
  2727. this.x = a.x - b.x;
  2728. this.y = a.y - b.y;
  2729. return this;
  2730. }
  2731. /**
  2732. * Multiplies the given vector with this instance.
  2733. *
  2734. * @param {Vector2} v - The vector to multiply.
  2735. * @return {Vector2} A reference to this vector.
  2736. */
  2737. multiply( v ) {
  2738. this.x *= v.x;
  2739. this.y *= v.y;
  2740. return this;
  2741. }
  2742. /**
  2743. * Multiplies the given scalar value with all components of this instance.
  2744. *
  2745. * @param {number} scalar - The scalar to multiply.
  2746. * @return {Vector2} A reference to this vector.
  2747. */
  2748. multiplyScalar( scalar ) {
  2749. this.x *= scalar;
  2750. this.y *= scalar;
  2751. return this;
  2752. }
  2753. /**
  2754. * Divides this instance by the given vector.
  2755. *
  2756. * @param {Vector2} v - The vector to divide.
  2757. * @return {Vector2} A reference to this vector.
  2758. */
  2759. divide( v ) {
  2760. this.x /= v.x;
  2761. this.y /= v.y;
  2762. return this;
  2763. }
  2764. /**
  2765. * Divides this vector by the given scalar.
  2766. *
  2767. * @param {number} scalar - The scalar to divide.
  2768. * @return {Vector2} A reference to this vector.
  2769. */
  2770. divideScalar( scalar ) {
  2771. return this.multiplyScalar( 1 / scalar );
  2772. }
  2773. /**
  2774. * Multiplies this vector (with an implicit 1 as the 3rd component) by
  2775. * the given 3x3 matrix.
  2776. *
  2777. * @param {Matrix3} m - The matrix to apply.
  2778. * @return {Vector2} A reference to this vector.
  2779. */
  2780. applyMatrix3( m ) {
  2781. const x = this.x, y = this.y;
  2782. const e = m.elements;
  2783. this.x = e[ 0 ] * x + e[ 3 ] * y + e[ 6 ];
  2784. this.y = e[ 1 ] * x + e[ 4 ] * y + e[ 7 ];
  2785. return this;
  2786. }
  2787. /**
  2788. * If this vector's x or y value is greater than the given vector's x or y
  2789. * value, replace that value with the corresponding min value.
  2790. *
  2791. * @param {Vector2} v - The vector.
  2792. * @return {Vector2} A reference to this vector.
  2793. */
  2794. min( v ) {
  2795. this.x = Math.min( this.x, v.x );
  2796. this.y = Math.min( this.y, v.y );
  2797. return this;
  2798. }
  2799. /**
  2800. * If this vector's x or y value is less than the given vector's x or y
  2801. * value, replace that value with the corresponding max value.
  2802. *
  2803. * @param {Vector2} v - The vector.
  2804. * @return {Vector2} A reference to this vector.
  2805. */
  2806. max( v ) {
  2807. this.x = Math.max( this.x, v.x );
  2808. this.y = Math.max( this.y, v.y );
  2809. return this;
  2810. }
  2811. /**
  2812. * If this vector's x or y value is greater than the max vector's x or y
  2813. * value, it is replaced by the corresponding value.
  2814. * If this vector's x or y value is less than the min vector's x or y value,
  2815. * it is replaced by the corresponding value.
  2816. *
  2817. * @param {Vector2} min - The minimum x and y values.
  2818. * @param {Vector2} max - The maximum x and y values in the desired range.
  2819. * @return {Vector2} A reference to this vector.
  2820. */
  2821. clamp( min, max ) {
  2822. // assumes min < max, componentwise
  2823. this.x = clamp( this.x, min.x, max.x );
  2824. this.y = clamp( this.y, min.y, max.y );
  2825. return this;
  2826. }
  2827. /**
  2828. * If this vector's x or y values are greater than the max value, they are
  2829. * replaced by the max value.
  2830. * If this vector's x or y values are less than the min value, they are
  2831. * replaced by the min value.
  2832. *
  2833. * @param {number} minVal - The minimum value the components will be clamped to.
  2834. * @param {number} maxVal - The maximum value the components will be clamped to.
  2835. * @return {Vector2} A reference to this vector.
  2836. */
  2837. clampScalar( minVal, maxVal ) {
  2838. this.x = clamp( this.x, minVal, maxVal );
  2839. this.y = clamp( this.y, minVal, maxVal );
  2840. return this;
  2841. }
  2842. /**
  2843. * If this vector's length is greater than the max value, it is replaced by
  2844. * the max value.
  2845. * If this vector's length is less than the min value, it is replaced by the
  2846. * min value.
  2847. *
  2848. * @param {number} min - The minimum value the vector length will be clamped to.
  2849. * @param {number} max - The maximum value the vector length will be clamped to.
  2850. * @return {Vector2} A reference to this vector.
  2851. */
  2852. clampLength( min, max ) {
  2853. const length = this.length();
  2854. return this.divideScalar( length || 1 ).multiplyScalar( clamp( length, min, max ) );
  2855. }
  2856. /**
  2857. * The components of this vector are rounded down to the nearest integer value.
  2858. *
  2859. * @return {Vector2} A reference to this vector.
  2860. */
  2861. floor() {
  2862. this.x = Math.floor( this.x );
  2863. this.y = Math.floor( this.y );
  2864. return this;
  2865. }
  2866. /**
  2867. * The components of this vector are rounded up to the nearest integer value.
  2868. *
  2869. * @return {Vector2} A reference to this vector.
  2870. */
  2871. ceil() {
  2872. this.x = Math.ceil( this.x );
  2873. this.y = Math.ceil( this.y );
  2874. return this;
  2875. }
  2876. /**
  2877. * The components of this vector are rounded to the nearest integer value
  2878. *
  2879. * @return {Vector2} A reference to this vector.
  2880. */
  2881. round() {
  2882. this.x = Math.round( this.x );
  2883. this.y = Math.round( this.y );
  2884. return this;
  2885. }
  2886. /**
  2887. * The components of this vector are rounded towards zero (up if negative,
  2888. * down if positive) to an integer value.
  2889. *
  2890. * @return {Vector2} A reference to this vector.
  2891. */
  2892. roundToZero() {
  2893. this.x = Math.trunc( this.x );
  2894. this.y = Math.trunc( this.y );
  2895. return this;
  2896. }
  2897. /**
  2898. * Inverts this vector - i.e. sets x = -x and y = -y.
  2899. *
  2900. * @return {Vector2} A reference to this vector.
  2901. */
  2902. negate() {
  2903. this.x = - this.x;
  2904. this.y = - this.y;
  2905. return this;
  2906. }
  2907. /**
  2908. * Calculates the dot product of the given vector with this instance.
  2909. *
  2910. * @param {Vector2} v - The vector to compute the dot product with.
  2911. * @return {number} The result of the dot product.
  2912. */
  2913. dot( v ) {
  2914. return this.x * v.x + this.y * v.y;
  2915. }
  2916. /**
  2917. * Calculates the cross product of the given vector with this instance.
  2918. *
  2919. * @param {Vector2} v - The vector to compute the cross product with.
  2920. * @return {number} The result of the cross product.
  2921. */
  2922. cross( v ) {
  2923. return this.x * v.y - this.y * v.x;
  2924. }
  2925. /**
  2926. * Computes the square of the Euclidean length (straight-line length) from
  2927. * (0, 0) to (x, y). If you are comparing the lengths of vectors, you should
  2928. * compare the length squared instead as it is slightly more efficient to calculate.
  2929. *
  2930. * @return {number} The square length of this vector.
  2931. */
  2932. lengthSq() {
  2933. return this.x * this.x + this.y * this.y;
  2934. }
  2935. /**
  2936. * Computes the Euclidean length (straight-line length) from (0, 0) to (x, y).
  2937. *
  2938. * @return {number} The length of this vector.
  2939. */
  2940. length() {
  2941. return Math.sqrt( this.x * this.x + this.y * this.y );
  2942. }
  2943. /**
  2944. * Computes the Manhattan length of this vector.
  2945. *
  2946. * @return {number} The length of this vector.
  2947. */
  2948. manhattanLength() {
  2949. return Math.abs( this.x ) + Math.abs( this.y );
  2950. }
  2951. /**
  2952. * Converts this vector to a unit vector - that is, sets it equal to a vector
  2953. * with the same direction as this one, but with a vector length of `1`.
  2954. *
  2955. * @return {Vector2} A reference to this vector.
  2956. */
  2957. normalize() {
  2958. return this.divideScalar( this.length() || 1 );
  2959. }
  2960. /**
  2961. * Computes the angle in radians of this vector with respect to the positive x-axis.
  2962. *
  2963. * @return {number} The angle in radians.
  2964. */
  2965. angle() {
  2966. const angle = Math.atan2( - this.y, - this.x ) + Math.PI;
  2967. return angle;
  2968. }
  2969. /**
  2970. * Returns the angle between the given vector and this instance in radians.
  2971. *
  2972. * @param {Vector2} v - The vector to compute the angle with.
  2973. * @return {number} The angle in radians.
  2974. */
  2975. angleTo( v ) {
  2976. const denominator = Math.sqrt( this.lengthSq() * v.lengthSq() );
  2977. if ( denominator === 0 ) return Math.PI / 2;
  2978. const theta = this.dot( v ) / denominator;
  2979. // clamp, to handle numerical problems
  2980. return Math.acos( clamp( theta, -1, 1 ) );
  2981. }
  2982. /**
  2983. * Computes the distance from the given vector to this instance.
  2984. *
  2985. * @param {Vector2} v - The vector to compute the distance to.
  2986. * @return {number} The distance.
  2987. */
  2988. distanceTo( v ) {
  2989. return Math.sqrt( this.distanceToSquared( v ) );
  2990. }
  2991. /**
  2992. * Computes the squared distance from the given vector to this instance.
  2993. * If you are just comparing the distance with another distance, you should compare
  2994. * the distance squared instead as it is slightly more efficient to calculate.
  2995. *
  2996. * @param {Vector2} v - The vector to compute the squared distance to.
  2997. * @return {number} The squared distance.
  2998. */
  2999. distanceToSquared( v ) {
  3000. const dx = this.x - v.x, dy = this.y - v.y;
  3001. return dx * dx + dy * dy;
  3002. }
  3003. /**
  3004. * Computes the Manhattan distance from the given vector to this instance.
  3005. *
  3006. * @param {Vector2} v - The vector to compute the Manhattan distance to.
  3007. * @return {number} The Manhattan distance.
  3008. */
  3009. manhattanDistanceTo( v ) {
  3010. return Math.abs( this.x - v.x ) + Math.abs( this.y - v.y );
  3011. }
  3012. /**
  3013. * Sets this vector to a vector with the same direction as this one, but
  3014. * with the specified length.
  3015. *
  3016. * @param {number} length - The new length of this vector.
  3017. * @return {Vector2} A reference to this vector.
  3018. */
  3019. setLength( length ) {
  3020. return this.normalize().multiplyScalar( length );
  3021. }
  3022. /**
  3023. * Linearly interpolates between the given vector and this instance, where
  3024. * alpha is the percent distance along the line - alpha = 0 will be this
  3025. * vector, and alpha = 1 will be the given one.
  3026. *
  3027. * @param {Vector2} v - The vector to interpolate towards.
  3028. * @param {number} alpha - The interpolation factor, typically in the closed interval `[0, 1]`.
  3029. * @return {Vector2} A reference to this vector.
  3030. */
  3031. lerp( v, alpha ) {
  3032. this.x += ( v.x - this.x ) * alpha;
  3033. this.y += ( v.y - this.y ) * alpha;
  3034. return this;
  3035. }
  3036. /**
  3037. * Linearly interpolates between the given vectors, where alpha is the percent
  3038. * distance along the line - alpha = 0 will be first vector, and alpha = 1 will
  3039. * be the second one. The result is stored in this instance.
  3040. *
  3041. * @param {Vector2} v1 - The first vector.
  3042. * @param {Vector2} v2 - The second vector.
  3043. * @param {number} alpha - The interpolation factor, typically in the closed interval `[0, 1]`.
  3044. * @return {Vector2} A reference to this vector.
  3045. */
  3046. lerpVectors( v1, v2, alpha ) {
  3047. this.x = v1.x + ( v2.x - v1.x ) * alpha;
  3048. this.y = v1.y + ( v2.y - v1.y ) * alpha;
  3049. return this;
  3050. }
  3051. /**
  3052. * Returns `true` if this vector is equal with the given one.
  3053. *
  3054. * @param {Vector2} v - The vector to test for equality.
  3055. * @return {boolean} Whether this vector is equal with the given one.
  3056. */
  3057. equals( v ) {
  3058. return ( ( v.x === this.x ) && ( v.y === this.y ) );
  3059. }
  3060. /**
  3061. * Sets this vector's x value to be `array[ offset ]` and y
  3062. * value to be `array[ offset + 1 ]`.
  3063. *
  3064. * @param {Array<number>} array - An array holding the vector component values.
  3065. * @param {number} [offset=0] - The offset into the array.
  3066. * @return {Vector2} A reference to this vector.
  3067. */
  3068. fromArray( array, offset = 0 ) {
  3069. this.x = array[ offset ];
  3070. this.y = array[ offset + 1 ];
  3071. return this;
  3072. }
  3073. /**
  3074. * Writes the components of this vector to the given array. If no array is provided,
  3075. * the method returns a new instance.
  3076. *
  3077. * @param {Array<number>} [array=[]] - The target array holding the vector components.
  3078. * @param {number} [offset=0] - Index of the first element in the array.
  3079. * @return {Array<number>} The vector components.
  3080. */
  3081. toArray( array = [], offset = 0 ) {
  3082. array[ offset ] = this.x;
  3083. array[ offset + 1 ] = this.y;
  3084. return array;
  3085. }
  3086. /**
  3087. * Sets the components of this vector from the given buffer attribute.
  3088. *
  3089. * @param {BufferAttribute} attribute - The buffer attribute holding vector data.
  3090. * @param {number} index - The index into the attribute.
  3091. * @return {Vector2} A reference to this vector.
  3092. */
  3093. fromBufferAttribute( attribute, index ) {
  3094. this.x = attribute.getX( index );
  3095. this.y = attribute.getY( index );
  3096. return this;
  3097. }
  3098. /**
  3099. * Rotates this vector around the given center by the given angle.
  3100. *
  3101. * @param {Vector2} center - The point around which to rotate.
  3102. * @param {number} angle - The angle to rotate, in radians.
  3103. * @return {Vector2} A reference to this vector.
  3104. */
  3105. rotateAround( center, angle ) {
  3106. const c = Math.cos( angle ), s = Math.sin( angle );
  3107. const x = this.x - center.x;
  3108. const y = this.y - center.y;
  3109. this.x = x * c - y * s + center.x;
  3110. this.y = x * s + y * c + center.y;
  3111. return this;
  3112. }
  3113. /**
  3114. * Sets each component of this vector to a pseudo-random value between `0` and
  3115. * `1`, excluding `1`.
  3116. *
  3117. * @return {Vector2} A reference to this vector.
  3118. */
  3119. random() {
  3120. this.x = Math.random();
  3121. this.y = Math.random();
  3122. return this;
  3123. }
  3124. *[ Symbol.iterator ]() {
  3125. yield this.x;
  3126. yield this.y;
  3127. }
  3128. }
  3129. /**
  3130. * Class for representing a Quaternion. Quaternions are used in three.js to represent rotations.
  3131. *
  3132. * Iterating through a vector instance will yield its components `(x, y, z, w)` in
  3133. * the corresponding order.
  3134. *
  3135. * Note that three.js expects Quaternions to be normalized.
  3136. * ```js
  3137. * const quaternion = new THREE.Quaternion();
  3138. * quaternion.setFromAxisAngle( new THREE.Vector3( 0, 1, 0 ), Math.PI / 2 );
  3139. *
  3140. * const vector = new THREE.Vector3( 1, 0, 0 );
  3141. * vector.applyQuaternion( quaternion );
  3142. * ```
  3143. */
  3144. class Quaternion {
  3145. /**
  3146. * Constructs a new quaternion.
  3147. *
  3148. * @param {number} [x=0] - The x value of this quaternion.
  3149. * @param {number} [y=0] - The y value of this quaternion.
  3150. * @param {number} [z=0] - The z value of this quaternion.
  3151. * @param {number} [w=1] - The w value of this quaternion.
  3152. */
  3153. constructor( x = 0, y = 0, z = 0, w = 1 ) {
  3154. /**
  3155. * This flag can be used for type testing.
  3156. *
  3157. * @type {boolean}
  3158. * @readonly
  3159. * @default true
  3160. */
  3161. this.isQuaternion = true;
  3162. this._x = x;
  3163. this._y = y;
  3164. this._z = z;
  3165. this._w = w;
  3166. }
  3167. /**
  3168. * Interpolates between two quaternions via SLERP. This implementation assumes the
  3169. * quaternion data are managed in flat arrays.
  3170. *
  3171. * @param {Array<number>} dst - The destination array.
  3172. * @param {number} dstOffset - An offset into the destination array.
  3173. * @param {Array<number>} src0 - The source array of the first quaternion.
  3174. * @param {number} srcOffset0 - An offset into the first source array.
  3175. * @param {Array<number>} src1 - The source array of the second quaternion.
  3176. * @param {number} srcOffset1 - An offset into the second source array.
  3177. * @param {number} t - The interpolation factor. A value in the range `[0,1]` will interpolate. A value outside the range `[0,1]` will extrapolate.
  3178. * @see {@link Quaternion#slerp}
  3179. */
  3180. static slerpFlat( dst, dstOffset, src0, srcOffset0, src1, srcOffset1, t ) {
  3181. let x0 = src0[ srcOffset0 + 0 ],
  3182. y0 = src0[ srcOffset0 + 1 ],
  3183. z0 = src0[ srcOffset0 + 2 ],
  3184. w0 = src0[ srcOffset0 + 3 ];
  3185. let x1 = src1[ srcOffset1 + 0 ],
  3186. y1 = src1[ srcOffset1 + 1 ],
  3187. z1 = src1[ srcOffset1 + 2 ],
  3188. w1 = src1[ srcOffset1 + 3 ];
  3189. if ( w0 !== w1 || x0 !== x1 || y0 !== y1 || z0 !== z1 ) {
  3190. let dot = x0 * x1 + y0 * y1 + z0 * z1 + w0 * w1;
  3191. if ( dot < 0 ) {
  3192. x1 = - x1;
  3193. y1 = - y1;
  3194. z1 = - z1;
  3195. w1 = - w1;
  3196. dot = - dot;
  3197. }
  3198. let s = 1 - t;
  3199. if ( dot < 0.9995 ) {
  3200. // slerp
  3201. const theta = Math.acos( dot );
  3202. const sin = Math.sin( theta );
  3203. s = Math.sin( s * theta ) / sin;
  3204. t = Math.sin( t * theta ) / sin;
  3205. x0 = x0 * s + x1 * t;
  3206. y0 = y0 * s + y1 * t;
  3207. z0 = z0 * s + z1 * t;
  3208. w0 = w0 * s + w1 * t;
  3209. } else {
  3210. // for small angles, lerp then normalize
  3211. x0 = x0 * s + x1 * t;
  3212. y0 = y0 * s + y1 * t;
  3213. z0 = z0 * s + z1 * t;
  3214. w0 = w0 * s + w1 * t;
  3215. const f = 1 / Math.sqrt( x0 * x0 + y0 * y0 + z0 * z0 + w0 * w0 );
  3216. x0 *= f;
  3217. y0 *= f;
  3218. z0 *= f;
  3219. w0 *= f;
  3220. }
  3221. }
  3222. dst[ dstOffset ] = x0;
  3223. dst[ dstOffset + 1 ] = y0;
  3224. dst[ dstOffset + 2 ] = z0;
  3225. dst[ dstOffset + 3 ] = w0;
  3226. }
  3227. /**
  3228. * Multiplies two quaternions. This implementation assumes the quaternion data are managed
  3229. * in flat arrays.
  3230. *
  3231. * @param {Array<number>} dst - The destination array.
  3232. * @param {number} dstOffset - An offset into the destination array.
  3233. * @param {Array<number>} src0 - The source array of the first quaternion.
  3234. * @param {number} srcOffset0 - An offset into the first source array.
  3235. * @param {Array<number>} src1 - The source array of the second quaternion.
  3236. * @param {number} srcOffset1 - An offset into the second source array.
  3237. * @return {Array<number>} The destination array.
  3238. * @see {@link Quaternion#multiplyQuaternions}.
  3239. */
  3240. static multiplyQuaternionsFlat( dst, dstOffset, src0, srcOffset0, src1, srcOffset1 ) {
  3241. const x0 = src0[ srcOffset0 ];
  3242. const y0 = src0[ srcOffset0 + 1 ];
  3243. const z0 = src0[ srcOffset0 + 2 ];
  3244. const w0 = src0[ srcOffset0 + 3 ];
  3245. const x1 = src1[ srcOffset1 ];
  3246. const y1 = src1[ srcOffset1 + 1 ];
  3247. const z1 = src1[ srcOffset1 + 2 ];
  3248. const w1 = src1[ srcOffset1 + 3 ];
  3249. dst[ dstOffset ] = x0 * w1 + w0 * x1 + y0 * z1 - z0 * y1;
  3250. dst[ dstOffset + 1 ] = y0 * w1 + w0 * y1 + z0 * x1 - x0 * z1;
  3251. dst[ dstOffset + 2 ] = z0 * w1 + w0 * z1 + x0 * y1 - y0 * x1;
  3252. dst[ dstOffset + 3 ] = w0 * w1 - x0 * x1 - y0 * y1 - z0 * z1;
  3253. return dst;
  3254. }
  3255. /**
  3256. * The x value of this quaternion.
  3257. *
  3258. * @type {number}
  3259. * @default 0
  3260. */
  3261. get x() {
  3262. return this._x;
  3263. }
  3264. set x( value ) {
  3265. this._x = value;
  3266. this._onChangeCallback();
  3267. }
  3268. /**
  3269. * The y value of this quaternion.
  3270. *
  3271. * @type {number}
  3272. * @default 0
  3273. */
  3274. get y() {
  3275. return this._y;
  3276. }
  3277. set y( value ) {
  3278. this._y = value;
  3279. this._onChangeCallback();
  3280. }
  3281. /**
  3282. * The z value of this quaternion.
  3283. *
  3284. * @type {number}
  3285. * @default 0
  3286. */
  3287. get z() {
  3288. return this._z;
  3289. }
  3290. set z( value ) {
  3291. this._z = value;
  3292. this._onChangeCallback();
  3293. }
  3294. /**
  3295. * The w value of this quaternion.
  3296. *
  3297. * @type {number}
  3298. * @default 1
  3299. */
  3300. get w() {
  3301. return this._w;
  3302. }
  3303. set w( value ) {
  3304. this._w = value;
  3305. this._onChangeCallback();
  3306. }
  3307. /**
  3308. * Sets the quaternion components.
  3309. *
  3310. * @param {number} x - The x value of this quaternion.
  3311. * @param {number} y - The y value of this quaternion.
  3312. * @param {number} z - The z value of this quaternion.
  3313. * @param {number} w - The w value of this quaternion.
  3314. * @return {Quaternion} A reference to this quaternion.
  3315. */
  3316. set( x, y, z, w ) {
  3317. this._x = x;
  3318. this._y = y;
  3319. this._z = z;
  3320. this._w = w;
  3321. this._onChangeCallback();
  3322. return this;
  3323. }
  3324. /**
  3325. * Returns a new quaternion with copied values from this instance.
  3326. *
  3327. * @return {Quaternion} A clone of this instance.
  3328. */
  3329. clone() {
  3330. return new this.constructor( this._x, this._y, this._z, this._w );
  3331. }
  3332. /**
  3333. * Copies the values of the given quaternion to this instance.
  3334. *
  3335. * @param {Quaternion} quaternion - The quaternion to copy.
  3336. * @return {Quaternion} A reference to this quaternion.
  3337. */
  3338. copy( quaternion ) {
  3339. this._x = quaternion.x;
  3340. this._y = quaternion.y;
  3341. this._z = quaternion.z;
  3342. this._w = quaternion.w;
  3343. this._onChangeCallback();
  3344. return this;
  3345. }
  3346. /**
  3347. * Sets this quaternion from the rotation specified by the given
  3348. * Euler angles.
  3349. *
  3350. * @param {Euler} euler - The Euler angles.
  3351. * @param {boolean} [update=true] - Whether the internal `onChange` callback should be executed or not.
  3352. * @return {Quaternion} A reference to this quaternion.
  3353. */
  3354. setFromEuler( euler, update = true ) {
  3355. const x = euler._x, y = euler._y, z = euler._z, order = euler._order;
  3356. // http://www.mathworks.com/matlabcentral/fileexchange/
  3357. // 20696-function-to-convert-between-dcm-euler-angles-quaternions-and-euler-vectors/
  3358. // content/SpinCalc.m
  3359. const cos = Math.cos;
  3360. const sin = Math.sin;
  3361. const c1 = cos( x / 2 );
  3362. const c2 = cos( y / 2 );
  3363. const c3 = cos( z / 2 );
  3364. const s1 = sin( x / 2 );
  3365. const s2 = sin( y / 2 );
  3366. const s3 = sin( z / 2 );
  3367. switch ( order ) {
  3368. case 'XYZ':
  3369. this._x = s1 * c2 * c3 + c1 * s2 * s3;
  3370. this._y = c1 * s2 * c3 - s1 * c2 * s3;
  3371. this._z = c1 * c2 * s3 + s1 * s2 * c3;
  3372. this._w = c1 * c2 * c3 - s1 * s2 * s3;
  3373. break;
  3374. case 'YXZ':
  3375. this._x = s1 * c2 * c3 + c1 * s2 * s3;
  3376. this._y = c1 * s2 * c3 - s1 * c2 * s3;
  3377. this._z = c1 * c2 * s3 - s1 * s2 * c3;
  3378. this._w = c1 * c2 * c3 + s1 * s2 * s3;
  3379. break;
  3380. case 'ZXY':
  3381. this._x = s1 * c2 * c3 - c1 * s2 * s3;
  3382. this._y = c1 * s2 * c3 + s1 * c2 * s3;
  3383. this._z = c1 * c2 * s3 + s1 * s2 * c3;
  3384. this._w = c1 * c2 * c3 - s1 * s2 * s3;
  3385. break;
  3386. case 'ZYX':
  3387. this._x = s1 * c2 * c3 - c1 * s2 * s3;
  3388. this._y = c1 * s2 * c3 + s1 * c2 * s3;
  3389. this._z = c1 * c2 * s3 - s1 * s2 * c3;
  3390. this._w = c1 * c2 * c3 + s1 * s2 * s3;
  3391. break;
  3392. case 'YZX':
  3393. this._x = s1 * c2 * c3 + c1 * s2 * s3;
  3394. this._y = c1 * s2 * c3 + s1 * c2 * s3;
  3395. this._z = c1 * c2 * s3 - s1 * s2 * c3;
  3396. this._w = c1 * c2 * c3 - s1 * s2 * s3;
  3397. break;
  3398. case 'XZY':
  3399. this._x = s1 * c2 * c3 - c1 * s2 * s3;
  3400. this._y = c1 * s2 * c3 - s1 * c2 * s3;
  3401. this._z = c1 * c2 * s3 + s1 * s2 * c3;
  3402. this._w = c1 * c2 * c3 + s1 * s2 * s3;
  3403. break;
  3404. default:
  3405. warn( 'Quaternion: .setFromEuler() encountered an unknown order: ' + order );
  3406. }
  3407. if ( update === true ) this._onChangeCallback();
  3408. return this;
  3409. }
  3410. /**
  3411. * Sets this quaternion from the given axis and angle.
  3412. *
  3413. * @param {Vector3} axis - The normalized axis.
  3414. * @param {number} angle - The angle in radians.
  3415. * @return {Quaternion} A reference to this quaternion.
  3416. */
  3417. setFromAxisAngle( axis, angle ) {
  3418. // http://www.euclideanspace.com/maths/geometry/rotations/conversions/angleToQuaternion/index.htm
  3419. const halfAngle = angle / 2, s = Math.sin( halfAngle );
  3420. this._x = axis.x * s;
  3421. this._y = axis.y * s;
  3422. this._z = axis.z * s;
  3423. this._w = Math.cos( halfAngle );
  3424. this._onChangeCallback();
  3425. return this;
  3426. }
  3427. /**
  3428. * Sets this quaternion from the given rotation matrix.
  3429. *
  3430. * @param {Matrix4} m - A 4x4 matrix of which the upper 3x3 of matrix is a pure rotation matrix (i.e. unscaled).
  3431. * @return {Quaternion} A reference to this quaternion.
  3432. */
  3433. setFromRotationMatrix( m ) {
  3434. // http://www.euclideanspace.com/maths/geometry/rotations/conversions/matrixToQuaternion/index.htm
  3435. // assumes the upper 3x3 of m is a pure rotation matrix (i.e, unscaled)
  3436. const te = m.elements,
  3437. m11 = te[ 0 ], m12 = te[ 4 ], m13 = te[ 8 ],
  3438. m21 = te[ 1 ], m22 = te[ 5 ], m23 = te[ 9 ],
  3439. m31 = te[ 2 ], m32 = te[ 6 ], m33 = te[ 10 ],
  3440. trace = m11 + m22 + m33;
  3441. if ( trace > 0 ) {
  3442. const s = 0.5 / Math.sqrt( trace + 1.0 );
  3443. this._w = 0.25 / s;
  3444. this._x = ( m32 - m23 ) * s;
  3445. this._y = ( m13 - m31 ) * s;
  3446. this._z = ( m21 - m12 ) * s;
  3447. } else if ( m11 > m22 && m11 > m33 ) {
  3448. const s = 2.0 * Math.sqrt( 1.0 + m11 - m22 - m33 );
  3449. this._w = ( m32 - m23 ) / s;
  3450. this._x = 0.25 * s;
  3451. this._y = ( m12 + m21 ) / s;
  3452. this._z = ( m13 + m31 ) / s;
  3453. } else if ( m22 > m33 ) {
  3454. const s = 2.0 * Math.sqrt( 1.0 + m22 - m11 - m33 );
  3455. this._w = ( m13 - m31 ) / s;
  3456. this._x = ( m12 + m21 ) / s;
  3457. this._y = 0.25 * s;
  3458. this._z = ( m23 + m32 ) / s;
  3459. } else {
  3460. const s = 2.0 * Math.sqrt( 1.0 + m33 - m11 - m22 );
  3461. this._w = ( m21 - m12 ) / s;
  3462. this._x = ( m13 + m31 ) / s;
  3463. this._y = ( m23 + m32 ) / s;
  3464. this._z = 0.25 * s;
  3465. }
  3466. this._onChangeCallback();
  3467. return this;
  3468. }
  3469. /**
  3470. * Sets this quaternion to the rotation required to rotate the direction vector
  3471. * `vFrom` to the direction vector `vTo`.
  3472. *
  3473. * @param {Vector3} vFrom - The first (normalized) direction vector.
  3474. * @param {Vector3} vTo - The second (normalized) direction vector.
  3475. * @return {Quaternion} A reference to this quaternion.
  3476. */
  3477. setFromUnitVectors( vFrom, vTo ) {
  3478. // assumes direction vectors vFrom and vTo are normalized
  3479. let r = vFrom.dot( vTo ) + 1;
  3480. if ( r < 1e-8 ) { // the epsilon value has been discussed in #31286
  3481. // vFrom and vTo point in opposite directions
  3482. r = 0;
  3483. if ( Math.abs( vFrom.x ) > Math.abs( vFrom.z ) ) {
  3484. this._x = - vFrom.y;
  3485. this._y = vFrom.x;
  3486. this._z = 0;
  3487. this._w = r;
  3488. } else {
  3489. this._x = 0;
  3490. this._y = - vFrom.z;
  3491. this._z = vFrom.y;
  3492. this._w = r;
  3493. }
  3494. } else {
  3495. // crossVectors( vFrom, vTo ); // inlined to avoid cyclic dependency on Vector3
  3496. this._x = vFrom.y * vTo.z - vFrom.z * vTo.y;
  3497. this._y = vFrom.z * vTo.x - vFrom.x * vTo.z;
  3498. this._z = vFrom.x * vTo.y - vFrom.y * vTo.x;
  3499. this._w = r;
  3500. }
  3501. return this.normalize();
  3502. }
  3503. /**
  3504. * Returns the angle between this quaternion and the given one in radians.
  3505. *
  3506. * @param {Quaternion} q - The quaternion to compute the angle with.
  3507. * @return {number} The angle in radians.
  3508. */
  3509. angleTo( q ) {
  3510. return 2 * Math.acos( Math.abs( clamp( this.dot( q ), -1, 1 ) ) );
  3511. }
  3512. /**
  3513. * Rotates this quaternion by a given angular step to the given quaternion.
  3514. * The method ensures that the final quaternion will not overshoot `q`.
  3515. *
  3516. * @param {Quaternion} q - The target quaternion.
  3517. * @param {number} step - The angular step in radians.
  3518. * @return {Quaternion} A reference to this quaternion.
  3519. */
  3520. rotateTowards( q, step ) {
  3521. const angle = this.angleTo( q );
  3522. if ( angle === 0 ) return this;
  3523. const t = Math.min( 1, step / angle );
  3524. this.slerp( q, t );
  3525. return this;
  3526. }
  3527. /**
  3528. * Sets this quaternion to the identity quaternion; that is, to the
  3529. * quaternion that represents "no rotation".
  3530. *
  3531. * @return {Quaternion} A reference to this quaternion.
  3532. */
  3533. identity() {
  3534. return this.set( 0, 0, 0, 1 );
  3535. }
  3536. /**
  3537. * Inverts this quaternion via {@link Quaternion#conjugate}. The
  3538. * quaternion is assumed to have unit length.
  3539. *
  3540. * @return {Quaternion} A reference to this quaternion.
  3541. */
  3542. invert() {
  3543. return this.conjugate();
  3544. }
  3545. /**
  3546. * Returns the rotational conjugate of this quaternion. The conjugate of a
  3547. * quaternion represents the same rotation in the opposite direction about
  3548. * the rotational axis.
  3549. *
  3550. * @return {Quaternion} A reference to this quaternion.
  3551. */
  3552. conjugate() {
  3553. this._x *= -1;
  3554. this._y *= -1;
  3555. this._z *= -1;
  3556. this._onChangeCallback();
  3557. return this;
  3558. }
  3559. /**
  3560. * Calculates the dot product of this quaternion and the given one.
  3561. *
  3562. * @param {Quaternion} v - The quaternion to compute the dot product with.
  3563. * @return {number} The result of the dot product.
  3564. */
  3565. dot( v ) {
  3566. return this._x * v._x + this._y * v._y + this._z * v._z + this._w * v._w;
  3567. }
  3568. /**
  3569. * Computes the squared Euclidean length (straight-line length) of this quaternion,
  3570. * considered as a 4 dimensional vector. This can be useful if you are comparing the
  3571. * lengths of two quaternions, as this is a slightly more efficient calculation than
  3572. * {@link Quaternion#length}.
  3573. *
  3574. * @return {number} The squared Euclidean length.
  3575. */
  3576. lengthSq() {
  3577. return this._x * this._x + this._y * this._y + this._z * this._z + this._w * this._w;
  3578. }
  3579. /**
  3580. * Computes the Euclidean length (straight-line length) of this quaternion,
  3581. * considered as a 4 dimensional vector.
  3582. *
  3583. * @return {number} The Euclidean length.
  3584. */
  3585. length() {
  3586. return Math.sqrt( this._x * this._x + this._y * this._y + this._z * this._z + this._w * this._w );
  3587. }
  3588. /**
  3589. * Normalizes this quaternion - that is, calculated the quaternion that performs
  3590. * the same rotation as this one, but has a length equal to `1`.
  3591. *
  3592. * @return {Quaternion} A reference to this quaternion.
  3593. */
  3594. normalize() {
  3595. let l = this.length();
  3596. if ( l === 0 ) {
  3597. this._x = 0;
  3598. this._y = 0;
  3599. this._z = 0;
  3600. this._w = 1;
  3601. } else {
  3602. l = 1 / l;
  3603. this._x = this._x * l;
  3604. this._y = this._y * l;
  3605. this._z = this._z * l;
  3606. this._w = this._w * l;
  3607. }
  3608. this._onChangeCallback();
  3609. return this;
  3610. }
  3611. /**
  3612. * Multiplies this quaternion by the given one.
  3613. *
  3614. * @param {Quaternion} q - The quaternion.
  3615. * @return {Quaternion} A reference to this quaternion.
  3616. */
  3617. multiply( q ) {
  3618. return this.multiplyQuaternions( this, q );
  3619. }
  3620. /**
  3621. * Pre-multiplies this quaternion by the given one.
  3622. *
  3623. * @param {Quaternion} q - The quaternion.
  3624. * @return {Quaternion} A reference to this quaternion.
  3625. */
  3626. premultiply( q ) {
  3627. return this.multiplyQuaternions( q, this );
  3628. }
  3629. /**
  3630. * Multiplies the given quaternions and stores the result in this instance.
  3631. *
  3632. * @param {Quaternion} a - The first quaternion.
  3633. * @param {Quaternion} b - The second quaternion.
  3634. * @return {Quaternion} A reference to this quaternion.
  3635. */
  3636. multiplyQuaternions( a, b ) {
  3637. // from http://www.euclideanspace.com/maths/algebra/realNormedAlgebra/quaternions/code/index.htm
  3638. const qax = a._x, qay = a._y, qaz = a._z, qaw = a._w;
  3639. const qbx = b._x, qby = b._y, qbz = b._z, qbw = b._w;
  3640. this._x = qax * qbw + qaw * qbx + qay * qbz - qaz * qby;
  3641. this._y = qay * qbw + qaw * qby + qaz * qbx - qax * qbz;
  3642. this._z = qaz * qbw + qaw * qbz + qax * qby - qay * qbx;
  3643. this._w = qaw * qbw - qax * qbx - qay * qby - qaz * qbz;
  3644. this._onChangeCallback();
  3645. return this;
  3646. }
  3647. /**
  3648. * Performs a spherical linear interpolation between this quaternion and the target quaternion.
  3649. *
  3650. * @param {Quaternion} qb - The target quaternion.
  3651. * @param {number} t - The interpolation factor. A value in the range `[0,1]` will interpolate. A value outside the range `[0,1]` will extrapolate.
  3652. * @return {Quaternion} A reference to this quaternion.
  3653. */
  3654. slerp( qb, t ) {
  3655. let x = qb._x, y = qb._y, z = qb._z, w = qb._w;
  3656. let dot = this.dot( qb );
  3657. if ( dot < 0 ) {
  3658. x = - x;
  3659. y = - y;
  3660. z = - z;
  3661. w = - w;
  3662. dot = - dot;
  3663. }
  3664. let s = 1 - t;
  3665. if ( dot < 0.9995 ) {
  3666. // slerp
  3667. const theta = Math.acos( dot );
  3668. const sin = Math.sin( theta );
  3669. s = Math.sin( s * theta ) / sin;
  3670. t = Math.sin( t * theta ) / sin;
  3671. this._x = this._x * s + x * t;
  3672. this._y = this._y * s + y * t;
  3673. this._z = this._z * s + z * t;
  3674. this._w = this._w * s + w * t;
  3675. this._onChangeCallback();
  3676. } else {
  3677. // for small angles, lerp then normalize
  3678. this._x = this._x * s + x * t;
  3679. this._y = this._y * s + y * t;
  3680. this._z = this._z * s + z * t;
  3681. this._w = this._w * s + w * t;
  3682. this.normalize(); // normalize calls _onChangeCallback()
  3683. }
  3684. return this;
  3685. }
  3686. /**
  3687. * Performs a spherical linear interpolation between the given quaternions
  3688. * and stores the result in this quaternion.
  3689. *
  3690. * @param {Quaternion} qa - The source quaternion.
  3691. * @param {Quaternion} qb - The target quaternion.
  3692. * @param {number} t - The interpolation factor in the closed interval `[0, 1]`.
  3693. * @return {Quaternion} A reference to this quaternion.
  3694. */
  3695. slerpQuaternions( qa, qb, t ) {
  3696. return this.copy( qa ).slerp( qb, t );
  3697. }
  3698. /**
  3699. * Sets this quaternion to a uniformly random, normalized quaternion.
  3700. *
  3701. * @return {Quaternion} A reference to this quaternion.
  3702. */
  3703. random() {
  3704. // Ken Shoemake
  3705. // Uniform random rotations
  3706. // D. Kirk, editor, Graphics Gems III, pages 124-132. Academic Press, New York, 1992.
  3707. const theta1 = 2 * Math.PI * Math.random();
  3708. const theta2 = 2 * Math.PI * Math.random();
  3709. const x0 = Math.random();
  3710. const r1 = Math.sqrt( 1 - x0 );
  3711. const r2 = Math.sqrt( x0 );
  3712. return this.set(
  3713. r1 * Math.sin( theta1 ),
  3714. r1 * Math.cos( theta1 ),
  3715. r2 * Math.sin( theta2 ),
  3716. r2 * Math.cos( theta2 ),
  3717. );
  3718. }
  3719. /**
  3720. * Returns `true` if this quaternion is equal with the given one.
  3721. *
  3722. * @param {Quaternion} quaternion - The quaternion to test for equality.
  3723. * @return {boolean} Whether this quaternion is equal with the given one.
  3724. */
  3725. equals( quaternion ) {
  3726. return ( quaternion._x === this._x ) && ( quaternion._y === this._y ) && ( quaternion._z === this._z ) && ( quaternion._w === this._w );
  3727. }
  3728. /**
  3729. * Sets this quaternion's components from the given array.
  3730. *
  3731. * @param {Array<number>} array - An array holding the quaternion component values.
  3732. * @param {number} [offset=0] - The offset into the array.
  3733. * @return {Quaternion} A reference to this quaternion.
  3734. */
  3735. fromArray( array, offset = 0 ) {
  3736. this._x = array[ offset ];
  3737. this._y = array[ offset + 1 ];
  3738. this._z = array[ offset + 2 ];
  3739. this._w = array[ offset + 3 ];
  3740. this._onChangeCallback();
  3741. return this;
  3742. }
  3743. /**
  3744. * Writes the components of this quaternion to the given array. If no array is provided,
  3745. * the method returns a new instance.
  3746. *
  3747. * @param {Array<number>} [array=[]] - The target array holding the quaternion components.
  3748. * @param {number} [offset=0] - Index of the first element in the array.
  3749. * @return {Array<number>} The quaternion components.
  3750. */
  3751. toArray( array = [], offset = 0 ) {
  3752. array[ offset ] = this._x;
  3753. array[ offset + 1 ] = this._y;
  3754. array[ offset + 2 ] = this._z;
  3755. array[ offset + 3 ] = this._w;
  3756. return array;
  3757. }
  3758. /**
  3759. * Sets the components of this quaternion from the given buffer attribute.
  3760. *
  3761. * @param {BufferAttribute} attribute - The buffer attribute holding quaternion data.
  3762. * @param {number} index - The index into the attribute.
  3763. * @return {Quaternion} A reference to this quaternion.
  3764. */
  3765. fromBufferAttribute( attribute, index ) {
  3766. this._x = attribute.getX( index );
  3767. this._y = attribute.getY( index );
  3768. this._z = attribute.getZ( index );
  3769. this._w = attribute.getW( index );
  3770. this._onChangeCallback();
  3771. return this;
  3772. }
  3773. /**
  3774. * This methods defines the serialization result of this class. Returns the
  3775. * numerical elements of this quaternion in an array of format `[x, y, z, w]`.
  3776. *
  3777. * @return {Array<number>} The serialized quaternion.
  3778. */
  3779. toJSON() {
  3780. return this.toArray();
  3781. }
  3782. _onChange( callback ) {
  3783. this._onChangeCallback = callback;
  3784. return this;
  3785. }
  3786. _onChangeCallback() {}
  3787. *[ Symbol.iterator ]() {
  3788. yield this._x;
  3789. yield this._y;
  3790. yield this._z;
  3791. yield this._w;
  3792. }
  3793. }
  3794. /**
  3795. * Class representing a 3D vector. A 3D vector is an ordered triplet of numbers
  3796. * (labeled x, y and z), which can be used to represent a number of things, such as:
  3797. *
  3798. * - A point in 3D space.
  3799. * - A direction and length in 3D space. In three.js the length will
  3800. * always be the Euclidean distance(straight-line distance) from `(0, 0, 0)` to `(x, y, z)`
  3801. * and the direction is also measured from `(0, 0, 0)` towards `(x, y, z)`.
  3802. * - Any arbitrary ordered triplet of numbers.
  3803. *
  3804. * There are other things a 3D vector can be used to represent, such as
  3805. * momentum vectors and so on, however these are the most
  3806. * common uses in three.js.
  3807. *
  3808. * Iterating through a vector instance will yield its components `(x, y, z)` in
  3809. * the corresponding order.
  3810. * ```js
  3811. * const a = new THREE.Vector3( 0, 1, 0 );
  3812. *
  3813. * //no arguments; will be initialised to (0, 0, 0)
  3814. * const b = new THREE.Vector3( );
  3815. *
  3816. * const d = a.distanceTo( b );
  3817. * ```
  3818. */
  3819. class Vector3 {
  3820. /**
  3821. * Constructs a new 3D vector.
  3822. *
  3823. * @param {number} [x=0] - The x value of this vector.
  3824. * @param {number} [y=0] - The y value of this vector.
  3825. * @param {number} [z=0] - The z value of this vector.
  3826. */
  3827. constructor( x = 0, y = 0, z = 0 ) {
  3828. /**
  3829. * This flag can be used for type testing.
  3830. *
  3831. * @type {boolean}
  3832. * @readonly
  3833. * @default true
  3834. */
  3835. Vector3.prototype.isVector3 = true;
  3836. /**
  3837. * The x value of this vector.
  3838. *
  3839. * @type {number}
  3840. */
  3841. this.x = x;
  3842. /**
  3843. * The y value of this vector.
  3844. *
  3845. * @type {number}
  3846. */
  3847. this.y = y;
  3848. /**
  3849. * The z value of this vector.
  3850. *
  3851. * @type {number}
  3852. */
  3853. this.z = z;
  3854. }
  3855. /**
  3856. * Sets the vector components.
  3857. *
  3858. * @param {number} x - The value of the x component.
  3859. * @param {number} y - The value of the y component.
  3860. * @param {number} z - The value of the z component.
  3861. * @return {Vector3} A reference to this vector.
  3862. */
  3863. set( x, y, z ) {
  3864. if ( z === undefined ) z = this.z; // sprite.scale.set(x,y)
  3865. this.x = x;
  3866. this.y = y;
  3867. this.z = z;
  3868. return this;
  3869. }
  3870. /**
  3871. * Sets the vector components to the same value.
  3872. *
  3873. * @param {number} scalar - The value to set for all vector components.
  3874. * @return {Vector3} A reference to this vector.
  3875. */
  3876. setScalar( scalar ) {
  3877. this.x = scalar;
  3878. this.y = scalar;
  3879. this.z = scalar;
  3880. return this;
  3881. }
  3882. /**
  3883. * Sets the vector's x component to the given value.
  3884. *
  3885. * @param {number} x - The value to set.
  3886. * @return {Vector3} A reference to this vector.
  3887. */
  3888. setX( x ) {
  3889. this.x = x;
  3890. return this;
  3891. }
  3892. /**
  3893. * Sets the vector's y component to the given value.
  3894. *
  3895. * @param {number} y - The value to set.
  3896. * @return {Vector3} A reference to this vector.
  3897. */
  3898. setY( y ) {
  3899. this.y = y;
  3900. return this;
  3901. }
  3902. /**
  3903. * Sets the vector's z component to the given value.
  3904. *
  3905. * @param {number} z - The value to set.
  3906. * @return {Vector3} A reference to this vector.
  3907. */
  3908. setZ( z ) {
  3909. this.z = z;
  3910. return this;
  3911. }
  3912. /**
  3913. * Allows to set a vector component with an index.
  3914. *
  3915. * @param {number} index - The component index. `0` equals to x, `1` equals to y, `2` equals to z.
  3916. * @param {number} value - The value to set.
  3917. * @return {Vector3} A reference to this vector.
  3918. */
  3919. setComponent( index, value ) {
  3920. switch ( index ) {
  3921. case 0: this.x = value; break;
  3922. case 1: this.y = value; break;
  3923. case 2: this.z = value; break;
  3924. default: throw new Error( 'index is out of range: ' + index );
  3925. }
  3926. return this;
  3927. }
  3928. /**
  3929. * Returns the value of the vector component which matches the given index.
  3930. *
  3931. * @param {number} index - The component index. `0` equals to x, `1` equals to y, `2` equals to z.
  3932. * @return {number} A vector component value.
  3933. */
  3934. getComponent( index ) {
  3935. switch ( index ) {
  3936. case 0: return this.x;
  3937. case 1: return this.y;
  3938. case 2: return this.z;
  3939. default: throw new Error( 'index is out of range: ' + index );
  3940. }
  3941. }
  3942. /**
  3943. * Returns a new vector with copied values from this instance.
  3944. *
  3945. * @return {Vector3} A clone of this instance.
  3946. */
  3947. clone() {
  3948. return new this.constructor( this.x, this.y, this.z );
  3949. }
  3950. /**
  3951. * Copies the values of the given vector to this instance.
  3952. *
  3953. * @param {Vector3} v - The vector to copy.
  3954. * @return {Vector3} A reference to this vector.
  3955. */
  3956. copy( v ) {
  3957. this.x = v.x;
  3958. this.y = v.y;
  3959. this.z = v.z;
  3960. return this;
  3961. }
  3962. /**
  3963. * Adds the given vector to this instance.
  3964. *
  3965. * @param {Vector3} v - The vector to add.
  3966. * @return {Vector3} A reference to this vector.
  3967. */
  3968. add( v ) {
  3969. this.x += v.x;
  3970. this.y += v.y;
  3971. this.z += v.z;
  3972. return this;
  3973. }
  3974. /**
  3975. * Adds the given scalar value to all components of this instance.
  3976. *
  3977. * @param {number} s - The scalar to add.
  3978. * @return {Vector3} A reference to this vector.
  3979. */
  3980. addScalar( s ) {
  3981. this.x += s;
  3982. this.y += s;
  3983. this.z += s;
  3984. return this;
  3985. }
  3986. /**
  3987. * Adds the given vectors and stores the result in this instance.
  3988. *
  3989. * @param {Vector3} a - The first vector.
  3990. * @param {Vector3} b - The second vector.
  3991. * @return {Vector3} A reference to this vector.
  3992. */
  3993. addVectors( a, b ) {
  3994. this.x = a.x + b.x;
  3995. this.y = a.y + b.y;
  3996. this.z = a.z + b.z;
  3997. return this;
  3998. }
  3999. /**
  4000. * Adds the given vector scaled by the given factor to this instance.
  4001. *
  4002. * @param {Vector3|Vector4} v - The vector.
  4003. * @param {number} s - The factor that scales `v`.
  4004. * @return {Vector3} A reference to this vector.
  4005. */
  4006. addScaledVector( v, s ) {
  4007. this.x += v.x * s;
  4008. this.y += v.y * s;
  4009. this.z += v.z * s;
  4010. return this;
  4011. }
  4012. /**
  4013. * Subtracts the given vector from this instance.
  4014. *
  4015. * @param {Vector3} v - The vector to subtract.
  4016. * @return {Vector3} A reference to this vector.
  4017. */
  4018. sub( v ) {
  4019. this.x -= v.x;
  4020. this.y -= v.y;
  4021. this.z -= v.z;
  4022. return this;
  4023. }
  4024. /**
  4025. * Subtracts the given scalar value from all components of this instance.
  4026. *
  4027. * @param {number} s - The scalar to subtract.
  4028. * @return {Vector3} A reference to this vector.
  4029. */
  4030. subScalar( s ) {
  4031. this.x -= s;
  4032. this.y -= s;
  4033. this.z -= s;
  4034. return this;
  4035. }
  4036. /**
  4037. * Subtracts the given vectors and stores the result in this instance.
  4038. *
  4039. * @param {Vector3} a - The first vector.
  4040. * @param {Vector3} b - The second vector.
  4041. * @return {Vector3} A reference to this vector.
  4042. */
  4043. subVectors( a, b ) {
  4044. this.x = a.x - b.x;
  4045. this.y = a.y - b.y;
  4046. this.z = a.z - b.z;
  4047. return this;
  4048. }
  4049. /**
  4050. * Multiplies the given vector with this instance.
  4051. *
  4052. * @param {Vector3} v - The vector to multiply.
  4053. * @return {Vector3} A reference to this vector.
  4054. */
  4055. multiply( v ) {
  4056. this.x *= v.x;
  4057. this.y *= v.y;
  4058. this.z *= v.z;
  4059. return this;
  4060. }
  4061. /**
  4062. * Multiplies the given scalar value with all components of this instance.
  4063. *
  4064. * @param {number} scalar - The scalar to multiply.
  4065. * @return {Vector3} A reference to this vector.
  4066. */
  4067. multiplyScalar( scalar ) {
  4068. this.x *= scalar;
  4069. this.y *= scalar;
  4070. this.z *= scalar;
  4071. return this;
  4072. }
  4073. /**
  4074. * Multiplies the given vectors and stores the result in this instance.
  4075. *
  4076. * @param {Vector3} a - The first vector.
  4077. * @param {Vector3} b - The second vector.
  4078. * @return {Vector3} A reference to this vector.
  4079. */
  4080. multiplyVectors( a, b ) {
  4081. this.x = a.x * b.x;
  4082. this.y = a.y * b.y;
  4083. this.z = a.z * b.z;
  4084. return this;
  4085. }
  4086. /**
  4087. * Applies the given Euler rotation to this vector.
  4088. *
  4089. * @param {Euler} euler - The Euler angles.
  4090. * @return {Vector3} A reference to this vector.
  4091. */
  4092. applyEuler( euler ) {
  4093. return this.applyQuaternion( _quaternion$5.setFromEuler( euler ) );
  4094. }
  4095. /**
  4096. * Applies a rotation specified by an axis and an angle to this vector.
  4097. *
  4098. * @param {Vector3} axis - A normalized vector representing the rotation axis.
  4099. * @param {number} angle - The angle in radians.
  4100. * @return {Vector3} A reference to this vector.
  4101. */
  4102. applyAxisAngle( axis, angle ) {
  4103. return this.applyQuaternion( _quaternion$5.setFromAxisAngle( axis, angle ) );
  4104. }
  4105. /**
  4106. * Multiplies this vector with the given 3x3 matrix.
  4107. *
  4108. * @param {Matrix3} m - The 3x3 matrix.
  4109. * @return {Vector3} A reference to this vector.
  4110. */
  4111. applyMatrix3( m ) {
  4112. const x = this.x, y = this.y, z = this.z;
  4113. const e = m.elements;
  4114. this.x = e[ 0 ] * x + e[ 3 ] * y + e[ 6 ] * z;
  4115. this.y = e[ 1 ] * x + e[ 4 ] * y + e[ 7 ] * z;
  4116. this.z = e[ 2 ] * x + e[ 5 ] * y + e[ 8 ] * z;
  4117. return this;
  4118. }
  4119. /**
  4120. * Multiplies this vector by the given normal matrix and normalizes
  4121. * the result.
  4122. *
  4123. * @param {Matrix3} m - The normal matrix.
  4124. * @return {Vector3} A reference to this vector.
  4125. */
  4126. applyNormalMatrix( m ) {
  4127. return this.applyMatrix3( m ).normalize();
  4128. }
  4129. /**
  4130. * Multiplies this vector (with an implicit 1 in the 4th dimension) by m, and
  4131. * divides by perspective.
  4132. *
  4133. * @param {Matrix4} m - The matrix to apply.
  4134. * @return {Vector3} A reference to this vector.
  4135. */
  4136. applyMatrix4( m ) {
  4137. const x = this.x, y = this.y, z = this.z;
  4138. const e = m.elements;
  4139. const w = 1 / ( e[ 3 ] * x + e[ 7 ] * y + e[ 11 ] * z + e[ 15 ] );
  4140. this.x = ( e[ 0 ] * x + e[ 4 ] * y + e[ 8 ] * z + e[ 12 ] ) * w;
  4141. this.y = ( e[ 1 ] * x + e[ 5 ] * y + e[ 9 ] * z + e[ 13 ] ) * w;
  4142. this.z = ( e[ 2 ] * x + e[ 6 ] * y + e[ 10 ] * z + e[ 14 ] ) * w;
  4143. return this;
  4144. }
  4145. /**
  4146. * Applies the given Quaternion to this vector.
  4147. *
  4148. * @param {Quaternion} q - The Quaternion.
  4149. * @return {Vector3} A reference to this vector.
  4150. */
  4151. applyQuaternion( q ) {
  4152. // quaternion q is assumed to have unit length
  4153. const vx = this.x, vy = this.y, vz = this.z;
  4154. const qx = q.x, qy = q.y, qz = q.z, qw = q.w;
  4155. // t = 2 * cross( q.xyz, v );
  4156. const tx = 2 * ( qy * vz - qz * vy );
  4157. const ty = 2 * ( qz * vx - qx * vz );
  4158. const tz = 2 * ( qx * vy - qy * vx );
  4159. // v + q.w * t + cross( q.xyz, t );
  4160. this.x = vx + qw * tx + qy * tz - qz * ty;
  4161. this.y = vy + qw * ty + qz * tx - qx * tz;
  4162. this.z = vz + qw * tz + qx * ty - qy * tx;
  4163. return this;
  4164. }
  4165. /**
  4166. * Projects this vector from world space into the camera's normalized
  4167. * device coordinate (NDC) space.
  4168. *
  4169. * @param {Camera} camera - The camera.
  4170. * @return {Vector3} A reference to this vector.
  4171. */
  4172. project( camera ) {
  4173. return this.applyMatrix4( camera.matrixWorldInverse ).applyMatrix4( camera.projectionMatrix );
  4174. }
  4175. /**
  4176. * Unprojects this vector from the camera's normalized device coordinate (NDC)
  4177. * space into world space.
  4178. *
  4179. * @param {Camera} camera - The camera.
  4180. * @return {Vector3} A reference to this vector.
  4181. */
  4182. unproject( camera ) {
  4183. return this.applyMatrix4( camera.projectionMatrixInverse ).applyMatrix4( camera.matrixWorld );
  4184. }
  4185. /**
  4186. * Transforms the direction of this vector by a matrix (the upper left 3 x 3
  4187. * subset of the given 4x4 matrix and then normalizes the result.
  4188. *
  4189. * @param {Matrix4} m - The matrix.
  4190. * @return {Vector3} A reference to this vector.
  4191. */
  4192. transformDirection( m ) {
  4193. // input: THREE.Matrix4 affine matrix
  4194. // vector interpreted as a direction
  4195. const x = this.x, y = this.y, z = this.z;
  4196. const e = m.elements;
  4197. this.x = e[ 0 ] * x + e[ 4 ] * y + e[ 8 ] * z;
  4198. this.y = e[ 1 ] * x + e[ 5 ] * y + e[ 9 ] * z;
  4199. this.z = e[ 2 ] * x + e[ 6 ] * y + e[ 10 ] * z;
  4200. return this.normalize();
  4201. }
  4202. /**
  4203. * Divides this instance by the given vector.
  4204. *
  4205. * @param {Vector3} v - The vector to divide.
  4206. * @return {Vector3} A reference to this vector.
  4207. */
  4208. divide( v ) {
  4209. this.x /= v.x;
  4210. this.y /= v.y;
  4211. this.z /= v.z;
  4212. return this;
  4213. }
  4214. /**
  4215. * Divides this vector by the given scalar.
  4216. *
  4217. * @param {number} scalar - The scalar to divide.
  4218. * @return {Vector3} A reference to this vector.
  4219. */
  4220. divideScalar( scalar ) {
  4221. return this.multiplyScalar( 1 / scalar );
  4222. }
  4223. /**
  4224. * If this vector's x, y or z value is greater than the given vector's x, y or z
  4225. * value, replace that value with the corresponding min value.
  4226. *
  4227. * @param {Vector3} v - The vector.
  4228. * @return {Vector3} A reference to this vector.
  4229. */
  4230. min( v ) {
  4231. this.x = Math.min( this.x, v.x );
  4232. this.y = Math.min( this.y, v.y );
  4233. this.z = Math.min( this.z, v.z );
  4234. return this;
  4235. }
  4236. /**
  4237. * If this vector's x, y or z value is less than the given vector's x, y or z
  4238. * value, replace that value with the corresponding max value.
  4239. *
  4240. * @param {Vector3} v - The vector.
  4241. * @return {Vector3} A reference to this vector.
  4242. */
  4243. max( v ) {
  4244. this.x = Math.max( this.x, v.x );
  4245. this.y = Math.max( this.y, v.y );
  4246. this.z = Math.max( this.z, v.z );
  4247. return this;
  4248. }
  4249. /**
  4250. * If this vector's x, y or z value is greater than the max vector's x, y or z
  4251. * value, it is replaced by the corresponding value.
  4252. * If this vector's x, y or z value is less than the min vector's x, y or z value,
  4253. * it is replaced by the corresponding value.
  4254. *
  4255. * @param {Vector3} min - The minimum x, y and z values.
  4256. * @param {Vector3} max - The maximum x, y and z values in the desired range.
  4257. * @return {Vector3} A reference to this vector.
  4258. */
  4259. clamp( min, max ) {
  4260. // assumes min < max, componentwise
  4261. this.x = clamp( this.x, min.x, max.x );
  4262. this.y = clamp( this.y, min.y, max.y );
  4263. this.z = clamp( this.z, min.z, max.z );
  4264. return this;
  4265. }
  4266. /**
  4267. * If this vector's x, y or z values are greater than the max value, they are
  4268. * replaced by the max value.
  4269. * If this vector's x, y or z values are less than the min value, they are
  4270. * replaced by the min value.
  4271. *
  4272. * @param {number} minVal - The minimum value the components will be clamped to.
  4273. * @param {number} maxVal - The maximum value the components will be clamped to.
  4274. * @return {Vector3} A reference to this vector.
  4275. */
  4276. clampScalar( minVal, maxVal ) {
  4277. this.x = clamp( this.x, minVal, maxVal );
  4278. this.y = clamp( this.y, minVal, maxVal );
  4279. this.z = clamp( this.z, minVal, maxVal );
  4280. return this;
  4281. }
  4282. /**
  4283. * If this vector's length is greater than the max value, it is replaced by
  4284. * the max value.
  4285. * If this vector's length is less than the min value, it is replaced by the
  4286. * min value.
  4287. *
  4288. * @param {number} min - The minimum value the vector length will be clamped to.
  4289. * @param {number} max - The maximum value the vector length will be clamped to.
  4290. * @return {Vector3} A reference to this vector.
  4291. */
  4292. clampLength( min, max ) {
  4293. const length = this.length();
  4294. return this.divideScalar( length || 1 ).multiplyScalar( clamp( length, min, max ) );
  4295. }
  4296. /**
  4297. * The components of this vector are rounded down to the nearest integer value.
  4298. *
  4299. * @return {Vector3} A reference to this vector.
  4300. */
  4301. floor() {
  4302. this.x = Math.floor( this.x );
  4303. this.y = Math.floor( this.y );
  4304. this.z = Math.floor( this.z );
  4305. return this;
  4306. }
  4307. /**
  4308. * The components of this vector are rounded up to the nearest integer value.
  4309. *
  4310. * @return {Vector3} A reference to this vector.
  4311. */
  4312. ceil() {
  4313. this.x = Math.ceil( this.x );
  4314. this.y = Math.ceil( this.y );
  4315. this.z = Math.ceil( this.z );
  4316. return this;
  4317. }
  4318. /**
  4319. * The components of this vector are rounded to the nearest integer value
  4320. *
  4321. * @return {Vector3} A reference to this vector.
  4322. */
  4323. round() {
  4324. this.x = Math.round( this.x );
  4325. this.y = Math.round( this.y );
  4326. this.z = Math.round( this.z );
  4327. return this;
  4328. }
  4329. /**
  4330. * The components of this vector are rounded towards zero (up if negative,
  4331. * down if positive) to an integer value.
  4332. *
  4333. * @return {Vector3} A reference to this vector.
  4334. */
  4335. roundToZero() {
  4336. this.x = Math.trunc( this.x );
  4337. this.y = Math.trunc( this.y );
  4338. this.z = Math.trunc( this.z );
  4339. return this;
  4340. }
  4341. /**
  4342. * Inverts this vector - i.e. sets x = -x, y = -y and z = -z.
  4343. *
  4344. * @return {Vector3} A reference to this vector.
  4345. */
  4346. negate() {
  4347. this.x = - this.x;
  4348. this.y = - this.y;
  4349. this.z = - this.z;
  4350. return this;
  4351. }
  4352. /**
  4353. * Calculates the dot product of the given vector with this instance.
  4354. *
  4355. * @param {Vector3} v - The vector to compute the dot product with.
  4356. * @return {number} The result of the dot product.
  4357. */
  4358. dot( v ) {
  4359. return this.x * v.x + this.y * v.y + this.z * v.z;
  4360. }
  4361. /**
  4362. * Computes the square of the Euclidean length (straight-line length) from
  4363. * (0, 0, 0) to (x, y, z). If you are comparing the lengths of vectors, you should
  4364. * compare the length squared instead as it is slightly more efficient to calculate.
  4365. *
  4366. * @return {number} The square length of this vector.
  4367. */
  4368. lengthSq() {
  4369. return this.x * this.x + this.y * this.y + this.z * this.z;
  4370. }
  4371. /**
  4372. * Computes the Euclidean length (straight-line length) from (0, 0, 0) to (x, y, z).
  4373. *
  4374. * @return {number} The length of this vector.
  4375. */
  4376. length() {
  4377. return Math.sqrt( this.x * this.x + this.y * this.y + this.z * this.z );
  4378. }
  4379. /**
  4380. * Computes the Manhattan length of this vector.
  4381. *
  4382. * @return {number} The length of this vector.
  4383. */
  4384. manhattanLength() {
  4385. return Math.abs( this.x ) + Math.abs( this.y ) + Math.abs( this.z );
  4386. }
  4387. /**
  4388. * Converts this vector to a unit vector - that is, sets it equal to a vector
  4389. * with the same direction as this one, but with a vector length of `1`.
  4390. *
  4391. * @return {Vector3} A reference to this vector.
  4392. */
  4393. normalize() {
  4394. return this.divideScalar( this.length() || 1 );
  4395. }
  4396. /**
  4397. * Sets this vector to a vector with the same direction as this one, but
  4398. * with the specified length.
  4399. *
  4400. * @param {number} length - The new length of this vector.
  4401. * @return {Vector3} A reference to this vector.
  4402. */
  4403. setLength( length ) {
  4404. return this.normalize().multiplyScalar( length );
  4405. }
  4406. /**
  4407. * Linearly interpolates between the given vector and this instance, where
  4408. * alpha is the percent distance along the line - alpha = 0 will be this
  4409. * vector, and alpha = 1 will be the given one.
  4410. *
  4411. * @param {Vector3} v - The vector to interpolate towards.
  4412. * @param {number} alpha - The interpolation factor, typically in the closed interval `[0, 1]`.
  4413. * @return {Vector3} A reference to this vector.
  4414. */
  4415. lerp( v, alpha ) {
  4416. this.x += ( v.x - this.x ) * alpha;
  4417. this.y += ( v.y - this.y ) * alpha;
  4418. this.z += ( v.z - this.z ) * alpha;
  4419. return this;
  4420. }
  4421. /**
  4422. * Linearly interpolates between the given vectors, where alpha is the percent
  4423. * distance along the line - alpha = 0 will be first vector, and alpha = 1 will
  4424. * be the second one. The result is stored in this instance.
  4425. *
  4426. * @param {Vector3} v1 - The first vector.
  4427. * @param {Vector3} v2 - The second vector.
  4428. * @param {number} alpha - The interpolation factor, typically in the closed interval `[0, 1]`.
  4429. * @return {Vector3} A reference to this vector.
  4430. */
  4431. lerpVectors( v1, v2, alpha ) {
  4432. this.x = v1.x + ( v2.x - v1.x ) * alpha;
  4433. this.y = v1.y + ( v2.y - v1.y ) * alpha;
  4434. this.z = v1.z + ( v2.z - v1.z ) * alpha;
  4435. return this;
  4436. }
  4437. /**
  4438. * Calculates the cross product of the given vector with this instance.
  4439. *
  4440. * @param {Vector3} v - The vector to compute the cross product with.
  4441. * @return {Vector3} The result of the cross product.
  4442. */
  4443. cross( v ) {
  4444. return this.crossVectors( this, v );
  4445. }
  4446. /**
  4447. * Calculates the cross product of the given vectors and stores the result
  4448. * in this instance.
  4449. *
  4450. * @param {Vector3} a - The first vector.
  4451. * @param {Vector3} b - The second vector.
  4452. * @return {Vector3} A reference to this vector.
  4453. */
  4454. crossVectors( a, b ) {
  4455. const ax = a.x, ay = a.y, az = a.z;
  4456. const bx = b.x, by = b.y, bz = b.z;
  4457. this.x = ay * bz - az * by;
  4458. this.y = az * bx - ax * bz;
  4459. this.z = ax * by - ay * bx;
  4460. return this;
  4461. }
  4462. /**
  4463. * Projects this vector onto the given one.
  4464. *
  4465. * @param {Vector3} v - The vector to project to.
  4466. * @return {Vector3} A reference to this vector.
  4467. */
  4468. projectOnVector( v ) {
  4469. const denominator = v.lengthSq();
  4470. if ( denominator === 0 ) return this.set( 0, 0, 0 );
  4471. const scalar = v.dot( this ) / denominator;
  4472. return this.copy( v ).multiplyScalar( scalar );
  4473. }
  4474. /**
  4475. * Projects this vector onto a plane by subtracting this
  4476. * vector projected onto the plane's normal from this vector.
  4477. *
  4478. * @param {Vector3} planeNormal - The plane normal.
  4479. * @return {Vector3} A reference to this vector.
  4480. */
  4481. projectOnPlane( planeNormal ) {
  4482. _vector$c.copy( this ).projectOnVector( planeNormal );
  4483. return this.sub( _vector$c );
  4484. }
  4485. /**
  4486. * Reflects this vector off a plane orthogonal to the given normal vector.
  4487. *
  4488. * @param {Vector3} normal - The (normalized) normal vector.
  4489. * @return {Vector3} A reference to this vector.
  4490. */
  4491. reflect( normal ) {
  4492. return this.sub( _vector$c.copy( normal ).multiplyScalar( 2 * this.dot( normal ) ) );
  4493. }
  4494. /**
  4495. * Returns the angle between the given vector and this instance in radians.
  4496. *
  4497. * @param {Vector3} v - The vector to compute the angle with.
  4498. * @return {number} The angle in radians.
  4499. */
  4500. angleTo( v ) {
  4501. const denominator = Math.sqrt( this.lengthSq() * v.lengthSq() );
  4502. if ( denominator === 0 ) return Math.PI / 2;
  4503. const theta = this.dot( v ) / denominator;
  4504. // clamp, to handle numerical problems
  4505. return Math.acos( clamp( theta, -1, 1 ) );
  4506. }
  4507. /**
  4508. * Computes the distance from the given vector to this instance.
  4509. *
  4510. * @param {Vector3} v - The vector to compute the distance to.
  4511. * @return {number} The distance.
  4512. */
  4513. distanceTo( v ) {
  4514. return Math.sqrt( this.distanceToSquared( v ) );
  4515. }
  4516. /**
  4517. * Computes the squared distance from the given vector to this instance.
  4518. * If you are just comparing the distance with another distance, you should compare
  4519. * the distance squared instead as it is slightly more efficient to calculate.
  4520. *
  4521. * @param {Vector3} v - The vector to compute the squared distance to.
  4522. * @return {number} The squared distance.
  4523. */
  4524. distanceToSquared( v ) {
  4525. const dx = this.x - v.x, dy = this.y - v.y, dz = this.z - v.z;
  4526. return dx * dx + dy * dy + dz * dz;
  4527. }
  4528. /**
  4529. * Computes the Manhattan distance from the given vector to this instance.
  4530. *
  4531. * @param {Vector3} v - The vector to compute the Manhattan distance to.
  4532. * @return {number} The Manhattan distance.
  4533. */
  4534. manhattanDistanceTo( v ) {
  4535. return Math.abs( this.x - v.x ) + Math.abs( this.y - v.y ) + Math.abs( this.z - v.z );
  4536. }
  4537. /**
  4538. * Sets the vector components from the given spherical coordinates.
  4539. *
  4540. * @param {Spherical} s - The spherical coordinates.
  4541. * @return {Vector3} A reference to this vector.
  4542. */
  4543. setFromSpherical( s ) {
  4544. return this.setFromSphericalCoords( s.radius, s.phi, s.theta );
  4545. }
  4546. /**
  4547. * Sets the vector components from the given spherical coordinates.
  4548. *
  4549. * @param {number} radius - The radius.
  4550. * @param {number} phi - The phi angle in radians.
  4551. * @param {number} theta - The theta angle in radians.
  4552. * @return {Vector3} A reference to this vector.
  4553. */
  4554. setFromSphericalCoords( radius, phi, theta ) {
  4555. const sinPhiRadius = Math.sin( phi ) * radius;
  4556. this.x = sinPhiRadius * Math.sin( theta );
  4557. this.y = Math.cos( phi ) * radius;
  4558. this.z = sinPhiRadius * Math.cos( theta );
  4559. return this;
  4560. }
  4561. /**
  4562. * Sets the vector components from the given cylindrical coordinates.
  4563. *
  4564. * @param {Cylindrical} c - The cylindrical coordinates.
  4565. * @return {Vector3} A reference to this vector.
  4566. */
  4567. setFromCylindrical( c ) {
  4568. return this.setFromCylindricalCoords( c.radius, c.theta, c.y );
  4569. }
  4570. /**
  4571. * Sets the vector components from the given cylindrical coordinates.
  4572. *
  4573. * @param {number} radius - The radius.
  4574. * @param {number} theta - The theta angle in radians.
  4575. * @param {number} y - The y value.
  4576. * @return {Vector3} A reference to this vector.
  4577. */
  4578. setFromCylindricalCoords( radius, theta, y ) {
  4579. this.x = radius * Math.sin( theta );
  4580. this.y = y;
  4581. this.z = radius * Math.cos( theta );
  4582. return this;
  4583. }
  4584. /**
  4585. * Sets the vector components to the position elements of the
  4586. * given transformation matrix.
  4587. *
  4588. * @param {Matrix4} m - The 4x4 matrix.
  4589. * @return {Vector3} A reference to this vector.
  4590. */
  4591. setFromMatrixPosition( m ) {
  4592. const e = m.elements;
  4593. this.x = e[ 12 ];
  4594. this.y = e[ 13 ];
  4595. this.z = e[ 14 ];
  4596. return this;
  4597. }
  4598. /**
  4599. * Sets the vector components to the scale elements of the
  4600. * given transformation matrix.
  4601. *
  4602. * @param {Matrix4} m - The 4x4 matrix.
  4603. * @return {Vector3} A reference to this vector.
  4604. */
  4605. setFromMatrixScale( m ) {
  4606. const sx = this.setFromMatrixColumn( m, 0 ).length();
  4607. const sy = this.setFromMatrixColumn( m, 1 ).length();
  4608. const sz = this.setFromMatrixColumn( m, 2 ).length();
  4609. this.x = sx;
  4610. this.y = sy;
  4611. this.z = sz;
  4612. return this;
  4613. }
  4614. /**
  4615. * Sets the vector components from the specified matrix column.
  4616. *
  4617. * @param {Matrix4} m - The 4x4 matrix.
  4618. * @param {number} index - The column index.
  4619. * @return {Vector3} A reference to this vector.
  4620. */
  4621. setFromMatrixColumn( m, index ) {
  4622. return this.fromArray( m.elements, index * 4 );
  4623. }
  4624. /**
  4625. * Sets the vector components from the specified matrix column.
  4626. *
  4627. * @param {Matrix3} m - The 3x3 matrix.
  4628. * @param {number} index - The column index.
  4629. * @return {Vector3} A reference to this vector.
  4630. */
  4631. setFromMatrix3Column( m, index ) {
  4632. return this.fromArray( m.elements, index * 3 );
  4633. }
  4634. /**
  4635. * Sets the vector components from the given Euler angles.
  4636. *
  4637. * @param {Euler} e - The Euler angles to set.
  4638. * @return {Vector3} A reference to this vector.
  4639. */
  4640. setFromEuler( e ) {
  4641. this.x = e._x;
  4642. this.y = e._y;
  4643. this.z = e._z;
  4644. return this;
  4645. }
  4646. /**
  4647. * Sets the vector components from the RGB components of the
  4648. * given color.
  4649. *
  4650. * @param {Color} c - The color to set.
  4651. * @return {Vector3} A reference to this vector.
  4652. */
  4653. setFromColor( c ) {
  4654. this.x = c.r;
  4655. this.y = c.g;
  4656. this.z = c.b;
  4657. return this;
  4658. }
  4659. /**
  4660. * Returns `true` if this vector is equal with the given one.
  4661. *
  4662. * @param {Vector3} v - The vector to test for equality.
  4663. * @return {boolean} Whether this vector is equal with the given one.
  4664. */
  4665. equals( v ) {
  4666. return ( ( v.x === this.x ) && ( v.y === this.y ) && ( v.z === this.z ) );
  4667. }
  4668. /**
  4669. * Sets this vector's x value to be `array[ offset ]`, y value to be `array[ offset + 1 ]`
  4670. * and z value to be `array[ offset + 2 ]`.
  4671. *
  4672. * @param {Array<number>} array - An array holding the vector component values.
  4673. * @param {number} [offset=0] - The offset into the array.
  4674. * @return {Vector3} A reference to this vector.
  4675. */
  4676. fromArray( array, offset = 0 ) {
  4677. this.x = array[ offset ];
  4678. this.y = array[ offset + 1 ];
  4679. this.z = array[ offset + 2 ];
  4680. return this;
  4681. }
  4682. /**
  4683. * Writes the components of this vector to the given array. If no array is provided,
  4684. * the method returns a new instance.
  4685. *
  4686. * @param {Array<number>} [array=[]] - The target array holding the vector components.
  4687. * @param {number} [offset=0] - Index of the first element in the array.
  4688. * @return {Array<number>} The vector components.
  4689. */
  4690. toArray( array = [], offset = 0 ) {
  4691. array[ offset ] = this.x;
  4692. array[ offset + 1 ] = this.y;
  4693. array[ offset + 2 ] = this.z;
  4694. return array;
  4695. }
  4696. /**
  4697. * Sets the components of this vector from the given buffer attribute.
  4698. *
  4699. * @param {BufferAttribute} attribute - The buffer attribute holding vector data.
  4700. * @param {number} index - The index into the attribute.
  4701. * @return {Vector3} A reference to this vector.
  4702. */
  4703. fromBufferAttribute( attribute, index ) {
  4704. this.x = attribute.getX( index );
  4705. this.y = attribute.getY( index );
  4706. this.z = attribute.getZ( index );
  4707. return this;
  4708. }
  4709. /**
  4710. * Sets each component of this vector to a pseudo-random value between `0` and
  4711. * `1`, excluding `1`.
  4712. *
  4713. * @return {Vector3} A reference to this vector.
  4714. */
  4715. random() {
  4716. this.x = Math.random();
  4717. this.y = Math.random();
  4718. this.z = Math.random();
  4719. return this;
  4720. }
  4721. /**
  4722. * Sets this vector to a uniformly random point on a unit sphere.
  4723. *
  4724. * @return {Vector3} A reference to this vector.
  4725. */
  4726. randomDirection() {
  4727. // https://mathworld.wolfram.com/SpherePointPicking.html
  4728. const theta = Math.random() * Math.PI * 2;
  4729. const u = Math.random() * 2 - 1;
  4730. const c = Math.sqrt( 1 - u * u );
  4731. this.x = c * Math.cos( theta );
  4732. this.y = u;
  4733. this.z = c * Math.sin( theta );
  4734. return this;
  4735. }
  4736. *[ Symbol.iterator ]() {
  4737. yield this.x;
  4738. yield this.y;
  4739. yield this.z;
  4740. }
  4741. }
  4742. const _vector$c = /*@__PURE__*/ new Vector3();
  4743. const _quaternion$5 = /*@__PURE__*/ new Quaternion();
  4744. /**
  4745. * Represents a 3x3 matrix.
  4746. *
  4747. * A Note on Row-Major and Column-Major Ordering:
  4748. *
  4749. * The constructor and {@link Matrix3#set} method take arguments in
  4750. * [row-major](https://en.wikipedia.org/wiki/Row-_and_column-major_order#Column-major_order)
  4751. * order, while internally they are stored in the {@link Matrix3#elements} array in column-major order.
  4752. * This means that calling:
  4753. * ```js
  4754. * const m = new THREE.Matrix();
  4755. * m.set( 11, 12, 13,
  4756. * 21, 22, 23,
  4757. * 31, 32, 33 );
  4758. * ```
  4759. * will result in the elements array containing:
  4760. * ```js
  4761. * m.elements = [ 11, 21, 31,
  4762. * 12, 22, 32,
  4763. * 13, 23, 33 ];
  4764. * ```
  4765. * and internally all calculations are performed using column-major ordering.
  4766. * However, as the actual ordering makes no difference mathematically and
  4767. * most people are used to thinking about matrices in row-major order, the
  4768. * three.js documentation shows matrices in row-major order. Just bear in
  4769. * mind that if you are reading the source code, you'll have to take the
  4770. * transpose of any matrices outlined here to make sense of the calculations.
  4771. */
  4772. class Matrix3 {
  4773. /**
  4774. * Constructs a new 3x3 matrix. The arguments are supposed to be
  4775. * in row-major order. If no arguments are provided, the constructor
  4776. * initializes the matrix as an identity matrix.
  4777. *
  4778. * @param {number} [n11] - 1-1 matrix element.
  4779. * @param {number} [n12] - 1-2 matrix element.
  4780. * @param {number} [n13] - 1-3 matrix element.
  4781. * @param {number} [n21] - 2-1 matrix element.
  4782. * @param {number} [n22] - 2-2 matrix element.
  4783. * @param {number} [n23] - 2-3 matrix element.
  4784. * @param {number} [n31] - 3-1 matrix element.
  4785. * @param {number} [n32] - 3-2 matrix element.
  4786. * @param {number} [n33] - 3-3 matrix element.
  4787. */
  4788. constructor( n11, n12, n13, n21, n22, n23, n31, n32, n33 ) {
  4789. /**
  4790. * This flag can be used for type testing.
  4791. *
  4792. * @type {boolean}
  4793. * @readonly
  4794. * @default true
  4795. */
  4796. Matrix3.prototype.isMatrix3 = true;
  4797. /**
  4798. * A column-major list of matrix values.
  4799. *
  4800. * @type {Array<number>}
  4801. */
  4802. this.elements = [
  4803. 1, 0, 0,
  4804. 0, 1, 0,
  4805. 0, 0, 1
  4806. ];
  4807. if ( n11 !== undefined ) {
  4808. this.set( n11, n12, n13, n21, n22, n23, n31, n32, n33 );
  4809. }
  4810. }
  4811. /**
  4812. * Sets the elements of the matrix.The arguments are supposed to be
  4813. * in row-major order.
  4814. *
  4815. * @param {number} [n11] - 1-1 matrix element.
  4816. * @param {number} [n12] - 1-2 matrix element.
  4817. * @param {number} [n13] - 1-3 matrix element.
  4818. * @param {number} [n21] - 2-1 matrix element.
  4819. * @param {number} [n22] - 2-2 matrix element.
  4820. * @param {number} [n23] - 2-3 matrix element.
  4821. * @param {number} [n31] - 3-1 matrix element.
  4822. * @param {number} [n32] - 3-2 matrix element.
  4823. * @param {number} [n33] - 3-3 matrix element.
  4824. * @return {Matrix3} A reference to this matrix.
  4825. */
  4826. set( n11, n12, n13, n21, n22, n23, n31, n32, n33 ) {
  4827. const te = this.elements;
  4828. te[ 0 ] = n11; te[ 1 ] = n21; te[ 2 ] = n31;
  4829. te[ 3 ] = n12; te[ 4 ] = n22; te[ 5 ] = n32;
  4830. te[ 6 ] = n13; te[ 7 ] = n23; te[ 8 ] = n33;
  4831. return this;
  4832. }
  4833. /**
  4834. * Sets this matrix to the 3x3 identity matrix.
  4835. *
  4836. * @return {Matrix3} A reference to this matrix.
  4837. */
  4838. identity() {
  4839. this.set(
  4840. 1, 0, 0,
  4841. 0, 1, 0,
  4842. 0, 0, 1
  4843. );
  4844. return this;
  4845. }
  4846. /**
  4847. * Copies the values of the given matrix to this instance.
  4848. *
  4849. * @param {Matrix3} m - The matrix to copy.
  4850. * @return {Matrix3} A reference to this matrix.
  4851. */
  4852. copy( m ) {
  4853. const te = this.elements;
  4854. const me = m.elements;
  4855. te[ 0 ] = me[ 0 ]; te[ 1 ] = me[ 1 ]; te[ 2 ] = me[ 2 ];
  4856. te[ 3 ] = me[ 3 ]; te[ 4 ] = me[ 4 ]; te[ 5 ] = me[ 5 ];
  4857. te[ 6 ] = me[ 6 ]; te[ 7 ] = me[ 7 ]; te[ 8 ] = me[ 8 ];
  4858. return this;
  4859. }
  4860. /**
  4861. * Extracts the basis of this matrix into the three axis vectors provided.
  4862. *
  4863. * @param {Vector3} xAxis - The basis's x axis.
  4864. * @param {Vector3} yAxis - The basis's y axis.
  4865. * @param {Vector3} zAxis - The basis's z axis.
  4866. * @return {Matrix3} A reference to this matrix.
  4867. */
  4868. extractBasis( xAxis, yAxis, zAxis ) {
  4869. xAxis.setFromMatrix3Column( this, 0 );
  4870. yAxis.setFromMatrix3Column( this, 1 );
  4871. zAxis.setFromMatrix3Column( this, 2 );
  4872. return this;
  4873. }
  4874. /**
  4875. * Set this matrix to the upper 3x3 matrix of the given 4x4 matrix.
  4876. *
  4877. * @param {Matrix4} m - The 4x4 matrix.
  4878. * @return {Matrix3} A reference to this matrix.
  4879. */
  4880. setFromMatrix4( m ) {
  4881. const me = m.elements;
  4882. this.set(
  4883. me[ 0 ], me[ 4 ], me[ 8 ],
  4884. me[ 1 ], me[ 5 ], me[ 9 ],
  4885. me[ 2 ], me[ 6 ], me[ 10 ]
  4886. );
  4887. return this;
  4888. }
  4889. /**
  4890. * Post-multiplies this matrix by the given 3x3 matrix.
  4891. *
  4892. * @param {Matrix3} m - The matrix to multiply with.
  4893. * @return {Matrix3} A reference to this matrix.
  4894. */
  4895. multiply( m ) {
  4896. return this.multiplyMatrices( this, m );
  4897. }
  4898. /**
  4899. * Pre-multiplies this matrix by the given 3x3 matrix.
  4900. *
  4901. * @param {Matrix3} m - The matrix to multiply with.
  4902. * @return {Matrix3} A reference to this matrix.
  4903. */
  4904. premultiply( m ) {
  4905. return this.multiplyMatrices( m, this );
  4906. }
  4907. /**
  4908. * Multiples the given 3x3 matrices and stores the result
  4909. * in this matrix.
  4910. *
  4911. * @param {Matrix3} a - The first matrix.
  4912. * @param {Matrix3} b - The second matrix.
  4913. * @return {Matrix3} A reference to this matrix.
  4914. */
  4915. multiplyMatrices( a, b ) {
  4916. const ae = a.elements;
  4917. const be = b.elements;
  4918. const te = this.elements;
  4919. const a11 = ae[ 0 ], a12 = ae[ 3 ], a13 = ae[ 6 ];
  4920. const a21 = ae[ 1 ], a22 = ae[ 4 ], a23 = ae[ 7 ];
  4921. const a31 = ae[ 2 ], a32 = ae[ 5 ], a33 = ae[ 8 ];
  4922. const b11 = be[ 0 ], b12 = be[ 3 ], b13 = be[ 6 ];
  4923. const b21 = be[ 1 ], b22 = be[ 4 ], b23 = be[ 7 ];
  4924. const b31 = be[ 2 ], b32 = be[ 5 ], b33 = be[ 8 ];
  4925. te[ 0 ] = a11 * b11 + a12 * b21 + a13 * b31;
  4926. te[ 3 ] = a11 * b12 + a12 * b22 + a13 * b32;
  4927. te[ 6 ] = a11 * b13 + a12 * b23 + a13 * b33;
  4928. te[ 1 ] = a21 * b11 + a22 * b21 + a23 * b31;
  4929. te[ 4 ] = a21 * b12 + a22 * b22 + a23 * b32;
  4930. te[ 7 ] = a21 * b13 + a22 * b23 + a23 * b33;
  4931. te[ 2 ] = a31 * b11 + a32 * b21 + a33 * b31;
  4932. te[ 5 ] = a31 * b12 + a32 * b22 + a33 * b32;
  4933. te[ 8 ] = a31 * b13 + a32 * b23 + a33 * b33;
  4934. return this;
  4935. }
  4936. /**
  4937. * Multiplies every component of the matrix by the given scalar.
  4938. *
  4939. * @param {number} s - The scalar.
  4940. * @return {Matrix3} A reference to this matrix.
  4941. */
  4942. multiplyScalar( s ) {
  4943. const te = this.elements;
  4944. te[ 0 ] *= s; te[ 3 ] *= s; te[ 6 ] *= s;
  4945. te[ 1 ] *= s; te[ 4 ] *= s; te[ 7 ] *= s;
  4946. te[ 2 ] *= s; te[ 5 ] *= s; te[ 8 ] *= s;
  4947. return this;
  4948. }
  4949. /**
  4950. * Computes and returns the determinant of this matrix.
  4951. *
  4952. * @return {number} The determinant.
  4953. */
  4954. determinant() {
  4955. const te = this.elements;
  4956. const a = te[ 0 ], b = te[ 1 ], c = te[ 2 ],
  4957. d = te[ 3 ], e = te[ 4 ], f = te[ 5 ],
  4958. g = te[ 6 ], h = te[ 7 ], i = te[ 8 ];
  4959. return a * e * i - a * f * h - b * d * i + b * f * g + c * d * h - c * e * g;
  4960. }
  4961. /**
  4962. * Inverts this matrix, using the [analytic method](https://en.wikipedia.org/wiki/Invertible_matrix#Analytic_solution).
  4963. * You can not invert with a determinant of zero. If you attempt this, the method produces
  4964. * a zero matrix instead.
  4965. *
  4966. * @return {Matrix3} A reference to this matrix.
  4967. */
  4968. invert() {
  4969. const te = this.elements,
  4970. n11 = te[ 0 ], n21 = te[ 1 ], n31 = te[ 2 ],
  4971. n12 = te[ 3 ], n22 = te[ 4 ], n32 = te[ 5 ],
  4972. n13 = te[ 6 ], n23 = te[ 7 ], n33 = te[ 8 ],
  4973. t11 = n33 * n22 - n32 * n23,
  4974. t12 = n32 * n13 - n33 * n12,
  4975. t13 = n23 * n12 - n22 * n13,
  4976. det = n11 * t11 + n21 * t12 + n31 * t13;
  4977. if ( det === 0 ) return this.set( 0, 0, 0, 0, 0, 0, 0, 0, 0 );
  4978. const detInv = 1 / det;
  4979. te[ 0 ] = t11 * detInv;
  4980. te[ 1 ] = ( n31 * n23 - n33 * n21 ) * detInv;
  4981. te[ 2 ] = ( n32 * n21 - n31 * n22 ) * detInv;
  4982. te[ 3 ] = t12 * detInv;
  4983. te[ 4 ] = ( n33 * n11 - n31 * n13 ) * detInv;
  4984. te[ 5 ] = ( n31 * n12 - n32 * n11 ) * detInv;
  4985. te[ 6 ] = t13 * detInv;
  4986. te[ 7 ] = ( n21 * n13 - n23 * n11 ) * detInv;
  4987. te[ 8 ] = ( n22 * n11 - n21 * n12 ) * detInv;
  4988. return this;
  4989. }
  4990. /**
  4991. * Transposes this matrix in place.
  4992. *
  4993. * @return {Matrix3} A reference to this matrix.
  4994. */
  4995. transpose() {
  4996. let tmp;
  4997. const m = this.elements;
  4998. tmp = m[ 1 ]; m[ 1 ] = m[ 3 ]; m[ 3 ] = tmp;
  4999. tmp = m[ 2 ]; m[ 2 ] = m[ 6 ]; m[ 6 ] = tmp;
  5000. tmp = m[ 5 ]; m[ 5 ] = m[ 7 ]; m[ 7 ] = tmp;
  5001. return this;
  5002. }
  5003. /**
  5004. * Computes the normal matrix which is the inverse transpose of the upper
  5005. * left 3x3 portion of the given 4x4 matrix.
  5006. *
  5007. * @param {Matrix4} matrix4 - The 4x4 matrix.
  5008. * @return {Matrix3} A reference to this matrix.
  5009. */
  5010. getNormalMatrix( matrix4 ) {
  5011. return this.setFromMatrix4( matrix4 ).invert().transpose();
  5012. }
  5013. /**
  5014. * Transposes this matrix into the supplied array, and returns itself unchanged.
  5015. *
  5016. * @param {Array<number>} r - An array to store the transposed matrix elements.
  5017. * @return {Matrix3} A reference to this matrix.
  5018. */
  5019. transposeIntoArray( r ) {
  5020. const m = this.elements;
  5021. r[ 0 ] = m[ 0 ];
  5022. r[ 1 ] = m[ 3 ];
  5023. r[ 2 ] = m[ 6 ];
  5024. r[ 3 ] = m[ 1 ];
  5025. r[ 4 ] = m[ 4 ];
  5026. r[ 5 ] = m[ 7 ];
  5027. r[ 6 ] = m[ 2 ];
  5028. r[ 7 ] = m[ 5 ];
  5029. r[ 8 ] = m[ 8 ];
  5030. return this;
  5031. }
  5032. /**
  5033. * Sets the UV transform matrix from offset, repeat, rotation, and center.
  5034. *
  5035. * @param {number} tx - Offset x.
  5036. * @param {number} ty - Offset y.
  5037. * @param {number} sx - Repeat x.
  5038. * @param {number} sy - Repeat y.
  5039. * @param {number} rotation - Rotation, in radians. Positive values rotate counterclockwise.
  5040. * @param {number} cx - Center x of rotation.
  5041. * @param {number} cy - Center y of rotation
  5042. * @return {Matrix3} A reference to this matrix.
  5043. */
  5044. setUvTransform( tx, ty, sx, sy, rotation, cx, cy ) {
  5045. const c = Math.cos( rotation );
  5046. const s = Math.sin( rotation );
  5047. this.set(
  5048. sx * c, sx * s, - sx * ( c * cx + s * cy ) + cx + tx,
  5049. - sy * s, sy * c, - sy * ( - s * cx + c * cy ) + cy + ty,
  5050. 0, 0, 1
  5051. );
  5052. return this;
  5053. }
  5054. /**
  5055. * Scales this matrix with the given scalar values.
  5056. *
  5057. * @param {number} sx - The amount to scale in the X axis.
  5058. * @param {number} sy - The amount to scale in the Y axis.
  5059. * @return {Matrix3} A reference to this matrix.
  5060. */
  5061. scale( sx, sy ) {
  5062. this.premultiply( _m3.makeScale( sx, sy ) );
  5063. return this;
  5064. }
  5065. /**
  5066. * Rotates this matrix by the given angle.
  5067. *
  5068. * @param {number} theta - The rotation in radians.
  5069. * @return {Matrix3} A reference to this matrix.
  5070. */
  5071. rotate( theta ) {
  5072. this.premultiply( _m3.makeRotation( - theta ) );
  5073. return this;
  5074. }
  5075. /**
  5076. * Translates this matrix by the given scalar values.
  5077. *
  5078. * @param {number} tx - The amount to translate in the X axis.
  5079. * @param {number} ty - The amount to translate in the Y axis.
  5080. * @return {Matrix3} A reference to this matrix.
  5081. */
  5082. translate( tx, ty ) {
  5083. this.premultiply( _m3.makeTranslation( tx, ty ) );
  5084. return this;
  5085. }
  5086. // for 2D Transforms
  5087. /**
  5088. * Sets this matrix as a 2D translation transform.
  5089. *
  5090. * @param {number|Vector2} x - The amount to translate in the X axis or alternatively a translation vector.
  5091. * @param {number} y - The amount to translate in the Y axis.
  5092. * @return {Matrix3} A reference to this matrix.
  5093. */
  5094. makeTranslation( x, y ) {
  5095. if ( x.isVector2 ) {
  5096. this.set(
  5097. 1, 0, x.x,
  5098. 0, 1, x.y,
  5099. 0, 0, 1
  5100. );
  5101. } else {
  5102. this.set(
  5103. 1, 0, x,
  5104. 0, 1, y,
  5105. 0, 0, 1
  5106. );
  5107. }
  5108. return this;
  5109. }
  5110. /**
  5111. * Sets this matrix as a 2D rotational transformation.
  5112. *
  5113. * @param {number} theta - The rotation in radians.
  5114. * @return {Matrix3} A reference to this matrix.
  5115. */
  5116. makeRotation( theta ) {
  5117. // counterclockwise
  5118. const c = Math.cos( theta );
  5119. const s = Math.sin( theta );
  5120. this.set(
  5121. c, - s, 0,
  5122. s, c, 0,
  5123. 0, 0, 1
  5124. );
  5125. return this;
  5126. }
  5127. /**
  5128. * Sets this matrix as a 2D scale transform.
  5129. *
  5130. * @param {number} x - The amount to scale in the X axis.
  5131. * @param {number} y - The amount to scale in the Y axis.
  5132. * @return {Matrix3} A reference to this matrix.
  5133. */
  5134. makeScale( x, y ) {
  5135. this.set(
  5136. x, 0, 0,
  5137. 0, y, 0,
  5138. 0, 0, 1
  5139. );
  5140. return this;
  5141. }
  5142. /**
  5143. * Returns `true` if this matrix is equal with the given one.
  5144. *
  5145. * @param {Matrix3} matrix - The matrix to test for equality.
  5146. * @return {boolean} Whether this matrix is equal with the given one.
  5147. */
  5148. equals( matrix ) {
  5149. const te = this.elements;
  5150. const me = matrix.elements;
  5151. for ( let i = 0; i < 9; i ++ ) {
  5152. if ( te[ i ] !== me[ i ] ) return false;
  5153. }
  5154. return true;
  5155. }
  5156. /**
  5157. * Sets the elements of the matrix from the given array.
  5158. *
  5159. * @param {Array<number>} array - The matrix elements in column-major order.
  5160. * @param {number} [offset=0] - Index of the first element in the array.
  5161. * @return {Matrix3} A reference to this matrix.
  5162. */
  5163. fromArray( array, offset = 0 ) {
  5164. for ( let i = 0; i < 9; i ++ ) {
  5165. this.elements[ i ] = array[ i + offset ];
  5166. }
  5167. return this;
  5168. }
  5169. /**
  5170. * Writes the elements of this matrix to the given array. If no array is provided,
  5171. * the method returns a new instance.
  5172. *
  5173. * @param {Array<number>} [array=[]] - The target array holding the matrix elements in column-major order.
  5174. * @param {number} [offset=0] - Index of the first element in the array.
  5175. * @return {Array<number>} The matrix elements in column-major order.
  5176. */
  5177. toArray( array = [], offset = 0 ) {
  5178. const te = this.elements;
  5179. array[ offset ] = te[ 0 ];
  5180. array[ offset + 1 ] = te[ 1 ];
  5181. array[ offset + 2 ] = te[ 2 ];
  5182. array[ offset + 3 ] = te[ 3 ];
  5183. array[ offset + 4 ] = te[ 4 ];
  5184. array[ offset + 5 ] = te[ 5 ];
  5185. array[ offset + 6 ] = te[ 6 ];
  5186. array[ offset + 7 ] = te[ 7 ];
  5187. array[ offset + 8 ] = te[ 8 ];
  5188. return array;
  5189. }
  5190. /**
  5191. * Returns a matrix with copied values from this instance.
  5192. *
  5193. * @return {Matrix3} A clone of this instance.
  5194. */
  5195. clone() {
  5196. return new this.constructor().fromArray( this.elements );
  5197. }
  5198. }
  5199. const _m3 = /*@__PURE__*/ new Matrix3();
  5200. const LINEAR_REC709_TO_XYZ = /*@__PURE__*/ new Matrix3().set(
  5201. 0.4123908, 0.3575843, 0.1804808,
  5202. 0.2126390, 0.7151687, 0.0721923,
  5203. 0.0193308, 0.1191948, 0.9505322
  5204. );
  5205. const XYZ_TO_LINEAR_REC709 = /*@__PURE__*/ new Matrix3().set(
  5206. 3.2409699, -1.5373832, -0.4986108,
  5207. -0.9692436, 1.8759675, 0.0415551,
  5208. 0.0556301, -0.203977, 1.0569715
  5209. );
  5210. function createColorManagement() {
  5211. const ColorManagement = {
  5212. enabled: true,
  5213. workingColorSpace: LinearSRGBColorSpace,
  5214. /**
  5215. * Implementations of supported color spaces.
  5216. *
  5217. * Required:
  5218. * - primaries: chromaticity coordinates [ rx ry gx gy bx by ]
  5219. * - whitePoint: reference white [ x y ]
  5220. * - transfer: transfer function (pre-defined)
  5221. * - toXYZ: Matrix3 RGB to XYZ transform
  5222. * - fromXYZ: Matrix3 XYZ to RGB transform
  5223. * - luminanceCoefficients: RGB luminance coefficients
  5224. *
  5225. * Optional:
  5226. * - outputColorSpaceConfig: { drawingBufferColorSpace: ColorSpace, toneMappingMode: 'extended' | 'standard' }
  5227. * - workingColorSpaceConfig: { unpackColorSpace: ColorSpace }
  5228. *
  5229. * Reference:
  5230. * - https://www.russellcottrell.com/photo/matrixCalculator.htm
  5231. */
  5232. spaces: {},
  5233. convert: function ( color, sourceColorSpace, targetColorSpace ) {
  5234. if ( this.enabled === false || sourceColorSpace === targetColorSpace || ! sourceColorSpace || ! targetColorSpace ) {
  5235. return color;
  5236. }
  5237. if ( this.spaces[ sourceColorSpace ].transfer === SRGBTransfer ) {
  5238. color.r = SRGBToLinear( color.r );
  5239. color.g = SRGBToLinear( color.g );
  5240. color.b = SRGBToLinear( color.b );
  5241. }
  5242. if ( this.spaces[ sourceColorSpace ].primaries !== this.spaces[ targetColorSpace ].primaries ) {
  5243. color.applyMatrix3( this.spaces[ sourceColorSpace ].toXYZ );
  5244. color.applyMatrix3( this.spaces[ targetColorSpace ].fromXYZ );
  5245. }
  5246. if ( this.spaces[ targetColorSpace ].transfer === SRGBTransfer ) {
  5247. color.r = LinearToSRGB( color.r );
  5248. color.g = LinearToSRGB( color.g );
  5249. color.b = LinearToSRGB( color.b );
  5250. }
  5251. return color;
  5252. },
  5253. workingToColorSpace: function ( color, targetColorSpace ) {
  5254. return this.convert( color, this.workingColorSpace, targetColorSpace );
  5255. },
  5256. colorSpaceToWorking: function ( color, sourceColorSpace ) {
  5257. return this.convert( color, sourceColorSpace, this.workingColorSpace );
  5258. },
  5259. getPrimaries: function ( colorSpace ) {
  5260. return this.spaces[ colorSpace ].primaries;
  5261. },
  5262. getTransfer: function ( colorSpace ) {
  5263. if ( colorSpace === NoColorSpace ) return LinearTransfer;
  5264. return this.spaces[ colorSpace ].transfer;
  5265. },
  5266. getToneMappingMode: function ( colorSpace ) {
  5267. return this.spaces[ colorSpace ].outputColorSpaceConfig.toneMappingMode || 'standard';
  5268. },
  5269. getLuminanceCoefficients: function ( target, colorSpace = this.workingColorSpace ) {
  5270. return target.fromArray( this.spaces[ colorSpace ].luminanceCoefficients );
  5271. },
  5272. define: function ( colorSpaces ) {
  5273. Object.assign( this.spaces, colorSpaces );
  5274. },
  5275. // Internal APIs
  5276. _getMatrix: function ( targetMatrix, sourceColorSpace, targetColorSpace ) {
  5277. return targetMatrix
  5278. .copy( this.spaces[ sourceColorSpace ].toXYZ )
  5279. .multiply( this.spaces[ targetColorSpace ].fromXYZ );
  5280. },
  5281. _getDrawingBufferColorSpace: function ( colorSpace ) {
  5282. return this.spaces[ colorSpace ].outputColorSpaceConfig.drawingBufferColorSpace;
  5283. },
  5284. _getUnpackColorSpace: function ( colorSpace = this.workingColorSpace ) {
  5285. return this.spaces[ colorSpace ].workingColorSpaceConfig.unpackColorSpace;
  5286. },
  5287. // Deprecated
  5288. fromWorkingColorSpace: function ( color, targetColorSpace ) {
  5289. warnOnce( 'ColorManagement: .fromWorkingColorSpace() has been renamed to .workingToColorSpace().' ); // @deprecated, r177
  5290. return ColorManagement.workingToColorSpace( color, targetColorSpace );
  5291. },
  5292. toWorkingColorSpace: function ( color, sourceColorSpace ) {
  5293. warnOnce( 'ColorManagement: .toWorkingColorSpace() has been renamed to .colorSpaceToWorking().' ); // @deprecated, r177
  5294. return ColorManagement.colorSpaceToWorking( color, sourceColorSpace );
  5295. },
  5296. };
  5297. /******************************************************************************
  5298. * sRGB definitions
  5299. */
  5300. const REC709_PRIMARIES = [ 0.640, 0.330, 0.300, 0.600, 0.150, 0.060 ];
  5301. const REC709_LUMINANCE_COEFFICIENTS = [ 0.2126, 0.7152, 0.0722 ];
  5302. const D65 = [ 0.3127, 0.3290 ];
  5303. ColorManagement.define( {
  5304. [ LinearSRGBColorSpace ]: {
  5305. primaries: REC709_PRIMARIES,
  5306. whitePoint: D65,
  5307. transfer: LinearTransfer,
  5308. toXYZ: LINEAR_REC709_TO_XYZ,
  5309. fromXYZ: XYZ_TO_LINEAR_REC709,
  5310. luminanceCoefficients: REC709_LUMINANCE_COEFFICIENTS,
  5311. workingColorSpaceConfig: { unpackColorSpace: SRGBColorSpace },
  5312. outputColorSpaceConfig: { drawingBufferColorSpace: SRGBColorSpace }
  5313. },
  5314. [ SRGBColorSpace ]: {
  5315. primaries: REC709_PRIMARIES,
  5316. whitePoint: D65,
  5317. transfer: SRGBTransfer,
  5318. toXYZ: LINEAR_REC709_TO_XYZ,
  5319. fromXYZ: XYZ_TO_LINEAR_REC709,
  5320. luminanceCoefficients: REC709_LUMINANCE_COEFFICIENTS,
  5321. outputColorSpaceConfig: { drawingBufferColorSpace: SRGBColorSpace }
  5322. },
  5323. } );
  5324. return ColorManagement;
  5325. }
  5326. const ColorManagement = /*@__PURE__*/ createColorManagement();
  5327. function SRGBToLinear( c ) {
  5328. return ( c < 0.04045 ) ? c * 0.0773993808 : Math.pow( c * 0.9478672986 + 0.0521327014, 2.4 );
  5329. }
  5330. function LinearToSRGB( c ) {
  5331. return ( c < 0.0031308 ) ? c * 12.92 : 1.055 * ( Math.pow( c, 0.41666 ) ) - 0.055;
  5332. }
  5333. let _canvas;
  5334. /**
  5335. * A class containing utility functions for images.
  5336. *
  5337. * @hideconstructor
  5338. */
  5339. class ImageUtils {
  5340. /**
  5341. * Returns a data URI containing a representation of the given image.
  5342. *
  5343. * @param {(HTMLImageElement|HTMLCanvasElement)} image - The image object.
  5344. * @param {string} [type='image/png'] - Indicates the image format.
  5345. * @return {string} The data URI.
  5346. */
  5347. static getDataURL( image, type = 'image/png' ) {
  5348. if ( /^data:/i.test( image.src ) ) {
  5349. return image.src;
  5350. }
  5351. if ( typeof HTMLCanvasElement === 'undefined' ) {
  5352. return image.src;
  5353. }
  5354. let canvas;
  5355. if ( image instanceof HTMLCanvasElement ) {
  5356. canvas = image;
  5357. } else {
  5358. if ( _canvas === undefined ) _canvas = createElementNS( 'canvas' );
  5359. _canvas.width = image.width;
  5360. _canvas.height = image.height;
  5361. const context = _canvas.getContext( '2d' );
  5362. if ( image instanceof ImageData ) {
  5363. context.putImageData( image, 0, 0 );
  5364. } else {
  5365. context.drawImage( image, 0, 0, image.width, image.height );
  5366. }
  5367. canvas = _canvas;
  5368. }
  5369. return canvas.toDataURL( type );
  5370. }
  5371. /**
  5372. * Converts the given sRGB image data to linear color space.
  5373. *
  5374. * @param {(HTMLImageElement|HTMLCanvasElement|ImageBitmap|Object)} image - The image object.
  5375. * @return {HTMLCanvasElement|Object} The converted image.
  5376. */
  5377. static sRGBToLinear( image ) {
  5378. if ( ( typeof HTMLImageElement !== 'undefined' && image instanceof HTMLImageElement ) ||
  5379. ( typeof HTMLCanvasElement !== 'undefined' && image instanceof HTMLCanvasElement ) ||
  5380. ( typeof ImageBitmap !== 'undefined' && image instanceof ImageBitmap ) ) {
  5381. const canvas = createElementNS( 'canvas' );
  5382. canvas.width = image.width;
  5383. canvas.height = image.height;
  5384. const context = canvas.getContext( '2d' );
  5385. context.drawImage( image, 0, 0, image.width, image.height );
  5386. const imageData = context.getImageData( 0, 0, image.width, image.height );
  5387. const data = imageData.data;
  5388. for ( let i = 0; i < data.length; i ++ ) {
  5389. data[ i ] = SRGBToLinear( data[ i ] / 255 ) * 255;
  5390. }
  5391. context.putImageData( imageData, 0, 0 );
  5392. return canvas;
  5393. } else if ( image.data ) {
  5394. const data = image.data.slice( 0 );
  5395. for ( let i = 0; i < data.length; i ++ ) {
  5396. if ( data instanceof Uint8Array || data instanceof Uint8ClampedArray ) {
  5397. data[ i ] = Math.floor( SRGBToLinear( data[ i ] / 255 ) * 255 );
  5398. } else {
  5399. // assuming float
  5400. data[ i ] = SRGBToLinear( data[ i ] );
  5401. }
  5402. }
  5403. return {
  5404. data: data,
  5405. width: image.width,
  5406. height: image.height
  5407. };
  5408. } else {
  5409. warn( 'ImageUtils.sRGBToLinear(): Unsupported image type. No color space conversion applied.' );
  5410. return image;
  5411. }
  5412. }
  5413. }
  5414. let _sourceId = 0;
  5415. /**
  5416. * Represents the data source of a texture.
  5417. *
  5418. * The main purpose of this class is to decouple the data definition from the texture
  5419. * definition so the same data can be used with multiple texture instances.
  5420. */
  5421. class Source {
  5422. /**
  5423. * Constructs a new video texture.
  5424. *
  5425. * @param {any} [data=null] - The data definition of a texture.
  5426. */
  5427. constructor( data = null ) {
  5428. /**
  5429. * This flag can be used for type testing.
  5430. *
  5431. * @type {boolean}
  5432. * @readonly
  5433. * @default true
  5434. */
  5435. this.isSource = true;
  5436. /**
  5437. * The ID of the source.
  5438. *
  5439. * @name Source#id
  5440. * @type {number}
  5441. * @readonly
  5442. */
  5443. Object.defineProperty( this, 'id', { value: _sourceId ++ } );
  5444. /**
  5445. * The UUID of the source.
  5446. *
  5447. * @type {string}
  5448. * @readonly
  5449. */
  5450. this.uuid = generateUUID();
  5451. /**
  5452. * The data definition of a texture.
  5453. *
  5454. * @type {any}
  5455. */
  5456. this.data = data;
  5457. /**
  5458. * This property is only relevant when {@link Source#needsUpdate} is set to `true` and
  5459. * provides more control on how texture data should be processed. When `dataReady` is set
  5460. * to `false`, the engine performs the memory allocation (if necessary) but does not transfer
  5461. * the data into the GPU memory.
  5462. *
  5463. * @type {boolean}
  5464. * @default true
  5465. */
  5466. this.dataReady = true;
  5467. /**
  5468. * This starts at `0` and counts how many times {@link Source#needsUpdate} is set to `true`.
  5469. *
  5470. * @type {number}
  5471. * @readonly
  5472. * @default 0
  5473. */
  5474. this.version = 0;
  5475. }
  5476. /**
  5477. * Returns the dimensions of the source into the given target vector.
  5478. *
  5479. * @param {(Vector2|Vector3)} target - The target object the result is written into.
  5480. * @return {(Vector2|Vector3)} The dimensions of the source.
  5481. */
  5482. getSize( target ) {
  5483. const data = this.data;
  5484. if ( ( typeof HTMLVideoElement !== 'undefined' ) && ( data instanceof HTMLVideoElement ) ) {
  5485. target.set( data.videoWidth, data.videoHeight, 0 );
  5486. } else if ( ( typeof VideoFrame !== 'undefined' ) && ( data instanceof VideoFrame ) ) {
  5487. target.set( data.displayHeight, data.displayWidth, 0 );
  5488. } else if ( data !== null ) {
  5489. target.set( data.width, data.height, data.depth || 0 );
  5490. } else {
  5491. target.set( 0, 0, 0 );
  5492. }
  5493. return target;
  5494. }
  5495. /**
  5496. * When the property is set to `true`, the engine allocates the memory
  5497. * for the texture (if necessary) and triggers the actual texture upload
  5498. * to the GPU next time the source is used.
  5499. *
  5500. * @type {boolean}
  5501. * @default false
  5502. * @param {boolean} value
  5503. */
  5504. set needsUpdate( value ) {
  5505. if ( value === true ) this.version ++;
  5506. }
  5507. /**
  5508. * Serializes the source into JSON.
  5509. *
  5510. * @param {?(Object|string)} meta - An optional value holding meta information about the serialization.
  5511. * @return {Object} A JSON object representing the serialized source.
  5512. * @see {@link ObjectLoader#parse}
  5513. */
  5514. toJSON( meta ) {
  5515. const isRootObject = ( meta === undefined || typeof meta === 'string' );
  5516. if ( ! isRootObject && meta.images[ this.uuid ] !== undefined ) {
  5517. return meta.images[ this.uuid ];
  5518. }
  5519. const output = {
  5520. uuid: this.uuid,
  5521. url: ''
  5522. };
  5523. const data = this.data;
  5524. if ( data !== null ) {
  5525. let url;
  5526. if ( Array.isArray( data ) ) {
  5527. // cube texture
  5528. url = [];
  5529. for ( let i = 0, l = data.length; i < l; i ++ ) {
  5530. if ( data[ i ].isDataTexture ) {
  5531. url.push( serializeImage( data[ i ].image ) );
  5532. } else {
  5533. url.push( serializeImage( data[ i ] ) );
  5534. }
  5535. }
  5536. } else {
  5537. // texture
  5538. url = serializeImage( data );
  5539. }
  5540. output.url = url;
  5541. }
  5542. if ( ! isRootObject ) {
  5543. meta.images[ this.uuid ] = output;
  5544. }
  5545. return output;
  5546. }
  5547. }
  5548. function serializeImage( image ) {
  5549. if ( ( typeof HTMLImageElement !== 'undefined' && image instanceof HTMLImageElement ) ||
  5550. ( typeof HTMLCanvasElement !== 'undefined' && image instanceof HTMLCanvasElement ) ||
  5551. ( typeof ImageBitmap !== 'undefined' && image instanceof ImageBitmap ) ) {
  5552. // default images
  5553. return ImageUtils.getDataURL( image );
  5554. } else {
  5555. if ( image.data ) {
  5556. // images of DataTexture
  5557. return {
  5558. data: Array.from( image.data ),
  5559. width: image.width,
  5560. height: image.height,
  5561. type: image.data.constructor.name
  5562. };
  5563. } else {
  5564. warn( 'Texture: Unable to serialize Texture.' );
  5565. return {};
  5566. }
  5567. }
  5568. }
  5569. let _textureId = 0;
  5570. const _tempVec3 = /*@__PURE__*/ new Vector3();
  5571. /**
  5572. * Base class for all textures.
  5573. *
  5574. * Note: After the initial use of a texture, its dimensions, format, and type
  5575. * cannot be changed. Instead, call {@link Texture#dispose} on the texture and instantiate a new one.
  5576. *
  5577. * @augments EventDispatcher
  5578. */
  5579. class Texture extends EventDispatcher {
  5580. /**
  5581. * Constructs a new texture.
  5582. *
  5583. * @param {?Object} [image=Texture.DEFAULT_IMAGE] - The image holding the texture data.
  5584. * @param {number} [mapping=Texture.DEFAULT_MAPPING] - The texture mapping.
  5585. * @param {number} [wrapS=ClampToEdgeWrapping] - The wrapS value.
  5586. * @param {number} [wrapT=ClampToEdgeWrapping] - The wrapT value.
  5587. * @param {number} [magFilter=LinearFilter] - The mag filter value.
  5588. * @param {number} [minFilter=LinearMipmapLinearFilter] - The min filter value.
  5589. * @param {number} [format=RGBAFormat] - The texture format.
  5590. * @param {number} [type=UnsignedByteType] - The texture type.
  5591. * @param {number} [anisotropy=Texture.DEFAULT_ANISOTROPY] - The anisotropy value.
  5592. * @param {string} [colorSpace=NoColorSpace] - The color space.
  5593. */
  5594. constructor( image = Texture.DEFAULT_IMAGE, mapping = Texture.DEFAULT_MAPPING, wrapS = ClampToEdgeWrapping, wrapT = ClampToEdgeWrapping, magFilter = LinearFilter, minFilter = LinearMipmapLinearFilter, format = RGBAFormat, type = UnsignedByteType, anisotropy = Texture.DEFAULT_ANISOTROPY, colorSpace = NoColorSpace ) {
  5595. super();
  5596. /**
  5597. * This flag can be used for type testing.
  5598. *
  5599. * @type {boolean}
  5600. * @readonly
  5601. * @default true
  5602. */
  5603. this.isTexture = true;
  5604. /**
  5605. * The ID of the texture.
  5606. *
  5607. * @name Texture#id
  5608. * @type {number}
  5609. * @readonly
  5610. */
  5611. Object.defineProperty( this, 'id', { value: _textureId ++ } );
  5612. /**
  5613. * The UUID of the texture.
  5614. *
  5615. * @type {string}
  5616. * @readonly
  5617. */
  5618. this.uuid = generateUUID();
  5619. /**
  5620. * The name of the texture.
  5621. *
  5622. * @type {string}
  5623. */
  5624. this.name = '';
  5625. /**
  5626. * The data definition of a texture. A reference to the data source can be
  5627. * shared across textures. This is often useful in context of spritesheets
  5628. * where multiple textures render the same data but with different texture
  5629. * transformations.
  5630. *
  5631. * @type {Source}
  5632. */
  5633. this.source = new Source( image );
  5634. /**
  5635. * An array holding user-defined mipmaps.
  5636. *
  5637. * @type {Array<Object>}
  5638. */
  5639. this.mipmaps = [];
  5640. /**
  5641. * How the texture is applied to the object. The value `UVMapping`
  5642. * is the default, where texture or uv coordinates are used to apply the map.
  5643. *
  5644. * @type {(UVMapping|CubeReflectionMapping|CubeRefractionMapping|EquirectangularReflectionMapping|EquirectangularRefractionMapping|CubeUVReflectionMapping)}
  5645. * @default UVMapping
  5646. */
  5647. this.mapping = mapping;
  5648. /**
  5649. * Lets you select the uv attribute to map the texture to. `0` for `uv`,
  5650. * `1` for `uv1`, `2` for `uv2` and `3` for `uv3`.
  5651. *
  5652. * @type {number}
  5653. * @default 0
  5654. */
  5655. this.channel = 0;
  5656. /**
  5657. * This defines how the texture is wrapped horizontally and corresponds to
  5658. * *U* in UV mapping.
  5659. *
  5660. * @type {(RepeatWrapping|ClampToEdgeWrapping|MirroredRepeatWrapping)}
  5661. * @default ClampToEdgeWrapping
  5662. */
  5663. this.wrapS = wrapS;
  5664. /**
  5665. * This defines how the texture is wrapped horizontally and corresponds to
  5666. * *V* in UV mapping.
  5667. *
  5668. * @type {(RepeatWrapping|ClampToEdgeWrapping|MirroredRepeatWrapping)}
  5669. * @default ClampToEdgeWrapping
  5670. */
  5671. this.wrapT = wrapT;
  5672. /**
  5673. * How the texture is sampled when a texel covers more than one pixel.
  5674. *
  5675. * @type {(NearestFilter|NearestMipmapNearestFilter|NearestMipmapLinearFilter|LinearFilter|LinearMipmapNearestFilter|LinearMipmapLinearFilter)}
  5676. * @default LinearFilter
  5677. */
  5678. this.magFilter = magFilter;
  5679. /**
  5680. * How the texture is sampled when a texel covers less than one pixel.
  5681. *
  5682. * @type {(NearestFilter|NearestMipmapNearestFilter|NearestMipmapLinearFilter|LinearFilter|LinearMipmapNearestFilter|LinearMipmapLinearFilter)}
  5683. * @default LinearMipmapLinearFilter
  5684. */
  5685. this.minFilter = minFilter;
  5686. /**
  5687. * The number of samples taken along the axis through the pixel that has the
  5688. * highest density of texels. By default, this value is `1`. A higher value
  5689. * gives a less blurry result than a basic mipmap, at the cost of more
  5690. * texture samples being used.
  5691. *
  5692. * @type {number}
  5693. * @default Texture.DEFAULT_ANISOTROPY
  5694. */
  5695. this.anisotropy = anisotropy;
  5696. /**
  5697. * The format of the texture.
  5698. *
  5699. * @type {number}
  5700. * @default RGBAFormat
  5701. */
  5702. this.format = format;
  5703. /**
  5704. * The default internal format is derived from {@link Texture#format} and {@link Texture#type} and
  5705. * defines how the texture data is going to be stored on the GPU.
  5706. *
  5707. * This property allows to overwrite the default format.
  5708. *
  5709. * @type {?string}
  5710. * @default null
  5711. */
  5712. this.internalFormat = null;
  5713. /**
  5714. * The data type of the texture.
  5715. *
  5716. * @type {number}
  5717. * @default UnsignedByteType
  5718. */
  5719. this.type = type;
  5720. /**
  5721. * How much a single repetition of the texture is offset from the beginning,
  5722. * in each direction U and V. Typical range is `0.0` to `1.0`.
  5723. *
  5724. * @type {Vector2}
  5725. * @default (0,0)
  5726. */
  5727. this.offset = new Vector2( 0, 0 );
  5728. /**
  5729. * How many times the texture is repeated across the surface, in each
  5730. * direction U and V. If repeat is set greater than `1` in either direction,
  5731. * the corresponding wrap parameter should also be set to `RepeatWrapping`
  5732. * or `MirroredRepeatWrapping` to achieve the desired tiling effect.
  5733. *
  5734. * @type {Vector2}
  5735. * @default (1,1)
  5736. */
  5737. this.repeat = new Vector2( 1, 1 );
  5738. /**
  5739. * The point around which rotation occurs. A value of `(0.5, 0.5)` corresponds
  5740. * to the center of the texture. Default is `(0, 0)`, the lower left.
  5741. *
  5742. * @type {Vector2}
  5743. * @default (0,0)
  5744. */
  5745. this.center = new Vector2( 0, 0 );
  5746. /**
  5747. * How much the texture is rotated around the center point, in radians.
  5748. * Positive values are counter-clockwise.
  5749. *
  5750. * @type {number}
  5751. * @default 0
  5752. */
  5753. this.rotation = 0;
  5754. /**
  5755. * Whether to update the texture's uv-transformation {@link Texture#matrix}
  5756. * from the properties {@link Texture#offset}, {@link Texture#repeat},
  5757. * {@link Texture#rotation}, and {@link Texture#center}.
  5758. *
  5759. * Set this to `false` if you are specifying the uv-transform matrix directly.
  5760. *
  5761. * @type {boolean}
  5762. * @default true
  5763. */
  5764. this.matrixAutoUpdate = true;
  5765. /**
  5766. * The uv-transformation matrix of the texture.
  5767. *
  5768. * @type {Matrix3}
  5769. */
  5770. this.matrix = new Matrix3();
  5771. /**
  5772. * Whether to generate mipmaps (if possible) for a texture.
  5773. *
  5774. * Set this to `false` if you are creating mipmaps manually.
  5775. *
  5776. * @type {boolean}
  5777. * @default true
  5778. */
  5779. this.generateMipmaps = true;
  5780. /**
  5781. * If set to `true`, the alpha channel, if present, is multiplied into the
  5782. * color channels when the texture is uploaded to the GPU.
  5783. *
  5784. * Note that this property has no effect when using `ImageBitmap`. You need to
  5785. * configure premultiply alpha on bitmap creation instead.
  5786. *
  5787. * @type {boolean}
  5788. * @default false
  5789. */
  5790. this.premultiplyAlpha = false;
  5791. /**
  5792. * If set to `true`, the texture is flipped along the vertical axis when
  5793. * uploaded to the GPU.
  5794. *
  5795. * Note that this property has no effect when using `ImageBitmap`. You need to
  5796. * configure the flip on bitmap creation instead.
  5797. *
  5798. * @type {boolean}
  5799. * @default true
  5800. */
  5801. this.flipY = true;
  5802. /**
  5803. * Specifies the alignment requirements for the start of each pixel row in memory.
  5804. * The allowable values are `1` (byte-alignment), `2` (rows aligned to even-numbered bytes),
  5805. * `4` (word-alignment), and `8` (rows start on double-word boundaries).
  5806. *
  5807. * @type {number}
  5808. * @default 4
  5809. */
  5810. this.unpackAlignment = 4; // valid values: 1, 2, 4, 8 (see http://www.khronos.org/opengles/sdk/docs/man/xhtml/glPixelStorei.xml)
  5811. /**
  5812. * Textures containing color data should be annotated with `SRGBColorSpace` or `LinearSRGBColorSpace`.
  5813. *
  5814. * @type {string}
  5815. * @default NoColorSpace
  5816. */
  5817. this.colorSpace = colorSpace;
  5818. /**
  5819. * An object that can be used to store custom data about the texture. It
  5820. * should not hold references to functions as these will not be cloned.
  5821. *
  5822. * @type {Object}
  5823. */
  5824. this.userData = {};
  5825. /**
  5826. * This can be used to only update a subregion or specific rows of the texture (for example, just the
  5827. * first 3 rows). Use the `addUpdateRange()` function to add ranges to this array.
  5828. *
  5829. * @type {Array<Object>}
  5830. */
  5831. this.updateRanges = [];
  5832. /**
  5833. * This starts at `0` and counts how many times {@link Texture#needsUpdate} is set to `true`.
  5834. *
  5835. * @type {number}
  5836. * @readonly
  5837. * @default 0
  5838. */
  5839. this.version = 0;
  5840. /**
  5841. * A callback function, called when the texture is updated (e.g., when
  5842. * {@link Texture#needsUpdate} has been set to true and then the texture is used).
  5843. *
  5844. * @type {?Function}
  5845. * @default null
  5846. */
  5847. this.onUpdate = null;
  5848. /**
  5849. * An optional back reference to the textures render target.
  5850. *
  5851. * @type {?(RenderTarget|WebGLRenderTarget)}
  5852. * @default null
  5853. */
  5854. this.renderTarget = null;
  5855. /**
  5856. * Indicates whether a texture belongs to a render target or not.
  5857. *
  5858. * @type {boolean}
  5859. * @readonly
  5860. * @default false
  5861. */
  5862. this.isRenderTargetTexture = false;
  5863. /**
  5864. * Indicates if a texture should be handled like a texture array.
  5865. *
  5866. * @type {boolean}
  5867. * @readonly
  5868. * @default false
  5869. */
  5870. this.isArrayTexture = image && image.depth && image.depth > 1 ? true : false;
  5871. /**
  5872. * Indicates whether this texture should be processed by `PMREMGenerator` or not
  5873. * (only relevant for render target textures).
  5874. *
  5875. * @type {number}
  5876. * @readonly
  5877. * @default 0
  5878. */
  5879. this.pmremVersion = 0;
  5880. }
  5881. /**
  5882. * The width of the texture in pixels.
  5883. */
  5884. get width() {
  5885. return this.source.getSize( _tempVec3 ).x;
  5886. }
  5887. /**
  5888. * The height of the texture in pixels.
  5889. */
  5890. get height() {
  5891. return this.source.getSize( _tempVec3 ).y;
  5892. }
  5893. /**
  5894. * The depth of the texture in pixels.
  5895. */
  5896. get depth() {
  5897. return this.source.getSize( _tempVec3 ).z;
  5898. }
  5899. /**
  5900. * The image object holding the texture data.
  5901. *
  5902. * @type {?Object}
  5903. */
  5904. get image() {
  5905. return this.source.data;
  5906. }
  5907. set image( value = null ) {
  5908. this.source.data = value;
  5909. }
  5910. /**
  5911. * Updates the texture transformation matrix from the from the properties {@link Texture#offset},
  5912. * {@link Texture#repeat}, {@link Texture#rotation}, and {@link Texture#center}.
  5913. */
  5914. updateMatrix() {
  5915. this.matrix.setUvTransform( this.offset.x, this.offset.y, this.repeat.x, this.repeat.y, this.rotation, this.center.x, this.center.y );
  5916. }
  5917. /**
  5918. * Adds a range of data in the data texture to be updated on the GPU.
  5919. *
  5920. * @param {number} start - Position at which to start update.
  5921. * @param {number} count - The number of components to update.
  5922. */
  5923. addUpdateRange( start, count ) {
  5924. this.updateRanges.push( { start, count } );
  5925. }
  5926. /**
  5927. * Clears the update ranges.
  5928. */
  5929. clearUpdateRanges() {
  5930. this.updateRanges.length = 0;
  5931. }
  5932. /**
  5933. * Returns a new texture with copied values from this instance.
  5934. *
  5935. * @return {Texture} A clone of this instance.
  5936. */
  5937. clone() {
  5938. return new this.constructor().copy( this );
  5939. }
  5940. /**
  5941. * Copies the values of the given texture to this instance.
  5942. *
  5943. * @param {Texture} source - The texture to copy.
  5944. * @return {Texture} A reference to this instance.
  5945. */
  5946. copy( source ) {
  5947. this.name = source.name;
  5948. this.source = source.source;
  5949. this.mipmaps = source.mipmaps.slice( 0 );
  5950. this.mapping = source.mapping;
  5951. this.channel = source.channel;
  5952. this.wrapS = source.wrapS;
  5953. this.wrapT = source.wrapT;
  5954. this.magFilter = source.magFilter;
  5955. this.minFilter = source.minFilter;
  5956. this.anisotropy = source.anisotropy;
  5957. this.format = source.format;
  5958. this.internalFormat = source.internalFormat;
  5959. this.type = source.type;
  5960. this.offset.copy( source.offset );
  5961. this.repeat.copy( source.repeat );
  5962. this.center.copy( source.center );
  5963. this.rotation = source.rotation;
  5964. this.matrixAutoUpdate = source.matrixAutoUpdate;
  5965. this.matrix.copy( source.matrix );
  5966. this.generateMipmaps = source.generateMipmaps;
  5967. this.premultiplyAlpha = source.premultiplyAlpha;
  5968. this.flipY = source.flipY;
  5969. this.unpackAlignment = source.unpackAlignment;
  5970. this.colorSpace = source.colorSpace;
  5971. this.renderTarget = source.renderTarget;
  5972. this.isRenderTargetTexture = source.isRenderTargetTexture;
  5973. this.isArrayTexture = source.isArrayTexture;
  5974. this.userData = JSON.parse( JSON.stringify( source.userData ) );
  5975. this.needsUpdate = true;
  5976. return this;
  5977. }
  5978. /**
  5979. * Sets this texture's properties based on `values`.
  5980. * @param {Object} values - A container with texture parameters.
  5981. */
  5982. setValues( values ) {
  5983. for ( const key in values ) {
  5984. const newValue = values[ key ];
  5985. if ( newValue === undefined ) {
  5986. warn( `Texture.setValues(): parameter '${ key }' has value of undefined.` );
  5987. continue;
  5988. }
  5989. const currentValue = this[ key ];
  5990. if ( currentValue === undefined ) {
  5991. warn( `Texture.setValues(): property '${ key }' does not exist.` );
  5992. continue;
  5993. }
  5994. if ( ( currentValue && newValue ) && ( currentValue.isVector2 && newValue.isVector2 ) ) {
  5995. currentValue.copy( newValue );
  5996. } else if ( ( currentValue && newValue ) && ( currentValue.isVector3 && newValue.isVector3 ) ) {
  5997. currentValue.copy( newValue );
  5998. } else if ( ( currentValue && newValue ) && ( currentValue.isMatrix3 && newValue.isMatrix3 ) ) {
  5999. currentValue.copy( newValue );
  6000. } else {
  6001. this[ key ] = newValue;
  6002. }
  6003. }
  6004. }
  6005. /**
  6006. * Serializes the texture into JSON.
  6007. *
  6008. * @param {?(Object|string)} meta - An optional value holding meta information about the serialization.
  6009. * @return {Object} A JSON object representing the serialized texture.
  6010. * @see {@link ObjectLoader#parse}
  6011. */
  6012. toJSON( meta ) {
  6013. const isRootObject = ( meta === undefined || typeof meta === 'string' );
  6014. if ( ! isRootObject && meta.textures[ this.uuid ] !== undefined ) {
  6015. return meta.textures[ this.uuid ];
  6016. }
  6017. const output = {
  6018. metadata: {
  6019. version: 4.7,
  6020. type: 'Texture',
  6021. generator: 'Texture.toJSON'
  6022. },
  6023. uuid: this.uuid,
  6024. name: this.name,
  6025. image: this.source.toJSON( meta ).uuid,
  6026. mapping: this.mapping,
  6027. channel: this.channel,
  6028. repeat: [ this.repeat.x, this.repeat.y ],
  6029. offset: [ this.offset.x, this.offset.y ],
  6030. center: [ this.center.x, this.center.y ],
  6031. rotation: this.rotation,
  6032. wrap: [ this.wrapS, this.wrapT ],
  6033. format: this.format,
  6034. internalFormat: this.internalFormat,
  6035. type: this.type,
  6036. colorSpace: this.colorSpace,
  6037. minFilter: this.minFilter,
  6038. magFilter: this.magFilter,
  6039. anisotropy: this.anisotropy,
  6040. flipY: this.flipY,
  6041. generateMipmaps: this.generateMipmaps,
  6042. premultiplyAlpha: this.premultiplyAlpha,
  6043. unpackAlignment: this.unpackAlignment
  6044. };
  6045. if ( Object.keys( this.userData ).length > 0 ) output.userData = this.userData;
  6046. if ( ! isRootObject ) {
  6047. meta.textures[ this.uuid ] = output;
  6048. }
  6049. return output;
  6050. }
  6051. /**
  6052. * Frees the GPU-related resources allocated by this instance. Call this
  6053. * method whenever this instance is no longer used in your app.
  6054. *
  6055. * @fires Texture#dispose
  6056. */
  6057. dispose() {
  6058. /**
  6059. * Fires when the texture has been disposed of.
  6060. *
  6061. * @event Texture#dispose
  6062. * @type {Object}
  6063. */
  6064. this.dispatchEvent( { type: 'dispose' } );
  6065. }
  6066. /**
  6067. * Transforms the given uv vector with the textures uv transformation matrix.
  6068. *
  6069. * @param {Vector2} uv - The uv vector.
  6070. * @return {Vector2} The transformed uv vector.
  6071. */
  6072. transformUv( uv ) {
  6073. if ( this.mapping !== UVMapping ) return uv;
  6074. uv.applyMatrix3( this.matrix );
  6075. if ( uv.x < 0 || uv.x > 1 ) {
  6076. switch ( this.wrapS ) {
  6077. case RepeatWrapping:
  6078. uv.x = uv.x - Math.floor( uv.x );
  6079. break;
  6080. case ClampToEdgeWrapping:
  6081. uv.x = uv.x < 0 ? 0 : 1;
  6082. break;
  6083. case MirroredRepeatWrapping:
  6084. if ( Math.abs( Math.floor( uv.x ) % 2 ) === 1 ) {
  6085. uv.x = Math.ceil( uv.x ) - uv.x;
  6086. } else {
  6087. uv.x = uv.x - Math.floor( uv.x );
  6088. }
  6089. break;
  6090. }
  6091. }
  6092. if ( uv.y < 0 || uv.y > 1 ) {
  6093. switch ( this.wrapT ) {
  6094. case RepeatWrapping:
  6095. uv.y = uv.y - Math.floor( uv.y );
  6096. break;
  6097. case ClampToEdgeWrapping:
  6098. uv.y = uv.y < 0 ? 0 : 1;
  6099. break;
  6100. case MirroredRepeatWrapping:
  6101. if ( Math.abs( Math.floor( uv.y ) % 2 ) === 1 ) {
  6102. uv.y = Math.ceil( uv.y ) - uv.y;
  6103. } else {
  6104. uv.y = uv.y - Math.floor( uv.y );
  6105. }
  6106. break;
  6107. }
  6108. }
  6109. if ( this.flipY ) {
  6110. uv.y = 1 - uv.y;
  6111. }
  6112. return uv;
  6113. }
  6114. /**
  6115. * Setting this property to `true` indicates the engine the texture
  6116. * must be updated in the next render. This triggers a texture upload
  6117. * to the GPU and ensures correct texture parameter configuration.
  6118. *
  6119. * @type {boolean}
  6120. * @default false
  6121. * @param {boolean} value
  6122. */
  6123. set needsUpdate( value ) {
  6124. if ( value === true ) {
  6125. this.version ++;
  6126. this.source.needsUpdate = true;
  6127. }
  6128. }
  6129. /**
  6130. * Setting this property to `true` indicates the engine the PMREM
  6131. * must be regenerated.
  6132. *
  6133. * @type {boolean}
  6134. * @default false
  6135. * @param {boolean} value
  6136. */
  6137. set needsPMREMUpdate( value ) {
  6138. if ( value === true ) {
  6139. this.pmremVersion ++;
  6140. }
  6141. }
  6142. }
  6143. /**
  6144. * The default image for all textures.
  6145. *
  6146. * @static
  6147. * @type {?Image}
  6148. * @default null
  6149. */
  6150. Texture.DEFAULT_IMAGE = null;
  6151. /**
  6152. * The default mapping for all textures.
  6153. *
  6154. * @static
  6155. * @type {number}
  6156. * @default UVMapping
  6157. */
  6158. Texture.DEFAULT_MAPPING = UVMapping;
  6159. /**
  6160. * The default anisotropy value for all textures.
  6161. *
  6162. * @static
  6163. * @type {number}
  6164. * @default 1
  6165. */
  6166. Texture.DEFAULT_ANISOTROPY = 1;
  6167. /**
  6168. * Class representing a 4D vector. A 4D vector is an ordered quadruplet of numbers
  6169. * (labeled x, y, z and w), which can be used to represent a number of things, such as:
  6170. *
  6171. * - A point in 4D space.
  6172. * - A direction and length in 4D space. In three.js the length will
  6173. * always be the Euclidean distance(straight-line distance) from `(0, 0, 0, 0)` to `(x, y, z, w)`
  6174. * and the direction is also measured from `(0, 0, 0, 0)` towards `(x, y, z, w)`.
  6175. * - Any arbitrary ordered quadruplet of numbers.
  6176. *
  6177. * There are other things a 4D vector can be used to represent, however these
  6178. * are the most common uses in *three.js*.
  6179. *
  6180. * Iterating through a vector instance will yield its components `(x, y, z, w)` in
  6181. * the corresponding order.
  6182. * ```js
  6183. * const a = new THREE.Vector4( 0, 1, 0, 0 );
  6184. *
  6185. * //no arguments; will be initialised to (0, 0, 0, 1)
  6186. * const b = new THREE.Vector4( );
  6187. *
  6188. * const d = a.dot( b );
  6189. * ```
  6190. */
  6191. class Vector4 {
  6192. /**
  6193. * Constructs a new 4D vector.
  6194. *
  6195. * @param {number} [x=0] - The x value of this vector.
  6196. * @param {number} [y=0] - The y value of this vector.
  6197. * @param {number} [z=0] - The z value of this vector.
  6198. * @param {number} [w=1] - The w value of this vector.
  6199. */
  6200. constructor( x = 0, y = 0, z = 0, w = 1 ) {
  6201. /**
  6202. * This flag can be used for type testing.
  6203. *
  6204. * @type {boolean}
  6205. * @readonly
  6206. * @default true
  6207. */
  6208. Vector4.prototype.isVector4 = true;
  6209. /**
  6210. * The x value of this vector.
  6211. *
  6212. * @type {number}
  6213. */
  6214. this.x = x;
  6215. /**
  6216. * The y value of this vector.
  6217. *
  6218. * @type {number}
  6219. */
  6220. this.y = y;
  6221. /**
  6222. * The z value of this vector.
  6223. *
  6224. * @type {number}
  6225. */
  6226. this.z = z;
  6227. /**
  6228. * The w value of this vector.
  6229. *
  6230. * @type {number}
  6231. */
  6232. this.w = w;
  6233. }
  6234. /**
  6235. * Alias for {@link Vector4#z}.
  6236. *
  6237. * @type {number}
  6238. */
  6239. get width() {
  6240. return this.z;
  6241. }
  6242. set width( value ) {
  6243. this.z = value;
  6244. }
  6245. /**
  6246. * Alias for {@link Vector4#w}.
  6247. *
  6248. * @type {number}
  6249. */
  6250. get height() {
  6251. return this.w;
  6252. }
  6253. set height( value ) {
  6254. this.w = value;
  6255. }
  6256. /**
  6257. * Sets the vector components.
  6258. *
  6259. * @param {number} x - The value of the x component.
  6260. * @param {number} y - The value of the y component.
  6261. * @param {number} z - The value of the z component.
  6262. * @param {number} w - The value of the w component.
  6263. * @return {Vector4} A reference to this vector.
  6264. */
  6265. set( x, y, z, w ) {
  6266. this.x = x;
  6267. this.y = y;
  6268. this.z = z;
  6269. this.w = w;
  6270. return this;
  6271. }
  6272. /**
  6273. * Sets the vector components to the same value.
  6274. *
  6275. * @param {number} scalar - The value to set for all vector components.
  6276. * @return {Vector4} A reference to this vector.
  6277. */
  6278. setScalar( scalar ) {
  6279. this.x = scalar;
  6280. this.y = scalar;
  6281. this.z = scalar;
  6282. this.w = scalar;
  6283. return this;
  6284. }
  6285. /**
  6286. * Sets the vector's x component to the given value
  6287. *
  6288. * @param {number} x - The value to set.
  6289. * @return {Vector4} A reference to this vector.
  6290. */
  6291. setX( x ) {
  6292. this.x = x;
  6293. return this;
  6294. }
  6295. /**
  6296. * Sets the vector's y component to the given value
  6297. *
  6298. * @param {number} y - The value to set.
  6299. * @return {Vector4} A reference to this vector.
  6300. */
  6301. setY( y ) {
  6302. this.y = y;
  6303. return this;
  6304. }
  6305. /**
  6306. * Sets the vector's z component to the given value
  6307. *
  6308. * @param {number} z - The value to set.
  6309. * @return {Vector4} A reference to this vector.
  6310. */
  6311. setZ( z ) {
  6312. this.z = z;
  6313. return this;
  6314. }
  6315. /**
  6316. * Sets the vector's w component to the given value
  6317. *
  6318. * @param {number} w - The value to set.
  6319. * @return {Vector4} A reference to this vector.
  6320. */
  6321. setW( w ) {
  6322. this.w = w;
  6323. return this;
  6324. }
  6325. /**
  6326. * Allows to set a vector component with an index.
  6327. *
  6328. * @param {number} index - The component index. `0` equals to x, `1` equals to y,
  6329. * `2` equals to z, `3` equals to w.
  6330. * @param {number} value - The value to set.
  6331. * @return {Vector4} A reference to this vector.
  6332. */
  6333. setComponent( index, value ) {
  6334. switch ( index ) {
  6335. case 0: this.x = value; break;
  6336. case 1: this.y = value; break;
  6337. case 2: this.z = value; break;
  6338. case 3: this.w = value; break;
  6339. default: throw new Error( 'index is out of range: ' + index );
  6340. }
  6341. return this;
  6342. }
  6343. /**
  6344. * Returns the value of the vector component which matches the given index.
  6345. *
  6346. * @param {number} index - The component index. `0` equals to x, `1` equals to y,
  6347. * `2` equals to z, `3` equals to w.
  6348. * @return {number} A vector component value.
  6349. */
  6350. getComponent( index ) {
  6351. switch ( index ) {
  6352. case 0: return this.x;
  6353. case 1: return this.y;
  6354. case 2: return this.z;
  6355. case 3: return this.w;
  6356. default: throw new Error( 'index is out of range: ' + index );
  6357. }
  6358. }
  6359. /**
  6360. * Returns a new vector with copied values from this instance.
  6361. *
  6362. * @return {Vector4} A clone of this instance.
  6363. */
  6364. clone() {
  6365. return new this.constructor( this.x, this.y, this.z, this.w );
  6366. }
  6367. /**
  6368. * Copies the values of the given vector to this instance.
  6369. *
  6370. * @param {Vector3|Vector4} v - The vector to copy.
  6371. * @return {Vector4} A reference to this vector.
  6372. */
  6373. copy( v ) {
  6374. this.x = v.x;
  6375. this.y = v.y;
  6376. this.z = v.z;
  6377. this.w = ( v.w !== undefined ) ? v.w : 1;
  6378. return this;
  6379. }
  6380. /**
  6381. * Adds the given vector to this instance.
  6382. *
  6383. * @param {Vector4} v - The vector to add.
  6384. * @return {Vector4} A reference to this vector.
  6385. */
  6386. add( v ) {
  6387. this.x += v.x;
  6388. this.y += v.y;
  6389. this.z += v.z;
  6390. this.w += v.w;
  6391. return this;
  6392. }
  6393. /**
  6394. * Adds the given scalar value to all components of this instance.
  6395. *
  6396. * @param {number} s - The scalar to add.
  6397. * @return {Vector4} A reference to this vector.
  6398. */
  6399. addScalar( s ) {
  6400. this.x += s;
  6401. this.y += s;
  6402. this.z += s;
  6403. this.w += s;
  6404. return this;
  6405. }
  6406. /**
  6407. * Adds the given vectors and stores the result in this instance.
  6408. *
  6409. * @param {Vector4} a - The first vector.
  6410. * @param {Vector4} b - The second vector.
  6411. * @return {Vector4} A reference to this vector.
  6412. */
  6413. addVectors( a, b ) {
  6414. this.x = a.x + b.x;
  6415. this.y = a.y + b.y;
  6416. this.z = a.z + b.z;
  6417. this.w = a.w + b.w;
  6418. return this;
  6419. }
  6420. /**
  6421. * Adds the given vector scaled by the given factor to this instance.
  6422. *
  6423. * @param {Vector4} v - The vector.
  6424. * @param {number} s - The factor that scales `v`.
  6425. * @return {Vector4} A reference to this vector.
  6426. */
  6427. addScaledVector( v, s ) {
  6428. this.x += v.x * s;
  6429. this.y += v.y * s;
  6430. this.z += v.z * s;
  6431. this.w += v.w * s;
  6432. return this;
  6433. }
  6434. /**
  6435. * Subtracts the given vector from this instance.
  6436. *
  6437. * @param {Vector4} v - The vector to subtract.
  6438. * @return {Vector4} A reference to this vector.
  6439. */
  6440. sub( v ) {
  6441. this.x -= v.x;
  6442. this.y -= v.y;
  6443. this.z -= v.z;
  6444. this.w -= v.w;
  6445. return this;
  6446. }
  6447. /**
  6448. * Subtracts the given scalar value from all components of this instance.
  6449. *
  6450. * @param {number} s - The scalar to subtract.
  6451. * @return {Vector4} A reference to this vector.
  6452. */
  6453. subScalar( s ) {
  6454. this.x -= s;
  6455. this.y -= s;
  6456. this.z -= s;
  6457. this.w -= s;
  6458. return this;
  6459. }
  6460. /**
  6461. * Subtracts the given vectors and stores the result in this instance.
  6462. *
  6463. * @param {Vector4} a - The first vector.
  6464. * @param {Vector4} b - The second vector.
  6465. * @return {Vector4} A reference to this vector.
  6466. */
  6467. subVectors( a, b ) {
  6468. this.x = a.x - b.x;
  6469. this.y = a.y - b.y;
  6470. this.z = a.z - b.z;
  6471. this.w = a.w - b.w;
  6472. return this;
  6473. }
  6474. /**
  6475. * Multiplies the given vector with this instance.
  6476. *
  6477. * @param {Vector4} v - The vector to multiply.
  6478. * @return {Vector4} A reference to this vector.
  6479. */
  6480. multiply( v ) {
  6481. this.x *= v.x;
  6482. this.y *= v.y;
  6483. this.z *= v.z;
  6484. this.w *= v.w;
  6485. return this;
  6486. }
  6487. /**
  6488. * Multiplies the given scalar value with all components of this instance.
  6489. *
  6490. * @param {number} scalar - The scalar to multiply.
  6491. * @return {Vector4} A reference to this vector.
  6492. */
  6493. multiplyScalar( scalar ) {
  6494. this.x *= scalar;
  6495. this.y *= scalar;
  6496. this.z *= scalar;
  6497. this.w *= scalar;
  6498. return this;
  6499. }
  6500. /**
  6501. * Multiplies this vector with the given 4x4 matrix.
  6502. *
  6503. * @param {Matrix4} m - The 4x4 matrix.
  6504. * @return {Vector4} A reference to this vector.
  6505. */
  6506. applyMatrix4( m ) {
  6507. const x = this.x, y = this.y, z = this.z, w = this.w;
  6508. const e = m.elements;
  6509. this.x = e[ 0 ] * x + e[ 4 ] * y + e[ 8 ] * z + e[ 12 ] * w;
  6510. this.y = e[ 1 ] * x + e[ 5 ] * y + e[ 9 ] * z + e[ 13 ] * w;
  6511. this.z = e[ 2 ] * x + e[ 6 ] * y + e[ 10 ] * z + e[ 14 ] * w;
  6512. this.w = e[ 3 ] * x + e[ 7 ] * y + e[ 11 ] * z + e[ 15 ] * w;
  6513. return this;
  6514. }
  6515. /**
  6516. * Divides this instance by the given vector.
  6517. *
  6518. * @param {Vector4} v - The vector to divide.
  6519. * @return {Vector4} A reference to this vector.
  6520. */
  6521. divide( v ) {
  6522. this.x /= v.x;
  6523. this.y /= v.y;
  6524. this.z /= v.z;
  6525. this.w /= v.w;
  6526. return this;
  6527. }
  6528. /**
  6529. * Divides this vector by the given scalar.
  6530. *
  6531. * @param {number} scalar - The scalar to divide.
  6532. * @return {Vector4} A reference to this vector.
  6533. */
  6534. divideScalar( scalar ) {
  6535. return this.multiplyScalar( 1 / scalar );
  6536. }
  6537. /**
  6538. * Sets the x, y and z components of this
  6539. * vector to the quaternion's axis and w to the angle.
  6540. *
  6541. * @param {Quaternion} q - The Quaternion to set.
  6542. * @return {Vector4} A reference to this vector.
  6543. */
  6544. setAxisAngleFromQuaternion( q ) {
  6545. // http://www.euclideanspace.com/maths/geometry/rotations/conversions/quaternionToAngle/index.htm
  6546. // q is assumed to be normalized
  6547. this.w = 2 * Math.acos( q.w );
  6548. const s = Math.sqrt( 1 - q.w * q.w );
  6549. if ( s < 0.0001 ) {
  6550. this.x = 1;
  6551. this.y = 0;
  6552. this.z = 0;
  6553. } else {
  6554. this.x = q.x / s;
  6555. this.y = q.y / s;
  6556. this.z = q.z / s;
  6557. }
  6558. return this;
  6559. }
  6560. /**
  6561. * Sets the x, y and z components of this
  6562. * vector to the axis of rotation and w to the angle.
  6563. *
  6564. * @param {Matrix4} m - A 4x4 matrix of which the upper left 3x3 matrix is a pure rotation matrix.
  6565. * @return {Vector4} A reference to this vector.
  6566. */
  6567. setAxisAngleFromRotationMatrix( m ) {
  6568. // http://www.euclideanspace.com/maths/geometry/rotations/conversions/matrixToAngle/index.htm
  6569. // assumes the upper 3x3 of m is a pure rotation matrix (i.e, unscaled)
  6570. let angle, x, y, z; // variables for result
  6571. const epsilon = 0.01, // margin to allow for rounding errors
  6572. epsilon2 = 0.1, // margin to distinguish between 0 and 180 degrees
  6573. te = m.elements,
  6574. m11 = te[ 0 ], m12 = te[ 4 ], m13 = te[ 8 ],
  6575. m21 = te[ 1 ], m22 = te[ 5 ], m23 = te[ 9 ],
  6576. m31 = te[ 2 ], m32 = te[ 6 ], m33 = te[ 10 ];
  6577. if ( ( Math.abs( m12 - m21 ) < epsilon ) &&
  6578. ( Math.abs( m13 - m31 ) < epsilon ) &&
  6579. ( Math.abs( m23 - m32 ) < epsilon ) ) {
  6580. // singularity found
  6581. // first check for identity matrix which must have +1 for all terms
  6582. // in leading diagonal and zero in other terms
  6583. if ( ( Math.abs( m12 + m21 ) < epsilon2 ) &&
  6584. ( Math.abs( m13 + m31 ) < epsilon2 ) &&
  6585. ( Math.abs( m23 + m32 ) < epsilon2 ) &&
  6586. ( Math.abs( m11 + m22 + m33 - 3 ) < epsilon2 ) ) {
  6587. // this singularity is identity matrix so angle = 0
  6588. this.set( 1, 0, 0, 0 );
  6589. return this; // zero angle, arbitrary axis
  6590. }
  6591. // otherwise this singularity is angle = 180
  6592. angle = Math.PI;
  6593. const xx = ( m11 + 1 ) / 2;
  6594. const yy = ( m22 + 1 ) / 2;
  6595. const zz = ( m33 + 1 ) / 2;
  6596. const xy = ( m12 + m21 ) / 4;
  6597. const xz = ( m13 + m31 ) / 4;
  6598. const yz = ( m23 + m32 ) / 4;
  6599. if ( ( xx > yy ) && ( xx > zz ) ) {
  6600. // m11 is the largest diagonal term
  6601. if ( xx < epsilon ) {
  6602. x = 0;
  6603. y = 0.707106781;
  6604. z = 0.707106781;
  6605. } else {
  6606. x = Math.sqrt( xx );
  6607. y = xy / x;
  6608. z = xz / x;
  6609. }
  6610. } else if ( yy > zz ) {
  6611. // m22 is the largest diagonal term
  6612. if ( yy < epsilon ) {
  6613. x = 0.707106781;
  6614. y = 0;
  6615. z = 0.707106781;
  6616. } else {
  6617. y = Math.sqrt( yy );
  6618. x = xy / y;
  6619. z = yz / y;
  6620. }
  6621. } else {
  6622. // m33 is the largest diagonal term so base result on this
  6623. if ( zz < epsilon ) {
  6624. x = 0.707106781;
  6625. y = 0.707106781;
  6626. z = 0;
  6627. } else {
  6628. z = Math.sqrt( zz );
  6629. x = xz / z;
  6630. y = yz / z;
  6631. }
  6632. }
  6633. this.set( x, y, z, angle );
  6634. return this; // return 180 deg rotation
  6635. }
  6636. // as we have reached here there are no singularities so we can handle normally
  6637. let s = Math.sqrt( ( m32 - m23 ) * ( m32 - m23 ) +
  6638. ( m13 - m31 ) * ( m13 - m31 ) +
  6639. ( m21 - m12 ) * ( m21 - m12 ) ); // used to normalize
  6640. if ( Math.abs( s ) < 0.001 ) s = 1;
  6641. // prevent divide by zero, should not happen if matrix is orthogonal and should be
  6642. // caught by singularity test above, but I've left it in just in case
  6643. this.x = ( m32 - m23 ) / s;
  6644. this.y = ( m13 - m31 ) / s;
  6645. this.z = ( m21 - m12 ) / s;
  6646. this.w = Math.acos( ( m11 + m22 + m33 - 1 ) / 2 );
  6647. return this;
  6648. }
  6649. /**
  6650. * Sets the vector components to the position elements of the
  6651. * given transformation matrix.
  6652. *
  6653. * @param {Matrix4} m - The 4x4 matrix.
  6654. * @return {Vector4} A reference to this vector.
  6655. */
  6656. setFromMatrixPosition( m ) {
  6657. const e = m.elements;
  6658. this.x = e[ 12 ];
  6659. this.y = e[ 13 ];
  6660. this.z = e[ 14 ];
  6661. this.w = e[ 15 ];
  6662. return this;
  6663. }
  6664. /**
  6665. * If this vector's x, y, z or w value is greater than the given vector's x, y, z or w
  6666. * value, replace that value with the corresponding min value.
  6667. *
  6668. * @param {Vector4} v - The vector.
  6669. * @return {Vector4} A reference to this vector.
  6670. */
  6671. min( v ) {
  6672. this.x = Math.min( this.x, v.x );
  6673. this.y = Math.min( this.y, v.y );
  6674. this.z = Math.min( this.z, v.z );
  6675. this.w = Math.min( this.w, v.w );
  6676. return this;
  6677. }
  6678. /**
  6679. * If this vector's x, y, z or w value is less than the given vector's x, y, z or w
  6680. * value, replace that value with the corresponding max value.
  6681. *
  6682. * @param {Vector4} v - The vector.
  6683. * @return {Vector4} A reference to this vector.
  6684. */
  6685. max( v ) {
  6686. this.x = Math.max( this.x, v.x );
  6687. this.y = Math.max( this.y, v.y );
  6688. this.z = Math.max( this.z, v.z );
  6689. this.w = Math.max( this.w, v.w );
  6690. return this;
  6691. }
  6692. /**
  6693. * If this vector's x, y, z or w value is greater than the max vector's x, y, z or w
  6694. * value, it is replaced by the corresponding value.
  6695. * If this vector's x, y, z or w value is less than the min vector's x, y, z or w value,
  6696. * it is replaced by the corresponding value.
  6697. *
  6698. * @param {Vector4} min - The minimum x, y and z values.
  6699. * @param {Vector4} max - The maximum x, y and z values in the desired range.
  6700. * @return {Vector4} A reference to this vector.
  6701. */
  6702. clamp( min, max ) {
  6703. // assumes min < max, componentwise
  6704. this.x = clamp( this.x, min.x, max.x );
  6705. this.y = clamp( this.y, min.y, max.y );
  6706. this.z = clamp( this.z, min.z, max.z );
  6707. this.w = clamp( this.w, min.w, max.w );
  6708. return this;
  6709. }
  6710. /**
  6711. * If this vector's x, y, z or w values are greater than the max value, they are
  6712. * replaced by the max value.
  6713. * If this vector's x, y, z or w values are less than the min value, they are
  6714. * replaced by the min value.
  6715. *
  6716. * @param {number} minVal - The minimum value the components will be clamped to.
  6717. * @param {number} maxVal - The maximum value the components will be clamped to.
  6718. * @return {Vector4} A reference to this vector.
  6719. */
  6720. clampScalar( minVal, maxVal ) {
  6721. this.x = clamp( this.x, minVal, maxVal );
  6722. this.y = clamp( this.y, minVal, maxVal );
  6723. this.z = clamp( this.z, minVal, maxVal );
  6724. this.w = clamp( this.w, minVal, maxVal );
  6725. return this;
  6726. }
  6727. /**
  6728. * If this vector's length is greater than the max value, it is replaced by
  6729. * the max value.
  6730. * If this vector's length is less than the min value, it is replaced by the
  6731. * min value.
  6732. *
  6733. * @param {number} min - The minimum value the vector length will be clamped to.
  6734. * @param {number} max - The maximum value the vector length will be clamped to.
  6735. * @return {Vector4} A reference to this vector.
  6736. */
  6737. clampLength( min, max ) {
  6738. const length = this.length();
  6739. return this.divideScalar( length || 1 ).multiplyScalar( clamp( length, min, max ) );
  6740. }
  6741. /**
  6742. * The components of this vector are rounded down to the nearest integer value.
  6743. *
  6744. * @return {Vector4} A reference to this vector.
  6745. */
  6746. floor() {
  6747. this.x = Math.floor( this.x );
  6748. this.y = Math.floor( this.y );
  6749. this.z = Math.floor( this.z );
  6750. this.w = Math.floor( this.w );
  6751. return this;
  6752. }
  6753. /**
  6754. * The components of this vector are rounded up to the nearest integer value.
  6755. *
  6756. * @return {Vector4} A reference to this vector.
  6757. */
  6758. ceil() {
  6759. this.x = Math.ceil( this.x );
  6760. this.y = Math.ceil( this.y );
  6761. this.z = Math.ceil( this.z );
  6762. this.w = Math.ceil( this.w );
  6763. return this;
  6764. }
  6765. /**
  6766. * The components of this vector are rounded to the nearest integer value
  6767. *
  6768. * @return {Vector4} A reference to this vector.
  6769. */
  6770. round() {
  6771. this.x = Math.round( this.x );
  6772. this.y = Math.round( this.y );
  6773. this.z = Math.round( this.z );
  6774. this.w = Math.round( this.w );
  6775. return this;
  6776. }
  6777. /**
  6778. * The components of this vector are rounded towards zero (up if negative,
  6779. * down if positive) to an integer value.
  6780. *
  6781. * @return {Vector4} A reference to this vector.
  6782. */
  6783. roundToZero() {
  6784. this.x = Math.trunc( this.x );
  6785. this.y = Math.trunc( this.y );
  6786. this.z = Math.trunc( this.z );
  6787. this.w = Math.trunc( this.w );
  6788. return this;
  6789. }
  6790. /**
  6791. * Inverts this vector - i.e. sets x = -x, y = -y, z = -z, w = -w.
  6792. *
  6793. * @return {Vector4} A reference to this vector.
  6794. */
  6795. negate() {
  6796. this.x = - this.x;
  6797. this.y = - this.y;
  6798. this.z = - this.z;
  6799. this.w = - this.w;
  6800. return this;
  6801. }
  6802. /**
  6803. * Calculates the dot product of the given vector with this instance.
  6804. *
  6805. * @param {Vector4} v - The vector to compute the dot product with.
  6806. * @return {number} The result of the dot product.
  6807. */
  6808. dot( v ) {
  6809. return this.x * v.x + this.y * v.y + this.z * v.z + this.w * v.w;
  6810. }
  6811. /**
  6812. * Computes the square of the Euclidean length (straight-line length) from
  6813. * (0, 0, 0, 0) to (x, y, z, w). If you are comparing the lengths of vectors, you should
  6814. * compare the length squared instead as it is slightly more efficient to calculate.
  6815. *
  6816. * @return {number} The square length of this vector.
  6817. */
  6818. lengthSq() {
  6819. return this.x * this.x + this.y * this.y + this.z * this.z + this.w * this.w;
  6820. }
  6821. /**
  6822. * Computes the Euclidean length (straight-line length) from (0, 0, 0, 0) to (x, y, z, w).
  6823. *
  6824. * @return {number} The length of this vector.
  6825. */
  6826. length() {
  6827. return Math.sqrt( this.x * this.x + this.y * this.y + this.z * this.z + this.w * this.w );
  6828. }
  6829. /**
  6830. * Computes the Manhattan length of this vector.
  6831. *
  6832. * @return {number} The length of this vector.
  6833. */
  6834. manhattanLength() {
  6835. return Math.abs( this.x ) + Math.abs( this.y ) + Math.abs( this.z ) + Math.abs( this.w );
  6836. }
  6837. /**
  6838. * Converts this vector to a unit vector - that is, sets it equal to a vector
  6839. * with the same direction as this one, but with a vector length of `1`.
  6840. *
  6841. * @return {Vector4} A reference to this vector.
  6842. */
  6843. normalize() {
  6844. return this.divideScalar( this.length() || 1 );
  6845. }
  6846. /**
  6847. * Sets this vector to a vector with the same direction as this one, but
  6848. * with the specified length.
  6849. *
  6850. * @param {number} length - The new length of this vector.
  6851. * @return {Vector4} A reference to this vector.
  6852. */
  6853. setLength( length ) {
  6854. return this.normalize().multiplyScalar( length );
  6855. }
  6856. /**
  6857. * Linearly interpolates between the given vector and this instance, where
  6858. * alpha is the percent distance along the line - alpha = 0 will be this
  6859. * vector, and alpha = 1 will be the given one.
  6860. *
  6861. * @param {Vector4} v - The vector to interpolate towards.
  6862. * @param {number} alpha - The interpolation factor, typically in the closed interval `[0, 1]`.
  6863. * @return {Vector4} A reference to this vector.
  6864. */
  6865. lerp( v, alpha ) {
  6866. this.x += ( v.x - this.x ) * alpha;
  6867. this.y += ( v.y - this.y ) * alpha;
  6868. this.z += ( v.z - this.z ) * alpha;
  6869. this.w += ( v.w - this.w ) * alpha;
  6870. return this;
  6871. }
  6872. /**
  6873. * Linearly interpolates between the given vectors, where alpha is the percent
  6874. * distance along the line - alpha = 0 will be first vector, and alpha = 1 will
  6875. * be the second one. The result is stored in this instance.
  6876. *
  6877. * @param {Vector4} v1 - The first vector.
  6878. * @param {Vector4} v2 - The second vector.
  6879. * @param {number} alpha - The interpolation factor, typically in the closed interval `[0, 1]`.
  6880. * @return {Vector4} A reference to this vector.
  6881. */
  6882. lerpVectors( v1, v2, alpha ) {
  6883. this.x = v1.x + ( v2.x - v1.x ) * alpha;
  6884. this.y = v1.y + ( v2.y - v1.y ) * alpha;
  6885. this.z = v1.z + ( v2.z - v1.z ) * alpha;
  6886. this.w = v1.w + ( v2.w - v1.w ) * alpha;
  6887. return this;
  6888. }
  6889. /**
  6890. * Returns `true` if this vector is equal with the given one.
  6891. *
  6892. * @param {Vector4} v - The vector to test for equality.
  6893. * @return {boolean} Whether this vector is equal with the given one.
  6894. */
  6895. equals( v ) {
  6896. return ( ( v.x === this.x ) && ( v.y === this.y ) && ( v.z === this.z ) && ( v.w === this.w ) );
  6897. }
  6898. /**
  6899. * Sets this vector's x value to be `array[ offset ]`, y value to be `array[ offset + 1 ]`,
  6900. * z value to be `array[ offset + 2 ]`, w value to be `array[ offset + 3 ]`.
  6901. *
  6902. * @param {Array<number>} array - An array holding the vector component values.
  6903. * @param {number} [offset=0] - The offset into the array.
  6904. * @return {Vector4} A reference to this vector.
  6905. */
  6906. fromArray( array, offset = 0 ) {
  6907. this.x = array[ offset ];
  6908. this.y = array[ offset + 1 ];
  6909. this.z = array[ offset + 2 ];
  6910. this.w = array[ offset + 3 ];
  6911. return this;
  6912. }
  6913. /**
  6914. * Writes the components of this vector to the given array. If no array is provided,
  6915. * the method returns a new instance.
  6916. *
  6917. * @param {Array<number>} [array=[]] - The target array holding the vector components.
  6918. * @param {number} [offset=0] - Index of the first element in the array.
  6919. * @return {Array<number>} The vector components.
  6920. */
  6921. toArray( array = [], offset = 0 ) {
  6922. array[ offset ] = this.x;
  6923. array[ offset + 1 ] = this.y;
  6924. array[ offset + 2 ] = this.z;
  6925. array[ offset + 3 ] = this.w;
  6926. return array;
  6927. }
  6928. /**
  6929. * Sets the components of this vector from the given buffer attribute.
  6930. *
  6931. * @param {BufferAttribute} attribute - The buffer attribute holding vector data.
  6932. * @param {number} index - The index into the attribute.
  6933. * @return {Vector4} A reference to this vector.
  6934. */
  6935. fromBufferAttribute( attribute, index ) {
  6936. this.x = attribute.getX( index );
  6937. this.y = attribute.getY( index );
  6938. this.z = attribute.getZ( index );
  6939. this.w = attribute.getW( index );
  6940. return this;
  6941. }
  6942. /**
  6943. * Sets each component of this vector to a pseudo-random value between `0` and
  6944. * `1`, excluding `1`.
  6945. *
  6946. * @return {Vector4} A reference to this vector.
  6947. */
  6948. random() {
  6949. this.x = Math.random();
  6950. this.y = Math.random();
  6951. this.z = Math.random();
  6952. this.w = Math.random();
  6953. return this;
  6954. }
  6955. *[ Symbol.iterator ]() {
  6956. yield this.x;
  6957. yield this.y;
  6958. yield this.z;
  6959. yield this.w;
  6960. }
  6961. }
  6962. /**
  6963. * A render target is a buffer where the video card draws pixels for a scene
  6964. * that is being rendered in the background. It is used in different effects,
  6965. * such as applying postprocessing to a rendered image before displaying it
  6966. * on the screen.
  6967. *
  6968. * @augments EventDispatcher
  6969. */
  6970. class RenderTarget extends EventDispatcher {
  6971. /**
  6972. * Render target options.
  6973. *
  6974. * @typedef {Object} RenderTarget~Options
  6975. * @property {boolean} [generateMipmaps=false] - Whether to generate mipmaps or not.
  6976. * @property {number} [magFilter=LinearFilter] - The mag filter.
  6977. * @property {number} [minFilter=LinearFilter] - The min filter.
  6978. * @property {number} [format=RGBAFormat] - The texture format.
  6979. * @property {number} [type=UnsignedByteType] - The texture type.
  6980. * @property {?string} [internalFormat=null] - The texture's internal format.
  6981. * @property {number} [wrapS=ClampToEdgeWrapping] - The texture's uv wrapping mode.
  6982. * @property {number} [wrapT=ClampToEdgeWrapping] - The texture's uv wrapping mode.
  6983. * @property {number} [anisotropy=1] - The texture's anisotropy value.
  6984. * @property {string} [colorSpace=NoColorSpace] - The texture's color space.
  6985. * @property {boolean} [depthBuffer=true] - Whether to allocate a depth buffer or not.
  6986. * @property {boolean} [stencilBuffer=false] - Whether to allocate a stencil buffer or not.
  6987. * @property {boolean} [resolveDepthBuffer=true] - Whether to resolve the depth buffer or not.
  6988. * @property {boolean} [resolveStencilBuffer=true] - Whether to resolve the stencil buffer or not.
  6989. * @property {?Texture} [depthTexture=null] - Reference to a depth texture.
  6990. * @property {number} [samples=0] - The MSAA samples count.
  6991. * @property {number} [count=1] - Defines the number of color attachments . Must be at least `1`.
  6992. * @property {number} [depth=1] - The texture depth.
  6993. * @property {boolean} [multiview=false] - Whether this target is used for multiview rendering.
  6994. */
  6995. /**
  6996. * Constructs a new render target.
  6997. *
  6998. * @param {number} [width=1] - The width of the render target.
  6999. * @param {number} [height=1] - The height of the render target.
  7000. * @param {RenderTarget~Options} [options] - The configuration object.
  7001. */
  7002. constructor( width = 1, height = 1, options = {} ) {
  7003. super();
  7004. options = Object.assign( {
  7005. generateMipmaps: false,
  7006. internalFormat: null,
  7007. minFilter: LinearFilter,
  7008. depthBuffer: true,
  7009. stencilBuffer: false,
  7010. resolveDepthBuffer: true,
  7011. resolveStencilBuffer: true,
  7012. depthTexture: null,
  7013. samples: 0,
  7014. count: 1,
  7015. depth: 1,
  7016. multiview: false
  7017. }, options );
  7018. /**
  7019. * This flag can be used for type testing.
  7020. *
  7021. * @type {boolean}
  7022. * @readonly
  7023. * @default true
  7024. */
  7025. this.isRenderTarget = true;
  7026. /**
  7027. * The width of the render target.
  7028. *
  7029. * @type {number}
  7030. * @default 1
  7031. */
  7032. this.width = width;
  7033. /**
  7034. * The height of the render target.
  7035. *
  7036. * @type {number}
  7037. * @default 1
  7038. */
  7039. this.height = height;
  7040. /**
  7041. * The depth of the render target.
  7042. *
  7043. * @type {number}
  7044. * @default 1
  7045. */
  7046. this.depth = options.depth;
  7047. /**
  7048. * A rectangular area inside the render target's viewport. Fragments that are
  7049. * outside the area will be discarded.
  7050. *
  7051. * @type {Vector4}
  7052. * @default (0,0,width,height)
  7053. */
  7054. this.scissor = new Vector4( 0, 0, width, height );
  7055. /**
  7056. * Indicates whether the scissor test should be enabled when rendering into
  7057. * this render target or not.
  7058. *
  7059. * @type {boolean}
  7060. * @default false
  7061. */
  7062. this.scissorTest = false;
  7063. /**
  7064. * A rectangular area representing the render target's viewport.
  7065. *
  7066. * @type {Vector4}
  7067. * @default (0,0,width,height)
  7068. */
  7069. this.viewport = new Vector4( 0, 0, width, height );
  7070. const image = { width: width, height: height, depth: options.depth };
  7071. const texture = new Texture( image );
  7072. /**
  7073. * An array of textures. Each color attachment is represented as a separate texture.
  7074. * Has at least a single entry for the default color attachment.
  7075. *
  7076. * @type {Array<Texture>}
  7077. */
  7078. this.textures = [];
  7079. const count = options.count;
  7080. for ( let i = 0; i < count; i ++ ) {
  7081. this.textures[ i ] = texture.clone();
  7082. this.textures[ i ].isRenderTargetTexture = true;
  7083. this.textures[ i ].renderTarget = this;
  7084. }
  7085. this._setTextureOptions( options );
  7086. /**
  7087. * Whether to allocate a depth buffer or not.
  7088. *
  7089. * @type {boolean}
  7090. * @default true
  7091. */
  7092. this.depthBuffer = options.depthBuffer;
  7093. /**
  7094. * Whether to allocate a stencil buffer or not.
  7095. *
  7096. * @type {boolean}
  7097. * @default false
  7098. */
  7099. this.stencilBuffer = options.stencilBuffer;
  7100. /**
  7101. * Whether to resolve the depth buffer or not.
  7102. *
  7103. * @type {boolean}
  7104. * @default true
  7105. */
  7106. this.resolveDepthBuffer = options.resolveDepthBuffer;
  7107. /**
  7108. * Whether to resolve the stencil buffer or not.
  7109. *
  7110. * @type {boolean}
  7111. * @default true
  7112. */
  7113. this.resolveStencilBuffer = options.resolveStencilBuffer;
  7114. this._depthTexture = null;
  7115. this.depthTexture = options.depthTexture;
  7116. /**
  7117. * The number of MSAA samples.
  7118. *
  7119. * A value of `0` disables MSAA.
  7120. *
  7121. * @type {number}
  7122. * @default 0
  7123. */
  7124. this.samples = options.samples;
  7125. /**
  7126. * Whether to this target is used in multiview rendering.
  7127. *
  7128. * @type {boolean}
  7129. * @default false
  7130. */
  7131. this.multiview = options.multiview;
  7132. }
  7133. _setTextureOptions( options = {} ) {
  7134. const values = {
  7135. minFilter: LinearFilter,
  7136. generateMipmaps: false,
  7137. flipY: false,
  7138. internalFormat: null
  7139. };
  7140. if ( options.mapping !== undefined ) values.mapping = options.mapping;
  7141. if ( options.wrapS !== undefined ) values.wrapS = options.wrapS;
  7142. if ( options.wrapT !== undefined ) values.wrapT = options.wrapT;
  7143. if ( options.wrapR !== undefined ) values.wrapR = options.wrapR;
  7144. if ( options.magFilter !== undefined ) values.magFilter = options.magFilter;
  7145. if ( options.minFilter !== undefined ) values.minFilter = options.minFilter;
  7146. if ( options.format !== undefined ) values.format = options.format;
  7147. if ( options.type !== undefined ) values.type = options.type;
  7148. if ( options.anisotropy !== undefined ) values.anisotropy = options.anisotropy;
  7149. if ( options.colorSpace !== undefined ) values.colorSpace = options.colorSpace;
  7150. if ( options.flipY !== undefined ) values.flipY = options.flipY;
  7151. if ( options.generateMipmaps !== undefined ) values.generateMipmaps = options.generateMipmaps;
  7152. if ( options.internalFormat !== undefined ) values.internalFormat = options.internalFormat;
  7153. for ( let i = 0; i < this.textures.length; i ++ ) {
  7154. const texture = this.textures[ i ];
  7155. texture.setValues( values );
  7156. }
  7157. }
  7158. /**
  7159. * The texture representing the default color attachment.
  7160. *
  7161. * @type {Texture}
  7162. */
  7163. get texture() {
  7164. return this.textures[ 0 ];
  7165. }
  7166. set texture( value ) {
  7167. this.textures[ 0 ] = value;
  7168. }
  7169. set depthTexture( current ) {
  7170. if ( this._depthTexture !== null ) this._depthTexture.renderTarget = null;
  7171. if ( current !== null ) current.renderTarget = this;
  7172. this._depthTexture = current;
  7173. }
  7174. /**
  7175. * Instead of saving the depth in a renderbuffer, a texture
  7176. * can be used instead which is useful for further processing
  7177. * e.g. in context of post-processing.
  7178. *
  7179. * @type {?DepthTexture}
  7180. * @default null
  7181. */
  7182. get depthTexture() {
  7183. return this._depthTexture;
  7184. }
  7185. /**
  7186. * Sets the size of this render target.
  7187. *
  7188. * @param {number} width - The width.
  7189. * @param {number} height - The height.
  7190. * @param {number} [depth=1] - The depth.
  7191. */
  7192. setSize( width, height, depth = 1 ) {
  7193. if ( this.width !== width || this.height !== height || this.depth !== depth ) {
  7194. this.width = width;
  7195. this.height = height;
  7196. this.depth = depth;
  7197. for ( let i = 0, il = this.textures.length; i < il; i ++ ) {
  7198. this.textures[ i ].image.width = width;
  7199. this.textures[ i ].image.height = height;
  7200. this.textures[ i ].image.depth = depth;
  7201. if ( this.textures[ i ].isData3DTexture !== true ) { // Fix for #31693
  7202. // TODO: Reconsider setting isArrayTexture flag here and in the ctor of Texture.
  7203. // Maybe a method `isArrayTexture()` or just a getter could replace a flag since
  7204. // both are evaluated on each call?
  7205. this.textures[ i ].isArrayTexture = this.textures[ i ].image.depth > 1;
  7206. }
  7207. }
  7208. this.dispose();
  7209. }
  7210. this.viewport.set( 0, 0, width, height );
  7211. this.scissor.set( 0, 0, width, height );
  7212. }
  7213. /**
  7214. * Returns a new render target with copied values from this instance.
  7215. *
  7216. * @return {RenderTarget} A clone of this instance.
  7217. */
  7218. clone() {
  7219. return new this.constructor().copy( this );
  7220. }
  7221. /**
  7222. * Copies the settings of the given render target. This is a structural copy so
  7223. * no resources are shared between render targets after the copy. That includes
  7224. * all MRT textures and the depth texture.
  7225. *
  7226. * @param {RenderTarget} source - The render target to copy.
  7227. * @return {RenderTarget} A reference to this instance.
  7228. */
  7229. copy( source ) {
  7230. this.width = source.width;
  7231. this.height = source.height;
  7232. this.depth = source.depth;
  7233. this.scissor.copy( source.scissor );
  7234. this.scissorTest = source.scissorTest;
  7235. this.viewport.copy( source.viewport );
  7236. this.textures.length = 0;
  7237. for ( let i = 0, il = source.textures.length; i < il; i ++ ) {
  7238. this.textures[ i ] = source.textures[ i ].clone();
  7239. this.textures[ i ].isRenderTargetTexture = true;
  7240. this.textures[ i ].renderTarget = this;
  7241. // ensure image object is not shared, see #20328
  7242. const image = Object.assign( {}, source.textures[ i ].image );
  7243. this.textures[ i ].source = new Source( image );
  7244. }
  7245. this.depthBuffer = source.depthBuffer;
  7246. this.stencilBuffer = source.stencilBuffer;
  7247. this.resolveDepthBuffer = source.resolveDepthBuffer;
  7248. this.resolveStencilBuffer = source.resolveStencilBuffer;
  7249. if ( source.depthTexture !== null ) this.depthTexture = source.depthTexture.clone();
  7250. this.samples = source.samples;
  7251. return this;
  7252. }
  7253. /**
  7254. * Frees the GPU-related resources allocated by this instance. Call this
  7255. * method whenever this instance is no longer used in your app.
  7256. *
  7257. * @fires RenderTarget#dispose
  7258. */
  7259. dispose() {
  7260. this.dispatchEvent( { type: 'dispose' } );
  7261. }
  7262. }
  7263. /**
  7264. * A render target used in context of {@link WebGLRenderer}.
  7265. *
  7266. * @augments RenderTarget
  7267. */
  7268. class WebGLRenderTarget extends RenderTarget {
  7269. /**
  7270. * Constructs a new 3D render target.
  7271. *
  7272. * @param {number} [width=1] - The width of the render target.
  7273. * @param {number} [height=1] - The height of the render target.
  7274. * @param {RenderTarget~Options} [options] - The configuration object.
  7275. */
  7276. constructor( width = 1, height = 1, options = {} ) {
  7277. super( width, height, options );
  7278. /**
  7279. * This flag can be used for type testing.
  7280. *
  7281. * @type {boolean}
  7282. * @readonly
  7283. * @default true
  7284. */
  7285. this.isWebGLRenderTarget = true;
  7286. }
  7287. }
  7288. /**
  7289. * Creates an array of textures directly from raw buffer data.
  7290. *
  7291. * @augments Texture
  7292. */
  7293. class DataArrayTexture extends Texture {
  7294. /**
  7295. * Constructs a new data array texture.
  7296. *
  7297. * @param {?TypedArray} [data=null] - The buffer data.
  7298. * @param {number} [width=1] - The width of the texture.
  7299. * @param {number} [height=1] - The height of the texture.
  7300. * @param {number} [depth=1] - The depth of the texture.
  7301. */
  7302. constructor( data = null, width = 1, height = 1, depth = 1 ) {
  7303. super( null );
  7304. /**
  7305. * This flag can be used for type testing.
  7306. *
  7307. * @type {boolean}
  7308. * @readonly
  7309. * @default true
  7310. */
  7311. this.isDataArrayTexture = true;
  7312. /**
  7313. * The image definition of a data texture.
  7314. *
  7315. * @type {{data:TypedArray,width:number,height:number,depth:number}}
  7316. */
  7317. this.image = { data, width, height, depth };
  7318. /**
  7319. * How the texture is sampled when a texel covers more than one pixel.
  7320. *
  7321. * Overwritten and set to `NearestFilter` by default.
  7322. *
  7323. * @type {(NearestFilter|NearestMipmapNearestFilter|NearestMipmapLinearFilter|LinearFilter|LinearMipmapNearestFilter|LinearMipmapLinearFilter)}
  7324. * @default NearestFilter
  7325. */
  7326. this.magFilter = NearestFilter;
  7327. /**
  7328. * How the texture is sampled when a texel covers less than one pixel.
  7329. *
  7330. * Overwritten and set to `NearestFilter` by default.
  7331. *
  7332. * @type {(NearestFilter|NearestMipmapNearestFilter|NearestMipmapLinearFilter|LinearFilter|LinearMipmapNearestFilter|LinearMipmapLinearFilter)}
  7333. * @default NearestFilter
  7334. */
  7335. this.minFilter = NearestFilter;
  7336. /**
  7337. * This defines how the texture is wrapped in the depth and corresponds to
  7338. * *W* in UVW mapping.
  7339. *
  7340. * @type {(RepeatWrapping|ClampToEdgeWrapping|MirroredRepeatWrapping)}
  7341. * @default ClampToEdgeWrapping
  7342. */
  7343. this.wrapR = ClampToEdgeWrapping;
  7344. /**
  7345. * Whether to generate mipmaps (if possible) for a texture.
  7346. *
  7347. * Overwritten and set to `false` by default.
  7348. *
  7349. * @type {boolean}
  7350. * @default false
  7351. */
  7352. this.generateMipmaps = false;
  7353. /**
  7354. * If set to `true`, the texture is flipped along the vertical axis when
  7355. * uploaded to the GPU.
  7356. *
  7357. * Overwritten and set to `false` by default.
  7358. *
  7359. * @type {boolean}
  7360. * @default false
  7361. */
  7362. this.flipY = false;
  7363. /**
  7364. * Specifies the alignment requirements for the start of each pixel row in memory.
  7365. *
  7366. * Overwritten and set to `1` by default.
  7367. *
  7368. * @type {boolean}
  7369. * @default 1
  7370. */
  7371. this.unpackAlignment = 1;
  7372. /**
  7373. * A set of all layers which need to be updated in the texture.
  7374. *
  7375. * @type {Set<number>}
  7376. */
  7377. this.layerUpdates = new Set();
  7378. }
  7379. /**
  7380. * Describes that a specific layer of the texture needs to be updated.
  7381. * Normally when {@link Texture#needsUpdate} is set to `true`, the
  7382. * entire data texture array is sent to the GPU. Marking specific
  7383. * layers will only transmit subsets of all mipmaps associated with a
  7384. * specific depth in the array which is often much more performant.
  7385. *
  7386. * @param {number} layerIndex - The layer index that should be updated.
  7387. */
  7388. addLayerUpdate( layerIndex ) {
  7389. this.layerUpdates.add( layerIndex );
  7390. }
  7391. /**
  7392. * Resets the layer updates registry.
  7393. */
  7394. clearLayerUpdates() {
  7395. this.layerUpdates.clear();
  7396. }
  7397. }
  7398. /**
  7399. * An array render target used in context of {@link WebGLRenderer}.
  7400. *
  7401. * @augments WebGLRenderTarget
  7402. */
  7403. class WebGLArrayRenderTarget extends WebGLRenderTarget {
  7404. /**
  7405. * Constructs a new array render target.
  7406. *
  7407. * @param {number} [width=1] - The width of the render target.
  7408. * @param {number} [height=1] - The height of the render target.
  7409. * @param {number} [depth=1] - The height of the render target.
  7410. * @param {RenderTarget~Options} [options] - The configuration object.
  7411. */
  7412. constructor( width = 1, height = 1, depth = 1, options = {} ) {
  7413. super( width, height, options );
  7414. /**
  7415. * This flag can be used for type testing.
  7416. *
  7417. * @type {boolean}
  7418. * @readonly
  7419. * @default true
  7420. */
  7421. this.isWebGLArrayRenderTarget = true;
  7422. this.depth = depth;
  7423. /**
  7424. * Overwritten with a different texture type.
  7425. *
  7426. * @type {DataArrayTexture}
  7427. */
  7428. this.texture = new DataArrayTexture( null, width, height, depth );
  7429. this._setTextureOptions( options );
  7430. this.texture.isRenderTargetTexture = true;
  7431. }
  7432. }
  7433. /**
  7434. * Creates a three-dimensional texture from raw data, with parameters to
  7435. * divide it into width, height, and depth.
  7436. *
  7437. * @augments Texture
  7438. */
  7439. class Data3DTexture extends Texture {
  7440. /**
  7441. * Constructs a new data array texture.
  7442. *
  7443. * @param {?TypedArray} [data=null] - The buffer data.
  7444. * @param {number} [width=1] - The width of the texture.
  7445. * @param {number} [height=1] - The height of the texture.
  7446. * @param {number} [depth=1] - The depth of the texture.
  7447. */
  7448. constructor( data = null, width = 1, height = 1, depth = 1 ) {
  7449. // We're going to add .setXXX() methods for setting properties later.
  7450. // Users can still set in Data3DTexture directly.
  7451. //
  7452. // const texture = new THREE.Data3DTexture( data, width, height, depth );
  7453. // texture.anisotropy = 16;
  7454. //
  7455. // See #14839
  7456. super( null );
  7457. /**
  7458. * This flag can be used for type testing.
  7459. *
  7460. * @type {boolean}
  7461. * @readonly
  7462. * @default true
  7463. */
  7464. this.isData3DTexture = true;
  7465. /**
  7466. * The image definition of a data texture.
  7467. *
  7468. * @type {{data:TypedArray,width:number,height:number,depth:number}}
  7469. */
  7470. this.image = { data, width, height, depth };
  7471. /**
  7472. * How the texture is sampled when a texel covers more than one pixel.
  7473. *
  7474. * Overwritten and set to `NearestFilter` by default.
  7475. *
  7476. * @type {(NearestFilter|NearestMipmapNearestFilter|NearestMipmapLinearFilter|LinearFilter|LinearMipmapNearestFilter|LinearMipmapLinearFilter)}
  7477. * @default NearestFilter
  7478. */
  7479. this.magFilter = NearestFilter;
  7480. /**
  7481. * How the texture is sampled when a texel covers less than one pixel.
  7482. *
  7483. * Overwritten and set to `NearestFilter` by default.
  7484. *
  7485. * @type {(NearestFilter|NearestMipmapNearestFilter|NearestMipmapLinearFilter|LinearFilter|LinearMipmapNearestFilter|LinearMipmapLinearFilter)}
  7486. * @default NearestFilter
  7487. */
  7488. this.minFilter = NearestFilter;
  7489. /**
  7490. * This defines how the texture is wrapped in the depth and corresponds to
  7491. * *W* in UVW mapping.
  7492. *
  7493. * @type {(RepeatWrapping|ClampToEdgeWrapping|MirroredRepeatWrapping)}
  7494. * @default ClampToEdgeWrapping
  7495. */
  7496. this.wrapR = ClampToEdgeWrapping;
  7497. /**
  7498. * Whether to generate mipmaps (if possible) for a texture.
  7499. *
  7500. * Overwritten and set to `false` by default.
  7501. *
  7502. * @type {boolean}
  7503. * @default false
  7504. */
  7505. this.generateMipmaps = false;
  7506. /**
  7507. * If set to `true`, the texture is flipped along the vertical axis when
  7508. * uploaded to the GPU.
  7509. *
  7510. * Overwritten and set to `false` by default.
  7511. *
  7512. * @type {boolean}
  7513. * @default false
  7514. */
  7515. this.flipY = false;
  7516. /**
  7517. * Specifies the alignment requirements for the start of each pixel row in memory.
  7518. *
  7519. * Overwritten and set to `1` by default.
  7520. *
  7521. * @type {boolean}
  7522. * @default 1
  7523. */
  7524. this.unpackAlignment = 1;
  7525. }
  7526. }
  7527. /**
  7528. * A 3D render target used in context of {@link WebGLRenderer}.
  7529. *
  7530. * @augments WebGLRenderTarget
  7531. */
  7532. class WebGL3DRenderTarget extends WebGLRenderTarget {
  7533. /**
  7534. * Constructs a new 3D render target.
  7535. *
  7536. * @param {number} [width=1] - The width of the render target.
  7537. * @param {number} [height=1] - The height of the render target.
  7538. * @param {number} [depth=1] - The height of the render target.
  7539. * @param {RenderTarget~Options} [options] - The configuration object.
  7540. */
  7541. constructor( width = 1, height = 1, depth = 1, options = {} ) {
  7542. super( width, height, options );
  7543. /**
  7544. * This flag can be used for type testing.
  7545. *
  7546. * @type {boolean}
  7547. * @readonly
  7548. * @default true
  7549. */
  7550. this.isWebGL3DRenderTarget = true;
  7551. this.depth = depth;
  7552. /**
  7553. * Overwritten with a different texture type.
  7554. *
  7555. * @type {Data3DTexture}
  7556. */
  7557. this.texture = new Data3DTexture( null, width, height, depth );
  7558. this._setTextureOptions( options );
  7559. this.texture.isRenderTargetTexture = true;
  7560. }
  7561. }
  7562. /**
  7563. * Represents a 4x4 matrix.
  7564. *
  7565. * The most common use of a 4x4 matrix in 3D computer graphics is as a transformation matrix.
  7566. * For an introduction to transformation matrices as used in WebGL, check out [this tutorial](https://www.opengl-tutorial.org/beginners-tutorials/tutorial-3-matrices)
  7567. *
  7568. * This allows a 3D vector representing a point in 3D space to undergo
  7569. * transformations such as translation, rotation, shear, scale, reflection,
  7570. * orthogonal or perspective projection and so on, by being multiplied by the
  7571. * matrix. This is known as `applying` the matrix to the vector.
  7572. *
  7573. * A Note on Row-Major and Column-Major Ordering:
  7574. *
  7575. * The constructor and {@link Matrix3#set} method take arguments in
  7576. * [row-major](https://en.wikipedia.org/wiki/Row-_and_column-major_order#Column-major_order)
  7577. * order, while internally they are stored in the {@link Matrix3#elements} array in column-major order.
  7578. * This means that calling:
  7579. * ```js
  7580. * const m = new THREE.Matrix4();
  7581. * m.set( 11, 12, 13, 14,
  7582. * 21, 22, 23, 24,
  7583. * 31, 32, 33, 34,
  7584. * 41, 42, 43, 44 );
  7585. * ```
  7586. * will result in the elements array containing:
  7587. * ```js
  7588. * m.elements = [ 11, 21, 31, 41,
  7589. * 12, 22, 32, 42,
  7590. * 13, 23, 33, 43,
  7591. * 14, 24, 34, 44 ];
  7592. * ```
  7593. * and internally all calculations are performed using column-major ordering.
  7594. * However, as the actual ordering makes no difference mathematically and
  7595. * most people are used to thinking about matrices in row-major order, the
  7596. * three.js documentation shows matrices in row-major order. Just bear in
  7597. * mind that if you are reading the source code, you'll have to take the
  7598. * transpose of any matrices outlined here to make sense of the calculations.
  7599. */
  7600. class Matrix4 {
  7601. /**
  7602. * Constructs a new 4x4 matrix. The arguments are supposed to be
  7603. * in row-major order. If no arguments are provided, the constructor
  7604. * initializes the matrix as an identity matrix.
  7605. *
  7606. * @param {number} [n11] - 1-1 matrix element.
  7607. * @param {number} [n12] - 1-2 matrix element.
  7608. * @param {number} [n13] - 1-3 matrix element.
  7609. * @param {number} [n14] - 1-4 matrix element.
  7610. * @param {number} [n21] - 2-1 matrix element.
  7611. * @param {number} [n22] - 2-2 matrix element.
  7612. * @param {number} [n23] - 2-3 matrix element.
  7613. * @param {number} [n24] - 2-4 matrix element.
  7614. * @param {number} [n31] - 3-1 matrix element.
  7615. * @param {number} [n32] - 3-2 matrix element.
  7616. * @param {number} [n33] - 3-3 matrix element.
  7617. * @param {number} [n34] - 3-4 matrix element.
  7618. * @param {number} [n41] - 4-1 matrix element.
  7619. * @param {number} [n42] - 4-2 matrix element.
  7620. * @param {number} [n43] - 4-3 matrix element.
  7621. * @param {number} [n44] - 4-4 matrix element.
  7622. */
  7623. constructor( n11, n12, n13, n14, n21, n22, n23, n24, n31, n32, n33, n34, n41, n42, n43, n44 ) {
  7624. /**
  7625. * This flag can be used for type testing.
  7626. *
  7627. * @type {boolean}
  7628. * @readonly
  7629. * @default true
  7630. */
  7631. Matrix4.prototype.isMatrix4 = true;
  7632. /**
  7633. * A column-major list of matrix values.
  7634. *
  7635. * @type {Array<number>}
  7636. */
  7637. this.elements = [
  7638. 1, 0, 0, 0,
  7639. 0, 1, 0, 0,
  7640. 0, 0, 1, 0,
  7641. 0, 0, 0, 1
  7642. ];
  7643. if ( n11 !== undefined ) {
  7644. this.set( n11, n12, n13, n14, n21, n22, n23, n24, n31, n32, n33, n34, n41, n42, n43, n44 );
  7645. }
  7646. }
  7647. /**
  7648. * Sets the elements of the matrix.The arguments are supposed to be
  7649. * in row-major order.
  7650. *
  7651. * @param {number} [n11] - 1-1 matrix element.
  7652. * @param {number} [n12] - 1-2 matrix element.
  7653. * @param {number} [n13] - 1-3 matrix element.
  7654. * @param {number} [n14] - 1-4 matrix element.
  7655. * @param {number} [n21] - 2-1 matrix element.
  7656. * @param {number} [n22] - 2-2 matrix element.
  7657. * @param {number} [n23] - 2-3 matrix element.
  7658. * @param {number} [n24] - 2-4 matrix element.
  7659. * @param {number} [n31] - 3-1 matrix element.
  7660. * @param {number} [n32] - 3-2 matrix element.
  7661. * @param {number} [n33] - 3-3 matrix element.
  7662. * @param {number} [n34] - 3-4 matrix element.
  7663. * @param {number} [n41] - 4-1 matrix element.
  7664. * @param {number} [n42] - 4-2 matrix element.
  7665. * @param {number} [n43] - 4-3 matrix element.
  7666. * @param {number} [n44] - 4-4 matrix element.
  7667. * @return {Matrix4} A reference to this matrix.
  7668. */
  7669. set( n11, n12, n13, n14, n21, n22, n23, n24, n31, n32, n33, n34, n41, n42, n43, n44 ) {
  7670. const te = this.elements;
  7671. te[ 0 ] = n11; te[ 4 ] = n12; te[ 8 ] = n13; te[ 12 ] = n14;
  7672. te[ 1 ] = n21; te[ 5 ] = n22; te[ 9 ] = n23; te[ 13 ] = n24;
  7673. te[ 2 ] = n31; te[ 6 ] = n32; te[ 10 ] = n33; te[ 14 ] = n34;
  7674. te[ 3 ] = n41; te[ 7 ] = n42; te[ 11 ] = n43; te[ 15 ] = n44;
  7675. return this;
  7676. }
  7677. /**
  7678. * Sets this matrix to the 4x4 identity matrix.
  7679. *
  7680. * @return {Matrix4} A reference to this matrix.
  7681. */
  7682. identity() {
  7683. this.set(
  7684. 1, 0, 0, 0,
  7685. 0, 1, 0, 0,
  7686. 0, 0, 1, 0,
  7687. 0, 0, 0, 1
  7688. );
  7689. return this;
  7690. }
  7691. /**
  7692. * Returns a matrix with copied values from this instance.
  7693. *
  7694. * @return {Matrix4} A clone of this instance.
  7695. */
  7696. clone() {
  7697. return new Matrix4().fromArray( this.elements );
  7698. }
  7699. /**
  7700. * Copies the values of the given matrix to this instance.
  7701. *
  7702. * @param {Matrix4} m - The matrix to copy.
  7703. * @return {Matrix4} A reference to this matrix.
  7704. */
  7705. copy( m ) {
  7706. const te = this.elements;
  7707. const me = m.elements;
  7708. te[ 0 ] = me[ 0 ]; te[ 1 ] = me[ 1 ]; te[ 2 ] = me[ 2 ]; te[ 3 ] = me[ 3 ];
  7709. te[ 4 ] = me[ 4 ]; te[ 5 ] = me[ 5 ]; te[ 6 ] = me[ 6 ]; te[ 7 ] = me[ 7 ];
  7710. te[ 8 ] = me[ 8 ]; te[ 9 ] = me[ 9 ]; te[ 10 ] = me[ 10 ]; te[ 11 ] = me[ 11 ];
  7711. te[ 12 ] = me[ 12 ]; te[ 13 ] = me[ 13 ]; te[ 14 ] = me[ 14 ]; te[ 15 ] = me[ 15 ];
  7712. return this;
  7713. }
  7714. /**
  7715. * Copies the translation component of the given matrix
  7716. * into this matrix's translation component.
  7717. *
  7718. * @param {Matrix4} m - The matrix to copy the translation component.
  7719. * @return {Matrix4} A reference to this matrix.
  7720. */
  7721. copyPosition( m ) {
  7722. const te = this.elements, me = m.elements;
  7723. te[ 12 ] = me[ 12 ];
  7724. te[ 13 ] = me[ 13 ];
  7725. te[ 14 ] = me[ 14 ];
  7726. return this;
  7727. }
  7728. /**
  7729. * Set the upper 3x3 elements of this matrix to the values of given 3x3 matrix.
  7730. *
  7731. * @param {Matrix3} m - The 3x3 matrix.
  7732. * @return {Matrix4} A reference to this matrix.
  7733. */
  7734. setFromMatrix3( m ) {
  7735. const me = m.elements;
  7736. this.set(
  7737. me[ 0 ], me[ 3 ], me[ 6 ], 0,
  7738. me[ 1 ], me[ 4 ], me[ 7 ], 0,
  7739. me[ 2 ], me[ 5 ], me[ 8 ], 0,
  7740. 0, 0, 0, 1
  7741. );
  7742. return this;
  7743. }
  7744. /**
  7745. * Extracts the basis of this matrix into the three axis vectors provided.
  7746. *
  7747. * @param {Vector3} xAxis - The basis's x axis.
  7748. * @param {Vector3} yAxis - The basis's y axis.
  7749. * @param {Vector3} zAxis - The basis's z axis.
  7750. * @return {Matrix4} A reference to this matrix.
  7751. */
  7752. extractBasis( xAxis, yAxis, zAxis ) {
  7753. if ( this.determinant() === 0 ) {
  7754. xAxis.set( 1, 0, 0 );
  7755. yAxis.set( 0, 1, 0 );
  7756. zAxis.set( 0, 0, 1 );
  7757. return this;
  7758. }
  7759. xAxis.setFromMatrixColumn( this, 0 );
  7760. yAxis.setFromMatrixColumn( this, 1 );
  7761. zAxis.setFromMatrixColumn( this, 2 );
  7762. return this;
  7763. }
  7764. /**
  7765. * Sets the given basis vectors to this matrix.
  7766. *
  7767. * @param {Vector3} xAxis - The basis's x axis.
  7768. * @param {Vector3} yAxis - The basis's y axis.
  7769. * @param {Vector3} zAxis - The basis's z axis.
  7770. * @return {Matrix4} A reference to this matrix.
  7771. */
  7772. makeBasis( xAxis, yAxis, zAxis ) {
  7773. this.set(
  7774. xAxis.x, yAxis.x, zAxis.x, 0,
  7775. xAxis.y, yAxis.y, zAxis.y, 0,
  7776. xAxis.z, yAxis.z, zAxis.z, 0,
  7777. 0, 0, 0, 1
  7778. );
  7779. return this;
  7780. }
  7781. /**
  7782. * Extracts the rotation component of the given matrix
  7783. * into this matrix's rotation component.
  7784. *
  7785. * Note: This method does not support reflection matrices.
  7786. *
  7787. * @param {Matrix4} m - The matrix.
  7788. * @return {Matrix4} A reference to this matrix.
  7789. */
  7790. extractRotation( m ) {
  7791. if ( m.determinant() === 0 ) {
  7792. return this.identity();
  7793. }
  7794. const te = this.elements;
  7795. const me = m.elements;
  7796. const scaleX = 1 / _v1$7.setFromMatrixColumn( m, 0 ).length();
  7797. const scaleY = 1 / _v1$7.setFromMatrixColumn( m, 1 ).length();
  7798. const scaleZ = 1 / _v1$7.setFromMatrixColumn( m, 2 ).length();
  7799. te[ 0 ] = me[ 0 ] * scaleX;
  7800. te[ 1 ] = me[ 1 ] * scaleX;
  7801. te[ 2 ] = me[ 2 ] * scaleX;
  7802. te[ 3 ] = 0;
  7803. te[ 4 ] = me[ 4 ] * scaleY;
  7804. te[ 5 ] = me[ 5 ] * scaleY;
  7805. te[ 6 ] = me[ 6 ] * scaleY;
  7806. te[ 7 ] = 0;
  7807. te[ 8 ] = me[ 8 ] * scaleZ;
  7808. te[ 9 ] = me[ 9 ] * scaleZ;
  7809. te[ 10 ] = me[ 10 ] * scaleZ;
  7810. te[ 11 ] = 0;
  7811. te[ 12 ] = 0;
  7812. te[ 13 ] = 0;
  7813. te[ 14 ] = 0;
  7814. te[ 15 ] = 1;
  7815. return this;
  7816. }
  7817. /**
  7818. * Sets the rotation component (the upper left 3x3 matrix) of this matrix to
  7819. * the rotation specified by the given Euler angles. The rest of
  7820. * the matrix is set to the identity. Depending on the {@link Euler#order},
  7821. * there are six possible outcomes. See [this page](https://en.wikipedia.org/wiki/Euler_angles#Rotation_matrix)
  7822. * for a complete list.
  7823. *
  7824. * @param {Euler} euler - The Euler angles.
  7825. * @return {Matrix4} A reference to this matrix.
  7826. */
  7827. makeRotationFromEuler( euler ) {
  7828. const te = this.elements;
  7829. const x = euler.x, y = euler.y, z = euler.z;
  7830. const a = Math.cos( x ), b = Math.sin( x );
  7831. const c = Math.cos( y ), d = Math.sin( y );
  7832. const e = Math.cos( z ), f = Math.sin( z );
  7833. if ( euler.order === 'XYZ' ) {
  7834. const ae = a * e, af = a * f, be = b * e, bf = b * f;
  7835. te[ 0 ] = c * e;
  7836. te[ 4 ] = - c * f;
  7837. te[ 8 ] = d;
  7838. te[ 1 ] = af + be * d;
  7839. te[ 5 ] = ae - bf * d;
  7840. te[ 9 ] = - b * c;
  7841. te[ 2 ] = bf - ae * d;
  7842. te[ 6 ] = be + af * d;
  7843. te[ 10 ] = a * c;
  7844. } else if ( euler.order === 'YXZ' ) {
  7845. const ce = c * e, cf = c * f, de = d * e, df = d * f;
  7846. te[ 0 ] = ce + df * b;
  7847. te[ 4 ] = de * b - cf;
  7848. te[ 8 ] = a * d;
  7849. te[ 1 ] = a * f;
  7850. te[ 5 ] = a * e;
  7851. te[ 9 ] = - b;
  7852. te[ 2 ] = cf * b - de;
  7853. te[ 6 ] = df + ce * b;
  7854. te[ 10 ] = a * c;
  7855. } else if ( euler.order === 'ZXY' ) {
  7856. const ce = c * e, cf = c * f, de = d * e, df = d * f;
  7857. te[ 0 ] = ce - df * b;
  7858. te[ 4 ] = - a * f;
  7859. te[ 8 ] = de + cf * b;
  7860. te[ 1 ] = cf + de * b;
  7861. te[ 5 ] = a * e;
  7862. te[ 9 ] = df - ce * b;
  7863. te[ 2 ] = - a * d;
  7864. te[ 6 ] = b;
  7865. te[ 10 ] = a * c;
  7866. } else if ( euler.order === 'ZYX' ) {
  7867. const ae = a * e, af = a * f, be = b * e, bf = b * f;
  7868. te[ 0 ] = c * e;
  7869. te[ 4 ] = be * d - af;
  7870. te[ 8 ] = ae * d + bf;
  7871. te[ 1 ] = c * f;
  7872. te[ 5 ] = bf * d + ae;
  7873. te[ 9 ] = af * d - be;
  7874. te[ 2 ] = - d;
  7875. te[ 6 ] = b * c;
  7876. te[ 10 ] = a * c;
  7877. } else if ( euler.order === 'YZX' ) {
  7878. const ac = a * c, ad = a * d, bc = b * c, bd = b * d;
  7879. te[ 0 ] = c * e;
  7880. te[ 4 ] = bd - ac * f;
  7881. te[ 8 ] = bc * f + ad;
  7882. te[ 1 ] = f;
  7883. te[ 5 ] = a * e;
  7884. te[ 9 ] = - b * e;
  7885. te[ 2 ] = - d * e;
  7886. te[ 6 ] = ad * f + bc;
  7887. te[ 10 ] = ac - bd * f;
  7888. } else if ( euler.order === 'XZY' ) {
  7889. const ac = a * c, ad = a * d, bc = b * c, bd = b * d;
  7890. te[ 0 ] = c * e;
  7891. te[ 4 ] = - f;
  7892. te[ 8 ] = d * e;
  7893. te[ 1 ] = ac * f + bd;
  7894. te[ 5 ] = a * e;
  7895. te[ 9 ] = ad * f - bc;
  7896. te[ 2 ] = bc * f - ad;
  7897. te[ 6 ] = b * e;
  7898. te[ 10 ] = bd * f + ac;
  7899. }
  7900. // bottom row
  7901. te[ 3 ] = 0;
  7902. te[ 7 ] = 0;
  7903. te[ 11 ] = 0;
  7904. // last column
  7905. te[ 12 ] = 0;
  7906. te[ 13 ] = 0;
  7907. te[ 14 ] = 0;
  7908. te[ 15 ] = 1;
  7909. return this;
  7910. }
  7911. /**
  7912. * Sets the rotation component of this matrix to the rotation specified by
  7913. * the given Quaternion as outlined [here](https://en.wikipedia.org/wiki/Rotation_matrix#Quaternion)
  7914. * The rest of the matrix is set to the identity.
  7915. *
  7916. * @param {Quaternion} q - The Quaternion.
  7917. * @return {Matrix4} A reference to this matrix.
  7918. */
  7919. makeRotationFromQuaternion( q ) {
  7920. return this.compose( _zero, q, _one );
  7921. }
  7922. /**
  7923. * Sets the rotation component of the transformation matrix, looking from `eye` towards
  7924. * `target`, and oriented by the up-direction.
  7925. *
  7926. * @param {Vector3} eye - The eye vector.
  7927. * @param {Vector3} target - The target vector.
  7928. * @param {Vector3} up - The up vector.
  7929. * @return {Matrix4} A reference to this matrix.
  7930. */
  7931. lookAt( eye, target, up ) {
  7932. const te = this.elements;
  7933. _z.subVectors( eye, target );
  7934. if ( _z.lengthSq() === 0 ) {
  7935. // eye and target are in the same position
  7936. _z.z = 1;
  7937. }
  7938. _z.normalize();
  7939. _x.crossVectors( up, _z );
  7940. if ( _x.lengthSq() === 0 ) {
  7941. // up and z are parallel
  7942. if ( Math.abs( up.z ) === 1 ) {
  7943. _z.x += 0.0001;
  7944. } else {
  7945. _z.z += 0.0001;
  7946. }
  7947. _z.normalize();
  7948. _x.crossVectors( up, _z );
  7949. }
  7950. _x.normalize();
  7951. _y.crossVectors( _z, _x );
  7952. te[ 0 ] = _x.x; te[ 4 ] = _y.x; te[ 8 ] = _z.x;
  7953. te[ 1 ] = _x.y; te[ 5 ] = _y.y; te[ 9 ] = _z.y;
  7954. te[ 2 ] = _x.z; te[ 6 ] = _y.z; te[ 10 ] = _z.z;
  7955. return this;
  7956. }
  7957. /**
  7958. * Post-multiplies this matrix by the given 4x4 matrix.
  7959. *
  7960. * @param {Matrix4} m - The matrix to multiply with.
  7961. * @return {Matrix4} A reference to this matrix.
  7962. */
  7963. multiply( m ) {
  7964. return this.multiplyMatrices( this, m );
  7965. }
  7966. /**
  7967. * Pre-multiplies this matrix by the given 4x4 matrix.
  7968. *
  7969. * @param {Matrix4} m - The matrix to multiply with.
  7970. * @return {Matrix4} A reference to this matrix.
  7971. */
  7972. premultiply( m ) {
  7973. return this.multiplyMatrices( m, this );
  7974. }
  7975. /**
  7976. * Multiples the given 4x4 matrices and stores the result
  7977. * in this matrix.
  7978. *
  7979. * @param {Matrix4} a - The first matrix.
  7980. * @param {Matrix4} b - The second matrix.
  7981. * @return {Matrix4} A reference to this matrix.
  7982. */
  7983. multiplyMatrices( a, b ) {
  7984. const ae = a.elements;
  7985. const be = b.elements;
  7986. const te = this.elements;
  7987. const a11 = ae[ 0 ], a12 = ae[ 4 ], a13 = ae[ 8 ], a14 = ae[ 12 ];
  7988. const a21 = ae[ 1 ], a22 = ae[ 5 ], a23 = ae[ 9 ], a24 = ae[ 13 ];
  7989. const a31 = ae[ 2 ], a32 = ae[ 6 ], a33 = ae[ 10 ], a34 = ae[ 14 ];
  7990. const a41 = ae[ 3 ], a42 = ae[ 7 ], a43 = ae[ 11 ], a44 = ae[ 15 ];
  7991. const b11 = be[ 0 ], b12 = be[ 4 ], b13 = be[ 8 ], b14 = be[ 12 ];
  7992. const b21 = be[ 1 ], b22 = be[ 5 ], b23 = be[ 9 ], b24 = be[ 13 ];
  7993. const b31 = be[ 2 ], b32 = be[ 6 ], b33 = be[ 10 ], b34 = be[ 14 ];
  7994. const b41 = be[ 3 ], b42 = be[ 7 ], b43 = be[ 11 ], b44 = be[ 15 ];
  7995. te[ 0 ] = a11 * b11 + a12 * b21 + a13 * b31 + a14 * b41;
  7996. te[ 4 ] = a11 * b12 + a12 * b22 + a13 * b32 + a14 * b42;
  7997. te[ 8 ] = a11 * b13 + a12 * b23 + a13 * b33 + a14 * b43;
  7998. te[ 12 ] = a11 * b14 + a12 * b24 + a13 * b34 + a14 * b44;
  7999. te[ 1 ] = a21 * b11 + a22 * b21 + a23 * b31 + a24 * b41;
  8000. te[ 5 ] = a21 * b12 + a22 * b22 + a23 * b32 + a24 * b42;
  8001. te[ 9 ] = a21 * b13 + a22 * b23 + a23 * b33 + a24 * b43;
  8002. te[ 13 ] = a21 * b14 + a22 * b24 + a23 * b34 + a24 * b44;
  8003. te[ 2 ] = a31 * b11 + a32 * b21 + a33 * b31 + a34 * b41;
  8004. te[ 6 ] = a31 * b12 + a32 * b22 + a33 * b32 + a34 * b42;
  8005. te[ 10 ] = a31 * b13 + a32 * b23 + a33 * b33 + a34 * b43;
  8006. te[ 14 ] = a31 * b14 + a32 * b24 + a33 * b34 + a34 * b44;
  8007. te[ 3 ] = a41 * b11 + a42 * b21 + a43 * b31 + a44 * b41;
  8008. te[ 7 ] = a41 * b12 + a42 * b22 + a43 * b32 + a44 * b42;
  8009. te[ 11 ] = a41 * b13 + a42 * b23 + a43 * b33 + a44 * b43;
  8010. te[ 15 ] = a41 * b14 + a42 * b24 + a43 * b34 + a44 * b44;
  8011. return this;
  8012. }
  8013. /**
  8014. * Multiplies every component of the matrix by the given scalar.
  8015. *
  8016. * @param {number} s - The scalar.
  8017. * @return {Matrix4} A reference to this matrix.
  8018. */
  8019. multiplyScalar( s ) {
  8020. const te = this.elements;
  8021. te[ 0 ] *= s; te[ 4 ] *= s; te[ 8 ] *= s; te[ 12 ] *= s;
  8022. te[ 1 ] *= s; te[ 5 ] *= s; te[ 9 ] *= s; te[ 13 ] *= s;
  8023. te[ 2 ] *= s; te[ 6 ] *= s; te[ 10 ] *= s; te[ 14 ] *= s;
  8024. te[ 3 ] *= s; te[ 7 ] *= s; te[ 11 ] *= s; te[ 15 ] *= s;
  8025. return this;
  8026. }
  8027. /**
  8028. * Computes and returns the determinant of this matrix.
  8029. *
  8030. * Based on the method outlined [here](http://www.euclideanspace.com/maths/algebra/matrix/functions/inverse/fourD/index.html).
  8031. *
  8032. * @return {number} The determinant.
  8033. */
  8034. determinant() {
  8035. const te = this.elements;
  8036. const n11 = te[ 0 ], n12 = te[ 4 ], n13 = te[ 8 ], n14 = te[ 12 ];
  8037. const n21 = te[ 1 ], n22 = te[ 5 ], n23 = te[ 9 ], n24 = te[ 13 ];
  8038. const n31 = te[ 2 ], n32 = te[ 6 ], n33 = te[ 10 ], n34 = te[ 14 ];
  8039. const n41 = te[ 3 ], n42 = te[ 7 ], n43 = te[ 11 ], n44 = te[ 15 ];
  8040. const t11 = n23 * n34 - n24 * n33;
  8041. const t12 = n22 * n34 - n24 * n32;
  8042. const t13 = n22 * n33 - n23 * n32;
  8043. const t21 = n21 * n34 - n24 * n31;
  8044. const t22 = n21 * n33 - n23 * n31;
  8045. const t23 = n21 * n32 - n22 * n31;
  8046. return n11 * ( n42 * t11 - n43 * t12 + n44 * t13 ) -
  8047. n12 * ( n41 * t11 - n43 * t21 + n44 * t22 ) +
  8048. n13 * ( n41 * t12 - n42 * t21 + n44 * t23 ) -
  8049. n14 * ( n41 * t13 - n42 * t22 + n43 * t23 );
  8050. }
  8051. /**
  8052. * Transposes this matrix in place.
  8053. *
  8054. * @return {Matrix4} A reference to this matrix.
  8055. */
  8056. transpose() {
  8057. const te = this.elements;
  8058. let tmp;
  8059. tmp = te[ 1 ]; te[ 1 ] = te[ 4 ]; te[ 4 ] = tmp;
  8060. tmp = te[ 2 ]; te[ 2 ] = te[ 8 ]; te[ 8 ] = tmp;
  8061. tmp = te[ 6 ]; te[ 6 ] = te[ 9 ]; te[ 9 ] = tmp;
  8062. tmp = te[ 3 ]; te[ 3 ] = te[ 12 ]; te[ 12 ] = tmp;
  8063. tmp = te[ 7 ]; te[ 7 ] = te[ 13 ]; te[ 13 ] = tmp;
  8064. tmp = te[ 11 ]; te[ 11 ] = te[ 14 ]; te[ 14 ] = tmp;
  8065. return this;
  8066. }
  8067. /**
  8068. * Sets the position component for this matrix from the given vector,
  8069. * without affecting the rest of the matrix.
  8070. *
  8071. * @param {number|Vector3} x - The x component of the vector or alternatively the vector object.
  8072. * @param {number} y - The y component of the vector.
  8073. * @param {number} z - The z component of the vector.
  8074. * @return {Matrix4} A reference to this matrix.
  8075. */
  8076. setPosition( x, y, z ) {
  8077. const te = this.elements;
  8078. if ( x.isVector3 ) {
  8079. te[ 12 ] = x.x;
  8080. te[ 13 ] = x.y;
  8081. te[ 14 ] = x.z;
  8082. } else {
  8083. te[ 12 ] = x;
  8084. te[ 13 ] = y;
  8085. te[ 14 ] = z;
  8086. }
  8087. return this;
  8088. }
  8089. /**
  8090. * Inverts this matrix, using the [analytic method](https://en.wikipedia.org/wiki/Invertible_matrix#Analytic_solution).
  8091. * You can not invert with a determinant of zero. If you attempt this, the method produces
  8092. * a zero matrix instead.
  8093. *
  8094. * @return {Matrix4} A reference to this matrix.
  8095. */
  8096. invert() {
  8097. // based on https://github.com/toji/gl-matrix
  8098. const te = this.elements,
  8099. n11 = te[ 0 ], n21 = te[ 1 ], n31 = te[ 2 ], n41 = te[ 3 ],
  8100. n12 = te[ 4 ], n22 = te[ 5 ], n32 = te[ 6 ], n42 = te[ 7 ],
  8101. n13 = te[ 8 ], n23 = te[ 9 ], n33 = te[ 10 ], n43 = te[ 11 ],
  8102. n14 = te[ 12 ], n24 = te[ 13 ], n34 = te[ 14 ], n44 = te[ 15 ],
  8103. t1 = n11 * n22 - n21 * n12,
  8104. t2 = n11 * n32 - n31 * n12,
  8105. t3 = n11 * n42 - n41 * n12,
  8106. t4 = n21 * n32 - n31 * n22,
  8107. t5 = n21 * n42 - n41 * n22,
  8108. t6 = n31 * n42 - n41 * n32,
  8109. t7 = n13 * n24 - n23 * n14,
  8110. t8 = n13 * n34 - n33 * n14,
  8111. t9 = n13 * n44 - n43 * n14,
  8112. t10 = n23 * n34 - n33 * n24,
  8113. t11 = n23 * n44 - n43 * n24,
  8114. t12 = n33 * n44 - n43 * n34;
  8115. const det = t1 * t12 - t2 * t11 + t3 * t10 + t4 * t9 - t5 * t8 + t6 * t7;
  8116. if ( det === 0 ) return this.set( 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0 );
  8117. const detInv = 1 / det;
  8118. te[ 0 ] = ( n22 * t12 - n32 * t11 + n42 * t10 ) * detInv;
  8119. te[ 1 ] = ( n31 * t11 - n21 * t12 - n41 * t10 ) * detInv;
  8120. te[ 2 ] = ( n24 * t6 - n34 * t5 + n44 * t4 ) * detInv;
  8121. te[ 3 ] = ( n33 * t5 - n23 * t6 - n43 * t4 ) * detInv;
  8122. te[ 4 ] = ( n32 * t9 - n12 * t12 - n42 * t8 ) * detInv;
  8123. te[ 5 ] = ( n11 * t12 - n31 * t9 + n41 * t8 ) * detInv;
  8124. te[ 6 ] = ( n34 * t3 - n14 * t6 - n44 * t2 ) * detInv;
  8125. te[ 7 ] = ( n13 * t6 - n33 * t3 + n43 * t2 ) * detInv;
  8126. te[ 8 ] = ( n12 * t11 - n22 * t9 + n42 * t7 ) * detInv;
  8127. te[ 9 ] = ( n21 * t9 - n11 * t11 - n41 * t7 ) * detInv;
  8128. te[ 10 ] = ( n14 * t5 - n24 * t3 + n44 * t1 ) * detInv;
  8129. te[ 11 ] = ( n23 * t3 - n13 * t5 - n43 * t1 ) * detInv;
  8130. te[ 12 ] = ( n22 * t8 - n12 * t10 - n32 * t7 ) * detInv;
  8131. te[ 13 ] = ( n11 * t10 - n21 * t8 + n31 * t7 ) * detInv;
  8132. te[ 14 ] = ( n24 * t2 - n14 * t4 - n34 * t1 ) * detInv;
  8133. te[ 15 ] = ( n13 * t4 - n23 * t2 + n33 * t1 ) * detInv;
  8134. return this;
  8135. }
  8136. /**
  8137. * Multiplies the columns of this matrix by the given vector.
  8138. *
  8139. * @param {Vector3} v - The scale vector.
  8140. * @return {Matrix4} A reference to this matrix.
  8141. */
  8142. scale( v ) {
  8143. const te = this.elements;
  8144. const x = v.x, y = v.y, z = v.z;
  8145. te[ 0 ] *= x; te[ 4 ] *= y; te[ 8 ] *= z;
  8146. te[ 1 ] *= x; te[ 5 ] *= y; te[ 9 ] *= z;
  8147. te[ 2 ] *= x; te[ 6 ] *= y; te[ 10 ] *= z;
  8148. te[ 3 ] *= x; te[ 7 ] *= y; te[ 11 ] *= z;
  8149. return this;
  8150. }
  8151. /**
  8152. * Gets the maximum scale value of the three axes.
  8153. *
  8154. * @return {number} The maximum scale.
  8155. */
  8156. getMaxScaleOnAxis() {
  8157. const te = this.elements;
  8158. const scaleXSq = te[ 0 ] * te[ 0 ] + te[ 1 ] * te[ 1 ] + te[ 2 ] * te[ 2 ];
  8159. const scaleYSq = te[ 4 ] * te[ 4 ] + te[ 5 ] * te[ 5 ] + te[ 6 ] * te[ 6 ];
  8160. const scaleZSq = te[ 8 ] * te[ 8 ] + te[ 9 ] * te[ 9 ] + te[ 10 ] * te[ 10 ];
  8161. return Math.sqrt( Math.max( scaleXSq, scaleYSq, scaleZSq ) );
  8162. }
  8163. /**
  8164. * Sets this matrix as a translation transform from the given vector.
  8165. *
  8166. * @param {number|Vector3} x - The amount to translate in the X axis or alternatively a translation vector.
  8167. * @param {number} y - The amount to translate in the Y axis.
  8168. * @param {number} z - The amount to translate in the z axis.
  8169. * @return {Matrix4} A reference to this matrix.
  8170. */
  8171. makeTranslation( x, y, z ) {
  8172. if ( x.isVector3 ) {
  8173. this.set(
  8174. 1, 0, 0, x.x,
  8175. 0, 1, 0, x.y,
  8176. 0, 0, 1, x.z,
  8177. 0, 0, 0, 1
  8178. );
  8179. } else {
  8180. this.set(
  8181. 1, 0, 0, x,
  8182. 0, 1, 0, y,
  8183. 0, 0, 1, z,
  8184. 0, 0, 0, 1
  8185. );
  8186. }
  8187. return this;
  8188. }
  8189. /**
  8190. * Sets this matrix as a rotational transformation around the X axis by
  8191. * the given angle.
  8192. *
  8193. * @param {number} theta - The rotation in radians.
  8194. * @return {Matrix4} A reference to this matrix.
  8195. */
  8196. makeRotationX( theta ) {
  8197. const c = Math.cos( theta ), s = Math.sin( theta );
  8198. this.set(
  8199. 1, 0, 0, 0,
  8200. 0, c, - s, 0,
  8201. 0, s, c, 0,
  8202. 0, 0, 0, 1
  8203. );
  8204. return this;
  8205. }
  8206. /**
  8207. * Sets this matrix as a rotational transformation around the Y axis by
  8208. * the given angle.
  8209. *
  8210. * @param {number} theta - The rotation in radians.
  8211. * @return {Matrix4} A reference to this matrix.
  8212. */
  8213. makeRotationY( theta ) {
  8214. const c = Math.cos( theta ), s = Math.sin( theta );
  8215. this.set(
  8216. c, 0, s, 0,
  8217. 0, 1, 0, 0,
  8218. - s, 0, c, 0,
  8219. 0, 0, 0, 1
  8220. );
  8221. return this;
  8222. }
  8223. /**
  8224. * Sets this matrix as a rotational transformation around the Z axis by
  8225. * the given angle.
  8226. *
  8227. * @param {number} theta - The rotation in radians.
  8228. * @return {Matrix4} A reference to this matrix.
  8229. */
  8230. makeRotationZ( theta ) {
  8231. const c = Math.cos( theta ), s = Math.sin( theta );
  8232. this.set(
  8233. c, - s, 0, 0,
  8234. s, c, 0, 0,
  8235. 0, 0, 1, 0,
  8236. 0, 0, 0, 1
  8237. );
  8238. return this;
  8239. }
  8240. /**
  8241. * Sets this matrix as a rotational transformation around the given axis by
  8242. * the given angle.
  8243. *
  8244. * This is a somewhat controversial but mathematically sound alternative to
  8245. * rotating via Quaternions. See the discussion [here](https://www.gamedev.net/articles/programming/math-and-physics/do-we-really-need-quaternions-r1199).
  8246. *
  8247. * @param {Vector3} axis - The normalized rotation axis.
  8248. * @param {number} angle - The rotation in radians.
  8249. * @return {Matrix4} A reference to this matrix.
  8250. */
  8251. makeRotationAxis( axis, angle ) {
  8252. // Based on http://www.gamedev.net/reference/articles/article1199.asp
  8253. const c = Math.cos( angle );
  8254. const s = Math.sin( angle );
  8255. const t = 1 - c;
  8256. const x = axis.x, y = axis.y, z = axis.z;
  8257. const tx = t * x, ty = t * y;
  8258. this.set(
  8259. tx * x + c, tx * y - s * z, tx * z + s * y, 0,
  8260. tx * y + s * z, ty * y + c, ty * z - s * x, 0,
  8261. tx * z - s * y, ty * z + s * x, t * z * z + c, 0,
  8262. 0, 0, 0, 1
  8263. );
  8264. return this;
  8265. }
  8266. /**
  8267. * Sets this matrix as a scale transformation.
  8268. *
  8269. * @param {number} x - The amount to scale in the X axis.
  8270. * @param {number} y - The amount to scale in the Y axis.
  8271. * @param {number} z - The amount to scale in the Z axis.
  8272. * @return {Matrix4} A reference to this matrix.
  8273. */
  8274. makeScale( x, y, z ) {
  8275. this.set(
  8276. x, 0, 0, 0,
  8277. 0, y, 0, 0,
  8278. 0, 0, z, 0,
  8279. 0, 0, 0, 1
  8280. );
  8281. return this;
  8282. }
  8283. /**
  8284. * Sets this matrix as a shear transformation.
  8285. *
  8286. * @param {number} xy - The amount to shear X by Y.
  8287. * @param {number} xz - The amount to shear X by Z.
  8288. * @param {number} yx - The amount to shear Y by X.
  8289. * @param {number} yz - The amount to shear Y by Z.
  8290. * @param {number} zx - The amount to shear Z by X.
  8291. * @param {number} zy - The amount to shear Z by Y.
  8292. * @return {Matrix4} A reference to this matrix.
  8293. */
  8294. makeShear( xy, xz, yx, yz, zx, zy ) {
  8295. this.set(
  8296. 1, yx, zx, 0,
  8297. xy, 1, zy, 0,
  8298. xz, yz, 1, 0,
  8299. 0, 0, 0, 1
  8300. );
  8301. return this;
  8302. }
  8303. /**
  8304. * Sets this matrix to the transformation composed of the given position,
  8305. * rotation (Quaternion) and scale.
  8306. *
  8307. * @param {Vector3} position - The position vector.
  8308. * @param {Quaternion} quaternion - The rotation as a Quaternion.
  8309. * @param {Vector3} scale - The scale vector.
  8310. * @return {Matrix4} A reference to this matrix.
  8311. */
  8312. compose( position, quaternion, scale ) {
  8313. const te = this.elements;
  8314. const x = quaternion._x, y = quaternion._y, z = quaternion._z, w = quaternion._w;
  8315. const x2 = x + x, y2 = y + y, z2 = z + z;
  8316. const xx = x * x2, xy = x * y2, xz = x * z2;
  8317. const yy = y * y2, yz = y * z2, zz = z * z2;
  8318. const wx = w * x2, wy = w * y2, wz = w * z2;
  8319. const sx = scale.x, sy = scale.y, sz = scale.z;
  8320. te[ 0 ] = ( 1 - ( yy + zz ) ) * sx;
  8321. te[ 1 ] = ( xy + wz ) * sx;
  8322. te[ 2 ] = ( xz - wy ) * sx;
  8323. te[ 3 ] = 0;
  8324. te[ 4 ] = ( xy - wz ) * sy;
  8325. te[ 5 ] = ( 1 - ( xx + zz ) ) * sy;
  8326. te[ 6 ] = ( yz + wx ) * sy;
  8327. te[ 7 ] = 0;
  8328. te[ 8 ] = ( xz + wy ) * sz;
  8329. te[ 9 ] = ( yz - wx ) * sz;
  8330. te[ 10 ] = ( 1 - ( xx + yy ) ) * sz;
  8331. te[ 11 ] = 0;
  8332. te[ 12 ] = position.x;
  8333. te[ 13 ] = position.y;
  8334. te[ 14 ] = position.z;
  8335. te[ 15 ] = 1;
  8336. return this;
  8337. }
  8338. /**
  8339. * Decomposes this matrix into its position, rotation and scale components
  8340. * and provides the result in the given objects.
  8341. *
  8342. * Note: Not all matrices are decomposable in this way. For example, if an
  8343. * object has a non-uniformly scaled parent, then the object's world matrix
  8344. * may not be decomposable, and this method may not be appropriate.
  8345. *
  8346. * @param {Vector3} position - The position vector.
  8347. * @param {Quaternion} quaternion - The rotation as a Quaternion.
  8348. * @param {Vector3} scale - The scale vector.
  8349. * @return {Matrix4} A reference to this matrix.
  8350. */
  8351. decompose( position, quaternion, scale ) {
  8352. const te = this.elements;
  8353. position.x = te[ 12 ];
  8354. position.y = te[ 13 ];
  8355. position.z = te[ 14 ];
  8356. const det = this.determinant();
  8357. if ( det === 0 ) {
  8358. scale.set( 1, 1, 1 );
  8359. quaternion.identity();
  8360. return this;
  8361. }
  8362. let sx = _v1$7.set( te[ 0 ], te[ 1 ], te[ 2 ] ).length();
  8363. const sy = _v1$7.set( te[ 4 ], te[ 5 ], te[ 6 ] ).length();
  8364. const sz = _v1$7.set( te[ 8 ], te[ 9 ], te[ 10 ] ).length();
  8365. // if determinant is negative, we need to invert one scale
  8366. if ( det < 0 ) sx = - sx;
  8367. // scale the rotation part
  8368. _m1$2.copy( this );
  8369. const invSX = 1 / sx;
  8370. const invSY = 1 / sy;
  8371. const invSZ = 1 / sz;
  8372. _m1$2.elements[ 0 ] *= invSX;
  8373. _m1$2.elements[ 1 ] *= invSX;
  8374. _m1$2.elements[ 2 ] *= invSX;
  8375. _m1$2.elements[ 4 ] *= invSY;
  8376. _m1$2.elements[ 5 ] *= invSY;
  8377. _m1$2.elements[ 6 ] *= invSY;
  8378. _m1$2.elements[ 8 ] *= invSZ;
  8379. _m1$2.elements[ 9 ] *= invSZ;
  8380. _m1$2.elements[ 10 ] *= invSZ;
  8381. quaternion.setFromRotationMatrix( _m1$2 );
  8382. scale.x = sx;
  8383. scale.y = sy;
  8384. scale.z = sz;
  8385. return this;
  8386. }
  8387. /**
  8388. * Creates a perspective projection matrix. This is used internally by
  8389. * {@link PerspectiveCamera#updateProjectionMatrix}.
  8390. * @param {number} left - Left boundary of the viewing frustum at the near plane.
  8391. * @param {number} right - Right boundary of the viewing frustum at the near plane.
  8392. * @param {number} top - Top boundary of the viewing frustum at the near plane.
  8393. * @param {number} bottom - Bottom boundary of the viewing frustum at the near plane.
  8394. * @param {number} near - The distance from the camera to the near plane.
  8395. * @param {number} far - The distance from the camera to the far plane.
  8396. * @param {(WebGLCoordinateSystem|WebGPUCoordinateSystem)} [coordinateSystem=WebGLCoordinateSystem] - The coordinate system.
  8397. * @param {boolean} [reversedDepth=false] - Whether to use a reversed depth.
  8398. * @return {Matrix4} A reference to this matrix.
  8399. */
  8400. makePerspective( left, right, top, bottom, near, far, coordinateSystem = WebGLCoordinateSystem, reversedDepth = false ) {
  8401. const te = this.elements;
  8402. const x = 2 * near / ( right - left );
  8403. const y = 2 * near / ( top - bottom );
  8404. const a = ( right + left ) / ( right - left );
  8405. const b = ( top + bottom ) / ( top - bottom );
  8406. let c, d;
  8407. if ( reversedDepth ) {
  8408. c = near / ( far - near );
  8409. d = ( far * near ) / ( far - near );
  8410. } else {
  8411. if ( coordinateSystem === WebGLCoordinateSystem ) {
  8412. c = - ( far + near ) / ( far - near );
  8413. d = ( -2 * far * near ) / ( far - near );
  8414. } else if ( coordinateSystem === WebGPUCoordinateSystem ) {
  8415. c = - far / ( far - near );
  8416. d = ( - far * near ) / ( far - near );
  8417. } else {
  8418. throw new Error( 'THREE.Matrix4.makePerspective(): Invalid coordinate system: ' + coordinateSystem );
  8419. }
  8420. }
  8421. te[ 0 ] = x; te[ 4 ] = 0; te[ 8 ] = a; te[ 12 ] = 0;
  8422. te[ 1 ] = 0; te[ 5 ] = y; te[ 9 ] = b; te[ 13 ] = 0;
  8423. te[ 2 ] = 0; te[ 6 ] = 0; te[ 10 ] = c; te[ 14 ] = d;
  8424. te[ 3 ] = 0; te[ 7 ] = 0; te[ 11 ] = -1; te[ 15 ] = 0;
  8425. return this;
  8426. }
  8427. /**
  8428. * Creates a orthographic projection matrix. This is used internally by
  8429. * {@link OrthographicCamera#updateProjectionMatrix}.
  8430. * @param {number} left - Left boundary of the viewing frustum at the near plane.
  8431. * @param {number} right - Right boundary of the viewing frustum at the near plane.
  8432. * @param {number} top - Top boundary of the viewing frustum at the near plane.
  8433. * @param {number} bottom - Bottom boundary of the viewing frustum at the near plane.
  8434. * @param {number} near - The distance from the camera to the near plane.
  8435. * @param {number} far - The distance from the camera to the far plane.
  8436. * @param {(WebGLCoordinateSystem|WebGPUCoordinateSystem)} [coordinateSystem=WebGLCoordinateSystem] - The coordinate system.
  8437. * @param {boolean} [reversedDepth=false] - Whether to use a reversed depth.
  8438. * @return {Matrix4} A reference to this matrix.
  8439. */
  8440. makeOrthographic( left, right, top, bottom, near, far, coordinateSystem = WebGLCoordinateSystem, reversedDepth = false ) {
  8441. const te = this.elements;
  8442. const x = 2 / ( right - left );
  8443. const y = 2 / ( top - bottom );
  8444. const a = - ( right + left ) / ( right - left );
  8445. const b = - ( top + bottom ) / ( top - bottom );
  8446. let c, d;
  8447. if ( reversedDepth ) {
  8448. c = 1 / ( far - near );
  8449. d = far / ( far - near );
  8450. } else {
  8451. if ( coordinateSystem === WebGLCoordinateSystem ) {
  8452. c = -2 / ( far - near );
  8453. d = - ( far + near ) / ( far - near );
  8454. } else if ( coordinateSystem === WebGPUCoordinateSystem ) {
  8455. c = -1 / ( far - near );
  8456. d = - near / ( far - near );
  8457. } else {
  8458. throw new Error( 'THREE.Matrix4.makeOrthographic(): Invalid coordinate system: ' + coordinateSystem );
  8459. }
  8460. }
  8461. te[ 0 ] = x; te[ 4 ] = 0; te[ 8 ] = 0; te[ 12 ] = a;
  8462. te[ 1 ] = 0; te[ 5 ] = y; te[ 9 ] = 0; te[ 13 ] = b;
  8463. te[ 2 ] = 0; te[ 6 ] = 0; te[ 10 ] = c; te[ 14 ] = d;
  8464. te[ 3 ] = 0; te[ 7 ] = 0; te[ 11 ] = 0; te[ 15 ] = 1;
  8465. return this;
  8466. }
  8467. /**
  8468. * Returns `true` if this matrix is equal with the given one.
  8469. *
  8470. * @param {Matrix4} matrix - The matrix to test for equality.
  8471. * @return {boolean} Whether this matrix is equal with the given one.
  8472. */
  8473. equals( matrix ) {
  8474. const te = this.elements;
  8475. const me = matrix.elements;
  8476. for ( let i = 0; i < 16; i ++ ) {
  8477. if ( te[ i ] !== me[ i ] ) return false;
  8478. }
  8479. return true;
  8480. }
  8481. /**
  8482. * Sets the elements of the matrix from the given array.
  8483. *
  8484. * @param {Array<number>} array - The matrix elements in column-major order.
  8485. * @param {number} [offset=0] - Index of the first element in the array.
  8486. * @return {Matrix4} A reference to this matrix.
  8487. */
  8488. fromArray( array, offset = 0 ) {
  8489. for ( let i = 0; i < 16; i ++ ) {
  8490. this.elements[ i ] = array[ i + offset ];
  8491. }
  8492. return this;
  8493. }
  8494. /**
  8495. * Writes the elements of this matrix to the given array. If no array is provided,
  8496. * the method returns a new instance.
  8497. *
  8498. * @param {Array<number>} [array=[]] - The target array holding the matrix elements in column-major order.
  8499. * @param {number} [offset=0] - Index of the first element in the array.
  8500. * @return {Array<number>} The matrix elements in column-major order.
  8501. */
  8502. toArray( array = [], offset = 0 ) {
  8503. const te = this.elements;
  8504. array[ offset ] = te[ 0 ];
  8505. array[ offset + 1 ] = te[ 1 ];
  8506. array[ offset + 2 ] = te[ 2 ];
  8507. array[ offset + 3 ] = te[ 3 ];
  8508. array[ offset + 4 ] = te[ 4 ];
  8509. array[ offset + 5 ] = te[ 5 ];
  8510. array[ offset + 6 ] = te[ 6 ];
  8511. array[ offset + 7 ] = te[ 7 ];
  8512. array[ offset + 8 ] = te[ 8 ];
  8513. array[ offset + 9 ] = te[ 9 ];
  8514. array[ offset + 10 ] = te[ 10 ];
  8515. array[ offset + 11 ] = te[ 11 ];
  8516. array[ offset + 12 ] = te[ 12 ];
  8517. array[ offset + 13 ] = te[ 13 ];
  8518. array[ offset + 14 ] = te[ 14 ];
  8519. array[ offset + 15 ] = te[ 15 ];
  8520. return array;
  8521. }
  8522. }
  8523. const _v1$7 = /*@__PURE__*/ new Vector3();
  8524. const _m1$2 = /*@__PURE__*/ new Matrix4();
  8525. const _zero = /*@__PURE__*/ new Vector3( 0, 0, 0 );
  8526. const _one = /*@__PURE__*/ new Vector3( 1, 1, 1 );
  8527. const _x = /*@__PURE__*/ new Vector3();
  8528. const _y = /*@__PURE__*/ new Vector3();
  8529. const _z = /*@__PURE__*/ new Vector3();
  8530. const _matrix$2 = /*@__PURE__*/ new Matrix4();
  8531. const _quaternion$4 = /*@__PURE__*/ new Quaternion();
  8532. /**
  8533. * A class representing Euler angles.
  8534. *
  8535. * Euler angles describe a rotational transformation by rotating an object on
  8536. * its various axes in specified amounts per axis, and a specified axis
  8537. * order.
  8538. *
  8539. * Iterating through an instance will yield its components (x, y, z,
  8540. * order) in the corresponding order.
  8541. *
  8542. * ```js
  8543. * const a = new THREE.Euler( 0, 1, 1.57, 'XYZ' );
  8544. * const b = new THREE.Vector3( 1, 0, 1 );
  8545. * b.applyEuler(a);
  8546. * ```
  8547. */
  8548. class Euler {
  8549. /**
  8550. * Constructs a new euler instance.
  8551. *
  8552. * @param {number} [x=0] - The angle of the x axis in radians.
  8553. * @param {number} [y=0] - The angle of the y axis in radians.
  8554. * @param {number} [z=0] - The angle of the z axis in radians.
  8555. * @param {string} [order=Euler.DEFAULT_ORDER] - A string representing the order that the rotations are applied.
  8556. */
  8557. constructor( x = 0, y = 0, z = 0, order = Euler.DEFAULT_ORDER ) {
  8558. /**
  8559. * This flag can be used for type testing.
  8560. *
  8561. * @type {boolean}
  8562. * @readonly
  8563. * @default true
  8564. */
  8565. this.isEuler = true;
  8566. this._x = x;
  8567. this._y = y;
  8568. this._z = z;
  8569. this._order = order;
  8570. }
  8571. /**
  8572. * The angle of the x axis in radians.
  8573. *
  8574. * @type {number}
  8575. * @default 0
  8576. */
  8577. get x() {
  8578. return this._x;
  8579. }
  8580. set x( value ) {
  8581. this._x = value;
  8582. this._onChangeCallback();
  8583. }
  8584. /**
  8585. * The angle of the y axis in radians.
  8586. *
  8587. * @type {number}
  8588. * @default 0
  8589. */
  8590. get y() {
  8591. return this._y;
  8592. }
  8593. set y( value ) {
  8594. this._y = value;
  8595. this._onChangeCallback();
  8596. }
  8597. /**
  8598. * The angle of the z axis in radians.
  8599. *
  8600. * @type {number}
  8601. * @default 0
  8602. */
  8603. get z() {
  8604. return this._z;
  8605. }
  8606. set z( value ) {
  8607. this._z = value;
  8608. this._onChangeCallback();
  8609. }
  8610. /**
  8611. * A string representing the order that the rotations are applied.
  8612. *
  8613. * @type {string}
  8614. * @default 'XYZ'
  8615. */
  8616. get order() {
  8617. return this._order;
  8618. }
  8619. set order( value ) {
  8620. this._order = value;
  8621. this._onChangeCallback();
  8622. }
  8623. /**
  8624. * Sets the Euler components.
  8625. *
  8626. * @param {number} x - The angle of the x axis in radians.
  8627. * @param {number} y - The angle of the y axis in radians.
  8628. * @param {number} z - The angle of the z axis in radians.
  8629. * @param {string} [order] - A string representing the order that the rotations are applied.
  8630. * @return {Euler} A reference to this Euler instance.
  8631. */
  8632. set( x, y, z, order = this._order ) {
  8633. this._x = x;
  8634. this._y = y;
  8635. this._z = z;
  8636. this._order = order;
  8637. this._onChangeCallback();
  8638. return this;
  8639. }
  8640. /**
  8641. * Returns a new Euler instance with copied values from this instance.
  8642. *
  8643. * @return {Euler} A clone of this instance.
  8644. */
  8645. clone() {
  8646. return new this.constructor( this._x, this._y, this._z, this._order );
  8647. }
  8648. /**
  8649. * Copies the values of the given Euler instance to this instance.
  8650. *
  8651. * @param {Euler} euler - The Euler instance to copy.
  8652. * @return {Euler} A reference to this Euler instance.
  8653. */
  8654. copy( euler ) {
  8655. this._x = euler._x;
  8656. this._y = euler._y;
  8657. this._z = euler._z;
  8658. this._order = euler._order;
  8659. this._onChangeCallback();
  8660. return this;
  8661. }
  8662. /**
  8663. * Sets the angles of this Euler instance from a pure rotation matrix.
  8664. *
  8665. * @param {Matrix4} m - A 4x4 matrix of which the upper 3x3 of matrix is a pure rotation matrix (i.e. unscaled).
  8666. * @param {string} [order] - A string representing the order that the rotations are applied.
  8667. * @param {boolean} [update=true] - Whether the internal `onChange` callback should be executed or not.
  8668. * @return {Euler} A reference to this Euler instance.
  8669. */
  8670. setFromRotationMatrix( m, order = this._order, update = true ) {
  8671. const te = m.elements;
  8672. const m11 = te[ 0 ], m12 = te[ 4 ], m13 = te[ 8 ];
  8673. const m21 = te[ 1 ], m22 = te[ 5 ], m23 = te[ 9 ];
  8674. const m31 = te[ 2 ], m32 = te[ 6 ], m33 = te[ 10 ];
  8675. switch ( order ) {
  8676. case 'XYZ':
  8677. this._y = Math.asin( clamp( m13, -1, 1 ) );
  8678. if ( Math.abs( m13 ) < 0.9999999 ) {
  8679. this._x = Math.atan2( - m23, m33 );
  8680. this._z = Math.atan2( - m12, m11 );
  8681. } else {
  8682. this._x = Math.atan2( m32, m22 );
  8683. this._z = 0;
  8684. }
  8685. break;
  8686. case 'YXZ':
  8687. this._x = Math.asin( - clamp( m23, -1, 1 ) );
  8688. if ( Math.abs( m23 ) < 0.9999999 ) {
  8689. this._y = Math.atan2( m13, m33 );
  8690. this._z = Math.atan2( m21, m22 );
  8691. } else {
  8692. this._y = Math.atan2( - m31, m11 );
  8693. this._z = 0;
  8694. }
  8695. break;
  8696. case 'ZXY':
  8697. this._x = Math.asin( clamp( m32, -1, 1 ) );
  8698. if ( Math.abs( m32 ) < 0.9999999 ) {
  8699. this._y = Math.atan2( - m31, m33 );
  8700. this._z = Math.atan2( - m12, m22 );
  8701. } else {
  8702. this._y = 0;
  8703. this._z = Math.atan2( m21, m11 );
  8704. }
  8705. break;
  8706. case 'ZYX':
  8707. this._y = Math.asin( - clamp( m31, -1, 1 ) );
  8708. if ( Math.abs( m31 ) < 0.9999999 ) {
  8709. this._x = Math.atan2( m32, m33 );
  8710. this._z = Math.atan2( m21, m11 );
  8711. } else {
  8712. this._x = 0;
  8713. this._z = Math.atan2( - m12, m22 );
  8714. }
  8715. break;
  8716. case 'YZX':
  8717. this._z = Math.asin( clamp( m21, -1, 1 ) );
  8718. if ( Math.abs( m21 ) < 0.9999999 ) {
  8719. this._x = Math.atan2( - m23, m22 );
  8720. this._y = Math.atan2( - m31, m11 );
  8721. } else {
  8722. this._x = 0;
  8723. this._y = Math.atan2( m13, m33 );
  8724. }
  8725. break;
  8726. case 'XZY':
  8727. this._z = Math.asin( - clamp( m12, -1, 1 ) );
  8728. if ( Math.abs( m12 ) < 0.9999999 ) {
  8729. this._x = Math.atan2( m32, m22 );
  8730. this._y = Math.atan2( m13, m11 );
  8731. } else {
  8732. this._x = Math.atan2( - m23, m33 );
  8733. this._y = 0;
  8734. }
  8735. break;
  8736. default:
  8737. warn( 'Euler: .setFromRotationMatrix() encountered an unknown order: ' + order );
  8738. }
  8739. this._order = order;
  8740. if ( update === true ) this._onChangeCallback();
  8741. return this;
  8742. }
  8743. /**
  8744. * Sets the angles of this Euler instance from a normalized quaternion.
  8745. *
  8746. * @param {Quaternion} q - A normalized Quaternion.
  8747. * @param {string} [order] - A string representing the order that the rotations are applied.
  8748. * @param {boolean} [update=true] - Whether the internal `onChange` callback should be executed or not.
  8749. * @return {Euler} A reference to this Euler instance.
  8750. */
  8751. setFromQuaternion( q, order, update ) {
  8752. _matrix$2.makeRotationFromQuaternion( q );
  8753. return this.setFromRotationMatrix( _matrix$2, order, update );
  8754. }
  8755. /**
  8756. * Sets the angles of this Euler instance from the given vector.
  8757. *
  8758. * @param {Vector3} v - The vector.
  8759. * @param {string} [order] - A string representing the order that the rotations are applied.
  8760. * @return {Euler} A reference to this Euler instance.
  8761. */
  8762. setFromVector3( v, order = this._order ) {
  8763. return this.set( v.x, v.y, v.z, order );
  8764. }
  8765. /**
  8766. * Resets the euler angle with a new order by creating a quaternion from this
  8767. * euler angle and then setting this euler angle with the quaternion and the
  8768. * new order.
  8769. *
  8770. * Warning: This discards revolution information.
  8771. *
  8772. * @param {string} [newOrder] - A string representing the new order that the rotations are applied.
  8773. * @return {Euler} A reference to this Euler instance.
  8774. */
  8775. reorder( newOrder ) {
  8776. _quaternion$4.setFromEuler( this );
  8777. return this.setFromQuaternion( _quaternion$4, newOrder );
  8778. }
  8779. /**
  8780. * Returns `true` if this Euler instance is equal with the given one.
  8781. *
  8782. * @param {Euler} euler - The Euler instance to test for equality.
  8783. * @return {boolean} Whether this Euler instance is equal with the given one.
  8784. */
  8785. equals( euler ) {
  8786. return ( euler._x === this._x ) && ( euler._y === this._y ) && ( euler._z === this._z ) && ( euler._order === this._order );
  8787. }
  8788. /**
  8789. * Sets this Euler instance's components to values from the given array. The first three
  8790. * entries of the array are assign to the x,y and z components. An optional fourth entry
  8791. * defines the Euler order.
  8792. *
  8793. * @param {Array<number,number,number,?string>} array - An array holding the Euler component values.
  8794. * @return {Euler} A reference to this Euler instance.
  8795. */
  8796. fromArray( array ) {
  8797. this._x = array[ 0 ];
  8798. this._y = array[ 1 ];
  8799. this._z = array[ 2 ];
  8800. if ( array[ 3 ] !== undefined ) this._order = array[ 3 ];
  8801. this._onChangeCallback();
  8802. return this;
  8803. }
  8804. /**
  8805. * Writes the components of this Euler instance to the given array. If no array is provided,
  8806. * the method returns a new instance.
  8807. *
  8808. * @param {Array<number,number,number,string>} [array=[]] - The target array holding the Euler components.
  8809. * @param {number} [offset=0] - Index of the first element in the array.
  8810. * @return {Array<number,number,number,string>} The Euler components.
  8811. */
  8812. toArray( array = [], offset = 0 ) {
  8813. array[ offset ] = this._x;
  8814. array[ offset + 1 ] = this._y;
  8815. array[ offset + 2 ] = this._z;
  8816. array[ offset + 3 ] = this._order;
  8817. return array;
  8818. }
  8819. _onChange( callback ) {
  8820. this._onChangeCallback = callback;
  8821. return this;
  8822. }
  8823. _onChangeCallback() {}
  8824. *[ Symbol.iterator ]() {
  8825. yield this._x;
  8826. yield this._y;
  8827. yield this._z;
  8828. yield this._order;
  8829. }
  8830. }
  8831. /**
  8832. * The default Euler angle order.
  8833. *
  8834. * @static
  8835. * @type {string}
  8836. * @default 'XYZ'
  8837. */
  8838. Euler.DEFAULT_ORDER = 'XYZ';
  8839. /**
  8840. * A layers object assigns an 3D object to 1 or more of 32
  8841. * layers numbered `0` to `31` - internally the layers are stored as a
  8842. * bit mask], and by default all 3D objects are a member of layer `0`.
  8843. *
  8844. * This can be used to control visibility - an object must share a layer with
  8845. * a camera to be visible when that camera's view is
  8846. * rendered.
  8847. *
  8848. * All classes that inherit from {@link Object3D} have an `layers` property which
  8849. * is an instance of this class.
  8850. */
  8851. class Layers {
  8852. /**
  8853. * Constructs a new layers instance, with membership
  8854. * initially set to layer `0`.
  8855. */
  8856. constructor() {
  8857. /**
  8858. * A bit mask storing which of the 32 layers this layers object is currently
  8859. * a member of.
  8860. *
  8861. * @type {number}
  8862. */
  8863. this.mask = 1 | 0;
  8864. }
  8865. /**
  8866. * Sets membership to the given layer, and remove membership all other layers.
  8867. *
  8868. * @param {number} layer - The layer to set.
  8869. */
  8870. set( layer ) {
  8871. this.mask = ( 1 << layer | 0 ) >>> 0;
  8872. }
  8873. /**
  8874. * Adds membership of the given layer.
  8875. *
  8876. * @param {number} layer - The layer to enable.
  8877. */
  8878. enable( layer ) {
  8879. this.mask |= 1 << layer | 0;
  8880. }
  8881. /**
  8882. * Adds membership to all layers.
  8883. */
  8884. enableAll() {
  8885. this.mask = 0xffffffff | 0;
  8886. }
  8887. /**
  8888. * Toggles the membership of the given layer.
  8889. *
  8890. * @param {number} layer - The layer to toggle.
  8891. */
  8892. toggle( layer ) {
  8893. this.mask ^= 1 << layer | 0;
  8894. }
  8895. /**
  8896. * Removes membership of the given layer.
  8897. *
  8898. * @param {number} layer - The layer to enable.
  8899. */
  8900. disable( layer ) {
  8901. this.mask &= ~ ( 1 << layer | 0 );
  8902. }
  8903. /**
  8904. * Removes the membership from all layers.
  8905. */
  8906. disableAll() {
  8907. this.mask = 0;
  8908. }
  8909. /**
  8910. * Returns `true` if this and the given layers object have at least one
  8911. * layer in common.
  8912. *
  8913. * @param {Layers} layers - The layers to test.
  8914. * @return {boolean } Whether this and the given layers object have at least one layer in common or not.
  8915. */
  8916. test( layers ) {
  8917. return ( this.mask & layers.mask ) !== 0;
  8918. }
  8919. /**
  8920. * Returns `true` if the given layer is enabled.
  8921. *
  8922. * @param {number} layer - The layer to test.
  8923. * @return {boolean } Whether the given layer is enabled or not.
  8924. */
  8925. isEnabled( layer ) {
  8926. return ( this.mask & ( 1 << layer | 0 ) ) !== 0;
  8927. }
  8928. }
  8929. let _object3DId = 0;
  8930. const _v1$6 = /*@__PURE__*/ new Vector3();
  8931. const _q1 = /*@__PURE__*/ new Quaternion();
  8932. const _m1$1 = /*@__PURE__*/ new Matrix4();
  8933. const _target = /*@__PURE__*/ new Vector3();
  8934. const _position$4 = /*@__PURE__*/ new Vector3();
  8935. const _scale$3 = /*@__PURE__*/ new Vector3();
  8936. const _quaternion$3 = /*@__PURE__*/ new Quaternion();
  8937. const _xAxis = /*@__PURE__*/ new Vector3( 1, 0, 0 );
  8938. const _yAxis = /*@__PURE__*/ new Vector3( 0, 1, 0 );
  8939. const _zAxis = /*@__PURE__*/ new Vector3( 0, 0, 1 );
  8940. /**
  8941. * Fires when the object has been added to its parent object.
  8942. *
  8943. * @event Object3D#added
  8944. * @type {Object}
  8945. */
  8946. const _addedEvent = { type: 'added' };
  8947. /**
  8948. * Fires when the object has been removed from its parent object.
  8949. *
  8950. * @event Object3D#removed
  8951. * @type {Object}
  8952. */
  8953. const _removedEvent = { type: 'removed' };
  8954. /**
  8955. * Fires when a new child object has been added.
  8956. *
  8957. * @event Object3D#childadded
  8958. * @type {Object}
  8959. */
  8960. const _childaddedEvent = { type: 'childadded', child: null };
  8961. /**
  8962. * Fires when a child object has been removed.
  8963. *
  8964. * @event Object3D#childremoved
  8965. * @type {Object}
  8966. */
  8967. const _childremovedEvent = { type: 'childremoved', child: null };
  8968. /**
  8969. * This is the base class for most objects in three.js and provides a set of
  8970. * properties and methods for manipulating objects in 3D space.
  8971. *
  8972. * @augments EventDispatcher
  8973. */
  8974. class Object3D extends EventDispatcher {
  8975. /**
  8976. * Constructs a new 3D object.
  8977. */
  8978. constructor() {
  8979. super();
  8980. /**
  8981. * This flag can be used for type testing.
  8982. *
  8983. * @type {boolean}
  8984. * @readonly
  8985. * @default true
  8986. */
  8987. this.isObject3D = true;
  8988. /**
  8989. * The ID of the 3D object.
  8990. *
  8991. * @name Object3D#id
  8992. * @type {number}
  8993. * @readonly
  8994. */
  8995. Object.defineProperty( this, 'id', { value: _object3DId ++ } );
  8996. /**
  8997. * The UUID of the 3D object.
  8998. *
  8999. * @type {string}
  9000. * @readonly
  9001. */
  9002. this.uuid = generateUUID();
  9003. /**
  9004. * The name of the 3D object.
  9005. *
  9006. * @type {string}
  9007. */
  9008. this.name = '';
  9009. /**
  9010. * The type property is used for detecting the object type
  9011. * in context of serialization/deserialization.
  9012. *
  9013. * @type {string}
  9014. * @readonly
  9015. */
  9016. this.type = 'Object3D';
  9017. /**
  9018. * A reference to the parent object.
  9019. *
  9020. * @type {?Object3D}
  9021. * @default null
  9022. */
  9023. this.parent = null;
  9024. /**
  9025. * An array holding the child 3D objects of this instance.
  9026. *
  9027. * @type {Array<Object3D>}
  9028. */
  9029. this.children = [];
  9030. /**
  9031. * Defines the `up` direction of the 3D object which influences
  9032. * the orientation via methods like {@link Object3D#lookAt}.
  9033. *
  9034. * The default values for all 3D objects is defined by `Object3D.DEFAULT_UP`.
  9035. *
  9036. * @type {Vector3}
  9037. */
  9038. this.up = Object3D.DEFAULT_UP.clone();
  9039. const position = new Vector3();
  9040. const rotation = new Euler();
  9041. const quaternion = new Quaternion();
  9042. const scale = new Vector3( 1, 1, 1 );
  9043. function onRotationChange() {
  9044. quaternion.setFromEuler( rotation, false );
  9045. }
  9046. function onQuaternionChange() {
  9047. rotation.setFromQuaternion( quaternion, undefined, false );
  9048. }
  9049. rotation._onChange( onRotationChange );
  9050. quaternion._onChange( onQuaternionChange );
  9051. Object.defineProperties( this, {
  9052. /**
  9053. * Represents the object's local position.
  9054. *
  9055. * @name Object3D#position
  9056. * @type {Vector3}
  9057. * @default (0,0,0)
  9058. */
  9059. position: {
  9060. configurable: true,
  9061. enumerable: true,
  9062. value: position
  9063. },
  9064. /**
  9065. * Represents the object's local rotation as Euler angles, in radians.
  9066. *
  9067. * @name Object3D#rotation
  9068. * @type {Euler}
  9069. * @default (0,0,0)
  9070. */
  9071. rotation: {
  9072. configurable: true,
  9073. enumerable: true,
  9074. value: rotation
  9075. },
  9076. /**
  9077. * Represents the object's local rotation as Quaternions.
  9078. *
  9079. * @name Object3D#quaternion
  9080. * @type {Quaternion}
  9081. */
  9082. quaternion: {
  9083. configurable: true,
  9084. enumerable: true,
  9085. value: quaternion
  9086. },
  9087. /**
  9088. * Represents the object's local scale.
  9089. *
  9090. * @name Object3D#scale
  9091. * @type {Vector3}
  9092. * @default (1,1,1)
  9093. */
  9094. scale: {
  9095. configurable: true,
  9096. enumerable: true,
  9097. value: scale
  9098. },
  9099. /**
  9100. * Represents the object's model-view matrix.
  9101. *
  9102. * @name Object3D#modelViewMatrix
  9103. * @type {Matrix4}
  9104. */
  9105. modelViewMatrix: {
  9106. value: new Matrix4()
  9107. },
  9108. /**
  9109. * Represents the object's normal matrix.
  9110. *
  9111. * @name Object3D#normalMatrix
  9112. * @type {Matrix3}
  9113. */
  9114. normalMatrix: {
  9115. value: new Matrix3()
  9116. }
  9117. } );
  9118. /**
  9119. * Represents the object's transformation matrix in local space.
  9120. *
  9121. * @type {Matrix4}
  9122. */
  9123. this.matrix = new Matrix4();
  9124. /**
  9125. * Represents the object's transformation matrix in world space.
  9126. * If the 3D object has no parent, then it's identical to the local transformation matrix
  9127. *
  9128. * @type {Matrix4}
  9129. */
  9130. this.matrixWorld = new Matrix4();
  9131. /**
  9132. * When set to `true`, the engine automatically computes the local matrix from position,
  9133. * rotation and scale every frame. If set to `false`, the app is responsible for recomputing
  9134. * the local matrix by calling `updateMatrix()`.
  9135. *
  9136. * The default values for all 3D objects is defined by `Object3D.DEFAULT_MATRIX_AUTO_UPDATE`.
  9137. *
  9138. * @type {boolean}
  9139. * @default true
  9140. */
  9141. this.matrixAutoUpdate = Object3D.DEFAULT_MATRIX_AUTO_UPDATE;
  9142. /**
  9143. * When set to `true`, the engine automatically computes the world matrix from the current local
  9144. * matrix and the object's transformation hierarchy. If set to `false`, the app is responsible for
  9145. * recomputing the world matrix by directly updating the `matrixWorld` property.
  9146. *
  9147. * The default values for all 3D objects is defined by `Object3D.DEFAULT_MATRIX_WORLD_AUTO_UPDATE`.
  9148. *
  9149. * @type {boolean}
  9150. * @default true
  9151. */
  9152. this.matrixWorldAutoUpdate = Object3D.DEFAULT_MATRIX_WORLD_AUTO_UPDATE; // checked by the renderer
  9153. /**
  9154. * When set to `true`, it calculates the world matrix in that frame and resets this property
  9155. * to `false`.
  9156. *
  9157. * @type {boolean}
  9158. * @default false
  9159. */
  9160. this.matrixWorldNeedsUpdate = false;
  9161. /**
  9162. * The layer membership of the 3D object. The 3D object is only visible if it has
  9163. * at least one layer in common with the camera in use. This property can also be
  9164. * used to filter out unwanted objects in ray-intersection tests when using {@link Raycaster}.
  9165. *
  9166. * @type {Layers}
  9167. */
  9168. this.layers = new Layers();
  9169. /**
  9170. * When set to `true`, the 3D object gets rendered.
  9171. *
  9172. * @type {boolean}
  9173. * @default true
  9174. */
  9175. this.visible = true;
  9176. /**
  9177. * When set to `true`, the 3D object gets rendered into shadow maps.
  9178. *
  9179. * @type {boolean}
  9180. * @default false
  9181. */
  9182. this.castShadow = false;
  9183. /**
  9184. * When set to `true`, the 3D object is affected by shadows in the scene.
  9185. *
  9186. * @type {boolean}
  9187. * @default false
  9188. */
  9189. this.receiveShadow = false;
  9190. /**
  9191. * When set to `true`, the 3D object is honored by view frustum culling.
  9192. *
  9193. * @type {boolean}
  9194. * @default true
  9195. */
  9196. this.frustumCulled = true;
  9197. /**
  9198. * This value allows the default rendering order of scene graph objects to be
  9199. * overridden although opaque and transparent objects remain sorted independently.
  9200. * When this property is set for an instance of {@link Group},all descendants
  9201. * objects will be sorted and rendered together. Sorting is from lowest to highest
  9202. * render order.
  9203. *
  9204. * @type {number}
  9205. * @default 0
  9206. */
  9207. this.renderOrder = 0;
  9208. /**
  9209. * An array holding the animation clips of the 3D object.
  9210. *
  9211. * @type {Array<AnimationClip>}
  9212. */
  9213. this.animations = [];
  9214. /**
  9215. * Custom depth material to be used when rendering to the depth map. Can only be used
  9216. * in context of meshes. When shadow-casting with a {@link DirectionalLight} or {@link SpotLight},
  9217. * if you are modifying vertex positions in the vertex shader you must specify a custom depth
  9218. * material for proper shadows.
  9219. *
  9220. * Only relevant in context of {@link WebGLRenderer}.
  9221. *
  9222. * @type {(Material|undefined)}
  9223. * @default undefined
  9224. */
  9225. this.customDepthMaterial = undefined;
  9226. /**
  9227. * Same as {@link Object3D#customDepthMaterial}, but used with {@link PointLight}.
  9228. *
  9229. * Only relevant in context of {@link WebGLRenderer}.
  9230. *
  9231. * @type {(Material|undefined)}
  9232. * @default undefined
  9233. */
  9234. this.customDistanceMaterial = undefined;
  9235. /**
  9236. * Whether the 3D object is supposed to be static or not. If set to `true`, it means
  9237. * the 3D object is not going to be changed after the initial renderer. This includes
  9238. * geometry and material settings. A static 3D object can be processed by the renderer
  9239. * slightly faster since certain state checks can be bypassed.
  9240. *
  9241. * Only relevant in context of {@link WebGPURenderer}.
  9242. *
  9243. * @type {boolean}
  9244. * @default false
  9245. */
  9246. this.static = false;
  9247. /**
  9248. * An object that can be used to store custom data about the 3D object. It
  9249. * should not hold references to functions as these will not be cloned.
  9250. *
  9251. * @type {Object}
  9252. */
  9253. this.userData = {};
  9254. /**
  9255. * The pivot point for rotation and scale transformations.
  9256. * When set, rotation and scale are applied around this point
  9257. * instead of the object's origin.
  9258. *
  9259. * @type {?Vector3}
  9260. * @default null
  9261. */
  9262. this.pivot = null;
  9263. }
  9264. /**
  9265. * A callback that is executed immediately before a 3D object is rendered to a shadow map.
  9266. *
  9267. * @param {Renderer|WebGLRenderer} renderer - The renderer.
  9268. * @param {Object3D} object - The 3D object.
  9269. * @param {Camera} camera - The camera that is used to render the scene.
  9270. * @param {Camera} shadowCamera - The shadow camera.
  9271. * @param {BufferGeometry} geometry - The 3D object's geometry.
  9272. * @param {Material} depthMaterial - The depth material.
  9273. * @param {Object} group - The geometry group data.
  9274. */
  9275. onBeforeShadow( /* renderer, object, camera, shadowCamera, geometry, depthMaterial, group */ ) {}
  9276. /**
  9277. * A callback that is executed immediately after a 3D object is rendered to a shadow map.
  9278. *
  9279. * @param {Renderer|WebGLRenderer} renderer - The renderer.
  9280. * @param {Object3D} object - The 3D object.
  9281. * @param {Camera} camera - The camera that is used to render the scene.
  9282. * @param {Camera} shadowCamera - The shadow camera.
  9283. * @param {BufferGeometry} geometry - The 3D object's geometry.
  9284. * @param {Material} depthMaterial - The depth material.
  9285. * @param {Object} group - The geometry group data.
  9286. */
  9287. onAfterShadow( /* renderer, object, camera, shadowCamera, geometry, depthMaterial, group */ ) {}
  9288. /**
  9289. * A callback that is executed immediately before a 3D object is rendered.
  9290. *
  9291. * @param {Renderer|WebGLRenderer} renderer - The renderer.
  9292. * @param {Object3D} object - The 3D object.
  9293. * @param {Camera} camera - The camera that is used to render the scene.
  9294. * @param {BufferGeometry} geometry - The 3D object's geometry.
  9295. * @param {Material} material - The 3D object's material.
  9296. * @param {Object} group - The geometry group data.
  9297. */
  9298. onBeforeRender( /* renderer, scene, camera, geometry, material, group */ ) {}
  9299. /**
  9300. * A callback that is executed immediately after a 3D object is rendered.
  9301. *
  9302. * @param {Renderer|WebGLRenderer} renderer - The renderer.
  9303. * @param {Object3D} object - The 3D object.
  9304. * @param {Camera} camera - The camera that is used to render the scene.
  9305. * @param {BufferGeometry} geometry - The 3D object's geometry.
  9306. * @param {Material} material - The 3D object's material.
  9307. * @param {Object} group - The geometry group data.
  9308. */
  9309. onAfterRender( /* renderer, scene, camera, geometry, material, group */ ) {}
  9310. /**
  9311. * Applies the given transformation matrix to the object and updates the object's position,
  9312. * rotation and scale.
  9313. *
  9314. * @param {Matrix4} matrix - The transformation matrix.
  9315. */
  9316. applyMatrix4( matrix ) {
  9317. if ( this.matrixAutoUpdate ) this.updateMatrix();
  9318. this.matrix.premultiply( matrix );
  9319. this.matrix.decompose( this.position, this.quaternion, this.scale );
  9320. }
  9321. /**
  9322. * Applies a rotation represented by given the quaternion to the 3D object.
  9323. *
  9324. * @param {Quaternion} q - The quaternion.
  9325. * @return {Object3D} A reference to this instance.
  9326. */
  9327. applyQuaternion( q ) {
  9328. this.quaternion.premultiply( q );
  9329. return this;
  9330. }
  9331. /**
  9332. * Sets the given rotation represented as an axis/angle couple to the 3D object.
  9333. *
  9334. * @param {Vector3} axis - The (normalized) axis vector.
  9335. * @param {number} angle - The angle in radians.
  9336. */
  9337. setRotationFromAxisAngle( axis, angle ) {
  9338. // assumes axis is normalized
  9339. this.quaternion.setFromAxisAngle( axis, angle );
  9340. }
  9341. /**
  9342. * Sets the given rotation represented as Euler angles to the 3D object.
  9343. *
  9344. * @param {Euler} euler - The Euler angles.
  9345. */
  9346. setRotationFromEuler( euler ) {
  9347. this.quaternion.setFromEuler( euler, true );
  9348. }
  9349. /**
  9350. * Sets the given rotation represented as rotation matrix to the 3D object.
  9351. *
  9352. * @param {Matrix4} m - Although a 4x4 matrix is expected, the upper 3x3 portion must be
  9353. * a pure rotation matrix (i.e, unscaled).
  9354. */
  9355. setRotationFromMatrix( m ) {
  9356. // assumes the upper 3x3 of m is a pure rotation matrix (i.e, unscaled)
  9357. this.quaternion.setFromRotationMatrix( m );
  9358. }
  9359. /**
  9360. * Sets the given rotation represented as a Quaternion to the 3D object.
  9361. *
  9362. * @param {Quaternion} q - The Quaternion
  9363. */
  9364. setRotationFromQuaternion( q ) {
  9365. // assumes q is normalized
  9366. this.quaternion.copy( q );
  9367. }
  9368. /**
  9369. * Rotates the 3D object along an axis in local space.
  9370. *
  9371. * @param {Vector3} axis - The (normalized) axis vector.
  9372. * @param {number} angle - The angle in radians.
  9373. * @return {Object3D} A reference to this instance.
  9374. */
  9375. rotateOnAxis( axis, angle ) {
  9376. // rotate object on axis in object space
  9377. // axis is assumed to be normalized
  9378. _q1.setFromAxisAngle( axis, angle );
  9379. this.quaternion.multiply( _q1 );
  9380. return this;
  9381. }
  9382. /**
  9383. * Rotates the 3D object along an axis in world space.
  9384. *
  9385. * @param {Vector3} axis - The (normalized) axis vector.
  9386. * @param {number} angle - The angle in radians.
  9387. * @return {Object3D} A reference to this instance.
  9388. */
  9389. rotateOnWorldAxis( axis, angle ) {
  9390. // rotate object on axis in world space
  9391. // axis is assumed to be normalized
  9392. // method assumes no rotated parent
  9393. _q1.setFromAxisAngle( axis, angle );
  9394. this.quaternion.premultiply( _q1 );
  9395. return this;
  9396. }
  9397. /**
  9398. * Rotates the 3D object around its X axis in local space.
  9399. *
  9400. * @param {number} angle - The angle in radians.
  9401. * @return {Object3D} A reference to this instance.
  9402. */
  9403. rotateX( angle ) {
  9404. return this.rotateOnAxis( _xAxis, angle );
  9405. }
  9406. /**
  9407. * Rotates the 3D object around its Y axis in local space.
  9408. *
  9409. * @param {number} angle - The angle in radians.
  9410. * @return {Object3D} A reference to this instance.
  9411. */
  9412. rotateY( angle ) {
  9413. return this.rotateOnAxis( _yAxis, angle );
  9414. }
  9415. /**
  9416. * Rotates the 3D object around its Z axis in local space.
  9417. *
  9418. * @param {number} angle - The angle in radians.
  9419. * @return {Object3D} A reference to this instance.
  9420. */
  9421. rotateZ( angle ) {
  9422. return this.rotateOnAxis( _zAxis, angle );
  9423. }
  9424. /**
  9425. * Translate the 3D object by a distance along the given axis in local space.
  9426. *
  9427. * @param {Vector3} axis - The (normalized) axis vector.
  9428. * @param {number} distance - The distance in world units.
  9429. * @return {Object3D} A reference to this instance.
  9430. */
  9431. translateOnAxis( axis, distance ) {
  9432. // translate object by distance along axis in object space
  9433. // axis is assumed to be normalized
  9434. _v1$6.copy( axis ).applyQuaternion( this.quaternion );
  9435. this.position.add( _v1$6.multiplyScalar( distance ) );
  9436. return this;
  9437. }
  9438. /**
  9439. * Translate the 3D object by a distance along its X-axis in local space.
  9440. *
  9441. * @param {number} distance - The distance in world units.
  9442. * @return {Object3D} A reference to this instance.
  9443. */
  9444. translateX( distance ) {
  9445. return this.translateOnAxis( _xAxis, distance );
  9446. }
  9447. /**
  9448. * Translate the 3D object by a distance along its Y-axis in local space.
  9449. *
  9450. * @param {number} distance - The distance in world units.
  9451. * @return {Object3D} A reference to this instance.
  9452. */
  9453. translateY( distance ) {
  9454. return this.translateOnAxis( _yAxis, distance );
  9455. }
  9456. /**
  9457. * Translate the 3D object by a distance along its Z-axis in local space.
  9458. *
  9459. * @param {number} distance - The distance in world units.
  9460. * @return {Object3D} A reference to this instance.
  9461. */
  9462. translateZ( distance ) {
  9463. return this.translateOnAxis( _zAxis, distance );
  9464. }
  9465. /**
  9466. * Converts the given vector from this 3D object's local space to world space.
  9467. *
  9468. * @param {Vector3} vector - The vector to convert.
  9469. * @return {Vector3} The converted vector.
  9470. */
  9471. localToWorld( vector ) {
  9472. this.updateWorldMatrix( true, false );
  9473. return vector.applyMatrix4( this.matrixWorld );
  9474. }
  9475. /**
  9476. * Converts the given vector from this 3D object's world space to local space.
  9477. *
  9478. * @param {Vector3} vector - The vector to convert.
  9479. * @return {Vector3} The converted vector.
  9480. */
  9481. worldToLocal( vector ) {
  9482. this.updateWorldMatrix( true, false );
  9483. return vector.applyMatrix4( _m1$1.copy( this.matrixWorld ).invert() );
  9484. }
  9485. /**
  9486. * Rotates the object to face a point in world space.
  9487. *
  9488. * This method does not support objects having non-uniformly-scaled parent(s).
  9489. *
  9490. * @param {number|Vector3} x - The x coordinate in world space. Alternatively, a vector representing a position in world space
  9491. * @param {number} [y] - The y coordinate in world space.
  9492. * @param {number} [z] - The z coordinate in world space.
  9493. */
  9494. lookAt( x, y, z ) {
  9495. // This method does not support objects having non-uniformly-scaled parent(s)
  9496. if ( x.isVector3 ) {
  9497. _target.copy( x );
  9498. } else {
  9499. _target.set( x, y, z );
  9500. }
  9501. const parent = this.parent;
  9502. this.updateWorldMatrix( true, false );
  9503. _position$4.setFromMatrixPosition( this.matrixWorld );
  9504. if ( this.isCamera || this.isLight ) {
  9505. _m1$1.lookAt( _position$4, _target, this.up );
  9506. } else {
  9507. _m1$1.lookAt( _target, _position$4, this.up );
  9508. }
  9509. this.quaternion.setFromRotationMatrix( _m1$1 );
  9510. if ( parent ) {
  9511. _m1$1.extractRotation( parent.matrixWorld );
  9512. _q1.setFromRotationMatrix( _m1$1 );
  9513. this.quaternion.premultiply( _q1.invert() );
  9514. }
  9515. }
  9516. /**
  9517. * Adds the given 3D object as a child to this 3D object. An arbitrary number of
  9518. * objects may be added. Any current parent on an object passed in here will be
  9519. * removed, since an object can have at most one parent.
  9520. *
  9521. * @fires Object3D#added
  9522. * @fires Object3D#childadded
  9523. * @param {Object3D} object - The 3D object to add.
  9524. * @return {Object3D} A reference to this instance.
  9525. */
  9526. add( object ) {
  9527. if ( arguments.length > 1 ) {
  9528. for ( let i = 0; i < arguments.length; i ++ ) {
  9529. this.add( arguments[ i ] );
  9530. }
  9531. return this;
  9532. }
  9533. if ( object === this ) {
  9534. error( 'Object3D.add: object can\'t be added as a child of itself.', object );
  9535. return this;
  9536. }
  9537. if ( object && object.isObject3D ) {
  9538. object.removeFromParent();
  9539. object.parent = this;
  9540. this.children.push( object );
  9541. object.dispatchEvent( _addedEvent );
  9542. _childaddedEvent.child = object;
  9543. this.dispatchEvent( _childaddedEvent );
  9544. _childaddedEvent.child = null;
  9545. } else {
  9546. error( 'Object3D.add: object not an instance of THREE.Object3D.', object );
  9547. }
  9548. return this;
  9549. }
  9550. /**
  9551. * Removes the given 3D object as child from this 3D object.
  9552. * An arbitrary number of objects may be removed.
  9553. *
  9554. * @fires Object3D#removed
  9555. * @fires Object3D#childremoved
  9556. * @param {Object3D} object - The 3D object to remove.
  9557. * @return {Object3D} A reference to this instance.
  9558. */
  9559. remove( object ) {
  9560. if ( arguments.length > 1 ) {
  9561. for ( let i = 0; i < arguments.length; i ++ ) {
  9562. this.remove( arguments[ i ] );
  9563. }
  9564. return this;
  9565. }
  9566. const index = this.children.indexOf( object );
  9567. if ( index !== -1 ) {
  9568. object.parent = null;
  9569. this.children.splice( index, 1 );
  9570. object.dispatchEvent( _removedEvent );
  9571. _childremovedEvent.child = object;
  9572. this.dispatchEvent( _childremovedEvent );
  9573. _childremovedEvent.child = null;
  9574. }
  9575. return this;
  9576. }
  9577. /**
  9578. * Removes this 3D object from its current parent.
  9579. *
  9580. * @fires Object3D#removed
  9581. * @fires Object3D#childremoved
  9582. * @return {Object3D} A reference to this instance.
  9583. */
  9584. removeFromParent() {
  9585. const parent = this.parent;
  9586. if ( parent !== null ) {
  9587. parent.remove( this );
  9588. }
  9589. return this;
  9590. }
  9591. /**
  9592. * Removes all child objects.
  9593. *
  9594. * @fires Object3D#removed
  9595. * @fires Object3D#childremoved
  9596. * @return {Object3D} A reference to this instance.
  9597. */
  9598. clear() {
  9599. return this.remove( ... this.children );
  9600. }
  9601. /**
  9602. * Adds the given 3D object as a child of this 3D object, while maintaining the object's world
  9603. * transform. This method does not support scene graphs having non-uniformly-scaled nodes(s).
  9604. *
  9605. * @fires Object3D#added
  9606. * @fires Object3D#childadded
  9607. * @param {Object3D} object - The 3D object to attach.
  9608. * @return {Object3D} A reference to this instance.
  9609. */
  9610. attach( object ) {
  9611. // adds object as a child of this, while maintaining the object's world transform
  9612. // Note: This method does not support scene graphs having non-uniformly-scaled nodes(s)
  9613. this.updateWorldMatrix( true, false );
  9614. _m1$1.copy( this.matrixWorld ).invert();
  9615. if ( object.parent !== null ) {
  9616. object.parent.updateWorldMatrix( true, false );
  9617. _m1$1.multiply( object.parent.matrixWorld );
  9618. }
  9619. object.applyMatrix4( _m1$1 );
  9620. object.removeFromParent();
  9621. object.parent = this;
  9622. this.children.push( object );
  9623. object.updateWorldMatrix( false, true );
  9624. object.dispatchEvent( _addedEvent );
  9625. _childaddedEvent.child = object;
  9626. this.dispatchEvent( _childaddedEvent );
  9627. _childaddedEvent.child = null;
  9628. return this;
  9629. }
  9630. /**
  9631. * Searches through the 3D object and its children, starting with the 3D object
  9632. * itself, and returns the first with a matching ID.
  9633. *
  9634. * @param {number} id - The id.
  9635. * @return {Object3D|undefined} The found 3D object. Returns `undefined` if no 3D object has been found.
  9636. */
  9637. getObjectById( id ) {
  9638. return this.getObjectByProperty( 'id', id );
  9639. }
  9640. /**
  9641. * Searches through the 3D object and its children, starting with the 3D object
  9642. * itself, and returns the first with a matching name.
  9643. *
  9644. * @param {string} name - The name.
  9645. * @return {Object3D|undefined} The found 3D object. Returns `undefined` if no 3D object has been found.
  9646. */
  9647. getObjectByName( name ) {
  9648. return this.getObjectByProperty( 'name', name );
  9649. }
  9650. /**
  9651. * Searches through the 3D object and its children, starting with the 3D object
  9652. * itself, and returns the first with a matching property value.
  9653. *
  9654. * @param {string} name - The name of the property.
  9655. * @param {any} value - The value.
  9656. * @return {Object3D|undefined} The found 3D object. Returns `undefined` if no 3D object has been found.
  9657. */
  9658. getObjectByProperty( name, value ) {
  9659. if ( this[ name ] === value ) return this;
  9660. for ( let i = 0, l = this.children.length; i < l; i ++ ) {
  9661. const child = this.children[ i ];
  9662. const object = child.getObjectByProperty( name, value );
  9663. if ( object !== undefined ) {
  9664. return object;
  9665. }
  9666. }
  9667. return undefined;
  9668. }
  9669. /**
  9670. * Searches through the 3D object and its children, starting with the 3D object
  9671. * itself, and returns all 3D objects with a matching property value.
  9672. *
  9673. * @param {string} name - The name of the property.
  9674. * @param {any} value - The value.
  9675. * @param {Array<Object3D>} result - The method stores the result in this array.
  9676. * @return {Array<Object3D>} The found 3D objects.
  9677. */
  9678. getObjectsByProperty( name, value, result = [] ) {
  9679. if ( this[ name ] === value ) result.push( this );
  9680. const children = this.children;
  9681. for ( let i = 0, l = children.length; i < l; i ++ ) {
  9682. children[ i ].getObjectsByProperty( name, value, result );
  9683. }
  9684. return result;
  9685. }
  9686. /**
  9687. * Returns a vector representing the position of the 3D object in world space.
  9688. *
  9689. * @param {Vector3} target - The target vector the result is stored to.
  9690. * @return {Vector3} The 3D object's position in world space.
  9691. */
  9692. getWorldPosition( target ) {
  9693. this.updateWorldMatrix( true, false );
  9694. return target.setFromMatrixPosition( this.matrixWorld );
  9695. }
  9696. /**
  9697. * Returns a Quaternion representing the position of the 3D object in world space.
  9698. *
  9699. * @param {Quaternion} target - The target Quaternion the result is stored to.
  9700. * @return {Quaternion} The 3D object's rotation in world space.
  9701. */
  9702. getWorldQuaternion( target ) {
  9703. this.updateWorldMatrix( true, false );
  9704. this.matrixWorld.decompose( _position$4, target, _scale$3 );
  9705. return target;
  9706. }
  9707. /**
  9708. * Returns a vector representing the scale of the 3D object in world space.
  9709. *
  9710. * @param {Vector3} target - The target vector the result is stored to.
  9711. * @return {Vector3} The 3D object's scale in world space.
  9712. */
  9713. getWorldScale( target ) {
  9714. this.updateWorldMatrix( true, false );
  9715. this.matrixWorld.decompose( _position$4, _quaternion$3, target );
  9716. return target;
  9717. }
  9718. /**
  9719. * Returns a vector representing the ("look") direction of the 3D object in world space.
  9720. *
  9721. * @param {Vector3} target - The target vector the result is stored to.
  9722. * @return {Vector3} The 3D object's direction in world space.
  9723. */
  9724. getWorldDirection( target ) {
  9725. this.updateWorldMatrix( true, false );
  9726. const e = this.matrixWorld.elements;
  9727. return target.set( e[ 8 ], e[ 9 ], e[ 10 ] ).normalize();
  9728. }
  9729. /**
  9730. * Abstract method to get intersections between a casted ray and this
  9731. * 3D object. Renderable 3D objects such as {@link Mesh}, {@link Line} or {@link Points}
  9732. * implement this method in order to use raycasting.
  9733. *
  9734. * @abstract
  9735. * @param {Raycaster} raycaster - The raycaster.
  9736. * @param {Array<Object>} intersects - An array holding the result of the method.
  9737. */
  9738. raycast( /* raycaster, intersects */ ) {}
  9739. /**
  9740. * Executes the callback on this 3D object and all descendants.
  9741. *
  9742. * Note: Modifying the scene graph inside the callback is discouraged.
  9743. *
  9744. * @param {Function} callback - A callback function that allows to process the current 3D object.
  9745. */
  9746. traverse( callback ) {
  9747. callback( this );
  9748. const children = this.children;
  9749. for ( let i = 0, l = children.length; i < l; i ++ ) {
  9750. children[ i ].traverse( callback );
  9751. }
  9752. }
  9753. /**
  9754. * Like {@link Object3D#traverse}, but the callback will only be executed for visible 3D objects.
  9755. * Descendants of invisible 3D objects are not traversed.
  9756. *
  9757. * Note: Modifying the scene graph inside the callback is discouraged.
  9758. *
  9759. * @param {Function} callback - A callback function that allows to process the current 3D object.
  9760. */
  9761. traverseVisible( callback ) {
  9762. if ( this.visible === false ) return;
  9763. callback( this );
  9764. const children = this.children;
  9765. for ( let i = 0, l = children.length; i < l; i ++ ) {
  9766. children[ i ].traverseVisible( callback );
  9767. }
  9768. }
  9769. /**
  9770. * Like {@link Object3D#traverse}, but the callback will only be executed for all ancestors.
  9771. *
  9772. * Note: Modifying the scene graph inside the callback is discouraged.
  9773. *
  9774. * @param {Function} callback - A callback function that allows to process the current 3D object.
  9775. */
  9776. traverseAncestors( callback ) {
  9777. const parent = this.parent;
  9778. if ( parent !== null ) {
  9779. callback( parent );
  9780. parent.traverseAncestors( callback );
  9781. }
  9782. }
  9783. /**
  9784. * Updates the transformation matrix in local space by computing it from the current
  9785. * position, rotation and scale values.
  9786. */
  9787. updateMatrix() {
  9788. this.matrix.compose( this.position, this.quaternion, this.scale );
  9789. const pivot = this.pivot;
  9790. if ( pivot !== null ) {
  9791. const px = pivot.x, py = pivot.y, pz = pivot.z;
  9792. const te = this.matrix.elements;
  9793. te[ 12 ] += px - te[ 0 ] * px - te[ 4 ] * py - te[ 8 ] * pz;
  9794. te[ 13 ] += py - te[ 1 ] * px - te[ 5 ] * py - te[ 9 ] * pz;
  9795. te[ 14 ] += pz - te[ 2 ] * px - te[ 6 ] * py - te[ 10 ] * pz;
  9796. }
  9797. this.matrixWorldNeedsUpdate = true;
  9798. }
  9799. /**
  9800. * Updates the transformation matrix in world space of this 3D objects and its descendants.
  9801. *
  9802. * To ensure correct results, this method also recomputes the 3D object's transformation matrix in
  9803. * local space. The computation of the local and world matrix can be controlled with the
  9804. * {@link Object3D#matrixAutoUpdate} and {@link Object3D#matrixWorldAutoUpdate} flags which are both
  9805. * `true` by default. Set these flags to `false` if you need more control over the update matrix process.
  9806. *
  9807. * @param {boolean} [force=false] - When set to `true`, a recomputation of world matrices is forced even
  9808. * when {@link Object3D#matrixWorldNeedsUpdate} is `false`.
  9809. */
  9810. updateMatrixWorld( force ) {
  9811. if ( this.matrixAutoUpdate ) this.updateMatrix();
  9812. if ( this.matrixWorldNeedsUpdate || force ) {
  9813. if ( this.matrixWorldAutoUpdate === true ) {
  9814. if ( this.parent === null ) {
  9815. this.matrixWorld.copy( this.matrix );
  9816. } else {
  9817. this.matrixWorld.multiplyMatrices( this.parent.matrixWorld, this.matrix );
  9818. }
  9819. }
  9820. this.matrixWorldNeedsUpdate = false;
  9821. force = true;
  9822. }
  9823. // make sure descendants are updated if required
  9824. const children = this.children;
  9825. for ( let i = 0, l = children.length; i < l; i ++ ) {
  9826. const child = children[ i ];
  9827. child.updateMatrixWorld( force );
  9828. }
  9829. }
  9830. /**
  9831. * An alternative version of {@link Object3D#updateMatrixWorld} with more control over the
  9832. * update of ancestor and descendant nodes.
  9833. *
  9834. * @param {boolean} [updateParents=false] Whether ancestor nodes should be updated or not.
  9835. * @param {boolean} [updateChildren=false] Whether descendant nodes should be updated or not.
  9836. */
  9837. updateWorldMatrix( updateParents, updateChildren ) {
  9838. const parent = this.parent;
  9839. if ( updateParents === true && parent !== null ) {
  9840. parent.updateWorldMatrix( true, false );
  9841. }
  9842. if ( this.matrixAutoUpdate ) this.updateMatrix();
  9843. if ( this.matrixWorldAutoUpdate === true ) {
  9844. if ( this.parent === null ) {
  9845. this.matrixWorld.copy( this.matrix );
  9846. } else {
  9847. this.matrixWorld.multiplyMatrices( this.parent.matrixWorld, this.matrix );
  9848. }
  9849. }
  9850. // make sure descendants are updated
  9851. if ( updateChildren === true ) {
  9852. const children = this.children;
  9853. for ( let i = 0, l = children.length; i < l; i ++ ) {
  9854. const child = children[ i ];
  9855. child.updateWorldMatrix( false, true );
  9856. }
  9857. }
  9858. }
  9859. /**
  9860. * Serializes the 3D object into JSON.
  9861. *
  9862. * @param {?(Object|string)} meta - An optional value holding meta information about the serialization.
  9863. * @return {Object} A JSON object representing the serialized 3D object.
  9864. * @see {@link ObjectLoader#parse}
  9865. */
  9866. toJSON( meta ) {
  9867. // meta is a string when called from JSON.stringify
  9868. const isRootObject = ( meta === undefined || typeof meta === 'string' );
  9869. const output = {};
  9870. // meta is a hash used to collect geometries, materials.
  9871. // not providing it implies that this is the root object
  9872. // being serialized.
  9873. if ( isRootObject ) {
  9874. // initialize meta obj
  9875. meta = {
  9876. geometries: {},
  9877. materials: {},
  9878. textures: {},
  9879. images: {},
  9880. shapes: {},
  9881. skeletons: {},
  9882. animations: {},
  9883. nodes: {}
  9884. };
  9885. output.metadata = {
  9886. version: 4.7,
  9887. type: 'Object',
  9888. generator: 'Object3D.toJSON'
  9889. };
  9890. }
  9891. // standard Object3D serialization
  9892. const object = {};
  9893. object.uuid = this.uuid;
  9894. object.type = this.type;
  9895. if ( this.name !== '' ) object.name = this.name;
  9896. if ( this.castShadow === true ) object.castShadow = true;
  9897. if ( this.receiveShadow === true ) object.receiveShadow = true;
  9898. if ( this.visible === false ) object.visible = false;
  9899. if ( this.frustumCulled === false ) object.frustumCulled = false;
  9900. if ( this.renderOrder !== 0 ) object.renderOrder = this.renderOrder;
  9901. if ( this.static !== false ) object.static = this.static;
  9902. if ( Object.keys( this.userData ).length > 0 ) object.userData = this.userData;
  9903. object.layers = this.layers.mask;
  9904. object.matrix = this.matrix.toArray();
  9905. object.up = this.up.toArray();
  9906. if ( this.pivot !== null ) object.pivot = this.pivot.toArray();
  9907. if ( this.matrixAutoUpdate === false ) object.matrixAutoUpdate = false;
  9908. if ( this.morphTargetDictionary !== undefined ) object.morphTargetDictionary = Object.assign( {}, this.morphTargetDictionary );
  9909. if ( this.morphTargetInfluences !== undefined ) object.morphTargetInfluences = this.morphTargetInfluences.slice();
  9910. // object specific properties
  9911. if ( this.isInstancedMesh ) {
  9912. object.type = 'InstancedMesh';
  9913. object.count = this.count;
  9914. object.instanceMatrix = this.instanceMatrix.toJSON();
  9915. if ( this.instanceColor !== null ) object.instanceColor = this.instanceColor.toJSON();
  9916. }
  9917. if ( this.isBatchedMesh ) {
  9918. object.type = 'BatchedMesh';
  9919. object.perObjectFrustumCulled = this.perObjectFrustumCulled;
  9920. object.sortObjects = this.sortObjects;
  9921. object.drawRanges = this._drawRanges;
  9922. object.reservedRanges = this._reservedRanges;
  9923. object.geometryInfo = this._geometryInfo.map( info => ( {
  9924. ...info,
  9925. boundingBox: info.boundingBox ? info.boundingBox.toJSON() : undefined,
  9926. boundingSphere: info.boundingSphere ? info.boundingSphere.toJSON() : undefined
  9927. } ) );
  9928. object.instanceInfo = this._instanceInfo.map( info => ( { ...info } ) );
  9929. object.availableInstanceIds = this._availableInstanceIds.slice();
  9930. object.availableGeometryIds = this._availableGeometryIds.slice();
  9931. object.nextIndexStart = this._nextIndexStart;
  9932. object.nextVertexStart = this._nextVertexStart;
  9933. object.geometryCount = this._geometryCount;
  9934. object.maxInstanceCount = this._maxInstanceCount;
  9935. object.maxVertexCount = this._maxVertexCount;
  9936. object.maxIndexCount = this._maxIndexCount;
  9937. object.geometryInitialized = this._geometryInitialized;
  9938. object.matricesTexture = this._matricesTexture.toJSON( meta );
  9939. object.indirectTexture = this._indirectTexture.toJSON( meta );
  9940. if ( this._colorsTexture !== null ) {
  9941. object.colorsTexture = this._colorsTexture.toJSON( meta );
  9942. }
  9943. if ( this.boundingSphere !== null ) {
  9944. object.boundingSphere = this.boundingSphere.toJSON();
  9945. }
  9946. if ( this.boundingBox !== null ) {
  9947. object.boundingBox = this.boundingBox.toJSON();
  9948. }
  9949. }
  9950. //
  9951. function serialize( library, element ) {
  9952. if ( library[ element.uuid ] === undefined ) {
  9953. library[ element.uuid ] = element.toJSON( meta );
  9954. }
  9955. return element.uuid;
  9956. }
  9957. if ( this.isScene ) {
  9958. if ( this.background ) {
  9959. if ( this.background.isColor ) {
  9960. object.background = this.background.toJSON();
  9961. } else if ( this.background.isTexture ) {
  9962. object.background = this.background.toJSON( meta ).uuid;
  9963. }
  9964. }
  9965. if ( this.environment && this.environment.isTexture && this.environment.isRenderTargetTexture !== true ) {
  9966. object.environment = this.environment.toJSON( meta ).uuid;
  9967. }
  9968. } else if ( this.isMesh || this.isLine || this.isPoints ) {
  9969. object.geometry = serialize( meta.geometries, this.geometry );
  9970. const parameters = this.geometry.parameters;
  9971. if ( parameters !== undefined && parameters.shapes !== undefined ) {
  9972. const shapes = parameters.shapes;
  9973. if ( Array.isArray( shapes ) ) {
  9974. for ( let i = 0, l = shapes.length; i < l; i ++ ) {
  9975. const shape = shapes[ i ];
  9976. serialize( meta.shapes, shape );
  9977. }
  9978. } else {
  9979. serialize( meta.shapes, shapes );
  9980. }
  9981. }
  9982. }
  9983. if ( this.isSkinnedMesh ) {
  9984. object.bindMode = this.bindMode;
  9985. object.bindMatrix = this.bindMatrix.toArray();
  9986. if ( this.skeleton !== undefined ) {
  9987. serialize( meta.skeletons, this.skeleton );
  9988. object.skeleton = this.skeleton.uuid;
  9989. }
  9990. }
  9991. if ( this.material !== undefined ) {
  9992. if ( Array.isArray( this.material ) ) {
  9993. const uuids = [];
  9994. for ( let i = 0, l = this.material.length; i < l; i ++ ) {
  9995. uuids.push( serialize( meta.materials, this.material[ i ] ) );
  9996. }
  9997. object.material = uuids;
  9998. } else {
  9999. object.material = serialize( meta.materials, this.material );
  10000. }
  10001. }
  10002. //
  10003. if ( this.children.length > 0 ) {
  10004. object.children = [];
  10005. for ( let i = 0; i < this.children.length; i ++ ) {
  10006. object.children.push( this.children[ i ].toJSON( meta ).object );
  10007. }
  10008. }
  10009. //
  10010. if ( this.animations.length > 0 ) {
  10011. object.animations = [];
  10012. for ( let i = 0; i < this.animations.length; i ++ ) {
  10013. const animation = this.animations[ i ];
  10014. object.animations.push( serialize( meta.animations, animation ) );
  10015. }
  10016. }
  10017. if ( isRootObject ) {
  10018. const geometries = extractFromCache( meta.geometries );
  10019. const materials = extractFromCache( meta.materials );
  10020. const textures = extractFromCache( meta.textures );
  10021. const images = extractFromCache( meta.images );
  10022. const shapes = extractFromCache( meta.shapes );
  10023. const skeletons = extractFromCache( meta.skeletons );
  10024. const animations = extractFromCache( meta.animations );
  10025. const nodes = extractFromCache( meta.nodes );
  10026. if ( geometries.length > 0 ) output.geometries = geometries;
  10027. if ( materials.length > 0 ) output.materials = materials;
  10028. if ( textures.length > 0 ) output.textures = textures;
  10029. if ( images.length > 0 ) output.images = images;
  10030. if ( shapes.length > 0 ) output.shapes = shapes;
  10031. if ( skeletons.length > 0 ) output.skeletons = skeletons;
  10032. if ( animations.length > 0 ) output.animations = animations;
  10033. if ( nodes.length > 0 ) output.nodes = nodes;
  10034. }
  10035. output.object = object;
  10036. return output;
  10037. // extract data from the cache hash
  10038. // remove metadata on each item
  10039. // and return as array
  10040. function extractFromCache( cache ) {
  10041. const values = [];
  10042. for ( const key in cache ) {
  10043. const data = cache[ key ];
  10044. delete data.metadata;
  10045. values.push( data );
  10046. }
  10047. return values;
  10048. }
  10049. }
  10050. /**
  10051. * Returns a new 3D object with copied values from this instance.
  10052. *
  10053. * @param {boolean} [recursive=true] - When set to `true`, descendants of the 3D object are also cloned.
  10054. * @return {Object3D} A clone of this instance.
  10055. */
  10056. clone( recursive ) {
  10057. return new this.constructor().copy( this, recursive );
  10058. }
  10059. /**
  10060. * Copies the values of the given 3D object to this instance.
  10061. *
  10062. * @param {Object3D} source - The 3D object to copy.
  10063. * @param {boolean} [recursive=true] - When set to `true`, descendants of the 3D object are cloned.
  10064. * @return {Object3D} A reference to this instance.
  10065. */
  10066. copy( source, recursive = true ) {
  10067. this.name = source.name;
  10068. this.up.copy( source.up );
  10069. this.position.copy( source.position );
  10070. this.rotation.order = source.rotation.order;
  10071. this.quaternion.copy( source.quaternion );
  10072. this.scale.copy( source.scale );
  10073. if ( source.pivot !== null ) {
  10074. this.pivot = source.pivot.clone();
  10075. }
  10076. this.matrix.copy( source.matrix );
  10077. this.matrixWorld.copy( source.matrixWorld );
  10078. this.matrixAutoUpdate = source.matrixAutoUpdate;
  10079. this.matrixWorldAutoUpdate = source.matrixWorldAutoUpdate;
  10080. this.matrixWorldNeedsUpdate = source.matrixWorldNeedsUpdate;
  10081. this.layers.mask = source.layers.mask;
  10082. this.visible = source.visible;
  10083. this.castShadow = source.castShadow;
  10084. this.receiveShadow = source.receiveShadow;
  10085. this.frustumCulled = source.frustumCulled;
  10086. this.renderOrder = source.renderOrder;
  10087. this.static = source.static;
  10088. this.animations = source.animations.slice();
  10089. this.userData = JSON.parse( JSON.stringify( source.userData ) );
  10090. if ( recursive === true ) {
  10091. for ( let i = 0; i < source.children.length; i ++ ) {
  10092. const child = source.children[ i ];
  10093. this.add( child.clone() );
  10094. }
  10095. }
  10096. return this;
  10097. }
  10098. }
  10099. /**
  10100. * The default up direction for objects, also used as the default
  10101. * position for {@link DirectionalLight} and {@link HemisphereLight}.
  10102. *
  10103. * @static
  10104. * @type {Vector3}
  10105. * @default (0,1,0)
  10106. */
  10107. Object3D.DEFAULT_UP = /*@__PURE__*/ new Vector3( 0, 1, 0 );
  10108. /**
  10109. * The default setting for {@link Object3D#matrixAutoUpdate} for
  10110. * newly created 3D objects.
  10111. *
  10112. * @static
  10113. * @type {boolean}
  10114. * @default true
  10115. */
  10116. Object3D.DEFAULT_MATRIX_AUTO_UPDATE = true;
  10117. /**
  10118. * The default setting for {@link Object3D#matrixWorldAutoUpdate} for
  10119. * newly created 3D objects.
  10120. *
  10121. * @static
  10122. * @type {boolean}
  10123. * @default true
  10124. */
  10125. Object3D.DEFAULT_MATRIX_WORLD_AUTO_UPDATE = true;
  10126. /**
  10127. * This is almost identical to an {@link Object3D}. Its purpose is to
  10128. * make working with groups of objects syntactically clearer.
  10129. *
  10130. * ```js
  10131. * // Create a group and add the two cubes.
  10132. * // These cubes can now be rotated / scaled etc as a group.
  10133. * const group = new THREE.Group();
  10134. *
  10135. * group.add( meshA );
  10136. * group.add( meshB );
  10137. *
  10138. * scene.add( group );
  10139. * ```
  10140. *
  10141. * @augments Object3D
  10142. */
  10143. class Group extends Object3D {
  10144. constructor() {
  10145. super();
  10146. /**
  10147. * This flag can be used for type testing.
  10148. *
  10149. * @type {boolean}
  10150. * @readonly
  10151. * @default true
  10152. */
  10153. this.isGroup = true;
  10154. this.type = 'Group';
  10155. }
  10156. }
  10157. const _moveEvent = { type: 'move' };
  10158. /**
  10159. * Class for representing a XR controller with its
  10160. * different coordinate systems.
  10161. *
  10162. * @private
  10163. */
  10164. class WebXRController {
  10165. /**
  10166. * Constructs a new XR controller.
  10167. */
  10168. constructor() {
  10169. /**
  10170. * A group representing the target ray space
  10171. * of the XR controller.
  10172. *
  10173. * @private
  10174. * @type {?Group}
  10175. * @default null
  10176. */
  10177. this._targetRay = null;
  10178. /**
  10179. * A group representing the grip space
  10180. * of the XR controller.
  10181. *
  10182. * @private
  10183. * @type {?Group}
  10184. * @default null
  10185. */
  10186. this._grip = null;
  10187. /**
  10188. * A group representing the hand space
  10189. * of the XR controller.
  10190. *
  10191. * @private
  10192. * @type {?Group}
  10193. * @default null
  10194. */
  10195. this._hand = null;
  10196. }
  10197. /**
  10198. * Returns a group representing the hand space of the XR controller.
  10199. *
  10200. * @return {Group} A group representing the hand space of the XR controller.
  10201. */
  10202. getHandSpace() {
  10203. if ( this._hand === null ) {
  10204. this._hand = new Group();
  10205. this._hand.matrixAutoUpdate = false;
  10206. this._hand.visible = false;
  10207. this._hand.joints = {};
  10208. this._hand.inputState = { pinching: false };
  10209. }
  10210. return this._hand;
  10211. }
  10212. /**
  10213. * Returns a group representing the target ray space of the XR controller.
  10214. *
  10215. * @return {Group} A group representing the target ray space of the XR controller.
  10216. */
  10217. getTargetRaySpace() {
  10218. if ( this._targetRay === null ) {
  10219. this._targetRay = new Group();
  10220. this._targetRay.matrixAutoUpdate = false;
  10221. this._targetRay.visible = false;
  10222. this._targetRay.hasLinearVelocity = false;
  10223. this._targetRay.linearVelocity = new Vector3();
  10224. this._targetRay.hasAngularVelocity = false;
  10225. this._targetRay.angularVelocity = new Vector3();
  10226. }
  10227. return this._targetRay;
  10228. }
  10229. /**
  10230. * Returns a group representing the grip space of the XR controller.
  10231. *
  10232. * @return {Group} A group representing the grip space of the XR controller.
  10233. */
  10234. getGripSpace() {
  10235. if ( this._grip === null ) {
  10236. this._grip = new Group();
  10237. this._grip.matrixAutoUpdate = false;
  10238. this._grip.visible = false;
  10239. this._grip.hasLinearVelocity = false;
  10240. this._grip.linearVelocity = new Vector3();
  10241. this._grip.hasAngularVelocity = false;
  10242. this._grip.angularVelocity = new Vector3();
  10243. }
  10244. return this._grip;
  10245. }
  10246. /**
  10247. * Dispatches the given event to the groups representing
  10248. * the different coordinate spaces of the XR controller.
  10249. *
  10250. * @param {Object} event - The event to dispatch.
  10251. * @return {WebXRController} A reference to this instance.
  10252. */
  10253. dispatchEvent( event ) {
  10254. if ( this._targetRay !== null ) {
  10255. this._targetRay.dispatchEvent( event );
  10256. }
  10257. if ( this._grip !== null ) {
  10258. this._grip.dispatchEvent( event );
  10259. }
  10260. if ( this._hand !== null ) {
  10261. this._hand.dispatchEvent( event );
  10262. }
  10263. return this;
  10264. }
  10265. /**
  10266. * Connects the controller with the given XR input source.
  10267. *
  10268. * @param {XRInputSource} inputSource - The input source.
  10269. * @return {WebXRController} A reference to this instance.
  10270. */
  10271. connect( inputSource ) {
  10272. if ( inputSource && inputSource.hand ) {
  10273. const hand = this._hand;
  10274. if ( hand ) {
  10275. for ( const inputjoint of inputSource.hand.values() ) {
  10276. // Initialize hand with joints when connected
  10277. this._getHandJoint( hand, inputjoint );
  10278. }
  10279. }
  10280. }
  10281. this.dispatchEvent( { type: 'connected', data: inputSource } );
  10282. return this;
  10283. }
  10284. /**
  10285. * Disconnects the controller from the given XR input source.
  10286. *
  10287. * @param {XRInputSource} inputSource - The input source.
  10288. * @return {WebXRController} A reference to this instance.
  10289. */
  10290. disconnect( inputSource ) {
  10291. this.dispatchEvent( { type: 'disconnected', data: inputSource } );
  10292. if ( this._targetRay !== null ) {
  10293. this._targetRay.visible = false;
  10294. }
  10295. if ( this._grip !== null ) {
  10296. this._grip.visible = false;
  10297. }
  10298. if ( this._hand !== null ) {
  10299. this._hand.visible = false;
  10300. }
  10301. return this;
  10302. }
  10303. /**
  10304. * Updates the controller with the given input source, XR frame and reference space.
  10305. * This updates the transformations of the groups that represent the different
  10306. * coordinate systems of the controller.
  10307. *
  10308. * @param {XRInputSource} inputSource - The input source.
  10309. * @param {XRFrame} frame - The XR frame.
  10310. * @param {XRReferenceSpace} referenceSpace - The reference space.
  10311. * @return {WebXRController} A reference to this instance.
  10312. */
  10313. update( inputSource, frame, referenceSpace ) {
  10314. let inputPose = null;
  10315. let gripPose = null;
  10316. let handPose = null;
  10317. const targetRay = this._targetRay;
  10318. const grip = this._grip;
  10319. const hand = this._hand;
  10320. if ( inputSource && frame.session.visibilityState !== 'visible-blurred' ) {
  10321. if ( hand && inputSource.hand ) {
  10322. handPose = true;
  10323. for ( const inputjoint of inputSource.hand.values() ) {
  10324. // Update the joints groups with the XRJoint poses
  10325. const jointPose = frame.getJointPose( inputjoint, referenceSpace );
  10326. // The transform of this joint will be updated with the joint pose on each frame
  10327. const joint = this._getHandJoint( hand, inputjoint );
  10328. if ( jointPose !== null ) {
  10329. joint.matrix.fromArray( jointPose.transform.matrix );
  10330. joint.matrix.decompose( joint.position, joint.rotation, joint.scale );
  10331. joint.matrixWorldNeedsUpdate = true;
  10332. joint.jointRadius = jointPose.radius;
  10333. }
  10334. joint.visible = jointPose !== null;
  10335. }
  10336. // Custom events
  10337. // Check pinchz
  10338. const indexTip = hand.joints[ 'index-finger-tip' ];
  10339. const thumbTip = hand.joints[ 'thumb-tip' ];
  10340. const distance = indexTip.position.distanceTo( thumbTip.position );
  10341. const distanceToPinch = 0.02;
  10342. const threshold = 0.005;
  10343. if ( hand.inputState.pinching && distance > distanceToPinch + threshold ) {
  10344. hand.inputState.pinching = false;
  10345. this.dispatchEvent( {
  10346. type: 'pinchend',
  10347. handedness: inputSource.handedness,
  10348. target: this
  10349. } );
  10350. } else if ( ! hand.inputState.pinching && distance <= distanceToPinch - threshold ) {
  10351. hand.inputState.pinching = true;
  10352. this.dispatchEvent( {
  10353. type: 'pinchstart',
  10354. handedness: inputSource.handedness,
  10355. target: this
  10356. } );
  10357. }
  10358. } else {
  10359. if ( grip !== null && inputSource.gripSpace ) {
  10360. gripPose = frame.getPose( inputSource.gripSpace, referenceSpace );
  10361. if ( gripPose !== null ) {
  10362. grip.matrix.fromArray( gripPose.transform.matrix );
  10363. grip.matrix.decompose( grip.position, grip.rotation, grip.scale );
  10364. grip.matrixWorldNeedsUpdate = true;
  10365. if ( gripPose.linearVelocity ) {
  10366. grip.hasLinearVelocity = true;
  10367. grip.linearVelocity.copy( gripPose.linearVelocity );
  10368. } else {
  10369. grip.hasLinearVelocity = false;
  10370. }
  10371. if ( gripPose.angularVelocity ) {
  10372. grip.hasAngularVelocity = true;
  10373. grip.angularVelocity.copy( gripPose.angularVelocity );
  10374. } else {
  10375. grip.hasAngularVelocity = false;
  10376. }
  10377. }
  10378. }
  10379. }
  10380. if ( targetRay !== null ) {
  10381. inputPose = frame.getPose( inputSource.targetRaySpace, referenceSpace );
  10382. // Some runtimes (namely Vive Cosmos with Vive OpenXR Runtime) have only grip space and ray space is equal to it
  10383. if ( inputPose === null && gripPose !== null ) {
  10384. inputPose = gripPose;
  10385. }
  10386. if ( inputPose !== null ) {
  10387. targetRay.matrix.fromArray( inputPose.transform.matrix );
  10388. targetRay.matrix.decompose( targetRay.position, targetRay.rotation, targetRay.scale );
  10389. targetRay.matrixWorldNeedsUpdate = true;
  10390. if ( inputPose.linearVelocity ) {
  10391. targetRay.hasLinearVelocity = true;
  10392. targetRay.linearVelocity.copy( inputPose.linearVelocity );
  10393. } else {
  10394. targetRay.hasLinearVelocity = false;
  10395. }
  10396. if ( inputPose.angularVelocity ) {
  10397. targetRay.hasAngularVelocity = true;
  10398. targetRay.angularVelocity.copy( inputPose.angularVelocity );
  10399. } else {
  10400. targetRay.hasAngularVelocity = false;
  10401. }
  10402. this.dispatchEvent( _moveEvent );
  10403. }
  10404. }
  10405. }
  10406. if ( targetRay !== null ) {
  10407. targetRay.visible = ( inputPose !== null );
  10408. }
  10409. if ( grip !== null ) {
  10410. grip.visible = ( gripPose !== null );
  10411. }
  10412. if ( hand !== null ) {
  10413. hand.visible = ( handPose !== null );
  10414. }
  10415. return this;
  10416. }
  10417. /**
  10418. * Returns a group representing the hand joint for the given input joint.
  10419. *
  10420. * @private
  10421. * @param {Group} hand - The group representing the hand space.
  10422. * @param {XRJointSpace} inputjoint - The hand joint data.
  10423. * @return {Group} A group representing the hand joint for the given input joint.
  10424. */
  10425. _getHandJoint( hand, inputjoint ) {
  10426. if ( hand.joints[ inputjoint.jointName ] === undefined ) {
  10427. const joint = new Group();
  10428. joint.matrixAutoUpdate = false;
  10429. joint.visible = false;
  10430. hand.joints[ inputjoint.jointName ] = joint;
  10431. hand.add( joint );
  10432. }
  10433. return hand.joints[ inputjoint.jointName ];
  10434. }
  10435. }
  10436. const _colorKeywords = { 'aliceblue': 0xF0F8FF, 'antiquewhite': 0xFAEBD7, 'aqua': 0x00FFFF, 'aquamarine': 0x7FFFD4, 'azure': 0xF0FFFF,
  10437. 'beige': 0xF5F5DC, 'bisque': 0xFFE4C4, 'black': 0x000000, 'blanchedalmond': 0xFFEBCD, 'blue': 0x0000FF, 'blueviolet': 0x8A2BE2,
  10438. 'brown': 0xA52A2A, 'burlywood': 0xDEB887, 'cadetblue': 0x5F9EA0, 'chartreuse': 0x7FFF00, 'chocolate': 0xD2691E, 'coral': 0xFF7F50,
  10439. 'cornflowerblue': 0x6495ED, 'cornsilk': 0xFFF8DC, 'crimson': 0xDC143C, 'cyan': 0x00FFFF, 'darkblue': 0x00008B, 'darkcyan': 0x008B8B,
  10440. 'darkgoldenrod': 0xB8860B, 'darkgray': 0xA9A9A9, 'darkgreen': 0x006400, 'darkgrey': 0xA9A9A9, 'darkkhaki': 0xBDB76B, 'darkmagenta': 0x8B008B,
  10441. 'darkolivegreen': 0x556B2F, 'darkorange': 0xFF8C00, 'darkorchid': 0x9932CC, 'darkred': 0x8B0000, 'darksalmon': 0xE9967A, 'darkseagreen': 0x8FBC8F,
  10442. 'darkslateblue': 0x483D8B, 'darkslategray': 0x2F4F4F, 'darkslategrey': 0x2F4F4F, 'darkturquoise': 0x00CED1, 'darkviolet': 0x9400D3,
  10443. 'deeppink': 0xFF1493, 'deepskyblue': 0x00BFFF, 'dimgray': 0x696969, 'dimgrey': 0x696969, 'dodgerblue': 0x1E90FF, 'firebrick': 0xB22222,
  10444. 'floralwhite': 0xFFFAF0, 'forestgreen': 0x228B22, 'fuchsia': 0xFF00FF, 'gainsboro': 0xDCDCDC, 'ghostwhite': 0xF8F8FF, 'gold': 0xFFD700,
  10445. 'goldenrod': 0xDAA520, 'gray': 0x808080, 'green': 0x008000, 'greenyellow': 0xADFF2F, 'grey': 0x808080, 'honeydew': 0xF0FFF0, 'hotpink': 0xFF69B4,
  10446. 'indianred': 0xCD5C5C, 'indigo': 0x4B0082, 'ivory': 0xFFFFF0, 'khaki': 0xF0E68C, 'lavender': 0xE6E6FA, 'lavenderblush': 0xFFF0F5, 'lawngreen': 0x7CFC00,
  10447. 'lemonchiffon': 0xFFFACD, 'lightblue': 0xADD8E6, 'lightcoral': 0xF08080, 'lightcyan': 0xE0FFFF, 'lightgoldenrodyellow': 0xFAFAD2, 'lightgray': 0xD3D3D3,
  10448. 'lightgreen': 0x90EE90, 'lightgrey': 0xD3D3D3, 'lightpink': 0xFFB6C1, 'lightsalmon': 0xFFA07A, 'lightseagreen': 0x20B2AA, 'lightskyblue': 0x87CEFA,
  10449. 'lightslategray': 0x778899, 'lightslategrey': 0x778899, 'lightsteelblue': 0xB0C4DE, 'lightyellow': 0xFFFFE0, 'lime': 0x00FF00, 'limegreen': 0x32CD32,
  10450. 'linen': 0xFAF0E6, 'magenta': 0xFF00FF, 'maroon': 0x800000, 'mediumaquamarine': 0x66CDAA, 'mediumblue': 0x0000CD, 'mediumorchid': 0xBA55D3,
  10451. 'mediumpurple': 0x9370DB, 'mediumseagreen': 0x3CB371, 'mediumslateblue': 0x7B68EE, 'mediumspringgreen': 0x00FA9A, 'mediumturquoise': 0x48D1CC,
  10452. 'mediumvioletred': 0xC71585, 'midnightblue': 0x191970, 'mintcream': 0xF5FFFA, 'mistyrose': 0xFFE4E1, 'moccasin': 0xFFE4B5, 'navajowhite': 0xFFDEAD,
  10453. 'navy': 0x000080, 'oldlace': 0xFDF5E6, 'olive': 0x808000, 'olivedrab': 0x6B8E23, 'orange': 0xFFA500, 'orangered': 0xFF4500, 'orchid': 0xDA70D6,
  10454. 'palegoldenrod': 0xEEE8AA, 'palegreen': 0x98FB98, 'paleturquoise': 0xAFEEEE, 'palevioletred': 0xDB7093, 'papayawhip': 0xFFEFD5, 'peachpuff': 0xFFDAB9,
  10455. 'peru': 0xCD853F, 'pink': 0xFFC0CB, 'plum': 0xDDA0DD, 'powderblue': 0xB0E0E6, 'purple': 0x800080, 'rebeccapurple': 0x663399, 'red': 0xFF0000, 'rosybrown': 0xBC8F8F,
  10456. 'royalblue': 0x4169E1, 'saddlebrown': 0x8B4513, 'salmon': 0xFA8072, 'sandybrown': 0xF4A460, 'seagreen': 0x2E8B57, 'seashell': 0xFFF5EE,
  10457. 'sienna': 0xA0522D, 'silver': 0xC0C0C0, 'skyblue': 0x87CEEB, 'slateblue': 0x6A5ACD, 'slategray': 0x708090, 'slategrey': 0x708090, 'snow': 0xFFFAFA,
  10458. 'springgreen': 0x00FF7F, 'steelblue': 0x4682B4, 'tan': 0xD2B48C, 'teal': 0x008080, 'thistle': 0xD8BFD8, 'tomato': 0xFF6347, 'turquoise': 0x40E0D0,
  10459. 'violet': 0xEE82EE, 'wheat': 0xF5DEB3, 'white': 0xFFFFFF, 'whitesmoke': 0xF5F5F5, 'yellow': 0xFFFF00, 'yellowgreen': 0x9ACD32 };
  10460. const _hslA = { h: 0, s: 0, l: 0 };
  10461. const _hslB = { h: 0, s: 0, l: 0 };
  10462. function hue2rgb( p, q, t ) {
  10463. if ( t < 0 ) t += 1;
  10464. if ( t > 1 ) t -= 1;
  10465. if ( t < 1 / 6 ) return p + ( q - p ) * 6 * t;
  10466. if ( t < 1 / 2 ) return q;
  10467. if ( t < 2 / 3 ) return p + ( q - p ) * 6 * ( 2 / 3 - t );
  10468. return p;
  10469. }
  10470. /**
  10471. * A Color instance is represented by RGB components in the linear <i>working
  10472. * color space</i>, which defaults to `LinearSRGBColorSpace`. Inputs
  10473. * conventionally using `SRGBColorSpace` (such as hexadecimals and CSS
  10474. * strings) are converted to the working color space automatically.
  10475. *
  10476. * ```js
  10477. * // converted automatically from SRGBColorSpace to LinearSRGBColorSpace
  10478. * const color = new THREE.Color().setHex( 0x112233 );
  10479. * ```
  10480. * Source color spaces may be specified explicitly, to ensure correct conversions.
  10481. * ```js
  10482. * // assumed already LinearSRGBColorSpace; no conversion
  10483. * const color = new THREE.Color().setRGB( 0.5, 0.5, 0.5 );
  10484. *
  10485. * // converted explicitly from SRGBColorSpace to LinearSRGBColorSpace
  10486. * const color = new THREE.Color().setRGB( 0.5, 0.5, 0.5, SRGBColorSpace );
  10487. * ```
  10488. * If THREE.ColorManagement is disabled, no conversions occur. For details,
  10489. * see <i>Color management</i>. Iterating through a Color instance will yield
  10490. * its components (r, g, b) in the corresponding order. A Color can be initialised
  10491. * in any of the following ways:
  10492. * ```js
  10493. * //empty constructor - will default white
  10494. * const color1 = new THREE.Color();
  10495. *
  10496. * //Hexadecimal color (recommended)
  10497. * const color2 = new THREE.Color( 0xff0000 );
  10498. *
  10499. * //RGB string
  10500. * const color3 = new THREE.Color("rgb(255, 0, 0)");
  10501. * const color4 = new THREE.Color("rgb(100%, 0%, 0%)");
  10502. *
  10503. * //X11 color name - all 140 color names are supported.
  10504. * //Note the lack of CamelCase in the name
  10505. * const color5 = new THREE.Color( 'skyblue' );
  10506. * //HSL string
  10507. * const color6 = new THREE.Color("hsl(0, 100%, 50%)");
  10508. *
  10509. * //Separate RGB values between 0 and 1
  10510. * const color7 = new THREE.Color( 1, 0, 0 );
  10511. * ```
  10512. */
  10513. class Color {
  10514. /**
  10515. * Constructs a new color.
  10516. *
  10517. * Note that standard method of specifying color in three.js is with a hexadecimal triplet,
  10518. * and that method is used throughout the rest of the documentation.
  10519. *
  10520. * @param {(number|string|Color)} [r] - The red component of the color. If `g` and `b` are
  10521. * not provided, it can be hexadecimal triplet, a CSS-style string or another `Color` instance.
  10522. * @param {number} [g] - The green component.
  10523. * @param {number} [b] - The blue component.
  10524. */
  10525. constructor( r, g, b ) {
  10526. /**
  10527. * This flag can be used for type testing.
  10528. *
  10529. * @type {boolean}
  10530. * @readonly
  10531. * @default true
  10532. */
  10533. this.isColor = true;
  10534. /**
  10535. * The red component.
  10536. *
  10537. * @type {number}
  10538. * @default 1
  10539. */
  10540. this.r = 1;
  10541. /**
  10542. * The green component.
  10543. *
  10544. * @type {number}
  10545. * @default 1
  10546. */
  10547. this.g = 1;
  10548. /**
  10549. * The blue component.
  10550. *
  10551. * @type {number}
  10552. * @default 1
  10553. */
  10554. this.b = 1;
  10555. return this.set( r, g, b );
  10556. }
  10557. /**
  10558. * Sets the colors's components from the given values.
  10559. *
  10560. * @param {(number|string|Color)} [r] - The red component of the color. If `g` and `b` are
  10561. * not provided, it can be hexadecimal triplet, a CSS-style string or another `Color` instance.
  10562. * @param {number} [g] - The green component.
  10563. * @param {number} [b] - The blue component.
  10564. * @return {Color} A reference to this color.
  10565. */
  10566. set( r, g, b ) {
  10567. if ( g === undefined && b === undefined ) {
  10568. // r is THREE.Color, hex or string
  10569. const value = r;
  10570. if ( value && value.isColor ) {
  10571. this.copy( value );
  10572. } else if ( typeof value === 'number' ) {
  10573. this.setHex( value );
  10574. } else if ( typeof value === 'string' ) {
  10575. this.setStyle( value );
  10576. }
  10577. } else {
  10578. this.setRGB( r, g, b );
  10579. }
  10580. return this;
  10581. }
  10582. /**
  10583. * Sets the colors's components to the given scalar value.
  10584. *
  10585. * @param {number} scalar - The scalar value.
  10586. * @return {Color} A reference to this color.
  10587. */
  10588. setScalar( scalar ) {
  10589. this.r = scalar;
  10590. this.g = scalar;
  10591. this.b = scalar;
  10592. return this;
  10593. }
  10594. /**
  10595. * Sets this color from a hexadecimal value.
  10596. *
  10597. * @param {number} hex - The hexadecimal value.
  10598. * @param {string} [colorSpace=SRGBColorSpace] - The color space.
  10599. * @return {Color} A reference to this color.
  10600. */
  10601. setHex( hex, colorSpace = SRGBColorSpace ) {
  10602. hex = Math.floor( hex );
  10603. this.r = ( hex >> 16 & 255 ) / 255;
  10604. this.g = ( hex >> 8 & 255 ) / 255;
  10605. this.b = ( hex & 255 ) / 255;
  10606. ColorManagement.colorSpaceToWorking( this, colorSpace );
  10607. return this;
  10608. }
  10609. /**
  10610. * Sets this color from RGB values.
  10611. *
  10612. * @param {number} r - Red channel value between `0.0` and `1.0`.
  10613. * @param {number} g - Green channel value between `0.0` and `1.0`.
  10614. * @param {number} b - Blue channel value between `0.0` and `1.0`.
  10615. * @param {string} [colorSpace=ColorManagement.workingColorSpace] - The color space.
  10616. * @return {Color} A reference to this color.
  10617. */
  10618. setRGB( r, g, b, colorSpace = ColorManagement.workingColorSpace ) {
  10619. this.r = r;
  10620. this.g = g;
  10621. this.b = b;
  10622. ColorManagement.colorSpaceToWorking( this, colorSpace );
  10623. return this;
  10624. }
  10625. /**
  10626. * Sets this color from RGB values.
  10627. *
  10628. * @param {number} h - Hue value between `0.0` and `1.0`.
  10629. * @param {number} s - Saturation value between `0.0` and `1.0`.
  10630. * @param {number} l - Lightness value between `0.0` and `1.0`.
  10631. * @param {string} [colorSpace=ColorManagement.workingColorSpace] - The color space.
  10632. * @return {Color} A reference to this color.
  10633. */
  10634. setHSL( h, s, l, colorSpace = ColorManagement.workingColorSpace ) {
  10635. // h,s,l ranges are in 0.0 - 1.0
  10636. h = euclideanModulo( h, 1 );
  10637. s = clamp( s, 0, 1 );
  10638. l = clamp( l, 0, 1 );
  10639. if ( s === 0 ) {
  10640. this.r = this.g = this.b = l;
  10641. } else {
  10642. const p = l <= 0.5 ? l * ( 1 + s ) : l + s - ( l * s );
  10643. const q = ( 2 * l ) - p;
  10644. this.r = hue2rgb( q, p, h + 1 / 3 );
  10645. this.g = hue2rgb( q, p, h );
  10646. this.b = hue2rgb( q, p, h - 1 / 3 );
  10647. }
  10648. ColorManagement.colorSpaceToWorking( this, colorSpace );
  10649. return this;
  10650. }
  10651. /**
  10652. * Sets this color from a CSS-style string. For example, `rgb(250, 0,0)`,
  10653. * `rgb(100%, 0%, 0%)`, `hsl(0, 100%, 50%)`, `#ff0000`, `#f00`, or `red` ( or
  10654. * any [X11 color name](https://en.wikipedia.org/wiki/X11_color_names#Color_name_chart) -
  10655. * all 140 color names are supported).
  10656. *
  10657. * @param {string} style - Color as a CSS-style string.
  10658. * @param {string} [colorSpace=SRGBColorSpace] - The color space.
  10659. * @return {Color} A reference to this color.
  10660. */
  10661. setStyle( style, colorSpace = SRGBColorSpace ) {
  10662. function handleAlpha( string ) {
  10663. if ( string === undefined ) return;
  10664. if ( parseFloat( string ) < 1 ) {
  10665. warn( 'Color: Alpha component of ' + style + ' will be ignored.' );
  10666. }
  10667. }
  10668. let m;
  10669. if ( m = /^(\w+)\(([^\)]*)\)/.exec( style ) ) {
  10670. // rgb / hsl
  10671. let color;
  10672. const name = m[ 1 ];
  10673. const components = m[ 2 ];
  10674. switch ( name ) {
  10675. case 'rgb':
  10676. case 'rgba':
  10677. if ( color = /^\s*(\d+)\s*,\s*(\d+)\s*,\s*(\d+)\s*(?:,\s*(\d*\.?\d+)\s*)?$/.exec( components ) ) {
  10678. // rgb(255,0,0) rgba(255,0,0,0.5)
  10679. handleAlpha( color[ 4 ] );
  10680. return this.setRGB(
  10681. Math.min( 255, parseInt( color[ 1 ], 10 ) ) / 255,
  10682. Math.min( 255, parseInt( color[ 2 ], 10 ) ) / 255,
  10683. Math.min( 255, parseInt( color[ 3 ], 10 ) ) / 255,
  10684. colorSpace
  10685. );
  10686. }
  10687. if ( color = /^\s*(\d+)\%\s*,\s*(\d+)\%\s*,\s*(\d+)\%\s*(?:,\s*(\d*\.?\d+)\s*)?$/.exec( components ) ) {
  10688. // rgb(100%,0%,0%) rgba(100%,0%,0%,0.5)
  10689. handleAlpha( color[ 4 ] );
  10690. return this.setRGB(
  10691. Math.min( 100, parseInt( color[ 1 ], 10 ) ) / 100,
  10692. Math.min( 100, parseInt( color[ 2 ], 10 ) ) / 100,
  10693. Math.min( 100, parseInt( color[ 3 ], 10 ) ) / 100,
  10694. colorSpace
  10695. );
  10696. }
  10697. break;
  10698. case 'hsl':
  10699. case 'hsla':
  10700. if ( color = /^\s*(\d*\.?\d+)\s*,\s*(\d*\.?\d+)\%\s*,\s*(\d*\.?\d+)\%\s*(?:,\s*(\d*\.?\d+)\s*)?$/.exec( components ) ) {
  10701. // hsl(120,50%,50%) hsla(120,50%,50%,0.5)
  10702. handleAlpha( color[ 4 ] );
  10703. return this.setHSL(
  10704. parseFloat( color[ 1 ] ) / 360,
  10705. parseFloat( color[ 2 ] ) / 100,
  10706. parseFloat( color[ 3 ] ) / 100,
  10707. colorSpace
  10708. );
  10709. }
  10710. break;
  10711. default:
  10712. warn( 'Color: Unknown color model ' + style );
  10713. }
  10714. } else if ( m = /^\#([A-Fa-f\d]+)$/.exec( style ) ) {
  10715. // hex color
  10716. const hex = m[ 1 ];
  10717. const size = hex.length;
  10718. if ( size === 3 ) {
  10719. // #ff0
  10720. return this.setRGB(
  10721. parseInt( hex.charAt( 0 ), 16 ) / 15,
  10722. parseInt( hex.charAt( 1 ), 16 ) / 15,
  10723. parseInt( hex.charAt( 2 ), 16 ) / 15,
  10724. colorSpace
  10725. );
  10726. } else if ( size === 6 ) {
  10727. // #ff0000
  10728. return this.setHex( parseInt( hex, 16 ), colorSpace );
  10729. } else {
  10730. warn( 'Color: Invalid hex color ' + style );
  10731. }
  10732. } else if ( style && style.length > 0 ) {
  10733. return this.setColorName( style, colorSpace );
  10734. }
  10735. return this;
  10736. }
  10737. /**
  10738. * Sets this color from a color name. Faster than {@link Color#setStyle} if
  10739. * you don't need the other CSS-style formats.
  10740. *
  10741. * For convenience, the list of names is exposed in `Color.NAMES` as a hash.
  10742. * ```js
  10743. * Color.NAMES.aliceblue // returns 0xF0F8FF
  10744. * ```
  10745. *
  10746. * @param {string} style - The color name.
  10747. * @param {string} [colorSpace=SRGBColorSpace] - The color space.
  10748. * @return {Color} A reference to this color.
  10749. */
  10750. setColorName( style, colorSpace = SRGBColorSpace ) {
  10751. // color keywords
  10752. const hex = _colorKeywords[ style.toLowerCase() ];
  10753. if ( hex !== undefined ) {
  10754. // red
  10755. this.setHex( hex, colorSpace );
  10756. } else {
  10757. // unknown color
  10758. warn( 'Color: Unknown color ' + style );
  10759. }
  10760. return this;
  10761. }
  10762. /**
  10763. * Returns a new color with copied values from this instance.
  10764. *
  10765. * @return {Color} A clone of this instance.
  10766. */
  10767. clone() {
  10768. return new this.constructor( this.r, this.g, this.b );
  10769. }
  10770. /**
  10771. * Copies the values of the given color to this instance.
  10772. *
  10773. * @param {Color} color - The color to copy.
  10774. * @return {Color} A reference to this color.
  10775. */
  10776. copy( color ) {
  10777. this.r = color.r;
  10778. this.g = color.g;
  10779. this.b = color.b;
  10780. return this;
  10781. }
  10782. /**
  10783. * Copies the given color into this color, and then converts this color from
  10784. * `SRGBColorSpace` to `LinearSRGBColorSpace`.
  10785. *
  10786. * @param {Color} color - The color to copy/convert.
  10787. * @return {Color} A reference to this color.
  10788. */
  10789. copySRGBToLinear( color ) {
  10790. this.r = SRGBToLinear( color.r );
  10791. this.g = SRGBToLinear( color.g );
  10792. this.b = SRGBToLinear( color.b );
  10793. return this;
  10794. }
  10795. /**
  10796. * Copies the given color into this color, and then converts this color from
  10797. * `LinearSRGBColorSpace` to `SRGBColorSpace`.
  10798. *
  10799. * @param {Color} color - The color to copy/convert.
  10800. * @return {Color} A reference to this color.
  10801. */
  10802. copyLinearToSRGB( color ) {
  10803. this.r = LinearToSRGB( color.r );
  10804. this.g = LinearToSRGB( color.g );
  10805. this.b = LinearToSRGB( color.b );
  10806. return this;
  10807. }
  10808. /**
  10809. * Converts this color from `SRGBColorSpace` to `LinearSRGBColorSpace`.
  10810. *
  10811. * @return {Color} A reference to this color.
  10812. */
  10813. convertSRGBToLinear() {
  10814. this.copySRGBToLinear( this );
  10815. return this;
  10816. }
  10817. /**
  10818. * Converts this color from `LinearSRGBColorSpace` to `SRGBColorSpace`.
  10819. *
  10820. * @return {Color} A reference to this color.
  10821. */
  10822. convertLinearToSRGB() {
  10823. this.copyLinearToSRGB( this );
  10824. return this;
  10825. }
  10826. /**
  10827. * Returns the hexadecimal value of this color.
  10828. *
  10829. * @param {string} [colorSpace=SRGBColorSpace] - The color space.
  10830. * @return {number} The hexadecimal value.
  10831. */
  10832. getHex( colorSpace = SRGBColorSpace ) {
  10833. ColorManagement.workingToColorSpace( _color.copy( this ), colorSpace );
  10834. return Math.round( clamp( _color.r * 255, 0, 255 ) ) * 65536 + Math.round( clamp( _color.g * 255, 0, 255 ) ) * 256 + Math.round( clamp( _color.b * 255, 0, 255 ) );
  10835. }
  10836. /**
  10837. * Returns the hexadecimal value of this color as a string (for example, 'FFFFFF').
  10838. *
  10839. * @param {string} [colorSpace=SRGBColorSpace] - The color space.
  10840. * @return {string} The hexadecimal value as a string.
  10841. */
  10842. getHexString( colorSpace = SRGBColorSpace ) {
  10843. return ( '000000' + this.getHex( colorSpace ).toString( 16 ) ).slice( -6 );
  10844. }
  10845. /**
  10846. * Converts the colors RGB values into the HSL format and stores them into the
  10847. * given target object.
  10848. *
  10849. * @param {{h:number,s:number,l:number}} target - The target object that is used to store the method's result.
  10850. * @param {string} [colorSpace=ColorManagement.workingColorSpace] - The color space.
  10851. * @return {{h:number,s:number,l:number}} The HSL representation of this color.
  10852. */
  10853. getHSL( target, colorSpace = ColorManagement.workingColorSpace ) {
  10854. // h,s,l ranges are in 0.0 - 1.0
  10855. ColorManagement.workingToColorSpace( _color.copy( this ), colorSpace );
  10856. const r = _color.r, g = _color.g, b = _color.b;
  10857. const max = Math.max( r, g, b );
  10858. const min = Math.min( r, g, b );
  10859. let hue, saturation;
  10860. const lightness = ( min + max ) / 2.0;
  10861. if ( min === max ) {
  10862. hue = 0;
  10863. saturation = 0;
  10864. } else {
  10865. const delta = max - min;
  10866. saturation = lightness <= 0.5 ? delta / ( max + min ) : delta / ( 2 - max - min );
  10867. switch ( max ) {
  10868. case r: hue = ( g - b ) / delta + ( g < b ? 6 : 0 ); break;
  10869. case g: hue = ( b - r ) / delta + 2; break;
  10870. case b: hue = ( r - g ) / delta + 4; break;
  10871. }
  10872. hue /= 6;
  10873. }
  10874. target.h = hue;
  10875. target.s = saturation;
  10876. target.l = lightness;
  10877. return target;
  10878. }
  10879. /**
  10880. * Returns the RGB values of this color and stores them into the given target object.
  10881. *
  10882. * @param {Color} target - The target color that is used to store the method's result.
  10883. * @param {string} [colorSpace=ColorManagement.workingColorSpace] - The color space.
  10884. * @return {Color} The RGB representation of this color.
  10885. */
  10886. getRGB( target, colorSpace = ColorManagement.workingColorSpace ) {
  10887. ColorManagement.workingToColorSpace( _color.copy( this ), colorSpace );
  10888. target.r = _color.r;
  10889. target.g = _color.g;
  10890. target.b = _color.b;
  10891. return target;
  10892. }
  10893. /**
  10894. * Returns the value of this color as a CSS style string. Example: `rgb(255,0,0)`.
  10895. *
  10896. * @param {string} [colorSpace=SRGBColorSpace] - The color space.
  10897. * @return {string} The CSS representation of this color.
  10898. */
  10899. getStyle( colorSpace = SRGBColorSpace ) {
  10900. ColorManagement.workingToColorSpace( _color.copy( this ), colorSpace );
  10901. const r = _color.r, g = _color.g, b = _color.b;
  10902. if ( colorSpace !== SRGBColorSpace ) {
  10903. // Requires CSS Color Module Level 4 (https://www.w3.org/TR/css-color-4/).
  10904. return `color(${ colorSpace } ${ r.toFixed( 3 ) } ${ g.toFixed( 3 ) } ${ b.toFixed( 3 ) })`;
  10905. }
  10906. return `rgb(${ Math.round( r * 255 ) },${ Math.round( g * 255 ) },${ Math.round( b * 255 ) })`;
  10907. }
  10908. /**
  10909. * Adds the given HSL values to this color's values.
  10910. * Internally, this converts the color's RGB values to HSL, adds HSL
  10911. * and then converts the color back to RGB.
  10912. *
  10913. * @param {number} h - Hue value between `0.0` and `1.0`.
  10914. * @param {number} s - Saturation value between `0.0` and `1.0`.
  10915. * @param {number} l - Lightness value between `0.0` and `1.0`.
  10916. * @return {Color} A reference to this color.
  10917. */
  10918. offsetHSL( h, s, l ) {
  10919. this.getHSL( _hslA );
  10920. return this.setHSL( _hslA.h + h, _hslA.s + s, _hslA.l + l );
  10921. }
  10922. /**
  10923. * Adds the RGB values of the given color to the RGB values of this color.
  10924. *
  10925. * @param {Color} color - The color to add.
  10926. * @return {Color} A reference to this color.
  10927. */
  10928. add( color ) {
  10929. this.r += color.r;
  10930. this.g += color.g;
  10931. this.b += color.b;
  10932. return this;
  10933. }
  10934. /**
  10935. * Adds the RGB values of the given colors and stores the result in this instance.
  10936. *
  10937. * @param {Color} color1 - The first color.
  10938. * @param {Color} color2 - The second color.
  10939. * @return {Color} A reference to this color.
  10940. */
  10941. addColors( color1, color2 ) {
  10942. this.r = color1.r + color2.r;
  10943. this.g = color1.g + color2.g;
  10944. this.b = color1.b + color2.b;
  10945. return this;
  10946. }
  10947. /**
  10948. * Adds the given scalar value to the RGB values of this color.
  10949. *
  10950. * @param {number} s - The scalar to add.
  10951. * @return {Color} A reference to this color.
  10952. */
  10953. addScalar( s ) {
  10954. this.r += s;
  10955. this.g += s;
  10956. this.b += s;
  10957. return this;
  10958. }
  10959. /**
  10960. * Subtracts the RGB values of the given color from the RGB values of this color.
  10961. *
  10962. * @param {Color} color - The color to subtract.
  10963. * @return {Color} A reference to this color.
  10964. */
  10965. sub( color ) {
  10966. this.r = Math.max( 0, this.r - color.r );
  10967. this.g = Math.max( 0, this.g - color.g );
  10968. this.b = Math.max( 0, this.b - color.b );
  10969. return this;
  10970. }
  10971. /**
  10972. * Multiplies the RGB values of the given color with the RGB values of this color.
  10973. *
  10974. * @param {Color} color - The color to multiply.
  10975. * @return {Color} A reference to this color.
  10976. */
  10977. multiply( color ) {
  10978. this.r *= color.r;
  10979. this.g *= color.g;
  10980. this.b *= color.b;
  10981. return this;
  10982. }
  10983. /**
  10984. * Multiplies the given scalar value with the RGB values of this color.
  10985. *
  10986. * @param {number} s - The scalar to multiply.
  10987. * @return {Color} A reference to this color.
  10988. */
  10989. multiplyScalar( s ) {
  10990. this.r *= s;
  10991. this.g *= s;
  10992. this.b *= s;
  10993. return this;
  10994. }
  10995. /**
  10996. * Linearly interpolates this color's RGB values toward the RGB values of the
  10997. * given color. The alpha argument can be thought of as the ratio between
  10998. * the two colors, where `0.0` is this color and `1.0` is the first argument.
  10999. *
  11000. * @param {Color} color - The color to converge on.
  11001. * @param {number} alpha - The interpolation factor in the closed interval `[0,1]`.
  11002. * @return {Color} A reference to this color.
  11003. */
  11004. lerp( color, alpha ) {
  11005. this.r += ( color.r - this.r ) * alpha;
  11006. this.g += ( color.g - this.g ) * alpha;
  11007. this.b += ( color.b - this.b ) * alpha;
  11008. return this;
  11009. }
  11010. /**
  11011. * Linearly interpolates between the given colors and stores the result in this instance.
  11012. * The alpha argument can be thought of as the ratio between the two colors, where `0.0`
  11013. * is the first and `1.0` is the second color.
  11014. *
  11015. * @param {Color} color1 - The first color.
  11016. * @param {Color} color2 - The second color.
  11017. * @param {number} alpha - The interpolation factor in the closed interval `[0,1]`.
  11018. * @return {Color} A reference to this color.
  11019. */
  11020. lerpColors( color1, color2, alpha ) {
  11021. this.r = color1.r + ( color2.r - color1.r ) * alpha;
  11022. this.g = color1.g + ( color2.g - color1.g ) * alpha;
  11023. this.b = color1.b + ( color2.b - color1.b ) * alpha;
  11024. return this;
  11025. }
  11026. /**
  11027. * Linearly interpolates this color's HSL values toward the HSL values of the
  11028. * given color. It differs from {@link Color#lerp} by not interpolating straight
  11029. * from one color to the other, but instead going through all the hues in between
  11030. * those two colors. The alpha argument can be thought of as the ratio between
  11031. * the two colors, where 0.0 is this color and 1.0 is the first argument.
  11032. *
  11033. * @param {Color} color - The color to converge on.
  11034. * @param {number} alpha - The interpolation factor in the closed interval `[0,1]`.
  11035. * @return {Color} A reference to this color.
  11036. */
  11037. lerpHSL( color, alpha ) {
  11038. this.getHSL( _hslA );
  11039. color.getHSL( _hslB );
  11040. const h = lerp( _hslA.h, _hslB.h, alpha );
  11041. const s = lerp( _hslA.s, _hslB.s, alpha );
  11042. const l = lerp( _hslA.l, _hslB.l, alpha );
  11043. this.setHSL( h, s, l );
  11044. return this;
  11045. }
  11046. /**
  11047. * Sets the color's RGB components from the given 3D vector.
  11048. *
  11049. * @param {Vector3} v - The vector to set.
  11050. * @return {Color} A reference to this color.
  11051. */
  11052. setFromVector3( v ) {
  11053. this.r = v.x;
  11054. this.g = v.y;
  11055. this.b = v.z;
  11056. return this;
  11057. }
  11058. /**
  11059. * Transforms this color with the given 3x3 matrix.
  11060. *
  11061. * @param {Matrix3} m - The matrix.
  11062. * @return {Color} A reference to this color.
  11063. */
  11064. applyMatrix3( m ) {
  11065. const r = this.r, g = this.g, b = this.b;
  11066. const e = m.elements;
  11067. this.r = e[ 0 ] * r + e[ 3 ] * g + e[ 6 ] * b;
  11068. this.g = e[ 1 ] * r + e[ 4 ] * g + e[ 7 ] * b;
  11069. this.b = e[ 2 ] * r + e[ 5 ] * g + e[ 8 ] * b;
  11070. return this;
  11071. }
  11072. /**
  11073. * Returns `true` if this color is equal with the given one.
  11074. *
  11075. * @param {Color} c - The color to test for equality.
  11076. * @return {boolean} Whether this bounding color is equal with the given one.
  11077. */
  11078. equals( c ) {
  11079. return ( c.r === this.r ) && ( c.g === this.g ) && ( c.b === this.b );
  11080. }
  11081. /**
  11082. * Sets this color's RGB components from the given array.
  11083. *
  11084. * @param {Array<number>} array - An array holding the RGB values.
  11085. * @param {number} [offset=0] - The offset into the array.
  11086. * @return {Color} A reference to this color.
  11087. */
  11088. fromArray( array, offset = 0 ) {
  11089. this.r = array[ offset ];
  11090. this.g = array[ offset + 1 ];
  11091. this.b = array[ offset + 2 ];
  11092. return this;
  11093. }
  11094. /**
  11095. * Writes the RGB components of this color to the given array. If no array is provided,
  11096. * the method returns a new instance.
  11097. *
  11098. * @param {Array<number>} [array=[]] - The target array holding the color components.
  11099. * @param {number} [offset=0] - Index of the first element in the array.
  11100. * @return {Array<number>} The color components.
  11101. */
  11102. toArray( array = [], offset = 0 ) {
  11103. array[ offset ] = this.r;
  11104. array[ offset + 1 ] = this.g;
  11105. array[ offset + 2 ] = this.b;
  11106. return array;
  11107. }
  11108. /**
  11109. * Sets the components of this color from the given buffer attribute.
  11110. *
  11111. * @param {BufferAttribute} attribute - The buffer attribute holding color data.
  11112. * @param {number} index - The index into the attribute.
  11113. * @return {Color} A reference to this color.
  11114. */
  11115. fromBufferAttribute( attribute, index ) {
  11116. this.r = attribute.getX( index );
  11117. this.g = attribute.getY( index );
  11118. this.b = attribute.getZ( index );
  11119. return this;
  11120. }
  11121. /**
  11122. * This methods defines the serialization result of this class. Returns the color
  11123. * as a hexadecimal value.
  11124. *
  11125. * @return {number} The hexadecimal value.
  11126. */
  11127. toJSON() {
  11128. return this.getHex();
  11129. }
  11130. *[ Symbol.iterator ]() {
  11131. yield this.r;
  11132. yield this.g;
  11133. yield this.b;
  11134. }
  11135. }
  11136. const _color = /*@__PURE__*/ new Color();
  11137. /**
  11138. * A dictionary with X11 color names.
  11139. *
  11140. * Note that multiple words such as Dark Orange become the string 'darkorange'.
  11141. *
  11142. * @static
  11143. * @type {Object}
  11144. */
  11145. Color.NAMES = _colorKeywords;
  11146. /**
  11147. * This class can be used to define an exponential squared fog,
  11148. * which gives a clear view near the camera and a faster than exponentially
  11149. * densening fog farther from the camera.
  11150. *
  11151. * ```js
  11152. * const scene = new THREE.Scene();
  11153. * scene.fog = new THREE.FogExp2( 0xcccccc, 0.002 );
  11154. * ```
  11155. */
  11156. class FogExp2 {
  11157. /**
  11158. * Constructs a new fog.
  11159. *
  11160. * @param {number|Color} color - The fog's color.
  11161. * @param {number} [density=0.00025] - Defines how fast the fog will grow dense.
  11162. */
  11163. constructor( color, density = 0.00025 ) {
  11164. /**
  11165. * This flag can be used for type testing.
  11166. *
  11167. * @type {boolean}
  11168. * @readonly
  11169. * @default true
  11170. */
  11171. this.isFogExp2 = true;
  11172. /**
  11173. * The name of the fog.
  11174. *
  11175. * @type {string}
  11176. */
  11177. this.name = '';
  11178. /**
  11179. * The fog's color.
  11180. *
  11181. * @type {Color}
  11182. */
  11183. this.color = new Color( color );
  11184. /**
  11185. * Defines how fast the fog will grow dense.
  11186. *
  11187. * @type {number}
  11188. * @default 0.00025
  11189. */
  11190. this.density = density;
  11191. }
  11192. /**
  11193. * Returns a new fog with copied values from this instance.
  11194. *
  11195. * @return {FogExp2} A clone of this instance.
  11196. */
  11197. clone() {
  11198. return new FogExp2( this.color, this.density );
  11199. }
  11200. /**
  11201. * Serializes the fog into JSON.
  11202. *
  11203. * @param {?(Object|string)} meta - An optional value holding meta information about the serialization.
  11204. * @return {Object} A JSON object representing the serialized fog
  11205. */
  11206. toJSON( /* meta */ ) {
  11207. return {
  11208. type: 'FogExp2',
  11209. name: this.name,
  11210. color: this.color.getHex(),
  11211. density: this.density
  11212. };
  11213. }
  11214. }
  11215. /**
  11216. * This class can be used to define a linear fog that grows linearly denser
  11217. * with the distance.
  11218. *
  11219. * ```js
  11220. * const scene = new THREE.Scene();
  11221. * scene.fog = new THREE.Fog( 0xcccccc, 10, 15 );
  11222. * ```
  11223. */
  11224. class Fog {
  11225. /**
  11226. * Constructs a new fog.
  11227. *
  11228. * @param {number|Color} color - The fog's color.
  11229. * @param {number} [near=1] - The minimum distance to start applying fog.
  11230. * @param {number} [far=1000] - The maximum distance at which fog stops being calculated and applied.
  11231. */
  11232. constructor( color, near = 1, far = 1000 ) {
  11233. /**
  11234. * This flag can be used for type testing.
  11235. *
  11236. * @type {boolean}
  11237. * @readonly
  11238. * @default true
  11239. */
  11240. this.isFog = true;
  11241. /**
  11242. * The name of the fog.
  11243. *
  11244. * @type {string}
  11245. */
  11246. this.name = '';
  11247. /**
  11248. * The fog's color.
  11249. *
  11250. * @type {Color}
  11251. */
  11252. this.color = new Color( color );
  11253. /**
  11254. * The minimum distance to start applying fog. Objects that are less than
  11255. * `near` units from the active camera won't be affected by fog.
  11256. *
  11257. * @type {number}
  11258. * @default 1
  11259. */
  11260. this.near = near;
  11261. /**
  11262. * The maximum distance at which fog stops being calculated and applied.
  11263. * Objects that are more than `far` units away from the active camera won't
  11264. * be affected by fog.
  11265. *
  11266. * @type {number}
  11267. * @default 1000
  11268. */
  11269. this.far = far;
  11270. }
  11271. /**
  11272. * Returns a new fog with copied values from this instance.
  11273. *
  11274. * @return {Fog} A clone of this instance.
  11275. */
  11276. clone() {
  11277. return new Fog( this.color, this.near, this.far );
  11278. }
  11279. /**
  11280. * Serializes the fog into JSON.
  11281. *
  11282. * @param {?(Object|string)} meta - An optional value holding meta information about the serialization.
  11283. * @return {Object} A JSON object representing the serialized fog
  11284. */
  11285. toJSON( /* meta */ ) {
  11286. return {
  11287. type: 'Fog',
  11288. name: this.name,
  11289. color: this.color.getHex(),
  11290. near: this.near,
  11291. far: this.far
  11292. };
  11293. }
  11294. }
  11295. /**
  11296. * Scenes allow you to set up what is to be rendered and where by three.js.
  11297. * This is where you place 3D objects like meshes, lines or lights.
  11298. *
  11299. * @augments Object3D
  11300. */
  11301. class Scene extends Object3D {
  11302. /**
  11303. * Constructs a new scene.
  11304. */
  11305. constructor() {
  11306. super();
  11307. /**
  11308. * This flag can be used for type testing.
  11309. *
  11310. * @type {boolean}
  11311. * @readonly
  11312. * @default true
  11313. */
  11314. this.isScene = true;
  11315. this.type = 'Scene';
  11316. /**
  11317. * Defines the background of the scene. Valid inputs are:
  11318. *
  11319. * - A color for defining a uniform colored background.
  11320. * - A texture for defining a (flat) textured background.
  11321. * - Cube textures or equirectangular textures for defining a skybox.
  11322. *
  11323. * @type {?(Color|Texture)}
  11324. * @default null
  11325. */
  11326. this.background = null;
  11327. /**
  11328. * Sets the environment map for all physical materials in the scene. However,
  11329. * it's not possible to overwrite an existing texture assigned to the `envMap`
  11330. * material property.
  11331. *
  11332. * @type {?Texture}
  11333. * @default null
  11334. */
  11335. this.environment = null;
  11336. /**
  11337. * A fog instance defining the type of fog that affects everything
  11338. * rendered in the scene.
  11339. *
  11340. * @type {?(Fog|FogExp2)}
  11341. * @default null
  11342. */
  11343. this.fog = null;
  11344. /**
  11345. * Sets the blurriness of the background. Only influences environment maps
  11346. * assigned to {@link Scene#background}. Valid input is a float between `0`
  11347. * and `1`.
  11348. *
  11349. * @type {number}
  11350. * @default 0
  11351. */
  11352. this.backgroundBlurriness = 0;
  11353. /**
  11354. * Attenuates the color of the background. Only applies to background textures.
  11355. *
  11356. * @type {number}
  11357. * @default 1
  11358. */
  11359. this.backgroundIntensity = 1;
  11360. /**
  11361. * The rotation of the background in radians. Only influences environment maps
  11362. * assigned to {@link Scene#background}.
  11363. *
  11364. * @type {Euler}
  11365. * @default (0,0,0)
  11366. */
  11367. this.backgroundRotation = new Euler();
  11368. /**
  11369. * Attenuates the color of the environment. Only influences environment maps
  11370. * assigned to {@link Scene#environment}.
  11371. *
  11372. * @type {number}
  11373. * @default 1
  11374. */
  11375. this.environmentIntensity = 1;
  11376. /**
  11377. * The rotation of the environment map in radians. Only influences physical materials
  11378. * in the scene when {@link Scene#environment} is used.
  11379. *
  11380. * @type {Euler}
  11381. * @default (0,0,0)
  11382. */
  11383. this.environmentRotation = new Euler();
  11384. /**
  11385. * Forces everything in the scene to be rendered with the defined material. It is possible
  11386. * to exclude materials from override by setting {@link Material#allowOverride} to `false`.
  11387. *
  11388. * @type {?Material}
  11389. * @default null
  11390. */
  11391. this.overrideMaterial = null;
  11392. if ( typeof __THREE_DEVTOOLS__ !== 'undefined' ) {
  11393. __THREE_DEVTOOLS__.dispatchEvent( new CustomEvent( 'observe', { detail: this } ) );
  11394. }
  11395. }
  11396. copy( source, recursive ) {
  11397. super.copy( source, recursive );
  11398. if ( source.background !== null ) this.background = source.background.clone();
  11399. if ( source.environment !== null ) this.environment = source.environment.clone();
  11400. if ( source.fog !== null ) this.fog = source.fog.clone();
  11401. this.backgroundBlurriness = source.backgroundBlurriness;
  11402. this.backgroundIntensity = source.backgroundIntensity;
  11403. this.backgroundRotation.copy( source.backgroundRotation );
  11404. this.environmentIntensity = source.environmentIntensity;
  11405. this.environmentRotation.copy( source.environmentRotation );
  11406. if ( source.overrideMaterial !== null ) this.overrideMaterial = source.overrideMaterial.clone();
  11407. this.matrixAutoUpdate = source.matrixAutoUpdate;
  11408. return this;
  11409. }
  11410. toJSON( meta ) {
  11411. const data = super.toJSON( meta );
  11412. if ( this.fog !== null ) data.object.fog = this.fog.toJSON();
  11413. if ( this.backgroundBlurriness > 0 ) data.object.backgroundBlurriness = this.backgroundBlurriness;
  11414. if ( this.backgroundIntensity !== 1 ) data.object.backgroundIntensity = this.backgroundIntensity;
  11415. data.object.backgroundRotation = this.backgroundRotation.toArray();
  11416. if ( this.environmentIntensity !== 1 ) data.object.environmentIntensity = this.environmentIntensity;
  11417. data.object.environmentRotation = this.environmentRotation.toArray();
  11418. return data;
  11419. }
  11420. }
  11421. const _v0$2 = /*@__PURE__*/ new Vector3();
  11422. const _v1$5 = /*@__PURE__*/ new Vector3();
  11423. const _v2$4 = /*@__PURE__*/ new Vector3();
  11424. const _v3$2 = /*@__PURE__*/ new Vector3();
  11425. const _vab = /*@__PURE__*/ new Vector3();
  11426. const _vac = /*@__PURE__*/ new Vector3();
  11427. const _vbc = /*@__PURE__*/ new Vector3();
  11428. const _vap = /*@__PURE__*/ new Vector3();
  11429. const _vbp = /*@__PURE__*/ new Vector3();
  11430. const _vcp = /*@__PURE__*/ new Vector3();
  11431. const _v40 = /*@__PURE__*/ new Vector4();
  11432. const _v41 = /*@__PURE__*/ new Vector4();
  11433. const _v42 = /*@__PURE__*/ new Vector4();
  11434. /**
  11435. * A geometric triangle as defined by three vectors representing its three corners.
  11436. */
  11437. class Triangle {
  11438. /**
  11439. * Constructs a new triangle.
  11440. *
  11441. * @param {Vector3} [a=(0,0,0)] - The first corner of the triangle.
  11442. * @param {Vector3} [b=(0,0,0)] - The second corner of the triangle.
  11443. * @param {Vector3} [c=(0,0,0)] - The third corner of the triangle.
  11444. */
  11445. constructor( a = new Vector3(), b = new Vector3(), c = new Vector3() ) {
  11446. /**
  11447. * The first corner of the triangle.
  11448. *
  11449. * @type {Vector3}
  11450. */
  11451. this.a = a;
  11452. /**
  11453. * The second corner of the triangle.
  11454. *
  11455. * @type {Vector3}
  11456. */
  11457. this.b = b;
  11458. /**
  11459. * The third corner of the triangle.
  11460. *
  11461. * @type {Vector3}
  11462. */
  11463. this.c = c;
  11464. }
  11465. /**
  11466. * Computes the normal vector of a triangle.
  11467. *
  11468. * @param {Vector3} a - The first corner of the triangle.
  11469. * @param {Vector3} b - The second corner of the triangle.
  11470. * @param {Vector3} c - The third corner of the triangle.
  11471. * @param {Vector3} target - The target vector that is used to store the method's result.
  11472. * @return {Vector3} The triangle's normal.
  11473. */
  11474. static getNormal( a, b, c, target ) {
  11475. target.subVectors( c, b );
  11476. _v0$2.subVectors( a, b );
  11477. target.cross( _v0$2 );
  11478. const targetLengthSq = target.lengthSq();
  11479. if ( targetLengthSq > 0 ) {
  11480. return target.multiplyScalar( 1 / Math.sqrt( targetLengthSq ) );
  11481. }
  11482. return target.set( 0, 0, 0 );
  11483. }
  11484. /**
  11485. * Computes a barycentric coordinates from the given vector.
  11486. * Returns `null` if the triangle is degenerate.
  11487. *
  11488. * @param {Vector3} point - A point in 3D space.
  11489. * @param {Vector3} a - The first corner of the triangle.
  11490. * @param {Vector3} b - The second corner of the triangle.
  11491. * @param {Vector3} c - The third corner of the triangle.
  11492. * @param {Vector3} target - The target vector that is used to store the method's result.
  11493. * @return {?Vector3} The barycentric coordinates for the given point
  11494. */
  11495. static getBarycoord( point, a, b, c, target ) {
  11496. // based on: http://www.blackpawn.com/texts/pointinpoly/default.html
  11497. _v0$2.subVectors( c, a );
  11498. _v1$5.subVectors( b, a );
  11499. _v2$4.subVectors( point, a );
  11500. const dot00 = _v0$2.dot( _v0$2 );
  11501. const dot01 = _v0$2.dot( _v1$5 );
  11502. const dot02 = _v0$2.dot( _v2$4 );
  11503. const dot11 = _v1$5.dot( _v1$5 );
  11504. const dot12 = _v1$5.dot( _v2$4 );
  11505. const denom = ( dot00 * dot11 - dot01 * dot01 );
  11506. // collinear or singular triangle
  11507. if ( denom === 0 ) {
  11508. target.set( 0, 0, 0 );
  11509. return null;
  11510. }
  11511. const invDenom = 1 / denom;
  11512. const u = ( dot11 * dot02 - dot01 * dot12 ) * invDenom;
  11513. const v = ( dot00 * dot12 - dot01 * dot02 ) * invDenom;
  11514. // barycentric coordinates must always sum to 1
  11515. return target.set( 1 - u - v, v, u );
  11516. }
  11517. /**
  11518. * Returns `true` if the given point, when projected onto the plane of the
  11519. * triangle, lies within the triangle.
  11520. *
  11521. * @param {Vector3} point - The point in 3D space to test.
  11522. * @param {Vector3} a - The first corner of the triangle.
  11523. * @param {Vector3} b - The second corner of the triangle.
  11524. * @param {Vector3} c - The third corner of the triangle.
  11525. * @return {boolean} Whether the given point, when projected onto the plane of the
  11526. * triangle, lies within the triangle or not.
  11527. */
  11528. static containsPoint( point, a, b, c ) {
  11529. // if the triangle is degenerate then we can't contain a point
  11530. if ( this.getBarycoord( point, a, b, c, _v3$2 ) === null ) {
  11531. return false;
  11532. }
  11533. return ( _v3$2.x >= 0 ) && ( _v3$2.y >= 0 ) && ( ( _v3$2.x + _v3$2.y ) <= 1 );
  11534. }
  11535. /**
  11536. * Computes the value barycentrically interpolated for the given point on the
  11537. * triangle. Returns `null` if the triangle is degenerate.
  11538. *
  11539. * @param {Vector3} point - Position of interpolated point.
  11540. * @param {Vector3} p1 - The first corner of the triangle.
  11541. * @param {Vector3} p2 - The second corner of the triangle.
  11542. * @param {Vector3} p3 - The third corner of the triangle.
  11543. * @param {Vector3} v1 - Value to interpolate of first vertex.
  11544. * @param {Vector3} v2 - Value to interpolate of second vertex.
  11545. * @param {Vector3} v3 - Value to interpolate of third vertex.
  11546. * @param {Vector3} target - The target vector that is used to store the method's result.
  11547. * @return {?Vector3} The interpolated value.
  11548. */
  11549. static getInterpolation( point, p1, p2, p3, v1, v2, v3, target ) {
  11550. if ( this.getBarycoord( point, p1, p2, p3, _v3$2 ) === null ) {
  11551. target.x = 0;
  11552. target.y = 0;
  11553. if ( 'z' in target ) target.z = 0;
  11554. if ( 'w' in target ) target.w = 0;
  11555. return null;
  11556. }
  11557. target.setScalar( 0 );
  11558. target.addScaledVector( v1, _v3$2.x );
  11559. target.addScaledVector( v2, _v3$2.y );
  11560. target.addScaledVector( v3, _v3$2.z );
  11561. return target;
  11562. }
  11563. /**
  11564. * Computes the value barycentrically interpolated for the given attribute and indices.
  11565. *
  11566. * @param {BufferAttribute} attr - The attribute to interpolate.
  11567. * @param {number} i1 - Index of first vertex.
  11568. * @param {number} i2 - Index of second vertex.
  11569. * @param {number} i3 - Index of third vertex.
  11570. * @param {Vector3} barycoord - The barycoordinate value to use to interpolate.
  11571. * @param {Vector3} target - The target vector that is used to store the method's result.
  11572. * @return {Vector3} The interpolated attribute value.
  11573. */
  11574. static getInterpolatedAttribute( attr, i1, i2, i3, barycoord, target ) {
  11575. _v40.setScalar( 0 );
  11576. _v41.setScalar( 0 );
  11577. _v42.setScalar( 0 );
  11578. _v40.fromBufferAttribute( attr, i1 );
  11579. _v41.fromBufferAttribute( attr, i2 );
  11580. _v42.fromBufferAttribute( attr, i3 );
  11581. target.setScalar( 0 );
  11582. target.addScaledVector( _v40, barycoord.x );
  11583. target.addScaledVector( _v41, barycoord.y );
  11584. target.addScaledVector( _v42, barycoord.z );
  11585. return target;
  11586. }
  11587. /**
  11588. * Returns `true` if the triangle is oriented towards the given direction.
  11589. *
  11590. * @param {Vector3} a - The first corner of the triangle.
  11591. * @param {Vector3} b - The second corner of the triangle.
  11592. * @param {Vector3} c - The third corner of the triangle.
  11593. * @param {Vector3} direction - The (normalized) direction vector.
  11594. * @return {boolean} Whether the triangle is oriented towards the given direction or not.
  11595. */
  11596. static isFrontFacing( a, b, c, direction ) {
  11597. _v0$2.subVectors( c, b );
  11598. _v1$5.subVectors( a, b );
  11599. // strictly front facing
  11600. return ( _v0$2.cross( _v1$5 ).dot( direction ) < 0 ) ? true : false;
  11601. }
  11602. /**
  11603. * Sets the triangle's vertices by copying the given values.
  11604. *
  11605. * @param {Vector3} a - The first corner of the triangle.
  11606. * @param {Vector3} b - The second corner of the triangle.
  11607. * @param {Vector3} c - The third corner of the triangle.
  11608. * @return {Triangle} A reference to this triangle.
  11609. */
  11610. set( a, b, c ) {
  11611. this.a.copy( a );
  11612. this.b.copy( b );
  11613. this.c.copy( c );
  11614. return this;
  11615. }
  11616. /**
  11617. * Sets the triangle's vertices by copying the given array values.
  11618. *
  11619. * @param {Array<Vector3>} points - An array with 3D points.
  11620. * @param {number} i0 - The array index representing the first corner of the triangle.
  11621. * @param {number} i1 - The array index representing the second corner of the triangle.
  11622. * @param {number} i2 - The array index representing the third corner of the triangle.
  11623. * @return {Triangle} A reference to this triangle.
  11624. */
  11625. setFromPointsAndIndices( points, i0, i1, i2 ) {
  11626. this.a.copy( points[ i0 ] );
  11627. this.b.copy( points[ i1 ] );
  11628. this.c.copy( points[ i2 ] );
  11629. return this;
  11630. }
  11631. /**
  11632. * Sets the triangle's vertices by copying the given attribute values.
  11633. *
  11634. * @param {BufferAttribute} attribute - A buffer attribute with 3D points data.
  11635. * @param {number} i0 - The attribute index representing the first corner of the triangle.
  11636. * @param {number} i1 - The attribute index representing the second corner of the triangle.
  11637. * @param {number} i2 - The attribute index representing the third corner of the triangle.
  11638. * @return {Triangle} A reference to this triangle.
  11639. */
  11640. setFromAttributeAndIndices( attribute, i0, i1, i2 ) {
  11641. this.a.fromBufferAttribute( attribute, i0 );
  11642. this.b.fromBufferAttribute( attribute, i1 );
  11643. this.c.fromBufferAttribute( attribute, i2 );
  11644. return this;
  11645. }
  11646. /**
  11647. * Returns a new triangle with copied values from this instance.
  11648. *
  11649. * @return {Triangle} A clone of this instance.
  11650. */
  11651. clone() {
  11652. return new this.constructor().copy( this );
  11653. }
  11654. /**
  11655. * Copies the values of the given triangle to this instance.
  11656. *
  11657. * @param {Triangle} triangle - The triangle to copy.
  11658. * @return {Triangle} A reference to this triangle.
  11659. */
  11660. copy( triangle ) {
  11661. this.a.copy( triangle.a );
  11662. this.b.copy( triangle.b );
  11663. this.c.copy( triangle.c );
  11664. return this;
  11665. }
  11666. /**
  11667. * Computes the area of the triangle.
  11668. *
  11669. * @return {number} The triangle's area.
  11670. */
  11671. getArea() {
  11672. _v0$2.subVectors( this.c, this.b );
  11673. _v1$5.subVectors( this.a, this.b );
  11674. return _v0$2.cross( _v1$5 ).length() * 0.5;
  11675. }
  11676. /**
  11677. * Computes the midpoint of the triangle.
  11678. *
  11679. * @param {Vector3} target - The target vector that is used to store the method's result.
  11680. * @return {Vector3} The triangle's midpoint.
  11681. */
  11682. getMidpoint( target ) {
  11683. return target.addVectors( this.a, this.b ).add( this.c ).multiplyScalar( 1 / 3 );
  11684. }
  11685. /**
  11686. * Computes the normal of the triangle.
  11687. *
  11688. * @param {Vector3} target - The target vector that is used to store the method's result.
  11689. * @return {Vector3} The triangle's normal.
  11690. */
  11691. getNormal( target ) {
  11692. return Triangle.getNormal( this.a, this.b, this.c, target );
  11693. }
  11694. /**
  11695. * Computes a plane the triangle lies within.
  11696. *
  11697. * @param {Plane} target - The target vector that is used to store the method's result.
  11698. * @return {Plane} The plane the triangle lies within.
  11699. */
  11700. getPlane( target ) {
  11701. return target.setFromCoplanarPoints( this.a, this.b, this.c );
  11702. }
  11703. /**
  11704. * Computes a barycentric coordinates from the given vector.
  11705. * Returns `null` if the triangle is degenerate.
  11706. *
  11707. * @param {Vector3} point - A point in 3D space.
  11708. * @param {Vector3} target - The target vector that is used to store the method's result.
  11709. * @return {?Vector3} The barycentric coordinates for the given point
  11710. */
  11711. getBarycoord( point, target ) {
  11712. return Triangle.getBarycoord( point, this.a, this.b, this.c, target );
  11713. }
  11714. /**
  11715. * Computes the value barycentrically interpolated for the given point on the
  11716. * triangle. Returns `null` if the triangle is degenerate.
  11717. *
  11718. * @param {Vector3} point - Position of interpolated point.
  11719. * @param {Vector3} v1 - Value to interpolate of first vertex.
  11720. * @param {Vector3} v2 - Value to interpolate of second vertex.
  11721. * @param {Vector3} v3 - Value to interpolate of third vertex.
  11722. * @param {Vector3} target - The target vector that is used to store the method's result.
  11723. * @return {?Vector3} The interpolated value.
  11724. */
  11725. getInterpolation( point, v1, v2, v3, target ) {
  11726. return Triangle.getInterpolation( point, this.a, this.b, this.c, v1, v2, v3, target );
  11727. }
  11728. /**
  11729. * Returns `true` if the given point, when projected onto the plane of the
  11730. * triangle, lies within the triangle.
  11731. *
  11732. * @param {Vector3} point - The point in 3D space to test.
  11733. * @return {boolean} Whether the given point, when projected onto the plane of the
  11734. * triangle, lies within the triangle or not.
  11735. */
  11736. containsPoint( point ) {
  11737. return Triangle.containsPoint( point, this.a, this.b, this.c );
  11738. }
  11739. /**
  11740. * Returns `true` if the triangle is oriented towards the given direction.
  11741. *
  11742. * @param {Vector3} direction - The (normalized) direction vector.
  11743. * @return {boolean} Whether the triangle is oriented towards the given direction or not.
  11744. */
  11745. isFrontFacing( direction ) {
  11746. return Triangle.isFrontFacing( this.a, this.b, this.c, direction );
  11747. }
  11748. /**
  11749. * Returns `true` if this triangle intersects with the given box.
  11750. *
  11751. * @param {Box3} box - The box to intersect.
  11752. * @return {boolean} Whether this triangle intersects with the given box or not.
  11753. */
  11754. intersectsBox( box ) {
  11755. return box.intersectsTriangle( this );
  11756. }
  11757. /**
  11758. * Returns the closest point on the triangle to the given point.
  11759. *
  11760. * @param {Vector3} p - The point to compute the closest point for.
  11761. * @param {Vector3} target - The target vector that is used to store the method's result.
  11762. * @return {Vector3} The closest point on the triangle.
  11763. */
  11764. closestPointToPoint( p, target ) {
  11765. const a = this.a, b = this.b, c = this.c;
  11766. let v, w;
  11767. // algorithm thanks to Real-Time Collision Detection by Christer Ericson,
  11768. // published by Morgan Kaufmann Publishers, (c) 2005 Elsevier Inc.,
  11769. // under the accompanying license; see chapter 5.1.5 for detailed explanation.
  11770. // basically, we're distinguishing which of the voronoi regions of the triangle
  11771. // the point lies in with the minimum amount of redundant computation.
  11772. _vab.subVectors( b, a );
  11773. _vac.subVectors( c, a );
  11774. _vap.subVectors( p, a );
  11775. const d1 = _vab.dot( _vap );
  11776. const d2 = _vac.dot( _vap );
  11777. if ( d1 <= 0 && d2 <= 0 ) {
  11778. // vertex region of A; barycentric coords (1, 0, 0)
  11779. return target.copy( a );
  11780. }
  11781. _vbp.subVectors( p, b );
  11782. const d3 = _vab.dot( _vbp );
  11783. const d4 = _vac.dot( _vbp );
  11784. if ( d3 >= 0 && d4 <= d3 ) {
  11785. // vertex region of B; barycentric coords (0, 1, 0)
  11786. return target.copy( b );
  11787. }
  11788. const vc = d1 * d4 - d3 * d2;
  11789. if ( vc <= 0 && d1 >= 0 && d3 <= 0 ) {
  11790. v = d1 / ( d1 - d3 );
  11791. // edge region of AB; barycentric coords (1-v, v, 0)
  11792. return target.copy( a ).addScaledVector( _vab, v );
  11793. }
  11794. _vcp.subVectors( p, c );
  11795. const d5 = _vab.dot( _vcp );
  11796. const d6 = _vac.dot( _vcp );
  11797. if ( d6 >= 0 && d5 <= d6 ) {
  11798. // vertex region of C; barycentric coords (0, 0, 1)
  11799. return target.copy( c );
  11800. }
  11801. const vb = d5 * d2 - d1 * d6;
  11802. if ( vb <= 0 && d2 >= 0 && d6 <= 0 ) {
  11803. w = d2 / ( d2 - d6 );
  11804. // edge region of AC; barycentric coords (1-w, 0, w)
  11805. return target.copy( a ).addScaledVector( _vac, w );
  11806. }
  11807. const va = d3 * d6 - d5 * d4;
  11808. if ( va <= 0 && ( d4 - d3 ) >= 0 && ( d5 - d6 ) >= 0 ) {
  11809. _vbc.subVectors( c, b );
  11810. w = ( d4 - d3 ) / ( ( d4 - d3 ) + ( d5 - d6 ) );
  11811. // edge region of BC; barycentric coords (0, 1-w, w)
  11812. return target.copy( b ).addScaledVector( _vbc, w ); // edge region of BC
  11813. }
  11814. // face region
  11815. const denom = 1 / ( va + vb + vc );
  11816. // u = va * denom
  11817. v = vb * denom;
  11818. w = vc * denom;
  11819. return target.copy( a ).addScaledVector( _vab, v ).addScaledVector( _vac, w );
  11820. }
  11821. /**
  11822. * Returns `true` if this triangle is equal with the given one.
  11823. *
  11824. * @param {Triangle} triangle - The triangle to test for equality.
  11825. * @return {boolean} Whether this triangle is equal with the given one.
  11826. */
  11827. equals( triangle ) {
  11828. return triangle.a.equals( this.a ) && triangle.b.equals( this.b ) && triangle.c.equals( this.c );
  11829. }
  11830. }
  11831. /**
  11832. * Represents an axis-aligned bounding box (AABB) in 3D space.
  11833. */
  11834. class Box3 {
  11835. /**
  11836. * Constructs a new bounding box.
  11837. *
  11838. * @param {Vector3} [min=(Infinity,Infinity,Infinity)] - A vector representing the lower boundary of the box.
  11839. * @param {Vector3} [max=(-Infinity,-Infinity,-Infinity)] - A vector representing the upper boundary of the box.
  11840. */
  11841. constructor( min = new Vector3( + Infinity, + Infinity, + Infinity ), max = new Vector3( - Infinity, - Infinity, - Infinity ) ) {
  11842. /**
  11843. * This flag can be used for type testing.
  11844. *
  11845. * @type {boolean}
  11846. * @readonly
  11847. * @default true
  11848. */
  11849. this.isBox3 = true;
  11850. /**
  11851. * The lower boundary of the box.
  11852. *
  11853. * @type {Vector3}
  11854. */
  11855. this.min = min;
  11856. /**
  11857. * The upper boundary of the box.
  11858. *
  11859. * @type {Vector3}
  11860. */
  11861. this.max = max;
  11862. }
  11863. /**
  11864. * Sets the lower and upper boundaries of this box.
  11865. * Please note that this method only copies the values from the given objects.
  11866. *
  11867. * @param {Vector3} min - The lower boundary of the box.
  11868. * @param {Vector3} max - The upper boundary of the box.
  11869. * @return {Box3} A reference to this bounding box.
  11870. */
  11871. set( min, max ) {
  11872. this.min.copy( min );
  11873. this.max.copy( max );
  11874. return this;
  11875. }
  11876. /**
  11877. * Sets the upper and lower bounds of this box so it encloses the position data
  11878. * in the given array.
  11879. *
  11880. * @param {Array<number>} array - An array holding 3D position data.
  11881. * @return {Box3} A reference to this bounding box.
  11882. */
  11883. setFromArray( array ) {
  11884. this.makeEmpty();
  11885. for ( let i = 0, il = array.length; i < il; i += 3 ) {
  11886. this.expandByPoint( _vector$b.fromArray( array, i ) );
  11887. }
  11888. return this;
  11889. }
  11890. /**
  11891. * Sets the upper and lower bounds of this box so it encloses the position data
  11892. * in the given buffer attribute.
  11893. *
  11894. * @param {BufferAttribute} attribute - A buffer attribute holding 3D position data.
  11895. * @return {Box3} A reference to this bounding box.
  11896. */
  11897. setFromBufferAttribute( attribute ) {
  11898. this.makeEmpty();
  11899. for ( let i = 0, il = attribute.count; i < il; i ++ ) {
  11900. this.expandByPoint( _vector$b.fromBufferAttribute( attribute, i ) );
  11901. }
  11902. return this;
  11903. }
  11904. /**
  11905. * Sets the upper and lower bounds of this box so it encloses the position data
  11906. * in the given array.
  11907. *
  11908. * @param {Array<Vector3>} points - An array holding 3D position data as instances of {@link Vector3}.
  11909. * @return {Box3} A reference to this bounding box.
  11910. */
  11911. setFromPoints( points ) {
  11912. this.makeEmpty();
  11913. for ( let i = 0, il = points.length; i < il; i ++ ) {
  11914. this.expandByPoint( points[ i ] );
  11915. }
  11916. return this;
  11917. }
  11918. /**
  11919. * Centers this box on the given center vector and sets this box's width, height and
  11920. * depth to the given size values.
  11921. *
  11922. * @param {Vector3} center - The center of the box.
  11923. * @param {Vector3} size - The x, y and z dimensions of the box.
  11924. * @return {Box3} A reference to this bounding box.
  11925. */
  11926. setFromCenterAndSize( center, size ) {
  11927. const halfSize = _vector$b.copy( size ).multiplyScalar( 0.5 );
  11928. this.min.copy( center ).sub( halfSize );
  11929. this.max.copy( center ).add( halfSize );
  11930. return this;
  11931. }
  11932. /**
  11933. * Computes the world-axis-aligned bounding box for the given 3D object
  11934. * (including its children), accounting for the object's, and children's,
  11935. * world transforms. The function may result in a larger box than strictly necessary.
  11936. *
  11937. * @param {Object3D} object - The 3D object to compute the bounding box for.
  11938. * @param {boolean} [precise=false] - If set to `true`, the method computes the smallest
  11939. * world-axis-aligned bounding box at the expense of more computation.
  11940. * @return {Box3} A reference to this bounding box.
  11941. */
  11942. setFromObject( object, precise = false ) {
  11943. this.makeEmpty();
  11944. return this.expandByObject( object, precise );
  11945. }
  11946. /**
  11947. * Returns a new box with copied values from this instance.
  11948. *
  11949. * @return {Box3} A clone of this instance.
  11950. */
  11951. clone() {
  11952. return new this.constructor().copy( this );
  11953. }
  11954. /**
  11955. * Copies the values of the given box to this instance.
  11956. *
  11957. * @param {Box3} box - The box to copy.
  11958. * @return {Box3} A reference to this bounding box.
  11959. */
  11960. copy( box ) {
  11961. this.min.copy( box.min );
  11962. this.max.copy( box.max );
  11963. return this;
  11964. }
  11965. /**
  11966. * Makes this box empty which means in encloses a zero space in 3D.
  11967. *
  11968. * @return {Box3} A reference to this bounding box.
  11969. */
  11970. makeEmpty() {
  11971. this.min.x = this.min.y = this.min.z = + Infinity;
  11972. this.max.x = this.max.y = this.max.z = - Infinity;
  11973. return this;
  11974. }
  11975. /**
  11976. * Returns true if this box includes zero points within its bounds.
  11977. * Note that a box with equal lower and upper bounds still includes one
  11978. * point, the one both bounds share.
  11979. *
  11980. * @return {boolean} Whether this box is empty or not.
  11981. */
  11982. isEmpty() {
  11983. // this is a more robust check for empty than ( volume <= 0 ) because volume can get positive with two negative axes
  11984. return ( this.max.x < this.min.x ) || ( this.max.y < this.min.y ) || ( this.max.z < this.min.z );
  11985. }
  11986. /**
  11987. * Returns the center point of this box.
  11988. *
  11989. * @param {Vector3} target - The target vector that is used to store the method's result.
  11990. * @return {Vector3} The center point.
  11991. */
  11992. getCenter( target ) {
  11993. return this.isEmpty() ? target.set( 0, 0, 0 ) : target.addVectors( this.min, this.max ).multiplyScalar( 0.5 );
  11994. }
  11995. /**
  11996. * Returns the dimensions of this box.
  11997. *
  11998. * @param {Vector3} target - The target vector that is used to store the method's result.
  11999. * @return {Vector3} The size.
  12000. */
  12001. getSize( target ) {
  12002. return this.isEmpty() ? target.set( 0, 0, 0 ) : target.subVectors( this.max, this.min );
  12003. }
  12004. /**
  12005. * Expands the boundaries of this box to include the given point.
  12006. *
  12007. * @param {Vector3} point - The point that should be included by the bounding box.
  12008. * @return {Box3} A reference to this bounding box.
  12009. */
  12010. expandByPoint( point ) {
  12011. this.min.min( point );
  12012. this.max.max( point );
  12013. return this;
  12014. }
  12015. /**
  12016. * Expands this box equilaterally by the given vector. The width of this
  12017. * box will be expanded by the x component of the vector in both
  12018. * directions. The height of this box will be expanded by the y component of
  12019. * the vector in both directions. The depth of this box will be
  12020. * expanded by the z component of the vector in both directions.
  12021. *
  12022. * @param {Vector3} vector - The vector that should expand the bounding box.
  12023. * @return {Box3} A reference to this bounding box.
  12024. */
  12025. expandByVector( vector ) {
  12026. this.min.sub( vector );
  12027. this.max.add( vector );
  12028. return this;
  12029. }
  12030. /**
  12031. * Expands each dimension of the box by the given scalar. If negative, the
  12032. * dimensions of the box will be contracted.
  12033. *
  12034. * @param {number} scalar - The scalar value that should expand the bounding box.
  12035. * @return {Box3} A reference to this bounding box.
  12036. */
  12037. expandByScalar( scalar ) {
  12038. this.min.addScalar( - scalar );
  12039. this.max.addScalar( scalar );
  12040. return this;
  12041. }
  12042. /**
  12043. * Expands the boundaries of this box to include the given 3D object and
  12044. * its children, accounting for the object's, and children's, world
  12045. * transforms. The function may result in a larger box than strictly
  12046. * necessary (unless the precise parameter is set to true).
  12047. *
  12048. * @param {Object3D} object - The 3D object that should expand the bounding box.
  12049. * @param {boolean} precise - If set to `true`, the method expands the bounding box
  12050. * as little as necessary at the expense of more computation.
  12051. * @return {Box3} A reference to this bounding box.
  12052. */
  12053. expandByObject( object, precise = false ) {
  12054. // Computes the world-axis-aligned bounding box of an object (including its children),
  12055. // accounting for both the object's, and children's, world transforms
  12056. object.updateWorldMatrix( false, false );
  12057. const geometry = object.geometry;
  12058. if ( geometry !== undefined ) {
  12059. const positionAttribute = geometry.getAttribute( 'position' );
  12060. // precise AABB computation based on vertex data requires at least a position attribute.
  12061. // instancing isn't supported so far and uses the normal (conservative) code path.
  12062. if ( precise === true && positionAttribute !== undefined && object.isInstancedMesh !== true ) {
  12063. for ( let i = 0, l = positionAttribute.count; i < l; i ++ ) {
  12064. if ( object.isMesh === true ) {
  12065. object.getVertexPosition( i, _vector$b );
  12066. } else {
  12067. _vector$b.fromBufferAttribute( positionAttribute, i );
  12068. }
  12069. _vector$b.applyMatrix4( object.matrixWorld );
  12070. this.expandByPoint( _vector$b );
  12071. }
  12072. } else {
  12073. if ( object.boundingBox !== undefined ) {
  12074. // object-level bounding box
  12075. if ( object.boundingBox === null ) {
  12076. object.computeBoundingBox();
  12077. }
  12078. _box$4.copy( object.boundingBox );
  12079. } else {
  12080. // geometry-level bounding box
  12081. if ( geometry.boundingBox === null ) {
  12082. geometry.computeBoundingBox();
  12083. }
  12084. _box$4.copy( geometry.boundingBox );
  12085. }
  12086. _box$4.applyMatrix4( object.matrixWorld );
  12087. this.union( _box$4 );
  12088. }
  12089. }
  12090. const children = object.children;
  12091. for ( let i = 0, l = children.length; i < l; i ++ ) {
  12092. this.expandByObject( children[ i ], precise );
  12093. }
  12094. return this;
  12095. }
  12096. /**
  12097. * Returns `true` if the given point lies within or on the boundaries of this box.
  12098. *
  12099. * @param {Vector3} point - The point to test.
  12100. * @return {boolean} Whether the bounding box contains the given point or not.
  12101. */
  12102. containsPoint( point ) {
  12103. return point.x >= this.min.x && point.x <= this.max.x &&
  12104. point.y >= this.min.y && point.y <= this.max.y &&
  12105. point.z >= this.min.z && point.z <= this.max.z;
  12106. }
  12107. /**
  12108. * Returns `true` if this bounding box includes the entirety of the given bounding box.
  12109. * If this box and the given one are identical, this function also returns `true`.
  12110. *
  12111. * @param {Box3} box - The bounding box to test.
  12112. * @return {boolean} Whether the bounding box contains the given bounding box or not.
  12113. */
  12114. containsBox( box ) {
  12115. return this.min.x <= box.min.x && box.max.x <= this.max.x &&
  12116. this.min.y <= box.min.y && box.max.y <= this.max.y &&
  12117. this.min.z <= box.min.z && box.max.z <= this.max.z;
  12118. }
  12119. /**
  12120. * Returns a point as a proportion of this box's width, height and depth.
  12121. *
  12122. * @param {Vector3} point - A point in 3D space.
  12123. * @param {Vector3} target - The target vector that is used to store the method's result.
  12124. * @return {Vector3} A point as a proportion of this box's width, height and depth.
  12125. */
  12126. getParameter( point, target ) {
  12127. // This can potentially have a divide by zero if the box
  12128. // has a size dimension of 0.
  12129. return target.set(
  12130. ( point.x - this.min.x ) / ( this.max.x - this.min.x ),
  12131. ( point.y - this.min.y ) / ( this.max.y - this.min.y ),
  12132. ( point.z - this.min.z ) / ( this.max.z - this.min.z )
  12133. );
  12134. }
  12135. /**
  12136. * Returns `true` if the given bounding box intersects with this bounding box.
  12137. *
  12138. * @param {Box3} box - The bounding box to test.
  12139. * @return {boolean} Whether the given bounding box intersects with this bounding box.
  12140. */
  12141. intersectsBox( box ) {
  12142. // using 6 splitting planes to rule out intersections.
  12143. return box.max.x >= this.min.x && box.min.x <= this.max.x &&
  12144. box.max.y >= this.min.y && box.min.y <= this.max.y &&
  12145. box.max.z >= this.min.z && box.min.z <= this.max.z;
  12146. }
  12147. /**
  12148. * Returns `true` if the given bounding sphere intersects with this bounding box.
  12149. *
  12150. * @param {Sphere} sphere - The bounding sphere to test.
  12151. * @return {boolean} Whether the given bounding sphere intersects with this bounding box.
  12152. */
  12153. intersectsSphere( sphere ) {
  12154. // Find the point on the AABB closest to the sphere center.
  12155. this.clampPoint( sphere.center, _vector$b );
  12156. // If that point is inside the sphere, the AABB and sphere intersect.
  12157. return _vector$b.distanceToSquared( sphere.center ) <= ( sphere.radius * sphere.radius );
  12158. }
  12159. /**
  12160. * Returns `true` if the given plane intersects with this bounding box.
  12161. *
  12162. * @param {Plane} plane - The plane to test.
  12163. * @return {boolean} Whether the given plane intersects with this bounding box.
  12164. */
  12165. intersectsPlane( plane ) {
  12166. // We compute the minimum and maximum dot product values. If those values
  12167. // are on the same side (back or front) of the plane, then there is no intersection.
  12168. let min, max;
  12169. if ( plane.normal.x > 0 ) {
  12170. min = plane.normal.x * this.min.x;
  12171. max = plane.normal.x * this.max.x;
  12172. } else {
  12173. min = plane.normal.x * this.max.x;
  12174. max = plane.normal.x * this.min.x;
  12175. }
  12176. if ( plane.normal.y > 0 ) {
  12177. min += plane.normal.y * this.min.y;
  12178. max += plane.normal.y * this.max.y;
  12179. } else {
  12180. min += plane.normal.y * this.max.y;
  12181. max += plane.normal.y * this.min.y;
  12182. }
  12183. if ( plane.normal.z > 0 ) {
  12184. min += plane.normal.z * this.min.z;
  12185. max += plane.normal.z * this.max.z;
  12186. } else {
  12187. min += plane.normal.z * this.max.z;
  12188. max += plane.normal.z * this.min.z;
  12189. }
  12190. return ( min <= - plane.constant && max >= - plane.constant );
  12191. }
  12192. /**
  12193. * Returns `true` if the given triangle intersects with this bounding box.
  12194. *
  12195. * @param {Triangle} triangle - The triangle to test.
  12196. * @return {boolean} Whether the given triangle intersects with this bounding box.
  12197. */
  12198. intersectsTriangle( triangle ) {
  12199. if ( this.isEmpty() ) {
  12200. return false;
  12201. }
  12202. // compute box center and extents
  12203. this.getCenter( _center );
  12204. _extents.subVectors( this.max, _center );
  12205. // translate triangle to aabb origin
  12206. _v0$1.subVectors( triangle.a, _center );
  12207. _v1$4.subVectors( triangle.b, _center );
  12208. _v2$3.subVectors( triangle.c, _center );
  12209. // compute edge vectors for triangle
  12210. _f0.subVectors( _v1$4, _v0$1 );
  12211. _f1.subVectors( _v2$3, _v1$4 );
  12212. _f2.subVectors( _v0$1, _v2$3 );
  12213. // test against axes that are given by cross product combinations of the edges of the triangle and the edges of the aabb
  12214. // make an axis testing of each of the 3 sides of the aabb against each of the 3 sides of the triangle = 9 axis of separation
  12215. // axis_ij = u_i x f_j (u0, u1, u2 = face normals of aabb = x,y,z axes vectors since aabb is axis aligned)
  12216. let axes = [
  12217. 0, - _f0.z, _f0.y, 0, - _f1.z, _f1.y, 0, - _f2.z, _f2.y,
  12218. _f0.z, 0, - _f0.x, _f1.z, 0, - _f1.x, _f2.z, 0, - _f2.x,
  12219. - _f0.y, _f0.x, 0, - _f1.y, _f1.x, 0, - _f2.y, _f2.x, 0
  12220. ];
  12221. if ( ! satForAxes( axes, _v0$1, _v1$4, _v2$3, _extents ) ) {
  12222. return false;
  12223. }
  12224. // test 3 face normals from the aabb
  12225. axes = [ 1, 0, 0, 0, 1, 0, 0, 0, 1 ];
  12226. if ( ! satForAxes( axes, _v0$1, _v1$4, _v2$3, _extents ) ) {
  12227. return false;
  12228. }
  12229. // finally testing the face normal of the triangle
  12230. // use already existing triangle edge vectors here
  12231. _triangleNormal.crossVectors( _f0, _f1 );
  12232. axes = [ _triangleNormal.x, _triangleNormal.y, _triangleNormal.z ];
  12233. return satForAxes( axes, _v0$1, _v1$4, _v2$3, _extents );
  12234. }
  12235. /**
  12236. * Clamps the given point within the bounds of this box.
  12237. *
  12238. * @param {Vector3} point - The point to clamp.
  12239. * @param {Vector3} target - The target vector that is used to store the method's result.
  12240. * @return {Vector3} The clamped point.
  12241. */
  12242. clampPoint( point, target ) {
  12243. return target.copy( point ).clamp( this.min, this.max );
  12244. }
  12245. /**
  12246. * Returns the euclidean distance from any edge of this box to the specified point. If
  12247. * the given point lies inside of this box, the distance will be `0`.
  12248. *
  12249. * @param {Vector3} point - The point to compute the distance to.
  12250. * @return {number} The euclidean distance.
  12251. */
  12252. distanceToPoint( point ) {
  12253. return this.clampPoint( point, _vector$b ).distanceTo( point );
  12254. }
  12255. /**
  12256. * Returns a bounding sphere that encloses this bounding box.
  12257. *
  12258. * @param {Sphere} target - The target sphere that is used to store the method's result.
  12259. * @return {Sphere} The bounding sphere that encloses this bounding box.
  12260. */
  12261. getBoundingSphere( target ) {
  12262. if ( this.isEmpty() ) {
  12263. target.makeEmpty();
  12264. } else {
  12265. this.getCenter( target.center );
  12266. target.radius = this.getSize( _vector$b ).length() * 0.5;
  12267. }
  12268. return target;
  12269. }
  12270. /**
  12271. * Computes the intersection of this bounding box and the given one, setting the upper
  12272. * bound of this box to the lesser of the two boxes' upper bounds and the
  12273. * lower bound of this box to the greater of the two boxes' lower bounds. If
  12274. * there's no overlap, makes this box empty.
  12275. *
  12276. * @param {Box3} box - The bounding box to intersect with.
  12277. * @return {Box3} A reference to this bounding box.
  12278. */
  12279. intersect( box ) {
  12280. this.min.max( box.min );
  12281. this.max.min( box.max );
  12282. // ensure that if there is no overlap, the result is fully empty, not slightly empty with non-inf/+inf values that will cause subsequence intersects to erroneously return valid values.
  12283. if ( this.isEmpty() ) this.makeEmpty();
  12284. return this;
  12285. }
  12286. /**
  12287. * Computes the union of this box and another and the given one, setting the upper
  12288. * bound of this box to the greater of the two boxes' upper bounds and the
  12289. * lower bound of this box to the lesser of the two boxes' lower bounds.
  12290. *
  12291. * @param {Box3} box - The bounding box that will be unioned with this instance.
  12292. * @return {Box3} A reference to this bounding box.
  12293. */
  12294. union( box ) {
  12295. this.min.min( box.min );
  12296. this.max.max( box.max );
  12297. return this;
  12298. }
  12299. /**
  12300. * Transforms this bounding box by the given 4x4 transformation matrix.
  12301. *
  12302. * @param {Matrix4} matrix - The transformation matrix.
  12303. * @return {Box3} A reference to this bounding box.
  12304. */
  12305. applyMatrix4( matrix ) {
  12306. // transform of empty box is an empty box.
  12307. if ( this.isEmpty() ) return this;
  12308. // NOTE: I am using a binary pattern to specify all 2^3 combinations below
  12309. _points[ 0 ].set( this.min.x, this.min.y, this.min.z ).applyMatrix4( matrix ); // 000
  12310. _points[ 1 ].set( this.min.x, this.min.y, this.max.z ).applyMatrix4( matrix ); // 001
  12311. _points[ 2 ].set( this.min.x, this.max.y, this.min.z ).applyMatrix4( matrix ); // 010
  12312. _points[ 3 ].set( this.min.x, this.max.y, this.max.z ).applyMatrix4( matrix ); // 011
  12313. _points[ 4 ].set( this.max.x, this.min.y, this.min.z ).applyMatrix4( matrix ); // 100
  12314. _points[ 5 ].set( this.max.x, this.min.y, this.max.z ).applyMatrix4( matrix ); // 101
  12315. _points[ 6 ].set( this.max.x, this.max.y, this.min.z ).applyMatrix4( matrix ); // 110
  12316. _points[ 7 ].set( this.max.x, this.max.y, this.max.z ).applyMatrix4( matrix ); // 111
  12317. this.setFromPoints( _points );
  12318. return this;
  12319. }
  12320. /**
  12321. * Adds the given offset to both the upper and lower bounds of this bounding box,
  12322. * effectively moving it in 3D space.
  12323. *
  12324. * @param {Vector3} offset - The offset that should be used to translate the bounding box.
  12325. * @return {Box3} A reference to this bounding box.
  12326. */
  12327. translate( offset ) {
  12328. this.min.add( offset );
  12329. this.max.add( offset );
  12330. return this;
  12331. }
  12332. /**
  12333. * Returns `true` if this bounding box is equal with the given one.
  12334. *
  12335. * @param {Box3} box - The box to test for equality.
  12336. * @return {boolean} Whether this bounding box is equal with the given one.
  12337. */
  12338. equals( box ) {
  12339. return box.min.equals( this.min ) && box.max.equals( this.max );
  12340. }
  12341. /**
  12342. * Returns a serialized structure of the bounding box.
  12343. *
  12344. * @return {Object} Serialized structure with fields representing the object state.
  12345. */
  12346. toJSON() {
  12347. return {
  12348. min: this.min.toArray(),
  12349. max: this.max.toArray()
  12350. };
  12351. }
  12352. /**
  12353. * Returns a serialized structure of the bounding box.
  12354. *
  12355. * @param {Object} json - The serialized json to set the box from.
  12356. * @return {Box3} A reference to this bounding box.
  12357. */
  12358. fromJSON( json ) {
  12359. this.min.fromArray( json.min );
  12360. this.max.fromArray( json.max );
  12361. return this;
  12362. }
  12363. }
  12364. const _points = [
  12365. /*@__PURE__*/ new Vector3(),
  12366. /*@__PURE__*/ new Vector3(),
  12367. /*@__PURE__*/ new Vector3(),
  12368. /*@__PURE__*/ new Vector3(),
  12369. /*@__PURE__*/ new Vector3(),
  12370. /*@__PURE__*/ new Vector3(),
  12371. /*@__PURE__*/ new Vector3(),
  12372. /*@__PURE__*/ new Vector3()
  12373. ];
  12374. const _vector$b = /*@__PURE__*/ new Vector3();
  12375. const _box$4 = /*@__PURE__*/ new Box3();
  12376. // triangle centered vertices
  12377. const _v0$1 = /*@__PURE__*/ new Vector3();
  12378. const _v1$4 = /*@__PURE__*/ new Vector3();
  12379. const _v2$3 = /*@__PURE__*/ new Vector3();
  12380. // triangle edge vectors
  12381. const _f0 = /*@__PURE__*/ new Vector3();
  12382. const _f1 = /*@__PURE__*/ new Vector3();
  12383. const _f2 = /*@__PURE__*/ new Vector3();
  12384. const _center = /*@__PURE__*/ new Vector3();
  12385. const _extents = /*@__PURE__*/ new Vector3();
  12386. const _triangleNormal = /*@__PURE__*/ new Vector3();
  12387. const _testAxis = /*@__PURE__*/ new Vector3();
  12388. function satForAxes( axes, v0, v1, v2, extents ) {
  12389. for ( let i = 0, j = axes.length - 3; i <= j; i += 3 ) {
  12390. _testAxis.fromArray( axes, i );
  12391. // project the aabb onto the separating axis
  12392. const r = extents.x * Math.abs( _testAxis.x ) + extents.y * Math.abs( _testAxis.y ) + extents.z * Math.abs( _testAxis.z );
  12393. // project all 3 vertices of the triangle onto the separating axis
  12394. const p0 = v0.dot( _testAxis );
  12395. const p1 = v1.dot( _testAxis );
  12396. const p2 = v2.dot( _testAxis );
  12397. // actual test, basically see if either of the most extreme of the triangle points intersects r
  12398. if ( Math.max( - Math.max( p0, p1, p2 ), Math.min( p0, p1, p2 ) ) > r ) {
  12399. // points of the projected triangle are outside the projected half-length of the aabb
  12400. // the axis is separating and we can exit
  12401. return false;
  12402. }
  12403. }
  12404. return true;
  12405. }
  12406. // Fast Half Float Conversions, http://www.fox-toolkit.org/ftp/fasthalffloatconversion.pdf
  12407. const _tables = /*@__PURE__*/ _generateTables();
  12408. function _generateTables() {
  12409. // float32 to float16 helpers
  12410. const buffer = new ArrayBuffer( 4 );
  12411. const floatView = new Float32Array( buffer );
  12412. const uint32View = new Uint32Array( buffer );
  12413. const baseTable = new Uint32Array( 512 );
  12414. const shiftTable = new Uint32Array( 512 );
  12415. for ( let i = 0; i < 256; ++ i ) {
  12416. const e = i - 127;
  12417. // very small number (0, -0)
  12418. if ( e < -27 ) {
  12419. baseTable[ i ] = 0x0000;
  12420. baseTable[ i | 0x100 ] = 0x8000;
  12421. shiftTable[ i ] = 24;
  12422. shiftTable[ i | 0x100 ] = 24;
  12423. // small number (denorm)
  12424. } else if ( e < -14 ) {
  12425. baseTable[ i ] = 0x0400 >> ( - e - 14 );
  12426. baseTable[ i | 0x100 ] = ( 0x0400 >> ( - e - 14 ) ) | 0x8000;
  12427. shiftTable[ i ] = - e - 1;
  12428. shiftTable[ i | 0x100 ] = - e - 1;
  12429. // normal number
  12430. } else if ( e <= 15 ) {
  12431. baseTable[ i ] = ( e + 15 ) << 10;
  12432. baseTable[ i | 0x100 ] = ( ( e + 15 ) << 10 ) | 0x8000;
  12433. shiftTable[ i ] = 13;
  12434. shiftTable[ i | 0x100 ] = 13;
  12435. // large number (Infinity, -Infinity)
  12436. } else if ( e < 128 ) {
  12437. baseTable[ i ] = 0x7c00;
  12438. baseTable[ i | 0x100 ] = 0xfc00;
  12439. shiftTable[ i ] = 24;
  12440. shiftTable[ i | 0x100 ] = 24;
  12441. // stay (NaN, Infinity, -Infinity)
  12442. } else {
  12443. baseTable[ i ] = 0x7c00;
  12444. baseTable[ i | 0x100 ] = 0xfc00;
  12445. shiftTable[ i ] = 13;
  12446. shiftTable[ i | 0x100 ] = 13;
  12447. }
  12448. }
  12449. // float16 to float32 helpers
  12450. const mantissaTable = new Uint32Array( 2048 );
  12451. const exponentTable = new Uint32Array( 64 );
  12452. const offsetTable = new Uint32Array( 64 );
  12453. for ( let i = 1; i < 1024; ++ i ) {
  12454. let m = i << 13; // zero pad mantissa bits
  12455. let e = 0; // zero exponent
  12456. // normalized
  12457. while ( ( m & 0x00800000 ) === 0 ) {
  12458. m <<= 1;
  12459. e -= 0x00800000; // decrement exponent
  12460. }
  12461. m &= -8388609; // clear leading 1 bit
  12462. e += 0x38800000; // adjust bias
  12463. mantissaTable[ i ] = m | e;
  12464. }
  12465. for ( let i = 1024; i < 2048; ++ i ) {
  12466. mantissaTable[ i ] = 0x38000000 + ( ( i - 1024 ) << 13 );
  12467. }
  12468. for ( let i = 1; i < 31; ++ i ) {
  12469. exponentTable[ i ] = i << 23;
  12470. }
  12471. exponentTable[ 31 ] = 0x47800000;
  12472. exponentTable[ 32 ] = 0x80000000;
  12473. for ( let i = 33; i < 63; ++ i ) {
  12474. exponentTable[ i ] = 0x80000000 + ( ( i - 32 ) << 23 );
  12475. }
  12476. exponentTable[ 63 ] = 0xc7800000;
  12477. for ( let i = 1; i < 64; ++ i ) {
  12478. if ( i !== 32 ) {
  12479. offsetTable[ i ] = 1024;
  12480. }
  12481. }
  12482. return {
  12483. floatView: floatView,
  12484. uint32View: uint32View,
  12485. baseTable: baseTable,
  12486. shiftTable: shiftTable,
  12487. mantissaTable: mantissaTable,
  12488. exponentTable: exponentTable,
  12489. offsetTable: offsetTable
  12490. };
  12491. }
  12492. /**
  12493. * Returns a half precision floating point value (FP16) from the given single
  12494. * precision floating point value (FP32).
  12495. *
  12496. * @param {number} val - A single precision floating point value.
  12497. * @return {number} The FP16 value.
  12498. */
  12499. function toHalfFloat( val ) {
  12500. if ( Math.abs( val ) > 65504 ) warn( 'DataUtils.toHalfFloat(): Value out of range.' );
  12501. val = clamp( val, -65504, 65504 );
  12502. _tables.floatView[ 0 ] = val;
  12503. const f = _tables.uint32View[ 0 ];
  12504. const e = ( f >> 23 ) & 0x1ff;
  12505. return _tables.baseTable[ e ] + ( ( f & 0x007fffff ) >> _tables.shiftTable[ e ] );
  12506. }
  12507. /**
  12508. * Returns a single precision floating point value (FP32) from the given half
  12509. * precision floating point value (FP16).
  12510. *
  12511. * @param {number} val - A half precision floating point value.
  12512. * @return {number} The FP32 value.
  12513. */
  12514. function fromHalfFloat( val ) {
  12515. const m = val >> 10;
  12516. _tables.uint32View[ 0 ] = _tables.mantissaTable[ _tables.offsetTable[ m ] + ( val & 0x3ff ) ] + _tables.exponentTable[ m ];
  12517. return _tables.floatView[ 0 ];
  12518. }
  12519. /**
  12520. * A class containing utility functions for data.
  12521. *
  12522. * @hideconstructor
  12523. */
  12524. class DataUtils {
  12525. /**
  12526. * Returns a half precision floating point value (FP16) from the given single
  12527. * precision floating point value (FP32).
  12528. *
  12529. * @param {number} val - A single precision floating point value.
  12530. * @return {number} The FP16 value.
  12531. */
  12532. static toHalfFloat( val ) {
  12533. return toHalfFloat( val );
  12534. }
  12535. /**
  12536. * Returns a single precision floating point value (FP32) from the given half
  12537. * precision floating point value (FP16).
  12538. *
  12539. * @param {number} val - A half precision floating point value.
  12540. * @return {number} The FP32 value.
  12541. */
  12542. static fromHalfFloat( val ) {
  12543. return fromHalfFloat( val );
  12544. }
  12545. }
  12546. const _vector$a = /*@__PURE__*/ new Vector3();
  12547. const _vector2$1 = /*@__PURE__*/ new Vector2();
  12548. let _id$2 = 0;
  12549. /**
  12550. * This class stores data for an attribute (such as vertex positions, face
  12551. * indices, normals, colors, UVs, and any custom attributes ) associated with
  12552. * a geometry, which allows for more efficient passing of data to the GPU.
  12553. *
  12554. * When working with vector-like data, the `fromBufferAttribute( attribute, index )`
  12555. * helper methods on vector and color class might be helpful. E.g. {@link Vector3#fromBufferAttribute}.
  12556. */
  12557. class BufferAttribute {
  12558. /**
  12559. * Constructs a new buffer attribute.
  12560. *
  12561. * @param {TypedArray} array - The array holding the attribute data.
  12562. * @param {number} itemSize - The item size.
  12563. * @param {boolean} [normalized=false] - Whether the data are normalized or not.
  12564. */
  12565. constructor( array, itemSize, normalized = false ) {
  12566. if ( Array.isArray( array ) ) {
  12567. throw new TypeError( 'THREE.BufferAttribute: array should be a Typed Array.' );
  12568. }
  12569. /**
  12570. * This flag can be used for type testing.
  12571. *
  12572. * @type {boolean}
  12573. * @readonly
  12574. * @default true
  12575. */
  12576. this.isBufferAttribute = true;
  12577. /**
  12578. * The ID of the buffer attribute.
  12579. *
  12580. * @name BufferAttribute#id
  12581. * @type {number}
  12582. * @readonly
  12583. */
  12584. Object.defineProperty( this, 'id', { value: _id$2 ++ } );
  12585. /**
  12586. * The name of the buffer attribute.
  12587. *
  12588. * @type {string}
  12589. */
  12590. this.name = '';
  12591. /**
  12592. * The array holding the attribute data. It should have `itemSize * numVertices`
  12593. * elements, where `numVertices` is the number of vertices in the associated geometry.
  12594. *
  12595. * @type {TypedArray}
  12596. */
  12597. this.array = array;
  12598. /**
  12599. * The number of values of the array that should be associated with a particular vertex.
  12600. * For instance, if this attribute is storing a 3-component vector (such as a position,
  12601. * normal, or color), then the value should be `3`.
  12602. *
  12603. * @type {number}
  12604. */
  12605. this.itemSize = itemSize;
  12606. /**
  12607. * Represents the number of items this buffer attribute stores. It is internally computed
  12608. * by dividing the `array` length by the `itemSize`.
  12609. *
  12610. * @type {number}
  12611. * @readonly
  12612. */
  12613. this.count = array !== undefined ? array.length / itemSize : 0;
  12614. /**
  12615. * Applies to integer data only. Indicates how the underlying data in the buffer maps to
  12616. * the values in the GLSL code. For instance, if `array` is an instance of `UInt16Array`,
  12617. * and `normalized` is `true`, the values `0 - +65535` in the array data will be mapped to
  12618. * `0.0f - +1.0f` in the GLSL attribute. If `normalized` is `false`, the values will be converted
  12619. * to floats unmodified, i.e. `65535` becomes `65535.0f`.
  12620. *
  12621. * @type {boolean}
  12622. */
  12623. this.normalized = normalized;
  12624. /**
  12625. * Defines the intended usage pattern of the data store for optimization purposes.
  12626. *
  12627. * Note: After the initial use of a buffer, its usage cannot be changed. Instead,
  12628. * instantiate a new one and set the desired usage before the next render.
  12629. *
  12630. * @type {(StaticDrawUsage|DynamicDrawUsage|StreamDrawUsage|StaticReadUsage|DynamicReadUsage|StreamReadUsage|StaticCopyUsage|DynamicCopyUsage|StreamCopyUsage)}
  12631. * @default StaticDrawUsage
  12632. */
  12633. this.usage = StaticDrawUsage;
  12634. /**
  12635. * This can be used to only update some components of stored vectors (for example, just the
  12636. * component related to color). Use the `addUpdateRange()` function to add ranges to this array.
  12637. *
  12638. * @type {Array<Object>}
  12639. */
  12640. this.updateRanges = [];
  12641. /**
  12642. * Configures the bound GPU type for use in shaders.
  12643. *
  12644. * Note: this only has an effect for integer arrays and is not configurable for float arrays.
  12645. * For lower precision float types, use `Float16BufferAttribute`.
  12646. *
  12647. * @type {(FloatType|IntType)}
  12648. * @default FloatType
  12649. */
  12650. this.gpuType = FloatType;
  12651. /**
  12652. * A version number, incremented every time the `needsUpdate` is set to `true`.
  12653. *
  12654. * @type {number}
  12655. */
  12656. this.version = 0;
  12657. }
  12658. /**
  12659. * A callback function that is executed after the renderer has transferred the attribute
  12660. * array data to the GPU.
  12661. */
  12662. onUploadCallback() {}
  12663. /**
  12664. * Flag to indicate that this attribute has changed and should be re-sent to
  12665. * the GPU. Set this to `true` when you modify the value of the array.
  12666. *
  12667. * @type {number}
  12668. * @default false
  12669. * @param {boolean} value
  12670. */
  12671. set needsUpdate( value ) {
  12672. if ( value === true ) this.version ++;
  12673. }
  12674. /**
  12675. * Sets the usage of this buffer attribute.
  12676. *
  12677. * @param {(StaticDrawUsage|DynamicDrawUsage|StreamDrawUsage|StaticReadUsage|DynamicReadUsage|StreamReadUsage|StaticCopyUsage|DynamicCopyUsage|StreamCopyUsage)} value - The usage to set.
  12678. * @return {BufferAttribute} A reference to this buffer attribute.
  12679. */
  12680. setUsage( value ) {
  12681. this.usage = value;
  12682. return this;
  12683. }
  12684. /**
  12685. * Adds a range of data in the data array to be updated on the GPU.
  12686. *
  12687. * @param {number} start - Position at which to start update.
  12688. * @param {number} count - The number of components to update.
  12689. */
  12690. addUpdateRange( start, count ) {
  12691. this.updateRanges.push( { start, count } );
  12692. }
  12693. /**
  12694. * Clears the update ranges.
  12695. */
  12696. clearUpdateRanges() {
  12697. this.updateRanges.length = 0;
  12698. }
  12699. /**
  12700. * Copies the values of the given buffer attribute to this instance.
  12701. *
  12702. * @param {BufferAttribute} source - The buffer attribute to copy.
  12703. * @return {BufferAttribute} A reference to this instance.
  12704. */
  12705. copy( source ) {
  12706. this.name = source.name;
  12707. this.array = new source.array.constructor( source.array );
  12708. this.itemSize = source.itemSize;
  12709. this.count = source.count;
  12710. this.normalized = source.normalized;
  12711. this.usage = source.usage;
  12712. this.gpuType = source.gpuType;
  12713. return this;
  12714. }
  12715. /**
  12716. * Copies a vector from the given buffer attribute to this one. The start
  12717. * and destination position in the attribute buffers are represented by the
  12718. * given indices.
  12719. *
  12720. * @param {number} index1 - The destination index into this buffer attribute.
  12721. * @param {BufferAttribute} attribute - The buffer attribute to copy from.
  12722. * @param {number} index2 - The source index into the given buffer attribute.
  12723. * @return {BufferAttribute} A reference to this instance.
  12724. */
  12725. copyAt( index1, attribute, index2 ) {
  12726. index1 *= this.itemSize;
  12727. index2 *= attribute.itemSize;
  12728. for ( let i = 0, l = this.itemSize; i < l; i ++ ) {
  12729. this.array[ index1 + i ] = attribute.array[ index2 + i ];
  12730. }
  12731. return this;
  12732. }
  12733. /**
  12734. * Copies the given array data into this buffer attribute.
  12735. *
  12736. * @param {(TypedArray|Array)} array - The array to copy.
  12737. * @return {BufferAttribute} A reference to this instance.
  12738. */
  12739. copyArray( array ) {
  12740. this.array.set( array );
  12741. return this;
  12742. }
  12743. /**
  12744. * Applies the given 3x3 matrix to the given attribute. Works with
  12745. * item size `2` and `3`.
  12746. *
  12747. * @param {Matrix3} m - The matrix to apply.
  12748. * @return {BufferAttribute} A reference to this instance.
  12749. */
  12750. applyMatrix3( m ) {
  12751. if ( this.itemSize === 2 ) {
  12752. for ( let i = 0, l = this.count; i < l; i ++ ) {
  12753. _vector2$1.fromBufferAttribute( this, i );
  12754. _vector2$1.applyMatrix3( m );
  12755. this.setXY( i, _vector2$1.x, _vector2$1.y );
  12756. }
  12757. } else if ( this.itemSize === 3 ) {
  12758. for ( let i = 0, l = this.count; i < l; i ++ ) {
  12759. _vector$a.fromBufferAttribute( this, i );
  12760. _vector$a.applyMatrix3( m );
  12761. this.setXYZ( i, _vector$a.x, _vector$a.y, _vector$a.z );
  12762. }
  12763. }
  12764. return this;
  12765. }
  12766. /**
  12767. * Applies the given 4x4 matrix to the given attribute. Only works with
  12768. * item size `3`.
  12769. *
  12770. * @param {Matrix4} m - The matrix to apply.
  12771. * @return {BufferAttribute} A reference to this instance.
  12772. */
  12773. applyMatrix4( m ) {
  12774. for ( let i = 0, l = this.count; i < l; i ++ ) {
  12775. _vector$a.fromBufferAttribute( this, i );
  12776. _vector$a.applyMatrix4( m );
  12777. this.setXYZ( i, _vector$a.x, _vector$a.y, _vector$a.z );
  12778. }
  12779. return this;
  12780. }
  12781. /**
  12782. * Applies the given 3x3 normal matrix to the given attribute. Only works with
  12783. * item size `3`.
  12784. *
  12785. * @param {Matrix3} m - The normal matrix to apply.
  12786. * @return {BufferAttribute} A reference to this instance.
  12787. */
  12788. applyNormalMatrix( m ) {
  12789. for ( let i = 0, l = this.count; i < l; i ++ ) {
  12790. _vector$a.fromBufferAttribute( this, i );
  12791. _vector$a.applyNormalMatrix( m );
  12792. this.setXYZ( i, _vector$a.x, _vector$a.y, _vector$a.z );
  12793. }
  12794. return this;
  12795. }
  12796. /**
  12797. * Applies the given 4x4 matrix to the given attribute. Only works with
  12798. * item size `3` and with direction vectors.
  12799. *
  12800. * @param {Matrix4} m - The matrix to apply.
  12801. * @return {BufferAttribute} A reference to this instance.
  12802. */
  12803. transformDirection( m ) {
  12804. for ( let i = 0, l = this.count; i < l; i ++ ) {
  12805. _vector$a.fromBufferAttribute( this, i );
  12806. _vector$a.transformDirection( m );
  12807. this.setXYZ( i, _vector$a.x, _vector$a.y, _vector$a.z );
  12808. }
  12809. return this;
  12810. }
  12811. /**
  12812. * Sets the given array data in the buffer attribute.
  12813. *
  12814. * @param {(TypedArray|Array)} value - The array data to set.
  12815. * @param {number} [offset=0] - The offset in this buffer attribute's array.
  12816. * @return {BufferAttribute} A reference to this instance.
  12817. */
  12818. set( value, offset = 0 ) {
  12819. // Matching BufferAttribute constructor, do not normalize the array.
  12820. this.array.set( value, offset );
  12821. return this;
  12822. }
  12823. /**
  12824. * Returns the given component of the vector at the given index.
  12825. *
  12826. * @param {number} index - The index into the buffer attribute.
  12827. * @param {number} component - The component index.
  12828. * @return {number} The returned value.
  12829. */
  12830. getComponent( index, component ) {
  12831. let value = this.array[ index * this.itemSize + component ];
  12832. if ( this.normalized ) value = denormalize( value, this.array );
  12833. return value;
  12834. }
  12835. /**
  12836. * Sets the given value to the given component of the vector at the given index.
  12837. *
  12838. * @param {number} index - The index into the buffer attribute.
  12839. * @param {number} component - The component index.
  12840. * @param {number} value - The value to set.
  12841. * @return {BufferAttribute} A reference to this instance.
  12842. */
  12843. setComponent( index, component, value ) {
  12844. if ( this.normalized ) value = normalize( value, this.array );
  12845. this.array[ index * this.itemSize + component ] = value;
  12846. return this;
  12847. }
  12848. /**
  12849. * Returns the x component of the vector at the given index.
  12850. *
  12851. * @param {number} index - The index into the buffer attribute.
  12852. * @return {number} The x component.
  12853. */
  12854. getX( index ) {
  12855. let x = this.array[ index * this.itemSize ];
  12856. if ( this.normalized ) x = denormalize( x, this.array );
  12857. return x;
  12858. }
  12859. /**
  12860. * Sets the x component of the vector at the given index.
  12861. *
  12862. * @param {number} index - The index into the buffer attribute.
  12863. * @param {number} x - The value to set.
  12864. * @return {BufferAttribute} A reference to this instance.
  12865. */
  12866. setX( index, x ) {
  12867. if ( this.normalized ) x = normalize( x, this.array );
  12868. this.array[ index * this.itemSize ] = x;
  12869. return this;
  12870. }
  12871. /**
  12872. * Returns the y component of the vector at the given index.
  12873. *
  12874. * @param {number} index - The index into the buffer attribute.
  12875. * @return {number} The y component.
  12876. */
  12877. getY( index ) {
  12878. let y = this.array[ index * this.itemSize + 1 ];
  12879. if ( this.normalized ) y = denormalize( y, this.array );
  12880. return y;
  12881. }
  12882. /**
  12883. * Sets the y component of the vector at the given index.
  12884. *
  12885. * @param {number} index - The index into the buffer attribute.
  12886. * @param {number} y - The value to set.
  12887. * @return {BufferAttribute} A reference to this instance.
  12888. */
  12889. setY( index, y ) {
  12890. if ( this.normalized ) y = normalize( y, this.array );
  12891. this.array[ index * this.itemSize + 1 ] = y;
  12892. return this;
  12893. }
  12894. /**
  12895. * Returns the z component of the vector at the given index.
  12896. *
  12897. * @param {number} index - The index into the buffer attribute.
  12898. * @return {number} The z component.
  12899. */
  12900. getZ( index ) {
  12901. let z = this.array[ index * this.itemSize + 2 ];
  12902. if ( this.normalized ) z = denormalize( z, this.array );
  12903. return z;
  12904. }
  12905. /**
  12906. * Sets the z component of the vector at the given index.
  12907. *
  12908. * @param {number} index - The index into the buffer attribute.
  12909. * @param {number} z - The value to set.
  12910. * @return {BufferAttribute} A reference to this instance.
  12911. */
  12912. setZ( index, z ) {
  12913. if ( this.normalized ) z = normalize( z, this.array );
  12914. this.array[ index * this.itemSize + 2 ] = z;
  12915. return this;
  12916. }
  12917. /**
  12918. * Returns the w component of the vector at the given index.
  12919. *
  12920. * @param {number} index - The index into the buffer attribute.
  12921. * @return {number} The w component.
  12922. */
  12923. getW( index ) {
  12924. let w = this.array[ index * this.itemSize + 3 ];
  12925. if ( this.normalized ) w = denormalize( w, this.array );
  12926. return w;
  12927. }
  12928. /**
  12929. * Sets the w component of the vector at the given index.
  12930. *
  12931. * @param {number} index - The index into the buffer attribute.
  12932. * @param {number} w - The value to set.
  12933. * @return {BufferAttribute} A reference to this instance.
  12934. */
  12935. setW( index, w ) {
  12936. if ( this.normalized ) w = normalize( w, this.array );
  12937. this.array[ index * this.itemSize + 3 ] = w;
  12938. return this;
  12939. }
  12940. /**
  12941. * Sets the x and y component of the vector at the given index.
  12942. *
  12943. * @param {number} index - The index into the buffer attribute.
  12944. * @param {number} x - The value for the x component to set.
  12945. * @param {number} y - The value for the y component to set.
  12946. * @return {BufferAttribute} A reference to this instance.
  12947. */
  12948. setXY( index, x, y ) {
  12949. index *= this.itemSize;
  12950. if ( this.normalized ) {
  12951. x = normalize( x, this.array );
  12952. y = normalize( y, this.array );
  12953. }
  12954. this.array[ index + 0 ] = x;
  12955. this.array[ index + 1 ] = y;
  12956. return this;
  12957. }
  12958. /**
  12959. * Sets the x, y and z component of the vector at the given index.
  12960. *
  12961. * @param {number} index - The index into the buffer attribute.
  12962. * @param {number} x - The value for the x component to set.
  12963. * @param {number} y - The value for the y component to set.
  12964. * @param {number} z - The value for the z component to set.
  12965. * @return {BufferAttribute} A reference to this instance.
  12966. */
  12967. setXYZ( index, x, y, z ) {
  12968. index *= this.itemSize;
  12969. if ( this.normalized ) {
  12970. x = normalize( x, this.array );
  12971. y = normalize( y, this.array );
  12972. z = normalize( z, this.array );
  12973. }
  12974. this.array[ index + 0 ] = x;
  12975. this.array[ index + 1 ] = y;
  12976. this.array[ index + 2 ] = z;
  12977. return this;
  12978. }
  12979. /**
  12980. * Sets the x, y, z and w component of the vector at the given index.
  12981. *
  12982. * @param {number} index - The index into the buffer attribute.
  12983. * @param {number} x - The value for the x component to set.
  12984. * @param {number} y - The value for the y component to set.
  12985. * @param {number} z - The value for the z component to set.
  12986. * @param {number} w - The value for the w component to set.
  12987. * @return {BufferAttribute} A reference to this instance.
  12988. */
  12989. setXYZW( index, x, y, z, w ) {
  12990. index *= this.itemSize;
  12991. if ( this.normalized ) {
  12992. x = normalize( x, this.array );
  12993. y = normalize( y, this.array );
  12994. z = normalize( z, this.array );
  12995. w = normalize( w, this.array );
  12996. }
  12997. this.array[ index + 0 ] = x;
  12998. this.array[ index + 1 ] = y;
  12999. this.array[ index + 2 ] = z;
  13000. this.array[ index + 3 ] = w;
  13001. return this;
  13002. }
  13003. /**
  13004. * Sets the given callback function that is executed after the Renderer has transferred
  13005. * the attribute array data to the GPU. Can be used to perform clean-up operations after
  13006. * the upload when attribute data are not needed anymore on the CPU side.
  13007. *
  13008. * @param {Function} callback - The `onUpload()` callback.
  13009. * @return {BufferAttribute} A reference to this instance.
  13010. */
  13011. onUpload( callback ) {
  13012. this.onUploadCallback = callback;
  13013. return this;
  13014. }
  13015. /**
  13016. * Returns a new buffer attribute with copied values from this instance.
  13017. *
  13018. * @return {BufferAttribute} A clone of this instance.
  13019. */
  13020. clone() {
  13021. return new this.constructor( this.array, this.itemSize ).copy( this );
  13022. }
  13023. /**
  13024. * Serializes the buffer attribute into JSON.
  13025. *
  13026. * @return {Object} A JSON object representing the serialized buffer attribute.
  13027. */
  13028. toJSON() {
  13029. const data = {
  13030. itemSize: this.itemSize,
  13031. type: this.array.constructor.name,
  13032. array: Array.from( this.array ),
  13033. normalized: this.normalized
  13034. };
  13035. if ( this.name !== '' ) data.name = this.name;
  13036. if ( this.usage !== StaticDrawUsage ) data.usage = this.usage;
  13037. return data;
  13038. }
  13039. }
  13040. /**
  13041. * Convenient class that can be used when creating a `Int8` buffer attribute with
  13042. * a plain `Array` instance.
  13043. *
  13044. * @augments BufferAttribute
  13045. */
  13046. class Int8BufferAttribute extends BufferAttribute {
  13047. /**
  13048. * Constructs a new buffer attribute.
  13049. *
  13050. * @param {(Array<number>|Int8Array)} array - The array holding the attribute data.
  13051. * @param {number} itemSize - The item size.
  13052. * @param {boolean} [normalized=false] - Whether the data are normalized or not.
  13053. */
  13054. constructor( array, itemSize, normalized ) {
  13055. super( new Int8Array( array ), itemSize, normalized );
  13056. }
  13057. }
  13058. /**
  13059. * Convenient class that can be used when creating a `UInt8` buffer attribute with
  13060. * a plain `Array` instance.
  13061. *
  13062. * @augments BufferAttribute
  13063. */
  13064. class Uint8BufferAttribute extends BufferAttribute {
  13065. /**
  13066. * Constructs a new buffer attribute.
  13067. *
  13068. * @param {(Array<number>|Uint8Array)} array - The array holding the attribute data.
  13069. * @param {number} itemSize - The item size.
  13070. * @param {boolean} [normalized=false] - Whether the data are normalized or not.
  13071. */
  13072. constructor( array, itemSize, normalized ) {
  13073. super( new Uint8Array( array ), itemSize, normalized );
  13074. }
  13075. }
  13076. /**
  13077. * Convenient class that can be used when creating a `UInt8Clamped` buffer attribute with
  13078. * a plain `Array` instance.
  13079. *
  13080. * @augments BufferAttribute
  13081. */
  13082. class Uint8ClampedBufferAttribute extends BufferAttribute {
  13083. /**
  13084. * Constructs a new buffer attribute.
  13085. *
  13086. * @param {(Array<number>|Uint8ClampedArray)} array - The array holding the attribute data.
  13087. * @param {number} itemSize - The item size.
  13088. * @param {boolean} [normalized=false] - Whether the data are normalized or not.
  13089. */
  13090. constructor( array, itemSize, normalized ) {
  13091. super( new Uint8ClampedArray( array ), itemSize, normalized );
  13092. }
  13093. }
  13094. /**
  13095. * Convenient class that can be used when creating a `Int16` buffer attribute with
  13096. * a plain `Array` instance.
  13097. *
  13098. * @augments BufferAttribute
  13099. */
  13100. class Int16BufferAttribute extends BufferAttribute {
  13101. /**
  13102. * Constructs a new buffer attribute.
  13103. *
  13104. * @param {(Array<number>|Int16Array)} array - The array holding the attribute data.
  13105. * @param {number} itemSize - The item size.
  13106. * @param {boolean} [normalized=false] - Whether the data are normalized or not.
  13107. */
  13108. constructor( array, itemSize, normalized ) {
  13109. super( new Int16Array( array ), itemSize, normalized );
  13110. }
  13111. }
  13112. /**
  13113. * Convenient class that can be used when creating a `UInt16` buffer attribute with
  13114. * a plain `Array` instance.
  13115. *
  13116. * @augments BufferAttribute
  13117. */
  13118. class Uint16BufferAttribute extends BufferAttribute {
  13119. /**
  13120. * Constructs a new buffer attribute.
  13121. *
  13122. * @param {(Array<number>|Uint16Array)} array - The array holding the attribute data.
  13123. * @param {number} itemSize - The item size.
  13124. * @param {boolean} [normalized=false] - Whether the data are normalized or not.
  13125. */
  13126. constructor( array, itemSize, normalized ) {
  13127. super( new Uint16Array( array ), itemSize, normalized );
  13128. }
  13129. }
  13130. /**
  13131. * Convenient class that can be used when creating a `Int32` buffer attribute with
  13132. * a plain `Array` instance.
  13133. *
  13134. * @augments BufferAttribute
  13135. */
  13136. class Int32BufferAttribute extends BufferAttribute {
  13137. /**
  13138. * Constructs a new buffer attribute.
  13139. *
  13140. * @param {(Array<number>|Int32Array)} array - The array holding the attribute data.
  13141. * @param {number} itemSize - The item size.
  13142. * @param {boolean} [normalized=false] - Whether the data are normalized or not.
  13143. */
  13144. constructor( array, itemSize, normalized ) {
  13145. super( new Int32Array( array ), itemSize, normalized );
  13146. }
  13147. }
  13148. /**
  13149. * Convenient class that can be used when creating a `UInt32` buffer attribute with
  13150. * a plain `Array` instance.
  13151. *
  13152. * @augments BufferAttribute
  13153. */
  13154. class Uint32BufferAttribute extends BufferAttribute {
  13155. /**
  13156. * Constructs a new buffer attribute.
  13157. *
  13158. * @param {(Array<number>|Uint32Array)} array - The array holding the attribute data.
  13159. * @param {number} itemSize - The item size.
  13160. * @param {boolean} [normalized=false] - Whether the data are normalized or not.
  13161. */
  13162. constructor( array, itemSize, normalized ) {
  13163. super( new Uint32Array( array ), itemSize, normalized );
  13164. }
  13165. }
  13166. /**
  13167. * Convenient class that can be used when creating a `Float16` buffer attribute with
  13168. * a plain `Array` instance.
  13169. *
  13170. * This class automatically converts to and from FP16 via `Uint16Array` since `Float16Array`
  13171. * browser support is still problematic.
  13172. *
  13173. * @augments BufferAttribute
  13174. */
  13175. class Float16BufferAttribute extends BufferAttribute {
  13176. /**
  13177. * Constructs a new buffer attribute.
  13178. *
  13179. * @param {(Array<number>|Uint16Array)} array - The array holding the attribute data.
  13180. * @param {number} itemSize - The item size.
  13181. * @param {boolean} [normalized=false] - Whether the data are normalized or not.
  13182. */
  13183. constructor( array, itemSize, normalized ) {
  13184. super( new Uint16Array( array ), itemSize, normalized );
  13185. this.isFloat16BufferAttribute = true;
  13186. }
  13187. getX( index ) {
  13188. let x = fromHalfFloat( this.array[ index * this.itemSize ] );
  13189. if ( this.normalized ) x = denormalize( x, this.array );
  13190. return x;
  13191. }
  13192. setX( index, x ) {
  13193. if ( this.normalized ) x = normalize( x, this.array );
  13194. this.array[ index * this.itemSize ] = toHalfFloat( x );
  13195. return this;
  13196. }
  13197. getY( index ) {
  13198. let y = fromHalfFloat( this.array[ index * this.itemSize + 1 ] );
  13199. if ( this.normalized ) y = denormalize( y, this.array );
  13200. return y;
  13201. }
  13202. setY( index, y ) {
  13203. if ( this.normalized ) y = normalize( y, this.array );
  13204. this.array[ index * this.itemSize + 1 ] = toHalfFloat( y );
  13205. return this;
  13206. }
  13207. getZ( index ) {
  13208. let z = fromHalfFloat( this.array[ index * this.itemSize + 2 ] );
  13209. if ( this.normalized ) z = denormalize( z, this.array );
  13210. return z;
  13211. }
  13212. setZ( index, z ) {
  13213. if ( this.normalized ) z = normalize( z, this.array );
  13214. this.array[ index * this.itemSize + 2 ] = toHalfFloat( z );
  13215. return this;
  13216. }
  13217. getW( index ) {
  13218. let w = fromHalfFloat( this.array[ index * this.itemSize + 3 ] );
  13219. if ( this.normalized ) w = denormalize( w, this.array );
  13220. return w;
  13221. }
  13222. setW( index, w ) {
  13223. if ( this.normalized ) w = normalize( w, this.array );
  13224. this.array[ index * this.itemSize + 3 ] = toHalfFloat( w );
  13225. return this;
  13226. }
  13227. setXY( index, x, y ) {
  13228. index *= this.itemSize;
  13229. if ( this.normalized ) {
  13230. x = normalize( x, this.array );
  13231. y = normalize( y, this.array );
  13232. }
  13233. this.array[ index + 0 ] = toHalfFloat( x );
  13234. this.array[ index + 1 ] = toHalfFloat( y );
  13235. return this;
  13236. }
  13237. setXYZ( index, x, y, z ) {
  13238. index *= this.itemSize;
  13239. if ( this.normalized ) {
  13240. x = normalize( x, this.array );
  13241. y = normalize( y, this.array );
  13242. z = normalize( z, this.array );
  13243. }
  13244. this.array[ index + 0 ] = toHalfFloat( x );
  13245. this.array[ index + 1 ] = toHalfFloat( y );
  13246. this.array[ index + 2 ] = toHalfFloat( z );
  13247. return this;
  13248. }
  13249. setXYZW( index, x, y, z, w ) {
  13250. index *= this.itemSize;
  13251. if ( this.normalized ) {
  13252. x = normalize( x, this.array );
  13253. y = normalize( y, this.array );
  13254. z = normalize( z, this.array );
  13255. w = normalize( w, this.array );
  13256. }
  13257. this.array[ index + 0 ] = toHalfFloat( x );
  13258. this.array[ index + 1 ] = toHalfFloat( y );
  13259. this.array[ index + 2 ] = toHalfFloat( z );
  13260. this.array[ index + 3 ] = toHalfFloat( w );
  13261. return this;
  13262. }
  13263. }
  13264. /**
  13265. * Convenient class that can be used when creating a `Float32` buffer attribute with
  13266. * a plain `Array` instance.
  13267. *
  13268. * @augments BufferAttribute
  13269. */
  13270. class Float32BufferAttribute extends BufferAttribute {
  13271. /**
  13272. * Constructs a new buffer attribute.
  13273. *
  13274. * @param {(Array<number>|Float32Array)} array - The array holding the attribute data.
  13275. * @param {number} itemSize - The item size.
  13276. * @param {boolean} [normalized=false] - Whether the data are normalized or not.
  13277. */
  13278. constructor( array, itemSize, normalized ) {
  13279. super( new Float32Array( array ), itemSize, normalized );
  13280. }
  13281. }
  13282. const _box$3 = /*@__PURE__*/ new Box3();
  13283. const _v1$3 = /*@__PURE__*/ new Vector3();
  13284. const _v2$2 = /*@__PURE__*/ new Vector3();
  13285. /**
  13286. * An analytical 3D sphere defined by a center and radius. This class is mainly
  13287. * used as a Bounding Sphere for 3D objects.
  13288. */
  13289. class Sphere {
  13290. /**
  13291. * Constructs a new sphere.
  13292. *
  13293. * @param {Vector3} [center=(0,0,0)] - The center of the sphere
  13294. * @param {number} [radius=-1] - The radius of the sphere.
  13295. */
  13296. constructor( center = new Vector3(), radius = -1 ) {
  13297. /**
  13298. * This flag can be used for type testing.
  13299. *
  13300. * @type {boolean}
  13301. * @readonly
  13302. * @default true
  13303. */
  13304. this.isSphere = true;
  13305. /**
  13306. * The center of the sphere
  13307. *
  13308. * @type {Vector3}
  13309. */
  13310. this.center = center;
  13311. /**
  13312. * The radius of the sphere.
  13313. *
  13314. * @type {number}
  13315. */
  13316. this.radius = radius;
  13317. }
  13318. /**
  13319. * Sets the sphere's components by copying the given values.
  13320. *
  13321. * @param {Vector3} center - The center.
  13322. * @param {number} radius - The radius.
  13323. * @return {Sphere} A reference to this sphere.
  13324. */
  13325. set( center, radius ) {
  13326. this.center.copy( center );
  13327. this.radius = radius;
  13328. return this;
  13329. }
  13330. /**
  13331. * Computes the minimum bounding sphere for list of points.
  13332. * If the optional center point is given, it is used as the sphere's
  13333. * center. Otherwise, the center of the axis-aligned bounding box
  13334. * encompassing the points is calculated.
  13335. *
  13336. * @param {Array<Vector3>} points - A list of points in 3D space.
  13337. * @param {Vector3} [optionalCenter] - The center of the sphere.
  13338. * @return {Sphere} A reference to this sphere.
  13339. */
  13340. setFromPoints( points, optionalCenter ) {
  13341. const center = this.center;
  13342. if ( optionalCenter !== undefined ) {
  13343. center.copy( optionalCenter );
  13344. } else {
  13345. _box$3.setFromPoints( points ).getCenter( center );
  13346. }
  13347. let maxRadiusSq = 0;
  13348. for ( let i = 0, il = points.length; i < il; i ++ ) {
  13349. maxRadiusSq = Math.max( maxRadiusSq, center.distanceToSquared( points[ i ] ) );
  13350. }
  13351. this.radius = Math.sqrt( maxRadiusSq );
  13352. return this;
  13353. }
  13354. /**
  13355. * Copies the values of the given sphere to this instance.
  13356. *
  13357. * @param {Sphere} sphere - The sphere to copy.
  13358. * @return {Sphere} A reference to this sphere.
  13359. */
  13360. copy( sphere ) {
  13361. this.center.copy( sphere.center );
  13362. this.radius = sphere.radius;
  13363. return this;
  13364. }
  13365. /**
  13366. * Returns `true` if the sphere is empty (the radius set to a negative number).
  13367. *
  13368. * Spheres with a radius of `0` contain only their center point and are not
  13369. * considered to be empty.
  13370. *
  13371. * @return {boolean} Whether this sphere is empty or not.
  13372. */
  13373. isEmpty() {
  13374. return ( this.radius < 0 );
  13375. }
  13376. /**
  13377. * Makes this sphere empty which means in encloses a zero space in 3D.
  13378. *
  13379. * @return {Sphere} A reference to this sphere.
  13380. */
  13381. makeEmpty() {
  13382. this.center.set( 0, 0, 0 );
  13383. this.radius = -1;
  13384. return this;
  13385. }
  13386. /**
  13387. * Returns `true` if this sphere contains the given point inclusive of
  13388. * the surface of the sphere.
  13389. *
  13390. * @param {Vector3} point - The point to check.
  13391. * @return {boolean} Whether this sphere contains the given point or not.
  13392. */
  13393. containsPoint( point ) {
  13394. return ( point.distanceToSquared( this.center ) <= ( this.radius * this.radius ) );
  13395. }
  13396. /**
  13397. * Returns the closest distance from the boundary of the sphere to the
  13398. * given point. If the sphere contains the point, the distance will
  13399. * be negative.
  13400. *
  13401. * @param {Vector3} point - The point to compute the distance to.
  13402. * @return {number} The distance to the point.
  13403. */
  13404. distanceToPoint( point ) {
  13405. return ( point.distanceTo( this.center ) - this.radius );
  13406. }
  13407. /**
  13408. * Returns `true` if this sphere intersects with the given one.
  13409. *
  13410. * @param {Sphere} sphere - The sphere to test.
  13411. * @return {boolean} Whether this sphere intersects with the given one or not.
  13412. */
  13413. intersectsSphere( sphere ) {
  13414. const radiusSum = this.radius + sphere.radius;
  13415. return sphere.center.distanceToSquared( this.center ) <= ( radiusSum * radiusSum );
  13416. }
  13417. /**
  13418. * Returns `true` if this sphere intersects with the given box.
  13419. *
  13420. * @param {Box3} box - The box to test.
  13421. * @return {boolean} Whether this sphere intersects with the given box or not.
  13422. */
  13423. intersectsBox( box ) {
  13424. return box.intersectsSphere( this );
  13425. }
  13426. /**
  13427. * Returns `true` if this sphere intersects with the given plane.
  13428. *
  13429. * @param {Plane} plane - The plane to test.
  13430. * @return {boolean} Whether this sphere intersects with the given plane or not.
  13431. */
  13432. intersectsPlane( plane ) {
  13433. return Math.abs( plane.distanceToPoint( this.center ) ) <= this.radius;
  13434. }
  13435. /**
  13436. * Clamps a point within the sphere. If the point is outside the sphere, it
  13437. * will clamp it to the closest point on the edge of the sphere. Points
  13438. * already inside the sphere will not be affected.
  13439. *
  13440. * @param {Vector3} point - The plane to clamp.
  13441. * @param {Vector3} target - The target vector that is used to store the method's result.
  13442. * @return {Vector3} The clamped point.
  13443. */
  13444. clampPoint( point, target ) {
  13445. const deltaLengthSq = this.center.distanceToSquared( point );
  13446. target.copy( point );
  13447. if ( deltaLengthSq > ( this.radius * this.radius ) ) {
  13448. target.sub( this.center ).normalize();
  13449. target.multiplyScalar( this.radius ).add( this.center );
  13450. }
  13451. return target;
  13452. }
  13453. /**
  13454. * Returns a bounding box that encloses this sphere.
  13455. *
  13456. * @param {Box3} target - The target box that is used to store the method's result.
  13457. * @return {Box3} The bounding box that encloses this sphere.
  13458. */
  13459. getBoundingBox( target ) {
  13460. if ( this.isEmpty() ) {
  13461. // Empty sphere produces empty bounding box
  13462. target.makeEmpty();
  13463. return target;
  13464. }
  13465. target.set( this.center, this.center );
  13466. target.expandByScalar( this.radius );
  13467. return target;
  13468. }
  13469. /**
  13470. * Transforms this sphere with the given 4x4 transformation matrix.
  13471. *
  13472. * @param {Matrix4} matrix - The transformation matrix.
  13473. * @return {Sphere} A reference to this sphere.
  13474. */
  13475. applyMatrix4( matrix ) {
  13476. this.center.applyMatrix4( matrix );
  13477. this.radius = this.radius * matrix.getMaxScaleOnAxis();
  13478. return this;
  13479. }
  13480. /**
  13481. * Translates the sphere's center by the given offset.
  13482. *
  13483. * @param {Vector3} offset - The offset.
  13484. * @return {Sphere} A reference to this sphere.
  13485. */
  13486. translate( offset ) {
  13487. this.center.add( offset );
  13488. return this;
  13489. }
  13490. /**
  13491. * Expands the boundaries of this sphere to include the given point.
  13492. *
  13493. * @param {Vector3} point - The point to include.
  13494. * @return {Sphere} A reference to this sphere.
  13495. */
  13496. expandByPoint( point ) {
  13497. if ( this.isEmpty() ) {
  13498. this.center.copy( point );
  13499. this.radius = 0;
  13500. return this;
  13501. }
  13502. _v1$3.subVectors( point, this.center );
  13503. const lengthSq = _v1$3.lengthSq();
  13504. if ( lengthSq > ( this.radius * this.radius ) ) {
  13505. // calculate the minimal sphere
  13506. const length = Math.sqrt( lengthSq );
  13507. const delta = ( length - this.radius ) * 0.5;
  13508. this.center.addScaledVector( _v1$3, delta / length );
  13509. this.radius += delta;
  13510. }
  13511. return this;
  13512. }
  13513. /**
  13514. * Expands this sphere to enclose both the original sphere and the given sphere.
  13515. *
  13516. * @param {Sphere} sphere - The sphere to include.
  13517. * @return {Sphere} A reference to this sphere.
  13518. */
  13519. union( sphere ) {
  13520. if ( sphere.isEmpty() ) {
  13521. return this;
  13522. }
  13523. if ( this.isEmpty() ) {
  13524. this.copy( sphere );
  13525. return this;
  13526. }
  13527. if ( this.center.equals( sphere.center ) === true ) {
  13528. this.radius = Math.max( this.radius, sphere.radius );
  13529. } else {
  13530. _v2$2.subVectors( sphere.center, this.center ).setLength( sphere.radius );
  13531. this.expandByPoint( _v1$3.copy( sphere.center ).add( _v2$2 ) );
  13532. this.expandByPoint( _v1$3.copy( sphere.center ).sub( _v2$2 ) );
  13533. }
  13534. return this;
  13535. }
  13536. /**
  13537. * Returns `true` if this sphere is equal with the given one.
  13538. *
  13539. * @param {Sphere} sphere - The sphere to test for equality.
  13540. * @return {boolean} Whether this bounding sphere is equal with the given one.
  13541. */
  13542. equals( sphere ) {
  13543. return sphere.center.equals( this.center ) && ( sphere.radius === this.radius );
  13544. }
  13545. /**
  13546. * Returns a new sphere with copied values from this instance.
  13547. *
  13548. * @return {Sphere} A clone of this instance.
  13549. */
  13550. clone() {
  13551. return new this.constructor().copy( this );
  13552. }
  13553. /**
  13554. * Returns a serialized structure of the bounding sphere.
  13555. *
  13556. * @return {Object} Serialized structure with fields representing the object state.
  13557. */
  13558. toJSON() {
  13559. return {
  13560. radius: this.radius,
  13561. center: this.center.toArray()
  13562. };
  13563. }
  13564. /**
  13565. * Returns a serialized structure of the bounding sphere.
  13566. *
  13567. * @param {Object} json - The serialized json to set the sphere from.
  13568. * @return {Sphere} A reference to this bounding sphere.
  13569. */
  13570. fromJSON( json ) {
  13571. this.radius = json.radius;
  13572. this.center.fromArray( json.center );
  13573. return this;
  13574. }
  13575. }
  13576. let _id$1 = 0;
  13577. const _m1 = /*@__PURE__*/ new Matrix4();
  13578. const _obj = /*@__PURE__*/ new Object3D();
  13579. const _offset = /*@__PURE__*/ new Vector3();
  13580. const _box$2 = /*@__PURE__*/ new Box3();
  13581. const _boxMorphTargets = /*@__PURE__*/ new Box3();
  13582. const _vector$9 = /*@__PURE__*/ new Vector3();
  13583. /**
  13584. * A representation of mesh, line, or point geometry. Includes vertex
  13585. * positions, face indices, normals, colors, UVs, and custom attributes
  13586. * within buffers, reducing the cost of passing all this data to the GPU.
  13587. *
  13588. * ```js
  13589. * const geometry = new THREE.BufferGeometry();
  13590. * // create a simple square shape. We duplicate the top left and bottom right
  13591. * // vertices because each vertex needs to appear once per triangle.
  13592. * const vertices = new Float32Array( [
  13593. * -1.0, -1.0, 1.0, // v0
  13594. * 1.0, -1.0, 1.0, // v1
  13595. * 1.0, 1.0, 1.0, // v2
  13596. *
  13597. * 1.0, 1.0, 1.0, // v3
  13598. * -1.0, 1.0, 1.0, // v4
  13599. * -1.0, -1.0, 1.0 // v5
  13600. * ] );
  13601. * // itemSize = 3 because there are 3 values (components) per vertex
  13602. * geometry.setAttribute( 'position', new THREE.BufferAttribute( vertices, 3 ) );
  13603. * const material = new THREE.MeshBasicMaterial( { color: 0xff0000 } );
  13604. * const mesh = new THREE.Mesh( geometry, material );
  13605. * ```
  13606. *
  13607. * @augments EventDispatcher
  13608. */
  13609. class BufferGeometry extends EventDispatcher {
  13610. /**
  13611. * Constructs a new geometry.
  13612. */
  13613. constructor() {
  13614. super();
  13615. /**
  13616. * This flag can be used for type testing.
  13617. *
  13618. * @type {boolean}
  13619. * @readonly
  13620. * @default true
  13621. */
  13622. this.isBufferGeometry = true;
  13623. /**
  13624. * The ID of the geometry.
  13625. *
  13626. * @name BufferGeometry#id
  13627. * @type {number}
  13628. * @readonly
  13629. */
  13630. Object.defineProperty( this, 'id', { value: _id$1 ++ } );
  13631. /**
  13632. * The UUID of the geometry.
  13633. *
  13634. * @type {string}
  13635. * @readonly
  13636. */
  13637. this.uuid = generateUUID();
  13638. /**
  13639. * The name of the geometry.
  13640. *
  13641. * @type {string}
  13642. */
  13643. this.name = '';
  13644. this.type = 'BufferGeometry';
  13645. /**
  13646. * Allows for vertices to be re-used across multiple triangles; this is
  13647. * called using "indexed triangles". Each triangle is associated with the
  13648. * indices of three vertices. This attribute therefore stores the index of
  13649. * each vertex for each triangular face. If this attribute is not set, the
  13650. * renderer assumes that each three contiguous positions represent a single triangle.
  13651. *
  13652. * @type {?BufferAttribute}
  13653. * @default null
  13654. */
  13655. this.index = null;
  13656. /**
  13657. * A (storage) buffer attribute which was generated with a compute shader and
  13658. * now defines indirect draw calls.
  13659. *
  13660. * Can only be used with {@link WebGPURenderer} and a WebGPU backend.
  13661. *
  13662. * @type {?BufferAttribute}
  13663. * @default null
  13664. */
  13665. this.indirect = null;
  13666. /**
  13667. * The offset, in bytes, into the indirect drawing buffer where the value data begins. If an array is provided, multiple indirect draw calls will be made for each offset.
  13668. *
  13669. * Can only be used with {@link WebGPURenderer} and a WebGPU backend.
  13670. *
  13671. * @type {number|Array<number>}
  13672. * @default 0
  13673. */
  13674. this.indirectOffset = 0;
  13675. /**
  13676. * This dictionary has as id the name of the attribute to be set and as value
  13677. * the buffer attribute to set it to. Rather than accessing this property directly,
  13678. * use `setAttribute()` and `getAttribute()` to access attributes of this geometry.
  13679. *
  13680. * @type {Object<string,(BufferAttribute|InterleavedBufferAttribute)>}
  13681. */
  13682. this.attributes = {};
  13683. /**
  13684. * This dictionary holds the morph targets of the geometry.
  13685. *
  13686. * Note: Once the geometry has been rendered, the morph attribute data cannot
  13687. * be changed. You will have to call `dispose()`, and create a new geometry instance.
  13688. *
  13689. * @type {Object}
  13690. */
  13691. this.morphAttributes = {};
  13692. /**
  13693. * Used to control the morph target behavior; when set to `true`, the morph
  13694. * target data is treated as relative offsets, rather than as absolute
  13695. * positions/normals.
  13696. *
  13697. * @type {boolean}
  13698. * @default false
  13699. */
  13700. this.morphTargetsRelative = false;
  13701. /**
  13702. * Split the geometry into groups, each of which will be rendered in a
  13703. * separate draw call. This allows an array of materials to be used with the geometry.
  13704. *
  13705. * Use `addGroup()` and `clearGroups()` to edit groups, rather than modifying this array directly.
  13706. *
  13707. * Every vertex and index must belong to exactly one group — groups must not share vertices or
  13708. * indices, and must not leave vertices or indices unused.
  13709. *
  13710. * @type {Array<Object>}
  13711. */
  13712. this.groups = [];
  13713. /**
  13714. * Bounding box for the geometry which can be calculated with `computeBoundingBox()`.
  13715. *
  13716. * @type {?Box3}
  13717. * @default null
  13718. */
  13719. this.boundingBox = null;
  13720. /**
  13721. * Bounding sphere for the geometry which can be calculated with `computeBoundingSphere()`.
  13722. *
  13723. * @type {?Sphere}
  13724. * @default null
  13725. */
  13726. this.boundingSphere = null;
  13727. /**
  13728. * Determines the part of the geometry to render. This should not be set directly,
  13729. * instead use `setDrawRange()`.
  13730. *
  13731. * @type {{start:number,count:number}}
  13732. */
  13733. this.drawRange = { start: 0, count: Infinity };
  13734. /**
  13735. * An object that can be used to store custom data about the geometry.
  13736. * It should not hold references to functions as these will not be cloned.
  13737. *
  13738. * @type {Object}
  13739. */
  13740. this.userData = {};
  13741. }
  13742. /**
  13743. * Returns the index of this geometry.
  13744. *
  13745. * @return {?BufferAttribute} The index. Returns `null` if no index is defined.
  13746. */
  13747. getIndex() {
  13748. return this.index;
  13749. }
  13750. /**
  13751. * Sets the given index to this geometry.
  13752. *
  13753. * @param {Array<number>|BufferAttribute} index - The index to set.
  13754. * @return {BufferGeometry} A reference to this instance.
  13755. */
  13756. setIndex( index ) {
  13757. if ( Array.isArray( index ) ) {
  13758. this.index = new ( arrayNeedsUint32( index ) ? Uint32BufferAttribute : Uint16BufferAttribute )( index, 1 );
  13759. } else {
  13760. this.index = index;
  13761. }
  13762. return this;
  13763. }
  13764. /**
  13765. * Sets the given indirect attribute to this geometry.
  13766. *
  13767. * @param {BufferAttribute} indirect - The attribute holding indirect draw calls.
  13768. * @param {number|Array<number>} [indirectOffset=0] - The offset, in bytes, into the indirect drawing buffer where the value data begins. If an array is provided, multiple indirect draw calls will be made for each offset.
  13769. * @return {BufferGeometry} A reference to this instance.
  13770. */
  13771. setIndirect( indirect, indirectOffset = 0 ) {
  13772. this.indirect = indirect;
  13773. this.indirectOffset = indirectOffset;
  13774. return this;
  13775. }
  13776. /**
  13777. * Returns the indirect attribute of this geometry.
  13778. *
  13779. * @return {?BufferAttribute} The indirect attribute. Returns `null` if no indirect attribute is defined.
  13780. */
  13781. getIndirect() {
  13782. return this.indirect;
  13783. }
  13784. /**
  13785. * Returns the buffer attribute for the given name.
  13786. *
  13787. * @param {string} name - The attribute name.
  13788. * @return {BufferAttribute|InterleavedBufferAttribute|undefined} The buffer attribute.
  13789. * Returns `undefined` if not attribute has been found.
  13790. */
  13791. getAttribute( name ) {
  13792. return this.attributes[ name ];
  13793. }
  13794. /**
  13795. * Sets the given attribute for the given name.
  13796. *
  13797. * @param {string} name - The attribute name.
  13798. * @param {BufferAttribute|InterleavedBufferAttribute} attribute - The attribute to set.
  13799. * @return {BufferGeometry} A reference to this instance.
  13800. */
  13801. setAttribute( name, attribute ) {
  13802. this.attributes[ name ] = attribute;
  13803. return this;
  13804. }
  13805. /**
  13806. * Deletes the attribute for the given name.
  13807. *
  13808. * @param {string} name - The attribute name to delete.
  13809. * @return {BufferGeometry} A reference to this instance.
  13810. */
  13811. deleteAttribute( name ) {
  13812. delete this.attributes[ name ];
  13813. return this;
  13814. }
  13815. /**
  13816. * Returns `true` if this geometry has an attribute for the given name.
  13817. *
  13818. * @param {string} name - The attribute name.
  13819. * @return {boolean} Whether this geometry has an attribute for the given name or not.
  13820. */
  13821. hasAttribute( name ) {
  13822. return this.attributes[ name ] !== undefined;
  13823. }
  13824. /**
  13825. * Adds a group to this geometry.
  13826. *
  13827. * @param {number} start - The first element in this draw call. That is the first
  13828. * vertex for non-indexed geometry, otherwise the first triangle index.
  13829. * @param {number} count - Specifies how many vertices (or indices) are part of this group.
  13830. * @param {number} [materialIndex=0] - The material array index to use.
  13831. */
  13832. addGroup( start, count, materialIndex = 0 ) {
  13833. this.groups.push( {
  13834. start: start,
  13835. count: count,
  13836. materialIndex: materialIndex
  13837. } );
  13838. }
  13839. /**
  13840. * Clears all groups.
  13841. */
  13842. clearGroups() {
  13843. this.groups = [];
  13844. }
  13845. /**
  13846. * Sets the draw range for this geometry.
  13847. *
  13848. * @param {number} start - The first vertex for non-indexed geometry, otherwise the first triangle index.
  13849. * @param {number} count - For non-indexed BufferGeometry, `count` is the number of vertices to render.
  13850. * For indexed BufferGeometry, `count` is the number of indices to render.
  13851. */
  13852. setDrawRange( start, count ) {
  13853. this.drawRange.start = start;
  13854. this.drawRange.count = count;
  13855. }
  13856. /**
  13857. * Applies the given 4x4 transformation matrix to the geometry.
  13858. *
  13859. * @param {Matrix4} matrix - The matrix to apply.
  13860. * @return {BufferGeometry} A reference to this instance.
  13861. */
  13862. applyMatrix4( matrix ) {
  13863. const position = this.attributes.position;
  13864. if ( position !== undefined ) {
  13865. position.applyMatrix4( matrix );
  13866. position.needsUpdate = true;
  13867. }
  13868. const normal = this.attributes.normal;
  13869. if ( normal !== undefined ) {
  13870. const normalMatrix = new Matrix3().getNormalMatrix( matrix );
  13871. normal.applyNormalMatrix( normalMatrix );
  13872. normal.needsUpdate = true;
  13873. }
  13874. const tangent = this.attributes.tangent;
  13875. if ( tangent !== undefined ) {
  13876. tangent.transformDirection( matrix );
  13877. tangent.needsUpdate = true;
  13878. }
  13879. if ( this.boundingBox !== null ) {
  13880. this.computeBoundingBox();
  13881. }
  13882. if ( this.boundingSphere !== null ) {
  13883. this.computeBoundingSphere();
  13884. }
  13885. return this;
  13886. }
  13887. /**
  13888. * Applies the rotation represented by the Quaternion to the geometry.
  13889. *
  13890. * @param {Quaternion} q - The Quaternion to apply.
  13891. * @return {BufferGeometry} A reference to this instance.
  13892. */
  13893. applyQuaternion( q ) {
  13894. _m1.makeRotationFromQuaternion( q );
  13895. this.applyMatrix4( _m1 );
  13896. return this;
  13897. }
  13898. /**
  13899. * Rotates the geometry about the X axis. This is typically done as a one time
  13900. * operation, and not during a loop. Use {@link Object3D#rotation} for typical
  13901. * real-time mesh rotation.
  13902. *
  13903. * @param {number} angle - The angle in radians.
  13904. * @return {BufferGeometry} A reference to this instance.
  13905. */
  13906. rotateX( angle ) {
  13907. // rotate geometry around world x-axis
  13908. _m1.makeRotationX( angle );
  13909. this.applyMatrix4( _m1 );
  13910. return this;
  13911. }
  13912. /**
  13913. * Rotates the geometry about the Y axis. This is typically done as a one time
  13914. * operation, and not during a loop. Use {@link Object3D#rotation} for typical
  13915. * real-time mesh rotation.
  13916. *
  13917. * @param {number} angle - The angle in radians.
  13918. * @return {BufferGeometry} A reference to this instance.
  13919. */
  13920. rotateY( angle ) {
  13921. // rotate geometry around world y-axis
  13922. _m1.makeRotationY( angle );
  13923. this.applyMatrix4( _m1 );
  13924. return this;
  13925. }
  13926. /**
  13927. * Rotates the geometry about the Z axis. This is typically done as a one time
  13928. * operation, and not during a loop. Use {@link Object3D#rotation} for typical
  13929. * real-time mesh rotation.
  13930. *
  13931. * @param {number} angle - The angle in radians.
  13932. * @return {BufferGeometry} A reference to this instance.
  13933. */
  13934. rotateZ( angle ) {
  13935. // rotate geometry around world z-axis
  13936. _m1.makeRotationZ( angle );
  13937. this.applyMatrix4( _m1 );
  13938. return this;
  13939. }
  13940. /**
  13941. * Translates the geometry. This is typically done as a one time
  13942. * operation, and not during a loop. Use {@link Object3D#position} for typical
  13943. * real-time mesh rotation.
  13944. *
  13945. * @param {number} x - The x offset.
  13946. * @param {number} y - The y offset.
  13947. * @param {number} z - The z offset.
  13948. * @return {BufferGeometry} A reference to this instance.
  13949. */
  13950. translate( x, y, z ) {
  13951. // translate geometry
  13952. _m1.makeTranslation( x, y, z );
  13953. this.applyMatrix4( _m1 );
  13954. return this;
  13955. }
  13956. /**
  13957. * Scales the geometry. This is typically done as a one time
  13958. * operation, and not during a loop. Use {@link Object3D#scale} for typical
  13959. * real-time mesh rotation.
  13960. *
  13961. * @param {number} x - The x scale.
  13962. * @param {number} y - The y scale.
  13963. * @param {number} z - The z scale.
  13964. * @return {BufferGeometry} A reference to this instance.
  13965. */
  13966. scale( x, y, z ) {
  13967. // scale geometry
  13968. _m1.makeScale( x, y, z );
  13969. this.applyMatrix4( _m1 );
  13970. return this;
  13971. }
  13972. /**
  13973. * Rotates the geometry to face a point in 3D space. This is typically done as a one time
  13974. * operation, and not during a loop. Use {@link Object3D#lookAt} for typical
  13975. * real-time mesh rotation.
  13976. *
  13977. * @param {Vector3} vector - The target point.
  13978. * @return {BufferGeometry} A reference to this instance.
  13979. */
  13980. lookAt( vector ) {
  13981. _obj.lookAt( vector );
  13982. _obj.updateMatrix();
  13983. this.applyMatrix4( _obj.matrix );
  13984. return this;
  13985. }
  13986. /**
  13987. * Center the geometry based on its bounding box.
  13988. *
  13989. * @return {BufferGeometry} A reference to this instance.
  13990. */
  13991. center() {
  13992. this.computeBoundingBox();
  13993. this.boundingBox.getCenter( _offset ).negate();
  13994. this.translate( _offset.x, _offset.y, _offset.z );
  13995. return this;
  13996. }
  13997. /**
  13998. * Defines a geometry by creating a `position` attribute based on the given array of points. The array
  13999. * can hold 2D or 3D vectors. When using two-dimensional data, the `z` coordinate for all vertices is
  14000. * set to `0`.
  14001. *
  14002. * If the method is used with an existing `position` attribute, the vertex data are overwritten with the
  14003. * data from the array. The length of the array must match the vertex count.
  14004. *
  14005. * @param {Array<Vector2>|Array<Vector3>} points - The points.
  14006. * @return {BufferGeometry} A reference to this instance.
  14007. */
  14008. setFromPoints( points ) {
  14009. const positionAttribute = this.getAttribute( 'position' );
  14010. if ( positionAttribute === undefined ) {
  14011. const position = [];
  14012. for ( let i = 0, l = points.length; i < l; i ++ ) {
  14013. const point = points[ i ];
  14014. position.push( point.x, point.y, point.z || 0 );
  14015. }
  14016. this.setAttribute( 'position', new Float32BufferAttribute( position, 3 ) );
  14017. } else {
  14018. const l = Math.min( points.length, positionAttribute.count ); // make sure data do not exceed buffer size
  14019. for ( let i = 0; i < l; i ++ ) {
  14020. const point = points[ i ];
  14021. positionAttribute.setXYZ( i, point.x, point.y, point.z || 0 );
  14022. }
  14023. if ( points.length > positionAttribute.count ) {
  14024. warn( 'BufferGeometry: Buffer size too small for points data. Use .dispose() and create a new geometry.' );
  14025. }
  14026. positionAttribute.needsUpdate = true;
  14027. }
  14028. return this;
  14029. }
  14030. /**
  14031. * Computes the bounding box of the geometry, and updates the `boundingBox` member.
  14032. * The bounding box is not computed by the engine; it must be computed by your app.
  14033. * You may need to recompute the bounding box if the geometry vertices are modified.
  14034. */
  14035. computeBoundingBox() {
  14036. if ( this.boundingBox === null ) {
  14037. this.boundingBox = new Box3();
  14038. }
  14039. const position = this.attributes.position;
  14040. const morphAttributesPosition = this.morphAttributes.position;
  14041. if ( position && position.isGLBufferAttribute ) {
  14042. error( 'BufferGeometry.computeBoundingBox(): GLBufferAttribute requires a manual bounding box.', this );
  14043. this.boundingBox.set(
  14044. new Vector3( - Infinity, - Infinity, - Infinity ),
  14045. new Vector3( + Infinity, + Infinity, + Infinity )
  14046. );
  14047. return;
  14048. }
  14049. if ( position !== undefined ) {
  14050. this.boundingBox.setFromBufferAttribute( position );
  14051. // process morph attributes if present
  14052. if ( morphAttributesPosition ) {
  14053. for ( let i = 0, il = morphAttributesPosition.length; i < il; i ++ ) {
  14054. const morphAttribute = morphAttributesPosition[ i ];
  14055. _box$2.setFromBufferAttribute( morphAttribute );
  14056. if ( this.morphTargetsRelative ) {
  14057. _vector$9.addVectors( this.boundingBox.min, _box$2.min );
  14058. this.boundingBox.expandByPoint( _vector$9 );
  14059. _vector$9.addVectors( this.boundingBox.max, _box$2.max );
  14060. this.boundingBox.expandByPoint( _vector$9 );
  14061. } else {
  14062. this.boundingBox.expandByPoint( _box$2.min );
  14063. this.boundingBox.expandByPoint( _box$2.max );
  14064. }
  14065. }
  14066. }
  14067. } else {
  14068. this.boundingBox.makeEmpty();
  14069. }
  14070. if ( isNaN( this.boundingBox.min.x ) || isNaN( this.boundingBox.min.y ) || isNaN( this.boundingBox.min.z ) ) {
  14071. error( 'BufferGeometry.computeBoundingBox(): Computed min/max have NaN values. The "position" attribute is likely to have NaN values.', this );
  14072. }
  14073. }
  14074. /**
  14075. * Computes the bounding sphere of the geometry, and updates the `boundingSphere` member.
  14076. * The engine automatically computes the bounding sphere when it is needed, e.g., for ray casting or view frustum culling.
  14077. * You may need to recompute the bounding sphere if the geometry vertices are modified.
  14078. */
  14079. computeBoundingSphere() {
  14080. if ( this.boundingSphere === null ) {
  14081. this.boundingSphere = new Sphere();
  14082. }
  14083. const position = this.attributes.position;
  14084. const morphAttributesPosition = this.morphAttributes.position;
  14085. if ( position && position.isGLBufferAttribute ) {
  14086. error( 'BufferGeometry.computeBoundingSphere(): GLBufferAttribute requires a manual bounding sphere.', this );
  14087. this.boundingSphere.set( new Vector3(), Infinity );
  14088. return;
  14089. }
  14090. if ( position ) {
  14091. // first, find the center of the bounding sphere
  14092. const center = this.boundingSphere.center;
  14093. _box$2.setFromBufferAttribute( position );
  14094. // process morph attributes if present
  14095. if ( morphAttributesPosition ) {
  14096. for ( let i = 0, il = morphAttributesPosition.length; i < il; i ++ ) {
  14097. const morphAttribute = morphAttributesPosition[ i ];
  14098. _boxMorphTargets.setFromBufferAttribute( morphAttribute );
  14099. if ( this.morphTargetsRelative ) {
  14100. _vector$9.addVectors( _box$2.min, _boxMorphTargets.min );
  14101. _box$2.expandByPoint( _vector$9 );
  14102. _vector$9.addVectors( _box$2.max, _boxMorphTargets.max );
  14103. _box$2.expandByPoint( _vector$9 );
  14104. } else {
  14105. _box$2.expandByPoint( _boxMorphTargets.min );
  14106. _box$2.expandByPoint( _boxMorphTargets.max );
  14107. }
  14108. }
  14109. }
  14110. _box$2.getCenter( center );
  14111. // second, try to find a boundingSphere with a radius smaller than the
  14112. // boundingSphere of the boundingBox: sqrt(3) smaller in the best case
  14113. let maxRadiusSq = 0;
  14114. for ( let i = 0, il = position.count; i < il; i ++ ) {
  14115. _vector$9.fromBufferAttribute( position, i );
  14116. maxRadiusSq = Math.max( maxRadiusSq, center.distanceToSquared( _vector$9 ) );
  14117. }
  14118. // process morph attributes if present
  14119. if ( morphAttributesPosition ) {
  14120. for ( let i = 0, il = morphAttributesPosition.length; i < il; i ++ ) {
  14121. const morphAttribute = morphAttributesPosition[ i ];
  14122. const morphTargetsRelative = this.morphTargetsRelative;
  14123. for ( let j = 0, jl = morphAttribute.count; j < jl; j ++ ) {
  14124. _vector$9.fromBufferAttribute( morphAttribute, j );
  14125. if ( morphTargetsRelative ) {
  14126. _offset.fromBufferAttribute( position, j );
  14127. _vector$9.add( _offset );
  14128. }
  14129. maxRadiusSq = Math.max( maxRadiusSq, center.distanceToSquared( _vector$9 ) );
  14130. }
  14131. }
  14132. }
  14133. this.boundingSphere.radius = Math.sqrt( maxRadiusSq );
  14134. if ( isNaN( this.boundingSphere.radius ) ) {
  14135. error( 'BufferGeometry.computeBoundingSphere(): Computed radius is NaN. The "position" attribute is likely to have NaN values.', this );
  14136. }
  14137. }
  14138. }
  14139. /**
  14140. * Calculates and adds a tangent attribute to this geometry.
  14141. *
  14142. * The computation is only supported for indexed geometries and if position, normal, and uv attributes
  14143. * are defined. When using a tangent space normal map, prefer the MikkTSpace algorithm provided by
  14144. * {@link BufferGeometryUtils#computeMikkTSpaceTangents} instead.
  14145. */
  14146. computeTangents() {
  14147. const index = this.index;
  14148. const attributes = this.attributes;
  14149. // based on http://www.terathon.com/code/tangent.html
  14150. // (per vertex tangents)
  14151. if ( index === null ||
  14152. attributes.position === undefined ||
  14153. attributes.normal === undefined ||
  14154. attributes.uv === undefined ) {
  14155. error( 'BufferGeometry: .computeTangents() failed. Missing required attributes (index, position, normal or uv)' );
  14156. return;
  14157. }
  14158. const positionAttribute = attributes.position;
  14159. const normalAttribute = attributes.normal;
  14160. const uvAttribute = attributes.uv;
  14161. if ( this.hasAttribute( 'tangent' ) === false ) {
  14162. this.setAttribute( 'tangent', new BufferAttribute( new Float32Array( 4 * positionAttribute.count ), 4 ) );
  14163. }
  14164. const tangentAttribute = this.getAttribute( 'tangent' );
  14165. const tan1 = [], tan2 = [];
  14166. for ( let i = 0; i < positionAttribute.count; i ++ ) {
  14167. tan1[ i ] = new Vector3();
  14168. tan2[ i ] = new Vector3();
  14169. }
  14170. const vA = new Vector3(),
  14171. vB = new Vector3(),
  14172. vC = new Vector3(),
  14173. uvA = new Vector2(),
  14174. uvB = new Vector2(),
  14175. uvC = new Vector2(),
  14176. sdir = new Vector3(),
  14177. tdir = new Vector3();
  14178. function handleTriangle( a, b, c ) {
  14179. vA.fromBufferAttribute( positionAttribute, a );
  14180. vB.fromBufferAttribute( positionAttribute, b );
  14181. vC.fromBufferAttribute( positionAttribute, c );
  14182. uvA.fromBufferAttribute( uvAttribute, a );
  14183. uvB.fromBufferAttribute( uvAttribute, b );
  14184. uvC.fromBufferAttribute( uvAttribute, c );
  14185. vB.sub( vA );
  14186. vC.sub( vA );
  14187. uvB.sub( uvA );
  14188. uvC.sub( uvA );
  14189. const r = 1.0 / ( uvB.x * uvC.y - uvC.x * uvB.y );
  14190. // silently ignore degenerate uv triangles having coincident or colinear vertices
  14191. if ( ! isFinite( r ) ) return;
  14192. sdir.copy( vB ).multiplyScalar( uvC.y ).addScaledVector( vC, - uvB.y ).multiplyScalar( r );
  14193. tdir.copy( vC ).multiplyScalar( uvB.x ).addScaledVector( vB, - uvC.x ).multiplyScalar( r );
  14194. tan1[ a ].add( sdir );
  14195. tan1[ b ].add( sdir );
  14196. tan1[ c ].add( sdir );
  14197. tan2[ a ].add( tdir );
  14198. tan2[ b ].add( tdir );
  14199. tan2[ c ].add( tdir );
  14200. }
  14201. let groups = this.groups;
  14202. if ( groups.length === 0 ) {
  14203. groups = [ {
  14204. start: 0,
  14205. count: index.count
  14206. } ];
  14207. }
  14208. for ( let i = 0, il = groups.length; i < il; ++ i ) {
  14209. const group = groups[ i ];
  14210. const start = group.start;
  14211. const count = group.count;
  14212. for ( let j = start, jl = start + count; j < jl; j += 3 ) {
  14213. handleTriangle(
  14214. index.getX( j + 0 ),
  14215. index.getX( j + 1 ),
  14216. index.getX( j + 2 )
  14217. );
  14218. }
  14219. }
  14220. const tmp = new Vector3(), tmp2 = new Vector3();
  14221. const n = new Vector3(), n2 = new Vector3();
  14222. function handleVertex( v ) {
  14223. n.fromBufferAttribute( normalAttribute, v );
  14224. n2.copy( n );
  14225. const t = tan1[ v ];
  14226. // Gram-Schmidt orthogonalize
  14227. tmp.copy( t );
  14228. tmp.sub( n.multiplyScalar( n.dot( t ) ) ).normalize();
  14229. // Calculate handedness
  14230. tmp2.crossVectors( n2, t );
  14231. const test = tmp2.dot( tan2[ v ] );
  14232. const w = ( test < 0.0 ) ? -1 : 1.0;
  14233. tangentAttribute.setXYZW( v, tmp.x, tmp.y, tmp.z, w );
  14234. }
  14235. for ( let i = 0, il = groups.length; i < il; ++ i ) {
  14236. const group = groups[ i ];
  14237. const start = group.start;
  14238. const count = group.count;
  14239. for ( let j = start, jl = start + count; j < jl; j += 3 ) {
  14240. handleVertex( index.getX( j + 0 ) );
  14241. handleVertex( index.getX( j + 1 ) );
  14242. handleVertex( index.getX( j + 2 ) );
  14243. }
  14244. }
  14245. }
  14246. /**
  14247. * Computes vertex normals for the given vertex data. For indexed geometries, the method sets
  14248. * each vertex normal to be the average of the face normals of the faces that share that vertex.
  14249. * For non-indexed geometries, vertices are not shared, and the method sets each vertex normal
  14250. * to be the same as the face normal.
  14251. */
  14252. computeVertexNormals() {
  14253. const index = this.index;
  14254. const positionAttribute = this.getAttribute( 'position' );
  14255. if ( positionAttribute !== undefined ) {
  14256. let normalAttribute = this.getAttribute( 'normal' );
  14257. if ( normalAttribute === undefined ) {
  14258. normalAttribute = new BufferAttribute( new Float32Array( positionAttribute.count * 3 ), 3 );
  14259. this.setAttribute( 'normal', normalAttribute );
  14260. } else {
  14261. // reset existing normals to zero
  14262. for ( let i = 0, il = normalAttribute.count; i < il; i ++ ) {
  14263. normalAttribute.setXYZ( i, 0, 0, 0 );
  14264. }
  14265. }
  14266. const pA = new Vector3(), pB = new Vector3(), pC = new Vector3();
  14267. const nA = new Vector3(), nB = new Vector3(), nC = new Vector3();
  14268. const cb = new Vector3(), ab = new Vector3();
  14269. // indexed elements
  14270. if ( index ) {
  14271. for ( let i = 0, il = index.count; i < il; i += 3 ) {
  14272. const vA = index.getX( i + 0 );
  14273. const vB = index.getX( i + 1 );
  14274. const vC = index.getX( i + 2 );
  14275. pA.fromBufferAttribute( positionAttribute, vA );
  14276. pB.fromBufferAttribute( positionAttribute, vB );
  14277. pC.fromBufferAttribute( positionAttribute, vC );
  14278. cb.subVectors( pC, pB );
  14279. ab.subVectors( pA, pB );
  14280. cb.cross( ab );
  14281. nA.fromBufferAttribute( normalAttribute, vA );
  14282. nB.fromBufferAttribute( normalAttribute, vB );
  14283. nC.fromBufferAttribute( normalAttribute, vC );
  14284. nA.add( cb );
  14285. nB.add( cb );
  14286. nC.add( cb );
  14287. normalAttribute.setXYZ( vA, nA.x, nA.y, nA.z );
  14288. normalAttribute.setXYZ( vB, nB.x, nB.y, nB.z );
  14289. normalAttribute.setXYZ( vC, nC.x, nC.y, nC.z );
  14290. }
  14291. } else {
  14292. // non-indexed elements (unconnected triangle soup)
  14293. for ( let i = 0, il = positionAttribute.count; i < il; i += 3 ) {
  14294. pA.fromBufferAttribute( positionAttribute, i + 0 );
  14295. pB.fromBufferAttribute( positionAttribute, i + 1 );
  14296. pC.fromBufferAttribute( positionAttribute, i + 2 );
  14297. cb.subVectors( pC, pB );
  14298. ab.subVectors( pA, pB );
  14299. cb.cross( ab );
  14300. normalAttribute.setXYZ( i + 0, cb.x, cb.y, cb.z );
  14301. normalAttribute.setXYZ( i + 1, cb.x, cb.y, cb.z );
  14302. normalAttribute.setXYZ( i + 2, cb.x, cb.y, cb.z );
  14303. }
  14304. }
  14305. this.normalizeNormals();
  14306. normalAttribute.needsUpdate = true;
  14307. }
  14308. }
  14309. /**
  14310. * Ensures every normal vector in a geometry will have a magnitude of `1`. This will
  14311. * correct lighting on the geometry surfaces.
  14312. */
  14313. normalizeNormals() {
  14314. const normals = this.attributes.normal;
  14315. for ( let i = 0, il = normals.count; i < il; i ++ ) {
  14316. _vector$9.fromBufferAttribute( normals, i );
  14317. _vector$9.normalize();
  14318. normals.setXYZ( i, _vector$9.x, _vector$9.y, _vector$9.z );
  14319. }
  14320. }
  14321. /**
  14322. * Return a new non-index version of this indexed geometry. If the geometry
  14323. * is already non-indexed, the method is a NOOP.
  14324. *
  14325. * @return {BufferGeometry} The non-indexed version of this indexed geometry.
  14326. */
  14327. toNonIndexed() {
  14328. function convertBufferAttribute( attribute, indices ) {
  14329. const array = attribute.array;
  14330. const itemSize = attribute.itemSize;
  14331. const normalized = attribute.normalized;
  14332. const array2 = new array.constructor( indices.length * itemSize );
  14333. let index = 0, index2 = 0;
  14334. for ( let i = 0, l = indices.length; i < l; i ++ ) {
  14335. if ( attribute.isInterleavedBufferAttribute ) {
  14336. index = indices[ i ] * attribute.data.stride + attribute.offset;
  14337. } else {
  14338. index = indices[ i ] * itemSize;
  14339. }
  14340. for ( let j = 0; j < itemSize; j ++ ) {
  14341. array2[ index2 ++ ] = array[ index ++ ];
  14342. }
  14343. }
  14344. return new BufferAttribute( array2, itemSize, normalized );
  14345. }
  14346. //
  14347. if ( this.index === null ) {
  14348. warn( 'BufferGeometry.toNonIndexed(): BufferGeometry is already non-indexed.' );
  14349. return this;
  14350. }
  14351. const geometry2 = new BufferGeometry();
  14352. const indices = this.index.array;
  14353. const attributes = this.attributes;
  14354. // attributes
  14355. for ( const name in attributes ) {
  14356. const attribute = attributes[ name ];
  14357. const newAttribute = convertBufferAttribute( attribute, indices );
  14358. geometry2.setAttribute( name, newAttribute );
  14359. }
  14360. // morph attributes
  14361. const morphAttributes = this.morphAttributes;
  14362. for ( const name in morphAttributes ) {
  14363. const morphArray = [];
  14364. const morphAttribute = morphAttributes[ name ]; // morphAttribute: array of Float32BufferAttributes
  14365. for ( let i = 0, il = morphAttribute.length; i < il; i ++ ) {
  14366. const attribute = morphAttribute[ i ];
  14367. const newAttribute = convertBufferAttribute( attribute, indices );
  14368. morphArray.push( newAttribute );
  14369. }
  14370. geometry2.morphAttributes[ name ] = morphArray;
  14371. }
  14372. geometry2.morphTargetsRelative = this.morphTargetsRelative;
  14373. // groups
  14374. const groups = this.groups;
  14375. for ( let i = 0, l = groups.length; i < l; i ++ ) {
  14376. const group = groups[ i ];
  14377. geometry2.addGroup( group.start, group.count, group.materialIndex );
  14378. }
  14379. return geometry2;
  14380. }
  14381. /**
  14382. * Serializes the geometry into JSON.
  14383. *
  14384. * @return {Object} A JSON object representing the serialized geometry.
  14385. */
  14386. toJSON() {
  14387. const data = {
  14388. metadata: {
  14389. version: 4.7,
  14390. type: 'BufferGeometry',
  14391. generator: 'BufferGeometry.toJSON'
  14392. }
  14393. };
  14394. // standard BufferGeometry serialization
  14395. data.uuid = this.uuid;
  14396. data.type = this.type;
  14397. if ( this.name !== '' ) data.name = this.name;
  14398. if ( Object.keys( this.userData ).length > 0 ) data.userData = this.userData;
  14399. if ( this.parameters !== undefined ) {
  14400. const parameters = this.parameters;
  14401. for ( const key in parameters ) {
  14402. if ( parameters[ key ] !== undefined ) data[ key ] = parameters[ key ];
  14403. }
  14404. return data;
  14405. }
  14406. // for simplicity the code assumes attributes are not shared across geometries, see #15811
  14407. data.data = { attributes: {} };
  14408. const index = this.index;
  14409. if ( index !== null ) {
  14410. data.data.index = {
  14411. type: index.array.constructor.name,
  14412. array: Array.prototype.slice.call( index.array )
  14413. };
  14414. }
  14415. const attributes = this.attributes;
  14416. for ( const key in attributes ) {
  14417. const attribute = attributes[ key ];
  14418. data.data.attributes[ key ] = attribute.toJSON( data.data );
  14419. }
  14420. const morphAttributes = {};
  14421. let hasMorphAttributes = false;
  14422. for ( const key in this.morphAttributes ) {
  14423. const attributeArray = this.morphAttributes[ key ];
  14424. const array = [];
  14425. for ( let i = 0, il = attributeArray.length; i < il; i ++ ) {
  14426. const attribute = attributeArray[ i ];
  14427. array.push( attribute.toJSON( data.data ) );
  14428. }
  14429. if ( array.length > 0 ) {
  14430. morphAttributes[ key ] = array;
  14431. hasMorphAttributes = true;
  14432. }
  14433. }
  14434. if ( hasMorphAttributes ) {
  14435. data.data.morphAttributes = morphAttributes;
  14436. data.data.morphTargetsRelative = this.morphTargetsRelative;
  14437. }
  14438. const groups = this.groups;
  14439. if ( groups.length > 0 ) {
  14440. data.data.groups = JSON.parse( JSON.stringify( groups ) );
  14441. }
  14442. const boundingSphere = this.boundingSphere;
  14443. if ( boundingSphere !== null ) {
  14444. data.data.boundingSphere = boundingSphere.toJSON();
  14445. }
  14446. return data;
  14447. }
  14448. /**
  14449. * Returns a new geometry with copied values from this instance.
  14450. *
  14451. * @return {BufferGeometry} A clone of this instance.
  14452. */
  14453. clone() {
  14454. return new this.constructor().copy( this );
  14455. }
  14456. /**
  14457. * Copies the values of the given geometry to this instance.
  14458. *
  14459. * @param {BufferGeometry} source - The geometry to copy.
  14460. * @return {BufferGeometry} A reference to this instance.
  14461. */
  14462. copy( source ) {
  14463. // reset
  14464. this.index = null;
  14465. this.attributes = {};
  14466. this.morphAttributes = {};
  14467. this.groups = [];
  14468. this.boundingBox = null;
  14469. this.boundingSphere = null;
  14470. // used for storing cloned, shared data
  14471. const data = {};
  14472. // name
  14473. this.name = source.name;
  14474. // index
  14475. const index = source.index;
  14476. if ( index !== null ) {
  14477. this.setIndex( index.clone() );
  14478. }
  14479. // attributes
  14480. const attributes = source.attributes;
  14481. for ( const name in attributes ) {
  14482. const attribute = attributes[ name ];
  14483. this.setAttribute( name, attribute.clone( data ) );
  14484. }
  14485. // morph attributes
  14486. const morphAttributes = source.morphAttributes;
  14487. for ( const name in morphAttributes ) {
  14488. const array = [];
  14489. const morphAttribute = morphAttributes[ name ]; // morphAttribute: array of Float32BufferAttributes
  14490. for ( let i = 0, l = morphAttribute.length; i < l; i ++ ) {
  14491. array.push( morphAttribute[ i ].clone( data ) );
  14492. }
  14493. this.morphAttributes[ name ] = array;
  14494. }
  14495. this.morphTargetsRelative = source.morphTargetsRelative;
  14496. // groups
  14497. const groups = source.groups;
  14498. for ( let i = 0, l = groups.length; i < l; i ++ ) {
  14499. const group = groups[ i ];
  14500. this.addGroup( group.start, group.count, group.materialIndex );
  14501. }
  14502. // bounding box
  14503. const boundingBox = source.boundingBox;
  14504. if ( boundingBox !== null ) {
  14505. this.boundingBox = boundingBox.clone();
  14506. }
  14507. // bounding sphere
  14508. const boundingSphere = source.boundingSphere;
  14509. if ( boundingSphere !== null ) {
  14510. this.boundingSphere = boundingSphere.clone();
  14511. }
  14512. // draw range
  14513. this.drawRange.start = source.drawRange.start;
  14514. this.drawRange.count = source.drawRange.count;
  14515. // user data
  14516. this.userData = source.userData;
  14517. return this;
  14518. }
  14519. /**
  14520. * Frees the GPU-related resources allocated by this instance. Call this
  14521. * method whenever this instance is no longer used in your app.
  14522. *
  14523. * @fires BufferGeometry#dispose
  14524. */
  14525. dispose() {
  14526. this.dispatchEvent( { type: 'dispose' } );
  14527. }
  14528. }
  14529. /**
  14530. * "Interleaved" means that multiple attributes, possibly of different types,
  14531. * (e.g., position, normal, uv, color) are packed into a single array buffer.
  14532. *
  14533. * An introduction into interleaved arrays can be found here: [Interleaved array basics](https://blog.tojicode.com/2011/05/interleaved-array-basics.html)
  14534. */
  14535. class InterleavedBuffer {
  14536. /**
  14537. * Constructs a new interleaved buffer.
  14538. *
  14539. * @param {TypedArray} array - A typed array with a shared buffer storing attribute data.
  14540. * @param {number} stride - The number of typed-array elements per vertex.
  14541. */
  14542. constructor( array, stride ) {
  14543. /**
  14544. * This flag can be used for type testing.
  14545. *
  14546. * @type {boolean}
  14547. * @readonly
  14548. * @default true
  14549. */
  14550. this.isInterleavedBuffer = true;
  14551. /**
  14552. * A typed array with a shared buffer storing attribute data.
  14553. *
  14554. * @type {TypedArray}
  14555. */
  14556. this.array = array;
  14557. /**
  14558. * The number of typed-array elements per vertex.
  14559. *
  14560. * @type {number}
  14561. */
  14562. this.stride = stride;
  14563. /**
  14564. * The total number of elements in the array
  14565. *
  14566. * @type {number}
  14567. * @readonly
  14568. */
  14569. this.count = array !== undefined ? array.length / stride : 0;
  14570. /**
  14571. * Defines the intended usage pattern of the data store for optimization purposes.
  14572. *
  14573. * Note: After the initial use of a buffer, its usage cannot be changed. Instead,
  14574. * instantiate a new one and set the desired usage before the next render.
  14575. *
  14576. * @type {(StaticDrawUsage|DynamicDrawUsage|StreamDrawUsage|StaticReadUsage|DynamicReadUsage|StreamReadUsage|StaticCopyUsage|DynamicCopyUsage|StreamCopyUsage)}
  14577. * @default StaticDrawUsage
  14578. */
  14579. this.usage = StaticDrawUsage;
  14580. /**
  14581. * This can be used to only update some components of stored vectors (for example, just the
  14582. * component related to color). Use the `addUpdateRange()` function to add ranges to this array.
  14583. *
  14584. * @type {Array<Object>}
  14585. */
  14586. this.updateRanges = [];
  14587. /**
  14588. * A version number, incremented every time the `needsUpdate` is set to `true`.
  14589. *
  14590. * @type {number}
  14591. */
  14592. this.version = 0;
  14593. /**
  14594. * The UUID of the interleaved buffer.
  14595. *
  14596. * @type {string}
  14597. * @readonly
  14598. */
  14599. this.uuid = generateUUID();
  14600. }
  14601. /**
  14602. * A callback function that is executed after the renderer has transferred the attribute array
  14603. * data to the GPU.
  14604. */
  14605. onUploadCallback() {}
  14606. /**
  14607. * Flag to indicate that this attribute has changed and should be re-sent to
  14608. * the GPU. Set this to `true` when you modify the value of the array.
  14609. *
  14610. * @type {number}
  14611. * @default false
  14612. * @param {boolean} value
  14613. */
  14614. set needsUpdate( value ) {
  14615. if ( value === true ) this.version ++;
  14616. }
  14617. /**
  14618. * Sets the usage of this interleaved buffer.
  14619. *
  14620. * @param {(StaticDrawUsage|DynamicDrawUsage|StreamDrawUsage|StaticReadUsage|DynamicReadUsage|StreamReadUsage|StaticCopyUsage|DynamicCopyUsage|StreamCopyUsage)} value - The usage to set.
  14621. * @return {InterleavedBuffer} A reference to this interleaved buffer.
  14622. */
  14623. setUsage( value ) {
  14624. this.usage = value;
  14625. return this;
  14626. }
  14627. /**
  14628. * Adds a range of data in the data array to be updated on the GPU.
  14629. *
  14630. * @param {number} start - Position at which to start update.
  14631. * @param {number} count - The number of components to update.
  14632. */
  14633. addUpdateRange( start, count ) {
  14634. this.updateRanges.push( { start, count } );
  14635. }
  14636. /**
  14637. * Clears the update ranges.
  14638. */
  14639. clearUpdateRanges() {
  14640. this.updateRanges.length = 0;
  14641. }
  14642. /**
  14643. * Copies the values of the given interleaved buffer to this instance.
  14644. *
  14645. * @param {InterleavedBuffer} source - The interleaved buffer to copy.
  14646. * @return {InterleavedBuffer} A reference to this instance.
  14647. */
  14648. copy( source ) {
  14649. this.array = new source.array.constructor( source.array );
  14650. this.count = source.count;
  14651. this.stride = source.stride;
  14652. this.usage = source.usage;
  14653. return this;
  14654. }
  14655. /**
  14656. * Copies a vector from the given interleaved buffer to this one. The start
  14657. * and destination position in the attribute buffers are represented by the
  14658. * given indices.
  14659. *
  14660. * @param {number} index1 - The destination index into this interleaved buffer.
  14661. * @param {InterleavedBuffer} interleavedBuffer - The interleaved buffer to copy from.
  14662. * @param {number} index2 - The source index into the given interleaved buffer.
  14663. * @return {InterleavedBuffer} A reference to this instance.
  14664. */
  14665. copyAt( index1, interleavedBuffer, index2 ) {
  14666. index1 *= this.stride;
  14667. index2 *= interleavedBuffer.stride;
  14668. for ( let i = 0, l = this.stride; i < l; i ++ ) {
  14669. this.array[ index1 + i ] = interleavedBuffer.array[ index2 + i ];
  14670. }
  14671. return this;
  14672. }
  14673. /**
  14674. * Sets the given array data in the interleaved buffer.
  14675. *
  14676. * @param {(TypedArray|Array)} value - The array data to set.
  14677. * @param {number} [offset=0] - The offset in this interleaved buffer's array.
  14678. * @return {InterleavedBuffer} A reference to this instance.
  14679. */
  14680. set( value, offset = 0 ) {
  14681. this.array.set( value, offset );
  14682. return this;
  14683. }
  14684. /**
  14685. * Returns a new interleaved buffer with copied values from this instance.
  14686. *
  14687. * @param {Object} [data] - An object with shared array buffers that allows to retain shared structures.
  14688. * @return {InterleavedBuffer} A clone of this instance.
  14689. */
  14690. clone( data ) {
  14691. if ( data.arrayBuffers === undefined ) {
  14692. data.arrayBuffers = {};
  14693. }
  14694. if ( this.array.buffer._uuid === undefined ) {
  14695. this.array.buffer._uuid = generateUUID();
  14696. }
  14697. if ( data.arrayBuffers[ this.array.buffer._uuid ] === undefined ) {
  14698. data.arrayBuffers[ this.array.buffer._uuid ] = this.array.slice( 0 ).buffer;
  14699. }
  14700. const array = new this.array.constructor( data.arrayBuffers[ this.array.buffer._uuid ] );
  14701. const ib = new this.constructor( array, this.stride );
  14702. ib.setUsage( this.usage );
  14703. return ib;
  14704. }
  14705. /**
  14706. * Sets the given callback function that is executed after the Renderer has transferred
  14707. * the array data to the GPU. Can be used to perform clean-up operations after
  14708. * the upload when data are not needed anymore on the CPU side.
  14709. *
  14710. * @param {Function} callback - The `onUpload()` callback.
  14711. * @return {InterleavedBuffer} A reference to this instance.
  14712. */
  14713. onUpload( callback ) {
  14714. this.onUploadCallback = callback;
  14715. return this;
  14716. }
  14717. /**
  14718. * Serializes the interleaved buffer into JSON.
  14719. *
  14720. * @param {Object} [data] - An optional value holding meta information about the serialization.
  14721. * @return {Object} A JSON object representing the serialized interleaved buffer.
  14722. */
  14723. toJSON( data ) {
  14724. if ( data.arrayBuffers === undefined ) {
  14725. data.arrayBuffers = {};
  14726. }
  14727. // generate UUID for array buffer if necessary
  14728. if ( this.array.buffer._uuid === undefined ) {
  14729. this.array.buffer._uuid = generateUUID();
  14730. }
  14731. if ( data.arrayBuffers[ this.array.buffer._uuid ] === undefined ) {
  14732. data.arrayBuffers[ this.array.buffer._uuid ] = Array.from( new Uint32Array( this.array.buffer ) );
  14733. }
  14734. //
  14735. return {
  14736. uuid: this.uuid,
  14737. buffer: this.array.buffer._uuid,
  14738. type: this.array.constructor.name,
  14739. stride: this.stride
  14740. };
  14741. }
  14742. }
  14743. const _vector$8 = /*@__PURE__*/ new Vector3();
  14744. /**
  14745. * An alternative version of a buffer attribute with interleaved data. Interleaved
  14746. * attributes share a common interleaved data storage ({@link InterleavedBuffer}) and refer with
  14747. * different offsets into the buffer.
  14748. */
  14749. class InterleavedBufferAttribute {
  14750. /**
  14751. * Constructs a new interleaved buffer attribute.
  14752. *
  14753. * @param {InterleavedBuffer} interleavedBuffer - The buffer holding the interleaved data.
  14754. * @param {number} itemSize - The item size.
  14755. * @param {number} offset - The attribute offset into the buffer.
  14756. * @param {boolean} [normalized=false] - Whether the data are normalized or not.
  14757. */
  14758. constructor( interleavedBuffer, itemSize, offset, normalized = false ) {
  14759. /**
  14760. * This flag can be used for type testing.
  14761. *
  14762. * @type {boolean}
  14763. * @readonly
  14764. * @default true
  14765. */
  14766. this.isInterleavedBufferAttribute = true;
  14767. /**
  14768. * The name of the buffer attribute.
  14769. *
  14770. * @type {string}
  14771. */
  14772. this.name = '';
  14773. /**
  14774. * The buffer holding the interleaved data.
  14775. *
  14776. * @type {InterleavedBuffer}
  14777. */
  14778. this.data = interleavedBuffer;
  14779. /**
  14780. * The item size, see {@link BufferAttribute#itemSize}.
  14781. *
  14782. * @type {number}
  14783. */
  14784. this.itemSize = itemSize;
  14785. /**
  14786. * The attribute offset into the buffer.
  14787. *
  14788. * @type {number}
  14789. */
  14790. this.offset = offset;
  14791. /**
  14792. * Whether the data are normalized or not, see {@link BufferAttribute#normalized}
  14793. *
  14794. * @type {InterleavedBuffer}
  14795. */
  14796. this.normalized = normalized;
  14797. }
  14798. /**
  14799. * The item count of this buffer attribute.
  14800. *
  14801. * @type {number}
  14802. * @readonly
  14803. */
  14804. get count() {
  14805. return this.data.count;
  14806. }
  14807. /**
  14808. * The array holding the interleaved buffer attribute data.
  14809. *
  14810. * @type {TypedArray}
  14811. */
  14812. get array() {
  14813. return this.data.array;
  14814. }
  14815. /**
  14816. * Flag to indicate that this attribute has changed and should be re-sent to
  14817. * the GPU. Set this to `true` when you modify the value of the array.
  14818. *
  14819. * @type {number}
  14820. * @default false
  14821. * @param {boolean} value
  14822. */
  14823. set needsUpdate( value ) {
  14824. this.data.needsUpdate = value;
  14825. }
  14826. /**
  14827. * Applies the given 4x4 matrix to the given attribute. Only works with
  14828. * item size `3`.
  14829. *
  14830. * @param {Matrix4} m - The matrix to apply.
  14831. * @return {InterleavedBufferAttribute} A reference to this instance.
  14832. */
  14833. applyMatrix4( m ) {
  14834. for ( let i = 0, l = this.data.count; i < l; i ++ ) {
  14835. _vector$8.fromBufferAttribute( this, i );
  14836. _vector$8.applyMatrix4( m );
  14837. this.setXYZ( i, _vector$8.x, _vector$8.y, _vector$8.z );
  14838. }
  14839. return this;
  14840. }
  14841. /**
  14842. * Applies the given 3x3 normal matrix to the given attribute. Only works with
  14843. * item size `3`.
  14844. *
  14845. * @param {Matrix3} m - The normal matrix to apply.
  14846. * @return {InterleavedBufferAttribute} A reference to this instance.
  14847. */
  14848. applyNormalMatrix( m ) {
  14849. for ( let i = 0, l = this.count; i < l; i ++ ) {
  14850. _vector$8.fromBufferAttribute( this, i );
  14851. _vector$8.applyNormalMatrix( m );
  14852. this.setXYZ( i, _vector$8.x, _vector$8.y, _vector$8.z );
  14853. }
  14854. return this;
  14855. }
  14856. /**
  14857. * Applies the given 4x4 matrix to the given attribute. Only works with
  14858. * item size `3` and with direction vectors.
  14859. *
  14860. * @param {Matrix4} m - The matrix to apply.
  14861. * @return {InterleavedBufferAttribute} A reference to this instance.
  14862. */
  14863. transformDirection( m ) {
  14864. for ( let i = 0, l = this.count; i < l; i ++ ) {
  14865. _vector$8.fromBufferAttribute( this, i );
  14866. _vector$8.transformDirection( m );
  14867. this.setXYZ( i, _vector$8.x, _vector$8.y, _vector$8.z );
  14868. }
  14869. return this;
  14870. }
  14871. /**
  14872. * Returns the given component of the vector at the given index.
  14873. *
  14874. * @param {number} index - The index into the buffer attribute.
  14875. * @param {number} component - The component index.
  14876. * @return {number} The returned value.
  14877. */
  14878. getComponent( index, component ) {
  14879. let value = this.array[ index * this.data.stride + this.offset + component ];
  14880. if ( this.normalized ) value = denormalize( value, this.array );
  14881. return value;
  14882. }
  14883. /**
  14884. * Sets the given value to the given component of the vector at the given index.
  14885. *
  14886. * @param {number} index - The index into the buffer attribute.
  14887. * @param {number} component - The component index.
  14888. * @param {number} value - The value to set.
  14889. * @return {InterleavedBufferAttribute} A reference to this instance.
  14890. */
  14891. setComponent( index, component, value ) {
  14892. if ( this.normalized ) value = normalize( value, this.array );
  14893. this.data.array[ index * this.data.stride + this.offset + component ] = value;
  14894. return this;
  14895. }
  14896. /**
  14897. * Sets the x component of the vector at the given index.
  14898. *
  14899. * @param {number} index - The index into the buffer attribute.
  14900. * @param {number} x - The value to set.
  14901. * @return {InterleavedBufferAttribute} A reference to this instance.
  14902. */
  14903. setX( index, x ) {
  14904. if ( this.normalized ) x = normalize( x, this.array );
  14905. this.data.array[ index * this.data.stride + this.offset ] = x;
  14906. return this;
  14907. }
  14908. /**
  14909. * Sets the y component of the vector at the given index.
  14910. *
  14911. * @param {number} index - The index into the buffer attribute.
  14912. * @param {number} y - The value to set.
  14913. * @return {InterleavedBufferAttribute} A reference to this instance.
  14914. */
  14915. setY( index, y ) {
  14916. if ( this.normalized ) y = normalize( y, this.array );
  14917. this.data.array[ index * this.data.stride + this.offset + 1 ] = y;
  14918. return this;
  14919. }
  14920. /**
  14921. * Sets the z component of the vector at the given index.
  14922. *
  14923. * @param {number} index - The index into the buffer attribute.
  14924. * @param {number} z - The value to set.
  14925. * @return {InterleavedBufferAttribute} A reference to this instance.
  14926. */
  14927. setZ( index, z ) {
  14928. if ( this.normalized ) z = normalize( z, this.array );
  14929. this.data.array[ index * this.data.stride + this.offset + 2 ] = z;
  14930. return this;
  14931. }
  14932. /**
  14933. * Sets the w component of the vector at the given index.
  14934. *
  14935. * @param {number} index - The index into the buffer attribute.
  14936. * @param {number} w - The value to set.
  14937. * @return {InterleavedBufferAttribute} A reference to this instance.
  14938. */
  14939. setW( index, w ) {
  14940. if ( this.normalized ) w = normalize( w, this.array );
  14941. this.data.array[ index * this.data.stride + this.offset + 3 ] = w;
  14942. return this;
  14943. }
  14944. /**
  14945. * Returns the x component of the vector at the given index.
  14946. *
  14947. * @param {number} index - The index into the buffer attribute.
  14948. * @return {number} The x component.
  14949. */
  14950. getX( index ) {
  14951. let x = this.data.array[ index * this.data.stride + this.offset ];
  14952. if ( this.normalized ) x = denormalize( x, this.array );
  14953. return x;
  14954. }
  14955. /**
  14956. * Returns the y component of the vector at the given index.
  14957. *
  14958. * @param {number} index - The index into the buffer attribute.
  14959. * @return {number} The y component.
  14960. */
  14961. getY( index ) {
  14962. let y = this.data.array[ index * this.data.stride + this.offset + 1 ];
  14963. if ( this.normalized ) y = denormalize( y, this.array );
  14964. return y;
  14965. }
  14966. /**
  14967. * Returns the z component of the vector at the given index.
  14968. *
  14969. * @param {number} index - The index into the buffer attribute.
  14970. * @return {number} The z component.
  14971. */
  14972. getZ( index ) {
  14973. let z = this.data.array[ index * this.data.stride + this.offset + 2 ];
  14974. if ( this.normalized ) z = denormalize( z, this.array );
  14975. return z;
  14976. }
  14977. /**
  14978. * Returns the w component of the vector at the given index.
  14979. *
  14980. * @param {number} index - The index into the buffer attribute.
  14981. * @return {number} The w component.
  14982. */
  14983. getW( index ) {
  14984. let w = this.data.array[ index * this.data.stride + this.offset + 3 ];
  14985. if ( this.normalized ) w = denormalize( w, this.array );
  14986. return w;
  14987. }
  14988. /**
  14989. * Sets the x and y component of the vector at the given index.
  14990. *
  14991. * @param {number} index - The index into the buffer attribute.
  14992. * @param {number} x - The value for the x component to set.
  14993. * @param {number} y - The value for the y component to set.
  14994. * @return {InterleavedBufferAttribute} A reference to this instance.
  14995. */
  14996. setXY( index, x, y ) {
  14997. index = index * this.data.stride + this.offset;
  14998. if ( this.normalized ) {
  14999. x = normalize( x, this.array );
  15000. y = normalize( y, this.array );
  15001. }
  15002. this.data.array[ index + 0 ] = x;
  15003. this.data.array[ index + 1 ] = y;
  15004. return this;
  15005. }
  15006. /**
  15007. * Sets the x, y and z component of the vector at the given index.
  15008. *
  15009. * @param {number} index - The index into the buffer attribute.
  15010. * @param {number} x - The value for the x component to set.
  15011. * @param {number} y - The value for the y component to set.
  15012. * @param {number} z - The value for the z component to set.
  15013. * @return {InterleavedBufferAttribute} A reference to this instance.
  15014. */
  15015. setXYZ( index, x, y, z ) {
  15016. index = index * this.data.stride + this.offset;
  15017. if ( this.normalized ) {
  15018. x = normalize( x, this.array );
  15019. y = normalize( y, this.array );
  15020. z = normalize( z, this.array );
  15021. }
  15022. this.data.array[ index + 0 ] = x;
  15023. this.data.array[ index + 1 ] = y;
  15024. this.data.array[ index + 2 ] = z;
  15025. return this;
  15026. }
  15027. /**
  15028. * Sets the x, y, z and w component of the vector at the given index.
  15029. *
  15030. * @param {number} index - The index into the buffer attribute.
  15031. * @param {number} x - The value for the x component to set.
  15032. * @param {number} y - The value for the y component to set.
  15033. * @param {number} z - The value for the z component to set.
  15034. * @param {number} w - The value for the w component to set.
  15035. * @return {InterleavedBufferAttribute} A reference to this instance.
  15036. */
  15037. setXYZW( index, x, y, z, w ) {
  15038. index = index * this.data.stride + this.offset;
  15039. if ( this.normalized ) {
  15040. x = normalize( x, this.array );
  15041. y = normalize( y, this.array );
  15042. z = normalize( z, this.array );
  15043. w = normalize( w, this.array );
  15044. }
  15045. this.data.array[ index + 0 ] = x;
  15046. this.data.array[ index + 1 ] = y;
  15047. this.data.array[ index + 2 ] = z;
  15048. this.data.array[ index + 3 ] = w;
  15049. return this;
  15050. }
  15051. /**
  15052. * Returns a new buffer attribute with copied values from this instance.
  15053. *
  15054. * If no parameter is provided, cloning an interleaved buffer attribute will de-interleave buffer data.
  15055. *
  15056. * @param {Object} [data] - An object with interleaved buffers that allows to retain the interleaved property.
  15057. * @return {BufferAttribute|InterleavedBufferAttribute} A clone of this instance.
  15058. */
  15059. clone( data ) {
  15060. if ( data === undefined ) {
  15061. log( 'InterleavedBufferAttribute.clone(): Cloning an interleaved buffer attribute will de-interleave buffer data.' );
  15062. const array = [];
  15063. for ( let i = 0; i < this.count; i ++ ) {
  15064. const index = i * this.data.stride + this.offset;
  15065. for ( let j = 0; j < this.itemSize; j ++ ) {
  15066. array.push( this.data.array[ index + j ] );
  15067. }
  15068. }
  15069. return new BufferAttribute( new this.array.constructor( array ), this.itemSize, this.normalized );
  15070. } else {
  15071. if ( data.interleavedBuffers === undefined ) {
  15072. data.interleavedBuffers = {};
  15073. }
  15074. if ( data.interleavedBuffers[ this.data.uuid ] === undefined ) {
  15075. data.interleavedBuffers[ this.data.uuid ] = this.data.clone( data );
  15076. }
  15077. return new InterleavedBufferAttribute( data.interleavedBuffers[ this.data.uuid ], this.itemSize, this.offset, this.normalized );
  15078. }
  15079. }
  15080. /**
  15081. * Serializes the buffer attribute into JSON.
  15082. *
  15083. * If no parameter is provided, cloning an interleaved buffer attribute will de-interleave buffer data.
  15084. *
  15085. * @param {Object} [data] - An optional value holding meta information about the serialization.
  15086. * @return {Object} A JSON object representing the serialized buffer attribute.
  15087. */
  15088. toJSON( data ) {
  15089. if ( data === undefined ) {
  15090. log( 'InterleavedBufferAttribute.toJSON(): Serializing an interleaved buffer attribute will de-interleave buffer data.' );
  15091. const array = [];
  15092. for ( let i = 0; i < this.count; i ++ ) {
  15093. const index = i * this.data.stride + this.offset;
  15094. for ( let j = 0; j < this.itemSize; j ++ ) {
  15095. array.push( this.data.array[ index + j ] );
  15096. }
  15097. }
  15098. // de-interleave data and save it as an ordinary buffer attribute for now
  15099. return {
  15100. itemSize: this.itemSize,
  15101. type: this.array.constructor.name,
  15102. array: array,
  15103. normalized: this.normalized
  15104. };
  15105. } else {
  15106. // save as true interleaved attribute
  15107. if ( data.interleavedBuffers === undefined ) {
  15108. data.interleavedBuffers = {};
  15109. }
  15110. if ( data.interleavedBuffers[ this.data.uuid ] === undefined ) {
  15111. data.interleavedBuffers[ this.data.uuid ] = this.data.toJSON( data );
  15112. }
  15113. return {
  15114. isInterleavedBufferAttribute: true,
  15115. itemSize: this.itemSize,
  15116. data: this.data.uuid,
  15117. offset: this.offset,
  15118. normalized: this.normalized
  15119. };
  15120. }
  15121. }
  15122. }
  15123. let _materialId = 0;
  15124. /**
  15125. * Abstract base class for materials.
  15126. *
  15127. * Materials define the appearance of renderable 3D objects.
  15128. *
  15129. * @abstract
  15130. * @augments EventDispatcher
  15131. */
  15132. class Material extends EventDispatcher {
  15133. /**
  15134. * Constructs a new material.
  15135. */
  15136. constructor() {
  15137. super();
  15138. /**
  15139. * This flag can be used for type testing.
  15140. *
  15141. * @type {boolean}
  15142. * @readonly
  15143. * @default true
  15144. */
  15145. this.isMaterial = true;
  15146. /**
  15147. * The ID of the material.
  15148. *
  15149. * @name Material#id
  15150. * @type {number}
  15151. * @readonly
  15152. */
  15153. Object.defineProperty( this, 'id', { value: _materialId ++ } );
  15154. /**
  15155. * The UUID of the material.
  15156. *
  15157. * @type {string}
  15158. * @readonly
  15159. */
  15160. this.uuid = generateUUID();
  15161. /**
  15162. * The name of the material.
  15163. *
  15164. * @type {string}
  15165. */
  15166. this.name = '';
  15167. /**
  15168. * The type property is used for detecting the object type
  15169. * in context of serialization/deserialization.
  15170. *
  15171. * @type {string}
  15172. * @readonly
  15173. */
  15174. this.type = 'Material';
  15175. /**
  15176. * Defines the blending type of the material.
  15177. *
  15178. * It must be set to `CustomBlending` if custom blending properties like
  15179. * {@link Material#blendSrc}, {@link Material#blendDst} or {@link Material#blendEquation}
  15180. * should have any effect.
  15181. *
  15182. * @type {(NoBlending|NormalBlending|AdditiveBlending|SubtractiveBlending|MultiplyBlending|CustomBlending)}
  15183. * @default NormalBlending
  15184. */
  15185. this.blending = NormalBlending;
  15186. /**
  15187. * Defines which side of faces will be rendered - front, back or both.
  15188. *
  15189. * @type {(FrontSide|BackSide|DoubleSide)}
  15190. * @default FrontSide
  15191. */
  15192. this.side = FrontSide;
  15193. /**
  15194. * If set to `true`, vertex colors should be used.
  15195. *
  15196. * The engine supports RGB and RGBA vertex colors depending on whether a three (RGB) or
  15197. * four (RGBA) component color buffer attribute is used.
  15198. *
  15199. * @type {boolean}
  15200. * @default false
  15201. */
  15202. this.vertexColors = false;
  15203. /**
  15204. * Defines how transparent the material is.
  15205. * A value of `0.0` indicates fully transparent, `1.0` is fully opaque.
  15206. *
  15207. * If the {@link Material#transparent} is not set to `true`,
  15208. * the material will remain fully opaque and this value will only affect its color.
  15209. *
  15210. * @type {number}
  15211. * @default 1
  15212. */
  15213. this.opacity = 1;
  15214. /**
  15215. * Defines whether this material is transparent. This has an effect on
  15216. * rendering as transparent objects need special treatment and are rendered
  15217. * after non-transparent objects.
  15218. *
  15219. * When set to true, the extent to which the material is transparent is
  15220. * controlled by {@link Material#opacity}.
  15221. *
  15222. * @type {boolean}
  15223. * @default false
  15224. */
  15225. this.transparent = false;
  15226. /**
  15227. * Enables alpha hashed transparency, an alternative to {@link Material#transparent} or
  15228. * {@link Material#alphaTest}. The material will not be rendered if opacity is lower than
  15229. * a random threshold. Randomization introduces some grain or noise, but approximates alpha
  15230. * blending without the associated problems of sorting. Using TAA can reduce the resulting noise.
  15231. *
  15232. * @type {boolean}
  15233. * @default false
  15234. */
  15235. this.alphaHash = false;
  15236. /**
  15237. * Defines the blending source factor.
  15238. *
  15239. * @type {(ZeroFactor|OneFactor|SrcColorFactor|OneMinusSrcColorFactor|SrcAlphaFactor|OneMinusSrcAlphaFactor|DstAlphaFactor|OneMinusDstAlphaFactor|DstColorFactor|OneMinusDstColorFactor|SrcAlphaSaturateFactor|ConstantColorFactor|OneMinusConstantColorFactor|ConstantAlphaFactor|OneMinusConstantAlphaFactor)}
  15240. * @default SrcAlphaFactor
  15241. */
  15242. this.blendSrc = SrcAlphaFactor;
  15243. /**
  15244. * Defines the blending destination factor.
  15245. *
  15246. * @type {(ZeroFactor|OneFactor|SrcColorFactor|OneMinusSrcColorFactor|SrcAlphaFactor|OneMinusSrcAlphaFactor|DstAlphaFactor|OneMinusDstAlphaFactor|DstColorFactor|OneMinusDstColorFactor|SrcAlphaSaturateFactor|ConstantColorFactor|OneMinusConstantColorFactor|ConstantAlphaFactor|OneMinusConstantAlphaFactor)}
  15247. * @default OneMinusSrcAlphaFactor
  15248. */
  15249. this.blendDst = OneMinusSrcAlphaFactor;
  15250. /**
  15251. * Defines the blending equation.
  15252. *
  15253. * @type {(AddEquation|SubtractEquation|ReverseSubtractEquation|MinEquation|MaxEquation)}
  15254. * @default AddEquation
  15255. */
  15256. this.blendEquation = AddEquation;
  15257. /**
  15258. * Defines the blending source alpha factor.
  15259. *
  15260. * @type {?(ZeroFactor|OneFactor|SrcColorFactor|OneMinusSrcColorFactor|SrcAlphaFactor|OneMinusSrcAlphaFactor|DstAlphaFactor|OneMinusDstAlphaFactor|DstColorFactor|OneMinusDstColorFactor|SrcAlphaSaturateFactor|ConstantColorFactor|OneMinusConstantColorFactor|ConstantAlphaFactor|OneMinusConstantAlphaFactor)}
  15261. * @default null
  15262. */
  15263. this.blendSrcAlpha = null;
  15264. /**
  15265. * Defines the blending destination alpha factor.
  15266. *
  15267. * @type {?(ZeroFactor|OneFactor|SrcColorFactor|OneMinusSrcColorFactor|SrcAlphaFactor|OneMinusSrcAlphaFactor|DstAlphaFactor|OneMinusDstAlphaFactor|DstColorFactor|OneMinusDstColorFactor|SrcAlphaSaturateFactor|ConstantColorFactor|OneMinusConstantColorFactor|ConstantAlphaFactor|OneMinusConstantAlphaFactor)}
  15268. * @default null
  15269. */
  15270. this.blendDstAlpha = null;
  15271. /**
  15272. * Defines the blending equation of the alpha channel.
  15273. *
  15274. * @type {?(AddEquation|SubtractEquation|ReverseSubtractEquation|MinEquation|MaxEquation)}
  15275. * @default null
  15276. */
  15277. this.blendEquationAlpha = null;
  15278. /**
  15279. * Represents the RGB values of the constant blend color.
  15280. *
  15281. * This property has only an effect when using custom blending with `ConstantColor` or `OneMinusConstantColor`.
  15282. *
  15283. * @type {Color}
  15284. * @default (0,0,0)
  15285. */
  15286. this.blendColor = new Color( 0, 0, 0 );
  15287. /**
  15288. * Represents the alpha value of the constant blend color.
  15289. *
  15290. * This property has only an effect when using custom blending with `ConstantAlpha` or `OneMinusConstantAlpha`.
  15291. *
  15292. * @type {number}
  15293. * @default 0
  15294. */
  15295. this.blendAlpha = 0;
  15296. /**
  15297. * Defines the depth function.
  15298. *
  15299. * @type {(NeverDepth|AlwaysDepth|LessDepth|LessEqualDepth|EqualDepth|GreaterEqualDepth|GreaterDepth|NotEqualDepth)}
  15300. * @default LessEqualDepth
  15301. */
  15302. this.depthFunc = LessEqualDepth;
  15303. /**
  15304. * Whether to have depth test enabled when rendering this material.
  15305. * When the depth test is disabled, the depth write will also be implicitly disabled.
  15306. *
  15307. * @type {boolean}
  15308. * @default true
  15309. */
  15310. this.depthTest = true;
  15311. /**
  15312. * Whether rendering this material has any effect on the depth buffer.
  15313. *
  15314. * When drawing 2D overlays it can be useful to disable the depth writing in
  15315. * order to layer several things together without creating z-index artifacts.
  15316. *
  15317. * @type {boolean}
  15318. * @default true
  15319. */
  15320. this.depthWrite = true;
  15321. /**
  15322. * The bit mask to use when writing to the stencil buffer.
  15323. *
  15324. * @type {number}
  15325. * @default 0xff
  15326. */
  15327. this.stencilWriteMask = 0xff;
  15328. /**
  15329. * The stencil comparison function to use.
  15330. *
  15331. * @type {NeverStencilFunc|LessStencilFunc|EqualStencilFunc|LessEqualStencilFunc|GreaterStencilFunc|NotEqualStencilFunc|GreaterEqualStencilFunc|AlwaysStencilFunc}
  15332. * @default AlwaysStencilFunc
  15333. */
  15334. this.stencilFunc = AlwaysStencilFunc;
  15335. /**
  15336. * The value to use when performing stencil comparisons or stencil operations.
  15337. *
  15338. * @type {number}
  15339. * @default 0
  15340. */
  15341. this.stencilRef = 0;
  15342. /**
  15343. * The bit mask to use when comparing against the stencil buffer.
  15344. *
  15345. * @type {number}
  15346. * @default 0xff
  15347. */
  15348. this.stencilFuncMask = 0xff;
  15349. /**
  15350. * Which stencil operation to perform when the comparison function returns `false`.
  15351. *
  15352. * @type {ZeroStencilOp|KeepStencilOp|ReplaceStencilOp|IncrementStencilOp|DecrementStencilOp|IncrementWrapStencilOp|DecrementWrapStencilOp|InvertStencilOp}
  15353. * @default KeepStencilOp
  15354. */
  15355. this.stencilFail = KeepStencilOp;
  15356. /**
  15357. * Which stencil operation to perform when the comparison function returns
  15358. * `true` but the depth test fails.
  15359. *
  15360. * @type {ZeroStencilOp|KeepStencilOp|ReplaceStencilOp|IncrementStencilOp|DecrementStencilOp|IncrementWrapStencilOp|DecrementWrapStencilOp|InvertStencilOp}
  15361. * @default KeepStencilOp
  15362. */
  15363. this.stencilZFail = KeepStencilOp;
  15364. /**
  15365. * Which stencil operation to perform when the comparison function returns
  15366. * `true` and the depth test passes.
  15367. *
  15368. * @type {ZeroStencilOp|KeepStencilOp|ReplaceStencilOp|IncrementStencilOp|DecrementStencilOp|IncrementWrapStencilOp|DecrementWrapStencilOp|InvertStencilOp}
  15369. * @default KeepStencilOp
  15370. */
  15371. this.stencilZPass = KeepStencilOp;
  15372. /**
  15373. * Whether stencil operations are performed against the stencil buffer. In
  15374. * order to perform writes or comparisons against the stencil buffer this
  15375. * value must be `true`.
  15376. *
  15377. * @type {boolean}
  15378. * @default false
  15379. */
  15380. this.stencilWrite = false;
  15381. /**
  15382. * User-defined clipping planes specified as THREE.Plane objects in world
  15383. * space. These planes apply to the objects this material is attached to.
  15384. * Points in space whose signed distance to the plane is negative are clipped
  15385. * (not rendered). This requires {@link WebGLRenderer#localClippingEnabled} to
  15386. * be `true`.
  15387. *
  15388. * @type {?Array<Plane>}
  15389. * @default null
  15390. */
  15391. this.clippingPlanes = null;
  15392. /**
  15393. * Changes the behavior of clipping planes so that only their intersection is
  15394. * clipped, rather than their union.
  15395. *
  15396. * @type {boolean}
  15397. * @default false
  15398. */
  15399. this.clipIntersection = false;
  15400. /**
  15401. * Defines whether to clip shadows according to the clipping planes specified
  15402. * on this material.
  15403. *
  15404. * @type {boolean}
  15405. * @default false
  15406. */
  15407. this.clipShadows = false;
  15408. /**
  15409. * Defines which side of faces cast shadows. If `null`, the side casting shadows
  15410. * is determined as follows:
  15411. *
  15412. * - When {@link Material#side} is set to `FrontSide`, the back side cast shadows.
  15413. * - When {@link Material#side} is set to `BackSide`, the front side cast shadows.
  15414. * - When {@link Material#side} is set to `DoubleSide`, both sides cast shadows.
  15415. *
  15416. * @type {?(FrontSide|BackSide|DoubleSide)}
  15417. * @default null
  15418. */
  15419. this.shadowSide = null;
  15420. /**
  15421. * Whether to render the material's color.
  15422. *
  15423. * This can be used in conjunction with {@link Object3D#renderOder} to create invisible
  15424. * objects that occlude other objects.
  15425. *
  15426. * @type {boolean}
  15427. * @default true
  15428. */
  15429. this.colorWrite = true;
  15430. /**
  15431. * Override the renderer's default precision for this material.
  15432. *
  15433. * @type {?('highp'|'mediump'|'lowp')}
  15434. * @default null
  15435. */
  15436. this.precision = null;
  15437. /**
  15438. * Whether to use polygon offset or not. When enabled, each fragment's depth value will
  15439. * be offset after it is interpolated from the depth values of the appropriate vertices.
  15440. * The offset is added before the depth test is performed and before the value is written
  15441. * into the depth buffer.
  15442. *
  15443. * Can be useful for rendering hidden-line images, for applying decals to surfaces, and for
  15444. * rendering solids with highlighted edges.
  15445. *
  15446. * @type {boolean}
  15447. * @default false
  15448. */
  15449. this.polygonOffset = false;
  15450. /**
  15451. * Specifies a scale factor that is used to create a variable depth offset for each polygon.
  15452. *
  15453. * @type {number}
  15454. * @default 0
  15455. */
  15456. this.polygonOffsetFactor = 0;
  15457. /**
  15458. * Is multiplied by an implementation-specific value to create a constant depth offset.
  15459. *
  15460. * @type {number}
  15461. * @default 0
  15462. */
  15463. this.polygonOffsetUnits = 0;
  15464. /**
  15465. * Whether to apply dithering to the color to remove the appearance of banding.
  15466. *
  15467. * @type {boolean}
  15468. * @default false
  15469. */
  15470. this.dithering = false;
  15471. /**
  15472. * Whether alpha to coverage should be enabled or not. Can only be used with MSAA-enabled contexts
  15473. * (meaning when the renderer was created with *antialias* parameter set to `true`). Enabling this
  15474. * will smooth aliasing on clip plane edges and alphaTest-clipped edges.
  15475. *
  15476. * @type {boolean}
  15477. * @default false
  15478. */
  15479. this.alphaToCoverage = false;
  15480. /**
  15481. * Whether to premultiply the alpha (transparency) value.
  15482. *
  15483. * @type {boolean}
  15484. * @default false
  15485. */
  15486. this.premultipliedAlpha = false;
  15487. /**
  15488. * Whether double-sided, transparent objects should be rendered with a single pass or not.
  15489. *
  15490. * The engine renders double-sided, transparent objects with two draw calls (back faces first,
  15491. * then front faces) to mitigate transparency artifacts. There are scenarios however where this
  15492. * approach produces no quality gains but still doubles draw calls e.g. when rendering flat
  15493. * vegetation like grass sprites. In these cases, set the `forceSinglePass` flag to `true` to
  15494. * disable the two pass rendering to avoid performance issues.
  15495. *
  15496. * @type {boolean}
  15497. * @default false
  15498. */
  15499. this.forceSinglePass = false;
  15500. /**
  15501. * Whether it's possible to override the material with {@link Scene#overrideMaterial} or not.
  15502. *
  15503. * @type {boolean}
  15504. * @default true
  15505. */
  15506. this.allowOverride = true;
  15507. /**
  15508. * Defines whether 3D objects using this material are visible.
  15509. *
  15510. * @type {boolean}
  15511. * @default true
  15512. */
  15513. this.visible = true;
  15514. /**
  15515. * Defines whether this material is tone mapped according to the renderer's tone mapping setting.
  15516. *
  15517. * It is ignored when rendering to a render target or using post processing or when using
  15518. * `WebGPURenderer`. In all these cases, all materials are honored by tone mapping.
  15519. *
  15520. * @type {boolean}
  15521. * @default true
  15522. */
  15523. this.toneMapped = true;
  15524. /**
  15525. * An object that can be used to store custom data about the Material. It
  15526. * should not hold references to functions as these will not be cloned.
  15527. *
  15528. * @type {Object}
  15529. */
  15530. this.userData = {};
  15531. /**
  15532. * This starts at `0` and counts how many times {@link Material#needsUpdate} is set to `true`.
  15533. *
  15534. * @type {number}
  15535. * @readonly
  15536. * @default 0
  15537. */
  15538. this.version = 0;
  15539. this._alphaTest = 0;
  15540. }
  15541. /**
  15542. * Sets the alpha value to be used when running an alpha test. The material
  15543. * will not be rendered if the opacity is lower than this value.
  15544. *
  15545. * @type {number}
  15546. * @readonly
  15547. * @default 0
  15548. */
  15549. get alphaTest() {
  15550. return this._alphaTest;
  15551. }
  15552. set alphaTest( value ) {
  15553. if ( this._alphaTest > 0 !== value > 0 ) {
  15554. this.version ++;
  15555. }
  15556. this._alphaTest = value;
  15557. }
  15558. /**
  15559. * An optional callback that is executed immediately before the material is used to render a 3D object.
  15560. *
  15561. * This method can only be used when rendering with {@link WebGLRenderer}.
  15562. *
  15563. * @param {WebGLRenderer} renderer - The renderer.
  15564. * @param {Scene} scene - The scene.
  15565. * @param {Camera} camera - The camera that is used to render the scene.
  15566. * @param {BufferGeometry} geometry - The 3D object's geometry.
  15567. * @param {Object3D} object - The 3D object.
  15568. * @param {Object} group - The geometry group data.
  15569. */
  15570. onBeforeRender( /* renderer, scene, camera, geometry, object, group */ ) {}
  15571. /**
  15572. * An optional callback that is executed immediately before the shader
  15573. * program is compiled. This function is called with the shader source code
  15574. * as a parameter. Useful for the modification of built-in materials.
  15575. *
  15576. * This method can only be used when rendering with {@link WebGLRenderer}. The
  15577. * recommended approach when customizing materials is to use `WebGPURenderer` with the new
  15578. * Node Material system and [TSL](https://github.com/mrdoob/three.js/wiki/Three.js-Shading-Language).
  15579. *
  15580. * @param {{vertexShader:string,fragmentShader:string,uniforms:Object}} shaderobject - The object holds the uniforms and the vertex and fragment shader source.
  15581. * @param {WebGLRenderer} renderer - A reference to the renderer.
  15582. */
  15583. onBeforeCompile( /* shaderobject, renderer */ ) {}
  15584. /**
  15585. * In case {@link Material#onBeforeCompile} is used, this callback can be used to identify
  15586. * values of settings used in `onBeforeCompile()`, so three.js can reuse a cached
  15587. * shader or recompile the shader for this material as needed.
  15588. *
  15589. * This method can only be used when rendering with {@link WebGLRenderer}.
  15590. *
  15591. * @return {string} The custom program cache key.
  15592. */
  15593. customProgramCacheKey() {
  15594. return this.onBeforeCompile.toString();
  15595. }
  15596. /**
  15597. * This method can be used to set default values from parameter objects.
  15598. * It is a generic implementation so it can be used with different types
  15599. * of materials.
  15600. *
  15601. * @param {Object} [values] - The material values to set.
  15602. */
  15603. setValues( values ) {
  15604. if ( values === undefined ) return;
  15605. for ( const key in values ) {
  15606. const newValue = values[ key ];
  15607. if ( newValue === undefined ) {
  15608. warn( `Material: parameter '${ key }' has value of undefined.` );
  15609. continue;
  15610. }
  15611. const currentValue = this[ key ];
  15612. if ( currentValue === undefined ) {
  15613. warn( `Material: '${ key }' is not a property of THREE.${ this.type }.` );
  15614. continue;
  15615. }
  15616. if ( currentValue && currentValue.isColor ) {
  15617. currentValue.set( newValue );
  15618. } else if ( ( currentValue && currentValue.isVector3 ) && ( newValue && newValue.isVector3 ) ) {
  15619. currentValue.copy( newValue );
  15620. } else {
  15621. this[ key ] = newValue;
  15622. }
  15623. }
  15624. }
  15625. /**
  15626. * Serializes the material into JSON.
  15627. *
  15628. * @param {?(Object|string)} meta - An optional value holding meta information about the serialization.
  15629. * @return {Object} A JSON object representing the serialized material.
  15630. * @see {@link ObjectLoader#parse}
  15631. */
  15632. toJSON( meta ) {
  15633. const isRootObject = ( meta === undefined || typeof meta === 'string' );
  15634. if ( isRootObject ) {
  15635. meta = {
  15636. textures: {},
  15637. images: {}
  15638. };
  15639. }
  15640. const data = {
  15641. metadata: {
  15642. version: 4.7,
  15643. type: 'Material',
  15644. generator: 'Material.toJSON'
  15645. }
  15646. };
  15647. // standard Material serialization
  15648. data.uuid = this.uuid;
  15649. data.type = this.type;
  15650. if ( this.name !== '' ) data.name = this.name;
  15651. if ( this.color && this.color.isColor ) data.color = this.color.getHex();
  15652. if ( this.roughness !== undefined ) data.roughness = this.roughness;
  15653. if ( this.metalness !== undefined ) data.metalness = this.metalness;
  15654. if ( this.sheen !== undefined ) data.sheen = this.sheen;
  15655. if ( this.sheenColor && this.sheenColor.isColor ) data.sheenColor = this.sheenColor.getHex();
  15656. if ( this.sheenRoughness !== undefined ) data.sheenRoughness = this.sheenRoughness;
  15657. if ( this.emissive && this.emissive.isColor ) data.emissive = this.emissive.getHex();
  15658. if ( this.emissiveIntensity !== undefined && this.emissiveIntensity !== 1 ) data.emissiveIntensity = this.emissiveIntensity;
  15659. if ( this.specular && this.specular.isColor ) data.specular = this.specular.getHex();
  15660. if ( this.specularIntensity !== undefined ) data.specularIntensity = this.specularIntensity;
  15661. if ( this.specularColor && this.specularColor.isColor ) data.specularColor = this.specularColor.getHex();
  15662. if ( this.shininess !== undefined ) data.shininess = this.shininess;
  15663. if ( this.clearcoat !== undefined ) data.clearcoat = this.clearcoat;
  15664. if ( this.clearcoatRoughness !== undefined ) data.clearcoatRoughness = this.clearcoatRoughness;
  15665. if ( this.clearcoatMap && this.clearcoatMap.isTexture ) {
  15666. data.clearcoatMap = this.clearcoatMap.toJSON( meta ).uuid;
  15667. }
  15668. if ( this.clearcoatRoughnessMap && this.clearcoatRoughnessMap.isTexture ) {
  15669. data.clearcoatRoughnessMap = this.clearcoatRoughnessMap.toJSON( meta ).uuid;
  15670. }
  15671. if ( this.clearcoatNormalMap && this.clearcoatNormalMap.isTexture ) {
  15672. data.clearcoatNormalMap = this.clearcoatNormalMap.toJSON( meta ).uuid;
  15673. data.clearcoatNormalScale = this.clearcoatNormalScale.toArray();
  15674. }
  15675. if ( this.sheenColorMap && this.sheenColorMap.isTexture ) {
  15676. data.sheenColorMap = this.sheenColorMap.toJSON( meta ).uuid;
  15677. }
  15678. if ( this.sheenRoughnessMap && this.sheenRoughnessMap.isTexture ) {
  15679. data.sheenRoughnessMap = this.sheenRoughnessMap.toJSON( meta ).uuid;
  15680. }
  15681. if ( this.dispersion !== undefined ) data.dispersion = this.dispersion;
  15682. if ( this.iridescence !== undefined ) data.iridescence = this.iridescence;
  15683. if ( this.iridescenceIOR !== undefined ) data.iridescenceIOR = this.iridescenceIOR;
  15684. if ( this.iridescenceThicknessRange !== undefined ) data.iridescenceThicknessRange = this.iridescenceThicknessRange;
  15685. if ( this.iridescenceMap && this.iridescenceMap.isTexture ) {
  15686. data.iridescenceMap = this.iridescenceMap.toJSON( meta ).uuid;
  15687. }
  15688. if ( this.iridescenceThicknessMap && this.iridescenceThicknessMap.isTexture ) {
  15689. data.iridescenceThicknessMap = this.iridescenceThicknessMap.toJSON( meta ).uuid;
  15690. }
  15691. if ( this.anisotropy !== undefined ) data.anisotropy = this.anisotropy;
  15692. if ( this.anisotropyRotation !== undefined ) data.anisotropyRotation = this.anisotropyRotation;
  15693. if ( this.anisotropyMap && this.anisotropyMap.isTexture ) {
  15694. data.anisotropyMap = this.anisotropyMap.toJSON( meta ).uuid;
  15695. }
  15696. if ( this.map && this.map.isTexture ) data.map = this.map.toJSON( meta ).uuid;
  15697. if ( this.matcap && this.matcap.isTexture ) data.matcap = this.matcap.toJSON( meta ).uuid;
  15698. if ( this.alphaMap && this.alphaMap.isTexture ) data.alphaMap = this.alphaMap.toJSON( meta ).uuid;
  15699. if ( this.lightMap && this.lightMap.isTexture ) {
  15700. data.lightMap = this.lightMap.toJSON( meta ).uuid;
  15701. data.lightMapIntensity = this.lightMapIntensity;
  15702. }
  15703. if ( this.aoMap && this.aoMap.isTexture ) {
  15704. data.aoMap = this.aoMap.toJSON( meta ).uuid;
  15705. data.aoMapIntensity = this.aoMapIntensity;
  15706. }
  15707. if ( this.bumpMap && this.bumpMap.isTexture ) {
  15708. data.bumpMap = this.bumpMap.toJSON( meta ).uuid;
  15709. data.bumpScale = this.bumpScale;
  15710. }
  15711. if ( this.normalMap && this.normalMap.isTexture ) {
  15712. data.normalMap = this.normalMap.toJSON( meta ).uuid;
  15713. data.normalMapType = this.normalMapType;
  15714. data.normalScale = this.normalScale.toArray();
  15715. }
  15716. if ( this.displacementMap && this.displacementMap.isTexture ) {
  15717. data.displacementMap = this.displacementMap.toJSON( meta ).uuid;
  15718. data.displacementScale = this.displacementScale;
  15719. data.displacementBias = this.displacementBias;
  15720. }
  15721. if ( this.roughnessMap && this.roughnessMap.isTexture ) data.roughnessMap = this.roughnessMap.toJSON( meta ).uuid;
  15722. if ( this.metalnessMap && this.metalnessMap.isTexture ) data.metalnessMap = this.metalnessMap.toJSON( meta ).uuid;
  15723. if ( this.emissiveMap && this.emissiveMap.isTexture ) data.emissiveMap = this.emissiveMap.toJSON( meta ).uuid;
  15724. if ( this.specularMap && this.specularMap.isTexture ) data.specularMap = this.specularMap.toJSON( meta ).uuid;
  15725. if ( this.specularIntensityMap && this.specularIntensityMap.isTexture ) data.specularIntensityMap = this.specularIntensityMap.toJSON( meta ).uuid;
  15726. if ( this.specularColorMap && this.specularColorMap.isTexture ) data.specularColorMap = this.specularColorMap.toJSON( meta ).uuid;
  15727. if ( this.envMap && this.envMap.isTexture ) {
  15728. data.envMap = this.envMap.toJSON( meta ).uuid;
  15729. if ( this.combine !== undefined ) data.combine = this.combine;
  15730. }
  15731. if ( this.envMapRotation !== undefined ) data.envMapRotation = this.envMapRotation.toArray();
  15732. if ( this.envMapIntensity !== undefined ) data.envMapIntensity = this.envMapIntensity;
  15733. if ( this.reflectivity !== undefined ) data.reflectivity = this.reflectivity;
  15734. if ( this.refractionRatio !== undefined ) data.refractionRatio = this.refractionRatio;
  15735. if ( this.gradientMap && this.gradientMap.isTexture ) {
  15736. data.gradientMap = this.gradientMap.toJSON( meta ).uuid;
  15737. }
  15738. if ( this.transmission !== undefined ) data.transmission = this.transmission;
  15739. if ( this.transmissionMap && this.transmissionMap.isTexture ) data.transmissionMap = this.transmissionMap.toJSON( meta ).uuid;
  15740. if ( this.thickness !== undefined ) data.thickness = this.thickness;
  15741. if ( this.thicknessMap && this.thicknessMap.isTexture ) data.thicknessMap = this.thicknessMap.toJSON( meta ).uuid;
  15742. if ( this.attenuationDistance !== undefined && this.attenuationDistance !== Infinity ) data.attenuationDistance = this.attenuationDistance;
  15743. if ( this.attenuationColor !== undefined ) data.attenuationColor = this.attenuationColor.getHex();
  15744. if ( this.size !== undefined ) data.size = this.size;
  15745. if ( this.shadowSide !== null ) data.shadowSide = this.shadowSide;
  15746. if ( this.sizeAttenuation !== undefined ) data.sizeAttenuation = this.sizeAttenuation;
  15747. if ( this.blending !== NormalBlending ) data.blending = this.blending;
  15748. if ( this.side !== FrontSide ) data.side = this.side;
  15749. if ( this.vertexColors === true ) data.vertexColors = true;
  15750. if ( this.opacity < 1 ) data.opacity = this.opacity;
  15751. if ( this.transparent === true ) data.transparent = true;
  15752. if ( this.blendSrc !== SrcAlphaFactor ) data.blendSrc = this.blendSrc;
  15753. if ( this.blendDst !== OneMinusSrcAlphaFactor ) data.blendDst = this.blendDst;
  15754. if ( this.blendEquation !== AddEquation ) data.blendEquation = this.blendEquation;
  15755. if ( this.blendSrcAlpha !== null ) data.blendSrcAlpha = this.blendSrcAlpha;
  15756. if ( this.blendDstAlpha !== null ) data.blendDstAlpha = this.blendDstAlpha;
  15757. if ( this.blendEquationAlpha !== null ) data.blendEquationAlpha = this.blendEquationAlpha;
  15758. if ( this.blendColor && this.blendColor.isColor ) data.blendColor = this.blendColor.getHex();
  15759. if ( this.blendAlpha !== 0 ) data.blendAlpha = this.blendAlpha;
  15760. if ( this.depthFunc !== LessEqualDepth ) data.depthFunc = this.depthFunc;
  15761. if ( this.depthTest === false ) data.depthTest = this.depthTest;
  15762. if ( this.depthWrite === false ) data.depthWrite = this.depthWrite;
  15763. if ( this.colorWrite === false ) data.colorWrite = this.colorWrite;
  15764. if ( this.stencilWriteMask !== 0xff ) data.stencilWriteMask = this.stencilWriteMask;
  15765. if ( this.stencilFunc !== AlwaysStencilFunc ) data.stencilFunc = this.stencilFunc;
  15766. if ( this.stencilRef !== 0 ) data.stencilRef = this.stencilRef;
  15767. if ( this.stencilFuncMask !== 0xff ) data.stencilFuncMask = this.stencilFuncMask;
  15768. if ( this.stencilFail !== KeepStencilOp ) data.stencilFail = this.stencilFail;
  15769. if ( this.stencilZFail !== KeepStencilOp ) data.stencilZFail = this.stencilZFail;
  15770. if ( this.stencilZPass !== KeepStencilOp ) data.stencilZPass = this.stencilZPass;
  15771. if ( this.stencilWrite === true ) data.stencilWrite = this.stencilWrite;
  15772. // rotation (SpriteMaterial)
  15773. if ( this.rotation !== undefined && this.rotation !== 0 ) data.rotation = this.rotation;
  15774. if ( this.polygonOffset === true ) data.polygonOffset = true;
  15775. if ( this.polygonOffsetFactor !== 0 ) data.polygonOffsetFactor = this.polygonOffsetFactor;
  15776. if ( this.polygonOffsetUnits !== 0 ) data.polygonOffsetUnits = this.polygonOffsetUnits;
  15777. if ( this.linewidth !== undefined && this.linewidth !== 1 ) data.linewidth = this.linewidth;
  15778. if ( this.dashSize !== undefined ) data.dashSize = this.dashSize;
  15779. if ( this.gapSize !== undefined ) data.gapSize = this.gapSize;
  15780. if ( this.scale !== undefined ) data.scale = this.scale;
  15781. if ( this.dithering === true ) data.dithering = true;
  15782. if ( this.alphaTest > 0 ) data.alphaTest = this.alphaTest;
  15783. if ( this.alphaHash === true ) data.alphaHash = true;
  15784. if ( this.alphaToCoverage === true ) data.alphaToCoverage = true;
  15785. if ( this.premultipliedAlpha === true ) data.premultipliedAlpha = true;
  15786. if ( this.forceSinglePass === true ) data.forceSinglePass = true;
  15787. if ( this.allowOverride === false ) data.allowOverride = false;
  15788. if ( this.wireframe === true ) data.wireframe = true;
  15789. if ( this.wireframeLinewidth > 1 ) data.wireframeLinewidth = this.wireframeLinewidth;
  15790. if ( this.wireframeLinecap !== 'round' ) data.wireframeLinecap = this.wireframeLinecap;
  15791. if ( this.wireframeLinejoin !== 'round' ) data.wireframeLinejoin = this.wireframeLinejoin;
  15792. if ( this.flatShading === true ) data.flatShading = true;
  15793. if ( this.visible === false ) data.visible = false;
  15794. if ( this.toneMapped === false ) data.toneMapped = false;
  15795. if ( this.fog === false ) data.fog = false;
  15796. if ( Object.keys( this.userData ).length > 0 ) data.userData = this.userData;
  15797. // TODO: Copied from Object3D.toJSON
  15798. function extractFromCache( cache ) {
  15799. const values = [];
  15800. for ( const key in cache ) {
  15801. const data = cache[ key ];
  15802. delete data.metadata;
  15803. values.push( data );
  15804. }
  15805. return values;
  15806. }
  15807. if ( isRootObject ) {
  15808. const textures = extractFromCache( meta.textures );
  15809. const images = extractFromCache( meta.images );
  15810. if ( textures.length > 0 ) data.textures = textures;
  15811. if ( images.length > 0 ) data.images = images;
  15812. }
  15813. return data;
  15814. }
  15815. /**
  15816. * Returns a new material with copied values from this instance.
  15817. *
  15818. * @return {Material} A clone of this instance.
  15819. */
  15820. clone() {
  15821. return new this.constructor().copy( this );
  15822. }
  15823. /**
  15824. * Copies the values of the given material to this instance.
  15825. *
  15826. * @param {Material} source - The material to copy.
  15827. * @return {Material} A reference to this instance.
  15828. */
  15829. copy( source ) {
  15830. this.name = source.name;
  15831. this.blending = source.blending;
  15832. this.side = source.side;
  15833. this.vertexColors = source.vertexColors;
  15834. this.opacity = source.opacity;
  15835. this.transparent = source.transparent;
  15836. this.blendSrc = source.blendSrc;
  15837. this.blendDst = source.blendDst;
  15838. this.blendEquation = source.blendEquation;
  15839. this.blendSrcAlpha = source.blendSrcAlpha;
  15840. this.blendDstAlpha = source.blendDstAlpha;
  15841. this.blendEquationAlpha = source.blendEquationAlpha;
  15842. this.blendColor.copy( source.blendColor );
  15843. this.blendAlpha = source.blendAlpha;
  15844. this.depthFunc = source.depthFunc;
  15845. this.depthTest = source.depthTest;
  15846. this.depthWrite = source.depthWrite;
  15847. this.stencilWriteMask = source.stencilWriteMask;
  15848. this.stencilFunc = source.stencilFunc;
  15849. this.stencilRef = source.stencilRef;
  15850. this.stencilFuncMask = source.stencilFuncMask;
  15851. this.stencilFail = source.stencilFail;
  15852. this.stencilZFail = source.stencilZFail;
  15853. this.stencilZPass = source.stencilZPass;
  15854. this.stencilWrite = source.stencilWrite;
  15855. const srcPlanes = source.clippingPlanes;
  15856. let dstPlanes = null;
  15857. if ( srcPlanes !== null ) {
  15858. const n = srcPlanes.length;
  15859. dstPlanes = new Array( n );
  15860. for ( let i = 0; i !== n; ++ i ) {
  15861. dstPlanes[ i ] = srcPlanes[ i ].clone();
  15862. }
  15863. }
  15864. this.clippingPlanes = dstPlanes;
  15865. this.clipIntersection = source.clipIntersection;
  15866. this.clipShadows = source.clipShadows;
  15867. this.shadowSide = source.shadowSide;
  15868. this.colorWrite = source.colorWrite;
  15869. this.precision = source.precision;
  15870. this.polygonOffset = source.polygonOffset;
  15871. this.polygonOffsetFactor = source.polygonOffsetFactor;
  15872. this.polygonOffsetUnits = source.polygonOffsetUnits;
  15873. this.dithering = source.dithering;
  15874. this.alphaTest = source.alphaTest;
  15875. this.alphaHash = source.alphaHash;
  15876. this.alphaToCoverage = source.alphaToCoverage;
  15877. this.premultipliedAlpha = source.premultipliedAlpha;
  15878. this.forceSinglePass = source.forceSinglePass;
  15879. this.allowOverride = source.allowOverride;
  15880. this.visible = source.visible;
  15881. this.toneMapped = source.toneMapped;
  15882. this.userData = JSON.parse( JSON.stringify( source.userData ) );
  15883. return this;
  15884. }
  15885. /**
  15886. * Frees the GPU-related resources allocated by this instance. Call this
  15887. * method whenever this instance is no longer used in your app.
  15888. *
  15889. * @fires Material#dispose
  15890. */
  15891. dispose() {
  15892. /**
  15893. * Fires when the material has been disposed of.
  15894. *
  15895. * @event Material#dispose
  15896. * @type {Object}
  15897. */
  15898. this.dispatchEvent( { type: 'dispose' } );
  15899. }
  15900. /**
  15901. * Setting this property to `true` indicates the engine the material
  15902. * needs to be recompiled.
  15903. *
  15904. * @type {boolean}
  15905. * @default false
  15906. * @param {boolean} value
  15907. */
  15908. set needsUpdate( value ) {
  15909. if ( value === true ) this.version ++;
  15910. }
  15911. }
  15912. /**
  15913. * A material for rendering instances of {@link Sprite}.
  15914. *
  15915. * ```js
  15916. * const map = new THREE.TextureLoader().load( 'textures/sprite.png' );
  15917. * const material = new THREE.SpriteMaterial( { map: map, color: 0xffffff } );
  15918. *
  15919. * const sprite = new THREE.Sprite( material );
  15920. * sprite.scale.set(200, 200, 1)
  15921. * scene.add( sprite );
  15922. * ```
  15923. *
  15924. * @augments Material
  15925. */
  15926. class SpriteMaterial extends Material {
  15927. /**
  15928. * Constructs a new sprite material.
  15929. *
  15930. * @param {Object} [parameters] - An object with one or more properties
  15931. * defining the material's appearance. Any property of the material
  15932. * (including any property from inherited materials) can be passed
  15933. * in here. Color values can be passed any type of value accepted
  15934. * by {@link Color#set}.
  15935. */
  15936. constructor( parameters ) {
  15937. super();
  15938. /**
  15939. * This flag can be used for type testing.
  15940. *
  15941. * @type {boolean}
  15942. * @readonly
  15943. * @default true
  15944. */
  15945. this.isSpriteMaterial = true;
  15946. this.type = 'SpriteMaterial';
  15947. /**
  15948. * Color of the material.
  15949. *
  15950. * @type {Color}
  15951. * @default (1,1,1)
  15952. */
  15953. this.color = new Color( 0xffffff );
  15954. /**
  15955. * The color map. May optionally include an alpha channel, typically combined
  15956. * with {@link Material#transparent} or {@link Material#alphaTest}. The texture map
  15957. * color is modulated by the diffuse `color`.
  15958. *
  15959. * @type {?Texture}
  15960. * @default null
  15961. */
  15962. this.map = null;
  15963. /**
  15964. * The alpha map is a grayscale texture that controls the opacity across the
  15965. * surface (black: fully transparent; white: fully opaque).
  15966. *
  15967. * Only the color of the texture is used, ignoring the alpha channel if one
  15968. * exists. For RGB and RGBA textures, the renderer will use the green channel
  15969. * when sampling this texture due to the extra bit of precision provided for
  15970. * green in DXT-compressed and uncompressed RGB 565 formats. Luminance-only and
  15971. * luminance/alpha textures will also still work as expected.
  15972. *
  15973. * @type {?Texture}
  15974. * @default null
  15975. */
  15976. this.alphaMap = null;
  15977. /**
  15978. * The rotation of the sprite in radians.
  15979. *
  15980. * @type {number}
  15981. * @default 0
  15982. */
  15983. this.rotation = 0;
  15984. /**
  15985. * Specifies whether size of the sprite is attenuated by the camera depth (perspective camera only).
  15986. *
  15987. * @type {boolean}
  15988. * @default true
  15989. */
  15990. this.sizeAttenuation = true;
  15991. /**
  15992. * Overwritten since sprite materials are transparent
  15993. * by default.
  15994. *
  15995. * @type {boolean}
  15996. * @default true
  15997. */
  15998. this.transparent = true;
  15999. /**
  16000. * Whether the material is affected by fog or not.
  16001. *
  16002. * @type {boolean}
  16003. * @default true
  16004. */
  16005. this.fog = true;
  16006. this.setValues( parameters );
  16007. }
  16008. copy( source ) {
  16009. super.copy( source );
  16010. this.color.copy( source.color );
  16011. this.map = source.map;
  16012. this.alphaMap = source.alphaMap;
  16013. this.rotation = source.rotation;
  16014. this.sizeAttenuation = source.sizeAttenuation;
  16015. this.fog = source.fog;
  16016. return this;
  16017. }
  16018. }
  16019. let _geometry;
  16020. const _intersectPoint = /*@__PURE__*/ new Vector3();
  16021. const _worldScale = /*@__PURE__*/ new Vector3();
  16022. const _mvPosition = /*@__PURE__*/ new Vector3();
  16023. const _alignedPosition = /*@__PURE__*/ new Vector2();
  16024. const _rotatedPosition = /*@__PURE__*/ new Vector2();
  16025. const _viewWorldMatrix = /*@__PURE__*/ new Matrix4();
  16026. const _vA$1 = /*@__PURE__*/ new Vector3();
  16027. const _vB$1 = /*@__PURE__*/ new Vector3();
  16028. const _vC$1 = /*@__PURE__*/ new Vector3();
  16029. const _uvA = /*@__PURE__*/ new Vector2();
  16030. const _uvB = /*@__PURE__*/ new Vector2();
  16031. const _uvC = /*@__PURE__*/ new Vector2();
  16032. /**
  16033. * A sprite is a plane that always faces towards the camera, generally with a
  16034. * partially transparent texture applied.
  16035. *
  16036. * Sprites do not cast shadows, setting {@link Object3D#castShadow} to `true` will
  16037. * have no effect.
  16038. *
  16039. * ```js
  16040. * const map = new THREE.TextureLoader().load( 'sprite.png' );
  16041. * const material = new THREE.SpriteMaterial( { map: map } );
  16042. *
  16043. * const sprite = new THREE.Sprite( material );
  16044. * scene.add( sprite );
  16045. * ```
  16046. *
  16047. * @augments Object3D
  16048. */
  16049. class Sprite extends Object3D {
  16050. /**
  16051. * Constructs a new sprite.
  16052. *
  16053. * @param {(SpriteMaterial|SpriteNodeMaterial)} [material] - The sprite material.
  16054. */
  16055. constructor( material = new SpriteMaterial() ) {
  16056. super();
  16057. /**
  16058. * This flag can be used for type testing.
  16059. *
  16060. * @type {boolean}
  16061. * @readonly
  16062. * @default true
  16063. */
  16064. this.isSprite = true;
  16065. this.type = 'Sprite';
  16066. if ( _geometry === undefined ) {
  16067. _geometry = new BufferGeometry();
  16068. const float32Array = new Float32Array( [
  16069. -0.5, -0.5, 0, 0, 0,
  16070. 0.5, -0.5, 0, 1, 0,
  16071. 0.5, 0.5, 0, 1, 1,
  16072. -0.5, 0.5, 0, 0, 1
  16073. ] );
  16074. const interleavedBuffer = new InterleavedBuffer( float32Array, 5 );
  16075. _geometry.setIndex( [ 0, 1, 2, 0, 2, 3 ] );
  16076. _geometry.setAttribute( 'position', new InterleavedBufferAttribute( interleavedBuffer, 3, 0, false ) );
  16077. _geometry.setAttribute( 'uv', new InterleavedBufferAttribute( interleavedBuffer, 2, 3, false ) );
  16078. }
  16079. /**
  16080. * The sprite geometry.
  16081. *
  16082. * @type {BufferGeometry}
  16083. */
  16084. this.geometry = _geometry;
  16085. /**
  16086. * The sprite material.
  16087. *
  16088. * @type {(SpriteMaterial|SpriteNodeMaterial)}
  16089. */
  16090. this.material = material;
  16091. /**
  16092. * The sprite's anchor point, and the point around which the sprite rotates.
  16093. * A value of `(0.5, 0.5)` corresponds to the midpoint of the sprite. A value
  16094. * of `(0, 0)` corresponds to the lower left corner of the sprite.
  16095. *
  16096. * @type {Vector2}
  16097. * @default (0.5,0.5)
  16098. */
  16099. this.center = new Vector2( 0.5, 0.5 );
  16100. /**
  16101. * The number of instances of this sprite.
  16102. * Can only be used with {@link WebGPURenderer}.
  16103. *
  16104. * @type {number}
  16105. * @default 1
  16106. */
  16107. this.count = 1;
  16108. }
  16109. /**
  16110. * Computes intersection points between a casted ray and this sprite.
  16111. *
  16112. * @param {Raycaster} raycaster - The raycaster.
  16113. * @param {Array<Object>} intersects - The target array that holds the intersection points.
  16114. */
  16115. raycast( raycaster, intersects ) {
  16116. if ( raycaster.camera === null ) {
  16117. error( 'Sprite: "Raycaster.camera" needs to be set in order to raycast against sprites.' );
  16118. }
  16119. _worldScale.setFromMatrixScale( this.matrixWorld );
  16120. _viewWorldMatrix.copy( raycaster.camera.matrixWorld );
  16121. this.modelViewMatrix.multiplyMatrices( raycaster.camera.matrixWorldInverse, this.matrixWorld );
  16122. _mvPosition.setFromMatrixPosition( this.modelViewMatrix );
  16123. if ( raycaster.camera.isPerspectiveCamera && this.material.sizeAttenuation === false ) {
  16124. _worldScale.multiplyScalar( - _mvPosition.z );
  16125. }
  16126. const rotation = this.material.rotation;
  16127. let sin, cos;
  16128. if ( rotation !== 0 ) {
  16129. cos = Math.cos( rotation );
  16130. sin = Math.sin( rotation );
  16131. }
  16132. const center = this.center;
  16133. transformVertex( _vA$1.set( -0.5, -0.5, 0 ), _mvPosition, center, _worldScale, sin, cos );
  16134. transformVertex( _vB$1.set( 0.5, -0.5, 0 ), _mvPosition, center, _worldScale, sin, cos );
  16135. transformVertex( _vC$1.set( 0.5, 0.5, 0 ), _mvPosition, center, _worldScale, sin, cos );
  16136. _uvA.set( 0, 0 );
  16137. _uvB.set( 1, 0 );
  16138. _uvC.set( 1, 1 );
  16139. // check first triangle
  16140. let intersect = raycaster.ray.intersectTriangle( _vA$1, _vB$1, _vC$1, false, _intersectPoint );
  16141. if ( intersect === null ) {
  16142. // check second triangle
  16143. transformVertex( _vB$1.set( -0.5, 0.5, 0 ), _mvPosition, center, _worldScale, sin, cos );
  16144. _uvB.set( 0, 1 );
  16145. intersect = raycaster.ray.intersectTriangle( _vA$1, _vC$1, _vB$1, false, _intersectPoint );
  16146. if ( intersect === null ) {
  16147. return;
  16148. }
  16149. }
  16150. const distance = raycaster.ray.origin.distanceTo( _intersectPoint );
  16151. if ( distance < raycaster.near || distance > raycaster.far ) return;
  16152. intersects.push( {
  16153. distance: distance,
  16154. point: _intersectPoint.clone(),
  16155. uv: Triangle.getInterpolation( _intersectPoint, _vA$1, _vB$1, _vC$1, _uvA, _uvB, _uvC, new Vector2() ),
  16156. face: null,
  16157. object: this
  16158. } );
  16159. }
  16160. copy( source, recursive ) {
  16161. super.copy( source, recursive );
  16162. if ( source.center !== undefined ) this.center.copy( source.center );
  16163. this.material = source.material;
  16164. return this;
  16165. }
  16166. }
  16167. function transformVertex( vertexPosition, mvPosition, center, scale, sin, cos ) {
  16168. // compute position in camera space
  16169. _alignedPosition.subVectors( vertexPosition, center ).addScalar( 0.5 ).multiply( scale );
  16170. // to check if rotation is not zero
  16171. if ( sin !== undefined ) {
  16172. _rotatedPosition.x = ( cos * _alignedPosition.x ) - ( sin * _alignedPosition.y );
  16173. _rotatedPosition.y = ( sin * _alignedPosition.x ) + ( cos * _alignedPosition.y );
  16174. } else {
  16175. _rotatedPosition.copy( _alignedPosition );
  16176. }
  16177. vertexPosition.copy( mvPosition );
  16178. vertexPosition.x += _rotatedPosition.x;
  16179. vertexPosition.y += _rotatedPosition.y;
  16180. // transform to world space
  16181. vertexPosition.applyMatrix4( _viewWorldMatrix );
  16182. }
  16183. const _v1$2 = /*@__PURE__*/ new Vector3();
  16184. const _v2$1 = /*@__PURE__*/ new Vector3();
  16185. /**
  16186. * A component for providing a basic Level of Detail (LOD) mechanism.
  16187. *
  16188. * Every LOD level is associated with an object, and rendering can be switched
  16189. * between them at the distances specified. Typically you would create, say,
  16190. * three meshes, one for far away (low detail), one for mid range (medium
  16191. * detail) and one for close up (high detail).
  16192. *
  16193. * ```js
  16194. * const lod = new THREE.LOD();
  16195. * const material = new THREE.MeshBasicMaterial( { color: 0xffff00 } );
  16196. *
  16197. * //Create spheres with 3 levels of detail and create new LOD levels for them
  16198. * for( let i = 0; i < 3; i++ ) {
  16199. *
  16200. * const geometry = new THREE.IcosahedronGeometry( 10, 3 - i );
  16201. * const mesh = new THREE.Mesh( geometry, material );
  16202. * lod.addLevel( mesh, i * 75 );
  16203. *
  16204. * }
  16205. *
  16206. * scene.add( lod );
  16207. * ```
  16208. *
  16209. * @augments Object3D
  16210. */
  16211. class LOD extends Object3D {
  16212. /**
  16213. * Constructs a new LOD.
  16214. */
  16215. constructor() {
  16216. super();
  16217. /**
  16218. * This flag can be used for type testing.
  16219. *
  16220. * @type {boolean}
  16221. * @readonly
  16222. * @default true
  16223. */
  16224. this.isLOD = true;
  16225. /**
  16226. * The current LOD index.
  16227. *
  16228. * @private
  16229. * @type {number}
  16230. * @default 0
  16231. */
  16232. this._currentLevel = 0;
  16233. this.type = 'LOD';
  16234. Object.defineProperties( this, {
  16235. /**
  16236. * This array holds the LOD levels.
  16237. *
  16238. * @name LOD#levels
  16239. * @type {Array<{object:Object3D,distance:number,hysteresis:number}>}
  16240. */
  16241. levels: {
  16242. enumerable: true,
  16243. value: []
  16244. }
  16245. } );
  16246. /**
  16247. * Whether the LOD object is updated automatically by the renderer per frame
  16248. * or not. If set to `false`, you have to call {@link LOD#update} in the
  16249. * render loop by yourself.
  16250. *
  16251. * @type {boolean}
  16252. * @default true
  16253. */
  16254. this.autoUpdate = true;
  16255. }
  16256. copy( source ) {
  16257. super.copy( source, false );
  16258. const levels = source.levels;
  16259. for ( let i = 0, l = levels.length; i < l; i ++ ) {
  16260. const level = levels[ i ];
  16261. this.addLevel( level.object.clone(), level.distance, level.hysteresis );
  16262. }
  16263. this.autoUpdate = source.autoUpdate;
  16264. return this;
  16265. }
  16266. /**
  16267. * Adds a mesh that will display at a certain distance and greater. Typically
  16268. * the further away the distance, the lower the detail on the mesh.
  16269. *
  16270. * @param {Object3D} object - The 3D object to display at this level.
  16271. * @param {number} [distance=0] - The distance at which to display this level of detail.
  16272. * @param {number} [hysteresis=0] - Threshold used to avoid flickering at LOD boundaries, as a fraction of distance.
  16273. * @return {LOD} A reference to this instance.
  16274. */
  16275. addLevel( object, distance = 0, hysteresis = 0 ) {
  16276. distance = Math.abs( distance );
  16277. const levels = this.levels;
  16278. let l;
  16279. for ( l = 0; l < levels.length; l ++ ) {
  16280. if ( distance < levels[ l ].distance ) {
  16281. break;
  16282. }
  16283. }
  16284. levels.splice( l, 0, { distance: distance, hysteresis: hysteresis, object: object } );
  16285. this.add( object );
  16286. return this;
  16287. }
  16288. /**
  16289. * Removes an existing level, based on the distance from the camera.
  16290. * Returns `true` when the level has been removed. Otherwise `false`.
  16291. *
  16292. * @param {number} distance - Distance of the level to remove.
  16293. * @return {boolean} Whether the level has been removed or not.
  16294. */
  16295. removeLevel( distance ) {
  16296. const levels = this.levels;
  16297. for ( let i = 0; i < levels.length; i ++ ) {
  16298. if ( levels[ i ].distance === distance ) {
  16299. const removedElements = levels.splice( i, 1 );
  16300. this.remove( removedElements[ 0 ].object );
  16301. return true;
  16302. }
  16303. }
  16304. return false;
  16305. }
  16306. /**
  16307. * Returns the currently active LOD level index.
  16308. *
  16309. * @return {number} The current active LOD level index.
  16310. */
  16311. getCurrentLevel() {
  16312. return this._currentLevel;
  16313. }
  16314. /**
  16315. * Returns a reference to the first 3D object that is greater than
  16316. * the given distance.
  16317. *
  16318. * @param {number} distance - The LOD distance.
  16319. * @return {?Object3D} The found 3D object. `null` if no 3D object has been found.
  16320. */
  16321. getObjectForDistance( distance ) {
  16322. const levels = this.levels;
  16323. if ( levels.length > 0 ) {
  16324. let i, l;
  16325. for ( i = 1, l = levels.length; i < l; i ++ ) {
  16326. let levelDistance = levels[ i ].distance;
  16327. if ( levels[ i ].object.visible ) {
  16328. levelDistance -= levelDistance * levels[ i ].hysteresis;
  16329. }
  16330. if ( distance < levelDistance ) {
  16331. break;
  16332. }
  16333. }
  16334. return levels[ i - 1 ].object;
  16335. }
  16336. return null;
  16337. }
  16338. /**
  16339. * Computes intersection points between a casted ray and this LOD.
  16340. *
  16341. * @param {Raycaster} raycaster - The raycaster.
  16342. * @param {Array<Object>} intersects - The target array that holds the intersection points.
  16343. */
  16344. raycast( raycaster, intersects ) {
  16345. const levels = this.levels;
  16346. if ( levels.length > 0 ) {
  16347. _v1$2.setFromMatrixPosition( this.matrixWorld );
  16348. const distance = raycaster.ray.origin.distanceTo( _v1$2 );
  16349. this.getObjectForDistance( distance ).raycast( raycaster, intersects );
  16350. }
  16351. }
  16352. /**
  16353. * Updates the LOD by computing which LOD level should be visible according
  16354. * to the current distance of the given camera.
  16355. *
  16356. * @param {Camera} camera - The camera the scene is rendered with.
  16357. */
  16358. update( camera ) {
  16359. const levels = this.levels;
  16360. if ( levels.length > 1 ) {
  16361. _v1$2.setFromMatrixPosition( camera.matrixWorld );
  16362. _v2$1.setFromMatrixPosition( this.matrixWorld );
  16363. const distance = _v1$2.distanceTo( _v2$1 ) / camera.zoom;
  16364. levels[ 0 ].object.visible = true;
  16365. let i, l;
  16366. for ( i = 1, l = levels.length; i < l; i ++ ) {
  16367. let levelDistance = levels[ i ].distance;
  16368. if ( levels[ i ].object.visible ) {
  16369. levelDistance -= levelDistance * levels[ i ].hysteresis;
  16370. }
  16371. if ( distance >= levelDistance ) {
  16372. levels[ i - 1 ].object.visible = false;
  16373. levels[ i ].object.visible = true;
  16374. } else {
  16375. break;
  16376. }
  16377. }
  16378. this._currentLevel = i - 1;
  16379. for ( ; i < l; i ++ ) {
  16380. levels[ i ].object.visible = false;
  16381. }
  16382. }
  16383. }
  16384. toJSON( meta ) {
  16385. const data = super.toJSON( meta );
  16386. if ( this.autoUpdate === false ) data.object.autoUpdate = false;
  16387. data.object.levels = [];
  16388. const levels = this.levels;
  16389. for ( let i = 0, l = levels.length; i < l; i ++ ) {
  16390. const level = levels[ i ];
  16391. data.object.levels.push( {
  16392. object: level.object.uuid,
  16393. distance: level.distance,
  16394. hysteresis: level.hysteresis
  16395. } );
  16396. }
  16397. return data;
  16398. }
  16399. }
  16400. const _vector$7 = /*@__PURE__*/ new Vector3();
  16401. const _segCenter = /*@__PURE__*/ new Vector3();
  16402. const _segDir = /*@__PURE__*/ new Vector3();
  16403. const _diff = /*@__PURE__*/ new Vector3();
  16404. const _edge1 = /*@__PURE__*/ new Vector3();
  16405. const _edge2 = /*@__PURE__*/ new Vector3();
  16406. const _normal$1 = /*@__PURE__*/ new Vector3();
  16407. /**
  16408. * A ray that emits from an origin in a certain direction. The class is used by
  16409. * {@link Raycaster} to assist with raycasting. Raycasting is used for
  16410. * mouse picking (working out what objects in the 3D space the mouse is over)
  16411. * amongst other things.
  16412. */
  16413. class Ray {
  16414. /**
  16415. * Constructs a new ray.
  16416. *
  16417. * @param {Vector3} [origin=(0,0,0)] - The origin of the ray.
  16418. * @param {Vector3} [direction=(0,0,-1)] - The (normalized) direction of the ray.
  16419. */
  16420. constructor( origin = new Vector3(), direction = new Vector3( 0, 0, -1 ) ) {
  16421. /**
  16422. * The origin of the ray.
  16423. *
  16424. * @type {Vector3}
  16425. */
  16426. this.origin = origin;
  16427. /**
  16428. * The (normalized) direction of the ray.
  16429. *
  16430. * @type {Vector3}
  16431. */
  16432. this.direction = direction;
  16433. }
  16434. /**
  16435. * Sets the ray's components by copying the given values.
  16436. *
  16437. * @param {Vector3} origin - The origin.
  16438. * @param {Vector3} direction - The direction.
  16439. * @return {Ray} A reference to this ray.
  16440. */
  16441. set( origin, direction ) {
  16442. this.origin.copy( origin );
  16443. this.direction.copy( direction );
  16444. return this;
  16445. }
  16446. /**
  16447. * Copies the values of the given ray to this instance.
  16448. *
  16449. * @param {Ray} ray - The ray to copy.
  16450. * @return {Ray} A reference to this ray.
  16451. */
  16452. copy( ray ) {
  16453. this.origin.copy( ray.origin );
  16454. this.direction.copy( ray.direction );
  16455. return this;
  16456. }
  16457. /**
  16458. * Returns a vector that is located at a given distance along this ray.
  16459. *
  16460. * @param {number} t - The distance along the ray to retrieve a position for.
  16461. * @param {Vector3} target - The target vector that is used to store the method's result.
  16462. * @return {Vector3} A position on the ray.
  16463. */
  16464. at( t, target ) {
  16465. return target.copy( this.origin ).addScaledVector( this.direction, t );
  16466. }
  16467. /**
  16468. * Adjusts the direction of the ray to point at the given vector in world space.
  16469. *
  16470. * @param {Vector3} v - The target position.
  16471. * @return {Ray} A reference to this ray.
  16472. */
  16473. lookAt( v ) {
  16474. this.direction.copy( v ).sub( this.origin ).normalize();
  16475. return this;
  16476. }
  16477. /**
  16478. * Shift the origin of this ray along its direction by the given distance.
  16479. *
  16480. * @param {number} t - The distance along the ray to interpolate.
  16481. * @return {Ray} A reference to this ray.
  16482. */
  16483. recast( t ) {
  16484. this.origin.copy( this.at( t, _vector$7 ) );
  16485. return this;
  16486. }
  16487. /**
  16488. * Returns the point along this ray that is closest to the given point.
  16489. *
  16490. * @param {Vector3} point - A point in 3D space to get the closet location on the ray for.
  16491. * @param {Vector3} target - The target vector that is used to store the method's result.
  16492. * @return {Vector3} The closest point on this ray.
  16493. */
  16494. closestPointToPoint( point, target ) {
  16495. target.subVectors( point, this.origin );
  16496. const directionDistance = target.dot( this.direction );
  16497. if ( directionDistance < 0 ) {
  16498. return target.copy( this.origin );
  16499. }
  16500. return target.copy( this.origin ).addScaledVector( this.direction, directionDistance );
  16501. }
  16502. /**
  16503. * Returns the distance of the closest approach between this ray and the given point.
  16504. *
  16505. * @param {Vector3} point - A point in 3D space to compute the distance to.
  16506. * @return {number} The distance.
  16507. */
  16508. distanceToPoint( point ) {
  16509. return Math.sqrt( this.distanceSqToPoint( point ) );
  16510. }
  16511. /**
  16512. * Returns the squared distance of the closest approach between this ray and the given point.
  16513. *
  16514. * @param {Vector3} point - A point in 3D space to compute the distance to.
  16515. * @return {number} The squared distance.
  16516. */
  16517. distanceSqToPoint( point ) {
  16518. const directionDistance = _vector$7.subVectors( point, this.origin ).dot( this.direction );
  16519. // point behind the ray
  16520. if ( directionDistance < 0 ) {
  16521. return this.origin.distanceToSquared( point );
  16522. }
  16523. _vector$7.copy( this.origin ).addScaledVector( this.direction, directionDistance );
  16524. return _vector$7.distanceToSquared( point );
  16525. }
  16526. /**
  16527. * Returns the squared distance between this ray and the given line segment.
  16528. *
  16529. * @param {Vector3} v0 - The start point of the line segment.
  16530. * @param {Vector3} v1 - The end point of the line segment.
  16531. * @param {Vector3} [optionalPointOnRay] - When provided, it receives the point on this ray that is closest to the segment.
  16532. * @param {Vector3} [optionalPointOnSegment] - When provided, it receives the point on the line segment that is closest to this ray.
  16533. * @return {number} The squared distance.
  16534. */
  16535. distanceSqToSegment( v0, v1, optionalPointOnRay, optionalPointOnSegment ) {
  16536. // from https://github.com/pmjoniak/GeometricTools/blob/master/GTEngine/Include/Mathematics/GteDistRaySegment.h
  16537. // It returns the min distance between the ray and the segment
  16538. // defined by v0 and v1
  16539. // It can also set two optional targets :
  16540. // - The closest point on the ray
  16541. // - The closest point on the segment
  16542. _segCenter.copy( v0 ).add( v1 ).multiplyScalar( 0.5 );
  16543. _segDir.copy( v1 ).sub( v0 ).normalize();
  16544. _diff.copy( this.origin ).sub( _segCenter );
  16545. const segExtent = v0.distanceTo( v1 ) * 0.5;
  16546. const a01 = - this.direction.dot( _segDir );
  16547. const b0 = _diff.dot( this.direction );
  16548. const b1 = - _diff.dot( _segDir );
  16549. const c = _diff.lengthSq();
  16550. const det = Math.abs( 1 - a01 * a01 );
  16551. let s0, s1, sqrDist, extDet;
  16552. if ( det > 0 ) {
  16553. // The ray and segment are not parallel.
  16554. s0 = a01 * b1 - b0;
  16555. s1 = a01 * b0 - b1;
  16556. extDet = segExtent * det;
  16557. if ( s0 >= 0 ) {
  16558. if ( s1 >= - extDet ) {
  16559. if ( s1 <= extDet ) {
  16560. // region 0
  16561. // Minimum at interior points of ray and segment.
  16562. const invDet = 1 / det;
  16563. s0 *= invDet;
  16564. s1 *= invDet;
  16565. sqrDist = s0 * ( s0 + a01 * s1 + 2 * b0 ) + s1 * ( a01 * s0 + s1 + 2 * b1 ) + c;
  16566. } else {
  16567. // region 1
  16568. s1 = segExtent;
  16569. s0 = Math.max( 0, - ( a01 * s1 + b0 ) );
  16570. sqrDist = - s0 * s0 + s1 * ( s1 + 2 * b1 ) + c;
  16571. }
  16572. } else {
  16573. // region 5
  16574. s1 = - segExtent;
  16575. s0 = Math.max( 0, - ( a01 * s1 + b0 ) );
  16576. sqrDist = - s0 * s0 + s1 * ( s1 + 2 * b1 ) + c;
  16577. }
  16578. } else {
  16579. if ( s1 <= - extDet ) {
  16580. // region 4
  16581. s0 = Math.max( 0, - ( - a01 * segExtent + b0 ) );
  16582. s1 = ( s0 > 0 ) ? - segExtent : Math.min( Math.max( - segExtent, - b1 ), segExtent );
  16583. sqrDist = - s0 * s0 + s1 * ( s1 + 2 * b1 ) + c;
  16584. } else if ( s1 <= extDet ) {
  16585. // region 3
  16586. s0 = 0;
  16587. s1 = Math.min( Math.max( - segExtent, - b1 ), segExtent );
  16588. sqrDist = s1 * ( s1 + 2 * b1 ) + c;
  16589. } else {
  16590. // region 2
  16591. s0 = Math.max( 0, - ( a01 * segExtent + b0 ) );
  16592. s1 = ( s0 > 0 ) ? segExtent : Math.min( Math.max( - segExtent, - b1 ), segExtent );
  16593. sqrDist = - s0 * s0 + s1 * ( s1 + 2 * b1 ) + c;
  16594. }
  16595. }
  16596. } else {
  16597. // Ray and segment are parallel.
  16598. s1 = ( a01 > 0 ) ? - segExtent : segExtent;
  16599. s0 = Math.max( 0, - ( a01 * s1 + b0 ) );
  16600. sqrDist = - s0 * s0 + s1 * ( s1 + 2 * b1 ) + c;
  16601. }
  16602. if ( optionalPointOnRay ) {
  16603. optionalPointOnRay.copy( this.origin ).addScaledVector( this.direction, s0 );
  16604. }
  16605. if ( optionalPointOnSegment ) {
  16606. optionalPointOnSegment.copy( _segCenter ).addScaledVector( _segDir, s1 );
  16607. }
  16608. return sqrDist;
  16609. }
  16610. /**
  16611. * Intersects this ray with the given sphere, returning the intersection
  16612. * point or `null` if there is no intersection.
  16613. *
  16614. * @param {Sphere} sphere - The sphere to intersect.
  16615. * @param {Vector3} target - The target vector that is used to store the method's result.
  16616. * @return {?Vector3} The intersection point.
  16617. */
  16618. intersectSphere( sphere, target ) {
  16619. _vector$7.subVectors( sphere.center, this.origin );
  16620. const tca = _vector$7.dot( this.direction );
  16621. const d2 = _vector$7.dot( _vector$7 ) - tca * tca;
  16622. const radius2 = sphere.radius * sphere.radius;
  16623. if ( d2 > radius2 ) return null;
  16624. const thc = Math.sqrt( radius2 - d2 );
  16625. // t0 = first intersect point - entrance on front of sphere
  16626. const t0 = tca - thc;
  16627. // t1 = second intersect point - exit point on back of sphere
  16628. const t1 = tca + thc;
  16629. // test to see if t1 is behind the ray - if so, return null
  16630. if ( t1 < 0 ) return null;
  16631. // test to see if t0 is behind the ray:
  16632. // if it is, the ray is inside the sphere, so return the second exit point scaled by t1,
  16633. // in order to always return an intersect point that is in front of the ray.
  16634. if ( t0 < 0 ) return this.at( t1, target );
  16635. // else t0 is in front of the ray, so return the first collision point scaled by t0
  16636. return this.at( t0, target );
  16637. }
  16638. /**
  16639. * Returns `true` if this ray intersects with the given sphere.
  16640. *
  16641. * @param {Sphere} sphere - The sphere to intersect.
  16642. * @return {boolean} Whether this ray intersects with the given sphere or not.
  16643. */
  16644. intersectsSphere( sphere ) {
  16645. if ( sphere.radius < 0 ) return false; // handle empty spheres, see #31187
  16646. return this.distanceSqToPoint( sphere.center ) <= ( sphere.radius * sphere.radius );
  16647. }
  16648. /**
  16649. * Computes the distance from the ray's origin to the given plane. Returns `null` if the ray
  16650. * does not intersect with the plane.
  16651. *
  16652. * @param {Plane} plane - The plane to compute the distance to.
  16653. * @return {?number} Whether this ray intersects with the given sphere or not.
  16654. */
  16655. distanceToPlane( plane ) {
  16656. const denominator = plane.normal.dot( this.direction );
  16657. if ( denominator === 0 ) {
  16658. // line is coplanar, return origin
  16659. if ( plane.distanceToPoint( this.origin ) === 0 ) {
  16660. return 0;
  16661. }
  16662. // Null is preferable to undefined since undefined means.... it is undefined
  16663. return null;
  16664. }
  16665. const t = - ( this.origin.dot( plane.normal ) + plane.constant ) / denominator;
  16666. // Return if the ray never intersects the plane
  16667. return t >= 0 ? t : null;
  16668. }
  16669. /**
  16670. * Intersects this ray with the given plane, returning the intersection
  16671. * point or `null` if there is no intersection.
  16672. *
  16673. * @param {Plane} plane - The plane to intersect.
  16674. * @param {Vector3} target - The target vector that is used to store the method's result.
  16675. * @return {?Vector3} The intersection point.
  16676. */
  16677. intersectPlane( plane, target ) {
  16678. const t = this.distanceToPlane( plane );
  16679. if ( t === null ) {
  16680. return null;
  16681. }
  16682. return this.at( t, target );
  16683. }
  16684. /**
  16685. * Returns `true` if this ray intersects with the given plane.
  16686. *
  16687. * @param {Plane} plane - The plane to intersect.
  16688. * @return {boolean} Whether this ray intersects with the given plane or not.
  16689. */
  16690. intersectsPlane( plane ) {
  16691. // check if the ray lies on the plane first
  16692. const distToPoint = plane.distanceToPoint( this.origin );
  16693. if ( distToPoint === 0 ) {
  16694. return true;
  16695. }
  16696. const denominator = plane.normal.dot( this.direction );
  16697. if ( denominator * distToPoint < 0 ) {
  16698. return true;
  16699. }
  16700. // ray origin is behind the plane (and is pointing behind it)
  16701. return false;
  16702. }
  16703. /**
  16704. * Intersects this ray with the given bounding box, returning the intersection
  16705. * point or `null` if there is no intersection.
  16706. *
  16707. * @param {Box3} box - The box to intersect.
  16708. * @param {Vector3} target - The target vector that is used to store the method's result.
  16709. * @return {?Vector3} The intersection point.
  16710. */
  16711. intersectBox( box, target ) {
  16712. let tmin, tmax, tymin, tymax, tzmin, tzmax;
  16713. const invdirx = 1 / this.direction.x,
  16714. invdiry = 1 / this.direction.y,
  16715. invdirz = 1 / this.direction.z;
  16716. const origin = this.origin;
  16717. if ( invdirx >= 0 ) {
  16718. tmin = ( box.min.x - origin.x ) * invdirx;
  16719. tmax = ( box.max.x - origin.x ) * invdirx;
  16720. } else {
  16721. tmin = ( box.max.x - origin.x ) * invdirx;
  16722. tmax = ( box.min.x - origin.x ) * invdirx;
  16723. }
  16724. if ( invdiry >= 0 ) {
  16725. tymin = ( box.min.y - origin.y ) * invdiry;
  16726. tymax = ( box.max.y - origin.y ) * invdiry;
  16727. } else {
  16728. tymin = ( box.max.y - origin.y ) * invdiry;
  16729. tymax = ( box.min.y - origin.y ) * invdiry;
  16730. }
  16731. if ( ( tmin > tymax ) || ( tymin > tmax ) ) return null;
  16732. if ( tymin > tmin || isNaN( tmin ) ) tmin = tymin;
  16733. if ( tymax < tmax || isNaN( tmax ) ) tmax = tymax;
  16734. if ( invdirz >= 0 ) {
  16735. tzmin = ( box.min.z - origin.z ) * invdirz;
  16736. tzmax = ( box.max.z - origin.z ) * invdirz;
  16737. } else {
  16738. tzmin = ( box.max.z - origin.z ) * invdirz;
  16739. tzmax = ( box.min.z - origin.z ) * invdirz;
  16740. }
  16741. if ( ( tmin > tzmax ) || ( tzmin > tmax ) ) return null;
  16742. if ( tzmin > tmin || tmin !== tmin ) tmin = tzmin;
  16743. if ( tzmax < tmax || tmax !== tmax ) tmax = tzmax;
  16744. //return point closest to the ray (positive side)
  16745. if ( tmax < 0 ) return null;
  16746. return this.at( tmin >= 0 ? tmin : tmax, target );
  16747. }
  16748. /**
  16749. * Returns `true` if this ray intersects with the given box.
  16750. *
  16751. * @param {Box3} box - The box to intersect.
  16752. * @return {boolean} Whether this ray intersects with the given box or not.
  16753. */
  16754. intersectsBox( box ) {
  16755. return this.intersectBox( box, _vector$7 ) !== null;
  16756. }
  16757. /**
  16758. * Intersects this ray with the given triangle, returning the intersection
  16759. * point or `null` if there is no intersection.
  16760. *
  16761. * @param {Vector3} a - The first vertex of the triangle.
  16762. * @param {Vector3} b - The second vertex of the triangle.
  16763. * @param {Vector3} c - The third vertex of the triangle.
  16764. * @param {boolean} backfaceCulling - Whether to use backface culling or not.
  16765. * @param {Vector3} target - The target vector that is used to store the method's result.
  16766. * @return {?Vector3} The intersection point.
  16767. */
  16768. intersectTriangle( a, b, c, backfaceCulling, target ) {
  16769. // Compute the offset origin, edges, and normal.
  16770. // from https://github.com/pmjoniak/GeometricTools/blob/master/GTEngine/Include/Mathematics/GteIntrRay3Triangle3.h
  16771. _edge1.subVectors( b, a );
  16772. _edge2.subVectors( c, a );
  16773. _normal$1.crossVectors( _edge1, _edge2 );
  16774. // Solve Q + t*D = b1*E1 + b2*E2 (Q = kDiff, D = ray direction,
  16775. // E1 = kEdge1, E2 = kEdge2, N = Cross(E1,E2)) by
  16776. // |Dot(D,N)|*b1 = sign(Dot(D,N))*Dot(D,Cross(Q,E2))
  16777. // |Dot(D,N)|*b2 = sign(Dot(D,N))*Dot(D,Cross(E1,Q))
  16778. // |Dot(D,N)|*t = -sign(Dot(D,N))*Dot(Q,N)
  16779. let DdN = this.direction.dot( _normal$1 );
  16780. let sign;
  16781. if ( DdN > 0 ) {
  16782. if ( backfaceCulling ) return null;
  16783. sign = 1;
  16784. } else if ( DdN < 0 ) {
  16785. sign = -1;
  16786. DdN = - DdN;
  16787. } else {
  16788. return null;
  16789. }
  16790. _diff.subVectors( this.origin, a );
  16791. const DdQxE2 = sign * this.direction.dot( _edge2.crossVectors( _diff, _edge2 ) );
  16792. // b1 < 0, no intersection
  16793. if ( DdQxE2 < 0 ) {
  16794. return null;
  16795. }
  16796. const DdE1xQ = sign * this.direction.dot( _edge1.cross( _diff ) );
  16797. // b2 < 0, no intersection
  16798. if ( DdE1xQ < 0 ) {
  16799. return null;
  16800. }
  16801. // b1+b2 > 1, no intersection
  16802. if ( DdQxE2 + DdE1xQ > DdN ) {
  16803. return null;
  16804. }
  16805. // Line intersects triangle, check if ray does.
  16806. const QdN = - sign * _diff.dot( _normal$1 );
  16807. // t < 0, no intersection
  16808. if ( QdN < 0 ) {
  16809. return null;
  16810. }
  16811. // Ray intersects triangle.
  16812. return this.at( QdN / DdN, target );
  16813. }
  16814. /**
  16815. * Transforms this ray with the given 4x4 transformation matrix.
  16816. *
  16817. * @param {Matrix4} matrix4 - The transformation matrix.
  16818. * @return {Ray} A reference to this ray.
  16819. */
  16820. applyMatrix4( matrix4 ) {
  16821. this.origin.applyMatrix4( matrix4 );
  16822. this.direction.transformDirection( matrix4 );
  16823. return this;
  16824. }
  16825. /**
  16826. * Returns `true` if this ray is equal with the given one.
  16827. *
  16828. * @param {Ray} ray - The ray to test for equality.
  16829. * @return {boolean} Whether this ray is equal with the given one.
  16830. */
  16831. equals( ray ) {
  16832. return ray.origin.equals( this.origin ) && ray.direction.equals( this.direction );
  16833. }
  16834. /**
  16835. * Returns a new ray with copied values from this instance.
  16836. *
  16837. * @return {Ray} A clone of this instance.
  16838. */
  16839. clone() {
  16840. return new this.constructor().copy( this );
  16841. }
  16842. }
  16843. /**
  16844. * A material for drawing geometries in a simple shaded (flat or wireframe) way.
  16845. *
  16846. * This material is not affected by lights.
  16847. *
  16848. * @augments Material
  16849. * @demo scenes/material-browser.html#MeshBasicMaterial
  16850. */
  16851. class MeshBasicMaterial extends Material {
  16852. /**
  16853. * Constructs a new mesh basic material.
  16854. *
  16855. * @param {Object} [parameters] - An object with one or more properties
  16856. * defining the material's appearance. Any property of the material
  16857. * (including any property from inherited materials) can be passed
  16858. * in here. Color values can be passed any type of value accepted
  16859. * by {@link Color#set}.
  16860. */
  16861. constructor( parameters ) {
  16862. super();
  16863. /**
  16864. * This flag can be used for type testing.
  16865. *
  16866. * @type {boolean}
  16867. * @readonly
  16868. * @default true
  16869. */
  16870. this.isMeshBasicMaterial = true;
  16871. this.type = 'MeshBasicMaterial';
  16872. /**
  16873. * Color of the material.
  16874. *
  16875. * @type {Color}
  16876. * @default (1,1,1)
  16877. */
  16878. this.color = new Color( 0xffffff ); // diffuse
  16879. /**
  16880. * The color map. May optionally include an alpha channel, typically combined
  16881. * with {@link Material#transparent} or {@link Material#alphaTest}. The texture map
  16882. * color is modulated by the diffuse `color`.
  16883. *
  16884. * @type {?Texture}
  16885. * @default null
  16886. */
  16887. this.map = null;
  16888. /**
  16889. * The light map. Requires a second set of UVs.
  16890. *
  16891. * @type {?Texture}
  16892. * @default null
  16893. */
  16894. this.lightMap = null;
  16895. /**
  16896. * Intensity of the baked light.
  16897. *
  16898. * @type {number}
  16899. * @default 1
  16900. */
  16901. this.lightMapIntensity = 1.0;
  16902. /**
  16903. * The red channel of this texture is used as the ambient occlusion map.
  16904. * Requires a second set of UVs.
  16905. *
  16906. * @type {?Texture}
  16907. * @default null
  16908. */
  16909. this.aoMap = null;
  16910. /**
  16911. * Intensity of the ambient occlusion effect. Range is `[0,1]`, where `0`
  16912. * disables ambient occlusion. Where intensity is `1` and the AO map's
  16913. * red channel is also `1`, ambient light is fully occluded on a surface.
  16914. *
  16915. * @type {number}
  16916. * @default 1
  16917. */
  16918. this.aoMapIntensity = 1.0;
  16919. /**
  16920. * Specular map used by the material.
  16921. *
  16922. * @type {?Texture}
  16923. * @default null
  16924. */
  16925. this.specularMap = null;
  16926. /**
  16927. * The alpha map is a grayscale texture that controls the opacity across the
  16928. * surface (black: fully transparent; white: fully opaque).
  16929. *
  16930. * Only the color of the texture is used, ignoring the alpha channel if one
  16931. * exists. For RGB and RGBA textures, the renderer will use the green channel
  16932. * when sampling this texture due to the extra bit of precision provided for
  16933. * green in DXT-compressed and uncompressed RGB 565 formats. Luminance-only and
  16934. * luminance/alpha textures will also still work as expected.
  16935. *
  16936. * @type {?Texture}
  16937. * @default null
  16938. */
  16939. this.alphaMap = null;
  16940. /**
  16941. * The environment map.
  16942. *
  16943. * @type {?Texture}
  16944. * @default null
  16945. */
  16946. this.envMap = null;
  16947. /**
  16948. * The rotation of the environment map in radians.
  16949. *
  16950. * @type {Euler}
  16951. * @default (0,0,0)
  16952. */
  16953. this.envMapRotation = new Euler();
  16954. /**
  16955. * How to combine the result of the surface's color with the environment map, if any.
  16956. *
  16957. * When set to `MixOperation`, the {@link MeshBasicMaterial#reflectivity} is used to
  16958. * blend between the two colors.
  16959. *
  16960. * @type {(MultiplyOperation|MixOperation|AddOperation)}
  16961. * @default MultiplyOperation
  16962. */
  16963. this.combine = MultiplyOperation;
  16964. /**
  16965. * How much the environment map affects the surface.
  16966. * The valid range is between `0` (no reflections) and `1` (full reflections).
  16967. *
  16968. * @type {number}
  16969. * @default 1
  16970. */
  16971. this.reflectivity = 1;
  16972. /**
  16973. * The index of refraction (IOR) of air (approximately 1) divided by the
  16974. * index of refraction of the material. It is used with environment mapping
  16975. * modes {@link CubeRefractionMapping} and {@link EquirectangularRefractionMapping}.
  16976. * The refraction ratio should not exceed `1`.
  16977. *
  16978. * @type {number}
  16979. * @default 0.98
  16980. */
  16981. this.refractionRatio = 0.98;
  16982. /**
  16983. * Renders the geometry as a wireframe.
  16984. *
  16985. * @type {boolean}
  16986. * @default false
  16987. */
  16988. this.wireframe = false;
  16989. /**
  16990. * Controls the thickness of the wireframe.
  16991. *
  16992. * Can only be used with {@link SVGRenderer}.
  16993. *
  16994. * @type {number}
  16995. * @default 1
  16996. */
  16997. this.wireframeLinewidth = 1;
  16998. /**
  16999. * Defines appearance of wireframe ends.
  17000. *
  17001. * Can only be used with {@link SVGRenderer}.
  17002. *
  17003. * @type {('round'|'bevel'|'miter')}
  17004. * @default 'round'
  17005. */
  17006. this.wireframeLinecap = 'round';
  17007. /**
  17008. * Defines appearance of wireframe joints.
  17009. *
  17010. * Can only be used with {@link SVGRenderer}.
  17011. *
  17012. * @type {('round'|'bevel'|'miter')}
  17013. * @default 'round'
  17014. */
  17015. this.wireframeLinejoin = 'round';
  17016. /**
  17017. * Whether the material is affected by fog or not.
  17018. *
  17019. * @type {boolean}
  17020. * @default true
  17021. */
  17022. this.fog = true;
  17023. this.setValues( parameters );
  17024. }
  17025. copy( source ) {
  17026. super.copy( source );
  17027. this.color.copy( source.color );
  17028. this.map = source.map;
  17029. this.lightMap = source.lightMap;
  17030. this.lightMapIntensity = source.lightMapIntensity;
  17031. this.aoMap = source.aoMap;
  17032. this.aoMapIntensity = source.aoMapIntensity;
  17033. this.specularMap = source.specularMap;
  17034. this.alphaMap = source.alphaMap;
  17035. this.envMap = source.envMap;
  17036. this.envMapRotation.copy( source.envMapRotation );
  17037. this.combine = source.combine;
  17038. this.reflectivity = source.reflectivity;
  17039. this.refractionRatio = source.refractionRatio;
  17040. this.wireframe = source.wireframe;
  17041. this.wireframeLinewidth = source.wireframeLinewidth;
  17042. this.wireframeLinecap = source.wireframeLinecap;
  17043. this.wireframeLinejoin = source.wireframeLinejoin;
  17044. this.fog = source.fog;
  17045. return this;
  17046. }
  17047. }
  17048. const _inverseMatrix$3 = /*@__PURE__*/ new Matrix4();
  17049. const _ray$3 = /*@__PURE__*/ new Ray();
  17050. const _sphere$6 = /*@__PURE__*/ new Sphere();
  17051. const _sphereHitAt = /*@__PURE__*/ new Vector3();
  17052. const _vA = /*@__PURE__*/ new Vector3();
  17053. const _vB = /*@__PURE__*/ new Vector3();
  17054. const _vC = /*@__PURE__*/ new Vector3();
  17055. const _tempA = /*@__PURE__*/ new Vector3();
  17056. const _morphA = /*@__PURE__*/ new Vector3();
  17057. const _intersectionPoint = /*@__PURE__*/ new Vector3();
  17058. const _intersectionPointWorld = /*@__PURE__*/ new Vector3();
  17059. /**
  17060. * Class representing triangular polygon mesh based objects.
  17061. *
  17062. * ```js
  17063. * const geometry = new THREE.BoxGeometry( 1, 1, 1 );
  17064. * const material = new THREE.MeshBasicMaterial( { color: 0xffff00 } );
  17065. * const mesh = new THREE.Mesh( geometry, material );
  17066. * scene.add( mesh );
  17067. * ```
  17068. *
  17069. * @augments Object3D
  17070. */
  17071. class Mesh extends Object3D {
  17072. /**
  17073. * Constructs a new mesh.
  17074. *
  17075. * @param {BufferGeometry} [geometry] - The mesh geometry.
  17076. * @param {Material|Array<Material>} [material] - The mesh material.
  17077. */
  17078. constructor( geometry = new BufferGeometry(), material = new MeshBasicMaterial() ) {
  17079. super();
  17080. /**
  17081. * This flag can be used for type testing.
  17082. *
  17083. * @type {boolean}
  17084. * @readonly
  17085. * @default true
  17086. */
  17087. this.isMesh = true;
  17088. this.type = 'Mesh';
  17089. /**
  17090. * The mesh geometry.
  17091. *
  17092. * @type {BufferGeometry}
  17093. */
  17094. this.geometry = geometry;
  17095. /**
  17096. * The mesh material.
  17097. *
  17098. * @type {Material|Array<Material>}
  17099. * @default MeshBasicMaterial
  17100. */
  17101. this.material = material;
  17102. /**
  17103. * A dictionary representing the morph targets in the geometry. The key is the
  17104. * morph targets name, the value its attribute index. This member is `undefined`
  17105. * by default and only set when morph targets are detected in the geometry.
  17106. *
  17107. * @type {Object<string,number>|undefined}
  17108. * @default undefined
  17109. */
  17110. this.morphTargetDictionary = undefined;
  17111. /**
  17112. * An array of weights typically in the range `[0,1]` that specify how much of the morph
  17113. * is applied. This member is `undefined` by default and only set when morph targets are
  17114. * detected in the geometry.
  17115. *
  17116. * @type {Array<number>|undefined}
  17117. * @default undefined
  17118. */
  17119. this.morphTargetInfluences = undefined;
  17120. /**
  17121. * The number of instances of this mesh.
  17122. * Can only be used with {@link WebGPURenderer}.
  17123. *
  17124. * @type {number}
  17125. * @default 1
  17126. */
  17127. this.count = 1;
  17128. this.updateMorphTargets();
  17129. }
  17130. copy( source, recursive ) {
  17131. super.copy( source, recursive );
  17132. if ( source.morphTargetInfluences !== undefined ) {
  17133. this.morphTargetInfluences = source.morphTargetInfluences.slice();
  17134. }
  17135. if ( source.morphTargetDictionary !== undefined ) {
  17136. this.morphTargetDictionary = Object.assign( {}, source.morphTargetDictionary );
  17137. }
  17138. this.material = Array.isArray( source.material ) ? source.material.slice() : source.material;
  17139. this.geometry = source.geometry;
  17140. return this;
  17141. }
  17142. /**
  17143. * Sets the values of {@link Mesh#morphTargetDictionary} and {@link Mesh#morphTargetInfluences}
  17144. * to make sure existing morph targets can influence this 3D object.
  17145. */
  17146. updateMorphTargets() {
  17147. const geometry = this.geometry;
  17148. const morphAttributes = geometry.morphAttributes;
  17149. const keys = Object.keys( morphAttributes );
  17150. if ( keys.length > 0 ) {
  17151. const morphAttribute = morphAttributes[ keys[ 0 ] ];
  17152. if ( morphAttribute !== undefined ) {
  17153. this.morphTargetInfluences = [];
  17154. this.morphTargetDictionary = {};
  17155. for ( let m = 0, ml = morphAttribute.length; m < ml; m ++ ) {
  17156. const name = morphAttribute[ m ].name || String( m );
  17157. this.morphTargetInfluences.push( 0 );
  17158. this.morphTargetDictionary[ name ] = m;
  17159. }
  17160. }
  17161. }
  17162. }
  17163. /**
  17164. * Returns the local-space position of the vertex at the given index, taking into
  17165. * account the current animation state of both morph targets and skinning.
  17166. *
  17167. * @param {number} index - The vertex index.
  17168. * @param {Vector3} target - The target object that is used to store the method's result.
  17169. * @return {Vector3} The vertex position in local space.
  17170. */
  17171. getVertexPosition( index, target ) {
  17172. const geometry = this.geometry;
  17173. const position = geometry.attributes.position;
  17174. const morphPosition = geometry.morphAttributes.position;
  17175. const morphTargetsRelative = geometry.morphTargetsRelative;
  17176. target.fromBufferAttribute( position, index );
  17177. const morphInfluences = this.morphTargetInfluences;
  17178. if ( morphPosition && morphInfluences ) {
  17179. _morphA.set( 0, 0, 0 );
  17180. for ( let i = 0, il = morphPosition.length; i < il; i ++ ) {
  17181. const influence = morphInfluences[ i ];
  17182. const morphAttribute = morphPosition[ i ];
  17183. if ( influence === 0 ) continue;
  17184. _tempA.fromBufferAttribute( morphAttribute, index );
  17185. if ( morphTargetsRelative ) {
  17186. _morphA.addScaledVector( _tempA, influence );
  17187. } else {
  17188. _morphA.addScaledVector( _tempA.sub( target ), influence );
  17189. }
  17190. }
  17191. target.add( _morphA );
  17192. }
  17193. return target;
  17194. }
  17195. /**
  17196. * Computes intersection points between a casted ray and this line.
  17197. *
  17198. * @param {Raycaster} raycaster - The raycaster.
  17199. * @param {Array<Object>} intersects - The target array that holds the intersection points.
  17200. */
  17201. raycast( raycaster, intersects ) {
  17202. const geometry = this.geometry;
  17203. const material = this.material;
  17204. const matrixWorld = this.matrixWorld;
  17205. if ( material === undefined ) return;
  17206. // test with bounding sphere in world space
  17207. if ( geometry.boundingSphere === null ) geometry.computeBoundingSphere();
  17208. _sphere$6.copy( geometry.boundingSphere );
  17209. _sphere$6.applyMatrix4( matrixWorld );
  17210. // check distance from ray origin to bounding sphere
  17211. _ray$3.copy( raycaster.ray ).recast( raycaster.near );
  17212. if ( _sphere$6.containsPoint( _ray$3.origin ) === false ) {
  17213. if ( _ray$3.intersectSphere( _sphere$6, _sphereHitAt ) === null ) return;
  17214. if ( _ray$3.origin.distanceToSquared( _sphereHitAt ) > ( raycaster.far - raycaster.near ) ** 2 ) return;
  17215. }
  17216. // convert ray to local space of mesh
  17217. _inverseMatrix$3.copy( matrixWorld ).invert();
  17218. _ray$3.copy( raycaster.ray ).applyMatrix4( _inverseMatrix$3 );
  17219. // test with bounding box in local space
  17220. if ( geometry.boundingBox !== null ) {
  17221. if ( _ray$3.intersectsBox( geometry.boundingBox ) === false ) return;
  17222. }
  17223. // test for intersections with geometry
  17224. this._computeIntersections( raycaster, intersects, _ray$3 );
  17225. }
  17226. _computeIntersections( raycaster, intersects, rayLocalSpace ) {
  17227. let intersection;
  17228. const geometry = this.geometry;
  17229. const material = this.material;
  17230. const index = geometry.index;
  17231. const position = geometry.attributes.position;
  17232. const uv = geometry.attributes.uv;
  17233. const uv1 = geometry.attributes.uv1;
  17234. const normal = geometry.attributes.normal;
  17235. const groups = geometry.groups;
  17236. const drawRange = geometry.drawRange;
  17237. if ( index !== null ) {
  17238. // indexed buffer geometry
  17239. if ( Array.isArray( material ) ) {
  17240. for ( let i = 0, il = groups.length; i < il; i ++ ) {
  17241. const group = groups[ i ];
  17242. const groupMaterial = material[ group.materialIndex ];
  17243. const start = Math.max( group.start, drawRange.start );
  17244. const end = Math.min( index.count, Math.min( ( group.start + group.count ), ( drawRange.start + drawRange.count ) ) );
  17245. for ( let j = start, jl = end; j < jl; j += 3 ) {
  17246. const a = index.getX( j );
  17247. const b = index.getX( j + 1 );
  17248. const c = index.getX( j + 2 );
  17249. intersection = checkGeometryIntersection( this, groupMaterial, raycaster, rayLocalSpace, uv, uv1, normal, a, b, c );
  17250. if ( intersection ) {
  17251. intersection.faceIndex = Math.floor( j / 3 ); // triangle number in indexed buffer semantics
  17252. intersection.face.materialIndex = group.materialIndex;
  17253. intersects.push( intersection );
  17254. }
  17255. }
  17256. }
  17257. } else {
  17258. const start = Math.max( 0, drawRange.start );
  17259. const end = Math.min( index.count, ( drawRange.start + drawRange.count ) );
  17260. for ( let i = start, il = end; i < il; i += 3 ) {
  17261. const a = index.getX( i );
  17262. const b = index.getX( i + 1 );
  17263. const c = index.getX( i + 2 );
  17264. intersection = checkGeometryIntersection( this, material, raycaster, rayLocalSpace, uv, uv1, normal, a, b, c );
  17265. if ( intersection ) {
  17266. intersection.faceIndex = Math.floor( i / 3 ); // triangle number in indexed buffer semantics
  17267. intersects.push( intersection );
  17268. }
  17269. }
  17270. }
  17271. } else if ( position !== undefined ) {
  17272. // non-indexed buffer geometry
  17273. if ( Array.isArray( material ) ) {
  17274. for ( let i = 0, il = groups.length; i < il; i ++ ) {
  17275. const group = groups[ i ];
  17276. const groupMaterial = material[ group.materialIndex ];
  17277. const start = Math.max( group.start, drawRange.start );
  17278. const end = Math.min( position.count, Math.min( ( group.start + group.count ), ( drawRange.start + drawRange.count ) ) );
  17279. for ( let j = start, jl = end; j < jl; j += 3 ) {
  17280. const a = j;
  17281. const b = j + 1;
  17282. const c = j + 2;
  17283. intersection = checkGeometryIntersection( this, groupMaterial, raycaster, rayLocalSpace, uv, uv1, normal, a, b, c );
  17284. if ( intersection ) {
  17285. intersection.faceIndex = Math.floor( j / 3 ); // triangle number in non-indexed buffer semantics
  17286. intersection.face.materialIndex = group.materialIndex;
  17287. intersects.push( intersection );
  17288. }
  17289. }
  17290. }
  17291. } else {
  17292. const start = Math.max( 0, drawRange.start );
  17293. const end = Math.min( position.count, ( drawRange.start + drawRange.count ) );
  17294. for ( let i = start, il = end; i < il; i += 3 ) {
  17295. const a = i;
  17296. const b = i + 1;
  17297. const c = i + 2;
  17298. intersection = checkGeometryIntersection( this, material, raycaster, rayLocalSpace, uv, uv1, normal, a, b, c );
  17299. if ( intersection ) {
  17300. intersection.faceIndex = Math.floor( i / 3 ); // triangle number in non-indexed buffer semantics
  17301. intersects.push( intersection );
  17302. }
  17303. }
  17304. }
  17305. }
  17306. }
  17307. }
  17308. function checkIntersection$1( object, material, raycaster, ray, pA, pB, pC, point ) {
  17309. let intersect;
  17310. if ( material.side === BackSide ) {
  17311. intersect = ray.intersectTriangle( pC, pB, pA, true, point );
  17312. } else {
  17313. intersect = ray.intersectTriangle( pA, pB, pC, ( material.side === FrontSide ), point );
  17314. }
  17315. if ( intersect === null ) return null;
  17316. _intersectionPointWorld.copy( point );
  17317. _intersectionPointWorld.applyMatrix4( object.matrixWorld );
  17318. const distance = raycaster.ray.origin.distanceTo( _intersectionPointWorld );
  17319. if ( distance < raycaster.near || distance > raycaster.far ) return null;
  17320. return {
  17321. distance: distance,
  17322. point: _intersectionPointWorld.clone(),
  17323. object: object
  17324. };
  17325. }
  17326. function checkGeometryIntersection( object, material, raycaster, ray, uv, uv1, normal, a, b, c ) {
  17327. object.getVertexPosition( a, _vA );
  17328. object.getVertexPosition( b, _vB );
  17329. object.getVertexPosition( c, _vC );
  17330. const intersection = checkIntersection$1( object, material, raycaster, ray, _vA, _vB, _vC, _intersectionPoint );
  17331. if ( intersection ) {
  17332. const barycoord = new Vector3();
  17333. Triangle.getBarycoord( _intersectionPoint, _vA, _vB, _vC, barycoord );
  17334. if ( uv ) {
  17335. intersection.uv = Triangle.getInterpolatedAttribute( uv, a, b, c, barycoord, new Vector2() );
  17336. }
  17337. if ( uv1 ) {
  17338. intersection.uv1 = Triangle.getInterpolatedAttribute( uv1, a, b, c, barycoord, new Vector2() );
  17339. }
  17340. if ( normal ) {
  17341. intersection.normal = Triangle.getInterpolatedAttribute( normal, a, b, c, barycoord, new Vector3() );
  17342. if ( intersection.normal.dot( ray.direction ) > 0 ) {
  17343. intersection.normal.multiplyScalar( -1 );
  17344. }
  17345. }
  17346. const face = {
  17347. a: a,
  17348. b: b,
  17349. c: c,
  17350. normal: new Vector3(),
  17351. materialIndex: 0
  17352. };
  17353. Triangle.getNormal( _vA, _vB, _vC, face.normal );
  17354. intersection.face = face;
  17355. intersection.barycoord = barycoord;
  17356. }
  17357. return intersection;
  17358. }
  17359. const _basePosition = /*@__PURE__*/ new Vector3();
  17360. const _skinIndex = /*@__PURE__*/ new Vector4();
  17361. const _skinWeight = /*@__PURE__*/ new Vector4();
  17362. const _vector3 = /*@__PURE__*/ new Vector3();
  17363. const _matrix4 = /*@__PURE__*/ new Matrix4();
  17364. const _vertex = /*@__PURE__*/ new Vector3();
  17365. const _sphere$5 = /*@__PURE__*/ new Sphere();
  17366. const _inverseMatrix$2 = /*@__PURE__*/ new Matrix4();
  17367. const _ray$2 = /*@__PURE__*/ new Ray();
  17368. /**
  17369. * A mesh that has a {@link Skeleton} that can then be used to animate the
  17370. * vertices of the geometry with skinning/skeleton animation.
  17371. *
  17372. * Next to a valid skeleton, the skinned mesh requires skin indices and weights
  17373. * as buffer attributes in its geometry. These attribute define which bones affect a single
  17374. * vertex to a certain extend.
  17375. *
  17376. * Typically skinned meshes are not created manually but loaders like {@link GLTFLoader}
  17377. * or {@link FBXLoader } import respective models.
  17378. *
  17379. * @augments Mesh
  17380. * @demo scenes/bones-browser.html
  17381. */
  17382. class SkinnedMesh extends Mesh {
  17383. /**
  17384. * Constructs a new skinned mesh.
  17385. *
  17386. * @param {BufferGeometry} [geometry] - The mesh geometry.
  17387. * @param {Material|Array<Material>} [material] - The mesh material.
  17388. */
  17389. constructor( geometry, material ) {
  17390. super( geometry, material );
  17391. /**
  17392. * This flag can be used for type testing.
  17393. *
  17394. * @type {boolean}
  17395. * @readonly
  17396. * @default true
  17397. */
  17398. this.isSkinnedMesh = true;
  17399. this.type = 'SkinnedMesh';
  17400. /**
  17401. * `AttachedBindMode` means the skinned mesh shares the same world space as the skeleton.
  17402. * This is not true when using `DetachedBindMode` which is useful when sharing a skeleton
  17403. * across multiple skinned meshes.
  17404. *
  17405. * @type {(AttachedBindMode|DetachedBindMode)}
  17406. * @default AttachedBindMode
  17407. */
  17408. this.bindMode = AttachedBindMode;
  17409. /**
  17410. * The base matrix that is used for the bound bone transforms.
  17411. *
  17412. * @type {Matrix4}
  17413. */
  17414. this.bindMatrix = new Matrix4();
  17415. /**
  17416. * The base matrix that is used for resetting the bound bone transforms.
  17417. *
  17418. * @type {Matrix4}
  17419. */
  17420. this.bindMatrixInverse = new Matrix4();
  17421. /**
  17422. * The bounding box of the skinned mesh. Can be computed via {@link SkinnedMesh#computeBoundingBox}.
  17423. *
  17424. * @type {?Box3}
  17425. * @default null
  17426. */
  17427. this.boundingBox = null;
  17428. /**
  17429. * The bounding sphere of the skinned mesh. Can be computed via {@link SkinnedMesh#computeBoundingSphere}.
  17430. *
  17431. * @type {?Sphere}
  17432. * @default null
  17433. */
  17434. this.boundingSphere = null;
  17435. }
  17436. /**
  17437. * Computes the bounding box of the skinned mesh, and updates {@link SkinnedMesh#boundingBox}.
  17438. * The bounding box is not automatically computed by the engine; this method must be called by your app.
  17439. * If the skinned mesh is animated, the bounding box should be recomputed per frame in order to reflect
  17440. * the current animation state.
  17441. */
  17442. computeBoundingBox() {
  17443. const geometry = this.geometry;
  17444. if ( this.boundingBox === null ) {
  17445. this.boundingBox = new Box3();
  17446. }
  17447. this.boundingBox.makeEmpty();
  17448. const positionAttribute = geometry.getAttribute( 'position' );
  17449. for ( let i = 0; i < positionAttribute.count; i ++ ) {
  17450. this.getVertexPosition( i, _vertex );
  17451. this.boundingBox.expandByPoint( _vertex );
  17452. }
  17453. }
  17454. /**
  17455. * Computes the bounding sphere of the skinned mesh, and updates {@link SkinnedMesh#boundingSphere}.
  17456. * The bounding sphere is automatically computed by the engine once when it is needed, e.g., for ray casting
  17457. * and view frustum culling. If the skinned mesh is animated, the bounding sphere should be recomputed
  17458. * per frame in order to reflect the current animation state.
  17459. */
  17460. computeBoundingSphere() {
  17461. const geometry = this.geometry;
  17462. if ( this.boundingSphere === null ) {
  17463. this.boundingSphere = new Sphere();
  17464. }
  17465. this.boundingSphere.makeEmpty();
  17466. const positionAttribute = geometry.getAttribute( 'position' );
  17467. for ( let i = 0; i < positionAttribute.count; i ++ ) {
  17468. this.getVertexPosition( i, _vertex );
  17469. this.boundingSphere.expandByPoint( _vertex );
  17470. }
  17471. }
  17472. copy( source, recursive ) {
  17473. super.copy( source, recursive );
  17474. this.bindMode = source.bindMode;
  17475. this.bindMatrix.copy( source.bindMatrix );
  17476. this.bindMatrixInverse.copy( source.bindMatrixInverse );
  17477. this.skeleton = source.skeleton;
  17478. if ( source.boundingBox !== null ) this.boundingBox = source.boundingBox.clone();
  17479. if ( source.boundingSphere !== null ) this.boundingSphere = source.boundingSphere.clone();
  17480. return this;
  17481. }
  17482. raycast( raycaster, intersects ) {
  17483. const material = this.material;
  17484. const matrixWorld = this.matrixWorld;
  17485. if ( material === undefined ) return;
  17486. // test with bounding sphere in world space
  17487. if ( this.boundingSphere === null ) this.computeBoundingSphere();
  17488. _sphere$5.copy( this.boundingSphere );
  17489. _sphere$5.applyMatrix4( matrixWorld );
  17490. if ( raycaster.ray.intersectsSphere( _sphere$5 ) === false ) return;
  17491. // convert ray to local space of skinned mesh
  17492. _inverseMatrix$2.copy( matrixWorld ).invert();
  17493. _ray$2.copy( raycaster.ray ).applyMatrix4( _inverseMatrix$2 );
  17494. // test with bounding box in local space
  17495. if ( this.boundingBox !== null ) {
  17496. if ( _ray$2.intersectsBox( this.boundingBox ) === false ) return;
  17497. }
  17498. // test for intersections with geometry
  17499. this._computeIntersections( raycaster, intersects, _ray$2 );
  17500. }
  17501. getVertexPosition( index, target ) {
  17502. super.getVertexPosition( index, target );
  17503. this.applyBoneTransform( index, target );
  17504. return target;
  17505. }
  17506. /**
  17507. * Binds the given skeleton to the skinned mesh.
  17508. *
  17509. * @param {Skeleton} skeleton - The skeleton to bind.
  17510. * @param {Matrix4} [bindMatrix] - The bind matrix. If no bind matrix is provided,
  17511. * the skinned mesh's world matrix will be used instead.
  17512. */
  17513. bind( skeleton, bindMatrix ) {
  17514. this.skeleton = skeleton;
  17515. if ( bindMatrix === undefined ) {
  17516. this.updateMatrixWorld( true );
  17517. this.skeleton.calculateInverses();
  17518. bindMatrix = this.matrixWorld;
  17519. }
  17520. this.bindMatrix.copy( bindMatrix );
  17521. this.bindMatrixInverse.copy( bindMatrix ).invert();
  17522. }
  17523. /**
  17524. * This method sets the skinned mesh in the rest pose).
  17525. */
  17526. pose() {
  17527. this.skeleton.pose();
  17528. }
  17529. /**
  17530. * Normalizes the skin weights which are defined as a buffer attribute
  17531. * in the skinned mesh's geometry.
  17532. */
  17533. normalizeSkinWeights() {
  17534. const vector = new Vector4();
  17535. const skinWeight = this.geometry.attributes.skinWeight;
  17536. for ( let i = 0, l = skinWeight.count; i < l; i ++ ) {
  17537. vector.fromBufferAttribute( skinWeight, i );
  17538. const scale = 1.0 / vector.manhattanLength();
  17539. if ( scale !== Infinity ) {
  17540. vector.multiplyScalar( scale );
  17541. } else {
  17542. vector.set( 1, 0, 0, 0 ); // do something reasonable
  17543. }
  17544. skinWeight.setXYZW( i, vector.x, vector.y, vector.z, vector.w );
  17545. }
  17546. }
  17547. updateMatrixWorld( force ) {
  17548. super.updateMatrixWorld( force );
  17549. if ( this.bindMode === AttachedBindMode ) {
  17550. this.bindMatrixInverse.copy( this.matrixWorld ).invert();
  17551. } else if ( this.bindMode === DetachedBindMode ) {
  17552. this.bindMatrixInverse.copy( this.bindMatrix ).invert();
  17553. } else {
  17554. warn( 'SkinnedMesh: Unrecognized bindMode: ' + this.bindMode );
  17555. }
  17556. }
  17557. /**
  17558. * Applies the bone transform associated with the given index to the given
  17559. * vertex position. Returns the updated vector.
  17560. *
  17561. * @param {number} index - The vertex index.
  17562. * @param {Vector3} target - The target object that is used to store the method's result.
  17563. * the skinned mesh's world matrix will be used instead.
  17564. * @return {Vector3} The updated vertex position.
  17565. */
  17566. applyBoneTransform( index, target ) {
  17567. const skeleton = this.skeleton;
  17568. const geometry = this.geometry;
  17569. _skinIndex.fromBufferAttribute( geometry.attributes.skinIndex, index );
  17570. _skinWeight.fromBufferAttribute( geometry.attributes.skinWeight, index );
  17571. _basePosition.copy( target ).applyMatrix4( this.bindMatrix );
  17572. target.set( 0, 0, 0 );
  17573. for ( let i = 0; i < 4; i ++ ) {
  17574. const weight = _skinWeight.getComponent( i );
  17575. if ( weight !== 0 ) {
  17576. const boneIndex = _skinIndex.getComponent( i );
  17577. _matrix4.multiplyMatrices( skeleton.bones[ boneIndex ].matrixWorld, skeleton.boneInverses[ boneIndex ] );
  17578. target.addScaledVector( _vector3.copy( _basePosition ).applyMatrix4( _matrix4 ), weight );
  17579. }
  17580. }
  17581. return target.applyMatrix4( this.bindMatrixInverse );
  17582. }
  17583. }
  17584. /**
  17585. * A bone which is part of a {@link Skeleton}. The skeleton in turn is used by
  17586. * the {@link SkinnedMesh}.
  17587. *
  17588. * ```js
  17589. * const root = new THREE.Bone();
  17590. * const child = new THREE.Bone();
  17591. *
  17592. * root.add( child );
  17593. * child.position.y = 5;
  17594. * ```
  17595. *
  17596. * @augments Object3D
  17597. */
  17598. class Bone extends Object3D {
  17599. /**
  17600. * Constructs a new bone.
  17601. */
  17602. constructor() {
  17603. super();
  17604. /**
  17605. * This flag can be used for type testing.
  17606. *
  17607. * @type {boolean}
  17608. * @readonly
  17609. * @default true
  17610. */
  17611. this.isBone = true;
  17612. this.type = 'Bone';
  17613. }
  17614. }
  17615. /**
  17616. * Creates a texture directly from raw buffer data.
  17617. *
  17618. * The interpretation of the data depends on type and format: If the type is
  17619. * `UnsignedByteType`, a `Uint8Array` will be useful for addressing the
  17620. * texel data. If the format is `RGBAFormat`, data needs four values for
  17621. * one texel; Red, Green, Blue and Alpha (typically the opacity).
  17622. *
  17623. * @augments Texture
  17624. */
  17625. class DataTexture extends Texture {
  17626. /**
  17627. * Constructs a new data texture.
  17628. *
  17629. * @param {?TypedArray} [data=null] - The buffer data.
  17630. * @param {number} [width=1] - The width of the texture.
  17631. * @param {number} [height=1] - The height of the texture.
  17632. * @param {number} [format=RGBAFormat] - The texture format.
  17633. * @param {number} [type=UnsignedByteType] - The texture type.
  17634. * @param {number} [mapping=Texture.DEFAULT_MAPPING] - The texture mapping.
  17635. * @param {number} [wrapS=ClampToEdgeWrapping] - The wrapS value.
  17636. * @param {number} [wrapT=ClampToEdgeWrapping] - The wrapT value.
  17637. * @param {number} [magFilter=NearestFilter] - The mag filter value.
  17638. * @param {number} [minFilter=NearestFilter] - The min filter value.
  17639. * @param {number} [anisotropy=Texture.DEFAULT_ANISOTROPY] - The anisotropy value.
  17640. * @param {string} [colorSpace=NoColorSpace] - The color space.
  17641. */
  17642. constructor( data = null, width = 1, height = 1, format, type, mapping, wrapS, wrapT, magFilter = NearestFilter, minFilter = NearestFilter, anisotropy, colorSpace ) {
  17643. super( null, mapping, wrapS, wrapT, magFilter, minFilter, format, type, anisotropy, colorSpace );
  17644. /**
  17645. * This flag can be used for type testing.
  17646. *
  17647. * @type {boolean}
  17648. * @readonly
  17649. * @default true
  17650. */
  17651. this.isDataTexture = true;
  17652. /**
  17653. * The image definition of a data texture.
  17654. *
  17655. * @type {{data:TypedArray,width:number,height:number}}
  17656. */
  17657. this.image = { data: data, width: width, height: height };
  17658. /**
  17659. * Whether to generate mipmaps (if possible) for a texture.
  17660. *
  17661. * Overwritten and set to `false` by default.
  17662. *
  17663. * @type {boolean}
  17664. * @default false
  17665. */
  17666. this.generateMipmaps = false;
  17667. /**
  17668. * If set to `true`, the texture is flipped along the vertical axis when
  17669. * uploaded to the GPU.
  17670. *
  17671. * Overwritten and set to `false` by default.
  17672. *
  17673. * @type {boolean}
  17674. * @default false
  17675. */
  17676. this.flipY = false;
  17677. /**
  17678. * Specifies the alignment requirements for the start of each pixel row in memory.
  17679. *
  17680. * Overwritten and set to `1` by default.
  17681. *
  17682. * @type {boolean}
  17683. * @default 1
  17684. */
  17685. this.unpackAlignment = 1;
  17686. }
  17687. }
  17688. const _offsetMatrix = /*@__PURE__*/ new Matrix4();
  17689. const _identityMatrix = /*@__PURE__*/ new Matrix4();
  17690. /**
  17691. * Class for representing the armatures in `three.js`. The skeleton
  17692. * is defined by a hierarchy of bones.
  17693. *
  17694. * ```js
  17695. * const bones = [];
  17696. *
  17697. * const shoulder = new THREE.Bone();
  17698. * const elbow = new THREE.Bone();
  17699. * const hand = new THREE.Bone();
  17700. *
  17701. * shoulder.add( elbow );
  17702. * elbow.add( hand );
  17703. *
  17704. * bones.push( shoulder , elbow, hand);
  17705. *
  17706. * shoulder.position.y = -5;
  17707. * elbow.position.y = 0;
  17708. * hand.position.y = 5;
  17709. *
  17710. * const armSkeleton = new THREE.Skeleton( bones );
  17711. * ```
  17712. */
  17713. class Skeleton {
  17714. /**
  17715. * Constructs a new skeleton.
  17716. *
  17717. * @param {Array<Bone>} [bones] - An array of bones.
  17718. * @param {Array<Matrix4>} [boneInverses] - An array of bone inverse matrices.
  17719. * If not provided, these matrices will be computed automatically via {@link Skeleton#calculateInverses}.
  17720. */
  17721. constructor( bones = [], boneInverses = [] ) {
  17722. this.uuid = generateUUID();
  17723. /**
  17724. * An array of bones defining the skeleton.
  17725. *
  17726. * @type {Array<Bone>}
  17727. */
  17728. this.bones = bones.slice( 0 );
  17729. /**
  17730. * An array of bone inverse matrices.
  17731. *
  17732. * @type {Array<Matrix4>}
  17733. */
  17734. this.boneInverses = boneInverses;
  17735. /**
  17736. * An array buffer holding the bone data.
  17737. * Input data for {@link Skeleton#boneTexture}.
  17738. *
  17739. * @type {?Float32Array}
  17740. * @default null
  17741. */
  17742. this.boneMatrices = null;
  17743. /**
  17744. * An array buffer holding the bone data of the previous frame.
  17745. * Required for computing velocity. Maintained in {@link SkinningNode}.
  17746. *
  17747. * @type {?Float32Array}
  17748. * @default null
  17749. */
  17750. this.previousBoneMatrices = null;
  17751. /**
  17752. * A texture holding the bone data for use
  17753. * in the vertex shader.
  17754. *
  17755. * @type {?DataTexture}
  17756. * @default null
  17757. */
  17758. this.boneTexture = null;
  17759. this.init();
  17760. }
  17761. /**
  17762. * Initializes the skeleton. This method gets automatically called by the constructor
  17763. * but depending on how the skeleton is created it might be necessary to call this method
  17764. * manually.
  17765. */
  17766. init() {
  17767. const bones = this.bones;
  17768. const boneInverses = this.boneInverses;
  17769. this.boneMatrices = new Float32Array( bones.length * 16 );
  17770. // calculate inverse bone matrices if necessary
  17771. if ( boneInverses.length === 0 ) {
  17772. this.calculateInverses();
  17773. } else {
  17774. // handle special case
  17775. if ( bones.length !== boneInverses.length ) {
  17776. warn( 'Skeleton: Number of inverse bone matrices does not match amount of bones.' );
  17777. this.boneInverses = [];
  17778. for ( let i = 0, il = this.bones.length; i < il; i ++ ) {
  17779. this.boneInverses.push( new Matrix4() );
  17780. }
  17781. }
  17782. }
  17783. }
  17784. /**
  17785. * Computes the bone inverse matrices. This method resets {@link Skeleton#boneInverses}
  17786. * and fills it with new matrices.
  17787. */
  17788. calculateInverses() {
  17789. this.boneInverses.length = 0;
  17790. for ( let i = 0, il = this.bones.length; i < il; i ++ ) {
  17791. const inverse = new Matrix4();
  17792. if ( this.bones[ i ] ) {
  17793. inverse.copy( this.bones[ i ].matrixWorld ).invert();
  17794. }
  17795. this.boneInverses.push( inverse );
  17796. }
  17797. }
  17798. /**
  17799. * Resets the skeleton to the base pose.
  17800. */
  17801. pose() {
  17802. // recover the bind-time world matrices
  17803. for ( let i = 0, il = this.bones.length; i < il; i ++ ) {
  17804. const bone = this.bones[ i ];
  17805. if ( bone ) {
  17806. bone.matrixWorld.copy( this.boneInverses[ i ] ).invert();
  17807. }
  17808. }
  17809. // compute the local matrices, positions, rotations and scales
  17810. for ( let i = 0, il = this.bones.length; i < il; i ++ ) {
  17811. const bone = this.bones[ i ];
  17812. if ( bone ) {
  17813. if ( bone.parent && bone.parent.isBone ) {
  17814. bone.matrix.copy( bone.parent.matrixWorld ).invert();
  17815. bone.matrix.multiply( bone.matrixWorld );
  17816. } else {
  17817. bone.matrix.copy( bone.matrixWorld );
  17818. }
  17819. bone.matrix.decompose( bone.position, bone.quaternion, bone.scale );
  17820. }
  17821. }
  17822. }
  17823. /**
  17824. * Resets the skeleton to the base pose.
  17825. */
  17826. update() {
  17827. const bones = this.bones;
  17828. const boneInverses = this.boneInverses;
  17829. const boneMatrices = this.boneMatrices;
  17830. const boneTexture = this.boneTexture;
  17831. // flatten bone matrices to array
  17832. for ( let i = 0, il = bones.length; i < il; i ++ ) {
  17833. // compute the offset between the current and the original transform
  17834. const matrix = bones[ i ] ? bones[ i ].matrixWorld : _identityMatrix;
  17835. _offsetMatrix.multiplyMatrices( matrix, boneInverses[ i ] );
  17836. _offsetMatrix.toArray( boneMatrices, i * 16 );
  17837. }
  17838. if ( boneTexture !== null ) {
  17839. boneTexture.needsUpdate = true;
  17840. }
  17841. }
  17842. /**
  17843. * Returns a new skeleton with copied values from this instance.
  17844. *
  17845. * @return {Skeleton} A clone of this instance.
  17846. */
  17847. clone() {
  17848. return new Skeleton( this.bones, this.boneInverses );
  17849. }
  17850. /**
  17851. * Computes a data texture for passing bone data to the vertex shader.
  17852. *
  17853. * @return {Skeleton} A reference of this instance.
  17854. */
  17855. computeBoneTexture() {
  17856. // layout (1 matrix = 4 pixels)
  17857. // RGBA RGBA RGBA RGBA (=> column1, column2, column3, column4)
  17858. // with 8x8 pixel texture max 16 bones * 4 pixels = (8 * 8)
  17859. // 16x16 pixel texture max 64 bones * 4 pixels = (16 * 16)
  17860. // 32x32 pixel texture max 256 bones * 4 pixels = (32 * 32)
  17861. // 64x64 pixel texture max 1024 bones * 4 pixels = (64 * 64)
  17862. let size = Math.sqrt( this.bones.length * 4 ); // 4 pixels needed for 1 matrix
  17863. size = Math.ceil( size / 4 ) * 4;
  17864. size = Math.max( size, 4 );
  17865. const boneMatrices = new Float32Array( size * size * 4 ); // 4 floats per RGBA pixel
  17866. boneMatrices.set( this.boneMatrices ); // copy current values
  17867. const boneTexture = new DataTexture( boneMatrices, size, size, RGBAFormat, FloatType );
  17868. boneTexture.needsUpdate = true;
  17869. this.boneMatrices = boneMatrices;
  17870. this.boneTexture = boneTexture;
  17871. return this;
  17872. }
  17873. /**
  17874. * Searches through the skeleton's bone array and returns the first with a
  17875. * matching name.
  17876. *
  17877. * @param {string} name - The name of the bone.
  17878. * @return {Bone|undefined} The found bone. `undefined` if no bone has been found.
  17879. */
  17880. getBoneByName( name ) {
  17881. for ( let i = 0, il = this.bones.length; i < il; i ++ ) {
  17882. const bone = this.bones[ i ];
  17883. if ( bone.name === name ) {
  17884. return bone;
  17885. }
  17886. }
  17887. return undefined;
  17888. }
  17889. /**
  17890. * Frees the GPU-related resources allocated by this instance. Call this
  17891. * method whenever this instance is no longer used in your app.
  17892. */
  17893. dispose( ) {
  17894. if ( this.boneTexture !== null ) {
  17895. this.boneTexture.dispose();
  17896. this.boneTexture = null;
  17897. }
  17898. }
  17899. /**
  17900. * Setups the skeleton by the given JSON and bones.
  17901. *
  17902. * @param {Object} json - The skeleton as serialized JSON.
  17903. * @param {Object<string, Bone>} bones - An array of bones.
  17904. * @return {Skeleton} A reference of this instance.
  17905. */
  17906. fromJSON( json, bones ) {
  17907. this.uuid = json.uuid;
  17908. for ( let i = 0, l = json.bones.length; i < l; i ++ ) {
  17909. const uuid = json.bones[ i ];
  17910. let bone = bones[ uuid ];
  17911. if ( bone === undefined ) {
  17912. warn( 'Skeleton: No bone found with UUID:', uuid );
  17913. bone = new Bone();
  17914. }
  17915. this.bones.push( bone );
  17916. this.boneInverses.push( new Matrix4().fromArray( json.boneInverses[ i ] ) );
  17917. }
  17918. this.init();
  17919. return this;
  17920. }
  17921. /**
  17922. * Serializes the skeleton into JSON.
  17923. *
  17924. * @return {Object} A JSON object representing the serialized skeleton.
  17925. * @see {@link ObjectLoader#parse}
  17926. */
  17927. toJSON() {
  17928. const data = {
  17929. metadata: {
  17930. version: 4.7,
  17931. type: 'Skeleton',
  17932. generator: 'Skeleton.toJSON'
  17933. },
  17934. bones: [],
  17935. boneInverses: []
  17936. };
  17937. data.uuid = this.uuid;
  17938. const bones = this.bones;
  17939. const boneInverses = this.boneInverses;
  17940. for ( let i = 0, l = bones.length; i < l; i ++ ) {
  17941. const bone = bones[ i ];
  17942. data.bones.push( bone.uuid );
  17943. const boneInverse = boneInverses[ i ];
  17944. data.boneInverses.push( boneInverse.toArray() );
  17945. }
  17946. return data;
  17947. }
  17948. }
  17949. /**
  17950. * An instanced version of a buffer attribute.
  17951. *
  17952. * @augments BufferAttribute
  17953. */
  17954. class InstancedBufferAttribute extends BufferAttribute {
  17955. /**
  17956. * Constructs a new instanced buffer attribute.
  17957. *
  17958. * @param {TypedArray} array - The array holding the attribute data.
  17959. * @param {number} itemSize - The item size.
  17960. * @param {boolean} [normalized=false] - Whether the data are normalized or not.
  17961. * @param {number} [meshPerAttribute=1] - How often a value of this buffer attribute should be repeated.
  17962. */
  17963. constructor( array, itemSize, normalized, meshPerAttribute = 1 ) {
  17964. super( array, itemSize, normalized );
  17965. /**
  17966. * This flag can be used for type testing.
  17967. *
  17968. * @type {boolean}
  17969. * @readonly
  17970. * @default true
  17971. */
  17972. this.isInstancedBufferAttribute = true;
  17973. /**
  17974. * Defines how often a value of this buffer attribute should be repeated. A
  17975. * value of one means that each value of the instanced attribute is used for
  17976. * a single instance. A value of two means that each value is used for two
  17977. * consecutive instances (and so on).
  17978. *
  17979. * @type {number}
  17980. * @default 1
  17981. */
  17982. this.meshPerAttribute = meshPerAttribute;
  17983. }
  17984. copy( source ) {
  17985. super.copy( source );
  17986. this.meshPerAttribute = source.meshPerAttribute;
  17987. return this;
  17988. }
  17989. toJSON() {
  17990. const data = super.toJSON();
  17991. data.meshPerAttribute = this.meshPerAttribute;
  17992. data.isInstancedBufferAttribute = true;
  17993. return data;
  17994. }
  17995. }
  17996. const _instanceLocalMatrix = /*@__PURE__*/ new Matrix4();
  17997. const _instanceWorldMatrix = /*@__PURE__*/ new Matrix4();
  17998. const _instanceIntersects = [];
  17999. const _box3 = /*@__PURE__*/ new Box3();
  18000. const _identity = /*@__PURE__*/ new Matrix4();
  18001. const _mesh$1 = /*@__PURE__*/ new Mesh();
  18002. const _sphere$4 = /*@__PURE__*/ new Sphere();
  18003. /**
  18004. * A special version of a mesh with instanced rendering support. Use
  18005. * this class if you have to render a large number of objects with the same
  18006. * geometry and material(s) but with different world transformations. The usage
  18007. * of 'InstancedMesh' will help you to reduce the number of draw calls and thus
  18008. * improve the overall rendering performance in your application.
  18009. *
  18010. * @augments Mesh
  18011. */
  18012. class InstancedMesh extends Mesh {
  18013. /**
  18014. * Constructs a new instanced mesh.
  18015. *
  18016. * @param {BufferGeometry} [geometry] - The mesh geometry.
  18017. * @param {Material|Array<Material>} [material] - The mesh material.
  18018. * @param {number} count - The number of instances.
  18019. */
  18020. constructor( geometry, material, count ) {
  18021. super( geometry, material );
  18022. /**
  18023. * This flag can be used for type testing.
  18024. *
  18025. * @type {boolean}
  18026. * @readonly
  18027. * @default true
  18028. */
  18029. this.isInstancedMesh = true;
  18030. /**
  18031. * Represents the local transformation of all instances. You have to set its
  18032. * {@link BufferAttribute#needsUpdate} flag to true if you modify instanced data
  18033. * via {@link InstancedMesh#setMatrixAt}.
  18034. *
  18035. * @type {InstancedBufferAttribute}
  18036. */
  18037. this.instanceMatrix = new InstancedBufferAttribute( new Float32Array( count * 16 ), 16 );
  18038. /**
  18039. * Represents the local transformation of all instances of the previous frame.
  18040. * Required for computing velocity. Maintained in {@link InstanceNode}.
  18041. *
  18042. * @type {?InstancedBufferAttribute}
  18043. * @default null
  18044. */
  18045. this.previousInstanceMatrix = null;
  18046. /**
  18047. * Represents the color of all instances. You have to set its
  18048. * {@link BufferAttribute#needsUpdate} flag to true if you modify instanced data
  18049. * via {@link InstancedMesh#setColorAt}.
  18050. *
  18051. * @type {?InstancedBufferAttribute}
  18052. * @default null
  18053. */
  18054. this.instanceColor = null;
  18055. /**
  18056. * Represents the morph target weights of all instances. You have to set its
  18057. * {@link Texture#needsUpdate} flag to true if you modify instanced data
  18058. * via {@link InstancedMesh#setMorphAt}.
  18059. *
  18060. * @type {?DataTexture}
  18061. * @default null
  18062. */
  18063. this.morphTexture = null;
  18064. /**
  18065. * The number of instances.
  18066. *
  18067. * @type {number}
  18068. */
  18069. this.count = count;
  18070. /**
  18071. * The bounding box of the instanced mesh. Can be computed via {@link InstancedMesh#computeBoundingBox}.
  18072. *
  18073. * @type {?Box3}
  18074. * @default null
  18075. */
  18076. this.boundingBox = null;
  18077. /**
  18078. * The bounding sphere of the instanced mesh. Can be computed via {@link InstancedMesh#computeBoundingSphere}.
  18079. *
  18080. * @type {?Sphere}
  18081. * @default null
  18082. */
  18083. this.boundingSphere = null;
  18084. for ( let i = 0; i < count; i ++ ) {
  18085. this.setMatrixAt( i, _identity );
  18086. }
  18087. }
  18088. /**
  18089. * Computes the bounding box of the instanced mesh, and updates {@link InstancedMesh#boundingBox}.
  18090. * The bounding box is not automatically computed by the engine; this method must be called by your app.
  18091. * You may need to recompute the bounding box if an instance is transformed via {@link InstancedMesh#setMatrixAt}.
  18092. */
  18093. computeBoundingBox() {
  18094. const geometry = this.geometry;
  18095. const count = this.count;
  18096. if ( this.boundingBox === null ) {
  18097. this.boundingBox = new Box3();
  18098. }
  18099. if ( geometry.boundingBox === null ) {
  18100. geometry.computeBoundingBox();
  18101. }
  18102. this.boundingBox.makeEmpty();
  18103. for ( let i = 0; i < count; i ++ ) {
  18104. this.getMatrixAt( i, _instanceLocalMatrix );
  18105. _box3.copy( geometry.boundingBox ).applyMatrix4( _instanceLocalMatrix );
  18106. this.boundingBox.union( _box3 );
  18107. }
  18108. }
  18109. /**
  18110. * Computes the bounding sphere of the instanced mesh, and updates {@link InstancedMesh#boundingSphere}
  18111. * The engine automatically computes the bounding sphere when it is needed, e.g., for ray casting or view frustum culling.
  18112. * You may need to recompute the bounding sphere if an instance is transformed via {@link InstancedMesh#setMatrixAt}.
  18113. */
  18114. computeBoundingSphere() {
  18115. const geometry = this.geometry;
  18116. const count = this.count;
  18117. if ( this.boundingSphere === null ) {
  18118. this.boundingSphere = new Sphere();
  18119. }
  18120. if ( geometry.boundingSphere === null ) {
  18121. geometry.computeBoundingSphere();
  18122. }
  18123. this.boundingSphere.makeEmpty();
  18124. for ( let i = 0; i < count; i ++ ) {
  18125. this.getMatrixAt( i, _instanceLocalMatrix );
  18126. _sphere$4.copy( geometry.boundingSphere ).applyMatrix4( _instanceLocalMatrix );
  18127. this.boundingSphere.union( _sphere$4 );
  18128. }
  18129. }
  18130. copy( source, recursive ) {
  18131. super.copy( source, recursive );
  18132. this.instanceMatrix.copy( source.instanceMatrix );
  18133. if ( source.previousInstanceMatrix !== null ) this.previousInstanceMatrix = source.previousInstanceMatrix.clone();
  18134. if ( source.morphTexture !== null ) this.morphTexture = source.morphTexture.clone();
  18135. if ( source.instanceColor !== null ) this.instanceColor = source.instanceColor.clone();
  18136. this.count = source.count;
  18137. if ( source.boundingBox !== null ) this.boundingBox = source.boundingBox.clone();
  18138. if ( source.boundingSphere !== null ) this.boundingSphere = source.boundingSphere.clone();
  18139. return this;
  18140. }
  18141. /**
  18142. * Gets the color of the defined instance.
  18143. *
  18144. * @param {number} index - The instance index.
  18145. * @param {Color} color - The target object that is used to store the method's result.
  18146. */
  18147. getColorAt( index, color ) {
  18148. color.fromArray( this.instanceColor.array, index * 3 );
  18149. }
  18150. /**
  18151. * Gets the local transformation matrix of the defined instance.
  18152. *
  18153. * @param {number} index - The instance index.
  18154. * @param {Matrix4} matrix - The target object that is used to store the method's result.
  18155. */
  18156. getMatrixAt( index, matrix ) {
  18157. matrix.fromArray( this.instanceMatrix.array, index * 16 );
  18158. }
  18159. /**
  18160. * Gets the morph target weights of the defined instance.
  18161. *
  18162. * @param {number} index - The instance index.
  18163. * @param {Mesh} object - The target object that is used to store the method's result.
  18164. */
  18165. getMorphAt( index, object ) {
  18166. const objectInfluences = object.morphTargetInfluences;
  18167. const array = this.morphTexture.source.data.data;
  18168. const len = objectInfluences.length + 1; // All influences + the baseInfluenceSum
  18169. const dataIndex = index * len + 1; // Skip the baseInfluenceSum at the beginning
  18170. for ( let i = 0; i < objectInfluences.length; i ++ ) {
  18171. objectInfluences[ i ] = array[ dataIndex + i ];
  18172. }
  18173. }
  18174. raycast( raycaster, intersects ) {
  18175. const matrixWorld = this.matrixWorld;
  18176. const raycastTimes = this.count;
  18177. _mesh$1.geometry = this.geometry;
  18178. _mesh$1.material = this.material;
  18179. if ( _mesh$1.material === undefined ) return;
  18180. // test with bounding sphere first
  18181. if ( this.boundingSphere === null ) this.computeBoundingSphere();
  18182. _sphere$4.copy( this.boundingSphere );
  18183. _sphere$4.applyMatrix4( matrixWorld );
  18184. if ( raycaster.ray.intersectsSphere( _sphere$4 ) === false ) return;
  18185. // now test each instance
  18186. for ( let instanceId = 0; instanceId < raycastTimes; instanceId ++ ) {
  18187. // calculate the world matrix for each instance
  18188. this.getMatrixAt( instanceId, _instanceLocalMatrix );
  18189. _instanceWorldMatrix.multiplyMatrices( matrixWorld, _instanceLocalMatrix );
  18190. // the mesh represents this single instance
  18191. _mesh$1.matrixWorld = _instanceWorldMatrix;
  18192. _mesh$1.raycast( raycaster, _instanceIntersects );
  18193. // process the result of raycast
  18194. for ( let i = 0, l = _instanceIntersects.length; i < l; i ++ ) {
  18195. const intersect = _instanceIntersects[ i ];
  18196. intersect.instanceId = instanceId;
  18197. intersect.object = this;
  18198. intersects.push( intersect );
  18199. }
  18200. _instanceIntersects.length = 0;
  18201. }
  18202. }
  18203. /**
  18204. * Sets the given color to the defined instance. Make sure you set the `needsUpdate` flag of
  18205. * {@link InstancedMesh#instanceColor} to `true` after updating all the colors.
  18206. *
  18207. * @param {number} index - The instance index.
  18208. * @param {Color} color - The instance color.
  18209. */
  18210. setColorAt( index, color ) {
  18211. if ( this.instanceColor === null ) {
  18212. this.instanceColor = new InstancedBufferAttribute( new Float32Array( this.instanceMatrix.count * 3 ).fill( 1 ), 3 );
  18213. }
  18214. color.toArray( this.instanceColor.array, index * 3 );
  18215. }
  18216. /**
  18217. * Sets the given local transformation matrix to the defined instance. Make sure you set the `needsUpdate` flag of
  18218. * {@link InstancedMesh#instanceMatrix} to `true` after updating all the colors.
  18219. *
  18220. * @param {number} index - The instance index.
  18221. * @param {Matrix4} matrix - The local transformation.
  18222. */
  18223. setMatrixAt( index, matrix ) {
  18224. matrix.toArray( this.instanceMatrix.array, index * 16 );
  18225. }
  18226. /**
  18227. * Sets the morph target weights to the defined instance. Make sure you set the `needsUpdate` flag of
  18228. * {@link InstancedMesh#morphTexture} to `true` after updating all the influences.
  18229. *
  18230. * @param {number} index - The instance index.
  18231. * @param {Mesh} object - A mesh which `morphTargetInfluences` property containing the morph target weights
  18232. * of a single instance.
  18233. */
  18234. setMorphAt( index, object ) {
  18235. const objectInfluences = object.morphTargetInfluences;
  18236. const len = objectInfluences.length + 1; // morphBaseInfluence + all influences
  18237. if ( this.morphTexture === null ) {
  18238. this.morphTexture = new DataTexture( new Float32Array( len * this.count ), len, this.count, RedFormat, FloatType );
  18239. }
  18240. const array = this.morphTexture.source.data.data;
  18241. let morphInfluencesSum = 0;
  18242. for ( let i = 0; i < objectInfluences.length; i ++ ) {
  18243. morphInfluencesSum += objectInfluences[ i ];
  18244. }
  18245. const morphBaseInfluence = this.geometry.morphTargetsRelative ? 1 : 1 - morphInfluencesSum;
  18246. const dataIndex = len * index;
  18247. array[ dataIndex ] = morphBaseInfluence;
  18248. array.set( objectInfluences, dataIndex + 1 );
  18249. }
  18250. updateMorphTargets() {
  18251. }
  18252. /**
  18253. * Frees the GPU-related resources allocated by this instance. Call this
  18254. * method whenever this instance is no longer used in your app.
  18255. */
  18256. dispose() {
  18257. this.dispatchEvent( { type: 'dispose' } );
  18258. if ( this.morphTexture !== null ) {
  18259. this.morphTexture.dispose();
  18260. this.morphTexture = null;
  18261. }
  18262. }
  18263. }
  18264. const _vector1 = /*@__PURE__*/ new Vector3();
  18265. const _vector2 = /*@__PURE__*/ new Vector3();
  18266. const _normalMatrix = /*@__PURE__*/ new Matrix3();
  18267. /**
  18268. * A two dimensional surface that extends infinitely in 3D space, represented
  18269. * in [Hessian normal form](http://mathworld.wolfram.com/HessianNormalForm.html)
  18270. * by a unit length normal vector and a constant.
  18271. */
  18272. class Plane {
  18273. /**
  18274. * Constructs a new plane.
  18275. *
  18276. * @param {Vector3} [normal=(1,0,0)] - A unit length vector defining the normal of the plane.
  18277. * @param {number} [constant=0] - The signed distance from the origin to the plane.
  18278. */
  18279. constructor( normal = new Vector3( 1, 0, 0 ), constant = 0 ) {
  18280. /**
  18281. * This flag can be used for type testing.
  18282. *
  18283. * @type {boolean}
  18284. * @readonly
  18285. * @default true
  18286. */
  18287. this.isPlane = true;
  18288. /**
  18289. * A unit length vector defining the normal of the plane.
  18290. *
  18291. * @type {Vector3}
  18292. */
  18293. this.normal = normal;
  18294. /**
  18295. * The signed distance from the origin to the plane.
  18296. *
  18297. * @type {number}
  18298. * @default 0
  18299. */
  18300. this.constant = constant;
  18301. }
  18302. /**
  18303. * Sets the plane components by copying the given values.
  18304. *
  18305. * @param {Vector3} normal - The normal.
  18306. * @param {number} constant - The constant.
  18307. * @return {Plane} A reference to this plane.
  18308. */
  18309. set( normal, constant ) {
  18310. this.normal.copy( normal );
  18311. this.constant = constant;
  18312. return this;
  18313. }
  18314. /**
  18315. * Sets the plane components by defining `x`, `y`, `z` as the
  18316. * plane normal and `w` as the constant.
  18317. *
  18318. * @param {number} x - The value for the normal's x component.
  18319. * @param {number} y - The value for the normal's y component.
  18320. * @param {number} z - The value for the normal's z component.
  18321. * @param {number} w - The constant value.
  18322. * @return {Plane} A reference to this plane.
  18323. */
  18324. setComponents( x, y, z, w ) {
  18325. this.normal.set( x, y, z );
  18326. this.constant = w;
  18327. return this;
  18328. }
  18329. /**
  18330. * Sets the plane from the given normal and coplanar point (that is a point
  18331. * that lies onto the plane).
  18332. *
  18333. * @param {Vector3} normal - The normal.
  18334. * @param {Vector3} point - A coplanar point.
  18335. * @return {Plane} A reference to this plane.
  18336. */
  18337. setFromNormalAndCoplanarPoint( normal, point ) {
  18338. this.normal.copy( normal );
  18339. this.constant = - point.dot( this.normal );
  18340. return this;
  18341. }
  18342. /**
  18343. * Sets the plane from three coplanar points. The winding order is
  18344. * assumed to be counter-clockwise, and determines the direction of
  18345. * the plane normal.
  18346. *
  18347. * @param {Vector3} a - The first coplanar point.
  18348. * @param {Vector3} b - The second coplanar point.
  18349. * @param {Vector3} c - The third coplanar point.
  18350. * @return {Plane} A reference to this plane.
  18351. */
  18352. setFromCoplanarPoints( a, b, c ) {
  18353. const normal = _vector1.subVectors( c, b ).cross( _vector2.subVectors( a, b ) ).normalize();
  18354. // Q: should an error be thrown if normal is zero (e.g. degenerate plane)?
  18355. this.setFromNormalAndCoplanarPoint( normal, a );
  18356. return this;
  18357. }
  18358. /**
  18359. * Copies the values of the given plane to this instance.
  18360. *
  18361. * @param {Plane} plane - The plane to copy.
  18362. * @return {Plane} A reference to this plane.
  18363. */
  18364. copy( plane ) {
  18365. this.normal.copy( plane.normal );
  18366. this.constant = plane.constant;
  18367. return this;
  18368. }
  18369. /**
  18370. * Normalizes the plane normal and adjusts the constant accordingly.
  18371. *
  18372. * @return {Plane} A reference to this plane.
  18373. */
  18374. normalize() {
  18375. // Note: will lead to a divide by zero if the plane is invalid.
  18376. const inverseNormalLength = 1.0 / this.normal.length();
  18377. this.normal.multiplyScalar( inverseNormalLength );
  18378. this.constant *= inverseNormalLength;
  18379. return this;
  18380. }
  18381. /**
  18382. * Negates both the plane normal and the constant.
  18383. *
  18384. * @return {Plane} A reference to this plane.
  18385. */
  18386. negate() {
  18387. this.constant *= -1;
  18388. this.normal.negate();
  18389. return this;
  18390. }
  18391. /**
  18392. * Returns the signed distance from the given point to this plane.
  18393. *
  18394. * @param {Vector3} point - The point to compute the distance for.
  18395. * @return {number} The signed distance.
  18396. */
  18397. distanceToPoint( point ) {
  18398. return this.normal.dot( point ) + this.constant;
  18399. }
  18400. /**
  18401. * Returns the signed distance from the given sphere to this plane.
  18402. *
  18403. * @param {Sphere} sphere - The sphere to compute the distance for.
  18404. * @return {number} The signed distance.
  18405. */
  18406. distanceToSphere( sphere ) {
  18407. return this.distanceToPoint( sphere.center ) - sphere.radius;
  18408. }
  18409. /**
  18410. * Projects a the given point onto the plane.
  18411. *
  18412. * @param {Vector3} point - The point to project.
  18413. * @param {Vector3} target - The target vector that is used to store the method's result.
  18414. * @return {Vector3} The projected point on the plane.
  18415. */
  18416. projectPoint( point, target ) {
  18417. return target.copy( point ).addScaledVector( this.normal, - this.distanceToPoint( point ) );
  18418. }
  18419. /**
  18420. * Returns the intersection point of the passed line and the plane. Returns
  18421. * `null` if the line does not intersect. Returns the line's starting point if
  18422. * the line is coplanar with the plane.
  18423. *
  18424. * @param {Line3} line - The line to compute the intersection for.
  18425. * @param {Vector3} target - The target vector that is used to store the method's result.
  18426. * @return {?Vector3} The intersection point.
  18427. */
  18428. intersectLine( line, target ) {
  18429. const direction = line.delta( _vector1 );
  18430. const denominator = this.normal.dot( direction );
  18431. if ( denominator === 0 ) {
  18432. // line is coplanar, return origin
  18433. if ( this.distanceToPoint( line.start ) === 0 ) {
  18434. return target.copy( line.start );
  18435. }
  18436. // Unsure if this is the correct method to handle this case.
  18437. return null;
  18438. }
  18439. const t = - ( line.start.dot( this.normal ) + this.constant ) / denominator;
  18440. if ( t < 0 || t > 1 ) {
  18441. return null;
  18442. }
  18443. return target.copy( line.start ).addScaledVector( direction, t );
  18444. }
  18445. /**
  18446. * Returns `true` if the given line segment intersects with (passes through) the plane.
  18447. *
  18448. * @param {Line3} line - The line to test.
  18449. * @return {boolean} Whether the given line segment intersects with the plane or not.
  18450. */
  18451. intersectsLine( line ) {
  18452. // Note: this tests if a line intersects the plane, not whether it (or its end-points) are coplanar with it.
  18453. const startSign = this.distanceToPoint( line.start );
  18454. const endSign = this.distanceToPoint( line.end );
  18455. return ( startSign < 0 && endSign > 0 ) || ( endSign < 0 && startSign > 0 );
  18456. }
  18457. /**
  18458. * Returns `true` if the given bounding box intersects with the plane.
  18459. *
  18460. * @param {Box3} box - The bounding box to test.
  18461. * @return {boolean} Whether the given bounding box intersects with the plane or not.
  18462. */
  18463. intersectsBox( box ) {
  18464. return box.intersectsPlane( this );
  18465. }
  18466. /**
  18467. * Returns `true` if the given bounding sphere intersects with the plane.
  18468. *
  18469. * @param {Sphere} sphere - The bounding sphere to test.
  18470. * @return {boolean} Whether the given bounding sphere intersects with the plane or not.
  18471. */
  18472. intersectsSphere( sphere ) {
  18473. return sphere.intersectsPlane( this );
  18474. }
  18475. /**
  18476. * Returns a coplanar vector to the plane, by calculating the
  18477. * projection of the normal at the origin onto the plane.
  18478. *
  18479. * @param {Vector3} target - The target vector that is used to store the method's result.
  18480. * @return {Vector3} The coplanar point.
  18481. */
  18482. coplanarPoint( target ) {
  18483. return target.copy( this.normal ).multiplyScalar( - this.constant );
  18484. }
  18485. /**
  18486. * Apply a 4x4 matrix to the plane. The matrix must be an affine, homogeneous transform.
  18487. *
  18488. * The optional normal matrix can be pre-computed like so:
  18489. * ```js
  18490. * const optionalNormalMatrix = new THREE.Matrix3().getNormalMatrix( matrix );
  18491. * ```
  18492. *
  18493. * @param {Matrix4} matrix - The transformation matrix.
  18494. * @param {Matrix4} [optionalNormalMatrix] - A pre-computed normal matrix.
  18495. * @return {Plane} A reference to this plane.
  18496. */
  18497. applyMatrix4( matrix, optionalNormalMatrix ) {
  18498. const normalMatrix = optionalNormalMatrix || _normalMatrix.getNormalMatrix( matrix );
  18499. const referencePoint = this.coplanarPoint( _vector1 ).applyMatrix4( matrix );
  18500. const normal = this.normal.applyMatrix3( normalMatrix ).normalize();
  18501. this.constant = - referencePoint.dot( normal );
  18502. return this;
  18503. }
  18504. /**
  18505. * Translates the plane by the distance defined by the given offset vector.
  18506. * Note that this only affects the plane constant and will not affect the normal vector.
  18507. *
  18508. * @param {Vector3} offset - The offset vector.
  18509. * @return {Plane} A reference to this plane.
  18510. */
  18511. translate( offset ) {
  18512. this.constant -= offset.dot( this.normal );
  18513. return this;
  18514. }
  18515. /**
  18516. * Returns `true` if this plane is equal with the given one.
  18517. *
  18518. * @param {Plane} plane - The plane to test for equality.
  18519. * @return {boolean} Whether this plane is equal with the given one.
  18520. */
  18521. equals( plane ) {
  18522. return plane.normal.equals( this.normal ) && ( plane.constant === this.constant );
  18523. }
  18524. /**
  18525. * Returns a new plane with copied values from this instance.
  18526. *
  18527. * @return {Plane} A clone of this instance.
  18528. */
  18529. clone() {
  18530. return new this.constructor().copy( this );
  18531. }
  18532. }
  18533. const _sphere$3 = /*@__PURE__*/ new Sphere();
  18534. const _defaultSpriteCenter = /*@__PURE__*/ new Vector2( 0.5, 0.5 );
  18535. const _vector$6 = /*@__PURE__*/ new Vector3();
  18536. /**
  18537. * Frustums are used to determine what is inside the camera's field of view.
  18538. * They help speed up the rendering process - objects which lie outside a camera's
  18539. * frustum can safely be excluded from rendering.
  18540. *
  18541. * This class is mainly intended for use internally by a renderer.
  18542. */
  18543. class Frustum {
  18544. /**
  18545. * Constructs a new frustum.
  18546. *
  18547. * @param {Plane} [p0] - The first plane that encloses the frustum.
  18548. * @param {Plane} [p1] - The second plane that encloses the frustum.
  18549. * @param {Plane} [p2] - The third plane that encloses the frustum.
  18550. * @param {Plane} [p3] - The fourth plane that encloses the frustum.
  18551. * @param {Plane} [p4] - The fifth plane that encloses the frustum.
  18552. * @param {Plane} [p5] - The sixth plane that encloses the frustum.
  18553. */
  18554. constructor( p0 = new Plane(), p1 = new Plane(), p2 = new Plane(), p3 = new Plane(), p4 = new Plane(), p5 = new Plane() ) {
  18555. /**
  18556. * This array holds the planes that enclose the frustum.
  18557. *
  18558. * @type {Array<Plane>}
  18559. */
  18560. this.planes = [ p0, p1, p2, p3, p4, p5 ];
  18561. }
  18562. /**
  18563. * Sets the frustum planes by copying the given planes.
  18564. *
  18565. * @param {Plane} [p0] - The first plane that encloses the frustum.
  18566. * @param {Plane} [p1] - The second plane that encloses the frustum.
  18567. * @param {Plane} [p2] - The third plane that encloses the frustum.
  18568. * @param {Plane} [p3] - The fourth plane that encloses the frustum.
  18569. * @param {Plane} [p4] - The fifth plane that encloses the frustum.
  18570. * @param {Plane} [p5] - The sixth plane that encloses the frustum.
  18571. * @return {Frustum} A reference to this frustum.
  18572. */
  18573. set( p0, p1, p2, p3, p4, p5 ) {
  18574. const planes = this.planes;
  18575. planes[ 0 ].copy( p0 );
  18576. planes[ 1 ].copy( p1 );
  18577. planes[ 2 ].copy( p2 );
  18578. planes[ 3 ].copy( p3 );
  18579. planes[ 4 ].copy( p4 );
  18580. planes[ 5 ].copy( p5 );
  18581. return this;
  18582. }
  18583. /**
  18584. * Copies the values of the given frustum to this instance.
  18585. *
  18586. * @param {Frustum} frustum - The frustum to copy.
  18587. * @return {Frustum} A reference to this frustum.
  18588. */
  18589. copy( frustum ) {
  18590. const planes = this.planes;
  18591. for ( let i = 0; i < 6; i ++ ) {
  18592. planes[ i ].copy( frustum.planes[ i ] );
  18593. }
  18594. return this;
  18595. }
  18596. /**
  18597. * Sets the frustum planes from the given projection matrix.
  18598. *
  18599. * @param {Matrix4} m - The projection matrix.
  18600. * @param {(WebGLCoordinateSystem|WebGPUCoordinateSystem)} coordinateSystem - The coordinate system.
  18601. * @param {boolean} [reversedDepth=false] - Whether to use a reversed depth.
  18602. * @return {Frustum} A reference to this frustum.
  18603. */
  18604. setFromProjectionMatrix( m, coordinateSystem = WebGLCoordinateSystem, reversedDepth = false ) {
  18605. const planes = this.planes;
  18606. const me = m.elements;
  18607. const me0 = me[ 0 ], me1 = me[ 1 ], me2 = me[ 2 ], me3 = me[ 3 ];
  18608. const me4 = me[ 4 ], me5 = me[ 5 ], me6 = me[ 6 ], me7 = me[ 7 ];
  18609. const me8 = me[ 8 ], me9 = me[ 9 ], me10 = me[ 10 ], me11 = me[ 11 ];
  18610. const me12 = me[ 12 ], me13 = me[ 13 ], me14 = me[ 14 ], me15 = me[ 15 ];
  18611. planes[ 0 ].setComponents( me3 - me0, me7 - me4, me11 - me8, me15 - me12 ).normalize();
  18612. planes[ 1 ].setComponents( me3 + me0, me7 + me4, me11 + me8, me15 + me12 ).normalize();
  18613. planes[ 2 ].setComponents( me3 + me1, me7 + me5, me11 + me9, me15 + me13 ).normalize();
  18614. planes[ 3 ].setComponents( me3 - me1, me7 - me5, me11 - me9, me15 - me13 ).normalize();
  18615. if ( reversedDepth ) {
  18616. planes[ 4 ].setComponents( me2, me6, me10, me14 ).normalize(); // far
  18617. planes[ 5 ].setComponents( me3 - me2, me7 - me6, me11 - me10, me15 - me14 ).normalize(); // near
  18618. } else {
  18619. planes[ 4 ].setComponents( me3 - me2, me7 - me6, me11 - me10, me15 - me14 ).normalize(); // far
  18620. if ( coordinateSystem === WebGLCoordinateSystem ) {
  18621. planes[ 5 ].setComponents( me3 + me2, me7 + me6, me11 + me10, me15 + me14 ).normalize(); // near
  18622. } else if ( coordinateSystem === WebGPUCoordinateSystem ) {
  18623. planes[ 5 ].setComponents( me2, me6, me10, me14 ).normalize(); // near
  18624. } else {
  18625. throw new Error( 'THREE.Frustum.setFromProjectionMatrix(): Invalid coordinate system: ' + coordinateSystem );
  18626. }
  18627. }
  18628. return this;
  18629. }
  18630. /**
  18631. * Returns `true` if the 3D object's bounding sphere is intersecting this frustum.
  18632. *
  18633. * Note that the 3D object must have a geometry so that the bounding sphere can be calculated.
  18634. *
  18635. * @param {Object3D} object - The 3D object to test.
  18636. * @return {boolean} Whether the 3D object's bounding sphere is intersecting this frustum or not.
  18637. */
  18638. intersectsObject( object ) {
  18639. if ( object.boundingSphere !== undefined ) {
  18640. if ( object.boundingSphere === null ) object.computeBoundingSphere();
  18641. _sphere$3.copy( object.boundingSphere ).applyMatrix4( object.matrixWorld );
  18642. } else {
  18643. const geometry = object.geometry;
  18644. if ( geometry.boundingSphere === null ) geometry.computeBoundingSphere();
  18645. _sphere$3.copy( geometry.boundingSphere ).applyMatrix4( object.matrixWorld );
  18646. }
  18647. return this.intersectsSphere( _sphere$3 );
  18648. }
  18649. /**
  18650. * Returns `true` if the given sprite is intersecting this frustum.
  18651. *
  18652. * @param {Sprite} sprite - The sprite to test.
  18653. * @return {boolean} Whether the sprite is intersecting this frustum or not.
  18654. */
  18655. intersectsSprite( sprite ) {
  18656. _sphere$3.center.set( 0, 0, 0 );
  18657. const offset = _defaultSpriteCenter.distanceTo( sprite.center );
  18658. _sphere$3.radius = 0.7071067811865476 + offset;
  18659. _sphere$3.applyMatrix4( sprite.matrixWorld );
  18660. return this.intersectsSphere( _sphere$3 );
  18661. }
  18662. /**
  18663. * Returns `true` if the given bounding sphere is intersecting this frustum.
  18664. *
  18665. * @param {Sphere} sphere - The bounding sphere to test.
  18666. * @return {boolean} Whether the bounding sphere is intersecting this frustum or not.
  18667. */
  18668. intersectsSphere( sphere ) {
  18669. const planes = this.planes;
  18670. const center = sphere.center;
  18671. const negRadius = - sphere.radius;
  18672. for ( let i = 0; i < 6; i ++ ) {
  18673. const distance = planes[ i ].distanceToPoint( center );
  18674. if ( distance < negRadius ) {
  18675. return false;
  18676. }
  18677. }
  18678. return true;
  18679. }
  18680. /**
  18681. * Returns `true` if the given bounding box is intersecting this frustum.
  18682. *
  18683. * @param {Box3} box - The bounding box to test.
  18684. * @return {boolean} Whether the bounding box is intersecting this frustum or not.
  18685. */
  18686. intersectsBox( box ) {
  18687. const planes = this.planes;
  18688. for ( let i = 0; i < 6; i ++ ) {
  18689. const plane = planes[ i ];
  18690. // corner at max distance
  18691. _vector$6.x = plane.normal.x > 0 ? box.max.x : box.min.x;
  18692. _vector$6.y = plane.normal.y > 0 ? box.max.y : box.min.y;
  18693. _vector$6.z = plane.normal.z > 0 ? box.max.z : box.min.z;
  18694. if ( plane.distanceToPoint( _vector$6 ) < 0 ) {
  18695. return false;
  18696. }
  18697. }
  18698. return true;
  18699. }
  18700. /**
  18701. * Returns `true` if the given point lies within the frustum.
  18702. *
  18703. * @param {Vector3} point - The point to test.
  18704. * @return {boolean} Whether the point lies within this frustum or not.
  18705. */
  18706. containsPoint( point ) {
  18707. const planes = this.planes;
  18708. for ( let i = 0; i < 6; i ++ ) {
  18709. if ( planes[ i ].distanceToPoint( point ) < 0 ) {
  18710. return false;
  18711. }
  18712. }
  18713. return true;
  18714. }
  18715. /**
  18716. * Returns a new frustum with copied values from this instance.
  18717. *
  18718. * @return {Frustum} A clone of this instance.
  18719. */
  18720. clone() {
  18721. return new this.constructor().copy( this );
  18722. }
  18723. }
  18724. const _projScreenMatrix$1 = /*@__PURE__*/ new Matrix4();
  18725. const _frustum$1 = /*@__PURE__*/ new Frustum();
  18726. /**
  18727. * FrustumArray is used to determine if an object is visible in at least one camera
  18728. * from an array of cameras. This is particularly useful for multi-view renderers.
  18729. */
  18730. class FrustumArray {
  18731. /**
  18732. * Constructs a new frustum array.
  18733. *
  18734. */
  18735. constructor() {
  18736. /**
  18737. * The coordinate system to use.
  18738. *
  18739. * @type {WebGLCoordinateSystem|WebGPUCoordinateSystem}
  18740. * @default WebGLCoordinateSystem
  18741. */
  18742. this.coordinateSystem = WebGLCoordinateSystem;
  18743. }
  18744. /**
  18745. * Returns `true` if the 3D object's bounding sphere is intersecting any frustum
  18746. * from the camera array.
  18747. *
  18748. * @param {Object3D} object - The 3D object to test.
  18749. * @param {Object} cameraArray - An object with a cameras property containing an array of cameras.
  18750. * @return {boolean} Whether the 3D object is visible in any camera.
  18751. */
  18752. intersectsObject( object, cameraArray ) {
  18753. if ( ! cameraArray.isArrayCamera || cameraArray.cameras.length === 0 ) {
  18754. return false;
  18755. }
  18756. for ( let i = 0; i < cameraArray.cameras.length; i ++ ) {
  18757. const camera = cameraArray.cameras[ i ];
  18758. _projScreenMatrix$1.multiplyMatrices(
  18759. camera.projectionMatrix,
  18760. camera.matrixWorldInverse
  18761. );
  18762. _frustum$1.setFromProjectionMatrix(
  18763. _projScreenMatrix$1,
  18764. camera.coordinateSystem,
  18765. camera.reversedDepth
  18766. );
  18767. if ( _frustum$1.intersectsObject( object ) ) {
  18768. return true; // Object is visible in at least one camera
  18769. }
  18770. }
  18771. return false; // Not visible in any camera
  18772. }
  18773. /**
  18774. * Returns `true` if the given sprite is intersecting any frustum
  18775. * from the camera array.
  18776. *
  18777. * @param {Sprite} sprite - The sprite to test.
  18778. * @param {Object} cameraArray - An object with a cameras property containing an array of cameras.
  18779. * @return {boolean} Whether the sprite is visible in any camera.
  18780. */
  18781. intersectsSprite( sprite, cameraArray ) {
  18782. if ( ! cameraArray || ! cameraArray.cameras || cameraArray.cameras.length === 0 ) {
  18783. return false;
  18784. }
  18785. for ( let i = 0; i < cameraArray.cameras.length; i ++ ) {
  18786. const camera = cameraArray.cameras[ i ];
  18787. _projScreenMatrix$1.multiplyMatrices(
  18788. camera.projectionMatrix,
  18789. camera.matrixWorldInverse
  18790. );
  18791. _frustum$1.setFromProjectionMatrix(
  18792. _projScreenMatrix$1,
  18793. camera.coordinateSystem,
  18794. camera.reversedDepth
  18795. );
  18796. if ( _frustum$1.intersectsSprite( sprite ) ) {
  18797. return true; // Sprite is visible in at least one camera
  18798. }
  18799. }
  18800. return false; // Not visible in any camera
  18801. }
  18802. /**
  18803. * Returns `true` if the given bounding sphere is intersecting any frustum
  18804. * from the camera array.
  18805. *
  18806. * @param {Sphere} sphere - The bounding sphere to test.
  18807. * @param {Object} cameraArray - An object with a cameras property containing an array of cameras.
  18808. * @return {boolean} Whether the sphere is visible in any camera.
  18809. */
  18810. intersectsSphere( sphere, cameraArray ) {
  18811. if ( ! cameraArray || ! cameraArray.cameras || cameraArray.cameras.length === 0 ) {
  18812. return false;
  18813. }
  18814. for ( let i = 0; i < cameraArray.cameras.length; i ++ ) {
  18815. const camera = cameraArray.cameras[ i ];
  18816. _projScreenMatrix$1.multiplyMatrices(
  18817. camera.projectionMatrix,
  18818. camera.matrixWorldInverse
  18819. );
  18820. _frustum$1.setFromProjectionMatrix(
  18821. _projScreenMatrix$1,
  18822. camera.coordinateSystem,
  18823. camera.reversedDepth
  18824. );
  18825. if ( _frustum$1.intersectsSphere( sphere ) ) {
  18826. return true; // Sphere is visible in at least one camera
  18827. }
  18828. }
  18829. return false; // Not visible in any camera
  18830. }
  18831. /**
  18832. * Returns `true` if the given bounding box is intersecting any frustum
  18833. * from the camera array.
  18834. *
  18835. * @param {Box3} box - The bounding box to test.
  18836. * @param {Object} cameraArray - An object with a cameras property containing an array of cameras.
  18837. * @return {boolean} Whether the box is visible in any camera.
  18838. */
  18839. intersectsBox( box, cameraArray ) {
  18840. if ( ! cameraArray || ! cameraArray.cameras || cameraArray.cameras.length === 0 ) {
  18841. return false;
  18842. }
  18843. for ( let i = 0; i < cameraArray.cameras.length; i ++ ) {
  18844. const camera = cameraArray.cameras[ i ];
  18845. _projScreenMatrix$1.multiplyMatrices(
  18846. camera.projectionMatrix,
  18847. camera.matrixWorldInverse
  18848. );
  18849. _frustum$1.setFromProjectionMatrix(
  18850. _projScreenMatrix$1,
  18851. camera.coordinateSystem,
  18852. camera.reversedDepth
  18853. );
  18854. if ( _frustum$1.intersectsBox( box ) ) {
  18855. return true; // Box is visible in at least one camera
  18856. }
  18857. }
  18858. return false; // Not visible in any camera
  18859. }
  18860. /**
  18861. * Returns `true` if the given point lies within any frustum
  18862. * from the camera array.
  18863. *
  18864. * @param {Vector3} point - The point to test.
  18865. * @param {Object} cameraArray - An object with a cameras property containing an array of cameras.
  18866. * @return {boolean} Whether the point is visible in any camera.
  18867. */
  18868. containsPoint( point, cameraArray ) {
  18869. if ( ! cameraArray || ! cameraArray.cameras || cameraArray.cameras.length === 0 ) {
  18870. return false;
  18871. }
  18872. for ( let i = 0; i < cameraArray.cameras.length; i ++ ) {
  18873. const camera = cameraArray.cameras[ i ];
  18874. _projScreenMatrix$1.multiplyMatrices(
  18875. camera.projectionMatrix,
  18876. camera.matrixWorldInverse
  18877. );
  18878. _frustum$1.setFromProjectionMatrix(
  18879. _projScreenMatrix$1,
  18880. camera.coordinateSystem,
  18881. camera.reversedDepth
  18882. );
  18883. if ( _frustum$1.containsPoint( point ) ) {
  18884. return true; // Point is visible in at least one camera
  18885. }
  18886. }
  18887. return false; // Not visible in any camera
  18888. }
  18889. /**
  18890. * Returns a new frustum array with copied values from this instance.
  18891. *
  18892. * @return {FrustumArray} A clone of this instance.
  18893. */
  18894. clone() {
  18895. return new FrustumArray();
  18896. }
  18897. }
  18898. function ascIdSort( a, b ) {
  18899. return a - b;
  18900. }
  18901. function sortOpaque( a, b ) {
  18902. return a.z - b.z;
  18903. }
  18904. function sortTransparent( a, b ) {
  18905. return b.z - a.z;
  18906. }
  18907. class MultiDrawRenderList {
  18908. constructor() {
  18909. this.index = 0;
  18910. this.pool = [];
  18911. this.list = [];
  18912. }
  18913. push( start, count, z, index ) {
  18914. const pool = this.pool;
  18915. const list = this.list;
  18916. if ( this.index >= pool.length ) {
  18917. pool.push( {
  18918. start: -1,
  18919. count: -1,
  18920. z: -1,
  18921. index: -1,
  18922. } );
  18923. }
  18924. const item = pool[ this.index ];
  18925. list.push( item );
  18926. this.index ++;
  18927. item.start = start;
  18928. item.count = count;
  18929. item.z = z;
  18930. item.index = index;
  18931. }
  18932. reset() {
  18933. this.list.length = 0;
  18934. this.index = 0;
  18935. }
  18936. }
  18937. const _matrix$1 = /*@__PURE__*/ new Matrix4();
  18938. const _whiteColor = /*@__PURE__*/ new Color( 1, 1, 1 );
  18939. const _frustum = /*@__PURE__*/ new Frustum();
  18940. const _frustumArray = /*@__PURE__*/ new FrustumArray();
  18941. const _box$1 = /*@__PURE__*/ new Box3();
  18942. const _sphere$2 = /*@__PURE__*/ new Sphere();
  18943. const _vector$5 = /*@__PURE__*/ new Vector3();
  18944. const _forward$1 = /*@__PURE__*/ new Vector3();
  18945. const _temp = /*@__PURE__*/ new Vector3();
  18946. const _renderList = /*@__PURE__*/ new MultiDrawRenderList();
  18947. const _mesh = /*@__PURE__*/ new Mesh();
  18948. const _batchIntersects = [];
  18949. // copies data from attribute "src" into "target" starting at "targetOffset"
  18950. function copyAttributeData( src, target, targetOffset = 0 ) {
  18951. const itemSize = target.itemSize;
  18952. if ( src.isInterleavedBufferAttribute || src.array.constructor !== target.array.constructor ) {
  18953. // use the component getters and setters if the array data cannot
  18954. // be copied directly
  18955. const vertexCount = src.count;
  18956. for ( let i = 0; i < vertexCount; i ++ ) {
  18957. for ( let c = 0; c < itemSize; c ++ ) {
  18958. target.setComponent( i + targetOffset, c, src.getComponent( i, c ) );
  18959. }
  18960. }
  18961. } else {
  18962. // faster copy approach using typed array set function
  18963. target.array.set( src.array, targetOffset * itemSize );
  18964. }
  18965. target.needsUpdate = true;
  18966. }
  18967. // safely copies array contents to a potentially smaller array
  18968. function copyArrayContents( src, target ) {
  18969. if ( src.constructor !== target.constructor ) {
  18970. // if arrays are of a different type (eg due to index size increasing) then data must be per-element copied
  18971. const len = Math.min( src.length, target.length );
  18972. for ( let i = 0; i < len; i ++ ) {
  18973. target[ i ] = src[ i ];
  18974. }
  18975. } else {
  18976. // if the arrays use the same data layout we can use a fast block copy
  18977. const len = Math.min( src.length, target.length );
  18978. target.set( new src.constructor( src.buffer, 0, len ) );
  18979. }
  18980. }
  18981. /**
  18982. * A special version of a mesh with multi draw batch rendering support. Use
  18983. * this class if you have to render a large number of objects with the same
  18984. * material but with different geometries or world transformations. The usage of
  18985. * `BatchedMesh` will help you to reduce the number of draw calls and thus improve the overall
  18986. * rendering performance in your application.
  18987. *
  18988. * ```js
  18989. * const box = new THREE.BoxGeometry( 1, 1, 1 );
  18990. * const sphere = new THREE.SphereGeometry( 1, 12, 12 );
  18991. * const material = new THREE.MeshBasicMaterial( { color: 0x00ff00 } );
  18992. *
  18993. * // initialize and add geometries into the batched mesh
  18994. * const batchedMesh = new BatchedMesh( 10, 5000, 10000, material );
  18995. * const boxGeometryId = batchedMesh.addGeometry( box );
  18996. * const sphereGeometryId = batchedMesh.addGeometry( sphere );
  18997. *
  18998. * // create instances of those geometries
  18999. * const boxInstancedId1 = batchedMesh.addInstance( boxGeometryId );
  19000. * const boxInstancedId2 = batchedMesh.addInstance( boxGeometryId );
  19001. *
  19002. * const sphereInstancedId1 = batchedMesh.addInstance( sphereGeometryId );
  19003. * const sphereInstancedId2 = batchedMesh.addInstance( sphereGeometryId );
  19004. *
  19005. * // position the geometries
  19006. * batchedMesh.setMatrixAt( boxInstancedId1, boxMatrix1 );
  19007. * batchedMesh.setMatrixAt( boxInstancedId2, boxMatrix2 );
  19008. *
  19009. * batchedMesh.setMatrixAt( sphereInstancedId1, sphereMatrix1 );
  19010. * batchedMesh.setMatrixAt( sphereInstancedId2, sphereMatrix2 );
  19011. *
  19012. * scene.add( batchedMesh );
  19013. * ```
  19014. *
  19015. * @augments Mesh
  19016. */
  19017. class BatchedMesh extends Mesh {
  19018. /**
  19019. * Constructs a new batched mesh.
  19020. *
  19021. * @param {number} maxInstanceCount - The maximum number of individual instances planned to be added and rendered.
  19022. * @param {number} maxVertexCount - The maximum number of vertices to be used by all unique geometries.
  19023. * @param {number} [maxIndexCount=maxVertexCount*2] - The maximum number of indices to be used by all unique geometries
  19024. * @param {Material|Array<Material>} [material] - The mesh material.
  19025. */
  19026. constructor( maxInstanceCount, maxVertexCount, maxIndexCount = maxVertexCount * 2, material ) {
  19027. super( new BufferGeometry(), material );
  19028. /**
  19029. * This flag can be used for type testing.
  19030. *
  19031. * @type {boolean}
  19032. * @readonly
  19033. * @default true
  19034. */
  19035. this.isBatchedMesh = true;
  19036. /**
  19037. * When set ot `true`, the individual objects of a batch are frustum culled.
  19038. *
  19039. * @type {boolean}
  19040. * @default true
  19041. */
  19042. this.perObjectFrustumCulled = true;
  19043. /**
  19044. * When set to `true`, the individual objects of a batch are sorted to improve overdraw-related artifacts.
  19045. * If the material is marked as "transparent" objects are rendered back to front and if not then they are
  19046. * rendered front to back.
  19047. *
  19048. * @type {boolean}
  19049. * @default true
  19050. */
  19051. this.sortObjects = true;
  19052. /**
  19053. * The bounding box of the batched mesh. Can be computed via {@link BatchedMesh#computeBoundingBox}.
  19054. *
  19055. * @type {?Box3}
  19056. * @default null
  19057. */
  19058. this.boundingBox = null;
  19059. /**
  19060. * The bounding sphere of the batched mesh. Can be computed via {@link BatchedMesh#computeBoundingSphere}.
  19061. *
  19062. * @type {?Sphere}
  19063. * @default null
  19064. */
  19065. this.boundingSphere = null;
  19066. /**
  19067. * Takes a sort a function that is run before render. The function takes a list of instances to
  19068. * sort and a camera. The objects in the list include a "z" field to perform a depth-ordered
  19069. * sort with.
  19070. *
  19071. * @type {?Function}
  19072. * @default null
  19073. */
  19074. this.customSort = null;
  19075. // stores visible, active, and geometry id per instance and reserved buffer ranges for geometries
  19076. this._instanceInfo = [];
  19077. this._geometryInfo = [];
  19078. // instance, geometry ids that have been set as inactive, and are available to be overwritten
  19079. this._availableInstanceIds = [];
  19080. this._availableGeometryIds = [];
  19081. // used to track where the next point is that geometry should be inserted
  19082. this._nextIndexStart = 0;
  19083. this._nextVertexStart = 0;
  19084. this._geometryCount = 0;
  19085. // flags
  19086. this._visibilityChanged = true;
  19087. this._geometryInitialized = false;
  19088. // cached user options
  19089. this._maxInstanceCount = maxInstanceCount;
  19090. this._maxVertexCount = maxVertexCount;
  19091. this._maxIndexCount = maxIndexCount;
  19092. // buffers for multi draw
  19093. this._multiDrawCounts = new Int32Array( maxInstanceCount );
  19094. this._multiDrawStarts = new Int32Array( maxInstanceCount );
  19095. this._multiDrawCount = 0;
  19096. this._multiDrawInstances = null;
  19097. // Local matrix per geometry by using data texture
  19098. this._matricesTexture = null;
  19099. this._indirectTexture = null;
  19100. this._colorsTexture = null;
  19101. this._initMatricesTexture();
  19102. this._initIndirectTexture();
  19103. }
  19104. /**
  19105. * The maximum number of individual instances that can be stored in the batch.
  19106. *
  19107. * @type {number}
  19108. * @readonly
  19109. */
  19110. get maxInstanceCount() {
  19111. return this._maxInstanceCount;
  19112. }
  19113. /**
  19114. * The instance count.
  19115. *
  19116. * @type {number}
  19117. * @readonly
  19118. */
  19119. get instanceCount() {
  19120. return this._instanceInfo.length - this._availableInstanceIds.length;
  19121. }
  19122. /**
  19123. * The number of unused vertices.
  19124. *
  19125. * @type {number}
  19126. * @readonly
  19127. */
  19128. get unusedVertexCount() {
  19129. return this._maxVertexCount - this._nextVertexStart;
  19130. }
  19131. /**
  19132. * The number of unused indices.
  19133. *
  19134. * @type {number}
  19135. * @readonly
  19136. */
  19137. get unusedIndexCount() {
  19138. return this._maxIndexCount - this._nextIndexStart;
  19139. }
  19140. _initMatricesTexture() {
  19141. // layout (1 matrix = 4 pixels)
  19142. // RGBA RGBA RGBA RGBA (=> column1, column2, column3, column4)
  19143. // with 8x8 pixel texture max 16 matrices * 4 pixels = (8 * 8)
  19144. // 16x16 pixel texture max 64 matrices * 4 pixels = (16 * 16)
  19145. // 32x32 pixel texture max 256 matrices * 4 pixels = (32 * 32)
  19146. // 64x64 pixel texture max 1024 matrices * 4 pixels = (64 * 64)
  19147. let size = Math.sqrt( this._maxInstanceCount * 4 ); // 4 pixels needed for 1 matrix
  19148. size = Math.ceil( size / 4 ) * 4;
  19149. size = Math.max( size, 4 );
  19150. const matricesArray = new Float32Array( size * size * 4 ); // 4 floats per RGBA pixel
  19151. const matricesTexture = new DataTexture( matricesArray, size, size, RGBAFormat, FloatType );
  19152. this._matricesTexture = matricesTexture;
  19153. }
  19154. _initIndirectTexture() {
  19155. let size = Math.sqrt( this._maxInstanceCount );
  19156. size = Math.ceil( size );
  19157. const indirectArray = new Uint32Array( size * size );
  19158. const indirectTexture = new DataTexture( indirectArray, size, size, RedIntegerFormat, UnsignedIntType );
  19159. this._indirectTexture = indirectTexture;
  19160. }
  19161. _initColorsTexture() {
  19162. let size = Math.sqrt( this._maxInstanceCount );
  19163. size = Math.ceil( size );
  19164. // 4 floats per RGBA pixel initialized to white
  19165. const colorsArray = new Float32Array( size * size * 4 ).fill( 1 );
  19166. const colorsTexture = new DataTexture( colorsArray, size, size, RGBAFormat, FloatType );
  19167. colorsTexture.colorSpace = ColorManagement.workingColorSpace;
  19168. this._colorsTexture = colorsTexture;
  19169. }
  19170. _initializeGeometry( reference ) {
  19171. const geometry = this.geometry;
  19172. const maxVertexCount = this._maxVertexCount;
  19173. const maxIndexCount = this._maxIndexCount;
  19174. if ( this._geometryInitialized === false ) {
  19175. for ( const attributeName in reference.attributes ) {
  19176. const srcAttribute = reference.getAttribute( attributeName );
  19177. const { array, itemSize, normalized } = srcAttribute;
  19178. const dstArray = new array.constructor( maxVertexCount * itemSize );
  19179. const dstAttribute = new BufferAttribute( dstArray, itemSize, normalized );
  19180. geometry.setAttribute( attributeName, dstAttribute );
  19181. }
  19182. if ( reference.getIndex() !== null ) {
  19183. // Reserve last u16 index for primitive restart.
  19184. const indexArray = maxVertexCount > 65535
  19185. ? new Uint32Array( maxIndexCount )
  19186. : new Uint16Array( maxIndexCount );
  19187. geometry.setIndex( new BufferAttribute( indexArray, 1 ) );
  19188. }
  19189. this._geometryInitialized = true;
  19190. }
  19191. }
  19192. // Make sure the geometry is compatible with the existing combined geometry attributes
  19193. _validateGeometry( geometry ) {
  19194. // check to ensure the geometries are using consistent attributes and indices
  19195. const batchGeometry = this.geometry;
  19196. if ( Boolean( geometry.getIndex() ) !== Boolean( batchGeometry.getIndex() ) ) {
  19197. throw new Error( 'THREE.BatchedMesh: All geometries must consistently have "index".' );
  19198. }
  19199. for ( const attributeName in batchGeometry.attributes ) {
  19200. if ( ! geometry.hasAttribute( attributeName ) ) {
  19201. throw new Error( `THREE.BatchedMesh: Added geometry missing "${ attributeName }". All geometries must have consistent attributes.` );
  19202. }
  19203. const srcAttribute = geometry.getAttribute( attributeName );
  19204. const dstAttribute = batchGeometry.getAttribute( attributeName );
  19205. if ( srcAttribute.itemSize !== dstAttribute.itemSize || srcAttribute.normalized !== dstAttribute.normalized ) {
  19206. throw new Error( 'THREE.BatchedMesh: All attributes must have a consistent itemSize and normalized value.' );
  19207. }
  19208. }
  19209. }
  19210. /**
  19211. * Validates the instance defined by the given ID.
  19212. *
  19213. * @param {number} instanceId - The instance to validate.
  19214. */
  19215. validateInstanceId( instanceId ) {
  19216. const instanceInfo = this._instanceInfo;
  19217. if ( instanceId < 0 || instanceId >= instanceInfo.length || instanceInfo[ instanceId ].active === false ) {
  19218. throw new Error( `THREE.BatchedMesh: Invalid instanceId ${instanceId}. Instance is either out of range or has been deleted.` );
  19219. }
  19220. }
  19221. /**
  19222. * Validates the geometry defined by the given ID.
  19223. *
  19224. * @param {number} geometryId - The geometry to validate.
  19225. */
  19226. validateGeometryId( geometryId ) {
  19227. const geometryInfoList = this._geometryInfo;
  19228. if ( geometryId < 0 || geometryId >= geometryInfoList.length || geometryInfoList[ geometryId ].active === false ) {
  19229. throw new Error( `THREE.BatchedMesh: Invalid geometryId ${geometryId}. Geometry is either out of range or has been deleted.` );
  19230. }
  19231. }
  19232. /**
  19233. * Takes a sort a function that is run before render. The function takes a list of instances to
  19234. * sort and a camera. The objects in the list include a "z" field to perform a depth-ordered sort with.
  19235. *
  19236. * @param {Function} func - The custom sort function.
  19237. * @return {BatchedMesh} A reference to this batched mesh.
  19238. */
  19239. setCustomSort( func ) {
  19240. this.customSort = func;
  19241. return this;
  19242. }
  19243. /**
  19244. * Computes the bounding box, updating {@link BatchedMesh#boundingBox}.
  19245. * Bounding boxes aren't computed by default. They need to be explicitly computed,
  19246. * otherwise they are `null`.
  19247. */
  19248. computeBoundingBox() {
  19249. if ( this.boundingBox === null ) {
  19250. this.boundingBox = new Box3();
  19251. }
  19252. const boundingBox = this.boundingBox;
  19253. const instanceInfo = this._instanceInfo;
  19254. boundingBox.makeEmpty();
  19255. for ( let i = 0, l = instanceInfo.length; i < l; i ++ ) {
  19256. if ( instanceInfo[ i ].active === false ) continue;
  19257. const geometryId = instanceInfo[ i ].geometryIndex;
  19258. this.getMatrixAt( i, _matrix$1 );
  19259. this.getBoundingBoxAt( geometryId, _box$1 ).applyMatrix4( _matrix$1 );
  19260. boundingBox.union( _box$1 );
  19261. }
  19262. }
  19263. /**
  19264. * Computes the bounding sphere, updating {@link BatchedMesh#boundingSphere}.
  19265. * Bounding spheres aren't computed by default. They need to be explicitly computed,
  19266. * otherwise they are `null`.
  19267. */
  19268. computeBoundingSphere() {
  19269. if ( this.boundingSphere === null ) {
  19270. this.boundingSphere = new Sphere();
  19271. }
  19272. const boundingSphere = this.boundingSphere;
  19273. const instanceInfo = this._instanceInfo;
  19274. boundingSphere.makeEmpty();
  19275. for ( let i = 0, l = instanceInfo.length; i < l; i ++ ) {
  19276. if ( instanceInfo[ i ].active === false ) continue;
  19277. const geometryId = instanceInfo[ i ].geometryIndex;
  19278. this.getMatrixAt( i, _matrix$1 );
  19279. this.getBoundingSphereAt( geometryId, _sphere$2 ).applyMatrix4( _matrix$1 );
  19280. boundingSphere.union( _sphere$2 );
  19281. }
  19282. }
  19283. /**
  19284. * Adds a new instance to the batch using the geometry of the given ID and returns
  19285. * a new id referring to the new instance to be used by other functions.
  19286. *
  19287. * @param {number} geometryId - The ID of a previously added geometry via {@link BatchedMesh#addGeometry}.
  19288. * @return {number} The instance ID.
  19289. */
  19290. addInstance( geometryId ) {
  19291. const atCapacity = this._instanceInfo.length >= this.maxInstanceCount;
  19292. // ensure we're not over geometry
  19293. if ( atCapacity && this._availableInstanceIds.length === 0 ) {
  19294. throw new Error( 'THREE.BatchedMesh: Maximum item count reached.' );
  19295. }
  19296. const instanceInfo = {
  19297. visible: true,
  19298. active: true,
  19299. geometryIndex: geometryId,
  19300. };
  19301. let drawId = null;
  19302. // Prioritize using previously freed instance ids
  19303. if ( this._availableInstanceIds.length > 0 ) {
  19304. this._availableInstanceIds.sort( ascIdSort );
  19305. drawId = this._availableInstanceIds.shift();
  19306. this._instanceInfo[ drawId ] = instanceInfo;
  19307. } else {
  19308. drawId = this._instanceInfo.length;
  19309. this._instanceInfo.push( instanceInfo );
  19310. }
  19311. const matricesTexture = this._matricesTexture;
  19312. _matrix$1.identity().toArray( matricesTexture.image.data, drawId * 16 );
  19313. matricesTexture.needsUpdate = true;
  19314. const colorsTexture = this._colorsTexture;
  19315. if ( colorsTexture ) {
  19316. _whiteColor.toArray( colorsTexture.image.data, drawId * 4 );
  19317. colorsTexture.needsUpdate = true;
  19318. }
  19319. this._visibilityChanged = true;
  19320. return drawId;
  19321. }
  19322. /**
  19323. * Adds the given geometry to the batch and returns the associated
  19324. * geometry id referring to it to be used in other functions.
  19325. *
  19326. * @param {BufferGeometry} geometry - The geometry to add.
  19327. * @param {number} [reservedVertexCount=-1] - Optional parameter specifying the amount of
  19328. * vertex buffer space to reserve for the added geometry. This is necessary if it is planned
  19329. * to set a new geometry at this index at a later time that is larger than the original geometry.
  19330. * Defaults to the length of the given geometry vertex buffer.
  19331. * @param {number} [reservedIndexCount=-1] - Optional parameter specifying the amount of index
  19332. * buffer space to reserve for the added geometry. This is necessary if it is planned to set a
  19333. * new geometry at this index at a later time that is larger than the original geometry. Defaults to
  19334. * the length of the given geometry index buffer.
  19335. * @return {number} The geometry ID.
  19336. */
  19337. addGeometry( geometry, reservedVertexCount = -1, reservedIndexCount = -1 ) {
  19338. this._initializeGeometry( geometry );
  19339. this._validateGeometry( geometry );
  19340. const geometryInfo = {
  19341. // geometry information
  19342. vertexStart: -1,
  19343. vertexCount: -1,
  19344. reservedVertexCount: -1,
  19345. indexStart: -1,
  19346. indexCount: -1,
  19347. reservedIndexCount: -1,
  19348. // draw range information
  19349. start: -1,
  19350. count: -1,
  19351. // state
  19352. boundingBox: null,
  19353. boundingSphere: null,
  19354. active: true,
  19355. };
  19356. const geometryInfoList = this._geometryInfo;
  19357. geometryInfo.vertexStart = this._nextVertexStart;
  19358. geometryInfo.reservedVertexCount = reservedVertexCount === -1 ? geometry.getAttribute( 'position' ).count : reservedVertexCount;
  19359. const index = geometry.getIndex();
  19360. const hasIndex = index !== null;
  19361. if ( hasIndex ) {
  19362. geometryInfo.indexStart = this._nextIndexStart;
  19363. geometryInfo.reservedIndexCount = reservedIndexCount === -1 ? index.count : reservedIndexCount;
  19364. }
  19365. if (
  19366. geometryInfo.indexStart !== -1 &&
  19367. geometryInfo.indexStart + geometryInfo.reservedIndexCount > this._maxIndexCount ||
  19368. geometryInfo.vertexStart + geometryInfo.reservedVertexCount > this._maxVertexCount
  19369. ) {
  19370. throw new Error( 'THREE.BatchedMesh: Reserved space request exceeds the maximum buffer size.' );
  19371. }
  19372. // update id
  19373. let geometryId;
  19374. if ( this._availableGeometryIds.length > 0 ) {
  19375. this._availableGeometryIds.sort( ascIdSort );
  19376. geometryId = this._availableGeometryIds.shift();
  19377. geometryInfoList[ geometryId ] = geometryInfo;
  19378. } else {
  19379. geometryId = this._geometryCount;
  19380. this._geometryCount ++;
  19381. geometryInfoList.push( geometryInfo );
  19382. }
  19383. // update the geometry
  19384. this.setGeometryAt( geometryId, geometry );
  19385. // increment the next geometry position
  19386. this._nextIndexStart = geometryInfo.indexStart + geometryInfo.reservedIndexCount;
  19387. this._nextVertexStart = geometryInfo.vertexStart + geometryInfo.reservedVertexCount;
  19388. return geometryId;
  19389. }
  19390. /**
  19391. * Replaces the geometry at the given ID with the provided geometry. Throws an error if there
  19392. * is not enough space reserved for geometry. Calling this will change all instances that are
  19393. * rendering that geometry.
  19394. *
  19395. * @param {number} geometryId - The ID of the geometry that should be replaced with the given geometry.
  19396. * @param {BufferGeometry} geometry - The new geometry.
  19397. * @return {number} The geometry ID.
  19398. */
  19399. setGeometryAt( geometryId, geometry ) {
  19400. if ( geometryId >= this._geometryCount ) {
  19401. throw new Error( 'THREE.BatchedMesh: Maximum geometry count reached.' );
  19402. }
  19403. this._validateGeometry( geometry );
  19404. const batchGeometry = this.geometry;
  19405. const hasIndex = batchGeometry.getIndex() !== null;
  19406. const dstIndex = batchGeometry.getIndex();
  19407. const srcIndex = geometry.getIndex();
  19408. const geometryInfo = this._geometryInfo[ geometryId ];
  19409. if (
  19410. hasIndex &&
  19411. srcIndex.count > geometryInfo.reservedIndexCount ||
  19412. geometry.attributes.position.count > geometryInfo.reservedVertexCount
  19413. ) {
  19414. throw new Error( 'THREE.BatchedMesh: Reserved space not large enough for provided geometry.' );
  19415. }
  19416. // copy geometry buffer data over
  19417. const vertexStart = geometryInfo.vertexStart;
  19418. const reservedVertexCount = geometryInfo.reservedVertexCount;
  19419. geometryInfo.vertexCount = geometry.getAttribute( 'position' ).count;
  19420. for ( const attributeName in batchGeometry.attributes ) {
  19421. // copy attribute data
  19422. const srcAttribute = geometry.getAttribute( attributeName );
  19423. const dstAttribute = batchGeometry.getAttribute( attributeName );
  19424. copyAttributeData( srcAttribute, dstAttribute, vertexStart );
  19425. // fill the rest in with zeroes
  19426. const itemSize = srcAttribute.itemSize;
  19427. for ( let i = srcAttribute.count, l = reservedVertexCount; i < l; i ++ ) {
  19428. const index = vertexStart + i;
  19429. for ( let c = 0; c < itemSize; c ++ ) {
  19430. dstAttribute.setComponent( index, c, 0 );
  19431. }
  19432. }
  19433. dstAttribute.needsUpdate = true;
  19434. dstAttribute.addUpdateRange( vertexStart * itemSize, reservedVertexCount * itemSize );
  19435. }
  19436. // copy index
  19437. if ( hasIndex ) {
  19438. const indexStart = geometryInfo.indexStart;
  19439. const reservedIndexCount = geometryInfo.reservedIndexCount;
  19440. geometryInfo.indexCount = geometry.getIndex().count;
  19441. // copy index data over
  19442. for ( let i = 0; i < srcIndex.count; i ++ ) {
  19443. dstIndex.setX( indexStart + i, vertexStart + srcIndex.getX( i ) );
  19444. }
  19445. // fill the rest in with zeroes
  19446. for ( let i = srcIndex.count, l = reservedIndexCount; i < l; i ++ ) {
  19447. dstIndex.setX( indexStart + i, vertexStart );
  19448. }
  19449. dstIndex.needsUpdate = true;
  19450. dstIndex.addUpdateRange( indexStart, geometryInfo.reservedIndexCount );
  19451. }
  19452. // update the draw range
  19453. geometryInfo.start = hasIndex ? geometryInfo.indexStart : geometryInfo.vertexStart;
  19454. geometryInfo.count = hasIndex ? geometryInfo.indexCount : geometryInfo.vertexCount;
  19455. // store the bounding boxes
  19456. geometryInfo.boundingBox = null;
  19457. if ( geometry.boundingBox !== null ) {
  19458. geometryInfo.boundingBox = geometry.boundingBox.clone();
  19459. }
  19460. geometryInfo.boundingSphere = null;
  19461. if ( geometry.boundingSphere !== null ) {
  19462. geometryInfo.boundingSphere = geometry.boundingSphere.clone();
  19463. }
  19464. this._visibilityChanged = true;
  19465. return geometryId;
  19466. }
  19467. /**
  19468. * Deletes the geometry defined by the given ID from this batch. Any instances referencing
  19469. * this geometry will also be removed as a side effect.
  19470. *
  19471. * @param {number} geometryId - The ID of the geometry to remove from the batch.
  19472. * @return {BatchedMesh} A reference to this batched mesh.
  19473. */
  19474. deleteGeometry( geometryId ) {
  19475. const geometryInfoList = this._geometryInfo;
  19476. if ( geometryId >= geometryInfoList.length || geometryInfoList[ geometryId ].active === false ) {
  19477. return this;
  19478. }
  19479. // delete any instances associated with this geometry
  19480. const instanceInfo = this._instanceInfo;
  19481. for ( let i = 0, l = instanceInfo.length; i < l; i ++ ) {
  19482. if ( instanceInfo[ i ].active && instanceInfo[ i ].geometryIndex === geometryId ) {
  19483. this.deleteInstance( i );
  19484. }
  19485. }
  19486. geometryInfoList[ geometryId ].active = false;
  19487. this._availableGeometryIds.push( geometryId );
  19488. this._visibilityChanged = true;
  19489. return this;
  19490. }
  19491. /**
  19492. * Deletes an existing instance from the batch using the given ID.
  19493. *
  19494. * @param {number} instanceId - The ID of the instance to remove from the batch.
  19495. * @return {BatchedMesh} A reference to this batched mesh.
  19496. */
  19497. deleteInstance( instanceId ) {
  19498. this.validateInstanceId( instanceId );
  19499. this._instanceInfo[ instanceId ].active = false;
  19500. this._availableInstanceIds.push( instanceId );
  19501. this._visibilityChanged = true;
  19502. return this;
  19503. }
  19504. /**
  19505. * Repacks the sub geometries in BatchedMesh to remove any unused space remaining from
  19506. * previously deleted geometry, freeing up space to add new geometry.
  19507. *
  19508. * @return {BatchedMesh} A reference to this batched mesh.
  19509. */
  19510. optimize() {
  19511. // track the next indices to copy data to
  19512. let nextVertexStart = 0;
  19513. let nextIndexStart = 0;
  19514. // Iterate over all geometry ranges in order sorted from earliest in the geometry buffer to latest
  19515. // in the geometry buffer. Because draw range objects can be reused there is no guarantee of their order.
  19516. const geometryInfoList = this._geometryInfo;
  19517. const indices = geometryInfoList
  19518. .map( ( e, i ) => i )
  19519. .sort( ( a, b ) => {
  19520. return geometryInfoList[ a ].vertexStart - geometryInfoList[ b ].vertexStart;
  19521. } );
  19522. const geometry = this.geometry;
  19523. for ( let i = 0, l = geometryInfoList.length; i < l; i ++ ) {
  19524. // if a geometry range is inactive then don't copy anything
  19525. const index = indices[ i ];
  19526. const geometryInfo = geometryInfoList[ index ];
  19527. if ( geometryInfo.active === false ) {
  19528. continue;
  19529. }
  19530. // if a geometry contains an index buffer then shift it, as well
  19531. if ( geometry.index !== null ) {
  19532. if ( geometryInfo.indexStart !== nextIndexStart ) {
  19533. const { indexStart, vertexStart, reservedIndexCount } = geometryInfo;
  19534. const index = geometry.index;
  19535. const array = index.array;
  19536. // shift the index pointers based on how the vertex data will shift
  19537. // adjusting the index must happen first so the original vertex start value is available
  19538. const elementDelta = nextVertexStart - vertexStart;
  19539. for ( let j = indexStart; j < indexStart + reservedIndexCount; j ++ ) {
  19540. array[ j ] = array[ j ] + elementDelta;
  19541. }
  19542. index.array.copyWithin( nextIndexStart, indexStart, indexStart + reservedIndexCount );
  19543. index.addUpdateRange( nextIndexStart, reservedIndexCount );
  19544. index.needsUpdate = true;
  19545. geometryInfo.indexStart = nextIndexStart;
  19546. }
  19547. nextIndexStart += geometryInfo.reservedIndexCount;
  19548. }
  19549. // if a geometry needs to be moved then copy attribute data to overwrite unused space
  19550. if ( geometryInfo.vertexStart !== nextVertexStart ) {
  19551. const { vertexStart, reservedVertexCount } = geometryInfo;
  19552. const attributes = geometry.attributes;
  19553. for ( const key in attributes ) {
  19554. const attribute = attributes[ key ];
  19555. const { array, itemSize } = attribute;
  19556. array.copyWithin( nextVertexStart * itemSize, vertexStart * itemSize, ( vertexStart + reservedVertexCount ) * itemSize );
  19557. attribute.addUpdateRange( nextVertexStart * itemSize, reservedVertexCount * itemSize );
  19558. attribute.needsUpdate = true;
  19559. }
  19560. geometryInfo.vertexStart = nextVertexStart;
  19561. }
  19562. nextVertexStart += geometryInfo.reservedVertexCount;
  19563. geometryInfo.start = geometry.index ? geometryInfo.indexStart : geometryInfo.vertexStart;
  19564. }
  19565. this._nextIndexStart = nextIndexStart;
  19566. this._nextVertexStart = nextVertexStart;
  19567. this._visibilityChanged = true;
  19568. return this;
  19569. }
  19570. /**
  19571. * Returns the bounding box for the given geometry.
  19572. *
  19573. * @param {number} geometryId - The ID of the geometry to return the bounding box for.
  19574. * @param {Box3} target - The target object that is used to store the method's result.
  19575. * @return {?Box3} The geometry's bounding box. Returns `null` if no geometry has been found for the given ID.
  19576. */
  19577. getBoundingBoxAt( geometryId, target ) {
  19578. if ( geometryId >= this._geometryCount ) {
  19579. return null;
  19580. }
  19581. // compute bounding box
  19582. const geometry = this.geometry;
  19583. const geometryInfo = this._geometryInfo[ geometryId ];
  19584. if ( geometryInfo.boundingBox === null ) {
  19585. const box = new Box3();
  19586. const index = geometry.index;
  19587. const position = geometry.attributes.position;
  19588. for ( let i = geometryInfo.start, l = geometryInfo.start + geometryInfo.count; i < l; i ++ ) {
  19589. let iv = i;
  19590. if ( index ) {
  19591. iv = index.getX( iv );
  19592. }
  19593. box.expandByPoint( _vector$5.fromBufferAttribute( position, iv ) );
  19594. }
  19595. geometryInfo.boundingBox = box;
  19596. }
  19597. target.copy( geometryInfo.boundingBox );
  19598. return target;
  19599. }
  19600. /**
  19601. * Returns the bounding sphere for the given geometry.
  19602. *
  19603. * @param {number} geometryId - The ID of the geometry to return the bounding sphere for.
  19604. * @param {Sphere} target - The target object that is used to store the method's result.
  19605. * @return {?Sphere} The geometry's bounding sphere. Returns `null` if no geometry has been found for the given ID.
  19606. */
  19607. getBoundingSphereAt( geometryId, target ) {
  19608. if ( geometryId >= this._geometryCount ) {
  19609. return null;
  19610. }
  19611. // compute bounding sphere
  19612. const geometry = this.geometry;
  19613. const geometryInfo = this._geometryInfo[ geometryId ];
  19614. if ( geometryInfo.boundingSphere === null ) {
  19615. const sphere = new Sphere();
  19616. this.getBoundingBoxAt( geometryId, _box$1 );
  19617. _box$1.getCenter( sphere.center );
  19618. const index = geometry.index;
  19619. const position = geometry.attributes.position;
  19620. let maxRadiusSq = 0;
  19621. for ( let i = geometryInfo.start, l = geometryInfo.start + geometryInfo.count; i < l; i ++ ) {
  19622. let iv = i;
  19623. if ( index ) {
  19624. iv = index.getX( iv );
  19625. }
  19626. _vector$5.fromBufferAttribute( position, iv );
  19627. maxRadiusSq = Math.max( maxRadiusSq, sphere.center.distanceToSquared( _vector$5 ) );
  19628. }
  19629. sphere.radius = Math.sqrt( maxRadiusSq );
  19630. geometryInfo.boundingSphere = sphere;
  19631. }
  19632. target.copy( geometryInfo.boundingSphere );
  19633. return target;
  19634. }
  19635. /**
  19636. * Sets the given local transformation matrix to the defined instance.
  19637. * Negatively scaled matrices are not supported.
  19638. *
  19639. * @param {number} instanceId - The ID of an instance to set the matrix of.
  19640. * @param {Matrix4} matrix - A 4x4 matrix representing the local transformation of a single instance.
  19641. * @return {BatchedMesh} A reference to this batched mesh.
  19642. */
  19643. setMatrixAt( instanceId, matrix ) {
  19644. this.validateInstanceId( instanceId );
  19645. const matricesTexture = this._matricesTexture;
  19646. const matricesArray = this._matricesTexture.image.data;
  19647. matrix.toArray( matricesArray, instanceId * 16 );
  19648. matricesTexture.needsUpdate = true;
  19649. return this;
  19650. }
  19651. /**
  19652. * Returns the local transformation matrix of the defined instance.
  19653. *
  19654. * @param {number} instanceId - The ID of an instance to get the matrix of.
  19655. * @param {Matrix4} matrix - The target object that is used to store the method's result.
  19656. * @return {Matrix4} The instance's local transformation matrix.
  19657. */
  19658. getMatrixAt( instanceId, matrix ) {
  19659. this.validateInstanceId( instanceId );
  19660. return matrix.fromArray( this._matricesTexture.image.data, instanceId * 16 );
  19661. }
  19662. /**
  19663. * Sets the given color to the defined instance.
  19664. *
  19665. * @param {number} instanceId - The ID of an instance to set the color of.
  19666. * @param {Color|Vector4} color - The color to set the instance to. Use a `Vector4` to also define alpha.
  19667. * @return {BatchedMesh} A reference to this batched mesh.
  19668. */
  19669. setColorAt( instanceId, color ) {
  19670. this.validateInstanceId( instanceId );
  19671. if ( this._colorsTexture === null ) {
  19672. this._initColorsTexture();
  19673. }
  19674. color.toArray( this._colorsTexture.image.data, instanceId * 4 );
  19675. this._colorsTexture.needsUpdate = true;
  19676. return this;
  19677. }
  19678. /**
  19679. * Returns the color of the defined instance.
  19680. *
  19681. * @param {number} instanceId - The ID of an instance to get the color of.
  19682. * @param {Color|Vector4} color - The target object that is used to store the method's result.
  19683. * @return {Color|Vector4} The instance's color. Use a `Vector4` to also retrieve alpha.
  19684. */
  19685. getColorAt( instanceId, color ) {
  19686. this.validateInstanceId( instanceId );
  19687. return color.fromArray( this._colorsTexture.image.data, instanceId * 4 );
  19688. }
  19689. /**
  19690. * Sets the visibility of the instance.
  19691. *
  19692. * @param {number} instanceId - The id of the instance to set the visibility of.
  19693. * @param {boolean} visible - Whether the instance is visible or not.
  19694. * @return {BatchedMesh} A reference to this batched mesh.
  19695. */
  19696. setVisibleAt( instanceId, visible ) {
  19697. this.validateInstanceId( instanceId );
  19698. if ( this._instanceInfo[ instanceId ].visible === visible ) {
  19699. return this;
  19700. }
  19701. this._instanceInfo[ instanceId ].visible = visible;
  19702. this._visibilityChanged = true;
  19703. return this;
  19704. }
  19705. /**
  19706. * Returns the visibility state of the defined instance.
  19707. *
  19708. * @param {number} instanceId - The ID of an instance to get the visibility state of.
  19709. * @return {boolean} Whether the instance is visible or not.
  19710. */
  19711. getVisibleAt( instanceId ) {
  19712. this.validateInstanceId( instanceId );
  19713. return this._instanceInfo[ instanceId ].visible;
  19714. }
  19715. /**
  19716. * Sets the geometry ID of the instance at the given index.
  19717. *
  19718. * @param {number} instanceId - The ID of the instance to set the geometry ID of.
  19719. * @param {number} geometryId - The geometry ID to be use by the instance.
  19720. * @return {BatchedMesh} A reference to this batched mesh.
  19721. */
  19722. setGeometryIdAt( instanceId, geometryId ) {
  19723. this.validateInstanceId( instanceId );
  19724. this.validateGeometryId( geometryId );
  19725. this._instanceInfo[ instanceId ].geometryIndex = geometryId;
  19726. return this;
  19727. }
  19728. /**
  19729. * Returns the geometry ID of the defined instance.
  19730. *
  19731. * @param {number} instanceId - The ID of an instance to get the geometry ID of.
  19732. * @return {number} The instance's geometry ID.
  19733. */
  19734. getGeometryIdAt( instanceId ) {
  19735. this.validateInstanceId( instanceId );
  19736. return this._instanceInfo[ instanceId ].geometryIndex;
  19737. }
  19738. /**
  19739. * Get the range representing the subset of triangles related to the attached geometry,
  19740. * indicating the starting offset and count, or `null` if invalid.
  19741. *
  19742. * @param {number} geometryId - The id of the geometry to get the range of.
  19743. * @param {Object} [target] - The target object that is used to store the method's result.
  19744. * @return {{
  19745. * vertexStart:number,vertexCount:number,reservedVertexCount:number,
  19746. * indexStart:number,indexCount:number,reservedIndexCount:number,
  19747. * start:number,count:number
  19748. * }} The result object with range data.
  19749. */
  19750. getGeometryRangeAt( geometryId, target = {} ) {
  19751. this.validateGeometryId( geometryId );
  19752. const geometryInfo = this._geometryInfo[ geometryId ];
  19753. target.vertexStart = geometryInfo.vertexStart;
  19754. target.vertexCount = geometryInfo.vertexCount;
  19755. target.reservedVertexCount = geometryInfo.reservedVertexCount;
  19756. target.indexStart = geometryInfo.indexStart;
  19757. target.indexCount = geometryInfo.indexCount;
  19758. target.reservedIndexCount = geometryInfo.reservedIndexCount;
  19759. target.start = geometryInfo.start;
  19760. target.count = geometryInfo.count;
  19761. return target;
  19762. }
  19763. /**
  19764. * Resizes the necessary buffers to support the provided number of instances.
  19765. * If the provided arguments shrink the number of instances but there are not enough
  19766. * unused Ids at the end of the list then an error is thrown.
  19767. *
  19768. * @param {number} maxInstanceCount - The max number of individual instances that can be added and rendered by the batch.
  19769. */
  19770. setInstanceCount( maxInstanceCount ) {
  19771. // shrink the available instances as much as possible
  19772. const availableInstanceIds = this._availableInstanceIds;
  19773. const instanceInfo = this._instanceInfo;
  19774. availableInstanceIds.sort( ascIdSort );
  19775. while ( availableInstanceIds[ availableInstanceIds.length - 1 ] === instanceInfo.length - 1 ) {
  19776. instanceInfo.pop();
  19777. availableInstanceIds.pop();
  19778. }
  19779. // throw an error if it can't be shrunk to the desired size
  19780. if ( maxInstanceCount < instanceInfo.length ) {
  19781. throw new Error( `BatchedMesh: Instance ids outside the range ${ maxInstanceCount } are being used. Cannot shrink instance count.` );
  19782. }
  19783. // copy the multi draw counts
  19784. const multiDrawCounts = new Int32Array( maxInstanceCount );
  19785. const multiDrawStarts = new Int32Array( maxInstanceCount );
  19786. copyArrayContents( this._multiDrawCounts, multiDrawCounts );
  19787. copyArrayContents( this._multiDrawStarts, multiDrawStarts );
  19788. this._multiDrawCounts = multiDrawCounts;
  19789. this._multiDrawStarts = multiDrawStarts;
  19790. this._maxInstanceCount = maxInstanceCount;
  19791. // update texture data for instance sampling
  19792. const indirectTexture = this._indirectTexture;
  19793. const matricesTexture = this._matricesTexture;
  19794. const colorsTexture = this._colorsTexture;
  19795. indirectTexture.dispose();
  19796. this._initIndirectTexture();
  19797. copyArrayContents( indirectTexture.image.data, this._indirectTexture.image.data );
  19798. matricesTexture.dispose();
  19799. this._initMatricesTexture();
  19800. copyArrayContents( matricesTexture.image.data, this._matricesTexture.image.data );
  19801. if ( colorsTexture ) {
  19802. colorsTexture.dispose();
  19803. this._initColorsTexture();
  19804. copyArrayContents( colorsTexture.image.data, this._colorsTexture.image.data );
  19805. }
  19806. }
  19807. /**
  19808. * Resizes the available space in the batch's vertex and index buffer attributes to the provided sizes.
  19809. * If the provided arguments shrink the geometry buffers but there is not enough unused space at the
  19810. * end of the geometry attributes then an error is thrown.
  19811. *
  19812. * @param {number} maxVertexCount - The maximum number of vertices to be used by all unique geometries to resize to.
  19813. * @param {number} maxIndexCount - The maximum number of indices to be used by all unique geometries to resize to.
  19814. */
  19815. setGeometrySize( maxVertexCount, maxIndexCount ) {
  19816. // Check if we can shrink to the requested vertex attribute size
  19817. const validRanges = [ ...this._geometryInfo ].filter( info => info.active );
  19818. const requiredVertexLength = Math.max( ...validRanges.map( range => range.vertexStart + range.reservedVertexCount ) );
  19819. if ( requiredVertexLength > maxVertexCount ) {
  19820. throw new Error( `BatchedMesh: Geometry vertex values are being used outside the range ${ maxIndexCount }. Cannot shrink further.` );
  19821. }
  19822. // Check if we can shrink to the requested index attribute size
  19823. if ( this.geometry.index ) {
  19824. const requiredIndexLength = Math.max( ...validRanges.map( range => range.indexStart + range.reservedIndexCount ) );
  19825. if ( requiredIndexLength > maxIndexCount ) {
  19826. throw new Error( `BatchedMesh: Geometry index values are being used outside the range ${ maxIndexCount }. Cannot shrink further.` );
  19827. }
  19828. }
  19829. //
  19830. // dispose of the previous geometry
  19831. const oldGeometry = this.geometry;
  19832. oldGeometry.dispose();
  19833. // recreate the geometry needed based on the previous variant
  19834. this._maxVertexCount = maxVertexCount;
  19835. this._maxIndexCount = maxIndexCount;
  19836. if ( this._geometryInitialized ) {
  19837. this._geometryInitialized = false;
  19838. this.geometry = new BufferGeometry();
  19839. this._initializeGeometry( oldGeometry );
  19840. }
  19841. // copy data from the previous geometry
  19842. const geometry = this.geometry;
  19843. if ( oldGeometry.index ) {
  19844. copyArrayContents( oldGeometry.index.array, geometry.index.array );
  19845. }
  19846. for ( const key in oldGeometry.attributes ) {
  19847. copyArrayContents( oldGeometry.attributes[ key ].array, geometry.attributes[ key ].array );
  19848. }
  19849. }
  19850. raycast( raycaster, intersects ) {
  19851. const instanceInfo = this._instanceInfo;
  19852. const geometryInfoList = this._geometryInfo;
  19853. const matrixWorld = this.matrixWorld;
  19854. const batchGeometry = this.geometry;
  19855. // iterate over each geometry
  19856. _mesh.material = this.material;
  19857. _mesh.geometry.index = batchGeometry.index;
  19858. _mesh.geometry.attributes = batchGeometry.attributes;
  19859. if ( _mesh.geometry.boundingBox === null ) {
  19860. _mesh.geometry.boundingBox = new Box3();
  19861. }
  19862. if ( _mesh.geometry.boundingSphere === null ) {
  19863. _mesh.geometry.boundingSphere = new Sphere();
  19864. }
  19865. for ( let i = 0, l = instanceInfo.length; i < l; i ++ ) {
  19866. if ( ! instanceInfo[ i ].visible || ! instanceInfo[ i ].active ) {
  19867. continue;
  19868. }
  19869. const geometryId = instanceInfo[ i ].geometryIndex;
  19870. const geometryInfo = geometryInfoList[ geometryId ];
  19871. _mesh.geometry.setDrawRange( geometryInfo.start, geometryInfo.count );
  19872. // get the intersects
  19873. this.getMatrixAt( i, _mesh.matrixWorld ).premultiply( matrixWorld );
  19874. this.getBoundingBoxAt( geometryId, _mesh.geometry.boundingBox );
  19875. this.getBoundingSphereAt( geometryId, _mesh.geometry.boundingSphere );
  19876. _mesh.raycast( raycaster, _batchIntersects );
  19877. // add batch id to the intersects
  19878. for ( let j = 0, l = _batchIntersects.length; j < l; j ++ ) {
  19879. const intersect = _batchIntersects[ j ];
  19880. intersect.object = this;
  19881. intersect.batchId = i;
  19882. intersects.push( intersect );
  19883. }
  19884. _batchIntersects.length = 0;
  19885. }
  19886. _mesh.material = null;
  19887. _mesh.geometry.index = null;
  19888. _mesh.geometry.attributes = {};
  19889. _mesh.geometry.setDrawRange( 0, Infinity );
  19890. }
  19891. copy( source ) {
  19892. super.copy( source );
  19893. this.geometry = source.geometry.clone();
  19894. this.perObjectFrustumCulled = source.perObjectFrustumCulled;
  19895. this.sortObjects = source.sortObjects;
  19896. this.boundingBox = source.boundingBox !== null ? source.boundingBox.clone() : null;
  19897. this.boundingSphere = source.boundingSphere !== null ? source.boundingSphere.clone() : null;
  19898. this._geometryInfo = source._geometryInfo.map( info => ( {
  19899. ...info,
  19900. boundingBox: info.boundingBox !== null ? info.boundingBox.clone() : null,
  19901. boundingSphere: info.boundingSphere !== null ? info.boundingSphere.clone() : null,
  19902. } ) );
  19903. this._instanceInfo = source._instanceInfo.map( info => ( { ...info } ) );
  19904. this._availableInstanceIds = source._availableInstanceIds.slice();
  19905. this._availableGeometryIds = source._availableGeometryIds.slice();
  19906. this._nextIndexStart = source._nextIndexStart;
  19907. this._nextVertexStart = source._nextVertexStart;
  19908. this._geometryCount = source._geometryCount;
  19909. this._maxInstanceCount = source._maxInstanceCount;
  19910. this._maxVertexCount = source._maxVertexCount;
  19911. this._maxIndexCount = source._maxIndexCount;
  19912. this._geometryInitialized = source._geometryInitialized;
  19913. this._multiDrawCounts = source._multiDrawCounts.slice();
  19914. this._multiDrawStarts = source._multiDrawStarts.slice();
  19915. this._indirectTexture = source._indirectTexture.clone();
  19916. this._indirectTexture.image.data = this._indirectTexture.image.data.slice();
  19917. this._matricesTexture = source._matricesTexture.clone();
  19918. this._matricesTexture.image.data = this._matricesTexture.image.data.slice();
  19919. if ( this._colorsTexture !== null ) {
  19920. this._colorsTexture = source._colorsTexture.clone();
  19921. this._colorsTexture.image.data = this._colorsTexture.image.data.slice();
  19922. }
  19923. return this;
  19924. }
  19925. /**
  19926. * Frees the GPU-related resources allocated by this instance. Call this
  19927. * method whenever this instance is no longer used in your app.
  19928. */
  19929. dispose() {
  19930. // Assuming the geometry is not shared with other meshes
  19931. this.geometry.dispose();
  19932. this._matricesTexture.dispose();
  19933. this._matricesTexture = null;
  19934. this._indirectTexture.dispose();
  19935. this._indirectTexture = null;
  19936. if ( this._colorsTexture !== null ) {
  19937. this._colorsTexture.dispose();
  19938. this._colorsTexture = null;
  19939. }
  19940. }
  19941. onBeforeRender( renderer, scene, camera, geometry, material/*, _group*/ ) {
  19942. // if visibility has not changed and frustum culling and object sorting is not required
  19943. // then skip iterating over all items
  19944. if ( ! this._visibilityChanged && ! this.perObjectFrustumCulled && ! this.sortObjects ) {
  19945. return;
  19946. }
  19947. // the indexed version of the multi draw function requires specifying the start
  19948. // offset in bytes.
  19949. const index = geometry.getIndex();
  19950. const bytesPerElement = index === null ? 1 : index.array.BYTES_PER_ELEMENT;
  19951. const instanceInfo = this._instanceInfo;
  19952. const multiDrawStarts = this._multiDrawStarts;
  19953. const multiDrawCounts = this._multiDrawCounts;
  19954. const geometryInfoList = this._geometryInfo;
  19955. const perObjectFrustumCulled = this.perObjectFrustumCulled;
  19956. const indirectTexture = this._indirectTexture;
  19957. const indirectArray = indirectTexture.image.data;
  19958. const frustum = camera.isArrayCamera ? _frustumArray : _frustum;
  19959. // prepare the frustum in the local frame
  19960. if ( perObjectFrustumCulled && ! camera.isArrayCamera ) {
  19961. _matrix$1
  19962. .multiplyMatrices( camera.projectionMatrix, camera.matrixWorldInverse )
  19963. .multiply( this.matrixWorld );
  19964. _frustum.setFromProjectionMatrix(
  19965. _matrix$1,
  19966. camera.coordinateSystem,
  19967. camera.reversedDepth
  19968. );
  19969. }
  19970. let multiDrawCount = 0;
  19971. if ( this.sortObjects ) {
  19972. // get the camera position in the local frame
  19973. _matrix$1.copy( this.matrixWorld ).invert();
  19974. _vector$5.setFromMatrixPosition( camera.matrixWorld ).applyMatrix4( _matrix$1 );
  19975. _forward$1.set( 0, 0, -1 ).transformDirection( camera.matrixWorld ).transformDirection( _matrix$1 );
  19976. for ( let i = 0, l = instanceInfo.length; i < l; i ++ ) {
  19977. if ( instanceInfo[ i ].visible && instanceInfo[ i ].active ) {
  19978. const geometryId = instanceInfo[ i ].geometryIndex;
  19979. // get the bounds in world space
  19980. this.getMatrixAt( i, _matrix$1 );
  19981. this.getBoundingSphereAt( geometryId, _sphere$2 ).applyMatrix4( _matrix$1 );
  19982. // determine whether the batched geometry is within the frustum
  19983. let culled = false;
  19984. if ( perObjectFrustumCulled ) {
  19985. culled = ! frustum.intersectsSphere( _sphere$2, camera );
  19986. }
  19987. if ( ! culled ) {
  19988. // get the distance from camera used for sorting
  19989. const geometryInfo = geometryInfoList[ geometryId ];
  19990. const z = _temp.subVectors( _sphere$2.center, _vector$5 ).dot( _forward$1 );
  19991. _renderList.push( geometryInfo.start, geometryInfo.count, z, i );
  19992. }
  19993. }
  19994. }
  19995. // Sort the draw ranges and prep for rendering
  19996. const list = _renderList.list;
  19997. const customSort = this.customSort;
  19998. if ( customSort === null ) {
  19999. list.sort( material.transparent ? sortTransparent : sortOpaque );
  20000. } else {
  20001. customSort.call( this, list, camera );
  20002. }
  20003. for ( let i = 0, l = list.length; i < l; i ++ ) {
  20004. const item = list[ i ];
  20005. multiDrawStarts[ multiDrawCount ] = item.start * bytesPerElement;
  20006. multiDrawCounts[ multiDrawCount ] = item.count;
  20007. indirectArray[ multiDrawCount ] = item.index;
  20008. multiDrawCount ++;
  20009. }
  20010. _renderList.reset();
  20011. } else {
  20012. for ( let i = 0, l = instanceInfo.length; i < l; i ++ ) {
  20013. if ( instanceInfo[ i ].visible && instanceInfo[ i ].active ) {
  20014. const geometryId = instanceInfo[ i ].geometryIndex;
  20015. // determine whether the batched geometry is within the frustum
  20016. let culled = false;
  20017. if ( perObjectFrustumCulled ) {
  20018. // get the bounds in world space
  20019. this.getMatrixAt( i, _matrix$1 );
  20020. this.getBoundingSphereAt( geometryId, _sphere$2 ).applyMatrix4( _matrix$1 );
  20021. culled = ! frustum.intersectsSphere( _sphere$2, camera );
  20022. }
  20023. if ( ! culled ) {
  20024. const geometryInfo = geometryInfoList[ geometryId ];
  20025. multiDrawStarts[ multiDrawCount ] = geometryInfo.start * bytesPerElement;
  20026. multiDrawCounts[ multiDrawCount ] = geometryInfo.count;
  20027. indirectArray[ multiDrawCount ] = i;
  20028. multiDrawCount ++;
  20029. }
  20030. }
  20031. }
  20032. }
  20033. indirectTexture.needsUpdate = true;
  20034. this._multiDrawCount = multiDrawCount;
  20035. this._visibilityChanged = false;
  20036. }
  20037. onBeforeShadow( renderer, object, camera, shadowCamera, geometry, depthMaterial/* , group */ ) {
  20038. this.onBeforeRender( renderer, null, shadowCamera, geometry, depthMaterial );
  20039. }
  20040. }
  20041. /**
  20042. * A material for rendering line primitives.
  20043. *
  20044. * Materials define the appearance of renderable 3D objects.
  20045. *
  20046. * ```js
  20047. * const material = new THREE.LineBasicMaterial( { color: 0xffffff } );
  20048. * ```
  20049. *
  20050. * @augments Material
  20051. */
  20052. class LineBasicMaterial extends Material {
  20053. /**
  20054. * Constructs a new line basic material.
  20055. *
  20056. * @param {Object} [parameters] - An object with one or more properties
  20057. * defining the material's appearance. Any property of the material
  20058. * (including any property from inherited materials) can be passed
  20059. * in here. Color values can be passed any type of value accepted
  20060. * by {@link Color#set}.
  20061. */
  20062. constructor( parameters ) {
  20063. super();
  20064. /**
  20065. * This flag can be used for type testing.
  20066. *
  20067. * @type {boolean}
  20068. * @readonly
  20069. * @default true
  20070. */
  20071. this.isLineBasicMaterial = true;
  20072. this.type = 'LineBasicMaterial';
  20073. /**
  20074. * Color of the material.
  20075. *
  20076. * @type {Color}
  20077. * @default (1,1,1)
  20078. */
  20079. this.color = new Color( 0xffffff );
  20080. /**
  20081. * Sets the color of the lines using data from a texture. The texture map
  20082. * color is modulated by the diffuse `color`.
  20083. *
  20084. * @type {?Texture}
  20085. * @default null
  20086. */
  20087. this.map = null;
  20088. /**
  20089. * Controls line thickness or lines.
  20090. *
  20091. * Can only be used with {@link SVGRenderer}. WebGL and WebGPU
  20092. * ignore this setting and always render line primitives with a
  20093. * width of one pixel.
  20094. *
  20095. * @type {number}
  20096. * @default 1
  20097. */
  20098. this.linewidth = 1;
  20099. /**
  20100. * Defines appearance of line ends.
  20101. *
  20102. * Can only be used with {@link SVGRenderer}.
  20103. *
  20104. * @type {('butt'|'round'|'square')}
  20105. * @default 'round'
  20106. */
  20107. this.linecap = 'round';
  20108. /**
  20109. * Defines appearance of line joints.
  20110. *
  20111. * Can only be used with {@link SVGRenderer}.
  20112. *
  20113. * @type {('round'|'bevel'|'miter')}
  20114. * @default 'round'
  20115. */
  20116. this.linejoin = 'round';
  20117. /**
  20118. * Whether the material is affected by fog or not.
  20119. *
  20120. * @type {boolean}
  20121. * @default true
  20122. */
  20123. this.fog = true;
  20124. this.setValues( parameters );
  20125. }
  20126. copy( source ) {
  20127. super.copy( source );
  20128. this.color.copy( source.color );
  20129. this.map = source.map;
  20130. this.linewidth = source.linewidth;
  20131. this.linecap = source.linecap;
  20132. this.linejoin = source.linejoin;
  20133. this.fog = source.fog;
  20134. return this;
  20135. }
  20136. }
  20137. const _vStart = /*@__PURE__*/ new Vector3();
  20138. const _vEnd = /*@__PURE__*/ new Vector3();
  20139. const _inverseMatrix$1 = /*@__PURE__*/ new Matrix4();
  20140. const _ray$1 = /*@__PURE__*/ new Ray();
  20141. const _sphere$1 = /*@__PURE__*/ new Sphere();
  20142. const _intersectPointOnRay = /*@__PURE__*/ new Vector3();
  20143. const _intersectPointOnSegment = /*@__PURE__*/ new Vector3();
  20144. /**
  20145. * A continuous line. The line are rendered by connecting consecutive
  20146. * vertices with straight lines.
  20147. *
  20148. * ```js
  20149. * const material = new THREE.LineBasicMaterial( { color: 0x0000ff } );
  20150. *
  20151. * const points = [];
  20152. * points.push( new THREE.Vector3( - 10, 0, 0 ) );
  20153. * points.push( new THREE.Vector3( 0, 10, 0 ) );
  20154. * points.push( new THREE.Vector3( 10, 0, 0 ) );
  20155. *
  20156. * const geometry = new THREE.BufferGeometry().setFromPoints( points );
  20157. *
  20158. * const line = new THREE.Line( geometry, material );
  20159. * scene.add( line );
  20160. * ```
  20161. *
  20162. * @augments Object3D
  20163. */
  20164. class Line extends Object3D {
  20165. /**
  20166. * Constructs a new line.
  20167. *
  20168. * @param {BufferGeometry} [geometry] - The line geometry.
  20169. * @param {Material|Array<Material>} [material] - The line material.
  20170. */
  20171. constructor( geometry = new BufferGeometry(), material = new LineBasicMaterial() ) {
  20172. super();
  20173. /**
  20174. * This flag can be used for type testing.
  20175. *
  20176. * @type {boolean}
  20177. * @readonly
  20178. * @default true
  20179. */
  20180. this.isLine = true;
  20181. this.type = 'Line';
  20182. /**
  20183. * The line geometry.
  20184. *
  20185. * @type {BufferGeometry}
  20186. */
  20187. this.geometry = geometry;
  20188. /**
  20189. * The line material.
  20190. *
  20191. * @type {Material|Array<Material>}
  20192. * @default LineBasicMaterial
  20193. */
  20194. this.material = material;
  20195. /**
  20196. * A dictionary representing the morph targets in the geometry. The key is the
  20197. * morph targets name, the value its attribute index. This member is `undefined`
  20198. * by default and only set when morph targets are detected in the geometry.
  20199. *
  20200. * @type {Object<string,number>|undefined}
  20201. * @default undefined
  20202. */
  20203. this.morphTargetDictionary = undefined;
  20204. /**
  20205. * An array of weights typically in the range `[0,1]` that specify how much of the morph
  20206. * is applied. This member is `undefined` by default and only set when morph targets are
  20207. * detected in the geometry.
  20208. *
  20209. * @type {Array<number>|undefined}
  20210. * @default undefined
  20211. */
  20212. this.morphTargetInfluences = undefined;
  20213. this.updateMorphTargets();
  20214. }
  20215. copy( source, recursive ) {
  20216. super.copy( source, recursive );
  20217. this.material = Array.isArray( source.material ) ? source.material.slice() : source.material;
  20218. this.geometry = source.geometry;
  20219. return this;
  20220. }
  20221. /**
  20222. * Computes an array of distance values which are necessary for rendering dashed lines.
  20223. * For each vertex in the geometry, the method calculates the cumulative length from the
  20224. * current point to the very beginning of the line.
  20225. *
  20226. * @return {Line} A reference to this line.
  20227. */
  20228. computeLineDistances() {
  20229. const geometry = this.geometry;
  20230. // we assume non-indexed geometry
  20231. if ( geometry.index === null ) {
  20232. const positionAttribute = geometry.attributes.position;
  20233. const lineDistances = [ 0 ];
  20234. for ( let i = 1, l = positionAttribute.count; i < l; i ++ ) {
  20235. _vStart.fromBufferAttribute( positionAttribute, i - 1 );
  20236. _vEnd.fromBufferAttribute( positionAttribute, i );
  20237. lineDistances[ i ] = lineDistances[ i - 1 ];
  20238. lineDistances[ i ] += _vStart.distanceTo( _vEnd );
  20239. }
  20240. geometry.setAttribute( 'lineDistance', new Float32BufferAttribute( lineDistances, 1 ) );
  20241. } else {
  20242. warn( 'Line.computeLineDistances(): Computation only possible with non-indexed BufferGeometry.' );
  20243. }
  20244. return this;
  20245. }
  20246. /**
  20247. * Computes intersection points between a casted ray and this line.
  20248. *
  20249. * @param {Raycaster} raycaster - The raycaster.
  20250. * @param {Array<Object>} intersects - The target array that holds the intersection points.
  20251. */
  20252. raycast( raycaster, intersects ) {
  20253. const geometry = this.geometry;
  20254. const matrixWorld = this.matrixWorld;
  20255. const threshold = raycaster.params.Line.threshold;
  20256. const drawRange = geometry.drawRange;
  20257. // Checking boundingSphere distance to ray
  20258. if ( geometry.boundingSphere === null ) geometry.computeBoundingSphere();
  20259. _sphere$1.copy( geometry.boundingSphere );
  20260. _sphere$1.applyMatrix4( matrixWorld );
  20261. _sphere$1.radius += threshold;
  20262. if ( raycaster.ray.intersectsSphere( _sphere$1 ) === false ) return;
  20263. //
  20264. _inverseMatrix$1.copy( matrixWorld ).invert();
  20265. _ray$1.copy( raycaster.ray ).applyMatrix4( _inverseMatrix$1 );
  20266. const localThreshold = threshold / ( ( this.scale.x + this.scale.y + this.scale.z ) / 3 );
  20267. const localThresholdSq = localThreshold * localThreshold;
  20268. const step = this.isLineSegments ? 2 : 1;
  20269. const index = geometry.index;
  20270. const attributes = geometry.attributes;
  20271. const positionAttribute = attributes.position;
  20272. if ( index !== null ) {
  20273. const start = Math.max( 0, drawRange.start );
  20274. const end = Math.min( index.count, ( drawRange.start + drawRange.count ) );
  20275. for ( let i = start, l = end - 1; i < l; i += step ) {
  20276. const a = index.getX( i );
  20277. const b = index.getX( i + 1 );
  20278. const intersect = checkIntersection( this, raycaster, _ray$1, localThresholdSq, a, b, i );
  20279. if ( intersect ) {
  20280. intersects.push( intersect );
  20281. }
  20282. }
  20283. if ( this.isLineLoop ) {
  20284. const a = index.getX( end - 1 );
  20285. const b = index.getX( start );
  20286. const intersect = checkIntersection( this, raycaster, _ray$1, localThresholdSq, a, b, end - 1 );
  20287. if ( intersect ) {
  20288. intersects.push( intersect );
  20289. }
  20290. }
  20291. } else {
  20292. const start = Math.max( 0, drawRange.start );
  20293. const end = Math.min( positionAttribute.count, ( drawRange.start + drawRange.count ) );
  20294. for ( let i = start, l = end - 1; i < l; i += step ) {
  20295. const intersect = checkIntersection( this, raycaster, _ray$1, localThresholdSq, i, i + 1, i );
  20296. if ( intersect ) {
  20297. intersects.push( intersect );
  20298. }
  20299. }
  20300. if ( this.isLineLoop ) {
  20301. const intersect = checkIntersection( this, raycaster, _ray$1, localThresholdSq, end - 1, start, end - 1 );
  20302. if ( intersect ) {
  20303. intersects.push( intersect );
  20304. }
  20305. }
  20306. }
  20307. }
  20308. /**
  20309. * Sets the values of {@link Line#morphTargetDictionary} and {@link Line#morphTargetInfluences}
  20310. * to make sure existing morph targets can influence this 3D object.
  20311. */
  20312. updateMorphTargets() {
  20313. const geometry = this.geometry;
  20314. const morphAttributes = geometry.morphAttributes;
  20315. const keys = Object.keys( morphAttributes );
  20316. if ( keys.length > 0 ) {
  20317. const morphAttribute = morphAttributes[ keys[ 0 ] ];
  20318. if ( morphAttribute !== undefined ) {
  20319. this.morphTargetInfluences = [];
  20320. this.morphTargetDictionary = {};
  20321. for ( let m = 0, ml = morphAttribute.length; m < ml; m ++ ) {
  20322. const name = morphAttribute[ m ].name || String( m );
  20323. this.morphTargetInfluences.push( 0 );
  20324. this.morphTargetDictionary[ name ] = m;
  20325. }
  20326. }
  20327. }
  20328. }
  20329. }
  20330. function checkIntersection( object, raycaster, ray, thresholdSq, a, b, i ) {
  20331. const positionAttribute = object.geometry.attributes.position;
  20332. _vStart.fromBufferAttribute( positionAttribute, a );
  20333. _vEnd.fromBufferAttribute( positionAttribute, b );
  20334. const distSq = ray.distanceSqToSegment( _vStart, _vEnd, _intersectPointOnRay, _intersectPointOnSegment );
  20335. if ( distSq > thresholdSq ) return;
  20336. _intersectPointOnRay.applyMatrix4( object.matrixWorld ); // Move back to world space for distance calculation
  20337. const distance = raycaster.ray.origin.distanceTo( _intersectPointOnRay );
  20338. if ( distance < raycaster.near || distance > raycaster.far ) return;
  20339. return {
  20340. distance: distance,
  20341. // What do we want? intersection point on the ray or on the segment??
  20342. // point: raycaster.ray.at( distance ),
  20343. point: _intersectPointOnSegment.clone().applyMatrix4( object.matrixWorld ),
  20344. index: i,
  20345. face: null,
  20346. faceIndex: null,
  20347. barycoord: null,
  20348. object: object
  20349. };
  20350. }
  20351. const _start = /*@__PURE__*/ new Vector3();
  20352. const _end = /*@__PURE__*/ new Vector3();
  20353. /**
  20354. * A series of lines drawn between pairs of vertices.
  20355. *
  20356. * @augments Line
  20357. */
  20358. class LineSegments extends Line {
  20359. /**
  20360. * Constructs a new line segments.
  20361. *
  20362. * @param {BufferGeometry} [geometry] - The line geometry.
  20363. * @param {Material|Array<Material>} [material] - The line material.
  20364. */
  20365. constructor( geometry, material ) {
  20366. super( geometry, material );
  20367. /**
  20368. * This flag can be used for type testing.
  20369. *
  20370. * @type {boolean}
  20371. * @readonly
  20372. * @default true
  20373. */
  20374. this.isLineSegments = true;
  20375. this.type = 'LineSegments';
  20376. }
  20377. computeLineDistances() {
  20378. const geometry = this.geometry;
  20379. // we assume non-indexed geometry
  20380. if ( geometry.index === null ) {
  20381. const positionAttribute = geometry.attributes.position;
  20382. const lineDistances = [];
  20383. for ( let i = 0, l = positionAttribute.count; i < l; i += 2 ) {
  20384. _start.fromBufferAttribute( positionAttribute, i );
  20385. _end.fromBufferAttribute( positionAttribute, i + 1 );
  20386. lineDistances[ i ] = ( i === 0 ) ? 0 : lineDistances[ i - 1 ];
  20387. lineDistances[ i + 1 ] = lineDistances[ i ] + _start.distanceTo( _end );
  20388. }
  20389. geometry.setAttribute( 'lineDistance', new Float32BufferAttribute( lineDistances, 1 ) );
  20390. } else {
  20391. warn( 'LineSegments.computeLineDistances(): Computation only possible with non-indexed BufferGeometry.' );
  20392. }
  20393. return this;
  20394. }
  20395. }
  20396. /**
  20397. * A continuous line. This is nearly the same as {@link Line} the only difference
  20398. * is that the last vertex is connected with the first vertex in order to close
  20399. * the line to form a loop.
  20400. *
  20401. * @augments Line
  20402. */
  20403. class LineLoop extends Line {
  20404. /**
  20405. * Constructs a new line loop.
  20406. *
  20407. * @param {BufferGeometry} [geometry] - The line geometry.
  20408. * @param {Material|Array<Material>} [material] - The line material.
  20409. */
  20410. constructor( geometry, material ) {
  20411. super( geometry, material );
  20412. /**
  20413. * This flag can be used for type testing.
  20414. *
  20415. * @type {boolean}
  20416. * @readonly
  20417. * @default true
  20418. */
  20419. this.isLineLoop = true;
  20420. this.type = 'LineLoop';
  20421. }
  20422. }
  20423. /**
  20424. * A material for rendering point primitives.
  20425. *
  20426. * Materials define the appearance of renderable 3D objects.
  20427. *
  20428. * ```js
  20429. * const vertices = [];
  20430. *
  20431. * for ( let i = 0; i < 10000; i ++ ) {
  20432. * const x = THREE.MathUtils.randFloatSpread( 2000 );
  20433. * const y = THREE.MathUtils.randFloatSpread( 2000 );
  20434. * const z = THREE.MathUtils.randFloatSpread( 2000 );
  20435. *
  20436. * vertices.push( x, y, z );
  20437. * }
  20438. *
  20439. * const geometry = new THREE.BufferGeometry();
  20440. * geometry.setAttribute( 'position', new THREE.Float32BufferAttribute( vertices, 3 ) );
  20441. * const material = new THREE.PointsMaterial( { color: 0x888888 } );
  20442. * const points = new THREE.Points( geometry, material );
  20443. * scene.add( points );
  20444. * ```
  20445. *
  20446. * @augments Material
  20447. */
  20448. class PointsMaterial extends Material {
  20449. /**
  20450. * Constructs a new points material.
  20451. *
  20452. * @param {Object} [parameters] - An object with one or more properties
  20453. * defining the material's appearance. Any property of the material
  20454. * (including any property from inherited materials) can be passed
  20455. * in here. Color values can be passed any type of value accepted
  20456. * by {@link Color#set}.
  20457. */
  20458. constructor( parameters ) {
  20459. super();
  20460. /**
  20461. * This flag can be used for type testing.
  20462. *
  20463. * @type {boolean}
  20464. * @readonly
  20465. * @default true
  20466. */
  20467. this.isPointsMaterial = true;
  20468. this.type = 'PointsMaterial';
  20469. /**
  20470. * Color of the material.
  20471. *
  20472. * @type {Color}
  20473. * @default (1,1,1)
  20474. */
  20475. this.color = new Color( 0xffffff );
  20476. /**
  20477. * The color map. May optionally include an alpha channel, typically combined
  20478. * with {@link Material#transparent} or {@link Material#alphaTest}. The texture map
  20479. * color is modulated by the diffuse `color`.
  20480. *
  20481. * @type {?Texture}
  20482. * @default null
  20483. */
  20484. this.map = null;
  20485. /**
  20486. * The alpha map is a grayscale texture that controls the opacity across the
  20487. * surface (black: fully transparent; white: fully opaque).
  20488. *
  20489. * Only the color of the texture is used, ignoring the alpha channel if one
  20490. * exists. For RGB and RGBA textures, the renderer will use the green channel
  20491. * when sampling this texture due to the extra bit of precision provided for
  20492. * green in DXT-compressed and uncompressed RGB 565 formats. Luminance-only and
  20493. * luminance/alpha textures will also still work as expected.
  20494. *
  20495. * @type {?Texture}
  20496. * @default null
  20497. */
  20498. this.alphaMap = null;
  20499. /**
  20500. * Defines the size of the points in pixels.
  20501. *
  20502. * Might be capped if the value exceeds hardware dependent parameters like [gl.ALIASED_POINT_SIZE_RANGE](https://developer.mozilla.org/en-US/docs/Web/API/WebGLRenderingContext/getParamete).
  20503. *
  20504. * @type {number}
  20505. * @default 1
  20506. */
  20507. this.size = 1;
  20508. /**
  20509. * Specifies whether size of individual points is attenuated by the camera depth (perspective camera only).
  20510. *
  20511. * @type {boolean}
  20512. * @default true
  20513. */
  20514. this.sizeAttenuation = true;
  20515. /**
  20516. * Whether the material is affected by fog or not.
  20517. *
  20518. * @type {boolean}
  20519. * @default true
  20520. */
  20521. this.fog = true;
  20522. this.setValues( parameters );
  20523. }
  20524. copy( source ) {
  20525. super.copy( source );
  20526. this.color.copy( source.color );
  20527. this.map = source.map;
  20528. this.alphaMap = source.alphaMap;
  20529. this.size = source.size;
  20530. this.sizeAttenuation = source.sizeAttenuation;
  20531. this.fog = source.fog;
  20532. return this;
  20533. }
  20534. }
  20535. const _inverseMatrix = /*@__PURE__*/ new Matrix4();
  20536. const _ray = /*@__PURE__*/ new Ray();
  20537. const _sphere = /*@__PURE__*/ new Sphere();
  20538. const _position$3 = /*@__PURE__*/ new Vector3();
  20539. /**
  20540. * A class for displaying points or point clouds.
  20541. *
  20542. * @augments Object3D
  20543. */
  20544. class Points extends Object3D {
  20545. /**
  20546. * Constructs a new point cloud.
  20547. *
  20548. * @param {BufferGeometry} [geometry] - The points geometry.
  20549. * @param {Material|Array<Material>} [material] - The points material.
  20550. */
  20551. constructor( geometry = new BufferGeometry(), material = new PointsMaterial() ) {
  20552. super();
  20553. /**
  20554. * This flag can be used for type testing.
  20555. *
  20556. * @type {boolean}
  20557. * @readonly
  20558. * @default true
  20559. */
  20560. this.isPoints = true;
  20561. this.type = 'Points';
  20562. /**
  20563. * The points geometry.
  20564. *
  20565. * @type {BufferGeometry}
  20566. */
  20567. this.geometry = geometry;
  20568. /**
  20569. * The line material.
  20570. *
  20571. * @type {Material|Array<Material>}
  20572. * @default PointsMaterial
  20573. */
  20574. this.material = material;
  20575. /**
  20576. * A dictionary representing the morph targets in the geometry. The key is the
  20577. * morph targets name, the value its attribute index. This member is `undefined`
  20578. * by default and only set when morph targets are detected in the geometry.
  20579. *
  20580. * @type {Object<string,number>|undefined}
  20581. * @default undefined
  20582. */
  20583. this.morphTargetDictionary = undefined;
  20584. /**
  20585. * An array of weights typically in the range `[0,1]` that specify how much of the morph
  20586. * is applied. This member is `undefined` by default and only set when morph targets are
  20587. * detected in the geometry.
  20588. *
  20589. * @type {Array<number>|undefined}
  20590. * @default undefined
  20591. */
  20592. this.morphTargetInfluences = undefined;
  20593. this.updateMorphTargets();
  20594. }
  20595. copy( source, recursive ) {
  20596. super.copy( source, recursive );
  20597. this.material = Array.isArray( source.material ) ? source.material.slice() : source.material;
  20598. this.geometry = source.geometry;
  20599. return this;
  20600. }
  20601. /**
  20602. * Computes intersection points between a casted ray and this point cloud.
  20603. *
  20604. * @param {Raycaster} raycaster - The raycaster.
  20605. * @param {Array<Object>} intersects - The target array that holds the intersection points.
  20606. */
  20607. raycast( raycaster, intersects ) {
  20608. const geometry = this.geometry;
  20609. const matrixWorld = this.matrixWorld;
  20610. const threshold = raycaster.params.Points.threshold;
  20611. const drawRange = geometry.drawRange;
  20612. // Checking boundingSphere distance to ray
  20613. if ( geometry.boundingSphere === null ) geometry.computeBoundingSphere();
  20614. _sphere.copy( geometry.boundingSphere );
  20615. _sphere.applyMatrix4( matrixWorld );
  20616. _sphere.radius += threshold;
  20617. if ( raycaster.ray.intersectsSphere( _sphere ) === false ) return;
  20618. //
  20619. _inverseMatrix.copy( matrixWorld ).invert();
  20620. _ray.copy( raycaster.ray ).applyMatrix4( _inverseMatrix );
  20621. const localThreshold = threshold / ( ( this.scale.x + this.scale.y + this.scale.z ) / 3 );
  20622. const localThresholdSq = localThreshold * localThreshold;
  20623. const index = geometry.index;
  20624. const attributes = geometry.attributes;
  20625. const positionAttribute = attributes.position;
  20626. if ( index !== null ) {
  20627. const start = Math.max( 0, drawRange.start );
  20628. const end = Math.min( index.count, ( drawRange.start + drawRange.count ) );
  20629. for ( let i = start, il = end; i < il; i ++ ) {
  20630. const a = index.getX( i );
  20631. _position$3.fromBufferAttribute( positionAttribute, a );
  20632. testPoint( _position$3, a, localThresholdSq, matrixWorld, raycaster, intersects, this );
  20633. }
  20634. } else {
  20635. const start = Math.max( 0, drawRange.start );
  20636. const end = Math.min( positionAttribute.count, ( drawRange.start + drawRange.count ) );
  20637. for ( let i = start, l = end; i < l; i ++ ) {
  20638. _position$3.fromBufferAttribute( positionAttribute, i );
  20639. testPoint( _position$3, i, localThresholdSq, matrixWorld, raycaster, intersects, this );
  20640. }
  20641. }
  20642. }
  20643. /**
  20644. * Sets the values of {@link Points#morphTargetDictionary} and {@link Points#morphTargetInfluences}
  20645. * to make sure existing morph targets can influence this 3D object.
  20646. */
  20647. updateMorphTargets() {
  20648. const geometry = this.geometry;
  20649. const morphAttributes = geometry.morphAttributes;
  20650. const keys = Object.keys( morphAttributes );
  20651. if ( keys.length > 0 ) {
  20652. const morphAttribute = morphAttributes[ keys[ 0 ] ];
  20653. if ( morphAttribute !== undefined ) {
  20654. this.morphTargetInfluences = [];
  20655. this.morphTargetDictionary = {};
  20656. for ( let m = 0, ml = morphAttribute.length; m < ml; m ++ ) {
  20657. const name = morphAttribute[ m ].name || String( m );
  20658. this.morphTargetInfluences.push( 0 );
  20659. this.morphTargetDictionary[ name ] = m;
  20660. }
  20661. }
  20662. }
  20663. }
  20664. }
  20665. function testPoint( point, index, localThresholdSq, matrixWorld, raycaster, intersects, object ) {
  20666. const rayPointDistanceSq = _ray.distanceSqToPoint( point );
  20667. if ( rayPointDistanceSq < localThresholdSq ) {
  20668. const intersectPoint = new Vector3();
  20669. _ray.closestPointToPoint( point, intersectPoint );
  20670. intersectPoint.applyMatrix4( matrixWorld );
  20671. const distance = raycaster.ray.origin.distanceTo( intersectPoint );
  20672. if ( distance < raycaster.near || distance > raycaster.far ) return;
  20673. intersects.push( {
  20674. distance: distance,
  20675. distanceToRay: Math.sqrt( rayPointDistanceSq ),
  20676. point: intersectPoint,
  20677. index: index,
  20678. face: null,
  20679. faceIndex: null,
  20680. barycoord: null,
  20681. object: object
  20682. } );
  20683. }
  20684. }
  20685. /**
  20686. * A texture for use with a video.
  20687. *
  20688. * ```js
  20689. * // assuming you have created a HTML video element with id="video"
  20690. * const video = document.getElementById( 'video' );
  20691. * const texture = new THREE.VideoTexture( video );
  20692. * ```
  20693. *
  20694. * Note: When using video textures with {@link WebGPURenderer}, {@link Texture#colorSpace} must be
  20695. * set to THREE.SRGBColorSpace.
  20696. *
  20697. * Note: After the initial use of a texture, its dimensions, format, and type
  20698. * cannot be changed. Instead, call {@link Texture#dispose} on the texture and instantiate a new one.
  20699. *
  20700. * @augments Texture
  20701. */
  20702. class VideoTexture extends Texture {
  20703. /**
  20704. * Constructs a new video texture.
  20705. *
  20706. * @param {HTMLVideoElement} video - The video element to use as a data source for the texture.
  20707. * @param {number} [mapping=Texture.DEFAULT_MAPPING] - The texture mapping.
  20708. * @param {number} [wrapS=ClampToEdgeWrapping] - The wrapS value.
  20709. * @param {number} [wrapT=ClampToEdgeWrapping] - The wrapT value.
  20710. * @param {number} [magFilter=LinearFilter] - The mag filter value.
  20711. * @param {number} [minFilter=LinearFilter] - The min filter value.
  20712. * @param {number} [format=RGBAFormat] - The texture format.
  20713. * @param {number} [type=UnsignedByteType] - The texture type.
  20714. * @param {number} [anisotropy=Texture.DEFAULT_ANISOTROPY] - The anisotropy value.
  20715. */
  20716. constructor( video, mapping, wrapS, wrapT, magFilter = LinearFilter, minFilter = LinearFilter, format, type, anisotropy ) {
  20717. super( video, mapping, wrapS, wrapT, magFilter, minFilter, format, type, anisotropy );
  20718. /**
  20719. * This flag can be used for type testing.
  20720. *
  20721. * @type {boolean}
  20722. * @readonly
  20723. * @default true
  20724. */
  20725. this.isVideoTexture = true;
  20726. /**
  20727. * Whether to generate mipmaps (if possible) for a texture.
  20728. *
  20729. * Overwritten and set to `false` by default.
  20730. *
  20731. * @type {boolean}
  20732. * @default false
  20733. */
  20734. this.generateMipmaps = false;
  20735. /**
  20736. * The video frame request callback identifier, which is a positive integer.
  20737. *
  20738. * Value of 0 represents no scheduled rVFC.
  20739. *
  20740. * @private
  20741. * @type {number}
  20742. */
  20743. this._requestVideoFrameCallbackId = 0;
  20744. const scope = this;
  20745. function updateVideo() {
  20746. scope.needsUpdate = true;
  20747. scope._requestVideoFrameCallbackId = video.requestVideoFrameCallback( updateVideo );
  20748. }
  20749. if ( 'requestVideoFrameCallback' in video ) {
  20750. this._requestVideoFrameCallbackId = video.requestVideoFrameCallback( updateVideo );
  20751. }
  20752. }
  20753. clone() {
  20754. return new this.constructor( this.image ).copy( this );
  20755. }
  20756. /**
  20757. * This method is called automatically by the renderer and sets {@link Texture#needsUpdate}
  20758. * to `true` every time a new frame is available.
  20759. *
  20760. * Only relevant if `requestVideoFrameCallback` is not supported in the browser.
  20761. */
  20762. update() {
  20763. const video = this.image;
  20764. const hasVideoFrameCallback = 'requestVideoFrameCallback' in video;
  20765. if ( hasVideoFrameCallback === false && video.readyState >= video.HAVE_CURRENT_DATA ) {
  20766. this.needsUpdate = true;
  20767. }
  20768. }
  20769. dispose() {
  20770. if ( this._requestVideoFrameCallbackId !== 0 ) {
  20771. this.source.data.cancelVideoFrameCallback( this._requestVideoFrameCallbackId );
  20772. this._requestVideoFrameCallbackId = 0;
  20773. }
  20774. super.dispose();
  20775. }
  20776. }
  20777. /**
  20778. * This class can be used as an alternative way to define video data. Instead of using
  20779. * an instance of `HTMLVideoElement` like with `VideoTexture`, `VideoFrameTexture` expects each frame is
  20780. * defined manually via {@link VideoFrameTexture#setFrame}. A typical use case for this module is when
  20781. * video frames are decoded with the WebCodecs API.
  20782. *
  20783. * ```js
  20784. * const texture = new THREE.VideoFrameTexture();
  20785. * texture.setFrame( frame );
  20786. * ```
  20787. *
  20788. * @augments VideoTexture
  20789. */
  20790. class VideoFrameTexture extends VideoTexture {
  20791. /**
  20792. * Constructs a new video frame texture.
  20793. *
  20794. * @param {number} [mapping=Texture.DEFAULT_MAPPING] - The texture mapping.
  20795. * @param {number} [wrapS=ClampToEdgeWrapping] - The wrapS value.
  20796. * @param {number} [wrapT=ClampToEdgeWrapping] - The wrapT value.
  20797. * @param {number} [magFilter=LinearFilter] - The mag filter value.
  20798. * @param {number} [minFilter=LinearFilter] - The min filter value.
  20799. * @param {number} [format=RGBAFormat] - The texture format.
  20800. * @param {number} [type=UnsignedByteType] - The texture type.
  20801. * @param {number} [anisotropy=Texture.DEFAULT_ANISOTROPY] - The anisotropy value.
  20802. */
  20803. constructor( mapping, wrapS, wrapT, magFilter, minFilter, format, type, anisotropy ) {
  20804. super( {}, mapping, wrapS, wrapT, magFilter, minFilter, format, type, anisotropy );
  20805. /**
  20806. * This flag can be used for type testing.
  20807. *
  20808. * @type {boolean}
  20809. * @readonly
  20810. * @default true
  20811. */
  20812. this.isVideoFrameTexture = true;
  20813. }
  20814. /**
  20815. * This method overwritten with an empty implementation since
  20816. * this type of texture is updated via `setFrame()`.
  20817. */
  20818. update() {}
  20819. clone() {
  20820. return new this.constructor().copy( this ); // restoring Texture.clone()
  20821. }
  20822. /**
  20823. * Sets the current frame of the video. This will automatically update the texture
  20824. * so the data can be used for rendering.
  20825. *
  20826. * @param {VideoFrame} frame - The video frame.
  20827. */
  20828. setFrame( frame ) {
  20829. this.image = frame;
  20830. this.needsUpdate = true;
  20831. }
  20832. }
  20833. /**
  20834. * This class can only be used in combination with `copyFramebufferToTexture()` methods
  20835. * of renderers. It extracts the contents of the current bound framebuffer and provides it
  20836. * as a texture for further usage.
  20837. *
  20838. * ```js
  20839. * const pixelRatio = window.devicePixelRatio;
  20840. * const textureSize = 128 * pixelRatio;
  20841. *
  20842. * const frameTexture = new FramebufferTexture( textureSize, textureSize );
  20843. *
  20844. * // calculate start position for copying part of the frame data
  20845. * const vector = new Vector2();
  20846. * vector.x = ( window.innerWidth * pixelRatio / 2 ) - ( textureSize / 2 );
  20847. * vector.y = ( window.innerHeight * pixelRatio / 2 ) - ( textureSize / 2 );
  20848. *
  20849. * renderer.render( scene, camera );
  20850. *
  20851. * // copy part of the rendered frame into the framebuffer texture
  20852. * renderer.copyFramebufferToTexture( frameTexture, vector );
  20853. * ```
  20854. *
  20855. * @augments Texture
  20856. */
  20857. class FramebufferTexture extends Texture {
  20858. /**
  20859. * Constructs a new framebuffer texture.
  20860. *
  20861. * @param {number} [width] - The width of the texture.
  20862. * @param {number} [height] - The height of the texture.
  20863. */
  20864. constructor( width, height ) {
  20865. super( { width, height } );
  20866. /**
  20867. * This flag can be used for type testing.
  20868. *
  20869. * @type {boolean}
  20870. * @readonly
  20871. * @default true
  20872. */
  20873. this.isFramebufferTexture = true;
  20874. /**
  20875. * How the texture is sampled when a texel covers more than one pixel.
  20876. *
  20877. * Overwritten and set to `NearestFilter` by default to disable filtering.
  20878. *
  20879. * @type {(NearestFilter|NearestMipmapNearestFilter|NearestMipmapLinearFilter|LinearFilter|LinearMipmapNearestFilter|LinearMipmapLinearFilter)}
  20880. * @default NearestFilter
  20881. */
  20882. this.magFilter = NearestFilter;
  20883. /**
  20884. * How the texture is sampled when a texel covers less than one pixel.
  20885. *
  20886. * Overwritten and set to `NearestFilter` by default to disable filtering.
  20887. *
  20888. * @type {(NearestFilter|NearestMipmapNearestFilter|NearestMipmapLinearFilter|LinearFilter|LinearMipmapNearestFilter|LinearMipmapLinearFilter)}
  20889. * @default NearestFilter
  20890. */
  20891. this.minFilter = NearestFilter;
  20892. /**
  20893. * Whether to generate mipmaps (if possible) for a texture.
  20894. *
  20895. * Overwritten and set to `false` by default.
  20896. *
  20897. * @type {boolean}
  20898. * @default false
  20899. */
  20900. this.generateMipmaps = false;
  20901. this.needsUpdate = true;
  20902. }
  20903. }
  20904. /**
  20905. * Creates a texture based on data in compressed form.
  20906. *
  20907. * These texture are usually loaded with {@link CompressedTextureLoader}.
  20908. *
  20909. * @augments Texture
  20910. */
  20911. class CompressedTexture extends Texture {
  20912. /**
  20913. * Constructs a new compressed texture.
  20914. *
  20915. * @param {Array<Object>} mipmaps - This array holds for all mipmaps (including the bases mip)
  20916. * the data and dimensions.
  20917. * @param {number} width - The width of the texture.
  20918. * @param {number} height - The height of the texture.
  20919. * @param {number} [format=RGBAFormat] - The texture format.
  20920. * @param {number} [type=UnsignedByteType] - The texture type.
  20921. * @param {number} [mapping=Texture.DEFAULT_MAPPING] - The texture mapping.
  20922. * @param {number} [wrapS=ClampToEdgeWrapping] - The wrapS value.
  20923. * @param {number} [wrapT=ClampToEdgeWrapping] - The wrapT value.
  20924. * @param {number} [magFilter=LinearFilter] - The mag filter value.
  20925. * @param {number} [minFilter=LinearMipmapLinearFilter] - The min filter value.
  20926. * @param {number} [anisotropy=Texture.DEFAULT_ANISOTROPY] - The anisotropy value.
  20927. * @param {string} [colorSpace=NoColorSpace] - The color space.
  20928. */
  20929. constructor( mipmaps, width, height, format, type, mapping, wrapS, wrapT, magFilter, minFilter, anisotropy, colorSpace ) {
  20930. super( null, mapping, wrapS, wrapT, magFilter, minFilter, format, type, anisotropy, colorSpace );
  20931. /**
  20932. * This flag can be used for type testing.
  20933. *
  20934. * @type {boolean}
  20935. * @readonly
  20936. * @default true
  20937. */
  20938. this.isCompressedTexture = true;
  20939. /**
  20940. * The image property of a compressed texture just defines its dimensions.
  20941. *
  20942. * @type {{width:number,height:number}}
  20943. */
  20944. this.image = { width: width, height: height };
  20945. /**
  20946. * This array holds for all mipmaps (including the bases mip) the data and dimensions.
  20947. *
  20948. * @type {Array<Object>}
  20949. */
  20950. this.mipmaps = mipmaps;
  20951. /**
  20952. * If set to `true`, the texture is flipped along the vertical axis when
  20953. * uploaded to the GPU.
  20954. *
  20955. * Overwritten and set to `false` by default since it is not possible to
  20956. * flip compressed textures.
  20957. *
  20958. * @type {boolean}
  20959. * @default false
  20960. * @readonly
  20961. */
  20962. this.flipY = false;
  20963. /**
  20964. * Whether to generate mipmaps (if possible) for a texture.
  20965. *
  20966. * Overwritten and set to `false` by default since it is not
  20967. * possible to generate mipmaps for compressed data. Mipmaps
  20968. * must be embedded in the compressed texture file.
  20969. *
  20970. * @type {boolean}
  20971. * @default false
  20972. * @readonly
  20973. */
  20974. this.generateMipmaps = false;
  20975. }
  20976. }
  20977. /**
  20978. * Creates a texture 2D array based on data in compressed form.
  20979. *
  20980. * These texture are usually loaded with {@link CompressedTextureLoader}.
  20981. *
  20982. * @augments CompressedTexture
  20983. */
  20984. class CompressedArrayTexture extends CompressedTexture {
  20985. /**
  20986. * Constructs a new compressed array texture.
  20987. *
  20988. * @param {Array<Object>} mipmaps - This array holds for all mipmaps (including the bases mip)
  20989. * the data and dimensions.
  20990. * @param {number} width - The width of the texture.
  20991. * @param {number} height - The height of the texture.
  20992. * @param {number} depth - The depth of the texture.
  20993. * @param {number} [format=RGBAFormat] - The min filter value.
  20994. * @param {number} [type=UnsignedByteType] - The min filter value.
  20995. */
  20996. constructor( mipmaps, width, height, depth, format, type ) {
  20997. super( mipmaps, width, height, format, type );
  20998. /**
  20999. * This flag can be used for type testing.
  21000. *
  21001. * @type {boolean}
  21002. * @readonly
  21003. * @default true
  21004. */
  21005. this.isCompressedArrayTexture = true;
  21006. /**
  21007. * The image property of a compressed texture just defines its dimensions.
  21008. *
  21009. * @name CompressedArrayTexture#image
  21010. * @type {{width:number,height:number,depth:number}}
  21011. */
  21012. this.image.depth = depth;
  21013. /**
  21014. * This defines how the texture is wrapped in the depth and corresponds to
  21015. * *W* in UVW mapping.
  21016. *
  21017. * @type {(RepeatWrapping|ClampToEdgeWrapping|MirroredRepeatWrapping)}
  21018. * @default ClampToEdgeWrapping
  21019. */
  21020. this.wrapR = ClampToEdgeWrapping;
  21021. /**
  21022. * A set of all layers which need to be updated in the texture.
  21023. *
  21024. * @type {Set<number>}
  21025. */
  21026. this.layerUpdates = new Set();
  21027. }
  21028. /**
  21029. * Describes that a specific layer of the texture needs to be updated.
  21030. * Normally when {@link Texture#needsUpdate} is set to `true`, the
  21031. * entire compressed texture array is sent to the GPU. Marking specific
  21032. * layers will only transmit subsets of all mipmaps associated with a
  21033. * specific depth in the array which is often much more performant.
  21034. *
  21035. * @param {number} layerIndex - The layer index that should be updated.
  21036. */
  21037. addLayerUpdate( layerIndex ) {
  21038. this.layerUpdates.add( layerIndex );
  21039. }
  21040. /**
  21041. * Resets the layer updates registry.
  21042. */
  21043. clearLayerUpdates() {
  21044. this.layerUpdates.clear();
  21045. }
  21046. }
  21047. /**
  21048. * Creates a cube texture based on data in compressed form.
  21049. *
  21050. * These texture are usually loaded with {@link CompressedTextureLoader}.
  21051. *
  21052. * @augments CompressedTexture
  21053. */
  21054. class CompressedCubeTexture extends CompressedTexture {
  21055. /**
  21056. * Constructs a new compressed texture.
  21057. *
  21058. * @param {Array<CompressedTexture>} images - An array of compressed textures.
  21059. * @param {number} [format=RGBAFormat] - The texture format.
  21060. * @param {number} [type=UnsignedByteType] - The texture type.
  21061. */
  21062. constructor( images, format, type ) {
  21063. super( undefined, images[ 0 ].width, images[ 0 ].height, format, type, CubeReflectionMapping );
  21064. /**
  21065. * This flag can be used for type testing.
  21066. *
  21067. * @type {boolean}
  21068. * @readonly
  21069. * @default true
  21070. */
  21071. this.isCompressedCubeTexture = true;
  21072. /**
  21073. * This flag can be used for type testing.
  21074. *
  21075. * @type {boolean}
  21076. * @readonly
  21077. * @default true
  21078. */
  21079. this.isCubeTexture = true;
  21080. this.image = images;
  21081. }
  21082. }
  21083. /**
  21084. * Creates a cube texture made up of six images.
  21085. *
  21086. * ```js
  21087. * const loader = new THREE.CubeTextureLoader();
  21088. * loader.setPath( 'textures/cube/pisa/' );
  21089. *
  21090. * const textureCube = loader.load( [
  21091. * 'px.png', 'nx.png', 'py.png', 'ny.png', 'pz.png', 'nz.png'
  21092. * ] );
  21093. *
  21094. * const material = new THREE.MeshBasicMaterial( { color: 0xffffff, envMap: textureCube } );
  21095. * ```
  21096. *
  21097. * @augments Texture
  21098. */
  21099. class CubeTexture extends Texture {
  21100. /**
  21101. * Constructs a new cube texture.
  21102. *
  21103. * @param {Array<Image>} [images=[]] - An array holding a image for each side of a cube.
  21104. * @param {number} [mapping=CubeReflectionMapping] - The texture mapping.
  21105. * @param {number} [wrapS=ClampToEdgeWrapping] - The wrapS value.
  21106. * @param {number} [wrapT=ClampToEdgeWrapping] - The wrapT value.
  21107. * @param {number} [magFilter=LinearFilter] - The mag filter value.
  21108. * @param {number} [minFilter=LinearMipmapLinearFilter] - The min filter value.
  21109. * @param {number} [format=RGBAFormat] - The texture format.
  21110. * @param {number} [type=UnsignedByteType] - The texture type.
  21111. * @param {number} [anisotropy=Texture.DEFAULT_ANISOTROPY] - The anisotropy value.
  21112. * @param {string} [colorSpace=NoColorSpace] - The color space value.
  21113. */
  21114. constructor( images = [], mapping = CubeReflectionMapping, wrapS, wrapT, magFilter, minFilter, format, type, anisotropy, colorSpace ) {
  21115. super( images, mapping, wrapS, wrapT, magFilter, minFilter, format, type, anisotropy, colorSpace );
  21116. /**
  21117. * This flag can be used for type testing.
  21118. *
  21119. * @type {boolean}
  21120. * @readonly
  21121. * @default true
  21122. */
  21123. this.isCubeTexture = true;
  21124. /**
  21125. * If set to `true`, the texture is flipped along the vertical axis when
  21126. * uploaded to the GPU.
  21127. *
  21128. * Overwritten and set to `false` by default.
  21129. *
  21130. * @type {boolean}
  21131. * @default false
  21132. */
  21133. this.flipY = false;
  21134. }
  21135. /**
  21136. * Alias for {@link CubeTexture#image}.
  21137. *
  21138. * @type {Array<Image>}
  21139. */
  21140. get images() {
  21141. return this.image;
  21142. }
  21143. set images( value ) {
  21144. this.image = value;
  21145. }
  21146. }
  21147. /**
  21148. * Creates a texture from a canvas element.
  21149. *
  21150. * This is almost the same as the base texture class, except that it sets {@link Texture#needsUpdate}
  21151. * to `true` immediately since a canvas can directly be used for rendering.
  21152. *
  21153. * @augments Texture
  21154. */
  21155. class CanvasTexture extends Texture {
  21156. /**
  21157. * Constructs a new texture.
  21158. *
  21159. * @param {HTMLCanvasElement} [canvas] - The HTML canvas element.
  21160. * @param {number} [mapping=Texture.DEFAULT_MAPPING] - The texture mapping.
  21161. * @param {number} [wrapS=ClampToEdgeWrapping] - The wrapS value.
  21162. * @param {number} [wrapT=ClampToEdgeWrapping] - The wrapT value.
  21163. * @param {number} [magFilter=LinearFilter] - The mag filter value.
  21164. * @param {number} [minFilter=LinearMipmapLinearFilter] - The min filter value.
  21165. * @param {number} [format=RGBAFormat] - The texture format.
  21166. * @param {number} [type=UnsignedByteType] - The texture type.
  21167. * @param {number} [anisotropy=Texture.DEFAULT_ANISOTROPY] - The anisotropy value.
  21168. */
  21169. constructor( canvas, mapping, wrapS, wrapT, magFilter, minFilter, format, type, anisotropy ) {
  21170. super( canvas, mapping, wrapS, wrapT, magFilter, minFilter, format, type, anisotropy );
  21171. /**
  21172. * This flag can be used for type testing.
  21173. *
  21174. * @type {boolean}
  21175. * @readonly
  21176. * @default true
  21177. */
  21178. this.isCanvasTexture = true;
  21179. this.needsUpdate = true;
  21180. }
  21181. }
  21182. /**
  21183. * This class can be used to automatically save the depth information of a
  21184. * rendering into a texture.
  21185. *
  21186. * @augments Texture
  21187. */
  21188. class DepthTexture extends Texture {
  21189. /**
  21190. * Constructs a new depth texture.
  21191. *
  21192. * @param {number} width - The width of the texture.
  21193. * @param {number} height - The height of the texture.
  21194. * @param {number} [type=UnsignedIntType] - The texture type.
  21195. * @param {number} [mapping=Texture.DEFAULT_MAPPING] - The texture mapping.
  21196. * @param {number} [wrapS=ClampToEdgeWrapping] - The wrapS value.
  21197. * @param {number} [wrapT=ClampToEdgeWrapping] - The wrapT value.
  21198. * @param {number} [magFilter=LinearFilter] - The mag filter value.
  21199. * @param {number} [minFilter=LinearFilter] - The min filter value.
  21200. * @param {number} [anisotropy=Texture.DEFAULT_ANISOTROPY] - The anisotropy value.
  21201. * @param {number} [format=DepthFormat] - The texture format.
  21202. * @param {number} [depth=1] - The depth of the texture.
  21203. */
  21204. constructor( width, height, type = UnsignedIntType, mapping, wrapS, wrapT, magFilter = NearestFilter, minFilter = NearestFilter, anisotropy, format = DepthFormat, depth = 1 ) {
  21205. if ( format !== DepthFormat && format !== DepthStencilFormat ) {
  21206. throw new Error( 'DepthTexture format must be either THREE.DepthFormat or THREE.DepthStencilFormat' );
  21207. }
  21208. const image = { width: width, height: height, depth: depth };
  21209. super( image, mapping, wrapS, wrapT, magFilter, minFilter, format, type, anisotropy );
  21210. /**
  21211. * This flag can be used for type testing.
  21212. *
  21213. * @type {boolean}
  21214. * @readonly
  21215. * @default true
  21216. */
  21217. this.isDepthTexture = true;
  21218. /**
  21219. * If set to `true`, the texture is flipped along the vertical axis when
  21220. * uploaded to the GPU.
  21221. *
  21222. * Overwritten and set to `false` by default.
  21223. *
  21224. * @type {boolean}
  21225. * @default false
  21226. */
  21227. this.flipY = false;
  21228. /**
  21229. * Whether to generate mipmaps (if possible) for a texture.
  21230. *
  21231. * Overwritten and set to `false` by default.
  21232. *
  21233. * @type {boolean}
  21234. * @default false
  21235. */
  21236. this.generateMipmaps = false;
  21237. /**
  21238. * Code corresponding to the depth compare function.
  21239. *
  21240. * @type {?(NeverCompare|LessCompare|EqualCompare|LessEqualCompare|GreaterCompare|NotEqualCompare|GreaterEqualCompare|AlwaysCompare)}
  21241. * @default null
  21242. */
  21243. this.compareFunction = null;
  21244. }
  21245. copy( source ) {
  21246. super.copy( source );
  21247. this.source = new Source( Object.assign( {}, source.image ) ); // see #30540
  21248. this.compareFunction = source.compareFunction;
  21249. return this;
  21250. }
  21251. toJSON( meta ) {
  21252. const data = super.toJSON( meta );
  21253. if ( this.compareFunction !== null ) data.compareFunction = this.compareFunction;
  21254. return data;
  21255. }
  21256. }
  21257. /**
  21258. * This class can be used to automatically save the depth information of a
  21259. * cube rendering into a cube texture with depth format. Used for PointLight shadows.
  21260. *
  21261. * @augments DepthTexture
  21262. */
  21263. class CubeDepthTexture extends DepthTexture {
  21264. /**
  21265. * Constructs a new cube depth texture.
  21266. *
  21267. * @param {number} size - The size (width and height) of each cube face.
  21268. * @param {number} [type=UnsignedIntType] - The texture type.
  21269. * @param {number} [mapping=CubeReflectionMapping] - The texture mapping.
  21270. * @param {number} [wrapS=ClampToEdgeWrapping] - The wrapS value.
  21271. * @param {number} [wrapT=ClampToEdgeWrapping] - The wrapT value.
  21272. * @param {number} [magFilter=NearestFilter] - The mag filter value.
  21273. * @param {number} [minFilter=NearestFilter] - The min filter value.
  21274. * @param {number} [anisotropy=Texture.DEFAULT_ANISOTROPY] - The anisotropy value.
  21275. * @param {number} [format=DepthFormat] - The texture format.
  21276. */
  21277. constructor( size, type = UnsignedIntType, mapping = CubeReflectionMapping, wrapS, wrapT, magFilter = NearestFilter, minFilter = NearestFilter, anisotropy, format = DepthFormat ) {
  21278. // Create 6 identical image descriptors for the cube faces
  21279. const image = { width: size, height: size, depth: 1 };
  21280. const images = [ image, image, image, image, image, image ];
  21281. // Call DepthTexture constructor with width, height
  21282. super( size, size, type, mapping, wrapS, wrapT, magFilter, minFilter, anisotropy, format );
  21283. // Replace the single image with the array of 6 images
  21284. this.image = images;
  21285. /**
  21286. * This flag can be used for type testing.
  21287. *
  21288. * @type {boolean}
  21289. * @readonly
  21290. * @default true
  21291. */
  21292. this.isCubeDepthTexture = true;
  21293. /**
  21294. * Set to true for cube texture handling in WebGLTextures.
  21295. *
  21296. * @type {boolean}
  21297. * @readonly
  21298. * @default true
  21299. */
  21300. this.isCubeTexture = true;
  21301. }
  21302. /**
  21303. * Alias for {@link CubeDepthTexture#image}.
  21304. *
  21305. * @type {Array<Image>}
  21306. */
  21307. get images() {
  21308. return this.image;
  21309. }
  21310. set images( value ) {
  21311. this.image = value;
  21312. }
  21313. }
  21314. /**
  21315. * Represents a texture created externally with the same renderer context.
  21316. *
  21317. * This may be a texture from a protected media stream, device camera feed,
  21318. * or other data feeds like a depth sensor.
  21319. *
  21320. * Note that this class is only supported in {@link WebGLRenderer}, and in
  21321. * the {@link WebGPURenderer} WebGPU backend.
  21322. *
  21323. * @augments Texture
  21324. */
  21325. class ExternalTexture extends Texture {
  21326. /**
  21327. * Creates a new raw texture.
  21328. *
  21329. * @param {?(WebGLTexture|GPUTexture)} [sourceTexture=null] - The external texture.
  21330. */
  21331. constructor( sourceTexture = null ) {
  21332. super();
  21333. /**
  21334. * The external source texture.
  21335. *
  21336. * @type {?(WebGLTexture|GPUTexture)}
  21337. * @default null
  21338. */
  21339. this.sourceTexture = sourceTexture;
  21340. /**
  21341. * This flag can be used for type testing.
  21342. *
  21343. * @type {boolean}
  21344. * @readonly
  21345. * @default true
  21346. */
  21347. this.isExternalTexture = true;
  21348. }
  21349. copy( source ) {
  21350. super.copy( source );
  21351. this.sourceTexture = source.sourceTexture;
  21352. return this;
  21353. }
  21354. }
  21355. /**
  21356. * A geometry class for a rectangular cuboid with a given width, height, and depth.
  21357. * On creation, the cuboid is centred on the origin, with each edge parallel to one
  21358. * of the axes.
  21359. *
  21360. * ```js
  21361. * const geometry = new THREE.BoxGeometry( 1, 1, 1 );
  21362. * const material = new THREE.MeshBasicMaterial( { color: 0x00ff00 } );
  21363. * const cube = new THREE.Mesh( geometry, material );
  21364. * scene.add( cube );
  21365. * ```
  21366. *
  21367. * @augments BufferGeometry
  21368. * @demo scenes/geometry-browser.html#BoxGeometry
  21369. */
  21370. class BoxGeometry extends BufferGeometry {
  21371. /**
  21372. * Constructs a new box geometry.
  21373. *
  21374. * @param {number} [width=1] - The width. That is, the length of the edges parallel to the X axis.
  21375. * @param {number} [height=1] - The height. That is, the length of the edges parallel to the Y axis.
  21376. * @param {number} [depth=1] - The depth. That is, the length of the edges parallel to the Z axis.
  21377. * @param {number} [widthSegments=1] - Number of segmented rectangular faces along the width of the sides.
  21378. * @param {number} [heightSegments=1] - Number of segmented rectangular faces along the height of the sides.
  21379. * @param {number} [depthSegments=1] - Number of segmented rectangular faces along the depth of the sides.
  21380. */
  21381. constructor( width = 1, height = 1, depth = 1, widthSegments = 1, heightSegments = 1, depthSegments = 1 ) {
  21382. super();
  21383. this.type = 'BoxGeometry';
  21384. /**
  21385. * Holds the constructor parameters that have been
  21386. * used to generate the geometry. Any modification
  21387. * after instantiation does not change the geometry.
  21388. *
  21389. * @type {Object}
  21390. */
  21391. this.parameters = {
  21392. width: width,
  21393. height: height,
  21394. depth: depth,
  21395. widthSegments: widthSegments,
  21396. heightSegments: heightSegments,
  21397. depthSegments: depthSegments
  21398. };
  21399. const scope = this;
  21400. // segments
  21401. widthSegments = Math.floor( widthSegments );
  21402. heightSegments = Math.floor( heightSegments );
  21403. depthSegments = Math.floor( depthSegments );
  21404. // buffers
  21405. const indices = [];
  21406. const vertices = [];
  21407. const normals = [];
  21408. const uvs = [];
  21409. // helper variables
  21410. let numberOfVertices = 0;
  21411. let groupStart = 0;
  21412. // build each side of the box geometry
  21413. buildPlane( 'z', 'y', 'x', -1, -1, depth, height, width, depthSegments, heightSegments, 0 ); // px
  21414. buildPlane( 'z', 'y', 'x', 1, -1, depth, height, - width, depthSegments, heightSegments, 1 ); // nx
  21415. buildPlane( 'x', 'z', 'y', 1, 1, width, depth, height, widthSegments, depthSegments, 2 ); // py
  21416. buildPlane( 'x', 'z', 'y', 1, -1, width, depth, - height, widthSegments, depthSegments, 3 ); // ny
  21417. buildPlane( 'x', 'y', 'z', 1, -1, width, height, depth, widthSegments, heightSegments, 4 ); // pz
  21418. buildPlane( 'x', 'y', 'z', -1, -1, width, height, - depth, widthSegments, heightSegments, 5 ); // nz
  21419. // build geometry
  21420. this.setIndex( indices );
  21421. this.setAttribute( 'position', new Float32BufferAttribute( vertices, 3 ) );
  21422. this.setAttribute( 'normal', new Float32BufferAttribute( normals, 3 ) );
  21423. this.setAttribute( 'uv', new Float32BufferAttribute( uvs, 2 ) );
  21424. function buildPlane( u, v, w, udir, vdir, width, height, depth, gridX, gridY, materialIndex ) {
  21425. const segmentWidth = width / gridX;
  21426. const segmentHeight = height / gridY;
  21427. const widthHalf = width / 2;
  21428. const heightHalf = height / 2;
  21429. const depthHalf = depth / 2;
  21430. const gridX1 = gridX + 1;
  21431. const gridY1 = gridY + 1;
  21432. let vertexCounter = 0;
  21433. let groupCount = 0;
  21434. const vector = new Vector3();
  21435. // generate vertices, normals and uvs
  21436. for ( let iy = 0; iy < gridY1; iy ++ ) {
  21437. const y = iy * segmentHeight - heightHalf;
  21438. for ( let ix = 0; ix < gridX1; ix ++ ) {
  21439. const x = ix * segmentWidth - widthHalf;
  21440. // set values to correct vector component
  21441. vector[ u ] = x * udir;
  21442. vector[ v ] = y * vdir;
  21443. vector[ w ] = depthHalf;
  21444. // now apply vector to vertex buffer
  21445. vertices.push( vector.x, vector.y, vector.z );
  21446. // set values to correct vector component
  21447. vector[ u ] = 0;
  21448. vector[ v ] = 0;
  21449. vector[ w ] = depth > 0 ? 1 : -1;
  21450. // now apply vector to normal buffer
  21451. normals.push( vector.x, vector.y, vector.z );
  21452. // uvs
  21453. uvs.push( ix / gridX );
  21454. uvs.push( 1 - ( iy / gridY ) );
  21455. // counters
  21456. vertexCounter += 1;
  21457. }
  21458. }
  21459. // indices
  21460. // 1. you need three indices to draw a single face
  21461. // 2. a single segment consists of two faces
  21462. // 3. so we need to generate six (2*3) indices per segment
  21463. for ( let iy = 0; iy < gridY; iy ++ ) {
  21464. for ( let ix = 0; ix < gridX; ix ++ ) {
  21465. const a = numberOfVertices + ix + gridX1 * iy;
  21466. const b = numberOfVertices + ix + gridX1 * ( iy + 1 );
  21467. const c = numberOfVertices + ( ix + 1 ) + gridX1 * ( iy + 1 );
  21468. const d = numberOfVertices + ( ix + 1 ) + gridX1 * iy;
  21469. // faces
  21470. indices.push( a, b, d );
  21471. indices.push( b, c, d );
  21472. // increase counter
  21473. groupCount += 6;
  21474. }
  21475. }
  21476. // add a group to the geometry. this will ensure multi material support
  21477. scope.addGroup( groupStart, groupCount, materialIndex );
  21478. // calculate new start value for groups
  21479. groupStart += groupCount;
  21480. // update total number of vertices
  21481. numberOfVertices += vertexCounter;
  21482. }
  21483. }
  21484. copy( source ) {
  21485. super.copy( source );
  21486. this.parameters = Object.assign( {}, source.parameters );
  21487. return this;
  21488. }
  21489. /**
  21490. * Factory method for creating an instance of this class from the given
  21491. * JSON object.
  21492. *
  21493. * @param {Object} data - A JSON object representing the serialized geometry.
  21494. * @return {BoxGeometry} A new instance.
  21495. */
  21496. static fromJSON( data ) {
  21497. return new BoxGeometry( data.width, data.height, data.depth, data.widthSegments, data.heightSegments, data.depthSegments );
  21498. }
  21499. }
  21500. /**
  21501. * A geometry class for representing a capsule.
  21502. *
  21503. * ```js
  21504. * const geometry = new THREE.CapsuleGeometry( 1, 1, 4, 8, 1 );
  21505. * const material = new THREE.MeshBasicMaterial( { color: 0x00ff00 } );
  21506. * const capsule = new THREE.Mesh( geometry, material );
  21507. * scene.add( capsule );
  21508. * ```
  21509. *
  21510. * @augments BufferGeometry
  21511. * @demo scenes/geometry-browser.html#CapsuleGeometry
  21512. */
  21513. class CapsuleGeometry extends BufferGeometry {
  21514. /**
  21515. * Constructs a new capsule geometry.
  21516. *
  21517. * @param {number} [radius=1] - Radius of the capsule.
  21518. * @param {number} [height=1] - Height of the middle section.
  21519. * @param {number} [capSegments=4] - Number of curve segments used to build each cap.
  21520. * @param {number} [radialSegments=8] - Number of segmented faces around the circumference of the capsule. Must be an integer >= 3.
  21521. * @param {number} [heightSegments=1] - Number of rows of faces along the height of the middle section. Must be an integer >= 1.
  21522. */
  21523. constructor( radius = 1, height = 1, capSegments = 4, radialSegments = 8, heightSegments = 1 ) {
  21524. super();
  21525. this.type = 'CapsuleGeometry';
  21526. /**
  21527. * Holds the constructor parameters that have been
  21528. * used to generate the geometry. Any modification
  21529. * after instantiation does not change the geometry.
  21530. *
  21531. * @type {Object}
  21532. */
  21533. this.parameters = {
  21534. radius: radius,
  21535. height: height,
  21536. capSegments: capSegments,
  21537. radialSegments: radialSegments,
  21538. heightSegments: heightSegments,
  21539. };
  21540. height = Math.max( 0, height );
  21541. capSegments = Math.max( 1, Math.floor( capSegments ) );
  21542. radialSegments = Math.max( 3, Math.floor( radialSegments ) );
  21543. heightSegments = Math.max( 1, Math.floor( heightSegments ) );
  21544. // buffers
  21545. const indices = [];
  21546. const vertices = [];
  21547. const normals = [];
  21548. const uvs = [];
  21549. // helper variables
  21550. const halfHeight = height / 2;
  21551. const capArcLength = ( Math.PI / 2 ) * radius;
  21552. const cylinderPartLength = height;
  21553. const totalArcLength = 2 * capArcLength + cylinderPartLength;
  21554. const numVerticalSegments = capSegments * 2 + heightSegments;
  21555. const verticesPerRow = radialSegments + 1;
  21556. const normal = new Vector3();
  21557. const vertex = new Vector3();
  21558. // generate vertices, normals, and uvs
  21559. for ( let iy = 0; iy <= numVerticalSegments; iy ++ ) {
  21560. let currentArcLength = 0;
  21561. let profileY = 0;
  21562. let profileRadius = 0;
  21563. let normalYComponent = 0;
  21564. if ( iy <= capSegments ) {
  21565. // bottom cap
  21566. const segmentProgress = iy / capSegments;
  21567. const angle = ( segmentProgress * Math.PI ) / 2;
  21568. profileY = - halfHeight - radius * Math.cos( angle );
  21569. profileRadius = radius * Math.sin( angle );
  21570. normalYComponent = - radius * Math.cos( angle );
  21571. currentArcLength = segmentProgress * capArcLength;
  21572. } else if ( iy <= capSegments + heightSegments ) {
  21573. // middle section
  21574. const segmentProgress = ( iy - capSegments ) / heightSegments;
  21575. profileY = - halfHeight + segmentProgress * height;
  21576. profileRadius = radius;
  21577. normalYComponent = 0;
  21578. currentArcLength = capArcLength + segmentProgress * cylinderPartLength;
  21579. } else {
  21580. // top cap
  21581. const segmentProgress =
  21582. ( iy - capSegments - heightSegments ) / capSegments;
  21583. const angle = ( segmentProgress * Math.PI ) / 2;
  21584. profileY = halfHeight + radius * Math.sin( angle );
  21585. profileRadius = radius * Math.cos( angle );
  21586. normalYComponent = radius * Math.sin( angle );
  21587. currentArcLength =
  21588. capArcLength + cylinderPartLength + segmentProgress * capArcLength;
  21589. }
  21590. const v = Math.max( 0, Math.min( 1, currentArcLength / totalArcLength ) );
  21591. // special case for the poles
  21592. let uOffset = 0;
  21593. if ( iy === 0 ) {
  21594. uOffset = 0.5 / radialSegments;
  21595. } else if ( iy === numVerticalSegments ) {
  21596. uOffset = -0.5 / radialSegments;
  21597. }
  21598. for ( let ix = 0; ix <= radialSegments; ix ++ ) {
  21599. const u = ix / radialSegments;
  21600. const theta = u * Math.PI * 2;
  21601. const sinTheta = Math.sin( theta );
  21602. const cosTheta = Math.cos( theta );
  21603. // vertex
  21604. vertex.x = - profileRadius * cosTheta;
  21605. vertex.y = profileY;
  21606. vertex.z = profileRadius * sinTheta;
  21607. vertices.push( vertex.x, vertex.y, vertex.z );
  21608. // normal
  21609. normal.set(
  21610. - profileRadius * cosTheta,
  21611. normalYComponent,
  21612. profileRadius * sinTheta
  21613. );
  21614. normal.normalize();
  21615. normals.push( normal.x, normal.y, normal.z );
  21616. // uv
  21617. uvs.push( u + uOffset, v );
  21618. }
  21619. if ( iy > 0 ) {
  21620. const prevIndexRow = ( iy - 1 ) * verticesPerRow;
  21621. for ( let ix = 0; ix < radialSegments; ix ++ ) {
  21622. const i1 = prevIndexRow + ix;
  21623. const i2 = prevIndexRow + ix + 1;
  21624. const i3 = iy * verticesPerRow + ix;
  21625. const i4 = iy * verticesPerRow + ix + 1;
  21626. indices.push( i1, i2, i3 );
  21627. indices.push( i2, i4, i3 );
  21628. }
  21629. }
  21630. }
  21631. // build geometry
  21632. this.setIndex( indices );
  21633. this.setAttribute( 'position', new Float32BufferAttribute( vertices, 3 ) );
  21634. this.setAttribute( 'normal', new Float32BufferAttribute( normals, 3 ) );
  21635. this.setAttribute( 'uv', new Float32BufferAttribute( uvs, 2 ) );
  21636. }
  21637. copy( source ) {
  21638. super.copy( source );
  21639. this.parameters = Object.assign( {}, source.parameters );
  21640. return this;
  21641. }
  21642. /**
  21643. * Factory method for creating an instance of this class from the given
  21644. * JSON object.
  21645. *
  21646. * @param {Object} data - A JSON object representing the serialized geometry.
  21647. * @return {CapsuleGeometry} A new instance.
  21648. */
  21649. static fromJSON( data ) {
  21650. return new CapsuleGeometry( data.radius, data.height, data.capSegments, data.radialSegments, data.heightSegments );
  21651. }
  21652. }
  21653. /**
  21654. * A simple shape of Euclidean geometry. It is constructed from a
  21655. * number of triangular segments that are oriented around a central point and
  21656. * extend as far out as a given radius. It is built counter-clockwise from a
  21657. * start angle and a given central angle. It can also be used to create
  21658. * regular polygons, where the number of segments determines the number of
  21659. * sides.
  21660. *
  21661. * ```js
  21662. * const geometry = new THREE.CircleGeometry( 5, 32 );
  21663. * const material = new THREE.MeshBasicMaterial( { color: 0xffff00 } );
  21664. * const circle = new THREE.Mesh( geometry, material );
  21665. * scene.add( circle )
  21666. * ```
  21667. *
  21668. * @augments BufferGeometry
  21669. * @demo scenes/geometry-browser.html#CircleGeometry
  21670. */
  21671. class CircleGeometry extends BufferGeometry {
  21672. /**
  21673. * Constructs a new circle geometry.
  21674. *
  21675. * @param {number} [radius=1] - Radius of the circle.
  21676. * @param {number} [segments=32] - Number of segments (triangles), minimum = `3`.
  21677. * @param {number} [thetaStart=0] - Start angle for first segment in radians.
  21678. * @param {number} [thetaLength=Math.PI*2] - The central angle, often called theta,
  21679. * of the circular sector in radians. The default value results in a complete circle.
  21680. */
  21681. constructor( radius = 1, segments = 32, thetaStart = 0, thetaLength = Math.PI * 2 ) {
  21682. super();
  21683. this.type = 'CircleGeometry';
  21684. /**
  21685. * Holds the constructor parameters that have been
  21686. * used to generate the geometry. Any modification
  21687. * after instantiation does not change the geometry.
  21688. *
  21689. * @type {Object}
  21690. */
  21691. this.parameters = {
  21692. radius: radius,
  21693. segments: segments,
  21694. thetaStart: thetaStart,
  21695. thetaLength: thetaLength
  21696. };
  21697. segments = Math.max( 3, segments );
  21698. // buffers
  21699. const indices = [];
  21700. const vertices = [];
  21701. const normals = [];
  21702. const uvs = [];
  21703. // helper variables
  21704. const vertex = new Vector3();
  21705. const uv = new Vector2();
  21706. // center point
  21707. vertices.push( 0, 0, 0 );
  21708. normals.push( 0, 0, 1 );
  21709. uvs.push( 0.5, 0.5 );
  21710. for ( let s = 0, i = 3; s <= segments; s ++, i += 3 ) {
  21711. const segment = thetaStart + s / segments * thetaLength;
  21712. // vertex
  21713. vertex.x = radius * Math.cos( segment );
  21714. vertex.y = radius * Math.sin( segment );
  21715. vertices.push( vertex.x, vertex.y, vertex.z );
  21716. // normal
  21717. normals.push( 0, 0, 1 );
  21718. // uvs
  21719. uv.x = ( vertices[ i ] / radius + 1 ) / 2;
  21720. uv.y = ( vertices[ i + 1 ] / radius + 1 ) / 2;
  21721. uvs.push( uv.x, uv.y );
  21722. }
  21723. // indices
  21724. for ( let i = 1; i <= segments; i ++ ) {
  21725. indices.push( i, i + 1, 0 );
  21726. }
  21727. // build geometry
  21728. this.setIndex( indices );
  21729. this.setAttribute( 'position', new Float32BufferAttribute( vertices, 3 ) );
  21730. this.setAttribute( 'normal', new Float32BufferAttribute( normals, 3 ) );
  21731. this.setAttribute( 'uv', new Float32BufferAttribute( uvs, 2 ) );
  21732. }
  21733. copy( source ) {
  21734. super.copy( source );
  21735. this.parameters = Object.assign( {}, source.parameters );
  21736. return this;
  21737. }
  21738. /**
  21739. * Factory method for creating an instance of this class from the given
  21740. * JSON object.
  21741. *
  21742. * @param {Object} data - A JSON object representing the serialized geometry.
  21743. * @return {CircleGeometry} A new instance.
  21744. */
  21745. static fromJSON( data ) {
  21746. return new CircleGeometry( data.radius, data.segments, data.thetaStart, data.thetaLength );
  21747. }
  21748. }
  21749. /**
  21750. * A geometry class for representing a cylinder.
  21751. *
  21752. * ```js
  21753. * const geometry = new THREE.CylinderGeometry( 5, 5, 20, 32 );
  21754. * const material = new THREE.MeshBasicMaterial( { color: 0xffff00 } );
  21755. * const cylinder = new THREE.Mesh( geometry, material );
  21756. * scene.add( cylinder );
  21757. * ```
  21758. *
  21759. * @augments BufferGeometry
  21760. * @demo scenes/geometry-browser.html#CylinderGeometry
  21761. */
  21762. class CylinderGeometry extends BufferGeometry {
  21763. /**
  21764. * Constructs a new cylinder geometry.
  21765. *
  21766. * @param {number} [radiusTop=1] - Radius of the cylinder at the top.
  21767. * @param {number} [radiusBottom=1] - Radius of the cylinder at the bottom.
  21768. * @param {number} [height=1] - Height of the cylinder.
  21769. * @param {number} [radialSegments=32] - Number of segmented faces around the circumference of the cylinder.
  21770. * @param {number} [heightSegments=1] - Number of rows of faces along the height of the cylinder.
  21771. * @param {boolean} [openEnded=false] - Whether the base of the cylinder is open or capped.
  21772. * @param {number} [thetaStart=0] - Start angle for first segment, in radians.
  21773. * @param {number} [thetaLength=Math.PI*2] - The central angle, often called theta, of the circular sector, in radians.
  21774. * The default value results in a complete cylinder.
  21775. */
  21776. constructor( radiusTop = 1, radiusBottom = 1, height = 1, radialSegments = 32, heightSegments = 1, openEnded = false, thetaStart = 0, thetaLength = Math.PI * 2 ) {
  21777. super();
  21778. this.type = 'CylinderGeometry';
  21779. /**
  21780. * Holds the constructor parameters that have been
  21781. * used to generate the geometry. Any modification
  21782. * after instantiation does not change the geometry.
  21783. *
  21784. * @type {Object}
  21785. */
  21786. this.parameters = {
  21787. radiusTop: radiusTop,
  21788. radiusBottom: radiusBottom,
  21789. height: height,
  21790. radialSegments: radialSegments,
  21791. heightSegments: heightSegments,
  21792. openEnded: openEnded,
  21793. thetaStart: thetaStart,
  21794. thetaLength: thetaLength
  21795. };
  21796. const scope = this;
  21797. radialSegments = Math.floor( radialSegments );
  21798. heightSegments = Math.floor( heightSegments );
  21799. // buffers
  21800. const indices = [];
  21801. const vertices = [];
  21802. const normals = [];
  21803. const uvs = [];
  21804. // helper variables
  21805. let index = 0;
  21806. const indexArray = [];
  21807. const halfHeight = height / 2;
  21808. let groupStart = 0;
  21809. // generate geometry
  21810. generateTorso();
  21811. if ( openEnded === false ) {
  21812. if ( radiusTop > 0 ) generateCap( true );
  21813. if ( radiusBottom > 0 ) generateCap( false );
  21814. }
  21815. // build geometry
  21816. this.setIndex( indices );
  21817. this.setAttribute( 'position', new Float32BufferAttribute( vertices, 3 ) );
  21818. this.setAttribute( 'normal', new Float32BufferAttribute( normals, 3 ) );
  21819. this.setAttribute( 'uv', new Float32BufferAttribute( uvs, 2 ) );
  21820. function generateTorso() {
  21821. const normal = new Vector3();
  21822. const vertex = new Vector3();
  21823. let groupCount = 0;
  21824. // this will be used to calculate the normal
  21825. const slope = ( radiusBottom - radiusTop ) / height;
  21826. // generate vertices, normals and uvs
  21827. for ( let y = 0; y <= heightSegments; y ++ ) {
  21828. const indexRow = [];
  21829. const v = y / heightSegments;
  21830. // calculate the radius of the current row
  21831. const radius = v * ( radiusBottom - radiusTop ) + radiusTop;
  21832. for ( let x = 0; x <= radialSegments; x ++ ) {
  21833. const u = x / radialSegments;
  21834. const theta = u * thetaLength + thetaStart;
  21835. const sinTheta = Math.sin( theta );
  21836. const cosTheta = Math.cos( theta );
  21837. // vertex
  21838. vertex.x = radius * sinTheta;
  21839. vertex.y = - v * height + halfHeight;
  21840. vertex.z = radius * cosTheta;
  21841. vertices.push( vertex.x, vertex.y, vertex.z );
  21842. // normal
  21843. normal.set( sinTheta, slope, cosTheta ).normalize();
  21844. normals.push( normal.x, normal.y, normal.z );
  21845. // uv
  21846. uvs.push( u, 1 - v );
  21847. // save index of vertex in respective row
  21848. indexRow.push( index ++ );
  21849. }
  21850. // now save vertices of the row in our index array
  21851. indexArray.push( indexRow );
  21852. }
  21853. // generate indices
  21854. for ( let x = 0; x < radialSegments; x ++ ) {
  21855. for ( let y = 0; y < heightSegments; y ++ ) {
  21856. // we use the index array to access the correct indices
  21857. const a = indexArray[ y ][ x ];
  21858. const b = indexArray[ y + 1 ][ x ];
  21859. const c = indexArray[ y + 1 ][ x + 1 ];
  21860. const d = indexArray[ y ][ x + 1 ];
  21861. // faces
  21862. if ( radiusTop > 0 || y !== 0 ) {
  21863. indices.push( a, b, d );
  21864. groupCount += 3;
  21865. }
  21866. if ( radiusBottom > 0 || y !== heightSegments - 1 ) {
  21867. indices.push( b, c, d );
  21868. groupCount += 3;
  21869. }
  21870. }
  21871. }
  21872. // add a group to the geometry. this will ensure multi material support
  21873. scope.addGroup( groupStart, groupCount, 0 );
  21874. // calculate new start value for groups
  21875. groupStart += groupCount;
  21876. }
  21877. function generateCap( top ) {
  21878. // save the index of the first center vertex
  21879. const centerIndexStart = index;
  21880. const uv = new Vector2();
  21881. const vertex = new Vector3();
  21882. let groupCount = 0;
  21883. const radius = ( top === true ) ? radiusTop : radiusBottom;
  21884. const sign = ( top === true ) ? 1 : -1;
  21885. // first we generate the center vertex data of the cap.
  21886. // because the geometry needs one set of uvs per face,
  21887. // we must generate a center vertex per face/segment
  21888. for ( let x = 1; x <= radialSegments; x ++ ) {
  21889. // vertex
  21890. vertices.push( 0, halfHeight * sign, 0 );
  21891. // normal
  21892. normals.push( 0, sign, 0 );
  21893. // uv
  21894. uvs.push( 0.5, 0.5 );
  21895. // increase index
  21896. index ++;
  21897. }
  21898. // save the index of the last center vertex
  21899. const centerIndexEnd = index;
  21900. // now we generate the surrounding vertices, normals and uvs
  21901. for ( let x = 0; x <= radialSegments; x ++ ) {
  21902. const u = x / radialSegments;
  21903. const theta = u * thetaLength + thetaStart;
  21904. const cosTheta = Math.cos( theta );
  21905. const sinTheta = Math.sin( theta );
  21906. // vertex
  21907. vertex.x = radius * sinTheta;
  21908. vertex.y = halfHeight * sign;
  21909. vertex.z = radius * cosTheta;
  21910. vertices.push( vertex.x, vertex.y, vertex.z );
  21911. // normal
  21912. normals.push( 0, sign, 0 );
  21913. // uv
  21914. uv.x = ( cosTheta * 0.5 ) + 0.5;
  21915. uv.y = ( sinTheta * 0.5 * sign ) + 0.5;
  21916. uvs.push( uv.x, uv.y );
  21917. // increase index
  21918. index ++;
  21919. }
  21920. // generate indices
  21921. for ( let x = 0; x < radialSegments; x ++ ) {
  21922. const c = centerIndexStart + x;
  21923. const i = centerIndexEnd + x;
  21924. if ( top === true ) {
  21925. // face top
  21926. indices.push( i, i + 1, c );
  21927. } else {
  21928. // face bottom
  21929. indices.push( i + 1, i, c );
  21930. }
  21931. groupCount += 3;
  21932. }
  21933. // add a group to the geometry. this will ensure multi material support
  21934. scope.addGroup( groupStart, groupCount, top === true ? 1 : 2 );
  21935. // calculate new start value for groups
  21936. groupStart += groupCount;
  21937. }
  21938. }
  21939. copy( source ) {
  21940. super.copy( source );
  21941. this.parameters = Object.assign( {}, source.parameters );
  21942. return this;
  21943. }
  21944. /**
  21945. * Factory method for creating an instance of this class from the given
  21946. * JSON object.
  21947. *
  21948. * @param {Object} data - A JSON object representing the serialized geometry.
  21949. * @return {CylinderGeometry} A new instance.
  21950. */
  21951. static fromJSON( data ) {
  21952. return new CylinderGeometry( data.radiusTop, data.radiusBottom, data.height, data.radialSegments, data.heightSegments, data.openEnded, data.thetaStart, data.thetaLength );
  21953. }
  21954. }
  21955. /**
  21956. * A geometry class for representing a cone.
  21957. *
  21958. * ```js
  21959. * const geometry = new THREE.ConeGeometry( 5, 20, 32 );
  21960. * const material = new THREE.MeshBasicMaterial( { color: 0xffff00 } );
  21961. * const cone = new THREE.Mesh(geometry, material );
  21962. * scene.add( cone );
  21963. * ```
  21964. *
  21965. * @augments CylinderGeometry
  21966. * @demo scenes/geometry-browser.html#ConeGeometry
  21967. */
  21968. class ConeGeometry extends CylinderGeometry {
  21969. /**
  21970. * Constructs a new cone geometry.
  21971. *
  21972. * @param {number} [radius=1] - Radius of the cone base.
  21973. * @param {number} [height=1] - Height of the cone.
  21974. * @param {number} [radialSegments=32] - Number of segmented faces around the circumference of the cone.
  21975. * @param {number} [heightSegments=1] - Number of rows of faces along the height of the cone.
  21976. * @param {boolean} [openEnded=false] - Whether the base of the cone is open or capped.
  21977. * @param {number} [thetaStart=0] - Start angle for first segment, in radians.
  21978. * @param {number} [thetaLength=Math.PI*2] - The central angle, often called theta, of the circular sector, in radians.
  21979. * The default value results in a complete cone.
  21980. */
  21981. constructor( radius = 1, height = 1, radialSegments = 32, heightSegments = 1, openEnded = false, thetaStart = 0, thetaLength = Math.PI * 2 ) {
  21982. super( 0, radius, height, radialSegments, heightSegments, openEnded, thetaStart, thetaLength );
  21983. this.type = 'ConeGeometry';
  21984. /**
  21985. * Holds the constructor parameters that have been
  21986. * used to generate the geometry. Any modification
  21987. * after instantiation does not change the geometry.
  21988. *
  21989. * @type {Object}
  21990. */
  21991. this.parameters = {
  21992. radius: radius,
  21993. height: height,
  21994. radialSegments: radialSegments,
  21995. heightSegments: heightSegments,
  21996. openEnded: openEnded,
  21997. thetaStart: thetaStart,
  21998. thetaLength: thetaLength
  21999. };
  22000. }
  22001. /**
  22002. * Factory method for creating an instance of this class from the given
  22003. * JSON object.
  22004. *
  22005. * @param {Object} data - A JSON object representing the serialized geometry.
  22006. * @return {ConeGeometry} A new instance.
  22007. */
  22008. static fromJSON( data ) {
  22009. return new ConeGeometry( data.radius, data.height, data.radialSegments, data.heightSegments, data.openEnded, data.thetaStart, data.thetaLength );
  22010. }
  22011. }
  22012. /**
  22013. * A polyhedron is a solid in three dimensions with flat faces. This class
  22014. * will take an array of vertices, project them onto a sphere, and then
  22015. * divide them up to the desired level of detail.
  22016. *
  22017. * @augments BufferGeometry
  22018. */
  22019. class PolyhedronGeometry extends BufferGeometry {
  22020. /**
  22021. * Constructs a new polyhedron geometry.
  22022. *
  22023. * @param {Array<number>} [vertices] - A flat array of vertices describing the base shape.
  22024. * @param {Array<number>} [indices] - A flat array of indices describing the base shape.
  22025. * @param {number} [radius=1] - The radius of the shape.
  22026. * @param {number} [detail=0] - How many levels to subdivide the geometry. The more detail, the smoother the shape.
  22027. */
  22028. constructor( vertices = [], indices = [], radius = 1, detail = 0 ) {
  22029. super();
  22030. this.type = 'PolyhedronGeometry';
  22031. /**
  22032. * Holds the constructor parameters that have been
  22033. * used to generate the geometry. Any modification
  22034. * after instantiation does not change the geometry.
  22035. *
  22036. * @type {Object}
  22037. */
  22038. this.parameters = {
  22039. vertices: vertices,
  22040. indices: indices,
  22041. radius: radius,
  22042. detail: detail
  22043. };
  22044. // default buffer data
  22045. const vertexBuffer = [];
  22046. const uvBuffer = [];
  22047. // the subdivision creates the vertex buffer data
  22048. subdivide( detail );
  22049. // all vertices should lie on a conceptual sphere with a given radius
  22050. applyRadius( radius );
  22051. // finally, create the uv data
  22052. generateUVs();
  22053. // build non-indexed geometry
  22054. this.setAttribute( 'position', new Float32BufferAttribute( vertexBuffer, 3 ) );
  22055. this.setAttribute( 'normal', new Float32BufferAttribute( vertexBuffer.slice(), 3 ) );
  22056. this.setAttribute( 'uv', new Float32BufferAttribute( uvBuffer, 2 ) );
  22057. if ( detail === 0 ) {
  22058. this.computeVertexNormals(); // flat normals
  22059. } else {
  22060. this.normalizeNormals(); // smooth normals
  22061. }
  22062. // helper functions
  22063. function subdivide( detail ) {
  22064. const a = new Vector3();
  22065. const b = new Vector3();
  22066. const c = new Vector3();
  22067. // iterate over all faces and apply a subdivision with the given detail value
  22068. for ( let i = 0; i < indices.length; i += 3 ) {
  22069. // get the vertices of the face
  22070. getVertexByIndex( indices[ i + 0 ], a );
  22071. getVertexByIndex( indices[ i + 1 ], b );
  22072. getVertexByIndex( indices[ i + 2 ], c );
  22073. // perform subdivision
  22074. subdivideFace( a, b, c, detail );
  22075. }
  22076. }
  22077. function subdivideFace( a, b, c, detail ) {
  22078. const cols = detail + 1;
  22079. // we use this multidimensional array as a data structure for creating the subdivision
  22080. const v = [];
  22081. // construct all of the vertices for this subdivision
  22082. for ( let i = 0; i <= cols; i ++ ) {
  22083. v[ i ] = [];
  22084. const aj = a.clone().lerp( c, i / cols );
  22085. const bj = b.clone().lerp( c, i / cols );
  22086. const rows = cols - i;
  22087. for ( let j = 0; j <= rows; j ++ ) {
  22088. if ( j === 0 && i === cols ) {
  22089. v[ i ][ j ] = aj;
  22090. } else {
  22091. v[ i ][ j ] = aj.clone().lerp( bj, j / rows );
  22092. }
  22093. }
  22094. }
  22095. // construct all of the faces
  22096. for ( let i = 0; i < cols; i ++ ) {
  22097. for ( let j = 0; j < 2 * ( cols - i ) - 1; j ++ ) {
  22098. const k = Math.floor( j / 2 );
  22099. if ( j % 2 === 0 ) {
  22100. pushVertex( v[ i ][ k + 1 ] );
  22101. pushVertex( v[ i + 1 ][ k ] );
  22102. pushVertex( v[ i ][ k ] );
  22103. } else {
  22104. pushVertex( v[ i ][ k + 1 ] );
  22105. pushVertex( v[ i + 1 ][ k + 1 ] );
  22106. pushVertex( v[ i + 1 ][ k ] );
  22107. }
  22108. }
  22109. }
  22110. }
  22111. function applyRadius( radius ) {
  22112. const vertex = new Vector3();
  22113. // iterate over the entire buffer and apply the radius to each vertex
  22114. for ( let i = 0; i < vertexBuffer.length; i += 3 ) {
  22115. vertex.x = vertexBuffer[ i + 0 ];
  22116. vertex.y = vertexBuffer[ i + 1 ];
  22117. vertex.z = vertexBuffer[ i + 2 ];
  22118. vertex.normalize().multiplyScalar( radius );
  22119. vertexBuffer[ i + 0 ] = vertex.x;
  22120. vertexBuffer[ i + 1 ] = vertex.y;
  22121. vertexBuffer[ i + 2 ] = vertex.z;
  22122. }
  22123. }
  22124. function generateUVs() {
  22125. const vertex = new Vector3();
  22126. for ( let i = 0; i < vertexBuffer.length; i += 3 ) {
  22127. vertex.x = vertexBuffer[ i + 0 ];
  22128. vertex.y = vertexBuffer[ i + 1 ];
  22129. vertex.z = vertexBuffer[ i + 2 ];
  22130. const u = azimuth( vertex ) / 2 / Math.PI + 0.5;
  22131. const v = inclination( vertex ) / Math.PI + 0.5;
  22132. uvBuffer.push( u, 1 - v );
  22133. }
  22134. correctUVs();
  22135. correctSeam();
  22136. }
  22137. function correctSeam() {
  22138. // handle case when face straddles the seam, see #3269
  22139. for ( let i = 0; i < uvBuffer.length; i += 6 ) {
  22140. // uv data of a single face
  22141. const x0 = uvBuffer[ i + 0 ];
  22142. const x1 = uvBuffer[ i + 2 ];
  22143. const x2 = uvBuffer[ i + 4 ];
  22144. const max = Math.max( x0, x1, x2 );
  22145. const min = Math.min( x0, x1, x2 );
  22146. // 0.9 is somewhat arbitrary
  22147. if ( max > 0.9 && min < 0.1 ) {
  22148. if ( x0 < 0.2 ) uvBuffer[ i + 0 ] += 1;
  22149. if ( x1 < 0.2 ) uvBuffer[ i + 2 ] += 1;
  22150. if ( x2 < 0.2 ) uvBuffer[ i + 4 ] += 1;
  22151. }
  22152. }
  22153. }
  22154. function pushVertex( vertex ) {
  22155. vertexBuffer.push( vertex.x, vertex.y, vertex.z );
  22156. }
  22157. function getVertexByIndex( index, vertex ) {
  22158. const stride = index * 3;
  22159. vertex.x = vertices[ stride + 0 ];
  22160. vertex.y = vertices[ stride + 1 ];
  22161. vertex.z = vertices[ stride + 2 ];
  22162. }
  22163. function correctUVs() {
  22164. const a = new Vector3();
  22165. const b = new Vector3();
  22166. const c = new Vector3();
  22167. const centroid = new Vector3();
  22168. const uvA = new Vector2();
  22169. const uvB = new Vector2();
  22170. const uvC = new Vector2();
  22171. for ( let i = 0, j = 0; i < vertexBuffer.length; i += 9, j += 6 ) {
  22172. a.set( vertexBuffer[ i + 0 ], vertexBuffer[ i + 1 ], vertexBuffer[ i + 2 ] );
  22173. b.set( vertexBuffer[ i + 3 ], vertexBuffer[ i + 4 ], vertexBuffer[ i + 5 ] );
  22174. c.set( vertexBuffer[ i + 6 ], vertexBuffer[ i + 7 ], vertexBuffer[ i + 8 ] );
  22175. uvA.set( uvBuffer[ j + 0 ], uvBuffer[ j + 1 ] );
  22176. uvB.set( uvBuffer[ j + 2 ], uvBuffer[ j + 3 ] );
  22177. uvC.set( uvBuffer[ j + 4 ], uvBuffer[ j + 5 ] );
  22178. centroid.copy( a ).add( b ).add( c ).divideScalar( 3 );
  22179. const azi = azimuth( centroid );
  22180. correctUV( uvA, j + 0, a, azi );
  22181. correctUV( uvB, j + 2, b, azi );
  22182. correctUV( uvC, j + 4, c, azi );
  22183. }
  22184. }
  22185. function correctUV( uv, stride, vector, azimuth ) {
  22186. if ( ( azimuth < 0 ) && ( uv.x === 1 ) ) {
  22187. uvBuffer[ stride ] = uv.x - 1;
  22188. }
  22189. if ( ( vector.x === 0 ) && ( vector.z === 0 ) ) {
  22190. uvBuffer[ stride ] = azimuth / 2 / Math.PI + 0.5;
  22191. }
  22192. }
  22193. // Angle around the Y axis, counter-clockwise when looking from above.
  22194. function azimuth( vector ) {
  22195. return Math.atan2( vector.z, - vector.x );
  22196. }
  22197. // Angle above the XZ plane.
  22198. function inclination( vector ) {
  22199. return Math.atan2( - vector.y, Math.sqrt( ( vector.x * vector.x ) + ( vector.z * vector.z ) ) );
  22200. }
  22201. }
  22202. copy( source ) {
  22203. super.copy( source );
  22204. this.parameters = Object.assign( {}, source.parameters );
  22205. return this;
  22206. }
  22207. /**
  22208. * Factory method for creating an instance of this class from the given
  22209. * JSON object.
  22210. *
  22211. * @param {Object} data - A JSON object representing the serialized geometry.
  22212. * @return {PolyhedronGeometry} A new instance.
  22213. */
  22214. static fromJSON( data ) {
  22215. return new PolyhedronGeometry( data.vertices, data.indices, data.radius, data.detail );
  22216. }
  22217. }
  22218. /**
  22219. * A geometry class for representing a dodecahedron.
  22220. *
  22221. * ```js
  22222. * const geometry = new THREE.DodecahedronGeometry();
  22223. * const material = new THREE.MeshBasicMaterial( { color: 0xffff00 } );
  22224. * const dodecahedron = new THREE.Mesh( geometry, material );
  22225. * scene.add( dodecahedron );
  22226. * ```
  22227. *
  22228. * @augments PolyhedronGeometry
  22229. * @demo scenes/geometry-browser.html#DodecahedronGeometry
  22230. */
  22231. class DodecahedronGeometry extends PolyhedronGeometry {
  22232. /**
  22233. * Constructs a new dodecahedron geometry.
  22234. *
  22235. * @param {number} [radius=1] - Radius of the dodecahedron.
  22236. * @param {number} [detail=0] - Setting this to a value greater than `0` adds vertices making it no longer a dodecahedron.
  22237. */
  22238. constructor( radius = 1, detail = 0 ) {
  22239. const t = ( 1 + Math.sqrt( 5 ) ) / 2;
  22240. const r = 1 / t;
  22241. const vertices = [
  22242. // (±1, ±1, ±1)
  22243. -1, -1, -1, -1, -1, 1,
  22244. -1, 1, -1, -1, 1, 1,
  22245. 1, -1, -1, 1, -1, 1,
  22246. 1, 1, -1, 1, 1, 1,
  22247. // (0, ±1/φ, ±φ)
  22248. 0, - r, - t, 0, - r, t,
  22249. 0, r, - t, 0, r, t,
  22250. // (±1/φ, ±φ, 0)
  22251. - r, - t, 0, - r, t, 0,
  22252. r, - t, 0, r, t, 0,
  22253. // (±φ, 0, ±1/φ)
  22254. - t, 0, - r, t, 0, - r,
  22255. - t, 0, r, t, 0, r
  22256. ];
  22257. const indices = [
  22258. 3, 11, 7, 3, 7, 15, 3, 15, 13,
  22259. 7, 19, 17, 7, 17, 6, 7, 6, 15,
  22260. 17, 4, 8, 17, 8, 10, 17, 10, 6,
  22261. 8, 0, 16, 8, 16, 2, 8, 2, 10,
  22262. 0, 12, 1, 0, 1, 18, 0, 18, 16,
  22263. 6, 10, 2, 6, 2, 13, 6, 13, 15,
  22264. 2, 16, 18, 2, 18, 3, 2, 3, 13,
  22265. 18, 1, 9, 18, 9, 11, 18, 11, 3,
  22266. 4, 14, 12, 4, 12, 0, 4, 0, 8,
  22267. 11, 9, 5, 11, 5, 19, 11, 19, 7,
  22268. 19, 5, 14, 19, 14, 4, 19, 4, 17,
  22269. 1, 12, 14, 1, 14, 5, 1, 5, 9
  22270. ];
  22271. super( vertices, indices, radius, detail );
  22272. this.type = 'DodecahedronGeometry';
  22273. /**
  22274. * Holds the constructor parameters that have been
  22275. * used to generate the geometry. Any modification
  22276. * after instantiation does not change the geometry.
  22277. *
  22278. * @type {Object}
  22279. */
  22280. this.parameters = {
  22281. radius: radius,
  22282. detail: detail
  22283. };
  22284. }
  22285. /**
  22286. * Factory method for creating an instance of this class from the given
  22287. * JSON object.
  22288. *
  22289. * @param {Object} data - A JSON object representing the serialized geometry.
  22290. * @return {DodecahedronGeometry} A new instance.
  22291. */
  22292. static fromJSON( data ) {
  22293. return new DodecahedronGeometry( data.radius, data.detail );
  22294. }
  22295. }
  22296. const _v0 = /*@__PURE__*/ new Vector3();
  22297. const _v1$1 = /*@__PURE__*/ new Vector3();
  22298. const _normal = /*@__PURE__*/ new Vector3();
  22299. const _triangle = /*@__PURE__*/ new Triangle();
  22300. /**
  22301. * Can be used as a helper object to view the edges of a geometry.
  22302. *
  22303. * ```js
  22304. * const geometry = new THREE.BoxGeometry();
  22305. * const edges = new THREE.EdgesGeometry( geometry );
  22306. * const line = new THREE.LineSegments( edges );
  22307. * scene.add( line );
  22308. * ```
  22309. *
  22310. * Note: It is not yet possible to serialize/deserialize instances of this class.
  22311. *
  22312. * @augments BufferGeometry
  22313. */
  22314. class EdgesGeometry extends BufferGeometry {
  22315. /**
  22316. * Constructs a new edges geometry.
  22317. *
  22318. * @param {?BufferGeometry} [geometry=null] - The geometry.
  22319. * @param {number} [thresholdAngle=1] - An edge is only rendered if the angle (in degrees)
  22320. * between the face normals of the adjoining faces exceeds this value.
  22321. */
  22322. constructor( geometry = null, thresholdAngle = 1 ) {
  22323. super();
  22324. this.type = 'EdgesGeometry';
  22325. /**
  22326. * Holds the constructor parameters that have been
  22327. * used to generate the geometry. Any modification
  22328. * after instantiation does not change the geometry.
  22329. *
  22330. * @type {Object}
  22331. */
  22332. this.parameters = {
  22333. geometry: geometry,
  22334. thresholdAngle: thresholdAngle
  22335. };
  22336. if ( geometry !== null ) {
  22337. const precisionPoints = 4;
  22338. const precision = Math.pow( 10, precisionPoints );
  22339. const thresholdDot = Math.cos( DEG2RAD * thresholdAngle );
  22340. const indexAttr = geometry.getIndex();
  22341. const positionAttr = geometry.getAttribute( 'position' );
  22342. const indexCount = indexAttr ? indexAttr.count : positionAttr.count;
  22343. const indexArr = [ 0, 0, 0 ];
  22344. const vertKeys = [ 'a', 'b', 'c' ];
  22345. const hashes = new Array( 3 );
  22346. const edgeData = {};
  22347. const vertices = [];
  22348. for ( let i = 0; i < indexCount; i += 3 ) {
  22349. if ( indexAttr ) {
  22350. indexArr[ 0 ] = indexAttr.getX( i );
  22351. indexArr[ 1 ] = indexAttr.getX( i + 1 );
  22352. indexArr[ 2 ] = indexAttr.getX( i + 2 );
  22353. } else {
  22354. indexArr[ 0 ] = i;
  22355. indexArr[ 1 ] = i + 1;
  22356. indexArr[ 2 ] = i + 2;
  22357. }
  22358. const { a, b, c } = _triangle;
  22359. a.fromBufferAttribute( positionAttr, indexArr[ 0 ] );
  22360. b.fromBufferAttribute( positionAttr, indexArr[ 1 ] );
  22361. c.fromBufferAttribute( positionAttr, indexArr[ 2 ] );
  22362. _triangle.getNormal( _normal );
  22363. // create hashes for the edge from the vertices
  22364. hashes[ 0 ] = `${ Math.round( a.x * precision ) },${ Math.round( a.y * precision ) },${ Math.round( a.z * precision ) }`;
  22365. hashes[ 1 ] = `${ Math.round( b.x * precision ) },${ Math.round( b.y * precision ) },${ Math.round( b.z * precision ) }`;
  22366. hashes[ 2 ] = `${ Math.round( c.x * precision ) },${ Math.round( c.y * precision ) },${ Math.round( c.z * precision ) }`;
  22367. // skip degenerate triangles
  22368. if ( hashes[ 0 ] === hashes[ 1 ] || hashes[ 1 ] === hashes[ 2 ] || hashes[ 2 ] === hashes[ 0 ] ) {
  22369. continue;
  22370. }
  22371. // iterate over every edge
  22372. for ( let j = 0; j < 3; j ++ ) {
  22373. // get the first and next vertex making up the edge
  22374. const jNext = ( j + 1 ) % 3;
  22375. const vecHash0 = hashes[ j ];
  22376. const vecHash1 = hashes[ jNext ];
  22377. const v0 = _triangle[ vertKeys[ j ] ];
  22378. const v1 = _triangle[ vertKeys[ jNext ] ];
  22379. const hash = `${ vecHash0 }_${ vecHash1 }`;
  22380. const reverseHash = `${ vecHash1 }_${ vecHash0 }`;
  22381. if ( reverseHash in edgeData && edgeData[ reverseHash ] ) {
  22382. // if we found a sibling edge add it into the vertex array if
  22383. // it meets the angle threshold and delete the edge from the map.
  22384. if ( _normal.dot( edgeData[ reverseHash ].normal ) <= thresholdDot ) {
  22385. vertices.push( v0.x, v0.y, v0.z );
  22386. vertices.push( v1.x, v1.y, v1.z );
  22387. }
  22388. edgeData[ reverseHash ] = null;
  22389. } else if ( ! ( hash in edgeData ) ) {
  22390. // if we've already got an edge here then skip adding a new one
  22391. edgeData[ hash ] = {
  22392. index0: indexArr[ j ],
  22393. index1: indexArr[ jNext ],
  22394. normal: _normal.clone(),
  22395. };
  22396. }
  22397. }
  22398. }
  22399. // iterate over all remaining, unmatched edges and add them to the vertex array
  22400. for ( const key in edgeData ) {
  22401. if ( edgeData[ key ] ) {
  22402. const { index0, index1 } = edgeData[ key ];
  22403. _v0.fromBufferAttribute( positionAttr, index0 );
  22404. _v1$1.fromBufferAttribute( positionAttr, index1 );
  22405. vertices.push( _v0.x, _v0.y, _v0.z );
  22406. vertices.push( _v1$1.x, _v1$1.y, _v1$1.z );
  22407. }
  22408. }
  22409. this.setAttribute( 'position', new Float32BufferAttribute( vertices, 3 ) );
  22410. }
  22411. }
  22412. copy( source ) {
  22413. super.copy( source );
  22414. this.parameters = Object.assign( {}, source.parameters );
  22415. return this;
  22416. }
  22417. }
  22418. /**
  22419. * An abstract base class for creating an analytic curve object that contains methods
  22420. * for interpolation.
  22421. *
  22422. * @abstract
  22423. */
  22424. class Curve {
  22425. /**
  22426. * Constructs a new curve.
  22427. */
  22428. constructor() {
  22429. /**
  22430. * The type property is used for detecting the object type
  22431. * in context of serialization/deserialization.
  22432. *
  22433. * @type {string}
  22434. * @readonly
  22435. */
  22436. this.type = 'Curve';
  22437. /**
  22438. * This value determines the amount of divisions when calculating the
  22439. * cumulative segment lengths of a curve via {@link Curve#getLengths}. To ensure
  22440. * precision when using methods like {@link Curve#getSpacedPoints}, it is
  22441. * recommended to increase the value of this property if the curve is very large.
  22442. *
  22443. * @type {number}
  22444. * @default 200
  22445. */
  22446. this.arcLengthDivisions = 200;
  22447. /**
  22448. * Must be set to `true` if the curve parameters have changed.
  22449. *
  22450. * @type {boolean}
  22451. * @default false
  22452. */
  22453. this.needsUpdate = false;
  22454. /**
  22455. * An internal cache that holds precomputed curve length values.
  22456. *
  22457. * @private
  22458. * @type {?Array<number>}
  22459. * @default null
  22460. */
  22461. this.cacheArcLengths = null;
  22462. }
  22463. /**
  22464. * This method returns a vector in 2D or 3D space (depending on the curve definition)
  22465. * for the given interpolation factor.
  22466. *
  22467. * @abstract
  22468. * @param {number} t - A interpolation factor representing a position on the curve. Must be in the range `[0,1]`.
  22469. * @param {(Vector2|Vector3)} [optionalTarget] - The optional target vector the result is written to.
  22470. * @return {(Vector2|Vector3)} The position on the curve. It can be a 2D or 3D vector depending on the curve definition.
  22471. */
  22472. getPoint( /* t, optionalTarget */ ) {
  22473. warn( 'Curve: .getPoint() not implemented.' );
  22474. }
  22475. /**
  22476. * This method returns a vector in 2D or 3D space (depending on the curve definition)
  22477. * for the given interpolation factor. Unlike {@link Curve#getPoint}, this method honors the length
  22478. * of the curve which equidistant samples.
  22479. *
  22480. * @param {number} u - A interpolation factor representing a position on the curve. Must be in the range `[0,1]`.
  22481. * @param {(Vector2|Vector3)} [optionalTarget] - The optional target vector the result is written to.
  22482. * @return {(Vector2|Vector3)} The position on the curve. It can be a 2D or 3D vector depending on the curve definition.
  22483. */
  22484. getPointAt( u, optionalTarget ) {
  22485. const t = this.getUtoTmapping( u );
  22486. return this.getPoint( t, optionalTarget );
  22487. }
  22488. /**
  22489. * This method samples the curve via {@link Curve#getPoint} and returns an array of points representing
  22490. * the curve shape.
  22491. *
  22492. * @param {number} [divisions=5] - The number of divisions.
  22493. * @return {Array<(Vector2|Vector3)>} An array holding the sampled curve values. The number of points is `divisions + 1`.
  22494. */
  22495. getPoints( divisions = 5 ) {
  22496. const points = [];
  22497. for ( let d = 0; d <= divisions; d ++ ) {
  22498. points.push( this.getPoint( d / divisions ) );
  22499. }
  22500. return points;
  22501. }
  22502. // Get sequence of points using getPointAt( u )
  22503. /**
  22504. * This method samples the curve via {@link Curve#getPointAt} and returns an array of points representing
  22505. * the curve shape. Unlike {@link Curve#getPoints}, this method returns equi-spaced points across the entire
  22506. * curve.
  22507. *
  22508. * @param {number} [divisions=5] - The number of divisions.
  22509. * @return {Array<(Vector2|Vector3)>} An array holding the sampled curve values. The number of points is `divisions + 1`.
  22510. */
  22511. getSpacedPoints( divisions = 5 ) {
  22512. const points = [];
  22513. for ( let d = 0; d <= divisions; d ++ ) {
  22514. points.push( this.getPointAt( d / divisions ) );
  22515. }
  22516. return points;
  22517. }
  22518. /**
  22519. * Returns the total arc length of the curve.
  22520. *
  22521. * @return {number} The length of the curve.
  22522. */
  22523. getLength() {
  22524. const lengths = this.getLengths();
  22525. return lengths[ lengths.length - 1 ];
  22526. }
  22527. /**
  22528. * Returns an array of cumulative segment lengths of the curve.
  22529. *
  22530. * @param {number} [divisions=this.arcLengthDivisions] - The number of divisions.
  22531. * @return {Array<number>} An array holding the cumulative segment lengths.
  22532. */
  22533. getLengths( divisions = this.arcLengthDivisions ) {
  22534. if ( this.cacheArcLengths &&
  22535. ( this.cacheArcLengths.length === divisions + 1 ) &&
  22536. ! this.needsUpdate ) {
  22537. return this.cacheArcLengths;
  22538. }
  22539. this.needsUpdate = false;
  22540. const cache = [];
  22541. let current, last = this.getPoint( 0 );
  22542. let sum = 0;
  22543. cache.push( 0 );
  22544. for ( let p = 1; p <= divisions; p ++ ) {
  22545. current = this.getPoint( p / divisions );
  22546. sum += current.distanceTo( last );
  22547. cache.push( sum );
  22548. last = current;
  22549. }
  22550. this.cacheArcLengths = cache;
  22551. return cache; // { sums: cache, sum: sum }; Sum is in the last element.
  22552. }
  22553. /**
  22554. * Update the cumulative segment distance cache. The method must be called
  22555. * every time curve parameters are changed. If an updated curve is part of a
  22556. * composed curve like {@link CurvePath}, this method must be called on the
  22557. * composed curve, too.
  22558. */
  22559. updateArcLengths() {
  22560. this.needsUpdate = true;
  22561. this.getLengths();
  22562. }
  22563. /**
  22564. * Given an interpolation factor in the range `[0,1]`, this method returns an updated
  22565. * interpolation factor in the same range that can be ued to sample equidistant points
  22566. * from a curve.
  22567. *
  22568. * @param {number} u - The interpolation factor.
  22569. * @param {?number} distance - An optional distance on the curve.
  22570. * @return {number} The updated interpolation factor.
  22571. */
  22572. getUtoTmapping( u, distance = null ) {
  22573. const arcLengths = this.getLengths();
  22574. let i = 0;
  22575. const il = arcLengths.length;
  22576. let targetArcLength; // The targeted u distance value to get
  22577. if ( distance ) {
  22578. targetArcLength = distance;
  22579. } else {
  22580. targetArcLength = u * arcLengths[ il - 1 ];
  22581. }
  22582. // binary search for the index with largest value smaller than target u distance
  22583. let low = 0, high = il - 1, comparison;
  22584. while ( low <= high ) {
  22585. i = Math.floor( low + ( high - low ) / 2 ); // less likely to overflow, though probably not issue here, JS doesn't really have integers, all numbers are floats
  22586. comparison = arcLengths[ i ] - targetArcLength;
  22587. if ( comparison < 0 ) {
  22588. low = i + 1;
  22589. } else if ( comparison > 0 ) {
  22590. high = i - 1;
  22591. } else {
  22592. high = i;
  22593. break;
  22594. // DONE
  22595. }
  22596. }
  22597. i = high;
  22598. if ( arcLengths[ i ] === targetArcLength ) {
  22599. return i / ( il - 1 );
  22600. }
  22601. // we could get finer grain at lengths, or use simple interpolation between two points
  22602. const lengthBefore = arcLengths[ i ];
  22603. const lengthAfter = arcLengths[ i + 1 ];
  22604. const segmentLength = lengthAfter - lengthBefore;
  22605. // determine where we are between the 'before' and 'after' points
  22606. const segmentFraction = ( targetArcLength - lengthBefore ) / segmentLength;
  22607. // add that fractional amount to t
  22608. const t = ( i + segmentFraction ) / ( il - 1 );
  22609. return t;
  22610. }
  22611. /**
  22612. * Returns a unit vector tangent for the given interpolation factor.
  22613. * If the derived curve does not implement its tangent derivation,
  22614. * two points a small delta apart will be used to find its gradient
  22615. * which seems to give a reasonable approximation.
  22616. *
  22617. * @param {number} t - The interpolation factor.
  22618. * @param {(Vector2|Vector3)} [optionalTarget] - The optional target vector the result is written to.
  22619. * @return {(Vector2|Vector3)} The tangent vector.
  22620. */
  22621. getTangent( t, optionalTarget ) {
  22622. const delta = 0.0001;
  22623. let t1 = t - delta;
  22624. let t2 = t + delta;
  22625. // Capping in case of danger
  22626. if ( t1 < 0 ) t1 = 0;
  22627. if ( t2 > 1 ) t2 = 1;
  22628. const pt1 = this.getPoint( t1 );
  22629. const pt2 = this.getPoint( t2 );
  22630. const tangent = optionalTarget || ( ( pt1.isVector2 ) ? new Vector2() : new Vector3() );
  22631. tangent.copy( pt2 ).sub( pt1 ).normalize();
  22632. return tangent;
  22633. }
  22634. /**
  22635. * Same as {@link Curve#getTangent} but with equidistant samples.
  22636. *
  22637. * @param {number} u - The interpolation factor.
  22638. * @param {(Vector2|Vector3)} [optionalTarget] - The optional target vector the result is written to.
  22639. * @return {(Vector2|Vector3)} The tangent vector.
  22640. * @see {@link Curve#getPointAt}
  22641. */
  22642. getTangentAt( u, optionalTarget ) {
  22643. const t = this.getUtoTmapping( u );
  22644. return this.getTangent( t, optionalTarget );
  22645. }
  22646. /**
  22647. * Generates the Frenet Frames. Requires a curve definition in 3D space. Used
  22648. * in geometries like {@link TubeGeometry} or {@link ExtrudeGeometry}.
  22649. *
  22650. * @param {number} segments - The number of segments.
  22651. * @param {boolean} [closed=false] - Whether the curve is closed or not.
  22652. * @return {{tangents: Array<Vector3>, normals: Array<Vector3>, binormals: Array<Vector3>}} The Frenet Frames.
  22653. */
  22654. computeFrenetFrames( segments, closed = false ) {
  22655. // see http://www.cs.indiana.edu/pub/techreports/TR425.pdf
  22656. const normal = new Vector3();
  22657. const tangents = [];
  22658. const normals = [];
  22659. const binormals = [];
  22660. const vec = new Vector3();
  22661. const mat = new Matrix4();
  22662. // compute the tangent vectors for each segment on the curve
  22663. for ( let i = 0; i <= segments; i ++ ) {
  22664. const u = i / segments;
  22665. tangents[ i ] = this.getTangentAt( u, new Vector3() );
  22666. }
  22667. // select an initial normal vector perpendicular to the first tangent vector,
  22668. // and in the direction of the minimum tangent xyz component
  22669. normals[ 0 ] = new Vector3();
  22670. binormals[ 0 ] = new Vector3();
  22671. let min = Number.MAX_VALUE;
  22672. const tx = Math.abs( tangents[ 0 ].x );
  22673. const ty = Math.abs( tangents[ 0 ].y );
  22674. const tz = Math.abs( tangents[ 0 ].z );
  22675. if ( tx <= min ) {
  22676. min = tx;
  22677. normal.set( 1, 0, 0 );
  22678. }
  22679. if ( ty <= min ) {
  22680. min = ty;
  22681. normal.set( 0, 1, 0 );
  22682. }
  22683. if ( tz <= min ) {
  22684. normal.set( 0, 0, 1 );
  22685. }
  22686. vec.crossVectors( tangents[ 0 ], normal ).normalize();
  22687. normals[ 0 ].crossVectors( tangents[ 0 ], vec );
  22688. binormals[ 0 ].crossVectors( tangents[ 0 ], normals[ 0 ] );
  22689. // compute the slowly-varying normal and binormal vectors for each segment on the curve
  22690. for ( let i = 1; i <= segments; i ++ ) {
  22691. normals[ i ] = normals[ i - 1 ].clone();
  22692. binormals[ i ] = binormals[ i - 1 ].clone();
  22693. vec.crossVectors( tangents[ i - 1 ], tangents[ i ] );
  22694. if ( vec.length() > Number.EPSILON ) {
  22695. vec.normalize();
  22696. const theta = Math.acos( clamp( tangents[ i - 1 ].dot( tangents[ i ] ), -1, 1 ) ); // clamp for floating pt errors
  22697. normals[ i ].applyMatrix4( mat.makeRotationAxis( vec, theta ) );
  22698. }
  22699. binormals[ i ].crossVectors( tangents[ i ], normals[ i ] );
  22700. }
  22701. // if the curve is closed, postprocess the vectors so the first and last normal vectors are the same
  22702. if ( closed === true ) {
  22703. let theta = Math.acos( clamp( normals[ 0 ].dot( normals[ segments ] ), -1, 1 ) );
  22704. theta /= segments;
  22705. if ( tangents[ 0 ].dot( vec.crossVectors( normals[ 0 ], normals[ segments ] ) ) > 0 ) {
  22706. theta = - theta;
  22707. }
  22708. for ( let i = 1; i <= segments; i ++ ) {
  22709. // twist a little...
  22710. normals[ i ].applyMatrix4( mat.makeRotationAxis( tangents[ i ], theta * i ) );
  22711. binormals[ i ].crossVectors( tangents[ i ], normals[ i ] );
  22712. }
  22713. }
  22714. return {
  22715. tangents: tangents,
  22716. normals: normals,
  22717. binormals: binormals
  22718. };
  22719. }
  22720. /**
  22721. * Returns a new curve with copied values from this instance.
  22722. *
  22723. * @return {Curve} A clone of this instance.
  22724. */
  22725. clone() {
  22726. return new this.constructor().copy( this );
  22727. }
  22728. /**
  22729. * Copies the values of the given curve to this instance.
  22730. *
  22731. * @param {Curve} source - The curve to copy.
  22732. * @return {Curve} A reference to this curve.
  22733. */
  22734. copy( source ) {
  22735. this.arcLengthDivisions = source.arcLengthDivisions;
  22736. return this;
  22737. }
  22738. /**
  22739. * Serializes the curve into JSON.
  22740. *
  22741. * @return {Object} A JSON object representing the serialized curve.
  22742. * @see {@link ObjectLoader#parse}
  22743. */
  22744. toJSON() {
  22745. const data = {
  22746. metadata: {
  22747. version: 4.7,
  22748. type: 'Curve',
  22749. generator: 'Curve.toJSON'
  22750. }
  22751. };
  22752. data.arcLengthDivisions = this.arcLengthDivisions;
  22753. data.type = this.type;
  22754. return data;
  22755. }
  22756. /**
  22757. * Deserializes the curve from the given JSON.
  22758. *
  22759. * @param {Object} json - The JSON holding the serialized curve.
  22760. * @return {Curve} A reference to this curve.
  22761. */
  22762. fromJSON( json ) {
  22763. this.arcLengthDivisions = json.arcLengthDivisions;
  22764. return this;
  22765. }
  22766. }
  22767. /**
  22768. * A curve representing an ellipse.
  22769. *
  22770. * ```js
  22771. * const curve = new THREE.EllipseCurve(
  22772. * 0, 0,
  22773. * 10, 10,
  22774. * 0, 2 * Math.PI,
  22775. * false,
  22776. * 0
  22777. * );
  22778. *
  22779. * const points = curve.getPoints( 50 );
  22780. * const geometry = new THREE.BufferGeometry().setFromPoints( points );
  22781. *
  22782. * const material = new THREE.LineBasicMaterial( { color: 0xff0000 } );
  22783. *
  22784. * // Create the final object to add to the scene
  22785. * const ellipse = new THREE.Line( geometry, material );
  22786. * ```
  22787. *
  22788. * @augments Curve
  22789. */
  22790. class EllipseCurve extends Curve {
  22791. /**
  22792. * Constructs a new ellipse curve.
  22793. *
  22794. * @param {number} [aX=0] - The X center of the ellipse.
  22795. * @param {number} [aY=0] - The Y center of the ellipse.
  22796. * @param {number} [xRadius=1] - The radius of the ellipse in the x direction.
  22797. * @param {number} [yRadius=1] - The radius of the ellipse in the y direction.
  22798. * @param {number} [aStartAngle=0] - The start angle of the curve in radians starting from the positive X axis.
  22799. * @param {number} [aEndAngle=Math.PI*2] - The end angle of the curve in radians starting from the positive X axis.
  22800. * @param {boolean} [aClockwise=false] - Whether the ellipse is drawn clockwise or not.
  22801. * @param {number} [aRotation=0] - The rotation angle of the ellipse in radians, counterclockwise from the positive X axis.
  22802. */
  22803. constructor( aX = 0, aY = 0, xRadius = 1, yRadius = 1, aStartAngle = 0, aEndAngle = Math.PI * 2, aClockwise = false, aRotation = 0 ) {
  22804. super();
  22805. /**
  22806. * This flag can be used for type testing.
  22807. *
  22808. * @type {boolean}
  22809. * @readonly
  22810. * @default true
  22811. */
  22812. this.isEllipseCurve = true;
  22813. this.type = 'EllipseCurve';
  22814. /**
  22815. * The X center of the ellipse.
  22816. *
  22817. * @type {number}
  22818. * @default 0
  22819. */
  22820. this.aX = aX;
  22821. /**
  22822. * The Y center of the ellipse.
  22823. *
  22824. * @type {number}
  22825. * @default 0
  22826. */
  22827. this.aY = aY;
  22828. /**
  22829. * The radius of the ellipse in the x direction.
  22830. * Setting the this value equal to the {@link EllipseCurve#yRadius} will result in a circle.
  22831. *
  22832. * @type {number}
  22833. * @default 1
  22834. */
  22835. this.xRadius = xRadius;
  22836. /**
  22837. * The radius of the ellipse in the y direction.
  22838. * Setting the this value equal to the {@link EllipseCurve#xRadius} will result in a circle.
  22839. *
  22840. * @type {number}
  22841. * @default 1
  22842. */
  22843. this.yRadius = yRadius;
  22844. /**
  22845. * The start angle of the curve in radians starting from the positive X axis.
  22846. *
  22847. * @type {number}
  22848. * @default 0
  22849. */
  22850. this.aStartAngle = aStartAngle;
  22851. /**
  22852. * The end angle of the curve in radians starting from the positive X axis.
  22853. *
  22854. * @type {number}
  22855. * @default Math.PI*2
  22856. */
  22857. this.aEndAngle = aEndAngle;
  22858. /**
  22859. * Whether the ellipse is drawn clockwise or not.
  22860. *
  22861. * @type {boolean}
  22862. * @default false
  22863. */
  22864. this.aClockwise = aClockwise;
  22865. /**
  22866. * The rotation angle of the ellipse in radians, counterclockwise from the positive X axis.
  22867. *
  22868. * @type {number}
  22869. * @default 0
  22870. */
  22871. this.aRotation = aRotation;
  22872. }
  22873. /**
  22874. * Returns a point on the curve.
  22875. *
  22876. * @param {number} t - A interpolation factor representing a position on the curve. Must be in the range `[0,1]`.
  22877. * @param {Vector2} [optionalTarget] - The optional target vector the result is written to.
  22878. * @return {Vector2} The position on the curve.
  22879. */
  22880. getPoint( t, optionalTarget = new Vector2() ) {
  22881. const point = optionalTarget;
  22882. const twoPi = Math.PI * 2;
  22883. let deltaAngle = this.aEndAngle - this.aStartAngle;
  22884. const samePoints = Math.abs( deltaAngle ) < Number.EPSILON;
  22885. // ensures that deltaAngle is 0 .. 2 PI
  22886. while ( deltaAngle < 0 ) deltaAngle += twoPi;
  22887. while ( deltaAngle > twoPi ) deltaAngle -= twoPi;
  22888. if ( deltaAngle < Number.EPSILON ) {
  22889. if ( samePoints ) {
  22890. deltaAngle = 0;
  22891. } else {
  22892. deltaAngle = twoPi;
  22893. }
  22894. }
  22895. if ( this.aClockwise === true && ! samePoints ) {
  22896. if ( deltaAngle === twoPi ) {
  22897. deltaAngle = - twoPi;
  22898. } else {
  22899. deltaAngle = deltaAngle - twoPi;
  22900. }
  22901. }
  22902. const angle = this.aStartAngle + t * deltaAngle;
  22903. let x = this.aX + this.xRadius * Math.cos( angle );
  22904. let y = this.aY + this.yRadius * Math.sin( angle );
  22905. if ( this.aRotation !== 0 ) {
  22906. const cos = Math.cos( this.aRotation );
  22907. const sin = Math.sin( this.aRotation );
  22908. const tx = x - this.aX;
  22909. const ty = y - this.aY;
  22910. // Rotate the point about the center of the ellipse.
  22911. x = tx * cos - ty * sin + this.aX;
  22912. y = tx * sin + ty * cos + this.aY;
  22913. }
  22914. return point.set( x, y );
  22915. }
  22916. copy( source ) {
  22917. super.copy( source );
  22918. this.aX = source.aX;
  22919. this.aY = source.aY;
  22920. this.xRadius = source.xRadius;
  22921. this.yRadius = source.yRadius;
  22922. this.aStartAngle = source.aStartAngle;
  22923. this.aEndAngle = source.aEndAngle;
  22924. this.aClockwise = source.aClockwise;
  22925. this.aRotation = source.aRotation;
  22926. return this;
  22927. }
  22928. toJSON() {
  22929. const data = super.toJSON();
  22930. data.aX = this.aX;
  22931. data.aY = this.aY;
  22932. data.xRadius = this.xRadius;
  22933. data.yRadius = this.yRadius;
  22934. data.aStartAngle = this.aStartAngle;
  22935. data.aEndAngle = this.aEndAngle;
  22936. data.aClockwise = this.aClockwise;
  22937. data.aRotation = this.aRotation;
  22938. return data;
  22939. }
  22940. fromJSON( json ) {
  22941. super.fromJSON( json );
  22942. this.aX = json.aX;
  22943. this.aY = json.aY;
  22944. this.xRadius = json.xRadius;
  22945. this.yRadius = json.yRadius;
  22946. this.aStartAngle = json.aStartAngle;
  22947. this.aEndAngle = json.aEndAngle;
  22948. this.aClockwise = json.aClockwise;
  22949. this.aRotation = json.aRotation;
  22950. return this;
  22951. }
  22952. }
  22953. /**
  22954. * A curve representing an arc.
  22955. *
  22956. * @augments EllipseCurve
  22957. */
  22958. class ArcCurve extends EllipseCurve {
  22959. /**
  22960. * Constructs a new arc curve.
  22961. *
  22962. * @param {number} [aX=0] - The X center of the ellipse.
  22963. * @param {number} [aY=0] - The Y center of the ellipse.
  22964. * @param {number} [aRadius=1] - The radius of the ellipse in the x direction.
  22965. * @param {number} [aStartAngle=0] - The start angle of the curve in radians starting from the positive X axis.
  22966. * @param {number} [aEndAngle=Math.PI*2] - The end angle of the curve in radians starting from the positive X axis.
  22967. * @param {boolean} [aClockwise=false] - Whether the ellipse is drawn clockwise or not.
  22968. */
  22969. constructor( aX, aY, aRadius, aStartAngle, aEndAngle, aClockwise ) {
  22970. super( aX, aY, aRadius, aRadius, aStartAngle, aEndAngle, aClockwise );
  22971. /**
  22972. * This flag can be used for type testing.
  22973. *
  22974. * @type {boolean}
  22975. * @readonly
  22976. * @default true
  22977. */
  22978. this.isArcCurve = true;
  22979. this.type = 'ArcCurve';
  22980. }
  22981. }
  22982. function CubicPoly() {
  22983. /**
  22984. * Centripetal CatmullRom Curve - which is useful for avoiding
  22985. * cusps and self-intersections in non-uniform catmull rom curves.
  22986. * http://www.cemyuksel.com/research/catmullrom_param/catmullrom.pdf
  22987. *
  22988. * curve.type accepts centripetal(default), chordal and catmullrom
  22989. * curve.tension is used for catmullrom which defaults to 0.5
  22990. */
  22991. /*
  22992. Based on an optimized c++ solution in
  22993. - http://stackoverflow.com/questions/9489736/catmull-rom-curve-with-no-cusps-and-no-self-intersections/
  22994. - http://ideone.com/NoEbVM
  22995. This CubicPoly class could be used for reusing some variables and calculations,
  22996. but for three.js curve use, it could be possible inlined and flatten into a single function call
  22997. which can be placed in CurveUtils.
  22998. */
  22999. let c0 = 0, c1 = 0, c2 = 0, c3 = 0;
  23000. /*
  23001. * Compute coefficients for a cubic polynomial
  23002. * p(s) = c0 + c1*s + c2*s^2 + c3*s^3
  23003. * such that
  23004. * p(0) = x0, p(1) = x1
  23005. * and
  23006. * p'(0) = t0, p'(1) = t1.
  23007. */
  23008. function init( x0, x1, t0, t1 ) {
  23009. c0 = x0;
  23010. c1 = t0;
  23011. c2 = -3 * x0 + 3 * x1 - 2 * t0 - t1;
  23012. c3 = 2 * x0 - 2 * x1 + t0 + t1;
  23013. }
  23014. return {
  23015. initCatmullRom: function ( x0, x1, x2, x3, tension ) {
  23016. init( x1, x2, tension * ( x2 - x0 ), tension * ( x3 - x1 ) );
  23017. },
  23018. initNonuniformCatmullRom: function ( x0, x1, x2, x3, dt0, dt1, dt2 ) {
  23019. // compute tangents when parameterized in [t1,t2]
  23020. let t1 = ( x1 - x0 ) / dt0 - ( x2 - x0 ) / ( dt0 + dt1 ) + ( x2 - x1 ) / dt1;
  23021. let t2 = ( x2 - x1 ) / dt1 - ( x3 - x1 ) / ( dt1 + dt2 ) + ( x3 - x2 ) / dt2;
  23022. // rescale tangents for parametrization in [0,1]
  23023. t1 *= dt1;
  23024. t2 *= dt1;
  23025. init( x1, x2, t1, t2 );
  23026. },
  23027. calc: function ( t ) {
  23028. const t2 = t * t;
  23029. const t3 = t2 * t;
  23030. return c0 + c1 * t + c2 * t2 + c3 * t3;
  23031. }
  23032. };
  23033. }
  23034. //
  23035. const tmp = /*@__PURE__*/ new Vector3();
  23036. const px = /*@__PURE__*/ new CubicPoly();
  23037. const py = /*@__PURE__*/ new CubicPoly();
  23038. const pz = /*@__PURE__*/ new CubicPoly();
  23039. /**
  23040. * A curve representing a Catmull-Rom spline.
  23041. *
  23042. * ```js
  23043. * //Create a closed wavey loop
  23044. * const curve = new THREE.CatmullRomCurve3( [
  23045. * new THREE.Vector3( -10, 0, 10 ),
  23046. * new THREE.Vector3( -5, 5, 5 ),
  23047. * new THREE.Vector3( 0, 0, 0 ),
  23048. * new THREE.Vector3( 5, -5, 5 ),
  23049. * new THREE.Vector3( 10, 0, 10 )
  23050. * ] );
  23051. *
  23052. * const points = curve.getPoints( 50 );
  23053. * const geometry = new THREE.BufferGeometry().setFromPoints( points );
  23054. *
  23055. * const material = new THREE.LineBasicMaterial( { color: 0xff0000 } );
  23056. *
  23057. * // Create the final object to add to the scene
  23058. * const curveObject = new THREE.Line( geometry, material );
  23059. * ```
  23060. *
  23061. * @augments Curve
  23062. */
  23063. class CatmullRomCurve3 extends Curve {
  23064. /**
  23065. * Constructs a new Catmull-Rom curve.
  23066. *
  23067. * @param {Array<Vector3>} [points] - An array of 3D points defining the curve.
  23068. * @param {boolean} [closed=false] - Whether the curve is closed or not.
  23069. * @param {('centripetal'|'chordal'|'catmullrom')} [curveType='centripetal'] - The curve type.
  23070. * @param {number} [tension=0.5] - Tension of the curve.
  23071. */
  23072. constructor( points = [], closed = false, curveType = 'centripetal', tension = 0.5 ) {
  23073. super();
  23074. /**
  23075. * This flag can be used for type testing.
  23076. *
  23077. * @type {boolean}
  23078. * @readonly
  23079. * @default true
  23080. */
  23081. this.isCatmullRomCurve3 = true;
  23082. this.type = 'CatmullRomCurve3';
  23083. /**
  23084. * An array of 3D points defining the curve.
  23085. *
  23086. * @type {Array<Vector3>}
  23087. */
  23088. this.points = points;
  23089. /**
  23090. * Whether the curve is closed or not.
  23091. *
  23092. * @type {boolean}
  23093. * @default false
  23094. */
  23095. this.closed = closed;
  23096. /**
  23097. * The curve type.
  23098. *
  23099. * @type {('centripetal'|'chordal'|'catmullrom')}
  23100. * @default 'centripetal'
  23101. */
  23102. this.curveType = curveType;
  23103. /**
  23104. * Tension of the curve.
  23105. *
  23106. * @type {number}
  23107. * @default 0.5
  23108. */
  23109. this.tension = tension;
  23110. }
  23111. /**
  23112. * Returns a point on the curve.
  23113. *
  23114. * @param {number} t - A interpolation factor representing a position on the curve. Must be in the range `[0,1]`.
  23115. * @param {Vector3} [optionalTarget] - The optional target vector the result is written to.
  23116. * @return {Vector3} The position on the curve.
  23117. */
  23118. getPoint( t, optionalTarget = new Vector3() ) {
  23119. const point = optionalTarget;
  23120. const points = this.points;
  23121. const l = points.length;
  23122. const p = ( l - ( this.closed ? 0 : 1 ) ) * t;
  23123. let intPoint = Math.floor( p );
  23124. let weight = p - intPoint;
  23125. if ( this.closed ) {
  23126. intPoint += intPoint > 0 ? 0 : ( Math.floor( Math.abs( intPoint ) / l ) + 1 ) * l;
  23127. } else if ( weight === 0 && intPoint === l - 1 ) {
  23128. intPoint = l - 2;
  23129. weight = 1;
  23130. }
  23131. let p0, p3; // 4 points (p1 & p2 defined below)
  23132. if ( this.closed || intPoint > 0 ) {
  23133. p0 = points[ ( intPoint - 1 ) % l ];
  23134. } else {
  23135. // extrapolate first point
  23136. tmp.subVectors( points[ 0 ], points[ 1 ] ).add( points[ 0 ] );
  23137. p0 = tmp;
  23138. }
  23139. const p1 = points[ intPoint % l ];
  23140. const p2 = points[ ( intPoint + 1 ) % l ];
  23141. if ( this.closed || intPoint + 2 < l ) {
  23142. p3 = points[ ( intPoint + 2 ) % l ];
  23143. } else {
  23144. // extrapolate last point
  23145. tmp.subVectors( points[ l - 1 ], points[ l - 2 ] ).add( points[ l - 1 ] );
  23146. p3 = tmp;
  23147. }
  23148. if ( this.curveType === 'centripetal' || this.curveType === 'chordal' ) {
  23149. // init Centripetal / Chordal Catmull-Rom
  23150. const pow = this.curveType === 'chordal' ? 0.5 : 0.25;
  23151. let dt0 = Math.pow( p0.distanceToSquared( p1 ), pow );
  23152. let dt1 = Math.pow( p1.distanceToSquared( p2 ), pow );
  23153. let dt2 = Math.pow( p2.distanceToSquared( p3 ), pow );
  23154. // safety check for repeated points
  23155. if ( dt1 < 1e-4 ) dt1 = 1.0;
  23156. if ( dt0 < 1e-4 ) dt0 = dt1;
  23157. if ( dt2 < 1e-4 ) dt2 = dt1;
  23158. px.initNonuniformCatmullRom( p0.x, p1.x, p2.x, p3.x, dt0, dt1, dt2 );
  23159. py.initNonuniformCatmullRom( p0.y, p1.y, p2.y, p3.y, dt0, dt1, dt2 );
  23160. pz.initNonuniformCatmullRom( p0.z, p1.z, p2.z, p3.z, dt0, dt1, dt2 );
  23161. } else if ( this.curveType === 'catmullrom' ) {
  23162. px.initCatmullRom( p0.x, p1.x, p2.x, p3.x, this.tension );
  23163. py.initCatmullRom( p0.y, p1.y, p2.y, p3.y, this.tension );
  23164. pz.initCatmullRom( p0.z, p1.z, p2.z, p3.z, this.tension );
  23165. }
  23166. point.set(
  23167. px.calc( weight ),
  23168. py.calc( weight ),
  23169. pz.calc( weight )
  23170. );
  23171. return point;
  23172. }
  23173. copy( source ) {
  23174. super.copy( source );
  23175. this.points = [];
  23176. for ( let i = 0, l = source.points.length; i < l; i ++ ) {
  23177. const point = source.points[ i ];
  23178. this.points.push( point.clone() );
  23179. }
  23180. this.closed = source.closed;
  23181. this.curveType = source.curveType;
  23182. this.tension = source.tension;
  23183. return this;
  23184. }
  23185. toJSON() {
  23186. const data = super.toJSON();
  23187. data.points = [];
  23188. for ( let i = 0, l = this.points.length; i < l; i ++ ) {
  23189. const point = this.points[ i ];
  23190. data.points.push( point.toArray() );
  23191. }
  23192. data.closed = this.closed;
  23193. data.curveType = this.curveType;
  23194. data.tension = this.tension;
  23195. return data;
  23196. }
  23197. fromJSON( json ) {
  23198. super.fromJSON( json );
  23199. this.points = [];
  23200. for ( let i = 0, l = json.points.length; i < l; i ++ ) {
  23201. const point = json.points[ i ];
  23202. this.points.push( new Vector3().fromArray( point ) );
  23203. }
  23204. this.closed = json.closed;
  23205. this.curveType = json.curveType;
  23206. this.tension = json.tension;
  23207. return this;
  23208. }
  23209. }
  23210. /**
  23211. * Interpolations contains spline and Bézier functions internally used by concrete curve classes.
  23212. *
  23213. * Bezier Curves formulas obtained from: https://en.wikipedia.org/wiki/B%C3%A9zier_curve
  23214. *
  23215. * @module Interpolations
  23216. */
  23217. /**
  23218. * Computes a point on a Catmull-Rom spline.
  23219. *
  23220. * @param {number} t - The interpolation factor.
  23221. * @param {number} p0 - The first control point.
  23222. * @param {number} p1 - The second control point.
  23223. * @param {number} p2 - The third control point.
  23224. * @param {number} p3 - The fourth control point.
  23225. * @return {number} The calculated point on a Catmull-Rom spline.
  23226. */
  23227. function CatmullRom( t, p0, p1, p2, p3 ) {
  23228. const v0 = ( p2 - p0 ) * 0.5;
  23229. const v1 = ( p3 - p1 ) * 0.5;
  23230. const t2 = t * t;
  23231. const t3 = t * t2;
  23232. return ( 2 * p1 - 2 * p2 + v0 + v1 ) * t3 + ( -3 * p1 + 3 * p2 - 2 * v0 - v1 ) * t2 + v0 * t + p1;
  23233. }
  23234. //
  23235. function QuadraticBezierP0( t, p ) {
  23236. const k = 1 - t;
  23237. return k * k * p;
  23238. }
  23239. function QuadraticBezierP1( t, p ) {
  23240. return 2 * ( 1 - t ) * t * p;
  23241. }
  23242. function QuadraticBezierP2( t, p ) {
  23243. return t * t * p;
  23244. }
  23245. /**
  23246. * Computes a point on a Quadratic Bezier curve.
  23247. *
  23248. * @param {number} t - The interpolation factor.
  23249. * @param {number} p0 - The first control point.
  23250. * @param {number} p1 - The second control point.
  23251. * @param {number} p2 - The third control point.
  23252. * @return {number} The calculated point on a Quadratic Bezier curve.
  23253. */
  23254. function QuadraticBezier( t, p0, p1, p2 ) {
  23255. return QuadraticBezierP0( t, p0 ) + QuadraticBezierP1( t, p1 ) +
  23256. QuadraticBezierP2( t, p2 );
  23257. }
  23258. //
  23259. function CubicBezierP0( t, p ) {
  23260. const k = 1 - t;
  23261. return k * k * k * p;
  23262. }
  23263. function CubicBezierP1( t, p ) {
  23264. const k = 1 - t;
  23265. return 3 * k * k * t * p;
  23266. }
  23267. function CubicBezierP2( t, p ) {
  23268. return 3 * ( 1 - t ) * t * t * p;
  23269. }
  23270. function CubicBezierP3( t, p ) {
  23271. return t * t * t * p;
  23272. }
  23273. /**
  23274. * Computes a point on a Cubic Bezier curve.
  23275. *
  23276. * @param {number} t - The interpolation factor.
  23277. * @param {number} p0 - The first control point.
  23278. * @param {number} p1 - The second control point.
  23279. * @param {number} p2 - The third control point.
  23280. * @param {number} p3 - The fourth control point.
  23281. * @return {number} The calculated point on a Cubic Bezier curve.
  23282. */
  23283. function CubicBezier( t, p0, p1, p2, p3 ) {
  23284. return CubicBezierP0( t, p0 ) + CubicBezierP1( t, p1 ) + CubicBezierP2( t, p2 ) +
  23285. CubicBezierP3( t, p3 );
  23286. }
  23287. /**
  23288. * A curve representing a 2D Cubic Bezier curve.
  23289. *
  23290. * ```js
  23291. * const curve = new THREE.CubicBezierCurve(
  23292. * new THREE.Vector2( - 0, 0 ),
  23293. * new THREE.Vector2( - 5, 15 ),
  23294. * new THREE.Vector2( 20, 15 ),
  23295. * new THREE.Vector2( 10, 0 )
  23296. * );
  23297. *
  23298. * const points = curve.getPoints( 50 );
  23299. * const geometry = new THREE.BufferGeometry().setFromPoints( points );
  23300. *
  23301. * const material = new THREE.LineBasicMaterial( { color: 0xff0000 } );
  23302. *
  23303. * // Create the final object to add to the scene
  23304. * const curveObject = new THREE.Line( geometry, material );
  23305. * ```
  23306. *
  23307. * @augments Curve
  23308. */
  23309. class CubicBezierCurve extends Curve {
  23310. /**
  23311. * Constructs a new Cubic Bezier curve.
  23312. *
  23313. * @param {Vector2} [v0] - The start point.
  23314. * @param {Vector2} [v1] - The first control point.
  23315. * @param {Vector2} [v2] - The second control point.
  23316. * @param {Vector2} [v3] - The end point.
  23317. */
  23318. constructor( v0 = new Vector2(), v1 = new Vector2(), v2 = new Vector2(), v3 = new Vector2() ) {
  23319. super();
  23320. /**
  23321. * This flag can be used for type testing.
  23322. *
  23323. * @type {boolean}
  23324. * @readonly
  23325. * @default true
  23326. */
  23327. this.isCubicBezierCurve = true;
  23328. this.type = 'CubicBezierCurve';
  23329. /**
  23330. * The start point.
  23331. *
  23332. * @type {Vector2}
  23333. */
  23334. this.v0 = v0;
  23335. /**
  23336. * The first control point.
  23337. *
  23338. * @type {Vector2}
  23339. */
  23340. this.v1 = v1;
  23341. /**
  23342. * The second control point.
  23343. *
  23344. * @type {Vector2}
  23345. */
  23346. this.v2 = v2;
  23347. /**
  23348. * The end point.
  23349. *
  23350. * @type {Vector2}
  23351. */
  23352. this.v3 = v3;
  23353. }
  23354. /**
  23355. * Returns a point on the curve.
  23356. *
  23357. * @param {number} t - A interpolation factor representing a position on the curve. Must be in the range `[0,1]`.
  23358. * @param {Vector2} [optionalTarget] - The optional target vector the result is written to.
  23359. * @return {Vector2} The position on the curve.
  23360. */
  23361. getPoint( t, optionalTarget = new Vector2() ) {
  23362. const point = optionalTarget;
  23363. const v0 = this.v0, v1 = this.v1, v2 = this.v2, v3 = this.v3;
  23364. point.set(
  23365. CubicBezier( t, v0.x, v1.x, v2.x, v3.x ),
  23366. CubicBezier( t, v0.y, v1.y, v2.y, v3.y )
  23367. );
  23368. return point;
  23369. }
  23370. copy( source ) {
  23371. super.copy( source );
  23372. this.v0.copy( source.v0 );
  23373. this.v1.copy( source.v1 );
  23374. this.v2.copy( source.v2 );
  23375. this.v3.copy( source.v3 );
  23376. return this;
  23377. }
  23378. toJSON() {
  23379. const data = super.toJSON();
  23380. data.v0 = this.v0.toArray();
  23381. data.v1 = this.v1.toArray();
  23382. data.v2 = this.v2.toArray();
  23383. data.v3 = this.v3.toArray();
  23384. return data;
  23385. }
  23386. fromJSON( json ) {
  23387. super.fromJSON( json );
  23388. this.v0.fromArray( json.v0 );
  23389. this.v1.fromArray( json.v1 );
  23390. this.v2.fromArray( json.v2 );
  23391. this.v3.fromArray( json.v3 );
  23392. return this;
  23393. }
  23394. }
  23395. /**
  23396. * A curve representing a 3D Cubic Bezier curve.
  23397. *
  23398. * @augments Curve
  23399. */
  23400. class CubicBezierCurve3 extends Curve {
  23401. /**
  23402. * Constructs a new Cubic Bezier curve.
  23403. *
  23404. * @param {Vector3} [v0] - The start point.
  23405. * @param {Vector3} [v1] - The first control point.
  23406. * @param {Vector3} [v2] - The second control point.
  23407. * @param {Vector3} [v3] - The end point.
  23408. */
  23409. constructor( v0 = new Vector3(), v1 = new Vector3(), v2 = new Vector3(), v3 = new Vector3() ) {
  23410. super();
  23411. /**
  23412. * This flag can be used for type testing.
  23413. *
  23414. * @type {boolean}
  23415. * @readonly
  23416. * @default true
  23417. */
  23418. this.isCubicBezierCurve3 = true;
  23419. this.type = 'CubicBezierCurve3';
  23420. /**
  23421. * The start point.
  23422. *
  23423. * @type {Vector3}
  23424. */
  23425. this.v0 = v0;
  23426. /**
  23427. * The first control point.
  23428. *
  23429. * @type {Vector3}
  23430. */
  23431. this.v1 = v1;
  23432. /**
  23433. * The second control point.
  23434. *
  23435. * @type {Vector3}
  23436. */
  23437. this.v2 = v2;
  23438. /**
  23439. * The end point.
  23440. *
  23441. * @type {Vector3}
  23442. */
  23443. this.v3 = v3;
  23444. }
  23445. /**
  23446. * Returns a point on the curve.
  23447. *
  23448. * @param {number} t - A interpolation factor representing a position on the curve. Must be in the range `[0,1]`.
  23449. * @param {Vector3} [optionalTarget] - The optional target vector the result is written to.
  23450. * @return {Vector3} The position on the curve.
  23451. */
  23452. getPoint( t, optionalTarget = new Vector3() ) {
  23453. const point = optionalTarget;
  23454. const v0 = this.v0, v1 = this.v1, v2 = this.v2, v3 = this.v3;
  23455. point.set(
  23456. CubicBezier( t, v0.x, v1.x, v2.x, v3.x ),
  23457. CubicBezier( t, v0.y, v1.y, v2.y, v3.y ),
  23458. CubicBezier( t, v0.z, v1.z, v2.z, v3.z )
  23459. );
  23460. return point;
  23461. }
  23462. copy( source ) {
  23463. super.copy( source );
  23464. this.v0.copy( source.v0 );
  23465. this.v1.copy( source.v1 );
  23466. this.v2.copy( source.v2 );
  23467. this.v3.copy( source.v3 );
  23468. return this;
  23469. }
  23470. toJSON() {
  23471. const data = super.toJSON();
  23472. data.v0 = this.v0.toArray();
  23473. data.v1 = this.v1.toArray();
  23474. data.v2 = this.v2.toArray();
  23475. data.v3 = this.v3.toArray();
  23476. return data;
  23477. }
  23478. fromJSON( json ) {
  23479. super.fromJSON( json );
  23480. this.v0.fromArray( json.v0 );
  23481. this.v1.fromArray( json.v1 );
  23482. this.v2.fromArray( json.v2 );
  23483. this.v3.fromArray( json.v3 );
  23484. return this;
  23485. }
  23486. }
  23487. /**
  23488. * A curve representing a 2D line segment.
  23489. *
  23490. * @augments Curve
  23491. */
  23492. class LineCurve extends Curve {
  23493. /**
  23494. * Constructs a new line curve.
  23495. *
  23496. * @param {Vector2} [v1] - The start point.
  23497. * @param {Vector2} [v2] - The end point.
  23498. */
  23499. constructor( v1 = new Vector2(), v2 = new Vector2() ) {
  23500. super();
  23501. /**
  23502. * This flag can be used for type testing.
  23503. *
  23504. * @type {boolean}
  23505. * @readonly
  23506. * @default true
  23507. */
  23508. this.isLineCurve = true;
  23509. this.type = 'LineCurve';
  23510. /**
  23511. * The start point.
  23512. *
  23513. * @type {Vector2}
  23514. */
  23515. this.v1 = v1;
  23516. /**
  23517. * The end point.
  23518. *
  23519. * @type {Vector2}
  23520. */
  23521. this.v2 = v2;
  23522. }
  23523. /**
  23524. * Returns a point on the line.
  23525. *
  23526. * @param {number} t - A interpolation factor representing a position on the line. Must be in the range `[0,1]`.
  23527. * @param {Vector2} [optionalTarget] - The optional target vector the result is written to.
  23528. * @return {Vector2} The position on the line.
  23529. */
  23530. getPoint( t, optionalTarget = new Vector2() ) {
  23531. const point = optionalTarget;
  23532. if ( t === 1 ) {
  23533. point.copy( this.v2 );
  23534. } else {
  23535. point.copy( this.v2 ).sub( this.v1 );
  23536. point.multiplyScalar( t ).add( this.v1 );
  23537. }
  23538. return point;
  23539. }
  23540. // Line curve is linear, so we can overwrite default getPointAt
  23541. getPointAt( u, optionalTarget ) {
  23542. return this.getPoint( u, optionalTarget );
  23543. }
  23544. getTangent( t, optionalTarget = new Vector2() ) {
  23545. return optionalTarget.subVectors( this.v2, this.v1 ).normalize();
  23546. }
  23547. getTangentAt( u, optionalTarget ) {
  23548. return this.getTangent( u, optionalTarget );
  23549. }
  23550. copy( source ) {
  23551. super.copy( source );
  23552. this.v1.copy( source.v1 );
  23553. this.v2.copy( source.v2 );
  23554. return this;
  23555. }
  23556. toJSON() {
  23557. const data = super.toJSON();
  23558. data.v1 = this.v1.toArray();
  23559. data.v2 = this.v2.toArray();
  23560. return data;
  23561. }
  23562. fromJSON( json ) {
  23563. super.fromJSON( json );
  23564. this.v1.fromArray( json.v1 );
  23565. this.v2.fromArray( json.v2 );
  23566. return this;
  23567. }
  23568. }
  23569. /**
  23570. * A curve representing a 3D line segment.
  23571. *
  23572. * @augments Curve
  23573. */
  23574. class LineCurve3 extends Curve {
  23575. /**
  23576. * Constructs a new line curve.
  23577. *
  23578. * @param {Vector3} [v1] - The start point.
  23579. * @param {Vector3} [v2] - The end point.
  23580. */
  23581. constructor( v1 = new Vector3(), v2 = new Vector3() ) {
  23582. super();
  23583. /**
  23584. * This flag can be used for type testing.
  23585. *
  23586. * @type {boolean}
  23587. * @readonly
  23588. * @default true
  23589. */
  23590. this.isLineCurve3 = true;
  23591. this.type = 'LineCurve3';
  23592. /**
  23593. * The start point.
  23594. *
  23595. * @type {Vector3}
  23596. */
  23597. this.v1 = v1;
  23598. /**
  23599. * The end point.
  23600. *
  23601. * @type {Vector2}
  23602. */
  23603. this.v2 = v2;
  23604. }
  23605. /**
  23606. * Returns a point on the line.
  23607. *
  23608. * @param {number} t - A interpolation factor representing a position on the line. Must be in the range `[0,1]`.
  23609. * @param {Vector3} [optionalTarget] - The optional target vector the result is written to.
  23610. * @return {Vector3} The position on the line.
  23611. */
  23612. getPoint( t, optionalTarget = new Vector3() ) {
  23613. const point = optionalTarget;
  23614. if ( t === 1 ) {
  23615. point.copy( this.v2 );
  23616. } else {
  23617. point.copy( this.v2 ).sub( this.v1 );
  23618. point.multiplyScalar( t ).add( this.v1 );
  23619. }
  23620. return point;
  23621. }
  23622. // Line curve is linear, so we can overwrite default getPointAt
  23623. getPointAt( u, optionalTarget ) {
  23624. return this.getPoint( u, optionalTarget );
  23625. }
  23626. getTangent( t, optionalTarget = new Vector3() ) {
  23627. return optionalTarget.subVectors( this.v2, this.v1 ).normalize();
  23628. }
  23629. getTangentAt( u, optionalTarget ) {
  23630. return this.getTangent( u, optionalTarget );
  23631. }
  23632. copy( source ) {
  23633. super.copy( source );
  23634. this.v1.copy( source.v1 );
  23635. this.v2.copy( source.v2 );
  23636. return this;
  23637. }
  23638. toJSON() {
  23639. const data = super.toJSON();
  23640. data.v1 = this.v1.toArray();
  23641. data.v2 = this.v2.toArray();
  23642. return data;
  23643. }
  23644. fromJSON( json ) {
  23645. super.fromJSON( json );
  23646. this.v1.fromArray( json.v1 );
  23647. this.v2.fromArray( json.v2 );
  23648. return this;
  23649. }
  23650. }
  23651. /**
  23652. * A curve representing a 2D Quadratic Bezier curve.
  23653. *
  23654. * ```js
  23655. * const curve = new THREE.QuadraticBezierCurve(
  23656. * new THREE.Vector2( - 10, 0 ),
  23657. * new THREE.Vector2( 20, 15 ),
  23658. * new THREE.Vector2( 10, 0 )
  23659. * )
  23660. *
  23661. * const points = curve.getPoints( 50 );
  23662. * const geometry = new THREE.BufferGeometry().setFromPoints( points );
  23663. *
  23664. * const material = new THREE.LineBasicMaterial( { color: 0xff0000 } );
  23665. *
  23666. * // Create the final object to add to the scene
  23667. * const curveObject = new THREE.Line( geometry, material );
  23668. * ```
  23669. *
  23670. * @augments Curve
  23671. */
  23672. class QuadraticBezierCurve extends Curve {
  23673. /**
  23674. * Constructs a new Quadratic Bezier curve.
  23675. *
  23676. * @param {Vector2} [v0] - The start point.
  23677. * @param {Vector2} [v1] - The control point.
  23678. * @param {Vector2} [v2] - The end point.
  23679. */
  23680. constructor( v0 = new Vector2(), v1 = new Vector2(), v2 = new Vector2() ) {
  23681. super();
  23682. /**
  23683. * This flag can be used for type testing.
  23684. *
  23685. * @type {boolean}
  23686. * @readonly
  23687. * @default true
  23688. */
  23689. this.isQuadraticBezierCurve = true;
  23690. this.type = 'QuadraticBezierCurve';
  23691. /**
  23692. * The start point.
  23693. *
  23694. * @type {Vector2}
  23695. */
  23696. this.v0 = v0;
  23697. /**
  23698. * The control point.
  23699. *
  23700. * @type {Vector2}
  23701. */
  23702. this.v1 = v1;
  23703. /**
  23704. * The end point.
  23705. *
  23706. * @type {Vector2}
  23707. */
  23708. this.v2 = v2;
  23709. }
  23710. /**
  23711. * Returns a point on the curve.
  23712. *
  23713. * @param {number} t - A interpolation factor representing a position on the curve. Must be in the range `[0,1]`.
  23714. * @param {Vector2} [optionalTarget] - The optional target vector the result is written to.
  23715. * @return {Vector2} The position on the curve.
  23716. */
  23717. getPoint( t, optionalTarget = new Vector2() ) {
  23718. const point = optionalTarget;
  23719. const v0 = this.v0, v1 = this.v1, v2 = this.v2;
  23720. point.set(
  23721. QuadraticBezier( t, v0.x, v1.x, v2.x ),
  23722. QuadraticBezier( t, v0.y, v1.y, v2.y )
  23723. );
  23724. return point;
  23725. }
  23726. copy( source ) {
  23727. super.copy( source );
  23728. this.v0.copy( source.v0 );
  23729. this.v1.copy( source.v1 );
  23730. this.v2.copy( source.v2 );
  23731. return this;
  23732. }
  23733. toJSON() {
  23734. const data = super.toJSON();
  23735. data.v0 = this.v0.toArray();
  23736. data.v1 = this.v1.toArray();
  23737. data.v2 = this.v2.toArray();
  23738. return data;
  23739. }
  23740. fromJSON( json ) {
  23741. super.fromJSON( json );
  23742. this.v0.fromArray( json.v0 );
  23743. this.v1.fromArray( json.v1 );
  23744. this.v2.fromArray( json.v2 );
  23745. return this;
  23746. }
  23747. }
  23748. /**
  23749. * A curve representing a 3D Quadratic Bezier curve.
  23750. *
  23751. * @augments Curve
  23752. */
  23753. class QuadraticBezierCurve3 extends Curve {
  23754. /**
  23755. * Constructs a new Quadratic Bezier curve.
  23756. *
  23757. * @param {Vector3} [v0] - The start point.
  23758. * @param {Vector3} [v1] - The control point.
  23759. * @param {Vector3} [v2] - The end point.
  23760. */
  23761. constructor( v0 = new Vector3(), v1 = new Vector3(), v2 = new Vector3() ) {
  23762. super();
  23763. /**
  23764. * This flag can be used for type testing.
  23765. *
  23766. * @type {boolean}
  23767. * @readonly
  23768. * @default true
  23769. */
  23770. this.isQuadraticBezierCurve3 = true;
  23771. this.type = 'QuadraticBezierCurve3';
  23772. /**
  23773. * The start point.
  23774. *
  23775. * @type {Vector3}
  23776. */
  23777. this.v0 = v0;
  23778. /**
  23779. * The control point.
  23780. *
  23781. * @type {Vector3}
  23782. */
  23783. this.v1 = v1;
  23784. /**
  23785. * The end point.
  23786. *
  23787. * @type {Vector3}
  23788. */
  23789. this.v2 = v2;
  23790. }
  23791. /**
  23792. * Returns a point on the curve.
  23793. *
  23794. * @param {number} t - A interpolation factor representing a position on the curve. Must be in the range `[0,1]`.
  23795. * @param {Vector3} [optionalTarget] - The optional target vector the result is written to.
  23796. * @return {Vector3} The position on the curve.
  23797. */
  23798. getPoint( t, optionalTarget = new Vector3() ) {
  23799. const point = optionalTarget;
  23800. const v0 = this.v0, v1 = this.v1, v2 = this.v2;
  23801. point.set(
  23802. QuadraticBezier( t, v0.x, v1.x, v2.x ),
  23803. QuadraticBezier( t, v0.y, v1.y, v2.y ),
  23804. QuadraticBezier( t, v0.z, v1.z, v2.z )
  23805. );
  23806. return point;
  23807. }
  23808. copy( source ) {
  23809. super.copy( source );
  23810. this.v0.copy( source.v0 );
  23811. this.v1.copy( source.v1 );
  23812. this.v2.copy( source.v2 );
  23813. return this;
  23814. }
  23815. toJSON() {
  23816. const data = super.toJSON();
  23817. data.v0 = this.v0.toArray();
  23818. data.v1 = this.v1.toArray();
  23819. data.v2 = this.v2.toArray();
  23820. return data;
  23821. }
  23822. fromJSON( json ) {
  23823. super.fromJSON( json );
  23824. this.v0.fromArray( json.v0 );
  23825. this.v1.fromArray( json.v1 );
  23826. this.v2.fromArray( json.v2 );
  23827. return this;
  23828. }
  23829. }
  23830. /**
  23831. * A curve representing a 2D spline curve.
  23832. *
  23833. * ```js
  23834. * // Create a sine-like wave
  23835. * const curve = new THREE.SplineCurve( [
  23836. * new THREE.Vector2( -10, 0 ),
  23837. * new THREE.Vector2( -5, 5 ),
  23838. * new THREE.Vector2( 0, 0 ),
  23839. * new THREE.Vector2( 5, -5 ),
  23840. * new THREE.Vector2( 10, 0 )
  23841. * ] );
  23842. *
  23843. * const points = curve.getPoints( 50 );
  23844. * const geometry = new THREE.BufferGeometry().setFromPoints( points );
  23845. *
  23846. * const material = new THREE.LineBasicMaterial( { color: 0xff0000 } );
  23847. *
  23848. * // Create the final object to add to the scene
  23849. * const splineObject = new THREE.Line( geometry, material );
  23850. * ```
  23851. *
  23852. * @augments Curve
  23853. */
  23854. class SplineCurve extends Curve {
  23855. /**
  23856. * Constructs a new 2D spline curve.
  23857. *
  23858. * @param {Array<Vector2>} [points] - An array of 2D points defining the curve.
  23859. */
  23860. constructor( points = [] ) {
  23861. super();
  23862. /**
  23863. * This flag can be used for type testing.
  23864. *
  23865. * @type {boolean}
  23866. * @readonly
  23867. * @default true
  23868. */
  23869. this.isSplineCurve = true;
  23870. this.type = 'SplineCurve';
  23871. /**
  23872. * An array of 2D points defining the curve.
  23873. *
  23874. * @type {Array<Vector2>}
  23875. */
  23876. this.points = points;
  23877. }
  23878. /**
  23879. * Returns a point on the curve.
  23880. *
  23881. * @param {number} t - A interpolation factor representing a position on the curve. Must be in the range `[0,1]`.
  23882. * @param {Vector2} [optionalTarget] - The optional target vector the result is written to.
  23883. * @return {Vector2} The position on the curve.
  23884. */
  23885. getPoint( t, optionalTarget = new Vector2() ) {
  23886. const point = optionalTarget;
  23887. const points = this.points;
  23888. const p = ( points.length - 1 ) * t;
  23889. const intPoint = Math.floor( p );
  23890. const weight = p - intPoint;
  23891. const p0 = points[ intPoint === 0 ? intPoint : intPoint - 1 ];
  23892. const p1 = points[ intPoint ];
  23893. const p2 = points[ intPoint > points.length - 2 ? points.length - 1 : intPoint + 1 ];
  23894. const p3 = points[ intPoint > points.length - 3 ? points.length - 1 : intPoint + 2 ];
  23895. point.set(
  23896. CatmullRom( weight, p0.x, p1.x, p2.x, p3.x ),
  23897. CatmullRom( weight, p0.y, p1.y, p2.y, p3.y )
  23898. );
  23899. return point;
  23900. }
  23901. copy( source ) {
  23902. super.copy( source );
  23903. this.points = [];
  23904. for ( let i = 0, l = source.points.length; i < l; i ++ ) {
  23905. const point = source.points[ i ];
  23906. this.points.push( point.clone() );
  23907. }
  23908. return this;
  23909. }
  23910. toJSON() {
  23911. const data = super.toJSON();
  23912. data.points = [];
  23913. for ( let i = 0, l = this.points.length; i < l; i ++ ) {
  23914. const point = this.points[ i ];
  23915. data.points.push( point.toArray() );
  23916. }
  23917. return data;
  23918. }
  23919. fromJSON( json ) {
  23920. super.fromJSON( json );
  23921. this.points = [];
  23922. for ( let i = 0, l = json.points.length; i < l; i ++ ) {
  23923. const point = json.points[ i ];
  23924. this.points.push( new Vector2().fromArray( point ) );
  23925. }
  23926. return this;
  23927. }
  23928. }
  23929. var Curves = /*#__PURE__*/Object.freeze({
  23930. __proto__: null,
  23931. ArcCurve: ArcCurve,
  23932. CatmullRomCurve3: CatmullRomCurve3,
  23933. CubicBezierCurve: CubicBezierCurve,
  23934. CubicBezierCurve3: CubicBezierCurve3,
  23935. EllipseCurve: EllipseCurve,
  23936. LineCurve: LineCurve,
  23937. LineCurve3: LineCurve3,
  23938. QuadraticBezierCurve: QuadraticBezierCurve,
  23939. QuadraticBezierCurve3: QuadraticBezierCurve3,
  23940. SplineCurve: SplineCurve
  23941. });
  23942. /**
  23943. * A base class extending {@link Curve}. `CurvePath` is simply an
  23944. * array of connected curves, but retains the API of a curve.
  23945. *
  23946. * @augments Curve
  23947. */
  23948. class CurvePath extends Curve {
  23949. /**
  23950. * Constructs a new curve path.
  23951. */
  23952. constructor() {
  23953. super();
  23954. this.type = 'CurvePath';
  23955. /**
  23956. * An array of curves defining the
  23957. * path.
  23958. *
  23959. * @type {Array<Curve>}
  23960. */
  23961. this.curves = [];
  23962. /**
  23963. * Whether the path should automatically be closed
  23964. * by a line curve.
  23965. *
  23966. * @type {boolean}
  23967. * @default false
  23968. */
  23969. this.autoClose = false;
  23970. }
  23971. /**
  23972. * Adds a curve to this curve path.
  23973. *
  23974. * @param {Curve} curve - The curve to add.
  23975. */
  23976. add( curve ) {
  23977. this.curves.push( curve );
  23978. }
  23979. /**
  23980. * Adds a line curve to close the path.
  23981. *
  23982. * @return {CurvePath} A reference to this curve path.
  23983. */
  23984. closePath() {
  23985. // Add a line curve if start and end of lines are not connected
  23986. const startPoint = this.curves[ 0 ].getPoint( 0 );
  23987. const endPoint = this.curves[ this.curves.length - 1 ].getPoint( 1 );
  23988. if ( ! startPoint.equals( endPoint ) ) {
  23989. const lineType = ( startPoint.isVector2 === true ) ? 'LineCurve' : 'LineCurve3';
  23990. this.curves.push( new Curves[ lineType ]( endPoint, startPoint ) );
  23991. }
  23992. return this;
  23993. }
  23994. /**
  23995. * This method returns a vector in 2D or 3D space (depending on the curve definitions)
  23996. * for the given interpolation factor.
  23997. *
  23998. * @param {number} t - A interpolation factor representing a position on the curve. Must be in the range `[0,1]`.
  23999. * @param {(Vector2|Vector3)} [optionalTarget] - The optional target vector the result is written to.
  24000. * @return {?(Vector2|Vector3)} The position on the curve. It can be a 2D or 3D vector depending on the curve definition.
  24001. */
  24002. getPoint( t, optionalTarget ) {
  24003. // To get accurate point with reference to
  24004. // entire path distance at time t,
  24005. // following has to be done:
  24006. // 1. Length of each sub path have to be known
  24007. // 2. Locate and identify type of curve
  24008. // 3. Get t for the curve
  24009. // 4. Return curve.getPointAt(t')
  24010. const d = t * this.getLength();
  24011. const curveLengths = this.getCurveLengths();
  24012. let i = 0;
  24013. // To think about boundaries points.
  24014. while ( i < curveLengths.length ) {
  24015. if ( curveLengths[ i ] >= d ) {
  24016. const diff = curveLengths[ i ] - d;
  24017. const curve = this.curves[ i ];
  24018. const segmentLength = curve.getLength();
  24019. const u = segmentLength === 0 ? 0 : 1 - diff / segmentLength;
  24020. return curve.getPointAt( u, optionalTarget );
  24021. }
  24022. i ++;
  24023. }
  24024. return null;
  24025. // loop where sum != 0, sum > d , sum+1 <d
  24026. }
  24027. getLength() {
  24028. // We cannot use the default THREE.Curve getPoint() with getLength() because in
  24029. // THREE.Curve, getLength() depends on getPoint() but in THREE.CurvePath
  24030. // getPoint() depends on getLength
  24031. const lens = this.getCurveLengths();
  24032. return lens[ lens.length - 1 ];
  24033. }
  24034. updateArcLengths() {
  24035. // cacheLengths must be recalculated.
  24036. this.needsUpdate = true;
  24037. this.cacheLengths = null;
  24038. this.getCurveLengths();
  24039. }
  24040. /**
  24041. * Returns list of cumulative curve lengths of the defined curves.
  24042. *
  24043. * @return {Array<number>} The curve lengths.
  24044. */
  24045. getCurveLengths() {
  24046. // Compute lengths and cache them
  24047. // We cannot overwrite getLengths() because UtoT mapping uses it.
  24048. // We use cache values if curves and cache array are same length
  24049. if ( this.cacheLengths && this.cacheLengths.length === this.curves.length ) {
  24050. return this.cacheLengths;
  24051. }
  24052. // Get length of sub-curve
  24053. // Push sums into cached array
  24054. const lengths = [];
  24055. let sums = 0;
  24056. for ( let i = 0, l = this.curves.length; i < l; i ++ ) {
  24057. sums += this.curves[ i ].getLength();
  24058. lengths.push( sums );
  24059. }
  24060. this.cacheLengths = lengths;
  24061. return lengths;
  24062. }
  24063. getSpacedPoints( divisions = 40 ) {
  24064. const points = [];
  24065. for ( let i = 0; i <= divisions; i ++ ) {
  24066. points.push( this.getPoint( i / divisions ) );
  24067. }
  24068. if ( this.autoClose ) {
  24069. points.push( points[ 0 ] );
  24070. }
  24071. return points;
  24072. }
  24073. getPoints( divisions = 12 ) {
  24074. const points = [];
  24075. let last;
  24076. for ( let i = 0, curves = this.curves; i < curves.length; i ++ ) {
  24077. const curve = curves[ i ];
  24078. const resolution = curve.isEllipseCurve ? divisions * 2
  24079. : ( curve.isLineCurve || curve.isLineCurve3 ) ? 1
  24080. : curve.isSplineCurve ? divisions * curve.points.length
  24081. : divisions;
  24082. const pts = curve.getPoints( resolution );
  24083. for ( let j = 0; j < pts.length; j ++ ) {
  24084. const point = pts[ j ];
  24085. if ( last && last.equals( point ) ) continue; // ensures no consecutive points are duplicates
  24086. points.push( point );
  24087. last = point;
  24088. }
  24089. }
  24090. if ( this.autoClose && points.length > 1 && ! points[ points.length - 1 ].equals( points[ 0 ] ) ) {
  24091. points.push( points[ 0 ] );
  24092. }
  24093. return points;
  24094. }
  24095. copy( source ) {
  24096. super.copy( source );
  24097. this.curves = [];
  24098. for ( let i = 0, l = source.curves.length; i < l; i ++ ) {
  24099. const curve = source.curves[ i ];
  24100. this.curves.push( curve.clone() );
  24101. }
  24102. this.autoClose = source.autoClose;
  24103. return this;
  24104. }
  24105. toJSON() {
  24106. const data = super.toJSON();
  24107. data.autoClose = this.autoClose;
  24108. data.curves = [];
  24109. for ( let i = 0, l = this.curves.length; i < l; i ++ ) {
  24110. const curve = this.curves[ i ];
  24111. data.curves.push( curve.toJSON() );
  24112. }
  24113. return data;
  24114. }
  24115. fromJSON( json ) {
  24116. super.fromJSON( json );
  24117. this.autoClose = json.autoClose;
  24118. this.curves = [];
  24119. for ( let i = 0, l = json.curves.length; i < l; i ++ ) {
  24120. const curve = json.curves[ i ];
  24121. this.curves.push( new Curves[ curve.type ]().fromJSON( curve ) );
  24122. }
  24123. return this;
  24124. }
  24125. }
  24126. /**
  24127. * A 2D path representation. The class provides methods for creating paths
  24128. * and contours of 2D shapes similar to the 2D Canvas API.
  24129. *
  24130. * ```js
  24131. * const path = new THREE.Path();
  24132. *
  24133. * path.lineTo( 0, 0.8 );
  24134. * path.quadraticCurveTo( 0, 1, 0.2, 1 );
  24135. * path.lineTo( 1, 1 );
  24136. *
  24137. * const points = path.getPoints();
  24138. *
  24139. * const geometry = new THREE.BufferGeometry().setFromPoints( points );
  24140. * const material = new THREE.LineBasicMaterial( { color: 0xffffff } );
  24141. *
  24142. * const line = new THREE.Line( geometry, material );
  24143. * scene.add( line );
  24144. * ```
  24145. *
  24146. * @augments CurvePath
  24147. */
  24148. class Path extends CurvePath {
  24149. /**
  24150. * Constructs a new path.
  24151. *
  24152. * @param {Array<Vector2>} [points] - An array of 2D points defining the path.
  24153. */
  24154. constructor( points ) {
  24155. super();
  24156. this.type = 'Path';
  24157. /**
  24158. * The current offset of the path. Any new curve added will start here.
  24159. *
  24160. * @type {Vector2}
  24161. */
  24162. this.currentPoint = new Vector2();
  24163. if ( points ) {
  24164. this.setFromPoints( points );
  24165. }
  24166. }
  24167. /**
  24168. * Creates a path from the given list of points. The points are added
  24169. * to the path as instances of {@link LineCurve}.
  24170. *
  24171. * @param {Array<Vector2>} points - An array of 2D points.
  24172. * @return {Path} A reference to this path.
  24173. */
  24174. setFromPoints( points ) {
  24175. this.moveTo( points[ 0 ].x, points[ 0 ].y );
  24176. for ( let i = 1, l = points.length; i < l; i ++ ) {
  24177. this.lineTo( points[ i ].x, points[ i ].y );
  24178. }
  24179. return this;
  24180. }
  24181. /**
  24182. * Moves {@link Path#currentPoint} to the given point.
  24183. *
  24184. * @param {number} x - The x coordinate.
  24185. * @param {number} y - The y coordinate.
  24186. * @return {Path} A reference to this path.
  24187. */
  24188. moveTo( x, y ) {
  24189. this.currentPoint.set( x, y ); // TODO consider referencing vectors instead of copying?
  24190. return this;
  24191. }
  24192. /**
  24193. * Adds an instance of {@link LineCurve} to the path by connecting
  24194. * the current point with the given one.
  24195. *
  24196. * @param {number} x - The x coordinate of the end point.
  24197. * @param {number} y - The y coordinate of the end point.
  24198. * @return {Path} A reference to this path.
  24199. */
  24200. lineTo( x, y ) {
  24201. const curve = new LineCurve( this.currentPoint.clone(), new Vector2( x, y ) );
  24202. this.curves.push( curve );
  24203. this.currentPoint.set( x, y );
  24204. return this;
  24205. }
  24206. /**
  24207. * Adds an instance of {@link QuadraticBezierCurve} to the path by connecting
  24208. * the current point with the given one.
  24209. *
  24210. * @param {number} aCPx - The x coordinate of the control point.
  24211. * @param {number} aCPy - The y coordinate of the control point.
  24212. * @param {number} aX - The x coordinate of the end point.
  24213. * @param {number} aY - The y coordinate of the end point.
  24214. * @return {Path} A reference to this path.
  24215. */
  24216. quadraticCurveTo( aCPx, aCPy, aX, aY ) {
  24217. const curve = new QuadraticBezierCurve(
  24218. this.currentPoint.clone(),
  24219. new Vector2( aCPx, aCPy ),
  24220. new Vector2( aX, aY )
  24221. );
  24222. this.curves.push( curve );
  24223. this.currentPoint.set( aX, aY );
  24224. return this;
  24225. }
  24226. /**
  24227. * Adds an instance of {@link CubicBezierCurve} to the path by connecting
  24228. * the current point with the given one.
  24229. *
  24230. * @param {number} aCP1x - The x coordinate of the first control point.
  24231. * @param {number} aCP1y - The y coordinate of the first control point.
  24232. * @param {number} aCP2x - The x coordinate of the second control point.
  24233. * @param {number} aCP2y - The y coordinate of the second control point.
  24234. * @param {number} aX - The x coordinate of the end point.
  24235. * @param {number} aY - The y coordinate of the end point.
  24236. * @return {Path} A reference to this path.
  24237. */
  24238. bezierCurveTo( aCP1x, aCP1y, aCP2x, aCP2y, aX, aY ) {
  24239. const curve = new CubicBezierCurve(
  24240. this.currentPoint.clone(),
  24241. new Vector2( aCP1x, aCP1y ),
  24242. new Vector2( aCP2x, aCP2y ),
  24243. new Vector2( aX, aY )
  24244. );
  24245. this.curves.push( curve );
  24246. this.currentPoint.set( aX, aY );
  24247. return this;
  24248. }
  24249. /**
  24250. * Adds an instance of {@link SplineCurve} to the path by connecting
  24251. * the current point with the given list of points.
  24252. *
  24253. * @param {Array<Vector2>} pts - An array of points in 2D space.
  24254. * @return {Path} A reference to this path.
  24255. */
  24256. splineThru( pts ) {
  24257. const npts = [ this.currentPoint.clone() ].concat( pts );
  24258. const curve = new SplineCurve( npts );
  24259. this.curves.push( curve );
  24260. this.currentPoint.copy( pts[ pts.length - 1 ] );
  24261. return this;
  24262. }
  24263. /**
  24264. * Adds an arc as an instance of {@link EllipseCurve} to the path, positioned relative
  24265. * to the current point.
  24266. *
  24267. * @param {number} [aX=0] - The x coordinate of the center of the arc offsetted from the previous curve.
  24268. * @param {number} [aY=0] - The y coordinate of the center of the arc offsetted from the previous curve.
  24269. * @param {number} [aRadius=1] - The radius of the arc.
  24270. * @param {number} [aStartAngle=0] - The start angle in radians.
  24271. * @param {number} [aEndAngle=Math.PI*2] - The end angle in radians.
  24272. * @param {boolean} [aClockwise=false] - Whether to sweep the arc clockwise or not.
  24273. * @return {Path} A reference to this path.
  24274. */
  24275. arc( aX, aY, aRadius, aStartAngle, aEndAngle, aClockwise ) {
  24276. const x0 = this.currentPoint.x;
  24277. const y0 = this.currentPoint.y;
  24278. this.absarc( aX + x0, aY + y0, aRadius,
  24279. aStartAngle, aEndAngle, aClockwise );
  24280. return this;
  24281. }
  24282. /**
  24283. * Adds an absolutely positioned arc as an instance of {@link EllipseCurve} to the path.
  24284. *
  24285. * @param {number} [aX=0] - The x coordinate of the center of the arc.
  24286. * @param {number} [aY=0] - The y coordinate of the center of the arc.
  24287. * @param {number} [aRadius=1] - The radius of the arc.
  24288. * @param {number} [aStartAngle=0] - The start angle in radians.
  24289. * @param {number} [aEndAngle=Math.PI*2] - The end angle in radians.
  24290. * @param {boolean} [aClockwise=false] - Whether to sweep the arc clockwise or not.
  24291. * @return {Path} A reference to this path.
  24292. */
  24293. absarc( aX, aY, aRadius, aStartAngle, aEndAngle, aClockwise ) {
  24294. this.absellipse( aX, aY, aRadius, aRadius, aStartAngle, aEndAngle, aClockwise );
  24295. return this;
  24296. }
  24297. /**
  24298. * Adds an ellipse as an instance of {@link EllipseCurve} to the path, positioned relative
  24299. * to the current point
  24300. *
  24301. * @param {number} [aX=0] - The x coordinate of the center of the ellipse offsetted from the previous curve.
  24302. * @param {number} [aY=0] - The y coordinate of the center of the ellipse offsetted from the previous curve.
  24303. * @param {number} [xRadius=1] - The radius of the ellipse in the x axis.
  24304. * @param {number} [yRadius=1] - The radius of the ellipse in the y axis.
  24305. * @param {number} [aStartAngle=0] - The start angle in radians.
  24306. * @param {number} [aEndAngle=Math.PI*2] - The end angle in radians.
  24307. * @param {boolean} [aClockwise=false] - Whether to sweep the ellipse clockwise or not.
  24308. * @param {number} [aRotation=0] - The rotation angle of the ellipse in radians, counterclockwise from the positive X axis.
  24309. * @return {Path} A reference to this path.
  24310. */
  24311. ellipse( aX, aY, xRadius, yRadius, aStartAngle, aEndAngle, aClockwise, aRotation ) {
  24312. const x0 = this.currentPoint.x;
  24313. const y0 = this.currentPoint.y;
  24314. this.absellipse( aX + x0, aY + y0, xRadius, yRadius, aStartAngle, aEndAngle, aClockwise, aRotation );
  24315. return this;
  24316. }
  24317. /**
  24318. * Adds an absolutely positioned ellipse as an instance of {@link EllipseCurve} to the path.
  24319. *
  24320. * @param {number} [aX=0] - The x coordinate of the absolute center of the ellipse.
  24321. * @param {number} [aY=0] - The y coordinate of the absolute center of the ellipse.
  24322. * @param {number} [xRadius=1] - The radius of the ellipse in the x axis.
  24323. * @param {number} [yRadius=1] - The radius of the ellipse in the y axis.
  24324. * @param {number} [aStartAngle=0] - The start angle in radians.
  24325. * @param {number} [aEndAngle=Math.PI*2] - The end angle in radians.
  24326. * @param {boolean} [aClockwise=false] - Whether to sweep the ellipse clockwise or not.
  24327. * @param {number} [aRotation=0] - The rotation angle of the ellipse in radians, counterclockwise from the positive X axis.
  24328. * @return {Path} A reference to this path.
  24329. */
  24330. absellipse( aX, aY, xRadius, yRadius, aStartAngle, aEndAngle, aClockwise, aRotation ) {
  24331. const curve = new EllipseCurve( aX, aY, xRadius, yRadius, aStartAngle, aEndAngle, aClockwise, aRotation );
  24332. if ( this.curves.length > 0 ) {
  24333. // if a previous curve is present, attempt to join
  24334. const firstPoint = curve.getPoint( 0 );
  24335. if ( ! firstPoint.equals( this.currentPoint ) ) {
  24336. this.lineTo( firstPoint.x, firstPoint.y );
  24337. }
  24338. }
  24339. this.curves.push( curve );
  24340. const lastPoint = curve.getPoint( 1 );
  24341. this.currentPoint.copy( lastPoint );
  24342. return this;
  24343. }
  24344. copy( source ) {
  24345. super.copy( source );
  24346. this.currentPoint.copy( source.currentPoint );
  24347. return this;
  24348. }
  24349. toJSON() {
  24350. const data = super.toJSON();
  24351. data.currentPoint = this.currentPoint.toArray();
  24352. return data;
  24353. }
  24354. fromJSON( json ) {
  24355. super.fromJSON( json );
  24356. this.currentPoint.fromArray( json.currentPoint );
  24357. return this;
  24358. }
  24359. }
  24360. /**
  24361. * Defines an arbitrary 2d shape plane using paths with optional holes. It
  24362. * can be used with {@link ExtrudeGeometry}, {@link ShapeGeometry}, to get
  24363. * points, or to get triangulated faces.
  24364. *
  24365. * ```js
  24366. * const heartShape = new THREE.Shape();
  24367. *
  24368. * heartShape.moveTo( 25, 25 );
  24369. * heartShape.bezierCurveTo( 25, 25, 20, 0, 0, 0 );
  24370. * heartShape.bezierCurveTo( - 30, 0, - 30, 35, - 30, 35 );
  24371. * heartShape.bezierCurveTo( - 30, 55, - 10, 77, 25, 95 );
  24372. * heartShape.bezierCurveTo( 60, 77, 80, 55, 80, 35 );
  24373. * heartShape.bezierCurveTo( 80, 35, 80, 0, 50, 0 );
  24374. * heartShape.bezierCurveTo( 35, 0, 25, 25, 25, 25 );
  24375. *
  24376. * const extrudeSettings = {
  24377. * depth: 8,
  24378. * bevelEnabled: true,
  24379. * bevelSegments: 2,
  24380. * steps: 2,
  24381. * bevelSize: 1,
  24382. * bevelThickness: 1
  24383. * };
  24384. *
  24385. * const geometry = new THREE.ExtrudeGeometry( heartShape, extrudeSettings );
  24386. * const mesh = new THREE.Mesh( geometry, new THREE.MeshBasicMaterial() );
  24387. * ```
  24388. *
  24389. * @augments Path
  24390. */
  24391. class Shape extends Path {
  24392. /**
  24393. * Constructs a new shape.
  24394. *
  24395. * @param {Array<Vector2>} [points] - An array of 2D points defining the shape.
  24396. */
  24397. constructor( points ) {
  24398. super( points );
  24399. /**
  24400. * The UUID of the shape.
  24401. *
  24402. * @type {string}
  24403. * @readonly
  24404. */
  24405. this.uuid = generateUUID();
  24406. this.type = 'Shape';
  24407. /**
  24408. * Defines the holes in the shape. Hole definitions must use the
  24409. * opposite winding order (CW/CCW) than the outer shape.
  24410. *
  24411. * @type {Array<Path>}
  24412. * @readonly
  24413. */
  24414. this.holes = [];
  24415. }
  24416. /**
  24417. * Returns an array representing each contour of the holes
  24418. * as a list of 2D points.
  24419. *
  24420. * @param {number} divisions - The fineness of the result.
  24421. * @return {Array<Array<Vector2>>} The holes as a series of 2D points.
  24422. */
  24423. getPointsHoles( divisions ) {
  24424. const holesPts = [];
  24425. for ( let i = 0, l = this.holes.length; i < l; i ++ ) {
  24426. holesPts[ i ] = this.holes[ i ].getPoints( divisions );
  24427. }
  24428. return holesPts;
  24429. }
  24430. // get points of shape and holes (keypoints based on segments parameter)
  24431. /**
  24432. * Returns an object that holds contour data for the shape and its holes as
  24433. * arrays of 2D points.
  24434. *
  24435. * @param {number} divisions - The fineness of the result.
  24436. * @return {{shape:Array<Vector2>,holes:Array<Array<Vector2>>}} An object with contour data.
  24437. */
  24438. extractPoints( divisions ) {
  24439. return {
  24440. shape: this.getPoints( divisions ),
  24441. holes: this.getPointsHoles( divisions )
  24442. };
  24443. }
  24444. copy( source ) {
  24445. super.copy( source );
  24446. this.holes = [];
  24447. for ( let i = 0, l = source.holes.length; i < l; i ++ ) {
  24448. const hole = source.holes[ i ];
  24449. this.holes.push( hole.clone() );
  24450. }
  24451. return this;
  24452. }
  24453. toJSON() {
  24454. const data = super.toJSON();
  24455. data.uuid = this.uuid;
  24456. data.holes = [];
  24457. for ( let i = 0, l = this.holes.length; i < l; i ++ ) {
  24458. const hole = this.holes[ i ];
  24459. data.holes.push( hole.toJSON() );
  24460. }
  24461. return data;
  24462. }
  24463. fromJSON( json ) {
  24464. super.fromJSON( json );
  24465. this.uuid = json.uuid;
  24466. this.holes = [];
  24467. for ( let i = 0, l = json.holes.length; i < l; i ++ ) {
  24468. const hole = json.holes[ i ];
  24469. this.holes.push( new Path().fromJSON( hole ) );
  24470. }
  24471. return this;
  24472. }
  24473. }
  24474. /* eslint-disable */
  24475. // copy of mapbox/earcut version 3.0.2
  24476. // https://github.com/mapbox/earcut/tree/v3.0.2
  24477. function earcut(data, holeIndices, dim = 2) {
  24478. const hasHoles = holeIndices && holeIndices.length;
  24479. const outerLen = hasHoles ? holeIndices[0] * dim : data.length;
  24480. let outerNode = linkedList(data, 0, outerLen, dim, true);
  24481. const triangles = [];
  24482. if (!outerNode || outerNode.next === outerNode.prev) return triangles;
  24483. let minX, minY, invSize;
  24484. if (hasHoles) outerNode = eliminateHoles(data, holeIndices, outerNode, dim);
  24485. // if the shape is not too simple, we'll use z-order curve hash later; calculate polygon bbox
  24486. if (data.length > 80 * dim) {
  24487. minX = data[0];
  24488. minY = data[1];
  24489. let maxX = minX;
  24490. let maxY = minY;
  24491. for (let i = dim; i < outerLen; i += dim) {
  24492. const x = data[i];
  24493. const y = data[i + 1];
  24494. if (x < minX) minX = x;
  24495. if (y < minY) minY = y;
  24496. if (x > maxX) maxX = x;
  24497. if (y > maxY) maxY = y;
  24498. }
  24499. // minX, minY and invSize are later used to transform coords into integers for z-order calculation
  24500. invSize = Math.max(maxX - minX, maxY - minY);
  24501. invSize = invSize !== 0 ? 32767 / invSize : 0;
  24502. }
  24503. earcutLinked(outerNode, triangles, dim, minX, minY, invSize, 0);
  24504. return triangles;
  24505. }
  24506. // create a circular doubly linked list from polygon points in the specified winding order
  24507. function linkedList(data, start, end, dim, clockwise) {
  24508. let last;
  24509. if (clockwise === (signedArea(data, start, end, dim) > 0)) {
  24510. for (let i = start; i < end; i += dim) last = insertNode(i / dim | 0, data[i], data[i + 1], last);
  24511. } else {
  24512. for (let i = end - dim; i >= start; i -= dim) last = insertNode(i / dim | 0, data[i], data[i + 1], last);
  24513. }
  24514. if (last && equals(last, last.next)) {
  24515. removeNode(last);
  24516. last = last.next;
  24517. }
  24518. return last;
  24519. }
  24520. // eliminate colinear or duplicate points
  24521. function filterPoints(start, end) {
  24522. if (!start) return start;
  24523. if (!end) end = start;
  24524. let p = start,
  24525. again;
  24526. do {
  24527. again = false;
  24528. if (!p.steiner && (equals(p, p.next) || area(p.prev, p, p.next) === 0)) {
  24529. removeNode(p);
  24530. p = end = p.prev;
  24531. if (p === p.next) break;
  24532. again = true;
  24533. } else {
  24534. p = p.next;
  24535. }
  24536. } while (again || p !== end);
  24537. return end;
  24538. }
  24539. // main ear slicing loop which triangulates a polygon (given as a linked list)
  24540. function earcutLinked(ear, triangles, dim, minX, minY, invSize, pass) {
  24541. if (!ear) return;
  24542. // interlink polygon nodes in z-order
  24543. if (!pass && invSize) indexCurve(ear, minX, minY, invSize);
  24544. let stop = ear;
  24545. // iterate through ears, slicing them one by one
  24546. while (ear.prev !== ear.next) {
  24547. const prev = ear.prev;
  24548. const next = ear.next;
  24549. if (invSize ? isEarHashed(ear, minX, minY, invSize) : isEar(ear)) {
  24550. triangles.push(prev.i, ear.i, next.i); // cut off the triangle
  24551. removeNode(ear);
  24552. // skipping the next vertex leads to less sliver triangles
  24553. ear = next.next;
  24554. stop = next.next;
  24555. continue;
  24556. }
  24557. ear = next;
  24558. // if we looped through the whole remaining polygon and can't find any more ears
  24559. if (ear === stop) {
  24560. // try filtering points and slicing again
  24561. if (!pass) {
  24562. earcutLinked(filterPoints(ear), triangles, dim, minX, minY, invSize, 1);
  24563. // if this didn't work, try curing all small self-intersections locally
  24564. } else if (pass === 1) {
  24565. ear = cureLocalIntersections(filterPoints(ear), triangles);
  24566. earcutLinked(ear, triangles, dim, minX, minY, invSize, 2);
  24567. // as a last resort, try splitting the remaining polygon into two
  24568. } else if (pass === 2) {
  24569. splitEarcut(ear, triangles, dim, minX, minY, invSize);
  24570. }
  24571. break;
  24572. }
  24573. }
  24574. }
  24575. // check whether a polygon node forms a valid ear with adjacent nodes
  24576. function isEar(ear) {
  24577. const a = ear.prev,
  24578. b = ear,
  24579. c = ear.next;
  24580. if (area(a, b, c) >= 0) return false; // reflex, can't be an ear
  24581. // now make sure we don't have other points inside the potential ear
  24582. const ax = a.x, bx = b.x, cx = c.x, ay = a.y, by = b.y, cy = c.y;
  24583. // triangle bbox
  24584. const x0 = Math.min(ax, bx, cx),
  24585. y0 = Math.min(ay, by, cy),
  24586. x1 = Math.max(ax, bx, cx),
  24587. y1 = Math.max(ay, by, cy);
  24588. let p = c.next;
  24589. while (p !== a) {
  24590. if (p.x >= x0 && p.x <= x1 && p.y >= y0 && p.y <= y1 &&
  24591. pointInTriangleExceptFirst(ax, ay, bx, by, cx, cy, p.x, p.y) &&
  24592. area(p.prev, p, p.next) >= 0) return false;
  24593. p = p.next;
  24594. }
  24595. return true;
  24596. }
  24597. function isEarHashed(ear, minX, minY, invSize) {
  24598. const a = ear.prev,
  24599. b = ear,
  24600. c = ear.next;
  24601. if (area(a, b, c) >= 0) return false; // reflex, can't be an ear
  24602. const ax = a.x, bx = b.x, cx = c.x, ay = a.y, by = b.y, cy = c.y;
  24603. // triangle bbox
  24604. const x0 = Math.min(ax, bx, cx),
  24605. y0 = Math.min(ay, by, cy),
  24606. x1 = Math.max(ax, bx, cx),
  24607. y1 = Math.max(ay, by, cy);
  24608. // z-order range for the current triangle bbox;
  24609. const minZ = zOrder(x0, y0, minX, minY, invSize),
  24610. maxZ = zOrder(x1, y1, minX, minY, invSize);
  24611. let p = ear.prevZ,
  24612. n = ear.nextZ;
  24613. // look for points inside the triangle in both directions
  24614. while (p && p.z >= minZ && n && n.z <= maxZ) {
  24615. if (p.x >= x0 && p.x <= x1 && p.y >= y0 && p.y <= y1 && p !== a && p !== c &&
  24616. pointInTriangleExceptFirst(ax, ay, bx, by, cx, cy, p.x, p.y) && area(p.prev, p, p.next) >= 0) return false;
  24617. p = p.prevZ;
  24618. if (n.x >= x0 && n.x <= x1 && n.y >= y0 && n.y <= y1 && n !== a && n !== c &&
  24619. pointInTriangleExceptFirst(ax, ay, bx, by, cx, cy, n.x, n.y) && area(n.prev, n, n.next) >= 0) return false;
  24620. n = n.nextZ;
  24621. }
  24622. // look for remaining points in decreasing z-order
  24623. while (p && p.z >= minZ) {
  24624. if (p.x >= x0 && p.x <= x1 && p.y >= y0 && p.y <= y1 && p !== a && p !== c &&
  24625. pointInTriangleExceptFirst(ax, ay, bx, by, cx, cy, p.x, p.y) && area(p.prev, p, p.next) >= 0) return false;
  24626. p = p.prevZ;
  24627. }
  24628. // look for remaining points in increasing z-order
  24629. while (n && n.z <= maxZ) {
  24630. if (n.x >= x0 && n.x <= x1 && n.y >= y0 && n.y <= y1 && n !== a && n !== c &&
  24631. pointInTriangleExceptFirst(ax, ay, bx, by, cx, cy, n.x, n.y) && area(n.prev, n, n.next) >= 0) return false;
  24632. n = n.nextZ;
  24633. }
  24634. return true;
  24635. }
  24636. // go through all polygon nodes and cure small local self-intersections
  24637. function cureLocalIntersections(start, triangles) {
  24638. let p = start;
  24639. do {
  24640. const a = p.prev,
  24641. b = p.next.next;
  24642. if (!equals(a, b) && intersects(a, p, p.next, b) && locallyInside(a, b) && locallyInside(b, a)) {
  24643. triangles.push(a.i, p.i, b.i);
  24644. // remove two nodes involved
  24645. removeNode(p);
  24646. removeNode(p.next);
  24647. p = start = b;
  24648. }
  24649. p = p.next;
  24650. } while (p !== start);
  24651. return filterPoints(p);
  24652. }
  24653. // try splitting polygon into two and triangulate them independently
  24654. function splitEarcut(start, triangles, dim, minX, minY, invSize) {
  24655. // look for a valid diagonal that divides the polygon into two
  24656. let a = start;
  24657. do {
  24658. let b = a.next.next;
  24659. while (b !== a.prev) {
  24660. if (a.i !== b.i && isValidDiagonal(a, b)) {
  24661. // split the polygon in two by the diagonal
  24662. let c = splitPolygon(a, b);
  24663. // filter colinear points around the cuts
  24664. a = filterPoints(a, a.next);
  24665. c = filterPoints(c, c.next);
  24666. // run earcut on each half
  24667. earcutLinked(a, triangles, dim, minX, minY, invSize, 0);
  24668. earcutLinked(c, triangles, dim, minX, minY, invSize, 0);
  24669. return;
  24670. }
  24671. b = b.next;
  24672. }
  24673. a = a.next;
  24674. } while (a !== start);
  24675. }
  24676. // link every hole into the outer loop, producing a single-ring polygon without holes
  24677. function eliminateHoles(data, holeIndices, outerNode, dim) {
  24678. const queue = [];
  24679. for (let i = 0, len = holeIndices.length; i < len; i++) {
  24680. const start = holeIndices[i] * dim;
  24681. const end = i < len - 1 ? holeIndices[i + 1] * dim : data.length;
  24682. const list = linkedList(data, start, end, dim, false);
  24683. if (list === list.next) list.steiner = true;
  24684. queue.push(getLeftmost(list));
  24685. }
  24686. queue.sort(compareXYSlope);
  24687. // process holes from left to right
  24688. for (let i = 0; i < queue.length; i++) {
  24689. outerNode = eliminateHole(queue[i], outerNode);
  24690. }
  24691. return outerNode;
  24692. }
  24693. function compareXYSlope(a, b) {
  24694. let result = a.x - b.x;
  24695. // when the left-most point of 2 holes meet at a vertex, sort the holes counterclockwise so that when we find
  24696. // the bridge to the outer shell is always the point that they meet at.
  24697. if (result === 0) {
  24698. result = a.y - b.y;
  24699. if (result === 0) {
  24700. const aSlope = (a.next.y - a.y) / (a.next.x - a.x);
  24701. const bSlope = (b.next.y - b.y) / (b.next.x - b.x);
  24702. result = aSlope - bSlope;
  24703. }
  24704. }
  24705. return result;
  24706. }
  24707. // find a bridge between vertices that connects hole with an outer ring and link it
  24708. function eliminateHole(hole, outerNode) {
  24709. const bridge = findHoleBridge(hole, outerNode);
  24710. if (!bridge) {
  24711. return outerNode;
  24712. }
  24713. const bridgeReverse = splitPolygon(bridge, hole);
  24714. // filter collinear points around the cuts
  24715. filterPoints(bridgeReverse, bridgeReverse.next);
  24716. return filterPoints(bridge, bridge.next);
  24717. }
  24718. // David Eberly's algorithm for finding a bridge between hole and outer polygon
  24719. function findHoleBridge(hole, outerNode) {
  24720. let p = outerNode;
  24721. const hx = hole.x;
  24722. const hy = hole.y;
  24723. let qx = -Infinity;
  24724. let m;
  24725. // find a segment intersected by a ray from the hole's leftmost point to the left;
  24726. // segment's endpoint with lesser x will be potential connection point
  24727. // unless they intersect at a vertex, then choose the vertex
  24728. if (equals(hole, p)) return p;
  24729. do {
  24730. if (equals(hole, p.next)) return p.next;
  24731. else if (hy <= p.y && hy >= p.next.y && p.next.y !== p.y) {
  24732. const x = p.x + (hy - p.y) * (p.next.x - p.x) / (p.next.y - p.y);
  24733. if (x <= hx && x > qx) {
  24734. qx = x;
  24735. m = p.x < p.next.x ? p : p.next;
  24736. if (x === hx) return m; // hole touches outer segment; pick leftmost endpoint
  24737. }
  24738. }
  24739. p = p.next;
  24740. } while (p !== outerNode);
  24741. if (!m) return null;
  24742. // look for points inside the triangle of hole point, segment intersection and endpoint;
  24743. // if there are no points found, we have a valid connection;
  24744. // otherwise choose the point of the minimum angle with the ray as connection point
  24745. const stop = m;
  24746. const mx = m.x;
  24747. const my = m.y;
  24748. let tanMin = Infinity;
  24749. p = m;
  24750. do {
  24751. if (hx >= p.x && p.x >= mx && hx !== p.x &&
  24752. pointInTriangle(hy < my ? hx : qx, hy, mx, my, hy < my ? qx : hx, hy, p.x, p.y)) {
  24753. const tan = Math.abs(hy - p.y) / (hx - p.x); // tangential
  24754. if (locallyInside(p, hole) &&
  24755. (tan < tanMin || (tan === tanMin && (p.x > m.x || (p.x === m.x && sectorContainsSector(m, p)))))) {
  24756. m = p;
  24757. tanMin = tan;
  24758. }
  24759. }
  24760. p = p.next;
  24761. } while (p !== stop);
  24762. return m;
  24763. }
  24764. // whether sector in vertex m contains sector in vertex p in the same coordinates
  24765. function sectorContainsSector(m, p) {
  24766. return area(m.prev, m, p.prev) < 0 && area(p.next, m, m.next) < 0;
  24767. }
  24768. // interlink polygon nodes in z-order
  24769. function indexCurve(start, minX, minY, invSize) {
  24770. let p = start;
  24771. do {
  24772. if (p.z === 0) p.z = zOrder(p.x, p.y, minX, minY, invSize);
  24773. p.prevZ = p.prev;
  24774. p.nextZ = p.next;
  24775. p = p.next;
  24776. } while (p !== start);
  24777. p.prevZ.nextZ = null;
  24778. p.prevZ = null;
  24779. sortLinked(p);
  24780. }
  24781. // Simon Tatham's linked list merge sort algorithm
  24782. // http://www.chiark.greenend.org.uk/~sgtatham/algorithms/listsort.html
  24783. function sortLinked(list) {
  24784. let numMerges;
  24785. let inSize = 1;
  24786. do {
  24787. let p = list;
  24788. let e;
  24789. list = null;
  24790. let tail = null;
  24791. numMerges = 0;
  24792. while (p) {
  24793. numMerges++;
  24794. let q = p;
  24795. let pSize = 0;
  24796. for (let i = 0; i < inSize; i++) {
  24797. pSize++;
  24798. q = q.nextZ;
  24799. if (!q) break;
  24800. }
  24801. let qSize = inSize;
  24802. while (pSize > 0 || (qSize > 0 && q)) {
  24803. if (pSize !== 0 && (qSize === 0 || !q || p.z <= q.z)) {
  24804. e = p;
  24805. p = p.nextZ;
  24806. pSize--;
  24807. } else {
  24808. e = q;
  24809. q = q.nextZ;
  24810. qSize--;
  24811. }
  24812. if (tail) tail.nextZ = e;
  24813. else list = e;
  24814. e.prevZ = tail;
  24815. tail = e;
  24816. }
  24817. p = q;
  24818. }
  24819. tail.nextZ = null;
  24820. inSize *= 2;
  24821. } while (numMerges > 1);
  24822. return list;
  24823. }
  24824. // z-order of a point given coords and inverse of the longer side of data bbox
  24825. function zOrder(x, y, minX, minY, invSize) {
  24826. // coords are transformed into non-negative 15-bit integer range
  24827. x = (x - minX) * invSize | 0;
  24828. y = (y - minY) * invSize | 0;
  24829. x = (x | (x << 8)) & 0x00FF00FF;
  24830. x = (x | (x << 4)) & 0x0F0F0F0F;
  24831. x = (x | (x << 2)) & 0x33333333;
  24832. x = (x | (x << 1)) & 0x55555555;
  24833. y = (y | (y << 8)) & 0x00FF00FF;
  24834. y = (y | (y << 4)) & 0x0F0F0F0F;
  24835. y = (y | (y << 2)) & 0x33333333;
  24836. y = (y | (y << 1)) & 0x55555555;
  24837. return x | (y << 1);
  24838. }
  24839. // find the leftmost node of a polygon ring
  24840. function getLeftmost(start) {
  24841. let p = start,
  24842. leftmost = start;
  24843. do {
  24844. if (p.x < leftmost.x || (p.x === leftmost.x && p.y < leftmost.y)) leftmost = p;
  24845. p = p.next;
  24846. } while (p !== start);
  24847. return leftmost;
  24848. }
  24849. // check if a point lies within a convex triangle
  24850. function pointInTriangle(ax, ay, bx, by, cx, cy, px, py) {
  24851. return (cx - px) * (ay - py) >= (ax - px) * (cy - py) &&
  24852. (ax - px) * (by - py) >= (bx - px) * (ay - py) &&
  24853. (bx - px) * (cy - py) >= (cx - px) * (by - py);
  24854. }
  24855. // check if a point lies within a convex triangle but false if its equal to the first point of the triangle
  24856. function pointInTriangleExceptFirst(ax, ay, bx, by, cx, cy, px, py) {
  24857. return !(ax === px && ay === py) && pointInTriangle(ax, ay, bx, by, cx, cy, px, py);
  24858. }
  24859. // check if a diagonal between two polygon nodes is valid (lies in polygon interior)
  24860. function isValidDiagonal(a, b) {
  24861. return a.next.i !== b.i && a.prev.i !== b.i && !intersectsPolygon(a, b) && // doesn't intersect other edges
  24862. (locallyInside(a, b) && locallyInside(b, a) && middleInside(a, b) && // locally visible
  24863. (area(a.prev, a, b.prev) || area(a, b.prev, b)) || // does not create opposite-facing sectors
  24864. equals(a, b) && area(a.prev, a, a.next) > 0 && area(b.prev, b, b.next) > 0); // special zero-length case
  24865. }
  24866. // signed area of a triangle
  24867. function area(p, q, r) {
  24868. return (q.y - p.y) * (r.x - q.x) - (q.x - p.x) * (r.y - q.y);
  24869. }
  24870. // check if two points are equal
  24871. function equals(p1, p2) {
  24872. return p1.x === p2.x && p1.y === p2.y;
  24873. }
  24874. // check if two segments intersect
  24875. function intersects(p1, q1, p2, q2) {
  24876. const o1 = sign(area(p1, q1, p2));
  24877. const o2 = sign(area(p1, q1, q2));
  24878. const o3 = sign(area(p2, q2, p1));
  24879. const o4 = sign(area(p2, q2, q1));
  24880. if (o1 !== o2 && o3 !== o4) return true; // general case
  24881. if (o1 === 0 && onSegment(p1, p2, q1)) return true; // p1, q1 and p2 are collinear and p2 lies on p1q1
  24882. if (o2 === 0 && onSegment(p1, q2, q1)) return true; // p1, q1 and q2 are collinear and q2 lies on p1q1
  24883. if (o3 === 0 && onSegment(p2, p1, q2)) return true; // p2, q2 and p1 are collinear and p1 lies on p2q2
  24884. if (o4 === 0 && onSegment(p2, q1, q2)) return true; // p2, q2 and q1 are collinear and q1 lies on p2q2
  24885. return false;
  24886. }
  24887. // for collinear points p, q, r, check if point q lies on segment pr
  24888. function onSegment(p, q, r) {
  24889. return q.x <= Math.max(p.x, r.x) && q.x >= Math.min(p.x, r.x) && q.y <= Math.max(p.y, r.y) && q.y >= Math.min(p.y, r.y);
  24890. }
  24891. function sign(num) {
  24892. return num > 0 ? 1 : num < 0 ? -1 : 0;
  24893. }
  24894. // check if a polygon diagonal intersects any polygon segments
  24895. function intersectsPolygon(a, b) {
  24896. let p = a;
  24897. do {
  24898. if (p.i !== a.i && p.next.i !== a.i && p.i !== b.i && p.next.i !== b.i &&
  24899. intersects(p, p.next, a, b)) return true;
  24900. p = p.next;
  24901. } while (p !== a);
  24902. return false;
  24903. }
  24904. // check if a polygon diagonal is locally inside the polygon
  24905. function locallyInside(a, b) {
  24906. return area(a.prev, a, a.next) < 0 ?
  24907. area(a, b, a.next) >= 0 && area(a, a.prev, b) >= 0 :
  24908. area(a, b, a.prev) < 0 || area(a, a.next, b) < 0;
  24909. }
  24910. // check if the middle point of a polygon diagonal is inside the polygon
  24911. function middleInside(a, b) {
  24912. let p = a;
  24913. let inside = false;
  24914. const px = (a.x + b.x) / 2;
  24915. const py = (a.y + b.y) / 2;
  24916. do {
  24917. if (((p.y > py) !== (p.next.y > py)) && p.next.y !== p.y &&
  24918. (px < (p.next.x - p.x) * (py - p.y) / (p.next.y - p.y) + p.x))
  24919. inside = !inside;
  24920. p = p.next;
  24921. } while (p !== a);
  24922. return inside;
  24923. }
  24924. // link two polygon vertices with a bridge; if the vertices belong to the same ring, it splits polygon into two;
  24925. // if one belongs to the outer ring and another to a hole, it merges it into a single ring
  24926. function splitPolygon(a, b) {
  24927. const a2 = createNode(a.i, a.x, a.y),
  24928. b2 = createNode(b.i, b.x, b.y),
  24929. an = a.next,
  24930. bp = b.prev;
  24931. a.next = b;
  24932. b.prev = a;
  24933. a2.next = an;
  24934. an.prev = a2;
  24935. b2.next = a2;
  24936. a2.prev = b2;
  24937. bp.next = b2;
  24938. b2.prev = bp;
  24939. return b2;
  24940. }
  24941. // create a node and optionally link it with previous one (in a circular doubly linked list)
  24942. function insertNode(i, x, y, last) {
  24943. const p = createNode(i, x, y);
  24944. if (!last) {
  24945. p.prev = p;
  24946. p.next = p;
  24947. } else {
  24948. p.next = last.next;
  24949. p.prev = last;
  24950. last.next.prev = p;
  24951. last.next = p;
  24952. }
  24953. return p;
  24954. }
  24955. function removeNode(p) {
  24956. p.next.prev = p.prev;
  24957. p.prev.next = p.next;
  24958. if (p.prevZ) p.prevZ.nextZ = p.nextZ;
  24959. if (p.nextZ) p.nextZ.prevZ = p.prevZ;
  24960. }
  24961. function createNode(i, x, y) {
  24962. return {
  24963. i, // vertex index in coordinates array
  24964. x, y, // vertex coordinates
  24965. prev: null, // previous and next vertex nodes in a polygon ring
  24966. next: null,
  24967. z: 0, // z-order curve value
  24968. prevZ: null, // previous and next nodes in z-order
  24969. nextZ: null,
  24970. steiner: false // indicates whether this is a steiner point
  24971. };
  24972. }
  24973. function signedArea(data, start, end, dim) {
  24974. let sum = 0;
  24975. for (let i = start, j = end - dim; i < end; i += dim) {
  24976. sum += (data[j] - data[i]) * (data[i + 1] + data[j + 1]);
  24977. j = i;
  24978. }
  24979. return sum;
  24980. }
  24981. /**
  24982. * An implementation of the earcut polygon triangulation algorithm.
  24983. * The code is a port of [mapbox/earcut](https://github.com/mapbox/earcut).
  24984. *
  24985. * @see https://github.com/mapbox/earcut
  24986. */
  24987. class Earcut {
  24988. /**
  24989. * Triangulates the given shape definition by returning an array of triangles.
  24990. *
  24991. * @param {Array<number>} data - An array with 2D points.
  24992. * @param {Array<number>} holeIndices - An array with indices defining holes.
  24993. * @param {number} [dim=2] - The number of coordinates per vertex in the input array.
  24994. * @return {Array<number>} An array representing the triangulated faces. Each face is defined by three consecutive numbers
  24995. * representing vertex indices.
  24996. */
  24997. static triangulate( data, holeIndices, dim = 2 ) {
  24998. return earcut( data, holeIndices, dim );
  24999. }
  25000. }
  25001. /**
  25002. * A class containing utility functions for shapes.
  25003. *
  25004. * @hideconstructor
  25005. */
  25006. class ShapeUtils {
  25007. /**
  25008. * Calculate area of a ( 2D ) contour polygon.
  25009. *
  25010. * @param {Array<Vector2>} contour - An array of 2D points.
  25011. * @return {number} The area.
  25012. */
  25013. static area( contour ) {
  25014. const n = contour.length;
  25015. let a = 0.0;
  25016. for ( let p = n - 1, q = 0; q < n; p = q ++ ) {
  25017. a += contour[ p ].x * contour[ q ].y - contour[ q ].x * contour[ p ].y;
  25018. }
  25019. return a * 0.5;
  25020. }
  25021. /**
  25022. * Returns `true` if the given contour uses a clockwise winding order.
  25023. *
  25024. * @param {Array<Vector2>} pts - An array of 2D points defining a polygon.
  25025. * @return {boolean} Whether the given contour uses a clockwise winding order or not.
  25026. */
  25027. static isClockWise( pts ) {
  25028. return ShapeUtils.area( pts ) < 0;
  25029. }
  25030. /**
  25031. * Triangulates the given shape definition.
  25032. *
  25033. * @param {Array<Vector2>} contour - An array of 2D points defining the contour.
  25034. * @param {Array<Array<Vector2>>} holes - An array that holds arrays of 2D points defining the holes.
  25035. * @return {Array<Array<number>>} An array that holds for each face definition an array with three indices.
  25036. */
  25037. static triangulateShape( contour, holes ) {
  25038. const vertices = []; // flat array of vertices like [ x0,y0, x1,y1, x2,y2, ... ]
  25039. const holeIndices = []; // array of hole indices
  25040. const faces = []; // final array of vertex indices like [ [ a,b,d ], [ b,c,d ] ]
  25041. removeDupEndPts( contour );
  25042. addContour( vertices, contour );
  25043. //
  25044. let holeIndex = contour.length;
  25045. holes.forEach( removeDupEndPts );
  25046. for ( let i = 0; i < holes.length; i ++ ) {
  25047. holeIndices.push( holeIndex );
  25048. holeIndex += holes[ i ].length;
  25049. addContour( vertices, holes[ i ] );
  25050. }
  25051. //
  25052. const triangles = Earcut.triangulate( vertices, holeIndices );
  25053. //
  25054. for ( let i = 0; i < triangles.length; i += 3 ) {
  25055. faces.push( triangles.slice( i, i + 3 ) );
  25056. }
  25057. return faces;
  25058. }
  25059. }
  25060. function removeDupEndPts( points ) {
  25061. const l = points.length;
  25062. if ( l > 2 && points[ l - 1 ].equals( points[ 0 ] ) ) {
  25063. points.pop();
  25064. }
  25065. }
  25066. function addContour( vertices, contour ) {
  25067. for ( let i = 0; i < contour.length; i ++ ) {
  25068. vertices.push( contour[ i ].x );
  25069. vertices.push( contour[ i ].y );
  25070. }
  25071. }
  25072. /**
  25073. * Creates extruded geometry from a path shape.
  25074. *
  25075. * ```js
  25076. * const length = 12, width = 8;
  25077. *
  25078. * const shape = new THREE.Shape();
  25079. * shape.moveTo( 0,0 );
  25080. * shape.lineTo( 0, width );
  25081. * shape.lineTo( length, width );
  25082. * shape.lineTo( length, 0 );
  25083. * shape.lineTo( 0, 0 );
  25084. *
  25085. * const geometry = new THREE.ExtrudeGeometry( shape );
  25086. * const material = new THREE.MeshBasicMaterial( { color: 0x00ff00 } );
  25087. * const mesh = new THREE.Mesh( geometry, material ) ;
  25088. * scene.add( mesh );
  25089. * ```
  25090. *
  25091. * @augments BufferGeometry
  25092. * @demo scenes/geometry-browser.html#ExtrudeGeometry
  25093. */
  25094. class ExtrudeGeometry extends BufferGeometry {
  25095. /**
  25096. * Constructs a new extrude geometry.
  25097. *
  25098. * @param {Shape|Array<Shape>} [shapes] - A shape or an array of shapes.
  25099. * @param {ExtrudeGeometry~Options} [options] - The extrude settings.
  25100. */
  25101. constructor( shapes = new Shape( [ new Vector2( 0.5, 0.5 ), new Vector2( -0.5, 0.5 ), new Vector2( -0.5, -0.5 ), new Vector2( 0.5, -0.5 ) ] ), options = {} ) {
  25102. super();
  25103. this.type = 'ExtrudeGeometry';
  25104. /**
  25105. * Holds the constructor parameters that have been
  25106. * used to generate the geometry. Any modification
  25107. * after instantiation does not change the geometry.
  25108. *
  25109. * @type {Object}
  25110. */
  25111. this.parameters = {
  25112. shapes: shapes,
  25113. options: options
  25114. };
  25115. shapes = Array.isArray( shapes ) ? shapes : [ shapes ];
  25116. const scope = this;
  25117. const verticesArray = [];
  25118. const uvArray = [];
  25119. for ( let i = 0, l = shapes.length; i < l; i ++ ) {
  25120. const shape = shapes[ i ];
  25121. addShape( shape );
  25122. }
  25123. // build geometry
  25124. this.setAttribute( 'position', new Float32BufferAttribute( verticesArray, 3 ) );
  25125. this.setAttribute( 'uv', new Float32BufferAttribute( uvArray, 2 ) );
  25126. this.computeVertexNormals();
  25127. // functions
  25128. function addShape( shape ) {
  25129. const placeholder = [];
  25130. // options
  25131. const curveSegments = options.curveSegments !== undefined ? options.curveSegments : 12;
  25132. const steps = options.steps !== undefined ? options.steps : 1;
  25133. const depth = options.depth !== undefined ? options.depth : 1;
  25134. let bevelEnabled = options.bevelEnabled !== undefined ? options.bevelEnabled : true;
  25135. let bevelThickness = options.bevelThickness !== undefined ? options.bevelThickness : 0.2;
  25136. let bevelSize = options.bevelSize !== undefined ? options.bevelSize : bevelThickness - 0.1;
  25137. let bevelOffset = options.bevelOffset !== undefined ? options.bevelOffset : 0;
  25138. let bevelSegments = options.bevelSegments !== undefined ? options.bevelSegments : 3;
  25139. const extrudePath = options.extrudePath;
  25140. const uvgen = options.UVGenerator !== undefined ? options.UVGenerator : WorldUVGenerator;
  25141. //
  25142. let extrudePts, extrudeByPath = false;
  25143. let splineTube, binormal, normal, position2;
  25144. if ( extrudePath ) {
  25145. extrudePts = extrudePath.getSpacedPoints( steps );
  25146. extrudeByPath = true;
  25147. bevelEnabled = false; // bevels not supported for path extrusion
  25148. // SETUP TNB variables
  25149. const isClosed = extrudePath.isCatmullRomCurve3 ? extrudePath.closed : false;
  25150. splineTube = extrudePath.computeFrenetFrames( steps, isClosed );
  25151. // log(splineTube, 'splineTube', splineTube.normals.length, 'steps', steps, 'extrudePts', extrudePts.length);
  25152. binormal = new Vector3();
  25153. normal = new Vector3();
  25154. position2 = new Vector3();
  25155. }
  25156. // Safeguards if bevels are not enabled
  25157. if ( ! bevelEnabled ) {
  25158. bevelSegments = 0;
  25159. bevelThickness = 0;
  25160. bevelSize = 0;
  25161. bevelOffset = 0;
  25162. }
  25163. // Variables initialization
  25164. const shapePoints = shape.extractPoints( curveSegments );
  25165. let vertices = shapePoints.shape;
  25166. const holes = shapePoints.holes;
  25167. const reverse = ! ShapeUtils.isClockWise( vertices );
  25168. if ( reverse ) {
  25169. vertices = vertices.reverse();
  25170. // Maybe we should also check if holes are in the opposite direction, just to be safe ...
  25171. for ( let h = 0, hl = holes.length; h < hl; h ++ ) {
  25172. const ahole = holes[ h ];
  25173. if ( ShapeUtils.isClockWise( ahole ) ) {
  25174. holes[ h ] = ahole.reverse();
  25175. }
  25176. }
  25177. }
  25178. /**Merges index-adjacent points that are within a threshold distance of each other. Array is modified in-place. Threshold distance is empirical, and scaled based on the magnitude of point coordinates.
  25179. * @param {Array<Vector2>} points
  25180. */
  25181. function mergeOverlappingPoints( points ) {
  25182. const THRESHOLD = 1e-10;
  25183. const THRESHOLD_SQ = THRESHOLD * THRESHOLD;
  25184. let prevPos = points[ 0 ];
  25185. for ( let i = 1; i <= points.length; i ++ ) {
  25186. const currentIndex = i % points.length;
  25187. const currentPos = points[ currentIndex ];
  25188. const dx = currentPos.x - prevPos.x;
  25189. const dy = currentPos.y - prevPos.y;
  25190. const distSq = dx * dx + dy * dy;
  25191. const scalingFactorSqrt = Math.max(
  25192. Math.abs( currentPos.x ),
  25193. Math.abs( currentPos.y ),
  25194. Math.abs( prevPos.x ),
  25195. Math.abs( prevPos.y )
  25196. );
  25197. const thresholdSqScaled = THRESHOLD_SQ * scalingFactorSqrt * scalingFactorSqrt;
  25198. if ( distSq <= thresholdSqScaled ) {
  25199. points.splice( currentIndex, 1 );
  25200. i --;
  25201. continue;
  25202. }
  25203. prevPos = currentPos;
  25204. }
  25205. }
  25206. mergeOverlappingPoints( vertices );
  25207. holes.forEach( mergeOverlappingPoints );
  25208. const numHoles = holes.length;
  25209. /* Vertices */
  25210. const contour = vertices; // vertices has all points but contour has only points of circumference
  25211. for ( let h = 0; h < numHoles; h ++ ) {
  25212. const ahole = holes[ h ];
  25213. vertices = vertices.concat( ahole );
  25214. }
  25215. function scalePt2( pt, vec, size ) {
  25216. if ( ! vec ) error( 'ExtrudeGeometry: vec does not exist' );
  25217. return pt.clone().addScaledVector( vec, size );
  25218. }
  25219. const vlen = vertices.length;
  25220. // Find directions for point movement
  25221. function getBevelVec( inPt, inPrev, inNext ) {
  25222. // computes for inPt the corresponding point inPt' on a new contour
  25223. // shifted by 1 unit (length of normalized vector) to the left
  25224. // if we walk along contour clockwise, this new contour is outside the old one
  25225. //
  25226. // inPt' is the intersection of the two lines parallel to the two
  25227. // adjacent edges of inPt at a distance of 1 unit on the left side.
  25228. let v_trans_x, v_trans_y, shrink_by; // resulting translation vector for inPt
  25229. // good reading for geometry algorithms (here: line-line intersection)
  25230. // http://geomalgorithms.com/a05-_intersect-1.html
  25231. const v_prev_x = inPt.x - inPrev.x,
  25232. v_prev_y = inPt.y - inPrev.y;
  25233. const v_next_x = inNext.x - inPt.x,
  25234. v_next_y = inNext.y - inPt.y;
  25235. const v_prev_lensq = ( v_prev_x * v_prev_x + v_prev_y * v_prev_y );
  25236. // check for collinear edges
  25237. const collinear0 = ( v_prev_x * v_next_y - v_prev_y * v_next_x );
  25238. if ( Math.abs( collinear0 ) > Number.EPSILON ) {
  25239. // not collinear
  25240. // length of vectors for normalizing
  25241. const v_prev_len = Math.sqrt( v_prev_lensq );
  25242. const v_next_len = Math.sqrt( v_next_x * v_next_x + v_next_y * v_next_y );
  25243. // shift adjacent points by unit vectors to the left
  25244. const ptPrevShift_x = ( inPrev.x - v_prev_y / v_prev_len );
  25245. const ptPrevShift_y = ( inPrev.y + v_prev_x / v_prev_len );
  25246. const ptNextShift_x = ( inNext.x - v_next_y / v_next_len );
  25247. const ptNextShift_y = ( inNext.y + v_next_x / v_next_len );
  25248. // scaling factor for v_prev to intersection point
  25249. const sf = ( ( ptNextShift_x - ptPrevShift_x ) * v_next_y -
  25250. ( ptNextShift_y - ptPrevShift_y ) * v_next_x ) /
  25251. ( v_prev_x * v_next_y - v_prev_y * v_next_x );
  25252. // vector from inPt to intersection point
  25253. v_trans_x = ( ptPrevShift_x + v_prev_x * sf - inPt.x );
  25254. v_trans_y = ( ptPrevShift_y + v_prev_y * sf - inPt.y );
  25255. // Don't normalize!, otherwise sharp corners become ugly
  25256. // but prevent crazy spikes
  25257. const v_trans_lensq = ( v_trans_x * v_trans_x + v_trans_y * v_trans_y );
  25258. if ( v_trans_lensq <= 2 ) {
  25259. return new Vector2( v_trans_x, v_trans_y );
  25260. } else {
  25261. shrink_by = Math.sqrt( v_trans_lensq / 2 );
  25262. }
  25263. } else {
  25264. // handle special case of collinear edges
  25265. let direction_eq = false; // assumes: opposite
  25266. if ( v_prev_x > Number.EPSILON ) {
  25267. if ( v_next_x > Number.EPSILON ) {
  25268. direction_eq = true;
  25269. }
  25270. } else {
  25271. if ( v_prev_x < - Number.EPSILON ) {
  25272. if ( v_next_x < - Number.EPSILON ) {
  25273. direction_eq = true;
  25274. }
  25275. } else {
  25276. if ( Math.sign( v_prev_y ) === Math.sign( v_next_y ) ) {
  25277. direction_eq = true;
  25278. }
  25279. }
  25280. }
  25281. if ( direction_eq ) {
  25282. // log("Warning: lines are a straight sequence");
  25283. v_trans_x = - v_prev_y;
  25284. v_trans_y = v_prev_x;
  25285. shrink_by = Math.sqrt( v_prev_lensq );
  25286. } else {
  25287. // log("Warning: lines are a straight spike");
  25288. v_trans_x = v_prev_x;
  25289. v_trans_y = v_prev_y;
  25290. shrink_by = Math.sqrt( v_prev_lensq / 2 );
  25291. }
  25292. }
  25293. return new Vector2( v_trans_x / shrink_by, v_trans_y / shrink_by );
  25294. }
  25295. const contourMovements = [];
  25296. for ( let i = 0, il = contour.length, j = il - 1, k = i + 1; i < il; i ++, j ++, k ++ ) {
  25297. if ( j === il ) j = 0;
  25298. if ( k === il ) k = 0;
  25299. // (j)---(i)---(k)
  25300. // log('i,j,k', i, j , k)
  25301. contourMovements[ i ] = getBevelVec( contour[ i ], contour[ j ], contour[ k ] );
  25302. }
  25303. const holesMovements = [];
  25304. let oneHoleMovements, verticesMovements = contourMovements.concat();
  25305. for ( let h = 0, hl = numHoles; h < hl; h ++ ) {
  25306. const ahole = holes[ h ];
  25307. oneHoleMovements = [];
  25308. for ( let i = 0, il = ahole.length, j = il - 1, k = i + 1; i < il; i ++, j ++, k ++ ) {
  25309. if ( j === il ) j = 0;
  25310. if ( k === il ) k = 0;
  25311. // (j)---(i)---(k)
  25312. oneHoleMovements[ i ] = getBevelVec( ahole[ i ], ahole[ j ], ahole[ k ] );
  25313. }
  25314. holesMovements.push( oneHoleMovements );
  25315. verticesMovements = verticesMovements.concat( oneHoleMovements );
  25316. }
  25317. let faces;
  25318. if ( bevelSegments === 0 ) {
  25319. faces = ShapeUtils.triangulateShape( contour, holes );
  25320. } else {
  25321. const contractedContourVertices = [];
  25322. const expandedHoleVertices = [];
  25323. // Loop bevelSegments, 1 for the front, 1 for the back
  25324. for ( let b = 0; b < bevelSegments; b ++ ) {
  25325. //for ( b = bevelSegments; b > 0; b -- ) {
  25326. const t = b / bevelSegments;
  25327. const z = bevelThickness * Math.cos( t * Math.PI / 2 );
  25328. const bs = bevelSize * Math.sin( t * Math.PI / 2 ) + bevelOffset;
  25329. // contract shape
  25330. for ( let i = 0, il = contour.length; i < il; i ++ ) {
  25331. const vert = scalePt2( contour[ i ], contourMovements[ i ], bs );
  25332. v( vert.x, vert.y, - z );
  25333. if ( t === 0 ) contractedContourVertices.push( vert );
  25334. }
  25335. // expand holes
  25336. for ( let h = 0, hl = numHoles; h < hl; h ++ ) {
  25337. const ahole = holes[ h ];
  25338. oneHoleMovements = holesMovements[ h ];
  25339. const oneHoleVertices = [];
  25340. for ( let i = 0, il = ahole.length; i < il; i ++ ) {
  25341. const vert = scalePt2( ahole[ i ], oneHoleMovements[ i ], bs );
  25342. v( vert.x, vert.y, - z );
  25343. if ( t === 0 ) oneHoleVertices.push( vert );
  25344. }
  25345. if ( t === 0 ) expandedHoleVertices.push( oneHoleVertices );
  25346. }
  25347. }
  25348. faces = ShapeUtils.triangulateShape( contractedContourVertices, expandedHoleVertices );
  25349. }
  25350. const flen = faces.length;
  25351. const bs = bevelSize + bevelOffset;
  25352. // Back facing vertices
  25353. for ( let i = 0; i < vlen; i ++ ) {
  25354. const vert = bevelEnabled ? scalePt2( vertices[ i ], verticesMovements[ i ], bs ) : vertices[ i ];
  25355. if ( ! extrudeByPath ) {
  25356. v( vert.x, vert.y, 0 );
  25357. } else {
  25358. // v( vert.x, vert.y + extrudePts[ 0 ].y, extrudePts[ 0 ].x );
  25359. normal.copy( splineTube.normals[ 0 ] ).multiplyScalar( vert.x );
  25360. binormal.copy( splineTube.binormals[ 0 ] ).multiplyScalar( vert.y );
  25361. position2.copy( extrudePts[ 0 ] ).add( normal ).add( binormal );
  25362. v( position2.x, position2.y, position2.z );
  25363. }
  25364. }
  25365. // Add stepped vertices...
  25366. // Including front facing vertices
  25367. for ( let s = 1; s <= steps; s ++ ) {
  25368. for ( let i = 0; i < vlen; i ++ ) {
  25369. const vert = bevelEnabled ? scalePt2( vertices[ i ], verticesMovements[ i ], bs ) : vertices[ i ];
  25370. if ( ! extrudeByPath ) {
  25371. v( vert.x, vert.y, depth / steps * s );
  25372. } else {
  25373. // v( vert.x, vert.y + extrudePts[ s - 1 ].y, extrudePts[ s - 1 ].x );
  25374. normal.copy( splineTube.normals[ s ] ).multiplyScalar( vert.x );
  25375. binormal.copy( splineTube.binormals[ s ] ).multiplyScalar( vert.y );
  25376. position2.copy( extrudePts[ s ] ).add( normal ).add( binormal );
  25377. v( position2.x, position2.y, position2.z );
  25378. }
  25379. }
  25380. }
  25381. // Add bevel segments planes
  25382. //for ( b = 1; b <= bevelSegments; b ++ ) {
  25383. for ( let b = bevelSegments - 1; b >= 0; b -- ) {
  25384. const t = b / bevelSegments;
  25385. const z = bevelThickness * Math.cos( t * Math.PI / 2 );
  25386. const bs = bevelSize * Math.sin( t * Math.PI / 2 ) + bevelOffset;
  25387. // contract shape
  25388. for ( let i = 0, il = contour.length; i < il; i ++ ) {
  25389. const vert = scalePt2( contour[ i ], contourMovements[ i ], bs );
  25390. v( vert.x, vert.y, depth + z );
  25391. }
  25392. // expand holes
  25393. for ( let h = 0, hl = holes.length; h < hl; h ++ ) {
  25394. const ahole = holes[ h ];
  25395. oneHoleMovements = holesMovements[ h ];
  25396. for ( let i = 0, il = ahole.length; i < il; i ++ ) {
  25397. const vert = scalePt2( ahole[ i ], oneHoleMovements[ i ], bs );
  25398. if ( ! extrudeByPath ) {
  25399. v( vert.x, vert.y, depth + z );
  25400. } else {
  25401. v( vert.x, vert.y + extrudePts[ steps - 1 ].y, extrudePts[ steps - 1 ].x + z );
  25402. }
  25403. }
  25404. }
  25405. }
  25406. /* Faces */
  25407. // Top and bottom faces
  25408. buildLidFaces();
  25409. // Sides faces
  25410. buildSideFaces();
  25411. ///// Internal functions
  25412. function buildLidFaces() {
  25413. const start = verticesArray.length / 3;
  25414. if ( bevelEnabled ) {
  25415. let layer = 0; // steps + 1
  25416. let offset = vlen * layer;
  25417. // Bottom faces
  25418. for ( let i = 0; i < flen; i ++ ) {
  25419. const face = faces[ i ];
  25420. f3( face[ 2 ] + offset, face[ 1 ] + offset, face[ 0 ] + offset );
  25421. }
  25422. layer = steps + bevelSegments * 2;
  25423. offset = vlen * layer;
  25424. // Top faces
  25425. for ( let i = 0; i < flen; i ++ ) {
  25426. const face = faces[ i ];
  25427. f3( face[ 0 ] + offset, face[ 1 ] + offset, face[ 2 ] + offset );
  25428. }
  25429. } else {
  25430. // Bottom faces
  25431. for ( let i = 0; i < flen; i ++ ) {
  25432. const face = faces[ i ];
  25433. f3( face[ 2 ], face[ 1 ], face[ 0 ] );
  25434. }
  25435. // Top faces
  25436. for ( let i = 0; i < flen; i ++ ) {
  25437. const face = faces[ i ];
  25438. f3( face[ 0 ] + vlen * steps, face[ 1 ] + vlen * steps, face[ 2 ] + vlen * steps );
  25439. }
  25440. }
  25441. scope.addGroup( start, verticesArray.length / 3 - start, 0 );
  25442. }
  25443. // Create faces for the z-sides of the shape
  25444. function buildSideFaces() {
  25445. const start = verticesArray.length / 3;
  25446. let layeroffset = 0;
  25447. sidewalls( contour, layeroffset );
  25448. layeroffset += contour.length;
  25449. for ( let h = 0, hl = holes.length; h < hl; h ++ ) {
  25450. const ahole = holes[ h ];
  25451. sidewalls( ahole, layeroffset );
  25452. //, true
  25453. layeroffset += ahole.length;
  25454. }
  25455. scope.addGroup( start, verticesArray.length / 3 - start, 1 );
  25456. }
  25457. function sidewalls( contour, layeroffset ) {
  25458. let i = contour.length;
  25459. while ( -- i >= 0 ) {
  25460. const j = i;
  25461. let k = i - 1;
  25462. if ( k < 0 ) k = contour.length - 1;
  25463. //log('b', i,j, i-1, k,vertices.length);
  25464. for ( let s = 0, sl = ( steps + bevelSegments * 2 ); s < sl; s ++ ) {
  25465. const slen1 = vlen * s;
  25466. const slen2 = vlen * ( s + 1 );
  25467. const a = layeroffset + j + slen1,
  25468. b = layeroffset + k + slen1,
  25469. c = layeroffset + k + slen2,
  25470. d = layeroffset + j + slen2;
  25471. f4( a, b, c, d );
  25472. }
  25473. }
  25474. }
  25475. function v( x, y, z ) {
  25476. placeholder.push( x );
  25477. placeholder.push( y );
  25478. placeholder.push( z );
  25479. }
  25480. function f3( a, b, c ) {
  25481. addVertex( a );
  25482. addVertex( b );
  25483. addVertex( c );
  25484. const nextIndex = verticesArray.length / 3;
  25485. const uvs = uvgen.generateTopUV( scope, verticesArray, nextIndex - 3, nextIndex - 2, nextIndex - 1 );
  25486. addUV( uvs[ 0 ] );
  25487. addUV( uvs[ 1 ] );
  25488. addUV( uvs[ 2 ] );
  25489. }
  25490. function f4( a, b, c, d ) {
  25491. addVertex( a );
  25492. addVertex( b );
  25493. addVertex( d );
  25494. addVertex( b );
  25495. addVertex( c );
  25496. addVertex( d );
  25497. const nextIndex = verticesArray.length / 3;
  25498. const uvs = uvgen.generateSideWallUV( scope, verticesArray, nextIndex - 6, nextIndex - 3, nextIndex - 2, nextIndex - 1 );
  25499. addUV( uvs[ 0 ] );
  25500. addUV( uvs[ 1 ] );
  25501. addUV( uvs[ 3 ] );
  25502. addUV( uvs[ 1 ] );
  25503. addUV( uvs[ 2 ] );
  25504. addUV( uvs[ 3 ] );
  25505. }
  25506. function addVertex( index ) {
  25507. verticesArray.push( placeholder[ index * 3 + 0 ] );
  25508. verticesArray.push( placeholder[ index * 3 + 1 ] );
  25509. verticesArray.push( placeholder[ index * 3 + 2 ] );
  25510. }
  25511. function addUV( vector2 ) {
  25512. uvArray.push( vector2.x );
  25513. uvArray.push( vector2.y );
  25514. }
  25515. }
  25516. }
  25517. copy( source ) {
  25518. super.copy( source );
  25519. this.parameters = Object.assign( {}, source.parameters );
  25520. return this;
  25521. }
  25522. toJSON() {
  25523. const data = super.toJSON();
  25524. const shapes = this.parameters.shapes;
  25525. const options = this.parameters.options;
  25526. return toJSON$1( shapes, options, data );
  25527. }
  25528. /**
  25529. * Factory method for creating an instance of this class from the given
  25530. * JSON object.
  25531. *
  25532. * @param {Object} data - A JSON object representing the serialized geometry.
  25533. * @param {Array<Shape>} shapes - An array of shapes.
  25534. * @return {ExtrudeGeometry} A new instance.
  25535. */
  25536. static fromJSON( data, shapes ) {
  25537. const geometryShapes = [];
  25538. for ( let j = 0, jl = data.shapes.length; j < jl; j ++ ) {
  25539. const shape = shapes[ data.shapes[ j ] ];
  25540. geometryShapes.push( shape );
  25541. }
  25542. const extrudePath = data.options.extrudePath;
  25543. if ( extrudePath !== undefined ) {
  25544. data.options.extrudePath = new Curves[ extrudePath.type ]().fromJSON( extrudePath );
  25545. }
  25546. return new ExtrudeGeometry( geometryShapes, data.options );
  25547. }
  25548. }
  25549. const WorldUVGenerator = {
  25550. generateTopUV: function ( geometry, vertices, indexA, indexB, indexC ) {
  25551. const a_x = vertices[ indexA * 3 ];
  25552. const a_y = vertices[ indexA * 3 + 1 ];
  25553. const b_x = vertices[ indexB * 3 ];
  25554. const b_y = vertices[ indexB * 3 + 1 ];
  25555. const c_x = vertices[ indexC * 3 ];
  25556. const c_y = vertices[ indexC * 3 + 1 ];
  25557. return [
  25558. new Vector2( a_x, a_y ),
  25559. new Vector2( b_x, b_y ),
  25560. new Vector2( c_x, c_y )
  25561. ];
  25562. },
  25563. generateSideWallUV: function ( geometry, vertices, indexA, indexB, indexC, indexD ) {
  25564. const a_x = vertices[ indexA * 3 ];
  25565. const a_y = vertices[ indexA * 3 + 1 ];
  25566. const a_z = vertices[ indexA * 3 + 2 ];
  25567. const b_x = vertices[ indexB * 3 ];
  25568. const b_y = vertices[ indexB * 3 + 1 ];
  25569. const b_z = vertices[ indexB * 3 + 2 ];
  25570. const c_x = vertices[ indexC * 3 ];
  25571. const c_y = vertices[ indexC * 3 + 1 ];
  25572. const c_z = vertices[ indexC * 3 + 2 ];
  25573. const d_x = vertices[ indexD * 3 ];
  25574. const d_y = vertices[ indexD * 3 + 1 ];
  25575. const d_z = vertices[ indexD * 3 + 2 ];
  25576. if ( Math.abs( a_y - b_y ) < Math.abs( a_x - b_x ) ) {
  25577. return [
  25578. new Vector2( a_x, 1 - a_z ),
  25579. new Vector2( b_x, 1 - b_z ),
  25580. new Vector2( c_x, 1 - c_z ),
  25581. new Vector2( d_x, 1 - d_z )
  25582. ];
  25583. } else {
  25584. return [
  25585. new Vector2( a_y, 1 - a_z ),
  25586. new Vector2( b_y, 1 - b_z ),
  25587. new Vector2( c_y, 1 - c_z ),
  25588. new Vector2( d_y, 1 - d_z )
  25589. ];
  25590. }
  25591. }
  25592. };
  25593. function toJSON$1( shapes, options, data ) {
  25594. data.shapes = [];
  25595. if ( Array.isArray( shapes ) ) {
  25596. for ( let i = 0, l = shapes.length; i < l; i ++ ) {
  25597. const shape = shapes[ i ];
  25598. data.shapes.push( shape.uuid );
  25599. }
  25600. } else {
  25601. data.shapes.push( shapes.uuid );
  25602. }
  25603. data.options = Object.assign( {}, options );
  25604. if ( options.extrudePath !== undefined ) data.options.extrudePath = options.extrudePath.toJSON();
  25605. return data;
  25606. }
  25607. /**
  25608. * A geometry class for representing an icosahedron.
  25609. *
  25610. * ```js
  25611. * const geometry = new THREE.IcosahedronGeometry();
  25612. * const material = new THREE.MeshBasicMaterial( { color: 0xffff00 } );
  25613. * const icosahedron = new THREE.Mesh( geometry, material );
  25614. * scene.add( icosahedron );
  25615. * ```
  25616. *
  25617. * @augments PolyhedronGeometry
  25618. * @demo scenes/geometry-browser.html#IcosahedronGeometry
  25619. */
  25620. class IcosahedronGeometry extends PolyhedronGeometry {
  25621. /**
  25622. * Constructs a new icosahedron geometry.
  25623. *
  25624. * @param {number} [radius=1] - Radius of the icosahedron.
  25625. * @param {number} [detail=0] - Setting this to a value greater than `0` adds vertices making it no longer a icosahedron.
  25626. */
  25627. constructor( radius = 1, detail = 0 ) {
  25628. const t = ( 1 + Math.sqrt( 5 ) ) / 2;
  25629. const vertices = [
  25630. -1, t, 0, 1, t, 0, -1, - t, 0, 1, - t, 0,
  25631. 0, -1, t, 0, 1, t, 0, -1, - t, 0, 1, - t,
  25632. t, 0, -1, t, 0, 1, - t, 0, -1, - t, 0, 1
  25633. ];
  25634. const indices = [
  25635. 0, 11, 5, 0, 5, 1, 0, 1, 7, 0, 7, 10, 0, 10, 11,
  25636. 1, 5, 9, 5, 11, 4, 11, 10, 2, 10, 7, 6, 7, 1, 8,
  25637. 3, 9, 4, 3, 4, 2, 3, 2, 6, 3, 6, 8, 3, 8, 9,
  25638. 4, 9, 5, 2, 4, 11, 6, 2, 10, 8, 6, 7, 9, 8, 1
  25639. ];
  25640. super( vertices, indices, radius, detail );
  25641. this.type = 'IcosahedronGeometry';
  25642. /**
  25643. * Holds the constructor parameters that have been
  25644. * used to generate the geometry. Any modification
  25645. * after instantiation does not change the geometry.
  25646. *
  25647. * @type {Object}
  25648. */
  25649. this.parameters = {
  25650. radius: radius,
  25651. detail: detail
  25652. };
  25653. }
  25654. /**
  25655. * Factory method for creating an instance of this class from the given
  25656. * JSON object.
  25657. *
  25658. * @param {Object} data - A JSON object representing the serialized geometry.
  25659. * @return {IcosahedronGeometry} A new instance.
  25660. */
  25661. static fromJSON( data ) {
  25662. return new IcosahedronGeometry( data.radius, data.detail );
  25663. }
  25664. }
  25665. /**
  25666. * Creates meshes with axial symmetry like vases. The lathe rotates around the Y axis.
  25667. *
  25668. * ```js
  25669. * const points = [];
  25670. * for ( let i = 0; i < 10; i ++ ) {
  25671. * points.push( new THREE.Vector2( Math.sin( i * 0.2 ) * 10 + 5, ( i - 5 ) * 2 ) );
  25672. * }
  25673. * const geometry = new THREE.LatheGeometry( points );
  25674. * const material = new THREE.MeshBasicMaterial( { color: 0xffff00 } );
  25675. * const lathe = new THREE.Mesh( geometry, material );
  25676. * scene.add( lathe );
  25677. * ```
  25678. *
  25679. * @augments BufferGeometry
  25680. * @demo scenes/geometry-browser.html#LatheGeometry
  25681. */
  25682. class LatheGeometry extends BufferGeometry {
  25683. /**
  25684. * Constructs a new lathe geometry.
  25685. *
  25686. * @param {Array<Vector2|Vector3>} [points] - An array of points in 2D space. The x-coordinate of each point
  25687. * must be greater than zero.
  25688. * @param {number} [segments=12] - The number of circumference segments to generate.
  25689. * @param {number} [phiStart=0] - The starting angle in radians.
  25690. * @param {number} [phiLength=Math.PI*2] - The radian (0 to 2PI) range of the lathed section 2PI is a
  25691. * closed lathe, less than 2PI is a portion.
  25692. */
  25693. constructor( points = [ new Vector2( 0, -0.5 ), new Vector2( 0.5, 0 ), new Vector2( 0, 0.5 ) ], segments = 12, phiStart = 0, phiLength = Math.PI * 2 ) {
  25694. super();
  25695. this.type = 'LatheGeometry';
  25696. /**
  25697. * Holds the constructor parameters that have been
  25698. * used to generate the geometry. Any modification
  25699. * after instantiation does not change the geometry.
  25700. *
  25701. * @type {Object}
  25702. */
  25703. this.parameters = {
  25704. points: points,
  25705. segments: segments,
  25706. phiStart: phiStart,
  25707. phiLength: phiLength
  25708. };
  25709. segments = Math.floor( segments );
  25710. // clamp phiLength so it's in range of [ 0, 2PI ]
  25711. phiLength = clamp( phiLength, 0, Math.PI * 2 );
  25712. // buffers
  25713. const indices = [];
  25714. const vertices = [];
  25715. const uvs = [];
  25716. const initNormals = [];
  25717. const normals = [];
  25718. // helper variables
  25719. const inverseSegments = 1.0 / segments;
  25720. const vertex = new Vector3();
  25721. const uv = new Vector2();
  25722. const normal = new Vector3();
  25723. const curNormal = new Vector3();
  25724. const prevNormal = new Vector3();
  25725. let dx = 0;
  25726. let dy = 0;
  25727. // pre-compute normals for initial "meridian"
  25728. for ( let j = 0; j <= ( points.length - 1 ); j ++ ) {
  25729. switch ( j ) {
  25730. case 0: // special handling for 1st vertex on path
  25731. dx = points[ j + 1 ].x - points[ j ].x;
  25732. dy = points[ j + 1 ].y - points[ j ].y;
  25733. normal.x = dy * 1.0;
  25734. normal.y = - dx;
  25735. normal.z = dy * 0.0;
  25736. prevNormal.copy( normal );
  25737. normal.normalize();
  25738. initNormals.push( normal.x, normal.y, normal.z );
  25739. break;
  25740. case ( points.length - 1 ): // special handling for last Vertex on path
  25741. initNormals.push( prevNormal.x, prevNormal.y, prevNormal.z );
  25742. break;
  25743. default: // default handling for all vertices in between
  25744. dx = points[ j + 1 ].x - points[ j ].x;
  25745. dy = points[ j + 1 ].y - points[ j ].y;
  25746. normal.x = dy * 1.0;
  25747. normal.y = - dx;
  25748. normal.z = dy * 0.0;
  25749. curNormal.copy( normal );
  25750. normal.x += prevNormal.x;
  25751. normal.y += prevNormal.y;
  25752. normal.z += prevNormal.z;
  25753. normal.normalize();
  25754. initNormals.push( normal.x, normal.y, normal.z );
  25755. prevNormal.copy( curNormal );
  25756. }
  25757. }
  25758. // generate vertices, uvs and normals
  25759. for ( let i = 0; i <= segments; i ++ ) {
  25760. const phi = phiStart + i * inverseSegments * phiLength;
  25761. const sin = Math.sin( phi );
  25762. const cos = Math.cos( phi );
  25763. for ( let j = 0; j <= ( points.length - 1 ); j ++ ) {
  25764. // vertex
  25765. vertex.x = points[ j ].x * sin;
  25766. vertex.y = points[ j ].y;
  25767. vertex.z = points[ j ].x * cos;
  25768. vertices.push( vertex.x, vertex.y, vertex.z );
  25769. // uv
  25770. uv.x = i / segments;
  25771. uv.y = j / ( points.length - 1 );
  25772. uvs.push( uv.x, uv.y );
  25773. // normal
  25774. const x = initNormals[ 3 * j + 0 ] * sin;
  25775. const y = initNormals[ 3 * j + 1 ];
  25776. const z = initNormals[ 3 * j + 0 ] * cos;
  25777. normals.push( x, y, z );
  25778. }
  25779. }
  25780. // indices
  25781. for ( let i = 0; i < segments; i ++ ) {
  25782. for ( let j = 0; j < ( points.length - 1 ); j ++ ) {
  25783. const base = j + i * points.length;
  25784. const a = base;
  25785. const b = base + points.length;
  25786. const c = base + points.length + 1;
  25787. const d = base + 1;
  25788. // faces
  25789. indices.push( a, b, d );
  25790. indices.push( c, d, b );
  25791. }
  25792. }
  25793. // build geometry
  25794. this.setIndex( indices );
  25795. this.setAttribute( 'position', new Float32BufferAttribute( vertices, 3 ) );
  25796. this.setAttribute( 'uv', new Float32BufferAttribute( uvs, 2 ) );
  25797. this.setAttribute( 'normal', new Float32BufferAttribute( normals, 3 ) );
  25798. }
  25799. copy( source ) {
  25800. super.copy( source );
  25801. this.parameters = Object.assign( {}, source.parameters );
  25802. return this;
  25803. }
  25804. /**
  25805. * Factory method for creating an instance of this class from the given
  25806. * JSON object.
  25807. *
  25808. * @param {Object} data - A JSON object representing the serialized geometry.
  25809. * @return {LatheGeometry} A new instance.
  25810. */
  25811. static fromJSON( data ) {
  25812. return new LatheGeometry( data.points, data.segments, data.phiStart, data.phiLength );
  25813. }
  25814. }
  25815. /**
  25816. * A geometry class for representing an octahedron.
  25817. *
  25818. * ```js
  25819. * const geometry = new THREE.OctahedronGeometry();
  25820. * const material = new THREE.MeshBasicMaterial( { color: 0xffff00 } );
  25821. * const octahedron = new THREE.Mesh( geometry, material );
  25822. * scene.add( octahedron );
  25823. * ```
  25824. *
  25825. * @augments PolyhedronGeometry
  25826. * @demo scenes/geometry-browser.html#OctahedronGeometry
  25827. */
  25828. class OctahedronGeometry extends PolyhedronGeometry {
  25829. /**
  25830. * Constructs a new octahedron geometry.
  25831. *
  25832. * @param {number} [radius=1] - Radius of the octahedron.
  25833. * @param {number} [detail=0] - Setting this to a value greater than `0` adds vertices making it no longer a octahedron.
  25834. */
  25835. constructor( radius = 1, detail = 0 ) {
  25836. const vertices = [
  25837. 1, 0, 0, -1, 0, 0, 0, 1, 0,
  25838. 0, -1, 0, 0, 0, 1, 0, 0, -1
  25839. ];
  25840. const indices = [
  25841. 0, 2, 4, 0, 4, 3, 0, 3, 5,
  25842. 0, 5, 2, 1, 2, 5, 1, 5, 3,
  25843. 1, 3, 4, 1, 4, 2
  25844. ];
  25845. super( vertices, indices, radius, detail );
  25846. this.type = 'OctahedronGeometry';
  25847. /**
  25848. * Holds the constructor parameters that have been
  25849. * used to generate the geometry. Any modification
  25850. * after instantiation does not change the geometry.
  25851. *
  25852. * @type {Object}
  25853. */
  25854. this.parameters = {
  25855. radius: radius,
  25856. detail: detail
  25857. };
  25858. }
  25859. /**
  25860. * Factory method for creating an instance of this class from the given
  25861. * JSON object.
  25862. *
  25863. * @param {Object} data - A JSON object representing the serialized geometry.
  25864. * @return {OctahedronGeometry} A new instance.
  25865. */
  25866. static fromJSON( data ) {
  25867. return new OctahedronGeometry( data.radius, data.detail );
  25868. }
  25869. }
  25870. /**
  25871. * A geometry class for representing a plane.
  25872. *
  25873. * ```js
  25874. * const geometry = new THREE.PlaneGeometry( 1, 1 );
  25875. * const material = new THREE.MeshBasicMaterial( { color: 0xffff00, side: THREE.DoubleSide } );
  25876. * const plane = new THREE.Mesh( geometry, material );
  25877. * scene.add( plane );
  25878. * ```
  25879. *
  25880. * @augments BufferGeometry
  25881. * @demo scenes/geometry-browser.html#PlaneGeometry
  25882. */
  25883. class PlaneGeometry extends BufferGeometry {
  25884. /**
  25885. * Constructs a new plane geometry.
  25886. *
  25887. * @param {number} [width=1] - The width along the X axis.
  25888. * @param {number} [height=1] - The height along the Y axis
  25889. * @param {number} [widthSegments=1] - The number of segments along the X axis.
  25890. * @param {number} [heightSegments=1] - The number of segments along the Y axis.
  25891. */
  25892. constructor( width = 1, height = 1, widthSegments = 1, heightSegments = 1 ) {
  25893. super();
  25894. this.type = 'PlaneGeometry';
  25895. /**
  25896. * Holds the constructor parameters that have been
  25897. * used to generate the geometry. Any modification
  25898. * after instantiation does not change the geometry.
  25899. *
  25900. * @type {Object}
  25901. */
  25902. this.parameters = {
  25903. width: width,
  25904. height: height,
  25905. widthSegments: widthSegments,
  25906. heightSegments: heightSegments
  25907. };
  25908. const width_half = width / 2;
  25909. const height_half = height / 2;
  25910. const gridX = Math.floor( widthSegments );
  25911. const gridY = Math.floor( heightSegments );
  25912. const gridX1 = gridX + 1;
  25913. const gridY1 = gridY + 1;
  25914. const segment_width = width / gridX;
  25915. const segment_height = height / gridY;
  25916. //
  25917. const indices = [];
  25918. const vertices = [];
  25919. const normals = [];
  25920. const uvs = [];
  25921. for ( let iy = 0; iy < gridY1; iy ++ ) {
  25922. const y = iy * segment_height - height_half;
  25923. for ( let ix = 0; ix < gridX1; ix ++ ) {
  25924. const x = ix * segment_width - width_half;
  25925. vertices.push( x, - y, 0 );
  25926. normals.push( 0, 0, 1 );
  25927. uvs.push( ix / gridX );
  25928. uvs.push( 1 - ( iy / gridY ) );
  25929. }
  25930. }
  25931. for ( let iy = 0; iy < gridY; iy ++ ) {
  25932. for ( let ix = 0; ix < gridX; ix ++ ) {
  25933. const a = ix + gridX1 * iy;
  25934. const b = ix + gridX1 * ( iy + 1 );
  25935. const c = ( ix + 1 ) + gridX1 * ( iy + 1 );
  25936. const d = ( ix + 1 ) + gridX1 * iy;
  25937. indices.push( a, b, d );
  25938. indices.push( b, c, d );
  25939. }
  25940. }
  25941. this.setIndex( indices );
  25942. this.setAttribute( 'position', new Float32BufferAttribute( vertices, 3 ) );
  25943. this.setAttribute( 'normal', new Float32BufferAttribute( normals, 3 ) );
  25944. this.setAttribute( 'uv', new Float32BufferAttribute( uvs, 2 ) );
  25945. }
  25946. copy( source ) {
  25947. super.copy( source );
  25948. this.parameters = Object.assign( {}, source.parameters );
  25949. return this;
  25950. }
  25951. /**
  25952. * Factory method for creating an instance of this class from the given
  25953. * JSON object.
  25954. *
  25955. * @param {Object} data - A JSON object representing the serialized geometry.
  25956. * @return {PlaneGeometry} A new instance.
  25957. */
  25958. static fromJSON( data ) {
  25959. return new PlaneGeometry( data.width, data.height, data.widthSegments, data.heightSegments );
  25960. }
  25961. }
  25962. /**
  25963. * A class for generating a two-dimensional ring geometry.
  25964. *
  25965. * ```js
  25966. * const geometry = new THREE.RingGeometry( 1, 5, 32 );
  25967. * const material = new THREE.MeshBasicMaterial( { color: 0xffff00, side: THREE.DoubleSide } );
  25968. * const mesh = new THREE.Mesh( geometry, material );
  25969. * scene.add( mesh );
  25970. * ```
  25971. *
  25972. * @augments BufferGeometry
  25973. * @demo scenes/geometry-browser.html#RingGeometry
  25974. */
  25975. class RingGeometry extends BufferGeometry {
  25976. /**
  25977. * Constructs a new ring geometry.
  25978. *
  25979. * @param {number} [innerRadius=0.5] - The inner radius of the ring.
  25980. * @param {number} [outerRadius=1] - The outer radius of the ring.
  25981. * @param {number} [thetaSegments=32] - Number of segments. A higher number means the ring will be more round. Minimum is `3`.
  25982. * @param {number} [phiSegments=1] - Number of segments per ring segment. Minimum is `1`.
  25983. * @param {number} [thetaStart=0] - Starting angle in radians.
  25984. * @param {number} [thetaLength=Math.PI*2] - Central angle in radians.
  25985. */
  25986. constructor( innerRadius = 0.5, outerRadius = 1, thetaSegments = 32, phiSegments = 1, thetaStart = 0, thetaLength = Math.PI * 2 ) {
  25987. super();
  25988. this.type = 'RingGeometry';
  25989. /**
  25990. * Holds the constructor parameters that have been
  25991. * used to generate the geometry. Any modification
  25992. * after instantiation does not change the geometry.
  25993. *
  25994. * @type {Object}
  25995. */
  25996. this.parameters = {
  25997. innerRadius: innerRadius,
  25998. outerRadius: outerRadius,
  25999. thetaSegments: thetaSegments,
  26000. phiSegments: phiSegments,
  26001. thetaStart: thetaStart,
  26002. thetaLength: thetaLength
  26003. };
  26004. thetaSegments = Math.max( 3, thetaSegments );
  26005. phiSegments = Math.max( 1, phiSegments );
  26006. // buffers
  26007. const indices = [];
  26008. const vertices = [];
  26009. const normals = [];
  26010. const uvs = [];
  26011. // some helper variables
  26012. let radius = innerRadius;
  26013. const radiusStep = ( ( outerRadius - innerRadius ) / phiSegments );
  26014. const vertex = new Vector3();
  26015. const uv = new Vector2();
  26016. // generate vertices, normals and uvs
  26017. for ( let j = 0; j <= phiSegments; j ++ ) {
  26018. for ( let i = 0; i <= thetaSegments; i ++ ) {
  26019. // values are generate from the inside of the ring to the outside
  26020. const segment = thetaStart + i / thetaSegments * thetaLength;
  26021. // vertex
  26022. vertex.x = radius * Math.cos( segment );
  26023. vertex.y = radius * Math.sin( segment );
  26024. vertices.push( vertex.x, vertex.y, vertex.z );
  26025. // normal
  26026. normals.push( 0, 0, 1 );
  26027. // uv
  26028. uv.x = ( vertex.x / outerRadius + 1 ) / 2;
  26029. uv.y = ( vertex.y / outerRadius + 1 ) / 2;
  26030. uvs.push( uv.x, uv.y );
  26031. }
  26032. // increase the radius for next row of vertices
  26033. radius += radiusStep;
  26034. }
  26035. // indices
  26036. for ( let j = 0; j < phiSegments; j ++ ) {
  26037. const thetaSegmentLevel = j * ( thetaSegments + 1 );
  26038. for ( let i = 0; i < thetaSegments; i ++ ) {
  26039. const segment = i + thetaSegmentLevel;
  26040. const a = segment;
  26041. const b = segment + thetaSegments + 1;
  26042. const c = segment + thetaSegments + 2;
  26043. const d = segment + 1;
  26044. // faces
  26045. indices.push( a, b, d );
  26046. indices.push( b, c, d );
  26047. }
  26048. }
  26049. // build geometry
  26050. this.setIndex( indices );
  26051. this.setAttribute( 'position', new Float32BufferAttribute( vertices, 3 ) );
  26052. this.setAttribute( 'normal', new Float32BufferAttribute( normals, 3 ) );
  26053. this.setAttribute( 'uv', new Float32BufferAttribute( uvs, 2 ) );
  26054. }
  26055. copy( source ) {
  26056. super.copy( source );
  26057. this.parameters = Object.assign( {}, source.parameters );
  26058. return this;
  26059. }
  26060. /**
  26061. * Factory method for creating an instance of this class from the given
  26062. * JSON object.
  26063. *
  26064. * @param {Object} data - A JSON object representing the serialized geometry.
  26065. * @return {RingGeometry} A new instance.
  26066. */
  26067. static fromJSON( data ) {
  26068. return new RingGeometry( data.innerRadius, data.outerRadius, data.thetaSegments, data.phiSegments, data.thetaStart, data.thetaLength );
  26069. }
  26070. }
  26071. /**
  26072. * Creates an one-sided polygonal geometry from one or more path shapes.
  26073. *
  26074. * ```js
  26075. * const arcShape = new THREE.Shape()
  26076. * .moveTo( 5, 1 )
  26077. * .absarc( 1, 1, 4, 0, Math.PI * 2, false );
  26078. *
  26079. * const geometry = new THREE.ShapeGeometry( arcShape );
  26080. * const material = new THREE.MeshBasicMaterial( { color: 0x00ff00, side: THREE.DoubleSide } );
  26081. * const mesh = new THREE.Mesh( geometry, material ) ;
  26082. * scene.add( mesh );
  26083. * ```
  26084. *
  26085. * @augments BufferGeometry
  26086. * @demo scenes/geometry-browser.html#ShapeGeometry
  26087. */
  26088. class ShapeGeometry extends BufferGeometry {
  26089. /**
  26090. * Constructs a new shape geometry.
  26091. *
  26092. * @param {Shape|Array<Shape>} [shapes] - A shape or an array of shapes.
  26093. * @param {number} [curveSegments=12] - Number of segments per shape.
  26094. */
  26095. constructor( shapes = new Shape( [ new Vector2( 0, 0.5 ), new Vector2( -0.5, -0.5 ), new Vector2( 0.5, -0.5 ) ] ), curveSegments = 12 ) {
  26096. super();
  26097. this.type = 'ShapeGeometry';
  26098. /**
  26099. * Holds the constructor parameters that have been
  26100. * used to generate the geometry. Any modification
  26101. * after instantiation does not change the geometry.
  26102. *
  26103. * @type {Object}
  26104. */
  26105. this.parameters = {
  26106. shapes: shapes,
  26107. curveSegments: curveSegments
  26108. };
  26109. // buffers
  26110. const indices = [];
  26111. const vertices = [];
  26112. const normals = [];
  26113. const uvs = [];
  26114. // helper variables
  26115. let groupStart = 0;
  26116. let groupCount = 0;
  26117. // allow single and array values for "shapes" parameter
  26118. if ( Array.isArray( shapes ) === false ) {
  26119. addShape( shapes );
  26120. } else {
  26121. for ( let i = 0; i < shapes.length; i ++ ) {
  26122. addShape( shapes[ i ] );
  26123. this.addGroup( groupStart, groupCount, i ); // enables MultiMaterial support
  26124. groupStart += groupCount;
  26125. groupCount = 0;
  26126. }
  26127. }
  26128. // build geometry
  26129. this.setIndex( indices );
  26130. this.setAttribute( 'position', new Float32BufferAttribute( vertices, 3 ) );
  26131. this.setAttribute( 'normal', new Float32BufferAttribute( normals, 3 ) );
  26132. this.setAttribute( 'uv', new Float32BufferAttribute( uvs, 2 ) );
  26133. // helper functions
  26134. function addShape( shape ) {
  26135. const indexOffset = vertices.length / 3;
  26136. const points = shape.extractPoints( curveSegments );
  26137. let shapeVertices = points.shape;
  26138. const shapeHoles = points.holes;
  26139. // check direction of vertices
  26140. if ( ShapeUtils.isClockWise( shapeVertices ) === false ) {
  26141. shapeVertices = shapeVertices.reverse();
  26142. }
  26143. for ( let i = 0, l = shapeHoles.length; i < l; i ++ ) {
  26144. const shapeHole = shapeHoles[ i ];
  26145. if ( ShapeUtils.isClockWise( shapeHole ) === true ) {
  26146. shapeHoles[ i ] = shapeHole.reverse();
  26147. }
  26148. }
  26149. const faces = ShapeUtils.triangulateShape( shapeVertices, shapeHoles );
  26150. // join vertices of inner and outer paths to a single array
  26151. for ( let i = 0, l = shapeHoles.length; i < l; i ++ ) {
  26152. const shapeHole = shapeHoles[ i ];
  26153. shapeVertices = shapeVertices.concat( shapeHole );
  26154. }
  26155. // vertices, normals, uvs
  26156. for ( let i = 0, l = shapeVertices.length; i < l; i ++ ) {
  26157. const vertex = shapeVertices[ i ];
  26158. vertices.push( vertex.x, vertex.y, 0 );
  26159. normals.push( 0, 0, 1 );
  26160. uvs.push( vertex.x, vertex.y ); // world uvs
  26161. }
  26162. // indices
  26163. for ( let i = 0, l = faces.length; i < l; i ++ ) {
  26164. const face = faces[ i ];
  26165. const a = face[ 0 ] + indexOffset;
  26166. const b = face[ 1 ] + indexOffset;
  26167. const c = face[ 2 ] + indexOffset;
  26168. indices.push( a, b, c );
  26169. groupCount += 3;
  26170. }
  26171. }
  26172. }
  26173. copy( source ) {
  26174. super.copy( source );
  26175. this.parameters = Object.assign( {}, source.parameters );
  26176. return this;
  26177. }
  26178. toJSON() {
  26179. const data = super.toJSON();
  26180. const shapes = this.parameters.shapes;
  26181. return toJSON( shapes, data );
  26182. }
  26183. /**
  26184. * Factory method for creating an instance of this class from the given
  26185. * JSON object.
  26186. *
  26187. * @param {Object} data - A JSON object representing the serialized geometry.
  26188. * @param {Array<Shape>} shapes - An array of shapes.
  26189. * @return {ShapeGeometry} A new instance.
  26190. */
  26191. static fromJSON( data, shapes ) {
  26192. const geometryShapes = [];
  26193. for ( let j = 0, jl = data.shapes.length; j < jl; j ++ ) {
  26194. const shape = shapes[ data.shapes[ j ] ];
  26195. geometryShapes.push( shape );
  26196. }
  26197. return new ShapeGeometry( geometryShapes, data.curveSegments );
  26198. }
  26199. }
  26200. function toJSON( shapes, data ) {
  26201. data.shapes = [];
  26202. if ( Array.isArray( shapes ) ) {
  26203. for ( let i = 0, l = shapes.length; i < l; i ++ ) {
  26204. const shape = shapes[ i ];
  26205. data.shapes.push( shape.uuid );
  26206. }
  26207. } else {
  26208. data.shapes.push( shapes.uuid );
  26209. }
  26210. return data;
  26211. }
  26212. /**
  26213. * A class for generating a sphere geometry.
  26214. *
  26215. * ```js
  26216. * const geometry = new THREE.SphereGeometry( 15, 32, 16 );
  26217. * const material = new THREE.MeshBasicMaterial( { color: 0xffff00 } );
  26218. * const sphere = new THREE.Mesh( geometry, material );
  26219. * scene.add( sphere );
  26220. * ```
  26221. *
  26222. * @augments BufferGeometry
  26223. * @demo scenes/geometry-browser.html#SphereGeometry
  26224. */
  26225. class SphereGeometry extends BufferGeometry {
  26226. /**
  26227. * Constructs a new sphere geometry.
  26228. *
  26229. * @param {number} [radius=1] - The sphere radius.
  26230. * @param {number} [widthSegments=32] - The number of horizontal segments. Minimum value is `3`.
  26231. * @param {number} [heightSegments=16] - The number of vertical segments. Minimum value is `2`.
  26232. * @param {number} [phiStart=0] - The horizontal starting angle in radians.
  26233. * @param {number} [phiLength=Math.PI*2] - The horizontal sweep angle size.
  26234. * @param {number} [thetaStart=0] - The vertical starting angle in radians.
  26235. * @param {number} [thetaLength=Math.PI] - The vertical sweep angle size.
  26236. */
  26237. constructor( radius = 1, widthSegments = 32, heightSegments = 16, phiStart = 0, phiLength = Math.PI * 2, thetaStart = 0, thetaLength = Math.PI ) {
  26238. super();
  26239. this.type = 'SphereGeometry';
  26240. /**
  26241. * Holds the constructor parameters that have been
  26242. * used to generate the geometry. Any modification
  26243. * after instantiation does not change the geometry.
  26244. *
  26245. * @type {Object}
  26246. */
  26247. this.parameters = {
  26248. radius: radius,
  26249. widthSegments: widthSegments,
  26250. heightSegments: heightSegments,
  26251. phiStart: phiStart,
  26252. phiLength: phiLength,
  26253. thetaStart: thetaStart,
  26254. thetaLength: thetaLength
  26255. };
  26256. widthSegments = Math.max( 3, Math.floor( widthSegments ) );
  26257. heightSegments = Math.max( 2, Math.floor( heightSegments ) );
  26258. const thetaEnd = Math.min( thetaStart + thetaLength, Math.PI );
  26259. let index = 0;
  26260. const grid = [];
  26261. const vertex = new Vector3();
  26262. const normal = new Vector3();
  26263. // buffers
  26264. const indices = [];
  26265. const vertices = [];
  26266. const normals = [];
  26267. const uvs = [];
  26268. // generate vertices, normals and uvs
  26269. for ( let iy = 0; iy <= heightSegments; iy ++ ) {
  26270. const verticesRow = [];
  26271. const v = iy / heightSegments;
  26272. // special case for the poles
  26273. let uOffset = 0;
  26274. if ( iy === 0 && thetaStart === 0 ) {
  26275. uOffset = 0.5 / widthSegments;
  26276. } else if ( iy === heightSegments && thetaEnd === Math.PI ) {
  26277. uOffset = -0.5 / widthSegments;
  26278. }
  26279. for ( let ix = 0; ix <= widthSegments; ix ++ ) {
  26280. const u = ix / widthSegments;
  26281. // vertex
  26282. vertex.x = - radius * Math.cos( phiStart + u * phiLength ) * Math.sin( thetaStart + v * thetaLength );
  26283. vertex.y = radius * Math.cos( thetaStart + v * thetaLength );
  26284. vertex.z = radius * Math.sin( phiStart + u * phiLength ) * Math.sin( thetaStart + v * thetaLength );
  26285. vertices.push( vertex.x, vertex.y, vertex.z );
  26286. // normal
  26287. normal.copy( vertex ).normalize();
  26288. normals.push( normal.x, normal.y, normal.z );
  26289. // uv
  26290. uvs.push( u + uOffset, 1 - v );
  26291. verticesRow.push( index ++ );
  26292. }
  26293. grid.push( verticesRow );
  26294. }
  26295. // indices
  26296. for ( let iy = 0; iy < heightSegments; iy ++ ) {
  26297. for ( let ix = 0; ix < widthSegments; ix ++ ) {
  26298. const a = grid[ iy ][ ix + 1 ];
  26299. const b = grid[ iy ][ ix ];
  26300. const c = grid[ iy + 1 ][ ix ];
  26301. const d = grid[ iy + 1 ][ ix + 1 ];
  26302. if ( iy !== 0 || thetaStart > 0 ) indices.push( a, b, d );
  26303. if ( iy !== heightSegments - 1 || thetaEnd < Math.PI ) indices.push( b, c, d );
  26304. }
  26305. }
  26306. // build geometry
  26307. this.setIndex( indices );
  26308. this.setAttribute( 'position', new Float32BufferAttribute( vertices, 3 ) );
  26309. this.setAttribute( 'normal', new Float32BufferAttribute( normals, 3 ) );
  26310. this.setAttribute( 'uv', new Float32BufferAttribute( uvs, 2 ) );
  26311. }
  26312. copy( source ) {
  26313. super.copy( source );
  26314. this.parameters = Object.assign( {}, source.parameters );
  26315. return this;
  26316. }
  26317. /**
  26318. * Factory method for creating an instance of this class from the given
  26319. * JSON object.
  26320. *
  26321. * @param {Object} data - A JSON object representing the serialized geometry.
  26322. * @return {SphereGeometry} A new instance.
  26323. */
  26324. static fromJSON( data ) {
  26325. return new SphereGeometry( data.radius, data.widthSegments, data.heightSegments, data.phiStart, data.phiLength, data.thetaStart, data.thetaLength );
  26326. }
  26327. }
  26328. /**
  26329. * A geometry class for representing an tetrahedron.
  26330. *
  26331. * ```js
  26332. * const geometry = new THREE.TetrahedronGeometry();
  26333. * const material = new THREE.MeshBasicMaterial( { color: 0xffff00 } );
  26334. * const tetrahedron = new THREE.Mesh( geometry, material );
  26335. * scene.add( tetrahedron );
  26336. * ```
  26337. *
  26338. * @augments PolyhedronGeometry
  26339. * @demo scenes/geometry-browser.html#TetrahedronGeometry
  26340. */
  26341. class TetrahedronGeometry extends PolyhedronGeometry {
  26342. /**
  26343. * Constructs a new tetrahedron geometry.
  26344. *
  26345. * @param {number} [radius=1] - Radius of the tetrahedron.
  26346. * @param {number} [detail=0] - Setting this to a value greater than `0` adds vertices making it no longer a tetrahedron.
  26347. */
  26348. constructor( radius = 1, detail = 0 ) {
  26349. const vertices = [
  26350. 1, 1, 1, -1, -1, 1, -1, 1, -1, 1, -1, -1
  26351. ];
  26352. const indices = [
  26353. 2, 1, 0, 0, 3, 2, 1, 3, 0, 2, 3, 1
  26354. ];
  26355. super( vertices, indices, radius, detail );
  26356. this.type = 'TetrahedronGeometry';
  26357. /**
  26358. * Holds the constructor parameters that have been
  26359. * used to generate the geometry. Any modification
  26360. * after instantiation does not change the geometry.
  26361. *
  26362. * @type {Object}
  26363. */
  26364. this.parameters = {
  26365. radius: radius,
  26366. detail: detail
  26367. };
  26368. }
  26369. /**
  26370. * Factory method for creating an instance of this class from the given
  26371. * JSON object.
  26372. *
  26373. * @param {Object} data - A JSON object representing the serialized geometry.
  26374. * @return {TetrahedronGeometry} A new instance.
  26375. */
  26376. static fromJSON( data ) {
  26377. return new TetrahedronGeometry( data.radius, data.detail );
  26378. }
  26379. }
  26380. /**
  26381. * A geometry class for representing an torus.
  26382. *
  26383. * ```js
  26384. * const geometry = new THREE.TorusGeometry( 10, 3, 16, 100 );
  26385. * const material = new THREE.MeshBasicMaterial( { color: 0xffff00 } );
  26386. * const torus = new THREE.Mesh( geometry, material );
  26387. * scene.add( torus );
  26388. * ```
  26389. *
  26390. * @augments BufferGeometry
  26391. * @demo scenes/geometry-browser.html#TorusGeometry
  26392. */
  26393. class TorusGeometry extends BufferGeometry {
  26394. /**
  26395. * Constructs a new torus geometry.
  26396. *
  26397. * @param {number} [radius=1] - Radius of the torus, from the center of the torus to the center of the tube.
  26398. * @param {number} [tube=0.4] - Radius of the tube. Must be smaller than `radius`.
  26399. * @param {number} [radialSegments=12] - The number of radial segments.
  26400. * @param {number} [tubularSegments=48] - The number of tubular segments.
  26401. * @param {number} [arc=Math.PI*2] - Central angle in radians.
  26402. * @param {number} [thetaStart=0] - Start of the tubular sweep in radians.
  26403. * @param {number} [thetaLength=Math.PI*2] - Length of the tubular sweep in radians.
  26404. */
  26405. constructor( radius = 1, tube = 0.4, radialSegments = 12, tubularSegments = 48, arc = Math.PI * 2, thetaStart = 0, thetaLength = Math.PI * 2 ) {
  26406. super();
  26407. this.type = 'TorusGeometry';
  26408. /**
  26409. * Holds the constructor parameters that have been
  26410. * used to generate the geometry. Any modification
  26411. * after instantiation does not change the geometry.
  26412. *
  26413. * @type {Object}
  26414. */
  26415. this.parameters = {
  26416. radius: radius,
  26417. tube: tube,
  26418. radialSegments: radialSegments,
  26419. tubularSegments: tubularSegments,
  26420. arc: arc,
  26421. thetaStart: thetaStart,
  26422. thetaLength: thetaLength,
  26423. };
  26424. radialSegments = Math.floor( radialSegments );
  26425. tubularSegments = Math.floor( tubularSegments );
  26426. // buffers
  26427. const indices = [];
  26428. const vertices = [];
  26429. const normals = [];
  26430. const uvs = [];
  26431. // helper variables
  26432. const center = new Vector3();
  26433. const vertex = new Vector3();
  26434. const normal = new Vector3();
  26435. // generate vertices, normals and uvs
  26436. for ( let j = 0; j <= radialSegments; j ++ ) {
  26437. const v = thetaStart + ( j / radialSegments ) * thetaLength;
  26438. for ( let i = 0; i <= tubularSegments; i ++ ) {
  26439. const u = i / tubularSegments * arc;
  26440. // vertex
  26441. vertex.x = ( radius + tube * Math.cos( v ) ) * Math.cos( u );
  26442. vertex.y = ( radius + tube * Math.cos( v ) ) * Math.sin( u );
  26443. vertex.z = tube * Math.sin( v );
  26444. vertices.push( vertex.x, vertex.y, vertex.z );
  26445. // normal
  26446. center.x = radius * Math.cos( u );
  26447. center.y = radius * Math.sin( u );
  26448. normal.subVectors( vertex, center ).normalize();
  26449. normals.push( normal.x, normal.y, normal.z );
  26450. // uv
  26451. uvs.push( i / tubularSegments );
  26452. uvs.push( j / radialSegments );
  26453. }
  26454. }
  26455. // generate indices
  26456. for ( let j = 1; j <= radialSegments; j ++ ) {
  26457. for ( let i = 1; i <= tubularSegments; i ++ ) {
  26458. // indices
  26459. const a = ( tubularSegments + 1 ) * j + i - 1;
  26460. const b = ( tubularSegments + 1 ) * ( j - 1 ) + i - 1;
  26461. const c = ( tubularSegments + 1 ) * ( j - 1 ) + i;
  26462. const d = ( tubularSegments + 1 ) * j + i;
  26463. // faces
  26464. indices.push( a, b, d );
  26465. indices.push( b, c, d );
  26466. }
  26467. }
  26468. // build geometry
  26469. this.setIndex( indices );
  26470. this.setAttribute( 'position', new Float32BufferAttribute( vertices, 3 ) );
  26471. this.setAttribute( 'normal', new Float32BufferAttribute( normals, 3 ) );
  26472. this.setAttribute( 'uv', new Float32BufferAttribute( uvs, 2 ) );
  26473. }
  26474. copy( source ) {
  26475. super.copy( source );
  26476. this.parameters = Object.assign( {}, source.parameters );
  26477. return this;
  26478. }
  26479. /**
  26480. * Factory method for creating an instance of this class from the given
  26481. * JSON object.
  26482. *
  26483. * @param {Object} data - A JSON object representing the serialized geometry.
  26484. * @return {TorusGeometry} A new instance.
  26485. */
  26486. static fromJSON( data ) {
  26487. return new TorusGeometry( data.radius, data.tube, data.radialSegments, data.tubularSegments, data.arc );
  26488. }
  26489. }
  26490. /**
  26491. * Creates a torus knot, the particular shape of which is defined by a pair
  26492. * of coprime integers, p and q. If p and q are not coprime, the result will
  26493. * be a torus link.
  26494. *
  26495. * ```js
  26496. * const geometry = new THREE.TorusKnotGeometry( 10, 3, 100, 16 );
  26497. * const material = new THREE.MeshBasicMaterial( { color: 0xffff00 } );
  26498. * const torusKnot = new THREE.Mesh( geometry, material );
  26499. * scene.add( torusKnot );
  26500. * ```
  26501. *
  26502. * @augments BufferGeometry
  26503. * @demo scenes/geometry-browser.html#TorusKnotGeometry
  26504. */
  26505. class TorusKnotGeometry extends BufferGeometry {
  26506. /**
  26507. * Constructs a new torus knot geometry.
  26508. *
  26509. * @param {number} [radius=1] - Radius of the torus knot.
  26510. * @param {number} [tube=0.4] - Radius of the tube.
  26511. * @param {number} [tubularSegments=64] - The number of tubular segments.
  26512. * @param {number} [radialSegments=8] - The number of radial segments.
  26513. * @param {number} [p=2] - This value determines, how many times the geometry winds around its axis of rotational symmetry.
  26514. * @param {number} [q=3] - This value determines, how many times the geometry winds around a circle in the interior of the torus.
  26515. */
  26516. constructor( radius = 1, tube = 0.4, tubularSegments = 64, radialSegments = 8, p = 2, q = 3 ) {
  26517. super();
  26518. this.type = 'TorusKnotGeometry';
  26519. /**
  26520. * Holds the constructor parameters that have been
  26521. * used to generate the geometry. Any modification
  26522. * after instantiation does not change the geometry.
  26523. *
  26524. * @type {Object}
  26525. */
  26526. this.parameters = {
  26527. radius: radius,
  26528. tube: tube,
  26529. tubularSegments: tubularSegments,
  26530. radialSegments: radialSegments,
  26531. p: p,
  26532. q: q
  26533. };
  26534. tubularSegments = Math.floor( tubularSegments );
  26535. radialSegments = Math.floor( radialSegments );
  26536. // buffers
  26537. const indices = [];
  26538. const vertices = [];
  26539. const normals = [];
  26540. const uvs = [];
  26541. // helper variables
  26542. const vertex = new Vector3();
  26543. const normal = new Vector3();
  26544. const P1 = new Vector3();
  26545. const P2 = new Vector3();
  26546. const B = new Vector3();
  26547. const T = new Vector3();
  26548. const N = new Vector3();
  26549. // generate vertices, normals and uvs
  26550. for ( let i = 0; i <= tubularSegments; ++ i ) {
  26551. // the radian "u" is used to calculate the position on the torus curve of the current tubular segment
  26552. const u = i / tubularSegments * p * Math.PI * 2;
  26553. // now we calculate two points. P1 is our current position on the curve, P2 is a little farther ahead.
  26554. // these points are used to create a special "coordinate space", which is necessary to calculate the correct vertex positions
  26555. calculatePositionOnCurve( u, p, q, radius, P1 );
  26556. calculatePositionOnCurve( u + 0.01, p, q, radius, P2 );
  26557. // calculate orthonormal basis
  26558. T.subVectors( P2, P1 );
  26559. N.addVectors( P2, P1 );
  26560. B.crossVectors( T, N );
  26561. N.crossVectors( B, T );
  26562. // normalize B, N. T can be ignored, we don't use it
  26563. B.normalize();
  26564. N.normalize();
  26565. for ( let j = 0; j <= radialSegments; ++ j ) {
  26566. // now calculate the vertices. they are nothing more than an extrusion of the torus curve.
  26567. // because we extrude a shape in the xy-plane, there is no need to calculate a z-value.
  26568. const v = j / radialSegments * Math.PI * 2;
  26569. const cx = - tube * Math.cos( v );
  26570. const cy = tube * Math.sin( v );
  26571. // now calculate the final vertex position.
  26572. // first we orient the extrusion with our basis vectors, then we add it to the current position on the curve
  26573. vertex.x = P1.x + ( cx * N.x + cy * B.x );
  26574. vertex.y = P1.y + ( cx * N.y + cy * B.y );
  26575. vertex.z = P1.z + ( cx * N.z + cy * B.z );
  26576. vertices.push( vertex.x, vertex.y, vertex.z );
  26577. // normal (P1 is always the center/origin of the extrusion, thus we can use it to calculate the normal)
  26578. normal.subVectors( vertex, P1 ).normalize();
  26579. normals.push( normal.x, normal.y, normal.z );
  26580. // uv
  26581. uvs.push( i / tubularSegments );
  26582. uvs.push( j / radialSegments );
  26583. }
  26584. }
  26585. // generate indices
  26586. for ( let j = 1; j <= tubularSegments; j ++ ) {
  26587. for ( let i = 1; i <= radialSegments; i ++ ) {
  26588. // indices
  26589. const a = ( radialSegments + 1 ) * ( j - 1 ) + ( i - 1 );
  26590. const b = ( radialSegments + 1 ) * j + ( i - 1 );
  26591. const c = ( radialSegments + 1 ) * j + i;
  26592. const d = ( radialSegments + 1 ) * ( j - 1 ) + i;
  26593. // faces
  26594. indices.push( a, b, d );
  26595. indices.push( b, c, d );
  26596. }
  26597. }
  26598. // build geometry
  26599. this.setIndex( indices );
  26600. this.setAttribute( 'position', new Float32BufferAttribute( vertices, 3 ) );
  26601. this.setAttribute( 'normal', new Float32BufferAttribute( normals, 3 ) );
  26602. this.setAttribute( 'uv', new Float32BufferAttribute( uvs, 2 ) );
  26603. // this function calculates the current position on the torus curve
  26604. function calculatePositionOnCurve( u, p, q, radius, position ) {
  26605. const cu = Math.cos( u );
  26606. const su = Math.sin( u );
  26607. const quOverP = q / p * u;
  26608. const cs = Math.cos( quOverP );
  26609. position.x = radius * ( 2 + cs ) * 0.5 * cu;
  26610. position.y = radius * ( 2 + cs ) * su * 0.5;
  26611. position.z = radius * Math.sin( quOverP ) * 0.5;
  26612. }
  26613. }
  26614. copy( source ) {
  26615. super.copy( source );
  26616. this.parameters = Object.assign( {}, source.parameters );
  26617. return this;
  26618. }
  26619. /**
  26620. * Factory method for creating an instance of this class from the given
  26621. * JSON object.
  26622. *
  26623. * @param {Object} data - A JSON object representing the serialized geometry.
  26624. * @return {TorusKnotGeometry} A new instance.
  26625. */
  26626. static fromJSON( data ) {
  26627. return new TorusKnotGeometry( data.radius, data.tube, data.tubularSegments, data.radialSegments, data.p, data.q );
  26628. }
  26629. }
  26630. /**
  26631. * Creates a tube that extrudes along a 3D curve.
  26632. *
  26633. * ```js
  26634. * class CustomSinCurve extends THREE.Curve {
  26635. *
  26636. * getPoint( t, optionalTarget = new THREE.Vector3() ) {
  26637. *
  26638. * const tx = t * 3 - 1.5;
  26639. * const ty = Math.sin( 2 * Math.PI * t );
  26640. * const tz = 0;
  26641. *
  26642. * return optionalTarget.set( tx, ty, tz );
  26643. * }
  26644. *
  26645. * }
  26646. *
  26647. * const path = new CustomSinCurve( 10 );
  26648. * const geometry = new THREE.TubeGeometry( path, 20, 2, 8, false );
  26649. * const material = new THREE.MeshBasicMaterial( { color: 0x00ff00 } );
  26650. * const mesh = new THREE.Mesh( geometry, material );
  26651. * scene.add( mesh );
  26652. * ```
  26653. *
  26654. * @augments BufferGeometry
  26655. * @demo scenes/geometry-browser.html#TubeGeometry
  26656. */
  26657. class TubeGeometry extends BufferGeometry {
  26658. /**
  26659. * Constructs a new tube geometry.
  26660. *
  26661. * @param {Curve} [path=QuadraticBezierCurve3] - A 3D curve defining the path of the tube.
  26662. * @param {number} [tubularSegments=64] - The number of segments that make up the tube.
  26663. * @param {number} [radius=1] -The radius of the tube.
  26664. * @param {number} [radialSegments=8] - The number of segments that make up the cross-section.
  26665. * @param {boolean} [closed=false] - Whether the tube is closed or not.
  26666. */
  26667. constructor( path = new QuadraticBezierCurve3( new Vector3( -1, -1, 0 ), new Vector3( -1, 1, 0 ), new Vector3( 1, 1, 0 ) ), tubularSegments = 64, radius = 1, radialSegments = 8, closed = false ) {
  26668. super();
  26669. this.type = 'TubeGeometry';
  26670. /**
  26671. * Holds the constructor parameters that have been
  26672. * used to generate the geometry. Any modification
  26673. * after instantiation does not change the geometry.
  26674. *
  26675. * @type {Object}
  26676. */
  26677. this.parameters = {
  26678. path: path,
  26679. tubularSegments: tubularSegments,
  26680. radius: radius,
  26681. radialSegments: radialSegments,
  26682. closed: closed
  26683. };
  26684. const frames = path.computeFrenetFrames( tubularSegments, closed );
  26685. // expose internals
  26686. this.tangents = frames.tangents;
  26687. this.normals = frames.normals;
  26688. this.binormals = frames.binormals;
  26689. // helper variables
  26690. const vertex = new Vector3();
  26691. const normal = new Vector3();
  26692. const uv = new Vector2();
  26693. let P = new Vector3();
  26694. // buffer
  26695. const vertices = [];
  26696. const normals = [];
  26697. const uvs = [];
  26698. const indices = [];
  26699. // create buffer data
  26700. generateBufferData();
  26701. // build geometry
  26702. this.setIndex( indices );
  26703. this.setAttribute( 'position', new Float32BufferAttribute( vertices, 3 ) );
  26704. this.setAttribute( 'normal', new Float32BufferAttribute( normals, 3 ) );
  26705. this.setAttribute( 'uv', new Float32BufferAttribute( uvs, 2 ) );
  26706. // functions
  26707. function generateBufferData() {
  26708. for ( let i = 0; i < tubularSegments; i ++ ) {
  26709. generateSegment( i );
  26710. }
  26711. // if the geometry is not closed, generate the last row of vertices and normals
  26712. // at the regular position on the given path
  26713. //
  26714. // if the geometry is closed, duplicate the first row of vertices and normals (uvs will differ)
  26715. generateSegment( ( closed === false ) ? tubularSegments : 0 );
  26716. // uvs are generated in a separate function.
  26717. // this makes it easy compute correct values for closed geometries
  26718. generateUVs();
  26719. // finally create faces
  26720. generateIndices();
  26721. }
  26722. function generateSegment( i ) {
  26723. // we use getPointAt to sample evenly distributed points from the given path
  26724. P = path.getPointAt( i / tubularSegments, P );
  26725. // retrieve corresponding normal and binormal
  26726. const N = frames.normals[ i ];
  26727. const B = frames.binormals[ i ];
  26728. // generate normals and vertices for the current segment
  26729. for ( let j = 0; j <= radialSegments; j ++ ) {
  26730. const v = j / radialSegments * Math.PI * 2;
  26731. const sin = Math.sin( v );
  26732. const cos = - Math.cos( v );
  26733. // normal
  26734. normal.x = ( cos * N.x + sin * B.x );
  26735. normal.y = ( cos * N.y + sin * B.y );
  26736. normal.z = ( cos * N.z + sin * B.z );
  26737. normal.normalize();
  26738. normals.push( normal.x, normal.y, normal.z );
  26739. // vertex
  26740. vertex.x = P.x + radius * normal.x;
  26741. vertex.y = P.y + radius * normal.y;
  26742. vertex.z = P.z + radius * normal.z;
  26743. vertices.push( vertex.x, vertex.y, vertex.z );
  26744. }
  26745. }
  26746. function generateIndices() {
  26747. for ( let j = 1; j <= tubularSegments; j ++ ) {
  26748. for ( let i = 1; i <= radialSegments; i ++ ) {
  26749. const a = ( radialSegments + 1 ) * ( j - 1 ) + ( i - 1 );
  26750. const b = ( radialSegments + 1 ) * j + ( i - 1 );
  26751. const c = ( radialSegments + 1 ) * j + i;
  26752. const d = ( radialSegments + 1 ) * ( j - 1 ) + i;
  26753. // faces
  26754. indices.push( a, b, d );
  26755. indices.push( b, c, d );
  26756. }
  26757. }
  26758. }
  26759. function generateUVs() {
  26760. for ( let i = 0; i <= tubularSegments; i ++ ) {
  26761. for ( let j = 0; j <= radialSegments; j ++ ) {
  26762. uv.x = i / tubularSegments;
  26763. uv.y = j / radialSegments;
  26764. uvs.push( uv.x, uv.y );
  26765. }
  26766. }
  26767. }
  26768. }
  26769. copy( source ) {
  26770. super.copy( source );
  26771. this.parameters = Object.assign( {}, source.parameters );
  26772. return this;
  26773. }
  26774. toJSON() {
  26775. const data = super.toJSON();
  26776. data.path = this.parameters.path.toJSON();
  26777. return data;
  26778. }
  26779. /**
  26780. * Factory method for creating an instance of this class from the given
  26781. * JSON object.
  26782. *
  26783. * @param {Object} data - A JSON object representing the serialized geometry.
  26784. * @return {TubeGeometry} A new instance.
  26785. */
  26786. static fromJSON( data ) {
  26787. // This only works for built-in curves (e.g. CatmullRomCurve3).
  26788. // User defined curves or instances of CurvePath will not be deserialized.
  26789. return new TubeGeometry(
  26790. new Curves[ data.path.type ]().fromJSON( data.path ),
  26791. data.tubularSegments,
  26792. data.radius,
  26793. data.radialSegments,
  26794. data.closed
  26795. );
  26796. }
  26797. }
  26798. /**
  26799. * Can be used as a helper object to visualize a geometry as a wireframe.
  26800. *
  26801. * ```js
  26802. * const geometry = new THREE.SphereGeometry();
  26803. *
  26804. * const wireframe = new THREE.WireframeGeometry( geometry );
  26805. *
  26806. * const line = new THREE.LineSegments( wireframe );
  26807. * line.material.depthWrite = false;
  26808. * line.material.opacity = 0.25;
  26809. * line.material.transparent = true;
  26810. *
  26811. * scene.add( line );
  26812. * ```
  26813. *
  26814. * Note: It is not yet possible to serialize/deserialize instances of this class.
  26815. *
  26816. * @augments BufferGeometry
  26817. */
  26818. class WireframeGeometry extends BufferGeometry {
  26819. /**
  26820. * Constructs a new wireframe geometry.
  26821. *
  26822. * @param {?BufferGeometry} [geometry=null] - The geometry.
  26823. */
  26824. constructor( geometry = null ) {
  26825. super();
  26826. this.type = 'WireframeGeometry';
  26827. /**
  26828. * Holds the constructor parameters that have been
  26829. * used to generate the geometry. Any modification
  26830. * after instantiation does not change the geometry.
  26831. *
  26832. * @type {Object}
  26833. */
  26834. this.parameters = {
  26835. geometry: geometry
  26836. };
  26837. if ( geometry !== null ) {
  26838. // buffer
  26839. const vertices = [];
  26840. const edges = new Set();
  26841. // helper variables
  26842. const start = new Vector3();
  26843. const end = new Vector3();
  26844. if ( geometry.index !== null ) {
  26845. // indexed BufferGeometry
  26846. const position = geometry.attributes.position;
  26847. const indices = geometry.index;
  26848. let groups = geometry.groups;
  26849. if ( groups.length === 0 ) {
  26850. groups = [ { start: 0, count: indices.count, materialIndex: 0 } ];
  26851. }
  26852. // create a data structure that contains all edges without duplicates
  26853. for ( let o = 0, ol = groups.length; o < ol; ++ o ) {
  26854. const group = groups[ o ];
  26855. const groupStart = group.start;
  26856. const groupCount = group.count;
  26857. for ( let i = groupStart, l = ( groupStart + groupCount ); i < l; i += 3 ) {
  26858. for ( let j = 0; j < 3; j ++ ) {
  26859. const index1 = indices.getX( i + j );
  26860. const index2 = indices.getX( i + ( j + 1 ) % 3 );
  26861. start.fromBufferAttribute( position, index1 );
  26862. end.fromBufferAttribute( position, index2 );
  26863. if ( isUniqueEdge( start, end, edges ) === true ) {
  26864. vertices.push( start.x, start.y, start.z );
  26865. vertices.push( end.x, end.y, end.z );
  26866. }
  26867. }
  26868. }
  26869. }
  26870. } else {
  26871. // non-indexed BufferGeometry
  26872. const position = geometry.attributes.position;
  26873. for ( let i = 0, l = ( position.count / 3 ); i < l; i ++ ) {
  26874. for ( let j = 0; j < 3; j ++ ) {
  26875. // three edges per triangle, an edge is represented as (index1, index2)
  26876. // e.g. the first triangle has the following edges: (0,1),(1,2),(2,0)
  26877. const index1 = 3 * i + j;
  26878. const index2 = 3 * i + ( ( j + 1 ) % 3 );
  26879. start.fromBufferAttribute( position, index1 );
  26880. end.fromBufferAttribute( position, index2 );
  26881. if ( isUniqueEdge( start, end, edges ) === true ) {
  26882. vertices.push( start.x, start.y, start.z );
  26883. vertices.push( end.x, end.y, end.z );
  26884. }
  26885. }
  26886. }
  26887. }
  26888. // build geometry
  26889. this.setAttribute( 'position', new Float32BufferAttribute( vertices, 3 ) );
  26890. }
  26891. }
  26892. copy( source ) {
  26893. super.copy( source );
  26894. this.parameters = Object.assign( {}, source.parameters );
  26895. return this;
  26896. }
  26897. }
  26898. function isUniqueEdge( start, end, edges ) {
  26899. const hash1 = `${start.x},${start.y},${start.z}-${end.x},${end.y},${end.z}`;
  26900. const hash2 = `${end.x},${end.y},${end.z}-${start.x},${start.y},${start.z}`; // coincident edge
  26901. if ( edges.has( hash1 ) === true || edges.has( hash2 ) === true ) {
  26902. return false;
  26903. } else {
  26904. edges.add( hash1 );
  26905. edges.add( hash2 );
  26906. return true;
  26907. }
  26908. }
  26909. var Geometries = /*#__PURE__*/Object.freeze({
  26910. __proto__: null,
  26911. BoxGeometry: BoxGeometry,
  26912. CapsuleGeometry: CapsuleGeometry,
  26913. CircleGeometry: CircleGeometry,
  26914. ConeGeometry: ConeGeometry,
  26915. CylinderGeometry: CylinderGeometry,
  26916. DodecahedronGeometry: DodecahedronGeometry,
  26917. EdgesGeometry: EdgesGeometry,
  26918. ExtrudeGeometry: ExtrudeGeometry,
  26919. IcosahedronGeometry: IcosahedronGeometry,
  26920. LatheGeometry: LatheGeometry,
  26921. OctahedronGeometry: OctahedronGeometry,
  26922. PlaneGeometry: PlaneGeometry,
  26923. PolyhedronGeometry: PolyhedronGeometry,
  26924. RingGeometry: RingGeometry,
  26925. ShapeGeometry: ShapeGeometry,
  26926. SphereGeometry: SphereGeometry,
  26927. TetrahedronGeometry: TetrahedronGeometry,
  26928. TorusGeometry: TorusGeometry,
  26929. TorusKnotGeometry: TorusKnotGeometry,
  26930. TubeGeometry: TubeGeometry,
  26931. WireframeGeometry: WireframeGeometry
  26932. });
  26933. /**
  26934. * This material can receive shadows, but otherwise is completely transparent.
  26935. *
  26936. * ```js
  26937. * const geometry = new THREE.PlaneGeometry( 2000, 2000 );
  26938. * geometry.rotateX( - Math.PI / 2 );
  26939. *
  26940. * const material = new THREE.ShadowMaterial();
  26941. * material.opacity = 0.2;
  26942. *
  26943. * const plane = new THREE.Mesh( geometry, material );
  26944. * plane.position.y = -200;
  26945. * plane.receiveShadow = true;
  26946. * scene.add( plane );
  26947. * ```
  26948. *
  26949. * @augments Material
  26950. */
  26951. class ShadowMaterial extends Material {
  26952. /**
  26953. * Constructs a new shadow material.
  26954. *
  26955. * @param {Object} [parameters] - An object with one or more properties
  26956. * defining the material's appearance. Any property of the material
  26957. * (including any property from inherited materials) can be passed
  26958. * in here. Color values can be passed any type of value accepted
  26959. * by {@link Color#set}.
  26960. */
  26961. constructor( parameters ) {
  26962. super();
  26963. /**
  26964. * This flag can be used for type testing.
  26965. *
  26966. * @type {boolean}
  26967. * @readonly
  26968. * @default true
  26969. */
  26970. this.isShadowMaterial = true;
  26971. this.type = 'ShadowMaterial';
  26972. /**
  26973. * Color of the material.
  26974. *
  26975. * @type {Color}
  26976. * @default (0,0,0)
  26977. */
  26978. this.color = new Color( 0x000000 );
  26979. /**
  26980. * Overwritten since shadow materials are transparent
  26981. * by default.
  26982. *
  26983. * @type {boolean}
  26984. * @default true
  26985. */
  26986. this.transparent = true;
  26987. /**
  26988. * Whether the material is affected by fog or not.
  26989. *
  26990. * @type {boolean}
  26991. * @default true
  26992. */
  26993. this.fog = true;
  26994. this.setValues( parameters );
  26995. }
  26996. copy( source ) {
  26997. super.copy( source );
  26998. this.color.copy( source.color );
  26999. this.fog = source.fog;
  27000. return this;
  27001. }
  27002. }
  27003. /**
  27004. * Provides utility functions for managing uniforms.
  27005. *
  27006. * @module UniformsUtils
  27007. */
  27008. /**
  27009. * Clones the given uniform definitions by performing a deep-copy. That means
  27010. * if the value of a uniform refers to an object like a Vector3 or Texture,
  27011. * the cloned uniform will refer to a new object reference.
  27012. *
  27013. * @param {Object} src - An object representing uniform definitions.
  27014. * @return {Object} The cloned uniforms.
  27015. */
  27016. function cloneUniforms( src ) {
  27017. const dst = {};
  27018. for ( const u in src ) {
  27019. dst[ u ] = {};
  27020. for ( const p in src[ u ] ) {
  27021. const property = src[ u ][ p ];
  27022. if ( property && ( property.isColor ||
  27023. property.isMatrix3 || property.isMatrix4 ||
  27024. property.isVector2 || property.isVector3 || property.isVector4 ||
  27025. property.isTexture || property.isQuaternion ) ) {
  27026. if ( property.isRenderTargetTexture ) {
  27027. warn( 'UniformsUtils: Textures of render targets cannot be cloned via cloneUniforms() or mergeUniforms().' );
  27028. dst[ u ][ p ] = null;
  27029. } else {
  27030. dst[ u ][ p ] = property.clone();
  27031. }
  27032. } else if ( Array.isArray( property ) ) {
  27033. dst[ u ][ p ] = property.slice();
  27034. } else {
  27035. dst[ u ][ p ] = property;
  27036. }
  27037. }
  27038. }
  27039. return dst;
  27040. }
  27041. /**
  27042. * Merges the given uniform definitions into a single object. Since the
  27043. * method internally uses cloneUniforms(), it performs a deep-copy when
  27044. * producing the merged uniform definitions.
  27045. *
  27046. * @param {Array} uniforms - An array of objects containing uniform definitions.
  27047. * @return {Object} The merged uniforms.
  27048. */
  27049. function mergeUniforms( uniforms ) {
  27050. const merged = {};
  27051. for ( let u = 0; u < uniforms.length; u ++ ) {
  27052. const tmp = cloneUniforms( uniforms[ u ] );
  27053. for ( const p in tmp ) {
  27054. merged[ p ] = tmp[ p ];
  27055. }
  27056. }
  27057. return merged;
  27058. }
  27059. function cloneUniformsGroups( src ) {
  27060. const dst = [];
  27061. for ( let u = 0; u < src.length; u ++ ) {
  27062. dst.push( src[ u ].clone() );
  27063. }
  27064. return dst;
  27065. }
  27066. function getUnlitUniformColorSpace( renderer ) {
  27067. const currentRenderTarget = renderer.getRenderTarget();
  27068. if ( currentRenderTarget === null ) {
  27069. // https://github.com/mrdoob/three.js/pull/23937#issuecomment-1111067398
  27070. return renderer.outputColorSpace;
  27071. }
  27072. // https://github.com/mrdoob/three.js/issues/27868
  27073. if ( currentRenderTarget.isXRRenderTarget === true ) {
  27074. return currentRenderTarget.texture.colorSpace;
  27075. }
  27076. return ColorManagement.workingColorSpace;
  27077. }
  27078. // Legacy
  27079. const UniformsUtils = { clone: cloneUniforms, merge: mergeUniforms };
  27080. var default_vertex = "void main() {\n\tgl_Position = projectionMatrix * modelViewMatrix * vec4( position, 1.0 );\n}";
  27081. var default_fragment = "void main() {\n\tgl_FragColor = vec4( 1.0, 0.0, 0.0, 1.0 );\n}";
  27082. /**
  27083. * A material rendered with custom shaders. A shader is a small program written in GLSL.
  27084. * that runs on the GPU. You may want to use a custom shader if you need to implement an
  27085. * effect not included with any of the built-in materials.
  27086. *
  27087. * There are the following notes to bear in mind when using a `ShaderMaterial`:
  27088. *
  27089. * - `ShaderMaterial` can only be used with {@link WebGLRenderer}.
  27090. * - Built in attributes and uniforms are passed to the shaders along with your code. If
  27091. * you don't want that, use {@link RawShaderMaterial} instead.
  27092. * - You can use the directive `#pragma unroll_loop_start` and `#pragma unroll_loop_end`
  27093. * in order to unroll a `for` loop in GLSL by the shader preprocessor. The directive has
  27094. * to be placed right above the loop. The loop formatting has to correspond to a defined standard.
  27095. * - The loop has to be [normalized](https://en.wikipedia.org/wiki/Normalized_loop).
  27096. * - The loop variable has to be *i*.
  27097. * - The value `UNROLLED_LOOP_INDEX` will be replaced with the explicitly
  27098. * value of *i* for the given iteration and can be used in preprocessor
  27099. * statements.
  27100. *
  27101. * ```js
  27102. * const material = new THREE.ShaderMaterial( {
  27103. * uniforms: {
  27104. * time: { value: 1.0 },
  27105. * resolution: { value: new THREE.Vector2() }
  27106. * },
  27107. * vertexShader: document.getElementById( 'vertexShader' ).textContent,
  27108. * fragmentShader: document.getElementById( 'fragmentShader' ).textContent
  27109. * } );
  27110. * ```
  27111. *
  27112. * @augments Material
  27113. */
  27114. class ShaderMaterial extends Material {
  27115. /**
  27116. * Constructs a new shader material.
  27117. *
  27118. * @param {Object} [parameters] - An object with one or more properties
  27119. * defining the material's appearance. Any property of the material
  27120. * (including any property from inherited materials) can be passed
  27121. * in here. Color values can be passed any type of value accepted
  27122. * by {@link Color#set}.
  27123. */
  27124. constructor( parameters ) {
  27125. super();
  27126. /**
  27127. * This flag can be used for type testing.
  27128. *
  27129. * @type {boolean}
  27130. * @readonly
  27131. * @default true
  27132. */
  27133. this.isShaderMaterial = true;
  27134. this.type = 'ShaderMaterial';
  27135. /**
  27136. * Defines custom constants using `#define` directives within the GLSL code
  27137. * for both the vertex shader and the fragment shader; each key/value pair
  27138. * yields another directive.
  27139. * ```js
  27140. * defines: {
  27141. * FOO: 15,
  27142. * BAR: true
  27143. * }
  27144. * ```
  27145. * Yields the lines:
  27146. * ```
  27147. * #define FOO 15
  27148. * #define BAR true
  27149. * ```
  27150. *
  27151. * @type {Object}
  27152. */
  27153. this.defines = {};
  27154. /**
  27155. * An object of the form:
  27156. * ```js
  27157. * {
  27158. * "uniform1": { value: 1.0 },
  27159. * "uniform2": { value: 2 }
  27160. * }
  27161. * ```
  27162. * specifying the uniforms to be passed to the shader code; keys are uniform
  27163. * names, values are definitions of the form
  27164. * ```
  27165. * {
  27166. * value: 1.0
  27167. * }
  27168. * ```
  27169. * where `value` is the value of the uniform. Names must match the name of
  27170. * the uniform, as defined in the GLSL code. Note that uniforms are refreshed
  27171. * on every frame, so updating the value of the uniform will immediately
  27172. * update the value available to the GLSL code.
  27173. *
  27174. * @type {Object}
  27175. */
  27176. this.uniforms = {};
  27177. /**
  27178. * An array holding uniforms groups for configuring UBOs.
  27179. *
  27180. * @type {Array<UniformsGroup>}
  27181. */
  27182. this.uniformsGroups = [];
  27183. /**
  27184. * Vertex shader GLSL code. This is the actual code for the shader.
  27185. *
  27186. * @type {string}
  27187. */
  27188. this.vertexShader = default_vertex;
  27189. /**
  27190. * Fragment shader GLSL code. This is the actual code for the shader.
  27191. *
  27192. * @type {string}
  27193. */
  27194. this.fragmentShader = default_fragment;
  27195. /**
  27196. * Controls line thickness or lines.
  27197. *
  27198. * WebGL and WebGPU ignore this setting and always render line primitives with a
  27199. * width of one pixel.
  27200. *
  27201. * @type {number}
  27202. * @default 1
  27203. */
  27204. this.linewidth = 1;
  27205. /**
  27206. * Renders the geometry as a wireframe.
  27207. *
  27208. * @type {boolean}
  27209. * @default false
  27210. */
  27211. this.wireframe = false;
  27212. /**
  27213. * Controls the thickness of the wireframe.
  27214. *
  27215. * WebGL and WebGPU ignore this property and always render
  27216. * 1 pixel wide lines.
  27217. *
  27218. * @type {number}
  27219. * @default 1
  27220. */
  27221. this.wireframeLinewidth = 1;
  27222. /**
  27223. * Defines whether the material color is affected by global fog settings; `true`
  27224. * to pass fog uniforms to the shader.
  27225. *
  27226. * Setting this property to `true` requires the definition of fog uniforms. It is
  27227. * recommended to use `UniformsUtils.merge()` to combine the custom shader uniforms
  27228. * with predefined fog uniforms.
  27229. *
  27230. * ```js
  27231. * const material = new ShaderMaterial( {
  27232. * uniforms: UniformsUtils.merge( [ UniformsLib[ 'fog' ], shaderUniforms ] );
  27233. * vertexShader: vertexShader,
  27234. * fragmentShader: fragmentShader,
  27235. * fog: true
  27236. * } );
  27237. * ```
  27238. *
  27239. * @type {boolean}
  27240. * @default false
  27241. */
  27242. this.fog = false;
  27243. /**
  27244. * Defines whether this material uses lighting; `true` to pass uniform data
  27245. * related to lighting to this shader.
  27246. *
  27247. * @type {boolean}
  27248. * @default false
  27249. */
  27250. this.lights = false;
  27251. /**
  27252. * Defines whether this material supports clipping; `true` to let the renderer
  27253. * pass the clippingPlanes uniform.
  27254. *
  27255. * @type {boolean}
  27256. * @default false
  27257. */
  27258. this.clipping = false;
  27259. /**
  27260. * Overwritten and set to `true` by default.
  27261. *
  27262. * @type {boolean}
  27263. * @default true
  27264. */
  27265. this.forceSinglePass = true;
  27266. /**
  27267. * This object allows to enable certain WebGL 2 extensions.
  27268. *
  27269. * - clipCullDistance: set to `true` to use vertex shader clipping
  27270. * - multiDraw: set to `true` to use vertex shader multi_draw / enable gl_DrawID
  27271. *
  27272. * @type {{clipCullDistance:false,multiDraw:false}}
  27273. */
  27274. this.extensions = {
  27275. clipCullDistance: false, // set to use vertex shader clipping
  27276. multiDraw: false // set to use vertex shader multi_draw / enable gl_DrawID
  27277. };
  27278. /**
  27279. * When the rendered geometry doesn't include these attributes but the
  27280. * material does, these default values will be passed to the shaders. This
  27281. * avoids errors when buffer data is missing.
  27282. *
  27283. * - color: [ 1, 1, 1 ]
  27284. * - uv: [ 0, 0 ]
  27285. * - uv1: [ 0, 0 ]
  27286. *
  27287. * @type {Object}
  27288. */
  27289. this.defaultAttributeValues = {
  27290. 'color': [ 1, 1, 1 ],
  27291. 'uv': [ 0, 0 ],
  27292. 'uv1': [ 0, 0 ]
  27293. };
  27294. /**
  27295. * If set, this calls [gl.bindAttribLocation](https://developer.mozilla.org/en-US/docs/Web/API/WebGLRenderingContext/bindAttribLocation)
  27296. * to bind a generic vertex index to an attribute variable.
  27297. *
  27298. * @type {string|undefined}
  27299. * @default undefined
  27300. */
  27301. this.index0AttributeName = undefined;
  27302. /**
  27303. * Can be used to force a uniform update while changing uniforms in
  27304. * {@link Object3D#onBeforeRender}.
  27305. *
  27306. * @type {boolean}
  27307. * @default false
  27308. */
  27309. this.uniformsNeedUpdate = false;
  27310. /**
  27311. * Defines the GLSL version of custom shader code.
  27312. *
  27313. * @type {?(GLSL1|GLSL3)}
  27314. * @default null
  27315. */
  27316. this.glslVersion = null;
  27317. if ( parameters !== undefined ) {
  27318. this.setValues( parameters );
  27319. }
  27320. }
  27321. copy( source ) {
  27322. super.copy( source );
  27323. this.fragmentShader = source.fragmentShader;
  27324. this.vertexShader = source.vertexShader;
  27325. this.uniforms = cloneUniforms( source.uniforms );
  27326. this.uniformsGroups = cloneUniformsGroups( source.uniformsGroups );
  27327. this.defines = Object.assign( {}, source.defines );
  27328. this.wireframe = source.wireframe;
  27329. this.wireframeLinewidth = source.wireframeLinewidth;
  27330. this.fog = source.fog;
  27331. this.lights = source.lights;
  27332. this.clipping = source.clipping;
  27333. this.extensions = Object.assign( {}, source.extensions );
  27334. this.glslVersion = source.glslVersion;
  27335. this.defaultAttributeValues = Object.assign( {}, source.defaultAttributeValues );
  27336. this.index0AttributeName = source.index0AttributeName;
  27337. this.uniformsNeedUpdate = source.uniformsNeedUpdate;
  27338. return this;
  27339. }
  27340. toJSON( meta ) {
  27341. const data = super.toJSON( meta );
  27342. data.glslVersion = this.glslVersion;
  27343. data.uniforms = {};
  27344. for ( const name in this.uniforms ) {
  27345. const uniform = this.uniforms[ name ];
  27346. const value = uniform.value;
  27347. if ( value && value.isTexture ) {
  27348. data.uniforms[ name ] = {
  27349. type: 't',
  27350. value: value.toJSON( meta ).uuid
  27351. };
  27352. } else if ( value && value.isColor ) {
  27353. data.uniforms[ name ] = {
  27354. type: 'c',
  27355. value: value.getHex()
  27356. };
  27357. } else if ( value && value.isVector2 ) {
  27358. data.uniforms[ name ] = {
  27359. type: 'v2',
  27360. value: value.toArray()
  27361. };
  27362. } else if ( value && value.isVector3 ) {
  27363. data.uniforms[ name ] = {
  27364. type: 'v3',
  27365. value: value.toArray()
  27366. };
  27367. } else if ( value && value.isVector4 ) {
  27368. data.uniforms[ name ] = {
  27369. type: 'v4',
  27370. value: value.toArray()
  27371. };
  27372. } else if ( value && value.isMatrix3 ) {
  27373. data.uniforms[ name ] = {
  27374. type: 'm3',
  27375. value: value.toArray()
  27376. };
  27377. } else if ( value && value.isMatrix4 ) {
  27378. data.uniforms[ name ] = {
  27379. type: 'm4',
  27380. value: value.toArray()
  27381. };
  27382. } else {
  27383. data.uniforms[ name ] = {
  27384. value: value
  27385. };
  27386. // note: the array variants v2v, v3v, v4v, m4v and tv are not supported so far
  27387. }
  27388. }
  27389. if ( Object.keys( this.defines ).length > 0 ) data.defines = this.defines;
  27390. data.vertexShader = this.vertexShader;
  27391. data.fragmentShader = this.fragmentShader;
  27392. data.lights = this.lights;
  27393. data.clipping = this.clipping;
  27394. const extensions = {};
  27395. for ( const key in this.extensions ) {
  27396. if ( this.extensions[ key ] === true ) extensions[ key ] = true;
  27397. }
  27398. if ( Object.keys( extensions ).length > 0 ) data.extensions = extensions;
  27399. return data;
  27400. }
  27401. }
  27402. /**
  27403. * This class works just like {@link ShaderMaterial}, except that definitions
  27404. * of built-in uniforms and attributes are not automatically prepended to the
  27405. * GLSL shader code.
  27406. *
  27407. * `RawShaderMaterial` can only be used with {@link WebGLRenderer}.
  27408. *
  27409. * @augments ShaderMaterial
  27410. */
  27411. class RawShaderMaterial extends ShaderMaterial {
  27412. /**
  27413. * Constructs a new raw shader material.
  27414. *
  27415. * @param {Object} [parameters] - An object with one or more properties
  27416. * defining the material's appearance. Any property of the material
  27417. * (including any property from inherited materials) can be passed
  27418. * in here. Color values can be passed any type of value accepted
  27419. * by {@link Color#set}.
  27420. */
  27421. constructor( parameters ) {
  27422. super( parameters );
  27423. /**
  27424. * This flag can be used for type testing.
  27425. *
  27426. * @type {boolean}
  27427. * @readonly
  27428. * @default true
  27429. */
  27430. this.isRawShaderMaterial = true;
  27431. this.type = 'RawShaderMaterial';
  27432. }
  27433. }
  27434. /**
  27435. * A standard physically based material, using Metallic-Roughness workflow.
  27436. *
  27437. * Physically based rendering (PBR) has recently become the standard in many
  27438. * 3D applications, such as [Unity](https://blogs.unity3d.com/2014/10/29/physically-based-shading-in-unity-5-a-primer/),
  27439. * [Unreal](https://docs.unrealengine.com/latest/INT/Engine/Rendering/Materials/PhysicallyBased/) and
  27440. * [3D Studio Max](http://area.autodesk.com/blogs/the-3ds-max-blog/what039s-new-for-rendering-in-3ds-max-2017).
  27441. *
  27442. * This approach differs from older approaches in that instead of using
  27443. * approximations for the way in which light interacts with a surface, a
  27444. * physically correct model is used. The idea is that, instead of tweaking
  27445. * materials to look good under specific lighting, a material can be created
  27446. * that will react 'correctly' under all lighting scenarios.
  27447. *
  27448. * In practice this gives a more accurate and realistic looking result than
  27449. * the {@link MeshLambertMaterial} or {@link MeshPhongMaterial}, at the cost of
  27450. * being somewhat more computationally expensive. `MeshStandardMaterial` uses per-fragment
  27451. * shading.
  27452. *
  27453. * Note that for best results you should always specify an environment map when using this material.
  27454. *
  27455. * For a non-technical introduction to the concept of PBR and how to set up a
  27456. * PBR material, check out these articles by the people at [marmoset](https://www.marmoset.co):
  27457. *
  27458. * - [Basic Theory of Physically Based Rendering](https://www.marmoset.co/posts/basic-theory-of-physically-based-rendering/)
  27459. * - [Physically Based Rendering and You Can Too](https://www.marmoset.co/posts/physically-based-rendering-and-you-can-too/)
  27460. *
  27461. * Technical details of the approach used in three.js (and most other PBR systems) can be found is this
  27462. * [paper from Disney](https://media.disneyanimation.com/uploads/production/publication_asset/48/asset/s2012_pbs_disney_brdf_notes_v3.pdf)
  27463. * (pdf), by Brent Burley.
  27464. *
  27465. * @augments Material
  27466. * @demo scenes/material-browser.html#MeshStandardMaterial
  27467. */
  27468. class MeshStandardMaterial extends Material {
  27469. /**
  27470. * Constructs a new mesh standard material.
  27471. *
  27472. * @param {Object} [parameters] - An object with one or more properties
  27473. * defining the material's appearance. Any property of the material
  27474. * (including any property from inherited materials) can be passed
  27475. * in here. Color values can be passed any type of value accepted
  27476. * by {@link Color#set}.
  27477. */
  27478. constructor( parameters ) {
  27479. super();
  27480. /**
  27481. * This flag can be used for type testing.
  27482. *
  27483. * @type {boolean}
  27484. * @readonly
  27485. * @default true
  27486. */
  27487. this.isMeshStandardMaterial = true;
  27488. this.type = 'MeshStandardMaterial';
  27489. this.defines = { 'STANDARD': '' };
  27490. /**
  27491. * Color of the material.
  27492. *
  27493. * @type {Color}
  27494. * @default (1,1,1)
  27495. */
  27496. this.color = new Color( 0xffffff ); // diffuse
  27497. /**
  27498. * How rough the material appears. `0.0` means a smooth mirror reflection, `1.0`
  27499. * means fully diffuse. If `roughnessMap` is also provided,
  27500. * both values are multiplied.
  27501. *
  27502. * @type {number}
  27503. * @default 1
  27504. */
  27505. this.roughness = 1.0;
  27506. /**
  27507. * How much the material is like a metal. Non-metallic materials such as wood
  27508. * or stone use `0.0`, metallic use `1.0`, with nothing (usually) in between.
  27509. * A value between `0.0` and `1.0` could be used for a rusty metal look.
  27510. * If `metalnessMap` is also provided, both values are multiplied.
  27511. *
  27512. * @type {number}
  27513. * @default 0
  27514. */
  27515. this.metalness = 0.0;
  27516. /**
  27517. * The color map. May optionally include an alpha channel, typically combined
  27518. * with {@link Material#transparent} or {@link Material#alphaTest}. The texture map
  27519. * color is modulated by the diffuse `color`.
  27520. *
  27521. * @type {?Texture}
  27522. * @default null
  27523. */
  27524. this.map = null;
  27525. /**
  27526. * The light map. Requires a second set of UVs.
  27527. *
  27528. * @type {?Texture}
  27529. * @default null
  27530. */
  27531. this.lightMap = null;
  27532. /**
  27533. * Intensity of the baked light.
  27534. *
  27535. * @type {number}
  27536. * @default 1
  27537. */
  27538. this.lightMapIntensity = 1.0;
  27539. /**
  27540. * The red channel of this texture is used as the ambient occlusion map.
  27541. * Requires a second set of UVs.
  27542. *
  27543. * @type {?Texture}
  27544. * @default null
  27545. */
  27546. this.aoMap = null;
  27547. /**
  27548. * Intensity of the ambient occlusion effect. Range is `[0,1]`, where `0`
  27549. * disables ambient occlusion. Where intensity is `1` and the AO map's
  27550. * red channel is also `1`, ambient light is fully occluded on a surface.
  27551. *
  27552. * @type {number}
  27553. * @default 1
  27554. */
  27555. this.aoMapIntensity = 1.0;
  27556. /**
  27557. * Emissive (light) color of the material, essentially a solid color
  27558. * unaffected by other lighting.
  27559. *
  27560. * @type {Color}
  27561. * @default (0,0,0)
  27562. */
  27563. this.emissive = new Color( 0x000000 );
  27564. /**
  27565. * Intensity of the emissive light. Modulates the emissive color.
  27566. *
  27567. * @type {number}
  27568. * @default 1
  27569. */
  27570. this.emissiveIntensity = 1.0;
  27571. /**
  27572. * Set emissive (glow) map. The emissive map color is modulated by the
  27573. * emissive color and the emissive intensity. If you have an emissive map,
  27574. * be sure to set the emissive color to something other than black.
  27575. *
  27576. * @type {?Texture}
  27577. * @default null
  27578. */
  27579. this.emissiveMap = null;
  27580. /**
  27581. * The texture to create a bump map. The black and white values map to the
  27582. * perceived depth in relation to the lights. Bump doesn't actually affect
  27583. * the geometry of the object, only the lighting. If a normal map is defined
  27584. * this will be ignored.
  27585. *
  27586. * @type {?Texture}
  27587. * @default null
  27588. */
  27589. this.bumpMap = null;
  27590. /**
  27591. * How much the bump map affects the material. Typical range is `[0,1]`.
  27592. *
  27593. * @type {number}
  27594. * @default 1
  27595. */
  27596. this.bumpScale = 1;
  27597. /**
  27598. * The texture to create a normal map. The RGB values affect the surface
  27599. * normal for each pixel fragment and change the way the color is lit. Normal
  27600. * maps do not change the actual shape of the surface, only the lighting. In
  27601. * case the material has a normal map authored using the left handed
  27602. * convention, the `y` component of `normalScale` should be negated to compensate
  27603. * for the different handedness.
  27604. *
  27605. * @type {?Texture}
  27606. * @default null
  27607. */
  27608. this.normalMap = null;
  27609. /**
  27610. * The type of normal map.
  27611. *
  27612. * @type {(TangentSpaceNormalMap|ObjectSpaceNormalMap)}
  27613. * @default TangentSpaceNormalMap
  27614. */
  27615. this.normalMapType = TangentSpaceNormalMap;
  27616. /**
  27617. * How much the normal map affects the material. Typical value range is `[0,1]`.
  27618. *
  27619. * @type {Vector2}
  27620. * @default (1,1)
  27621. */
  27622. this.normalScale = new Vector2( 1, 1 );
  27623. /**
  27624. * The displacement map affects the position of the mesh's vertices. Unlike
  27625. * other maps which only affect the light and shade of the material the
  27626. * displaced vertices can cast shadows, block other objects, and otherwise
  27627. * act as real geometry. The displacement texture is an image where the value
  27628. * of each pixel (white being the highest) is mapped against, and
  27629. * repositions, the vertices of the mesh.
  27630. *
  27631. * @type {?Texture}
  27632. * @default null
  27633. */
  27634. this.displacementMap = null;
  27635. /**
  27636. * How much the displacement map affects the mesh (where black is no
  27637. * displacement, and white is maximum displacement). Without a displacement
  27638. * map set, this value is not applied.
  27639. *
  27640. * @type {number}
  27641. * @default 0
  27642. */
  27643. this.displacementScale = 1;
  27644. /**
  27645. * The offset of the displacement map's values on the mesh's vertices.
  27646. * The bias is added to the scaled sample of the displacement map.
  27647. * Without a displacement map set, this value is not applied.
  27648. *
  27649. * @type {number}
  27650. * @default 0
  27651. */
  27652. this.displacementBias = 0;
  27653. /**
  27654. * The green channel of this texture is used to alter the roughness of the
  27655. * material.
  27656. *
  27657. * @type {?Texture}
  27658. * @default null
  27659. */
  27660. this.roughnessMap = null;
  27661. /**
  27662. * The blue channel of this texture is used to alter the metalness of the
  27663. * material.
  27664. *
  27665. * @type {?Texture}
  27666. * @default null
  27667. */
  27668. this.metalnessMap = null;
  27669. /**
  27670. * The alpha map is a grayscale texture that controls the opacity across the
  27671. * surface (black: fully transparent; white: fully opaque).
  27672. *
  27673. * Only the color of the texture is used, ignoring the alpha channel if one
  27674. * exists. For RGB and RGBA textures, the renderer will use the green channel
  27675. * when sampling this texture due to the extra bit of precision provided for
  27676. * green in DXT-compressed and uncompressed RGB 565 formats. Luminance-only and
  27677. * luminance/alpha textures will also still work as expected.
  27678. *
  27679. * @type {?Texture}
  27680. * @default null
  27681. */
  27682. this.alphaMap = null;
  27683. /**
  27684. * The environment map. To ensure a physically correct rendering, environment maps
  27685. * are internally pre-processed with {@link PMREMGenerator}.
  27686. *
  27687. * @type {?Texture}
  27688. * @default null
  27689. */
  27690. this.envMap = null;
  27691. /**
  27692. * The rotation of the environment map in radians.
  27693. *
  27694. * @type {Euler}
  27695. * @default (0,0,0)
  27696. */
  27697. this.envMapRotation = new Euler();
  27698. /**
  27699. * Scales the effect of the environment map by multiplying its color.
  27700. *
  27701. * @type {number}
  27702. * @default 1
  27703. */
  27704. this.envMapIntensity = 1.0;
  27705. /**
  27706. * Renders the geometry as a wireframe.
  27707. *
  27708. * @type {boolean}
  27709. * @default false
  27710. */
  27711. this.wireframe = false;
  27712. /**
  27713. * Controls the thickness of the wireframe.
  27714. *
  27715. * Can only be used with {@link SVGRenderer}.
  27716. *
  27717. * @type {number}
  27718. * @default 1
  27719. */
  27720. this.wireframeLinewidth = 1;
  27721. /**
  27722. * Defines appearance of wireframe ends.
  27723. *
  27724. * Can only be used with {@link SVGRenderer}.
  27725. *
  27726. * @type {('round'|'bevel'|'miter')}
  27727. * @default 'round'
  27728. */
  27729. this.wireframeLinecap = 'round';
  27730. /**
  27731. * Defines appearance of wireframe joints.
  27732. *
  27733. * Can only be used with {@link SVGRenderer}.
  27734. *
  27735. * @type {('round'|'bevel'|'miter')}
  27736. * @default 'round'
  27737. */
  27738. this.wireframeLinejoin = 'round';
  27739. /**
  27740. * Whether the material is rendered with flat shading or not.
  27741. *
  27742. * @type {boolean}
  27743. * @default false
  27744. */
  27745. this.flatShading = false;
  27746. /**
  27747. * Whether the material is affected by fog or not.
  27748. *
  27749. * @type {boolean}
  27750. * @default true
  27751. */
  27752. this.fog = true;
  27753. this.setValues( parameters );
  27754. }
  27755. copy( source ) {
  27756. super.copy( source );
  27757. this.defines = { 'STANDARD': '' };
  27758. this.color.copy( source.color );
  27759. this.roughness = source.roughness;
  27760. this.metalness = source.metalness;
  27761. this.map = source.map;
  27762. this.lightMap = source.lightMap;
  27763. this.lightMapIntensity = source.lightMapIntensity;
  27764. this.aoMap = source.aoMap;
  27765. this.aoMapIntensity = source.aoMapIntensity;
  27766. this.emissive.copy( source.emissive );
  27767. this.emissiveMap = source.emissiveMap;
  27768. this.emissiveIntensity = source.emissiveIntensity;
  27769. this.bumpMap = source.bumpMap;
  27770. this.bumpScale = source.bumpScale;
  27771. this.normalMap = source.normalMap;
  27772. this.normalMapType = source.normalMapType;
  27773. this.normalScale.copy( source.normalScale );
  27774. this.displacementMap = source.displacementMap;
  27775. this.displacementScale = source.displacementScale;
  27776. this.displacementBias = source.displacementBias;
  27777. this.roughnessMap = source.roughnessMap;
  27778. this.metalnessMap = source.metalnessMap;
  27779. this.alphaMap = source.alphaMap;
  27780. this.envMap = source.envMap;
  27781. this.envMapRotation.copy( source.envMapRotation );
  27782. this.envMapIntensity = source.envMapIntensity;
  27783. this.wireframe = source.wireframe;
  27784. this.wireframeLinewidth = source.wireframeLinewidth;
  27785. this.wireframeLinecap = source.wireframeLinecap;
  27786. this.wireframeLinejoin = source.wireframeLinejoin;
  27787. this.flatShading = source.flatShading;
  27788. this.fog = source.fog;
  27789. return this;
  27790. }
  27791. }
  27792. /**
  27793. * An extension of the {@link MeshStandardMaterial}, providing more advanced
  27794. * physically-based rendering properties:
  27795. *
  27796. * - Anisotropy: Ability to represent the anisotropic property of materials
  27797. * as observable with brushed metals.
  27798. * - Clearcoat: Some materials — like car paints, carbon fiber, and wet surfaces — require
  27799. * a clear, reflective layer on top of another layer that may be irregular or rough.
  27800. * Clearcoat approximates this effect, without the need for a separate transparent surface.
  27801. * - Iridescence: Allows to render the effect where hue varies depending on the viewing
  27802. * angle and illumination angle. This can be seen on soap bubbles, oil films, or on the
  27803. * wings of many insects.
  27804. * - Physically-based transparency: One limitation of {@link Material#opacity} is that highly
  27805. * transparent materials are less reflective. Physically-based transmission provides a more
  27806. * realistic option for thin, transparent surfaces like glass.
  27807. * - Advanced reflectivity: More flexible reflectivity for non-metallic materials.
  27808. * - Sheen: Can be used for representing cloth and fabric materials.
  27809. *
  27810. * As a result of these complex shading features, `MeshPhysicalMaterial` has a
  27811. * higher performance cost, per pixel, than other three.js materials. Most
  27812. * effects are disabled by default, and add cost as they are enabled. For
  27813. * best results, always specify an environment map when using this material.
  27814. *
  27815. * @augments MeshStandardMaterial
  27816. * @demo scenes/material-browser.html#MeshPhysicalMaterial
  27817. */
  27818. class MeshPhysicalMaterial extends MeshStandardMaterial {
  27819. /**
  27820. * Constructs a new mesh physical material.
  27821. *
  27822. * @param {Object} [parameters] - An object with one or more properties
  27823. * defining the material's appearance. Any property of the material
  27824. * (including any property from inherited materials) can be passed
  27825. * in here. Color values can be passed any type of value accepted
  27826. * by {@link Color#set}.
  27827. */
  27828. constructor( parameters ) {
  27829. super();
  27830. /**
  27831. * This flag can be used for type testing.
  27832. *
  27833. * @type {boolean}
  27834. * @readonly
  27835. * @default true
  27836. */
  27837. this.isMeshPhysicalMaterial = true;
  27838. this.defines = {
  27839. 'STANDARD': '',
  27840. 'PHYSICAL': ''
  27841. };
  27842. this.type = 'MeshPhysicalMaterial';
  27843. /**
  27844. * The rotation of the anisotropy in tangent, bitangent space, measured in radians
  27845. * counter-clockwise from the tangent. When `anisotropyMap` is present, this
  27846. * property provides additional rotation to the vectors in the texture.
  27847. *
  27848. * @type {number}
  27849. * @default 1
  27850. */
  27851. this.anisotropyRotation = 0;
  27852. /**
  27853. * Red and green channels represent the anisotropy direction in `[-1, 1]` tangent,
  27854. * bitangent space, to be rotated by `anisotropyRotation`. The blue channel
  27855. * contains strength as `[0, 1]` to be multiplied by `anisotropy`.
  27856. *
  27857. * @type {?Texture}
  27858. * @default null
  27859. */
  27860. this.anisotropyMap = null;
  27861. /**
  27862. * The red channel of this texture is multiplied against `clearcoat`,
  27863. * for per-pixel control over a coating's intensity.
  27864. *
  27865. * @type {?Texture}
  27866. * @default null
  27867. */
  27868. this.clearcoatMap = null;
  27869. /**
  27870. * Roughness of the clear coat layer, from `0.0` to `1.0`.
  27871. *
  27872. * @type {number}
  27873. * @default 0
  27874. */
  27875. this.clearcoatRoughness = 0.0;
  27876. /**
  27877. * The green channel of this texture is multiplied against
  27878. * `clearcoatRoughness`, for per-pixel control over a coating's roughness.
  27879. *
  27880. * @type {?Texture}
  27881. * @default null
  27882. */
  27883. this.clearcoatRoughnessMap = null;
  27884. /**
  27885. * How much `clearcoatNormalMap` affects the clear coat layer, from
  27886. * `(0,0)` to `(1,1)`.
  27887. *
  27888. * @type {Vector2}
  27889. * @default (1,1)
  27890. */
  27891. this.clearcoatNormalScale = new Vector2( 1, 1 );
  27892. /**
  27893. * Can be used to enable independent normals for the clear coat layer.
  27894. *
  27895. * @type {?Texture}
  27896. * @default null
  27897. */
  27898. this.clearcoatNormalMap = null;
  27899. /**
  27900. * Index-of-refraction for non-metallic materials, from `1.0` to `2.333`.
  27901. *
  27902. * @type {number}
  27903. * @default 1.5
  27904. */
  27905. this.ior = 1.5;
  27906. /**
  27907. * Degree of reflectivity, from `0.0` to `1.0`. Default is `0.5`, which
  27908. * corresponds to an index-of-refraction of `1.5`.
  27909. *
  27910. * This models the reflectivity of non-metallic materials. It has no effect
  27911. * when `metalness` is `1.0`
  27912. *
  27913. * @name MeshPhysicalMaterial#reflectivity
  27914. * @type {number}
  27915. * @default 0.5
  27916. */
  27917. Object.defineProperty( this, 'reflectivity', {
  27918. get: function () {
  27919. return ( clamp( 2.5 * ( this.ior - 1 ) / ( this.ior + 1 ), 0, 1 ) );
  27920. },
  27921. set: function ( reflectivity ) {
  27922. this.ior = ( 1 + 0.4 * reflectivity ) / ( 1 - 0.4 * reflectivity );
  27923. }
  27924. } );
  27925. /**
  27926. * The red channel of this texture is multiplied against `iridescence`, for per-pixel
  27927. * control over iridescence.
  27928. *
  27929. * @type {?Texture}
  27930. * @default null
  27931. */
  27932. this.iridescenceMap = null;
  27933. /**
  27934. * Strength of the iridescence RGB color shift effect, represented by an index-of-refraction.
  27935. * Between `1.0` to `2.333`.
  27936. *
  27937. * @type {number}
  27938. * @default 1.3
  27939. */
  27940. this.iridescenceIOR = 1.3;
  27941. /**
  27942. *Array of exactly 2 elements, specifying minimum and maximum thickness of the iridescence layer.
  27943. Thickness of iridescence layer has an equivalent effect of the one `thickness` has on `ior`.
  27944. *
  27945. * @type {Array<number,number>}
  27946. * @default [100,400]
  27947. */
  27948. this.iridescenceThicknessRange = [ 100, 400 ];
  27949. /**
  27950. * A texture that defines the thickness of the iridescence layer, stored in the green channel.
  27951. * Minimum and maximum values of thickness are defined by `iridescenceThicknessRange` array:
  27952. * - `0.0` in the green channel will result in thickness equal to first element of the array.
  27953. * - `1.0` in the green channel will result in thickness equal to second element of the array.
  27954. * - Values in-between will linearly interpolate between the elements of the array.
  27955. *
  27956. * @type {?Texture}
  27957. * @default null
  27958. */
  27959. this.iridescenceThicknessMap = null;
  27960. /**
  27961. * The sheen tint.
  27962. *
  27963. * @type {Color}
  27964. * @default (0,0,0)
  27965. */
  27966. this.sheenColor = new Color( 0x000000 );
  27967. /**
  27968. * The RGB channels of this texture are multiplied against `sheenColor`, for per-pixel control
  27969. * over sheen tint.
  27970. *
  27971. * @type {?Texture}
  27972. * @default null
  27973. */
  27974. this.sheenColorMap = null;
  27975. /**
  27976. * Roughness of the sheen layer, from `0.0` to `1.0`.
  27977. *
  27978. * @type {number}
  27979. * @default 1
  27980. */
  27981. this.sheenRoughness = 1.0;
  27982. /**
  27983. * The alpha channel of this texture is multiplied against `sheenRoughness`, for per-pixel control
  27984. * over sheen roughness.
  27985. *
  27986. * @type {?Texture}
  27987. * @default null
  27988. */
  27989. this.sheenRoughnessMap = null;
  27990. /**
  27991. * The red channel of this texture is multiplied against `transmission`, for per-pixel control over
  27992. * optical transparency.
  27993. *
  27994. * @type {?Texture}
  27995. * @default null
  27996. */
  27997. this.transmissionMap = null;
  27998. /**
  27999. * The thickness of the volume beneath the surface. The value is given in the
  28000. * coordinate space of the mesh. If the value is `0` the material is
  28001. * thin-walled. Otherwise the material is a volume boundary.
  28002. *
  28003. * @type {number}
  28004. * @default 0
  28005. */
  28006. this.thickness = 0;
  28007. /**
  28008. * A texture that defines the thickness, stored in the green channel. This will
  28009. * be multiplied by `thickness`.
  28010. *
  28011. * @type {?Texture}
  28012. * @default null
  28013. */
  28014. this.thicknessMap = null;
  28015. /**
  28016. * Density of the medium given as the average distance that light travels in
  28017. * the medium before interacting with a particle. The value is given in world
  28018. * space units, and must be greater than zero.
  28019. *
  28020. * @type {number}
  28021. * @default Infinity
  28022. */
  28023. this.attenuationDistance = Infinity;
  28024. /**
  28025. * The color that white light turns into due to absorption when reaching the
  28026. * attenuation distance.
  28027. *
  28028. * @type {Color}
  28029. * @default (1,1,1)
  28030. */
  28031. this.attenuationColor = new Color( 1, 1, 1 );
  28032. /**
  28033. * A float that scales the amount of specular reflection for non-metals only.
  28034. * When set to zero, the model is effectively Lambertian. From `0.0` to `1.0`.
  28035. *
  28036. * @type {number}
  28037. * @default 1
  28038. */
  28039. this.specularIntensity = 1.0;
  28040. /**
  28041. * The alpha channel of this texture is multiplied against `specularIntensity`,
  28042. * for per-pixel control over specular intensity.
  28043. *
  28044. * @type {?Texture}
  28045. * @default null
  28046. */
  28047. this.specularIntensityMap = null;
  28048. /**
  28049. * Tints the specular reflection at normal incidence for non-metals only.
  28050. *
  28051. * @type {Color}
  28052. * @default (1,1,1)
  28053. */
  28054. this.specularColor = new Color( 1, 1, 1 );
  28055. /**
  28056. * The RGB channels of this texture are multiplied against `specularColor`,
  28057. * for per-pixel control over specular color.
  28058. *
  28059. * @type {?Texture}
  28060. * @default null
  28061. */
  28062. this.specularColorMap = null;
  28063. this._anisotropy = 0;
  28064. this._clearcoat = 0;
  28065. this._dispersion = 0;
  28066. this._iridescence = 0;
  28067. this._sheen = 0.0;
  28068. this._transmission = 0;
  28069. this.setValues( parameters );
  28070. }
  28071. /**
  28072. * The anisotropy strength, from `0.0` to `1.0`.
  28073. *
  28074. * @type {number}
  28075. * @default 0
  28076. */
  28077. get anisotropy() {
  28078. return this._anisotropy;
  28079. }
  28080. set anisotropy( value ) {
  28081. if ( this._anisotropy > 0 !== value > 0 ) {
  28082. this.version ++;
  28083. }
  28084. this._anisotropy = value;
  28085. }
  28086. /**
  28087. * Represents the intensity of the clear coat layer, from `0.0` to `1.0`. Use
  28088. * clear coat related properties to enable multilayer materials that have a
  28089. * thin translucent layer over the base layer.
  28090. *
  28091. * @type {number}
  28092. * @default 0
  28093. */
  28094. get clearcoat() {
  28095. return this._clearcoat;
  28096. }
  28097. set clearcoat( value ) {
  28098. if ( this._clearcoat > 0 !== value > 0 ) {
  28099. this.version ++;
  28100. }
  28101. this._clearcoat = value;
  28102. }
  28103. /**
  28104. * The intensity of the iridescence layer, simulating RGB color shift based on the angle between
  28105. * the surface and the viewer, from `0.0` to `1.0`.
  28106. *
  28107. * @type {number}
  28108. * @default 0
  28109. */
  28110. get iridescence() {
  28111. return this._iridescence;
  28112. }
  28113. set iridescence( value ) {
  28114. if ( this._iridescence > 0 !== value > 0 ) {
  28115. this.version ++;
  28116. }
  28117. this._iridescence = value;
  28118. }
  28119. /**
  28120. * Defines the strength of the angular separation of colors (chromatic aberration) transmitting
  28121. * through a relatively clear volume. Any value zero or larger is valid, the typical range of
  28122. * realistic values is `[0, 1]`. This property can be only be used with transmissive objects.
  28123. *
  28124. * @type {number}
  28125. * @default 0
  28126. */
  28127. get dispersion() {
  28128. return this._dispersion;
  28129. }
  28130. set dispersion( value ) {
  28131. if ( this._dispersion > 0 !== value > 0 ) {
  28132. this.version ++;
  28133. }
  28134. this._dispersion = value;
  28135. }
  28136. /**
  28137. * The intensity of the sheen layer, from `0.0` to `1.0`.
  28138. *
  28139. * @type {number}
  28140. * @default 0
  28141. */
  28142. get sheen() {
  28143. return this._sheen;
  28144. }
  28145. set sheen( value ) {
  28146. if ( this._sheen > 0 !== value > 0 ) {
  28147. this.version ++;
  28148. }
  28149. this._sheen = value;
  28150. }
  28151. /**
  28152. * Degree of transmission (or optical transparency), from `0.0` to `1.0`.
  28153. *
  28154. * Thin, transparent or semitransparent, plastic or glass materials remain
  28155. * largely reflective even if they are fully transmissive. The transmission
  28156. * property can be used to model these materials.
  28157. *
  28158. * When transmission is non-zero, `opacity` should be set to `1`.
  28159. *
  28160. * @type {number}
  28161. * @default 0
  28162. */
  28163. get transmission() {
  28164. return this._transmission;
  28165. }
  28166. set transmission( value ) {
  28167. if ( this._transmission > 0 !== value > 0 ) {
  28168. this.version ++;
  28169. }
  28170. this._transmission = value;
  28171. }
  28172. copy( source ) {
  28173. super.copy( source );
  28174. this.defines = {
  28175. 'STANDARD': '',
  28176. 'PHYSICAL': ''
  28177. };
  28178. this.anisotropy = source.anisotropy;
  28179. this.anisotropyRotation = source.anisotropyRotation;
  28180. this.anisotropyMap = source.anisotropyMap;
  28181. this.clearcoat = source.clearcoat;
  28182. this.clearcoatMap = source.clearcoatMap;
  28183. this.clearcoatRoughness = source.clearcoatRoughness;
  28184. this.clearcoatRoughnessMap = source.clearcoatRoughnessMap;
  28185. this.clearcoatNormalMap = source.clearcoatNormalMap;
  28186. this.clearcoatNormalScale.copy( source.clearcoatNormalScale );
  28187. this.dispersion = source.dispersion;
  28188. this.ior = source.ior;
  28189. this.iridescence = source.iridescence;
  28190. this.iridescenceMap = source.iridescenceMap;
  28191. this.iridescenceIOR = source.iridescenceIOR;
  28192. this.iridescenceThicknessRange = [ ...source.iridescenceThicknessRange ];
  28193. this.iridescenceThicknessMap = source.iridescenceThicknessMap;
  28194. this.sheen = source.sheen;
  28195. this.sheenColor.copy( source.sheenColor );
  28196. this.sheenColorMap = source.sheenColorMap;
  28197. this.sheenRoughness = source.sheenRoughness;
  28198. this.sheenRoughnessMap = source.sheenRoughnessMap;
  28199. this.transmission = source.transmission;
  28200. this.transmissionMap = source.transmissionMap;
  28201. this.thickness = source.thickness;
  28202. this.thicknessMap = source.thicknessMap;
  28203. this.attenuationDistance = source.attenuationDistance;
  28204. this.attenuationColor.copy( source.attenuationColor );
  28205. this.specularIntensity = source.specularIntensity;
  28206. this.specularIntensityMap = source.specularIntensityMap;
  28207. this.specularColor.copy( source.specularColor );
  28208. this.specularColorMap = source.specularColorMap;
  28209. return this;
  28210. }
  28211. }
  28212. /**
  28213. * A material for shiny surfaces with specular highlights.
  28214. *
  28215. * The material uses a non-physically based [Blinn-Phong](https://en.wikipedia.org/wiki/Blinn-Phong_shading_model)
  28216. * model for calculating reflectance. Unlike the Lambertian model used in the
  28217. * {@link MeshLambertMaterial} this can simulate shiny surfaces with specular
  28218. * highlights (such as varnished wood). `MeshPhongMaterial` uses per-fragment shading.
  28219. *
  28220. * Performance will generally be greater when using this material over the
  28221. * {@link MeshStandardMaterial} or {@link MeshPhysicalMaterial}, at the cost of
  28222. * some graphical accuracy.
  28223. *
  28224. * @augments Material
  28225. * @demo scenes/material-browser.html#MeshPhongMaterial
  28226. */
  28227. class MeshPhongMaterial extends Material {
  28228. /**
  28229. * Constructs a new mesh phong material.
  28230. *
  28231. * @param {Object} [parameters] - An object with one or more properties
  28232. * defining the material's appearance. Any property of the material
  28233. * (including any property from inherited materials) can be passed
  28234. * in here. Color values can be passed any type of value accepted
  28235. * by {@link Color#set}.
  28236. */
  28237. constructor( parameters ) {
  28238. super();
  28239. /**
  28240. * This flag can be used for type testing.
  28241. *
  28242. * @type {boolean}
  28243. * @readonly
  28244. * @default true
  28245. */
  28246. this.isMeshPhongMaterial = true;
  28247. this.type = 'MeshPhongMaterial';
  28248. /**
  28249. * Color of the material.
  28250. *
  28251. * @type {Color}
  28252. * @default (1,1,1)
  28253. */
  28254. this.color = new Color( 0xffffff ); // diffuse
  28255. /**
  28256. * Specular color of the material. The default color is set to `0x111111` (very dark grey)
  28257. *
  28258. * This defines how shiny the material is and the color of its shine.
  28259. *
  28260. * @type {Color}
  28261. */
  28262. this.specular = new Color( 0x111111 );
  28263. /**
  28264. * How shiny the specular highlight is; a higher value gives a sharper highlight.
  28265. *
  28266. * @type {number}
  28267. * @default 30
  28268. */
  28269. this.shininess = 30;
  28270. /**
  28271. * The color map. May optionally include an alpha channel, typically combined
  28272. * with {@link Material#transparent} or {@link Material#alphaTest}. The texture map
  28273. * color is modulated by the diffuse `color`.
  28274. *
  28275. * @type {?Texture}
  28276. * @default null
  28277. */
  28278. this.map = null;
  28279. /**
  28280. * The light map. Requires a second set of UVs.
  28281. *
  28282. * @type {?Texture}
  28283. * @default null
  28284. */
  28285. this.lightMap = null;
  28286. /**
  28287. * Intensity of the baked light.
  28288. *
  28289. * @type {number}
  28290. * @default 1
  28291. */
  28292. this.lightMapIntensity = 1.0;
  28293. /**
  28294. * The red channel of this texture is used as the ambient occlusion map.
  28295. * Requires a second set of UVs.
  28296. *
  28297. * @type {?Texture}
  28298. * @default null
  28299. */
  28300. this.aoMap = null;
  28301. /**
  28302. * Intensity of the ambient occlusion effect. Range is `[0,1]`, where `0`
  28303. * disables ambient occlusion. Where intensity is `1` and the AO map's
  28304. * red channel is also `1`, ambient light is fully occluded on a surface.
  28305. *
  28306. * @type {number}
  28307. * @default 1
  28308. */
  28309. this.aoMapIntensity = 1.0;
  28310. /**
  28311. * Emissive (light) color of the material, essentially a solid color
  28312. * unaffected by other lighting.
  28313. *
  28314. * @type {Color}
  28315. * @default (0,0,0)
  28316. */
  28317. this.emissive = new Color( 0x000000 );
  28318. /**
  28319. * Intensity of the emissive light. Modulates the emissive color.
  28320. *
  28321. * @type {number}
  28322. * @default 1
  28323. */
  28324. this.emissiveIntensity = 1.0;
  28325. /**
  28326. * Set emissive (glow) map. The emissive map color is modulated by the
  28327. * emissive color and the emissive intensity. If you have an emissive map,
  28328. * be sure to set the emissive color to something other than black.
  28329. *
  28330. * @type {?Texture}
  28331. * @default null
  28332. */
  28333. this.emissiveMap = null;
  28334. /**
  28335. * The texture to create a bump map. The black and white values map to the
  28336. * perceived depth in relation to the lights. Bump doesn't actually affect
  28337. * the geometry of the object, only the lighting. If a normal map is defined
  28338. * this will be ignored.
  28339. *
  28340. * @type {?Texture}
  28341. * @default null
  28342. */
  28343. this.bumpMap = null;
  28344. /**
  28345. * How much the bump map affects the material. Typical range is `[0,1]`.
  28346. *
  28347. * @type {number}
  28348. * @default 1
  28349. */
  28350. this.bumpScale = 1;
  28351. /**
  28352. * The texture to create a normal map. The RGB values affect the surface
  28353. * normal for each pixel fragment and change the way the color is lit. Normal
  28354. * maps do not change the actual shape of the surface, only the lighting. In
  28355. * case the material has a normal map authored using the left handed
  28356. * convention, the `y` component of `normalScale` should be negated to compensate
  28357. * for the different handedness.
  28358. *
  28359. * @type {?Texture}
  28360. * @default null
  28361. */
  28362. this.normalMap = null;
  28363. /**
  28364. * The type of normal map.
  28365. *
  28366. * @type {(TangentSpaceNormalMap|ObjectSpaceNormalMap)}
  28367. * @default TangentSpaceNormalMap
  28368. */
  28369. this.normalMapType = TangentSpaceNormalMap;
  28370. /**
  28371. * How much the normal map affects the material. Typical value range is `[0,1]`.
  28372. *
  28373. * @type {Vector2}
  28374. * @default (1,1)
  28375. */
  28376. this.normalScale = new Vector2( 1, 1 );
  28377. /**
  28378. * The displacement map affects the position of the mesh's vertices. Unlike
  28379. * other maps which only affect the light and shade of the material the
  28380. * displaced vertices can cast shadows, block other objects, and otherwise
  28381. * act as real geometry. The displacement texture is an image where the value
  28382. * of each pixel (white being the highest) is mapped against, and
  28383. * repositions, the vertices of the mesh.
  28384. *
  28385. * @type {?Texture}
  28386. * @default null
  28387. */
  28388. this.displacementMap = null;
  28389. /**
  28390. * How much the displacement map affects the mesh (where black is no
  28391. * displacement, and white is maximum displacement). Without a displacement
  28392. * map set, this value is not applied.
  28393. *
  28394. * @type {number}
  28395. * @default 0
  28396. */
  28397. this.displacementScale = 1;
  28398. /**
  28399. * The offset of the displacement map's values on the mesh's vertices.
  28400. * The bias is added to the scaled sample of the displacement map.
  28401. * Without a displacement map set, this value is not applied.
  28402. *
  28403. * @type {number}
  28404. * @default 0
  28405. */
  28406. this.displacementBias = 0;
  28407. /**
  28408. * The specular map value affects both how much the specular surface
  28409. * highlight contributes and how much of the environment map affects the
  28410. * surface.
  28411. *
  28412. * @type {?Texture}
  28413. * @default null
  28414. */
  28415. this.specularMap = null;
  28416. /**
  28417. * The alpha map is a grayscale texture that controls the opacity across the
  28418. * surface (black: fully transparent; white: fully opaque).
  28419. *
  28420. * Only the color of the texture is used, ignoring the alpha channel if one
  28421. * exists. For RGB and RGBA textures, the renderer will use the green channel
  28422. * when sampling this texture due to the extra bit of precision provided for
  28423. * green in DXT-compressed and uncompressed RGB 565 formats. Luminance-only and
  28424. * luminance/alpha textures will also still work as expected.
  28425. *
  28426. * @type {?Texture}
  28427. * @default null
  28428. */
  28429. this.alphaMap = null;
  28430. /**
  28431. * The environment map.
  28432. *
  28433. * @type {?Texture}
  28434. * @default null
  28435. */
  28436. this.envMap = null;
  28437. /**
  28438. * The rotation of the environment map in radians.
  28439. *
  28440. * @type {Euler}
  28441. * @default (0,0,0)
  28442. */
  28443. this.envMapRotation = new Euler();
  28444. /**
  28445. * How to combine the result of the surface's color with the environment map, if any.
  28446. *
  28447. * When set to `MixOperation`, the {@link MeshBasicMaterial#reflectivity} is used to
  28448. * blend between the two colors.
  28449. *
  28450. * @type {(MultiplyOperation|MixOperation|AddOperation)}
  28451. * @default MultiplyOperation
  28452. */
  28453. this.combine = MultiplyOperation;
  28454. /**
  28455. * How much the environment map affects the surface.
  28456. * The valid range is between `0` (no reflections) and `1` (full reflections).
  28457. *
  28458. * @type {number}
  28459. * @default 1
  28460. */
  28461. this.reflectivity = 1;
  28462. /**
  28463. * Scales the effect of the environment map by multiplying its color.
  28464. *
  28465. * @type {number}
  28466. * @default 1
  28467. */
  28468. this.envMapIntensity = 1.0;
  28469. /**
  28470. * The index of refraction (IOR) of air (approximately 1) divided by the
  28471. * index of refraction of the material. It is used with environment mapping
  28472. * modes {@link CubeRefractionMapping} and {@link EquirectangularRefractionMapping}.
  28473. * The refraction ratio should not exceed `1`.
  28474. *
  28475. * @type {number}
  28476. * @default 0.98
  28477. */
  28478. this.refractionRatio = 0.98;
  28479. /**
  28480. * Renders the geometry as a wireframe.
  28481. *
  28482. * @type {boolean}
  28483. * @default false
  28484. */
  28485. this.wireframe = false;
  28486. /**
  28487. * Controls the thickness of the wireframe.
  28488. *
  28489. * Can only be used with {@link SVGRenderer}.
  28490. *
  28491. * @type {number}
  28492. * @default 1
  28493. */
  28494. this.wireframeLinewidth = 1;
  28495. /**
  28496. * Defines appearance of wireframe ends.
  28497. *
  28498. * Can only be used with {@link SVGRenderer}.
  28499. *
  28500. * @type {('round'|'bevel'|'miter')}
  28501. * @default 'round'
  28502. */
  28503. this.wireframeLinecap = 'round';
  28504. /**
  28505. * Defines appearance of wireframe joints.
  28506. *
  28507. * Can only be used with {@link SVGRenderer}.
  28508. *
  28509. * @type {('round'|'bevel'|'miter')}
  28510. * @default 'round'
  28511. */
  28512. this.wireframeLinejoin = 'round';
  28513. /**
  28514. * Whether the material is rendered with flat shading or not.
  28515. *
  28516. * @type {boolean}
  28517. * @default false
  28518. */
  28519. this.flatShading = false;
  28520. /**
  28521. * Whether the material is affected by fog or not.
  28522. *
  28523. * @type {boolean}
  28524. * @default true
  28525. */
  28526. this.fog = true;
  28527. this.setValues( parameters );
  28528. }
  28529. copy( source ) {
  28530. super.copy( source );
  28531. this.color.copy( source.color );
  28532. this.specular.copy( source.specular );
  28533. this.shininess = source.shininess;
  28534. this.map = source.map;
  28535. this.lightMap = source.lightMap;
  28536. this.lightMapIntensity = source.lightMapIntensity;
  28537. this.aoMap = source.aoMap;
  28538. this.aoMapIntensity = source.aoMapIntensity;
  28539. this.emissive.copy( source.emissive );
  28540. this.emissiveMap = source.emissiveMap;
  28541. this.emissiveIntensity = source.emissiveIntensity;
  28542. this.bumpMap = source.bumpMap;
  28543. this.bumpScale = source.bumpScale;
  28544. this.normalMap = source.normalMap;
  28545. this.normalMapType = source.normalMapType;
  28546. this.normalScale.copy( source.normalScale );
  28547. this.displacementMap = source.displacementMap;
  28548. this.displacementScale = source.displacementScale;
  28549. this.displacementBias = source.displacementBias;
  28550. this.specularMap = source.specularMap;
  28551. this.alphaMap = source.alphaMap;
  28552. this.envMap = source.envMap;
  28553. this.envMapRotation.copy( source.envMapRotation );
  28554. this.combine = source.combine;
  28555. this.reflectivity = source.reflectivity;
  28556. this.envMapIntensity = source.envMapIntensity;
  28557. this.refractionRatio = source.refractionRatio;
  28558. this.wireframe = source.wireframe;
  28559. this.wireframeLinewidth = source.wireframeLinewidth;
  28560. this.wireframeLinecap = source.wireframeLinecap;
  28561. this.wireframeLinejoin = source.wireframeLinejoin;
  28562. this.flatShading = source.flatShading;
  28563. this.fog = source.fog;
  28564. return this;
  28565. }
  28566. }
  28567. /**
  28568. * A material implementing toon shading.
  28569. *
  28570. * @augments Material
  28571. * @demo scenes/material-browser.html#MeshToonMaterial
  28572. */
  28573. class MeshToonMaterial extends Material {
  28574. /**
  28575. * Constructs a new mesh toon material.
  28576. *
  28577. * @param {Object} [parameters] - An object with one or more properties
  28578. * defining the material's appearance. Any property of the material
  28579. * (including any property from inherited materials) can be passed
  28580. * in here. Color values can be passed any type of value accepted
  28581. * by {@link Color#set}.
  28582. */
  28583. constructor( parameters ) {
  28584. super();
  28585. /**
  28586. * This flag can be used for type testing.
  28587. *
  28588. * @type {boolean}
  28589. * @readonly
  28590. * @default true
  28591. */
  28592. this.isMeshToonMaterial = true;
  28593. this.defines = { 'TOON': '' };
  28594. this.type = 'MeshToonMaterial';
  28595. /**
  28596. * Color of the material.
  28597. *
  28598. * @type {Color}
  28599. * @default (1,1,1)
  28600. */
  28601. this.color = new Color( 0xffffff );
  28602. /**
  28603. * The color map. May optionally include an alpha channel, typically combined
  28604. * with {@link Material#transparent} or {@link Material#alphaTest}. The texture map
  28605. * color is modulated by the diffuse `color`.
  28606. *
  28607. * @type {?Texture}
  28608. * @default null
  28609. */
  28610. this.map = null;
  28611. /**
  28612. * Gradient map for toon shading. It's required to set
  28613. * {@link Texture#minFilter} and {@link Texture#magFilter} to {@linkNearestFilter}
  28614. * when using this type of texture.
  28615. *
  28616. * @type {?Texture}
  28617. * @default null
  28618. */
  28619. this.gradientMap = null;
  28620. /**
  28621. * The light map. Requires a second set of UVs.
  28622. *
  28623. * @type {?Texture}
  28624. * @default null
  28625. */
  28626. this.lightMap = null;
  28627. /**
  28628. * Intensity of the baked light.
  28629. *
  28630. * @type {number}
  28631. * @default 1
  28632. */
  28633. this.lightMapIntensity = 1.0;
  28634. /**
  28635. * The red channel of this texture is used as the ambient occlusion map.
  28636. * Requires a second set of UVs.
  28637. *
  28638. * @type {?Texture}
  28639. * @default null
  28640. */
  28641. this.aoMap = null;
  28642. /**
  28643. * Intensity of the ambient occlusion effect. Range is `[0,1]`, where `0`
  28644. * disables ambient occlusion. Where intensity is `1` and the AO map's
  28645. * red channel is also `1`, ambient light is fully occluded on a surface.
  28646. *
  28647. * @type {number}
  28648. * @default 1
  28649. */
  28650. this.aoMapIntensity = 1.0;
  28651. /**
  28652. * Emissive (light) color of the material, essentially a solid color
  28653. * unaffected by other lighting.
  28654. *
  28655. * @type {Color}
  28656. * @default (0,0,0)
  28657. */
  28658. this.emissive = new Color( 0x000000 );
  28659. /**
  28660. * Intensity of the emissive light. Modulates the emissive color.
  28661. *
  28662. * @type {number}
  28663. * @default 1
  28664. */
  28665. this.emissiveIntensity = 1.0;
  28666. /**
  28667. * Set emissive (glow) map. The emissive map color is modulated by the
  28668. * emissive color and the emissive intensity. If you have an emissive map,
  28669. * be sure to set the emissive color to something other than black.
  28670. *
  28671. * @type {?Texture}
  28672. * @default null
  28673. */
  28674. this.emissiveMap = null;
  28675. /**
  28676. * The texture to create a bump map. The black and white values map to the
  28677. * perceived depth in relation to the lights. Bump doesn't actually affect
  28678. * the geometry of the object, only the lighting. If a normal map is defined
  28679. * this will be ignored.
  28680. *
  28681. * @type {?Texture}
  28682. * @default null
  28683. */
  28684. this.bumpMap = null;
  28685. /**
  28686. * How much the bump map affects the material. Typical range is `[0,1]`.
  28687. *
  28688. * @type {number}
  28689. * @default 1
  28690. */
  28691. this.bumpScale = 1;
  28692. /**
  28693. * The texture to create a normal map. The RGB values affect the surface
  28694. * normal for each pixel fragment and change the way the color is lit. Normal
  28695. * maps do not change the actual shape of the surface, only the lighting. In
  28696. * case the material has a normal map authored using the left handed
  28697. * convention, the `y` component of `normalScale` should be negated to compensate
  28698. * for the different handedness.
  28699. *
  28700. * @type {?Texture}
  28701. * @default null
  28702. */
  28703. this.normalMap = null;
  28704. /**
  28705. * The type of normal map.
  28706. *
  28707. * @type {(TangentSpaceNormalMap|ObjectSpaceNormalMap)}
  28708. * @default TangentSpaceNormalMap
  28709. */
  28710. this.normalMapType = TangentSpaceNormalMap;
  28711. /**
  28712. * How much the normal map affects the material. Typical value range is `[0,1]`.
  28713. *
  28714. * @type {Vector2}
  28715. * @default (1,1)
  28716. */
  28717. this.normalScale = new Vector2( 1, 1 );
  28718. /**
  28719. * The displacement map affects the position of the mesh's vertices. Unlike
  28720. * other maps which only affect the light and shade of the material the
  28721. * displaced vertices can cast shadows, block other objects, and otherwise
  28722. * act as real geometry. The displacement texture is an image where the value
  28723. * of each pixel (white being the highest) is mapped against, and
  28724. * repositions, the vertices of the mesh.
  28725. *
  28726. * @type {?Texture}
  28727. * @default null
  28728. */
  28729. this.displacementMap = null;
  28730. /**
  28731. * How much the displacement map affects the mesh (where black is no
  28732. * displacement, and white is maximum displacement). Without a displacement
  28733. * map set, this value is not applied.
  28734. *
  28735. * @type {number}
  28736. * @default 0
  28737. */
  28738. this.displacementScale = 1;
  28739. /**
  28740. * The offset of the displacement map's values on the mesh's vertices.
  28741. * The bias is added to the scaled sample of the displacement map.
  28742. * Without a displacement map set, this value is not applied.
  28743. *
  28744. * @type {number}
  28745. * @default 0
  28746. */
  28747. this.displacementBias = 0;
  28748. /**
  28749. * The alpha map is a grayscale texture that controls the opacity across the
  28750. * surface (black: fully transparent; white: fully opaque).
  28751. *
  28752. * Only the color of the texture is used, ignoring the alpha channel if one
  28753. * exists. For RGB and RGBA textures, the renderer will use the green channel
  28754. * when sampling this texture due to the extra bit of precision provided for
  28755. * green in DXT-compressed and uncompressed RGB 565 formats. Luminance-only and
  28756. * luminance/alpha textures will also still work as expected.
  28757. *
  28758. * @type {?Texture}
  28759. * @default null
  28760. */
  28761. this.alphaMap = null;
  28762. /**
  28763. * Renders the geometry as a wireframe.
  28764. *
  28765. * @type {boolean}
  28766. * @default false
  28767. */
  28768. this.wireframe = false;
  28769. /**
  28770. * Controls the thickness of the wireframe.
  28771. *
  28772. * Can only be used with {@link SVGRenderer}.
  28773. *
  28774. * @type {number}
  28775. * @default 1
  28776. */
  28777. this.wireframeLinewidth = 1;
  28778. /**
  28779. * Defines appearance of wireframe ends.
  28780. *
  28781. * Can only be used with {@link SVGRenderer}.
  28782. *
  28783. * @type {('round'|'bevel'|'miter')}
  28784. * @default 'round'
  28785. */
  28786. this.wireframeLinecap = 'round';
  28787. /**
  28788. * Defines appearance of wireframe joints.
  28789. *
  28790. * Can only be used with {@link SVGRenderer}.
  28791. *
  28792. * @type {('round'|'bevel'|'miter')}
  28793. * @default 'round'
  28794. */
  28795. this.wireframeLinejoin = 'round';
  28796. /**
  28797. * Whether the material is affected by fog or not.
  28798. *
  28799. * @type {boolean}
  28800. * @default true
  28801. */
  28802. this.fog = true;
  28803. this.setValues( parameters );
  28804. }
  28805. copy( source ) {
  28806. super.copy( source );
  28807. this.color.copy( source.color );
  28808. this.map = source.map;
  28809. this.gradientMap = source.gradientMap;
  28810. this.lightMap = source.lightMap;
  28811. this.lightMapIntensity = source.lightMapIntensity;
  28812. this.aoMap = source.aoMap;
  28813. this.aoMapIntensity = source.aoMapIntensity;
  28814. this.emissive.copy( source.emissive );
  28815. this.emissiveMap = source.emissiveMap;
  28816. this.emissiveIntensity = source.emissiveIntensity;
  28817. this.bumpMap = source.bumpMap;
  28818. this.bumpScale = source.bumpScale;
  28819. this.normalMap = source.normalMap;
  28820. this.normalMapType = source.normalMapType;
  28821. this.normalScale.copy( source.normalScale );
  28822. this.displacementMap = source.displacementMap;
  28823. this.displacementScale = source.displacementScale;
  28824. this.displacementBias = source.displacementBias;
  28825. this.alphaMap = source.alphaMap;
  28826. this.wireframe = source.wireframe;
  28827. this.wireframeLinewidth = source.wireframeLinewidth;
  28828. this.wireframeLinecap = source.wireframeLinecap;
  28829. this.wireframeLinejoin = source.wireframeLinejoin;
  28830. this.fog = source.fog;
  28831. return this;
  28832. }
  28833. }
  28834. /**
  28835. * A material that maps the normal vectors to RGB colors.
  28836. *
  28837. * @augments Material
  28838. * @demo scenes/material-browser.html#MeshNormalMaterial
  28839. */
  28840. class MeshNormalMaterial extends Material {
  28841. /**
  28842. * Constructs a new mesh normal material.
  28843. *
  28844. * @param {Object} [parameters] - An object with one or more properties
  28845. * defining the material's appearance. Any property of the material
  28846. * (including any property from inherited materials) can be passed
  28847. * in here. Color values can be passed any type of value accepted
  28848. * by {@link Color#set}.
  28849. */
  28850. constructor( parameters ) {
  28851. super();
  28852. /**
  28853. * This flag can be used for type testing.
  28854. *
  28855. * @type {boolean}
  28856. * @readonly
  28857. * @default true
  28858. */
  28859. this.isMeshNormalMaterial = true;
  28860. this.type = 'MeshNormalMaterial';
  28861. /**
  28862. * The texture to create a bump map. The black and white values map to the
  28863. * perceived depth in relation to the lights. Bump doesn't actually affect
  28864. * the geometry of the object, only the lighting. If a normal map is defined
  28865. * this will be ignored.
  28866. *
  28867. * @type {?Texture}
  28868. * @default null
  28869. */
  28870. this.bumpMap = null;
  28871. /**
  28872. * How much the bump map affects the material. Typical range is `[0,1]`.
  28873. *
  28874. * @type {number}
  28875. * @default 1
  28876. */
  28877. this.bumpScale = 1;
  28878. /**
  28879. * The texture to create a normal map. The RGB values affect the surface
  28880. * normal for each pixel fragment and change the way the color is lit. Normal
  28881. * maps do not change the actual shape of the surface, only the lighting. In
  28882. * case the material has a normal map authored using the left handed
  28883. * convention, the `y` component of `normalScale` should be negated to compensate
  28884. * for the different handedness.
  28885. *
  28886. * @type {?Texture}
  28887. * @default null
  28888. */
  28889. this.normalMap = null;
  28890. /**
  28891. * The type of normal map.
  28892. *
  28893. * @type {(TangentSpaceNormalMap|ObjectSpaceNormalMap)}
  28894. * @default TangentSpaceNormalMap
  28895. */
  28896. this.normalMapType = TangentSpaceNormalMap;
  28897. /**
  28898. * How much the normal map affects the material. Typical value range is `[0,1]`.
  28899. *
  28900. * @type {Vector2}
  28901. * @default (1,1)
  28902. */
  28903. this.normalScale = new Vector2( 1, 1 );
  28904. /**
  28905. * The displacement map affects the position of the mesh's vertices. Unlike
  28906. * other maps which only affect the light and shade of the material the
  28907. * displaced vertices can cast shadows, block other objects, and otherwise
  28908. * act as real geometry. The displacement texture is an image where the value
  28909. * of each pixel (white being the highest) is mapped against, and
  28910. * repositions, the vertices of the mesh.
  28911. *
  28912. * @type {?Texture}
  28913. * @default null
  28914. */
  28915. this.displacementMap = null;
  28916. /**
  28917. * How much the displacement map affects the mesh (where black is no
  28918. * displacement, and white is maximum displacement). Without a displacement
  28919. * map set, this value is not applied.
  28920. *
  28921. * @type {number}
  28922. * @default 0
  28923. */
  28924. this.displacementScale = 1;
  28925. /**
  28926. * The offset of the displacement map's values on the mesh's vertices.
  28927. * The bias is added to the scaled sample of the displacement map.
  28928. * Without a displacement map set, this value is not applied.
  28929. *
  28930. * @type {number}
  28931. * @default 0
  28932. */
  28933. this.displacementBias = 0;
  28934. /**
  28935. * Renders the geometry as a wireframe.
  28936. *
  28937. * @type {boolean}
  28938. * @default false
  28939. */
  28940. this.wireframe = false;
  28941. /**
  28942. * Controls the thickness of the wireframe.
  28943. *
  28944. * WebGL and WebGPU ignore this property and always render
  28945. * 1 pixel wide lines.
  28946. *
  28947. * @type {number}
  28948. * @default 1
  28949. */
  28950. this.wireframeLinewidth = 1;
  28951. /**
  28952. * Whether the material is rendered with flat shading or not.
  28953. *
  28954. * @type {boolean}
  28955. * @default false
  28956. */
  28957. this.flatShading = false;
  28958. this.setValues( parameters );
  28959. }
  28960. copy( source ) {
  28961. super.copy( source );
  28962. this.bumpMap = source.bumpMap;
  28963. this.bumpScale = source.bumpScale;
  28964. this.normalMap = source.normalMap;
  28965. this.normalMapType = source.normalMapType;
  28966. this.normalScale.copy( source.normalScale );
  28967. this.displacementMap = source.displacementMap;
  28968. this.displacementScale = source.displacementScale;
  28969. this.displacementBias = source.displacementBias;
  28970. this.wireframe = source.wireframe;
  28971. this.wireframeLinewidth = source.wireframeLinewidth;
  28972. this.flatShading = source.flatShading;
  28973. return this;
  28974. }
  28975. }
  28976. /**
  28977. * A material for non-shiny surfaces, without specular highlights.
  28978. *
  28979. * The material uses a non-physically based [Lambertian](https://en.wikipedia.org/wiki/Lambertian_reflectance)
  28980. * model for calculating reflectance. This can simulate some surfaces (such
  28981. * as untreated wood or stone) well, but cannot simulate shiny surfaces with
  28982. * specular highlights (such as varnished wood). `MeshLambertMaterial` uses per-fragment
  28983. * shading.
  28984. *
  28985. * Due to the simplicity of the reflectance and illumination models,
  28986. * performance will be greater when using this material over the
  28987. * {@link MeshPhongMaterial}, {@link MeshStandardMaterial} or
  28988. * {@link MeshPhysicalMaterial}, at the cost of some graphical accuracy.
  28989. *
  28990. * @augments Material
  28991. * @demo scenes/material-browser.html#MeshLambertMaterial
  28992. */
  28993. class MeshLambertMaterial extends Material {
  28994. /**
  28995. * Constructs a new mesh lambert material.
  28996. *
  28997. * @param {Object} [parameters] - An object with one or more properties
  28998. * defining the material's appearance. Any property of the material
  28999. * (including any property from inherited materials) can be passed
  29000. * in here. Color values can be passed any type of value accepted
  29001. * by {@link Color#set}.
  29002. */
  29003. constructor( parameters ) {
  29004. super();
  29005. /**
  29006. * This flag can be used for type testing.
  29007. *
  29008. * @type {boolean}
  29009. * @readonly
  29010. * @default true
  29011. */
  29012. this.isMeshLambertMaterial = true;
  29013. this.type = 'MeshLambertMaterial';
  29014. /**
  29015. * Color of the material.
  29016. *
  29017. * @type {Color}
  29018. * @default (1,1,1)
  29019. */
  29020. this.color = new Color( 0xffffff ); // diffuse
  29021. /**
  29022. * The color map. May optionally include an alpha channel, typically combined
  29023. * with {@link Material#transparent} or {@link Material#alphaTest}. The texture map
  29024. * color is modulated by the diffuse `color`.
  29025. *
  29026. * @type {?Texture}
  29027. * @default null
  29028. */
  29029. this.map = null;
  29030. /**
  29031. * The light map. Requires a second set of UVs.
  29032. *
  29033. * @type {?Texture}
  29034. * @default null
  29035. */
  29036. this.lightMap = null;
  29037. /**
  29038. * Intensity of the baked light.
  29039. *
  29040. * @type {number}
  29041. * @default 1
  29042. */
  29043. this.lightMapIntensity = 1.0;
  29044. /**
  29045. * The red channel of this texture is used as the ambient occlusion map.
  29046. * Requires a second set of UVs.
  29047. *
  29048. * @type {?Texture}
  29049. * @default null
  29050. */
  29051. this.aoMap = null;
  29052. /**
  29053. * Intensity of the ambient occlusion effect. Range is `[0,1]`, where `0`
  29054. * disables ambient occlusion. Where intensity is `1` and the AO map's
  29055. * red channel is also `1`, ambient light is fully occluded on a surface.
  29056. *
  29057. * @type {number}
  29058. * @default 1
  29059. */
  29060. this.aoMapIntensity = 1.0;
  29061. /**
  29062. * Emissive (light) color of the material, essentially a solid color
  29063. * unaffected by other lighting.
  29064. *
  29065. * @type {Color}
  29066. * @default (0,0,0)
  29067. */
  29068. this.emissive = new Color( 0x000000 );
  29069. /**
  29070. * Intensity of the emissive light. Modulates the emissive color.
  29071. *
  29072. * @type {number}
  29073. * @default 1
  29074. */
  29075. this.emissiveIntensity = 1.0;
  29076. /**
  29077. * Set emissive (glow) map. The emissive map color is modulated by the
  29078. * emissive color and the emissive intensity. If you have an emissive map,
  29079. * be sure to set the emissive color to something other than black.
  29080. *
  29081. * @type {?Texture}
  29082. * @default null
  29083. */
  29084. this.emissiveMap = null;
  29085. /**
  29086. * The texture to create a bump map. The black and white values map to the
  29087. * perceived depth in relation to the lights. Bump doesn't actually affect
  29088. * the geometry of the object, only the lighting. If a normal map is defined
  29089. * this will be ignored.
  29090. *
  29091. * @type {?Texture}
  29092. * @default null
  29093. */
  29094. this.bumpMap = null;
  29095. /**
  29096. * How much the bump map affects the material. Typical range is `[0,1]`.
  29097. *
  29098. * @type {number}
  29099. * @default 1
  29100. */
  29101. this.bumpScale = 1;
  29102. /**
  29103. * The texture to create a normal map. The RGB values affect the surface
  29104. * normal for each pixel fragment and change the way the color is lit. Normal
  29105. * maps do not change the actual shape of the surface, only the lighting. In
  29106. * case the material has a normal map authored using the left handed
  29107. * convention, the `y` component of `normalScale` should be negated to compensate
  29108. * for the different handedness.
  29109. *
  29110. * @type {?Texture}
  29111. * @default null
  29112. */
  29113. this.normalMap = null;
  29114. /**
  29115. * The type of normal map.
  29116. *
  29117. * @type {(TangentSpaceNormalMap|ObjectSpaceNormalMap)}
  29118. * @default TangentSpaceNormalMap
  29119. */
  29120. this.normalMapType = TangentSpaceNormalMap;
  29121. /**
  29122. * How much the normal map affects the material. Typical value range is `[0,1]`.
  29123. *
  29124. * @type {Vector2}
  29125. * @default (1,1)
  29126. */
  29127. this.normalScale = new Vector2( 1, 1 );
  29128. /**
  29129. * The displacement map affects the position of the mesh's vertices. Unlike
  29130. * other maps which only affect the light and shade of the material the
  29131. * displaced vertices can cast shadows, block other objects, and otherwise
  29132. * act as real geometry. The displacement texture is an image where the value
  29133. * of each pixel (white being the highest) is mapped against, and
  29134. * repositions, the vertices of the mesh.
  29135. *
  29136. * @type {?Texture}
  29137. * @default null
  29138. */
  29139. this.displacementMap = null;
  29140. /**
  29141. * How much the displacement map affects the mesh (where black is no
  29142. * displacement, and white is maximum displacement). Without a displacement
  29143. * map set, this value is not applied.
  29144. *
  29145. * @type {number}
  29146. * @default 0
  29147. */
  29148. this.displacementScale = 1;
  29149. /**
  29150. * The offset of the displacement map's values on the mesh's vertices.
  29151. * The bias is added to the scaled sample of the displacement map.
  29152. * Without a displacement map set, this value is not applied.
  29153. *
  29154. * @type {number}
  29155. * @default 0
  29156. */
  29157. this.displacementBias = 0;
  29158. /**
  29159. * Specular map used by the material.
  29160. *
  29161. * @type {?Texture}
  29162. * @default null
  29163. */
  29164. this.specularMap = null;
  29165. /**
  29166. * The alpha map is a grayscale texture that controls the opacity across the
  29167. * surface (black: fully transparent; white: fully opaque).
  29168. *
  29169. * Only the color of the texture is used, ignoring the alpha channel if one
  29170. * exists. For RGB and RGBA textures, the renderer will use the green channel
  29171. * when sampling this texture due to the extra bit of precision provided for
  29172. * green in DXT-compressed and uncompressed RGB 565 formats. Luminance-only and
  29173. * luminance/alpha textures will also still work as expected.
  29174. *
  29175. * @type {?Texture}
  29176. * @default null
  29177. */
  29178. this.alphaMap = null;
  29179. /**
  29180. * The environment map.
  29181. *
  29182. * @type {?Texture}
  29183. * @default null
  29184. */
  29185. this.envMap = null;
  29186. /**
  29187. * The rotation of the environment map in radians.
  29188. *
  29189. * @type {Euler}
  29190. * @default (0,0,0)
  29191. */
  29192. this.envMapRotation = new Euler();
  29193. /**
  29194. * How to combine the result of the surface's color with the environment map, if any.
  29195. *
  29196. * When set to `MixOperation`, the {@link MeshBasicMaterial#reflectivity} is used to
  29197. * blend between the two colors.
  29198. *
  29199. * @type {(MultiplyOperation|MixOperation|AddOperation)}
  29200. * @default MultiplyOperation
  29201. */
  29202. this.combine = MultiplyOperation;
  29203. /**
  29204. * How much the environment map affects the surface.
  29205. * The valid range is between `0` (no reflections) and `1` (full reflections).
  29206. *
  29207. * @type {number}
  29208. * @default 1
  29209. */
  29210. this.reflectivity = 1;
  29211. /**
  29212. * Scales the effect of the environment map by multiplying its color.
  29213. *
  29214. * @type {number}
  29215. * @default 1
  29216. */
  29217. this.envMapIntensity = 1.0;
  29218. /**
  29219. * The index of refraction (IOR) of air (approximately 1) divided by the
  29220. * index of refraction of the material. It is used with environment mapping
  29221. * modes {@link CubeRefractionMapping} and {@link EquirectangularRefractionMapping}.
  29222. * The refraction ratio should not exceed `1`.
  29223. *
  29224. * @type {number}
  29225. * @default 0.98
  29226. */
  29227. this.refractionRatio = 0.98;
  29228. /**
  29229. * Renders the geometry as a wireframe.
  29230. *
  29231. * @type {boolean}
  29232. * @default false
  29233. */
  29234. this.wireframe = false;
  29235. /**
  29236. * Controls the thickness of the wireframe.
  29237. *
  29238. * Can only be used with {@link SVGRenderer}.
  29239. *
  29240. * @type {number}
  29241. * @default 1
  29242. */
  29243. this.wireframeLinewidth = 1;
  29244. /**
  29245. * Defines appearance of wireframe ends.
  29246. *
  29247. * Can only be used with {@link SVGRenderer}.
  29248. *
  29249. * @type {('round'|'bevel'|'miter')}
  29250. * @default 'round'
  29251. */
  29252. this.wireframeLinecap = 'round';
  29253. /**
  29254. * Defines appearance of wireframe joints.
  29255. *
  29256. * Can only be used with {@link SVGRenderer}.
  29257. *
  29258. * @type {('round'|'bevel'|'miter')}
  29259. * @default 'round'
  29260. */
  29261. this.wireframeLinejoin = 'round';
  29262. /**
  29263. * Whether the material is rendered with flat shading or not.
  29264. *
  29265. * @type {boolean}
  29266. * @default false
  29267. */
  29268. this.flatShading = false;
  29269. /**
  29270. * Whether the material is affected by fog or not.
  29271. *
  29272. * @type {boolean}
  29273. * @default true
  29274. */
  29275. this.fog = true;
  29276. this.setValues( parameters );
  29277. }
  29278. copy( source ) {
  29279. super.copy( source );
  29280. this.color.copy( source.color );
  29281. this.map = source.map;
  29282. this.lightMap = source.lightMap;
  29283. this.lightMapIntensity = source.lightMapIntensity;
  29284. this.aoMap = source.aoMap;
  29285. this.aoMapIntensity = source.aoMapIntensity;
  29286. this.emissive.copy( source.emissive );
  29287. this.emissiveMap = source.emissiveMap;
  29288. this.emissiveIntensity = source.emissiveIntensity;
  29289. this.bumpMap = source.bumpMap;
  29290. this.bumpScale = source.bumpScale;
  29291. this.normalMap = source.normalMap;
  29292. this.normalMapType = source.normalMapType;
  29293. this.normalScale.copy( source.normalScale );
  29294. this.displacementMap = source.displacementMap;
  29295. this.displacementScale = source.displacementScale;
  29296. this.displacementBias = source.displacementBias;
  29297. this.specularMap = source.specularMap;
  29298. this.alphaMap = source.alphaMap;
  29299. this.envMap = source.envMap;
  29300. this.envMapRotation.copy( source.envMapRotation );
  29301. this.combine = source.combine;
  29302. this.reflectivity = source.reflectivity;
  29303. this.envMapIntensity = source.envMapIntensity;
  29304. this.refractionRatio = source.refractionRatio;
  29305. this.wireframe = source.wireframe;
  29306. this.wireframeLinewidth = source.wireframeLinewidth;
  29307. this.wireframeLinecap = source.wireframeLinecap;
  29308. this.wireframeLinejoin = source.wireframeLinejoin;
  29309. this.flatShading = source.flatShading;
  29310. this.fog = source.fog;
  29311. return this;
  29312. }
  29313. }
  29314. /**
  29315. * A material for drawing geometry by depth. Depth is based off of the camera
  29316. * near and far plane. White is nearest, black is farthest.
  29317. *
  29318. * @augments Material
  29319. * @demo scenes/material-browser.html#MeshDepthMaterial
  29320. */
  29321. class MeshDepthMaterial extends Material {
  29322. /**
  29323. * Constructs a new mesh depth material.
  29324. *
  29325. * @param {Object} [parameters] - An object with one or more properties
  29326. * defining the material's appearance. Any property of the material
  29327. * (including any property from inherited materials) can be passed
  29328. * in here. Color values can be passed any type of value accepted
  29329. * by {@link Color#set}.
  29330. */
  29331. constructor( parameters ) {
  29332. super();
  29333. /**
  29334. * This flag can be used for type testing.
  29335. *
  29336. * @type {boolean}
  29337. * @readonly
  29338. * @default true
  29339. */
  29340. this.isMeshDepthMaterial = true;
  29341. this.type = 'MeshDepthMaterial';
  29342. /**
  29343. * Type for depth packing.
  29344. *
  29345. * @type {(BasicDepthPacking|RGBADepthPacking|RGBDepthPacking|RGDepthPacking)}
  29346. * @default BasicDepthPacking
  29347. */
  29348. this.depthPacking = BasicDepthPacking;
  29349. /**
  29350. * The color map. May optionally include an alpha channel, typically combined
  29351. * with {@link Material#transparent} or {@link Material#alphaTest}.
  29352. *
  29353. * @type {?Texture}
  29354. * @default null
  29355. */
  29356. this.map = null;
  29357. /**
  29358. * The alpha map is a grayscale texture that controls the opacity across the
  29359. * surface (black: fully transparent; white: fully opaque).
  29360. *
  29361. * Only the color of the texture is used, ignoring the alpha channel if one
  29362. * exists. For RGB and RGBA textures, the renderer will use the green channel
  29363. * when sampling this texture due to the extra bit of precision provided for
  29364. * green in DXT-compressed and uncompressed RGB 565 formats. Luminance-only and
  29365. * luminance/alpha textures will also still work as expected.
  29366. *
  29367. * @type {?Texture}
  29368. * @default null
  29369. */
  29370. this.alphaMap = null;
  29371. /**
  29372. * The displacement map affects the position of the mesh's vertices. Unlike
  29373. * other maps which only affect the light and shade of the material the
  29374. * displaced vertices can cast shadows, block other objects, and otherwise
  29375. * act as real geometry. The displacement texture is an image where the value
  29376. * of each pixel (white being the highest) is mapped against, and
  29377. * repositions, the vertices of the mesh.
  29378. *
  29379. * @type {?Texture}
  29380. * @default null
  29381. */
  29382. this.displacementMap = null;
  29383. /**
  29384. * How much the displacement map affects the mesh (where black is no
  29385. * displacement, and white is maximum displacement). Without a displacement
  29386. * map set, this value is not applied.
  29387. *
  29388. * @type {number}
  29389. * @default 0
  29390. */
  29391. this.displacementScale = 1;
  29392. /**
  29393. * The offset of the displacement map's values on the mesh's vertices.
  29394. * The bias is added to the scaled sample of the displacement map.
  29395. * Without a displacement map set, this value is not applied.
  29396. *
  29397. * @type {number}
  29398. * @default 0
  29399. */
  29400. this.displacementBias = 0;
  29401. /**
  29402. * Renders the geometry as a wireframe.
  29403. *
  29404. * @type {boolean}
  29405. * @default false
  29406. */
  29407. this.wireframe = false;
  29408. /**
  29409. * Controls the thickness of the wireframe.
  29410. *
  29411. * WebGL and WebGPU ignore this property and always render
  29412. * 1 pixel wide lines.
  29413. *
  29414. * @type {number}
  29415. * @default 1
  29416. */
  29417. this.wireframeLinewidth = 1;
  29418. this.setValues( parameters );
  29419. }
  29420. copy( source ) {
  29421. super.copy( source );
  29422. this.depthPacking = source.depthPacking;
  29423. this.map = source.map;
  29424. this.alphaMap = source.alphaMap;
  29425. this.displacementMap = source.displacementMap;
  29426. this.displacementScale = source.displacementScale;
  29427. this.displacementBias = source.displacementBias;
  29428. this.wireframe = source.wireframe;
  29429. this.wireframeLinewidth = source.wireframeLinewidth;
  29430. return this;
  29431. }
  29432. }
  29433. /**
  29434. * A material used internally for implementing shadow mapping with
  29435. * point lights.
  29436. *
  29437. * Can also be used to customize the shadow casting of an object by assigning
  29438. * an instance of `MeshDistanceMaterial` to {@link Object3D#customDistanceMaterial}.
  29439. * The following examples demonstrates this approach in order to ensure
  29440. * transparent parts of objects do not cast shadows.
  29441. *
  29442. * @augments Material
  29443. */
  29444. class MeshDistanceMaterial extends Material {
  29445. /**
  29446. * Constructs a new mesh distance material.
  29447. *
  29448. * @param {Object} [parameters] - An object with one or more properties
  29449. * defining the material's appearance. Any property of the material
  29450. * (including any property from inherited materials) can be passed
  29451. * in here. Color values can be passed any type of value accepted
  29452. * by {@link Color#set}.
  29453. */
  29454. constructor( parameters ) {
  29455. super();
  29456. /**
  29457. * This flag can be used for type testing.
  29458. *
  29459. * @type {boolean}
  29460. * @readonly
  29461. * @default true
  29462. */
  29463. this.isMeshDistanceMaterial = true;
  29464. this.type = 'MeshDistanceMaterial';
  29465. /**
  29466. * The color map. May optionally include an alpha channel, typically combined
  29467. * with {@link Material#transparent} or {@link Material#alphaTest}.
  29468. *
  29469. * @type {?Texture}
  29470. * @default null
  29471. */
  29472. this.map = null;
  29473. /**
  29474. * The alpha map is a grayscale texture that controls the opacity across the
  29475. * surface (black: fully transparent; white: fully opaque).
  29476. *
  29477. * Only the color of the texture is used, ignoring the alpha channel if one
  29478. * exists. For RGB and RGBA textures, the renderer will use the green channel
  29479. * when sampling this texture due to the extra bit of precision provided for
  29480. * green in DXT-compressed and uncompressed RGB 565 formats. Luminance-only and
  29481. * luminance/alpha textures will also still work as expected.
  29482. *
  29483. * @type {?Texture}
  29484. * @default null
  29485. */
  29486. this.alphaMap = null;
  29487. /**
  29488. * The displacement map affects the position of the mesh's vertices. Unlike
  29489. * other maps which only affect the light and shade of the material the
  29490. * displaced vertices can cast shadows, block other objects, and otherwise
  29491. * act as real geometry. The displacement texture is an image where the value
  29492. * of each pixel (white being the highest) is mapped against, and
  29493. * repositions, the vertices of the mesh.
  29494. *
  29495. * @type {?Texture}
  29496. * @default null
  29497. */
  29498. this.displacementMap = null;
  29499. /**
  29500. * How much the displacement map affects the mesh (where black is no
  29501. * displacement, and white is maximum displacement). Without a displacement
  29502. * map set, this value is not applied.
  29503. *
  29504. * @type {number}
  29505. * @default 0
  29506. */
  29507. this.displacementScale = 1;
  29508. /**
  29509. * The offset of the displacement map's values on the mesh's vertices.
  29510. * The bias is added to the scaled sample of the displacement map.
  29511. * Without a displacement map set, this value is not applied.
  29512. *
  29513. * @type {number}
  29514. * @default 0
  29515. */
  29516. this.displacementBias = 0;
  29517. this.setValues( parameters );
  29518. }
  29519. copy( source ) {
  29520. super.copy( source );
  29521. this.map = source.map;
  29522. this.alphaMap = source.alphaMap;
  29523. this.displacementMap = source.displacementMap;
  29524. this.displacementScale = source.displacementScale;
  29525. this.displacementBias = source.displacementBias;
  29526. return this;
  29527. }
  29528. }
  29529. /**
  29530. * This material is defined by a MatCap (or Lit Sphere) texture, which encodes the
  29531. * material color and shading.
  29532. *
  29533. * `MeshMatcapMaterial` does not respond to lights since the matcap image file encodes
  29534. * baked lighting. It will cast a shadow onto an object that receives shadows
  29535. * (and shadow clipping works), but it will not self-shadow or receive
  29536. * shadows.
  29537. *
  29538. * @augments Material
  29539. * @demo scenes/material-browser.html#MeshMatcapMaterial
  29540. */
  29541. class MeshMatcapMaterial extends Material {
  29542. /**
  29543. * Constructs a new mesh matcap material.
  29544. *
  29545. * @param {Object} [parameters] - An object with one or more properties
  29546. * defining the material's appearance. Any property of the material
  29547. * (including any property from inherited materials) can be passed
  29548. * in here. Color values can be passed any type of value accepted
  29549. * by {@link Color#set}.
  29550. */
  29551. constructor( parameters ) {
  29552. super();
  29553. /**
  29554. * This flag can be used for type testing.
  29555. *
  29556. * @type {boolean}
  29557. * @readonly
  29558. * @default true
  29559. */
  29560. this.isMeshMatcapMaterial = true;
  29561. this.defines = { 'MATCAP': '' };
  29562. this.type = 'MeshMatcapMaterial';
  29563. /**
  29564. * Color of the material.
  29565. *
  29566. * @type {Color}
  29567. * @default (1,1,1)
  29568. */
  29569. this.color = new Color( 0xffffff ); // diffuse
  29570. /**
  29571. * The matcap map.
  29572. *
  29573. * @type {?Texture}
  29574. * @default null
  29575. */
  29576. this.matcap = null;
  29577. /**
  29578. * The color map. May optionally include an alpha channel, typically combined
  29579. * with {@link Material#transparent} or {@link Material#alphaTest}. The texture map
  29580. * color is modulated by the diffuse `color`.
  29581. *
  29582. * @type {?Texture}
  29583. * @default null
  29584. */
  29585. this.map = null;
  29586. /**
  29587. * The texture to create a bump map. The black and white values map to the
  29588. * perceived depth in relation to the lights. Bump doesn't actually affect
  29589. * the geometry of the object, only the lighting. If a normal map is defined
  29590. * this will be ignored.
  29591. *
  29592. * @type {?Texture}
  29593. * @default null
  29594. */
  29595. this.bumpMap = null;
  29596. /**
  29597. * How much the bump map affects the material. Typical range is `[0,1]`.
  29598. *
  29599. * @type {number}
  29600. * @default 1
  29601. */
  29602. this.bumpScale = 1;
  29603. /**
  29604. * The texture to create a normal map. The RGB values affect the surface
  29605. * normal for each pixel fragment and change the way the color is lit. Normal
  29606. * maps do not change the actual shape of the surface, only the lighting. In
  29607. * case the material has a normal map authored using the left handed
  29608. * convention, the `y` component of `normalScale` should be negated to compensate
  29609. * for the different handedness.
  29610. *
  29611. * @type {?Texture}
  29612. * @default null
  29613. */
  29614. this.normalMap = null;
  29615. /**
  29616. * The type of normal map.
  29617. *
  29618. * @type {(TangentSpaceNormalMap|ObjectSpaceNormalMap)}
  29619. * @default TangentSpaceNormalMap
  29620. */
  29621. this.normalMapType = TangentSpaceNormalMap;
  29622. /**
  29623. * How much the normal map affects the material. Typical value range is `[0,1]`.
  29624. *
  29625. * @type {Vector2}
  29626. * @default (1,1)
  29627. */
  29628. this.normalScale = new Vector2( 1, 1 );
  29629. /**
  29630. * The displacement map affects the position of the mesh's vertices. Unlike
  29631. * other maps which only affect the light and shade of the material the
  29632. * displaced vertices can cast shadows, block other objects, and otherwise
  29633. * act as real geometry. The displacement texture is an image where the value
  29634. * of each pixel (white being the highest) is mapped against, and
  29635. * repositions, the vertices of the mesh.
  29636. *
  29637. * @type {?Texture}
  29638. * @default null
  29639. */
  29640. this.displacementMap = null;
  29641. /**
  29642. * How much the displacement map affects the mesh (where black is no
  29643. * displacement, and white is maximum displacement). Without a displacement
  29644. * map set, this value is not applied.
  29645. *
  29646. * @type {number}
  29647. * @default 0
  29648. */
  29649. this.displacementScale = 1;
  29650. /**
  29651. * The offset of the displacement map's values on the mesh's vertices.
  29652. * The bias is added to the scaled sample of the displacement map.
  29653. * Without a displacement map set, this value is not applied.
  29654. *
  29655. * @type {number}
  29656. * @default 0
  29657. */
  29658. this.displacementBias = 0;
  29659. /**
  29660. * The alpha map is a grayscale texture that controls the opacity across the
  29661. * surface (black: fully transparent; white: fully opaque).
  29662. *
  29663. * Only the color of the texture is used, ignoring the alpha channel if one
  29664. * exists. For RGB and RGBA textures, the renderer will use the green channel
  29665. * when sampling this texture due to the extra bit of precision provided for
  29666. * green in DXT-compressed and uncompressed RGB 565 formats. Luminance-only and
  29667. * luminance/alpha textures will also still work as expected.
  29668. *
  29669. * @type {?Texture}
  29670. * @default null
  29671. */
  29672. this.alphaMap = null;
  29673. /**
  29674. * Renders the geometry as a wireframe.
  29675. *
  29676. * @type {boolean}
  29677. * @default false
  29678. */
  29679. this.wireframe = false;
  29680. /**
  29681. * Controls the thickness of the wireframe.
  29682. *
  29683. * Can only be used with {@link SVGRenderer}.
  29684. *
  29685. * @type {number}
  29686. * @default 1
  29687. */
  29688. this.wireframeLinewidth = 1;
  29689. /**
  29690. * Whether the material is rendered with flat shading or not.
  29691. *
  29692. * @type {boolean}
  29693. * @default false
  29694. */
  29695. this.flatShading = false;
  29696. /**
  29697. * Whether the material is affected by fog or not.
  29698. *
  29699. * @type {boolean}
  29700. * @default true
  29701. */
  29702. this.fog = true;
  29703. this.setValues( parameters );
  29704. }
  29705. copy( source ) {
  29706. super.copy( source );
  29707. this.defines = { 'MATCAP': '' };
  29708. this.color.copy( source.color );
  29709. this.matcap = source.matcap;
  29710. this.map = source.map;
  29711. this.bumpMap = source.bumpMap;
  29712. this.bumpScale = source.bumpScale;
  29713. this.normalMap = source.normalMap;
  29714. this.normalMapType = source.normalMapType;
  29715. this.normalScale.copy( source.normalScale );
  29716. this.displacementMap = source.displacementMap;
  29717. this.displacementScale = source.displacementScale;
  29718. this.displacementBias = source.displacementBias;
  29719. this.alphaMap = source.alphaMap;
  29720. this.wireframe = source.wireframe;
  29721. this.wireframeLinewidth = source.wireframeLinewidth;
  29722. this.flatShading = source.flatShading;
  29723. this.fog = source.fog;
  29724. return this;
  29725. }
  29726. }
  29727. /**
  29728. * A material for rendering line primitives.
  29729. *
  29730. * Materials define the appearance of renderable 3D objects.
  29731. *
  29732. * ```js
  29733. * const material = new THREE.LineDashedMaterial( {
  29734. * color: 0xffffff,
  29735. * scale: 1,
  29736. * dashSize: 3,
  29737. * gapSize: 1,
  29738. * } );
  29739. * ```
  29740. *
  29741. * @augments LineBasicMaterial
  29742. */
  29743. class LineDashedMaterial extends LineBasicMaterial {
  29744. /**
  29745. * Constructs a new line dashed material.
  29746. *
  29747. * @param {Object} [parameters] - An object with one or more properties
  29748. * defining the material's appearance. Any property of the material
  29749. * (including any property from inherited materials) can be passed
  29750. * in here. Color values can be passed any type of value accepted
  29751. * by {@link Color#set}.
  29752. */
  29753. constructor( parameters ) {
  29754. super();
  29755. /**
  29756. * This flag can be used for type testing.
  29757. *
  29758. * @type {boolean}
  29759. * @readonly
  29760. * @default true
  29761. */
  29762. this.isLineDashedMaterial = true;
  29763. this.type = 'LineDashedMaterial';
  29764. /**
  29765. * The scale of the dashed part of a line.
  29766. *
  29767. * @type {number}
  29768. * @default 1
  29769. */
  29770. this.scale = 1;
  29771. /**
  29772. * The size of the dash. This is both the gap with the stroke.
  29773. *
  29774. * @type {number}
  29775. * @default 3
  29776. */
  29777. this.dashSize = 3;
  29778. /**
  29779. * The size of the gap.
  29780. *
  29781. * @type {number}
  29782. * @default 1
  29783. */
  29784. this.gapSize = 1;
  29785. this.setValues( parameters );
  29786. }
  29787. copy( source ) {
  29788. super.copy( source );
  29789. this.scale = source.scale;
  29790. this.dashSize = source.dashSize;
  29791. this.gapSize = source.gapSize;
  29792. return this;
  29793. }
  29794. }
  29795. /**
  29796. * Converts an array to a specific type.
  29797. *
  29798. * @param {TypedArray|Array} array - The array to convert.
  29799. * @param {TypedArray.constructor} type - The constructor of a typed array that defines the new type.
  29800. * @return {TypedArray} The converted array.
  29801. */
  29802. function convertArray( array, type ) {
  29803. if ( ! array || array.constructor === type ) return array;
  29804. if ( typeof type.BYTES_PER_ELEMENT === 'number' ) {
  29805. return new type( array ); // create typed array
  29806. }
  29807. return Array.prototype.slice.call( array ); // create Array
  29808. }
  29809. /**
  29810. * Returns an array by which times and values can be sorted.
  29811. *
  29812. * @param {Array<number>} times - The keyframe time values.
  29813. * @return {Array<number>} The array.
  29814. */
  29815. function getKeyframeOrder( times ) {
  29816. function compareTime( i, j ) {
  29817. return times[ i ] - times[ j ];
  29818. }
  29819. const n = times.length;
  29820. const result = new Array( n );
  29821. for ( let i = 0; i !== n; ++ i ) result[ i ] = i;
  29822. result.sort( compareTime );
  29823. return result;
  29824. }
  29825. /**
  29826. * Sorts the given array by the previously computed order via `getKeyframeOrder()`.
  29827. *
  29828. * @param {Array<number>} values - The values to sort.
  29829. * @param {number} stride - The stride.
  29830. * @param {Array<number>} order - The sort order.
  29831. * @return {Array<number>} The sorted values.
  29832. */
  29833. function sortedArray( values, stride, order ) {
  29834. const nValues = values.length;
  29835. const result = new values.constructor( nValues );
  29836. for ( let i = 0, dstOffset = 0; dstOffset !== nValues; ++ i ) {
  29837. const srcOffset = order[ i ] * stride;
  29838. for ( let j = 0; j !== stride; ++ j ) {
  29839. result[ dstOffset ++ ] = values[ srcOffset + j ];
  29840. }
  29841. }
  29842. return result;
  29843. }
  29844. /**
  29845. * Used for parsing AOS keyframe formats.
  29846. *
  29847. * @param {Array<number>} jsonKeys - A list of JSON keyframes.
  29848. * @param {Array<number>} times - This array will be filled with keyframe times by this function.
  29849. * @param {Array<number>} values - This array will be filled with keyframe values by this function.
  29850. * @param {string} valuePropertyName - The name of the property to use.
  29851. */
  29852. function flattenJSON( jsonKeys, times, values, valuePropertyName ) {
  29853. let i = 1, key = jsonKeys[ 0 ];
  29854. while ( key !== undefined && key[ valuePropertyName ] === undefined ) {
  29855. key = jsonKeys[ i ++ ];
  29856. }
  29857. if ( key === undefined ) return; // no data
  29858. let value = key[ valuePropertyName ];
  29859. if ( value === undefined ) return; // no data
  29860. if ( Array.isArray( value ) ) {
  29861. do {
  29862. value = key[ valuePropertyName ];
  29863. if ( value !== undefined ) {
  29864. times.push( key.time );
  29865. values.push( ...value ); // push all elements
  29866. }
  29867. key = jsonKeys[ i ++ ];
  29868. } while ( key !== undefined );
  29869. } else if ( value.toArray !== undefined ) {
  29870. // ...assume THREE.Math-ish
  29871. do {
  29872. value = key[ valuePropertyName ];
  29873. if ( value !== undefined ) {
  29874. times.push( key.time );
  29875. value.toArray( values, values.length );
  29876. }
  29877. key = jsonKeys[ i ++ ];
  29878. } while ( key !== undefined );
  29879. } else {
  29880. // otherwise push as-is
  29881. do {
  29882. value = key[ valuePropertyName ];
  29883. if ( value !== undefined ) {
  29884. times.push( key.time );
  29885. values.push( value );
  29886. }
  29887. key = jsonKeys[ i ++ ];
  29888. } while ( key !== undefined );
  29889. }
  29890. }
  29891. /**
  29892. * Creates a new clip, containing only the segment of the original clip between the given frames.
  29893. *
  29894. * @param {AnimationClip} sourceClip - The values to sort.
  29895. * @param {string} name - The name of the clip.
  29896. * @param {number} startFrame - The start frame.
  29897. * @param {number} endFrame - The end frame.
  29898. * @param {number} [fps=30] - The FPS.
  29899. * @return {AnimationClip} The new sub clip.
  29900. */
  29901. function subclip( sourceClip, name, startFrame, endFrame, fps = 30 ) {
  29902. const clip = sourceClip.clone();
  29903. clip.name = name;
  29904. const tracks = [];
  29905. for ( let i = 0; i < clip.tracks.length; ++ i ) {
  29906. const track = clip.tracks[ i ];
  29907. const valueSize = track.getValueSize();
  29908. const times = [];
  29909. const values = [];
  29910. for ( let j = 0; j < track.times.length; ++ j ) {
  29911. const frame = track.times[ j ] * fps;
  29912. if ( frame < startFrame || frame >= endFrame ) continue;
  29913. times.push( track.times[ j ] );
  29914. for ( let k = 0; k < valueSize; ++ k ) {
  29915. values.push( track.values[ j * valueSize + k ] );
  29916. }
  29917. }
  29918. if ( times.length === 0 ) continue;
  29919. track.times = convertArray( times, track.times.constructor );
  29920. track.values = convertArray( values, track.values.constructor );
  29921. tracks.push( track );
  29922. }
  29923. clip.tracks = tracks;
  29924. // find minimum .times value across all tracks in the trimmed clip
  29925. let minStartTime = Infinity;
  29926. for ( let i = 0; i < clip.tracks.length; ++ i ) {
  29927. if ( minStartTime > clip.tracks[ i ].times[ 0 ] ) {
  29928. minStartTime = clip.tracks[ i ].times[ 0 ];
  29929. }
  29930. }
  29931. // shift all tracks such that clip begins at t=0
  29932. for ( let i = 0; i < clip.tracks.length; ++ i ) {
  29933. clip.tracks[ i ].shift( -1 * minStartTime );
  29934. }
  29935. clip.resetDuration();
  29936. return clip;
  29937. }
  29938. /**
  29939. * Converts the keyframes of the given animation clip to an additive format.
  29940. *
  29941. * @param {AnimationClip} targetClip - The clip to make additive.
  29942. * @param {number} [referenceFrame=0] - The reference frame.
  29943. * @param {AnimationClip} [referenceClip=targetClip] - The reference clip.
  29944. * @param {number} [fps=30] - The FPS.
  29945. * @return {AnimationClip} The updated clip which is now additive.
  29946. */
  29947. function makeClipAdditive( targetClip, referenceFrame = 0, referenceClip = targetClip, fps = 30 ) {
  29948. if ( fps <= 0 ) fps = 30;
  29949. const numTracks = referenceClip.tracks.length;
  29950. const referenceTime = referenceFrame / fps;
  29951. // Make each track's values relative to the values at the reference frame
  29952. for ( let i = 0; i < numTracks; ++ i ) {
  29953. const referenceTrack = referenceClip.tracks[ i ];
  29954. const referenceTrackType = referenceTrack.ValueTypeName;
  29955. // Skip this track if it's non-numeric
  29956. if ( referenceTrackType === 'bool' || referenceTrackType === 'string' ) continue;
  29957. // Find the track in the target clip whose name and type matches the reference track
  29958. const targetTrack = targetClip.tracks.find( function ( track ) {
  29959. return track.name === referenceTrack.name
  29960. && track.ValueTypeName === referenceTrackType;
  29961. } );
  29962. if ( targetTrack === undefined ) continue;
  29963. let referenceOffset = 0;
  29964. const referenceValueSize = referenceTrack.getValueSize();
  29965. if ( referenceTrack.createInterpolant.isInterpolantFactoryMethodGLTFCubicSpline ) {
  29966. referenceOffset = referenceValueSize / 3;
  29967. }
  29968. let targetOffset = 0;
  29969. const targetValueSize = targetTrack.getValueSize();
  29970. if ( targetTrack.createInterpolant.isInterpolantFactoryMethodGLTFCubicSpline ) {
  29971. targetOffset = targetValueSize / 3;
  29972. }
  29973. const lastIndex = referenceTrack.times.length - 1;
  29974. let referenceValue;
  29975. // Find the value to subtract out of the track
  29976. if ( referenceTime <= referenceTrack.times[ 0 ] ) {
  29977. // Reference frame is earlier than the first keyframe, so just use the first keyframe
  29978. const startIndex = referenceOffset;
  29979. const endIndex = referenceValueSize - referenceOffset;
  29980. referenceValue = referenceTrack.values.slice( startIndex, endIndex );
  29981. } else if ( referenceTime >= referenceTrack.times[ lastIndex ] ) {
  29982. // Reference frame is after the last keyframe, so just use the last keyframe
  29983. const startIndex = lastIndex * referenceValueSize + referenceOffset;
  29984. const endIndex = startIndex + referenceValueSize - referenceOffset;
  29985. referenceValue = referenceTrack.values.slice( startIndex, endIndex );
  29986. } else {
  29987. // Interpolate to the reference value
  29988. const interpolant = referenceTrack.createInterpolant();
  29989. const startIndex = referenceOffset;
  29990. const endIndex = referenceValueSize - referenceOffset;
  29991. interpolant.evaluate( referenceTime );
  29992. referenceValue = interpolant.resultBuffer.slice( startIndex, endIndex );
  29993. }
  29994. // Conjugate the quaternion
  29995. if ( referenceTrackType === 'quaternion' ) {
  29996. const referenceQuat = new Quaternion().fromArray( referenceValue ).normalize().conjugate();
  29997. referenceQuat.toArray( referenceValue );
  29998. }
  29999. // Subtract the reference value from all of the track values
  30000. const numTimes = targetTrack.times.length;
  30001. for ( let j = 0; j < numTimes; ++ j ) {
  30002. const valueStart = j * targetValueSize + targetOffset;
  30003. if ( referenceTrackType === 'quaternion' ) {
  30004. // Multiply the conjugate for quaternion track types
  30005. Quaternion.multiplyQuaternionsFlat(
  30006. targetTrack.values,
  30007. valueStart,
  30008. referenceValue,
  30009. 0,
  30010. targetTrack.values,
  30011. valueStart
  30012. );
  30013. } else {
  30014. const valueEnd = targetValueSize - targetOffset * 2;
  30015. // Subtract each value for all other numeric track types
  30016. for ( let k = 0; k < valueEnd; ++ k ) {
  30017. targetTrack.values[ valueStart + k ] -= referenceValue[ k ];
  30018. }
  30019. }
  30020. }
  30021. }
  30022. targetClip.blendMode = AdditiveAnimationBlendMode;
  30023. return targetClip;
  30024. }
  30025. /**
  30026. * A class with various methods to assist with animations.
  30027. *
  30028. * @hideconstructor
  30029. */
  30030. class AnimationUtils {
  30031. /**
  30032. * Converts an array to a specific type
  30033. *
  30034. * @static
  30035. * @param {TypedArray|Array} array - The array to convert.
  30036. * @param {TypedArray.constructor} type - The constructor of a type array.
  30037. * @return {TypedArray} The converted array
  30038. */
  30039. static convertArray( array, type ) {
  30040. return convertArray( array, type );
  30041. }
  30042. /**
  30043. * Returns `true` if the given object is a typed array.
  30044. *
  30045. * @static
  30046. * @param {any} object - The object to check.
  30047. * @return {boolean} Whether the given object is a typed array.
  30048. */
  30049. static isTypedArray( object ) {
  30050. return isTypedArray( object );
  30051. }
  30052. /**
  30053. * Returns an array by which times and values can be sorted.
  30054. *
  30055. * @static
  30056. * @param {Array<number>} times - The keyframe time values.
  30057. * @return {Array<number>} The array.
  30058. */
  30059. static getKeyframeOrder( times ) {
  30060. return getKeyframeOrder( times );
  30061. }
  30062. /**
  30063. * Sorts the given array by the previously computed order via `getKeyframeOrder()`.
  30064. *
  30065. * @static
  30066. * @param {Array<number>} values - The values to sort.
  30067. * @param {number} stride - The stride.
  30068. * @param {Array<number>} order - The sort order.
  30069. * @return {Array<number>} The sorted values.
  30070. */
  30071. static sortedArray( values, stride, order ) {
  30072. return sortedArray( values, stride, order );
  30073. }
  30074. /**
  30075. * Used for parsing AOS keyframe formats.
  30076. *
  30077. * @static
  30078. * @param {Array<number>} jsonKeys - A list of JSON keyframes.
  30079. * @param {Array<number>} times - This array will be filled with keyframe times by this method.
  30080. * @param {Array<number>} values - This array will be filled with keyframe values by this method.
  30081. * @param {string} valuePropertyName - The name of the property to use.
  30082. */
  30083. static flattenJSON( jsonKeys, times, values, valuePropertyName ) {
  30084. flattenJSON( jsonKeys, times, values, valuePropertyName );
  30085. }
  30086. /**
  30087. * Creates a new clip, containing only the segment of the original clip between the given frames.
  30088. *
  30089. * @static
  30090. * @param {AnimationClip} sourceClip - The values to sort.
  30091. * @param {string} name - The name of the clip.
  30092. * @param {number} startFrame - The start frame.
  30093. * @param {number} endFrame - The end frame.
  30094. * @param {number} [fps=30] - The FPS.
  30095. * @return {AnimationClip} The new sub clip.
  30096. */
  30097. static subclip( sourceClip, name, startFrame, endFrame, fps = 30 ) {
  30098. return subclip( sourceClip, name, startFrame, endFrame, fps );
  30099. }
  30100. /**
  30101. * Converts the keyframes of the given animation clip to an additive format.
  30102. *
  30103. * @static
  30104. * @param {AnimationClip} targetClip - The clip to make additive.
  30105. * @param {number} [referenceFrame=0] - The reference frame.
  30106. * @param {AnimationClip} [referenceClip=targetClip] - The reference clip.
  30107. * @param {number} [fps=30] - The FPS.
  30108. * @return {AnimationClip} The updated clip which is now additive.
  30109. */
  30110. static makeClipAdditive( targetClip, referenceFrame = 0, referenceClip = targetClip, fps = 30 ) {
  30111. return makeClipAdditive( targetClip, referenceFrame, referenceClip, fps );
  30112. }
  30113. }
  30114. /**
  30115. * Abstract base class of interpolants over parametric samples.
  30116. *
  30117. * The parameter domain is one dimensional, typically the time or a path
  30118. * along a curve defined by the data.
  30119. *
  30120. * The sample values can have any dimensionality and derived classes may
  30121. * apply special interpretations to the data.
  30122. *
  30123. * This class provides the interval seek in a Template Method, deferring
  30124. * the actual interpolation to derived classes.
  30125. *
  30126. * Time complexity is O(1) for linear access crossing at most two points
  30127. * and O(log N) for random access, where N is the number of positions.
  30128. *
  30129. * References: {@link http://www.oodesign.com/template-method-pattern.html}
  30130. *
  30131. * @abstract
  30132. */
  30133. class Interpolant {
  30134. /**
  30135. * Constructs a new interpolant.
  30136. *
  30137. * @param {TypedArray} parameterPositions - The parameter positions hold the interpolation factors.
  30138. * @param {TypedArray} sampleValues - The sample values.
  30139. * @param {number} sampleSize - The sample size
  30140. * @param {TypedArray} [resultBuffer] - The result buffer.
  30141. */
  30142. constructor( parameterPositions, sampleValues, sampleSize, resultBuffer ) {
  30143. /**
  30144. * The parameter positions.
  30145. *
  30146. * @type {TypedArray}
  30147. */
  30148. this.parameterPositions = parameterPositions;
  30149. /**
  30150. * A cache index.
  30151. *
  30152. * @private
  30153. * @type {number}
  30154. * @default 0
  30155. */
  30156. this._cachedIndex = 0;
  30157. /**
  30158. * The result buffer.
  30159. *
  30160. * @type {TypedArray}
  30161. */
  30162. this.resultBuffer = resultBuffer !== undefined ? resultBuffer : new sampleValues.constructor( sampleSize );
  30163. /**
  30164. * The sample values.
  30165. *
  30166. * @type {TypedArray}
  30167. */
  30168. this.sampleValues = sampleValues;
  30169. /**
  30170. * The value size.
  30171. *
  30172. * @type {TypedArray}
  30173. */
  30174. this.valueSize = sampleSize;
  30175. /**
  30176. * The interpolation settings.
  30177. *
  30178. * @type {?Object}
  30179. * @default null
  30180. */
  30181. this.settings = null;
  30182. /**
  30183. * The default settings object.
  30184. *
  30185. * @type {Object}
  30186. */
  30187. this.DefaultSettings_ = {};
  30188. }
  30189. /**
  30190. * Evaluate the interpolant at position `t`.
  30191. *
  30192. * @param {number} t - The interpolation factor.
  30193. * @return {TypedArray} The result buffer.
  30194. */
  30195. evaluate( t ) {
  30196. const pp = this.parameterPositions;
  30197. let i1 = this._cachedIndex,
  30198. t1 = pp[ i1 ],
  30199. t0 = pp[ i1 - 1 ];
  30200. validate_interval: {
  30201. seek: {
  30202. let right;
  30203. linear_scan: {
  30204. //- See http://jsperf.com/comparison-to-undefined/3
  30205. //- slower code:
  30206. //-
  30207. //- if ( t >= t1 || t1 === undefined ) {
  30208. forward_scan: if ( ! ( t < t1 ) ) {
  30209. for ( let giveUpAt = i1 + 2; ; ) {
  30210. if ( t1 === undefined ) {
  30211. if ( t < t0 ) break forward_scan;
  30212. // after end
  30213. i1 = pp.length;
  30214. this._cachedIndex = i1;
  30215. return this.copySampleValue_( i1 - 1 );
  30216. }
  30217. if ( i1 === giveUpAt ) break; // this loop
  30218. t0 = t1;
  30219. t1 = pp[ ++ i1 ];
  30220. if ( t < t1 ) {
  30221. // we have arrived at the sought interval
  30222. break seek;
  30223. }
  30224. }
  30225. // prepare binary search on the right side of the index
  30226. right = pp.length;
  30227. break linear_scan;
  30228. }
  30229. //- slower code:
  30230. //- if ( t < t0 || t0 === undefined ) {
  30231. if ( ! ( t >= t0 ) ) {
  30232. // looping?
  30233. const t1global = pp[ 1 ];
  30234. if ( t < t1global ) {
  30235. i1 = 2; // + 1, using the scan for the details
  30236. t0 = t1global;
  30237. }
  30238. // linear reverse scan
  30239. for ( let giveUpAt = i1 - 2; ; ) {
  30240. if ( t0 === undefined ) {
  30241. // before start
  30242. this._cachedIndex = 0;
  30243. return this.copySampleValue_( 0 );
  30244. }
  30245. if ( i1 === giveUpAt ) break; // this loop
  30246. t1 = t0;
  30247. t0 = pp[ -- i1 - 1 ];
  30248. if ( t >= t0 ) {
  30249. // we have arrived at the sought interval
  30250. break seek;
  30251. }
  30252. }
  30253. // prepare binary search on the left side of the index
  30254. right = i1;
  30255. i1 = 0;
  30256. break linear_scan;
  30257. }
  30258. // the interval is valid
  30259. break validate_interval;
  30260. } // linear scan
  30261. // binary search
  30262. while ( i1 < right ) {
  30263. const mid = ( i1 + right ) >>> 1;
  30264. if ( t < pp[ mid ] ) {
  30265. right = mid;
  30266. } else {
  30267. i1 = mid + 1;
  30268. }
  30269. }
  30270. t1 = pp[ i1 ];
  30271. t0 = pp[ i1 - 1 ];
  30272. // check boundary cases, again
  30273. if ( t0 === undefined ) {
  30274. this._cachedIndex = 0;
  30275. return this.copySampleValue_( 0 );
  30276. }
  30277. if ( t1 === undefined ) {
  30278. i1 = pp.length;
  30279. this._cachedIndex = i1;
  30280. return this.copySampleValue_( i1 - 1 );
  30281. }
  30282. } // seek
  30283. this._cachedIndex = i1;
  30284. this.intervalChanged_( i1, t0, t1 );
  30285. } // validate_interval
  30286. return this.interpolate_( i1, t0, t, t1 );
  30287. }
  30288. /**
  30289. * Returns the interpolation settings.
  30290. *
  30291. * @return {Object} The interpolation settings.
  30292. */
  30293. getSettings_() {
  30294. return this.settings || this.DefaultSettings_;
  30295. }
  30296. /**
  30297. * Copies a sample value to the result buffer.
  30298. *
  30299. * @param {number} index - An index into the sample value buffer.
  30300. * @return {TypedArray} The result buffer.
  30301. */
  30302. copySampleValue_( index ) {
  30303. // copies a sample value to the result buffer
  30304. const result = this.resultBuffer,
  30305. values = this.sampleValues,
  30306. stride = this.valueSize,
  30307. offset = index * stride;
  30308. for ( let i = 0; i !== stride; ++ i ) {
  30309. result[ i ] = values[ offset + i ];
  30310. }
  30311. return result;
  30312. }
  30313. /**
  30314. * Copies a sample value to the result buffer.
  30315. *
  30316. * @abstract
  30317. * @param {number} i1 - An index into the sample value buffer.
  30318. * @param {number} t0 - The previous interpolation factor.
  30319. * @param {number} t - The current interpolation factor.
  30320. * @param {number} t1 - The next interpolation factor.
  30321. * @return {TypedArray} The result buffer.
  30322. */
  30323. interpolate_( /* i1, t0, t, t1 */ ) {
  30324. throw new Error( 'call to abstract method' );
  30325. // implementations shall return this.resultBuffer
  30326. }
  30327. /**
  30328. * Optional method that is executed when the interval has changed.
  30329. *
  30330. * @param {number} i1 - An index into the sample value buffer.
  30331. * @param {number} t0 - The previous interpolation factor.
  30332. * @param {number} t - The current interpolation factor.
  30333. */
  30334. intervalChanged_( /* i1, t0, t1 */ ) {
  30335. // empty
  30336. }
  30337. }
  30338. /**
  30339. * Fast and simple cubic spline interpolant.
  30340. *
  30341. * It was derived from a Hermitian construction setting the first derivative
  30342. * at each sample position to the linear slope between neighboring positions
  30343. * over their parameter interval.
  30344. *
  30345. * @augments Interpolant
  30346. */
  30347. class CubicInterpolant extends Interpolant {
  30348. /**
  30349. * Constructs a new cubic interpolant.
  30350. *
  30351. * @param {TypedArray} parameterPositions - The parameter positions hold the interpolation factors.
  30352. * @param {TypedArray} sampleValues - The sample values.
  30353. * @param {number} sampleSize - The sample size
  30354. * @param {TypedArray} [resultBuffer] - The result buffer.
  30355. */
  30356. constructor( parameterPositions, sampleValues, sampleSize, resultBuffer ) {
  30357. super( parameterPositions, sampleValues, sampleSize, resultBuffer );
  30358. this._weightPrev = -0;
  30359. this._offsetPrev = -0;
  30360. this._weightNext = -0;
  30361. this._offsetNext = -0;
  30362. this.DefaultSettings_ = {
  30363. endingStart: ZeroCurvatureEnding,
  30364. endingEnd: ZeroCurvatureEnding
  30365. };
  30366. }
  30367. intervalChanged_( i1, t0, t1 ) {
  30368. const pp = this.parameterPositions;
  30369. let iPrev = i1 - 2,
  30370. iNext = i1 + 1,
  30371. tPrev = pp[ iPrev ],
  30372. tNext = pp[ iNext ];
  30373. if ( tPrev === undefined ) {
  30374. switch ( this.getSettings_().endingStart ) {
  30375. case ZeroSlopeEnding:
  30376. // f'(t0) = 0
  30377. iPrev = i1;
  30378. tPrev = 2 * t0 - t1;
  30379. break;
  30380. case WrapAroundEnding:
  30381. // use the other end of the curve
  30382. iPrev = pp.length - 2;
  30383. tPrev = t0 + pp[ iPrev ] - pp[ iPrev + 1 ];
  30384. break;
  30385. default: // ZeroCurvatureEnding
  30386. // f''(t0) = 0 a.k.a. Natural Spline
  30387. iPrev = i1;
  30388. tPrev = t1;
  30389. }
  30390. }
  30391. if ( tNext === undefined ) {
  30392. switch ( this.getSettings_().endingEnd ) {
  30393. case ZeroSlopeEnding:
  30394. // f'(tN) = 0
  30395. iNext = i1;
  30396. tNext = 2 * t1 - t0;
  30397. break;
  30398. case WrapAroundEnding:
  30399. // use the other end of the curve
  30400. iNext = 1;
  30401. tNext = t1 + pp[ 1 ] - pp[ 0 ];
  30402. break;
  30403. default: // ZeroCurvatureEnding
  30404. // f''(tN) = 0, a.k.a. Natural Spline
  30405. iNext = i1 - 1;
  30406. tNext = t0;
  30407. }
  30408. }
  30409. const halfDt = ( t1 - t0 ) * 0.5,
  30410. stride = this.valueSize;
  30411. this._weightPrev = halfDt / ( t0 - tPrev );
  30412. this._weightNext = halfDt / ( tNext - t1 );
  30413. this._offsetPrev = iPrev * stride;
  30414. this._offsetNext = iNext * stride;
  30415. }
  30416. interpolate_( i1, t0, t, t1 ) {
  30417. const result = this.resultBuffer,
  30418. values = this.sampleValues,
  30419. stride = this.valueSize,
  30420. o1 = i1 * stride, o0 = o1 - stride,
  30421. oP = this._offsetPrev, oN = this._offsetNext,
  30422. wP = this._weightPrev, wN = this._weightNext,
  30423. p = ( t - t0 ) / ( t1 - t0 ),
  30424. pp = p * p,
  30425. ppp = pp * p;
  30426. // evaluate polynomials
  30427. const sP = - wP * ppp + 2 * wP * pp - wP * p;
  30428. const s0 = ( 1 + wP ) * ppp + ( -1.5 - 2 * wP ) * pp + ( -0.5 + wP ) * p + 1;
  30429. const s1 = ( -1 - wN ) * ppp + ( 1.5 + wN ) * pp + 0.5 * p;
  30430. const sN = wN * ppp - wN * pp;
  30431. // combine data linearly
  30432. for ( let i = 0; i !== stride; ++ i ) {
  30433. result[ i ] =
  30434. sP * values[ oP + i ] +
  30435. s0 * values[ o0 + i ] +
  30436. s1 * values[ o1 + i ] +
  30437. sN * values[ oN + i ];
  30438. }
  30439. return result;
  30440. }
  30441. }
  30442. /**
  30443. * A basic linear interpolant.
  30444. *
  30445. * @augments Interpolant
  30446. */
  30447. class LinearInterpolant extends Interpolant {
  30448. /**
  30449. * Constructs a new linear interpolant.
  30450. *
  30451. * @param {TypedArray} parameterPositions - The parameter positions hold the interpolation factors.
  30452. * @param {TypedArray} sampleValues - The sample values.
  30453. * @param {number} sampleSize - The sample size
  30454. * @param {TypedArray} [resultBuffer] - The result buffer.
  30455. */
  30456. constructor( parameterPositions, sampleValues, sampleSize, resultBuffer ) {
  30457. super( parameterPositions, sampleValues, sampleSize, resultBuffer );
  30458. }
  30459. interpolate_( i1, t0, t, t1 ) {
  30460. const result = this.resultBuffer,
  30461. values = this.sampleValues,
  30462. stride = this.valueSize,
  30463. offset1 = i1 * stride,
  30464. offset0 = offset1 - stride,
  30465. weight1 = ( t - t0 ) / ( t1 - t0 ),
  30466. weight0 = 1 - weight1;
  30467. for ( let i = 0; i !== stride; ++ i ) {
  30468. result[ i ] =
  30469. values[ offset0 + i ] * weight0 +
  30470. values[ offset1 + i ] * weight1;
  30471. }
  30472. return result;
  30473. }
  30474. }
  30475. /**
  30476. * Interpolant that evaluates to the sample value at the position preceding
  30477. * the parameter.
  30478. *
  30479. * @augments Interpolant
  30480. */
  30481. class DiscreteInterpolant extends Interpolant {
  30482. /**
  30483. * Constructs a new discrete interpolant.
  30484. *
  30485. * @param {TypedArray} parameterPositions - The parameter positions hold the interpolation factors.
  30486. * @param {TypedArray} sampleValues - The sample values.
  30487. * @param {number} sampleSize - The sample size
  30488. * @param {TypedArray} [resultBuffer] - The result buffer.
  30489. */
  30490. constructor( parameterPositions, sampleValues, sampleSize, resultBuffer ) {
  30491. super( parameterPositions, sampleValues, sampleSize, resultBuffer );
  30492. }
  30493. interpolate_( i1 /*, t0, t, t1 */ ) {
  30494. return this.copySampleValue_( i1 - 1 );
  30495. }
  30496. }
  30497. /**
  30498. * A Bezier interpolant using cubic Bezier curves with 2D control points.
  30499. *
  30500. * This interpolant supports the COLLADA/Maya style of Bezier animation where
  30501. * each keyframe has explicit in/out tangent control points specified as
  30502. * 2D coordinates (time, value).
  30503. *
  30504. * The tangent data must be provided via the `settings` object:
  30505. * - `settings.inTangents`: Float32Array with [time, value] pairs per keyframe per component
  30506. * - `settings.outTangents`: Float32Array with [time, value] pairs per keyframe per component
  30507. *
  30508. * For a track with N keyframes and stride S:
  30509. * - Each tangent array has N * S * 2 values
  30510. * - Layout: [k0_c0_time, k0_c0_value, k0_c1_time, k0_c1_value, ..., k0_cS_time, k0_cS_value,
  30511. * k1_c0_time, k1_c0_value, ...]
  30512. *
  30513. * @augments Interpolant
  30514. */
  30515. class BezierInterpolant extends Interpolant {
  30516. interpolate_( i1, t0, t, t1 ) {
  30517. const result = this.resultBuffer;
  30518. const values = this.sampleValues;
  30519. const stride = this.valueSize;
  30520. const offset1 = i1 * stride;
  30521. const offset0 = offset1 - stride;
  30522. const settings = this.settings || this.DefaultSettings_;
  30523. const inTangents = settings.inTangents;
  30524. const outTangents = settings.outTangents;
  30525. // If no tangent data, fall back to linear interpolation
  30526. if ( ! inTangents || ! outTangents ) {
  30527. const weight1 = ( t - t0 ) / ( t1 - t0 );
  30528. const weight0 = 1 - weight1;
  30529. for ( let i = 0; i !== stride; ++ i ) {
  30530. result[ i ] = values[ offset0 + i ] * weight0 + values[ offset1 + i ] * weight1;
  30531. }
  30532. return result;
  30533. }
  30534. const tangentStride = stride * 2;
  30535. const i0 = i1 - 1;
  30536. for ( let i = 0; i !== stride; ++ i ) {
  30537. const v0 = values[ offset0 + i ];
  30538. const v1 = values[ offset1 + i ];
  30539. // outTangent of previous keyframe (C0)
  30540. const outTangentOffset = i0 * tangentStride + i * 2;
  30541. const c0x = outTangents[ outTangentOffset ];
  30542. const c0y = outTangents[ outTangentOffset + 1 ];
  30543. // inTangent of current keyframe (C1)
  30544. const inTangentOffset = i1 * tangentStride + i * 2;
  30545. const c1x = inTangents[ inTangentOffset ];
  30546. const c1y = inTangents[ inTangentOffset + 1 ];
  30547. // Solve for Bezier parameter s where Bx(s) = t using Newton-Raphson
  30548. let s = ( t - t0 ) / ( t1 - t0 );
  30549. let s2, s3, oneMinusS, oneMinusS2, oneMinusS3;
  30550. for ( let iter = 0; iter < 8; iter ++ ) {
  30551. s2 = s * s;
  30552. s3 = s2 * s;
  30553. oneMinusS = 1 - s;
  30554. oneMinusS2 = oneMinusS * oneMinusS;
  30555. oneMinusS3 = oneMinusS2 * oneMinusS;
  30556. // Bezier X(s) = (1-s)³·t0 + 3(1-s)²s·c0x + 3(1-s)s²·c1x + s³·t1
  30557. const bx = oneMinusS3 * t0 + 3 * oneMinusS2 * s * c0x + 3 * oneMinusS * s2 * c1x + s3 * t1;
  30558. const error = bx - t;
  30559. if ( Math.abs( error ) < 1e-10 ) break;
  30560. // Derivative dX/ds
  30561. const dbx = 3 * oneMinusS2 * ( c0x - t0 ) + 6 * oneMinusS * s * ( c1x - c0x ) + 3 * s2 * ( t1 - c1x );
  30562. if ( Math.abs( dbx ) < 1e-10 ) break;
  30563. s = s - error / dbx;
  30564. s = Math.max( 0, Math.min( 1, s ) );
  30565. }
  30566. // Evaluate Bezier Y(s)
  30567. result[ i ] = oneMinusS3 * v0 + 3 * oneMinusS2 * s * c0y + 3 * oneMinusS * s2 * c1y + s3 * v1;
  30568. }
  30569. return result;
  30570. }
  30571. }
  30572. /**
  30573. * Represents a timed sequence of keyframes, which are composed of lists of
  30574. * times and related values, and which are used to animate a specific property
  30575. * of an object.
  30576. */
  30577. class KeyframeTrack {
  30578. /**
  30579. * Constructs a new keyframe track.
  30580. *
  30581. * @param {string} name - The keyframe track's name.
  30582. * @param {Array<number>} times - A list of keyframe times.
  30583. * @param {Array<number|string|boolean>} values - A list of keyframe values.
  30584. * @param {(InterpolateLinear|InterpolateDiscrete|InterpolateSmooth|InterpolateBezier)} [interpolation] - The interpolation type.
  30585. */
  30586. constructor( name, times, values, interpolation ) {
  30587. if ( name === undefined ) throw new Error( 'THREE.KeyframeTrack: track name is undefined' );
  30588. if ( times === undefined || times.length === 0 ) throw new Error( 'THREE.KeyframeTrack: no keyframes in track named ' + name );
  30589. /**
  30590. * The track's name can refer to morph targets or bones or
  30591. * possibly other values within an animated object. See {@link PropertyBinding#parseTrackName}
  30592. * for the forms of strings that can be parsed for property binding.
  30593. *
  30594. * @type {string}
  30595. */
  30596. this.name = name;
  30597. /**
  30598. * The keyframe times.
  30599. *
  30600. * @type {Float32Array}
  30601. */
  30602. this.times = convertArray( times, this.TimeBufferType );
  30603. /**
  30604. * The keyframe values.
  30605. *
  30606. * @type {Float32Array}
  30607. */
  30608. this.values = convertArray( values, this.ValueBufferType );
  30609. this.setInterpolation( interpolation || this.DefaultInterpolation );
  30610. }
  30611. /**
  30612. * Converts the keyframe track to JSON.
  30613. *
  30614. * @static
  30615. * @param {KeyframeTrack} track - The keyframe track to serialize.
  30616. * @return {Object} The serialized keyframe track as JSON.
  30617. */
  30618. static toJSON( track ) {
  30619. const trackType = track.constructor;
  30620. let json;
  30621. // derived classes can define a static toJSON method
  30622. if ( trackType.toJSON !== this.toJSON ) {
  30623. json = trackType.toJSON( track );
  30624. } else {
  30625. // by default, we assume the data can be serialized as-is
  30626. json = {
  30627. 'name': track.name,
  30628. 'times': convertArray( track.times, Array ),
  30629. 'values': convertArray( track.values, Array )
  30630. };
  30631. const interpolation = track.getInterpolation();
  30632. if ( interpolation !== track.DefaultInterpolation ) {
  30633. json.interpolation = interpolation;
  30634. }
  30635. }
  30636. json.type = track.ValueTypeName; // mandatory
  30637. return json;
  30638. }
  30639. /**
  30640. * Factory method for creating a new discrete interpolant.
  30641. *
  30642. * @static
  30643. * @param {TypedArray} [result] - The result buffer.
  30644. * @return {DiscreteInterpolant} The new interpolant.
  30645. */
  30646. InterpolantFactoryMethodDiscrete( result ) {
  30647. return new DiscreteInterpolant( this.times, this.values, this.getValueSize(), result );
  30648. }
  30649. /**
  30650. * Factory method for creating a new linear interpolant.
  30651. *
  30652. * @static
  30653. * @param {TypedArray} [result] - The result buffer.
  30654. * @return {LinearInterpolant} The new interpolant.
  30655. */
  30656. InterpolantFactoryMethodLinear( result ) {
  30657. return new LinearInterpolant( this.times, this.values, this.getValueSize(), result );
  30658. }
  30659. /**
  30660. * Factory method for creating a new smooth interpolant.
  30661. *
  30662. * @static
  30663. * @param {TypedArray} [result] - The result buffer.
  30664. * @return {CubicInterpolant} The new interpolant.
  30665. */
  30666. InterpolantFactoryMethodSmooth( result ) {
  30667. return new CubicInterpolant( this.times, this.values, this.getValueSize(), result );
  30668. }
  30669. /**
  30670. * Factory method for creating a new Bezier interpolant.
  30671. *
  30672. * The Bezier interpolant requires tangent data to be set via the `settings` property
  30673. * on the track before creating the interpolant. The settings should contain:
  30674. * - `inTangents`: Float32Array with [time, value] pairs per keyframe per component
  30675. * - `outTangents`: Float32Array with [time, value] pairs per keyframe per component
  30676. *
  30677. * @static
  30678. * @param {TypedArray} [result] - The result buffer.
  30679. * @return {BezierInterpolant} The new interpolant.
  30680. */
  30681. InterpolantFactoryMethodBezier( result ) {
  30682. const interpolant = new BezierInterpolant( this.times, this.values, this.getValueSize(), result );
  30683. // Pass tangent data from track settings to interpolant
  30684. if ( this.settings ) {
  30685. interpolant.settings = this.settings;
  30686. }
  30687. return interpolant;
  30688. }
  30689. /**
  30690. * Defines the interpolation factor method for this keyframe track.
  30691. *
  30692. * @param {(InterpolateLinear|InterpolateDiscrete|InterpolateSmooth|InterpolateBezier)} interpolation - The interpolation type.
  30693. * @return {KeyframeTrack} A reference to this keyframe track.
  30694. */
  30695. setInterpolation( interpolation ) {
  30696. let factoryMethod;
  30697. switch ( interpolation ) {
  30698. case InterpolateDiscrete:
  30699. factoryMethod = this.InterpolantFactoryMethodDiscrete;
  30700. break;
  30701. case InterpolateLinear:
  30702. factoryMethod = this.InterpolantFactoryMethodLinear;
  30703. break;
  30704. case InterpolateSmooth:
  30705. factoryMethod = this.InterpolantFactoryMethodSmooth;
  30706. break;
  30707. case InterpolateBezier:
  30708. factoryMethod = this.InterpolantFactoryMethodBezier;
  30709. break;
  30710. }
  30711. if ( factoryMethod === undefined ) {
  30712. const message = 'unsupported interpolation for ' +
  30713. this.ValueTypeName + ' keyframe track named ' + this.name;
  30714. if ( this.createInterpolant === undefined ) {
  30715. // fall back to default, unless the default itself is messed up
  30716. if ( interpolation !== this.DefaultInterpolation ) {
  30717. this.setInterpolation( this.DefaultInterpolation );
  30718. } else {
  30719. throw new Error( message ); // fatal, in this case
  30720. }
  30721. }
  30722. warn( 'KeyframeTrack:', message );
  30723. return this;
  30724. }
  30725. this.createInterpolant = factoryMethod;
  30726. return this;
  30727. }
  30728. /**
  30729. * Returns the current interpolation type.
  30730. *
  30731. * @return {(InterpolateLinear|InterpolateDiscrete|InterpolateSmooth|InterpolateBezier)} The interpolation type.
  30732. */
  30733. getInterpolation() {
  30734. switch ( this.createInterpolant ) {
  30735. case this.InterpolantFactoryMethodDiscrete:
  30736. return InterpolateDiscrete;
  30737. case this.InterpolantFactoryMethodLinear:
  30738. return InterpolateLinear;
  30739. case this.InterpolantFactoryMethodSmooth:
  30740. return InterpolateSmooth;
  30741. case this.InterpolantFactoryMethodBezier:
  30742. return InterpolateBezier;
  30743. }
  30744. }
  30745. /**
  30746. * Returns the value size.
  30747. *
  30748. * @return {number} The value size.
  30749. */
  30750. getValueSize() {
  30751. return this.values.length / this.times.length;
  30752. }
  30753. /**
  30754. * Moves all keyframes either forward or backward in time.
  30755. *
  30756. * @param {number} timeOffset - The offset to move the time values.
  30757. * @return {KeyframeTrack} A reference to this keyframe track.
  30758. */
  30759. shift( timeOffset ) {
  30760. if ( timeOffset !== 0.0 ) {
  30761. const times = this.times;
  30762. for ( let i = 0, n = times.length; i !== n; ++ i ) {
  30763. times[ i ] += timeOffset;
  30764. }
  30765. }
  30766. return this;
  30767. }
  30768. /**
  30769. * Scale all keyframe times by a factor (useful for frame - seconds conversions).
  30770. *
  30771. * @param {number} timeScale - The time scale.
  30772. * @return {KeyframeTrack} A reference to this keyframe track.
  30773. */
  30774. scale( timeScale ) {
  30775. if ( timeScale !== 1.0 ) {
  30776. const times = this.times;
  30777. for ( let i = 0, n = times.length; i !== n; ++ i ) {
  30778. times[ i ] *= timeScale;
  30779. }
  30780. }
  30781. return this;
  30782. }
  30783. /**
  30784. * Removes keyframes before and after animation without changing any values within the defined time range.
  30785. *
  30786. * Note: The method does not shift around keys to the start of the track time, because for interpolated
  30787. * keys this will change their values
  30788. *
  30789. * @param {number} startTime - The start time.
  30790. * @param {number} endTime - The end time.
  30791. * @return {KeyframeTrack} A reference to this keyframe track.
  30792. */
  30793. trim( startTime, endTime ) {
  30794. const times = this.times,
  30795. nKeys = times.length;
  30796. let from = 0,
  30797. to = nKeys - 1;
  30798. while ( from !== nKeys && times[ from ] < startTime ) {
  30799. ++ from;
  30800. }
  30801. while ( to !== -1 && times[ to ] > endTime ) {
  30802. -- to;
  30803. }
  30804. ++ to; // inclusive -> exclusive bound
  30805. if ( from !== 0 || to !== nKeys ) {
  30806. // empty tracks are forbidden, so keep at least one keyframe
  30807. if ( from >= to ) {
  30808. to = Math.max( to, 1 );
  30809. from = to - 1;
  30810. }
  30811. const stride = this.getValueSize();
  30812. this.times = times.slice( from, to );
  30813. this.values = this.values.slice( from * stride, to * stride );
  30814. }
  30815. return this;
  30816. }
  30817. /**
  30818. * Performs minimal validation on the keyframe track. Returns `true` if the values
  30819. * are valid.
  30820. *
  30821. * @return {boolean} Whether the keyframes are valid or not.
  30822. */
  30823. validate() {
  30824. let valid = true;
  30825. const valueSize = this.getValueSize();
  30826. if ( valueSize - Math.floor( valueSize ) !== 0 ) {
  30827. error( 'KeyframeTrack: Invalid value size in track.', this );
  30828. valid = false;
  30829. }
  30830. const times = this.times,
  30831. values = this.values,
  30832. nKeys = times.length;
  30833. if ( nKeys === 0 ) {
  30834. error( 'KeyframeTrack: Track is empty.', this );
  30835. valid = false;
  30836. }
  30837. let prevTime = null;
  30838. for ( let i = 0; i !== nKeys; i ++ ) {
  30839. const currTime = times[ i ];
  30840. if ( typeof currTime === 'number' && isNaN( currTime ) ) {
  30841. error( 'KeyframeTrack: Time is not a valid number.', this, i, currTime );
  30842. valid = false;
  30843. break;
  30844. }
  30845. if ( prevTime !== null && prevTime > currTime ) {
  30846. error( 'KeyframeTrack: Out of order keys.', this, i, currTime, prevTime );
  30847. valid = false;
  30848. break;
  30849. }
  30850. prevTime = currTime;
  30851. }
  30852. if ( values !== undefined ) {
  30853. if ( isTypedArray( values ) ) {
  30854. for ( let i = 0, n = values.length; i !== n; ++ i ) {
  30855. const value = values[ i ];
  30856. if ( isNaN( value ) ) {
  30857. error( 'KeyframeTrack: Value is not a valid number.', this, i, value );
  30858. valid = false;
  30859. break;
  30860. }
  30861. }
  30862. }
  30863. }
  30864. return valid;
  30865. }
  30866. /**
  30867. * Optimizes this keyframe track by removing equivalent sequential keys (which are
  30868. * common in morph target sequences).
  30869. *
  30870. * @return {KeyframeTrack} A reference to this keyframe track.
  30871. */
  30872. optimize() {
  30873. // (0,0,0,0,1,1,1,0,0,0,0,0,0,0) --> (0,0,1,1,0,0)
  30874. // times or values may be shared with other tracks, so overwriting is unsafe
  30875. const times = this.times.slice(),
  30876. values = this.values.slice(),
  30877. stride = this.getValueSize(),
  30878. smoothInterpolation = this.getInterpolation() === InterpolateSmooth,
  30879. lastIndex = times.length - 1;
  30880. let writeIndex = 1;
  30881. for ( let i = 1; i < lastIndex; ++ i ) {
  30882. let keep = false;
  30883. const time = times[ i ];
  30884. const timeNext = times[ i + 1 ];
  30885. // remove adjacent keyframes scheduled at the same time
  30886. if ( time !== timeNext && ( i !== 1 || time !== times[ 0 ] ) ) {
  30887. if ( ! smoothInterpolation ) {
  30888. // remove unnecessary keyframes same as their neighbors
  30889. const offset = i * stride,
  30890. offsetP = offset - stride,
  30891. offsetN = offset + stride;
  30892. for ( let j = 0; j !== stride; ++ j ) {
  30893. const value = values[ offset + j ];
  30894. if ( value !== values[ offsetP + j ] ||
  30895. value !== values[ offsetN + j ] ) {
  30896. keep = true;
  30897. break;
  30898. }
  30899. }
  30900. } else {
  30901. keep = true;
  30902. }
  30903. }
  30904. // in-place compaction
  30905. if ( keep ) {
  30906. if ( i !== writeIndex ) {
  30907. times[ writeIndex ] = times[ i ];
  30908. const readOffset = i * stride,
  30909. writeOffset = writeIndex * stride;
  30910. for ( let j = 0; j !== stride; ++ j ) {
  30911. values[ writeOffset + j ] = values[ readOffset + j ];
  30912. }
  30913. }
  30914. ++ writeIndex;
  30915. }
  30916. }
  30917. // flush last keyframe (compaction looks ahead)
  30918. if ( lastIndex > 0 ) {
  30919. times[ writeIndex ] = times[ lastIndex ];
  30920. for ( let readOffset = lastIndex * stride, writeOffset = writeIndex * stride, j = 0; j !== stride; ++ j ) {
  30921. values[ writeOffset + j ] = values[ readOffset + j ];
  30922. }
  30923. ++ writeIndex;
  30924. }
  30925. if ( writeIndex !== times.length ) {
  30926. this.times = times.slice( 0, writeIndex );
  30927. this.values = values.slice( 0, writeIndex * stride );
  30928. } else {
  30929. this.times = times;
  30930. this.values = values;
  30931. }
  30932. return this;
  30933. }
  30934. /**
  30935. * Returns a new keyframe track with copied values from this instance.
  30936. *
  30937. * @return {KeyframeTrack} A clone of this instance.
  30938. */
  30939. clone() {
  30940. const times = this.times.slice();
  30941. const values = this.values.slice();
  30942. const TypedKeyframeTrack = this.constructor;
  30943. const track = new TypedKeyframeTrack( this.name, times, values );
  30944. // Interpolant argument to constructor is not saved, so copy the factory method directly.
  30945. track.createInterpolant = this.createInterpolant;
  30946. return track;
  30947. }
  30948. }
  30949. /**
  30950. * The value type name.
  30951. *
  30952. * @type {string}
  30953. * @default ''
  30954. */
  30955. KeyframeTrack.prototype.ValueTypeName = '';
  30956. /**
  30957. * The time buffer type of this keyframe track.
  30958. *
  30959. * @type {TypedArray|Array}
  30960. * @default Float32Array.constructor
  30961. */
  30962. KeyframeTrack.prototype.TimeBufferType = Float32Array;
  30963. /**
  30964. * The value buffer type of this keyframe track.
  30965. *
  30966. * @type {TypedArray|Array}
  30967. * @default Float32Array.constructor
  30968. */
  30969. KeyframeTrack.prototype.ValueBufferType = Float32Array;
  30970. /**
  30971. * The default interpolation type of this keyframe track.
  30972. *
  30973. * @type {(InterpolateLinear|InterpolateDiscrete|InterpolateSmooth|InterpolateBezier)}
  30974. * @default InterpolateLinear
  30975. */
  30976. KeyframeTrack.prototype.DefaultInterpolation = InterpolateLinear;
  30977. /**
  30978. * A track for boolean keyframe values.
  30979. *
  30980. * @augments KeyframeTrack
  30981. */
  30982. class BooleanKeyframeTrack extends KeyframeTrack {
  30983. /**
  30984. * Constructs a new boolean keyframe track.
  30985. *
  30986. * This keyframe track type has no `interpolation` parameter because the
  30987. * interpolation is always discrete.
  30988. *
  30989. * @param {string} name - The keyframe track's name.
  30990. * @param {Array<number>} times - A list of keyframe times.
  30991. * @param {Array<boolean>} values - A list of keyframe values.
  30992. */
  30993. constructor( name, times, values ) {
  30994. super( name, times, values );
  30995. }
  30996. }
  30997. /**
  30998. * The value type name.
  30999. *
  31000. * @type {string}
  31001. * @default 'bool'
  31002. */
  31003. BooleanKeyframeTrack.prototype.ValueTypeName = 'bool';
  31004. /**
  31005. * The value buffer type of this keyframe track.
  31006. *
  31007. * @type {TypedArray|Array}
  31008. * @default Array.constructor
  31009. */
  31010. BooleanKeyframeTrack.prototype.ValueBufferType = Array;
  31011. /**
  31012. * The default interpolation type of this keyframe track.
  31013. *
  31014. * @type {(InterpolateLinear|InterpolateDiscrete|InterpolateSmooth)}
  31015. * @default InterpolateDiscrete
  31016. */
  31017. BooleanKeyframeTrack.prototype.DefaultInterpolation = InterpolateDiscrete;
  31018. BooleanKeyframeTrack.prototype.InterpolantFactoryMethodLinear = undefined;
  31019. BooleanKeyframeTrack.prototype.InterpolantFactoryMethodSmooth = undefined;
  31020. /**
  31021. * A track for color keyframe values.
  31022. *
  31023. * @augments KeyframeTrack
  31024. */
  31025. class ColorKeyframeTrack extends KeyframeTrack {
  31026. /**
  31027. * Constructs a new color keyframe track.
  31028. *
  31029. * @param {string} name - The keyframe track's name.
  31030. * @param {Array<number>} times - A list of keyframe times.
  31031. * @param {Array<number>} values - A list of keyframe values.
  31032. * @param {(InterpolateLinear|InterpolateDiscrete|InterpolateSmooth)} [interpolation] - The interpolation type.
  31033. */
  31034. constructor( name, times, values, interpolation ) {
  31035. super( name, times, values, interpolation );
  31036. }
  31037. }
  31038. /**
  31039. * The value type name.
  31040. *
  31041. * @type {string}
  31042. * @default 'color'
  31043. */
  31044. ColorKeyframeTrack.prototype.ValueTypeName = 'color';
  31045. /**
  31046. * A track for numeric keyframe values.
  31047. *
  31048. * @augments KeyframeTrack
  31049. */
  31050. class NumberKeyframeTrack extends KeyframeTrack {
  31051. /**
  31052. * Constructs a new number keyframe track.
  31053. *
  31054. * @param {string} name - The keyframe track's name.
  31055. * @param {Array<number>} times - A list of keyframe times.
  31056. * @param {Array<number>} values - A list of keyframe values.
  31057. * @param {(InterpolateLinear|InterpolateDiscrete|InterpolateSmooth)} [interpolation] - The interpolation type.
  31058. */
  31059. constructor( name, times, values, interpolation ) {
  31060. super( name, times, values, interpolation );
  31061. }
  31062. }
  31063. /**
  31064. * The value type name.
  31065. *
  31066. * @type {string}
  31067. * @default 'number'
  31068. */
  31069. NumberKeyframeTrack.prototype.ValueTypeName = 'number';
  31070. /**
  31071. * Spherical linear unit quaternion interpolant.
  31072. *
  31073. * @augments Interpolant
  31074. */
  31075. class QuaternionLinearInterpolant extends Interpolant {
  31076. /**
  31077. * Constructs a new SLERP interpolant.
  31078. *
  31079. * @param {TypedArray} parameterPositions - The parameter positions hold the interpolation factors.
  31080. * @param {TypedArray} sampleValues - The sample values.
  31081. * @param {number} sampleSize - The sample size
  31082. * @param {TypedArray} [resultBuffer] - The result buffer.
  31083. */
  31084. constructor( parameterPositions, sampleValues, sampleSize, resultBuffer ) {
  31085. super( parameterPositions, sampleValues, sampleSize, resultBuffer );
  31086. }
  31087. interpolate_( i1, t0, t, t1 ) {
  31088. const result = this.resultBuffer,
  31089. values = this.sampleValues,
  31090. stride = this.valueSize,
  31091. alpha = ( t - t0 ) / ( t1 - t0 );
  31092. let offset = i1 * stride;
  31093. for ( let end = offset + stride; offset !== end; offset += 4 ) {
  31094. Quaternion.slerpFlat( result, 0, values, offset - stride, values, offset, alpha );
  31095. }
  31096. return result;
  31097. }
  31098. }
  31099. /**
  31100. * A track for Quaternion keyframe values.
  31101. *
  31102. * @augments KeyframeTrack
  31103. */
  31104. class QuaternionKeyframeTrack extends KeyframeTrack {
  31105. /**
  31106. * Constructs a new Quaternion keyframe track.
  31107. *
  31108. * @param {string} name - The keyframe track's name.
  31109. * @param {Array<number>} times - A list of keyframe times.
  31110. * @param {Array<number>} values - A list of keyframe values.
  31111. * @param {(InterpolateLinear|InterpolateDiscrete|InterpolateSmooth)} [interpolation] - The interpolation type.
  31112. */
  31113. constructor( name, times, values, interpolation ) {
  31114. super( name, times, values, interpolation );
  31115. }
  31116. /**
  31117. * Overwritten so the method returns Quaternion based interpolant.
  31118. *
  31119. * @static
  31120. * @param {TypedArray} [result] - The result buffer.
  31121. * @return {QuaternionLinearInterpolant} The new interpolant.
  31122. */
  31123. InterpolantFactoryMethodLinear( result ) {
  31124. return new QuaternionLinearInterpolant( this.times, this.values, this.getValueSize(), result );
  31125. }
  31126. }
  31127. /**
  31128. * The value type name.
  31129. *
  31130. * @type {string}
  31131. * @default 'quaternion'
  31132. */
  31133. QuaternionKeyframeTrack.prototype.ValueTypeName = 'quaternion';
  31134. // ValueBufferType is inherited
  31135. // DefaultInterpolation is inherited;
  31136. QuaternionKeyframeTrack.prototype.InterpolantFactoryMethodSmooth = undefined;
  31137. /**
  31138. * A track for string keyframe values.
  31139. *
  31140. * @augments KeyframeTrack
  31141. */
  31142. class StringKeyframeTrack extends KeyframeTrack {
  31143. /**
  31144. * Constructs a new string keyframe track.
  31145. *
  31146. * This keyframe track type has no `interpolation` parameter because the
  31147. * interpolation is always discrete.
  31148. *
  31149. * @param {string} name - The keyframe track's name.
  31150. * @param {Array<number>} times - A list of keyframe times.
  31151. * @param {Array<string>} values - A list of keyframe values.
  31152. */
  31153. constructor( name, times, values ) {
  31154. super( name, times, values );
  31155. }
  31156. }
  31157. /**
  31158. * The value type name.
  31159. *
  31160. * @type {string}
  31161. * @default 'string'
  31162. */
  31163. StringKeyframeTrack.prototype.ValueTypeName = 'string';
  31164. /**
  31165. * The value buffer type of this keyframe track.
  31166. *
  31167. * @type {TypedArray|Array}
  31168. * @default Array.constructor
  31169. */
  31170. StringKeyframeTrack.prototype.ValueBufferType = Array;
  31171. /**
  31172. * The default interpolation type of this keyframe track.
  31173. *
  31174. * @type {(InterpolateLinear|InterpolateDiscrete|InterpolateSmooth)}
  31175. * @default InterpolateDiscrete
  31176. */
  31177. StringKeyframeTrack.prototype.DefaultInterpolation = InterpolateDiscrete;
  31178. StringKeyframeTrack.prototype.InterpolantFactoryMethodLinear = undefined;
  31179. StringKeyframeTrack.prototype.InterpolantFactoryMethodSmooth = undefined;
  31180. /**
  31181. * A track for vector keyframe values.
  31182. *
  31183. * @augments KeyframeTrack
  31184. */
  31185. class VectorKeyframeTrack extends KeyframeTrack {
  31186. /**
  31187. * Constructs a new vector keyframe track.
  31188. *
  31189. * @param {string} name - The keyframe track's name.
  31190. * @param {Array<number>} times - A list of keyframe times.
  31191. * @param {Array<number>} values - A list of keyframe values.
  31192. * @param {(InterpolateLinear|InterpolateDiscrete|InterpolateSmooth)} [interpolation] - The interpolation type.
  31193. */
  31194. constructor( name, times, values, interpolation ) {
  31195. super( name, times, values, interpolation );
  31196. }
  31197. }
  31198. /**
  31199. * The value type name.
  31200. *
  31201. * @type {string}
  31202. * @default 'vector'
  31203. */
  31204. VectorKeyframeTrack.prototype.ValueTypeName = 'vector';
  31205. /**
  31206. * A reusable set of keyframe tracks which represent an animation.
  31207. */
  31208. class AnimationClip {
  31209. /**
  31210. * Constructs a new animation clip.
  31211. *
  31212. * Note: Instead of instantiating an AnimationClip directly with the constructor, you can
  31213. * use the static interface of this class for creating clips. In most cases though, animation clips
  31214. * will automatically be created by loaders when importing animated 3D assets.
  31215. *
  31216. * @param {string} [name=''] - The clip's name.
  31217. * @param {number} [duration=-1] - The clip's duration in seconds. If a negative value is passed,
  31218. * the duration will be calculated from the passed keyframes.
  31219. * @param {Array<KeyframeTrack>} tracks - An array of keyframe tracks.
  31220. * @param {(NormalAnimationBlendMode|AdditiveAnimationBlendMode)} [blendMode=NormalAnimationBlendMode] - Defines how the animation
  31221. * is blended/combined when two or more animations are simultaneously played.
  31222. */
  31223. constructor( name = '', duration = -1, tracks = [], blendMode = NormalAnimationBlendMode ) {
  31224. /**
  31225. * The clip's name.
  31226. *
  31227. * @type {string}
  31228. */
  31229. this.name = name;
  31230. /**
  31231. * An array of keyframe tracks.
  31232. *
  31233. * @type {Array<KeyframeTrack>}
  31234. */
  31235. this.tracks = tracks;
  31236. /**
  31237. * The clip's duration in seconds.
  31238. *
  31239. * @type {number}
  31240. */
  31241. this.duration = duration;
  31242. /**
  31243. * Defines how the animation is blended/combined when two or more animations
  31244. * are simultaneously played.
  31245. *
  31246. * @type {(NormalAnimationBlendMode|AdditiveAnimationBlendMode)}
  31247. */
  31248. this.blendMode = blendMode;
  31249. /**
  31250. * The UUID of the animation clip.
  31251. *
  31252. * @type {string}
  31253. * @readonly
  31254. */
  31255. this.uuid = generateUUID();
  31256. /**
  31257. * An object that can be used to store custom data about the animation clip.
  31258. * It should not hold references to functions as these will not be cloned.
  31259. *
  31260. * @type {Object}
  31261. */
  31262. this.userData = {};
  31263. // this means it should figure out its duration by scanning the tracks
  31264. if ( this.duration < 0 ) {
  31265. this.resetDuration();
  31266. }
  31267. }
  31268. /**
  31269. * Factory method for creating an animation clip from the given JSON.
  31270. *
  31271. * @static
  31272. * @param {Object} json - The serialized animation clip.
  31273. * @return {AnimationClip} The new animation clip.
  31274. */
  31275. static parse( json ) {
  31276. const tracks = [],
  31277. jsonTracks = json.tracks,
  31278. frameTime = 1.0 / ( json.fps || 1.0 );
  31279. for ( let i = 0, n = jsonTracks.length; i !== n; ++ i ) {
  31280. tracks.push( parseKeyframeTrack( jsonTracks[ i ] ).scale( frameTime ) );
  31281. }
  31282. const clip = new this( json.name, json.duration, tracks, json.blendMode );
  31283. clip.uuid = json.uuid;
  31284. clip.userData = JSON.parse( json.userData || '{}' );
  31285. return clip;
  31286. }
  31287. /**
  31288. * Serializes the given animation clip into JSON.
  31289. *
  31290. * @static
  31291. * @param {AnimationClip} clip - The animation clip to serialize.
  31292. * @return {Object} The JSON object.
  31293. */
  31294. static toJSON( clip ) {
  31295. const tracks = [],
  31296. clipTracks = clip.tracks;
  31297. const json = {
  31298. 'name': clip.name,
  31299. 'duration': clip.duration,
  31300. 'tracks': tracks,
  31301. 'uuid': clip.uuid,
  31302. 'blendMode': clip.blendMode,
  31303. 'userData': JSON.stringify( clip.userData ),
  31304. };
  31305. for ( let i = 0, n = clipTracks.length; i !== n; ++ i ) {
  31306. tracks.push( KeyframeTrack.toJSON( clipTracks[ i ] ) );
  31307. }
  31308. return json;
  31309. }
  31310. /**
  31311. * Returns a new animation clip from the passed morph targets array of a
  31312. * geometry, taking a name and the number of frames per second.
  31313. *
  31314. * Note: The fps parameter is required, but the animation speed can be
  31315. * overridden via {@link AnimationAction#setDuration}.
  31316. *
  31317. * @static
  31318. * @param {string} name - The name of the animation clip.
  31319. * @param {Array<Object>} morphTargetSequence - A sequence of morph targets.
  31320. * @param {number} fps - The Frames-Per-Second value.
  31321. * @param {boolean} noLoop - Whether the clip should be no loop or not.
  31322. * @return {AnimationClip} The new animation clip.
  31323. */
  31324. static CreateFromMorphTargetSequence( name, morphTargetSequence, fps, noLoop ) {
  31325. const numMorphTargets = morphTargetSequence.length;
  31326. const tracks = [];
  31327. for ( let i = 0; i < numMorphTargets; i ++ ) {
  31328. let times = [];
  31329. let values = [];
  31330. times.push(
  31331. ( i + numMorphTargets - 1 ) % numMorphTargets,
  31332. i,
  31333. ( i + 1 ) % numMorphTargets );
  31334. values.push( 0, 1, 0 );
  31335. const order = getKeyframeOrder( times );
  31336. times = sortedArray( times, 1, order );
  31337. values = sortedArray( values, 1, order );
  31338. // if there is a key at the first frame, duplicate it as the
  31339. // last frame as well for perfect loop.
  31340. if ( ! noLoop && times[ 0 ] === 0 ) {
  31341. times.push( numMorphTargets );
  31342. values.push( values[ 0 ] );
  31343. }
  31344. tracks.push(
  31345. new NumberKeyframeTrack(
  31346. '.morphTargetInfluences[' + morphTargetSequence[ i ].name + ']',
  31347. times, values
  31348. ).scale( 1.0 / fps ) );
  31349. }
  31350. return new this( name, -1, tracks );
  31351. }
  31352. /**
  31353. * Searches for an animation clip by name, taking as its first parameter
  31354. * either an array of clips, or a mesh or geometry that contains an
  31355. * array named "animations" property.
  31356. *
  31357. * @static
  31358. * @param {(Array<AnimationClip>|Object3D)} objectOrClipArray - The array or object to search through.
  31359. * @param {string} name - The name to search for.
  31360. * @return {?AnimationClip} The found animation clip. Returns `null` if no clip has been found.
  31361. */
  31362. static findByName( objectOrClipArray, name ) {
  31363. let clipArray = objectOrClipArray;
  31364. if ( ! Array.isArray( objectOrClipArray ) ) {
  31365. const o = objectOrClipArray;
  31366. clipArray = o.geometry && o.geometry.animations || o.animations;
  31367. }
  31368. for ( let i = 0; i < clipArray.length; i ++ ) {
  31369. if ( clipArray[ i ].name === name ) {
  31370. return clipArray[ i ];
  31371. }
  31372. }
  31373. return null;
  31374. }
  31375. /**
  31376. * Returns an array of new AnimationClips created from the morph target
  31377. * sequences of a geometry, trying to sort morph target names into
  31378. * animation-group-based patterns like "Walk_001, Walk_002, Run_001, Run_002...".
  31379. *
  31380. * See {@link MD2Loader#parse} as an example for how the method should be used.
  31381. *
  31382. * @static
  31383. * @param {Array<Object>} morphTargets - A sequence of morph targets.
  31384. * @param {number} fps - The Frames-Per-Second value.
  31385. * @param {boolean} noLoop - Whether the clip should be no loop or not.
  31386. * @return {Array<AnimationClip>} An array of new animation clips.
  31387. */
  31388. static CreateClipsFromMorphTargetSequences( morphTargets, fps, noLoop ) {
  31389. const animationToMorphTargets = {};
  31390. // tested with https://regex101.com/ on trick sequences
  31391. // such flamingo_flyA_003, flamingo_run1_003, crdeath0059
  31392. const pattern = /^([\w-]*?)([\d]+)$/;
  31393. // sort morph target names into animation groups based
  31394. // patterns like Walk_001, Walk_002, Run_001, Run_002
  31395. for ( let i = 0, il = morphTargets.length; i < il; i ++ ) {
  31396. const morphTarget = morphTargets[ i ];
  31397. const parts = morphTarget.name.match( pattern );
  31398. if ( parts && parts.length > 1 ) {
  31399. const name = parts[ 1 ];
  31400. let animationMorphTargets = animationToMorphTargets[ name ];
  31401. if ( ! animationMorphTargets ) {
  31402. animationToMorphTargets[ name ] = animationMorphTargets = [];
  31403. }
  31404. animationMorphTargets.push( morphTarget );
  31405. }
  31406. }
  31407. const clips = [];
  31408. for ( const name in animationToMorphTargets ) {
  31409. clips.push( this.CreateFromMorphTargetSequence( name, animationToMorphTargets[ name ], fps, noLoop ) );
  31410. }
  31411. return clips;
  31412. }
  31413. /**
  31414. * Parses the `animation.hierarchy` format and returns a new animation clip.
  31415. *
  31416. * @static
  31417. * @deprecated since r175.
  31418. * @param {Object} animation - A serialized animation clip as JSON.
  31419. * @param {Array<Bone>} bones - An array of bones.
  31420. * @return {?AnimationClip} The new animation clip.
  31421. */
  31422. static parseAnimation( animation, bones ) {
  31423. warn( 'AnimationClip: parseAnimation() is deprecated and will be removed with r185' );
  31424. if ( ! animation ) {
  31425. error( 'AnimationClip: No animation in JSONLoader data.' );
  31426. return null;
  31427. }
  31428. const addNonemptyTrack = function ( trackType, trackName, animationKeys, propertyName, destTracks ) {
  31429. // only return track if there are actually keys.
  31430. if ( animationKeys.length !== 0 ) {
  31431. const times = [];
  31432. const values = [];
  31433. flattenJSON( animationKeys, times, values, propertyName );
  31434. // empty keys are filtered out, so check again
  31435. if ( times.length !== 0 ) {
  31436. destTracks.push( new trackType( trackName, times, values ) );
  31437. }
  31438. }
  31439. };
  31440. const tracks = [];
  31441. const clipName = animation.name || 'default';
  31442. const fps = animation.fps || 30;
  31443. const blendMode = animation.blendMode;
  31444. // automatic length determination in AnimationClip.
  31445. let duration = animation.length || -1;
  31446. const hierarchyTracks = animation.hierarchy || [];
  31447. for ( let h = 0; h < hierarchyTracks.length; h ++ ) {
  31448. const animationKeys = hierarchyTracks[ h ].keys;
  31449. // skip empty tracks
  31450. if ( ! animationKeys || animationKeys.length === 0 ) continue;
  31451. // process morph targets
  31452. if ( animationKeys[ 0 ].morphTargets ) {
  31453. // figure out all morph targets used in this track
  31454. const morphTargetNames = {};
  31455. let k;
  31456. for ( k = 0; k < animationKeys.length; k ++ ) {
  31457. if ( animationKeys[ k ].morphTargets ) {
  31458. for ( let m = 0; m < animationKeys[ k ].morphTargets.length; m ++ ) {
  31459. morphTargetNames[ animationKeys[ k ].morphTargets[ m ] ] = -1;
  31460. }
  31461. }
  31462. }
  31463. // create a track for each morph target with all zero
  31464. // morphTargetInfluences except for the keys in which
  31465. // the morphTarget is named.
  31466. for ( const morphTargetName in morphTargetNames ) {
  31467. const times = [];
  31468. const values = [];
  31469. for ( let m = 0; m !== animationKeys[ k ].morphTargets.length; ++ m ) {
  31470. const animationKey = animationKeys[ k ];
  31471. times.push( animationKey.time );
  31472. values.push( ( animationKey.morphTarget === morphTargetName ) ? 1 : 0 );
  31473. }
  31474. tracks.push( new NumberKeyframeTrack( '.morphTargetInfluence[' + morphTargetName + ']', times, values ) );
  31475. }
  31476. duration = morphTargetNames.length * fps;
  31477. } else {
  31478. // ...assume skeletal animation
  31479. const boneName = '.bones[' + bones[ h ].name + ']';
  31480. addNonemptyTrack(
  31481. VectorKeyframeTrack, boneName + '.position',
  31482. animationKeys, 'pos', tracks );
  31483. addNonemptyTrack(
  31484. QuaternionKeyframeTrack, boneName + '.quaternion',
  31485. animationKeys, 'rot', tracks );
  31486. addNonemptyTrack(
  31487. VectorKeyframeTrack, boneName + '.scale',
  31488. animationKeys, 'scl', tracks );
  31489. }
  31490. }
  31491. if ( tracks.length === 0 ) {
  31492. return null;
  31493. }
  31494. const clip = new this( clipName, duration, tracks, blendMode );
  31495. return clip;
  31496. }
  31497. /**
  31498. * Sets the duration of this clip to the duration of its longest keyframe track.
  31499. *
  31500. * @return {AnimationClip} A reference to this animation clip.
  31501. */
  31502. resetDuration() {
  31503. const tracks = this.tracks;
  31504. let duration = 0;
  31505. for ( let i = 0, n = tracks.length; i !== n; ++ i ) {
  31506. const track = this.tracks[ i ];
  31507. duration = Math.max( duration, track.times[ track.times.length - 1 ] );
  31508. }
  31509. this.duration = duration;
  31510. return this;
  31511. }
  31512. /**
  31513. * Trims all tracks to the clip's duration.
  31514. *
  31515. * @return {AnimationClip} A reference to this animation clip.
  31516. */
  31517. trim() {
  31518. for ( let i = 0; i < this.tracks.length; i ++ ) {
  31519. this.tracks[ i ].trim( 0, this.duration );
  31520. }
  31521. return this;
  31522. }
  31523. /**
  31524. * Performs minimal validation on each track in the clip. Returns `true` if all
  31525. * tracks are valid.
  31526. *
  31527. * @return {boolean} Whether the clip's keyframes are valid or not.
  31528. */
  31529. validate() {
  31530. let valid = true;
  31531. for ( let i = 0; i < this.tracks.length; i ++ ) {
  31532. valid = valid && this.tracks[ i ].validate();
  31533. }
  31534. return valid;
  31535. }
  31536. /**
  31537. * Optimizes each track by removing equivalent sequential keys (which are
  31538. * common in morph target sequences).
  31539. *
  31540. * @return {AnimationClip} A reference to this animation clip.
  31541. */
  31542. optimize() {
  31543. for ( let i = 0; i < this.tracks.length; i ++ ) {
  31544. this.tracks[ i ].optimize();
  31545. }
  31546. return this;
  31547. }
  31548. /**
  31549. * Returns a new animation clip with copied values from this instance.
  31550. *
  31551. * @return {AnimationClip} A clone of this instance.
  31552. */
  31553. clone() {
  31554. const tracks = [];
  31555. for ( let i = 0; i < this.tracks.length; i ++ ) {
  31556. tracks.push( this.tracks[ i ].clone() );
  31557. }
  31558. const clip = new this.constructor( this.name, this.duration, tracks, this.blendMode );
  31559. clip.userData = JSON.parse( JSON.stringify( this.userData ) );
  31560. return clip;
  31561. }
  31562. /**
  31563. * Serializes this animation clip into JSON.
  31564. *
  31565. * @return {Object} The JSON object.
  31566. */
  31567. toJSON() {
  31568. return this.constructor.toJSON( this );
  31569. }
  31570. }
  31571. function getTrackTypeForValueTypeName( typeName ) {
  31572. switch ( typeName.toLowerCase() ) {
  31573. case 'scalar':
  31574. case 'double':
  31575. case 'float':
  31576. case 'number':
  31577. case 'integer':
  31578. return NumberKeyframeTrack;
  31579. case 'vector':
  31580. case 'vector2':
  31581. case 'vector3':
  31582. case 'vector4':
  31583. return VectorKeyframeTrack;
  31584. case 'color':
  31585. return ColorKeyframeTrack;
  31586. case 'quaternion':
  31587. return QuaternionKeyframeTrack;
  31588. case 'bool':
  31589. case 'boolean':
  31590. return BooleanKeyframeTrack;
  31591. case 'string':
  31592. return StringKeyframeTrack;
  31593. }
  31594. throw new Error( 'THREE.KeyframeTrack: Unsupported typeName: ' + typeName );
  31595. }
  31596. function parseKeyframeTrack( json ) {
  31597. if ( json.type === undefined ) {
  31598. throw new Error( 'THREE.KeyframeTrack: track type undefined, can not parse' );
  31599. }
  31600. const trackType = getTrackTypeForValueTypeName( json.type );
  31601. if ( json.times === undefined ) {
  31602. const times = [], values = [];
  31603. flattenJSON( json.keys, times, values, 'value' );
  31604. json.times = times;
  31605. json.values = values;
  31606. }
  31607. // derived classes can define a static parse method
  31608. if ( trackType.parse !== undefined ) {
  31609. return trackType.parse( json );
  31610. } else {
  31611. // by default, we assume a constructor compatible with the base
  31612. return new trackType( json.name, json.times, json.values, json.interpolation );
  31613. }
  31614. }
  31615. /**
  31616. * @class
  31617. * @classdesc A simple caching system, used internally by {@link FileLoader}.
  31618. * To enable caching across all loaders that use {@link FileLoader}, add `THREE.Cache.enabled = true.` once in your app.
  31619. * @hideconstructor
  31620. */
  31621. const Cache = {
  31622. /**
  31623. * Whether caching is enabled or not.
  31624. *
  31625. * @static
  31626. * @type {boolean}
  31627. * @default false
  31628. */
  31629. enabled: false,
  31630. /**
  31631. * A dictionary that holds cached files.
  31632. *
  31633. * @static
  31634. * @type {Object<string,Object>}
  31635. */
  31636. files: {},
  31637. /**
  31638. * Adds a cache entry with a key to reference the file. If this key already
  31639. * holds a file, it is overwritten.
  31640. *
  31641. * @static
  31642. * @param {string} key - The key to reference the cached file.
  31643. * @param {Object} file - The file to be cached.
  31644. */
  31645. add: function ( key, file ) {
  31646. if ( this.enabled === false ) return;
  31647. // log( 'Cache', 'Adding key:', key );
  31648. this.files[ key ] = file;
  31649. },
  31650. /**
  31651. * Gets the cached value for the given key.
  31652. *
  31653. * @static
  31654. * @param {string} key - The key to reference the cached file.
  31655. * @return {Object|undefined} The cached file. If the key does not exist `undefined` is returned.
  31656. */
  31657. get: function ( key ) {
  31658. if ( this.enabled === false ) return;
  31659. // log( 'Cache', 'Checking key:', key );
  31660. return this.files[ key ];
  31661. },
  31662. /**
  31663. * Removes the cached file associated with the given key.
  31664. *
  31665. * @static
  31666. * @param {string} key - The key to reference the cached file.
  31667. */
  31668. remove: function ( key ) {
  31669. delete this.files[ key ];
  31670. },
  31671. /**
  31672. * Remove all values from the cache.
  31673. *
  31674. * @static
  31675. */
  31676. clear: function () {
  31677. this.files = {};
  31678. }
  31679. };
  31680. /**
  31681. * Handles and keeps track of loaded and pending data. A default global
  31682. * instance of this class is created and used by loaders if not supplied
  31683. * manually.
  31684. *
  31685. * In general that should be sufficient, however there are times when it can
  31686. * be useful to have separate loaders - for example if you want to show
  31687. * separate loading bars for objects and textures.
  31688. *
  31689. * ```js
  31690. * const manager = new THREE.LoadingManager();
  31691. * manager.onLoad = () => console.log( 'Loading complete!' );
  31692. *
  31693. * const loader1 = new OBJLoader( manager );
  31694. * const loader2 = new ColladaLoader( manager );
  31695. * ```
  31696. */
  31697. class LoadingManager {
  31698. /**
  31699. * Constructs a new loading manager.
  31700. *
  31701. * @param {Function} [onLoad] - Executes when all items have been loaded.
  31702. * @param {Function} [onProgress] - Executes when single items have been loaded.
  31703. * @param {Function} [onError] - Executes when an error occurs.
  31704. */
  31705. constructor( onLoad, onProgress, onError ) {
  31706. const scope = this;
  31707. let isLoading = false;
  31708. let itemsLoaded = 0;
  31709. let itemsTotal = 0;
  31710. let urlModifier = undefined;
  31711. const handlers = [];
  31712. // Refer to #5689 for the reason why we don't set .onStart
  31713. // in the constructor
  31714. /**
  31715. * Executes when an item starts loading.
  31716. *
  31717. * @type {Function|undefined}
  31718. * @default undefined
  31719. */
  31720. this.onStart = undefined;
  31721. /**
  31722. * Executes when all items have been loaded.
  31723. *
  31724. * @type {Function|undefined}
  31725. * @default undefined
  31726. */
  31727. this.onLoad = onLoad;
  31728. /**
  31729. * Executes when single items have been loaded.
  31730. *
  31731. * @type {Function|undefined}
  31732. * @default undefined
  31733. */
  31734. this.onProgress = onProgress;
  31735. /**
  31736. * Executes when an error occurs.
  31737. *
  31738. * @type {Function|undefined}
  31739. * @default undefined
  31740. */
  31741. this.onError = onError;
  31742. /**
  31743. * Used for aborting ongoing requests in loaders using this manager.
  31744. *
  31745. * @private
  31746. * @type {AbortController | null}
  31747. */
  31748. this._abortController = null;
  31749. /**
  31750. * This should be called by any loader using the manager when the loader
  31751. * starts loading an item.
  31752. *
  31753. * @param {string} url - The URL to load.
  31754. */
  31755. this.itemStart = function ( url ) {
  31756. itemsTotal ++;
  31757. if ( isLoading === false ) {
  31758. if ( scope.onStart !== undefined ) {
  31759. scope.onStart( url, itemsLoaded, itemsTotal );
  31760. }
  31761. }
  31762. isLoading = true;
  31763. };
  31764. /**
  31765. * This should be called by any loader using the manager when the loader
  31766. * ended loading an item.
  31767. *
  31768. * @param {string} url - The URL of the loaded item.
  31769. */
  31770. this.itemEnd = function ( url ) {
  31771. itemsLoaded ++;
  31772. if ( scope.onProgress !== undefined ) {
  31773. scope.onProgress( url, itemsLoaded, itemsTotal );
  31774. }
  31775. if ( itemsLoaded === itemsTotal ) {
  31776. isLoading = false;
  31777. if ( scope.onLoad !== undefined ) {
  31778. scope.onLoad();
  31779. }
  31780. }
  31781. };
  31782. /**
  31783. * This should be called by any loader using the manager when the loader
  31784. * encounters an error when loading an item.
  31785. *
  31786. * @param {string} url - The URL of the item that produces an error.
  31787. */
  31788. this.itemError = function ( url ) {
  31789. if ( scope.onError !== undefined ) {
  31790. scope.onError( url );
  31791. }
  31792. };
  31793. /**
  31794. * Given a URL, uses the URL modifier callback (if any) and returns a
  31795. * resolved URL. If no URL modifier is set, returns the original URL.
  31796. *
  31797. * @param {string} url - The URL to load.
  31798. * @return {string} The resolved URL.
  31799. */
  31800. this.resolveURL = function ( url ) {
  31801. if ( urlModifier ) {
  31802. return urlModifier( url );
  31803. }
  31804. return url;
  31805. };
  31806. /**
  31807. * If provided, the callback will be passed each resource URL before a
  31808. * request is sent. The callback may return the original URL, or a new URL to
  31809. * override loading behavior. This behavior can be used to load assets from
  31810. * .ZIP files, drag-and-drop APIs, and Data URIs.
  31811. *
  31812. * ```js
  31813. * const blobs = {'fish.gltf': blob1, 'diffuse.png': blob2, 'normal.png': blob3};
  31814. *
  31815. * const manager = new THREE.LoadingManager();
  31816. *
  31817. * // Initialize loading manager with URL callback.
  31818. * const objectURLs = [];
  31819. * manager.setURLModifier( ( url ) => {
  31820. *
  31821. * url = URL.createObjectURL( blobs[ url ] );
  31822. * objectURLs.push( url );
  31823. * return url;
  31824. *
  31825. * } );
  31826. *
  31827. * // Load as usual, then revoke the blob URLs.
  31828. * const loader = new GLTFLoader( manager );
  31829. * loader.load( 'fish.gltf', (gltf) => {
  31830. *
  31831. * scene.add( gltf.scene );
  31832. * objectURLs.forEach( ( url ) => URL.revokeObjectURL( url ) );
  31833. *
  31834. * } );
  31835. * ```
  31836. *
  31837. * @param {function(string):string} transform - URL modifier callback. Called with an URL and must return a resolved URL.
  31838. * @return {LoadingManager} A reference to this loading manager.
  31839. */
  31840. this.setURLModifier = function ( transform ) {
  31841. urlModifier = transform;
  31842. return this;
  31843. };
  31844. /**
  31845. * Registers a loader with the given regular expression. Can be used to
  31846. * define what loader should be used in order to load specific files. A
  31847. * typical use case is to overwrite the default loader for textures.
  31848. *
  31849. * ```js
  31850. * // add handler for TGA textures
  31851. * manager.addHandler( /\.tga$/i, new TGALoader() );
  31852. * ```
  31853. *
  31854. * @param {string} regex - A regular expression.
  31855. * @param {Loader} loader - A loader that should handle matched cases.
  31856. * @return {LoadingManager} A reference to this loading manager.
  31857. */
  31858. this.addHandler = function ( regex, loader ) {
  31859. handlers.push( regex, loader );
  31860. return this;
  31861. };
  31862. /**
  31863. * Removes the loader for the given regular expression.
  31864. *
  31865. * @param {string} regex - A regular expression.
  31866. * @return {LoadingManager} A reference to this loading manager.
  31867. */
  31868. this.removeHandler = function ( regex ) {
  31869. const index = handlers.indexOf( regex );
  31870. if ( index !== -1 ) {
  31871. handlers.splice( index, 2 );
  31872. }
  31873. return this;
  31874. };
  31875. /**
  31876. * Can be used to retrieve the registered loader for the given file path.
  31877. *
  31878. * @param {string} file - The file path.
  31879. * @return {?Loader} The registered loader. Returns `null` if no loader was found.
  31880. */
  31881. this.getHandler = function ( file ) {
  31882. for ( let i = 0, l = handlers.length; i < l; i += 2 ) {
  31883. const regex = handlers[ i ];
  31884. const loader = handlers[ i + 1 ];
  31885. if ( regex.global ) regex.lastIndex = 0; // see #17920
  31886. if ( regex.test( file ) ) {
  31887. return loader;
  31888. }
  31889. }
  31890. return null;
  31891. };
  31892. /**
  31893. * Can be used to abort ongoing loading requests in loaders using this manager.
  31894. * The abort only works if the loaders implement {@link Loader#abort} and `AbortSignal.any()`
  31895. * is supported in the browser.
  31896. *
  31897. * @return {LoadingManager} A reference to this loading manager.
  31898. */
  31899. this.abort = function () {
  31900. this.abortController.abort();
  31901. this._abortController = null;
  31902. return this;
  31903. };
  31904. }
  31905. // TODO: Revert this back to a single member variable once this issue has been fixed
  31906. // https://github.com/cloudflare/workerd/issues/3657
  31907. /**
  31908. * Used for aborting ongoing requests in loaders using this manager.
  31909. *
  31910. * @type {AbortController}
  31911. */
  31912. get abortController() {
  31913. if ( ! this._abortController ) {
  31914. this._abortController = new AbortController();
  31915. }
  31916. return this._abortController;
  31917. }
  31918. }
  31919. /**
  31920. * The global default loading manager.
  31921. *
  31922. * @constant
  31923. * @type {LoadingManager}
  31924. */
  31925. const DefaultLoadingManager = /*@__PURE__*/ new LoadingManager();
  31926. /**
  31927. * Abstract base class for loaders.
  31928. *
  31929. * @abstract
  31930. */
  31931. class Loader {
  31932. /**
  31933. * Constructs a new loader.
  31934. *
  31935. * @param {LoadingManager} [manager] - The loading manager.
  31936. */
  31937. constructor( manager ) {
  31938. /**
  31939. * The loading manager.
  31940. *
  31941. * @type {LoadingManager}
  31942. * @default DefaultLoadingManager
  31943. */
  31944. this.manager = ( manager !== undefined ) ? manager : DefaultLoadingManager;
  31945. /**
  31946. * The crossOrigin string to implement CORS for loading the url from a
  31947. * different domain that allows CORS.
  31948. *
  31949. * @type {string}
  31950. * @default 'anonymous'
  31951. */
  31952. this.crossOrigin = 'anonymous';
  31953. /**
  31954. * Whether the XMLHttpRequest uses credentials.
  31955. *
  31956. * @type {boolean}
  31957. * @default false
  31958. */
  31959. this.withCredentials = false;
  31960. /**
  31961. * The base path from which the asset will be loaded.
  31962. *
  31963. * @type {string}
  31964. */
  31965. this.path = '';
  31966. /**
  31967. * The base path from which additional resources like textures will be loaded.
  31968. *
  31969. * @type {string}
  31970. */
  31971. this.resourcePath = '';
  31972. /**
  31973. * The [request header](https://developer.mozilla.org/en-US/docs/Glossary/Request_header)
  31974. * used in HTTP request.
  31975. *
  31976. * @type {Object<string, any>}
  31977. */
  31978. this.requestHeader = {};
  31979. if ( typeof __THREE_DEVTOOLS__ !== 'undefined' ) {
  31980. __THREE_DEVTOOLS__.dispatchEvent( new CustomEvent( 'observe', { detail: this } ) );
  31981. }
  31982. }
  31983. /**
  31984. * This method needs to be implemented by all concrete loaders. It holds the
  31985. * logic for loading assets from the backend.
  31986. *
  31987. * @abstract
  31988. * @param {string} url - The path/URL of the file to be loaded.
  31989. * @param {Function} onLoad - Executed when the loading process has been finished.
  31990. * @param {onProgressCallback} [onProgress] - Executed while the loading is in progress.
  31991. * @param {onErrorCallback} [onError] - Executed when errors occur.
  31992. */
  31993. load( /* url, onLoad, onProgress, onError */ ) {}
  31994. /**
  31995. * A async version of {@link Loader#load}.
  31996. *
  31997. * @param {string} url - The path/URL of the file to be loaded.
  31998. * @param {onProgressCallback} [onProgress] - Executed while the loading is in progress.
  31999. * @return {Promise} A Promise that resolves when the asset has been loaded.
  32000. */
  32001. loadAsync( url, onProgress ) {
  32002. const scope = this;
  32003. return new Promise( function ( resolve, reject ) {
  32004. scope.load( url, resolve, onProgress, reject );
  32005. } );
  32006. }
  32007. /**
  32008. * This method needs to be implemented by all concrete loaders. It holds the
  32009. * logic for parsing the asset into three.js entities.
  32010. *
  32011. * @abstract
  32012. * @param {any} data - The data to parse.
  32013. */
  32014. parse( /* data */ ) {}
  32015. /**
  32016. * Sets the `crossOrigin` String to implement CORS for loading the URL
  32017. * from a different domain that allows CORS.
  32018. *
  32019. * @param {string} crossOrigin - The `crossOrigin` value.
  32020. * @return {Loader} A reference to this instance.
  32021. */
  32022. setCrossOrigin( crossOrigin ) {
  32023. this.crossOrigin = crossOrigin;
  32024. return this;
  32025. }
  32026. /**
  32027. * Whether the XMLHttpRequest uses credentials such as cookies, authorization
  32028. * headers or TLS client certificates, see [XMLHttpRequest.withCredentials](https://developer.mozilla.org/en-US/docs/Web/API/XMLHttpRequest/withCredentials).
  32029. *
  32030. * Note: This setting has no effect if you are loading files locally or from the same domain.
  32031. *
  32032. * @param {boolean} value - The `withCredentials` value.
  32033. * @return {Loader} A reference to this instance.
  32034. */
  32035. setWithCredentials( value ) {
  32036. this.withCredentials = value;
  32037. return this;
  32038. }
  32039. /**
  32040. * Sets the base path for the asset.
  32041. *
  32042. * @param {string} path - The base path.
  32043. * @return {Loader} A reference to this instance.
  32044. */
  32045. setPath( path ) {
  32046. this.path = path;
  32047. return this;
  32048. }
  32049. /**
  32050. * Sets the base path for dependent resources like textures.
  32051. *
  32052. * @param {string} resourcePath - The resource path.
  32053. * @return {Loader} A reference to this instance.
  32054. */
  32055. setResourcePath( resourcePath ) {
  32056. this.resourcePath = resourcePath;
  32057. return this;
  32058. }
  32059. /**
  32060. * Sets the given request header.
  32061. *
  32062. * @param {Object} requestHeader - A [request header](https://developer.mozilla.org/en-US/docs/Glossary/Request_header)
  32063. * for configuring the HTTP request.
  32064. * @return {Loader} A reference to this instance.
  32065. */
  32066. setRequestHeader( requestHeader ) {
  32067. this.requestHeader = requestHeader;
  32068. return this;
  32069. }
  32070. /**
  32071. * This method can be implemented in loaders for aborting ongoing requests.
  32072. *
  32073. * @abstract
  32074. * @return {Loader} A reference to this instance.
  32075. */
  32076. abort() {
  32077. return this;
  32078. }
  32079. }
  32080. /**
  32081. * Callback for onProgress in loaders.
  32082. *
  32083. * @callback onProgressCallback
  32084. * @param {ProgressEvent} event - An instance of `ProgressEvent` that represents the current loading status.
  32085. */
  32086. /**
  32087. * Callback for onError in loaders.
  32088. *
  32089. * @callback onErrorCallback
  32090. * @param {Error} error - The error which occurred during the loading process.
  32091. */
  32092. /**
  32093. * The default material name that is used by loaders
  32094. * when creating materials for loaded 3D objects.
  32095. *
  32096. * Note: Not all loaders might honor this setting.
  32097. *
  32098. * @static
  32099. * @type {string}
  32100. * @default '__DEFAULT'
  32101. */
  32102. Loader.DEFAULT_MATERIAL_NAME = '__DEFAULT';
  32103. const loading = {};
  32104. class HttpError extends Error {
  32105. constructor( message, response ) {
  32106. super( message );
  32107. this.response = response;
  32108. }
  32109. }
  32110. /**
  32111. * A low level class for loading resources with the Fetch API, used internally by
  32112. * most loaders. It can also be used directly to load any file type that does
  32113. * not have a loader.
  32114. *
  32115. * This loader supports caching. If you want to use it, add `THREE.Cache.enabled = true;`
  32116. * once to your application.
  32117. *
  32118. * ```js
  32119. * const loader = new THREE.FileLoader();
  32120. * const data = await loader.loadAsync( 'example.txt' );
  32121. * ```
  32122. *
  32123. * @augments Loader
  32124. */
  32125. class FileLoader extends Loader {
  32126. /**
  32127. * Constructs a new file loader.
  32128. *
  32129. * @param {LoadingManager} [manager] - The loading manager.
  32130. */
  32131. constructor( manager ) {
  32132. super( manager );
  32133. /**
  32134. * The expected mime type. Valid values can be found
  32135. * [here](hhttps://developer.mozilla.org/en-US/docs/Web/API/DOMParser/parseFromString#mimetype)
  32136. *
  32137. * @type {string}
  32138. */
  32139. this.mimeType = '';
  32140. /**
  32141. * The expected response type.
  32142. *
  32143. * @type {('arraybuffer'|'blob'|'document'|'json'|'')}
  32144. * @default ''
  32145. */
  32146. this.responseType = '';
  32147. /**
  32148. * Used for aborting requests.
  32149. *
  32150. * @private
  32151. * @type {AbortController}
  32152. */
  32153. this._abortController = new AbortController();
  32154. }
  32155. /**
  32156. * Starts loading from the given URL and pass the loaded response to the `onLoad()` callback.
  32157. *
  32158. * @param {string} url - The path/URL of the file to be loaded. This can also be a data URI.
  32159. * @param {function(any)} onLoad - Executed when the loading process has been finished.
  32160. * @param {onProgressCallback} [onProgress] - Executed while the loading is in progress.
  32161. * @param {onErrorCallback} [onError] - Executed when errors occur.
  32162. * @return {any|undefined} The cached resource if available.
  32163. */
  32164. load( url, onLoad, onProgress, onError ) {
  32165. if ( url === undefined ) url = '';
  32166. if ( this.path !== undefined ) url = this.path + url;
  32167. url = this.manager.resolveURL( url );
  32168. const cached = Cache.get( `file:${url}` );
  32169. if ( cached !== undefined ) {
  32170. this.manager.itemStart( url );
  32171. setTimeout( () => {
  32172. if ( onLoad ) onLoad( cached );
  32173. this.manager.itemEnd( url );
  32174. }, 0 );
  32175. return cached;
  32176. }
  32177. // Check if request is duplicate
  32178. if ( loading[ url ] !== undefined ) {
  32179. loading[ url ].push( {
  32180. onLoad: onLoad,
  32181. onProgress: onProgress,
  32182. onError: onError
  32183. } );
  32184. return;
  32185. }
  32186. // Initialise array for duplicate requests
  32187. loading[ url ] = [];
  32188. loading[ url ].push( {
  32189. onLoad: onLoad,
  32190. onProgress: onProgress,
  32191. onError: onError,
  32192. } );
  32193. // create request
  32194. const req = new Request( url, {
  32195. headers: new Headers( this.requestHeader ),
  32196. credentials: this.withCredentials ? 'include' : 'same-origin',
  32197. signal: ( typeof AbortSignal.any === 'function' ) ? AbortSignal.any( [ this._abortController.signal, this.manager.abortController.signal ] ) : this._abortController.signal
  32198. } );
  32199. // record states ( avoid data race )
  32200. const mimeType = this.mimeType;
  32201. const responseType = this.responseType;
  32202. // start the fetch
  32203. fetch( req )
  32204. .then( response => {
  32205. if ( response.status === 200 || response.status === 0 ) {
  32206. // Some browsers return HTTP Status 0 when using non-http protocol
  32207. // e.g. 'file://' or 'data://'. Handle as success.
  32208. if ( response.status === 0 ) {
  32209. warn( 'FileLoader: HTTP Status 0 received.' );
  32210. }
  32211. // Workaround: Checking if response.body === undefined for Alipay browser #23548
  32212. if ( typeof ReadableStream === 'undefined' || response.body === undefined || response.body.getReader === undefined ) {
  32213. return response;
  32214. }
  32215. const callbacks = loading[ url ];
  32216. const reader = response.body.getReader();
  32217. // Nginx needs X-File-Size check
  32218. // https://serverfault.com/questions/482875/why-does-nginx-remove-content-length-header-for-chunked-content
  32219. const contentLength = response.headers.get( 'X-File-Size' ) || response.headers.get( 'Content-Length' );
  32220. const total = contentLength ? parseInt( contentLength ) : 0;
  32221. const lengthComputable = total !== 0;
  32222. let loaded = 0;
  32223. // periodically read data into the new stream tracking while download progress
  32224. const stream = new ReadableStream( {
  32225. start( controller ) {
  32226. readData();
  32227. function readData() {
  32228. reader.read().then( ( { done, value } ) => {
  32229. if ( done ) {
  32230. controller.close();
  32231. } else {
  32232. loaded += value.byteLength;
  32233. const event = new ProgressEvent( 'progress', { lengthComputable, loaded, total } );
  32234. for ( let i = 0, il = callbacks.length; i < il; i ++ ) {
  32235. const callback = callbacks[ i ];
  32236. if ( callback.onProgress ) callback.onProgress( event );
  32237. }
  32238. controller.enqueue( value );
  32239. readData();
  32240. }
  32241. }, ( e ) => {
  32242. controller.error( e );
  32243. } );
  32244. }
  32245. }
  32246. } );
  32247. return new Response( stream );
  32248. } else {
  32249. throw new HttpError( `fetch for "${response.url}" responded with ${response.status}: ${response.statusText}`, response );
  32250. }
  32251. } )
  32252. .then( response => {
  32253. switch ( responseType ) {
  32254. case 'arraybuffer':
  32255. return response.arrayBuffer();
  32256. case 'blob':
  32257. return response.blob();
  32258. case 'document':
  32259. return response.text()
  32260. .then( text => {
  32261. const parser = new DOMParser();
  32262. return parser.parseFromString( text, mimeType );
  32263. } );
  32264. case 'json':
  32265. return response.json();
  32266. default:
  32267. if ( mimeType === '' ) {
  32268. return response.text();
  32269. } else {
  32270. // sniff encoding
  32271. const re = /charset="?([^;"\s]*)"?/i;
  32272. const exec = re.exec( mimeType );
  32273. const label = exec && exec[ 1 ] ? exec[ 1 ].toLowerCase() : undefined;
  32274. const decoder = new TextDecoder( label );
  32275. return response.arrayBuffer().then( ab => decoder.decode( ab ) );
  32276. }
  32277. }
  32278. } )
  32279. .then( data => {
  32280. // Add to cache only on HTTP success, so that we do not cache
  32281. // error response bodies as proper responses to requests.
  32282. Cache.add( `file:${url}`, data );
  32283. const callbacks = loading[ url ];
  32284. delete loading[ url ];
  32285. for ( let i = 0, il = callbacks.length; i < il; i ++ ) {
  32286. const callback = callbacks[ i ];
  32287. if ( callback.onLoad ) callback.onLoad( data );
  32288. }
  32289. } )
  32290. .catch( err => {
  32291. // Abort errors and other errors are handled the same
  32292. const callbacks = loading[ url ];
  32293. if ( callbacks === undefined ) {
  32294. // When onLoad was called and url was deleted in `loading`
  32295. this.manager.itemError( url );
  32296. throw err;
  32297. }
  32298. delete loading[ url ];
  32299. for ( let i = 0, il = callbacks.length; i < il; i ++ ) {
  32300. const callback = callbacks[ i ];
  32301. if ( callback.onError ) callback.onError( err );
  32302. }
  32303. this.manager.itemError( url );
  32304. } )
  32305. .finally( () => {
  32306. this.manager.itemEnd( url );
  32307. } );
  32308. this.manager.itemStart( url );
  32309. }
  32310. /**
  32311. * Sets the expected response type.
  32312. *
  32313. * @param {('arraybuffer'|'blob'|'document'|'json'|'')} value - The response type.
  32314. * @return {FileLoader} A reference to this file loader.
  32315. */
  32316. setResponseType( value ) {
  32317. this.responseType = value;
  32318. return this;
  32319. }
  32320. /**
  32321. * Sets the expected mime type of the loaded file.
  32322. *
  32323. * @param {string} value - The mime type.
  32324. * @return {FileLoader} A reference to this file loader.
  32325. */
  32326. setMimeType( value ) {
  32327. this.mimeType = value;
  32328. return this;
  32329. }
  32330. /**
  32331. * Aborts ongoing fetch requests.
  32332. *
  32333. * @return {FileLoader} A reference to this instance.
  32334. */
  32335. abort() {
  32336. this._abortController.abort();
  32337. this._abortController = new AbortController();
  32338. return this;
  32339. }
  32340. }
  32341. /**
  32342. * Class for loading animation clips in the JSON format. The files are internally
  32343. * loaded via {@link FileLoader}.
  32344. *
  32345. * ```js
  32346. * const loader = new THREE.AnimationLoader();
  32347. * const animations = await loader.loadAsync( 'animations/animation.js' );
  32348. * ```
  32349. *
  32350. * @augments Loader
  32351. */
  32352. class AnimationLoader extends Loader {
  32353. /**
  32354. * Constructs a new animation loader.
  32355. *
  32356. * @param {LoadingManager} [manager] - The loading manager.
  32357. */
  32358. constructor( manager ) {
  32359. super( manager );
  32360. }
  32361. /**
  32362. * Starts loading from the given URL and pass the loaded animations as an array
  32363. * holding instances of {@link AnimationClip} to the `onLoad()` callback.
  32364. *
  32365. * @param {string} url - The path/URL of the file to be loaded. This can also be a data URI.
  32366. * @param {function(Array<AnimationClip>)} onLoad - Executed when the loading process has been finished.
  32367. * @param {onProgressCallback} onProgress - Executed while the loading is in progress.
  32368. * @param {onErrorCallback} onError - Executed when errors occur.
  32369. */
  32370. load( url, onLoad, onProgress, onError ) {
  32371. const scope = this;
  32372. const loader = new FileLoader( this.manager );
  32373. loader.setPath( this.path );
  32374. loader.setRequestHeader( this.requestHeader );
  32375. loader.setWithCredentials( this.withCredentials );
  32376. loader.load( url, function ( text ) {
  32377. try {
  32378. onLoad( scope.parse( JSON.parse( text ) ) );
  32379. } catch ( e ) {
  32380. if ( onError ) {
  32381. onError( e );
  32382. } else {
  32383. error( e );
  32384. }
  32385. scope.manager.itemError( url );
  32386. }
  32387. }, onProgress, onError );
  32388. }
  32389. /**
  32390. * Parses the given JSON object and returns an array of animation clips.
  32391. *
  32392. * @param {Object} json - The serialized animation clips.
  32393. * @return {Array<AnimationClip>} The parsed animation clips.
  32394. */
  32395. parse( json ) {
  32396. const animations = [];
  32397. for ( let i = 0; i < json.length; i ++ ) {
  32398. const clip = AnimationClip.parse( json[ i ] );
  32399. animations.push( clip );
  32400. }
  32401. return animations;
  32402. }
  32403. }
  32404. /**
  32405. * Abstract base class for loading compressed texture formats S3TC, ASTC or ETC.
  32406. * Textures are internally loaded via {@link FileLoader}.
  32407. *
  32408. * Derived classes have to implement the `parse()` method which holds the parsing
  32409. * for the respective format.
  32410. *
  32411. * @abstract
  32412. * @augments Loader
  32413. */
  32414. class CompressedTextureLoader extends Loader {
  32415. /**
  32416. * Constructs a new compressed texture loader.
  32417. *
  32418. * @param {LoadingManager} [manager] - The loading manager.
  32419. */
  32420. constructor( manager ) {
  32421. super( manager );
  32422. }
  32423. /**
  32424. * Starts loading from the given URL and passes the loaded compressed texture
  32425. * to the `onLoad()` callback. The method also returns a new texture object which can
  32426. * directly be used for material creation. If you do it this way, the texture
  32427. * may pop up in your scene once the respective loading process is finished.
  32428. *
  32429. * @param {string} url - The path/URL of the file to be loaded. This can also be a data URI.
  32430. * @param {function(CompressedTexture)} onLoad - Executed when the loading process has been finished.
  32431. * @param {onProgressCallback} onProgress - Executed while the loading is in progress.
  32432. * @param {onErrorCallback} onError - Executed when errors occur.
  32433. * @return {CompressedTexture} The compressed texture.
  32434. */
  32435. load( url, onLoad, onProgress, onError ) {
  32436. const scope = this;
  32437. const images = [];
  32438. const texture = new CompressedTexture();
  32439. const loader = new FileLoader( this.manager );
  32440. loader.setPath( this.path );
  32441. loader.setResponseType( 'arraybuffer' );
  32442. loader.setRequestHeader( this.requestHeader );
  32443. loader.setWithCredentials( scope.withCredentials );
  32444. let loaded = 0;
  32445. function loadTexture( i ) {
  32446. loader.load( url[ i ], function ( buffer ) {
  32447. const texDatas = scope.parse( buffer, true );
  32448. images[ i ] = {
  32449. width: texDatas.width,
  32450. height: texDatas.height,
  32451. format: texDatas.format,
  32452. mipmaps: texDatas.mipmaps
  32453. };
  32454. loaded += 1;
  32455. if ( loaded === 6 ) {
  32456. if ( texDatas.mipmapCount === 1 ) texture.minFilter = LinearFilter;
  32457. texture.image = images;
  32458. texture.format = texDatas.format;
  32459. texture.needsUpdate = true;
  32460. if ( onLoad ) onLoad( texture );
  32461. }
  32462. }, onProgress, onError );
  32463. }
  32464. if ( Array.isArray( url ) ) {
  32465. for ( let i = 0, il = url.length; i < il; ++ i ) {
  32466. loadTexture( i );
  32467. }
  32468. } else {
  32469. // compressed cubemap texture stored in a single DDS file
  32470. loader.load( url, function ( buffer ) {
  32471. const texDatas = scope.parse( buffer, true );
  32472. if ( texDatas.isCubemap ) {
  32473. const faces = texDatas.mipmaps.length / texDatas.mipmapCount;
  32474. for ( let f = 0; f < faces; f ++ ) {
  32475. images[ f ] = { mipmaps: [] };
  32476. for ( let i = 0; i < texDatas.mipmapCount; i ++ ) {
  32477. images[ f ].mipmaps.push( texDatas.mipmaps[ f * texDatas.mipmapCount + i ] );
  32478. images[ f ].format = texDatas.format;
  32479. images[ f ].width = texDatas.width;
  32480. images[ f ].height = texDatas.height;
  32481. }
  32482. }
  32483. texture.image = images;
  32484. } else {
  32485. texture.image.width = texDatas.width;
  32486. texture.image.height = texDatas.height;
  32487. texture.mipmaps = texDatas.mipmaps;
  32488. }
  32489. if ( texDatas.mipmapCount === 1 ) {
  32490. texture.minFilter = LinearFilter;
  32491. }
  32492. texture.format = texDatas.format;
  32493. texture.needsUpdate = true;
  32494. if ( onLoad ) onLoad( texture );
  32495. }, onProgress, onError );
  32496. }
  32497. return texture;
  32498. }
  32499. }
  32500. const _loading = new WeakMap();
  32501. /**
  32502. * A loader for loading images. The class loads images with the HTML `Image` API.
  32503. *
  32504. * ```js
  32505. * const loader = new THREE.ImageLoader();
  32506. * const image = await loader.loadAsync( 'image.png' );
  32507. * ```
  32508. * Please note that `ImageLoader` has dropped support for progress
  32509. * events in `r84`. For an `ImageLoader` that supports progress events, see
  32510. * [this thread](https://github.com/mrdoob/three.js/issues/10439#issuecomment-275785639).
  32511. *
  32512. * @augments Loader
  32513. */
  32514. class ImageLoader extends Loader {
  32515. /**
  32516. * Constructs a new image loader.
  32517. *
  32518. * @param {LoadingManager} [manager] - The loading manager.
  32519. */
  32520. constructor( manager ) {
  32521. super( manager );
  32522. }
  32523. /**
  32524. * Starts loading from the given URL and passes the loaded image
  32525. * to the `onLoad()` callback. The method also returns a new `Image` object which can
  32526. * directly be used for texture creation. If you do it this way, the texture
  32527. * may pop up in your scene once the respective loading process is finished.
  32528. *
  32529. * @param {string} url - The path/URL of the file to be loaded. This can also be a data URI.
  32530. * @param {function(Image)} onLoad - Executed when the loading process has been finished.
  32531. * @param {onProgressCallback} onProgress - Unsupported in this loader.
  32532. * @param {onErrorCallback} onError - Executed when errors occur.
  32533. * @return {Image} The image.
  32534. */
  32535. load( url, onLoad, onProgress, onError ) {
  32536. if ( this.path !== undefined ) url = this.path + url;
  32537. url = this.manager.resolveURL( url );
  32538. const scope = this;
  32539. const cached = Cache.get( `image:${url}` );
  32540. if ( cached !== undefined ) {
  32541. if ( cached.complete === true ) {
  32542. scope.manager.itemStart( url );
  32543. setTimeout( function () {
  32544. if ( onLoad ) onLoad( cached );
  32545. scope.manager.itemEnd( url );
  32546. }, 0 );
  32547. } else {
  32548. let arr = _loading.get( cached );
  32549. if ( arr === undefined ) {
  32550. arr = [];
  32551. _loading.set( cached, arr );
  32552. }
  32553. arr.push( { onLoad, onError } );
  32554. }
  32555. return cached;
  32556. }
  32557. const image = createElementNS( 'img' );
  32558. function onImageLoad() {
  32559. removeEventListeners();
  32560. if ( onLoad ) onLoad( this );
  32561. //
  32562. const callbacks = _loading.get( this ) || [];
  32563. for ( let i = 0; i < callbacks.length; i ++ ) {
  32564. const callback = callbacks[ i ];
  32565. if ( callback.onLoad ) callback.onLoad( this );
  32566. }
  32567. _loading.delete( this );
  32568. scope.manager.itemEnd( url );
  32569. }
  32570. function onImageError( event ) {
  32571. removeEventListeners();
  32572. if ( onError ) onError( event );
  32573. Cache.remove( `image:${url}` );
  32574. //
  32575. const callbacks = _loading.get( this ) || [];
  32576. for ( let i = 0; i < callbacks.length; i ++ ) {
  32577. const callback = callbacks[ i ];
  32578. if ( callback.onError ) callback.onError( event );
  32579. }
  32580. _loading.delete( this );
  32581. scope.manager.itemError( url );
  32582. scope.manager.itemEnd( url );
  32583. }
  32584. function removeEventListeners() {
  32585. image.removeEventListener( 'load', onImageLoad, false );
  32586. image.removeEventListener( 'error', onImageError, false );
  32587. }
  32588. image.addEventListener( 'load', onImageLoad, false );
  32589. image.addEventListener( 'error', onImageError, false );
  32590. if ( url.slice( 0, 5 ) !== 'data:' ) {
  32591. if ( this.crossOrigin !== undefined ) image.crossOrigin = this.crossOrigin;
  32592. }
  32593. Cache.add( `image:${url}`, image );
  32594. scope.manager.itemStart( url );
  32595. image.src = url;
  32596. return image;
  32597. }
  32598. }
  32599. /**
  32600. * Class for loading cube textures. Images are internally loaded via {@link ImageLoader}.
  32601. *
  32602. * The loader returns an instance of {@link CubeTexture} and expects the cube map to
  32603. * be defined as six separate images representing the sides of a cube. Other cube map definitions
  32604. * like vertical and horizontal cross, column and row layouts are not supported.
  32605. *
  32606. * Note that, by convention, cube maps are specified in a coordinate system
  32607. * in which positive-x is to the right when looking up the positive-z axis --
  32608. * in other words, using a left-handed coordinate system. Since three.js uses
  32609. * a right-handed coordinate system, environment maps used in three.js will
  32610. * have pos-x and neg-x swapped.
  32611. *
  32612. * The loaded cube texture is in sRGB color space. Meaning {@link Texture#colorSpace}
  32613. * is set to `SRGBColorSpace` by default.
  32614. *
  32615. * ```js
  32616. * const loader = new THREE.CubeTextureLoader().setPath( 'textures/cubeMaps/' );
  32617. * const cubeTexture = await loader.loadAsync( [
  32618. * 'px.png', 'nx.png', 'py.png', 'ny.png', 'pz.png', 'nz.png'
  32619. * ] );
  32620. * scene.background = cubeTexture;
  32621. * ```
  32622. *
  32623. * @augments Loader
  32624. */
  32625. class CubeTextureLoader extends Loader {
  32626. /**
  32627. * Constructs a new cube texture loader.
  32628. *
  32629. * @param {LoadingManager} [manager] - The loading manager.
  32630. */
  32631. constructor( manager ) {
  32632. super( manager );
  32633. }
  32634. /**
  32635. * Starts loading from the given URL and pass the fully loaded cube texture
  32636. * to the `onLoad()` callback. The method also returns a new cube texture object which can
  32637. * directly be used for material creation. If you do it this way, the cube texture
  32638. * may pop up in your scene once the respective loading process is finished.
  32639. *
  32640. * @param {Array<string>} urls - Array of 6 URLs to images, one for each side of the
  32641. * cube texture. The urls should be specified in the following order: pos-x,
  32642. * neg-x, pos-y, neg-y, pos-z, neg-z. An array of data URIs are allowed as well.
  32643. * @param {function(CubeTexture)} onLoad - Executed when the loading process has been finished.
  32644. * @param {onProgressCallback} onProgress - Unsupported in this loader.
  32645. * @param {onErrorCallback} onError - Executed when errors occur.
  32646. * @return {CubeTexture} The cube texture.
  32647. */
  32648. load( urls, onLoad, onProgress, onError ) {
  32649. const texture = new CubeTexture();
  32650. texture.colorSpace = SRGBColorSpace;
  32651. const loader = new ImageLoader( this.manager );
  32652. loader.setCrossOrigin( this.crossOrigin );
  32653. loader.setPath( this.path );
  32654. let loaded = 0;
  32655. function loadTexture( i ) {
  32656. loader.load( urls[ i ], function ( image ) {
  32657. texture.images[ i ] = image;
  32658. loaded ++;
  32659. if ( loaded === 6 ) {
  32660. texture.needsUpdate = true;
  32661. if ( onLoad ) onLoad( texture );
  32662. }
  32663. }, undefined, onError );
  32664. }
  32665. for ( let i = 0; i < urls.length; ++ i ) {
  32666. loadTexture( i );
  32667. }
  32668. return texture;
  32669. }
  32670. }
  32671. /**
  32672. * Abstract base class for loading binary texture formats RGBE, EXR or TGA.
  32673. * Textures are internally loaded via {@link FileLoader}.
  32674. *
  32675. * Derived classes have to implement the `parse()` method which holds the parsing
  32676. * for the respective format.
  32677. *
  32678. * @abstract
  32679. * @augments Loader
  32680. */
  32681. class DataTextureLoader extends Loader {
  32682. /**
  32683. * Constructs a new data texture loader.
  32684. *
  32685. * @param {LoadingManager} [manager] - The loading manager.
  32686. */
  32687. constructor( manager ) {
  32688. super( manager );
  32689. }
  32690. /**
  32691. * Starts loading from the given URL and passes the loaded data texture
  32692. * to the `onLoad()` callback. The method also returns a new texture object which can
  32693. * directly be used for material creation. If you do it this way, the texture
  32694. * may pop up in your scene once the respective loading process is finished.
  32695. *
  32696. * @param {string} url - The path/URL of the file to be loaded. This can also be a data URI.
  32697. * @param {function(DataTexture)} onLoad - Executed when the loading process has been finished.
  32698. * @param {onProgressCallback} onProgress - Executed while the loading is in progress.
  32699. * @param {onErrorCallback} onError - Executed when errors occur.
  32700. * @return {DataTexture} The data texture.
  32701. */
  32702. load( url, onLoad, onProgress, onError ) {
  32703. const scope = this;
  32704. const texture = new DataTexture();
  32705. const loader = new FileLoader( this.manager );
  32706. loader.setResponseType( 'arraybuffer' );
  32707. loader.setRequestHeader( this.requestHeader );
  32708. loader.setPath( this.path );
  32709. loader.setWithCredentials( scope.withCredentials );
  32710. loader.load( url, function ( buffer ) {
  32711. let texData;
  32712. try {
  32713. texData = scope.parse( buffer );
  32714. } catch ( error ) {
  32715. if ( onError !== undefined ) {
  32716. onError( error );
  32717. } else {
  32718. error( error );
  32719. return;
  32720. }
  32721. }
  32722. if ( texData.image !== undefined ) {
  32723. texture.image = texData.image;
  32724. } else if ( texData.data !== undefined ) {
  32725. texture.image.width = texData.width;
  32726. texture.image.height = texData.height;
  32727. texture.image.data = texData.data;
  32728. }
  32729. texture.wrapS = texData.wrapS !== undefined ? texData.wrapS : ClampToEdgeWrapping;
  32730. texture.wrapT = texData.wrapT !== undefined ? texData.wrapT : ClampToEdgeWrapping;
  32731. texture.magFilter = texData.magFilter !== undefined ? texData.magFilter : LinearFilter;
  32732. texture.minFilter = texData.minFilter !== undefined ? texData.minFilter : LinearFilter;
  32733. texture.anisotropy = texData.anisotropy !== undefined ? texData.anisotropy : 1;
  32734. if ( texData.colorSpace !== undefined ) {
  32735. texture.colorSpace = texData.colorSpace;
  32736. }
  32737. if ( texData.flipY !== undefined ) {
  32738. texture.flipY = texData.flipY;
  32739. }
  32740. if ( texData.format !== undefined ) {
  32741. texture.format = texData.format;
  32742. }
  32743. if ( texData.type !== undefined ) {
  32744. texture.type = texData.type;
  32745. }
  32746. if ( texData.mipmaps !== undefined ) {
  32747. texture.mipmaps = texData.mipmaps;
  32748. texture.minFilter = LinearMipmapLinearFilter; // presumably...
  32749. }
  32750. if ( texData.mipmapCount === 1 ) {
  32751. texture.minFilter = LinearFilter;
  32752. }
  32753. if ( texData.generateMipmaps !== undefined ) {
  32754. texture.generateMipmaps = texData.generateMipmaps;
  32755. }
  32756. texture.needsUpdate = true;
  32757. if ( onLoad ) onLoad( texture, texData );
  32758. }, onProgress, onError );
  32759. return texture;
  32760. }
  32761. }
  32762. /**
  32763. * Class for loading textures. Images are internally
  32764. * loaded via {@link ImageLoader}.
  32765. *
  32766. * ```js
  32767. * const loader = new THREE.TextureLoader();
  32768. * const texture = await loader.loadAsync( 'textures/land_ocean_ice_cloud_2048.jpg' );
  32769. *
  32770. * const material = new THREE.MeshBasicMaterial( { map:texture } );
  32771. * ```
  32772. * Please note that `TextureLoader` has dropped support for progress
  32773. * events in `r84`. For a `TextureLoader` that supports progress events, see
  32774. * [this thread](https://github.com/mrdoob/three.js/issues/10439#issuecomment-293260145).
  32775. *
  32776. * @augments Loader
  32777. */
  32778. class TextureLoader extends Loader {
  32779. /**
  32780. * Constructs a new texture loader.
  32781. *
  32782. * @param {LoadingManager} [manager] - The loading manager.
  32783. */
  32784. constructor( manager ) {
  32785. super( manager );
  32786. }
  32787. /**
  32788. * Starts loading from the given URL and pass the fully loaded texture
  32789. * to the `onLoad()` callback. The method also returns a new texture object which can
  32790. * directly be used for material creation. If you do it this way, the texture
  32791. * may pop up in your scene once the respective loading process is finished.
  32792. *
  32793. * @param {string} url - The path/URL of the file to be loaded. This can also be a data URI.
  32794. * @param {function(Texture)} onLoad - Executed when the loading process has been finished.
  32795. * @param {onProgressCallback} onProgress - Unsupported in this loader.
  32796. * @param {onErrorCallback} onError - Executed when errors occur.
  32797. * @return {Texture} The texture.
  32798. */
  32799. load( url, onLoad, onProgress, onError ) {
  32800. const texture = new Texture();
  32801. const loader = new ImageLoader( this.manager );
  32802. loader.setCrossOrigin( this.crossOrigin );
  32803. loader.setPath( this.path );
  32804. loader.load( url, function ( image ) {
  32805. texture.image = image;
  32806. texture.needsUpdate = true;
  32807. if ( onLoad !== undefined ) {
  32808. onLoad( texture );
  32809. }
  32810. }, onProgress, onError );
  32811. return texture;
  32812. }
  32813. }
  32814. /**
  32815. * Abstract base class for lights - all other light types inherit the
  32816. * properties and methods described here.
  32817. *
  32818. * @abstract
  32819. * @augments Object3D
  32820. */
  32821. class Light extends Object3D {
  32822. /**
  32823. * Constructs a new light.
  32824. *
  32825. * @param {(number|Color|string)} [color=0xffffff] - The light's color.
  32826. * @param {number} [intensity=1] - The light's strength/intensity.
  32827. */
  32828. constructor( color, intensity = 1 ) {
  32829. super();
  32830. /**
  32831. * This flag can be used for type testing.
  32832. *
  32833. * @type {boolean}
  32834. * @readonly
  32835. * @default true
  32836. */
  32837. this.isLight = true;
  32838. this.type = 'Light';
  32839. /**
  32840. * The light's color.
  32841. *
  32842. * @type {Color}
  32843. */
  32844. this.color = new Color( color );
  32845. /**
  32846. * The light's intensity.
  32847. *
  32848. * @type {number}
  32849. * @default 1
  32850. */
  32851. this.intensity = intensity;
  32852. }
  32853. /**
  32854. * Frees the GPU-related resources allocated by this instance. Call this
  32855. * method whenever this instance is no longer used in your app.
  32856. */
  32857. dispose() {
  32858. this.dispatchEvent( { type: 'dispose' } );
  32859. }
  32860. copy( source, recursive ) {
  32861. super.copy( source, recursive );
  32862. this.color.copy( source.color );
  32863. this.intensity = source.intensity;
  32864. return this;
  32865. }
  32866. toJSON( meta ) {
  32867. const data = super.toJSON( meta );
  32868. data.object.color = this.color.getHex();
  32869. data.object.intensity = this.intensity;
  32870. return data;
  32871. }
  32872. }
  32873. /**
  32874. * A light source positioned directly above the scene, with color fading from
  32875. * the sky color to the ground color.
  32876. *
  32877. * This light cannot be used to cast shadows.
  32878. *
  32879. * ```js
  32880. * const light = new THREE.HemisphereLight( 0xffffbb, 0x080820, 1 );
  32881. * scene.add( light );
  32882. * ```
  32883. *
  32884. * @augments Light
  32885. */
  32886. class HemisphereLight extends Light {
  32887. /**
  32888. * Constructs a new hemisphere light.
  32889. *
  32890. * @param {(number|Color|string)} [skyColor=0xffffff] - The light's sky color.
  32891. * @param {(number|Color|string)} [groundColor=0xffffff] - The light's ground color.
  32892. * @param {number} [intensity=1] - The light's strength/intensity.
  32893. */
  32894. constructor( skyColor, groundColor, intensity ) {
  32895. super( skyColor, intensity );
  32896. /**
  32897. * This flag can be used for type testing.
  32898. *
  32899. * @type {boolean}
  32900. * @readonly
  32901. * @default true
  32902. */
  32903. this.isHemisphereLight = true;
  32904. this.type = 'HemisphereLight';
  32905. this.position.copy( Object3D.DEFAULT_UP );
  32906. this.updateMatrix();
  32907. /**
  32908. * The light's ground color.
  32909. *
  32910. * @type {Color}
  32911. */
  32912. this.groundColor = new Color( groundColor );
  32913. }
  32914. copy( source, recursive ) {
  32915. super.copy( source, recursive );
  32916. this.groundColor.copy( source.groundColor );
  32917. return this;
  32918. }
  32919. toJSON( meta ) {
  32920. const data = super.toJSON( meta );
  32921. data.object.groundColor = this.groundColor.getHex();
  32922. return data;
  32923. }
  32924. }
  32925. const _projScreenMatrix = /*@__PURE__*/ new Matrix4();
  32926. const _lightPositionWorld = /*@__PURE__*/ new Vector3();
  32927. const _lookTarget = /*@__PURE__*/ new Vector3();
  32928. /**
  32929. * Abstract base class for light shadow classes. These classes
  32930. * represent the shadow configuration for different light types.
  32931. *
  32932. * @abstract
  32933. */
  32934. class LightShadow {
  32935. /**
  32936. * Constructs a new light shadow.
  32937. *
  32938. * @param {Camera} camera - The light's view of the world.
  32939. */
  32940. constructor( camera ) {
  32941. /**
  32942. * The light's view of the world.
  32943. *
  32944. * @type {Camera}
  32945. */
  32946. this.camera = camera;
  32947. /**
  32948. * The intensity of the shadow. The default is `1`.
  32949. * Valid values are in the range `[0, 1]`.
  32950. *
  32951. * @type {number}
  32952. * @default 1
  32953. */
  32954. this.intensity = 1;
  32955. /**
  32956. * Shadow map bias, how much to add or subtract from the normalized depth
  32957. * when deciding whether a surface is in shadow.
  32958. *
  32959. * The default is `0`. Very tiny adjustments here (in the order of `0.0001`)
  32960. * may help reduce artifacts in shadows.
  32961. *
  32962. * @type {number}
  32963. * @default 0
  32964. */
  32965. this.bias = 0;
  32966. /**
  32967. * A node version of `bias`. Only supported with `WebGPURenderer`.
  32968. *
  32969. * If a bias node is defined, `bias` has no effect.
  32970. *
  32971. * @type {?Node<float>}
  32972. * @default null
  32973. */
  32974. this.biasNode = null;
  32975. /**
  32976. * Defines how much the position used to query the shadow map is offset along
  32977. * the object normal. The default is `0`. Increasing this value can be used to
  32978. * reduce shadow acne especially in large scenes where light shines onto
  32979. * geometry at a shallow angle. The cost is that shadows may appear distorted.
  32980. *
  32981. * @type {number}
  32982. * @default 0
  32983. */
  32984. this.normalBias = 0;
  32985. /**
  32986. * Setting this to values greater than 1 will blur the edges of the shadow.
  32987. * High values will cause unwanted banding effects in the shadows - a greater
  32988. * map size will allow for a higher value to be used here before these effects
  32989. * become visible.
  32990. *
  32991. * The property has no effect when the shadow map type is `BasicShadowMap`.
  32992. *
  32993. * @type {number}
  32994. * @default 1
  32995. */
  32996. this.radius = 1;
  32997. /**
  32998. * The amount of samples to use when blurring a VSM shadow map.
  32999. *
  33000. * @type {number}
  33001. * @default 8
  33002. */
  33003. this.blurSamples = 8;
  33004. /**
  33005. * Defines the width and height of the shadow map. Higher values give better quality
  33006. * shadows at the cost of computation time. Values must be powers of two.
  33007. *
  33008. * @type {Vector2}
  33009. * @default (512,512)
  33010. */
  33011. this.mapSize = new Vector2( 512, 512 );
  33012. /**
  33013. * The type of shadow texture. The default is `UnsignedByteType`.
  33014. *
  33015. * @type {number}
  33016. * @default UnsignedByteType
  33017. */
  33018. this.mapType = UnsignedByteType;
  33019. /**
  33020. * The depth map generated using the internal camera; a location beyond a
  33021. * pixel's depth is in shadow. Computed internally during rendering.
  33022. *
  33023. * @type {?RenderTarget}
  33024. * @default null
  33025. */
  33026. this.map = null;
  33027. /**
  33028. * The distribution map generated using the internal camera; an occlusion is
  33029. * calculated based on the distribution of depths. Computed internally during
  33030. * rendering.
  33031. *
  33032. * @type {?RenderTarget}
  33033. * @default null
  33034. */
  33035. this.mapPass = null;
  33036. /**
  33037. * Model to shadow camera space, to compute location and depth in shadow map.
  33038. * This is computed internally during rendering.
  33039. *
  33040. * @type {Matrix4}
  33041. */
  33042. this.matrix = new Matrix4();
  33043. /**
  33044. * Enables automatic updates of the light's shadow. If you do not require dynamic
  33045. * lighting / shadows, you may set this to `false`.
  33046. *
  33047. * @type {boolean}
  33048. * @default true
  33049. */
  33050. this.autoUpdate = true;
  33051. /**
  33052. * When set to `true`, shadow maps will be updated in the next `render` call.
  33053. * If you have set {@link LightShadow#autoUpdate} to `false`, you will need to
  33054. * set this property to `true` and then make a render call to update the light's shadow.
  33055. *
  33056. * @type {boolean}
  33057. * @default false
  33058. */
  33059. this.needsUpdate = false;
  33060. this._frustum = new Frustum();
  33061. this._frameExtents = new Vector2( 1, 1 );
  33062. this._viewportCount = 1;
  33063. this._viewports = [
  33064. new Vector4( 0, 0, 1, 1 )
  33065. ];
  33066. }
  33067. /**
  33068. * Used internally by the renderer to get the number of viewports that need
  33069. * to be rendered for this shadow.
  33070. *
  33071. * @return {number} The viewport count.
  33072. */
  33073. getViewportCount() {
  33074. return this._viewportCount;
  33075. }
  33076. /**
  33077. * Gets the shadow cameras frustum. Used internally by the renderer to cull objects.
  33078. *
  33079. * @return {Frustum} The shadow camera frustum.
  33080. */
  33081. getFrustum() {
  33082. return this._frustum;
  33083. }
  33084. /**
  33085. * Update the matrices for the camera and shadow, used internally by the renderer.
  33086. *
  33087. * @param {Light} light - The light for which the shadow is being rendered.
  33088. */
  33089. updateMatrices( light ) {
  33090. const shadowCamera = this.camera;
  33091. const shadowMatrix = this.matrix;
  33092. _lightPositionWorld.setFromMatrixPosition( light.matrixWorld );
  33093. shadowCamera.position.copy( _lightPositionWorld );
  33094. _lookTarget.setFromMatrixPosition( light.target.matrixWorld );
  33095. shadowCamera.lookAt( _lookTarget );
  33096. shadowCamera.updateMatrixWorld();
  33097. _projScreenMatrix.multiplyMatrices( shadowCamera.projectionMatrix, shadowCamera.matrixWorldInverse );
  33098. this._frustum.setFromProjectionMatrix( _projScreenMatrix, shadowCamera.coordinateSystem, shadowCamera.reversedDepth );
  33099. if ( shadowCamera.reversedDepth ) {
  33100. shadowMatrix.set(
  33101. 0.5, 0.0, 0.0, 0.5,
  33102. 0.0, 0.5, 0.0, 0.5,
  33103. 0.0, 0.0, 1.0, 0.0,
  33104. 0.0, 0.0, 0.0, 1.0
  33105. );
  33106. } else {
  33107. shadowMatrix.set(
  33108. 0.5, 0.0, 0.0, 0.5,
  33109. 0.0, 0.5, 0.0, 0.5,
  33110. 0.0, 0.0, 0.5, 0.5,
  33111. 0.0, 0.0, 0.0, 1.0
  33112. );
  33113. }
  33114. shadowMatrix.multiply( _projScreenMatrix );
  33115. }
  33116. /**
  33117. * Returns a viewport definition for the given viewport index.
  33118. *
  33119. * @param {number} viewportIndex - The viewport index.
  33120. * @return {Vector4} The viewport.
  33121. */
  33122. getViewport( viewportIndex ) {
  33123. return this._viewports[ viewportIndex ];
  33124. }
  33125. /**
  33126. * Returns the frame extends.
  33127. *
  33128. * @return {Vector2} The frame extends.
  33129. */
  33130. getFrameExtents() {
  33131. return this._frameExtents;
  33132. }
  33133. /**
  33134. * Frees the GPU-related resources allocated by this instance. Call this
  33135. * method whenever this instance is no longer used in your app.
  33136. */
  33137. dispose() {
  33138. if ( this.map ) {
  33139. this.map.dispose();
  33140. }
  33141. if ( this.mapPass ) {
  33142. this.mapPass.dispose();
  33143. }
  33144. }
  33145. /**
  33146. * Copies the values of the given light shadow instance to this instance.
  33147. *
  33148. * @param {LightShadow} source - The light shadow to copy.
  33149. * @return {LightShadow} A reference to this light shadow instance.
  33150. */
  33151. copy( source ) {
  33152. this.camera = source.camera.clone();
  33153. this.intensity = source.intensity;
  33154. this.bias = source.bias;
  33155. this.radius = source.radius;
  33156. this.autoUpdate = source.autoUpdate;
  33157. this.needsUpdate = source.needsUpdate;
  33158. this.normalBias = source.normalBias;
  33159. this.blurSamples = source.blurSamples;
  33160. this.mapSize.copy( source.mapSize );
  33161. this.biasNode = source.biasNode;
  33162. return this;
  33163. }
  33164. /**
  33165. * Returns a new light shadow instance with copied values from this instance.
  33166. *
  33167. * @return {LightShadow} A clone of this instance.
  33168. */
  33169. clone() {
  33170. return new this.constructor().copy( this );
  33171. }
  33172. /**
  33173. * Serializes the light shadow into JSON.
  33174. *
  33175. * @return {Object} A JSON object representing the serialized light shadow.
  33176. * @see {@link ObjectLoader#parse}
  33177. */
  33178. toJSON() {
  33179. const object = {};
  33180. if ( this.intensity !== 1 ) object.intensity = this.intensity;
  33181. if ( this.bias !== 0 ) object.bias = this.bias;
  33182. if ( this.normalBias !== 0 ) object.normalBias = this.normalBias;
  33183. if ( this.radius !== 1 ) object.radius = this.radius;
  33184. if ( this.mapSize.x !== 512 || this.mapSize.y !== 512 ) object.mapSize = this.mapSize.toArray();
  33185. object.camera = this.camera.toJSON( false ).object;
  33186. delete object.camera.matrix;
  33187. return object;
  33188. }
  33189. }
  33190. const _position$2 = /*@__PURE__*/ new Vector3();
  33191. const _quaternion$2 = /*@__PURE__*/ new Quaternion();
  33192. const _scale$2 = /*@__PURE__*/ new Vector3();
  33193. /**
  33194. * Abstract base class for cameras. This class should always be inherited
  33195. * when you build a new camera.
  33196. *
  33197. * @abstract
  33198. * @augments Object3D
  33199. */
  33200. class Camera extends Object3D {
  33201. /**
  33202. * Constructs a new camera.
  33203. */
  33204. constructor() {
  33205. super();
  33206. /**
  33207. * This flag can be used for type testing.
  33208. *
  33209. * @type {boolean}
  33210. * @readonly
  33211. * @default true
  33212. */
  33213. this.isCamera = true;
  33214. this.type = 'Camera';
  33215. /**
  33216. * The inverse of the camera's world matrix.
  33217. *
  33218. * @type {Matrix4}
  33219. */
  33220. this.matrixWorldInverse = new Matrix4();
  33221. /**
  33222. * The camera's projection matrix.
  33223. *
  33224. * @type {Matrix4}
  33225. */
  33226. this.projectionMatrix = new Matrix4();
  33227. /**
  33228. * The inverse of the camera's projection matrix.
  33229. *
  33230. * @type {Matrix4}
  33231. */
  33232. this.projectionMatrixInverse = new Matrix4();
  33233. /**
  33234. * The coordinate system in which the camera is used.
  33235. *
  33236. * @type {(WebGLCoordinateSystem|WebGPUCoordinateSystem)}
  33237. */
  33238. this.coordinateSystem = WebGLCoordinateSystem;
  33239. this._reversedDepth = false;
  33240. }
  33241. /**
  33242. * The flag that indicates whether the camera uses a reversed depth buffer.
  33243. *
  33244. * @type {boolean}
  33245. * @default false
  33246. */
  33247. get reversedDepth() {
  33248. return this._reversedDepth;
  33249. }
  33250. copy( source, recursive ) {
  33251. super.copy( source, recursive );
  33252. this.matrixWorldInverse.copy( source.matrixWorldInverse );
  33253. this.projectionMatrix.copy( source.projectionMatrix );
  33254. this.projectionMatrixInverse.copy( source.projectionMatrixInverse );
  33255. this.coordinateSystem = source.coordinateSystem;
  33256. return this;
  33257. }
  33258. /**
  33259. * Returns a vector representing the ("look") direction of the 3D object in world space.
  33260. *
  33261. * This method is overwritten since cameras have a different forward vector compared to other
  33262. * 3D objects. A camera looks down its local, negative z-axis by default.
  33263. *
  33264. * @param {Vector3} target - The target vector the result is stored to.
  33265. * @return {Vector3} The 3D object's direction in world space.
  33266. */
  33267. getWorldDirection( target ) {
  33268. return super.getWorldDirection( target ).negate();
  33269. }
  33270. updateMatrixWorld( force ) {
  33271. super.updateMatrixWorld( force );
  33272. // exclude scale from view matrix to be glTF conform
  33273. this.matrixWorld.decompose( _position$2, _quaternion$2, _scale$2 );
  33274. if ( _scale$2.x === 1 && _scale$2.y === 1 && _scale$2.z === 1 ) {
  33275. this.matrixWorldInverse.copy( this.matrixWorld ).invert();
  33276. } else {
  33277. this.matrixWorldInverse.compose( _position$2, _quaternion$2, _scale$2.set( 1, 1, 1 ) ).invert();
  33278. }
  33279. }
  33280. updateWorldMatrix( updateParents, updateChildren ) {
  33281. super.updateWorldMatrix( updateParents, updateChildren );
  33282. // exclude scale from view matrix to be glTF conform
  33283. this.matrixWorld.decompose( _position$2, _quaternion$2, _scale$2 );
  33284. if ( _scale$2.x === 1 && _scale$2.y === 1 && _scale$2.z === 1 ) {
  33285. this.matrixWorldInverse.copy( this.matrixWorld ).invert();
  33286. } else {
  33287. this.matrixWorldInverse.compose( _position$2, _quaternion$2, _scale$2.set( 1, 1, 1 ) ).invert();
  33288. }
  33289. }
  33290. clone() {
  33291. return new this.constructor().copy( this );
  33292. }
  33293. }
  33294. const _v3$1 = /*@__PURE__*/ new Vector3();
  33295. const _minTarget = /*@__PURE__*/ new Vector2();
  33296. const _maxTarget = /*@__PURE__*/ new Vector2();
  33297. /**
  33298. * Camera that uses [perspective projection](https://en.wikipedia.org/wiki/Perspective_(graphical)).
  33299. *
  33300. * This projection mode is designed to mimic the way the human eye sees. It
  33301. * is the most common projection mode used for rendering a 3D scene.
  33302. *
  33303. * ```js
  33304. * const camera = new THREE.PerspectiveCamera( 45, width / height, 1, 1000 );
  33305. * scene.add( camera );
  33306. * ```
  33307. *
  33308. * @augments Camera
  33309. */
  33310. class PerspectiveCamera extends Camera {
  33311. /**
  33312. * Constructs a new perspective camera.
  33313. *
  33314. * @param {number} [fov=50] - The vertical field of view.
  33315. * @param {number} [aspect=1] - The aspect ratio.
  33316. * @param {number} [near=0.1] - The camera's near plane.
  33317. * @param {number} [far=2000] - The camera's far plane.
  33318. */
  33319. constructor( fov = 50, aspect = 1, near = 0.1, far = 2000 ) {
  33320. super();
  33321. /**
  33322. * This flag can be used for type testing.
  33323. *
  33324. * @type {boolean}
  33325. * @readonly
  33326. * @default true
  33327. */
  33328. this.isPerspectiveCamera = true;
  33329. this.type = 'PerspectiveCamera';
  33330. /**
  33331. * The vertical field of view, from bottom to top of view,
  33332. * in degrees.
  33333. *
  33334. * @type {number}
  33335. * @default 50
  33336. */
  33337. this.fov = fov;
  33338. /**
  33339. * The zoom factor of the camera.
  33340. *
  33341. * @type {number}
  33342. * @default 1
  33343. */
  33344. this.zoom = 1;
  33345. /**
  33346. * The camera's near plane. The valid range is greater than `0`
  33347. * and less than the current value of {@link PerspectiveCamera#far}.
  33348. *
  33349. * Note that, unlike for the {@link OrthographicCamera}, `0` is <em>not</em> a
  33350. * valid value for a perspective camera's near plane.
  33351. *
  33352. * @type {number}
  33353. * @default 0.1
  33354. */
  33355. this.near = near;
  33356. /**
  33357. * The camera's far plane. Must be greater than the
  33358. * current value of {@link PerspectiveCamera#near}.
  33359. *
  33360. * @type {number}
  33361. * @default 2000
  33362. */
  33363. this.far = far;
  33364. /**
  33365. * Object distance used for stereoscopy and depth-of-field effects. This
  33366. * parameter does not influence the projection matrix unless a
  33367. * {@link StereoCamera} is being used.
  33368. *
  33369. * @type {number}
  33370. * @default 10
  33371. */
  33372. this.focus = 10;
  33373. /**
  33374. * The aspect ratio, usually the canvas width / canvas height.
  33375. *
  33376. * @type {number}
  33377. * @default 1
  33378. */
  33379. this.aspect = aspect;
  33380. /**
  33381. * Represents the frustum window specification. This property should not be edited
  33382. * directly but via {@link PerspectiveCamera#setViewOffset} and {@link PerspectiveCamera#clearViewOffset}.
  33383. *
  33384. * @type {?Object}
  33385. * @default null
  33386. */
  33387. this.view = null;
  33388. /**
  33389. * Film size used for the larger axis. Default is `35` (millimeters). This
  33390. * parameter does not influence the projection matrix unless {@link PerspectiveCamera#filmOffset}
  33391. * is set to a nonzero value.
  33392. *
  33393. * @type {number}
  33394. * @default 35
  33395. */
  33396. this.filmGauge = 35;
  33397. /**
  33398. * Horizontal off-center offset in the same unit as {@link PerspectiveCamera#filmGauge}.
  33399. *
  33400. * @type {number}
  33401. * @default 0
  33402. */
  33403. this.filmOffset = 0;
  33404. this.updateProjectionMatrix();
  33405. }
  33406. copy( source, recursive ) {
  33407. super.copy( source, recursive );
  33408. this.fov = source.fov;
  33409. this.zoom = source.zoom;
  33410. this.near = source.near;
  33411. this.far = source.far;
  33412. this.focus = source.focus;
  33413. this.aspect = source.aspect;
  33414. this.view = source.view === null ? null : Object.assign( {}, source.view );
  33415. this.filmGauge = source.filmGauge;
  33416. this.filmOffset = source.filmOffset;
  33417. return this;
  33418. }
  33419. /**
  33420. * Sets the FOV by focal length in respect to the current {@link PerspectiveCamera#filmGauge}.
  33421. *
  33422. * The default film gauge is 35, so that the focal length can be specified for
  33423. * a 35mm (full frame) camera.
  33424. *
  33425. * @param {number} focalLength - Values for focal length and film gauge must have the same unit.
  33426. */
  33427. setFocalLength( focalLength ) {
  33428. /** see {@link http://www.bobatkins.com/photography/technical/field_of_view.html} */
  33429. const vExtentSlope = 0.5 * this.getFilmHeight() / focalLength;
  33430. this.fov = RAD2DEG * 2 * Math.atan( vExtentSlope );
  33431. this.updateProjectionMatrix();
  33432. }
  33433. /**
  33434. * Returns the focal length from the current {@link PerspectiveCamera#fov} and
  33435. * {@link PerspectiveCamera#filmGauge}.
  33436. *
  33437. * @return {number} The computed focal length.
  33438. */
  33439. getFocalLength() {
  33440. const vExtentSlope = Math.tan( DEG2RAD * 0.5 * this.fov );
  33441. return 0.5 * this.getFilmHeight() / vExtentSlope;
  33442. }
  33443. /**
  33444. * Returns the current vertical field of view angle in degrees considering {@link PerspectiveCamera#zoom}.
  33445. *
  33446. * @return {number} The effective FOV.
  33447. */
  33448. getEffectiveFOV() {
  33449. return RAD2DEG * 2 * Math.atan(
  33450. Math.tan( DEG2RAD * 0.5 * this.fov ) / this.zoom );
  33451. }
  33452. /**
  33453. * Returns the width of the image on the film. If {@link PerspectiveCamera#aspect} is greater than or
  33454. * equal to one (landscape format), the result equals {@link PerspectiveCamera#filmGauge}.
  33455. *
  33456. * @return {number} The film width.
  33457. */
  33458. getFilmWidth() {
  33459. // film not completely covered in portrait format (aspect < 1)
  33460. return this.filmGauge * Math.min( this.aspect, 1 );
  33461. }
  33462. /**
  33463. * Returns the height of the image on the film. If {@link PerspectiveCamera#aspect} is greater than or
  33464. * equal to one (landscape format), the result equals {@link PerspectiveCamera#filmGauge}.
  33465. *
  33466. * @return {number} The film width.
  33467. */
  33468. getFilmHeight() {
  33469. // film not completely covered in landscape format (aspect > 1)
  33470. return this.filmGauge / Math.max( this.aspect, 1 );
  33471. }
  33472. /**
  33473. * Computes the 2D bounds of the camera's viewable rectangle at a given distance along the viewing direction.
  33474. * Sets `minTarget` and `maxTarget` to the coordinates of the lower-left and upper-right corners of the view rectangle.
  33475. *
  33476. * @param {number} distance - The viewing distance.
  33477. * @param {Vector2} minTarget - The lower-left corner of the view rectangle is written into this vector.
  33478. * @param {Vector2} maxTarget - The upper-right corner of the view rectangle is written into this vector.
  33479. */
  33480. getViewBounds( distance, minTarget, maxTarget ) {
  33481. _v3$1.set( -1, -1, 0.5 ).applyMatrix4( this.projectionMatrixInverse );
  33482. minTarget.set( _v3$1.x, _v3$1.y ).multiplyScalar( - distance / _v3$1.z );
  33483. _v3$1.set( 1, 1, 0.5 ).applyMatrix4( this.projectionMatrixInverse );
  33484. maxTarget.set( _v3$1.x, _v3$1.y ).multiplyScalar( - distance / _v3$1.z );
  33485. }
  33486. /**
  33487. * Computes the width and height of the camera's viewable rectangle at a given distance along the viewing direction.
  33488. *
  33489. * @param {number} distance - The viewing distance.
  33490. * @param {Vector2} target - The target vector that is used to store result where x is width and y is height.
  33491. * @returns {Vector2} The view size.
  33492. */
  33493. getViewSize( distance, target ) {
  33494. this.getViewBounds( distance, _minTarget, _maxTarget );
  33495. return target.subVectors( _maxTarget, _minTarget );
  33496. }
  33497. /**
  33498. * Sets an offset in a larger frustum. This is useful for multi-window or
  33499. * multi-monitor/multi-machine setups.
  33500. *
  33501. * For example, if you have 3x2 monitors and each monitor is 1920x1080 and
  33502. * the monitors are in grid like this
  33503. *```
  33504. * +---+---+---+
  33505. * | A | B | C |
  33506. * +---+---+---+
  33507. * | D | E | F |
  33508. * +---+---+---+
  33509. *```
  33510. * then for each monitor you would call it like this:
  33511. *```js
  33512. * const w = 1920;
  33513. * const h = 1080;
  33514. * const fullWidth = w * 3;
  33515. * const fullHeight = h * 2;
  33516. *
  33517. * // --A--
  33518. * camera.setViewOffset( fullWidth, fullHeight, w * 0, h * 0, w, h );
  33519. * // --B--
  33520. * camera.setViewOffset( fullWidth, fullHeight, w * 1, h * 0, w, h );
  33521. * // --C--
  33522. * camera.setViewOffset( fullWidth, fullHeight, w * 2, h * 0, w, h );
  33523. * // --D--
  33524. * camera.setViewOffset( fullWidth, fullHeight, w * 0, h * 1, w, h );
  33525. * // --E--
  33526. * camera.setViewOffset( fullWidth, fullHeight, w * 1, h * 1, w, h );
  33527. * // --F--
  33528. * camera.setViewOffset( fullWidth, fullHeight, w * 2, h * 1, w, h );
  33529. * ```
  33530. *
  33531. * Note there is no reason monitors have to be the same size or in a grid.
  33532. *
  33533. * @param {number} fullWidth - The full width of multiview setup.
  33534. * @param {number} fullHeight - The full height of multiview setup.
  33535. * @param {number} x - The horizontal offset of the subcamera.
  33536. * @param {number} y - The vertical offset of the subcamera.
  33537. * @param {number} width - The width of subcamera.
  33538. * @param {number} height - The height of subcamera.
  33539. */
  33540. setViewOffset( fullWidth, fullHeight, x, y, width, height ) {
  33541. this.aspect = fullWidth / fullHeight;
  33542. if ( this.view === null ) {
  33543. this.view = {
  33544. enabled: true,
  33545. fullWidth: 1,
  33546. fullHeight: 1,
  33547. offsetX: 0,
  33548. offsetY: 0,
  33549. width: 1,
  33550. height: 1
  33551. };
  33552. }
  33553. this.view.enabled = true;
  33554. this.view.fullWidth = fullWidth;
  33555. this.view.fullHeight = fullHeight;
  33556. this.view.offsetX = x;
  33557. this.view.offsetY = y;
  33558. this.view.width = width;
  33559. this.view.height = height;
  33560. this.updateProjectionMatrix();
  33561. }
  33562. /**
  33563. * Removes the view offset from the projection matrix.
  33564. */
  33565. clearViewOffset() {
  33566. if ( this.view !== null ) {
  33567. this.view.enabled = false;
  33568. }
  33569. this.updateProjectionMatrix();
  33570. }
  33571. /**
  33572. * Updates the camera's projection matrix. Must be called after any change of
  33573. * camera properties.
  33574. */
  33575. updateProjectionMatrix() {
  33576. const near = this.near;
  33577. let top = near * Math.tan( DEG2RAD * 0.5 * this.fov ) / this.zoom;
  33578. let height = 2 * top;
  33579. let width = this.aspect * height;
  33580. let left = -0.5 * width;
  33581. const view = this.view;
  33582. if ( this.view !== null && this.view.enabled ) {
  33583. const fullWidth = view.fullWidth,
  33584. fullHeight = view.fullHeight;
  33585. left += view.offsetX * width / fullWidth;
  33586. top -= view.offsetY * height / fullHeight;
  33587. width *= view.width / fullWidth;
  33588. height *= view.height / fullHeight;
  33589. }
  33590. const skew = this.filmOffset;
  33591. if ( skew !== 0 ) left += near * skew / this.getFilmWidth();
  33592. this.projectionMatrix.makePerspective( left, left + width, top, top - height, near, this.far, this.coordinateSystem, this.reversedDepth );
  33593. this.projectionMatrixInverse.copy( this.projectionMatrix ).invert();
  33594. }
  33595. toJSON( meta ) {
  33596. const data = super.toJSON( meta );
  33597. data.object.fov = this.fov;
  33598. data.object.zoom = this.zoom;
  33599. data.object.near = this.near;
  33600. data.object.far = this.far;
  33601. data.object.focus = this.focus;
  33602. data.object.aspect = this.aspect;
  33603. if ( this.view !== null ) data.object.view = Object.assign( {}, this.view );
  33604. data.object.filmGauge = this.filmGauge;
  33605. data.object.filmOffset = this.filmOffset;
  33606. return data;
  33607. }
  33608. }
  33609. /**
  33610. * Represents the shadow configuration of directional lights.
  33611. *
  33612. * @augments LightShadow
  33613. */
  33614. class SpotLightShadow extends LightShadow {
  33615. /**
  33616. * Constructs a new spot light shadow.
  33617. */
  33618. constructor() {
  33619. super( new PerspectiveCamera( 50, 1, 0.5, 500 ) );
  33620. /**
  33621. * This flag can be used for type testing.
  33622. *
  33623. * @type {boolean}
  33624. * @readonly
  33625. * @default true
  33626. */
  33627. this.isSpotLightShadow = true;
  33628. /**
  33629. * Used to focus the shadow camera. The camera's field of view is set as a
  33630. * percentage of the spotlight's field-of-view. Range is `[0, 1]`.
  33631. *
  33632. * @type {number}
  33633. * @default 1
  33634. */
  33635. this.focus = 1;
  33636. /**
  33637. * Texture aspect ratio.
  33638. *
  33639. * @type {number}
  33640. * @default 1
  33641. */
  33642. this.aspect = 1;
  33643. }
  33644. updateMatrices( light ) {
  33645. const camera = this.camera;
  33646. const fov = RAD2DEG * 2 * light.angle * this.focus;
  33647. const aspect = ( this.mapSize.width / this.mapSize.height ) * this.aspect;
  33648. const far = light.distance || camera.far;
  33649. if ( fov !== camera.fov || aspect !== camera.aspect || far !== camera.far ) {
  33650. camera.fov = fov;
  33651. camera.aspect = aspect;
  33652. camera.far = far;
  33653. camera.updateProjectionMatrix();
  33654. }
  33655. super.updateMatrices( light );
  33656. }
  33657. copy( source ) {
  33658. super.copy( source );
  33659. this.focus = source.focus;
  33660. return this;
  33661. }
  33662. }
  33663. /**
  33664. * This light gets emitted from a single point in one direction, along a cone
  33665. * that increases in size the further from the light it gets.
  33666. *
  33667. * This light can cast shadows - see the {@link SpotLightShadow} for details.
  33668. *
  33669. * ```js
  33670. * // white spotlight shining from the side, modulated by a texture
  33671. * const spotLight = new THREE.SpotLight( 0xffffff );
  33672. * spotLight.position.set( 100, 1000, 100 );
  33673. * spotLight.map = new THREE.TextureLoader().load( url );
  33674. *
  33675. * spotLight.castShadow = true;
  33676. * spotLight.shadow.mapSize.width = 1024;
  33677. * spotLight.shadow.mapSize.height = 1024;
  33678. * spotLight.shadow.camera.near = 500;
  33679. * spotLight.shadow.camera.far = 4000;
  33680. * spotLight.shadow.camera.fov = 30;s
  33681. * ```
  33682. *
  33683. * @augments Light
  33684. */
  33685. class SpotLight extends Light {
  33686. /**
  33687. * Constructs a new spot light.
  33688. *
  33689. * @param {(number|Color|string)} [color=0xffffff] - The light's color.
  33690. * @param {number} [intensity=1] - The light's strength/intensity measured in candela (cd).
  33691. * @param {number} [distance=0] - Maximum range of the light. `0` means no limit.
  33692. * @param {number} [angle=Math.PI/3] - Maximum angle of light dispersion from its direction whose upper bound is `Math.PI/2`.
  33693. * @param {number} [penumbra=0] - Percent of the spotlight cone that is attenuated due to penumbra. Value range is `[0,1]`.
  33694. * @param {number} [decay=2] - The amount the light dims along the distance of the light.
  33695. */
  33696. constructor( color, intensity, distance = 0, angle = Math.PI / 3, penumbra = 0, decay = 2 ) {
  33697. super( color, intensity );
  33698. /**
  33699. * This flag can be used for type testing.
  33700. *
  33701. * @type {boolean}
  33702. * @readonly
  33703. * @default true
  33704. */
  33705. this.isSpotLight = true;
  33706. this.type = 'SpotLight';
  33707. this.position.copy( Object3D.DEFAULT_UP );
  33708. this.updateMatrix();
  33709. /**
  33710. * The spot light points from its position to the
  33711. * target's position.
  33712. *
  33713. * For the target's position to be changed to anything other
  33714. * than the default, it must be added to the scene.
  33715. *
  33716. * It is also possible to set the target to be another 3D object
  33717. * in the scene. The light will now track the target object.
  33718. *
  33719. * @type {Object3D}
  33720. */
  33721. this.target = new Object3D();
  33722. /**
  33723. * Maximum range of the light. `0` means no limit.
  33724. *
  33725. * @type {number}
  33726. * @default 0
  33727. */
  33728. this.distance = distance;
  33729. /**
  33730. * Maximum angle of light dispersion from its direction whose upper bound is `Math.PI/2`.
  33731. *
  33732. * @type {number}
  33733. * @default Math.PI/3
  33734. */
  33735. this.angle = angle;
  33736. /**
  33737. * Percent of the spotlight cone that is attenuated due to penumbra.
  33738. * Value range is `[0,1]`.
  33739. *
  33740. * @type {number}
  33741. * @default 0
  33742. */
  33743. this.penumbra = penumbra;
  33744. /**
  33745. * The amount the light dims along the distance of the light. In context of
  33746. * physically-correct rendering the default value should not be changed.
  33747. *
  33748. * @type {number}
  33749. * @default 2
  33750. */
  33751. this.decay = decay;
  33752. /**
  33753. * A texture used to modulate the color of the light. The spot light
  33754. * color is mixed with the RGB value of this texture, with a ratio
  33755. * corresponding to its alpha value. The cookie-like masking effect is
  33756. * reproduced using pixel values (0, 0, 0, 1-cookie_value).
  33757. *
  33758. * *Warning*: This property is disabled if {@link Object3D#castShadow} is set to `false`.
  33759. *
  33760. * @type {?Texture}
  33761. * @default null
  33762. */
  33763. this.map = null;
  33764. /**
  33765. * This property holds the light's shadow configuration.
  33766. *
  33767. * @type {SpotLightShadow}
  33768. */
  33769. this.shadow = new SpotLightShadow();
  33770. }
  33771. /**
  33772. * The light's power. Power is the luminous power of the light measured in lumens (lm).
  33773. * Changing the power will also change the light's intensity.
  33774. *
  33775. * @type {number}
  33776. */
  33777. get power() {
  33778. // compute the light's luminous power (in lumens) from its intensity (in candela)
  33779. // by convention for a spotlight, luminous power (lm) = π * luminous intensity (cd)
  33780. return this.intensity * Math.PI;
  33781. }
  33782. set power( power ) {
  33783. // set the light's intensity (in candela) from the desired luminous power (in lumens)
  33784. this.intensity = power / Math.PI;
  33785. }
  33786. dispose() {
  33787. super.dispose();
  33788. this.shadow.dispose();
  33789. }
  33790. copy( source, recursive ) {
  33791. super.copy( source, recursive );
  33792. this.distance = source.distance;
  33793. this.angle = source.angle;
  33794. this.penumbra = source.penumbra;
  33795. this.decay = source.decay;
  33796. this.target = source.target.clone();
  33797. this.map = source.map;
  33798. this.shadow = source.shadow.clone();
  33799. return this;
  33800. }
  33801. toJSON( meta ) {
  33802. const data = super.toJSON( meta );
  33803. data.object.distance = this.distance;
  33804. data.object.angle = this.angle;
  33805. data.object.decay = this.decay;
  33806. data.object.penumbra = this.penumbra;
  33807. data.object.target = this.target.uuid;
  33808. if ( this.map && this.map.isTexture ) data.object.map = this.map.toJSON( meta ).uuid;
  33809. data.object.shadow = this.shadow.toJSON();
  33810. return data;
  33811. }
  33812. }
  33813. /**
  33814. * Represents the shadow configuration of point lights.
  33815. *
  33816. * @augments LightShadow
  33817. */
  33818. class PointLightShadow extends LightShadow {
  33819. /**
  33820. * Constructs a new point light shadow.
  33821. */
  33822. constructor() {
  33823. super( new PerspectiveCamera( 90, 1, 0.5, 500 ) );
  33824. /**
  33825. * This flag can be used for type testing.
  33826. *
  33827. * @type {boolean}
  33828. * @readonly
  33829. * @default true
  33830. */
  33831. this.isPointLightShadow = true;
  33832. }
  33833. }
  33834. /**
  33835. * A light that gets emitted from a single point in all directions. A common
  33836. * use case for this is to replicate the light emitted from a bare
  33837. * lightbulb.
  33838. *
  33839. * This light can cast shadows - see the {@link PointLightShadow} for details.
  33840. *
  33841. * ```js
  33842. * const light = new THREE.PointLight( 0xff0000, 1, 100 );
  33843. * light.position.set( 50, 50, 50 );
  33844. * scene.add( light );
  33845. * ```
  33846. *
  33847. * @augments Light
  33848. */
  33849. class PointLight extends Light {
  33850. /**
  33851. * Constructs a new point light.
  33852. *
  33853. * @param {(number|Color|string)} [color=0xffffff] - The light's color.
  33854. * @param {number} [intensity=1] - The light's strength/intensity measured in candela (cd).
  33855. * @param {number} [distance=0] - Maximum range of the light. `0` means no limit.
  33856. * @param {number} [decay=2] - The amount the light dims along the distance of the light.
  33857. */
  33858. constructor( color, intensity, distance = 0, decay = 2 ) {
  33859. super( color, intensity );
  33860. /**
  33861. * This flag can be used for type testing.
  33862. *
  33863. * @type {boolean}
  33864. * @readonly
  33865. * @default true
  33866. */
  33867. this.isPointLight = true;
  33868. this.type = 'PointLight';
  33869. /**
  33870. * When distance is zero, light will attenuate according to inverse-square
  33871. * law to infinite distance. When distance is non-zero, light will attenuate
  33872. * according to inverse-square law until near the distance cutoff, where it
  33873. * will then attenuate quickly and smoothly to 0. Inherently, cutoffs are not
  33874. * physically correct.
  33875. *
  33876. * @type {number}
  33877. * @default 0
  33878. */
  33879. this.distance = distance;
  33880. /**
  33881. * The amount the light dims along the distance of the light. In context of
  33882. * physically-correct rendering the default value should not be changed.
  33883. *
  33884. * @type {number}
  33885. * @default 2
  33886. */
  33887. this.decay = decay;
  33888. /**
  33889. * This property holds the light's shadow configuration.
  33890. *
  33891. * @type {PointLightShadow}
  33892. */
  33893. this.shadow = new PointLightShadow();
  33894. }
  33895. /**
  33896. * The light's power. Power is the luminous power of the light measured in lumens (lm).
  33897. * Changing the power will also change the light's intensity.
  33898. *
  33899. * @type {number}
  33900. */
  33901. get power() {
  33902. // compute the light's luminous power (in lumens) from its intensity (in candela)
  33903. // for an isotropic light source, luminous power (lm) = 4 π luminous intensity (cd)
  33904. return this.intensity * 4 * Math.PI;
  33905. }
  33906. set power( power ) {
  33907. // set the light's intensity (in candela) from the desired luminous power (in lumens)
  33908. this.intensity = power / ( 4 * Math.PI );
  33909. }
  33910. dispose() {
  33911. super.dispose();
  33912. this.shadow.dispose();
  33913. }
  33914. copy( source, recursive ) {
  33915. super.copy( source, recursive );
  33916. this.distance = source.distance;
  33917. this.decay = source.decay;
  33918. this.shadow = source.shadow.clone();
  33919. return this;
  33920. }
  33921. toJSON( meta ) {
  33922. const data = super.toJSON( meta );
  33923. data.object.distance = this.distance;
  33924. data.object.decay = this.decay;
  33925. data.object.shadow = this.shadow.toJSON();
  33926. return data;
  33927. }
  33928. }
  33929. /**
  33930. * Camera that uses [orthographic projection](https://en.wikipedia.org/wiki/Orthographic_projection).
  33931. *
  33932. * In this projection mode, an object's size in the rendered image stays
  33933. * constant regardless of its distance from the camera. This can be useful
  33934. * for rendering 2D scenes and UI elements, amongst other things.
  33935. *
  33936. * ```js
  33937. * const camera = new THREE.OrthographicCamera( width / - 2, width / 2, height / 2, height / - 2, 1, 1000 );
  33938. * scene.add( camera );
  33939. * ```
  33940. *
  33941. * @augments Camera
  33942. */
  33943. class OrthographicCamera extends Camera {
  33944. /**
  33945. * Constructs a new orthographic camera.
  33946. *
  33947. * @param {number} [left=-1] - The left plane of the camera's frustum.
  33948. * @param {number} [right=1] - The right plane of the camera's frustum.
  33949. * @param {number} [top=1] - The top plane of the camera's frustum.
  33950. * @param {number} [bottom=-1] - The bottom plane of the camera's frustum.
  33951. * @param {number} [near=0.1] - The camera's near plane.
  33952. * @param {number} [far=2000] - The camera's far plane.
  33953. */
  33954. constructor( left = -1, right = 1, top = 1, bottom = -1, near = 0.1, far = 2000 ) {
  33955. super();
  33956. /**
  33957. * This flag can be used for type testing.
  33958. *
  33959. * @type {boolean}
  33960. * @readonly
  33961. * @default true
  33962. */
  33963. this.isOrthographicCamera = true;
  33964. this.type = 'OrthographicCamera';
  33965. /**
  33966. * The zoom factor of the camera.
  33967. *
  33968. * @type {number}
  33969. * @default 1
  33970. */
  33971. this.zoom = 1;
  33972. /**
  33973. * Represents the frustum window specification. This property should not be edited
  33974. * directly but via {@link PerspectiveCamera#setViewOffset} and {@link PerspectiveCamera#clearViewOffset}.
  33975. *
  33976. * @type {?Object}
  33977. * @default null
  33978. */
  33979. this.view = null;
  33980. /**
  33981. * The left plane of the camera's frustum.
  33982. *
  33983. * @type {number}
  33984. * @default -1
  33985. */
  33986. this.left = left;
  33987. /**
  33988. * The right plane of the camera's frustum.
  33989. *
  33990. * @type {number}
  33991. * @default 1
  33992. */
  33993. this.right = right;
  33994. /**
  33995. * The top plane of the camera's frustum.
  33996. *
  33997. * @type {number}
  33998. * @default 1
  33999. */
  34000. this.top = top;
  34001. /**
  34002. * The bottom plane of the camera's frustum.
  34003. *
  34004. * @type {number}
  34005. * @default -1
  34006. */
  34007. this.bottom = bottom;
  34008. /**
  34009. * The camera's near plane. The valid range is greater than `0`
  34010. * and less than the current value of {@link OrthographicCamera#far}.
  34011. *
  34012. * Note that, unlike for the {@link PerspectiveCamera}, `0` is a
  34013. * valid value for an orthographic camera's near plane.
  34014. *
  34015. * @type {number}
  34016. * @default 0.1
  34017. */
  34018. this.near = near;
  34019. /**
  34020. * The camera's far plane. Must be greater than the
  34021. * current value of {@link OrthographicCamera#near}.
  34022. *
  34023. * @type {number}
  34024. * @default 2000
  34025. */
  34026. this.far = far;
  34027. this.updateProjectionMatrix();
  34028. }
  34029. copy( source, recursive ) {
  34030. super.copy( source, recursive );
  34031. this.left = source.left;
  34032. this.right = source.right;
  34033. this.top = source.top;
  34034. this.bottom = source.bottom;
  34035. this.near = source.near;
  34036. this.far = source.far;
  34037. this.zoom = source.zoom;
  34038. this.view = source.view === null ? null : Object.assign( {}, source.view );
  34039. return this;
  34040. }
  34041. /**
  34042. * Sets an offset in a larger frustum. This is useful for multi-window or
  34043. * multi-monitor/multi-machine setups.
  34044. *
  34045. * @param {number} fullWidth - The full width of multiview setup.
  34046. * @param {number} fullHeight - The full height of multiview setup.
  34047. * @param {number} x - The horizontal offset of the subcamera.
  34048. * @param {number} y - The vertical offset of the subcamera.
  34049. * @param {number} width - The width of subcamera.
  34050. * @param {number} height - The height of subcamera.
  34051. * @see {@link PerspectiveCamera#setViewOffset}
  34052. */
  34053. setViewOffset( fullWidth, fullHeight, x, y, width, height ) {
  34054. if ( this.view === null ) {
  34055. this.view = {
  34056. enabled: true,
  34057. fullWidth: 1,
  34058. fullHeight: 1,
  34059. offsetX: 0,
  34060. offsetY: 0,
  34061. width: 1,
  34062. height: 1
  34063. };
  34064. }
  34065. this.view.enabled = true;
  34066. this.view.fullWidth = fullWidth;
  34067. this.view.fullHeight = fullHeight;
  34068. this.view.offsetX = x;
  34069. this.view.offsetY = y;
  34070. this.view.width = width;
  34071. this.view.height = height;
  34072. this.updateProjectionMatrix();
  34073. }
  34074. /**
  34075. * Removes the view offset from the projection matrix.
  34076. */
  34077. clearViewOffset() {
  34078. if ( this.view !== null ) {
  34079. this.view.enabled = false;
  34080. }
  34081. this.updateProjectionMatrix();
  34082. }
  34083. /**
  34084. * Updates the camera's projection matrix. Must be called after any change of
  34085. * camera properties.
  34086. */
  34087. updateProjectionMatrix() {
  34088. const dx = ( this.right - this.left ) / ( 2 * this.zoom );
  34089. const dy = ( this.top - this.bottom ) / ( 2 * this.zoom );
  34090. const cx = ( this.right + this.left ) / 2;
  34091. const cy = ( this.top + this.bottom ) / 2;
  34092. let left = cx - dx;
  34093. let right = cx + dx;
  34094. let top = cy + dy;
  34095. let bottom = cy - dy;
  34096. if ( this.view !== null && this.view.enabled ) {
  34097. const scaleW = ( this.right - this.left ) / this.view.fullWidth / this.zoom;
  34098. const scaleH = ( this.top - this.bottom ) / this.view.fullHeight / this.zoom;
  34099. left += scaleW * this.view.offsetX;
  34100. right = left + scaleW * this.view.width;
  34101. top -= scaleH * this.view.offsetY;
  34102. bottom = top - scaleH * this.view.height;
  34103. }
  34104. this.projectionMatrix.makeOrthographic( left, right, top, bottom, this.near, this.far, this.coordinateSystem, this.reversedDepth );
  34105. this.projectionMatrixInverse.copy( this.projectionMatrix ).invert();
  34106. }
  34107. toJSON( meta ) {
  34108. const data = super.toJSON( meta );
  34109. data.object.zoom = this.zoom;
  34110. data.object.left = this.left;
  34111. data.object.right = this.right;
  34112. data.object.top = this.top;
  34113. data.object.bottom = this.bottom;
  34114. data.object.near = this.near;
  34115. data.object.far = this.far;
  34116. if ( this.view !== null ) data.object.view = Object.assign( {}, this.view );
  34117. return data;
  34118. }
  34119. }
  34120. /**
  34121. * Represents the shadow configuration of directional lights.
  34122. *
  34123. * @augments LightShadow
  34124. */
  34125. class DirectionalLightShadow extends LightShadow {
  34126. /**
  34127. * Constructs a new directional light shadow.
  34128. */
  34129. constructor() {
  34130. super( new OrthographicCamera( -5, 5, 5, -5, 0.5, 500 ) );
  34131. /**
  34132. * This flag can be used for type testing.
  34133. *
  34134. * @type {boolean}
  34135. * @readonly
  34136. * @default true
  34137. */
  34138. this.isDirectionalLightShadow = true;
  34139. }
  34140. }
  34141. /**
  34142. * A light that gets emitted in a specific direction. This light will behave
  34143. * as though it is infinitely far away and the rays produced from it are all
  34144. * parallel. The common use case for this is to simulate daylight; the sun is
  34145. * far enough away that its position can be considered to be infinite, and
  34146. * all light rays coming from it are parallel.
  34147. *
  34148. * A common point of confusion for directional lights is that setting the
  34149. * rotation has no effect. This is because three.js's DirectionalLight is the
  34150. * equivalent to what is often called a 'Target Direct Light' in other
  34151. * applications.
  34152. *
  34153. * This means that its direction is calculated as pointing from the light's
  34154. * {@link Object3D#position} to the {@link DirectionalLight#target} position
  34155. * (as opposed to a 'Free Direct Light' that just has a rotation
  34156. * component).
  34157. *
  34158. * This light can cast shadows - see the {@link DirectionalLightShadow} for details.
  34159. *
  34160. * ```js
  34161. * // White directional light at half intensity shining from the top.
  34162. * const directionalLight = new THREE.DirectionalLight( 0xffffff, 0.5 );
  34163. * scene.add( directionalLight );
  34164. * ```
  34165. *
  34166. * @augments Light
  34167. */
  34168. class DirectionalLight extends Light {
  34169. /**
  34170. * Constructs a new directional light.
  34171. *
  34172. * @param {(number|Color|string)} [color=0xffffff] - The light's color.
  34173. * @param {number} [intensity=1] - The light's strength/intensity.
  34174. */
  34175. constructor( color, intensity ) {
  34176. super( color, intensity );
  34177. /**
  34178. * This flag can be used for type testing.
  34179. *
  34180. * @type {boolean}
  34181. * @readonly
  34182. * @default true
  34183. */
  34184. this.isDirectionalLight = true;
  34185. this.type = 'DirectionalLight';
  34186. this.position.copy( Object3D.DEFAULT_UP );
  34187. this.updateMatrix();
  34188. /**
  34189. * The directional light points from its position to the
  34190. * target's position.
  34191. *
  34192. * For the target's position to be changed to anything other
  34193. * than the default, it must be added to the scene.
  34194. *
  34195. * It is also possible to set the target to be another 3D object
  34196. * in the scene. The light will now track the target object.
  34197. *
  34198. * @type {Object3D}
  34199. */
  34200. this.target = new Object3D();
  34201. /**
  34202. * This property holds the light's shadow configuration.
  34203. *
  34204. * @type {DirectionalLightShadow}
  34205. */
  34206. this.shadow = new DirectionalLightShadow();
  34207. }
  34208. dispose() {
  34209. super.dispose();
  34210. this.shadow.dispose();
  34211. }
  34212. copy( source ) {
  34213. super.copy( source );
  34214. this.target = source.target.clone();
  34215. this.shadow = source.shadow.clone();
  34216. return this;
  34217. }
  34218. toJSON( meta ) {
  34219. const data = super.toJSON( meta );
  34220. data.object.shadow = this.shadow.toJSON();
  34221. data.object.target = this.target.uuid;
  34222. return data;
  34223. }
  34224. }
  34225. /**
  34226. * This light globally illuminates all objects in the scene equally.
  34227. *
  34228. * It cannot be used to cast shadows as it does not have a direction.
  34229. *
  34230. * ```js
  34231. * const light = new THREE.AmbientLight( 0x404040 ); // soft white light
  34232. * scene.add( light );
  34233. * ```
  34234. *
  34235. * @augments Light
  34236. */
  34237. class AmbientLight extends Light {
  34238. /**
  34239. * Constructs a new ambient light.
  34240. *
  34241. * @param {(number|Color|string)} [color=0xffffff] - The light's color.
  34242. * @param {number} [intensity=1] - The light's strength/intensity.
  34243. */
  34244. constructor( color, intensity ) {
  34245. super( color, intensity );
  34246. /**
  34247. * This flag can be used for type testing.
  34248. *
  34249. * @type {boolean}
  34250. * @readonly
  34251. * @default true
  34252. */
  34253. this.isAmbientLight = true;
  34254. this.type = 'AmbientLight';
  34255. }
  34256. }
  34257. /**
  34258. * This class emits light uniformly across the face a rectangular plane.
  34259. * This light type can be used to simulate light sources such as bright
  34260. * windows or strip lighting.
  34261. *
  34262. * Important Notes:
  34263. *
  34264. * - There is no shadow support.
  34265. * - Only PBR materials are supported.
  34266. * - You have to include `RectAreaLightUniformsLib` (`WebGLRenderer`) or `RectAreaLightTexturesLib` (`WebGPURenderer`)
  34267. * into your app and init the uniforms/textures.
  34268. *
  34269. * ```js
  34270. * RectAreaLightUniformsLib.init(); // only relevant for WebGLRenderer
  34271. * THREE.RectAreaLightNode.setLTC( RectAreaLightTexturesLib.init() ); // only relevant for WebGPURenderer
  34272. *
  34273. * const intensity = 1; const width = 10; const height = 10;
  34274. * const rectLight = new THREE.RectAreaLight( 0xffffff, intensity, width, height );
  34275. * rectLight.position.set( 5, 5, 0 );
  34276. * rectLight.lookAt( 0, 0, 0 );
  34277. * scene.add( rectLight )
  34278. * ```
  34279. *
  34280. * @augments Light
  34281. */
  34282. class RectAreaLight extends Light {
  34283. /**
  34284. * Constructs a new area light.
  34285. *
  34286. * @param {(number|Color|string)} [color=0xffffff] - The light's color.
  34287. * @param {number} [intensity=1] - The light's strength/intensity.
  34288. * @param {number} [width=10] - The width of the light.
  34289. * @param {number} [height=10] - The height of the light.
  34290. */
  34291. constructor( color, intensity, width = 10, height = 10 ) {
  34292. super( color, intensity );
  34293. /**
  34294. * This flag can be used for type testing.
  34295. *
  34296. * @type {boolean}
  34297. * @readonly
  34298. * @default true
  34299. */
  34300. this.isRectAreaLight = true;
  34301. this.type = 'RectAreaLight';
  34302. /**
  34303. * The width of the light.
  34304. *
  34305. * @type {number}
  34306. * @default 10
  34307. */
  34308. this.width = width;
  34309. /**
  34310. * The height of the light.
  34311. *
  34312. * @type {number}
  34313. * @default 10
  34314. */
  34315. this.height = height;
  34316. }
  34317. /**
  34318. * The light's power. Power is the luminous power of the light measured in lumens (lm).
  34319. * Changing the power will also change the light's intensity.
  34320. *
  34321. * @type {number}
  34322. */
  34323. get power() {
  34324. // compute the light's luminous power (in lumens) from its intensity (in nits)
  34325. return this.intensity * this.width * this.height * Math.PI;
  34326. }
  34327. set power( power ) {
  34328. // set the light's intensity (in nits) from the desired luminous power (in lumens)
  34329. this.intensity = power / ( this.width * this.height * Math.PI );
  34330. }
  34331. copy( source ) {
  34332. super.copy( source );
  34333. this.width = source.width;
  34334. this.height = source.height;
  34335. return this;
  34336. }
  34337. toJSON( meta ) {
  34338. const data = super.toJSON( meta );
  34339. data.object.width = this.width;
  34340. data.object.height = this.height;
  34341. return data;
  34342. }
  34343. }
  34344. /**
  34345. * Represents a third-order spherical harmonics (SH). Light probes use this class
  34346. * to encode lighting information.
  34347. *
  34348. * - Primary reference: {@link https://graphics.stanford.edu/papers/envmap/envmap.pdf}
  34349. * - Secondary reference: {@link https://www.ppsloan.org/publications/StupidSH36.pdf}
  34350. */
  34351. class SphericalHarmonics3 {
  34352. /**
  34353. * Constructs a new spherical harmonics.
  34354. */
  34355. constructor() {
  34356. /**
  34357. * This flag can be used for type testing.
  34358. *
  34359. * @type {boolean}
  34360. * @readonly
  34361. * @default true
  34362. */
  34363. this.isSphericalHarmonics3 = true;
  34364. /**
  34365. * An array holding the (9) SH coefficients.
  34366. *
  34367. * @type {Array<Vector3>}
  34368. */
  34369. this.coefficients = [];
  34370. for ( let i = 0; i < 9; i ++ ) {
  34371. this.coefficients.push( new Vector3() );
  34372. }
  34373. }
  34374. /**
  34375. * Sets the given SH coefficients to this instance by copying
  34376. * the values.
  34377. *
  34378. * @param {Array<Vector3>} coefficients - The SH coefficients.
  34379. * @return {SphericalHarmonics3} A reference to this spherical harmonics.
  34380. */
  34381. set( coefficients ) {
  34382. for ( let i = 0; i < 9; i ++ ) {
  34383. this.coefficients[ i ].copy( coefficients[ i ] );
  34384. }
  34385. return this;
  34386. }
  34387. /**
  34388. * Sets all SH coefficients to `0`.
  34389. *
  34390. * @return {SphericalHarmonics3} A reference to this spherical harmonics.
  34391. */
  34392. zero() {
  34393. for ( let i = 0; i < 9; i ++ ) {
  34394. this.coefficients[ i ].set( 0, 0, 0 );
  34395. }
  34396. return this;
  34397. }
  34398. /**
  34399. * Returns the radiance in the direction of the given normal.
  34400. *
  34401. * @param {Vector3} normal - The normal vector (assumed to be unit length)
  34402. * @param {Vector3} target - The target vector that is used to store the method's result.
  34403. * @return {Vector3} The radiance.
  34404. */
  34405. getAt( normal, target ) {
  34406. // normal is assumed to be unit length
  34407. const x = normal.x, y = normal.y, z = normal.z;
  34408. const coeff = this.coefficients;
  34409. // band 0
  34410. target.copy( coeff[ 0 ] ).multiplyScalar( 0.282095 );
  34411. // band 1
  34412. target.addScaledVector( coeff[ 1 ], 0.488603 * y );
  34413. target.addScaledVector( coeff[ 2 ], 0.488603 * z );
  34414. target.addScaledVector( coeff[ 3 ], 0.488603 * x );
  34415. // band 2
  34416. target.addScaledVector( coeff[ 4 ], 1.092548 * ( x * y ) );
  34417. target.addScaledVector( coeff[ 5 ], 1.092548 * ( y * z ) );
  34418. target.addScaledVector( coeff[ 6 ], 0.315392 * ( 3.0 * z * z - 1.0 ) );
  34419. target.addScaledVector( coeff[ 7 ], 1.092548 * ( x * z ) );
  34420. target.addScaledVector( coeff[ 8 ], 0.546274 * ( x * x - y * y ) );
  34421. return target;
  34422. }
  34423. /**
  34424. * Returns the irradiance (radiance convolved with cosine lobe) in the
  34425. * direction of the given normal.
  34426. *
  34427. * @param {Vector3} normal - The normal vector (assumed to be unit length)
  34428. * @param {Vector3} target - The target vector that is used to store the method's result.
  34429. * @return {Vector3} The irradiance.
  34430. */
  34431. getIrradianceAt( normal, target ) {
  34432. // normal is assumed to be unit length
  34433. const x = normal.x, y = normal.y, z = normal.z;
  34434. const coeff = this.coefficients;
  34435. // band 0
  34436. target.copy( coeff[ 0 ] ).multiplyScalar( 0.886227 ); // π * 0.282095
  34437. // band 1
  34438. target.addScaledVector( coeff[ 1 ], 2.0 * 0.511664 * y ); // ( 2 * π / 3 ) * 0.488603
  34439. target.addScaledVector( coeff[ 2 ], 2.0 * 0.511664 * z );
  34440. target.addScaledVector( coeff[ 3 ], 2.0 * 0.511664 * x );
  34441. // band 2
  34442. target.addScaledVector( coeff[ 4 ], 2.0 * 0.429043 * x * y ); // ( π / 4 ) * 1.092548
  34443. target.addScaledVector( coeff[ 5 ], 2.0 * 0.429043 * y * z );
  34444. target.addScaledVector( coeff[ 6 ], 0.743125 * z * z - 0.247708 ); // ( π / 4 ) * 0.315392 * 3
  34445. target.addScaledVector( coeff[ 7 ], 2.0 * 0.429043 * x * z );
  34446. target.addScaledVector( coeff[ 8 ], 0.429043 * ( x * x - y * y ) ); // ( π / 4 ) * 0.546274
  34447. return target;
  34448. }
  34449. /**
  34450. * Adds the given SH to this instance.
  34451. *
  34452. * @param {SphericalHarmonics3} sh - The SH to add.
  34453. * @return {SphericalHarmonics3} A reference to this spherical harmonics.
  34454. */
  34455. add( sh ) {
  34456. for ( let i = 0; i < 9; i ++ ) {
  34457. this.coefficients[ i ].add( sh.coefficients[ i ] );
  34458. }
  34459. return this;
  34460. }
  34461. /**
  34462. * A convenience method for performing {@link SphericalHarmonics3#add} and
  34463. * {@link SphericalHarmonics3#scale} at once.
  34464. *
  34465. * @param {SphericalHarmonics3} sh - The SH to add.
  34466. * @param {number} s - The scale factor.
  34467. * @return {SphericalHarmonics3} A reference to this spherical harmonics.
  34468. */
  34469. addScaledSH( sh, s ) {
  34470. for ( let i = 0; i < 9; i ++ ) {
  34471. this.coefficients[ i ].addScaledVector( sh.coefficients[ i ], s );
  34472. }
  34473. return this;
  34474. }
  34475. /**
  34476. * Scales this SH by the given scale factor.
  34477. *
  34478. * @param {number} s - The scale factor.
  34479. * @return {SphericalHarmonics3} A reference to this spherical harmonics.
  34480. */
  34481. scale( s ) {
  34482. for ( let i = 0; i < 9; i ++ ) {
  34483. this.coefficients[ i ].multiplyScalar( s );
  34484. }
  34485. return this;
  34486. }
  34487. /**
  34488. * Linear interpolates between the given SH and this instance by the given
  34489. * alpha factor.
  34490. *
  34491. * @param {SphericalHarmonics3} sh - The SH to interpolate with.
  34492. * @param {number} alpha - The alpha factor.
  34493. * @return {SphericalHarmonics3} A reference to this spherical harmonics.
  34494. */
  34495. lerp( sh, alpha ) {
  34496. for ( let i = 0; i < 9; i ++ ) {
  34497. this.coefficients[ i ].lerp( sh.coefficients[ i ], alpha );
  34498. }
  34499. return this;
  34500. }
  34501. /**
  34502. * Returns `true` if this spherical harmonics is equal with the given one.
  34503. *
  34504. * @param {SphericalHarmonics3} sh - The spherical harmonics to test for equality.
  34505. * @return {boolean} Whether this spherical harmonics is equal with the given one.
  34506. */
  34507. equals( sh ) {
  34508. for ( let i = 0; i < 9; i ++ ) {
  34509. if ( ! this.coefficients[ i ].equals( sh.coefficients[ i ] ) ) {
  34510. return false;
  34511. }
  34512. }
  34513. return true;
  34514. }
  34515. /**
  34516. * Copies the values of the given spherical harmonics to this instance.
  34517. *
  34518. * @param {SphericalHarmonics3} sh - The spherical harmonics to copy.
  34519. * @return {SphericalHarmonics3} A reference to this spherical harmonics.
  34520. */
  34521. copy( sh ) {
  34522. return this.set( sh.coefficients );
  34523. }
  34524. /**
  34525. * Returns a new spherical harmonics with copied values from this instance.
  34526. *
  34527. * @return {SphericalHarmonics3} A clone of this instance.
  34528. */
  34529. clone() {
  34530. return new this.constructor().copy( this );
  34531. }
  34532. /**
  34533. * Sets the SH coefficients of this instance from the given array.
  34534. *
  34535. * @param {Array<number>} array - An array holding the SH coefficients.
  34536. * @param {number} [offset=0] - The array offset where to start copying.
  34537. * @return {SphericalHarmonics3} A clone of this instance.
  34538. */
  34539. fromArray( array, offset = 0 ) {
  34540. const coefficients = this.coefficients;
  34541. for ( let i = 0; i < 9; i ++ ) {
  34542. coefficients[ i ].fromArray( array, offset + ( i * 3 ) );
  34543. }
  34544. return this;
  34545. }
  34546. /**
  34547. * Returns an array with the SH coefficients, or copies them into the provided
  34548. * array. The coefficients are represented as numbers.
  34549. *
  34550. * @param {Array<number>} [array=[]] - The target array.
  34551. * @param {number} [offset=0] - The array offset where to start copying.
  34552. * @return {Array<number>} An array with flat SH coefficients.
  34553. */
  34554. toArray( array = [], offset = 0 ) {
  34555. const coefficients = this.coefficients;
  34556. for ( let i = 0; i < 9; i ++ ) {
  34557. coefficients[ i ].toArray( array, offset + ( i * 3 ) );
  34558. }
  34559. return array;
  34560. }
  34561. /**
  34562. * Computes the SH basis for the given normal vector.
  34563. *
  34564. * @param {Vector3} normal - The normal.
  34565. * @param {Array<number>} shBasis - The target array holding the SH basis.
  34566. */
  34567. static getBasisAt( normal, shBasis ) {
  34568. // normal is assumed to be unit length
  34569. const x = normal.x, y = normal.y, z = normal.z;
  34570. // band 0
  34571. shBasis[ 0 ] = 0.282095;
  34572. // band 1
  34573. shBasis[ 1 ] = 0.488603 * y;
  34574. shBasis[ 2 ] = 0.488603 * z;
  34575. shBasis[ 3 ] = 0.488603 * x;
  34576. // band 2
  34577. shBasis[ 4 ] = 1.092548 * x * y;
  34578. shBasis[ 5 ] = 1.092548 * y * z;
  34579. shBasis[ 6 ] = 0.315392 * ( 3 * z * z - 1 );
  34580. shBasis[ 7 ] = 1.092548 * x * z;
  34581. shBasis[ 8 ] = 0.546274 * ( x * x - y * y );
  34582. }
  34583. }
  34584. /**
  34585. * Light probes are an alternative way of adding light to a 3D scene. Unlike
  34586. * classical light sources (e.g. directional, point or spot lights), light
  34587. * probes do not emit light. Instead they store information about light
  34588. * passing through 3D space. During rendering, the light that hits a 3D
  34589. * object is approximated by using the data from the light probe.
  34590. *
  34591. * Light probes are usually created from (radiance) environment maps. The
  34592. * class {@link LightProbeGenerator} can be used to create light probes from
  34593. * cube textures or render targets. However, light estimation data could also
  34594. * be provided in other forms e.g. by WebXR. This enables the rendering of
  34595. * augmented reality content that reacts to real world lighting.
  34596. *
  34597. * The current probe implementation in three.js supports so-called diffuse
  34598. * light probes. This type of light probe is functionally equivalent to an
  34599. * irradiance environment map.
  34600. *
  34601. * @augments Light
  34602. */
  34603. class LightProbe extends Light {
  34604. /**
  34605. * Constructs a new light probe.
  34606. *
  34607. * @param {SphericalHarmonics3} sh - The spherical harmonics which represents encoded lighting information.
  34608. * @param {number} [intensity=1] - The light's strength/intensity.
  34609. */
  34610. constructor( sh = new SphericalHarmonics3(), intensity = 1 ) {
  34611. super( undefined, intensity );
  34612. /**
  34613. * This flag can be used for type testing.
  34614. *
  34615. * @type {boolean}
  34616. * @readonly
  34617. * @default true
  34618. */
  34619. this.isLightProbe = true;
  34620. /**
  34621. * A light probe uses spherical harmonics to encode lighting information.
  34622. *
  34623. * @type {SphericalHarmonics3}
  34624. */
  34625. this.sh = sh;
  34626. }
  34627. copy( source ) {
  34628. super.copy( source );
  34629. this.sh.copy( source.sh );
  34630. return this;
  34631. }
  34632. toJSON( meta ) {
  34633. const data = super.toJSON( meta );
  34634. data.object.sh = this.sh.toArray();
  34635. return data;
  34636. }
  34637. }
  34638. /**
  34639. * Class for loading materials. The files are internally
  34640. * loaded via {@link FileLoader}.
  34641. *
  34642. * ```js
  34643. * const loader = new THREE.MaterialLoader();
  34644. * const material = await loader.loadAsync( 'material.json' );
  34645. * ```
  34646. * This loader does not support node materials. Use {@link NodeMaterialLoader} instead.
  34647. *
  34648. * @augments Loader
  34649. */
  34650. class MaterialLoader extends Loader {
  34651. /**
  34652. * Constructs a new material loader.
  34653. *
  34654. * @param {LoadingManager} [manager] - The loading manager.
  34655. */
  34656. constructor( manager ) {
  34657. super( manager );
  34658. /**
  34659. * A dictionary holding textures used by the material.
  34660. *
  34661. * @type {Object<string,Texture>}
  34662. */
  34663. this.textures = {};
  34664. }
  34665. /**
  34666. * Starts loading from the given URL and pass the loaded material to the `onLoad()` callback.
  34667. *
  34668. * @param {string} url - The path/URL of the file to be loaded. This can also be a data URI.
  34669. * @param {function(Material)} onLoad - Executed when the loading process has been finished.
  34670. * @param {onProgressCallback} onProgress - Executed while the loading is in progress.
  34671. * @param {onErrorCallback} onError - Executed when errors occur.
  34672. */
  34673. load( url, onLoad, onProgress, onError ) {
  34674. const scope = this;
  34675. const loader = new FileLoader( scope.manager );
  34676. loader.setPath( scope.path );
  34677. loader.setRequestHeader( scope.requestHeader );
  34678. loader.setWithCredentials( scope.withCredentials );
  34679. loader.load( url, function ( text ) {
  34680. try {
  34681. onLoad( scope.parse( JSON.parse( text ) ) );
  34682. } catch ( e ) {
  34683. if ( onError ) {
  34684. onError( e );
  34685. } else {
  34686. error( e );
  34687. }
  34688. scope.manager.itemError( url );
  34689. }
  34690. }, onProgress, onError );
  34691. }
  34692. /**
  34693. * Parses the given JSON object and returns a material.
  34694. *
  34695. * @param {Object} json - The serialized material.
  34696. * @return {Material} The parsed material.
  34697. */
  34698. parse( json ) {
  34699. const textures = this.textures;
  34700. function getTexture( name ) {
  34701. if ( textures[ name ] === undefined ) {
  34702. warn( 'MaterialLoader: Undefined texture', name );
  34703. }
  34704. return textures[ name ];
  34705. }
  34706. const material = this.createMaterialFromType( json.type );
  34707. if ( json.uuid !== undefined ) material.uuid = json.uuid;
  34708. if ( json.name !== undefined ) material.name = json.name;
  34709. if ( json.color !== undefined && material.color !== undefined ) material.color.setHex( json.color );
  34710. if ( json.roughness !== undefined ) material.roughness = json.roughness;
  34711. if ( json.metalness !== undefined ) material.metalness = json.metalness;
  34712. if ( json.sheen !== undefined ) material.sheen = json.sheen;
  34713. if ( json.sheenColor !== undefined ) material.sheenColor = new Color().setHex( json.sheenColor );
  34714. if ( json.sheenRoughness !== undefined ) material.sheenRoughness = json.sheenRoughness;
  34715. if ( json.emissive !== undefined && material.emissive !== undefined ) material.emissive.setHex( json.emissive );
  34716. if ( json.specular !== undefined && material.specular !== undefined ) material.specular.setHex( json.specular );
  34717. if ( json.specularIntensity !== undefined ) material.specularIntensity = json.specularIntensity;
  34718. if ( json.specularColor !== undefined && material.specularColor !== undefined ) material.specularColor.setHex( json.specularColor );
  34719. if ( json.shininess !== undefined ) material.shininess = json.shininess;
  34720. if ( json.clearcoat !== undefined ) material.clearcoat = json.clearcoat;
  34721. if ( json.clearcoatRoughness !== undefined ) material.clearcoatRoughness = json.clearcoatRoughness;
  34722. if ( json.dispersion !== undefined ) material.dispersion = json.dispersion;
  34723. if ( json.iridescence !== undefined ) material.iridescence = json.iridescence;
  34724. if ( json.iridescenceIOR !== undefined ) material.iridescenceIOR = json.iridescenceIOR;
  34725. if ( json.iridescenceThicknessRange !== undefined ) material.iridescenceThicknessRange = json.iridescenceThicknessRange;
  34726. if ( json.transmission !== undefined ) material.transmission = json.transmission;
  34727. if ( json.thickness !== undefined ) material.thickness = json.thickness;
  34728. if ( json.attenuationDistance !== undefined ) material.attenuationDistance = json.attenuationDistance;
  34729. if ( json.attenuationColor !== undefined && material.attenuationColor !== undefined ) material.attenuationColor.setHex( json.attenuationColor );
  34730. if ( json.anisotropy !== undefined ) material.anisotropy = json.anisotropy;
  34731. if ( json.anisotropyRotation !== undefined ) material.anisotropyRotation = json.anisotropyRotation;
  34732. if ( json.fog !== undefined ) material.fog = json.fog;
  34733. if ( json.flatShading !== undefined ) material.flatShading = json.flatShading;
  34734. if ( json.blending !== undefined ) material.blending = json.blending;
  34735. if ( json.combine !== undefined ) material.combine = json.combine;
  34736. if ( json.side !== undefined ) material.side = json.side;
  34737. if ( json.shadowSide !== undefined ) material.shadowSide = json.shadowSide;
  34738. if ( json.opacity !== undefined ) material.opacity = json.opacity;
  34739. if ( json.transparent !== undefined ) material.transparent = json.transparent;
  34740. if ( json.alphaTest !== undefined ) material.alphaTest = json.alphaTest;
  34741. if ( json.alphaHash !== undefined ) material.alphaHash = json.alphaHash;
  34742. if ( json.depthFunc !== undefined ) material.depthFunc = json.depthFunc;
  34743. if ( json.depthTest !== undefined ) material.depthTest = json.depthTest;
  34744. if ( json.depthWrite !== undefined ) material.depthWrite = json.depthWrite;
  34745. if ( json.colorWrite !== undefined ) material.colorWrite = json.colorWrite;
  34746. if ( json.blendSrc !== undefined ) material.blendSrc = json.blendSrc;
  34747. if ( json.blendDst !== undefined ) material.blendDst = json.blendDst;
  34748. if ( json.blendEquation !== undefined ) material.blendEquation = json.blendEquation;
  34749. if ( json.blendSrcAlpha !== undefined ) material.blendSrcAlpha = json.blendSrcAlpha;
  34750. if ( json.blendDstAlpha !== undefined ) material.blendDstAlpha = json.blendDstAlpha;
  34751. if ( json.blendEquationAlpha !== undefined ) material.blendEquationAlpha = json.blendEquationAlpha;
  34752. if ( json.blendColor !== undefined && material.blendColor !== undefined ) material.blendColor.setHex( json.blendColor );
  34753. if ( json.blendAlpha !== undefined ) material.blendAlpha = json.blendAlpha;
  34754. if ( json.stencilWriteMask !== undefined ) material.stencilWriteMask = json.stencilWriteMask;
  34755. if ( json.stencilFunc !== undefined ) material.stencilFunc = json.stencilFunc;
  34756. if ( json.stencilRef !== undefined ) material.stencilRef = json.stencilRef;
  34757. if ( json.stencilFuncMask !== undefined ) material.stencilFuncMask = json.stencilFuncMask;
  34758. if ( json.stencilFail !== undefined ) material.stencilFail = json.stencilFail;
  34759. if ( json.stencilZFail !== undefined ) material.stencilZFail = json.stencilZFail;
  34760. if ( json.stencilZPass !== undefined ) material.stencilZPass = json.stencilZPass;
  34761. if ( json.stencilWrite !== undefined ) material.stencilWrite = json.stencilWrite;
  34762. if ( json.wireframe !== undefined ) material.wireframe = json.wireframe;
  34763. if ( json.wireframeLinewidth !== undefined ) material.wireframeLinewidth = json.wireframeLinewidth;
  34764. if ( json.wireframeLinecap !== undefined ) material.wireframeLinecap = json.wireframeLinecap;
  34765. if ( json.wireframeLinejoin !== undefined ) material.wireframeLinejoin = json.wireframeLinejoin;
  34766. if ( json.rotation !== undefined ) material.rotation = json.rotation;
  34767. if ( json.linewidth !== undefined ) material.linewidth = json.linewidth;
  34768. if ( json.dashSize !== undefined ) material.dashSize = json.dashSize;
  34769. if ( json.gapSize !== undefined ) material.gapSize = json.gapSize;
  34770. if ( json.scale !== undefined ) material.scale = json.scale;
  34771. if ( json.polygonOffset !== undefined ) material.polygonOffset = json.polygonOffset;
  34772. if ( json.polygonOffsetFactor !== undefined ) material.polygonOffsetFactor = json.polygonOffsetFactor;
  34773. if ( json.polygonOffsetUnits !== undefined ) material.polygonOffsetUnits = json.polygonOffsetUnits;
  34774. if ( json.dithering !== undefined ) material.dithering = json.dithering;
  34775. if ( json.alphaToCoverage !== undefined ) material.alphaToCoverage = json.alphaToCoverage;
  34776. if ( json.premultipliedAlpha !== undefined ) material.premultipliedAlpha = json.premultipliedAlpha;
  34777. if ( json.forceSinglePass !== undefined ) material.forceSinglePass = json.forceSinglePass;
  34778. if ( json.allowOverride !== undefined ) material.allowOverride = json.allowOverride;
  34779. if ( json.visible !== undefined ) material.visible = json.visible;
  34780. if ( json.toneMapped !== undefined ) material.toneMapped = json.toneMapped;
  34781. if ( json.userData !== undefined ) material.userData = json.userData;
  34782. if ( json.vertexColors !== undefined ) {
  34783. if ( typeof json.vertexColors === 'number' ) {
  34784. material.vertexColors = ( json.vertexColors > 0 ) ? true : false;
  34785. } else {
  34786. material.vertexColors = json.vertexColors;
  34787. }
  34788. }
  34789. // Shader Material
  34790. if ( json.uniforms !== undefined ) {
  34791. for ( const name in json.uniforms ) {
  34792. const uniform = json.uniforms[ name ];
  34793. material.uniforms[ name ] = {};
  34794. switch ( uniform.type ) {
  34795. case 't':
  34796. material.uniforms[ name ].value = getTexture( uniform.value );
  34797. break;
  34798. case 'c':
  34799. material.uniforms[ name ].value = new Color().setHex( uniform.value );
  34800. break;
  34801. case 'v2':
  34802. material.uniforms[ name ].value = new Vector2().fromArray( uniform.value );
  34803. break;
  34804. case 'v3':
  34805. material.uniforms[ name ].value = new Vector3().fromArray( uniform.value );
  34806. break;
  34807. case 'v4':
  34808. material.uniforms[ name ].value = new Vector4().fromArray( uniform.value );
  34809. break;
  34810. case 'm3':
  34811. material.uniforms[ name ].value = new Matrix3().fromArray( uniform.value );
  34812. break;
  34813. case 'm4':
  34814. material.uniforms[ name ].value = new Matrix4().fromArray( uniform.value );
  34815. break;
  34816. default:
  34817. material.uniforms[ name ].value = uniform.value;
  34818. }
  34819. }
  34820. }
  34821. if ( json.defines !== undefined ) material.defines = json.defines;
  34822. if ( json.vertexShader !== undefined ) material.vertexShader = json.vertexShader;
  34823. if ( json.fragmentShader !== undefined ) material.fragmentShader = json.fragmentShader;
  34824. if ( json.glslVersion !== undefined ) material.glslVersion = json.glslVersion;
  34825. if ( json.extensions !== undefined ) {
  34826. for ( const key in json.extensions ) {
  34827. material.extensions[ key ] = json.extensions[ key ];
  34828. }
  34829. }
  34830. if ( json.lights !== undefined ) material.lights = json.lights;
  34831. if ( json.clipping !== undefined ) material.clipping = json.clipping;
  34832. // for PointsMaterial
  34833. if ( json.size !== undefined ) material.size = json.size;
  34834. if ( json.sizeAttenuation !== undefined ) material.sizeAttenuation = json.sizeAttenuation;
  34835. // maps
  34836. if ( json.map !== undefined ) material.map = getTexture( json.map );
  34837. if ( json.matcap !== undefined ) material.matcap = getTexture( json.matcap );
  34838. if ( json.alphaMap !== undefined ) material.alphaMap = getTexture( json.alphaMap );
  34839. if ( json.bumpMap !== undefined ) material.bumpMap = getTexture( json.bumpMap );
  34840. if ( json.bumpScale !== undefined ) material.bumpScale = json.bumpScale;
  34841. if ( json.normalMap !== undefined ) material.normalMap = getTexture( json.normalMap );
  34842. if ( json.normalMapType !== undefined ) material.normalMapType = json.normalMapType;
  34843. if ( json.normalScale !== undefined ) {
  34844. let normalScale = json.normalScale;
  34845. if ( Array.isArray( normalScale ) === false ) {
  34846. // Blender exporter used to export a scalar. See #7459
  34847. normalScale = [ normalScale, normalScale ];
  34848. }
  34849. material.normalScale = new Vector2().fromArray( normalScale );
  34850. }
  34851. if ( json.displacementMap !== undefined ) material.displacementMap = getTexture( json.displacementMap );
  34852. if ( json.displacementScale !== undefined ) material.displacementScale = json.displacementScale;
  34853. if ( json.displacementBias !== undefined ) material.displacementBias = json.displacementBias;
  34854. if ( json.roughnessMap !== undefined ) material.roughnessMap = getTexture( json.roughnessMap );
  34855. if ( json.metalnessMap !== undefined ) material.metalnessMap = getTexture( json.metalnessMap );
  34856. if ( json.emissiveMap !== undefined ) material.emissiveMap = getTexture( json.emissiveMap );
  34857. if ( json.emissiveIntensity !== undefined ) material.emissiveIntensity = json.emissiveIntensity;
  34858. if ( json.specularMap !== undefined ) material.specularMap = getTexture( json.specularMap );
  34859. if ( json.specularIntensityMap !== undefined ) material.specularIntensityMap = getTexture( json.specularIntensityMap );
  34860. if ( json.specularColorMap !== undefined ) material.specularColorMap = getTexture( json.specularColorMap );
  34861. if ( json.envMap !== undefined ) material.envMap = getTexture( json.envMap );
  34862. if ( json.envMapRotation !== undefined ) material.envMapRotation.fromArray( json.envMapRotation );
  34863. if ( json.envMapIntensity !== undefined ) material.envMapIntensity = json.envMapIntensity;
  34864. if ( json.reflectivity !== undefined ) material.reflectivity = json.reflectivity;
  34865. if ( json.refractionRatio !== undefined ) material.refractionRatio = json.refractionRatio;
  34866. if ( json.lightMap !== undefined ) material.lightMap = getTexture( json.lightMap );
  34867. if ( json.lightMapIntensity !== undefined ) material.lightMapIntensity = json.lightMapIntensity;
  34868. if ( json.aoMap !== undefined ) material.aoMap = getTexture( json.aoMap );
  34869. if ( json.aoMapIntensity !== undefined ) material.aoMapIntensity = json.aoMapIntensity;
  34870. if ( json.gradientMap !== undefined ) material.gradientMap = getTexture( json.gradientMap );
  34871. if ( json.clearcoatMap !== undefined ) material.clearcoatMap = getTexture( json.clearcoatMap );
  34872. if ( json.clearcoatRoughnessMap !== undefined ) material.clearcoatRoughnessMap = getTexture( json.clearcoatRoughnessMap );
  34873. if ( json.clearcoatNormalMap !== undefined ) material.clearcoatNormalMap = getTexture( json.clearcoatNormalMap );
  34874. if ( json.clearcoatNormalScale !== undefined ) material.clearcoatNormalScale = new Vector2().fromArray( json.clearcoatNormalScale );
  34875. if ( json.iridescenceMap !== undefined ) material.iridescenceMap = getTexture( json.iridescenceMap );
  34876. if ( json.iridescenceThicknessMap !== undefined ) material.iridescenceThicknessMap = getTexture( json.iridescenceThicknessMap );
  34877. if ( json.transmissionMap !== undefined ) material.transmissionMap = getTexture( json.transmissionMap );
  34878. if ( json.thicknessMap !== undefined ) material.thicknessMap = getTexture( json.thicknessMap );
  34879. if ( json.anisotropyMap !== undefined ) material.anisotropyMap = getTexture( json.anisotropyMap );
  34880. if ( json.sheenColorMap !== undefined ) material.sheenColorMap = getTexture( json.sheenColorMap );
  34881. if ( json.sheenRoughnessMap !== undefined ) material.sheenRoughnessMap = getTexture( json.sheenRoughnessMap );
  34882. return material;
  34883. }
  34884. /**
  34885. * Textures are not embedded in the material JSON so they have
  34886. * to be injected before the loading process starts.
  34887. *
  34888. * @param {Object} value - A dictionary holding textures for material properties.
  34889. * @return {MaterialLoader} A reference to this material loader.
  34890. */
  34891. setTextures( value ) {
  34892. this.textures = value;
  34893. return this;
  34894. }
  34895. /**
  34896. * Creates a material for the given type.
  34897. *
  34898. * @param {string} type - The material type.
  34899. * @return {Material} The new material.
  34900. */
  34901. createMaterialFromType( type ) {
  34902. return MaterialLoader.createMaterialFromType( type );
  34903. }
  34904. /**
  34905. * Creates a material for the given type.
  34906. *
  34907. * @static
  34908. * @param {string} type - The material type.
  34909. * @return {Material} The new material.
  34910. */
  34911. static createMaterialFromType( type ) {
  34912. const materialLib = {
  34913. ShadowMaterial,
  34914. SpriteMaterial,
  34915. RawShaderMaterial,
  34916. ShaderMaterial,
  34917. PointsMaterial,
  34918. MeshPhysicalMaterial,
  34919. MeshStandardMaterial,
  34920. MeshPhongMaterial,
  34921. MeshToonMaterial,
  34922. MeshNormalMaterial,
  34923. MeshLambertMaterial,
  34924. MeshDepthMaterial,
  34925. MeshDistanceMaterial,
  34926. MeshBasicMaterial,
  34927. MeshMatcapMaterial,
  34928. LineDashedMaterial,
  34929. LineBasicMaterial,
  34930. Material
  34931. };
  34932. return new materialLib[ type ]();
  34933. }
  34934. }
  34935. /**
  34936. * A class with loader utility functions.
  34937. */
  34938. class LoaderUtils {
  34939. /**
  34940. * Extracts the base URL from the given URL.
  34941. *
  34942. * @param {string} url -The URL to extract the base URL from.
  34943. * @return {string} The extracted base URL.
  34944. */
  34945. static extractUrlBase( url ) {
  34946. const index = url.lastIndexOf( '/' );
  34947. if ( index === -1 ) return './';
  34948. return url.slice( 0, index + 1 );
  34949. }
  34950. /**
  34951. * Resolves relative URLs against the given path. Absolute paths, data urls,
  34952. * and blob URLs will be returned as is. Invalid URLs will return an empty
  34953. * string.
  34954. *
  34955. * @param {string} url -The URL to resolve.
  34956. * @param {string} path - The base path for relative URLs to be resolved against.
  34957. * @return {string} The resolved URL.
  34958. */
  34959. static resolveURL( url, path ) {
  34960. // Invalid URL
  34961. if ( typeof url !== 'string' || url === '' ) return '';
  34962. // Host Relative URL
  34963. if ( /^https?:\/\//i.test( path ) && /^\//.test( url ) ) {
  34964. path = path.replace( /(^https?:\/\/[^\/]+).*/i, '$1' );
  34965. }
  34966. // Absolute URL http://,https://,//
  34967. if ( /^(https?:)?\/\//i.test( url ) ) return url;
  34968. // Data URI
  34969. if ( /^data:.*,.*$/i.test( url ) ) return url;
  34970. // Blob URL
  34971. if ( /^blob:.*$/i.test( url ) ) return url;
  34972. // Relative URL
  34973. return path + url;
  34974. }
  34975. }
  34976. /**
  34977. * An instanced version of a geometry.
  34978. */
  34979. class InstancedBufferGeometry extends BufferGeometry {
  34980. /**
  34981. * Constructs a new instanced buffer geometry.
  34982. */
  34983. constructor() {
  34984. super();
  34985. /**
  34986. * This flag can be used for type testing.
  34987. *
  34988. * @type {boolean}
  34989. * @readonly
  34990. * @default true
  34991. */
  34992. this.isInstancedBufferGeometry = true;
  34993. this.type = 'InstancedBufferGeometry';
  34994. /**
  34995. * The instance count.
  34996. *
  34997. * @type {number}
  34998. * @default Infinity
  34999. */
  35000. this.instanceCount = Infinity;
  35001. }
  35002. copy( source ) {
  35003. super.copy( source );
  35004. this.instanceCount = source.instanceCount;
  35005. return this;
  35006. }
  35007. toJSON() {
  35008. const data = super.toJSON();
  35009. data.instanceCount = this.instanceCount;
  35010. data.isInstancedBufferGeometry = true;
  35011. return data;
  35012. }
  35013. }
  35014. /**
  35015. * Class for loading geometries. The files are internally
  35016. * loaded via {@link FileLoader}.
  35017. *
  35018. * ```js
  35019. * const loader = new THREE.BufferGeometryLoader();
  35020. * const geometry = await loader.loadAsync( 'models/json/pressure.json' );
  35021. *
  35022. * const material = new THREE.MeshBasicMaterial( { color: 0xF5F5F5 } );
  35023. * const object = new THREE.Mesh( geometry, material );
  35024. * scene.add( object );
  35025. * ```
  35026. *
  35027. * @augments Loader
  35028. */
  35029. class BufferGeometryLoader extends Loader {
  35030. /**
  35031. * Constructs a new geometry loader.
  35032. *
  35033. * @param {LoadingManager} [manager] - The loading manager.
  35034. */
  35035. constructor( manager ) {
  35036. super( manager );
  35037. }
  35038. /**
  35039. * Starts loading from the given URL and pass the loaded geometry to the `onLoad()` callback.
  35040. *
  35041. * @param {string} url - The path/URL of the file to be loaded. This can also be a data URI.
  35042. * @param {function(BufferGeometry)} onLoad - Executed when the loading process has been finished.
  35043. * @param {onProgressCallback} onProgress - Executed while the loading is in progress.
  35044. * @param {onErrorCallback} onError - Executed when errors occur.
  35045. */
  35046. load( url, onLoad, onProgress, onError ) {
  35047. const scope = this;
  35048. const loader = new FileLoader( scope.manager );
  35049. loader.setPath( scope.path );
  35050. loader.setRequestHeader( scope.requestHeader );
  35051. loader.setWithCredentials( scope.withCredentials );
  35052. loader.load( url, function ( text ) {
  35053. try {
  35054. onLoad( scope.parse( JSON.parse( text ) ) );
  35055. } catch ( e ) {
  35056. if ( onError ) {
  35057. onError( e );
  35058. } else {
  35059. error( e );
  35060. }
  35061. scope.manager.itemError( url );
  35062. }
  35063. }, onProgress, onError );
  35064. }
  35065. /**
  35066. * Parses the given JSON object and returns a geometry.
  35067. *
  35068. * @param {Object} json - The serialized geometry.
  35069. * @return {BufferGeometry} The parsed geometry.
  35070. */
  35071. parse( json ) {
  35072. const interleavedBufferMap = {};
  35073. const arrayBufferMap = {};
  35074. function getInterleavedBuffer( json, uuid ) {
  35075. if ( interleavedBufferMap[ uuid ] !== undefined ) return interleavedBufferMap[ uuid ];
  35076. const interleavedBuffers = json.interleavedBuffers;
  35077. const interleavedBuffer = interleavedBuffers[ uuid ];
  35078. const buffer = getArrayBuffer( json, interleavedBuffer.buffer );
  35079. const array = getTypedArray( interleavedBuffer.type, buffer );
  35080. const ib = new InterleavedBuffer( array, interleavedBuffer.stride );
  35081. ib.uuid = interleavedBuffer.uuid;
  35082. interleavedBufferMap[ uuid ] = ib;
  35083. return ib;
  35084. }
  35085. function getArrayBuffer( json, uuid ) {
  35086. if ( arrayBufferMap[ uuid ] !== undefined ) return arrayBufferMap[ uuid ];
  35087. const arrayBuffers = json.arrayBuffers;
  35088. const arrayBuffer = arrayBuffers[ uuid ];
  35089. const ab = new Uint32Array( arrayBuffer ).buffer;
  35090. arrayBufferMap[ uuid ] = ab;
  35091. return ab;
  35092. }
  35093. const geometry = json.isInstancedBufferGeometry ? new InstancedBufferGeometry() : new BufferGeometry();
  35094. const index = json.data.index;
  35095. if ( index !== undefined ) {
  35096. const typedArray = getTypedArray( index.type, index.array );
  35097. geometry.setIndex( new BufferAttribute( typedArray, 1 ) );
  35098. }
  35099. const attributes = json.data.attributes;
  35100. for ( const key in attributes ) {
  35101. const attribute = attributes[ key ];
  35102. let bufferAttribute;
  35103. if ( attribute.isInterleavedBufferAttribute ) {
  35104. const interleavedBuffer = getInterleavedBuffer( json.data, attribute.data );
  35105. bufferAttribute = new InterleavedBufferAttribute( interleavedBuffer, attribute.itemSize, attribute.offset, attribute.normalized );
  35106. } else {
  35107. const typedArray = getTypedArray( attribute.type, attribute.array );
  35108. const bufferAttributeConstr = attribute.isInstancedBufferAttribute ? InstancedBufferAttribute : BufferAttribute;
  35109. bufferAttribute = new bufferAttributeConstr( typedArray, attribute.itemSize, attribute.normalized );
  35110. }
  35111. if ( attribute.name !== undefined ) bufferAttribute.name = attribute.name;
  35112. if ( attribute.usage !== undefined ) bufferAttribute.setUsage( attribute.usage );
  35113. geometry.setAttribute( key, bufferAttribute );
  35114. }
  35115. const morphAttributes = json.data.morphAttributes;
  35116. if ( morphAttributes ) {
  35117. for ( const key in morphAttributes ) {
  35118. const attributeArray = morphAttributes[ key ];
  35119. const array = [];
  35120. for ( let i = 0, il = attributeArray.length; i < il; i ++ ) {
  35121. const attribute = attributeArray[ i ];
  35122. let bufferAttribute;
  35123. if ( attribute.isInterleavedBufferAttribute ) {
  35124. const interleavedBuffer = getInterleavedBuffer( json.data, attribute.data );
  35125. bufferAttribute = new InterleavedBufferAttribute( interleavedBuffer, attribute.itemSize, attribute.offset, attribute.normalized );
  35126. } else {
  35127. const typedArray = getTypedArray( attribute.type, attribute.array );
  35128. bufferAttribute = new BufferAttribute( typedArray, attribute.itemSize, attribute.normalized );
  35129. }
  35130. if ( attribute.name !== undefined ) bufferAttribute.name = attribute.name;
  35131. array.push( bufferAttribute );
  35132. }
  35133. geometry.morphAttributes[ key ] = array;
  35134. }
  35135. }
  35136. const morphTargetsRelative = json.data.morphTargetsRelative;
  35137. if ( morphTargetsRelative ) {
  35138. geometry.morphTargetsRelative = true;
  35139. }
  35140. const groups = json.data.groups || json.data.drawcalls || json.data.offsets;
  35141. if ( groups !== undefined ) {
  35142. for ( let i = 0, n = groups.length; i !== n; ++ i ) {
  35143. const group = groups[ i ];
  35144. geometry.addGroup( group.start, group.count, group.materialIndex );
  35145. }
  35146. }
  35147. const boundingSphere = json.data.boundingSphere;
  35148. if ( boundingSphere !== undefined ) {
  35149. geometry.boundingSphere = new Sphere().fromJSON( boundingSphere );
  35150. }
  35151. if ( json.name ) geometry.name = json.name;
  35152. if ( json.userData ) geometry.userData = json.userData;
  35153. return geometry;
  35154. }
  35155. }
  35156. /**
  35157. * A loader for loading a JSON resource in the [JSON Object/Scene format](https://github.com/mrdoob/three.js/wiki/JSON-Object-Scene-format-4).
  35158. * The files are internally loaded via {@link FileLoader}.
  35159. *
  35160. * ```js
  35161. * const loader = new THREE.ObjectLoader();
  35162. * const obj = await loader.loadAsync( 'models/json/example.json' );
  35163. * scene.add( obj );
  35164. *
  35165. * // Alternatively, to parse a previously loaded JSON structure
  35166. * const object = await loader.parseAsync( a_json_object );
  35167. * scene.add( object );
  35168. * ```
  35169. *
  35170. * @augments Loader
  35171. */
  35172. class ObjectLoader extends Loader {
  35173. /**
  35174. * Constructs a new object loader.
  35175. *
  35176. * @param {LoadingManager} [manager] - The loading manager.
  35177. */
  35178. constructor( manager ) {
  35179. super( manager );
  35180. }
  35181. /**
  35182. * Starts loading from the given URL and pass the loaded 3D object to the `onLoad()` callback.
  35183. *
  35184. * @param {string} url - The path/URL of the file to be loaded. This can also be a data URI.
  35185. * @param {function(Object3D)} onLoad - Executed when the loading process has been finished.
  35186. * @param {onProgressCallback} onProgress - Executed while the loading is in progress.
  35187. * @param {onErrorCallback} onError - Executed when errors occur.
  35188. */
  35189. load( url, onLoad, onProgress, onError ) {
  35190. const scope = this;
  35191. const path = ( this.path === '' ) ? LoaderUtils.extractUrlBase( url ) : this.path;
  35192. this.resourcePath = this.resourcePath || path;
  35193. const loader = new FileLoader( this.manager );
  35194. loader.setPath( this.path );
  35195. loader.setRequestHeader( this.requestHeader );
  35196. loader.setWithCredentials( this.withCredentials );
  35197. loader.load( url, function ( text ) {
  35198. let json = null;
  35199. try {
  35200. json = JSON.parse( text );
  35201. } catch ( error ) {
  35202. if ( onError !== undefined ) onError( error );
  35203. error( 'ObjectLoader: Can\'t parse ' + url + '.', error.message );
  35204. return;
  35205. }
  35206. const metadata = json.metadata;
  35207. if ( metadata === undefined || metadata.type === undefined || metadata.type.toLowerCase() === 'geometry' ) {
  35208. if ( onError !== undefined ) onError( new Error( 'THREE.ObjectLoader: Can\'t load ' + url ) );
  35209. error( 'ObjectLoader: Can\'t load ' + url );
  35210. return;
  35211. }
  35212. scope.parse( json, onLoad );
  35213. }, onProgress, onError );
  35214. }
  35215. /**
  35216. * Async version of {@link ObjectLoader#load}.
  35217. *
  35218. * @async
  35219. * @param {string} url - The path/URL of the file to be loaded. This can also be a data URI.
  35220. * @param {onProgressCallback} onProgress - Executed while the loading is in progress.
  35221. * @return {Promise<Object3D>} A Promise that resolves with the loaded 3D object.
  35222. */
  35223. async loadAsync( url, onProgress ) {
  35224. const scope = this;
  35225. const path = ( this.path === '' ) ? LoaderUtils.extractUrlBase( url ) : this.path;
  35226. this.resourcePath = this.resourcePath || path;
  35227. const loader = new FileLoader( this.manager );
  35228. loader.setPath( this.path );
  35229. loader.setRequestHeader( this.requestHeader );
  35230. loader.setWithCredentials( this.withCredentials );
  35231. const text = await loader.loadAsync( url, onProgress );
  35232. const json = JSON.parse( text );
  35233. const metadata = json.metadata;
  35234. if ( metadata === undefined || metadata.type === undefined || metadata.type.toLowerCase() === 'geometry' ) {
  35235. throw new Error( 'THREE.ObjectLoader: Can\'t load ' + url );
  35236. }
  35237. return await scope.parseAsync( json );
  35238. }
  35239. /**
  35240. * Parses the given JSON. This is used internally by {@link ObjectLoader#load}
  35241. * but can also be used directly to parse a previously loaded JSON structure.
  35242. *
  35243. * @param {Object} json - The serialized 3D object.
  35244. * @param {onLoad} onLoad - Executed when all resources (e.g. textures) have been fully loaded.
  35245. * @return {Object3D} The parsed 3D object.
  35246. */
  35247. parse( json, onLoad ) {
  35248. const animations = this.parseAnimations( json.animations );
  35249. const shapes = this.parseShapes( json.shapes );
  35250. const geometries = this.parseGeometries( json.geometries, shapes );
  35251. const images = this.parseImages( json.images, function () {
  35252. if ( onLoad !== undefined ) onLoad( object );
  35253. } );
  35254. const textures = this.parseTextures( json.textures, images );
  35255. const materials = this.parseMaterials( json.materials, textures );
  35256. const object = this.parseObject( json.object, geometries, materials, textures, animations );
  35257. const skeletons = this.parseSkeletons( json.skeletons, object );
  35258. this.bindSkeletons( object, skeletons );
  35259. this.bindLightTargets( object );
  35260. //
  35261. if ( onLoad !== undefined ) {
  35262. let hasImages = false;
  35263. for ( const uuid in images ) {
  35264. if ( images[ uuid ].data instanceof HTMLImageElement ) {
  35265. hasImages = true;
  35266. break;
  35267. }
  35268. }
  35269. if ( hasImages === false ) onLoad( object );
  35270. }
  35271. return object;
  35272. }
  35273. /**
  35274. * Async version of {@link ObjectLoader#parse}.
  35275. *
  35276. * @param {Object} json - The serialized 3D object.
  35277. * @return {Promise<Object3D>} A Promise that resolves with the parsed 3D object.
  35278. */
  35279. async parseAsync( json ) {
  35280. const animations = this.parseAnimations( json.animations );
  35281. const shapes = this.parseShapes( json.shapes );
  35282. const geometries = this.parseGeometries( json.geometries, shapes );
  35283. const images = await this.parseImagesAsync( json.images );
  35284. const textures = this.parseTextures( json.textures, images );
  35285. const materials = this.parseMaterials( json.materials, textures );
  35286. const object = this.parseObject( json.object, geometries, materials, textures, animations );
  35287. const skeletons = this.parseSkeletons( json.skeletons, object );
  35288. this.bindSkeletons( object, skeletons );
  35289. this.bindLightTargets( object );
  35290. return object;
  35291. }
  35292. // internals
  35293. parseShapes( json ) {
  35294. const shapes = {};
  35295. if ( json !== undefined ) {
  35296. for ( let i = 0, l = json.length; i < l; i ++ ) {
  35297. const shape = new Shape().fromJSON( json[ i ] );
  35298. shapes[ shape.uuid ] = shape;
  35299. }
  35300. }
  35301. return shapes;
  35302. }
  35303. parseSkeletons( json, object ) {
  35304. const skeletons = {};
  35305. const bones = {};
  35306. // generate bone lookup table
  35307. object.traverse( function ( child ) {
  35308. if ( child.isBone ) bones[ child.uuid ] = child;
  35309. } );
  35310. // create skeletons
  35311. if ( json !== undefined ) {
  35312. for ( let i = 0, l = json.length; i < l; i ++ ) {
  35313. const skeleton = new Skeleton().fromJSON( json[ i ], bones );
  35314. skeletons[ skeleton.uuid ] = skeleton;
  35315. }
  35316. }
  35317. return skeletons;
  35318. }
  35319. parseGeometries( json, shapes ) {
  35320. const geometries = {};
  35321. if ( json !== undefined ) {
  35322. const bufferGeometryLoader = new BufferGeometryLoader();
  35323. for ( let i = 0, l = json.length; i < l; i ++ ) {
  35324. let geometry;
  35325. const data = json[ i ];
  35326. switch ( data.type ) {
  35327. case 'BufferGeometry':
  35328. case 'InstancedBufferGeometry':
  35329. geometry = bufferGeometryLoader.parse( data );
  35330. break;
  35331. default:
  35332. if ( data.type in Geometries ) {
  35333. geometry = Geometries[ data.type ].fromJSON( data, shapes );
  35334. } else {
  35335. warn( `ObjectLoader: Unsupported geometry type "${ data.type }"` );
  35336. }
  35337. }
  35338. geometry.uuid = data.uuid;
  35339. if ( data.name !== undefined ) geometry.name = data.name;
  35340. if ( data.userData !== undefined ) geometry.userData = data.userData;
  35341. geometries[ data.uuid ] = geometry;
  35342. }
  35343. }
  35344. return geometries;
  35345. }
  35346. parseMaterials( json, textures ) {
  35347. const cache = {}; // MultiMaterial
  35348. const materials = {};
  35349. if ( json !== undefined ) {
  35350. const loader = new MaterialLoader();
  35351. loader.setTextures( textures );
  35352. for ( let i = 0, l = json.length; i < l; i ++ ) {
  35353. const data = json[ i ];
  35354. if ( cache[ data.uuid ] === undefined ) {
  35355. cache[ data.uuid ] = loader.parse( data );
  35356. }
  35357. materials[ data.uuid ] = cache[ data.uuid ];
  35358. }
  35359. }
  35360. return materials;
  35361. }
  35362. parseAnimations( json ) {
  35363. const animations = {};
  35364. if ( json !== undefined ) {
  35365. for ( let i = 0; i < json.length; i ++ ) {
  35366. const data = json[ i ];
  35367. const clip = AnimationClip.parse( data );
  35368. animations[ clip.uuid ] = clip;
  35369. }
  35370. }
  35371. return animations;
  35372. }
  35373. parseImages( json, onLoad ) {
  35374. const scope = this;
  35375. const images = {};
  35376. let loader;
  35377. function loadImage( url ) {
  35378. scope.manager.itemStart( url );
  35379. return loader.load( url, function () {
  35380. scope.manager.itemEnd( url );
  35381. }, undefined, function () {
  35382. scope.manager.itemError( url );
  35383. scope.manager.itemEnd( url );
  35384. } );
  35385. }
  35386. function deserializeImage( image ) {
  35387. if ( typeof image === 'string' ) {
  35388. const url = image;
  35389. const path = /^(\/\/)|([a-z]+:(\/\/)?)/i.test( url ) ? url : scope.resourcePath + url;
  35390. return loadImage( path );
  35391. } else {
  35392. if ( image.data ) {
  35393. return {
  35394. data: getTypedArray( image.type, image.data ),
  35395. width: image.width,
  35396. height: image.height
  35397. };
  35398. } else {
  35399. return null;
  35400. }
  35401. }
  35402. }
  35403. if ( json !== undefined && json.length > 0 ) {
  35404. const manager = new LoadingManager( onLoad );
  35405. loader = new ImageLoader( manager );
  35406. loader.setCrossOrigin( this.crossOrigin );
  35407. for ( let i = 0, il = json.length; i < il; i ++ ) {
  35408. const image = json[ i ];
  35409. const url = image.url;
  35410. if ( Array.isArray( url ) ) {
  35411. // load array of images e.g CubeTexture
  35412. const imageArray = [];
  35413. for ( let j = 0, jl = url.length; j < jl; j ++ ) {
  35414. const currentUrl = url[ j ];
  35415. const deserializedImage = deserializeImage( currentUrl );
  35416. if ( deserializedImage !== null ) {
  35417. if ( deserializedImage instanceof HTMLImageElement ) {
  35418. imageArray.push( deserializedImage );
  35419. } else {
  35420. // special case: handle array of data textures for cube textures
  35421. imageArray.push( new DataTexture( deserializedImage.data, deserializedImage.width, deserializedImage.height ) );
  35422. }
  35423. }
  35424. }
  35425. images[ image.uuid ] = new Source( imageArray );
  35426. } else {
  35427. // load single image
  35428. const deserializedImage = deserializeImage( image.url );
  35429. images[ image.uuid ] = new Source( deserializedImage );
  35430. }
  35431. }
  35432. }
  35433. return images;
  35434. }
  35435. async parseImagesAsync( json ) {
  35436. const scope = this;
  35437. const images = {};
  35438. let loader;
  35439. async function deserializeImage( image ) {
  35440. if ( typeof image === 'string' ) {
  35441. const url = image;
  35442. const path = /^(\/\/)|([a-z]+:(\/\/)?)/i.test( url ) ? url : scope.resourcePath + url;
  35443. return await loader.loadAsync( path );
  35444. } else {
  35445. if ( image.data ) {
  35446. return {
  35447. data: getTypedArray( image.type, image.data ),
  35448. width: image.width,
  35449. height: image.height
  35450. };
  35451. } else {
  35452. return null;
  35453. }
  35454. }
  35455. }
  35456. if ( json !== undefined && json.length > 0 ) {
  35457. loader = new ImageLoader( this.manager );
  35458. loader.setCrossOrigin( this.crossOrigin );
  35459. for ( let i = 0, il = json.length; i < il; i ++ ) {
  35460. const image = json[ i ];
  35461. const url = image.url;
  35462. if ( Array.isArray( url ) ) {
  35463. // load array of images e.g CubeTexture
  35464. const imageArray = [];
  35465. for ( let j = 0, jl = url.length; j < jl; j ++ ) {
  35466. const currentUrl = url[ j ];
  35467. const deserializedImage = await deserializeImage( currentUrl );
  35468. if ( deserializedImage !== null ) {
  35469. if ( deserializedImage instanceof HTMLImageElement ) {
  35470. imageArray.push( deserializedImage );
  35471. } else {
  35472. // special case: handle array of data textures for cube textures
  35473. imageArray.push( new DataTexture( deserializedImage.data, deserializedImage.width, deserializedImage.height ) );
  35474. }
  35475. }
  35476. }
  35477. images[ image.uuid ] = new Source( imageArray );
  35478. } else {
  35479. // load single image
  35480. const deserializedImage = await deserializeImage( image.url );
  35481. images[ image.uuid ] = new Source( deserializedImage );
  35482. }
  35483. }
  35484. }
  35485. return images;
  35486. }
  35487. parseTextures( json, images ) {
  35488. function parseConstant( value, type ) {
  35489. if ( typeof value === 'number' ) return value;
  35490. warn( 'ObjectLoader.parseTexture: Constant should be in numeric form.', value );
  35491. return type[ value ];
  35492. }
  35493. const textures = {};
  35494. if ( json !== undefined ) {
  35495. for ( let i = 0, l = json.length; i < l; i ++ ) {
  35496. const data = json[ i ];
  35497. if ( data.image === undefined ) {
  35498. warn( 'ObjectLoader: No "image" specified for', data.uuid );
  35499. }
  35500. if ( images[ data.image ] === undefined ) {
  35501. warn( 'ObjectLoader: Undefined image', data.image );
  35502. }
  35503. const source = images[ data.image ];
  35504. const image = source.data;
  35505. let texture;
  35506. if ( Array.isArray( image ) ) {
  35507. texture = new CubeTexture();
  35508. if ( image.length === 6 ) texture.needsUpdate = true;
  35509. } else {
  35510. if ( image && image.data ) {
  35511. texture = new DataTexture();
  35512. } else {
  35513. texture = new Texture();
  35514. }
  35515. if ( image ) texture.needsUpdate = true; // textures can have undefined image data
  35516. }
  35517. texture.source = source;
  35518. texture.uuid = data.uuid;
  35519. if ( data.name !== undefined ) texture.name = data.name;
  35520. if ( data.mapping !== undefined ) texture.mapping = parseConstant( data.mapping, TEXTURE_MAPPING );
  35521. if ( data.channel !== undefined ) texture.channel = data.channel;
  35522. if ( data.offset !== undefined ) texture.offset.fromArray( data.offset );
  35523. if ( data.repeat !== undefined ) texture.repeat.fromArray( data.repeat );
  35524. if ( data.center !== undefined ) texture.center.fromArray( data.center );
  35525. if ( data.rotation !== undefined ) texture.rotation = data.rotation;
  35526. if ( data.wrap !== undefined ) {
  35527. texture.wrapS = parseConstant( data.wrap[ 0 ], TEXTURE_WRAPPING );
  35528. texture.wrapT = parseConstant( data.wrap[ 1 ], TEXTURE_WRAPPING );
  35529. }
  35530. if ( data.format !== undefined ) texture.format = data.format;
  35531. if ( data.internalFormat !== undefined ) texture.internalFormat = data.internalFormat;
  35532. if ( data.type !== undefined ) texture.type = data.type;
  35533. if ( data.colorSpace !== undefined ) texture.colorSpace = data.colorSpace;
  35534. if ( data.minFilter !== undefined ) texture.minFilter = parseConstant( data.minFilter, TEXTURE_FILTER );
  35535. if ( data.magFilter !== undefined ) texture.magFilter = parseConstant( data.magFilter, TEXTURE_FILTER );
  35536. if ( data.anisotropy !== undefined ) texture.anisotropy = data.anisotropy;
  35537. if ( data.flipY !== undefined ) texture.flipY = data.flipY;
  35538. if ( data.generateMipmaps !== undefined ) texture.generateMipmaps = data.generateMipmaps;
  35539. if ( data.premultiplyAlpha !== undefined ) texture.premultiplyAlpha = data.premultiplyAlpha;
  35540. if ( data.unpackAlignment !== undefined ) texture.unpackAlignment = data.unpackAlignment;
  35541. if ( data.compareFunction !== undefined ) texture.compareFunction = data.compareFunction;
  35542. if ( data.userData !== undefined ) texture.userData = data.userData;
  35543. textures[ data.uuid ] = texture;
  35544. }
  35545. }
  35546. return textures;
  35547. }
  35548. parseObject( data, geometries, materials, textures, animations ) {
  35549. let object;
  35550. function getGeometry( name ) {
  35551. if ( geometries[ name ] === undefined ) {
  35552. warn( 'ObjectLoader: Undefined geometry', name );
  35553. }
  35554. return geometries[ name ];
  35555. }
  35556. function getMaterial( name ) {
  35557. if ( name === undefined ) return undefined;
  35558. if ( Array.isArray( name ) ) {
  35559. const array = [];
  35560. for ( let i = 0, l = name.length; i < l; i ++ ) {
  35561. const uuid = name[ i ];
  35562. if ( materials[ uuid ] === undefined ) {
  35563. warn( 'ObjectLoader: Undefined material', uuid );
  35564. }
  35565. array.push( materials[ uuid ] );
  35566. }
  35567. return array;
  35568. }
  35569. if ( materials[ name ] === undefined ) {
  35570. warn( 'ObjectLoader: Undefined material', name );
  35571. }
  35572. return materials[ name ];
  35573. }
  35574. function getTexture( uuid ) {
  35575. if ( textures[ uuid ] === undefined ) {
  35576. warn( 'ObjectLoader: Undefined texture', uuid );
  35577. }
  35578. return textures[ uuid ];
  35579. }
  35580. let geometry, material;
  35581. switch ( data.type ) {
  35582. case 'Scene':
  35583. object = new Scene();
  35584. if ( data.background !== undefined ) {
  35585. if ( Number.isInteger( data.background ) ) {
  35586. object.background = new Color( data.background );
  35587. } else {
  35588. object.background = getTexture( data.background );
  35589. }
  35590. }
  35591. if ( data.environment !== undefined ) {
  35592. object.environment = getTexture( data.environment );
  35593. }
  35594. if ( data.fog !== undefined ) {
  35595. if ( data.fog.type === 'Fog' ) {
  35596. object.fog = new Fog( data.fog.color, data.fog.near, data.fog.far );
  35597. } else if ( data.fog.type === 'FogExp2' ) {
  35598. object.fog = new FogExp2( data.fog.color, data.fog.density );
  35599. }
  35600. if ( data.fog.name !== '' ) {
  35601. object.fog.name = data.fog.name;
  35602. }
  35603. }
  35604. if ( data.backgroundBlurriness !== undefined ) object.backgroundBlurriness = data.backgroundBlurriness;
  35605. if ( data.backgroundIntensity !== undefined ) object.backgroundIntensity = data.backgroundIntensity;
  35606. if ( data.backgroundRotation !== undefined ) object.backgroundRotation.fromArray( data.backgroundRotation );
  35607. if ( data.environmentIntensity !== undefined ) object.environmentIntensity = data.environmentIntensity;
  35608. if ( data.environmentRotation !== undefined ) object.environmentRotation.fromArray( data.environmentRotation );
  35609. break;
  35610. case 'PerspectiveCamera':
  35611. object = new PerspectiveCamera( data.fov, data.aspect, data.near, data.far );
  35612. if ( data.focus !== undefined ) object.focus = data.focus;
  35613. if ( data.zoom !== undefined ) object.zoom = data.zoom;
  35614. if ( data.filmGauge !== undefined ) object.filmGauge = data.filmGauge;
  35615. if ( data.filmOffset !== undefined ) object.filmOffset = data.filmOffset;
  35616. if ( data.view !== undefined ) object.view = Object.assign( {}, data.view );
  35617. break;
  35618. case 'OrthographicCamera':
  35619. object = new OrthographicCamera( data.left, data.right, data.top, data.bottom, data.near, data.far );
  35620. if ( data.zoom !== undefined ) object.zoom = data.zoom;
  35621. if ( data.view !== undefined ) object.view = Object.assign( {}, data.view );
  35622. break;
  35623. case 'AmbientLight':
  35624. object = new AmbientLight( data.color, data.intensity );
  35625. break;
  35626. case 'DirectionalLight':
  35627. object = new DirectionalLight( data.color, data.intensity );
  35628. object.target = data.target || '';
  35629. break;
  35630. case 'PointLight':
  35631. object = new PointLight( data.color, data.intensity, data.distance, data.decay );
  35632. break;
  35633. case 'RectAreaLight':
  35634. object = new RectAreaLight( data.color, data.intensity, data.width, data.height );
  35635. break;
  35636. case 'SpotLight':
  35637. object = new SpotLight( data.color, data.intensity, data.distance, data.angle, data.penumbra, data.decay );
  35638. object.target = data.target || '';
  35639. break;
  35640. case 'HemisphereLight':
  35641. object = new HemisphereLight( data.color, data.groundColor, data.intensity );
  35642. break;
  35643. case 'LightProbe':
  35644. const sh = new SphericalHarmonics3().fromArray( data.sh );
  35645. object = new LightProbe( sh, data.intensity );
  35646. break;
  35647. case 'SkinnedMesh':
  35648. geometry = getGeometry( data.geometry );
  35649. material = getMaterial( data.material );
  35650. object = new SkinnedMesh( geometry, material );
  35651. if ( data.bindMode !== undefined ) object.bindMode = data.bindMode;
  35652. if ( data.bindMatrix !== undefined ) object.bindMatrix.fromArray( data.bindMatrix );
  35653. if ( data.skeleton !== undefined ) object.skeleton = data.skeleton;
  35654. break;
  35655. case 'Mesh':
  35656. geometry = getGeometry( data.geometry );
  35657. material = getMaterial( data.material );
  35658. object = new Mesh( geometry, material );
  35659. break;
  35660. case 'InstancedMesh':
  35661. geometry = getGeometry( data.geometry );
  35662. material = getMaterial( data.material );
  35663. const count = data.count;
  35664. const instanceMatrix = data.instanceMatrix;
  35665. const instanceColor = data.instanceColor;
  35666. object = new InstancedMesh( geometry, material, count );
  35667. object.instanceMatrix = new InstancedBufferAttribute( new Float32Array( instanceMatrix.array ), 16 );
  35668. if ( instanceColor !== undefined ) object.instanceColor = new InstancedBufferAttribute( new Float32Array( instanceColor.array ), instanceColor.itemSize );
  35669. break;
  35670. case 'BatchedMesh':
  35671. geometry = getGeometry( data.geometry );
  35672. material = getMaterial( data.material );
  35673. object = new BatchedMesh( data.maxInstanceCount, data.maxVertexCount, data.maxIndexCount, material );
  35674. object.geometry = geometry;
  35675. object.perObjectFrustumCulled = data.perObjectFrustumCulled;
  35676. object.sortObjects = data.sortObjects;
  35677. object._drawRanges = data.drawRanges;
  35678. object._reservedRanges = data.reservedRanges;
  35679. object._geometryInfo = data.geometryInfo.map( info => {
  35680. let box = null;
  35681. let sphere = null;
  35682. if ( info.boundingBox !== undefined ) {
  35683. box = new Box3().fromJSON( info.boundingBox );
  35684. }
  35685. if ( info.boundingSphere !== undefined ) {
  35686. sphere = new Sphere().fromJSON( info.boundingSphere );
  35687. }
  35688. return {
  35689. ...info,
  35690. boundingBox: box,
  35691. boundingSphere: sphere
  35692. };
  35693. } );
  35694. object._instanceInfo = data.instanceInfo;
  35695. object._availableInstanceIds = data._availableInstanceIds;
  35696. object._availableGeometryIds = data._availableGeometryIds;
  35697. object._nextIndexStart = data.nextIndexStart;
  35698. object._nextVertexStart = data.nextVertexStart;
  35699. object._geometryCount = data.geometryCount;
  35700. object._maxInstanceCount = data.maxInstanceCount;
  35701. object._maxVertexCount = data.maxVertexCount;
  35702. object._maxIndexCount = data.maxIndexCount;
  35703. object._geometryInitialized = data.geometryInitialized;
  35704. object._matricesTexture = getTexture( data.matricesTexture.uuid );
  35705. object._indirectTexture = getTexture( data.indirectTexture.uuid );
  35706. if ( data.colorsTexture !== undefined ) {
  35707. object._colorsTexture = getTexture( data.colorsTexture.uuid );
  35708. }
  35709. if ( data.boundingSphere !== undefined ) {
  35710. object.boundingSphere = new Sphere().fromJSON( data.boundingSphere );
  35711. }
  35712. if ( data.boundingBox !== undefined ) {
  35713. object.boundingBox = new Box3().fromJSON( data.boundingBox );
  35714. }
  35715. break;
  35716. case 'LOD':
  35717. object = new LOD();
  35718. break;
  35719. case 'Line':
  35720. object = new Line( getGeometry( data.geometry ), getMaterial( data.material ) );
  35721. break;
  35722. case 'LineLoop':
  35723. object = new LineLoop( getGeometry( data.geometry ), getMaterial( data.material ) );
  35724. break;
  35725. case 'LineSegments':
  35726. object = new LineSegments( getGeometry( data.geometry ), getMaterial( data.material ) );
  35727. break;
  35728. case 'PointCloud':
  35729. case 'Points':
  35730. object = new Points( getGeometry( data.geometry ), getMaterial( data.material ) );
  35731. break;
  35732. case 'Sprite':
  35733. object = new Sprite( getMaterial( data.material ) );
  35734. break;
  35735. case 'Group':
  35736. object = new Group();
  35737. break;
  35738. case 'Bone':
  35739. object = new Bone();
  35740. break;
  35741. default:
  35742. object = new Object3D();
  35743. }
  35744. object.uuid = data.uuid;
  35745. if ( data.name !== undefined ) object.name = data.name;
  35746. if ( data.matrix !== undefined ) {
  35747. object.matrix.fromArray( data.matrix );
  35748. if ( data.matrixAutoUpdate !== undefined ) object.matrixAutoUpdate = data.matrixAutoUpdate;
  35749. if ( object.matrixAutoUpdate ) object.matrix.decompose( object.position, object.quaternion, object.scale );
  35750. } else {
  35751. if ( data.position !== undefined ) object.position.fromArray( data.position );
  35752. if ( data.rotation !== undefined ) object.rotation.fromArray( data.rotation );
  35753. if ( data.quaternion !== undefined ) object.quaternion.fromArray( data.quaternion );
  35754. if ( data.scale !== undefined ) object.scale.fromArray( data.scale );
  35755. }
  35756. if ( data.up !== undefined ) object.up.fromArray( data.up );
  35757. if ( data.pivot !== undefined ) object.pivot = new Vector3().fromArray( data.pivot );
  35758. if ( data.morphTargetDictionary !== undefined ) object.morphTargetDictionary = Object.assign( {}, data.morphTargetDictionary );
  35759. if ( data.morphTargetInfluences !== undefined ) object.morphTargetInfluences = data.morphTargetInfluences.slice();
  35760. if ( data.castShadow !== undefined ) object.castShadow = data.castShadow;
  35761. if ( data.receiveShadow !== undefined ) object.receiveShadow = data.receiveShadow;
  35762. if ( data.shadow ) {
  35763. if ( data.shadow.intensity !== undefined ) object.shadow.intensity = data.shadow.intensity;
  35764. if ( data.shadow.bias !== undefined ) object.shadow.bias = data.shadow.bias;
  35765. if ( data.shadow.normalBias !== undefined ) object.shadow.normalBias = data.shadow.normalBias;
  35766. if ( data.shadow.radius !== undefined ) object.shadow.radius = data.shadow.radius;
  35767. if ( data.shadow.mapSize !== undefined ) object.shadow.mapSize.fromArray( data.shadow.mapSize );
  35768. if ( data.shadow.camera !== undefined ) object.shadow.camera = this.parseObject( data.shadow.camera );
  35769. }
  35770. if ( data.visible !== undefined ) object.visible = data.visible;
  35771. if ( data.frustumCulled !== undefined ) object.frustumCulled = data.frustumCulled;
  35772. if ( data.renderOrder !== undefined ) object.renderOrder = data.renderOrder;
  35773. if ( data.static !== undefined ) object.static = data.static;
  35774. if ( data.userData !== undefined ) object.userData = data.userData;
  35775. if ( data.layers !== undefined ) object.layers.mask = data.layers;
  35776. if ( data.children !== undefined ) {
  35777. const children = data.children;
  35778. for ( let i = 0; i < children.length; i ++ ) {
  35779. object.add( this.parseObject( children[ i ], geometries, materials, textures, animations ) );
  35780. }
  35781. }
  35782. if ( data.animations !== undefined ) {
  35783. const objectAnimations = data.animations;
  35784. for ( let i = 0; i < objectAnimations.length; i ++ ) {
  35785. const uuid = objectAnimations[ i ];
  35786. object.animations.push( animations[ uuid ] );
  35787. }
  35788. }
  35789. if ( data.type === 'LOD' ) {
  35790. if ( data.autoUpdate !== undefined ) object.autoUpdate = data.autoUpdate;
  35791. const levels = data.levels;
  35792. for ( let l = 0; l < levels.length; l ++ ) {
  35793. const level = levels[ l ];
  35794. const child = object.getObjectByProperty( 'uuid', level.object );
  35795. if ( child !== undefined ) {
  35796. object.addLevel( child, level.distance, level.hysteresis );
  35797. }
  35798. }
  35799. }
  35800. return object;
  35801. }
  35802. bindSkeletons( object, skeletons ) {
  35803. if ( Object.keys( skeletons ).length === 0 ) return;
  35804. object.traverse( function ( child ) {
  35805. if ( child.isSkinnedMesh === true && child.skeleton !== undefined ) {
  35806. const skeleton = skeletons[ child.skeleton ];
  35807. if ( skeleton === undefined ) {
  35808. warn( 'ObjectLoader: No skeleton found with UUID:', child.skeleton );
  35809. } else {
  35810. child.bind( skeleton, child.bindMatrix );
  35811. }
  35812. }
  35813. } );
  35814. }
  35815. bindLightTargets( object ) {
  35816. object.traverse( function ( child ) {
  35817. if ( child.isDirectionalLight || child.isSpotLight ) {
  35818. const uuid = child.target;
  35819. const target = object.getObjectByProperty( 'uuid', uuid );
  35820. if ( target !== undefined ) {
  35821. child.target = target;
  35822. } else {
  35823. child.target = new Object3D();
  35824. }
  35825. }
  35826. } );
  35827. }
  35828. }
  35829. const TEXTURE_MAPPING = {
  35830. UVMapping: UVMapping,
  35831. CubeReflectionMapping: CubeReflectionMapping,
  35832. CubeRefractionMapping: CubeRefractionMapping,
  35833. EquirectangularReflectionMapping: EquirectangularReflectionMapping,
  35834. EquirectangularRefractionMapping: EquirectangularRefractionMapping,
  35835. CubeUVReflectionMapping: CubeUVReflectionMapping
  35836. };
  35837. const TEXTURE_WRAPPING = {
  35838. RepeatWrapping: RepeatWrapping,
  35839. ClampToEdgeWrapping: ClampToEdgeWrapping,
  35840. MirroredRepeatWrapping: MirroredRepeatWrapping
  35841. };
  35842. const TEXTURE_FILTER = {
  35843. NearestFilter: NearestFilter,
  35844. NearestMipmapNearestFilter: NearestMipmapNearestFilter,
  35845. NearestMipmapLinearFilter: NearestMipmapLinearFilter,
  35846. LinearFilter: LinearFilter,
  35847. LinearMipmapNearestFilter: LinearMipmapNearestFilter,
  35848. LinearMipmapLinearFilter: LinearMipmapLinearFilter
  35849. };
  35850. const _errorMap = new WeakMap();
  35851. /**
  35852. * A loader for loading images as an [ImageBitmap](https://developer.mozilla.org/en-US/docs/Web/API/ImageBitmap).
  35853. * An `ImageBitmap` provides an asynchronous and resource efficient pathway to prepare
  35854. * textures for rendering.
  35855. *
  35856. * Note that {@link Texture#flipY} and {@link Texture#premultiplyAlpha} are ignored with image bitmaps.
  35857. * These options need to be configured via {@link ImageBitmapLoader#setOptions} prior to loading,
  35858. * unlike regular images which can be configured on the Texture to set these options on GPU upload instead.
  35859. *
  35860. * To match the default behaviour of {@link Texture}, the following options are needed:
  35861. *
  35862. * ```js
  35863. * { imageOrientation: 'flipY', premultiplyAlpha: 'none' }
  35864. * ```
  35865. *
  35866. * Also note that unlike {@link FileLoader}, this loader will only avoid multiple concurrent requests to the same URL if {@link Cache} is enabled.
  35867. *
  35868. * ```js
  35869. * const loader = new THREE.ImageBitmapLoader();
  35870. * loader.setOptions( { imageOrientation: 'flipY' } ); // set options if needed
  35871. * const imageBitmap = await loader.loadAsync( 'image.png' );
  35872. *
  35873. * const texture = new THREE.Texture( imageBitmap );
  35874. * texture.needsUpdate = true;
  35875. * ```
  35876. *
  35877. * @augments Loader
  35878. */
  35879. class ImageBitmapLoader extends Loader {
  35880. /**
  35881. * Constructs a new image bitmap loader.
  35882. *
  35883. * @param {LoadingManager} [manager] - The loading manager.
  35884. */
  35885. constructor( manager ) {
  35886. super( manager );
  35887. /**
  35888. * This flag can be used for type testing.
  35889. *
  35890. * @type {boolean}
  35891. * @readonly
  35892. * @default true
  35893. */
  35894. this.isImageBitmapLoader = true;
  35895. if ( typeof createImageBitmap === 'undefined' ) {
  35896. warn( 'ImageBitmapLoader: createImageBitmap() not supported.' );
  35897. }
  35898. if ( typeof fetch === 'undefined' ) {
  35899. warn( 'ImageBitmapLoader: fetch() not supported.' );
  35900. }
  35901. /**
  35902. * Represents the loader options.
  35903. *
  35904. * @type {Object}
  35905. * @default {premultiplyAlpha:'none'}
  35906. */
  35907. this.options = { premultiplyAlpha: 'none' };
  35908. /**
  35909. * Used for aborting requests.
  35910. *
  35911. * @private
  35912. * @type {AbortController}
  35913. */
  35914. this._abortController = new AbortController();
  35915. }
  35916. /**
  35917. * Sets the given loader options. The structure of the object must match the `options` parameter of
  35918. * [createImageBitmap](https://developer.mozilla.org/en-US/docs/Web/API/Window/createImageBitmap).
  35919. *
  35920. * @param {Object} options - The loader options to set.
  35921. * @return {ImageBitmapLoader} A reference to this image bitmap loader.
  35922. */
  35923. setOptions( options ) {
  35924. this.options = options;
  35925. return this;
  35926. }
  35927. /**
  35928. * Starts loading from the given URL and pass the loaded image bitmap to the `onLoad()` callback.
  35929. *
  35930. * @param {string} url - The path/URL of the file to be loaded. This can also be a data URI.
  35931. * @param {function(ImageBitmap)} onLoad - Executed when the loading process has been finished.
  35932. * @param {onProgressCallback} onProgress - Unsupported in this loader.
  35933. * @param {onErrorCallback} onError - Executed when errors occur.
  35934. * @return {ImageBitmap|undefined} The image bitmap.
  35935. */
  35936. load( url, onLoad, onProgress, onError ) {
  35937. if ( url === undefined ) url = '';
  35938. if ( this.path !== undefined ) url = this.path + url;
  35939. url = this.manager.resolveURL( url );
  35940. const scope = this;
  35941. const cached = Cache.get( `image-bitmap:${url}` );
  35942. if ( cached !== undefined ) {
  35943. scope.manager.itemStart( url );
  35944. // If cached is a promise, wait for it to resolve
  35945. if ( cached.then ) {
  35946. cached.then( imageBitmap => {
  35947. // check if there is an error for the cached promise
  35948. if ( _errorMap.has( cached ) === true ) {
  35949. if ( onError ) onError( _errorMap.get( cached ) );
  35950. scope.manager.itemError( url );
  35951. scope.manager.itemEnd( url );
  35952. } else {
  35953. if ( onLoad ) onLoad( imageBitmap );
  35954. scope.manager.itemEnd( url );
  35955. return imageBitmap;
  35956. }
  35957. } );
  35958. return;
  35959. }
  35960. // If cached is not a promise (i.e., it's already an imageBitmap)
  35961. setTimeout( function () {
  35962. if ( onLoad ) onLoad( cached );
  35963. scope.manager.itemEnd( url );
  35964. }, 0 );
  35965. return cached;
  35966. }
  35967. const fetchOptions = {};
  35968. fetchOptions.credentials = ( this.crossOrigin === 'anonymous' ) ? 'same-origin' : 'include';
  35969. fetchOptions.headers = this.requestHeader;
  35970. fetchOptions.signal = ( typeof AbortSignal.any === 'function' ) ? AbortSignal.any( [ this._abortController.signal, this.manager.abortController.signal ] ) : this._abortController.signal;
  35971. const promise = fetch( url, fetchOptions ).then( function ( res ) {
  35972. return res.blob();
  35973. } ).then( function ( blob ) {
  35974. return createImageBitmap( blob, Object.assign( scope.options, { colorSpaceConversion: 'none' } ) );
  35975. } ).then( function ( imageBitmap ) {
  35976. Cache.add( `image-bitmap:${url}`, imageBitmap );
  35977. if ( onLoad ) onLoad( imageBitmap );
  35978. scope.manager.itemEnd( url );
  35979. return imageBitmap;
  35980. } ).catch( function ( e ) {
  35981. if ( onError ) onError( e );
  35982. _errorMap.set( promise, e );
  35983. Cache.remove( `image-bitmap:${url}` );
  35984. scope.manager.itemError( url );
  35985. scope.manager.itemEnd( url );
  35986. } );
  35987. Cache.add( `image-bitmap:${url}`, promise );
  35988. scope.manager.itemStart( url );
  35989. }
  35990. /**
  35991. * Aborts ongoing fetch requests.
  35992. *
  35993. * @return {ImageBitmapLoader} A reference to this instance.
  35994. */
  35995. abort() {
  35996. this._abortController.abort();
  35997. this._abortController = new AbortController();
  35998. return this;
  35999. }
  36000. }
  36001. let _context;
  36002. /**
  36003. * Manages the global audio context in the engine.
  36004. *
  36005. * @hideconstructor
  36006. */
  36007. class AudioContext {
  36008. /**
  36009. * Returns the global native audio context.
  36010. *
  36011. * @return {AudioContext} The native audio context.
  36012. */
  36013. static getContext() {
  36014. if ( _context === undefined ) {
  36015. _context = new ( window.AudioContext || window.webkitAudioContext )();
  36016. }
  36017. return _context;
  36018. }
  36019. /**
  36020. * Allows to set the global native audio context from outside.
  36021. *
  36022. * @param {AudioContext} value - The native context to set.
  36023. */
  36024. static setContext( value ) {
  36025. _context = value;
  36026. }
  36027. }
  36028. /**
  36029. * Class for loading audio buffers. Audios are internally
  36030. * loaded via {@link FileLoader}.
  36031. *
  36032. * ```js
  36033. * const audioListener = new THREE.AudioListener();
  36034. * const ambientSound = new THREE.Audio( audioListener );
  36035. *
  36036. * const loader = new THREE.AudioLoader();
  36037. * const audioBuffer = await loader.loadAsync( 'audio/ambient_ocean.ogg' );
  36038. *
  36039. * ambientSound.setBuffer( audioBuffer );
  36040. * ambientSound.play();
  36041. * ```
  36042. *
  36043. * @augments Loader
  36044. */
  36045. class AudioLoader extends Loader {
  36046. /**
  36047. * Constructs a new audio loader.
  36048. *
  36049. * @param {LoadingManager} [manager] - The loading manager.
  36050. */
  36051. constructor( manager ) {
  36052. super( manager );
  36053. }
  36054. /**
  36055. * Starts loading from the given URL and passes the loaded audio buffer
  36056. * to the `onLoad()` callback.
  36057. *
  36058. * @param {string} url - The path/URL of the file to be loaded. This can also be a data URI.
  36059. * @param {function(AudioBuffer)} onLoad - Executed when the loading process has been finished.
  36060. * @param {onProgressCallback} onProgress - Executed while the loading is in progress.
  36061. * @param {onErrorCallback} onError - Executed when errors occur.
  36062. */
  36063. load( url, onLoad, onProgress, onError ) {
  36064. const scope = this;
  36065. const loader = new FileLoader( this.manager );
  36066. loader.setResponseType( 'arraybuffer' );
  36067. loader.setPath( this.path );
  36068. loader.setRequestHeader( this.requestHeader );
  36069. loader.setWithCredentials( this.withCredentials );
  36070. loader.load( url, function ( buffer ) {
  36071. try {
  36072. // Create a copy of the buffer. The `decodeAudioData` method
  36073. // detaches the buffer when complete, preventing reuse.
  36074. const bufferCopy = buffer.slice( 0 );
  36075. const context = AudioContext.getContext();
  36076. context.decodeAudioData( bufferCopy, function ( audioBuffer ) {
  36077. onLoad( audioBuffer );
  36078. } ).catch( handleError );
  36079. } catch ( e ) {
  36080. handleError( e );
  36081. }
  36082. }, onProgress, onError );
  36083. function handleError( e ) {
  36084. if ( onError ) {
  36085. onError( e );
  36086. } else {
  36087. error( e );
  36088. }
  36089. scope.manager.itemError( url );
  36090. }
  36091. }
  36092. }
  36093. const _eyeRight = /*@__PURE__*/ new Matrix4();
  36094. const _eyeLeft = /*@__PURE__*/ new Matrix4();
  36095. const _projectionMatrix = /*@__PURE__*/ new Matrix4();
  36096. /**
  36097. * A special type of camera that uses two perspective cameras with
  36098. * stereoscopic projection. Can be used for rendering stereo effects
  36099. * like [3D Anaglyph](https://en.wikipedia.org/wiki/Anaglyph_3D) or
  36100. * [Parallax Barrier](https://en.wikipedia.org/wiki/parallax_barrier).
  36101. */
  36102. class StereoCamera {
  36103. /**
  36104. * Constructs a new stereo camera.
  36105. */
  36106. constructor() {
  36107. /**
  36108. * The type property is used for detecting the object type
  36109. * in context of serialization/deserialization.
  36110. *
  36111. * @type {string}
  36112. * @readonly
  36113. */
  36114. this.type = 'StereoCamera';
  36115. /**
  36116. * The aspect.
  36117. *
  36118. * @type {number}
  36119. * @default 1
  36120. */
  36121. this.aspect = 1;
  36122. /**
  36123. * The eye separation which represents the distance
  36124. * between the left and right camera.
  36125. *
  36126. * @type {number}
  36127. * @default 0.064
  36128. */
  36129. this.eyeSep = 0.064;
  36130. /**
  36131. * The camera representing the left eye. This is added to layer `1` so objects to be
  36132. * rendered by the left camera must also be added to this layer.
  36133. *
  36134. * @type {PerspectiveCamera}
  36135. */
  36136. this.cameraL = new PerspectiveCamera();
  36137. this.cameraL.layers.enable( 1 );
  36138. this.cameraL.matrixAutoUpdate = false;
  36139. /**
  36140. * The camera representing the right eye. This is added to layer `2` so objects to be
  36141. * rendered by the right camera must also be added to this layer.
  36142. *
  36143. * @type {PerspectiveCamera}
  36144. */
  36145. this.cameraR = new PerspectiveCamera();
  36146. this.cameraR.layers.enable( 2 );
  36147. this.cameraR.matrixAutoUpdate = false;
  36148. this._cache = {
  36149. focus: null,
  36150. fov: null,
  36151. aspect: null,
  36152. near: null,
  36153. far: null,
  36154. zoom: null,
  36155. eyeSep: null
  36156. };
  36157. }
  36158. /**
  36159. * Updates the stereo camera based on the given perspective camera.
  36160. *
  36161. * @param {PerspectiveCamera} camera - The perspective camera.
  36162. */
  36163. update( camera ) {
  36164. const cache = this._cache;
  36165. const needsUpdate = cache.focus !== camera.focus || cache.fov !== camera.fov ||
  36166. cache.aspect !== camera.aspect * this.aspect || cache.near !== camera.near ||
  36167. cache.far !== camera.far || cache.zoom !== camera.zoom || cache.eyeSep !== this.eyeSep;
  36168. if ( needsUpdate ) {
  36169. cache.focus = camera.focus;
  36170. cache.fov = camera.fov;
  36171. cache.aspect = camera.aspect * this.aspect;
  36172. cache.near = camera.near;
  36173. cache.far = camera.far;
  36174. cache.zoom = camera.zoom;
  36175. cache.eyeSep = this.eyeSep;
  36176. // Off-axis stereoscopic effect based on
  36177. // http://paulbourke.net/stereographics/stereorender/
  36178. _projectionMatrix.copy( camera.projectionMatrix );
  36179. const eyeSepHalf = cache.eyeSep / 2;
  36180. const eyeSepOnProjection = eyeSepHalf * cache.near / cache.focus;
  36181. const ymax = ( cache.near * Math.tan( DEG2RAD * cache.fov * 0.5 ) ) / cache.zoom;
  36182. let xmin, xmax;
  36183. // translate xOffset
  36184. _eyeLeft.elements[ 12 ] = - eyeSepHalf;
  36185. _eyeRight.elements[ 12 ] = eyeSepHalf;
  36186. // for left eye
  36187. xmin = - ymax * cache.aspect + eyeSepOnProjection;
  36188. xmax = ymax * cache.aspect + eyeSepOnProjection;
  36189. _projectionMatrix.elements[ 0 ] = 2 * cache.near / ( xmax - xmin );
  36190. _projectionMatrix.elements[ 8 ] = ( xmax + xmin ) / ( xmax - xmin );
  36191. this.cameraL.projectionMatrix.copy( _projectionMatrix );
  36192. // for right eye
  36193. xmin = - ymax * cache.aspect - eyeSepOnProjection;
  36194. xmax = ymax * cache.aspect - eyeSepOnProjection;
  36195. _projectionMatrix.elements[ 0 ] = 2 * cache.near / ( xmax - xmin );
  36196. _projectionMatrix.elements[ 8 ] = ( xmax + xmin ) / ( xmax - xmin );
  36197. this.cameraR.projectionMatrix.copy( _projectionMatrix );
  36198. }
  36199. this.cameraL.matrixWorld.copy( camera.matrixWorld ).multiply( _eyeLeft );
  36200. this.cameraR.matrixWorld.copy( camera.matrixWorld ).multiply( _eyeRight );
  36201. }
  36202. }
  36203. const fov = -90; // negative fov is not an error
  36204. const aspect = 1;
  36205. /**
  36206. * A special type of camera that is positioned in 3D space to render its surroundings into a
  36207. * cube render target. The render target can then be used as an environment map for rendering
  36208. * realtime reflections in your scene.
  36209. *
  36210. * ```js
  36211. * // Create cube render target
  36212. * const cubeRenderTarget = new THREE.WebGLCubeRenderTarget( 256, { generateMipmaps: true, minFilter: THREE.LinearMipmapLinearFilter } );
  36213. *
  36214. * // Create cube camera
  36215. * const cubeCamera = new THREE.CubeCamera( 1, 100000, cubeRenderTarget );
  36216. * scene.add( cubeCamera );
  36217. *
  36218. * // Create car
  36219. * const chromeMaterial = new THREE.MeshLambertMaterial( { color: 0xffffff, envMap: cubeRenderTarget.texture } );
  36220. * const car = new THREE.Mesh( carGeometry, chromeMaterial );
  36221. * scene.add( car );
  36222. *
  36223. * // Update the render target cube
  36224. * car.visible = false;
  36225. * cubeCamera.position.copy( car.position );
  36226. * cubeCamera.update( renderer, scene );
  36227. *
  36228. * // Render the scene
  36229. * car.visible = true;
  36230. * renderer.render( scene, camera );
  36231. * ```
  36232. *
  36233. * @augments Object3D
  36234. */
  36235. class CubeCamera extends Object3D {
  36236. /**
  36237. * Constructs a new cube camera.
  36238. *
  36239. * @param {number} near - The camera's near plane.
  36240. * @param {number} far - The camera's far plane.
  36241. * @param {WebGLCubeRenderTarget} renderTarget - The cube render target.
  36242. */
  36243. constructor( near, far, renderTarget ) {
  36244. super();
  36245. this.type = 'CubeCamera';
  36246. /**
  36247. * A reference to the cube render target.
  36248. *
  36249. * @type {WebGLCubeRenderTarget}
  36250. */
  36251. this.renderTarget = renderTarget;
  36252. /**
  36253. * The current active coordinate system.
  36254. *
  36255. * @type {?(WebGLCoordinateSystem|WebGPUCoordinateSystem)}
  36256. * @default null
  36257. */
  36258. this.coordinateSystem = null;
  36259. /**
  36260. * The current active mipmap level
  36261. *
  36262. * @type {number}
  36263. * @default 0
  36264. */
  36265. this.activeMipmapLevel = 0;
  36266. const cameraPX = new PerspectiveCamera( fov, aspect, near, far );
  36267. cameraPX.layers = this.layers;
  36268. this.add( cameraPX );
  36269. const cameraNX = new PerspectiveCamera( fov, aspect, near, far );
  36270. cameraNX.layers = this.layers;
  36271. this.add( cameraNX );
  36272. const cameraPY = new PerspectiveCamera( fov, aspect, near, far );
  36273. cameraPY.layers = this.layers;
  36274. this.add( cameraPY );
  36275. const cameraNY = new PerspectiveCamera( fov, aspect, near, far );
  36276. cameraNY.layers = this.layers;
  36277. this.add( cameraNY );
  36278. const cameraPZ = new PerspectiveCamera( fov, aspect, near, far );
  36279. cameraPZ.layers = this.layers;
  36280. this.add( cameraPZ );
  36281. const cameraNZ = new PerspectiveCamera( fov, aspect, near, far );
  36282. cameraNZ.layers = this.layers;
  36283. this.add( cameraNZ );
  36284. }
  36285. /**
  36286. * Must be called when the coordinate system of the cube camera is changed.
  36287. */
  36288. updateCoordinateSystem() {
  36289. const coordinateSystem = this.coordinateSystem;
  36290. const cameras = this.children.concat();
  36291. const [ cameraPX, cameraNX, cameraPY, cameraNY, cameraPZ, cameraNZ ] = cameras;
  36292. for ( const camera of cameras ) this.remove( camera );
  36293. if ( coordinateSystem === WebGLCoordinateSystem ) {
  36294. cameraPX.up.set( 0, 1, 0 );
  36295. cameraPX.lookAt( 1, 0, 0 );
  36296. cameraNX.up.set( 0, 1, 0 );
  36297. cameraNX.lookAt( -1, 0, 0 );
  36298. cameraPY.up.set( 0, 0, -1 );
  36299. cameraPY.lookAt( 0, 1, 0 );
  36300. cameraNY.up.set( 0, 0, 1 );
  36301. cameraNY.lookAt( 0, -1, 0 );
  36302. cameraPZ.up.set( 0, 1, 0 );
  36303. cameraPZ.lookAt( 0, 0, 1 );
  36304. cameraNZ.up.set( 0, 1, 0 );
  36305. cameraNZ.lookAt( 0, 0, -1 );
  36306. } else if ( coordinateSystem === WebGPUCoordinateSystem ) {
  36307. cameraPX.up.set( 0, -1, 0 );
  36308. cameraPX.lookAt( -1, 0, 0 );
  36309. cameraNX.up.set( 0, -1, 0 );
  36310. cameraNX.lookAt( 1, 0, 0 );
  36311. cameraPY.up.set( 0, 0, 1 );
  36312. cameraPY.lookAt( 0, 1, 0 );
  36313. cameraNY.up.set( 0, 0, -1 );
  36314. cameraNY.lookAt( 0, -1, 0 );
  36315. cameraPZ.up.set( 0, -1, 0 );
  36316. cameraPZ.lookAt( 0, 0, 1 );
  36317. cameraNZ.up.set( 0, -1, 0 );
  36318. cameraNZ.lookAt( 0, 0, -1 );
  36319. } else {
  36320. throw new Error( 'THREE.CubeCamera.updateCoordinateSystem(): Invalid coordinate system: ' + coordinateSystem );
  36321. }
  36322. for ( const camera of cameras ) {
  36323. this.add( camera );
  36324. camera.updateMatrixWorld();
  36325. }
  36326. }
  36327. /**
  36328. * Calling this method will render the given scene with the given renderer
  36329. * into the cube render target of the camera.
  36330. *
  36331. * @param {(Renderer|WebGLRenderer)} renderer - The renderer.
  36332. * @param {Scene} scene - The scene to render.
  36333. */
  36334. update( renderer, scene ) {
  36335. if ( this.parent === null ) this.updateMatrixWorld();
  36336. const { renderTarget, activeMipmapLevel } = this;
  36337. if ( this.coordinateSystem !== renderer.coordinateSystem ) {
  36338. this.coordinateSystem = renderer.coordinateSystem;
  36339. this.updateCoordinateSystem();
  36340. }
  36341. const [ cameraPX, cameraNX, cameraPY, cameraNY, cameraPZ, cameraNZ ] = this.children;
  36342. const currentRenderTarget = renderer.getRenderTarget();
  36343. const currentActiveCubeFace = renderer.getActiveCubeFace();
  36344. const currentActiveMipmapLevel = renderer.getActiveMipmapLevel();
  36345. const currentXrEnabled = renderer.xr.enabled;
  36346. renderer.xr.enabled = false;
  36347. const generateMipmaps = renderTarget.texture.generateMipmaps;
  36348. renderTarget.texture.generateMipmaps = false;
  36349. // https://github.com/mrdoob/three.js/issues/31413#issuecomment-3095966812
  36350. const reversedDepthBuffer = !! ( renderer.isWebGLRenderer && renderer.state.buffers.depth.getReversed() );
  36351. renderer.setRenderTarget( renderTarget, 0, activeMipmapLevel );
  36352. if ( reversedDepthBuffer && renderer.autoClear === false ) renderer.clearDepth();
  36353. renderer.render( scene, cameraPX );
  36354. renderer.setRenderTarget( renderTarget, 1, activeMipmapLevel );
  36355. if ( reversedDepthBuffer && renderer.autoClear === false ) renderer.clearDepth();
  36356. renderer.render( scene, cameraNX );
  36357. renderer.setRenderTarget( renderTarget, 2, activeMipmapLevel );
  36358. if ( reversedDepthBuffer && renderer.autoClear === false ) renderer.clearDepth();
  36359. renderer.render( scene, cameraPY );
  36360. renderer.setRenderTarget( renderTarget, 3, activeMipmapLevel );
  36361. if ( reversedDepthBuffer && renderer.autoClear === false ) renderer.clearDepth();
  36362. renderer.render( scene, cameraNY );
  36363. renderer.setRenderTarget( renderTarget, 4, activeMipmapLevel );
  36364. if ( reversedDepthBuffer && renderer.autoClear === false ) renderer.clearDepth();
  36365. renderer.render( scene, cameraPZ );
  36366. // mipmaps are generated during the last call of render()
  36367. // at this point, all sides of the cube render target are defined
  36368. renderTarget.texture.generateMipmaps = generateMipmaps;
  36369. renderer.setRenderTarget( renderTarget, 5, activeMipmapLevel );
  36370. if ( reversedDepthBuffer && renderer.autoClear === false ) renderer.clearDepth();
  36371. renderer.render( scene, cameraNZ );
  36372. renderer.setRenderTarget( currentRenderTarget, currentActiveCubeFace, currentActiveMipmapLevel );
  36373. renderer.xr.enabled = currentXrEnabled;
  36374. renderTarget.texture.needsPMREMUpdate = true;
  36375. }
  36376. }
  36377. /**
  36378. * This type of camera can be used in order to efficiently render a scene with a
  36379. * predefined set of cameras. This is an important performance aspect for
  36380. * rendering VR scenes.
  36381. *
  36382. * An instance of `ArrayCamera` always has an array of sub cameras. It's mandatory
  36383. * to define for each sub camera the `viewport` property which determines the
  36384. * part of the viewport that is rendered with this camera.
  36385. *
  36386. * @augments PerspectiveCamera
  36387. */
  36388. class ArrayCamera extends PerspectiveCamera {
  36389. /**
  36390. * Constructs a new array camera.
  36391. *
  36392. * @param {Array<PerspectiveCamera>} [array=[]] - An array of perspective sub cameras.
  36393. */
  36394. constructor( array = [] ) {
  36395. super();
  36396. /**
  36397. * This flag can be used for type testing.
  36398. *
  36399. * @type {boolean}
  36400. * @readonly
  36401. * @default true
  36402. */
  36403. this.isArrayCamera = true;
  36404. /**
  36405. * Whether this camera is used with multiview rendering or not.
  36406. *
  36407. * @type {boolean}
  36408. * @readonly
  36409. * @default false
  36410. */
  36411. this.isMultiViewCamera = false;
  36412. /**
  36413. * An array of perspective sub cameras.
  36414. *
  36415. * @type {Array<PerspectiveCamera>}
  36416. */
  36417. this.cameras = array;
  36418. }
  36419. }
  36420. /**
  36421. * Class for keeping track of time.
  36422. *
  36423. * @deprecated since r183.
  36424. */
  36425. class Clock {
  36426. /**
  36427. * Constructs a new clock.
  36428. *
  36429. * @deprecated since 183.
  36430. * @param {boolean} [autoStart=true] - Whether to automatically start the clock when
  36431. * `getDelta()` is called for the first time.
  36432. */
  36433. constructor( autoStart = true ) {
  36434. /**
  36435. * If set to `true`, the clock starts automatically when `getDelta()` is called
  36436. * for the first time.
  36437. *
  36438. * @type {boolean}
  36439. * @default true
  36440. */
  36441. this.autoStart = autoStart;
  36442. /**
  36443. * Holds the time at which the clock's `start()` method was last called.
  36444. *
  36445. * @type {number}
  36446. * @default 0
  36447. */
  36448. this.startTime = 0;
  36449. /**
  36450. * Holds the time at which the clock's `start()`, `getElapsedTime()` or
  36451. * `getDelta()` methods were last called.
  36452. *
  36453. * @type {number}
  36454. * @default 0
  36455. */
  36456. this.oldTime = 0;
  36457. /**
  36458. * Keeps track of the total time that the clock has been running.
  36459. *
  36460. * @type {number}
  36461. * @default 0
  36462. */
  36463. this.elapsedTime = 0;
  36464. /**
  36465. * Whether the clock is running or not.
  36466. *
  36467. * @type {boolean}
  36468. * @default true
  36469. */
  36470. this.running = false;
  36471. warn( 'THREE.Clock: This module has been deprecated. Please use THREE.Timer instead.' ); // @deprecated, r183
  36472. }
  36473. /**
  36474. * Starts the clock. When `autoStart` is set to `true`, the method is automatically
  36475. * called by the class.
  36476. */
  36477. start() {
  36478. this.startTime = performance.now();
  36479. this.oldTime = this.startTime;
  36480. this.elapsedTime = 0;
  36481. this.running = true;
  36482. }
  36483. /**
  36484. * Stops the clock.
  36485. */
  36486. stop() {
  36487. this.getElapsedTime();
  36488. this.running = false;
  36489. this.autoStart = false;
  36490. }
  36491. /**
  36492. * Returns the elapsed time in seconds.
  36493. *
  36494. * @return {number} The elapsed time.
  36495. */
  36496. getElapsedTime() {
  36497. this.getDelta();
  36498. return this.elapsedTime;
  36499. }
  36500. /**
  36501. * Returns the delta time in seconds.
  36502. *
  36503. * @return {number} The delta time.
  36504. */
  36505. getDelta() {
  36506. let diff = 0;
  36507. if ( this.autoStart && ! this.running ) {
  36508. this.start();
  36509. return 0;
  36510. }
  36511. if ( this.running ) {
  36512. const newTime = performance.now();
  36513. diff = ( newTime - this.oldTime ) / 1000;
  36514. this.oldTime = newTime;
  36515. this.elapsedTime += diff;
  36516. }
  36517. return diff;
  36518. }
  36519. }
  36520. const _position$1 = /*@__PURE__*/ new Vector3();
  36521. const _quaternion$1 = /*@__PURE__*/ new Quaternion();
  36522. const _scale$1 = /*@__PURE__*/ new Vector3();
  36523. const _forward = /*@__PURE__*/ new Vector3();
  36524. const _up = /*@__PURE__*/ new Vector3();
  36525. /**
  36526. * The class represents a virtual listener of the all positional and non-positional audio effects
  36527. * in the scene. A three.js application usually creates a single listener. It is a mandatory
  36528. * constructor parameter for audios entities like {@link Audio} and {@link PositionalAudio}.
  36529. *
  36530. * In most cases, the listener object is a child of the camera. So the 3D transformation of the
  36531. * camera represents the 3D transformation of the listener.
  36532. *
  36533. * @augments Object3D
  36534. */
  36535. class AudioListener extends Object3D {
  36536. /**
  36537. * Constructs a new audio listener.
  36538. */
  36539. constructor() {
  36540. super();
  36541. this.type = 'AudioListener';
  36542. /**
  36543. * The native audio context.
  36544. *
  36545. * @type {AudioContext}
  36546. * @readonly
  36547. */
  36548. this.context = AudioContext.getContext();
  36549. /**
  36550. * The gain node used for volume control.
  36551. *
  36552. * @type {GainNode}
  36553. * @readonly
  36554. */
  36555. this.gain = this.context.createGain();
  36556. this.gain.connect( this.context.destination );
  36557. /**
  36558. * An optional filter.
  36559. *
  36560. * Defined via {@link AudioListener#setFilter}.
  36561. *
  36562. * @type {?AudioNode}
  36563. * @default null
  36564. * @readonly
  36565. */
  36566. this.filter = null;
  36567. /**
  36568. * Time delta values required for `linearRampToValueAtTime()` usage.
  36569. *
  36570. * @type {number}
  36571. * @default 0
  36572. * @readonly
  36573. */
  36574. this.timeDelta = 0;
  36575. // private
  36576. this._clock = new Clock();
  36577. }
  36578. /**
  36579. * Returns the listener's input node.
  36580. *
  36581. * This method is used by other audio nodes to connect to this listener.
  36582. *
  36583. * @return {GainNode} The input node.
  36584. */
  36585. getInput() {
  36586. return this.gain;
  36587. }
  36588. /**
  36589. * Removes the current filter from this listener.
  36590. *
  36591. * @return {AudioListener} A reference to this listener.
  36592. */
  36593. removeFilter() {
  36594. if ( this.filter !== null ) {
  36595. this.gain.disconnect( this.filter );
  36596. this.filter.disconnect( this.context.destination );
  36597. this.gain.connect( this.context.destination );
  36598. this.filter = null;
  36599. }
  36600. return this;
  36601. }
  36602. /**
  36603. * Returns the current set filter.
  36604. *
  36605. * @return {?AudioNode} The filter.
  36606. */
  36607. getFilter() {
  36608. return this.filter;
  36609. }
  36610. /**
  36611. * Sets the given filter to this listener.
  36612. *
  36613. * @param {AudioNode} value - The filter to set.
  36614. * @return {AudioListener} A reference to this listener.
  36615. */
  36616. setFilter( value ) {
  36617. if ( this.filter !== null ) {
  36618. this.gain.disconnect( this.filter );
  36619. this.filter.disconnect( this.context.destination );
  36620. } else {
  36621. this.gain.disconnect( this.context.destination );
  36622. }
  36623. this.filter = value;
  36624. this.gain.connect( this.filter );
  36625. this.filter.connect( this.context.destination );
  36626. return this;
  36627. }
  36628. /**
  36629. * Returns the applications master volume.
  36630. *
  36631. * @return {number} The master volume.
  36632. */
  36633. getMasterVolume() {
  36634. return this.gain.gain.value;
  36635. }
  36636. /**
  36637. * Sets the applications master volume. This volume setting affects
  36638. * all audio nodes in the scene.
  36639. *
  36640. * @param {number} value - The master volume to set.
  36641. * @return {AudioListener} A reference to this listener.
  36642. */
  36643. setMasterVolume( value ) {
  36644. this.gain.gain.setTargetAtTime( value, this.context.currentTime, 0.01 );
  36645. return this;
  36646. }
  36647. updateMatrixWorld( force ) {
  36648. super.updateMatrixWorld( force );
  36649. const listener = this.context.listener;
  36650. this.timeDelta = this._clock.getDelta();
  36651. this.matrixWorld.decompose( _position$1, _quaternion$1, _scale$1 );
  36652. // the initial forward and up directions must be orthogonal
  36653. _forward.set( 0, 0, -1 ).applyQuaternion( _quaternion$1 );
  36654. _up.set( 0, 1, 0 ).applyQuaternion( _quaternion$1 );
  36655. if ( listener.positionX ) {
  36656. // code path for Chrome (see #14393)
  36657. const endTime = this.context.currentTime + this.timeDelta;
  36658. listener.positionX.linearRampToValueAtTime( _position$1.x, endTime );
  36659. listener.positionY.linearRampToValueAtTime( _position$1.y, endTime );
  36660. listener.positionZ.linearRampToValueAtTime( _position$1.z, endTime );
  36661. listener.forwardX.linearRampToValueAtTime( _forward.x, endTime );
  36662. listener.forwardY.linearRampToValueAtTime( _forward.y, endTime );
  36663. listener.forwardZ.linearRampToValueAtTime( _forward.z, endTime );
  36664. listener.upX.linearRampToValueAtTime( _up.x, endTime );
  36665. listener.upY.linearRampToValueAtTime( _up.y, endTime );
  36666. listener.upZ.linearRampToValueAtTime( _up.z, endTime );
  36667. } else {
  36668. listener.setPosition( _position$1.x, _position$1.y, _position$1.z );
  36669. listener.setOrientation( _forward.x, _forward.y, _forward.z, _up.x, _up.y, _up.z );
  36670. }
  36671. }
  36672. }
  36673. /**
  36674. * Represents a non-positional ( global ) audio object.
  36675. *
  36676. * This and related audio modules make use of the [Web Audio API](https://www.w3.org/TR/webaudio-1.1/).
  36677. *
  36678. * ```js
  36679. * // create an AudioListener and add it to the camera
  36680. * const listener = new THREE.AudioListener();
  36681. * camera.add( listener );
  36682. *
  36683. * // create a global audio source
  36684. * const sound = new THREE.Audio( listener );
  36685. *
  36686. * // load a sound and set it as the Audio object's buffer
  36687. * const audioLoader = new THREE.AudioLoader();
  36688. * audioLoader.load( 'sounds/ambient.ogg', function( buffer ) {
  36689. * sound.setBuffer( buffer );
  36690. * sound.setLoop( true );
  36691. * sound.setVolume( 0.5 );
  36692. * sound.play();
  36693. * });
  36694. * ```
  36695. *
  36696. * @augments Object3D
  36697. */
  36698. class Audio extends Object3D {
  36699. /**
  36700. * Constructs a new audio.
  36701. *
  36702. * @param {AudioListener} listener - The global audio listener.
  36703. */
  36704. constructor( listener ) {
  36705. super();
  36706. this.type = 'Audio';
  36707. /**
  36708. * The global audio listener.
  36709. *
  36710. * @type {AudioListener}
  36711. * @readonly
  36712. */
  36713. this.listener = listener;
  36714. /**
  36715. * The audio context.
  36716. *
  36717. * @type {AudioContext}
  36718. * @readonly
  36719. */
  36720. this.context = listener.context;
  36721. /**
  36722. * The gain node used for volume control.
  36723. *
  36724. * @type {GainNode}
  36725. * @readonly
  36726. */
  36727. this.gain = this.context.createGain();
  36728. this.gain.connect( listener.getInput() );
  36729. /**
  36730. * Whether to start playback automatically or not.
  36731. *
  36732. * @type {boolean}
  36733. * @default false
  36734. */
  36735. this.autoplay = false;
  36736. /**
  36737. * A reference to an audio buffer.
  36738. *
  36739. * Defined via {@link Audio#setBuffer}.
  36740. *
  36741. * @type {?AudioBuffer}
  36742. * @default null
  36743. * @readonly
  36744. */
  36745. this.buffer = null;
  36746. /**
  36747. * Modify pitch, measured in cents. +/- 100 is a semitone.
  36748. * +/- 1200 is an octave.
  36749. *
  36750. * Defined via {@link Audio#setDetune}.
  36751. *
  36752. * @type {number}
  36753. * @default 0
  36754. * @readonly
  36755. */
  36756. this.detune = 0;
  36757. /**
  36758. * Whether the audio should loop or not.
  36759. *
  36760. * Defined via {@link Audio#setLoop}.
  36761. *
  36762. * @type {boolean}
  36763. * @default false
  36764. * @readonly
  36765. */
  36766. this.loop = false;
  36767. /**
  36768. * Defines where in the audio buffer the replay should
  36769. * start, in seconds.
  36770. *
  36771. * @type {number}
  36772. * @default 0
  36773. */
  36774. this.loopStart = 0;
  36775. /**
  36776. * Defines where in the audio buffer the replay should
  36777. * stop, in seconds.
  36778. *
  36779. * @type {number}
  36780. * @default 0
  36781. */
  36782. this.loopEnd = 0;
  36783. /**
  36784. * An offset to the time within the audio buffer the playback
  36785. * should begin, in seconds.
  36786. *
  36787. * @type {number}
  36788. * @default 0
  36789. */
  36790. this.offset = 0;
  36791. /**
  36792. * Overrides the default duration of the audio.
  36793. *
  36794. * @type {undefined|number}
  36795. * @default undefined
  36796. */
  36797. this.duration = undefined;
  36798. /**
  36799. * The playback speed.
  36800. *
  36801. * Defined via {@link Audio#setPlaybackRate}.
  36802. *
  36803. * @type {number}
  36804. * @readonly
  36805. * @default 1
  36806. */
  36807. this.playbackRate = 1;
  36808. /**
  36809. * Indicates whether the audio is playing or not.
  36810. *
  36811. * This flag will be automatically set when using {@link Audio#play},
  36812. * {@link Audio#pause}, {@link Audio#stop}.
  36813. *
  36814. * @type {boolean}
  36815. * @readonly
  36816. * @default false
  36817. */
  36818. this.isPlaying = false;
  36819. /**
  36820. * Indicates whether the audio playback can be controlled
  36821. * with method like {@link Audio#play} or {@link Audio#pause}.
  36822. *
  36823. * This flag will be automatically set when audio sources are
  36824. * defined.
  36825. *
  36826. * @type {boolean}
  36827. * @readonly
  36828. * @default true
  36829. */
  36830. this.hasPlaybackControl = true;
  36831. /**
  36832. * Holds a reference to the current audio source.
  36833. *
  36834. * The property is automatically by one of the `set*()` methods.
  36835. *
  36836. * @type {?AudioNode}
  36837. * @readonly
  36838. * @default null
  36839. */
  36840. this.source = null;
  36841. /**
  36842. * Defines the source type.
  36843. *
  36844. * The property is automatically set by one of the `set*()` methods.
  36845. *
  36846. * @type {('empty'|'audioNode'|'mediaNode'|'mediaStreamNode'|'buffer')}
  36847. * @readonly
  36848. * @default 'empty'
  36849. */
  36850. this.sourceType = 'empty';
  36851. this._startedAt = 0;
  36852. this._progress = 0;
  36853. this._connected = false;
  36854. /**
  36855. * Can be used to apply a variety of low-order filters to create
  36856. * more complex sound effects e.g. via `BiquadFilterNode`.
  36857. *
  36858. * The property is automatically set by {@link Audio#setFilters}.
  36859. *
  36860. * @type {Array<AudioNode>}
  36861. * @readonly
  36862. */
  36863. this.filters = [];
  36864. }
  36865. /**
  36866. * Returns the output audio node.
  36867. *
  36868. * @return {GainNode} The output node.
  36869. */
  36870. getOutput() {
  36871. return this.gain;
  36872. }
  36873. /**
  36874. * Sets the given audio node as the source of this instance.
  36875. *
  36876. * {@link Audio#sourceType} is set to `audioNode` and {@link Audio#hasPlaybackControl} to `false`.
  36877. *
  36878. * @param {AudioNode} audioNode - The audio node like an instance of `OscillatorNode`.
  36879. * @return {Audio} A reference to this instance.
  36880. */
  36881. setNodeSource( audioNode ) {
  36882. this.hasPlaybackControl = false;
  36883. this.sourceType = 'audioNode';
  36884. this.source = audioNode;
  36885. this.connect();
  36886. return this;
  36887. }
  36888. /**
  36889. * Sets the given media element as the source of this instance.
  36890. *
  36891. * {@link Audio#sourceType} is set to `mediaNode` and {@link Audio#hasPlaybackControl} to `false`.
  36892. *
  36893. * @param {HTMLMediaElement} mediaElement - The media element.
  36894. * @return {Audio} A reference to this instance.
  36895. */
  36896. setMediaElementSource( mediaElement ) {
  36897. this.hasPlaybackControl = false;
  36898. this.sourceType = 'mediaNode';
  36899. this.source = this.context.createMediaElementSource( mediaElement );
  36900. this.connect();
  36901. return this;
  36902. }
  36903. /**
  36904. * Sets the given media stream as the source of this instance.
  36905. *
  36906. * {@link Audio#sourceType} is set to `mediaStreamNode` and {@link Audio#hasPlaybackControl} to `false`.
  36907. *
  36908. * @param {MediaStream} mediaStream - The media stream.
  36909. * @return {Audio} A reference to this instance.
  36910. */
  36911. setMediaStreamSource( mediaStream ) {
  36912. this.hasPlaybackControl = false;
  36913. this.sourceType = 'mediaStreamNode';
  36914. this.source = this.context.createMediaStreamSource( mediaStream );
  36915. this.connect();
  36916. return this;
  36917. }
  36918. /**
  36919. * Sets the given audio buffer as the source of this instance.
  36920. *
  36921. * {@link Audio#sourceType} is set to `buffer` and {@link Audio#hasPlaybackControl} to `true`.
  36922. *
  36923. * @param {AudioBuffer} audioBuffer - The audio buffer.
  36924. * @return {Audio} A reference to this instance.
  36925. */
  36926. setBuffer( audioBuffer ) {
  36927. this.buffer = audioBuffer;
  36928. this.sourceType = 'buffer';
  36929. if ( this.autoplay ) this.play();
  36930. return this;
  36931. }
  36932. /**
  36933. * Starts the playback of the audio.
  36934. *
  36935. * Can only be used with compatible audio sources that allow playback control.
  36936. *
  36937. * @param {number} [delay=0] - The delay, in seconds, at which the audio should start playing.
  36938. * @return {Audio|undefined} A reference to this instance.
  36939. */
  36940. play( delay = 0 ) {
  36941. if ( this.isPlaying === true ) {
  36942. warn( 'Audio: Audio is already playing.' );
  36943. return;
  36944. }
  36945. if ( this.hasPlaybackControl === false ) {
  36946. warn( 'Audio: this Audio has no playback control.' );
  36947. return;
  36948. }
  36949. this._startedAt = this.context.currentTime + delay;
  36950. const source = this.context.createBufferSource();
  36951. source.buffer = this.buffer;
  36952. source.loop = this.loop;
  36953. source.loopStart = this.loopStart;
  36954. source.loopEnd = this.loopEnd;
  36955. source.onended = this.onEnded.bind( this );
  36956. source.start( this._startedAt, this._progress + this.offset, this.duration );
  36957. this.isPlaying = true;
  36958. this.source = source;
  36959. this.setDetune( this.detune );
  36960. this.setPlaybackRate( this.playbackRate );
  36961. return this.connect();
  36962. }
  36963. /**
  36964. * Pauses the playback of the audio.
  36965. *
  36966. * Can only be used with compatible audio sources that allow playback control.
  36967. *
  36968. * @return {Audio|undefined} A reference to this instance.
  36969. */
  36970. pause() {
  36971. if ( this.hasPlaybackControl === false ) {
  36972. warn( 'Audio: this Audio has no playback control.' );
  36973. return;
  36974. }
  36975. if ( this.isPlaying === true ) {
  36976. // update current progress
  36977. this._progress += Math.max( this.context.currentTime - this._startedAt, 0 ) * this.playbackRate;
  36978. if ( this.loop === true ) {
  36979. // ensure _progress does not exceed duration with looped audios
  36980. this._progress = this._progress % ( this.duration || this.buffer.duration );
  36981. }
  36982. this.source.stop();
  36983. this.source.onended = null;
  36984. this.isPlaying = false;
  36985. }
  36986. return this;
  36987. }
  36988. /**
  36989. * Stops the playback of the audio.
  36990. *
  36991. * Can only be used with compatible audio sources that allow playback control.
  36992. *
  36993. * @param {number} [delay=0] - The delay, in seconds, at which the audio should stop playing.
  36994. * @return {Audio|undefined} A reference to this instance.
  36995. */
  36996. stop( delay = 0 ) {
  36997. if ( this.hasPlaybackControl === false ) {
  36998. warn( 'Audio: this Audio has no playback control.' );
  36999. return;
  37000. }
  37001. this._progress = 0;
  37002. if ( this.source !== null ) {
  37003. this.source.stop( this.context.currentTime + delay );
  37004. this.source.onended = null;
  37005. }
  37006. this.isPlaying = false;
  37007. return this;
  37008. }
  37009. /**
  37010. * Connects to the audio source. This is used internally on
  37011. * initialisation and when setting / removing filters.
  37012. *
  37013. * @return {Audio} A reference to this instance.
  37014. */
  37015. connect() {
  37016. if ( this.filters.length > 0 ) {
  37017. this.source.connect( this.filters[ 0 ] );
  37018. for ( let i = 1, l = this.filters.length; i < l; i ++ ) {
  37019. this.filters[ i - 1 ].connect( this.filters[ i ] );
  37020. }
  37021. this.filters[ this.filters.length - 1 ].connect( this.getOutput() );
  37022. } else {
  37023. this.source.connect( this.getOutput() );
  37024. }
  37025. this._connected = true;
  37026. return this;
  37027. }
  37028. /**
  37029. * Disconnects to the audio source. This is used internally on
  37030. * initialisation and when setting / removing filters.
  37031. *
  37032. * @return {Audio|undefined} A reference to this instance.
  37033. */
  37034. disconnect() {
  37035. if ( this._connected === false ) {
  37036. return;
  37037. }
  37038. if ( this.filters.length > 0 ) {
  37039. this.source.disconnect( this.filters[ 0 ] );
  37040. for ( let i = 1, l = this.filters.length; i < l; i ++ ) {
  37041. this.filters[ i - 1 ].disconnect( this.filters[ i ] );
  37042. }
  37043. this.filters[ this.filters.length - 1 ].disconnect( this.getOutput() );
  37044. } else {
  37045. this.source.disconnect( this.getOutput() );
  37046. }
  37047. this._connected = false;
  37048. return this;
  37049. }
  37050. /**
  37051. * Returns the current set filters.
  37052. *
  37053. * @return {Array<AudioNode>} The list of filters.
  37054. */
  37055. getFilters() {
  37056. return this.filters;
  37057. }
  37058. /**
  37059. * Sets an array of filters and connects them with the audio source.
  37060. *
  37061. * @param {Array<AudioNode>} [value] - A list of filters.
  37062. * @return {Audio} A reference to this instance.
  37063. */
  37064. setFilters( value ) {
  37065. if ( ! value ) value = [];
  37066. if ( this._connected === true ) {
  37067. this.disconnect();
  37068. this.filters = value.slice();
  37069. this.connect();
  37070. } else {
  37071. this.filters = value.slice();
  37072. }
  37073. return this;
  37074. }
  37075. /**
  37076. * Defines the detuning of oscillation in cents.
  37077. *
  37078. * @param {number} value - The detuning of oscillation in cents.
  37079. * @return {Audio} A reference to this instance.
  37080. */
  37081. setDetune( value ) {
  37082. this.detune = value;
  37083. if ( this.isPlaying === true && this.source.detune !== undefined ) {
  37084. this.source.detune.setTargetAtTime( this.detune, this.context.currentTime, 0.01 );
  37085. }
  37086. return this;
  37087. }
  37088. /**
  37089. * Returns the detuning of oscillation in cents.
  37090. *
  37091. * @return {number} The detuning of oscillation in cents.
  37092. */
  37093. getDetune() {
  37094. return this.detune;
  37095. }
  37096. /**
  37097. * Returns the first filter in the list of filters.
  37098. *
  37099. * @return {AudioNode|undefined} The first filter in the list of filters.
  37100. */
  37101. getFilter() {
  37102. return this.getFilters()[ 0 ];
  37103. }
  37104. /**
  37105. * Applies a single filter node to the audio.
  37106. *
  37107. * @param {AudioNode} [filter] - The filter to set.
  37108. * @return {Audio} A reference to this instance.
  37109. */
  37110. setFilter( filter ) {
  37111. return this.setFilters( filter ? [ filter ] : [] );
  37112. }
  37113. /**
  37114. * Sets the playback rate.
  37115. *
  37116. * Can only be used with compatible audio sources that allow playback control.
  37117. *
  37118. * @param {number} [value] - The playback rate to set.
  37119. * @return {Audio|undefined} A reference to this instance.
  37120. */
  37121. setPlaybackRate( value ) {
  37122. if ( this.hasPlaybackControl === false ) {
  37123. warn( 'Audio: this Audio has no playback control.' );
  37124. return;
  37125. }
  37126. this.playbackRate = value;
  37127. if ( this.isPlaying === true ) {
  37128. this.source.playbackRate.setTargetAtTime( this.playbackRate, this.context.currentTime, 0.01 );
  37129. }
  37130. return this;
  37131. }
  37132. /**
  37133. * Returns the current playback rate.
  37134. * @return {number} The playback rate.
  37135. */
  37136. getPlaybackRate() {
  37137. return this.playbackRate;
  37138. }
  37139. /**
  37140. * Automatically called when playback finished.
  37141. */
  37142. onEnded() {
  37143. this.isPlaying = false;
  37144. this._progress = 0;
  37145. }
  37146. /**
  37147. * Returns the loop flag.
  37148. *
  37149. * Can only be used with compatible audio sources that allow playback control.
  37150. *
  37151. * @return {boolean} Whether the audio should loop or not.
  37152. */
  37153. getLoop() {
  37154. if ( this.hasPlaybackControl === false ) {
  37155. warn( 'Audio: this Audio has no playback control.' );
  37156. return false;
  37157. }
  37158. return this.loop;
  37159. }
  37160. /**
  37161. * Sets the loop flag.
  37162. *
  37163. * Can only be used with compatible audio sources that allow playback control.
  37164. *
  37165. * @param {boolean} value - Whether the audio should loop or not.
  37166. * @return {Audio|undefined} A reference to this instance.
  37167. */
  37168. setLoop( value ) {
  37169. if ( this.hasPlaybackControl === false ) {
  37170. warn( 'Audio: this Audio has no playback control.' );
  37171. return;
  37172. }
  37173. this.loop = value;
  37174. if ( this.isPlaying === true ) {
  37175. this.source.loop = this.loop;
  37176. }
  37177. return this;
  37178. }
  37179. /**
  37180. * Sets the loop start value which defines where in the audio buffer the replay should
  37181. * start, in seconds.
  37182. *
  37183. * @param {number} value - The loop start value.
  37184. * @return {Audio} A reference to this instance.
  37185. */
  37186. setLoopStart( value ) {
  37187. this.loopStart = value;
  37188. return this;
  37189. }
  37190. /**
  37191. * Sets the loop end value which defines where in the audio buffer the replay should
  37192. * stop, in seconds.
  37193. *
  37194. * @param {number} value - The loop end value.
  37195. * @return {Audio} A reference to this instance.
  37196. */
  37197. setLoopEnd( value ) {
  37198. this.loopEnd = value;
  37199. return this;
  37200. }
  37201. /**
  37202. * Returns the volume.
  37203. *
  37204. * @return {number} The volume.
  37205. */
  37206. getVolume() {
  37207. return this.gain.gain.value;
  37208. }
  37209. /**
  37210. * Sets the volume.
  37211. *
  37212. * @param {number} value - The volume to set.
  37213. * @return {Audio} A reference to this instance.
  37214. */
  37215. setVolume( value ) {
  37216. this.gain.gain.setTargetAtTime( value, this.context.currentTime, 0.01 );
  37217. return this;
  37218. }
  37219. copy( source, recursive ) {
  37220. super.copy( source, recursive );
  37221. if ( source.sourceType !== 'buffer' ) {
  37222. warn( 'Audio: Audio source type cannot be copied.' );
  37223. return this;
  37224. }
  37225. this.autoplay = source.autoplay;
  37226. this.buffer = source.buffer;
  37227. this.detune = source.detune;
  37228. this.loop = source.loop;
  37229. this.loopStart = source.loopStart;
  37230. this.loopEnd = source.loopEnd;
  37231. this.offset = source.offset;
  37232. this.duration = source.duration;
  37233. this.playbackRate = source.playbackRate;
  37234. this.hasPlaybackControl = source.hasPlaybackControl;
  37235. this.sourceType = source.sourceType;
  37236. this.filters = source.filters.slice();
  37237. return this;
  37238. }
  37239. clone( recursive ) {
  37240. return new this.constructor( this.listener ).copy( this, recursive );
  37241. }
  37242. }
  37243. const _position = /*@__PURE__*/ new Vector3();
  37244. const _quaternion = /*@__PURE__*/ new Quaternion();
  37245. const _scale = /*@__PURE__*/ new Vector3();
  37246. const _orientation = /*@__PURE__*/ new Vector3();
  37247. /**
  37248. * Represents a positional audio object.
  37249. *
  37250. * ```js
  37251. * // create an AudioListener and add it to the camera
  37252. * const listener = new THREE.AudioListener();
  37253. * camera.add( listener );
  37254. *
  37255. * // create the PositionalAudio object (passing in the listener)
  37256. * const sound = new THREE.PositionalAudio( listener );
  37257. *
  37258. * // load a sound and set it as the PositionalAudio object's buffer
  37259. * const audioLoader = new THREE.AudioLoader();
  37260. * audioLoader.load( 'sounds/song.ogg', function( buffer ) {
  37261. * sound.setBuffer( buffer );
  37262. * sound.setRefDistance( 20 );
  37263. * sound.play();
  37264. * });
  37265. *
  37266. * // create an object for the sound to play from
  37267. * const sphere = new THREE.SphereGeometry( 20, 32, 16 );
  37268. * const material = new THREE.MeshPhongMaterial( { color: 0xff2200 } );
  37269. * const mesh = new THREE.Mesh( sphere, material );
  37270. * scene.add( mesh );
  37271. *
  37272. * // finally add the sound to the mesh
  37273. * mesh.add( sound );
  37274. *
  37275. * @augments Audio
  37276. */
  37277. class PositionalAudio extends Audio {
  37278. /**
  37279. * Constructs a positional audio.
  37280. *
  37281. * @param {AudioListener} listener - The global audio listener.
  37282. */
  37283. constructor( listener ) {
  37284. super( listener );
  37285. /**
  37286. * The panner node represents the location, direction, and behavior of an audio
  37287. * source in 3D space.
  37288. *
  37289. * @type {PannerNode}
  37290. * @readonly
  37291. */
  37292. this.panner = this.context.createPanner();
  37293. this.panner.panningModel = 'HRTF';
  37294. this.panner.connect( this.gain );
  37295. }
  37296. connect() {
  37297. super.connect();
  37298. this.panner.connect( this.gain );
  37299. return this;
  37300. }
  37301. disconnect() {
  37302. super.disconnect();
  37303. this.panner.disconnect( this.gain );
  37304. return this;
  37305. }
  37306. getOutput() {
  37307. return this.panner;
  37308. }
  37309. /**
  37310. * Returns the current reference distance.
  37311. *
  37312. * @return {number} The reference distance.
  37313. */
  37314. getRefDistance() {
  37315. return this.panner.refDistance;
  37316. }
  37317. /**
  37318. * Defines the reference distance for reducing volume as the audio source moves
  37319. * further from the listener – i.e. the distance at which the volume reduction
  37320. * starts taking effect.
  37321. *
  37322. * @param {number} value - The reference distance to set.
  37323. * @return {PositionalAudio} A reference to this instance.
  37324. */
  37325. setRefDistance( value ) {
  37326. this.panner.refDistance = value;
  37327. return this;
  37328. }
  37329. /**
  37330. * Returns the current rolloff factor.
  37331. *
  37332. * @return {number} The rolloff factor.
  37333. */
  37334. getRolloffFactor() {
  37335. return this.panner.rolloffFactor;
  37336. }
  37337. /**
  37338. * Defines how quickly the volume is reduced as the source moves away from the listener.
  37339. *
  37340. * @param {number} value - The rolloff factor.
  37341. * @return {PositionalAudio} A reference to this instance.
  37342. */
  37343. setRolloffFactor( value ) {
  37344. this.panner.rolloffFactor = value;
  37345. return this;
  37346. }
  37347. /**
  37348. * Returns the current distance model.
  37349. *
  37350. * @return {('linear'|'inverse'|'exponential')} The distance model.
  37351. */
  37352. getDistanceModel() {
  37353. return this.panner.distanceModel;
  37354. }
  37355. /**
  37356. * Defines which algorithm to use to reduce the volume of the audio source
  37357. * as it moves away from the listener.
  37358. *
  37359. * Read [the spec](https://www.w3.org/TR/webaudio-1.1/#enumdef-distancemodeltype)
  37360. * for more details.
  37361. *
  37362. * @param {('linear'|'inverse'|'exponential')} value - The distance model to set.
  37363. * @return {PositionalAudio} A reference to this instance.
  37364. */
  37365. setDistanceModel( value ) {
  37366. this.panner.distanceModel = value;
  37367. return this;
  37368. }
  37369. /**
  37370. * Returns the current max distance.
  37371. *
  37372. * @return {number} The max distance.
  37373. */
  37374. getMaxDistance() {
  37375. return this.panner.maxDistance;
  37376. }
  37377. /**
  37378. * Defines the maximum distance between the audio source and the listener,
  37379. * after which the volume is not reduced any further.
  37380. *
  37381. * This value is used only by the `linear` distance model.
  37382. *
  37383. * @param {number} value - The max distance.
  37384. * @return {PositionalAudio} A reference to this instance.
  37385. */
  37386. setMaxDistance( value ) {
  37387. this.panner.maxDistance = value;
  37388. return this;
  37389. }
  37390. /**
  37391. * Sets the directional cone in which the audio can be listened.
  37392. *
  37393. * @param {number} coneInnerAngle - An angle, in degrees, of a cone inside of which there will be no volume reduction.
  37394. * @param {number} coneOuterAngle - An angle, in degrees, of a cone outside of which the volume will be reduced by a constant value, defined by the `coneOuterGain` parameter.
  37395. * @param {number} coneOuterGain - The amount of volume reduction outside the cone defined by the `coneOuterAngle`. When set to `0`, no sound can be heard.
  37396. * @return {PositionalAudio} A reference to this instance.
  37397. */
  37398. setDirectionalCone( coneInnerAngle, coneOuterAngle, coneOuterGain ) {
  37399. this.panner.coneInnerAngle = coneInnerAngle;
  37400. this.panner.coneOuterAngle = coneOuterAngle;
  37401. this.panner.coneOuterGain = coneOuterGain;
  37402. return this;
  37403. }
  37404. updateMatrixWorld( force ) {
  37405. super.updateMatrixWorld( force );
  37406. if ( this.hasPlaybackControl === true && this.isPlaying === false ) return;
  37407. this.matrixWorld.decompose( _position, _quaternion, _scale );
  37408. _orientation.set( 0, 0, 1 ).applyQuaternion( _quaternion );
  37409. const panner = this.panner;
  37410. if ( panner.positionX ) {
  37411. // code path for Chrome and Firefox (see #14393)
  37412. const endTime = this.context.currentTime + this.listener.timeDelta;
  37413. panner.positionX.linearRampToValueAtTime( _position.x, endTime );
  37414. panner.positionY.linearRampToValueAtTime( _position.y, endTime );
  37415. panner.positionZ.linearRampToValueAtTime( _position.z, endTime );
  37416. panner.orientationX.linearRampToValueAtTime( _orientation.x, endTime );
  37417. panner.orientationY.linearRampToValueAtTime( _orientation.y, endTime );
  37418. panner.orientationZ.linearRampToValueAtTime( _orientation.z, endTime );
  37419. } else {
  37420. panner.setPosition( _position.x, _position.y, _position.z );
  37421. panner.setOrientation( _orientation.x, _orientation.y, _orientation.z );
  37422. }
  37423. }
  37424. }
  37425. /**
  37426. * This class can be used to analyse audio data.
  37427. *
  37428. * ```js
  37429. * // create an AudioListener and add it to the camera
  37430. * const listener = new THREE.AudioListener();
  37431. * camera.add( listener );
  37432. *
  37433. * // create an Audio source
  37434. * const sound = new THREE.Audio( listener );
  37435. *
  37436. * // load a sound and set it as the Audio object's buffer
  37437. * const audioLoader = new THREE.AudioLoader();
  37438. * audioLoader.load( 'sounds/ambient.ogg', function( buffer ) {
  37439. * sound.setBuffer( buffer );
  37440. * sound.setLoop(true);
  37441. * sound.setVolume(0.5);
  37442. * sound.play();
  37443. * });
  37444. *
  37445. * // create an AudioAnalyser, passing in the sound and desired fftSize
  37446. * const analyser = new THREE.AudioAnalyser( sound, 32 );
  37447. *
  37448. * // get the average frequency of the sound
  37449. * const data = analyser.getAverageFrequency();
  37450. * ```
  37451. */
  37452. class AudioAnalyser {
  37453. /**
  37454. * Constructs a new audio analyzer.
  37455. *
  37456. * @param {Audio} audio - The audio to analyze.
  37457. * @param {number} [fftSize=2048] - The window size in samples that is used when performing a Fast Fourier Transform (FFT) to get frequency domain data.
  37458. */
  37459. constructor( audio, fftSize = 2048 ) {
  37460. /**
  37461. * The global audio listener.
  37462. *
  37463. * @type {AnalyserNode}
  37464. */
  37465. this.analyser = audio.context.createAnalyser();
  37466. this.analyser.fftSize = fftSize;
  37467. /**
  37468. * Holds the analyzed data.
  37469. *
  37470. * @type {Uint8Array}
  37471. */
  37472. this.data = new Uint8Array( this.analyser.frequencyBinCount );
  37473. audio.getOutput().connect( this.analyser );
  37474. }
  37475. /**
  37476. * Returns an array with frequency data of the audio.
  37477. *
  37478. * Each item in the array represents the decibel value for a specific frequency.
  37479. * The frequencies are spread linearly from 0 to 1/2 of the sample rate.
  37480. * For example, for 48000 sample rate, the last item of the array will represent
  37481. * the decibel value for 24000 Hz.
  37482. *
  37483. * @return {Uint8Array} The frequency data.
  37484. */
  37485. getFrequencyData() {
  37486. this.analyser.getByteFrequencyData( this.data );
  37487. return this.data;
  37488. }
  37489. /**
  37490. * Returns the average of the frequencies returned by {@link AudioAnalyser#getFrequencyData}.
  37491. *
  37492. * @return {number} The average frequency.
  37493. */
  37494. getAverageFrequency() {
  37495. let value = 0;
  37496. const data = this.getFrequencyData();
  37497. for ( let i = 0; i < data.length; i ++ ) {
  37498. value += data[ i ];
  37499. }
  37500. return value / data.length;
  37501. }
  37502. }
  37503. /**
  37504. * Buffered scene graph property that allows weighted accumulation; used internally.
  37505. */
  37506. class PropertyMixer {
  37507. /**
  37508. * Constructs a new property mixer.
  37509. *
  37510. * @param {PropertyBinding} binding - The property binding.
  37511. * @param {string} typeName - The keyframe track type name.
  37512. * @param {number} valueSize - The keyframe track value size.
  37513. */
  37514. constructor( binding, typeName, valueSize ) {
  37515. /**
  37516. * The property binding.
  37517. *
  37518. * @type {PropertyBinding}
  37519. */
  37520. this.binding = binding;
  37521. /**
  37522. * The keyframe track value size.
  37523. *
  37524. * @type {number}
  37525. */
  37526. this.valueSize = valueSize;
  37527. let mixFunction,
  37528. mixFunctionAdditive,
  37529. setIdentity;
  37530. // buffer layout: [ incoming | accu0 | accu1 | orig | addAccu | (optional work) ]
  37531. //
  37532. // interpolators can use .buffer as their .result
  37533. // the data then goes to 'incoming'
  37534. //
  37535. // 'accu0' and 'accu1' are used frame-interleaved for
  37536. // the cumulative result and are compared to detect
  37537. // changes
  37538. //
  37539. // 'orig' stores the original state of the property
  37540. //
  37541. // 'add' is used for additive cumulative results
  37542. //
  37543. // 'work' is optional and is only present for quaternion types. It is used
  37544. // to store intermediate quaternion multiplication results
  37545. switch ( typeName ) {
  37546. case 'quaternion':
  37547. mixFunction = this._slerp;
  37548. mixFunctionAdditive = this._slerpAdditive;
  37549. setIdentity = this._setAdditiveIdentityQuaternion;
  37550. this.buffer = new Float64Array( valueSize * 6 );
  37551. this._workIndex = 5;
  37552. break;
  37553. case 'string':
  37554. case 'bool':
  37555. mixFunction = this._select;
  37556. // Use the regular mix function and for additive on these types,
  37557. // additive is not relevant for non-numeric types
  37558. mixFunctionAdditive = this._select;
  37559. setIdentity = this._setAdditiveIdentityOther;
  37560. this.buffer = new Array( valueSize * 5 );
  37561. break;
  37562. default:
  37563. mixFunction = this._lerp;
  37564. mixFunctionAdditive = this._lerpAdditive;
  37565. setIdentity = this._setAdditiveIdentityNumeric;
  37566. this.buffer = new Float64Array( valueSize * 5 );
  37567. }
  37568. this._mixBufferRegion = mixFunction;
  37569. this._mixBufferRegionAdditive = mixFunctionAdditive;
  37570. this._setIdentity = setIdentity;
  37571. this._origIndex = 3;
  37572. this._addIndex = 4;
  37573. /**
  37574. * Accumulated weight of the property binding.
  37575. *
  37576. * @type {number}
  37577. * @default 0
  37578. */
  37579. this.cumulativeWeight = 0;
  37580. /**
  37581. * Accumulated additive weight of the property binding.
  37582. *
  37583. * @type {number}
  37584. * @default 0
  37585. */
  37586. this.cumulativeWeightAdditive = 0;
  37587. /**
  37588. * Number of active keyframe tracks currently using this property binding.
  37589. *
  37590. * @type {number}
  37591. * @default 0
  37592. */
  37593. this.useCount = 0;
  37594. /**
  37595. * Number of keyframe tracks referencing this property binding.
  37596. *
  37597. * @type {number}
  37598. * @default 0
  37599. */
  37600. this.referenceCount = 0;
  37601. }
  37602. /**
  37603. * Accumulates data in the `incoming` region into `accu<i>`.
  37604. *
  37605. * @param {number} accuIndex - The accumulation index.
  37606. * @param {number} weight - The weight.
  37607. */
  37608. accumulate( accuIndex, weight ) {
  37609. // note: happily accumulating nothing when weight = 0, the caller knows
  37610. // the weight and shouldn't have made the call in the first place
  37611. const buffer = this.buffer,
  37612. stride = this.valueSize,
  37613. offset = accuIndex * stride + stride;
  37614. let currentWeight = this.cumulativeWeight;
  37615. if ( currentWeight === 0 ) {
  37616. // accuN := incoming * weight
  37617. for ( let i = 0; i !== stride; ++ i ) {
  37618. buffer[ offset + i ] = buffer[ i ];
  37619. }
  37620. currentWeight = weight;
  37621. } else {
  37622. // accuN := accuN + incoming * weight
  37623. currentWeight += weight;
  37624. const mix = weight / currentWeight;
  37625. this._mixBufferRegion( buffer, offset, 0, mix, stride );
  37626. }
  37627. this.cumulativeWeight = currentWeight;
  37628. }
  37629. /**
  37630. * Accumulates data in the `incoming` region into `add`.
  37631. *
  37632. * @param {number} weight - The weight.
  37633. */
  37634. accumulateAdditive( weight ) {
  37635. const buffer = this.buffer,
  37636. stride = this.valueSize,
  37637. offset = stride * this._addIndex;
  37638. if ( this.cumulativeWeightAdditive === 0 ) {
  37639. // add = identity
  37640. this._setIdentity();
  37641. }
  37642. // add := add + incoming * weight
  37643. this._mixBufferRegionAdditive( buffer, offset, 0, weight, stride );
  37644. this.cumulativeWeightAdditive += weight;
  37645. }
  37646. /**
  37647. * Applies the state of `accu<i>` to the binding when accus differ.
  37648. *
  37649. * @param {number} accuIndex - The accumulation index.
  37650. */
  37651. apply( accuIndex ) {
  37652. const stride = this.valueSize,
  37653. buffer = this.buffer,
  37654. offset = accuIndex * stride + stride,
  37655. weight = this.cumulativeWeight,
  37656. weightAdditive = this.cumulativeWeightAdditive,
  37657. binding = this.binding;
  37658. this.cumulativeWeight = 0;
  37659. this.cumulativeWeightAdditive = 0;
  37660. if ( weight < 1 ) {
  37661. // accuN := accuN + original * ( 1 - cumulativeWeight )
  37662. const originalValueOffset = stride * this._origIndex;
  37663. this._mixBufferRegion(
  37664. buffer, offset, originalValueOffset, 1 - weight, stride );
  37665. }
  37666. if ( weightAdditive > 0 ) {
  37667. // accuN := accuN + additive accuN
  37668. this._mixBufferRegionAdditive( buffer, offset, this._addIndex * stride, 1, stride );
  37669. }
  37670. for ( let i = stride, e = stride + stride; i !== e; ++ i ) {
  37671. if ( buffer[ i ] !== buffer[ i + stride ] ) {
  37672. // value has changed -> update scene graph
  37673. binding.setValue( buffer, offset );
  37674. break;
  37675. }
  37676. }
  37677. }
  37678. /**
  37679. * Remembers the state of the bound property and copy it to both accus.
  37680. */
  37681. saveOriginalState() {
  37682. const binding = this.binding;
  37683. const buffer = this.buffer,
  37684. stride = this.valueSize,
  37685. originalValueOffset = stride * this._origIndex;
  37686. binding.getValue( buffer, originalValueOffset );
  37687. // accu[0..1] := orig -- initially detect changes against the original
  37688. for ( let i = stride, e = originalValueOffset; i !== e; ++ i ) {
  37689. buffer[ i ] = buffer[ originalValueOffset + ( i % stride ) ];
  37690. }
  37691. // Add to identity for additive
  37692. this._setIdentity();
  37693. this.cumulativeWeight = 0;
  37694. this.cumulativeWeightAdditive = 0;
  37695. }
  37696. /**
  37697. * Applies the state previously taken via {@link PropertyMixer#saveOriginalState} to the binding.
  37698. */
  37699. restoreOriginalState() {
  37700. const originalValueOffset = this.valueSize * 3;
  37701. this.binding.setValue( this.buffer, originalValueOffset );
  37702. }
  37703. // internals
  37704. _setAdditiveIdentityNumeric() {
  37705. const startIndex = this._addIndex * this.valueSize;
  37706. const endIndex = startIndex + this.valueSize;
  37707. for ( let i = startIndex; i < endIndex; i ++ ) {
  37708. this.buffer[ i ] = 0;
  37709. }
  37710. }
  37711. _setAdditiveIdentityQuaternion() {
  37712. this._setAdditiveIdentityNumeric();
  37713. this.buffer[ this._addIndex * this.valueSize + 3 ] = 1;
  37714. }
  37715. _setAdditiveIdentityOther() {
  37716. const startIndex = this._origIndex * this.valueSize;
  37717. const targetIndex = this._addIndex * this.valueSize;
  37718. for ( let i = 0; i < this.valueSize; i ++ ) {
  37719. this.buffer[ targetIndex + i ] = this.buffer[ startIndex + i ];
  37720. }
  37721. }
  37722. // mix functions
  37723. _select( buffer, dstOffset, srcOffset, t, stride ) {
  37724. if ( t >= 0.5 ) {
  37725. for ( let i = 0; i !== stride; ++ i ) {
  37726. buffer[ dstOffset + i ] = buffer[ srcOffset + i ];
  37727. }
  37728. }
  37729. }
  37730. _slerp( buffer, dstOffset, srcOffset, t ) {
  37731. Quaternion.slerpFlat( buffer, dstOffset, buffer, dstOffset, buffer, srcOffset, t );
  37732. }
  37733. _slerpAdditive( buffer, dstOffset, srcOffset, t, stride ) {
  37734. const workOffset = this._workIndex * stride;
  37735. // Store result in intermediate buffer offset
  37736. Quaternion.multiplyQuaternionsFlat( buffer, workOffset, buffer, dstOffset, buffer, srcOffset );
  37737. // Slerp to the intermediate result
  37738. Quaternion.slerpFlat( buffer, dstOffset, buffer, dstOffset, buffer, workOffset, t );
  37739. }
  37740. _lerp( buffer, dstOffset, srcOffset, t, stride ) {
  37741. const s = 1 - t;
  37742. for ( let i = 0; i !== stride; ++ i ) {
  37743. const j = dstOffset + i;
  37744. buffer[ j ] = buffer[ j ] * s + buffer[ srcOffset + i ] * t;
  37745. }
  37746. }
  37747. _lerpAdditive( buffer, dstOffset, srcOffset, t, stride ) {
  37748. for ( let i = 0; i !== stride; ++ i ) {
  37749. const j = dstOffset + i;
  37750. buffer[ j ] = buffer[ j ] + buffer[ srcOffset + i ] * t;
  37751. }
  37752. }
  37753. }
  37754. // Characters [].:/ are reserved for track binding syntax.
  37755. const _RESERVED_CHARS_RE = '\\[\\]\\.:\\/';
  37756. const _reservedRe = new RegExp( '[' + _RESERVED_CHARS_RE + ']', 'g' );
  37757. // Attempts to allow node names from any language. ES5's `\w` regexp matches
  37758. // only latin characters, and the unicode \p{L} is not yet supported. So
  37759. // instead, we exclude reserved characters and match everything else.
  37760. const _wordChar = '[^' + _RESERVED_CHARS_RE + ']';
  37761. const _wordCharOrDot = '[^' + _RESERVED_CHARS_RE.replace( '\\.', '' ) + ']';
  37762. // Parent directories, delimited by '/' or ':'. Currently unused, but must
  37763. // be matched to parse the rest of the track name.
  37764. const _directoryRe = /*@__PURE__*/ /((?:WC+[\/:])*)/.source.replace( 'WC', _wordChar );
  37765. // Target node. May contain word characters (a-zA-Z0-9_) and '.' or '-'.
  37766. const _nodeRe = /*@__PURE__*/ /(WCOD+)?/.source.replace( 'WCOD', _wordCharOrDot );
  37767. // Object on target node, and accessor. May not contain reserved
  37768. // characters. Accessor may contain any character except closing bracket.
  37769. const _objectRe = /*@__PURE__*/ /(?:\.(WC+)(?:\[(.+)\])?)?/.source.replace( 'WC', _wordChar );
  37770. // Property and accessor. May not contain reserved characters. Accessor may
  37771. // contain any non-bracket characters.
  37772. const _propertyRe = /*@__PURE__*/ /\.(WC+)(?:\[(.+)\])?/.source.replace( 'WC', _wordChar );
  37773. const _trackRe = new RegExp( ''
  37774. + '^'
  37775. + _directoryRe
  37776. + _nodeRe
  37777. + _objectRe
  37778. + _propertyRe
  37779. + '$'
  37780. );
  37781. const _supportedObjectNames = [ 'material', 'materials', 'bones', 'map' ];
  37782. class Composite {
  37783. constructor( targetGroup, path, optionalParsedPath ) {
  37784. const parsedPath = optionalParsedPath || PropertyBinding.parseTrackName( path );
  37785. this._targetGroup = targetGroup;
  37786. this._bindings = targetGroup.subscribe_( path, parsedPath );
  37787. }
  37788. getValue( array, offset ) {
  37789. this.bind(); // bind all binding
  37790. const firstValidIndex = this._targetGroup.nCachedObjects_,
  37791. binding = this._bindings[ firstValidIndex ];
  37792. // and only call .getValue on the first
  37793. if ( binding !== undefined ) binding.getValue( array, offset );
  37794. }
  37795. setValue( array, offset ) {
  37796. const bindings = this._bindings;
  37797. for ( let i = this._targetGroup.nCachedObjects_, n = bindings.length; i !== n; ++ i ) {
  37798. bindings[ i ].setValue( array, offset );
  37799. }
  37800. }
  37801. bind() {
  37802. const bindings = this._bindings;
  37803. for ( let i = this._targetGroup.nCachedObjects_, n = bindings.length; i !== n; ++ i ) {
  37804. bindings[ i ].bind();
  37805. }
  37806. }
  37807. unbind() {
  37808. const bindings = this._bindings;
  37809. for ( let i = this._targetGroup.nCachedObjects_, n = bindings.length; i !== n; ++ i ) {
  37810. bindings[ i ].unbind();
  37811. }
  37812. }
  37813. }
  37814. // Note: This class uses a State pattern on a per-method basis:
  37815. // 'bind' sets 'this.getValue' / 'setValue' and shadows the
  37816. // prototype version of these methods with one that represents
  37817. // the bound state. When the property is not found, the methods
  37818. // become no-ops.
  37819. /**
  37820. * This holds a reference to a real property in the scene graph; used internally.
  37821. */
  37822. class PropertyBinding {
  37823. /**
  37824. * Constructs a new property binding.
  37825. *
  37826. * @param {Object} rootNode - The root node.
  37827. * @param {string} path - The path.
  37828. * @param {?Object} [parsedPath] - The parsed path.
  37829. */
  37830. constructor( rootNode, path, parsedPath ) {
  37831. /**
  37832. * The object path to the animated property.
  37833. *
  37834. * @type {string}
  37835. */
  37836. this.path = path;
  37837. /**
  37838. * An object holding information about the path.
  37839. *
  37840. * @type {Object}
  37841. */
  37842. this.parsedPath = parsedPath || PropertyBinding.parseTrackName( path );
  37843. /**
  37844. * The object owns the animated property.
  37845. *
  37846. * @type {?Object}
  37847. */
  37848. this.node = PropertyBinding.findNode( rootNode, this.parsedPath.nodeName );
  37849. /**
  37850. * The root node.
  37851. *
  37852. * @type {Object3D|Skeleton}
  37853. */
  37854. this.rootNode = rootNode;
  37855. // initial state of these methods that calls 'bind'
  37856. this.getValue = this._getValue_unbound;
  37857. this.setValue = this._setValue_unbound;
  37858. }
  37859. /**
  37860. * Factory method for creating a property binding from the given parameters.
  37861. *
  37862. * @static
  37863. * @param {Object} root - The root node.
  37864. * @param {string} path - The path.
  37865. * @param {?Object} [parsedPath] - The parsed path.
  37866. * @return {PropertyBinding|Composite} The created property binding or composite.
  37867. */
  37868. static create( root, path, parsedPath ) {
  37869. if ( ! ( root && root.isAnimationObjectGroup ) ) {
  37870. return new PropertyBinding( root, path, parsedPath );
  37871. } else {
  37872. return new PropertyBinding.Composite( root, path, parsedPath );
  37873. }
  37874. }
  37875. /**
  37876. * Replaces spaces with underscores and removes unsupported characters from
  37877. * node names, to ensure compatibility with parseTrackName().
  37878. *
  37879. * @param {string} name - Node name to be sanitized.
  37880. * @return {string} The sanitized node name.
  37881. */
  37882. static sanitizeNodeName( name ) {
  37883. return name.replace( /\s/g, '_' ).replace( _reservedRe, '' );
  37884. }
  37885. /**
  37886. * Parses the given track name (an object path to an animated property) and
  37887. * returns an object with information about the path. Matches strings in the following forms:
  37888. *
  37889. * - nodeName.property
  37890. * - nodeName.property[accessor]
  37891. * - nodeName.material.property[accessor]
  37892. * - uuid.property[accessor]
  37893. * - uuid.objectName[objectIndex].propertyName[propertyIndex]
  37894. * - parentName/nodeName.property
  37895. * - parentName/parentName/nodeName.property[index]
  37896. * - .bone[Armature.DEF_cog].position
  37897. * - scene:helium_balloon_model:helium_balloon_model.position
  37898. *
  37899. * @static
  37900. * @param {string} trackName - The track name to parse.
  37901. * @return {Object} The parsed track name as an object.
  37902. */
  37903. static parseTrackName( trackName ) {
  37904. const matches = _trackRe.exec( trackName );
  37905. if ( matches === null ) {
  37906. throw new Error( 'PropertyBinding: Cannot parse trackName: ' + trackName );
  37907. }
  37908. const results = {
  37909. // directoryName: matches[ 1 ], // (tschw) currently unused
  37910. nodeName: matches[ 2 ],
  37911. objectName: matches[ 3 ],
  37912. objectIndex: matches[ 4 ],
  37913. propertyName: matches[ 5 ], // required
  37914. propertyIndex: matches[ 6 ]
  37915. };
  37916. const lastDot = results.nodeName && results.nodeName.lastIndexOf( '.' );
  37917. if ( lastDot !== undefined && lastDot !== -1 ) {
  37918. const objectName = results.nodeName.substring( lastDot + 1 );
  37919. // Object names must be checked against an allowlist. Otherwise, there
  37920. // is no way to parse 'foo.bar.baz': 'baz' must be a property, but
  37921. // 'bar' could be the objectName, or part of a nodeName (which can
  37922. // include '.' characters).
  37923. if ( _supportedObjectNames.indexOf( objectName ) !== -1 ) {
  37924. results.nodeName = results.nodeName.substring( 0, lastDot );
  37925. results.objectName = objectName;
  37926. }
  37927. }
  37928. if ( results.propertyName === null || results.propertyName.length === 0 ) {
  37929. throw new Error( 'PropertyBinding: can not parse propertyName from trackName: ' + trackName );
  37930. }
  37931. return results;
  37932. }
  37933. /**
  37934. * Searches for a node in the hierarchy of the given root object by the given
  37935. * node name.
  37936. *
  37937. * @static
  37938. * @param {Object} root - The root object.
  37939. * @param {string|number} nodeName - The name of the node.
  37940. * @return {?Object} The found node. Returns `null` if no object was found.
  37941. */
  37942. static findNode( root, nodeName ) {
  37943. if ( nodeName === undefined || nodeName === '' || nodeName === '.' || nodeName === -1 || nodeName === root.name || nodeName === root.uuid ) {
  37944. return root;
  37945. }
  37946. // search into skeleton bones.
  37947. if ( root.skeleton ) {
  37948. const bone = root.skeleton.getBoneByName( nodeName );
  37949. if ( bone !== undefined ) {
  37950. return bone;
  37951. }
  37952. }
  37953. // search into node subtree.
  37954. if ( root.children ) {
  37955. const searchNodeSubtree = function ( children ) {
  37956. for ( let i = 0; i < children.length; i ++ ) {
  37957. const childNode = children[ i ];
  37958. if ( childNode.name === nodeName || childNode.uuid === nodeName ) {
  37959. return childNode;
  37960. }
  37961. const result = searchNodeSubtree( childNode.children );
  37962. if ( result ) return result;
  37963. }
  37964. return null;
  37965. };
  37966. const subTreeNode = searchNodeSubtree( root.children );
  37967. if ( subTreeNode ) {
  37968. return subTreeNode;
  37969. }
  37970. }
  37971. return null;
  37972. }
  37973. // these are used to "bind" a nonexistent property
  37974. _getValue_unavailable() {}
  37975. _setValue_unavailable() {}
  37976. // Getters
  37977. _getValue_direct( buffer, offset ) {
  37978. buffer[ offset ] = this.targetObject[ this.propertyName ];
  37979. }
  37980. _getValue_array( buffer, offset ) {
  37981. const source = this.resolvedProperty;
  37982. for ( let i = 0, n = source.length; i !== n; ++ i ) {
  37983. buffer[ offset ++ ] = source[ i ];
  37984. }
  37985. }
  37986. _getValue_arrayElement( buffer, offset ) {
  37987. buffer[ offset ] = this.resolvedProperty[ this.propertyIndex ];
  37988. }
  37989. _getValue_toArray( buffer, offset ) {
  37990. this.resolvedProperty.toArray( buffer, offset );
  37991. }
  37992. // Direct
  37993. _setValue_direct( buffer, offset ) {
  37994. this.targetObject[ this.propertyName ] = buffer[ offset ];
  37995. }
  37996. _setValue_direct_setNeedsUpdate( buffer, offset ) {
  37997. this.targetObject[ this.propertyName ] = buffer[ offset ];
  37998. this.targetObject.needsUpdate = true;
  37999. }
  38000. _setValue_direct_setMatrixWorldNeedsUpdate( buffer, offset ) {
  38001. this.targetObject[ this.propertyName ] = buffer[ offset ];
  38002. this.targetObject.matrixWorldNeedsUpdate = true;
  38003. }
  38004. // EntireArray
  38005. _setValue_array( buffer, offset ) {
  38006. const dest = this.resolvedProperty;
  38007. for ( let i = 0, n = dest.length; i !== n; ++ i ) {
  38008. dest[ i ] = buffer[ offset ++ ];
  38009. }
  38010. }
  38011. _setValue_array_setNeedsUpdate( buffer, offset ) {
  38012. const dest = this.resolvedProperty;
  38013. for ( let i = 0, n = dest.length; i !== n; ++ i ) {
  38014. dest[ i ] = buffer[ offset ++ ];
  38015. }
  38016. this.targetObject.needsUpdate = true;
  38017. }
  38018. _setValue_array_setMatrixWorldNeedsUpdate( buffer, offset ) {
  38019. const dest = this.resolvedProperty;
  38020. for ( let i = 0, n = dest.length; i !== n; ++ i ) {
  38021. dest[ i ] = buffer[ offset ++ ];
  38022. }
  38023. this.targetObject.matrixWorldNeedsUpdate = true;
  38024. }
  38025. // ArrayElement
  38026. _setValue_arrayElement( buffer, offset ) {
  38027. this.resolvedProperty[ this.propertyIndex ] = buffer[ offset ];
  38028. }
  38029. _setValue_arrayElement_setNeedsUpdate( buffer, offset ) {
  38030. this.resolvedProperty[ this.propertyIndex ] = buffer[ offset ];
  38031. this.targetObject.needsUpdate = true;
  38032. }
  38033. _setValue_arrayElement_setMatrixWorldNeedsUpdate( buffer, offset ) {
  38034. this.resolvedProperty[ this.propertyIndex ] = buffer[ offset ];
  38035. this.targetObject.matrixWorldNeedsUpdate = true;
  38036. }
  38037. // HasToFromArray
  38038. _setValue_fromArray( buffer, offset ) {
  38039. this.resolvedProperty.fromArray( buffer, offset );
  38040. }
  38041. _setValue_fromArray_setNeedsUpdate( buffer, offset ) {
  38042. this.resolvedProperty.fromArray( buffer, offset );
  38043. this.targetObject.needsUpdate = true;
  38044. }
  38045. _setValue_fromArray_setMatrixWorldNeedsUpdate( buffer, offset ) {
  38046. this.resolvedProperty.fromArray( buffer, offset );
  38047. this.targetObject.matrixWorldNeedsUpdate = true;
  38048. }
  38049. _getValue_unbound( targetArray, offset ) {
  38050. this.bind();
  38051. this.getValue( targetArray, offset );
  38052. }
  38053. _setValue_unbound( sourceArray, offset ) {
  38054. this.bind();
  38055. this.setValue( sourceArray, offset );
  38056. }
  38057. /**
  38058. * Creates a getter / setter pair for the property tracked by this binding.
  38059. */
  38060. bind() {
  38061. let targetObject = this.node;
  38062. const parsedPath = this.parsedPath;
  38063. const objectName = parsedPath.objectName;
  38064. const propertyName = parsedPath.propertyName;
  38065. let propertyIndex = parsedPath.propertyIndex;
  38066. if ( ! targetObject ) {
  38067. targetObject = PropertyBinding.findNode( this.rootNode, parsedPath.nodeName );
  38068. this.node = targetObject;
  38069. }
  38070. // set fail state so we can just 'return' on error
  38071. this.getValue = this._getValue_unavailable;
  38072. this.setValue = this._setValue_unavailable;
  38073. // ensure there is a value node
  38074. if ( ! targetObject ) {
  38075. warn( 'PropertyBinding: No target node found for track: ' + this.path + '.' );
  38076. return;
  38077. }
  38078. if ( objectName ) {
  38079. let objectIndex = parsedPath.objectIndex;
  38080. // special cases were we need to reach deeper into the hierarchy to get the face materials....
  38081. switch ( objectName ) {
  38082. case 'materials':
  38083. if ( ! targetObject.material ) {
  38084. error( 'PropertyBinding: Can not bind to material as node does not have a material.', this );
  38085. return;
  38086. }
  38087. if ( ! targetObject.material.materials ) {
  38088. error( 'PropertyBinding: Can not bind to material.materials as node.material does not have a materials array.', this );
  38089. return;
  38090. }
  38091. targetObject = targetObject.material.materials;
  38092. break;
  38093. case 'bones':
  38094. if ( ! targetObject.skeleton ) {
  38095. error( 'PropertyBinding: Can not bind to bones as node does not have a skeleton.', this );
  38096. return;
  38097. }
  38098. // potential future optimization: skip this if propertyIndex is already an integer
  38099. // and convert the integer string to a true integer.
  38100. targetObject = targetObject.skeleton.bones;
  38101. // support resolving morphTarget names into indices.
  38102. for ( let i = 0; i < targetObject.length; i ++ ) {
  38103. if ( targetObject[ i ].name === objectIndex ) {
  38104. objectIndex = i;
  38105. break;
  38106. }
  38107. }
  38108. break;
  38109. case 'map':
  38110. if ( 'map' in targetObject ) {
  38111. targetObject = targetObject.map;
  38112. break;
  38113. }
  38114. if ( ! targetObject.material ) {
  38115. error( 'PropertyBinding: Can not bind to material as node does not have a material.', this );
  38116. return;
  38117. }
  38118. if ( ! targetObject.material.map ) {
  38119. error( 'PropertyBinding: Can not bind to material.map as node.material does not have a map.', this );
  38120. return;
  38121. }
  38122. targetObject = targetObject.material.map;
  38123. break;
  38124. default:
  38125. if ( targetObject[ objectName ] === undefined ) {
  38126. error( 'PropertyBinding: Can not bind to objectName of node undefined.', this );
  38127. return;
  38128. }
  38129. targetObject = targetObject[ objectName ];
  38130. }
  38131. if ( objectIndex !== undefined ) {
  38132. if ( targetObject[ objectIndex ] === undefined ) {
  38133. error( 'PropertyBinding: Trying to bind to objectIndex of objectName, but is undefined.', this, targetObject );
  38134. return;
  38135. }
  38136. targetObject = targetObject[ objectIndex ];
  38137. }
  38138. }
  38139. // resolve property
  38140. const nodeProperty = targetObject[ propertyName ];
  38141. if ( nodeProperty === undefined ) {
  38142. const nodeName = parsedPath.nodeName;
  38143. error( 'PropertyBinding: Trying to update property for track: ' + nodeName +
  38144. '.' + propertyName + ' but it wasn\'t found.', targetObject );
  38145. return;
  38146. }
  38147. // determine versioning scheme
  38148. let versioning = this.Versioning.None;
  38149. this.targetObject = targetObject;
  38150. if ( targetObject.isMaterial === true ) {
  38151. versioning = this.Versioning.NeedsUpdate;
  38152. } else if ( targetObject.isObject3D === true ) {
  38153. versioning = this.Versioning.MatrixWorldNeedsUpdate;
  38154. }
  38155. // determine how the property gets bound
  38156. let bindingType = this.BindingType.Direct;
  38157. if ( propertyIndex !== undefined ) {
  38158. // access a sub element of the property array (only primitives are supported right now)
  38159. if ( propertyName === 'morphTargetInfluences' ) {
  38160. // potential optimization, skip this if propertyIndex is already an integer, and convert the integer string to a true integer.
  38161. // support resolving morphTarget names into indices.
  38162. if ( ! targetObject.geometry ) {
  38163. error( 'PropertyBinding: Can not bind to morphTargetInfluences because node does not have a geometry.', this );
  38164. return;
  38165. }
  38166. if ( ! targetObject.geometry.morphAttributes ) {
  38167. error( 'PropertyBinding: Can not bind to morphTargetInfluences because node does not have a geometry.morphAttributes.', this );
  38168. return;
  38169. }
  38170. if ( targetObject.morphTargetDictionary[ propertyIndex ] !== undefined ) {
  38171. propertyIndex = targetObject.morphTargetDictionary[ propertyIndex ];
  38172. }
  38173. }
  38174. bindingType = this.BindingType.ArrayElement;
  38175. this.resolvedProperty = nodeProperty;
  38176. this.propertyIndex = propertyIndex;
  38177. } else if ( nodeProperty.fromArray !== undefined && nodeProperty.toArray !== undefined ) {
  38178. // must use copy for Object3D.Euler/Quaternion
  38179. bindingType = this.BindingType.HasFromToArray;
  38180. this.resolvedProperty = nodeProperty;
  38181. } else if ( Array.isArray( nodeProperty ) ) {
  38182. bindingType = this.BindingType.EntireArray;
  38183. this.resolvedProperty = nodeProperty;
  38184. } else {
  38185. this.propertyName = propertyName;
  38186. }
  38187. // select getter / setter
  38188. this.getValue = this.GetterByBindingType[ bindingType ];
  38189. this.setValue = this.SetterByBindingTypeAndVersioning[ bindingType ][ versioning ];
  38190. }
  38191. /**
  38192. * Unbinds the property.
  38193. */
  38194. unbind() {
  38195. this.node = null;
  38196. // back to the prototype version of getValue / setValue
  38197. // note: avoiding to mutate the shape of 'this' via 'delete'
  38198. this.getValue = this._getValue_unbound;
  38199. this.setValue = this._setValue_unbound;
  38200. }
  38201. }
  38202. PropertyBinding.Composite = Composite;
  38203. PropertyBinding.prototype.BindingType = {
  38204. Direct: 0,
  38205. EntireArray: 1,
  38206. ArrayElement: 2,
  38207. HasFromToArray: 3
  38208. };
  38209. PropertyBinding.prototype.Versioning = {
  38210. None: 0,
  38211. NeedsUpdate: 1,
  38212. MatrixWorldNeedsUpdate: 2
  38213. };
  38214. PropertyBinding.prototype.GetterByBindingType = [
  38215. PropertyBinding.prototype._getValue_direct,
  38216. PropertyBinding.prototype._getValue_array,
  38217. PropertyBinding.prototype._getValue_arrayElement,
  38218. PropertyBinding.prototype._getValue_toArray,
  38219. ];
  38220. PropertyBinding.prototype.SetterByBindingTypeAndVersioning = [
  38221. [
  38222. // Direct
  38223. PropertyBinding.prototype._setValue_direct,
  38224. PropertyBinding.prototype._setValue_direct_setNeedsUpdate,
  38225. PropertyBinding.prototype._setValue_direct_setMatrixWorldNeedsUpdate,
  38226. ], [
  38227. // EntireArray
  38228. PropertyBinding.prototype._setValue_array,
  38229. PropertyBinding.prototype._setValue_array_setNeedsUpdate,
  38230. PropertyBinding.prototype._setValue_array_setMatrixWorldNeedsUpdate,
  38231. ], [
  38232. // ArrayElement
  38233. PropertyBinding.prototype._setValue_arrayElement,
  38234. PropertyBinding.prototype._setValue_arrayElement_setNeedsUpdate,
  38235. PropertyBinding.prototype._setValue_arrayElement_setMatrixWorldNeedsUpdate,
  38236. ], [
  38237. // HasToFromArray
  38238. PropertyBinding.prototype._setValue_fromArray,
  38239. PropertyBinding.prototype._setValue_fromArray_setNeedsUpdate,
  38240. PropertyBinding.prototype._setValue_fromArray_setMatrixWorldNeedsUpdate,
  38241. ]
  38242. ];
  38243. /**
  38244. * A group of objects that receives a shared animation state.
  38245. *
  38246. * Usage:
  38247. *
  38248. * - Add objects you would otherwise pass as 'root' to the
  38249. * constructor or the .clipAction method of AnimationMixer.
  38250. * - Instead pass this object as 'root'.
  38251. * - You can also add and remove objects later when the mixer is running.
  38252. *
  38253. * Note:
  38254. *
  38255. * - Objects of this class appear as one object to the mixer,
  38256. * so cache control of the individual objects must be done on the group.
  38257. *
  38258. * Limitation:
  38259. *
  38260. * - The animated properties must be compatible among the all objects in the group.
  38261. * - A single property can either be controlled through a target group or directly, but not both.
  38262. */
  38263. class AnimationObjectGroup {
  38264. /**
  38265. * Constructs a new animation group.
  38266. *
  38267. * @param {...Object3D} arguments - An arbitrary number of 3D objects that share the same animation state.
  38268. */
  38269. constructor() {
  38270. /**
  38271. * This flag can be used for type testing.
  38272. *
  38273. * @type {boolean}
  38274. * @readonly
  38275. * @default true
  38276. */
  38277. this.isAnimationObjectGroup = true;
  38278. /**
  38279. * The UUID of the 3D object.
  38280. *
  38281. * @type {string}
  38282. * @readonly
  38283. */
  38284. this.uuid = generateUUID();
  38285. // cached objects followed by the active ones
  38286. this._objects = Array.prototype.slice.call( arguments );
  38287. this.nCachedObjects_ = 0; // threshold
  38288. // note: read by PropertyBinding.Composite
  38289. const indices = {};
  38290. this._indicesByUUID = indices; // for bookkeeping
  38291. for ( let i = 0, n = arguments.length; i !== n; ++ i ) {
  38292. indices[ arguments[ i ].uuid ] = i;
  38293. }
  38294. this._paths = []; // inside: string
  38295. this._parsedPaths = []; // inside: { we don't care, here }
  38296. this._bindings = []; // inside: Array< PropertyBinding >
  38297. this._bindingsIndicesByPath = {}; // inside: indices in these arrays
  38298. const scope = this;
  38299. this.stats = {
  38300. objects: {
  38301. get total() {
  38302. return scope._objects.length;
  38303. },
  38304. get inUse() {
  38305. return this.total - scope.nCachedObjects_;
  38306. }
  38307. },
  38308. get bindingsPerObject() {
  38309. return scope._bindings.length;
  38310. }
  38311. };
  38312. }
  38313. /**
  38314. * Adds an arbitrary number of objects to this animation group.
  38315. *
  38316. * @param {...Object3D} arguments - The 3D objects to add.
  38317. */
  38318. add() {
  38319. const objects = this._objects,
  38320. indicesByUUID = this._indicesByUUID,
  38321. paths = this._paths,
  38322. parsedPaths = this._parsedPaths,
  38323. bindings = this._bindings,
  38324. nBindings = bindings.length;
  38325. let knownObject = undefined,
  38326. nObjects = objects.length,
  38327. nCachedObjects = this.nCachedObjects_;
  38328. for ( let i = 0, n = arguments.length; i !== n; ++ i ) {
  38329. const object = arguments[ i ],
  38330. uuid = object.uuid;
  38331. let index = indicesByUUID[ uuid ];
  38332. if ( index === undefined ) {
  38333. // unknown object -> add it to the ACTIVE region
  38334. index = nObjects ++;
  38335. indicesByUUID[ uuid ] = index;
  38336. objects.push( object );
  38337. // accounting is done, now do the same for all bindings
  38338. for ( let j = 0, m = nBindings; j !== m; ++ j ) {
  38339. bindings[ j ].push( new PropertyBinding( object, paths[ j ], parsedPaths[ j ] ) );
  38340. }
  38341. } else if ( index < nCachedObjects ) {
  38342. knownObject = objects[ index ];
  38343. // move existing object to the ACTIVE region
  38344. const firstActiveIndex = -- nCachedObjects,
  38345. lastCachedObject = objects[ firstActiveIndex ];
  38346. indicesByUUID[ lastCachedObject.uuid ] = index;
  38347. objects[ index ] = lastCachedObject;
  38348. indicesByUUID[ uuid ] = firstActiveIndex;
  38349. objects[ firstActiveIndex ] = object;
  38350. // accounting is done, now do the same for all bindings
  38351. for ( let j = 0, m = nBindings; j !== m; ++ j ) {
  38352. const bindingsForPath = bindings[ j ],
  38353. lastCached = bindingsForPath[ firstActiveIndex ];
  38354. let binding = bindingsForPath[ index ];
  38355. bindingsForPath[ index ] = lastCached;
  38356. if ( binding === undefined ) {
  38357. // since we do not bother to create new bindings
  38358. // for objects that are cached, the binding may
  38359. // or may not exist
  38360. binding = new PropertyBinding( object, paths[ j ], parsedPaths[ j ] );
  38361. }
  38362. bindingsForPath[ firstActiveIndex ] = binding;
  38363. }
  38364. } else if ( objects[ index ] !== knownObject ) {
  38365. error( 'AnimationObjectGroup: Different objects with the same UUID ' +
  38366. 'detected. Clean the caches or recreate your infrastructure when reloading scenes.' );
  38367. } // else the object is already where we want it to be
  38368. } // for arguments
  38369. this.nCachedObjects_ = nCachedObjects;
  38370. }
  38371. /**
  38372. * Removes an arbitrary number of objects to this animation group
  38373. *
  38374. * @param {...Object3D} arguments - The 3D objects to remove.
  38375. */
  38376. remove() {
  38377. const objects = this._objects,
  38378. indicesByUUID = this._indicesByUUID,
  38379. bindings = this._bindings,
  38380. nBindings = bindings.length;
  38381. let nCachedObjects = this.nCachedObjects_;
  38382. for ( let i = 0, n = arguments.length; i !== n; ++ i ) {
  38383. const object = arguments[ i ],
  38384. uuid = object.uuid,
  38385. index = indicesByUUID[ uuid ];
  38386. if ( index !== undefined && index >= nCachedObjects ) {
  38387. // move existing object into the CACHED region
  38388. const lastCachedIndex = nCachedObjects ++,
  38389. firstActiveObject = objects[ lastCachedIndex ];
  38390. indicesByUUID[ firstActiveObject.uuid ] = index;
  38391. objects[ index ] = firstActiveObject;
  38392. indicesByUUID[ uuid ] = lastCachedIndex;
  38393. objects[ lastCachedIndex ] = object;
  38394. // accounting is done, now do the same for all bindings
  38395. for ( let j = 0, m = nBindings; j !== m; ++ j ) {
  38396. const bindingsForPath = bindings[ j ],
  38397. firstActive = bindingsForPath[ lastCachedIndex ],
  38398. binding = bindingsForPath[ index ];
  38399. bindingsForPath[ index ] = firstActive;
  38400. bindingsForPath[ lastCachedIndex ] = binding;
  38401. }
  38402. }
  38403. } // for arguments
  38404. this.nCachedObjects_ = nCachedObjects;
  38405. }
  38406. /**
  38407. * Deallocates all memory resources for the passed 3D objects of this animation group.
  38408. *
  38409. * @param {...Object3D} arguments - The 3D objects to uncache.
  38410. */
  38411. uncache() {
  38412. const objects = this._objects,
  38413. indicesByUUID = this._indicesByUUID,
  38414. bindings = this._bindings,
  38415. nBindings = bindings.length;
  38416. let nCachedObjects = this.nCachedObjects_,
  38417. nObjects = objects.length;
  38418. for ( let i = 0, n = arguments.length; i !== n; ++ i ) {
  38419. const object = arguments[ i ],
  38420. uuid = object.uuid,
  38421. index = indicesByUUID[ uuid ];
  38422. if ( index !== undefined ) {
  38423. delete indicesByUUID[ uuid ];
  38424. if ( index < nCachedObjects ) {
  38425. // object is cached, shrink the CACHED region
  38426. const firstActiveIndex = -- nCachedObjects,
  38427. lastCachedObject = objects[ firstActiveIndex ],
  38428. lastIndex = -- nObjects,
  38429. lastObject = objects[ lastIndex ];
  38430. // last cached object takes this object's place
  38431. indicesByUUID[ lastCachedObject.uuid ] = index;
  38432. objects[ index ] = lastCachedObject;
  38433. // last object goes to the activated slot and pop
  38434. indicesByUUID[ lastObject.uuid ] = firstActiveIndex;
  38435. objects[ firstActiveIndex ] = lastObject;
  38436. objects.pop();
  38437. // accounting is done, now do the same for all bindings
  38438. for ( let j = 0, m = nBindings; j !== m; ++ j ) {
  38439. const bindingsForPath = bindings[ j ],
  38440. lastCached = bindingsForPath[ firstActiveIndex ],
  38441. last = bindingsForPath[ lastIndex ];
  38442. bindingsForPath[ index ] = lastCached;
  38443. bindingsForPath[ firstActiveIndex ] = last;
  38444. bindingsForPath.pop();
  38445. }
  38446. } else {
  38447. // object is active, just swap with the last and pop
  38448. const lastIndex = -- nObjects,
  38449. lastObject = objects[ lastIndex ];
  38450. if ( lastIndex > 0 ) {
  38451. indicesByUUID[ lastObject.uuid ] = index;
  38452. }
  38453. objects[ index ] = lastObject;
  38454. objects.pop();
  38455. // accounting is done, now do the same for all bindings
  38456. for ( let j = 0, m = nBindings; j !== m; ++ j ) {
  38457. const bindingsForPath = bindings[ j ];
  38458. bindingsForPath[ index ] = bindingsForPath[ lastIndex ];
  38459. bindingsForPath.pop();
  38460. }
  38461. } // cached or active
  38462. } // if object is known
  38463. } // for arguments
  38464. this.nCachedObjects_ = nCachedObjects;
  38465. }
  38466. // Internal interface used by befriended PropertyBinding.Composite:
  38467. subscribe_( path, parsedPath ) {
  38468. // returns an array of bindings for the given path that is changed
  38469. // according to the contained objects in the group
  38470. const indicesByPath = this._bindingsIndicesByPath;
  38471. let index = indicesByPath[ path ];
  38472. const bindings = this._bindings;
  38473. if ( index !== undefined ) return bindings[ index ];
  38474. const paths = this._paths,
  38475. parsedPaths = this._parsedPaths,
  38476. objects = this._objects,
  38477. nObjects = objects.length,
  38478. nCachedObjects = this.nCachedObjects_,
  38479. bindingsForPath = new Array( nObjects );
  38480. index = bindings.length;
  38481. indicesByPath[ path ] = index;
  38482. paths.push( path );
  38483. parsedPaths.push( parsedPath );
  38484. bindings.push( bindingsForPath );
  38485. for ( let i = nCachedObjects, n = objects.length; i !== n; ++ i ) {
  38486. const object = objects[ i ];
  38487. bindingsForPath[ i ] = new PropertyBinding( object, path, parsedPath );
  38488. }
  38489. return bindingsForPath;
  38490. }
  38491. unsubscribe_( path ) {
  38492. // tells the group to forget about a property path and no longer
  38493. // update the array previously obtained with 'subscribe_'
  38494. const indicesByPath = this._bindingsIndicesByPath,
  38495. index = indicesByPath[ path ];
  38496. if ( index !== undefined ) {
  38497. const paths = this._paths,
  38498. parsedPaths = this._parsedPaths,
  38499. bindings = this._bindings,
  38500. lastBindingsIndex = bindings.length - 1,
  38501. lastBindings = bindings[ lastBindingsIndex ],
  38502. lastBindingsPath = path[ lastBindingsIndex ];
  38503. indicesByPath[ lastBindingsPath ] = index;
  38504. bindings[ index ] = lastBindings;
  38505. bindings.pop();
  38506. parsedPaths[ index ] = parsedPaths[ lastBindingsIndex ];
  38507. parsedPaths.pop();
  38508. paths[ index ] = paths[ lastBindingsIndex ];
  38509. paths.pop();
  38510. }
  38511. }
  38512. }
  38513. /**
  38514. * An instance of `AnimationAction` schedules the playback of an animation which is
  38515. * stored in {@link AnimationClip}.
  38516. */
  38517. class AnimationAction {
  38518. /**
  38519. * Constructs a new animation action.
  38520. *
  38521. * @param {AnimationMixer} mixer - The mixer that is controlled by this action.
  38522. * @param {AnimationClip} clip - The animation clip that holds the actual keyframes.
  38523. * @param {?Object3D} [localRoot=null] - The root object on which this action is performed.
  38524. * @param {(NormalAnimationBlendMode|AdditiveAnimationBlendMode)} [blendMode] - The blend mode.
  38525. */
  38526. constructor( mixer, clip, localRoot = null, blendMode = clip.blendMode ) {
  38527. this._mixer = mixer;
  38528. this._clip = clip;
  38529. this._localRoot = localRoot;
  38530. /**
  38531. * Defines how the animation is blended/combined when two or more animations
  38532. * are simultaneously played.
  38533. *
  38534. * @type {(NormalAnimationBlendMode|AdditiveAnimationBlendMode)}
  38535. */
  38536. this.blendMode = blendMode;
  38537. const tracks = clip.tracks,
  38538. nTracks = tracks.length,
  38539. interpolants = new Array( nTracks );
  38540. const interpolantSettings = {
  38541. endingStart: ZeroCurvatureEnding,
  38542. endingEnd: ZeroCurvatureEnding
  38543. };
  38544. for ( let i = 0; i !== nTracks; ++ i ) {
  38545. const interpolant = tracks[ i ].createInterpolant( null );
  38546. interpolants[ i ] = interpolant;
  38547. interpolant.settings = interpolantSettings;
  38548. }
  38549. this._interpolantSettings = interpolantSettings;
  38550. this._interpolants = interpolants; // bound by the mixer
  38551. // inside: PropertyMixer (managed by the mixer)
  38552. this._propertyBindings = new Array( nTracks );
  38553. this._cacheIndex = null; // for the memory manager
  38554. this._byClipCacheIndex = null; // for the memory manager
  38555. this._timeScaleInterpolant = null;
  38556. this._weightInterpolant = null;
  38557. /**
  38558. * The loop mode, set via {@link AnimationAction#setLoop}.
  38559. *
  38560. * @type {(LoopRepeat|LoopOnce|LoopPingPong)}
  38561. * @default LoopRepeat
  38562. */
  38563. this.loop = LoopRepeat;
  38564. this._loopCount = -1;
  38565. // global mixer time when the action is to be started
  38566. // it's set back to 'null' upon start of the action
  38567. this._startTime = null;
  38568. /**
  38569. * The local time of this action (in seconds, starting with `0`).
  38570. *
  38571. * The value gets clamped or wrapped to `[0,clip.duration]` (according to the
  38572. * loop state).
  38573. *
  38574. * @type {number}
  38575. * @default Infinity
  38576. */
  38577. this.time = 0;
  38578. /**
  38579. * Scaling factor for the {@link AnimationAction#time}. A value of `0` causes the
  38580. * animation to pause. Negative values cause the animation to play backwards.
  38581. *
  38582. * @type {number}
  38583. * @default 1
  38584. */
  38585. this.timeScale = 1;
  38586. this._effectiveTimeScale = 1;
  38587. /**
  38588. * The degree of influence of this action (in the interval `[0, 1]`). Values
  38589. * between `0` (no impact) and `1` (full impact) can be used to blend between
  38590. * several actions.
  38591. *
  38592. * @type {number}
  38593. * @default 1
  38594. */
  38595. this.weight = 1;
  38596. this._effectiveWeight = 1;
  38597. /**
  38598. * The number of repetitions of the performed clip over the course of this action.
  38599. * Can be set via {@link AnimationAction#setLoop}.
  38600. *
  38601. * Setting this number has no effect if {@link AnimationAction#loop} is set to
  38602. * `THREE:LoopOnce`.
  38603. *
  38604. * @type {number}
  38605. * @default Infinity
  38606. */
  38607. this.repetitions = Infinity;
  38608. /**
  38609. * If set to `true`, the playback of the action is paused.
  38610. *
  38611. * @type {boolean}
  38612. * @default false
  38613. */
  38614. this.paused = false;
  38615. /**
  38616. * If set to `false`, the action is disabled so it has no impact.
  38617. *
  38618. * When the action is re-enabled, the animation continues from its current
  38619. * time (setting `enabled` to `false` doesn't reset the action).
  38620. *
  38621. * @type {boolean}
  38622. * @default true
  38623. */
  38624. this.enabled = true;
  38625. /**
  38626. * If set to true the animation will automatically be paused on its last frame.
  38627. *
  38628. * If set to false, {@link AnimationAction#enabled} will automatically be switched
  38629. * to `false` when the last loop of the action has finished, so that this action has
  38630. * no further impact.
  38631. *
  38632. * Note: This member has no impact if the action is interrupted (it
  38633. * has only an effect if its last loop has really finished).
  38634. *
  38635. * @type {boolean}
  38636. * @default false
  38637. */
  38638. this.clampWhenFinished = false;
  38639. /**
  38640. * Enables smooth interpolation without separate clips for start, loop and end.
  38641. *
  38642. * @type {boolean}
  38643. * @default true
  38644. */
  38645. this.zeroSlopeAtStart = true;
  38646. /**
  38647. * Enables smooth interpolation without separate clips for start, loop and end.
  38648. *
  38649. * @type {boolean}
  38650. * @default true
  38651. */
  38652. this.zeroSlopeAtEnd = true;
  38653. }
  38654. /**
  38655. * Starts the playback of the animation.
  38656. *
  38657. * @return {AnimationAction} A reference to this animation action.
  38658. */
  38659. play() {
  38660. this._mixer._activateAction( this );
  38661. return this;
  38662. }
  38663. /**
  38664. * Stops the playback of the animation.
  38665. *
  38666. * @return {AnimationAction} A reference to this animation action.
  38667. */
  38668. stop() {
  38669. this._mixer._deactivateAction( this );
  38670. return this.reset();
  38671. }
  38672. /**
  38673. * Resets the playback of the animation.
  38674. *
  38675. * @return {AnimationAction} A reference to this animation action.
  38676. */
  38677. reset() {
  38678. this.paused = false;
  38679. this.enabled = true;
  38680. this.time = 0; // restart clip
  38681. this._loopCount = -1;// forget previous loops
  38682. this._startTime = null;// forget scheduling
  38683. return this.stopFading().stopWarping();
  38684. }
  38685. /**
  38686. * Returns `true` if the animation is running.
  38687. *
  38688. * @return {boolean} Whether the animation is running or not.
  38689. */
  38690. isRunning() {
  38691. return this.enabled && ! this.paused && this.timeScale !== 0 &&
  38692. this._startTime === null && this._mixer._isActiveAction( this );
  38693. }
  38694. /**
  38695. * Returns `true` when {@link AnimationAction#play} has been called.
  38696. *
  38697. * @return {boolean} Whether the animation is scheduled or not.
  38698. */
  38699. isScheduled() {
  38700. return this._mixer._isActiveAction( this );
  38701. }
  38702. /**
  38703. * Defines the time when the animation should start.
  38704. *
  38705. * @param {number} time - The start time in seconds.
  38706. * @return {AnimationAction} A reference to this animation action.
  38707. */
  38708. startAt( time ) {
  38709. this._startTime = time;
  38710. return this;
  38711. }
  38712. /**
  38713. * Configures the loop settings for this action.
  38714. *
  38715. * @param {(LoopRepeat|LoopOnce|LoopPingPong)} mode - The loop mode.
  38716. * @param {number} repetitions - The number of repetitions.
  38717. * @return {AnimationAction} A reference to this animation action.
  38718. */
  38719. setLoop( mode, repetitions ) {
  38720. this.loop = mode;
  38721. this.repetitions = repetitions;
  38722. return this;
  38723. }
  38724. /**
  38725. * Sets the effective weight of this action.
  38726. *
  38727. * An action has no effect and thus an effective weight of zero when the
  38728. * action is disabled.
  38729. *
  38730. * @param {number} weight - The weight to set.
  38731. * @return {AnimationAction} A reference to this animation action.
  38732. */
  38733. setEffectiveWeight( weight ) {
  38734. this.weight = weight;
  38735. // note: same logic as when updated at runtime
  38736. this._effectiveWeight = this.enabled ? weight : 0;
  38737. return this.stopFading();
  38738. }
  38739. /**
  38740. * Returns the effective weight of this action.
  38741. *
  38742. * @return {number} The effective weight.
  38743. */
  38744. getEffectiveWeight() {
  38745. return this._effectiveWeight;
  38746. }
  38747. /**
  38748. * Fades the animation in by increasing its weight gradually from `0` to `1`,
  38749. * within the passed time interval.
  38750. *
  38751. * @param {number} duration - The duration of the fade.
  38752. * @return {AnimationAction} A reference to this animation action.
  38753. */
  38754. fadeIn( duration ) {
  38755. return this._scheduleFading( duration, 0, 1 );
  38756. }
  38757. /**
  38758. * Fades the animation out by decreasing its weight gradually from `1` to `0`,
  38759. * within the passed time interval.
  38760. *
  38761. * @param {number} duration - The duration of the fade.
  38762. * @return {AnimationAction} A reference to this animation action.
  38763. */
  38764. fadeOut( duration ) {
  38765. return this._scheduleFading( duration, 1, 0 );
  38766. }
  38767. /**
  38768. * Causes this action to fade in and the given action to fade out,
  38769. * within the passed time interval.
  38770. *
  38771. * @param {AnimationAction} fadeOutAction - The animation action to fade out.
  38772. * @param {number} duration - The duration of the fade.
  38773. * @param {boolean} [warp=false] - Whether warping should be used or not.
  38774. * @return {AnimationAction} A reference to this animation action.
  38775. */
  38776. crossFadeFrom( fadeOutAction, duration, warp = false ) {
  38777. fadeOutAction.fadeOut( duration );
  38778. this.fadeIn( duration );
  38779. if ( warp === true ) {
  38780. const fadeInDuration = this._clip.duration,
  38781. fadeOutDuration = fadeOutAction._clip.duration,
  38782. startEndRatio = fadeOutDuration / fadeInDuration,
  38783. endStartRatio = fadeInDuration / fadeOutDuration;
  38784. fadeOutAction.warp( 1.0, startEndRatio, duration );
  38785. this.warp( endStartRatio, 1.0, duration );
  38786. }
  38787. return this;
  38788. }
  38789. /**
  38790. * Causes this action to fade out and the given action to fade in,
  38791. * within the passed time interval.
  38792. *
  38793. * @param {AnimationAction} fadeInAction - The animation action to fade in.
  38794. * @param {number} duration - The duration of the fade.
  38795. * @param {boolean} [warp=false] - Whether warping should be used or not.
  38796. * @return {AnimationAction} A reference to this animation action.
  38797. */
  38798. crossFadeTo( fadeInAction, duration, warp = false ) {
  38799. return fadeInAction.crossFadeFrom( this, duration, warp );
  38800. }
  38801. /**
  38802. * Stops any fading which is applied to this action.
  38803. *
  38804. * @return {AnimationAction} A reference to this animation action.
  38805. */
  38806. stopFading() {
  38807. const weightInterpolant = this._weightInterpolant;
  38808. if ( weightInterpolant !== null ) {
  38809. this._weightInterpolant = null;
  38810. this._mixer._takeBackControlInterpolant( weightInterpolant );
  38811. }
  38812. return this;
  38813. }
  38814. /**
  38815. * Sets the effective time scale of this action.
  38816. *
  38817. * An action has no effect and thus an effective time scale of zero when the
  38818. * action is paused.
  38819. *
  38820. * @param {number} timeScale - The time scale to set.
  38821. * @return {AnimationAction} A reference to this animation action.
  38822. */
  38823. setEffectiveTimeScale( timeScale ) {
  38824. this.timeScale = timeScale;
  38825. this._effectiveTimeScale = this.paused ? 0 : timeScale;
  38826. return this.stopWarping();
  38827. }
  38828. /**
  38829. * Returns the effective time scale of this action.
  38830. *
  38831. * @return {number} The effective time scale.
  38832. */
  38833. getEffectiveTimeScale() {
  38834. return this._effectiveTimeScale;
  38835. }
  38836. /**
  38837. * Sets the duration for a single loop of this action.
  38838. *
  38839. * @param {number} duration - The duration to set.
  38840. * @return {AnimationAction} A reference to this animation action.
  38841. */
  38842. setDuration( duration ) {
  38843. this.timeScale = this._clip.duration / duration;
  38844. return this.stopWarping();
  38845. }
  38846. /**
  38847. * Synchronizes this action with the passed other action.
  38848. *
  38849. * @param {AnimationAction} action - The action to sync with.
  38850. * @return {AnimationAction} A reference to this animation action.
  38851. */
  38852. syncWith( action ) {
  38853. this.time = action.time;
  38854. this.timeScale = action.timeScale;
  38855. return this.stopWarping();
  38856. }
  38857. /**
  38858. * Decelerates this animation's speed to `0` within the passed time interval.
  38859. *
  38860. * @param {number} duration - The duration.
  38861. * @return {AnimationAction} A reference to this animation action.
  38862. */
  38863. halt( duration ) {
  38864. return this.warp( this._effectiveTimeScale, 0, duration );
  38865. }
  38866. /**
  38867. * Changes the playback speed, within the passed time interval, by modifying
  38868. * {@link AnimationAction#timeScale} gradually from `startTimeScale` to
  38869. * `endTimeScale`.
  38870. *
  38871. * @param {number} startTimeScale - The start time scale.
  38872. * @param {number} endTimeScale - The end time scale.
  38873. * @param {number} duration - The duration.
  38874. * @return {AnimationAction} A reference to this animation action.
  38875. */
  38876. warp( startTimeScale, endTimeScale, duration ) {
  38877. const mixer = this._mixer,
  38878. now = mixer.time,
  38879. timeScale = this.timeScale;
  38880. let interpolant = this._timeScaleInterpolant;
  38881. if ( interpolant === null ) {
  38882. interpolant = mixer._lendControlInterpolant();
  38883. this._timeScaleInterpolant = interpolant;
  38884. }
  38885. const times = interpolant.parameterPositions,
  38886. values = interpolant.sampleValues;
  38887. times[ 0 ] = now;
  38888. times[ 1 ] = now + duration;
  38889. values[ 0 ] = startTimeScale / timeScale;
  38890. values[ 1 ] = endTimeScale / timeScale;
  38891. return this;
  38892. }
  38893. /**
  38894. * Stops any scheduled warping which is applied to this action.
  38895. *
  38896. * @return {AnimationAction} A reference to this animation action.
  38897. */
  38898. stopWarping() {
  38899. const timeScaleInterpolant = this._timeScaleInterpolant;
  38900. if ( timeScaleInterpolant !== null ) {
  38901. this._timeScaleInterpolant = null;
  38902. this._mixer._takeBackControlInterpolant( timeScaleInterpolant );
  38903. }
  38904. return this;
  38905. }
  38906. /**
  38907. * Returns the animation mixer of this animation action.
  38908. *
  38909. * @return {AnimationMixer} The animation mixer.
  38910. */
  38911. getMixer() {
  38912. return this._mixer;
  38913. }
  38914. /**
  38915. * Returns the animation clip of this animation action.
  38916. *
  38917. * @return {AnimationClip} The animation clip.
  38918. */
  38919. getClip() {
  38920. return this._clip;
  38921. }
  38922. /**
  38923. * Returns the root object of this animation action.
  38924. *
  38925. * @return {Object3D} The root object.
  38926. */
  38927. getRoot() {
  38928. return this._localRoot || this._mixer._root;
  38929. }
  38930. // Internal
  38931. _update( time, deltaTime, timeDirection, accuIndex ) {
  38932. // called by the mixer
  38933. if ( ! this.enabled ) {
  38934. // call ._updateWeight() to update ._effectiveWeight
  38935. this._updateWeight( time );
  38936. return;
  38937. }
  38938. const startTime = this._startTime;
  38939. if ( startTime !== null ) {
  38940. // check for scheduled start of action
  38941. const timeRunning = ( time - startTime ) * timeDirection;
  38942. if ( timeRunning < 0 || timeDirection === 0 ) {
  38943. deltaTime = 0;
  38944. } else {
  38945. this._startTime = null; // unschedule
  38946. deltaTime = timeDirection * timeRunning;
  38947. }
  38948. }
  38949. // apply time scale and advance time
  38950. deltaTime *= this._updateTimeScale( time );
  38951. const clipTime = this._updateTime( deltaTime );
  38952. // note: _updateTime may disable the action resulting in
  38953. // an effective weight of 0
  38954. const weight = this._updateWeight( time );
  38955. if ( weight > 0 ) {
  38956. const interpolants = this._interpolants;
  38957. const propertyMixers = this._propertyBindings;
  38958. switch ( this.blendMode ) {
  38959. case AdditiveAnimationBlendMode:
  38960. for ( let j = 0, m = interpolants.length; j !== m; ++ j ) {
  38961. interpolants[ j ].evaluate( clipTime );
  38962. propertyMixers[ j ].accumulateAdditive( weight );
  38963. }
  38964. break;
  38965. case NormalAnimationBlendMode:
  38966. default:
  38967. for ( let j = 0, m = interpolants.length; j !== m; ++ j ) {
  38968. interpolants[ j ].evaluate( clipTime );
  38969. propertyMixers[ j ].accumulate( accuIndex, weight );
  38970. }
  38971. }
  38972. }
  38973. }
  38974. _updateWeight( time ) {
  38975. let weight = 0;
  38976. if ( this.enabled ) {
  38977. weight = this.weight;
  38978. const interpolant = this._weightInterpolant;
  38979. if ( interpolant !== null ) {
  38980. const interpolantValue = interpolant.evaluate( time )[ 0 ];
  38981. weight *= interpolantValue;
  38982. if ( time > interpolant.parameterPositions[ 1 ] ) {
  38983. this.stopFading();
  38984. if ( interpolantValue === 0 ) {
  38985. // faded out, disable
  38986. this.enabled = false;
  38987. }
  38988. }
  38989. }
  38990. }
  38991. this._effectiveWeight = weight;
  38992. return weight;
  38993. }
  38994. _updateTimeScale( time ) {
  38995. let timeScale = 0;
  38996. if ( ! this.paused ) {
  38997. timeScale = this.timeScale;
  38998. const interpolant = this._timeScaleInterpolant;
  38999. if ( interpolant !== null ) {
  39000. const interpolantValue = interpolant.evaluate( time )[ 0 ];
  39001. timeScale *= interpolantValue;
  39002. if ( time > interpolant.parameterPositions[ 1 ] ) {
  39003. this.stopWarping();
  39004. if ( timeScale === 0 ) {
  39005. // motion has halted, pause
  39006. this.paused = true;
  39007. } else {
  39008. // warp done - apply final time scale
  39009. this.timeScale = timeScale;
  39010. }
  39011. }
  39012. }
  39013. }
  39014. this._effectiveTimeScale = timeScale;
  39015. return timeScale;
  39016. }
  39017. _updateTime( deltaTime ) {
  39018. const duration = this._clip.duration;
  39019. const loop = this.loop;
  39020. let time = this.time + deltaTime;
  39021. let loopCount = this._loopCount;
  39022. const pingPong = ( loop === LoopPingPong );
  39023. if ( deltaTime === 0 ) {
  39024. if ( loopCount === -1 ) return time;
  39025. return ( pingPong && ( loopCount & 1 ) === 1 ) ? duration - time : time;
  39026. }
  39027. if ( loop === LoopOnce ) {
  39028. if ( loopCount === -1 ) {
  39029. // just started
  39030. this._loopCount = 0;
  39031. this._setEndings( true, true, false );
  39032. }
  39033. handle_stop: {
  39034. if ( time >= duration ) {
  39035. time = duration;
  39036. } else if ( time < 0 ) {
  39037. time = 0;
  39038. } else {
  39039. this.time = time;
  39040. break handle_stop;
  39041. }
  39042. if ( this.clampWhenFinished ) this.paused = true;
  39043. else this.enabled = false;
  39044. this.time = time;
  39045. this._mixer.dispatchEvent( {
  39046. type: 'finished', action: this,
  39047. direction: deltaTime < 0 ? -1 : 1
  39048. } );
  39049. }
  39050. } else { // repetitive Repeat or PingPong
  39051. if ( loopCount === -1 ) {
  39052. // just started
  39053. if ( deltaTime >= 0 ) {
  39054. loopCount = 0;
  39055. this._setEndings( true, this.repetitions === 0, pingPong );
  39056. } else {
  39057. // when looping in reverse direction, the initial
  39058. // transition through zero counts as a repetition,
  39059. // so leave loopCount at -1
  39060. this._setEndings( this.repetitions === 0, true, pingPong );
  39061. }
  39062. }
  39063. if ( time >= duration || time < 0 ) {
  39064. // wrap around
  39065. const loopDelta = Math.floor( time / duration ); // signed
  39066. time -= duration * loopDelta;
  39067. loopCount += Math.abs( loopDelta );
  39068. const pending = this.repetitions - loopCount;
  39069. if ( pending <= 0 ) {
  39070. // have to stop (switch state, clamp time, fire event)
  39071. if ( this.clampWhenFinished ) this.paused = true;
  39072. else this.enabled = false;
  39073. time = deltaTime > 0 ? duration : 0;
  39074. this.time = time;
  39075. this._mixer.dispatchEvent( {
  39076. type: 'finished', action: this,
  39077. direction: deltaTime > 0 ? 1 : -1
  39078. } );
  39079. } else {
  39080. // keep running
  39081. if ( pending === 1 ) {
  39082. // entering the last round
  39083. const atStart = deltaTime < 0;
  39084. this._setEndings( atStart, ! atStart, pingPong );
  39085. } else {
  39086. this._setEndings( false, false, pingPong );
  39087. }
  39088. this._loopCount = loopCount;
  39089. this.time = time;
  39090. this._mixer.dispatchEvent( {
  39091. type: 'loop', action: this, loopDelta: loopDelta
  39092. } );
  39093. }
  39094. } else {
  39095. this.time = time;
  39096. }
  39097. if ( pingPong && ( loopCount & 1 ) === 1 ) {
  39098. // invert time for the "pong round"
  39099. return duration - time;
  39100. }
  39101. }
  39102. return time;
  39103. }
  39104. _setEndings( atStart, atEnd, pingPong ) {
  39105. const settings = this._interpolantSettings;
  39106. if ( pingPong ) {
  39107. settings.endingStart = ZeroSlopeEnding;
  39108. settings.endingEnd = ZeroSlopeEnding;
  39109. } else {
  39110. // assuming for LoopOnce atStart == atEnd == true
  39111. if ( atStart ) {
  39112. settings.endingStart = this.zeroSlopeAtStart ? ZeroSlopeEnding : ZeroCurvatureEnding;
  39113. } else {
  39114. settings.endingStart = WrapAroundEnding;
  39115. }
  39116. if ( atEnd ) {
  39117. settings.endingEnd = this.zeroSlopeAtEnd ? ZeroSlopeEnding : ZeroCurvatureEnding;
  39118. } else {
  39119. settings.endingEnd = WrapAroundEnding;
  39120. }
  39121. }
  39122. }
  39123. _scheduleFading( duration, weightNow, weightThen ) {
  39124. const mixer = this._mixer, now = mixer.time;
  39125. let interpolant = this._weightInterpolant;
  39126. if ( interpolant === null ) {
  39127. interpolant = mixer._lendControlInterpolant();
  39128. this._weightInterpolant = interpolant;
  39129. }
  39130. const times = interpolant.parameterPositions,
  39131. values = interpolant.sampleValues;
  39132. times[ 0 ] = now;
  39133. values[ 0 ] = weightNow;
  39134. times[ 1 ] = now + duration;
  39135. values[ 1 ] = weightThen;
  39136. return this;
  39137. }
  39138. }
  39139. const _controlInterpolantsResultBuffer = new Float32Array( 1 );
  39140. /**
  39141. * `AnimationMixer` is a player for animations on a particular object in
  39142. * the scene. When multiple objects in the scene are animated independently,
  39143. * one `AnimationMixer` may be used for each object.
  39144. */
  39145. class AnimationMixer extends EventDispatcher {
  39146. /**
  39147. * Constructs a new animation mixer.
  39148. *
  39149. * @param {Object3D} root - The object whose animations shall be played by this mixer.
  39150. */
  39151. constructor( root ) {
  39152. super();
  39153. this._root = root;
  39154. this._initMemoryManager();
  39155. this._accuIndex = 0;
  39156. /**
  39157. * The global mixer time (in seconds; starting with `0` on the mixer's creation).
  39158. *
  39159. * @type {number}
  39160. * @default 0
  39161. */
  39162. this.time = 0;
  39163. /**
  39164. * A scaling factor for the global time.
  39165. *
  39166. * Note: Setting this member to `0` and later back to `1` is a
  39167. * possibility to pause/unpause all actions that are controlled by this
  39168. * mixer.
  39169. *
  39170. * @type {number}
  39171. * @default 1
  39172. */
  39173. this.timeScale = 1.0;
  39174. if ( typeof __THREE_DEVTOOLS__ !== 'undefined' ) {
  39175. __THREE_DEVTOOLS__.dispatchEvent( new CustomEvent( 'observe', { detail: this } ) );
  39176. }
  39177. }
  39178. _bindAction( action, prototypeAction ) {
  39179. const root = action._localRoot || this._root,
  39180. tracks = action._clip.tracks,
  39181. nTracks = tracks.length,
  39182. bindings = action._propertyBindings,
  39183. interpolants = action._interpolants,
  39184. rootUuid = root.uuid,
  39185. bindingsByRoot = this._bindingsByRootAndName;
  39186. let bindingsByName = bindingsByRoot[ rootUuid ];
  39187. if ( bindingsByName === undefined ) {
  39188. bindingsByName = {};
  39189. bindingsByRoot[ rootUuid ] = bindingsByName;
  39190. }
  39191. for ( let i = 0; i !== nTracks; ++ i ) {
  39192. const track = tracks[ i ],
  39193. trackName = track.name;
  39194. let binding = bindingsByName[ trackName ];
  39195. if ( binding !== undefined ) {
  39196. ++ binding.referenceCount;
  39197. bindings[ i ] = binding;
  39198. } else {
  39199. binding = bindings[ i ];
  39200. if ( binding !== undefined ) {
  39201. // existing binding, make sure the cache knows
  39202. if ( binding._cacheIndex === null ) {
  39203. ++ binding.referenceCount;
  39204. this._addInactiveBinding( binding, rootUuid, trackName );
  39205. }
  39206. continue;
  39207. }
  39208. const path = prototypeAction && prototypeAction.
  39209. _propertyBindings[ i ].binding.parsedPath;
  39210. binding = new PropertyMixer(
  39211. PropertyBinding.create( root, trackName, path ),
  39212. track.ValueTypeName, track.getValueSize() );
  39213. ++ binding.referenceCount;
  39214. this._addInactiveBinding( binding, rootUuid, trackName );
  39215. bindings[ i ] = binding;
  39216. }
  39217. interpolants[ i ].resultBuffer = binding.buffer;
  39218. }
  39219. }
  39220. _activateAction( action ) {
  39221. if ( ! this._isActiveAction( action ) ) {
  39222. if ( action._cacheIndex === null ) {
  39223. // this action has been forgotten by the cache, but the user
  39224. // appears to be still using it -> rebind
  39225. const rootUuid = ( action._localRoot || this._root ).uuid,
  39226. clipUuid = action._clip.uuid,
  39227. actionsForClip = this._actionsByClip[ clipUuid ];
  39228. this._bindAction( action,
  39229. actionsForClip && actionsForClip.knownActions[ 0 ] );
  39230. this._addInactiveAction( action, clipUuid, rootUuid );
  39231. }
  39232. const bindings = action._propertyBindings;
  39233. // increment reference counts / sort out state
  39234. for ( let i = 0, n = bindings.length; i !== n; ++ i ) {
  39235. const binding = bindings[ i ];
  39236. if ( binding.useCount ++ === 0 ) {
  39237. this._lendBinding( binding );
  39238. binding.saveOriginalState();
  39239. }
  39240. }
  39241. this._lendAction( action );
  39242. }
  39243. }
  39244. _deactivateAction( action ) {
  39245. if ( this._isActiveAction( action ) ) {
  39246. const bindings = action._propertyBindings;
  39247. // decrement reference counts / sort out state
  39248. for ( let i = 0, n = bindings.length; i !== n; ++ i ) {
  39249. const binding = bindings[ i ];
  39250. if ( -- binding.useCount === 0 ) {
  39251. binding.restoreOriginalState();
  39252. this._takeBackBinding( binding );
  39253. }
  39254. }
  39255. this._takeBackAction( action );
  39256. }
  39257. }
  39258. // Memory manager
  39259. _initMemoryManager() {
  39260. this._actions = []; // 'nActiveActions' followed by inactive ones
  39261. this._nActiveActions = 0;
  39262. this._actionsByClip = {};
  39263. // inside:
  39264. // {
  39265. // knownActions: Array< AnimationAction > - used as prototypes
  39266. // actionByRoot: AnimationAction - lookup
  39267. // }
  39268. this._bindings = []; // 'nActiveBindings' followed by inactive ones
  39269. this._nActiveBindings = 0;
  39270. this._bindingsByRootAndName = {}; // inside: Map< name, PropertyMixer >
  39271. this._controlInterpolants = []; // same game as above
  39272. this._nActiveControlInterpolants = 0;
  39273. const scope = this;
  39274. this.stats = {
  39275. actions: {
  39276. get total() {
  39277. return scope._actions.length;
  39278. },
  39279. get inUse() {
  39280. return scope._nActiveActions;
  39281. }
  39282. },
  39283. bindings: {
  39284. get total() {
  39285. return scope._bindings.length;
  39286. },
  39287. get inUse() {
  39288. return scope._nActiveBindings;
  39289. }
  39290. },
  39291. controlInterpolants: {
  39292. get total() {
  39293. return scope._controlInterpolants.length;
  39294. },
  39295. get inUse() {
  39296. return scope._nActiveControlInterpolants;
  39297. }
  39298. }
  39299. };
  39300. }
  39301. // Memory management for AnimationAction objects
  39302. _isActiveAction( action ) {
  39303. const index = action._cacheIndex;
  39304. return index !== null && index < this._nActiveActions;
  39305. }
  39306. _addInactiveAction( action, clipUuid, rootUuid ) {
  39307. const actions = this._actions,
  39308. actionsByClip = this._actionsByClip;
  39309. let actionsForClip = actionsByClip[ clipUuid ];
  39310. if ( actionsForClip === undefined ) {
  39311. actionsForClip = {
  39312. knownActions: [ action ],
  39313. actionByRoot: {}
  39314. };
  39315. action._byClipCacheIndex = 0;
  39316. actionsByClip[ clipUuid ] = actionsForClip;
  39317. } else {
  39318. const knownActions = actionsForClip.knownActions;
  39319. action._byClipCacheIndex = knownActions.length;
  39320. knownActions.push( action );
  39321. }
  39322. action._cacheIndex = actions.length;
  39323. actions.push( action );
  39324. actionsForClip.actionByRoot[ rootUuid ] = action;
  39325. }
  39326. _removeInactiveAction( action ) {
  39327. const actions = this._actions,
  39328. lastInactiveAction = actions[ actions.length - 1 ],
  39329. cacheIndex = action._cacheIndex;
  39330. lastInactiveAction._cacheIndex = cacheIndex;
  39331. actions[ cacheIndex ] = lastInactiveAction;
  39332. actions.pop();
  39333. action._cacheIndex = null;
  39334. const clipUuid = action._clip.uuid,
  39335. actionsByClip = this._actionsByClip,
  39336. actionsForClip = actionsByClip[ clipUuid ],
  39337. knownActionsForClip = actionsForClip.knownActions,
  39338. lastKnownAction =
  39339. knownActionsForClip[ knownActionsForClip.length - 1 ],
  39340. byClipCacheIndex = action._byClipCacheIndex;
  39341. lastKnownAction._byClipCacheIndex = byClipCacheIndex;
  39342. knownActionsForClip[ byClipCacheIndex ] = lastKnownAction;
  39343. knownActionsForClip.pop();
  39344. action._byClipCacheIndex = null;
  39345. const actionByRoot = actionsForClip.actionByRoot,
  39346. rootUuid = ( action._localRoot || this._root ).uuid;
  39347. delete actionByRoot[ rootUuid ];
  39348. if ( knownActionsForClip.length === 0 ) {
  39349. delete actionsByClip[ clipUuid ];
  39350. }
  39351. this._removeInactiveBindingsForAction( action );
  39352. }
  39353. _removeInactiveBindingsForAction( action ) {
  39354. const bindings = action._propertyBindings;
  39355. for ( let i = 0, n = bindings.length; i !== n; ++ i ) {
  39356. const binding = bindings[ i ];
  39357. if ( -- binding.referenceCount === 0 ) {
  39358. this._removeInactiveBinding( binding );
  39359. }
  39360. }
  39361. }
  39362. _lendAction( action ) {
  39363. // [ active actions | inactive actions ]
  39364. // [ active actions >| inactive actions ]
  39365. // s a
  39366. // <-swap->
  39367. // a s
  39368. const actions = this._actions,
  39369. prevIndex = action._cacheIndex,
  39370. lastActiveIndex = this._nActiveActions ++,
  39371. firstInactiveAction = actions[ lastActiveIndex ];
  39372. action._cacheIndex = lastActiveIndex;
  39373. actions[ lastActiveIndex ] = action;
  39374. firstInactiveAction._cacheIndex = prevIndex;
  39375. actions[ prevIndex ] = firstInactiveAction;
  39376. }
  39377. _takeBackAction( action ) {
  39378. // [ active actions | inactive actions ]
  39379. // [ active actions |< inactive actions ]
  39380. // a s
  39381. // <-swap->
  39382. // s a
  39383. const actions = this._actions,
  39384. prevIndex = action._cacheIndex,
  39385. firstInactiveIndex = -- this._nActiveActions,
  39386. lastActiveAction = actions[ firstInactiveIndex ];
  39387. action._cacheIndex = firstInactiveIndex;
  39388. actions[ firstInactiveIndex ] = action;
  39389. lastActiveAction._cacheIndex = prevIndex;
  39390. actions[ prevIndex ] = lastActiveAction;
  39391. }
  39392. // Memory management for PropertyMixer objects
  39393. _addInactiveBinding( binding, rootUuid, trackName ) {
  39394. const bindingsByRoot = this._bindingsByRootAndName,
  39395. bindings = this._bindings;
  39396. let bindingByName = bindingsByRoot[ rootUuid ];
  39397. if ( bindingByName === undefined ) {
  39398. bindingByName = {};
  39399. bindingsByRoot[ rootUuid ] = bindingByName;
  39400. }
  39401. bindingByName[ trackName ] = binding;
  39402. binding._cacheIndex = bindings.length;
  39403. bindings.push( binding );
  39404. }
  39405. _removeInactiveBinding( binding ) {
  39406. const bindings = this._bindings,
  39407. propBinding = binding.binding,
  39408. rootUuid = propBinding.rootNode.uuid,
  39409. trackName = propBinding.path,
  39410. bindingsByRoot = this._bindingsByRootAndName,
  39411. bindingByName = bindingsByRoot[ rootUuid ],
  39412. lastInactiveBinding = bindings[ bindings.length - 1 ],
  39413. cacheIndex = binding._cacheIndex;
  39414. lastInactiveBinding._cacheIndex = cacheIndex;
  39415. bindings[ cacheIndex ] = lastInactiveBinding;
  39416. bindings.pop();
  39417. delete bindingByName[ trackName ];
  39418. if ( Object.keys( bindingByName ).length === 0 ) {
  39419. delete bindingsByRoot[ rootUuid ];
  39420. }
  39421. }
  39422. _lendBinding( binding ) {
  39423. const bindings = this._bindings,
  39424. prevIndex = binding._cacheIndex,
  39425. lastActiveIndex = this._nActiveBindings ++,
  39426. firstInactiveBinding = bindings[ lastActiveIndex ];
  39427. binding._cacheIndex = lastActiveIndex;
  39428. bindings[ lastActiveIndex ] = binding;
  39429. firstInactiveBinding._cacheIndex = prevIndex;
  39430. bindings[ prevIndex ] = firstInactiveBinding;
  39431. }
  39432. _takeBackBinding( binding ) {
  39433. const bindings = this._bindings,
  39434. prevIndex = binding._cacheIndex,
  39435. firstInactiveIndex = -- this._nActiveBindings,
  39436. lastActiveBinding = bindings[ firstInactiveIndex ];
  39437. binding._cacheIndex = firstInactiveIndex;
  39438. bindings[ firstInactiveIndex ] = binding;
  39439. lastActiveBinding._cacheIndex = prevIndex;
  39440. bindings[ prevIndex ] = lastActiveBinding;
  39441. }
  39442. // Memory management of Interpolants for weight and time scale
  39443. _lendControlInterpolant() {
  39444. const interpolants = this._controlInterpolants,
  39445. lastActiveIndex = this._nActiveControlInterpolants ++;
  39446. let interpolant = interpolants[ lastActiveIndex ];
  39447. if ( interpolant === undefined ) {
  39448. interpolant = new LinearInterpolant(
  39449. new Float32Array( 2 ), new Float32Array( 2 ),
  39450. 1, _controlInterpolantsResultBuffer );
  39451. interpolant.__cacheIndex = lastActiveIndex;
  39452. interpolants[ lastActiveIndex ] = interpolant;
  39453. }
  39454. return interpolant;
  39455. }
  39456. _takeBackControlInterpolant( interpolant ) {
  39457. const interpolants = this._controlInterpolants,
  39458. prevIndex = interpolant.__cacheIndex,
  39459. firstInactiveIndex = -- this._nActiveControlInterpolants,
  39460. lastActiveInterpolant = interpolants[ firstInactiveIndex ];
  39461. interpolant.__cacheIndex = firstInactiveIndex;
  39462. interpolants[ firstInactiveIndex ] = interpolant;
  39463. lastActiveInterpolant.__cacheIndex = prevIndex;
  39464. interpolants[ prevIndex ] = lastActiveInterpolant;
  39465. }
  39466. /**
  39467. * Returns an instance of {@link AnimationAction} for the passed clip.
  39468. *
  39469. * If an action fitting the clip and root parameters doesn't yet exist, it
  39470. * will be created by this method. Calling this method several times with the
  39471. * same clip and root parameters always returns the same action.
  39472. *
  39473. * @param {AnimationClip|string} clip - An animation clip or alternatively the name of the animation clip.
  39474. * @param {Object3D} [optionalRoot] - An alternative root object.
  39475. * @param {(NormalAnimationBlendMode|AdditiveAnimationBlendMode)} [blendMode] - The blend mode.
  39476. * @return {?AnimationAction} The animation action.
  39477. */
  39478. clipAction( clip, optionalRoot, blendMode ) {
  39479. const root = optionalRoot || this._root,
  39480. rootUuid = root.uuid;
  39481. let clipObject = typeof clip === 'string' ? AnimationClip.findByName( root, clip ) : clip;
  39482. const clipUuid = clipObject !== null ? clipObject.uuid : clip;
  39483. const actionsForClip = this._actionsByClip[ clipUuid ];
  39484. let prototypeAction = null;
  39485. if ( blendMode === undefined ) {
  39486. if ( clipObject !== null ) {
  39487. blendMode = clipObject.blendMode;
  39488. } else {
  39489. blendMode = NormalAnimationBlendMode;
  39490. }
  39491. }
  39492. if ( actionsForClip !== undefined ) {
  39493. const existingAction = actionsForClip.actionByRoot[ rootUuid ];
  39494. if ( existingAction !== undefined && existingAction.blendMode === blendMode ) {
  39495. return existingAction;
  39496. }
  39497. // we know the clip, so we don't have to parse all
  39498. // the bindings again but can just copy
  39499. prototypeAction = actionsForClip.knownActions[ 0 ];
  39500. // also, take the clip from the prototype action
  39501. if ( clipObject === null )
  39502. clipObject = prototypeAction._clip;
  39503. }
  39504. // clip must be known when specified via string
  39505. if ( clipObject === null ) return null;
  39506. // allocate all resources required to run it
  39507. const newAction = new AnimationAction( this, clipObject, optionalRoot, blendMode );
  39508. this._bindAction( newAction, prototypeAction );
  39509. // and make the action known to the memory manager
  39510. this._addInactiveAction( newAction, clipUuid, rootUuid );
  39511. return newAction;
  39512. }
  39513. /**
  39514. * Returns an existing animation action for the passed clip.
  39515. *
  39516. * @param {AnimationClip|string} clip - An animation clip or alternatively the name of the animation clip.
  39517. * @param {Object3D} [optionalRoot] - An alternative root object.
  39518. * @return {?AnimationAction} The animation action. Returns `null` if no action was found.
  39519. */
  39520. existingAction( clip, optionalRoot ) {
  39521. const root = optionalRoot || this._root,
  39522. rootUuid = root.uuid,
  39523. clipObject = typeof clip === 'string' ?
  39524. AnimationClip.findByName( root, clip ) : clip,
  39525. clipUuid = clipObject ? clipObject.uuid : clip,
  39526. actionsForClip = this._actionsByClip[ clipUuid ];
  39527. if ( actionsForClip !== undefined ) {
  39528. return actionsForClip.actionByRoot[ rootUuid ] || null;
  39529. }
  39530. return null;
  39531. }
  39532. /**
  39533. * Deactivates all previously scheduled actions on this mixer.
  39534. *
  39535. * @return {AnimationMixer} A reference to this animation mixer.
  39536. */
  39537. stopAllAction() {
  39538. const actions = this._actions,
  39539. nActions = this._nActiveActions;
  39540. for ( let i = nActions - 1; i >= 0; -- i ) {
  39541. actions[ i ].stop();
  39542. }
  39543. return this;
  39544. }
  39545. /**
  39546. * Advances the global mixer time and updates the animation.
  39547. *
  39548. * This is usually done in the render loop by passing the delta
  39549. * time from {@link Clock} or {@link Timer}.
  39550. *
  39551. * @param {number} deltaTime - The delta time in seconds.
  39552. * @return {AnimationMixer} A reference to this animation mixer.
  39553. */
  39554. update( deltaTime ) {
  39555. deltaTime *= this.timeScale;
  39556. const actions = this._actions,
  39557. nActions = this._nActiveActions,
  39558. time = this.time += deltaTime,
  39559. timeDirection = Math.sign( deltaTime ),
  39560. accuIndex = this._accuIndex ^= 1;
  39561. // run active actions
  39562. for ( let i = 0; i !== nActions; ++ i ) {
  39563. const action = actions[ i ];
  39564. action._update( time, deltaTime, timeDirection, accuIndex );
  39565. }
  39566. // update scene graph
  39567. const bindings = this._bindings,
  39568. nBindings = this._nActiveBindings;
  39569. for ( let i = 0; i !== nBindings; ++ i ) {
  39570. bindings[ i ].apply( accuIndex );
  39571. }
  39572. return this;
  39573. }
  39574. /**
  39575. * Sets the global mixer to a specific time and updates the animation accordingly.
  39576. *
  39577. * This is useful when you need to jump to an exact time in an animation. The
  39578. * input parameter will be scaled by {@link AnimationMixer#timeScale}
  39579. *
  39580. * @param {number} time - The time to set in seconds.
  39581. * @return {AnimationMixer} A reference to this animation mixer.
  39582. */
  39583. setTime( time ) {
  39584. this.time = 0; // Zero out time attribute for AnimationMixer object;
  39585. for ( let i = 0; i < this._actions.length; i ++ ) {
  39586. this._actions[ i ].time = 0; // Zero out time attribute for all associated AnimationAction objects.
  39587. }
  39588. return this.update( time ); // Update used to set exact time. Returns "this" AnimationMixer object.
  39589. }
  39590. /**
  39591. * Returns this mixer's root object.
  39592. *
  39593. * @return {Object3D} The mixer's root object.
  39594. */
  39595. getRoot() {
  39596. return this._root;
  39597. }
  39598. /**
  39599. * Deallocates all memory resources for a clip. Before using this method make
  39600. * sure to call {@link AnimationAction#stop} for all related actions.
  39601. *
  39602. * @param {AnimationClip} clip - The clip to uncache.
  39603. */
  39604. uncacheClip( clip ) {
  39605. const actions = this._actions,
  39606. clipUuid = clip.uuid,
  39607. actionsByClip = this._actionsByClip,
  39608. actionsForClip = actionsByClip[ clipUuid ];
  39609. if ( actionsForClip !== undefined ) {
  39610. // note: just calling _removeInactiveAction would mess up the
  39611. // iteration state and also require updating the state we can
  39612. // just throw away
  39613. const actionsToRemove = actionsForClip.knownActions;
  39614. for ( let i = 0, n = actionsToRemove.length; i !== n; ++ i ) {
  39615. const action = actionsToRemove[ i ];
  39616. this._deactivateAction( action );
  39617. const cacheIndex = action._cacheIndex,
  39618. lastInactiveAction = actions[ actions.length - 1 ];
  39619. action._cacheIndex = null;
  39620. action._byClipCacheIndex = null;
  39621. lastInactiveAction._cacheIndex = cacheIndex;
  39622. actions[ cacheIndex ] = lastInactiveAction;
  39623. actions.pop();
  39624. this._removeInactiveBindingsForAction( action );
  39625. }
  39626. delete actionsByClip[ clipUuid ];
  39627. }
  39628. }
  39629. /**
  39630. * Deallocates all memory resources for a root object. Before using this
  39631. * method make sure to call {@link AnimationAction#stop} for all related
  39632. * actions or alternatively {@link AnimationMixer#stopAllAction} when the
  39633. * mixer operates on a single root.
  39634. *
  39635. * @param {Object3D} root - The root object to uncache.
  39636. */
  39637. uncacheRoot( root ) {
  39638. const rootUuid = root.uuid,
  39639. actionsByClip = this._actionsByClip;
  39640. for ( const clipUuid in actionsByClip ) {
  39641. const actionByRoot = actionsByClip[ clipUuid ].actionByRoot,
  39642. action = actionByRoot[ rootUuid ];
  39643. if ( action !== undefined ) {
  39644. this._deactivateAction( action );
  39645. this._removeInactiveAction( action );
  39646. }
  39647. }
  39648. const bindingsByRoot = this._bindingsByRootAndName,
  39649. bindingByName = bindingsByRoot[ rootUuid ];
  39650. if ( bindingByName !== undefined ) {
  39651. for ( const trackName in bindingByName ) {
  39652. const binding = bindingByName[ trackName ];
  39653. binding.restoreOriginalState();
  39654. this._removeInactiveBinding( binding );
  39655. }
  39656. }
  39657. }
  39658. /**
  39659. * Deallocates all memory resources for an action. The action is identified by the
  39660. * given clip and an optional root object. Before using this method make
  39661. * sure to call {@link AnimationAction#stop} to deactivate the action.
  39662. *
  39663. * @param {AnimationClip|string} clip - An animation clip or alternatively the name of the animation clip.
  39664. * @param {Object3D} [optionalRoot] - An alternative root object.
  39665. */
  39666. uncacheAction( clip, optionalRoot ) {
  39667. const action = this.existingAction( clip, optionalRoot );
  39668. if ( action !== null ) {
  39669. this._deactivateAction( action );
  39670. this._removeInactiveAction( action );
  39671. }
  39672. }
  39673. }
  39674. /**
  39675. * Represents a 3D render target.
  39676. *
  39677. * @augments RenderTarget
  39678. */
  39679. class RenderTarget3D extends RenderTarget {
  39680. /**
  39681. * Constructs a new 3D render target.
  39682. *
  39683. * @param {number} [width=1] - The width of the render target.
  39684. * @param {number} [height=1] - The height of the render target.
  39685. * @param {number} [depth=1] - The height of the render target.
  39686. * @param {RenderTarget~Options} [options] - The configuration object.
  39687. */
  39688. constructor( width = 1, height = 1, depth = 1, options = {} ) {
  39689. super( width, height, options );
  39690. /**
  39691. * This flag can be used for type testing.
  39692. *
  39693. * @type {boolean}
  39694. * @readonly
  39695. * @default true
  39696. */
  39697. this.isRenderTarget3D = true;
  39698. this.depth = depth;
  39699. /**
  39700. * Overwritten with a different texture type.
  39701. *
  39702. * @type {Data3DTexture}
  39703. */
  39704. this.texture = new Data3DTexture( null, width, height, depth );
  39705. this._setTextureOptions( options );
  39706. this.texture.isRenderTargetTexture = true;
  39707. }
  39708. }
  39709. /**
  39710. * Represents a uniform which is a global shader variable. They are passed to shader programs.
  39711. *
  39712. * When declaring a uniform of a {@link ShaderMaterial}, it is declared by value or by object.
  39713. * ```js
  39714. * uniforms: {
  39715. * time: { value: 1.0 },
  39716. * resolution: new Uniform( new Vector2() )
  39717. * };
  39718. * ```
  39719. * Since this class can only be used in context of {@link ShaderMaterial}, it is only supported
  39720. * in {@link WebGLRenderer}.
  39721. */
  39722. class Uniform {
  39723. /**
  39724. * Constructs a new uniform.
  39725. *
  39726. * @param {any} value - The uniform value.
  39727. */
  39728. constructor( value ) {
  39729. /**
  39730. * The uniform value.
  39731. *
  39732. * @type {any}
  39733. */
  39734. this.value = value;
  39735. }
  39736. /**
  39737. * Returns a new uniform with copied values from this instance.
  39738. * If the value has a `clone()` method, the value is cloned as well.
  39739. *
  39740. * @return {Uniform} A clone of this instance.
  39741. */
  39742. clone() {
  39743. return new Uniform( this.value.clone === undefined ? this.value : this.value.clone() );
  39744. }
  39745. }
  39746. let _id = 0;
  39747. /**
  39748. * A class for managing multiple uniforms in a single group. The renderer will process
  39749. * such a definition as a single UBO.
  39750. *
  39751. * Since this class can only be used in context of {@link ShaderMaterial}, it is only supported
  39752. * in {@link WebGLRenderer}.
  39753. *
  39754. * @augments EventDispatcher
  39755. */
  39756. class UniformsGroup extends EventDispatcher {
  39757. /**
  39758. * Constructs a new uniforms group.
  39759. */
  39760. constructor() {
  39761. super();
  39762. /**
  39763. * This flag can be used for type testing.
  39764. *
  39765. * @type {boolean}
  39766. * @readonly
  39767. * @default true
  39768. */
  39769. this.isUniformsGroup = true;
  39770. /**
  39771. * The ID of the 3D object.
  39772. *
  39773. * @name UniformsGroup#id
  39774. * @type {number}
  39775. * @readonly
  39776. */
  39777. Object.defineProperty( this, 'id', { value: _id ++ } );
  39778. /**
  39779. * The name of the uniforms group.
  39780. *
  39781. * @type {string}
  39782. */
  39783. this.name = '';
  39784. /**
  39785. * The buffer usage.
  39786. *
  39787. * @type {(StaticDrawUsage|DynamicDrawUsage|StreamDrawUsage|StaticReadUsage|DynamicReadUsage|StreamReadUsage|StaticCopyUsage|DynamicCopyUsage|StreamCopyUsage)}
  39788. * @default StaticDrawUsage
  39789. */
  39790. this.usage = StaticDrawUsage;
  39791. /**
  39792. * An array holding the uniforms.
  39793. *
  39794. * @type {Array<Uniform>}
  39795. */
  39796. this.uniforms = [];
  39797. }
  39798. /**
  39799. * Adds the given uniform to this uniforms group.
  39800. *
  39801. * @param {Uniform} uniform - The uniform to add.
  39802. * @return {UniformsGroup} A reference to this uniforms group.
  39803. */
  39804. add( uniform ) {
  39805. this.uniforms.push( uniform );
  39806. return this;
  39807. }
  39808. /**
  39809. * Removes the given uniform from this uniforms group.
  39810. *
  39811. * @param {Uniform} uniform - The uniform to remove.
  39812. * @return {UniformsGroup} A reference to this uniforms group.
  39813. */
  39814. remove( uniform ) {
  39815. const index = this.uniforms.indexOf( uniform );
  39816. if ( index !== -1 ) this.uniforms.splice( index, 1 );
  39817. return this;
  39818. }
  39819. /**
  39820. * Sets the name of this uniforms group.
  39821. *
  39822. * @param {string} name - The name to set.
  39823. * @return {UniformsGroup} A reference to this uniforms group.
  39824. */
  39825. setName( name ) {
  39826. this.name = name;
  39827. return this;
  39828. }
  39829. /**
  39830. * Sets the usage of this uniforms group.
  39831. *
  39832. * @param {(StaticDrawUsage|DynamicDrawUsage|StreamDrawUsage|StaticReadUsage|DynamicReadUsage|StreamReadUsage|StaticCopyUsage|DynamicCopyUsage|StreamCopyUsage)} value - The usage to set.
  39833. * @return {UniformsGroup} A reference to this uniforms group.
  39834. */
  39835. setUsage( value ) {
  39836. this.usage = value;
  39837. return this;
  39838. }
  39839. /**
  39840. * Frees the GPU-related resources allocated by this instance. Call this
  39841. * method whenever this instance is no longer used in your app.
  39842. *
  39843. * @fires Texture#dispose
  39844. */
  39845. dispose() {
  39846. this.dispatchEvent( { type: 'dispose' } );
  39847. }
  39848. /**
  39849. * Copies the values of the given uniforms group to this instance.
  39850. *
  39851. * @param {UniformsGroup} source - The uniforms group to copy.
  39852. * @return {UniformsGroup} A reference to this uniforms group.
  39853. */
  39854. copy( source ) {
  39855. this.name = source.name;
  39856. this.usage = source.usage;
  39857. const uniformsSource = source.uniforms;
  39858. this.uniforms.length = 0;
  39859. for ( let i = 0, l = uniformsSource.length; i < l; i ++ ) {
  39860. const uniforms = Array.isArray( uniformsSource[ i ] ) ? uniformsSource[ i ] : [ uniformsSource[ i ] ];
  39861. for ( let j = 0; j < uniforms.length; j ++ ) {
  39862. this.uniforms.push( uniforms[ j ].clone() );
  39863. }
  39864. }
  39865. return this;
  39866. }
  39867. /**
  39868. * Returns a new uniforms group with copied values from this instance.
  39869. *
  39870. * @return {UniformsGroup} A clone of this instance.
  39871. */
  39872. clone() {
  39873. return new this.constructor().copy( this );
  39874. }
  39875. }
  39876. /**
  39877. * An instanced version of an interleaved buffer.
  39878. *
  39879. * @augments InterleavedBuffer
  39880. */
  39881. class InstancedInterleavedBuffer extends InterleavedBuffer {
  39882. /**
  39883. * Constructs a new instanced interleaved buffer.
  39884. *
  39885. * @param {TypedArray} array - A typed array with a shared buffer storing attribute data.
  39886. * @param {number} stride - The number of typed-array elements per vertex.
  39887. * @param {number} [meshPerAttribute=1] - Defines how often a value of this interleaved buffer should be repeated.
  39888. */
  39889. constructor( array, stride, meshPerAttribute = 1 ) {
  39890. super( array, stride );
  39891. /**
  39892. * This flag can be used for type testing.
  39893. *
  39894. * @type {boolean}
  39895. * @readonly
  39896. * @default true
  39897. */
  39898. this.isInstancedInterleavedBuffer = true;
  39899. /**
  39900. * Defines how often a value of this buffer attribute should be repeated,
  39901. * see {@link InstancedBufferAttribute#meshPerAttribute}.
  39902. *
  39903. * @type {number}
  39904. * @default 1
  39905. */
  39906. this.meshPerAttribute = meshPerAttribute;
  39907. }
  39908. copy( source ) {
  39909. super.copy( source );
  39910. this.meshPerAttribute = source.meshPerAttribute;
  39911. return this;
  39912. }
  39913. clone( data ) {
  39914. const ib = super.clone( data );
  39915. ib.meshPerAttribute = this.meshPerAttribute;
  39916. return ib;
  39917. }
  39918. toJSON( data ) {
  39919. const json = super.toJSON( data );
  39920. json.isInstancedInterleavedBuffer = true;
  39921. json.meshPerAttribute = this.meshPerAttribute;
  39922. return json;
  39923. }
  39924. }
  39925. /**
  39926. * An alternative version of a buffer attribute with more control over the VBO.
  39927. *
  39928. * The renderer does not construct a VBO for this kind of attribute. Instead, it uses
  39929. * whatever VBO is passed in constructor and can later be altered via the `buffer` property.
  39930. *
  39931. * The most common use case for this class is when some kind of GPGPU calculation interferes
  39932. * or even produces the VBOs in question.
  39933. *
  39934. * Notice that this class can only be used with {@link WebGLRenderer}.
  39935. */
  39936. class GLBufferAttribute {
  39937. /**
  39938. * Constructs a new GL buffer attribute.
  39939. *
  39940. * @param {WebGLBuffer} buffer - The native WebGL buffer.
  39941. * @param {number} type - The native data type (e.g. `gl.FLOAT`).
  39942. * @param {number} itemSize - The item size.
  39943. * @param {number} elementSize - The corresponding size (in bytes) for the given `type` parameter.
  39944. * @param {number} count - The expected number of vertices in VBO.
  39945. * @param {boolean} [normalized=false] - Whether the data are normalized or not.
  39946. */
  39947. constructor( buffer, type, itemSize, elementSize, count, normalized = false ) {
  39948. /**
  39949. * This flag can be used for type testing.
  39950. *
  39951. * @type {boolean}
  39952. * @readonly
  39953. * @default true
  39954. */
  39955. this.isGLBufferAttribute = true;
  39956. /**
  39957. * The name of the buffer attribute.
  39958. *
  39959. * @type {string}
  39960. */
  39961. this.name = '';
  39962. /**
  39963. * The native WebGL buffer.
  39964. *
  39965. * @type {WebGLBuffer}
  39966. */
  39967. this.buffer = buffer;
  39968. /**
  39969. * The native data type.
  39970. *
  39971. * @type {number}
  39972. */
  39973. this.type = type;
  39974. /**
  39975. * The item size, see {@link BufferAttribute#itemSize}.
  39976. *
  39977. * @type {number}
  39978. */
  39979. this.itemSize = itemSize;
  39980. /**
  39981. * The corresponding size (in bytes) for the given `type` parameter.
  39982. *
  39983. * @type {number}
  39984. */
  39985. this.elementSize = elementSize;
  39986. /**
  39987. * The expected number of vertices in VBO.
  39988. *
  39989. * @type {number}
  39990. */
  39991. this.count = count;
  39992. /**
  39993. * Applies to integer data only. Indicates how the underlying data in the buffer maps to
  39994. * the values in the GLSL code. For instance, if `buffer` contains data of `gl.UNSIGNED_SHORT`,
  39995. * and `normalized` is `true`, the values `0 - +65535` in the buffer data will be mapped to
  39996. * `0.0f - +1.0f` in the GLSL attribute. If `normalized` is `false`, the values will be converted
  39997. * to floats unmodified, i.e. `65535` becomes `65535.0f`.
  39998. *
  39999. * @type {boolean}
  40000. */
  40001. this.normalized = normalized;
  40002. /**
  40003. * A version number, incremented every time the `needsUpdate` is set to `true`.
  40004. *
  40005. * @type {number}
  40006. */
  40007. this.version = 0;
  40008. }
  40009. /**
  40010. * Flag to indicate that this attribute has changed and should be re-sent to
  40011. * the GPU. Set this to `true` when you modify the value of the array.
  40012. *
  40013. * @type {number}
  40014. * @default false
  40015. * @param {boolean} value
  40016. */
  40017. set needsUpdate( value ) {
  40018. if ( value === true ) this.version ++;
  40019. }
  40020. /**
  40021. * Sets the given native WebGL buffer.
  40022. *
  40023. * @param {WebGLBuffer} buffer - The buffer to set.
  40024. * @return {BufferAttribute} A reference to this instance.
  40025. */
  40026. setBuffer( buffer ) {
  40027. this.buffer = buffer;
  40028. return this;
  40029. }
  40030. /**
  40031. * Sets the given native data type and element size.
  40032. *
  40033. * @param {number} type - The native data type (e.g. `gl.FLOAT`).
  40034. * @param {number} elementSize - The corresponding size (in bytes) for the given `type` parameter.
  40035. * @return {BufferAttribute} A reference to this instance.
  40036. */
  40037. setType( type, elementSize ) {
  40038. this.type = type;
  40039. this.elementSize = elementSize;
  40040. return this;
  40041. }
  40042. /**
  40043. * Sets the item size.
  40044. *
  40045. * @param {number} itemSize - The item size.
  40046. * @return {BufferAttribute} A reference to this instance.
  40047. */
  40048. setItemSize( itemSize ) {
  40049. this.itemSize = itemSize;
  40050. return this;
  40051. }
  40052. /**
  40053. * Sets the count (the expected number of vertices in VBO).
  40054. *
  40055. * @param {number} count - The count.
  40056. * @return {BufferAttribute} A reference to this instance.
  40057. */
  40058. setCount( count ) {
  40059. this.count = count;
  40060. return this;
  40061. }
  40062. }
  40063. const _matrix = /*@__PURE__*/ new Matrix4();
  40064. /**
  40065. * This class is designed to assist with raycasting. Raycasting is used for
  40066. * mouse picking (working out what objects in the 3d space the mouse is over)
  40067. * amongst other things.
  40068. */
  40069. class Raycaster {
  40070. /**
  40071. * Constructs a new raycaster.
  40072. *
  40073. * @param {Vector3} origin - The origin vector where the ray casts from.
  40074. * @param {Vector3} direction - The (normalized) direction vector that gives direction to the ray.
  40075. * @param {number} [near=0] - All results returned are further away than near. Near can't be negative.
  40076. * @param {number} [far=Infinity] - All results returned are closer than far. Far can't be lower than near.
  40077. */
  40078. constructor( origin, direction, near = 0, far = Infinity ) {
  40079. /**
  40080. * The ray used for raycasting.
  40081. *
  40082. * @type {Ray}
  40083. */
  40084. this.ray = new Ray( origin, direction );
  40085. /**
  40086. * All results returned are further away than near. Near can't be negative.
  40087. *
  40088. * @type {number}
  40089. * @default 0
  40090. */
  40091. this.near = near;
  40092. /**
  40093. * All results returned are closer than far. Far can't be lower than near.
  40094. *
  40095. * @type {number}
  40096. * @default Infinity
  40097. */
  40098. this.far = far;
  40099. /**
  40100. * The camera to use when raycasting against view-dependent objects such as
  40101. * billboarded objects like sprites. This field can be set manually or
  40102. * is set when calling `setFromCamera()`.
  40103. *
  40104. * @type {?Camera}
  40105. * @default null
  40106. */
  40107. this.camera = null;
  40108. /**
  40109. * Allows to selectively ignore 3D objects when performing intersection tests.
  40110. * The following code example ensures that only 3D objects on layer `1` will be
  40111. * honored by raycaster.
  40112. * ```js
  40113. * raycaster.layers.set( 1 );
  40114. * object.layers.enable( 1 );
  40115. * ```
  40116. *
  40117. * @type {Layers}
  40118. */
  40119. this.layers = new Layers();
  40120. /**
  40121. * A parameter object that configures the raycasting. It has the structure:
  40122. *
  40123. * ```
  40124. * {
  40125. * Mesh: {},
  40126. * Line: { threshold: 1 },
  40127. * LOD: {},
  40128. * Points: { threshold: 1 },
  40129. * Sprite: {}
  40130. * }
  40131. * ```
  40132. * Where `threshold` is the precision of the raycaster when intersecting objects, in world units.
  40133. *
  40134. * @type {Object}
  40135. */
  40136. this.params = {
  40137. Mesh: {},
  40138. Line: { threshold: 1 },
  40139. LOD: {},
  40140. Points: { threshold: 1 },
  40141. Sprite: {}
  40142. };
  40143. }
  40144. /**
  40145. * Updates the ray with a new origin and direction by copying the values from the arguments.
  40146. *
  40147. * @param {Vector3} origin - The origin vector where the ray casts from.
  40148. * @param {Vector3} direction - The (normalized) direction vector that gives direction to the ray.
  40149. */
  40150. set( origin, direction ) {
  40151. // direction is assumed to be normalized (for accurate distance calculations)
  40152. this.ray.set( origin, direction );
  40153. }
  40154. /**
  40155. * Uses the given coordinates and camera to compute a new origin and direction for the internal ray.
  40156. *
  40157. * @param {Vector2} coords - 2D coordinates of the mouse, in normalized device coordinates (NDC).
  40158. * X and Y components should be between `-1` and `1`.
  40159. * @param {Camera} camera - The camera from which the ray should originate.
  40160. */
  40161. setFromCamera( coords, camera ) {
  40162. if ( camera.isPerspectiveCamera ) {
  40163. this.ray.origin.setFromMatrixPosition( camera.matrixWorld );
  40164. this.ray.direction.set( coords.x, coords.y, 0.5 ).unproject( camera ).sub( this.ray.origin ).normalize();
  40165. this.camera = camera;
  40166. } else if ( camera.isOrthographicCamera ) {
  40167. this.ray.origin.set( coords.x, coords.y, ( camera.near + camera.far ) / ( camera.near - camera.far ) ).unproject( camera ); // set origin in plane of camera
  40168. this.ray.direction.set( 0, 0, -1 ).transformDirection( camera.matrixWorld );
  40169. this.camera = camera;
  40170. } else {
  40171. error( 'Raycaster: Unsupported camera type: ' + camera.type );
  40172. }
  40173. }
  40174. /**
  40175. * Uses the given WebXR controller to compute a new origin and direction for the internal ray.
  40176. *
  40177. * @param {WebXRController} controller - The controller to copy the position and direction from.
  40178. * @return {Raycaster} A reference to this raycaster.
  40179. */
  40180. setFromXRController( controller ) {
  40181. _matrix.identity().extractRotation( controller.matrixWorld );
  40182. this.ray.origin.setFromMatrixPosition( controller.matrixWorld );
  40183. this.ray.direction.set( 0, 0, -1 ).applyMatrix4( _matrix );
  40184. return this;
  40185. }
  40186. /**
  40187. * The intersection point of a raycaster intersection test.
  40188. * @typedef {Object} Raycaster~Intersection
  40189. * @property {number} distance - The distance from the ray's origin to the intersection point.
  40190. * @property {number} distanceToRay - Some 3D objects e.g. {@link Points} provide the distance of the
  40191. * intersection to the nearest point on the ray. For other objects it will be `undefined`.
  40192. * @property {Vector3} point - The intersection point, in world coordinates.
  40193. * @property {Object} face - The face that has been intersected.
  40194. * @property {number} faceIndex - The face index.
  40195. * @property {Object3D} object - The 3D object that has been intersected.
  40196. * @property {Vector2} uv - U,V coordinates at point of intersection.
  40197. * @property {Vector2} uv1 - Second set of U,V coordinates at point of intersection.
  40198. * @property {Vector3} normal - Interpolated normal vector at point of intersection.
  40199. * @property {number} instanceId - The index number of the instance where the ray
  40200. * intersects the {@link InstancedMesh}.
  40201. */
  40202. /**
  40203. * Checks all intersection between the ray and the object with or without the
  40204. * descendants. Intersections are returned sorted by distance, closest first.
  40205. *
  40206. * `Raycaster` delegates to the `raycast()` method of the passed 3D object, when
  40207. * evaluating whether the ray intersects the object or not. This allows meshes to respond
  40208. * differently to ray casting than lines or points.
  40209. *
  40210. * Note that for meshes, faces must be pointed towards the origin of the ray in order
  40211. * to be detected; intersections of the ray passing through the back of a face will not
  40212. * be detected. To raycast against both faces of an object, you'll want to set {@link Material#side}
  40213. * to `THREE.DoubleSide`.
  40214. *
  40215. * @param {Object3D} object - The 3D object to check for intersection with the ray.
  40216. * @param {boolean} [recursive=true] - If set to `true`, it also checks all descendants.
  40217. * Otherwise it only checks intersection with the object.
  40218. * @param {Array<Raycaster~Intersection>} [intersects=[]] The target array that holds the result of the method.
  40219. * @return {Array<Raycaster~Intersection>} An array holding the intersection points.
  40220. */
  40221. intersectObject( object, recursive = true, intersects = [] ) {
  40222. intersect( object, this, intersects, recursive );
  40223. intersects.sort( ascSort );
  40224. return intersects;
  40225. }
  40226. /**
  40227. * Checks all intersection between the ray and the objects with or without
  40228. * the descendants. Intersections are returned sorted by distance, closest first.
  40229. *
  40230. * @param {Array<Object3D>} objects - The 3D objects to check for intersection with the ray.
  40231. * @param {boolean} [recursive=true] - If set to `true`, it also checks all descendants.
  40232. * Otherwise it only checks intersection with the object.
  40233. * @param {Array<Raycaster~Intersection>} [intersects=[]] The target array that holds the result of the method.
  40234. * @return {Array<Raycaster~Intersection>} An array holding the intersection points.
  40235. */
  40236. intersectObjects( objects, recursive = true, intersects = [] ) {
  40237. for ( let i = 0, l = objects.length; i < l; i ++ ) {
  40238. intersect( objects[ i ], this, intersects, recursive );
  40239. }
  40240. intersects.sort( ascSort );
  40241. return intersects;
  40242. }
  40243. }
  40244. function ascSort( a, b ) {
  40245. return a.distance - b.distance;
  40246. }
  40247. function intersect( object, raycaster, intersects, recursive ) {
  40248. let propagate = true;
  40249. if ( object.layers.test( raycaster.layers ) ) {
  40250. const result = object.raycast( raycaster, intersects );
  40251. if ( result === false ) propagate = false;
  40252. }
  40253. if ( propagate === true && recursive === true ) {
  40254. const children = object.children;
  40255. for ( let i = 0, l = children.length; i < l; i ++ ) {
  40256. intersect( children[ i ], raycaster, intersects, true );
  40257. }
  40258. }
  40259. }
  40260. /**
  40261. * This class is an alternative to {@link Clock} with a different API design and behavior.
  40262. * The goal is to avoid the conceptual flaws that became apparent in `Clock` over time.
  40263. *
  40264. * - `Timer` has an `update()` method that updates its internal state. That makes it possible to
  40265. * call `getDelta()` and `getElapsed()` multiple times per simulation step without getting different values.
  40266. * - The class can make use of the Page Visibility API to avoid large time delta values when the app
  40267. * is inactive (e.g. tab switched or browser hidden).
  40268. *
  40269. * ```js
  40270. * const timer = new Timer();
  40271. * timer.connect( document ); // use Page Visibility API
  40272. * ```
  40273. */
  40274. class Timer {
  40275. /**
  40276. * Constructs a new timer.
  40277. */
  40278. constructor() {
  40279. this._previousTime = 0;
  40280. this._currentTime = 0;
  40281. this._startTime = performance.now();
  40282. this._delta = 0;
  40283. this._elapsed = 0;
  40284. this._timescale = 1;
  40285. this._document = null;
  40286. this._pageVisibilityHandler = null;
  40287. }
  40288. /**
  40289. * Connect the timer to the given document.Calling this method is not mandatory to
  40290. * use the timer but enables the usage of the Page Visibility API to avoid large time
  40291. * delta values.
  40292. *
  40293. * @param {Document} document - The document.
  40294. */
  40295. connect( document ) {
  40296. this._document = document;
  40297. // use Page Visibility API to avoid large time delta values
  40298. if ( document.hidden !== undefined ) {
  40299. this._pageVisibilityHandler = handleVisibilityChange.bind( this );
  40300. document.addEventListener( 'visibilitychange', this._pageVisibilityHandler, false );
  40301. }
  40302. }
  40303. /**
  40304. * Disconnects the timer from the DOM and also disables the usage of the Page Visibility API.
  40305. */
  40306. disconnect() {
  40307. if ( this._pageVisibilityHandler !== null ) {
  40308. this._document.removeEventListener( 'visibilitychange', this._pageVisibilityHandler );
  40309. this._pageVisibilityHandler = null;
  40310. }
  40311. this._document = null;
  40312. }
  40313. /**
  40314. * Returns the time delta in seconds.
  40315. *
  40316. * @return {number} The time delta in second.
  40317. */
  40318. getDelta() {
  40319. return this._delta / 1000;
  40320. }
  40321. /**
  40322. * Returns the elapsed time in seconds.
  40323. *
  40324. * @return {number} The elapsed time in second.
  40325. */
  40326. getElapsed() {
  40327. return this._elapsed / 1000;
  40328. }
  40329. /**
  40330. * Returns the timescale.
  40331. *
  40332. * @return {number} The timescale.
  40333. */
  40334. getTimescale() {
  40335. return this._timescale;
  40336. }
  40337. /**
  40338. * Sets the given timescale which scale the time delta computation
  40339. * in `update()`.
  40340. *
  40341. * @param {number} timescale - The timescale to set.
  40342. * @return {Timer} A reference to this timer.
  40343. */
  40344. setTimescale( timescale ) {
  40345. this._timescale = timescale;
  40346. return this;
  40347. }
  40348. /**
  40349. * Resets the time computation for the current simulation step.
  40350. *
  40351. * @return {Timer} A reference to this timer.
  40352. */
  40353. reset() {
  40354. this._currentTime = performance.now() - this._startTime;
  40355. return this;
  40356. }
  40357. /**
  40358. * Can be used to free all internal resources. Usually called when
  40359. * the timer instance isn't required anymore.
  40360. */
  40361. dispose() {
  40362. this.disconnect();
  40363. }
  40364. /**
  40365. * Updates the internal state of the timer. This method should be called
  40366. * once per simulation step and before you perform queries against the timer
  40367. * (e.g. via `getDelta()`).
  40368. *
  40369. * @param {number} timestamp - The current time in milliseconds. Can be obtained
  40370. * from the `requestAnimationFrame` callback argument. If not provided, the current
  40371. * time will be determined with `performance.now`.
  40372. * @return {Timer} A reference to this timer.
  40373. */
  40374. update( timestamp ) {
  40375. if ( this._pageVisibilityHandler !== null && this._document.hidden === true ) {
  40376. this._delta = 0;
  40377. } else {
  40378. this._previousTime = this._currentTime;
  40379. this._currentTime = ( timestamp !== undefined ? timestamp : performance.now() ) - this._startTime;
  40380. this._delta = ( this._currentTime - this._previousTime ) * this._timescale;
  40381. this._elapsed += this._delta; // _elapsed is the accumulation of all previous deltas
  40382. }
  40383. return this;
  40384. }
  40385. }
  40386. function handleVisibilityChange() {
  40387. if ( this._document.hidden === false ) this.reset();
  40388. }
  40389. /**
  40390. * This class can be used to represent points in 3D space as
  40391. * [Spherical coordinates](https://en.wikipedia.org/wiki/Spherical_coordinate_system).
  40392. */
  40393. class Spherical {
  40394. /**
  40395. * Constructs a new spherical.
  40396. *
  40397. * @param {number} [radius=1] - The radius, or the Euclidean distance (straight-line distance) from the point to the origin.
  40398. * @param {number} [phi=0] - The polar angle in radians from the y (up) axis.
  40399. * @param {number} [theta=0] - The equator/azimuthal angle in radians around the y (up) axis.
  40400. */
  40401. constructor( radius = 1, phi = 0, theta = 0 ) {
  40402. /**
  40403. * The radius, or the Euclidean distance (straight-line distance) from the point to the origin.
  40404. *
  40405. * @type {number}
  40406. * @default 1
  40407. */
  40408. this.radius = radius;
  40409. /**
  40410. * The polar angle in radians from the y (up) axis.
  40411. *
  40412. * @type {number}
  40413. * @default 0
  40414. */
  40415. this.phi = phi;
  40416. /**
  40417. * The equator/azimuthal angle in radians around the y (up) axis.
  40418. *
  40419. * @type {number}
  40420. * @default 0
  40421. */
  40422. this.theta = theta;
  40423. }
  40424. /**
  40425. * Sets the spherical components by copying the given values.
  40426. *
  40427. * @param {number} radius - The radius.
  40428. * @param {number} phi - The polar angle.
  40429. * @param {number} theta - The azimuthal angle.
  40430. * @return {Spherical} A reference to this spherical.
  40431. */
  40432. set( radius, phi, theta ) {
  40433. this.radius = radius;
  40434. this.phi = phi;
  40435. this.theta = theta;
  40436. return this;
  40437. }
  40438. /**
  40439. * Copies the values of the given spherical to this instance.
  40440. *
  40441. * @param {Spherical} other - The spherical to copy.
  40442. * @return {Spherical} A reference to this spherical.
  40443. */
  40444. copy( other ) {
  40445. this.radius = other.radius;
  40446. this.phi = other.phi;
  40447. this.theta = other.theta;
  40448. return this;
  40449. }
  40450. /**
  40451. * Restricts the polar angle [page:.phi phi] to be between `0.000001` and pi -
  40452. * `0.000001`.
  40453. *
  40454. * @return {Spherical} A reference to this spherical.
  40455. */
  40456. makeSafe() {
  40457. const EPS = 0.000001;
  40458. this.phi = clamp( this.phi, EPS, Math.PI - EPS );
  40459. return this;
  40460. }
  40461. /**
  40462. * Sets the spherical components from the given vector which is assumed to hold
  40463. * Cartesian coordinates.
  40464. *
  40465. * @param {Vector3} v - The vector to set.
  40466. * @return {Spherical} A reference to this spherical.
  40467. */
  40468. setFromVector3( v ) {
  40469. return this.setFromCartesianCoords( v.x, v.y, v.z );
  40470. }
  40471. /**
  40472. * Sets the spherical components from the given Cartesian coordinates.
  40473. *
  40474. * @param {number} x - The x value.
  40475. * @param {number} y - The y value.
  40476. * @param {number} z - The z value.
  40477. * @return {Spherical} A reference to this spherical.
  40478. */
  40479. setFromCartesianCoords( x, y, z ) {
  40480. this.radius = Math.sqrt( x * x + y * y + z * z );
  40481. if ( this.radius === 0 ) {
  40482. this.theta = 0;
  40483. this.phi = 0;
  40484. } else {
  40485. this.theta = Math.atan2( x, z );
  40486. this.phi = Math.acos( clamp( y / this.radius, -1, 1 ) );
  40487. }
  40488. return this;
  40489. }
  40490. /**
  40491. * Returns a new spherical with copied values from this instance.
  40492. *
  40493. * @return {Spherical} A clone of this instance.
  40494. */
  40495. clone() {
  40496. return new this.constructor().copy( this );
  40497. }
  40498. }
  40499. /**
  40500. * This class can be used to represent points in 3D space as
  40501. * [Cylindrical coordinates](https://en.wikipedia.org/wiki/Cylindrical_coordinate_system).
  40502. */
  40503. class Cylindrical {
  40504. /**
  40505. * Constructs a new cylindrical.
  40506. *
  40507. * @param {number} [radius=1] - The distance from the origin to a point in the x-z plane.
  40508. * @param {number} [theta=0] - A counterclockwise angle in the x-z plane measured in radians from the positive z-axis.
  40509. * @param {number} [y=0] - The height above the x-z plane.
  40510. */
  40511. constructor( radius = 1, theta = 0, y = 0 ) {
  40512. /**
  40513. * The distance from the origin to a point in the x-z plane.
  40514. *
  40515. * @type {number}
  40516. * @default 1
  40517. */
  40518. this.radius = radius;
  40519. /**
  40520. * A counterclockwise angle in the x-z plane measured in radians from the positive z-axis.
  40521. *
  40522. * @type {number}
  40523. * @default 0
  40524. */
  40525. this.theta = theta;
  40526. /**
  40527. * The height above the x-z plane.
  40528. *
  40529. * @type {number}
  40530. * @default 0
  40531. */
  40532. this.y = y;
  40533. }
  40534. /**
  40535. * Sets the cylindrical components by copying the given values.
  40536. *
  40537. * @param {number} radius - The radius.
  40538. * @param {number} theta - The theta angle.
  40539. * @param {number} y - The height value.
  40540. * @return {Cylindrical} A reference to this cylindrical.
  40541. */
  40542. set( radius, theta, y ) {
  40543. this.radius = radius;
  40544. this.theta = theta;
  40545. this.y = y;
  40546. return this;
  40547. }
  40548. /**
  40549. * Copies the values of the given cylindrical to this instance.
  40550. *
  40551. * @param {Cylindrical} other - The cylindrical to copy.
  40552. * @return {Cylindrical} A reference to this cylindrical.
  40553. */
  40554. copy( other ) {
  40555. this.radius = other.radius;
  40556. this.theta = other.theta;
  40557. this.y = other.y;
  40558. return this;
  40559. }
  40560. /**
  40561. * Sets the cylindrical components from the given vector which is assumed to hold
  40562. * Cartesian coordinates.
  40563. *
  40564. * @param {Vector3} v - The vector to set.
  40565. * @return {Cylindrical} A reference to this cylindrical.
  40566. */
  40567. setFromVector3( v ) {
  40568. return this.setFromCartesianCoords( v.x, v.y, v.z );
  40569. }
  40570. /**
  40571. * Sets the cylindrical components from the given Cartesian coordinates.
  40572. *
  40573. * @param {number} x - The x value.
  40574. * @param {number} y - The x value.
  40575. * @param {number} z - The x value.
  40576. * @return {Cylindrical} A reference to this cylindrical.
  40577. */
  40578. setFromCartesianCoords( x, y, z ) {
  40579. this.radius = Math.sqrt( x * x + z * z );
  40580. this.theta = Math.atan2( x, z );
  40581. this.y = y;
  40582. return this;
  40583. }
  40584. /**
  40585. * Returns a new cylindrical with copied values from this instance.
  40586. *
  40587. * @return {Cylindrical} A clone of this instance.
  40588. */
  40589. clone() {
  40590. return new this.constructor().copy( this );
  40591. }
  40592. }
  40593. /**
  40594. * Represents a 2x2 matrix.
  40595. *
  40596. * A Note on Row-Major and Column-Major Ordering:
  40597. *
  40598. * The constructor and {@link Matrix2#set} method take arguments in
  40599. * [row-major](https://en.wikipedia.org/wiki/Row-_and_column-major_order#Column-major_order)
  40600. * order, while internally they are stored in the {@link Matrix2#elements} array in column-major order.
  40601. * This means that calling:
  40602. * ```js
  40603. * const m = new THREE.Matrix2();
  40604. * m.set( 11, 12,
  40605. * 21, 22 );
  40606. * ```
  40607. * will result in the elements array containing:
  40608. * ```js
  40609. * m.elements = [ 11, 21,
  40610. * 12, 22 ];
  40611. * ```
  40612. * and internally all calculations are performed using column-major ordering.
  40613. * However, as the actual ordering makes no difference mathematically and
  40614. * most people are used to thinking about matrices in row-major order, the
  40615. * three.js documentation shows matrices in row-major order. Just bear in
  40616. * mind that if you are reading the source code, you'll have to take the
  40617. * transpose of any matrices outlined here to make sense of the calculations.
  40618. */
  40619. class Matrix2 {
  40620. /**
  40621. * Constructs a new 2x2 matrix. The arguments are supposed to be
  40622. * in row-major order. If no arguments are provided, the constructor
  40623. * initializes the matrix as an identity matrix.
  40624. *
  40625. * @param {number} [n11] - 1-1 matrix element.
  40626. * @param {number} [n12] - 1-2 matrix element.
  40627. * @param {number} [n21] - 2-1 matrix element.
  40628. * @param {number} [n22] - 2-2 matrix element.
  40629. */
  40630. constructor( n11, n12, n21, n22 ) {
  40631. /**
  40632. * This flag can be used for type testing.
  40633. *
  40634. * @type {boolean}
  40635. * @readonly
  40636. * @default true
  40637. */
  40638. Matrix2.prototype.isMatrix2 = true;
  40639. /**
  40640. * A column-major list of matrix values.
  40641. *
  40642. * @type {Array<number>}
  40643. */
  40644. this.elements = [
  40645. 1, 0,
  40646. 0, 1,
  40647. ];
  40648. if ( n11 !== undefined ) {
  40649. this.set( n11, n12, n21, n22 );
  40650. }
  40651. }
  40652. /**
  40653. * Sets this matrix to the 2x2 identity matrix.
  40654. *
  40655. * @return {Matrix2} A reference to this matrix.
  40656. */
  40657. identity() {
  40658. this.set(
  40659. 1, 0,
  40660. 0, 1,
  40661. );
  40662. return this;
  40663. }
  40664. /**
  40665. * Sets the elements of the matrix from the given array.
  40666. *
  40667. * @param {Array<number>} array - The matrix elements in column-major order.
  40668. * @param {number} [offset=0] - Index of the first element in the array.
  40669. * @return {Matrix2} A reference to this matrix.
  40670. */
  40671. fromArray( array, offset = 0 ) {
  40672. for ( let i = 0; i < 4; i ++ ) {
  40673. this.elements[ i ] = array[ i + offset ];
  40674. }
  40675. return this;
  40676. }
  40677. /**
  40678. * Sets the elements of the matrix.The arguments are supposed to be
  40679. * in row-major order.
  40680. *
  40681. * @param {number} n11 - 1-1 matrix element.
  40682. * @param {number} n12 - 1-2 matrix element.
  40683. * @param {number} n21 - 2-1 matrix element.
  40684. * @param {number} n22 - 2-2 matrix element.
  40685. * @return {Matrix2} A reference to this matrix.
  40686. */
  40687. set( n11, n12, n21, n22 ) {
  40688. const te = this.elements;
  40689. te[ 0 ] = n11; te[ 2 ] = n12;
  40690. te[ 1 ] = n21; te[ 3 ] = n22;
  40691. return this;
  40692. }
  40693. }
  40694. const _vector$4 = /*@__PURE__*/ new Vector2();
  40695. /**
  40696. * Represents an axis-aligned bounding box (AABB) in 2D space.
  40697. */
  40698. class Box2 {
  40699. /**
  40700. * Constructs a new bounding box.
  40701. *
  40702. * @param {Vector2} [min=(Infinity,Infinity)] - A vector representing the lower boundary of the box.
  40703. * @param {Vector2} [max=(-Infinity,-Infinity)] - A vector representing the upper boundary of the box.
  40704. */
  40705. constructor( min = new Vector2( + Infinity, + Infinity ), max = new Vector2( - Infinity, - Infinity ) ) {
  40706. /**
  40707. * This flag can be used for type testing.
  40708. *
  40709. * @type {boolean}
  40710. * @readonly
  40711. * @default true
  40712. */
  40713. this.isBox2 = true;
  40714. /**
  40715. * The lower boundary of the box.
  40716. *
  40717. * @type {Vector2}
  40718. */
  40719. this.min = min;
  40720. /**
  40721. * The upper boundary of the box.
  40722. *
  40723. * @type {Vector2}
  40724. */
  40725. this.max = max;
  40726. }
  40727. /**
  40728. * Sets the lower and upper boundaries of this box.
  40729. * Please note that this method only copies the values from the given objects.
  40730. *
  40731. * @param {Vector2} min - The lower boundary of the box.
  40732. * @param {Vector2} max - The upper boundary of the box.
  40733. * @return {Box2} A reference to this bounding box.
  40734. */
  40735. set( min, max ) {
  40736. this.min.copy( min );
  40737. this.max.copy( max );
  40738. return this;
  40739. }
  40740. /**
  40741. * Sets the upper and lower bounds of this box so it encloses the position data
  40742. * in the given array.
  40743. *
  40744. * @param {Array<Vector2>} points - An array holding 2D position data as instances of {@link Vector2}.
  40745. * @return {Box2} A reference to this bounding box.
  40746. */
  40747. setFromPoints( points ) {
  40748. this.makeEmpty();
  40749. for ( let i = 0, il = points.length; i < il; i ++ ) {
  40750. this.expandByPoint( points[ i ] );
  40751. }
  40752. return this;
  40753. }
  40754. /**
  40755. * Centers this box on the given center vector and sets this box's width, height and
  40756. * depth to the given size values.
  40757. *
  40758. * @param {Vector2} center - The center of the box.
  40759. * @param {Vector2} size - The x and y dimensions of the box.
  40760. * @return {Box2} A reference to this bounding box.
  40761. */
  40762. setFromCenterAndSize( center, size ) {
  40763. const halfSize = _vector$4.copy( size ).multiplyScalar( 0.5 );
  40764. this.min.copy( center ).sub( halfSize );
  40765. this.max.copy( center ).add( halfSize );
  40766. return this;
  40767. }
  40768. /**
  40769. * Returns a new box with copied values from this instance.
  40770. *
  40771. * @return {Box2} A clone of this instance.
  40772. */
  40773. clone() {
  40774. return new this.constructor().copy( this );
  40775. }
  40776. /**
  40777. * Copies the values of the given box to this instance.
  40778. *
  40779. * @param {Box2} box - The box to copy.
  40780. * @return {Box2} A reference to this bounding box.
  40781. */
  40782. copy( box ) {
  40783. this.min.copy( box.min );
  40784. this.max.copy( box.max );
  40785. return this;
  40786. }
  40787. /**
  40788. * Makes this box empty which means in encloses a zero space in 2D.
  40789. *
  40790. * @return {Box2} A reference to this bounding box.
  40791. */
  40792. makeEmpty() {
  40793. this.min.x = this.min.y = + Infinity;
  40794. this.max.x = this.max.y = - Infinity;
  40795. return this;
  40796. }
  40797. /**
  40798. * Returns true if this box includes zero points within its bounds.
  40799. * Note that a box with equal lower and upper bounds still includes one
  40800. * point, the one both bounds share.
  40801. *
  40802. * @return {boolean} Whether this box is empty or not.
  40803. */
  40804. isEmpty() {
  40805. // this is a more robust check for empty than ( volume <= 0 ) because volume can get positive with two negative axes
  40806. return ( this.max.x < this.min.x ) || ( this.max.y < this.min.y );
  40807. }
  40808. /**
  40809. * Returns the center point of this box.
  40810. *
  40811. * @param {Vector2} target - The target vector that is used to store the method's result.
  40812. * @return {Vector2} The center point.
  40813. */
  40814. getCenter( target ) {
  40815. return this.isEmpty() ? target.set( 0, 0 ) : target.addVectors( this.min, this.max ).multiplyScalar( 0.5 );
  40816. }
  40817. /**
  40818. * Returns the dimensions of this box.
  40819. *
  40820. * @param {Vector2} target - The target vector that is used to store the method's result.
  40821. * @return {Vector2} The size.
  40822. */
  40823. getSize( target ) {
  40824. return this.isEmpty() ? target.set( 0, 0 ) : target.subVectors( this.max, this.min );
  40825. }
  40826. /**
  40827. * Expands the boundaries of this box to include the given point.
  40828. *
  40829. * @param {Vector2} point - The point that should be included by the bounding box.
  40830. * @return {Box2} A reference to this bounding box.
  40831. */
  40832. expandByPoint( point ) {
  40833. this.min.min( point );
  40834. this.max.max( point );
  40835. return this;
  40836. }
  40837. /**
  40838. * Expands this box equilaterally by the given vector. The width of this
  40839. * box will be expanded by the x component of the vector in both
  40840. * directions. The height of this box will be expanded by the y component of
  40841. * the vector in both directions.
  40842. *
  40843. * @param {Vector2} vector - The vector that should expand the bounding box.
  40844. * @return {Box2} A reference to this bounding box.
  40845. */
  40846. expandByVector( vector ) {
  40847. this.min.sub( vector );
  40848. this.max.add( vector );
  40849. return this;
  40850. }
  40851. /**
  40852. * Expands each dimension of the box by the given scalar. If negative, the
  40853. * dimensions of the box will be contracted.
  40854. *
  40855. * @param {number} scalar - The scalar value that should expand the bounding box.
  40856. * @return {Box2} A reference to this bounding box.
  40857. */
  40858. expandByScalar( scalar ) {
  40859. this.min.addScalar( - scalar );
  40860. this.max.addScalar( scalar );
  40861. return this;
  40862. }
  40863. /**
  40864. * Returns `true` if the given point lies within or on the boundaries of this box.
  40865. *
  40866. * @param {Vector2} point - The point to test.
  40867. * @return {boolean} Whether the bounding box contains the given point or not.
  40868. */
  40869. containsPoint( point ) {
  40870. return point.x >= this.min.x && point.x <= this.max.x &&
  40871. point.y >= this.min.y && point.y <= this.max.y;
  40872. }
  40873. /**
  40874. * Returns `true` if this bounding box includes the entirety of the given bounding box.
  40875. * If this box and the given one are identical, this function also returns `true`.
  40876. *
  40877. * @param {Box2} box - The bounding box to test.
  40878. * @return {boolean} Whether the bounding box contains the given bounding box or not.
  40879. */
  40880. containsBox( box ) {
  40881. return this.min.x <= box.min.x && box.max.x <= this.max.x &&
  40882. this.min.y <= box.min.y && box.max.y <= this.max.y;
  40883. }
  40884. /**
  40885. * Returns a point as a proportion of this box's width and height.
  40886. *
  40887. * @param {Vector2} point - A point in 2D space.
  40888. * @param {Vector2} target - The target vector that is used to store the method's result.
  40889. * @return {Vector2} A point as a proportion of this box's width and height.
  40890. */
  40891. getParameter( point, target ) {
  40892. // This can potentially have a divide by zero if the box
  40893. // has a size dimension of 0.
  40894. return target.set(
  40895. ( point.x - this.min.x ) / ( this.max.x - this.min.x ),
  40896. ( point.y - this.min.y ) / ( this.max.y - this.min.y )
  40897. );
  40898. }
  40899. /**
  40900. * Returns `true` if the given bounding box intersects with this bounding box.
  40901. *
  40902. * @param {Box2} box - The bounding box to test.
  40903. * @return {boolean} Whether the given bounding box intersects with this bounding box.
  40904. */
  40905. intersectsBox( box ) {
  40906. // using 4 splitting planes to rule out intersections
  40907. return box.max.x >= this.min.x && box.min.x <= this.max.x &&
  40908. box.max.y >= this.min.y && box.min.y <= this.max.y;
  40909. }
  40910. /**
  40911. * Clamps the given point within the bounds of this box.
  40912. *
  40913. * @param {Vector2} point - The point to clamp.
  40914. * @param {Vector2} target - The target vector that is used to store the method's result.
  40915. * @return {Vector2} The clamped point.
  40916. */
  40917. clampPoint( point, target ) {
  40918. return target.copy( point ).clamp( this.min, this.max );
  40919. }
  40920. /**
  40921. * Returns the euclidean distance from any edge of this box to the specified point. If
  40922. * the given point lies inside of this box, the distance will be `0`.
  40923. *
  40924. * @param {Vector2} point - The point to compute the distance to.
  40925. * @return {number} The euclidean distance.
  40926. */
  40927. distanceToPoint( point ) {
  40928. return this.clampPoint( point, _vector$4 ).distanceTo( point );
  40929. }
  40930. /**
  40931. * Computes the intersection of this bounding box and the given one, setting the upper
  40932. * bound of this box to the lesser of the two boxes' upper bounds and the
  40933. * lower bound of this box to the greater of the two boxes' lower bounds. If
  40934. * there's no overlap, makes this box empty.
  40935. *
  40936. * @param {Box2} box - The bounding box to intersect with.
  40937. * @return {Box2} A reference to this bounding box.
  40938. */
  40939. intersect( box ) {
  40940. this.min.max( box.min );
  40941. this.max.min( box.max );
  40942. if ( this.isEmpty() ) this.makeEmpty();
  40943. return this;
  40944. }
  40945. /**
  40946. * Computes the union of this box and another and the given one, setting the upper
  40947. * bound of this box to the greater of the two boxes' upper bounds and the
  40948. * lower bound of this box to the lesser of the two boxes' lower bounds.
  40949. *
  40950. * @param {Box2} box - The bounding box that will be unioned with this instance.
  40951. * @return {Box2} A reference to this bounding box.
  40952. */
  40953. union( box ) {
  40954. this.min.min( box.min );
  40955. this.max.max( box.max );
  40956. return this;
  40957. }
  40958. /**
  40959. * Adds the given offset to both the upper and lower bounds of this bounding box,
  40960. * effectively moving it in 2D space.
  40961. *
  40962. * @param {Vector2} offset - The offset that should be used to translate the bounding box.
  40963. * @return {Box2} A reference to this bounding box.
  40964. */
  40965. translate( offset ) {
  40966. this.min.add( offset );
  40967. this.max.add( offset );
  40968. return this;
  40969. }
  40970. /**
  40971. * Returns `true` if this bounding box is equal with the given one.
  40972. *
  40973. * @param {Box2} box - The box to test for equality.
  40974. * @return {boolean} Whether this bounding box is equal with the given one.
  40975. */
  40976. equals( box ) {
  40977. return box.min.equals( this.min ) && box.max.equals( this.max );
  40978. }
  40979. }
  40980. const _startP = /*@__PURE__*/ new Vector3();
  40981. const _startEnd = /*@__PURE__*/ new Vector3();
  40982. const _d1 = /*@__PURE__*/ new Vector3();
  40983. const _d2 = /*@__PURE__*/ new Vector3();
  40984. const _r = /*@__PURE__*/ new Vector3();
  40985. const _c1 = /*@__PURE__*/ new Vector3();
  40986. const _c2 = /*@__PURE__*/ new Vector3();
  40987. /**
  40988. * An analytical line segment in 3D space represented by a start and end point.
  40989. */
  40990. class Line3 {
  40991. /**
  40992. * Constructs a new line segment.
  40993. *
  40994. * @param {Vector3} [start=(0,0,0)] - Start of the line segment.
  40995. * @param {Vector3} [end=(0,0,0)] - End of the line segment.
  40996. */
  40997. constructor( start = new Vector3(), end = new Vector3() ) {
  40998. /**
  40999. * Start of the line segment.
  41000. *
  41001. * @type {Vector3}
  41002. */
  41003. this.start = start;
  41004. /**
  41005. * End of the line segment.
  41006. *
  41007. * @type {Vector3}
  41008. */
  41009. this.end = end;
  41010. }
  41011. /**
  41012. * Sets the start and end values by copying the given vectors.
  41013. *
  41014. * @param {Vector3} start - The start point.
  41015. * @param {Vector3} end - The end point.
  41016. * @return {Line3} A reference to this line segment.
  41017. */
  41018. set( start, end ) {
  41019. this.start.copy( start );
  41020. this.end.copy( end );
  41021. return this;
  41022. }
  41023. /**
  41024. * Copies the values of the given line segment to this instance.
  41025. *
  41026. * @param {Line3} line - The line segment to copy.
  41027. * @return {Line3} A reference to this line segment.
  41028. */
  41029. copy( line ) {
  41030. this.start.copy( line.start );
  41031. this.end.copy( line.end );
  41032. return this;
  41033. }
  41034. /**
  41035. * Returns the center of the line segment.
  41036. *
  41037. * @param {Vector3} target - The target vector that is used to store the method's result.
  41038. * @return {Vector3} The center point.
  41039. */
  41040. getCenter( target ) {
  41041. return target.addVectors( this.start, this.end ).multiplyScalar( 0.5 );
  41042. }
  41043. /**
  41044. * Returns the delta vector of the line segment's start and end point.
  41045. *
  41046. * @param {Vector3} target - The target vector that is used to store the method's result.
  41047. * @return {Vector3} The delta vector.
  41048. */
  41049. delta( target ) {
  41050. return target.subVectors( this.end, this.start );
  41051. }
  41052. /**
  41053. * Returns the squared Euclidean distance between the line' start and end point.
  41054. *
  41055. * @return {number} The squared Euclidean distance.
  41056. */
  41057. distanceSq() {
  41058. return this.start.distanceToSquared( this.end );
  41059. }
  41060. /**
  41061. * Returns the Euclidean distance between the line' start and end point.
  41062. *
  41063. * @return {number} The Euclidean distance.
  41064. */
  41065. distance() {
  41066. return this.start.distanceTo( this.end );
  41067. }
  41068. /**
  41069. * Returns a vector at a certain position along the line segment.
  41070. *
  41071. * @param {number} t - A value between `[0,1]` to represent a position along the line segment.
  41072. * @param {Vector3} target - The target vector that is used to store the method's result.
  41073. * @return {Vector3} The delta vector.
  41074. */
  41075. at( t, target ) {
  41076. return this.delta( target ).multiplyScalar( t ).add( this.start );
  41077. }
  41078. /**
  41079. * Returns a point parameter based on the closest point as projected on the line segment.
  41080. *
  41081. * @param {Vector3} point - The point for which to return a point parameter.
  41082. * @param {boolean} clampToLine - Whether to clamp the result to the range `[0,1]` or not.
  41083. * @return {number} The point parameter.
  41084. */
  41085. closestPointToPointParameter( point, clampToLine ) {
  41086. _startP.subVectors( point, this.start );
  41087. _startEnd.subVectors( this.end, this.start );
  41088. const startEnd2 = _startEnd.dot( _startEnd );
  41089. const startEnd_startP = _startEnd.dot( _startP );
  41090. let t = startEnd_startP / startEnd2;
  41091. if ( clampToLine ) {
  41092. t = clamp( t, 0, 1 );
  41093. }
  41094. return t;
  41095. }
  41096. /**
  41097. * Returns the closest point on the line for a given point.
  41098. *
  41099. * @param {Vector3} point - The point to compute the closest point on the line for.
  41100. * @param {boolean} clampToLine - Whether to clamp the result to the range `[0,1]` or not.
  41101. * @param {Vector3} target - The target vector that is used to store the method's result.
  41102. * @return {Vector3} The closest point on the line.
  41103. */
  41104. closestPointToPoint( point, clampToLine, target ) {
  41105. const t = this.closestPointToPointParameter( point, clampToLine );
  41106. return this.delta( target ).multiplyScalar( t ).add( this.start );
  41107. }
  41108. /**
  41109. * Returns the closest squared distance between this line segment and the given one.
  41110. *
  41111. * @param {Line3} line - The line segment to compute the closest squared distance to.
  41112. * @param {Vector3} [c1] - The closest point on this line segment.
  41113. * @param {Vector3} [c2] - The closest point on the given line segment.
  41114. * @return {number} The squared distance between this line segment and the given one.
  41115. */
  41116. distanceSqToLine3( line, c1 = _c1, c2 = _c2 ) {
  41117. // from Real-Time Collision Detection by Christer Ericson, chapter 5.1.9
  41118. // Computes closest points C1 and C2 of S1(s)=P1+s*(Q1-P1) and
  41119. // S2(t)=P2+t*(Q2-P2), returning s and t. Function result is squared
  41120. // distance between between S1(s) and S2(t)
  41121. const EPSILON = 1e-8 * 1e-8; // must be squared since we compare squared length
  41122. let s, t;
  41123. const p1 = this.start;
  41124. const p2 = line.start;
  41125. const q1 = this.end;
  41126. const q2 = line.end;
  41127. _d1.subVectors( q1, p1 ); // Direction vector of segment S1
  41128. _d2.subVectors( q2, p2 ); // Direction vector of segment S2
  41129. _r.subVectors( p1, p2 );
  41130. const a = _d1.dot( _d1 ); // Squared length of segment S1, always nonnegative
  41131. const e = _d2.dot( _d2 ); // Squared length of segment S2, always nonnegative
  41132. const f = _d2.dot( _r );
  41133. // Check if either or both segments degenerate into points
  41134. if ( a <= EPSILON && e <= EPSILON ) {
  41135. // Both segments degenerate into points
  41136. c1.copy( p1 );
  41137. c2.copy( p2 );
  41138. c1.sub( c2 );
  41139. return c1.dot( c1 );
  41140. }
  41141. if ( a <= EPSILON ) {
  41142. // First segment degenerates into a point
  41143. s = 0;
  41144. t = f / e; // s = 0 => t = (b*s + f) / e = f / e
  41145. t = clamp( t, 0, 1 );
  41146. } else {
  41147. const c = _d1.dot( _r );
  41148. if ( e <= EPSILON ) {
  41149. // Second segment degenerates into a point
  41150. t = 0;
  41151. s = clamp( - c / a, 0, 1 ); // t = 0 => s = (b*t - c) / a = -c / a
  41152. } else {
  41153. // The general nondegenerate case starts here
  41154. const b = _d1.dot( _d2 );
  41155. const denom = a * e - b * b; // Always nonnegative
  41156. // If segments not parallel, compute closest point on L1 to L2 and
  41157. // clamp to segment S1. Else pick arbitrary s (here 0)
  41158. if ( denom !== 0 ) {
  41159. s = clamp( ( b * f - c * e ) / denom, 0, 1 );
  41160. } else {
  41161. s = 0;
  41162. }
  41163. // Compute point on L2 closest to S1(s) using
  41164. // t = Dot((P1 + D1*s) - P2,D2) / Dot(D2,D2) = (b*s + f) / e
  41165. t = ( b * s + f ) / e;
  41166. // If t in [0,1] done. Else clamp t, recompute s for the new value
  41167. // of t using s = Dot((P2 + D2*t) - P1,D1) / Dot(D1,D1)= (t*b - c) / a
  41168. // and clamp s to [0, 1]
  41169. if ( t < 0 ) {
  41170. t = 0.;
  41171. s = clamp( - c / a, 0, 1 );
  41172. } else if ( t > 1 ) {
  41173. t = 1;
  41174. s = clamp( ( b - c ) / a, 0, 1 );
  41175. }
  41176. }
  41177. }
  41178. c1.copy( p1 ).addScaledVector( _d1, s );
  41179. c2.copy( p2 ).addScaledVector( _d2, t );
  41180. return c1.distanceToSquared( c2 );
  41181. }
  41182. /**
  41183. * Applies a 4x4 transformation matrix to this line segment.
  41184. *
  41185. * @param {Matrix4} matrix - The transformation matrix.
  41186. * @return {Line3} A reference to this line segment.
  41187. */
  41188. applyMatrix4( matrix ) {
  41189. this.start.applyMatrix4( matrix );
  41190. this.end.applyMatrix4( matrix );
  41191. return this;
  41192. }
  41193. /**
  41194. * Returns `true` if this line segment is equal with the given one.
  41195. *
  41196. * @param {Line3} line - The line segment to test for equality.
  41197. * @return {boolean} Whether this line segment is equal with the given one.
  41198. */
  41199. equals( line ) {
  41200. return line.start.equals( this.start ) && line.end.equals( this.end );
  41201. }
  41202. /**
  41203. * Returns a new line segment with copied values from this instance.
  41204. *
  41205. * @return {Line3} A clone of this instance.
  41206. */
  41207. clone() {
  41208. return new this.constructor().copy( this );
  41209. }
  41210. }
  41211. const _vector$3 = /*@__PURE__*/ new Vector3();
  41212. /**
  41213. * This displays a cone shaped helper object for a {@link SpotLight}.
  41214. *
  41215. * When the spot light or its target are transformed or light properties are
  41216. * changed, it's necessary to call the `update()` method of the respective helper.
  41217. *
  41218. * ```js
  41219. * const spotLight = new THREE.SpotLight( 0xffffff );
  41220. * spotLight.position.set( 10, 10, 10 );
  41221. * scene.add( spotLight );
  41222. *
  41223. * const spotLightHelper = new THREE.SpotLightHelper( spotLight );
  41224. * scene.add( spotLightHelper );
  41225. * ```
  41226. *
  41227. * @augments Object3D
  41228. */
  41229. class SpotLightHelper extends Object3D {
  41230. /**
  41231. * Constructs a new spot light helper.
  41232. *
  41233. * @param {HemisphereLight} light - The light to be visualized.
  41234. * @param {number|Color|string} [color] - The helper's color. If not set, the helper will take
  41235. * the color of the light.
  41236. */
  41237. constructor( light, color ) {
  41238. super();
  41239. /**
  41240. * The light being visualized.
  41241. *
  41242. * @type {SpotLight}
  41243. */
  41244. this.light = light;
  41245. this.matrixAutoUpdate = false;
  41246. /**
  41247. * The color parameter passed in the constructor.
  41248. * If not set, the helper will take the color of the light.
  41249. *
  41250. * @type {number|Color|string}
  41251. */
  41252. this.color = color;
  41253. this.type = 'SpotLightHelper';
  41254. const geometry = new BufferGeometry();
  41255. const positions = [
  41256. 0, 0, 0, 0, 0, 1,
  41257. 0, 0, 0, 1, 0, 1,
  41258. 0, 0, 0, -1, 0, 1,
  41259. 0, 0, 0, 0, 1, 1,
  41260. 0, 0, 0, 0, -1, 1
  41261. ];
  41262. for ( let i = 0, j = 1, l = 32; i < l; i ++, j ++ ) {
  41263. const p1 = ( i / l ) * Math.PI * 2;
  41264. const p2 = ( j / l ) * Math.PI * 2;
  41265. positions.push(
  41266. Math.cos( p1 ), Math.sin( p1 ), 1,
  41267. Math.cos( p2 ), Math.sin( p2 ), 1
  41268. );
  41269. }
  41270. geometry.setAttribute( 'position', new Float32BufferAttribute( positions, 3 ) );
  41271. const material = new LineBasicMaterial( { fog: false, toneMapped: false } );
  41272. this.cone = new LineSegments( geometry, material );
  41273. this.add( this.cone );
  41274. this.update();
  41275. }
  41276. /**
  41277. * Frees the GPU-related resources allocated by this instance. Call this
  41278. * method whenever this instance is no longer used in your app.
  41279. */
  41280. dispose() {
  41281. this.cone.geometry.dispose();
  41282. this.cone.material.dispose();
  41283. }
  41284. /**
  41285. * Updates the helper to match the position and direction of the
  41286. * light being visualized.
  41287. */
  41288. update() {
  41289. this.light.updateWorldMatrix( true, false );
  41290. this.light.target.updateWorldMatrix( true, false );
  41291. // update the local matrix based on the parent and light target transforms
  41292. if ( this.parent ) {
  41293. this.parent.updateWorldMatrix( true );
  41294. this.matrix
  41295. .copy( this.parent.matrixWorld )
  41296. .invert()
  41297. .multiply( this.light.matrixWorld );
  41298. } else {
  41299. this.matrix.copy( this.light.matrixWorld );
  41300. }
  41301. this.matrixWorld.copy( this.light.matrixWorld );
  41302. const coneLength = this.light.distance ? this.light.distance : 1000;
  41303. const coneWidth = coneLength * Math.tan( this.light.angle );
  41304. this.cone.scale.set( coneWidth, coneWidth, coneLength );
  41305. _vector$3.setFromMatrixPosition( this.light.target.matrixWorld );
  41306. this.cone.lookAt( _vector$3 );
  41307. if ( this.color !== undefined ) {
  41308. this.cone.material.color.set( this.color );
  41309. } else {
  41310. this.cone.material.color.copy( this.light.color );
  41311. }
  41312. }
  41313. }
  41314. const _vector$2 = /*@__PURE__*/ new Vector3();
  41315. const _boneMatrix = /*@__PURE__*/ new Matrix4();
  41316. const _matrixWorldInv = /*@__PURE__*/ new Matrix4();
  41317. /**
  41318. * A helper object to assist with visualizing a {@link Skeleton}.
  41319. *
  41320. * ```js
  41321. * const helper = new THREE.SkeletonHelper( skinnedMesh );
  41322. * scene.add( helper );
  41323. * ```
  41324. *
  41325. * @augments LineSegments
  41326. */
  41327. class SkeletonHelper extends LineSegments {
  41328. /**
  41329. * Constructs a new skeleton helper.
  41330. *
  41331. * @param {Object3D} object - Usually an instance of {@link SkinnedMesh}. However, any 3D object
  41332. * can be used if it represents a hierarchy of bones (see {@link Bone}).
  41333. */
  41334. constructor( object ) {
  41335. const bones = getBoneList( object );
  41336. const geometry = new BufferGeometry();
  41337. const vertices = [];
  41338. const colors = [];
  41339. for ( let i = 0; i < bones.length; i ++ ) {
  41340. const bone = bones[ i ];
  41341. if ( bone.parent && bone.parent.isBone ) {
  41342. vertices.push( 0, 0, 0 );
  41343. vertices.push( 0, 0, 0 );
  41344. colors.push( 0, 0, 0 );
  41345. colors.push( 0, 0, 0 );
  41346. }
  41347. }
  41348. geometry.setAttribute( 'position', new Float32BufferAttribute( vertices, 3 ) );
  41349. geometry.setAttribute( 'color', new Float32BufferAttribute( colors, 3 ) );
  41350. const material = new LineBasicMaterial( { vertexColors: true, depthTest: false, depthWrite: false, toneMapped: false, transparent: true } );
  41351. super( geometry, material );
  41352. /**
  41353. * This flag can be used for type testing.
  41354. *
  41355. * @type {boolean}
  41356. * @readonly
  41357. * @default true
  41358. */
  41359. this.isSkeletonHelper = true;
  41360. this.type = 'SkeletonHelper';
  41361. /**
  41362. * The object being visualized.
  41363. *
  41364. * @type {Object3D}
  41365. */
  41366. this.root = object;
  41367. /**
  41368. * The list of bones that the helper visualizes.
  41369. *
  41370. * @type {Array<Bone>}
  41371. */
  41372. this.bones = bones;
  41373. this.matrix = object.matrixWorld;
  41374. this.matrixAutoUpdate = false;
  41375. // colors
  41376. const color1 = new Color( 0x0000ff );
  41377. const color2 = new Color( 0x00ff00 );
  41378. this.setColors( color1, color2 );
  41379. }
  41380. updateMatrixWorld( force ) {
  41381. const bones = this.bones;
  41382. const geometry = this.geometry;
  41383. const position = geometry.getAttribute( 'position' );
  41384. _matrixWorldInv.copy( this.root.matrixWorld ).invert();
  41385. for ( let i = 0, j = 0; i < bones.length; i ++ ) {
  41386. const bone = bones[ i ];
  41387. if ( bone.parent && bone.parent.isBone ) {
  41388. _boneMatrix.multiplyMatrices( _matrixWorldInv, bone.matrixWorld );
  41389. _vector$2.setFromMatrixPosition( _boneMatrix );
  41390. position.setXYZ( j, _vector$2.x, _vector$2.y, _vector$2.z );
  41391. _boneMatrix.multiplyMatrices( _matrixWorldInv, bone.parent.matrixWorld );
  41392. _vector$2.setFromMatrixPosition( _boneMatrix );
  41393. position.setXYZ( j + 1, _vector$2.x, _vector$2.y, _vector$2.z );
  41394. j += 2;
  41395. }
  41396. }
  41397. geometry.getAttribute( 'position' ).needsUpdate = true;
  41398. super.updateMatrixWorld( force );
  41399. }
  41400. /**
  41401. * Defines the colors of the helper.
  41402. *
  41403. * @param {Color} color1 - The first line color for each bone.
  41404. * @param {Color} color2 - The second line color for each bone.
  41405. * @return {SkeletonHelper} A reference to this helper.
  41406. */
  41407. setColors( color1, color2 ) {
  41408. const geometry = this.geometry;
  41409. const colorAttribute = geometry.getAttribute( 'color' );
  41410. for ( let i = 0; i < colorAttribute.count; i += 2 ) {
  41411. colorAttribute.setXYZ( i, color1.r, color1.g, color1.b );
  41412. colorAttribute.setXYZ( i + 1, color2.r, color2.g, color2.b );
  41413. }
  41414. colorAttribute.needsUpdate = true;
  41415. return this;
  41416. }
  41417. /**
  41418. * Frees the GPU-related resources allocated by this instance. Call this
  41419. * method whenever this instance is no longer used in your app.
  41420. */
  41421. dispose() {
  41422. this.geometry.dispose();
  41423. this.material.dispose();
  41424. }
  41425. }
  41426. function getBoneList( object ) {
  41427. const boneList = [];
  41428. if ( object.isBone === true ) {
  41429. boneList.push( object );
  41430. }
  41431. for ( let i = 0; i < object.children.length; i ++ ) {
  41432. boneList.push( ...getBoneList( object.children[ i ] ) );
  41433. }
  41434. return boneList;
  41435. }
  41436. /**
  41437. * This displays a helper object consisting of a spherical mesh for
  41438. * visualizing an instance of {@link PointLight}.
  41439. *
  41440. * ```js
  41441. * const pointLight = new THREE.PointLight( 0xff0000, 1, 100 );
  41442. * pointLight.position.set( 10, 10, 10 );
  41443. * scene.add( pointLight );
  41444. *
  41445. * const sphereSize = 1;
  41446. * const pointLightHelper = new THREE.PointLightHelper( pointLight, sphereSize );
  41447. * scene.add( pointLightHelper );
  41448. * ```
  41449. *
  41450. * @augments Mesh
  41451. */
  41452. class PointLightHelper extends Mesh {
  41453. /**
  41454. * Constructs a new point light helper.
  41455. *
  41456. * @param {PointLight} light - The light to be visualized.
  41457. * @param {number} [sphereSize=1] - The size of the sphere helper.
  41458. * @param {number|Color|string} [color] - The helper's color. If not set, the helper will take
  41459. * the color of the light.
  41460. */
  41461. constructor( light, sphereSize, color ) {
  41462. const geometry = new SphereGeometry( sphereSize, 4, 2 );
  41463. const material = new MeshBasicMaterial( { wireframe: true, fog: false, toneMapped: false } );
  41464. super( geometry, material );
  41465. /**
  41466. * The light being visualized.
  41467. *
  41468. * @type {PointLight}
  41469. */
  41470. this.light = light;
  41471. /**
  41472. * The color parameter passed in the constructor.
  41473. * If not set, the helper will take the color of the light.
  41474. *
  41475. * @type {number|Color|string}
  41476. */
  41477. this.color = color;
  41478. this.type = 'PointLightHelper';
  41479. this.matrix = this.light.matrixWorld;
  41480. this.matrixAutoUpdate = false;
  41481. this.update();
  41482. }
  41483. /**
  41484. * Frees the GPU-related resources allocated by this instance. Call this
  41485. * method whenever this instance is no longer used in your app.
  41486. */
  41487. dispose() {
  41488. this.geometry.dispose();
  41489. this.material.dispose();
  41490. }
  41491. /**
  41492. * Updates the helper to match the position of the
  41493. * light being visualized.
  41494. */
  41495. update() {
  41496. this.light.updateWorldMatrix( true, false );
  41497. if ( this.color !== undefined ) {
  41498. this.material.color.set( this.color );
  41499. } else {
  41500. this.material.color.copy( this.light.color );
  41501. }
  41502. /*
  41503. const d = this.light.distance;
  41504. if ( d === 0.0 ) {
  41505. this.lightDistance.visible = false;
  41506. } else {
  41507. this.lightDistance.visible = true;
  41508. this.lightDistance.scale.set( d, d, d );
  41509. }
  41510. */
  41511. }
  41512. }
  41513. const _vector$1 = /*@__PURE__*/ new Vector3();
  41514. const _color1 = /*@__PURE__*/ new Color();
  41515. const _color2 = /*@__PURE__*/ new Color();
  41516. /**
  41517. * Creates a visual aid consisting of a spherical mesh for a
  41518. * given {@link HemisphereLight}.
  41519. *
  41520. * When the hemisphere light is transformed or its light properties are changed,
  41521. * it's necessary to call the `update()` method of the respective helper.
  41522. *
  41523. * ```js
  41524. * const light = new THREE.HemisphereLight( 0xffffbb, 0x080820, 1 );
  41525. * const helper = new THREE.HemisphereLightHelper( light, 5 );
  41526. * scene.add( helper );
  41527. * ```
  41528. *
  41529. * @augments Object3D
  41530. */
  41531. class HemisphereLightHelper extends Object3D {
  41532. /**
  41533. * Constructs a new hemisphere light helper.
  41534. *
  41535. * @param {HemisphereLight} light - The light to be visualized.
  41536. * @param {number} [size=1] - The size of the mesh used to visualize the light.
  41537. * @param {number|Color|string} [color] - The helper's color. If not set, the helper will take
  41538. * the color of the light.
  41539. */
  41540. constructor( light, size, color ) {
  41541. super();
  41542. /**
  41543. * The light being visualized.
  41544. *
  41545. * @type {HemisphereLight}
  41546. */
  41547. this.light = light;
  41548. this.matrix = light.matrixWorld;
  41549. this.matrixAutoUpdate = false;
  41550. /**
  41551. * The color parameter passed in the constructor.
  41552. * If not set, the helper will take the color of the light.
  41553. *
  41554. * @type {number|Color|string}
  41555. */
  41556. this.color = color;
  41557. this.type = 'HemisphereLightHelper';
  41558. const geometry = new OctahedronGeometry( size );
  41559. geometry.rotateY( Math.PI * 0.5 );
  41560. this.material = new MeshBasicMaterial( { wireframe: true, fog: false, toneMapped: false } );
  41561. if ( this.color === undefined ) this.material.vertexColors = true;
  41562. const position = geometry.getAttribute( 'position' );
  41563. const colors = new Float32Array( position.count * 3 );
  41564. geometry.setAttribute( 'color', new BufferAttribute( colors, 3 ) );
  41565. this.add( new Mesh( geometry, this.material ) );
  41566. this.update();
  41567. }
  41568. /**
  41569. * Frees the GPU-related resources allocated by this instance. Call this
  41570. * method whenever this instance is no longer used in your app.
  41571. */
  41572. dispose() {
  41573. this.children[ 0 ].geometry.dispose();
  41574. this.children[ 0 ].material.dispose();
  41575. }
  41576. /**
  41577. * Updates the helper to match the position and direction of the
  41578. * light being visualized.
  41579. */
  41580. update() {
  41581. const mesh = this.children[ 0 ];
  41582. if ( this.color !== undefined ) {
  41583. this.material.color.set( this.color );
  41584. } else {
  41585. const colors = mesh.geometry.getAttribute( 'color' );
  41586. _color1.copy( this.light.color );
  41587. _color2.copy( this.light.groundColor );
  41588. for ( let i = 0, l = colors.count; i < l; i ++ ) {
  41589. const color = ( i < ( l / 2 ) ) ? _color1 : _color2;
  41590. colors.setXYZ( i, color.r, color.g, color.b );
  41591. }
  41592. colors.needsUpdate = true;
  41593. }
  41594. this.light.updateWorldMatrix( true, false );
  41595. mesh.lookAt( _vector$1.setFromMatrixPosition( this.light.matrixWorld ).negate() );
  41596. }
  41597. }
  41598. /**
  41599. * The helper is an object to define grids. Grids are two-dimensional
  41600. * arrays of lines.
  41601. *
  41602. * ```js
  41603. * const size = 10;
  41604. * const divisions = 10;
  41605. *
  41606. * const gridHelper = new THREE.GridHelper( size, divisions );
  41607. * scene.add( gridHelper );
  41608. * ```
  41609. *
  41610. * @augments LineSegments
  41611. */
  41612. class GridHelper extends LineSegments {
  41613. /**
  41614. * Constructs a new grid helper.
  41615. *
  41616. * @param {number} [size=10] - The size of the grid.
  41617. * @param {number} [divisions=10] - The number of divisions across the grid.
  41618. * @param {number|Color|string} [color1=0x444444] - The color of the center line.
  41619. * @param {number|Color|string} [color2=0x888888] - The color of the lines of the grid.
  41620. */
  41621. constructor( size = 10, divisions = 10, color1 = 0x444444, color2 = 0x888888 ) {
  41622. color1 = new Color( color1 );
  41623. color2 = new Color( color2 );
  41624. const center = divisions / 2;
  41625. const step = size / divisions;
  41626. const halfSize = size / 2;
  41627. const vertices = [], colors = [];
  41628. for ( let i = 0, j = 0, k = - halfSize; i <= divisions; i ++, k += step ) {
  41629. vertices.push( - halfSize, 0, k, halfSize, 0, k );
  41630. vertices.push( k, 0, - halfSize, k, 0, halfSize );
  41631. const color = i === center ? color1 : color2;
  41632. color.toArray( colors, j ); j += 3;
  41633. color.toArray( colors, j ); j += 3;
  41634. color.toArray( colors, j ); j += 3;
  41635. color.toArray( colors, j ); j += 3;
  41636. }
  41637. const geometry = new BufferGeometry();
  41638. geometry.setAttribute( 'position', new Float32BufferAttribute( vertices, 3 ) );
  41639. geometry.setAttribute( 'color', new Float32BufferAttribute( colors, 3 ) );
  41640. const material = new LineBasicMaterial( { vertexColors: true, toneMapped: false } );
  41641. super( geometry, material );
  41642. this.type = 'GridHelper';
  41643. }
  41644. /**
  41645. * Frees the GPU-related resources allocated by this instance. Call this
  41646. * method whenever this instance is no longer used in your app.
  41647. */
  41648. dispose() {
  41649. this.geometry.dispose();
  41650. this.material.dispose();
  41651. }
  41652. }
  41653. /**
  41654. * This helper is an object to define polar grids. Grids are
  41655. * two-dimensional arrays of lines.
  41656. *
  41657. * ```js
  41658. * const radius = 10;
  41659. * const sectors = 16;
  41660. * const rings = 8;
  41661. * const divisions = 64;
  41662. *
  41663. * const helper = new THREE.PolarGridHelper( radius, sectors, rings, divisions );
  41664. * scene.add( helper );
  41665. * ```
  41666. *
  41667. * @augments LineSegments
  41668. */
  41669. class PolarGridHelper extends LineSegments {
  41670. /**
  41671. * Constructs a new polar grid helper.
  41672. *
  41673. * @param {number} [radius=10] - The radius of the polar grid. This can be any positive number.
  41674. * @param {number} [sectors=16] - The number of sectors the grid will be divided into. This can be any positive integer.
  41675. * @param {number} [rings=16] - The number of rings. This can be any positive integer.
  41676. * @param {number} [divisions=64] - The number of line segments used for each circle. This can be any positive integer.
  41677. * @param {number|Color|string} [color1=0x444444] - The first color used for grid elements.
  41678. * @param {number|Color|string} [color2=0x888888] - The second color used for grid elements.
  41679. */
  41680. constructor( radius = 10, sectors = 16, rings = 8, divisions = 64, color1 = 0x444444, color2 = 0x888888 ) {
  41681. color1 = new Color( color1 );
  41682. color2 = new Color( color2 );
  41683. const vertices = [];
  41684. const colors = [];
  41685. // create the sectors
  41686. if ( sectors > 1 ) {
  41687. for ( let i = 0; i < sectors; i ++ ) {
  41688. const v = ( i / sectors ) * ( Math.PI * 2 );
  41689. const x = Math.sin( v ) * radius;
  41690. const z = Math.cos( v ) * radius;
  41691. vertices.push( 0, 0, 0 );
  41692. vertices.push( x, 0, z );
  41693. const color = ( i & 1 ) ? color1 : color2;
  41694. colors.push( color.r, color.g, color.b );
  41695. colors.push( color.r, color.g, color.b );
  41696. }
  41697. }
  41698. // create the rings
  41699. for ( let i = 0; i < rings; i ++ ) {
  41700. const color = ( i & 1 ) ? color1 : color2;
  41701. const r = radius - ( radius / rings * i );
  41702. for ( let j = 0; j < divisions; j ++ ) {
  41703. // first vertex
  41704. let v = ( j / divisions ) * ( Math.PI * 2 );
  41705. let x = Math.sin( v ) * r;
  41706. let z = Math.cos( v ) * r;
  41707. vertices.push( x, 0, z );
  41708. colors.push( color.r, color.g, color.b );
  41709. // second vertex
  41710. v = ( ( j + 1 ) / divisions ) * ( Math.PI * 2 );
  41711. x = Math.sin( v ) * r;
  41712. z = Math.cos( v ) * r;
  41713. vertices.push( x, 0, z );
  41714. colors.push( color.r, color.g, color.b );
  41715. }
  41716. }
  41717. const geometry = new BufferGeometry();
  41718. geometry.setAttribute( 'position', new Float32BufferAttribute( vertices, 3 ) );
  41719. geometry.setAttribute( 'color', new Float32BufferAttribute( colors, 3 ) );
  41720. const material = new LineBasicMaterial( { vertexColors: true, toneMapped: false } );
  41721. super( geometry, material );
  41722. this.type = 'PolarGridHelper';
  41723. }
  41724. /**
  41725. * Frees the GPU-related resources allocated by this instance. Call this
  41726. * method whenever this instance is no longer used in your app.
  41727. */
  41728. dispose() {
  41729. this.geometry.dispose();
  41730. this.material.dispose();
  41731. }
  41732. }
  41733. const _v1 = /*@__PURE__*/ new Vector3();
  41734. const _v2 = /*@__PURE__*/ new Vector3();
  41735. const _v3 = /*@__PURE__*/ new Vector3();
  41736. /**
  41737. * Helper object to assist with visualizing a {@link DirectionalLight}'s
  41738. * effect on the scene. This consists of a plane and a line representing the
  41739. * light's position and direction.
  41740. *
  41741. * When the directional light or its target are transformed or light properties
  41742. * are changed, it's necessary to call the `update()` method of the respective helper.
  41743. *
  41744. * ```js
  41745. * const light = new THREE.DirectionalLight( 0xFFFFFF );
  41746. * scene.add( light );
  41747. *
  41748. * const helper = new THREE.DirectionalLightHelper( light, 5 );
  41749. * scene.add( helper );
  41750. * ```
  41751. *
  41752. * @augments Object3D
  41753. */
  41754. class DirectionalLightHelper extends Object3D {
  41755. /**
  41756. * Constructs a new directional light helper.
  41757. *
  41758. * @param {DirectionalLight} light - The light to be visualized.
  41759. * @param {number} [size=1] - The dimensions of the plane.
  41760. * @param {number|Color|string} [color] - The helper's color. If not set, the helper will take
  41761. * the color of the light.
  41762. */
  41763. constructor( light, size, color ) {
  41764. super();
  41765. /**
  41766. * The light being visualized.
  41767. *
  41768. * @type {DirectionalLight}
  41769. */
  41770. this.light = light;
  41771. this.matrix = light.matrixWorld;
  41772. this.matrixAutoUpdate = false;
  41773. /**
  41774. * The color parameter passed in the constructor.
  41775. * If not set, the helper will take the color of the light.
  41776. *
  41777. * @type {number|Color|string}
  41778. */
  41779. this.color = color;
  41780. this.type = 'DirectionalLightHelper';
  41781. if ( size === undefined ) size = 1;
  41782. let geometry = new BufferGeometry();
  41783. geometry.setAttribute( 'position', new Float32BufferAttribute( [
  41784. - size, size, 0,
  41785. size, size, 0,
  41786. size, - size, 0,
  41787. - size, - size, 0,
  41788. - size, size, 0
  41789. ], 3 ) );
  41790. const material = new LineBasicMaterial( { fog: false, toneMapped: false } );
  41791. /**
  41792. * Contains the line showing the location of the directional light.
  41793. *
  41794. * @type {Line}
  41795. */
  41796. this.lightPlane = new Line( geometry, material );
  41797. this.add( this.lightPlane );
  41798. geometry = new BufferGeometry();
  41799. geometry.setAttribute( 'position', new Float32BufferAttribute( [ 0, 0, 0, 0, 0, 1 ], 3 ) );
  41800. /**
  41801. * Represents the target line of the directional light.
  41802. *
  41803. * @type {Line}
  41804. */
  41805. this.targetLine = new Line( geometry, material );
  41806. this.add( this.targetLine );
  41807. this.update();
  41808. }
  41809. /**
  41810. * Frees the GPU-related resources allocated by this instance. Call this
  41811. * method whenever this instance is no longer used in your app.
  41812. */
  41813. dispose() {
  41814. this.lightPlane.geometry.dispose();
  41815. this.lightPlane.material.dispose();
  41816. this.targetLine.geometry.dispose();
  41817. this.targetLine.material.dispose();
  41818. }
  41819. /**
  41820. * Updates the helper to match the position and direction of the
  41821. * light being visualized.
  41822. */
  41823. update() {
  41824. this.light.updateWorldMatrix( true, false );
  41825. this.light.target.updateWorldMatrix( true, false );
  41826. _v1.setFromMatrixPosition( this.light.matrixWorld );
  41827. _v2.setFromMatrixPosition( this.light.target.matrixWorld );
  41828. _v3.subVectors( _v2, _v1 );
  41829. this.lightPlane.lookAt( _v2 );
  41830. if ( this.color !== undefined ) {
  41831. this.lightPlane.material.color.set( this.color );
  41832. this.targetLine.material.color.set( this.color );
  41833. } else {
  41834. this.lightPlane.material.color.copy( this.light.color );
  41835. this.targetLine.material.color.copy( this.light.color );
  41836. }
  41837. this.targetLine.lookAt( _v2 );
  41838. this.targetLine.scale.z = _v3.length();
  41839. }
  41840. }
  41841. const _vector = /*@__PURE__*/ new Vector3();
  41842. const _camera = /*@__PURE__*/ new Camera();
  41843. /**
  41844. * This helps with visualizing what a camera contains in its frustum. It
  41845. * visualizes the frustum of a camera using a line segments.
  41846. *
  41847. * Based on frustum visualization in [lightgl.js shadowmap example](https://github.com/evanw/lightgl.js/blob/master/tests/shadowmap.html).
  41848. *
  41849. * `CameraHelper` must be a child of the scene.
  41850. *
  41851. * When the camera is transformed or its projection matrix is changed, it's necessary
  41852. * to call the `update()` method of the respective helper.
  41853. *
  41854. * ```js
  41855. * const camera = new THREE.PerspectiveCamera( 75, window.innerWidth / window.innerHeight, 0.1, 1000 );
  41856. * const helper = new THREE.CameraHelper( camera );
  41857. * scene.add( helper );
  41858. * ```
  41859. *
  41860. * @augments LineSegments
  41861. */
  41862. class CameraHelper extends LineSegments {
  41863. /**
  41864. * Constructs a new arrow helper.
  41865. *
  41866. * @param {Camera} camera - The camera to visualize.
  41867. */
  41868. constructor( camera ) {
  41869. const geometry = new BufferGeometry();
  41870. const material = new LineBasicMaterial( { color: 0xffffff, vertexColors: true, toneMapped: false } );
  41871. const vertices = [];
  41872. const colors = [];
  41873. const pointMap = {};
  41874. // near
  41875. addLine( 'n1', 'n2' );
  41876. addLine( 'n2', 'n4' );
  41877. addLine( 'n4', 'n3' );
  41878. addLine( 'n3', 'n1' );
  41879. // far
  41880. addLine( 'f1', 'f2' );
  41881. addLine( 'f2', 'f4' );
  41882. addLine( 'f4', 'f3' );
  41883. addLine( 'f3', 'f1' );
  41884. // sides
  41885. addLine( 'n1', 'f1' );
  41886. addLine( 'n2', 'f2' );
  41887. addLine( 'n3', 'f3' );
  41888. addLine( 'n4', 'f4' );
  41889. // cone
  41890. addLine( 'p', 'n1' );
  41891. addLine( 'p', 'n2' );
  41892. addLine( 'p', 'n3' );
  41893. addLine( 'p', 'n4' );
  41894. // up
  41895. addLine( 'u1', 'u2' );
  41896. addLine( 'u2', 'u3' );
  41897. addLine( 'u3', 'u1' );
  41898. // target
  41899. addLine( 'c', 't' );
  41900. addLine( 'p', 'c' );
  41901. // cross
  41902. addLine( 'cn1', 'cn2' );
  41903. addLine( 'cn3', 'cn4' );
  41904. addLine( 'cf1', 'cf2' );
  41905. addLine( 'cf3', 'cf4' );
  41906. function addLine( a, b ) {
  41907. addPoint( a );
  41908. addPoint( b );
  41909. }
  41910. function addPoint( id ) {
  41911. vertices.push( 0, 0, 0 );
  41912. colors.push( 0, 0, 0 );
  41913. if ( pointMap[ id ] === undefined ) {
  41914. pointMap[ id ] = [];
  41915. }
  41916. pointMap[ id ].push( ( vertices.length / 3 ) - 1 );
  41917. }
  41918. geometry.setAttribute( 'position', new Float32BufferAttribute( vertices, 3 ) );
  41919. geometry.setAttribute( 'color', new Float32BufferAttribute( colors, 3 ) );
  41920. super( geometry, material );
  41921. this.type = 'CameraHelper';
  41922. /**
  41923. * The camera being visualized.
  41924. *
  41925. * @type {Camera}
  41926. */
  41927. this.camera = camera;
  41928. if ( this.camera.updateProjectionMatrix ) this.camera.updateProjectionMatrix();
  41929. this.matrix = camera.matrixWorld;
  41930. this.matrixAutoUpdate = false;
  41931. /**
  41932. * This contains the points used to visualize the camera.
  41933. *
  41934. * @type {Object<string,Array<number>>}
  41935. */
  41936. this.pointMap = pointMap;
  41937. this.update();
  41938. // colors
  41939. const colorFrustum = new Color( 0xffaa00 );
  41940. const colorCone = new Color( 0xff0000 );
  41941. const colorUp = new Color( 0x00aaff );
  41942. const colorTarget = new Color( 0xffffff );
  41943. const colorCross = new Color( 0x333333 );
  41944. this.setColors( colorFrustum, colorCone, colorUp, colorTarget, colorCross );
  41945. }
  41946. /**
  41947. * Defines the colors of the helper.
  41948. *
  41949. * @param {Color} frustum - The frustum line color.
  41950. * @param {Color} cone - The cone line color.
  41951. * @param {Color} up - The up line color.
  41952. * @param {Color} target - The target line color.
  41953. * @param {Color} cross - The cross line color.
  41954. * @return {CameraHelper} A reference to this helper.
  41955. */
  41956. setColors( frustum, cone, up, target, cross ) {
  41957. const geometry = this.geometry;
  41958. const colorAttribute = geometry.getAttribute( 'color' );
  41959. // near
  41960. colorAttribute.setXYZ( 0, frustum.r, frustum.g, frustum.b ); colorAttribute.setXYZ( 1, frustum.r, frustum.g, frustum.b ); // n1, n2
  41961. colorAttribute.setXYZ( 2, frustum.r, frustum.g, frustum.b ); colorAttribute.setXYZ( 3, frustum.r, frustum.g, frustum.b ); // n2, n4
  41962. colorAttribute.setXYZ( 4, frustum.r, frustum.g, frustum.b ); colorAttribute.setXYZ( 5, frustum.r, frustum.g, frustum.b ); // n4, n3
  41963. colorAttribute.setXYZ( 6, frustum.r, frustum.g, frustum.b ); colorAttribute.setXYZ( 7, frustum.r, frustum.g, frustum.b ); // n3, n1
  41964. // far
  41965. colorAttribute.setXYZ( 8, frustum.r, frustum.g, frustum.b ); colorAttribute.setXYZ( 9, frustum.r, frustum.g, frustum.b ); // f1, f2
  41966. colorAttribute.setXYZ( 10, frustum.r, frustum.g, frustum.b ); colorAttribute.setXYZ( 11, frustum.r, frustum.g, frustum.b ); // f2, f4
  41967. colorAttribute.setXYZ( 12, frustum.r, frustum.g, frustum.b ); colorAttribute.setXYZ( 13, frustum.r, frustum.g, frustum.b ); // f4, f3
  41968. colorAttribute.setXYZ( 14, frustum.r, frustum.g, frustum.b ); colorAttribute.setXYZ( 15, frustum.r, frustum.g, frustum.b ); // f3, f1
  41969. // sides
  41970. colorAttribute.setXYZ( 16, frustum.r, frustum.g, frustum.b ); colorAttribute.setXYZ( 17, frustum.r, frustum.g, frustum.b ); // n1, f1
  41971. colorAttribute.setXYZ( 18, frustum.r, frustum.g, frustum.b ); colorAttribute.setXYZ( 19, frustum.r, frustum.g, frustum.b ); // n2, f2
  41972. colorAttribute.setXYZ( 20, frustum.r, frustum.g, frustum.b ); colorAttribute.setXYZ( 21, frustum.r, frustum.g, frustum.b ); // n3, f3
  41973. colorAttribute.setXYZ( 22, frustum.r, frustum.g, frustum.b ); colorAttribute.setXYZ( 23, frustum.r, frustum.g, frustum.b ); // n4, f4
  41974. // cone
  41975. colorAttribute.setXYZ( 24, cone.r, cone.g, cone.b ); colorAttribute.setXYZ( 25, cone.r, cone.g, cone.b ); // p, n1
  41976. colorAttribute.setXYZ( 26, cone.r, cone.g, cone.b ); colorAttribute.setXYZ( 27, cone.r, cone.g, cone.b ); // p, n2
  41977. colorAttribute.setXYZ( 28, cone.r, cone.g, cone.b ); colorAttribute.setXYZ( 29, cone.r, cone.g, cone.b ); // p, n3
  41978. colorAttribute.setXYZ( 30, cone.r, cone.g, cone.b ); colorAttribute.setXYZ( 31, cone.r, cone.g, cone.b ); // p, n4
  41979. // up
  41980. colorAttribute.setXYZ( 32, up.r, up.g, up.b ); colorAttribute.setXYZ( 33, up.r, up.g, up.b ); // u1, u2
  41981. colorAttribute.setXYZ( 34, up.r, up.g, up.b ); colorAttribute.setXYZ( 35, up.r, up.g, up.b ); // u2, u3
  41982. colorAttribute.setXYZ( 36, up.r, up.g, up.b ); colorAttribute.setXYZ( 37, up.r, up.g, up.b ); // u3, u1
  41983. // target
  41984. colorAttribute.setXYZ( 38, target.r, target.g, target.b ); colorAttribute.setXYZ( 39, target.r, target.g, target.b ); // c, t
  41985. colorAttribute.setXYZ( 40, cross.r, cross.g, cross.b ); colorAttribute.setXYZ( 41, cross.r, cross.g, cross.b ); // p, c
  41986. // cross
  41987. colorAttribute.setXYZ( 42, cross.r, cross.g, cross.b ); colorAttribute.setXYZ( 43, cross.r, cross.g, cross.b ); // cn1, cn2
  41988. colorAttribute.setXYZ( 44, cross.r, cross.g, cross.b ); colorAttribute.setXYZ( 45, cross.r, cross.g, cross.b ); // cn3, cn4
  41989. colorAttribute.setXYZ( 46, cross.r, cross.g, cross.b ); colorAttribute.setXYZ( 47, cross.r, cross.g, cross.b ); // cf1, cf2
  41990. colorAttribute.setXYZ( 48, cross.r, cross.g, cross.b ); colorAttribute.setXYZ( 49, cross.r, cross.g, cross.b ); // cf3, cf4
  41991. colorAttribute.needsUpdate = true;
  41992. return this;
  41993. }
  41994. /**
  41995. * Updates the helper based on the projection matrix of the camera.
  41996. */
  41997. update() {
  41998. const geometry = this.geometry;
  41999. const pointMap = this.pointMap;
  42000. const w = 1, h = 1;
  42001. let nearZ, farZ;
  42002. // we need just camera projection matrix inverse
  42003. // world matrix must be identity
  42004. _camera.projectionMatrixInverse.copy( this.camera.projectionMatrixInverse );
  42005. // Adjust z values based on coordinate system
  42006. if ( this.camera.reversedDepth === true ) {
  42007. nearZ = 1;
  42008. farZ = 0;
  42009. } else {
  42010. if ( this.camera.coordinateSystem === WebGLCoordinateSystem ) {
  42011. nearZ = -1;
  42012. farZ = 1;
  42013. } else if ( this.camera.coordinateSystem === WebGPUCoordinateSystem ) {
  42014. nearZ = 0;
  42015. farZ = 1;
  42016. } else {
  42017. throw new Error( 'THREE.CameraHelper.update(): Invalid coordinate system: ' + this.camera.coordinateSystem );
  42018. }
  42019. }
  42020. // center / target
  42021. setPoint( 'c', pointMap, geometry, _camera, 0, 0, nearZ );
  42022. setPoint( 't', pointMap, geometry, _camera, 0, 0, farZ );
  42023. // near
  42024. setPoint( 'n1', pointMap, geometry, _camera, - w, - h, nearZ );
  42025. setPoint( 'n2', pointMap, geometry, _camera, w, - h, nearZ );
  42026. setPoint( 'n3', pointMap, geometry, _camera, - w, h, nearZ );
  42027. setPoint( 'n4', pointMap, geometry, _camera, w, h, nearZ );
  42028. // far
  42029. setPoint( 'f1', pointMap, geometry, _camera, - w, - h, farZ );
  42030. setPoint( 'f2', pointMap, geometry, _camera, w, - h, farZ );
  42031. setPoint( 'f3', pointMap, geometry, _camera, - w, h, farZ );
  42032. setPoint( 'f4', pointMap, geometry, _camera, w, h, farZ );
  42033. // up
  42034. setPoint( 'u1', pointMap, geometry, _camera, w * 0.7, h * 1.1, nearZ );
  42035. setPoint( 'u2', pointMap, geometry, _camera, - w * 0.7, h * 1.1, nearZ );
  42036. setPoint( 'u3', pointMap, geometry, _camera, 0, h * 2, nearZ );
  42037. // cross
  42038. setPoint( 'cf1', pointMap, geometry, _camera, - w, 0, farZ );
  42039. setPoint( 'cf2', pointMap, geometry, _camera, w, 0, farZ );
  42040. setPoint( 'cf3', pointMap, geometry, _camera, 0, - h, farZ );
  42041. setPoint( 'cf4', pointMap, geometry, _camera, 0, h, farZ );
  42042. setPoint( 'cn1', pointMap, geometry, _camera, - w, 0, nearZ );
  42043. setPoint( 'cn2', pointMap, geometry, _camera, w, 0, nearZ );
  42044. setPoint( 'cn3', pointMap, geometry, _camera, 0, - h, nearZ );
  42045. setPoint( 'cn4', pointMap, geometry, _camera, 0, h, nearZ );
  42046. geometry.getAttribute( 'position' ).needsUpdate = true;
  42047. }
  42048. /**
  42049. * Frees the GPU-related resources allocated by this instance. Call this
  42050. * method whenever this instance is no longer used in your app.
  42051. */
  42052. dispose() {
  42053. this.geometry.dispose();
  42054. this.material.dispose();
  42055. }
  42056. }
  42057. function setPoint( point, pointMap, geometry, camera, x, y, z ) {
  42058. _vector.set( x, y, z ).unproject( camera );
  42059. const points = pointMap[ point ];
  42060. if ( points !== undefined ) {
  42061. const position = geometry.getAttribute( 'position' );
  42062. for ( let i = 0, l = points.length; i < l; i ++ ) {
  42063. position.setXYZ( points[ i ], _vector.x, _vector.y, _vector.z );
  42064. }
  42065. }
  42066. }
  42067. const _box = /*@__PURE__*/ new Box3();
  42068. /**
  42069. * Helper object to graphically show the world-axis-aligned bounding box
  42070. * around an object. The actual bounding box is handled with {@link Box3},
  42071. * this is just a visual helper for debugging. It can be automatically
  42072. * resized with {@link BoxHelper#update} when the object it's created from
  42073. * is transformed. Note that the object must have a geometry for this to work,
  42074. * so it won't work with sprites.
  42075. *
  42076. * ```js
  42077. * const sphere = new THREE.SphereGeometry();
  42078. * const object = new THREE.Mesh( sphere, new THREE.MeshBasicMaterial( 0xff0000 ) );
  42079. * const box = new THREE.BoxHelper( object, 0xffff00 );
  42080. * scene.add( box );
  42081. * ```
  42082. *
  42083. * @augments LineSegments
  42084. */
  42085. class BoxHelper extends LineSegments {
  42086. /**
  42087. * Constructs a new box helper.
  42088. *
  42089. * @param {Object3D} [object] - The 3D object to show the world-axis-aligned bounding box.
  42090. * @param {number|Color|string} [color=0xffff00] - The box's color.
  42091. */
  42092. constructor( object, color = 0xffff00 ) {
  42093. const indices = new Uint16Array( [ 0, 1, 1, 2, 2, 3, 3, 0, 4, 5, 5, 6, 6, 7, 7, 4, 0, 4, 1, 5, 2, 6, 3, 7 ] );
  42094. const positions = new Float32Array( 8 * 3 );
  42095. const geometry = new BufferGeometry();
  42096. geometry.setIndex( new BufferAttribute( indices, 1 ) );
  42097. geometry.setAttribute( 'position', new BufferAttribute( positions, 3 ) );
  42098. super( geometry, new LineBasicMaterial( { color: color, toneMapped: false } ) );
  42099. /**
  42100. * The 3D object being visualized.
  42101. *
  42102. * @type {Object3D}
  42103. */
  42104. this.object = object;
  42105. this.type = 'BoxHelper';
  42106. this.matrixAutoUpdate = false;
  42107. this.update();
  42108. }
  42109. /**
  42110. * Updates the helper's geometry to match the dimensions of the object,
  42111. * including any children.
  42112. */
  42113. update() {
  42114. if ( this.object !== undefined ) {
  42115. _box.setFromObject( this.object );
  42116. }
  42117. if ( _box.isEmpty() ) return;
  42118. const min = _box.min;
  42119. const max = _box.max;
  42120. /*
  42121. 5____4
  42122. 1/___0/|
  42123. | 6__|_7
  42124. 2/___3/
  42125. 0: max.x, max.y, max.z
  42126. 1: min.x, max.y, max.z
  42127. 2: min.x, min.y, max.z
  42128. 3: max.x, min.y, max.z
  42129. 4: max.x, max.y, min.z
  42130. 5: min.x, max.y, min.z
  42131. 6: min.x, min.y, min.z
  42132. 7: max.x, min.y, min.z
  42133. */
  42134. const position = this.geometry.attributes.position;
  42135. const array = position.array;
  42136. array[ 0 ] = max.x; array[ 1 ] = max.y; array[ 2 ] = max.z;
  42137. array[ 3 ] = min.x; array[ 4 ] = max.y; array[ 5 ] = max.z;
  42138. array[ 6 ] = min.x; array[ 7 ] = min.y; array[ 8 ] = max.z;
  42139. array[ 9 ] = max.x; array[ 10 ] = min.y; array[ 11 ] = max.z;
  42140. array[ 12 ] = max.x; array[ 13 ] = max.y; array[ 14 ] = min.z;
  42141. array[ 15 ] = min.x; array[ 16 ] = max.y; array[ 17 ] = min.z;
  42142. array[ 18 ] = min.x; array[ 19 ] = min.y; array[ 20 ] = min.z;
  42143. array[ 21 ] = max.x; array[ 22 ] = min.y; array[ 23 ] = min.z;
  42144. position.needsUpdate = true;
  42145. this.geometry.computeBoundingSphere();
  42146. }
  42147. /**
  42148. * Updates the wireframe box for the passed object.
  42149. *
  42150. * @param {Object3D} object - The 3D object to create the helper for.
  42151. * @return {BoxHelper} A reference to this instance.
  42152. */
  42153. setFromObject( object ) {
  42154. this.object = object;
  42155. this.update();
  42156. return this;
  42157. }
  42158. copy( source, recursive ) {
  42159. super.copy( source, recursive );
  42160. this.object = source.object;
  42161. return this;
  42162. }
  42163. /**
  42164. * Frees the GPU-related resources allocated by this instance. Call this
  42165. * method whenever this instance is no longer used in your app.
  42166. */
  42167. dispose() {
  42168. this.geometry.dispose();
  42169. this.material.dispose();
  42170. }
  42171. }
  42172. /**
  42173. * A helper object to visualize an instance of {@link Box3}.
  42174. *
  42175. * ```js
  42176. * const box = new THREE.Box3();
  42177. * box.setFromCenterAndSize( new THREE.Vector3( 1, 1, 1 ), new THREE.Vector3( 2, 1, 3 ) );
  42178. *
  42179. * const helper = new THREE.Box3Helper( box, 0xffff00 );
  42180. * scene.add( helper )
  42181. * ```
  42182. *
  42183. * @augments LineSegments
  42184. */
  42185. class Box3Helper extends LineSegments {
  42186. /**
  42187. * Constructs a new box3 helper.
  42188. *
  42189. * @param {Box3} box - The box to visualize.
  42190. * @param {number|Color|string} [color=0xffff00] - The box's color.
  42191. */
  42192. constructor( box, color = 0xffff00 ) {
  42193. const indices = new Uint16Array( [ 0, 1, 1, 2, 2, 3, 3, 0, 4, 5, 5, 6, 6, 7, 7, 4, 0, 4, 1, 5, 2, 6, 3, 7 ] );
  42194. const positions = [ 1, 1, 1, -1, 1, 1, -1, -1, 1, 1, -1, 1, 1, 1, -1, -1, 1, -1, -1, -1, -1, 1, -1, -1 ];
  42195. const geometry = new BufferGeometry();
  42196. geometry.setIndex( new BufferAttribute( indices, 1 ) );
  42197. geometry.setAttribute( 'position', new Float32BufferAttribute( positions, 3 ) );
  42198. super( geometry, new LineBasicMaterial( { color: color, toneMapped: false } ) );
  42199. /**
  42200. * The box being visualized.
  42201. *
  42202. * @type {Box3}
  42203. */
  42204. this.box = box;
  42205. this.type = 'Box3Helper';
  42206. this.geometry.computeBoundingSphere();
  42207. }
  42208. updateMatrixWorld( force ) {
  42209. const box = this.box;
  42210. if ( box.isEmpty() ) return;
  42211. box.getCenter( this.position );
  42212. box.getSize( this.scale );
  42213. this.scale.multiplyScalar( 0.5 );
  42214. super.updateMatrixWorld( force );
  42215. }
  42216. /**
  42217. * Frees the GPU-related resources allocated by this instance. Call this
  42218. * method whenever this instance is no longer used in your app.
  42219. */
  42220. dispose() {
  42221. this.geometry.dispose();
  42222. this.material.dispose();
  42223. }
  42224. }
  42225. /**
  42226. * A helper object to visualize an instance of {@link Plane}.
  42227. *
  42228. * ```js
  42229. * const plane = new THREE.Plane( new THREE.Vector3( 1, 1, 0.2 ), 3 );
  42230. * const helper = new THREE.PlaneHelper( plane, 1, 0xffff00 );
  42231. * scene.add( helper );
  42232. * ```
  42233. *
  42234. * @augments Line
  42235. */
  42236. class PlaneHelper extends Line {
  42237. /**
  42238. * Constructs a new plane helper.
  42239. *
  42240. * @param {Plane} plane - The plane to be visualized.
  42241. * @param {number} [size=1] - The side length of plane helper.
  42242. * @param {number|Color|string} [hex=0xffff00] - The helper's color.
  42243. */
  42244. constructor( plane, size = 1, hex = 0xffff00 ) {
  42245. const color = hex;
  42246. const positions = [ 1, -1, 0, -1, 1, 0, -1, -1, 0, 1, 1, 0, -1, 1, 0, -1, -1, 0, 1, -1, 0, 1, 1, 0 ];
  42247. const geometry = new BufferGeometry();
  42248. geometry.setAttribute( 'position', new Float32BufferAttribute( positions, 3 ) );
  42249. geometry.computeBoundingSphere();
  42250. super( geometry, new LineBasicMaterial( { color: color, toneMapped: false } ) );
  42251. this.type = 'PlaneHelper';
  42252. /**
  42253. * The plane being visualized.
  42254. *
  42255. * @type {Plane}
  42256. */
  42257. this.plane = plane;
  42258. /**
  42259. * The side length of plane helper.
  42260. *
  42261. * @type {number}
  42262. * @default 1
  42263. */
  42264. this.size = size;
  42265. const positions2 = [ 1, 1, 0, -1, 1, 0, -1, -1, 0, 1, 1, 0, -1, -1, 0, 1, -1, 0 ];
  42266. const geometry2 = new BufferGeometry();
  42267. geometry2.setAttribute( 'position', new Float32BufferAttribute( positions2, 3 ) );
  42268. geometry2.computeBoundingSphere();
  42269. this.add( new Mesh( geometry2, new MeshBasicMaterial( { color: color, opacity: 0.2, transparent: true, depthWrite: false, toneMapped: false } ) ) );
  42270. }
  42271. updateMatrixWorld( force ) {
  42272. this.position.set( 0, 0, 0 );
  42273. this.scale.set( 0.5 * this.size, 0.5 * this.size, 1 );
  42274. this.lookAt( this.plane.normal );
  42275. this.translateZ( - this.plane.constant );
  42276. super.updateMatrixWorld( force );
  42277. }
  42278. /**
  42279. * Updates the helper to match the position and direction of the
  42280. * light being visualized.
  42281. */
  42282. dispose() {
  42283. this.geometry.dispose();
  42284. this.material.dispose();
  42285. this.children[ 0 ].geometry.dispose();
  42286. this.children[ 0 ].material.dispose();
  42287. }
  42288. }
  42289. const _axis = /*@__PURE__*/ new Vector3();
  42290. let _lineGeometry, _coneGeometry;
  42291. /**
  42292. * An 3D arrow object for visualizing directions.
  42293. *
  42294. * ```js
  42295. * const dir = new THREE.Vector3( 1, 2, 0 );
  42296. *
  42297. * //normalize the direction vector (convert to vector of length 1)
  42298. * dir.normalize();
  42299. *
  42300. * const origin = new THREE.Vector3( 0, 0, 0 );
  42301. * const length = 1;
  42302. * const hex = 0xffff00;
  42303. *
  42304. * const arrowHelper = new THREE.ArrowHelper( dir, origin, length, hex );
  42305. * scene.add( arrowHelper );
  42306. * ```
  42307. *
  42308. * @augments Object3D
  42309. */
  42310. class ArrowHelper extends Object3D {
  42311. /**
  42312. * Constructs a new arrow helper.
  42313. *
  42314. * @param {Vector3} [dir=(0, 0, 1)] - The (normalized) direction vector.
  42315. * @param {Vector3} [origin=(0, 0, 0)] - Point at which the arrow starts.
  42316. * @param {number} [length=1] - Length of the arrow in world units.
  42317. * @param {(number|Color|string)} [color=0xffff00] - Color of the arrow.
  42318. * @param {number} [headLength=length*0.2] - The length of the head of the arrow.
  42319. * @param {number} [headWidth=headLength*0.2] - The width of the head of the arrow.
  42320. */
  42321. constructor( dir = new Vector3( 0, 0, 1 ), origin = new Vector3( 0, 0, 0 ), length = 1, color = 0xffff00, headLength = length * 0.2, headWidth = headLength * 0.2 ) {
  42322. super();
  42323. this.type = 'ArrowHelper';
  42324. if ( _lineGeometry === undefined ) {
  42325. _lineGeometry = new BufferGeometry();
  42326. _lineGeometry.setAttribute( 'position', new Float32BufferAttribute( [ 0, 0, 0, 0, 1, 0 ], 3 ) );
  42327. _coneGeometry = new ConeGeometry( 0.5, 1, 5, 1 );
  42328. _coneGeometry.translate( 0, -0.5, 0 );
  42329. }
  42330. this.position.copy( origin );
  42331. /**
  42332. * The line part of the arrow helper.
  42333. *
  42334. * @type {Line}
  42335. */
  42336. this.line = new Line( _lineGeometry, new LineBasicMaterial( { color: color, toneMapped: false } ) );
  42337. this.line.matrixAutoUpdate = false;
  42338. this.add( this.line );
  42339. /**
  42340. * The cone part of the arrow helper.
  42341. *
  42342. * @type {Mesh}
  42343. */
  42344. this.cone = new Mesh( _coneGeometry, new MeshBasicMaterial( { color: color, toneMapped: false } ) );
  42345. this.cone.matrixAutoUpdate = false;
  42346. this.add( this.cone );
  42347. this.setDirection( dir );
  42348. this.setLength( length, headLength, headWidth );
  42349. }
  42350. /**
  42351. * Sets the direction of the helper.
  42352. *
  42353. * @param {Vector3} dir - The normalized direction vector.
  42354. */
  42355. setDirection( dir ) {
  42356. // dir is assumed to be normalized
  42357. if ( dir.y > 0.99999 ) {
  42358. this.quaternion.set( 0, 0, 0, 1 );
  42359. } else if ( dir.y < -0.99999 ) {
  42360. this.quaternion.set( 1, 0, 0, 0 );
  42361. } else {
  42362. _axis.set( dir.z, 0, - dir.x ).normalize();
  42363. const radians = Math.acos( dir.y );
  42364. this.quaternion.setFromAxisAngle( _axis, radians );
  42365. }
  42366. }
  42367. /**
  42368. * Sets the length of the helper.
  42369. *
  42370. * @param {number} length - Length of the arrow in world units.
  42371. * @param {number} [headLength=length*0.2] - The length of the head of the arrow.
  42372. * @param {number} [headWidth=headLength*0.2] - The width of the head of the arrow.
  42373. */
  42374. setLength( length, headLength = length * 0.2, headWidth = headLength * 0.2 ) {
  42375. this.line.scale.set( 1, Math.max( 0.0001, length - headLength ), 1 ); // see #17458
  42376. this.line.updateMatrix();
  42377. this.cone.scale.set( headWidth, headLength, headWidth );
  42378. this.cone.position.y = length;
  42379. this.cone.updateMatrix();
  42380. }
  42381. /**
  42382. * Sets the color of the helper.
  42383. *
  42384. * @param {number|Color|string} color - The color to set.
  42385. */
  42386. setColor( color ) {
  42387. this.line.material.color.set( color );
  42388. this.cone.material.color.set( color );
  42389. }
  42390. copy( source ) {
  42391. super.copy( source, false );
  42392. this.line.copy( source.line );
  42393. this.cone.copy( source.cone );
  42394. return this;
  42395. }
  42396. /**
  42397. * Frees the GPU-related resources allocated by this instance. Call this
  42398. * method whenever this instance is no longer used in your app.
  42399. */
  42400. dispose() {
  42401. this.line.geometry.dispose();
  42402. this.line.material.dispose();
  42403. this.cone.geometry.dispose();
  42404. this.cone.material.dispose();
  42405. }
  42406. }
  42407. /**
  42408. * An axis object to visualize the 3 axes in a simple way.
  42409. * The X axis is red. The Y axis is green. The Z axis is blue.
  42410. *
  42411. * ```js
  42412. * const axesHelper = new THREE.AxesHelper( 5 );
  42413. * scene.add( axesHelper );
  42414. * ```
  42415. *
  42416. * @augments LineSegments
  42417. */
  42418. class AxesHelper extends LineSegments {
  42419. /**
  42420. * Constructs a new axes helper.
  42421. *
  42422. * @param {number} [size=1] - Size of the lines representing the axes.
  42423. */
  42424. constructor( size = 1 ) {
  42425. const vertices = [
  42426. 0, 0, 0, size, 0, 0,
  42427. 0, 0, 0, 0, size, 0,
  42428. 0, 0, 0, 0, 0, size
  42429. ];
  42430. const colors = [
  42431. 1, 0, 0, 1, 0.6, 0,
  42432. 0, 1, 0, 0.6, 1, 0,
  42433. 0, 0, 1, 0, 0.6, 1
  42434. ];
  42435. const geometry = new BufferGeometry();
  42436. geometry.setAttribute( 'position', new Float32BufferAttribute( vertices, 3 ) );
  42437. geometry.setAttribute( 'color', new Float32BufferAttribute( colors, 3 ) );
  42438. const material = new LineBasicMaterial( { vertexColors: true, toneMapped: false } );
  42439. super( geometry, material );
  42440. this.type = 'AxesHelper';
  42441. }
  42442. /**
  42443. * Defines the colors of the axes helper.
  42444. *
  42445. * @param {number|Color|string} xAxisColor - The color for the x axis.
  42446. * @param {number|Color|string} yAxisColor - The color for the y axis.
  42447. * @param {number|Color|string} zAxisColor - The color for the z axis.
  42448. * @return {AxesHelper} A reference to this axes helper.
  42449. */
  42450. setColors( xAxisColor, yAxisColor, zAxisColor ) {
  42451. const color = new Color();
  42452. const array = this.geometry.attributes.color.array;
  42453. color.set( xAxisColor );
  42454. color.toArray( array, 0 );
  42455. color.toArray( array, 3 );
  42456. color.set( yAxisColor );
  42457. color.toArray( array, 6 );
  42458. color.toArray( array, 9 );
  42459. color.set( zAxisColor );
  42460. color.toArray( array, 12 );
  42461. color.toArray( array, 15 );
  42462. this.geometry.attributes.color.needsUpdate = true;
  42463. return this;
  42464. }
  42465. /**
  42466. * Frees the GPU-related resources allocated by this instance. Call this
  42467. * method whenever this instance is no longer used in your app.
  42468. */
  42469. dispose() {
  42470. this.geometry.dispose();
  42471. this.material.dispose();
  42472. }
  42473. }
  42474. /**
  42475. * This class is used to convert a series of paths to an array of
  42476. * shapes. It is specifically used in context of fonts and SVG.
  42477. */
  42478. class ShapePath {
  42479. /**
  42480. * Constructs a new shape path.
  42481. */
  42482. constructor() {
  42483. this.type = 'ShapePath';
  42484. /**
  42485. * The color of the shape.
  42486. *
  42487. * @type {Color}
  42488. */
  42489. this.color = new Color();
  42490. /**
  42491. * The paths that have been generated for this shape.
  42492. *
  42493. * @type {Array<Path>}
  42494. * @default null
  42495. */
  42496. this.subPaths = [];
  42497. /**
  42498. * The current path that is being generated.
  42499. *
  42500. * @type {?Path}
  42501. * @default null
  42502. */
  42503. this.currentPath = null;
  42504. }
  42505. /**
  42506. * Creates a new path and moves it current point to the given one.
  42507. *
  42508. * @param {number} x - The x coordinate.
  42509. * @param {number} y - The y coordinate.
  42510. * @return {ShapePath} A reference to this shape path.
  42511. */
  42512. moveTo( x, y ) {
  42513. this.currentPath = new Path();
  42514. this.subPaths.push( this.currentPath );
  42515. this.currentPath.moveTo( x, y );
  42516. return this;
  42517. }
  42518. /**
  42519. * Adds an instance of {@link LineCurve} to the path by connecting
  42520. * the current point with the given one.
  42521. *
  42522. * @param {number} x - The x coordinate of the end point.
  42523. * @param {number} y - The y coordinate of the end point.
  42524. * @return {ShapePath} A reference to this shape path.
  42525. */
  42526. lineTo( x, y ) {
  42527. this.currentPath.lineTo( x, y );
  42528. return this;
  42529. }
  42530. /**
  42531. * Adds an instance of {@link QuadraticBezierCurve} to the path by connecting
  42532. * the current point with the given one.
  42533. *
  42534. * @param {number} aCPx - The x coordinate of the control point.
  42535. * @param {number} aCPy - The y coordinate of the control point.
  42536. * @param {number} aX - The x coordinate of the end point.
  42537. * @param {number} aY - The y coordinate of the end point.
  42538. * @return {ShapePath} A reference to this shape path.
  42539. */
  42540. quadraticCurveTo( aCPx, aCPy, aX, aY ) {
  42541. this.currentPath.quadraticCurveTo( aCPx, aCPy, aX, aY );
  42542. return this;
  42543. }
  42544. /**
  42545. * Adds an instance of {@link CubicBezierCurve} to the path by connecting
  42546. * the current point with the given one.
  42547. *
  42548. * @param {number} aCP1x - The x coordinate of the first control point.
  42549. * @param {number} aCP1y - The y coordinate of the first control point.
  42550. * @param {number} aCP2x - The x coordinate of the second control point.
  42551. * @param {number} aCP2y - The y coordinate of the second control point.
  42552. * @param {number} aX - The x coordinate of the end point.
  42553. * @param {number} aY - The y coordinate of the end point.
  42554. * @return {ShapePath} A reference to this shape path.
  42555. */
  42556. bezierCurveTo( aCP1x, aCP1y, aCP2x, aCP2y, aX, aY ) {
  42557. this.currentPath.bezierCurveTo( aCP1x, aCP1y, aCP2x, aCP2y, aX, aY );
  42558. return this;
  42559. }
  42560. /**
  42561. * Adds an instance of {@link SplineCurve} to the path by connecting
  42562. * the current point with the given list of points.
  42563. *
  42564. * @param {Array<Vector2>} pts - An array of points in 2D space.
  42565. * @return {ShapePath} A reference to this shape path.
  42566. */
  42567. splineThru( pts ) {
  42568. this.currentPath.splineThru( pts );
  42569. return this;
  42570. }
  42571. /**
  42572. * Converts the paths into an array of shapes.
  42573. *
  42574. * @param {boolean} isCCW - By default solid shapes are defined clockwise (CW) and holes are defined counterclockwise (CCW).
  42575. * If this flag is set to `true`, then those are flipped.
  42576. * @return {Array<Shape>} An array of shapes.
  42577. */
  42578. toShapes( isCCW ) {
  42579. function toShapesNoHoles( inSubpaths ) {
  42580. const shapes = [];
  42581. for ( let i = 0, l = inSubpaths.length; i < l; i ++ ) {
  42582. const tmpPath = inSubpaths[ i ];
  42583. const tmpShape = new Shape();
  42584. tmpShape.curves = tmpPath.curves;
  42585. shapes.push( tmpShape );
  42586. }
  42587. return shapes;
  42588. }
  42589. function isPointInsidePolygon( inPt, inPolygon ) {
  42590. const polyLen = inPolygon.length;
  42591. // inPt on polygon contour => immediate success or
  42592. // toggling of inside/outside at every single! intersection point of an edge
  42593. // with the horizontal line through inPt, left of inPt
  42594. // not counting lowerY endpoints of edges and whole edges on that line
  42595. let inside = false;
  42596. for ( let p = polyLen - 1, q = 0; q < polyLen; p = q ++ ) {
  42597. let edgeLowPt = inPolygon[ p ];
  42598. let edgeHighPt = inPolygon[ q ];
  42599. let edgeDx = edgeHighPt.x - edgeLowPt.x;
  42600. let edgeDy = edgeHighPt.y - edgeLowPt.y;
  42601. if ( Math.abs( edgeDy ) > Number.EPSILON ) {
  42602. // not parallel
  42603. if ( edgeDy < 0 ) {
  42604. edgeLowPt = inPolygon[ q ]; edgeDx = - edgeDx;
  42605. edgeHighPt = inPolygon[ p ]; edgeDy = - edgeDy;
  42606. }
  42607. if ( ( inPt.y < edgeLowPt.y ) || ( inPt.y > edgeHighPt.y ) ) continue;
  42608. if ( inPt.y === edgeLowPt.y ) {
  42609. if ( inPt.x === edgeLowPt.x ) return true; // inPt is on contour ?
  42610. // continue; // no intersection or edgeLowPt => doesn't count !!!
  42611. } else {
  42612. const perpEdge = edgeDy * ( inPt.x - edgeLowPt.x ) - edgeDx * ( inPt.y - edgeLowPt.y );
  42613. if ( perpEdge === 0 ) return true; // inPt is on contour ?
  42614. if ( perpEdge < 0 ) continue;
  42615. inside = ! inside; // true intersection left of inPt
  42616. }
  42617. } else {
  42618. // parallel or collinear
  42619. if ( inPt.y !== edgeLowPt.y ) continue; // parallel
  42620. // edge lies on the same horizontal line as inPt
  42621. if ( ( ( edgeHighPt.x <= inPt.x ) && ( inPt.x <= edgeLowPt.x ) ) ||
  42622. ( ( edgeLowPt.x <= inPt.x ) && ( inPt.x <= edgeHighPt.x ) ) ) return true; // inPt: Point on contour !
  42623. // continue;
  42624. }
  42625. }
  42626. return inside;
  42627. }
  42628. const isClockWise = ShapeUtils.isClockWise;
  42629. const subPaths = this.subPaths;
  42630. if ( subPaths.length === 0 ) return [];
  42631. let solid, tmpPath, tmpShape;
  42632. const shapes = [];
  42633. if ( subPaths.length === 1 ) {
  42634. tmpPath = subPaths[ 0 ];
  42635. tmpShape = new Shape();
  42636. tmpShape.curves = tmpPath.curves;
  42637. shapes.push( tmpShape );
  42638. return shapes;
  42639. }
  42640. let holesFirst = ! isClockWise( subPaths[ 0 ].getPoints() );
  42641. holesFirst = isCCW ? ! holesFirst : holesFirst;
  42642. // log("Holes first", holesFirst);
  42643. const betterShapeHoles = [];
  42644. const newShapes = [];
  42645. let newShapeHoles = [];
  42646. let mainIdx = 0;
  42647. let tmpPoints;
  42648. newShapes[ mainIdx ] = undefined;
  42649. newShapeHoles[ mainIdx ] = [];
  42650. for ( let i = 0, l = subPaths.length; i < l; i ++ ) {
  42651. tmpPath = subPaths[ i ];
  42652. tmpPoints = tmpPath.getPoints();
  42653. solid = isClockWise( tmpPoints );
  42654. solid = isCCW ? ! solid : solid;
  42655. if ( solid ) {
  42656. if ( ( ! holesFirst ) && ( newShapes[ mainIdx ] ) ) mainIdx ++;
  42657. newShapes[ mainIdx ] = { s: new Shape(), p: tmpPoints };
  42658. newShapes[ mainIdx ].s.curves = tmpPath.curves;
  42659. if ( holesFirst ) mainIdx ++;
  42660. newShapeHoles[ mainIdx ] = [];
  42661. //log('cw', i);
  42662. } else {
  42663. newShapeHoles[ mainIdx ].push( { h: tmpPath, p: tmpPoints[ 0 ] } );
  42664. //log('ccw', i);
  42665. }
  42666. }
  42667. // only Holes? -> probably all Shapes with wrong orientation
  42668. if ( ! newShapes[ 0 ] ) return toShapesNoHoles( subPaths );
  42669. if ( newShapes.length > 1 ) {
  42670. let ambiguous = false;
  42671. let toChange = 0;
  42672. for ( let sIdx = 0, sLen = newShapes.length; sIdx < sLen; sIdx ++ ) {
  42673. betterShapeHoles[ sIdx ] = [];
  42674. }
  42675. for ( let sIdx = 0, sLen = newShapes.length; sIdx < sLen; sIdx ++ ) {
  42676. const sho = newShapeHoles[ sIdx ];
  42677. for ( let hIdx = 0; hIdx < sho.length; hIdx ++ ) {
  42678. const ho = sho[ hIdx ];
  42679. let hole_unassigned = true;
  42680. for ( let s2Idx = 0; s2Idx < newShapes.length; s2Idx ++ ) {
  42681. if ( isPointInsidePolygon( ho.p, newShapes[ s2Idx ].p ) ) {
  42682. if ( sIdx !== s2Idx ) toChange ++;
  42683. if ( hole_unassigned ) {
  42684. hole_unassigned = false;
  42685. betterShapeHoles[ s2Idx ].push( ho );
  42686. } else {
  42687. ambiguous = true;
  42688. }
  42689. }
  42690. }
  42691. if ( hole_unassigned ) {
  42692. betterShapeHoles[ sIdx ].push( ho );
  42693. }
  42694. }
  42695. }
  42696. if ( toChange > 0 && ambiguous === false ) {
  42697. newShapeHoles = betterShapeHoles;
  42698. }
  42699. }
  42700. let tmpHoles;
  42701. for ( let i = 0, il = newShapes.length; i < il; i ++ ) {
  42702. tmpShape = newShapes[ i ].s;
  42703. shapes.push( tmpShape );
  42704. tmpHoles = newShapeHoles[ i ];
  42705. for ( let j = 0, jl = tmpHoles.length; j < jl; j ++ ) {
  42706. tmpShape.holes.push( tmpHoles[ j ].h );
  42707. }
  42708. }
  42709. //log("shape", shapes);
  42710. return shapes;
  42711. }
  42712. }
  42713. /**
  42714. * Abstract base class for controls.
  42715. *
  42716. * @abstract
  42717. * @augments EventDispatcher
  42718. */
  42719. class Controls extends EventDispatcher {
  42720. /**
  42721. * Constructs a new controls instance.
  42722. *
  42723. * @param {Object3D} object - The object that is managed by the controls.
  42724. * @param {?HTMLElement} domElement - The HTML element used for event listeners.
  42725. */
  42726. constructor( object, domElement = null ) {
  42727. super();
  42728. /**
  42729. * The object that is managed by the controls.
  42730. *
  42731. * @type {Object3D}
  42732. */
  42733. this.object = object;
  42734. /**
  42735. * The HTML element used for event listeners.
  42736. *
  42737. * @type {?HTMLElement}
  42738. * @default null
  42739. */
  42740. this.domElement = domElement;
  42741. /**
  42742. * Whether the controls responds to user input or not.
  42743. *
  42744. * @type {boolean}
  42745. * @default true
  42746. */
  42747. this.enabled = true;
  42748. /**
  42749. * The internal state of the controls.
  42750. *
  42751. * @type {number}
  42752. * @default -1
  42753. */
  42754. this.state = -1;
  42755. /**
  42756. * This object defines the keyboard input of the controls.
  42757. *
  42758. * @type {Object}
  42759. */
  42760. this.keys = {};
  42761. /**
  42762. * This object defines what type of actions are assigned to the available mouse buttons.
  42763. * It depends on the control implementation what kind of mouse buttons and actions are supported.
  42764. *
  42765. * @type {{LEFT: ?number, MIDDLE: ?number, RIGHT: ?number}}
  42766. */
  42767. this.mouseButtons = { LEFT: null, MIDDLE: null, RIGHT: null };
  42768. /**
  42769. * This object defines what type of actions are assigned to what kind of touch interaction.
  42770. * It depends on the control implementation what kind of touch interaction and actions are supported.
  42771. *
  42772. * @type {{ONE: ?number, TWO: ?number}}
  42773. */
  42774. this.touches = { ONE: null, TWO: null };
  42775. }
  42776. /**
  42777. * Connects the controls to the DOM. This method has so called "side effects" since
  42778. * it adds the module's event listeners to the DOM.
  42779. *
  42780. * @param {HTMLElement} element - The DOM element to connect to.
  42781. */
  42782. connect( element ) {
  42783. if ( element === undefined ) {
  42784. warn( 'Controls: connect() now requires an element.' ); // @deprecated, the warning can be removed with r185
  42785. return;
  42786. }
  42787. if ( this.domElement !== null ) this.disconnect();
  42788. this.domElement = element;
  42789. }
  42790. /**
  42791. * Disconnects the controls from the DOM.
  42792. */
  42793. disconnect() {}
  42794. /**
  42795. * Call this method if you no longer want use to the controls. It frees all internal
  42796. * resources and removes all event listeners.
  42797. */
  42798. dispose() {}
  42799. /**
  42800. * Controls should implement this method if they have to update their internal state
  42801. * per simulation step.
  42802. *
  42803. * @param {number} [delta] - The time delta in seconds.
  42804. */
  42805. update( /* delta */ ) {}
  42806. }
  42807. /**
  42808. * Scales the texture as large as possible within its surface without cropping
  42809. * or stretching the texture. The method preserves the original aspect ratio of
  42810. * the texture. Akin to CSS `object-fit: contain`
  42811. *
  42812. * @param {Texture} texture - The texture.
  42813. * @param {number} aspect - The texture's aspect ratio.
  42814. * @return {Texture} The updated texture.
  42815. */
  42816. function contain( texture, aspect ) {
  42817. const imageAspect = ( texture.image && texture.image.width ) ? texture.image.width / texture.image.height : 1;
  42818. if ( imageAspect > aspect ) {
  42819. texture.repeat.x = 1;
  42820. texture.repeat.y = imageAspect / aspect;
  42821. texture.offset.x = 0;
  42822. texture.offset.y = ( 1 - texture.repeat.y ) / 2;
  42823. } else {
  42824. texture.repeat.x = aspect / imageAspect;
  42825. texture.repeat.y = 1;
  42826. texture.offset.x = ( 1 - texture.repeat.x ) / 2;
  42827. texture.offset.y = 0;
  42828. }
  42829. return texture;
  42830. }
  42831. /**
  42832. * Scales the texture to the smallest possible size to fill the surface, leaving
  42833. * no empty space. The method preserves the original aspect ratio of the texture.
  42834. * Akin to CSS `object-fit: cover`.
  42835. *
  42836. * @param {Texture} texture - The texture.
  42837. * @param {number} aspect - The texture's aspect ratio.
  42838. * @return {Texture} The updated texture.
  42839. */
  42840. function cover( texture, aspect ) {
  42841. const imageAspect = ( texture.image && texture.image.width ) ? texture.image.width / texture.image.height : 1;
  42842. if ( imageAspect > aspect ) {
  42843. texture.repeat.x = aspect / imageAspect;
  42844. texture.repeat.y = 1;
  42845. texture.offset.x = ( 1 - texture.repeat.x ) / 2;
  42846. texture.offset.y = 0;
  42847. } else {
  42848. texture.repeat.x = 1;
  42849. texture.repeat.y = imageAspect / aspect;
  42850. texture.offset.x = 0;
  42851. texture.offset.y = ( 1 - texture.repeat.y ) / 2;
  42852. }
  42853. return texture;
  42854. }
  42855. /**
  42856. * Configures the texture to the default transformation. Akin to CSS `object-fit: fill`.
  42857. *
  42858. * @param {Texture} texture - The texture.
  42859. * @return {Texture} The updated texture.
  42860. */
  42861. function fill( texture ) {
  42862. texture.repeat.x = 1;
  42863. texture.repeat.y = 1;
  42864. texture.offset.x = 0;
  42865. texture.offset.y = 0;
  42866. return texture;
  42867. }
  42868. /**
  42869. * Determines how many bytes must be used to represent the texture.
  42870. *
  42871. * @param {number} width - The width of the texture.
  42872. * @param {number} height - The height of the texture.
  42873. * @param {number} format - The texture's format.
  42874. * @param {number} type - The texture's type.
  42875. * @return {number} The byte length.
  42876. */
  42877. function getByteLength( width, height, format, type ) {
  42878. const typeByteLength = getTextureTypeByteLength( type );
  42879. switch ( format ) {
  42880. // https://registry.khronos.org/OpenGL-Refpages/es3.0/html/glTexImage2D.xhtml
  42881. case AlphaFormat:
  42882. return width * height;
  42883. case RedFormat:
  42884. return ( ( width * height ) / typeByteLength.components ) * typeByteLength.byteLength;
  42885. case RedIntegerFormat:
  42886. return ( ( width * height ) / typeByteLength.components ) * typeByteLength.byteLength;
  42887. case RGFormat:
  42888. return ( ( width * height * 2 ) / typeByteLength.components ) * typeByteLength.byteLength;
  42889. case RGIntegerFormat:
  42890. return ( ( width * height * 2 ) / typeByteLength.components ) * typeByteLength.byteLength;
  42891. case RGBFormat:
  42892. return ( ( width * height * 3 ) / typeByteLength.components ) * typeByteLength.byteLength;
  42893. case RGBAFormat:
  42894. return ( ( width * height * 4 ) / typeByteLength.components ) * typeByteLength.byteLength;
  42895. case RGBAIntegerFormat:
  42896. return ( ( width * height * 4 ) / typeByteLength.components ) * typeByteLength.byteLength;
  42897. // https://registry.khronos.org/webgl/extensions/WEBGL_compressed_texture_s3tc_srgb/
  42898. case RGB_S3TC_DXT1_Format:
  42899. case RGBA_S3TC_DXT1_Format:
  42900. return Math.floor( ( width + 3 ) / 4 ) * Math.floor( ( height + 3 ) / 4 ) * 8;
  42901. case RGBA_S3TC_DXT3_Format:
  42902. case RGBA_S3TC_DXT5_Format:
  42903. return Math.floor( ( width + 3 ) / 4 ) * Math.floor( ( height + 3 ) / 4 ) * 16;
  42904. // https://registry.khronos.org/webgl/extensions/WEBGL_compressed_texture_pvrtc/
  42905. case RGB_PVRTC_2BPPV1_Format:
  42906. case RGBA_PVRTC_2BPPV1_Format:
  42907. return ( Math.max( width, 16 ) * Math.max( height, 8 ) ) / 4;
  42908. case RGB_PVRTC_4BPPV1_Format:
  42909. case RGBA_PVRTC_4BPPV1_Format:
  42910. return ( Math.max( width, 8 ) * Math.max( height, 8 ) ) / 2;
  42911. // https://registry.khronos.org/webgl/extensions/WEBGL_compressed_texture_etc/
  42912. case RGB_ETC1_Format:
  42913. case RGB_ETC2_Format:
  42914. case R11_EAC_Format:
  42915. case SIGNED_R11_EAC_Format:
  42916. return Math.floor( ( width + 3 ) / 4 ) * Math.floor( ( height + 3 ) / 4 ) * 8;
  42917. case RGBA_ETC2_EAC_Format:
  42918. case RG11_EAC_Format:
  42919. case SIGNED_RG11_EAC_Format:
  42920. return Math.floor( ( width + 3 ) / 4 ) * Math.floor( ( height + 3 ) / 4 ) * 16;
  42921. // https://registry.khronos.org/webgl/extensions/WEBGL_compressed_texture_astc/
  42922. case RGBA_ASTC_4x4_Format:
  42923. return Math.floor( ( width + 3 ) / 4 ) * Math.floor( ( height + 3 ) / 4 ) * 16;
  42924. case RGBA_ASTC_5x4_Format:
  42925. return Math.floor( ( width + 4 ) / 5 ) * Math.floor( ( height + 3 ) / 4 ) * 16;
  42926. case RGBA_ASTC_5x5_Format:
  42927. return Math.floor( ( width + 4 ) / 5 ) * Math.floor( ( height + 4 ) / 5 ) * 16;
  42928. case RGBA_ASTC_6x5_Format:
  42929. return Math.floor( ( width + 5 ) / 6 ) * Math.floor( ( height + 4 ) / 5 ) * 16;
  42930. case RGBA_ASTC_6x6_Format:
  42931. return Math.floor( ( width + 5 ) / 6 ) * Math.floor( ( height + 5 ) / 6 ) * 16;
  42932. case RGBA_ASTC_8x5_Format:
  42933. return Math.floor( ( width + 7 ) / 8 ) * Math.floor( ( height + 4 ) / 5 ) * 16;
  42934. case RGBA_ASTC_8x6_Format:
  42935. return Math.floor( ( width + 7 ) / 8 ) * Math.floor( ( height + 5 ) / 6 ) * 16;
  42936. case RGBA_ASTC_8x8_Format:
  42937. return Math.floor( ( width + 7 ) / 8 ) * Math.floor( ( height + 7 ) / 8 ) * 16;
  42938. case RGBA_ASTC_10x5_Format:
  42939. return Math.floor( ( width + 9 ) / 10 ) * Math.floor( ( height + 4 ) / 5 ) * 16;
  42940. case RGBA_ASTC_10x6_Format:
  42941. return Math.floor( ( width + 9 ) / 10 ) * Math.floor( ( height + 5 ) / 6 ) * 16;
  42942. case RGBA_ASTC_10x8_Format:
  42943. return Math.floor( ( width + 9 ) / 10 ) * Math.floor( ( height + 7 ) / 8 ) * 16;
  42944. case RGBA_ASTC_10x10_Format:
  42945. return Math.floor( ( width + 9 ) / 10 ) * Math.floor( ( height + 9 ) / 10 ) * 16;
  42946. case RGBA_ASTC_12x10_Format:
  42947. return Math.floor( ( width + 11 ) / 12 ) * Math.floor( ( height + 9 ) / 10 ) * 16;
  42948. case RGBA_ASTC_12x12_Format:
  42949. return Math.floor( ( width + 11 ) / 12 ) * Math.floor( ( height + 11 ) / 12 ) * 16;
  42950. // https://registry.khronos.org/webgl/extensions/EXT_texture_compression_bptc/
  42951. case RGBA_BPTC_Format:
  42952. case RGB_BPTC_SIGNED_Format:
  42953. case RGB_BPTC_UNSIGNED_Format:
  42954. return Math.ceil( width / 4 ) * Math.ceil( height / 4 ) * 16;
  42955. // https://registry.khronos.org/webgl/extensions/EXT_texture_compression_rgtc/
  42956. case RED_RGTC1_Format:
  42957. case SIGNED_RED_RGTC1_Format:
  42958. return Math.ceil( width / 4 ) * Math.ceil( height / 4 ) * 8;
  42959. case RED_GREEN_RGTC2_Format:
  42960. case SIGNED_RED_GREEN_RGTC2_Format:
  42961. return Math.ceil( width / 4 ) * Math.ceil( height / 4 ) * 16;
  42962. }
  42963. throw new Error(
  42964. `Unable to determine texture byte length for ${format} format.`,
  42965. );
  42966. }
  42967. function getTextureTypeByteLength( type ) {
  42968. switch ( type ) {
  42969. case UnsignedByteType:
  42970. case ByteType:
  42971. return { byteLength: 1, components: 1 };
  42972. case UnsignedShortType:
  42973. case ShortType:
  42974. case HalfFloatType:
  42975. return { byteLength: 2, components: 1 };
  42976. case UnsignedShort4444Type:
  42977. case UnsignedShort5551Type:
  42978. return { byteLength: 2, components: 4 };
  42979. case UnsignedIntType:
  42980. case IntType:
  42981. case FloatType:
  42982. return { byteLength: 4, components: 1 };
  42983. case UnsignedInt5999Type:
  42984. case UnsignedInt101111Type:
  42985. return { byteLength: 4, components: 3 };
  42986. }
  42987. throw new Error( `Unknown texture type ${type}.` );
  42988. }
  42989. /**
  42990. * A class containing utility functions for textures.
  42991. *
  42992. * @hideconstructor
  42993. */
  42994. class TextureUtils {
  42995. /**
  42996. * Scales the texture as large as possible within its surface without cropping
  42997. * or stretching the texture. The method preserves the original aspect ratio of
  42998. * the texture. Akin to CSS `object-fit: contain`
  42999. *
  43000. * @param {Texture} texture - The texture.
  43001. * @param {number} aspect - The texture's aspect ratio.
  43002. * @return {Texture} The updated texture.
  43003. */
  43004. static contain( texture, aspect ) {
  43005. return contain( texture, aspect );
  43006. }
  43007. /**
  43008. * Scales the texture to the smallest possible size to fill the surface, leaving
  43009. * no empty space. The method preserves the original aspect ratio of the texture.
  43010. * Akin to CSS `object-fit: cover`.
  43011. *
  43012. * @param {Texture} texture - The texture.
  43013. * @param {number} aspect - The texture's aspect ratio.
  43014. * @return {Texture} The updated texture.
  43015. */
  43016. static cover( texture, aspect ) {
  43017. return cover( texture, aspect );
  43018. }
  43019. /**
  43020. * Configures the texture to the default transformation. Akin to CSS `object-fit: fill`.
  43021. *
  43022. * @param {Texture} texture - The texture.
  43023. * @return {Texture} The updated texture.
  43024. */
  43025. static fill( texture ) {
  43026. return fill( texture );
  43027. }
  43028. /**
  43029. * Determines how many bytes must be used to represent the texture.
  43030. *
  43031. * @param {number} width - The width of the texture.
  43032. * @param {number} height - The height of the texture.
  43033. * @param {number} format - The texture's format.
  43034. * @param {number} type - The texture's type.
  43035. * @return {number} The byte length.
  43036. */
  43037. static getByteLength( width, height, format, type ) {
  43038. return getByteLength( width, height, format, type );
  43039. }
  43040. }
  43041. if ( typeof __THREE_DEVTOOLS__ !== 'undefined' ) {
  43042. __THREE_DEVTOOLS__.dispatchEvent( new CustomEvent( 'register', { detail: {
  43043. revision: REVISION,
  43044. } } ) );
  43045. }
  43046. if ( typeof window !== 'undefined' ) {
  43047. if ( window.__THREE__ ) {
  43048. warn( 'WARNING: Multiple instances of Three.js being imported.' );
  43049. } else {
  43050. window.__THREE__ = REVISION;
  43051. }
  43052. }
  43053. export { ACESFilmicToneMapping, AddEquation, AddOperation, AdditiveAnimationBlendMode, AdditiveBlending, AgXToneMapping, AlphaFormat, AlwaysCompare, AlwaysDepth, AlwaysStencilFunc, AmbientLight, AnimationAction, AnimationClip, AnimationLoader, AnimationMixer, AnimationObjectGroup, AnimationUtils, ArcCurve, ArrayCamera, ArrowHelper, AttachedBindMode, Audio, AudioAnalyser, AudioContext, AudioListener, AudioLoader, AxesHelper, BackSide, BasicDepthPacking, BasicShadowMap, BatchedMesh, BezierInterpolant, Bone, BooleanKeyframeTrack, Box2, Box3, Box3Helper, BoxGeometry, BoxHelper, BufferAttribute, BufferGeometry, BufferGeometryLoader, ByteType, Cache, Camera, CameraHelper, CanvasTexture, CapsuleGeometry, CatmullRomCurve3, CineonToneMapping, CircleGeometry, ClampToEdgeWrapping, Clock, Color, ColorKeyframeTrack, ColorManagement, Compatibility, CompressedArrayTexture, CompressedCubeTexture, CompressedTexture, CompressedTextureLoader, ConeGeometry, ConstantAlphaFactor, ConstantColorFactor, Controls, CubeCamera, CubeDepthTexture, CubeReflectionMapping, CubeRefractionMapping, CubeTexture, CubeTextureLoader, CubeUVReflectionMapping, CubicBezierCurve, CubicBezierCurve3, CubicInterpolant, CullFaceBack, CullFaceFront, CullFaceFrontBack, CullFaceNone, Curve, CurvePath, CustomBlending, CustomToneMapping, CylinderGeometry, Cylindrical, Data3DTexture, DataArrayTexture, DataTexture, DataTextureLoader, DataUtils, DecrementStencilOp, DecrementWrapStencilOp, DefaultLoadingManager, DepthFormat, DepthStencilFormat, DepthTexture, DetachedBindMode, DirectionalLight, DirectionalLightHelper, DiscreteInterpolant, DodecahedronGeometry, DoubleSide, DstAlphaFactor, DstColorFactor, DynamicCopyUsage, DynamicDrawUsage, DynamicReadUsage, EdgesGeometry, EllipseCurve, EqualCompare, EqualDepth, EqualStencilFunc, EquirectangularReflectionMapping, EquirectangularRefractionMapping, Euler, EventDispatcher, ExternalTexture, ExtrudeGeometry, FileLoader, Float16BufferAttribute, Float32BufferAttribute, FloatType, Fog, FogExp2, FramebufferTexture, FrontSide, Frustum, FrustumArray, GLBufferAttribute, GLSL1, GLSL3, GreaterCompare, GreaterDepth, GreaterEqualCompare, GreaterEqualDepth, GreaterEqualStencilFunc, GreaterStencilFunc, GridHelper, Group, HalfFloatType, HemisphereLight, HemisphereLightHelper, IcosahedronGeometry, ImageBitmapLoader, ImageLoader, ImageUtils, IncrementStencilOp, IncrementWrapStencilOp, InstancedBufferAttribute, InstancedBufferGeometry, InstancedInterleavedBuffer, InstancedMesh, Int16BufferAttribute, Int32BufferAttribute, Int8BufferAttribute, IntType, InterleavedBuffer, InterleavedBufferAttribute, Interpolant, InterpolateBezier, InterpolateDiscrete, InterpolateLinear, InterpolateSmooth, InterpolationSamplingMode, InterpolationSamplingType, InvertStencilOp, KeepStencilOp, KeyframeTrack, LOD, LatheGeometry, Layers, LessCompare, LessDepth, LessEqualCompare, LessEqualDepth, LessEqualStencilFunc, LessStencilFunc, Light, LightProbe, Line, Line3, LineBasicMaterial, LineCurve, LineCurve3, LineDashedMaterial, LineLoop, LineSegments, LinearFilter, LinearInterpolant, LinearMipMapLinearFilter, LinearMipMapNearestFilter, LinearMipmapLinearFilter, LinearMipmapNearestFilter, LinearSRGBColorSpace, LinearToneMapping, LinearTransfer, Loader, LoaderUtils, LoadingManager, LoopOnce, LoopPingPong, LoopRepeat, MOUSE, Material, MaterialBlending, MaterialLoader, MathUtils, Matrix2, Matrix3, Matrix4, MaxEquation, Mesh, MeshBasicMaterial, MeshDepthMaterial, MeshDistanceMaterial, MeshLambertMaterial, MeshMatcapMaterial, MeshNormalMaterial, MeshPhongMaterial, MeshPhysicalMaterial, MeshStandardMaterial, MeshToonMaterial, MinEquation, MirroredRepeatWrapping, MixOperation, MultiplyBlending, MultiplyOperation, NearestFilter, NearestMipMapLinearFilter, NearestMipMapNearestFilter, NearestMipmapLinearFilter, NearestMipmapNearestFilter, NeutralToneMapping, NeverCompare, NeverDepth, NeverStencilFunc, NoBlending, NoColorSpace, NoNormalPacking, NoToneMapping, NormalAnimationBlendMode, NormalBlending, NormalGAPacking, NormalRGPacking, NotEqualCompare, NotEqualDepth, NotEqualStencilFunc, NumberKeyframeTrack, Object3D, ObjectLoader, ObjectSpaceNormalMap, OctahedronGeometry, OneFactor, OneMinusConstantAlphaFactor, OneMinusConstantColorFactor, OneMinusDstAlphaFactor, OneMinusDstColorFactor, OneMinusSrcAlphaFactor, OneMinusSrcColorFactor, OrthographicCamera, PCFShadowMap, PCFSoftShadowMap, Path, PerspectiveCamera, Plane, PlaneGeometry, PlaneHelper, PointLight, PointLightHelper, Points, PointsMaterial, PolarGridHelper, PolyhedronGeometry, PositionalAudio, PropertyBinding, PropertyMixer, QuadraticBezierCurve, QuadraticBezierCurve3, Quaternion, QuaternionKeyframeTrack, QuaternionLinearInterpolant, R11_EAC_Format, RAD2DEG, RED_GREEN_RGTC2_Format, RED_RGTC1_Format, REVISION, RG11_EAC_Format, RGBADepthPacking, RGBAFormat, RGBAIntegerFormat, RGBA_ASTC_10x10_Format, RGBA_ASTC_10x5_Format, RGBA_ASTC_10x6_Format, RGBA_ASTC_10x8_Format, RGBA_ASTC_12x10_Format, RGBA_ASTC_12x12_Format, RGBA_ASTC_4x4_Format, RGBA_ASTC_5x4_Format, RGBA_ASTC_5x5_Format, RGBA_ASTC_6x5_Format, RGBA_ASTC_6x6_Format, RGBA_ASTC_8x5_Format, RGBA_ASTC_8x6_Format, RGBA_ASTC_8x8_Format, RGBA_BPTC_Format, RGBA_ETC2_EAC_Format, RGBA_PVRTC_2BPPV1_Format, RGBA_PVRTC_4BPPV1_Format, RGBA_S3TC_DXT1_Format, RGBA_S3TC_DXT3_Format, RGBA_S3TC_DXT5_Format, RGBDepthPacking, RGBFormat, RGBIntegerFormat, RGB_BPTC_SIGNED_Format, RGB_BPTC_UNSIGNED_Format, RGB_ETC1_Format, RGB_ETC2_Format, RGB_PVRTC_2BPPV1_Format, RGB_PVRTC_4BPPV1_Format, RGB_S3TC_DXT1_Format, RGDepthPacking, RGFormat, RGIntegerFormat, RawShaderMaterial, Ray, Raycaster, RectAreaLight, RedFormat, RedIntegerFormat, ReinhardToneMapping, RenderTarget, RenderTarget3D, RepeatWrapping, ReplaceStencilOp, ReverseSubtractEquation, RingGeometry, SIGNED_R11_EAC_Format, SIGNED_RED_GREEN_RGTC2_Format, SIGNED_RED_RGTC1_Format, SIGNED_RG11_EAC_Format, SRGBColorSpace, SRGBTransfer, Scene, ShaderMaterial, ShadowMaterial, Shape, ShapeGeometry, ShapePath, ShapeUtils, ShortType, Skeleton, SkeletonHelper, SkinnedMesh, Source, Sphere, SphereGeometry, Spherical, SphericalHarmonics3, SplineCurve, SpotLight, SpotLightHelper, Sprite, SpriteMaterial, SrcAlphaFactor, SrcAlphaSaturateFactor, SrcColorFactor, StaticCopyUsage, StaticDrawUsage, StaticReadUsage, StereoCamera, StreamCopyUsage, StreamDrawUsage, StreamReadUsage, StringKeyframeTrack, SubtractEquation, SubtractiveBlending, TOUCH, TangentSpaceNormalMap, TetrahedronGeometry, Texture, TextureLoader, TextureUtils, Timer, TimestampQuery, TorusGeometry, TorusKnotGeometry, Triangle, TriangleFanDrawMode, TriangleStripDrawMode, TrianglesDrawMode, TubeGeometry, UVMapping, Uint16BufferAttribute, Uint32BufferAttribute, Uint8BufferAttribute, Uint8ClampedBufferAttribute, Uniform, UniformsGroup, UniformsUtils, UnsignedByteType, UnsignedInt101111Type, UnsignedInt248Type, UnsignedInt5999Type, UnsignedIntType, UnsignedShort4444Type, UnsignedShort5551Type, UnsignedShortType, VSMShadowMap, Vector2, Vector3, Vector4, VectorKeyframeTrack, VideoFrameTexture, VideoTexture, WebGL3DRenderTarget, WebGLArrayRenderTarget, WebGLCoordinateSystem, WebGLRenderTarget, WebGPUCoordinateSystem, WebXRController, WireframeGeometry, WrapAroundEnding, ZeroCurvatureEnding, ZeroFactor, ZeroSlopeEnding, ZeroStencilOp, arrayNeedsUint32, cloneUniforms, createCanvasElement, createElementNS, error, getByteLength, getConsoleFunction, getUnlitUniformColorSpace, isTypedArray, log, mergeUniforms, probeAsync, setConsoleFunction, warn, warnOnce };
粤ICP备19079148号