three.core.js 1.3 MB

12345678910111213141516171819202122232425262728293031323334353637383940414243444546474849505152535455565758596061626364656667686970717273747576777879808182838485868788899091929394959697989910010110210310410510610710810911011111211311411511611711811912012112212312412512612712812913013113213313413513613713813914014114214314414514614714814915015115215315415515615715815916016116216316416516616716816917017117217317417517617717817918018118218318418518618718818919019119219319419519619719819920020120220320420520620720820921021121221321421521621721821922022122222322422522622722822923023123223323423523623723823924024124224324424524624724824925025125225325425525625725825926026126226326426526626726826927027127227327427527627727827928028128228328428528628728828929029129229329429529629729829930030130230330430530630730830931031131231331431531631731831932032132232332432532632732832933033133233333433533633733833934034134234334434534634734834935035135235335435535635735835936036136236336436536636736836937037137237337437537637737837938038138238338438538638738838939039139239339439539639739839940040140240340440540640740840941041141241341441541641741841942042142242342442542642742842943043143243343443543643743843944044144244344444544644744844945045145245345445545645745845946046146246346446546646746846947047147247347447547647747847948048148248348448548648748848949049149249349449549649749849950050150250350450550650750850951051151251351451551651751851952052152252352452552652752852953053153253353453553653753853954054154254354454554654754854955055155255355455555655755855956056156256356456556656756856957057157257357457557657757857958058158258358458558658758858959059159259359459559659759859960060160260360460560660760860961061161261361461561661761861962062162262362462562662762862963063163263363463563663763863964064164264364464564664764864965065165265365465565665765865966066166266366466566666766866967067167267367467567667767867968068168268368468568668768868969069169269369469569669769869970070170270370470570670770870971071171271371471571671771871972072172272372472572672772872973073173273373473573673773873974074174274374474574674774874975075175275375475575675775875976076176276376476576676776876977077177277377477577677777877978078178278378478578678778878979079179279379479579679779879980080180280380480580680780880981081181281381481581681781881982082182282382482582682782882983083183283383483583683783883984084184284384484584684784884985085185285385485585685785885986086186286386486586686786886987087187287387487587687787887988088188288388488588688788888989089189289389489589689789889990090190290390490590690790890991091191291391491591691791891992092192292392492592692792892993093193293393493593693793893994094194294394494594694794894995095195295395495595695795895996096196296396496596696796896997097197297397497597697797897998098198298398498598698798898999099199299399499599699799899910001001100210031004100510061007100810091010101110121013101410151016101710181019102010211022102310241025102610271028102910301031103210331034103510361037103810391040104110421043104410451046104710481049105010511052105310541055105610571058105910601061106210631064106510661067106810691070107110721073107410751076107710781079108010811082108310841085108610871088108910901091109210931094109510961097109810991100110111021103110411051106110711081109111011111112111311141115111611171118111911201121112211231124112511261127112811291130113111321133113411351136113711381139114011411142114311441145114611471148114911501151115211531154115511561157115811591160116111621163116411651166116711681169117011711172117311741175117611771178117911801181118211831184118511861187118811891190119111921193119411951196119711981199120012011202120312041205120612071208120912101211121212131214121512161217121812191220122112221223122412251226122712281229123012311232123312341235123612371238123912401241124212431244124512461247124812491250125112521253125412551256125712581259126012611262126312641265126612671268126912701271127212731274127512761277127812791280128112821283128412851286128712881289129012911292129312941295129612971298129913001301130213031304130513061307130813091310131113121313131413151316131713181319132013211322132313241325132613271328132913301331133213331334133513361337133813391340134113421343134413451346134713481349135013511352135313541355135613571358135913601361136213631364136513661367136813691370137113721373137413751376137713781379138013811382138313841385138613871388138913901391139213931394139513961397139813991400140114021403140414051406140714081409141014111412141314141415141614171418141914201421142214231424142514261427142814291430143114321433143414351436143714381439144014411442144314441445144614471448144914501451145214531454145514561457145814591460146114621463146414651466146714681469147014711472147314741475147614771478147914801481148214831484148514861487148814891490149114921493149414951496149714981499150015011502150315041505150615071508150915101511151215131514151515161517151815191520152115221523152415251526152715281529153015311532153315341535153615371538153915401541154215431544154515461547154815491550155115521553155415551556155715581559156015611562156315641565156615671568156915701571157215731574157515761577157815791580158115821583158415851586158715881589159015911592159315941595159615971598159916001601160216031604160516061607160816091610161116121613161416151616161716181619162016211622162316241625162616271628162916301631163216331634163516361637163816391640164116421643164416451646164716481649165016511652165316541655165616571658165916601661166216631664166516661667166816691670167116721673167416751676167716781679168016811682168316841685168616871688168916901691169216931694169516961697169816991700170117021703170417051706170717081709171017111712171317141715171617171718171917201721172217231724172517261727172817291730173117321733173417351736173717381739174017411742174317441745174617471748174917501751175217531754175517561757175817591760176117621763176417651766176717681769177017711772177317741775177617771778177917801781178217831784178517861787178817891790179117921793179417951796179717981799180018011802180318041805180618071808180918101811181218131814181518161817181818191820182118221823182418251826182718281829183018311832183318341835183618371838183918401841184218431844184518461847184818491850185118521853185418551856185718581859186018611862186318641865186618671868186918701871187218731874187518761877187818791880188118821883188418851886188718881889189018911892189318941895189618971898189919001901190219031904190519061907190819091910191119121913191419151916191719181919192019211922192319241925192619271928192919301931193219331934193519361937193819391940194119421943194419451946194719481949195019511952195319541955195619571958195919601961196219631964196519661967196819691970197119721973197419751976197719781979198019811982198319841985198619871988198919901991199219931994199519961997199819992000200120022003200420052006200720082009201020112012201320142015201620172018201920202021202220232024202520262027202820292030203120322033203420352036203720382039204020412042204320442045204620472048204920502051205220532054205520562057205820592060206120622063206420652066206720682069207020712072207320742075207620772078207920802081208220832084208520862087208820892090209120922093209420952096209720982099210021012102210321042105210621072108210921102111211221132114211521162117211821192120212121222123212421252126212721282129213021312132213321342135213621372138213921402141214221432144214521462147214821492150215121522153215421552156215721582159216021612162216321642165216621672168216921702171217221732174217521762177217821792180218121822183218421852186218721882189219021912192219321942195219621972198219922002201220222032204220522062207220822092210221122122213221422152216221722182219222022212222222322242225222622272228222922302231223222332234223522362237223822392240224122422243224422452246224722482249225022512252225322542255225622572258225922602261226222632264226522662267226822692270227122722273227422752276227722782279228022812282228322842285228622872288228922902291229222932294229522962297229822992300230123022303230423052306230723082309231023112312231323142315231623172318231923202321232223232324232523262327232823292330233123322333233423352336233723382339234023412342234323442345234623472348234923502351235223532354235523562357235823592360236123622363236423652366236723682369237023712372237323742375237623772378237923802381238223832384238523862387238823892390239123922393239423952396239723982399240024012402240324042405240624072408240924102411241224132414241524162417241824192420242124222423242424252426242724282429243024312432243324342435243624372438243924402441244224432444244524462447244824492450245124522453245424552456245724582459246024612462246324642465246624672468246924702471247224732474247524762477247824792480248124822483248424852486248724882489249024912492249324942495249624972498249925002501250225032504250525062507250825092510251125122513251425152516251725182519252025212522252325242525252625272528252925302531253225332534253525362537253825392540254125422543254425452546254725482549255025512552255325542555255625572558255925602561256225632564256525662567256825692570257125722573257425752576257725782579258025812582258325842585258625872588258925902591259225932594259525962597259825992600260126022603260426052606260726082609261026112612261326142615261626172618261926202621262226232624262526262627262826292630263126322633263426352636263726382639264026412642264326442645264626472648264926502651265226532654265526562657265826592660266126622663266426652666266726682669267026712672267326742675267626772678267926802681268226832684268526862687268826892690269126922693269426952696269726982699270027012702270327042705270627072708270927102711271227132714271527162717271827192720272127222723272427252726272727282729273027312732273327342735273627372738273927402741274227432744274527462747274827492750275127522753275427552756275727582759276027612762276327642765276627672768276927702771277227732774277527762777277827792780278127822783278427852786278727882789279027912792279327942795279627972798279928002801280228032804280528062807280828092810281128122813281428152816281728182819282028212822282328242825282628272828282928302831283228332834283528362837283828392840284128422843284428452846284728482849285028512852285328542855285628572858285928602861286228632864286528662867286828692870287128722873287428752876287728782879288028812882288328842885288628872888288928902891289228932894289528962897289828992900290129022903290429052906290729082909291029112912291329142915291629172918291929202921292229232924292529262927292829292930293129322933293429352936293729382939294029412942294329442945294629472948294929502951295229532954295529562957295829592960296129622963296429652966296729682969297029712972297329742975297629772978297929802981298229832984298529862987298829892990299129922993299429952996299729982999300030013002300330043005300630073008300930103011301230133014301530163017301830193020302130223023302430253026302730283029303030313032303330343035303630373038303930403041304230433044304530463047304830493050305130523053305430553056305730583059306030613062306330643065306630673068306930703071307230733074307530763077307830793080308130823083308430853086308730883089309030913092309330943095309630973098309931003101310231033104310531063107310831093110311131123113311431153116311731183119312031213122312331243125312631273128312931303131313231333134313531363137313831393140314131423143314431453146314731483149315031513152315331543155315631573158315931603161316231633164316531663167316831693170317131723173317431753176317731783179318031813182318331843185318631873188318931903191319231933194319531963197319831993200320132023203320432053206320732083209321032113212321332143215321632173218321932203221322232233224322532263227322832293230323132323233323432353236323732383239324032413242324332443245324632473248324932503251325232533254325532563257325832593260326132623263326432653266326732683269327032713272327332743275327632773278327932803281328232833284328532863287328832893290329132923293329432953296329732983299330033013302330333043305330633073308330933103311331233133314331533163317331833193320332133223323332433253326332733283329333033313332333333343335333633373338333933403341334233433344334533463347334833493350335133523353335433553356335733583359336033613362336333643365336633673368336933703371337233733374337533763377337833793380338133823383338433853386338733883389339033913392339333943395339633973398339934003401340234033404340534063407340834093410341134123413341434153416341734183419342034213422342334243425342634273428342934303431343234333434343534363437343834393440344134423443344434453446344734483449345034513452345334543455345634573458345934603461346234633464346534663467346834693470347134723473347434753476347734783479348034813482348334843485348634873488348934903491349234933494349534963497349834993500350135023503350435053506350735083509351035113512351335143515351635173518351935203521352235233524352535263527352835293530353135323533353435353536353735383539354035413542354335443545354635473548354935503551355235533554355535563557355835593560356135623563356435653566356735683569357035713572357335743575357635773578357935803581358235833584358535863587358835893590359135923593359435953596359735983599360036013602360336043605360636073608360936103611361236133614361536163617361836193620362136223623362436253626362736283629363036313632363336343635363636373638363936403641364236433644364536463647364836493650365136523653365436553656365736583659366036613662366336643665366636673668366936703671367236733674367536763677367836793680368136823683368436853686368736883689369036913692369336943695369636973698369937003701370237033704370537063707370837093710371137123713371437153716371737183719372037213722372337243725372637273728372937303731373237333734373537363737373837393740374137423743374437453746374737483749375037513752375337543755375637573758375937603761376237633764376537663767376837693770377137723773377437753776377737783779378037813782378337843785378637873788378937903791379237933794379537963797379837993800380138023803380438053806380738083809381038113812381338143815381638173818381938203821382238233824382538263827382838293830383138323833383438353836383738383839384038413842384338443845384638473848384938503851385238533854385538563857385838593860386138623863386438653866386738683869387038713872387338743875387638773878387938803881388238833884388538863887388838893890389138923893389438953896389738983899390039013902390339043905390639073908390939103911391239133914391539163917391839193920392139223923392439253926392739283929393039313932393339343935393639373938393939403941394239433944394539463947394839493950395139523953395439553956395739583959396039613962396339643965396639673968396939703971397239733974397539763977397839793980398139823983398439853986398739883989399039913992399339943995399639973998399940004001400240034004400540064007400840094010401140124013401440154016401740184019402040214022402340244025402640274028402940304031403240334034403540364037403840394040404140424043404440454046404740484049405040514052405340544055405640574058405940604061406240634064406540664067406840694070407140724073407440754076407740784079408040814082408340844085408640874088408940904091409240934094409540964097409840994100410141024103410441054106410741084109411041114112411341144115411641174118411941204121412241234124412541264127412841294130413141324133413441354136413741384139414041414142414341444145414641474148414941504151415241534154415541564157415841594160416141624163416441654166416741684169417041714172417341744175417641774178417941804181418241834184418541864187418841894190419141924193419441954196419741984199420042014202420342044205420642074208420942104211421242134214421542164217421842194220422142224223422442254226422742284229423042314232423342344235423642374238423942404241424242434244424542464247424842494250425142524253425442554256425742584259426042614262426342644265426642674268426942704271427242734274427542764277427842794280428142824283428442854286428742884289429042914292429342944295429642974298429943004301430243034304430543064307430843094310431143124313431443154316431743184319432043214322432343244325432643274328432943304331433243334334433543364337433843394340434143424343434443454346434743484349435043514352435343544355435643574358435943604361436243634364436543664367436843694370437143724373437443754376437743784379438043814382438343844385438643874388438943904391439243934394439543964397439843994400440144024403440444054406440744084409441044114412441344144415441644174418441944204421442244234424442544264427442844294430443144324433443444354436443744384439444044414442444344444445444644474448444944504451445244534454445544564457445844594460446144624463446444654466446744684469447044714472447344744475447644774478447944804481448244834484448544864487448844894490449144924493449444954496449744984499450045014502450345044505450645074508450945104511451245134514451545164517451845194520452145224523452445254526452745284529453045314532453345344535453645374538453945404541454245434544454545464547454845494550455145524553455445554556455745584559456045614562456345644565456645674568456945704571457245734574457545764577457845794580458145824583458445854586458745884589459045914592459345944595459645974598459946004601460246034604460546064607460846094610461146124613461446154616461746184619462046214622462346244625462646274628462946304631463246334634463546364637463846394640464146424643464446454646464746484649465046514652465346544655465646574658465946604661466246634664466546664667466846694670467146724673467446754676467746784679468046814682468346844685468646874688468946904691469246934694469546964697469846994700470147024703470447054706470747084709471047114712471347144715471647174718471947204721472247234724472547264727472847294730473147324733473447354736473747384739474047414742474347444745474647474748474947504751475247534754475547564757475847594760476147624763476447654766476747684769477047714772477347744775477647774778477947804781478247834784478547864787478847894790479147924793479447954796479747984799480048014802480348044805480648074808480948104811481248134814481548164817481848194820482148224823482448254826482748284829483048314832483348344835483648374838483948404841484248434844484548464847484848494850485148524853485448554856485748584859486048614862486348644865486648674868486948704871487248734874487548764877487848794880488148824883488448854886488748884889489048914892489348944895489648974898489949004901490249034904490549064907490849094910491149124913491449154916491749184919492049214922492349244925492649274928492949304931493249334934493549364937493849394940494149424943494449454946494749484949495049514952495349544955495649574958495949604961496249634964496549664967496849694970497149724973497449754976497749784979498049814982498349844985498649874988498949904991499249934994499549964997499849995000500150025003500450055006500750085009501050115012501350145015501650175018501950205021502250235024502550265027502850295030503150325033503450355036503750385039504050415042504350445045504650475048504950505051505250535054505550565057505850595060506150625063506450655066506750685069507050715072507350745075507650775078507950805081508250835084508550865087508850895090509150925093509450955096509750985099510051015102510351045105510651075108510951105111511251135114511551165117511851195120512151225123512451255126512751285129513051315132513351345135513651375138513951405141514251435144514551465147514851495150515151525153515451555156515751585159516051615162516351645165516651675168516951705171517251735174517551765177517851795180518151825183518451855186518751885189519051915192519351945195519651975198519952005201520252035204520552065207520852095210521152125213521452155216521752185219522052215222522352245225522652275228522952305231523252335234523552365237523852395240524152425243524452455246524752485249525052515252525352545255525652575258525952605261526252635264526552665267526852695270527152725273527452755276527752785279528052815282528352845285528652875288528952905291529252935294529552965297529852995300530153025303530453055306530753085309531053115312531353145315531653175318531953205321532253235324532553265327532853295330533153325333533453355336533753385339534053415342534353445345534653475348534953505351535253535354535553565357535853595360536153625363536453655366536753685369537053715372537353745375537653775378537953805381538253835384538553865387538853895390539153925393539453955396539753985399540054015402540354045405540654075408540954105411541254135414541554165417541854195420542154225423542454255426542754285429543054315432543354345435543654375438543954405441544254435444544554465447544854495450545154525453545454555456545754585459546054615462546354645465546654675468546954705471547254735474547554765477547854795480548154825483548454855486548754885489549054915492549354945495549654975498549955005501550255035504550555065507550855095510551155125513551455155516551755185519552055215522552355245525552655275528552955305531553255335534553555365537553855395540554155425543554455455546554755485549555055515552555355545555555655575558555955605561556255635564556555665567556855695570557155725573557455755576557755785579558055815582558355845585558655875588558955905591559255935594559555965597559855995600560156025603560456055606560756085609561056115612561356145615561656175618561956205621562256235624562556265627562856295630563156325633563456355636563756385639564056415642564356445645564656475648564956505651565256535654565556565657565856595660566156625663566456655666566756685669567056715672567356745675567656775678567956805681568256835684568556865687568856895690569156925693569456955696569756985699570057015702570357045705570657075708570957105711571257135714571557165717571857195720572157225723572457255726572757285729573057315732573357345735573657375738573957405741574257435744574557465747574857495750575157525753575457555756575757585759576057615762576357645765576657675768576957705771577257735774577557765777577857795780578157825783578457855786578757885789579057915792579357945795579657975798579958005801580258035804580558065807580858095810581158125813581458155816581758185819582058215822582358245825582658275828582958305831583258335834583558365837583858395840584158425843584458455846584758485849585058515852585358545855585658575858585958605861586258635864586558665867586858695870587158725873587458755876587758785879588058815882588358845885588658875888588958905891589258935894589558965897589858995900590159025903590459055906590759085909591059115912591359145915591659175918591959205921592259235924592559265927592859295930593159325933593459355936593759385939594059415942594359445945594659475948594959505951595259535954595559565957595859595960596159625963596459655966596759685969597059715972597359745975597659775978597959805981598259835984598559865987598859895990599159925993599459955996599759985999600060016002600360046005600660076008600960106011601260136014601560166017601860196020602160226023602460256026602760286029603060316032603360346035603660376038603960406041604260436044604560466047604860496050605160526053605460556056605760586059606060616062606360646065606660676068606960706071607260736074607560766077607860796080608160826083608460856086608760886089609060916092609360946095609660976098609961006101610261036104610561066107610861096110611161126113611461156116611761186119612061216122612361246125612661276128612961306131613261336134613561366137613861396140614161426143614461456146614761486149615061516152615361546155615661576158615961606161616261636164616561666167616861696170617161726173617461756176617761786179618061816182618361846185618661876188618961906191619261936194619561966197619861996200620162026203620462056206620762086209621062116212621362146215621662176218621962206221622262236224622562266227622862296230623162326233623462356236623762386239624062416242624362446245624662476248624962506251625262536254625562566257625862596260626162626263626462656266626762686269627062716272627362746275627662776278627962806281628262836284628562866287628862896290629162926293629462956296629762986299630063016302630363046305630663076308630963106311631263136314631563166317631863196320632163226323632463256326632763286329633063316332633363346335633663376338633963406341634263436344634563466347634863496350635163526353635463556356635763586359636063616362636363646365636663676368636963706371637263736374637563766377637863796380638163826383638463856386638763886389639063916392639363946395639663976398639964006401640264036404640564066407640864096410641164126413641464156416641764186419642064216422642364246425642664276428642964306431643264336434643564366437643864396440644164426443644464456446644764486449645064516452645364546455645664576458645964606461646264636464646564666467646864696470647164726473647464756476647764786479648064816482648364846485648664876488648964906491649264936494649564966497649864996500650165026503650465056506650765086509651065116512651365146515651665176518651965206521652265236524652565266527652865296530653165326533653465356536653765386539654065416542654365446545654665476548654965506551655265536554655565566557655865596560656165626563656465656566656765686569657065716572657365746575657665776578657965806581658265836584658565866587658865896590659165926593659465956596659765986599660066016602660366046605660666076608660966106611661266136614661566166617661866196620662166226623662466256626662766286629663066316632663366346635663666376638663966406641664266436644664566466647664866496650665166526653665466556656665766586659666066616662666366646665666666676668666966706671667266736674667566766677667866796680668166826683668466856686668766886689669066916692669366946695669666976698669967006701670267036704670567066707670867096710671167126713671467156716671767186719672067216722672367246725672667276728672967306731673267336734673567366737673867396740674167426743674467456746674767486749675067516752675367546755675667576758675967606761676267636764676567666767676867696770677167726773677467756776677767786779678067816782678367846785678667876788678967906791679267936794679567966797679867996800680168026803680468056806680768086809681068116812681368146815681668176818681968206821682268236824682568266827682868296830683168326833683468356836683768386839684068416842684368446845684668476848684968506851685268536854685568566857685868596860686168626863686468656866686768686869687068716872687368746875687668776878687968806881688268836884688568866887688868896890689168926893689468956896689768986899690069016902690369046905690669076908690969106911691269136914691569166917691869196920692169226923692469256926692769286929693069316932693369346935693669376938693969406941694269436944694569466947694869496950695169526953695469556956695769586959696069616962696369646965696669676968696969706971697269736974697569766977697869796980698169826983698469856986698769886989699069916992699369946995699669976998699970007001700270037004700570067007700870097010701170127013701470157016701770187019702070217022702370247025702670277028702970307031703270337034703570367037703870397040704170427043704470457046704770487049705070517052705370547055705670577058705970607061706270637064706570667067706870697070707170727073707470757076707770787079708070817082708370847085708670877088708970907091709270937094709570967097709870997100710171027103710471057106710771087109711071117112711371147115711671177118711971207121712271237124712571267127712871297130713171327133713471357136713771387139714071417142714371447145714671477148714971507151715271537154715571567157715871597160716171627163716471657166716771687169717071717172717371747175717671777178717971807181718271837184718571867187718871897190719171927193719471957196719771987199720072017202720372047205720672077208720972107211721272137214721572167217721872197220722172227223722472257226722772287229723072317232723372347235723672377238723972407241724272437244724572467247724872497250725172527253725472557256725772587259726072617262726372647265726672677268726972707271727272737274727572767277727872797280728172827283728472857286728772887289729072917292729372947295729672977298729973007301730273037304730573067307730873097310731173127313731473157316731773187319732073217322732373247325732673277328732973307331733273337334733573367337733873397340734173427343734473457346734773487349735073517352735373547355735673577358735973607361736273637364736573667367736873697370737173727373737473757376737773787379738073817382738373847385738673877388738973907391739273937394739573967397739873997400740174027403740474057406740774087409741074117412741374147415741674177418741974207421742274237424742574267427742874297430743174327433743474357436743774387439744074417442744374447445744674477448744974507451745274537454745574567457745874597460746174627463746474657466746774687469747074717472747374747475747674777478747974807481748274837484748574867487748874897490749174927493749474957496749774987499750075017502750375047505750675077508750975107511751275137514751575167517751875197520752175227523752475257526752775287529753075317532753375347535753675377538753975407541754275437544754575467547754875497550755175527553755475557556755775587559756075617562756375647565756675677568756975707571757275737574757575767577757875797580758175827583758475857586758775887589759075917592759375947595759675977598759976007601760276037604760576067607760876097610761176127613761476157616761776187619762076217622762376247625762676277628762976307631763276337634763576367637763876397640764176427643764476457646764776487649765076517652765376547655765676577658765976607661766276637664766576667667766876697670767176727673767476757676767776787679768076817682768376847685768676877688768976907691769276937694769576967697769876997700770177027703770477057706770777087709771077117712771377147715771677177718771977207721772277237724772577267727772877297730773177327733773477357736773777387739774077417742774377447745774677477748774977507751775277537754775577567757775877597760776177627763776477657766776777687769777077717772777377747775777677777778777977807781778277837784778577867787778877897790779177927793779477957796779777987799780078017802780378047805780678077808780978107811781278137814781578167817781878197820782178227823782478257826782778287829783078317832783378347835783678377838783978407841784278437844784578467847784878497850785178527853785478557856785778587859786078617862786378647865786678677868786978707871787278737874787578767877787878797880788178827883788478857886788778887889789078917892789378947895789678977898789979007901790279037904790579067907790879097910791179127913791479157916791779187919792079217922792379247925792679277928792979307931793279337934793579367937793879397940794179427943794479457946794779487949795079517952795379547955795679577958795979607961796279637964796579667967796879697970797179727973797479757976797779787979798079817982798379847985798679877988798979907991799279937994799579967997799879998000800180028003800480058006800780088009801080118012801380148015801680178018801980208021802280238024802580268027802880298030803180328033803480358036803780388039804080418042804380448045804680478048804980508051805280538054805580568057805880598060806180628063806480658066806780688069807080718072807380748075807680778078807980808081808280838084808580868087808880898090809180928093809480958096809780988099810081018102810381048105810681078108810981108111811281138114811581168117811881198120812181228123812481258126812781288129813081318132813381348135813681378138813981408141814281438144814581468147814881498150815181528153815481558156815781588159816081618162816381648165816681678168816981708171817281738174817581768177817881798180818181828183818481858186818781888189819081918192819381948195819681978198819982008201820282038204820582068207820882098210821182128213821482158216821782188219822082218222822382248225822682278228822982308231823282338234823582368237823882398240824182428243824482458246824782488249825082518252825382548255825682578258825982608261826282638264826582668267826882698270827182728273827482758276827782788279828082818282828382848285828682878288828982908291829282938294829582968297829882998300830183028303830483058306830783088309831083118312831383148315831683178318831983208321832283238324832583268327832883298330833183328333833483358336833783388339834083418342834383448345834683478348834983508351835283538354835583568357835883598360836183628363836483658366836783688369837083718372837383748375837683778378837983808381838283838384838583868387838883898390839183928393839483958396839783988399840084018402840384048405840684078408840984108411841284138414841584168417841884198420842184228423842484258426842784288429843084318432843384348435843684378438843984408441844284438444844584468447844884498450845184528453845484558456845784588459846084618462846384648465846684678468846984708471847284738474847584768477847884798480848184828483848484858486848784888489849084918492849384948495849684978498849985008501850285038504850585068507850885098510851185128513851485158516851785188519852085218522852385248525852685278528852985308531853285338534853585368537853885398540854185428543854485458546854785488549855085518552855385548555855685578558855985608561856285638564856585668567856885698570857185728573857485758576857785788579858085818582858385848585858685878588858985908591859285938594859585968597859885998600860186028603860486058606860786088609861086118612861386148615861686178618861986208621862286238624862586268627862886298630863186328633863486358636863786388639864086418642864386448645864686478648864986508651865286538654865586568657865886598660866186628663866486658666866786688669867086718672867386748675867686778678867986808681868286838684868586868687868886898690869186928693869486958696869786988699870087018702870387048705870687078708870987108711871287138714871587168717871887198720872187228723872487258726872787288729873087318732873387348735873687378738873987408741874287438744874587468747874887498750875187528753875487558756875787588759876087618762876387648765876687678768876987708771877287738774877587768777877887798780878187828783878487858786878787888789879087918792879387948795879687978798879988008801880288038804880588068807880888098810881188128813881488158816881788188819882088218822882388248825882688278828882988308831883288338834883588368837883888398840884188428843884488458846884788488849885088518852885388548855885688578858885988608861886288638864886588668867886888698870887188728873887488758876887788788879888088818882888388848885888688878888888988908891889288938894889588968897889888998900890189028903890489058906890789088909891089118912891389148915891689178918891989208921892289238924892589268927892889298930893189328933893489358936893789388939894089418942894389448945894689478948894989508951895289538954895589568957895889598960896189628963896489658966896789688969897089718972897389748975897689778978897989808981898289838984898589868987898889898990899189928993899489958996899789988999900090019002900390049005900690079008900990109011901290139014901590169017901890199020902190229023902490259026902790289029903090319032903390349035903690379038903990409041904290439044904590469047904890499050905190529053905490559056905790589059906090619062906390649065906690679068906990709071907290739074907590769077907890799080908190829083908490859086908790889089909090919092909390949095909690979098909991009101910291039104910591069107910891099110911191129113911491159116911791189119912091219122912391249125912691279128912991309131913291339134913591369137913891399140914191429143914491459146914791489149915091519152915391549155915691579158915991609161916291639164916591669167916891699170917191729173917491759176917791789179918091819182918391849185918691879188918991909191919291939194919591969197919891999200920192029203920492059206920792089209921092119212921392149215921692179218921992209221922292239224922592269227922892299230923192329233923492359236923792389239924092419242924392449245924692479248924992509251925292539254925592569257925892599260926192629263926492659266926792689269927092719272927392749275927692779278927992809281928292839284928592869287928892899290929192929293929492959296929792989299930093019302930393049305930693079308930993109311931293139314931593169317931893199320932193229323932493259326932793289329933093319332933393349335933693379338933993409341934293439344934593469347934893499350935193529353935493559356935793589359936093619362936393649365936693679368936993709371937293739374937593769377937893799380938193829383938493859386938793889389939093919392939393949395939693979398939994009401940294039404940594069407940894099410941194129413941494159416941794189419942094219422942394249425942694279428942994309431943294339434943594369437943894399440944194429443944494459446944794489449945094519452945394549455945694579458945994609461946294639464946594669467946894699470947194729473947494759476947794789479948094819482948394849485948694879488948994909491949294939494949594969497949894999500950195029503950495059506950795089509951095119512951395149515951695179518951995209521952295239524952595269527952895299530953195329533953495359536953795389539954095419542954395449545954695479548954995509551955295539554955595569557955895599560956195629563956495659566956795689569957095719572957395749575957695779578957995809581958295839584958595869587958895899590959195929593959495959596959795989599960096019602960396049605960696079608960996109611961296139614961596169617961896199620962196229623962496259626962796289629963096319632963396349635963696379638963996409641964296439644964596469647964896499650965196529653965496559656965796589659966096619662966396649665966696679668966996709671967296739674967596769677967896799680968196829683968496859686968796889689969096919692969396949695969696979698969997009701970297039704970597069707970897099710971197129713971497159716971797189719972097219722972397249725972697279728972997309731973297339734973597369737973897399740974197429743974497459746974797489749975097519752975397549755975697579758975997609761976297639764976597669767976897699770977197729773977497759776977797789779978097819782978397849785978697879788978997909791979297939794979597969797979897999800980198029803980498059806980798089809981098119812981398149815981698179818981998209821982298239824982598269827982898299830983198329833983498359836983798389839984098419842984398449845984698479848984998509851985298539854985598569857985898599860986198629863986498659866986798689869987098719872987398749875987698779878987998809881988298839884988598869887988898899890989198929893989498959896989798989899990099019902990399049905990699079908990999109911991299139914991599169917991899199920992199229923992499259926992799289929993099319932993399349935993699379938993999409941994299439944994599469947994899499950995199529953995499559956995799589959996099619962996399649965996699679968996999709971997299739974997599769977997899799980998199829983998499859986998799889989999099919992999399949995999699979998999910000100011000210003100041000510006100071000810009100101001110012100131001410015100161001710018100191002010021100221002310024100251002610027100281002910030100311003210033100341003510036100371003810039100401004110042100431004410045100461004710048100491005010051100521005310054100551005610057100581005910060100611006210063100641006510066100671006810069100701007110072100731007410075100761007710078100791008010081100821008310084100851008610087100881008910090100911009210093100941009510096100971009810099101001010110102101031010410105101061010710108101091011010111101121011310114101151011610117101181011910120101211012210123101241012510126101271012810129101301013110132101331013410135101361013710138101391014010141101421014310144101451014610147101481014910150101511015210153101541015510156101571015810159101601016110162101631016410165101661016710168101691017010171101721017310174101751017610177101781017910180101811018210183101841018510186101871018810189101901019110192101931019410195101961019710198101991020010201102021020310204102051020610207102081020910210102111021210213102141021510216102171021810219102201022110222102231022410225102261022710228102291023010231102321023310234102351023610237102381023910240102411024210243102441024510246102471024810249102501025110252102531025410255102561025710258102591026010261102621026310264102651026610267102681026910270102711027210273102741027510276102771027810279102801028110282102831028410285102861028710288102891029010291102921029310294102951029610297102981029910300103011030210303103041030510306103071030810309103101031110312103131031410315103161031710318103191032010321103221032310324103251032610327103281032910330103311033210333103341033510336103371033810339103401034110342103431034410345103461034710348103491035010351103521035310354103551035610357103581035910360103611036210363103641036510366103671036810369103701037110372103731037410375103761037710378103791038010381103821038310384103851038610387103881038910390103911039210393103941039510396103971039810399104001040110402104031040410405104061040710408104091041010411104121041310414104151041610417104181041910420104211042210423104241042510426104271042810429104301043110432104331043410435104361043710438104391044010441104421044310444104451044610447104481044910450104511045210453104541045510456104571045810459104601046110462104631046410465104661046710468104691047010471104721047310474104751047610477104781047910480104811048210483104841048510486104871048810489104901049110492104931049410495104961049710498104991050010501105021050310504105051050610507105081050910510105111051210513105141051510516105171051810519105201052110522105231052410525105261052710528105291053010531105321053310534105351053610537105381053910540105411054210543105441054510546105471054810549105501055110552105531055410555105561055710558105591056010561105621056310564105651056610567105681056910570105711057210573105741057510576105771057810579105801058110582105831058410585105861058710588105891059010591105921059310594105951059610597105981059910600106011060210603106041060510606106071060810609106101061110612106131061410615106161061710618106191062010621106221062310624106251062610627106281062910630106311063210633106341063510636106371063810639106401064110642106431064410645106461064710648106491065010651106521065310654106551065610657106581065910660106611066210663106641066510666106671066810669106701067110672106731067410675106761067710678106791068010681106821068310684106851068610687106881068910690106911069210693106941069510696106971069810699107001070110702107031070410705107061070710708107091071010711107121071310714107151071610717107181071910720107211072210723107241072510726107271072810729107301073110732107331073410735107361073710738107391074010741107421074310744107451074610747107481074910750107511075210753107541075510756107571075810759107601076110762107631076410765107661076710768107691077010771107721077310774107751077610777107781077910780107811078210783107841078510786107871078810789107901079110792107931079410795107961079710798107991080010801108021080310804108051080610807108081080910810108111081210813108141081510816108171081810819108201082110822108231082410825108261082710828108291083010831108321083310834108351083610837108381083910840108411084210843108441084510846108471084810849108501085110852108531085410855108561085710858108591086010861108621086310864108651086610867108681086910870108711087210873108741087510876108771087810879108801088110882108831088410885108861088710888108891089010891108921089310894108951089610897108981089910900109011090210903109041090510906109071090810909109101091110912109131091410915109161091710918109191092010921109221092310924109251092610927109281092910930109311093210933109341093510936109371093810939109401094110942109431094410945109461094710948109491095010951109521095310954109551095610957109581095910960109611096210963109641096510966109671096810969109701097110972109731097410975109761097710978109791098010981109821098310984109851098610987109881098910990109911099210993109941099510996109971099810999110001100111002110031100411005110061100711008110091101011011110121101311014110151101611017110181101911020110211102211023110241102511026110271102811029110301103111032110331103411035110361103711038110391104011041110421104311044110451104611047110481104911050110511105211053110541105511056110571105811059110601106111062110631106411065110661106711068110691107011071110721107311074110751107611077110781107911080110811108211083110841108511086110871108811089110901109111092110931109411095110961109711098110991110011101111021110311104111051110611107111081110911110111111111211113111141111511116111171111811119111201112111122111231112411125111261112711128111291113011131111321113311134111351113611137111381113911140111411114211143111441114511146111471114811149111501115111152111531115411155111561115711158111591116011161111621116311164111651116611167111681116911170111711117211173111741117511176111771117811179111801118111182111831118411185111861118711188111891119011191111921119311194111951119611197111981119911200112011120211203112041120511206112071120811209112101121111212112131121411215112161121711218112191122011221112221122311224112251122611227112281122911230112311123211233112341123511236112371123811239112401124111242112431124411245112461124711248112491125011251112521125311254112551125611257112581125911260112611126211263112641126511266112671126811269112701127111272112731127411275112761127711278112791128011281112821128311284112851128611287112881128911290112911129211293112941129511296112971129811299113001130111302113031130411305113061130711308113091131011311113121131311314113151131611317113181131911320113211132211323113241132511326113271132811329113301133111332113331133411335113361133711338113391134011341113421134311344113451134611347113481134911350113511135211353113541135511356113571135811359113601136111362113631136411365113661136711368113691137011371113721137311374113751137611377113781137911380113811138211383113841138511386113871138811389113901139111392113931139411395113961139711398113991140011401114021140311404114051140611407114081140911410114111141211413114141141511416114171141811419114201142111422114231142411425114261142711428114291143011431114321143311434114351143611437114381143911440114411144211443114441144511446114471144811449114501145111452114531145411455114561145711458114591146011461114621146311464114651146611467114681146911470114711147211473114741147511476114771147811479114801148111482114831148411485114861148711488114891149011491114921149311494114951149611497114981149911500115011150211503115041150511506115071150811509115101151111512115131151411515115161151711518115191152011521115221152311524115251152611527115281152911530115311153211533115341153511536115371153811539115401154111542115431154411545115461154711548115491155011551115521155311554115551155611557115581155911560115611156211563115641156511566115671156811569115701157111572115731157411575115761157711578115791158011581115821158311584115851158611587115881158911590115911159211593115941159511596115971159811599116001160111602116031160411605116061160711608116091161011611116121161311614116151161611617116181161911620116211162211623116241162511626116271162811629116301163111632116331163411635116361163711638116391164011641116421164311644116451164611647116481164911650116511165211653116541165511656116571165811659116601166111662116631166411665116661166711668116691167011671116721167311674116751167611677116781167911680116811168211683116841168511686116871168811689116901169111692116931169411695116961169711698116991170011701117021170311704117051170611707117081170911710117111171211713117141171511716117171171811719117201172111722117231172411725117261172711728117291173011731117321173311734117351173611737117381173911740117411174211743117441174511746117471174811749117501175111752117531175411755117561175711758117591176011761117621176311764117651176611767117681176911770117711177211773117741177511776117771177811779117801178111782117831178411785117861178711788117891179011791117921179311794117951179611797117981179911800118011180211803118041180511806118071180811809118101181111812118131181411815118161181711818118191182011821118221182311824118251182611827118281182911830118311183211833118341183511836118371183811839118401184111842118431184411845118461184711848118491185011851118521185311854118551185611857118581185911860118611186211863118641186511866118671186811869118701187111872118731187411875118761187711878118791188011881118821188311884118851188611887118881188911890118911189211893118941189511896118971189811899119001190111902119031190411905119061190711908119091191011911119121191311914119151191611917119181191911920119211192211923119241192511926119271192811929119301193111932119331193411935119361193711938119391194011941119421194311944119451194611947119481194911950119511195211953119541195511956119571195811959119601196111962119631196411965119661196711968119691197011971119721197311974119751197611977119781197911980119811198211983119841198511986119871198811989119901199111992119931199411995119961199711998119991200012001120021200312004120051200612007120081200912010120111201212013120141201512016120171201812019120201202112022120231202412025120261202712028120291203012031120321203312034120351203612037120381203912040120411204212043120441204512046120471204812049120501205112052120531205412055120561205712058120591206012061120621206312064120651206612067120681206912070120711207212073120741207512076120771207812079120801208112082120831208412085120861208712088120891209012091120921209312094120951209612097120981209912100121011210212103121041210512106121071210812109121101211112112121131211412115121161211712118121191212012121121221212312124121251212612127121281212912130121311213212133121341213512136121371213812139121401214112142121431214412145121461214712148121491215012151121521215312154121551215612157121581215912160121611216212163121641216512166121671216812169121701217112172121731217412175121761217712178121791218012181121821218312184121851218612187121881218912190121911219212193121941219512196121971219812199122001220112202122031220412205122061220712208122091221012211122121221312214122151221612217122181221912220122211222212223122241222512226122271222812229122301223112232122331223412235122361223712238122391224012241122421224312244122451224612247122481224912250122511225212253122541225512256122571225812259122601226112262122631226412265122661226712268122691227012271122721227312274122751227612277122781227912280122811228212283122841228512286122871228812289122901229112292122931229412295122961229712298122991230012301123021230312304123051230612307123081230912310123111231212313123141231512316123171231812319123201232112322123231232412325123261232712328123291233012331123321233312334123351233612337123381233912340123411234212343123441234512346123471234812349123501235112352123531235412355123561235712358123591236012361123621236312364123651236612367123681236912370123711237212373123741237512376123771237812379123801238112382123831238412385123861238712388123891239012391123921239312394123951239612397123981239912400124011240212403124041240512406124071240812409124101241112412124131241412415124161241712418124191242012421124221242312424124251242612427124281242912430124311243212433124341243512436124371243812439124401244112442124431244412445124461244712448124491245012451124521245312454124551245612457124581245912460124611246212463124641246512466124671246812469124701247112472124731247412475124761247712478124791248012481124821248312484124851248612487124881248912490124911249212493124941249512496124971249812499125001250112502125031250412505125061250712508125091251012511125121251312514125151251612517125181251912520125211252212523125241252512526125271252812529125301253112532125331253412535125361253712538125391254012541125421254312544125451254612547125481254912550125511255212553125541255512556125571255812559125601256112562125631256412565125661256712568125691257012571125721257312574125751257612577125781257912580125811258212583125841258512586125871258812589125901259112592125931259412595125961259712598125991260012601126021260312604126051260612607126081260912610126111261212613126141261512616126171261812619126201262112622126231262412625126261262712628126291263012631126321263312634126351263612637126381263912640126411264212643126441264512646126471264812649126501265112652126531265412655126561265712658126591266012661126621266312664126651266612667126681266912670126711267212673126741267512676126771267812679126801268112682126831268412685126861268712688126891269012691126921269312694126951269612697126981269912700127011270212703127041270512706127071270812709127101271112712127131271412715127161271712718127191272012721127221272312724127251272612727127281272912730127311273212733127341273512736127371273812739127401274112742127431274412745127461274712748127491275012751127521275312754127551275612757127581275912760127611276212763127641276512766127671276812769127701277112772127731277412775127761277712778127791278012781127821278312784127851278612787127881278912790127911279212793127941279512796127971279812799128001280112802128031280412805128061280712808128091281012811128121281312814128151281612817128181281912820128211282212823128241282512826128271282812829128301283112832128331283412835128361283712838128391284012841128421284312844128451284612847128481284912850128511285212853128541285512856128571285812859128601286112862128631286412865128661286712868128691287012871128721287312874128751287612877128781287912880128811288212883128841288512886128871288812889128901289112892128931289412895128961289712898128991290012901129021290312904129051290612907129081290912910129111291212913129141291512916129171291812919129201292112922129231292412925129261292712928129291293012931129321293312934129351293612937129381293912940129411294212943129441294512946129471294812949129501295112952129531295412955129561295712958129591296012961129621296312964129651296612967129681296912970129711297212973129741297512976129771297812979129801298112982129831298412985129861298712988129891299012991129921299312994129951299612997129981299913000130011300213003130041300513006130071300813009130101301113012130131301413015130161301713018130191302013021130221302313024130251302613027130281302913030130311303213033130341303513036130371303813039130401304113042130431304413045130461304713048130491305013051130521305313054130551305613057130581305913060130611306213063130641306513066130671306813069130701307113072130731307413075130761307713078130791308013081130821308313084130851308613087130881308913090130911309213093130941309513096130971309813099131001310113102131031310413105131061310713108131091311013111131121311313114131151311613117131181311913120131211312213123131241312513126131271312813129131301313113132131331313413135131361313713138131391314013141131421314313144131451314613147131481314913150131511315213153131541315513156131571315813159131601316113162131631316413165131661316713168131691317013171131721317313174131751317613177131781317913180131811318213183131841318513186131871318813189131901319113192131931319413195131961319713198131991320013201132021320313204132051320613207132081320913210132111321213213132141321513216132171321813219132201322113222132231322413225132261322713228132291323013231132321323313234132351323613237132381323913240132411324213243132441324513246132471324813249132501325113252132531325413255132561325713258132591326013261132621326313264132651326613267132681326913270132711327213273132741327513276132771327813279132801328113282132831328413285132861328713288132891329013291132921329313294132951329613297132981329913300133011330213303133041330513306133071330813309133101331113312133131331413315133161331713318133191332013321133221332313324133251332613327133281332913330133311333213333133341333513336133371333813339133401334113342133431334413345133461334713348133491335013351133521335313354133551335613357133581335913360133611336213363133641336513366133671336813369133701337113372133731337413375133761337713378133791338013381133821338313384133851338613387133881338913390133911339213393133941339513396133971339813399134001340113402134031340413405134061340713408134091341013411134121341313414134151341613417134181341913420134211342213423134241342513426134271342813429134301343113432134331343413435134361343713438134391344013441134421344313444134451344613447134481344913450134511345213453134541345513456134571345813459134601346113462134631346413465134661346713468134691347013471134721347313474134751347613477134781347913480134811348213483134841348513486134871348813489134901349113492134931349413495134961349713498134991350013501135021350313504135051350613507135081350913510135111351213513135141351513516135171351813519135201352113522135231352413525135261352713528135291353013531135321353313534135351353613537135381353913540135411354213543135441354513546135471354813549135501355113552135531355413555135561355713558135591356013561135621356313564135651356613567135681356913570135711357213573135741357513576135771357813579135801358113582135831358413585135861358713588135891359013591135921359313594135951359613597135981359913600136011360213603136041360513606136071360813609136101361113612136131361413615136161361713618136191362013621136221362313624136251362613627136281362913630136311363213633136341363513636136371363813639136401364113642136431364413645136461364713648136491365013651136521365313654136551365613657136581365913660136611366213663136641366513666136671366813669136701367113672136731367413675136761367713678136791368013681136821368313684136851368613687136881368913690136911369213693136941369513696136971369813699137001370113702137031370413705137061370713708137091371013711137121371313714137151371613717137181371913720137211372213723137241372513726137271372813729137301373113732137331373413735137361373713738137391374013741137421374313744137451374613747137481374913750137511375213753137541375513756137571375813759137601376113762137631376413765137661376713768137691377013771137721377313774137751377613777137781377913780137811378213783137841378513786137871378813789137901379113792137931379413795137961379713798137991380013801138021380313804138051380613807138081380913810138111381213813138141381513816138171381813819138201382113822138231382413825138261382713828138291383013831138321383313834138351383613837138381383913840138411384213843138441384513846138471384813849138501385113852138531385413855138561385713858138591386013861138621386313864138651386613867138681386913870138711387213873138741387513876138771387813879138801388113882138831388413885138861388713888138891389013891138921389313894138951389613897138981389913900139011390213903139041390513906139071390813909139101391113912139131391413915139161391713918139191392013921139221392313924139251392613927139281392913930139311393213933139341393513936139371393813939139401394113942139431394413945139461394713948139491395013951139521395313954139551395613957139581395913960139611396213963139641396513966139671396813969139701397113972139731397413975139761397713978139791398013981139821398313984139851398613987139881398913990139911399213993139941399513996139971399813999140001400114002140031400414005140061400714008140091401014011140121401314014140151401614017140181401914020140211402214023140241402514026140271402814029140301403114032140331403414035140361403714038140391404014041140421404314044140451404614047140481404914050140511405214053140541405514056140571405814059140601406114062140631406414065140661406714068140691407014071140721407314074140751407614077140781407914080140811408214083140841408514086140871408814089140901409114092140931409414095140961409714098140991410014101141021410314104141051410614107141081410914110141111411214113141141411514116141171411814119141201412114122141231412414125141261412714128141291413014131141321413314134141351413614137141381413914140141411414214143141441414514146141471414814149141501415114152141531415414155141561415714158141591416014161141621416314164141651416614167141681416914170141711417214173141741417514176141771417814179141801418114182141831418414185141861418714188141891419014191141921419314194141951419614197141981419914200142011420214203142041420514206142071420814209142101421114212142131421414215142161421714218142191422014221142221422314224142251422614227142281422914230142311423214233142341423514236142371423814239142401424114242142431424414245142461424714248142491425014251142521425314254142551425614257142581425914260142611426214263142641426514266142671426814269142701427114272142731427414275142761427714278142791428014281142821428314284142851428614287142881428914290142911429214293142941429514296142971429814299143001430114302143031430414305143061430714308143091431014311143121431314314143151431614317143181431914320143211432214323143241432514326143271432814329143301433114332143331433414335143361433714338143391434014341143421434314344143451434614347143481434914350143511435214353143541435514356143571435814359143601436114362143631436414365143661436714368143691437014371143721437314374143751437614377143781437914380143811438214383143841438514386143871438814389143901439114392143931439414395143961439714398143991440014401144021440314404144051440614407144081440914410144111441214413144141441514416144171441814419144201442114422144231442414425144261442714428144291443014431144321443314434144351443614437144381443914440144411444214443144441444514446144471444814449144501445114452144531445414455144561445714458144591446014461144621446314464144651446614467144681446914470144711447214473144741447514476144771447814479144801448114482144831448414485144861448714488144891449014491144921449314494144951449614497144981449914500145011450214503145041450514506145071450814509145101451114512145131451414515145161451714518145191452014521145221452314524145251452614527145281452914530145311453214533145341453514536145371453814539145401454114542145431454414545145461454714548145491455014551145521455314554145551455614557145581455914560145611456214563145641456514566145671456814569145701457114572145731457414575145761457714578145791458014581145821458314584145851458614587145881458914590145911459214593145941459514596145971459814599146001460114602146031460414605146061460714608146091461014611146121461314614146151461614617146181461914620146211462214623146241462514626146271462814629146301463114632146331463414635146361463714638146391464014641146421464314644146451464614647146481464914650146511465214653146541465514656146571465814659146601466114662146631466414665146661466714668146691467014671146721467314674146751467614677146781467914680146811468214683146841468514686146871468814689146901469114692146931469414695146961469714698146991470014701147021470314704147051470614707147081470914710147111471214713147141471514716147171471814719147201472114722147231472414725147261472714728147291473014731147321473314734147351473614737147381473914740147411474214743147441474514746147471474814749147501475114752147531475414755147561475714758147591476014761147621476314764147651476614767147681476914770147711477214773147741477514776147771477814779147801478114782147831478414785147861478714788147891479014791147921479314794147951479614797147981479914800148011480214803148041480514806148071480814809148101481114812148131481414815148161481714818148191482014821148221482314824148251482614827148281482914830148311483214833148341483514836148371483814839148401484114842148431484414845148461484714848148491485014851148521485314854148551485614857148581485914860148611486214863148641486514866148671486814869148701487114872148731487414875148761487714878148791488014881148821488314884148851488614887148881488914890148911489214893148941489514896148971489814899149001490114902149031490414905149061490714908149091491014911149121491314914149151491614917149181491914920149211492214923149241492514926149271492814929149301493114932149331493414935149361493714938149391494014941149421494314944149451494614947149481494914950149511495214953149541495514956149571495814959149601496114962149631496414965149661496714968149691497014971149721497314974149751497614977149781497914980149811498214983149841498514986149871498814989149901499114992149931499414995149961499714998149991500015001150021500315004150051500615007150081500915010150111501215013150141501515016150171501815019150201502115022150231502415025150261502715028150291503015031150321503315034150351503615037150381503915040150411504215043150441504515046150471504815049150501505115052150531505415055150561505715058150591506015061150621506315064150651506615067150681506915070150711507215073150741507515076150771507815079150801508115082150831508415085150861508715088150891509015091150921509315094150951509615097150981509915100151011510215103151041510515106151071510815109151101511115112151131511415115151161511715118151191512015121151221512315124151251512615127151281512915130151311513215133151341513515136151371513815139151401514115142151431514415145151461514715148151491515015151151521515315154151551515615157151581515915160151611516215163151641516515166151671516815169151701517115172151731517415175151761517715178151791518015181151821518315184151851518615187151881518915190151911519215193151941519515196151971519815199152001520115202152031520415205152061520715208152091521015211152121521315214152151521615217152181521915220152211522215223152241522515226152271522815229152301523115232152331523415235152361523715238152391524015241152421524315244152451524615247152481524915250152511525215253152541525515256152571525815259152601526115262152631526415265152661526715268152691527015271152721527315274152751527615277152781527915280152811528215283152841528515286152871528815289152901529115292152931529415295152961529715298152991530015301153021530315304153051530615307153081530915310153111531215313153141531515316153171531815319153201532115322153231532415325153261532715328153291533015331153321533315334153351533615337153381533915340153411534215343153441534515346153471534815349153501535115352153531535415355153561535715358153591536015361153621536315364153651536615367153681536915370153711537215373153741537515376153771537815379153801538115382153831538415385153861538715388153891539015391153921539315394153951539615397153981539915400154011540215403154041540515406154071540815409154101541115412154131541415415154161541715418154191542015421154221542315424154251542615427154281542915430154311543215433154341543515436154371543815439154401544115442154431544415445154461544715448154491545015451154521545315454154551545615457154581545915460154611546215463154641546515466154671546815469154701547115472154731547415475154761547715478154791548015481154821548315484154851548615487154881548915490154911549215493154941549515496154971549815499155001550115502155031550415505155061550715508155091551015511155121551315514155151551615517155181551915520155211552215523155241552515526155271552815529155301553115532155331553415535155361553715538155391554015541155421554315544155451554615547155481554915550155511555215553155541555515556155571555815559155601556115562155631556415565155661556715568155691557015571155721557315574155751557615577155781557915580155811558215583155841558515586155871558815589155901559115592155931559415595155961559715598155991560015601156021560315604156051560615607156081560915610156111561215613156141561515616156171561815619156201562115622156231562415625156261562715628156291563015631156321563315634156351563615637156381563915640156411564215643156441564515646156471564815649156501565115652156531565415655156561565715658156591566015661156621566315664156651566615667156681566915670156711567215673156741567515676156771567815679156801568115682156831568415685156861568715688156891569015691156921569315694156951569615697156981569915700157011570215703157041570515706157071570815709157101571115712157131571415715157161571715718157191572015721157221572315724157251572615727157281572915730157311573215733157341573515736157371573815739157401574115742157431574415745157461574715748157491575015751157521575315754157551575615757157581575915760157611576215763157641576515766157671576815769157701577115772157731577415775157761577715778157791578015781157821578315784157851578615787157881578915790157911579215793157941579515796157971579815799158001580115802158031580415805158061580715808158091581015811158121581315814158151581615817158181581915820158211582215823158241582515826158271582815829158301583115832158331583415835158361583715838158391584015841158421584315844158451584615847158481584915850158511585215853158541585515856158571585815859158601586115862158631586415865158661586715868158691587015871158721587315874158751587615877158781587915880158811588215883158841588515886158871588815889158901589115892158931589415895158961589715898158991590015901159021590315904159051590615907159081590915910159111591215913159141591515916159171591815919159201592115922159231592415925159261592715928159291593015931159321593315934159351593615937159381593915940159411594215943159441594515946159471594815949159501595115952159531595415955159561595715958159591596015961159621596315964159651596615967159681596915970159711597215973159741597515976159771597815979159801598115982159831598415985159861598715988159891599015991159921599315994159951599615997159981599916000160011600216003160041600516006160071600816009160101601116012160131601416015160161601716018160191602016021160221602316024160251602616027160281602916030160311603216033160341603516036160371603816039160401604116042160431604416045160461604716048160491605016051160521605316054160551605616057160581605916060160611606216063160641606516066160671606816069160701607116072160731607416075160761607716078160791608016081160821608316084160851608616087160881608916090160911609216093160941609516096160971609816099161001610116102161031610416105161061610716108161091611016111161121611316114161151611616117161181611916120161211612216123161241612516126161271612816129161301613116132161331613416135161361613716138161391614016141161421614316144161451614616147161481614916150161511615216153161541615516156161571615816159161601616116162161631616416165161661616716168161691617016171161721617316174161751617616177161781617916180161811618216183161841618516186161871618816189161901619116192161931619416195161961619716198161991620016201162021620316204162051620616207162081620916210162111621216213162141621516216162171621816219162201622116222162231622416225162261622716228162291623016231162321623316234162351623616237162381623916240162411624216243162441624516246162471624816249162501625116252162531625416255162561625716258162591626016261162621626316264162651626616267162681626916270162711627216273162741627516276162771627816279162801628116282162831628416285162861628716288162891629016291162921629316294162951629616297162981629916300163011630216303163041630516306163071630816309163101631116312163131631416315163161631716318163191632016321163221632316324163251632616327163281632916330163311633216333163341633516336163371633816339163401634116342163431634416345163461634716348163491635016351163521635316354163551635616357163581635916360163611636216363163641636516366163671636816369163701637116372163731637416375163761637716378163791638016381163821638316384163851638616387163881638916390163911639216393163941639516396163971639816399164001640116402164031640416405164061640716408164091641016411164121641316414164151641616417164181641916420164211642216423164241642516426164271642816429164301643116432164331643416435164361643716438164391644016441164421644316444164451644616447164481644916450164511645216453164541645516456164571645816459164601646116462164631646416465164661646716468164691647016471164721647316474164751647616477164781647916480164811648216483164841648516486164871648816489164901649116492164931649416495164961649716498164991650016501165021650316504165051650616507165081650916510165111651216513165141651516516165171651816519165201652116522165231652416525165261652716528165291653016531165321653316534165351653616537165381653916540165411654216543165441654516546165471654816549165501655116552165531655416555165561655716558165591656016561165621656316564165651656616567165681656916570165711657216573165741657516576165771657816579165801658116582165831658416585165861658716588165891659016591165921659316594165951659616597165981659916600166011660216603166041660516606166071660816609166101661116612166131661416615166161661716618166191662016621166221662316624166251662616627166281662916630166311663216633166341663516636166371663816639166401664116642166431664416645166461664716648166491665016651166521665316654166551665616657166581665916660166611666216663166641666516666166671666816669166701667116672166731667416675166761667716678166791668016681166821668316684166851668616687166881668916690166911669216693166941669516696166971669816699167001670116702167031670416705167061670716708167091671016711167121671316714167151671616717167181671916720167211672216723167241672516726167271672816729167301673116732167331673416735167361673716738167391674016741167421674316744167451674616747167481674916750167511675216753167541675516756167571675816759167601676116762167631676416765167661676716768167691677016771167721677316774167751677616777167781677916780167811678216783167841678516786167871678816789167901679116792167931679416795167961679716798167991680016801168021680316804168051680616807168081680916810168111681216813168141681516816168171681816819168201682116822168231682416825168261682716828168291683016831168321683316834168351683616837168381683916840168411684216843168441684516846168471684816849168501685116852168531685416855168561685716858168591686016861168621686316864168651686616867168681686916870168711687216873168741687516876168771687816879168801688116882168831688416885168861688716888168891689016891168921689316894168951689616897168981689916900169011690216903169041690516906169071690816909169101691116912169131691416915169161691716918169191692016921169221692316924169251692616927169281692916930169311693216933169341693516936169371693816939169401694116942169431694416945169461694716948169491695016951169521695316954169551695616957169581695916960169611696216963169641696516966169671696816969169701697116972169731697416975169761697716978169791698016981169821698316984169851698616987169881698916990169911699216993169941699516996169971699816999170001700117002170031700417005170061700717008170091701017011170121701317014170151701617017170181701917020170211702217023170241702517026170271702817029170301703117032170331703417035170361703717038170391704017041170421704317044170451704617047170481704917050170511705217053170541705517056170571705817059170601706117062170631706417065170661706717068170691707017071170721707317074170751707617077170781707917080170811708217083170841708517086170871708817089170901709117092170931709417095170961709717098170991710017101171021710317104171051710617107171081710917110171111711217113171141711517116171171711817119171201712117122171231712417125171261712717128171291713017131171321713317134171351713617137171381713917140171411714217143171441714517146171471714817149171501715117152171531715417155171561715717158171591716017161171621716317164171651716617167171681716917170171711717217173171741717517176171771717817179171801718117182171831718417185171861718717188171891719017191171921719317194171951719617197171981719917200172011720217203172041720517206172071720817209172101721117212172131721417215172161721717218172191722017221172221722317224172251722617227172281722917230172311723217233172341723517236172371723817239172401724117242172431724417245172461724717248172491725017251172521725317254172551725617257172581725917260172611726217263172641726517266172671726817269172701727117272172731727417275172761727717278172791728017281172821728317284172851728617287172881728917290172911729217293172941729517296172971729817299173001730117302173031730417305173061730717308173091731017311173121731317314173151731617317173181731917320173211732217323173241732517326173271732817329173301733117332173331733417335173361733717338173391734017341173421734317344173451734617347173481734917350173511735217353173541735517356173571735817359173601736117362173631736417365173661736717368173691737017371173721737317374173751737617377173781737917380173811738217383173841738517386173871738817389173901739117392173931739417395173961739717398173991740017401174021740317404174051740617407174081740917410174111741217413174141741517416174171741817419174201742117422174231742417425174261742717428174291743017431174321743317434174351743617437174381743917440174411744217443174441744517446174471744817449174501745117452174531745417455174561745717458174591746017461174621746317464174651746617467174681746917470174711747217473174741747517476174771747817479174801748117482174831748417485174861748717488174891749017491174921749317494174951749617497174981749917500175011750217503175041750517506175071750817509175101751117512175131751417515175161751717518175191752017521175221752317524175251752617527175281752917530175311753217533175341753517536175371753817539175401754117542175431754417545175461754717548175491755017551175521755317554175551755617557175581755917560175611756217563175641756517566175671756817569175701757117572175731757417575175761757717578175791758017581175821758317584175851758617587175881758917590175911759217593175941759517596175971759817599176001760117602176031760417605176061760717608176091761017611176121761317614176151761617617176181761917620176211762217623176241762517626176271762817629176301763117632176331763417635176361763717638176391764017641176421764317644176451764617647176481764917650176511765217653176541765517656176571765817659176601766117662176631766417665176661766717668176691767017671176721767317674176751767617677176781767917680176811768217683176841768517686176871768817689176901769117692176931769417695176961769717698176991770017701177021770317704177051770617707177081770917710177111771217713177141771517716177171771817719177201772117722177231772417725177261772717728177291773017731177321773317734177351773617737177381773917740177411774217743177441774517746177471774817749177501775117752177531775417755177561775717758177591776017761177621776317764177651776617767177681776917770177711777217773177741777517776177771777817779177801778117782177831778417785177861778717788177891779017791177921779317794177951779617797177981779917800178011780217803178041780517806178071780817809178101781117812178131781417815178161781717818178191782017821178221782317824178251782617827178281782917830178311783217833178341783517836178371783817839178401784117842178431784417845178461784717848178491785017851178521785317854178551785617857178581785917860178611786217863178641786517866178671786817869178701787117872178731787417875178761787717878178791788017881178821788317884178851788617887178881788917890178911789217893178941789517896178971789817899179001790117902179031790417905179061790717908179091791017911179121791317914179151791617917179181791917920179211792217923179241792517926179271792817929179301793117932179331793417935179361793717938179391794017941179421794317944179451794617947179481794917950179511795217953179541795517956179571795817959179601796117962179631796417965179661796717968179691797017971179721797317974179751797617977179781797917980179811798217983179841798517986179871798817989179901799117992179931799417995179961799717998179991800018001180021800318004180051800618007180081800918010180111801218013180141801518016180171801818019180201802118022180231802418025180261802718028180291803018031180321803318034180351803618037180381803918040180411804218043180441804518046180471804818049180501805118052180531805418055180561805718058180591806018061180621806318064180651806618067180681806918070180711807218073180741807518076180771807818079180801808118082180831808418085180861808718088180891809018091180921809318094180951809618097180981809918100181011810218103181041810518106181071810818109181101811118112181131811418115181161811718118181191812018121181221812318124181251812618127181281812918130181311813218133181341813518136181371813818139181401814118142181431814418145181461814718148181491815018151181521815318154181551815618157181581815918160181611816218163181641816518166181671816818169181701817118172181731817418175181761817718178181791818018181181821818318184181851818618187181881818918190181911819218193181941819518196181971819818199182001820118202182031820418205182061820718208182091821018211182121821318214182151821618217182181821918220182211822218223182241822518226182271822818229182301823118232182331823418235182361823718238182391824018241182421824318244182451824618247182481824918250182511825218253182541825518256182571825818259182601826118262182631826418265182661826718268182691827018271182721827318274182751827618277182781827918280182811828218283182841828518286182871828818289182901829118292182931829418295182961829718298182991830018301183021830318304183051830618307183081830918310183111831218313183141831518316183171831818319183201832118322183231832418325183261832718328183291833018331183321833318334183351833618337183381833918340183411834218343183441834518346183471834818349183501835118352183531835418355183561835718358183591836018361183621836318364183651836618367183681836918370183711837218373183741837518376183771837818379183801838118382183831838418385183861838718388183891839018391183921839318394183951839618397183981839918400184011840218403184041840518406184071840818409184101841118412184131841418415184161841718418184191842018421184221842318424184251842618427184281842918430184311843218433184341843518436184371843818439184401844118442184431844418445184461844718448184491845018451184521845318454184551845618457184581845918460184611846218463184641846518466184671846818469184701847118472184731847418475184761847718478184791848018481184821848318484184851848618487184881848918490184911849218493184941849518496184971849818499185001850118502185031850418505185061850718508185091851018511185121851318514185151851618517185181851918520185211852218523185241852518526185271852818529185301853118532185331853418535185361853718538185391854018541185421854318544185451854618547185481854918550185511855218553185541855518556185571855818559185601856118562185631856418565185661856718568185691857018571185721857318574185751857618577185781857918580185811858218583185841858518586185871858818589185901859118592185931859418595185961859718598185991860018601186021860318604186051860618607186081860918610186111861218613186141861518616186171861818619186201862118622186231862418625186261862718628186291863018631186321863318634186351863618637186381863918640186411864218643186441864518646186471864818649186501865118652186531865418655186561865718658186591866018661186621866318664186651866618667186681866918670186711867218673186741867518676186771867818679186801868118682186831868418685186861868718688186891869018691186921869318694186951869618697186981869918700187011870218703187041870518706187071870818709187101871118712187131871418715187161871718718187191872018721187221872318724187251872618727187281872918730187311873218733187341873518736187371873818739187401874118742187431874418745187461874718748187491875018751187521875318754187551875618757187581875918760187611876218763187641876518766187671876818769187701877118772187731877418775187761877718778187791878018781187821878318784187851878618787187881878918790187911879218793187941879518796187971879818799188001880118802188031880418805188061880718808188091881018811188121881318814188151881618817188181881918820188211882218823188241882518826188271882818829188301883118832188331883418835188361883718838188391884018841188421884318844188451884618847188481884918850188511885218853188541885518856188571885818859188601886118862188631886418865188661886718868188691887018871188721887318874188751887618877188781887918880188811888218883188841888518886188871888818889188901889118892188931889418895188961889718898188991890018901189021890318904189051890618907189081890918910189111891218913189141891518916189171891818919189201892118922189231892418925189261892718928189291893018931189321893318934189351893618937189381893918940189411894218943189441894518946189471894818949189501895118952189531895418955189561895718958189591896018961189621896318964189651896618967189681896918970189711897218973189741897518976189771897818979189801898118982189831898418985189861898718988189891899018991189921899318994189951899618997189981899919000190011900219003190041900519006190071900819009190101901119012190131901419015190161901719018190191902019021190221902319024190251902619027190281902919030190311903219033190341903519036190371903819039190401904119042190431904419045190461904719048190491905019051190521905319054190551905619057190581905919060190611906219063190641906519066190671906819069190701907119072190731907419075190761907719078190791908019081190821908319084190851908619087190881908919090190911909219093190941909519096190971909819099191001910119102191031910419105191061910719108191091911019111191121911319114191151911619117191181911919120191211912219123191241912519126191271912819129191301913119132191331913419135191361913719138191391914019141191421914319144191451914619147191481914919150191511915219153191541915519156191571915819159191601916119162191631916419165191661916719168191691917019171191721917319174191751917619177191781917919180191811918219183191841918519186191871918819189191901919119192191931919419195191961919719198191991920019201192021920319204192051920619207192081920919210192111921219213192141921519216192171921819219192201922119222192231922419225192261922719228192291923019231192321923319234192351923619237192381923919240192411924219243192441924519246192471924819249192501925119252192531925419255192561925719258192591926019261192621926319264192651926619267192681926919270192711927219273192741927519276192771927819279192801928119282192831928419285192861928719288192891929019291192921929319294192951929619297192981929919300193011930219303193041930519306193071930819309193101931119312193131931419315193161931719318193191932019321193221932319324193251932619327193281932919330193311933219333193341933519336193371933819339193401934119342193431934419345193461934719348193491935019351193521935319354193551935619357193581935919360193611936219363193641936519366193671936819369193701937119372193731937419375193761937719378193791938019381193821938319384193851938619387193881938919390193911939219393193941939519396193971939819399194001940119402194031940419405194061940719408194091941019411194121941319414194151941619417194181941919420194211942219423194241942519426194271942819429194301943119432194331943419435194361943719438194391944019441194421944319444194451944619447194481944919450194511945219453194541945519456194571945819459194601946119462194631946419465194661946719468194691947019471194721947319474194751947619477194781947919480194811948219483194841948519486194871948819489194901949119492194931949419495194961949719498194991950019501195021950319504195051950619507195081950919510195111951219513195141951519516195171951819519195201952119522195231952419525195261952719528195291953019531195321953319534195351953619537195381953919540195411954219543195441954519546195471954819549195501955119552195531955419555195561955719558195591956019561195621956319564195651956619567195681956919570195711957219573195741957519576195771957819579195801958119582195831958419585195861958719588195891959019591195921959319594195951959619597195981959919600196011960219603196041960519606196071960819609196101961119612196131961419615196161961719618196191962019621196221962319624196251962619627196281962919630196311963219633196341963519636196371963819639196401964119642196431964419645196461964719648196491965019651196521965319654196551965619657196581965919660196611966219663196641966519666196671966819669196701967119672196731967419675196761967719678196791968019681196821968319684196851968619687196881968919690196911969219693196941969519696196971969819699197001970119702197031970419705197061970719708197091971019711197121971319714197151971619717197181971919720197211972219723197241972519726197271972819729197301973119732197331973419735197361973719738197391974019741197421974319744197451974619747197481974919750197511975219753197541975519756197571975819759197601976119762197631976419765197661976719768197691977019771197721977319774197751977619777197781977919780197811978219783197841978519786197871978819789197901979119792197931979419795197961979719798197991980019801198021980319804198051980619807198081980919810198111981219813198141981519816198171981819819198201982119822198231982419825198261982719828198291983019831198321983319834198351983619837198381983919840198411984219843198441984519846198471984819849198501985119852198531985419855198561985719858198591986019861198621986319864198651986619867198681986919870198711987219873198741987519876198771987819879198801988119882198831988419885198861988719888198891989019891198921989319894198951989619897198981989919900199011990219903199041990519906199071990819909199101991119912199131991419915199161991719918199191992019921199221992319924199251992619927199281992919930199311993219933199341993519936199371993819939199401994119942199431994419945199461994719948199491995019951199521995319954199551995619957199581995919960199611996219963199641996519966199671996819969199701997119972199731997419975199761997719978199791998019981199821998319984199851998619987199881998919990199911999219993199941999519996199971999819999200002000120002200032000420005200062000720008200092001020011200122001320014200152001620017200182001920020200212002220023200242002520026200272002820029200302003120032200332003420035200362003720038200392004020041200422004320044200452004620047200482004920050200512005220053200542005520056200572005820059200602006120062200632006420065200662006720068200692007020071200722007320074200752007620077200782007920080200812008220083200842008520086200872008820089200902009120092200932009420095200962009720098200992010020101201022010320104201052010620107201082010920110201112011220113201142011520116201172011820119201202012120122201232012420125201262012720128201292013020131201322013320134201352013620137201382013920140201412014220143201442014520146201472014820149201502015120152201532015420155201562015720158201592016020161201622016320164201652016620167201682016920170201712017220173201742017520176201772017820179201802018120182201832018420185201862018720188201892019020191201922019320194201952019620197201982019920200202012020220203202042020520206202072020820209202102021120212202132021420215202162021720218202192022020221202222022320224202252022620227202282022920230202312023220233202342023520236202372023820239202402024120242202432024420245202462024720248202492025020251202522025320254202552025620257202582025920260202612026220263202642026520266202672026820269202702027120272202732027420275202762027720278202792028020281202822028320284202852028620287202882028920290202912029220293202942029520296202972029820299203002030120302203032030420305203062030720308203092031020311203122031320314203152031620317203182031920320203212032220323203242032520326203272032820329203302033120332203332033420335203362033720338203392034020341203422034320344203452034620347203482034920350203512035220353203542035520356203572035820359203602036120362203632036420365203662036720368203692037020371203722037320374203752037620377203782037920380203812038220383203842038520386203872038820389203902039120392203932039420395203962039720398203992040020401204022040320404204052040620407204082040920410204112041220413204142041520416204172041820419204202042120422204232042420425204262042720428204292043020431204322043320434204352043620437204382043920440204412044220443204442044520446204472044820449204502045120452204532045420455204562045720458204592046020461204622046320464204652046620467204682046920470204712047220473204742047520476204772047820479204802048120482204832048420485204862048720488204892049020491204922049320494204952049620497204982049920500205012050220503205042050520506205072050820509205102051120512205132051420515205162051720518205192052020521205222052320524205252052620527205282052920530205312053220533205342053520536205372053820539205402054120542205432054420545205462054720548205492055020551205522055320554205552055620557205582055920560205612056220563205642056520566205672056820569205702057120572205732057420575205762057720578205792058020581205822058320584205852058620587205882058920590205912059220593205942059520596205972059820599206002060120602206032060420605206062060720608206092061020611206122061320614206152061620617206182061920620206212062220623206242062520626206272062820629206302063120632206332063420635206362063720638206392064020641206422064320644206452064620647206482064920650206512065220653206542065520656206572065820659206602066120662206632066420665206662066720668206692067020671206722067320674206752067620677206782067920680206812068220683206842068520686206872068820689206902069120692206932069420695206962069720698206992070020701207022070320704207052070620707207082070920710207112071220713207142071520716207172071820719207202072120722207232072420725207262072720728207292073020731207322073320734207352073620737207382073920740207412074220743207442074520746207472074820749207502075120752207532075420755207562075720758207592076020761207622076320764207652076620767207682076920770207712077220773207742077520776207772077820779207802078120782207832078420785207862078720788207892079020791207922079320794207952079620797207982079920800208012080220803208042080520806208072080820809208102081120812208132081420815208162081720818208192082020821208222082320824208252082620827208282082920830208312083220833208342083520836208372083820839208402084120842208432084420845208462084720848208492085020851208522085320854208552085620857208582085920860208612086220863208642086520866208672086820869208702087120872208732087420875208762087720878208792088020881208822088320884208852088620887208882088920890208912089220893208942089520896208972089820899209002090120902209032090420905209062090720908209092091020911209122091320914209152091620917209182091920920209212092220923209242092520926209272092820929209302093120932209332093420935209362093720938209392094020941209422094320944209452094620947209482094920950209512095220953209542095520956209572095820959209602096120962209632096420965209662096720968209692097020971209722097320974209752097620977209782097920980209812098220983209842098520986209872098820989209902099120992209932099420995209962099720998209992100021001210022100321004210052100621007210082100921010210112101221013210142101521016210172101821019210202102121022210232102421025210262102721028210292103021031210322103321034210352103621037210382103921040210412104221043210442104521046210472104821049210502105121052210532105421055210562105721058210592106021061210622106321064210652106621067210682106921070210712107221073210742107521076210772107821079210802108121082210832108421085210862108721088210892109021091210922109321094210952109621097210982109921100211012110221103211042110521106211072110821109211102111121112211132111421115211162111721118211192112021121211222112321124211252112621127211282112921130211312113221133211342113521136211372113821139211402114121142211432114421145211462114721148211492115021151211522115321154211552115621157211582115921160211612116221163211642116521166211672116821169211702117121172211732117421175211762117721178211792118021181211822118321184211852118621187211882118921190211912119221193211942119521196211972119821199212002120121202212032120421205212062120721208212092121021211212122121321214212152121621217212182121921220212212122221223212242122521226212272122821229212302123121232212332123421235212362123721238212392124021241212422124321244212452124621247212482124921250212512125221253212542125521256212572125821259212602126121262212632126421265212662126721268212692127021271212722127321274212752127621277212782127921280212812128221283212842128521286212872128821289212902129121292212932129421295212962129721298212992130021301213022130321304213052130621307213082130921310213112131221313213142131521316213172131821319213202132121322213232132421325213262132721328213292133021331213322133321334213352133621337213382133921340213412134221343213442134521346213472134821349213502135121352213532135421355213562135721358213592136021361213622136321364213652136621367213682136921370213712137221373213742137521376213772137821379213802138121382213832138421385213862138721388213892139021391213922139321394213952139621397213982139921400214012140221403214042140521406214072140821409214102141121412214132141421415214162141721418214192142021421214222142321424214252142621427214282142921430214312143221433214342143521436214372143821439214402144121442214432144421445214462144721448214492145021451214522145321454214552145621457214582145921460214612146221463214642146521466214672146821469214702147121472214732147421475214762147721478214792148021481214822148321484214852148621487214882148921490214912149221493214942149521496214972149821499215002150121502215032150421505215062150721508215092151021511215122151321514215152151621517215182151921520215212152221523215242152521526215272152821529215302153121532215332153421535215362153721538215392154021541215422154321544215452154621547215482154921550215512155221553215542155521556215572155821559215602156121562215632156421565215662156721568215692157021571215722157321574215752157621577215782157921580215812158221583215842158521586215872158821589215902159121592215932159421595215962159721598215992160021601216022160321604216052160621607216082160921610216112161221613216142161521616216172161821619216202162121622216232162421625216262162721628216292163021631216322163321634216352163621637216382163921640216412164221643216442164521646216472164821649216502165121652216532165421655216562165721658216592166021661216622166321664216652166621667216682166921670216712167221673216742167521676216772167821679216802168121682216832168421685216862168721688216892169021691216922169321694216952169621697216982169921700217012170221703217042170521706217072170821709217102171121712217132171421715217162171721718217192172021721217222172321724217252172621727217282172921730217312173221733217342173521736217372173821739217402174121742217432174421745217462174721748217492175021751217522175321754217552175621757217582175921760217612176221763217642176521766217672176821769217702177121772217732177421775217762177721778217792178021781217822178321784217852178621787217882178921790217912179221793217942179521796217972179821799218002180121802218032180421805218062180721808218092181021811218122181321814218152181621817218182181921820218212182221823218242182521826218272182821829218302183121832218332183421835218362183721838218392184021841218422184321844218452184621847218482184921850218512185221853218542185521856218572185821859218602186121862218632186421865218662186721868218692187021871218722187321874218752187621877218782187921880218812188221883218842188521886218872188821889218902189121892218932189421895218962189721898218992190021901219022190321904219052190621907219082190921910219112191221913219142191521916219172191821919219202192121922219232192421925219262192721928219292193021931219322193321934219352193621937219382193921940219412194221943219442194521946219472194821949219502195121952219532195421955219562195721958219592196021961219622196321964219652196621967219682196921970219712197221973219742197521976219772197821979219802198121982219832198421985219862198721988219892199021991219922199321994219952199621997219982199922000220012200222003220042200522006220072200822009220102201122012220132201422015220162201722018220192202022021220222202322024220252202622027220282202922030220312203222033220342203522036220372203822039220402204122042220432204422045220462204722048220492205022051220522205322054220552205622057220582205922060220612206222063220642206522066220672206822069220702207122072220732207422075220762207722078220792208022081220822208322084220852208622087220882208922090220912209222093220942209522096220972209822099221002210122102221032210422105221062210722108221092211022111221122211322114221152211622117221182211922120221212212222123221242212522126221272212822129221302213122132221332213422135221362213722138221392214022141221422214322144221452214622147221482214922150221512215222153221542215522156221572215822159221602216122162221632216422165221662216722168221692217022171221722217322174221752217622177221782217922180221812218222183221842218522186221872218822189221902219122192221932219422195221962219722198221992220022201222022220322204222052220622207222082220922210222112221222213222142221522216222172221822219222202222122222222232222422225222262222722228222292223022231222322223322234222352223622237222382223922240222412224222243222442224522246222472224822249222502225122252222532225422255222562225722258222592226022261222622226322264222652226622267222682226922270222712227222273222742227522276222772227822279222802228122282222832228422285222862228722288222892229022291222922229322294222952229622297222982229922300223012230222303223042230522306223072230822309223102231122312223132231422315223162231722318223192232022321223222232322324223252232622327223282232922330223312233222333223342233522336223372233822339223402234122342223432234422345223462234722348223492235022351223522235322354223552235622357223582235922360223612236222363223642236522366223672236822369223702237122372223732237422375223762237722378223792238022381223822238322384223852238622387223882238922390223912239222393223942239522396223972239822399224002240122402224032240422405224062240722408224092241022411224122241322414224152241622417224182241922420224212242222423224242242522426224272242822429224302243122432224332243422435224362243722438224392244022441224422244322444224452244622447224482244922450224512245222453224542245522456224572245822459224602246122462224632246422465224662246722468224692247022471224722247322474224752247622477224782247922480224812248222483224842248522486224872248822489224902249122492224932249422495224962249722498224992250022501225022250322504225052250622507225082250922510225112251222513225142251522516225172251822519225202252122522225232252422525225262252722528225292253022531225322253322534225352253622537225382253922540225412254222543225442254522546225472254822549225502255122552225532255422555225562255722558225592256022561225622256322564225652256622567225682256922570225712257222573225742257522576225772257822579225802258122582225832258422585225862258722588225892259022591225922259322594225952259622597225982259922600226012260222603226042260522606226072260822609226102261122612226132261422615226162261722618226192262022621226222262322624226252262622627226282262922630226312263222633226342263522636226372263822639226402264122642226432264422645226462264722648226492265022651226522265322654226552265622657226582265922660226612266222663226642266522666226672266822669226702267122672226732267422675226762267722678226792268022681226822268322684226852268622687226882268922690226912269222693226942269522696226972269822699227002270122702227032270422705227062270722708227092271022711227122271322714227152271622717227182271922720227212272222723227242272522726227272272822729227302273122732227332273422735227362273722738227392274022741227422274322744227452274622747227482274922750227512275222753227542275522756227572275822759227602276122762227632276422765227662276722768227692277022771227722277322774227752277622777227782277922780227812278222783227842278522786227872278822789227902279122792227932279422795227962279722798227992280022801228022280322804228052280622807228082280922810228112281222813228142281522816228172281822819228202282122822228232282422825228262282722828228292283022831228322283322834228352283622837228382283922840228412284222843228442284522846228472284822849228502285122852228532285422855228562285722858228592286022861228622286322864228652286622867228682286922870228712287222873228742287522876228772287822879228802288122882228832288422885228862288722888228892289022891228922289322894228952289622897228982289922900229012290222903229042290522906229072290822909229102291122912229132291422915229162291722918229192292022921229222292322924229252292622927229282292922930229312293222933229342293522936229372293822939229402294122942229432294422945229462294722948229492295022951229522295322954229552295622957229582295922960229612296222963229642296522966229672296822969229702297122972229732297422975229762297722978229792298022981229822298322984229852298622987229882298922990229912299222993229942299522996229972299822999230002300123002230032300423005230062300723008230092301023011230122301323014230152301623017230182301923020230212302223023230242302523026230272302823029230302303123032230332303423035230362303723038230392304023041230422304323044230452304623047230482304923050230512305223053230542305523056230572305823059230602306123062230632306423065230662306723068230692307023071230722307323074230752307623077230782307923080230812308223083230842308523086230872308823089230902309123092230932309423095230962309723098230992310023101231022310323104231052310623107231082310923110231112311223113231142311523116231172311823119231202312123122231232312423125231262312723128231292313023131231322313323134231352313623137231382313923140231412314223143231442314523146231472314823149231502315123152231532315423155231562315723158231592316023161231622316323164231652316623167231682316923170231712317223173231742317523176231772317823179231802318123182231832318423185231862318723188231892319023191231922319323194231952319623197231982319923200232012320223203232042320523206232072320823209232102321123212232132321423215232162321723218232192322023221232222322323224232252322623227232282322923230232312323223233232342323523236232372323823239232402324123242232432324423245232462324723248232492325023251232522325323254232552325623257232582325923260232612326223263232642326523266232672326823269232702327123272232732327423275232762327723278232792328023281232822328323284232852328623287232882328923290232912329223293232942329523296232972329823299233002330123302233032330423305233062330723308233092331023311233122331323314233152331623317233182331923320233212332223323233242332523326233272332823329233302333123332233332333423335233362333723338233392334023341233422334323344233452334623347233482334923350233512335223353233542335523356233572335823359233602336123362233632336423365233662336723368233692337023371233722337323374233752337623377233782337923380233812338223383233842338523386233872338823389233902339123392233932339423395233962339723398233992340023401234022340323404234052340623407234082340923410234112341223413234142341523416234172341823419234202342123422234232342423425234262342723428234292343023431234322343323434234352343623437234382343923440234412344223443234442344523446234472344823449234502345123452234532345423455234562345723458234592346023461234622346323464234652346623467234682346923470234712347223473234742347523476234772347823479234802348123482234832348423485234862348723488234892349023491234922349323494234952349623497234982349923500235012350223503235042350523506235072350823509235102351123512235132351423515235162351723518235192352023521235222352323524235252352623527235282352923530235312353223533235342353523536235372353823539235402354123542235432354423545235462354723548235492355023551235522355323554235552355623557235582355923560235612356223563235642356523566235672356823569235702357123572235732357423575235762357723578235792358023581235822358323584235852358623587235882358923590235912359223593235942359523596235972359823599236002360123602236032360423605236062360723608236092361023611236122361323614236152361623617236182361923620236212362223623236242362523626236272362823629236302363123632236332363423635236362363723638236392364023641236422364323644236452364623647236482364923650236512365223653236542365523656236572365823659236602366123662236632366423665236662366723668236692367023671236722367323674236752367623677236782367923680236812368223683236842368523686236872368823689236902369123692236932369423695236962369723698236992370023701237022370323704237052370623707237082370923710237112371223713237142371523716237172371823719237202372123722237232372423725237262372723728237292373023731237322373323734237352373623737237382373923740237412374223743237442374523746237472374823749237502375123752237532375423755237562375723758237592376023761237622376323764237652376623767237682376923770237712377223773237742377523776237772377823779237802378123782237832378423785237862378723788237892379023791237922379323794237952379623797237982379923800238012380223803238042380523806238072380823809238102381123812238132381423815238162381723818238192382023821238222382323824238252382623827238282382923830238312383223833238342383523836238372383823839238402384123842238432384423845238462384723848238492385023851238522385323854238552385623857238582385923860238612386223863238642386523866238672386823869238702387123872238732387423875238762387723878238792388023881238822388323884238852388623887238882388923890238912389223893238942389523896238972389823899239002390123902239032390423905239062390723908239092391023911239122391323914239152391623917239182391923920239212392223923239242392523926239272392823929239302393123932239332393423935239362393723938239392394023941239422394323944239452394623947239482394923950239512395223953239542395523956239572395823959239602396123962239632396423965239662396723968239692397023971239722397323974239752397623977239782397923980239812398223983239842398523986239872398823989239902399123992239932399423995239962399723998239992400024001240022400324004240052400624007240082400924010240112401224013240142401524016240172401824019240202402124022240232402424025240262402724028240292403024031240322403324034240352403624037240382403924040240412404224043240442404524046240472404824049240502405124052240532405424055240562405724058240592406024061240622406324064240652406624067240682406924070240712407224073240742407524076240772407824079240802408124082240832408424085240862408724088240892409024091240922409324094240952409624097240982409924100241012410224103241042410524106241072410824109241102411124112241132411424115241162411724118241192412024121241222412324124241252412624127241282412924130241312413224133241342413524136241372413824139241402414124142241432414424145241462414724148241492415024151241522415324154241552415624157241582415924160241612416224163241642416524166241672416824169241702417124172241732417424175241762417724178241792418024181241822418324184241852418624187241882418924190241912419224193241942419524196241972419824199242002420124202242032420424205242062420724208242092421024211242122421324214242152421624217242182421924220242212422224223242242422524226242272422824229242302423124232242332423424235242362423724238242392424024241242422424324244242452424624247242482424924250242512425224253242542425524256242572425824259242602426124262242632426424265242662426724268242692427024271242722427324274242752427624277242782427924280242812428224283242842428524286242872428824289242902429124292242932429424295242962429724298242992430024301243022430324304243052430624307243082430924310243112431224313243142431524316243172431824319243202432124322243232432424325243262432724328243292433024331243322433324334243352433624337243382433924340243412434224343243442434524346243472434824349243502435124352243532435424355243562435724358243592436024361243622436324364243652436624367243682436924370243712437224373243742437524376243772437824379243802438124382243832438424385243862438724388243892439024391243922439324394243952439624397243982439924400244012440224403244042440524406244072440824409244102441124412244132441424415244162441724418244192442024421244222442324424244252442624427244282442924430244312443224433244342443524436244372443824439244402444124442244432444424445244462444724448244492445024451244522445324454244552445624457244582445924460244612446224463244642446524466244672446824469244702447124472244732447424475244762447724478244792448024481244822448324484244852448624487244882448924490244912449224493244942449524496244972449824499245002450124502245032450424505245062450724508245092451024511245122451324514245152451624517245182451924520245212452224523245242452524526245272452824529245302453124532245332453424535245362453724538245392454024541245422454324544245452454624547245482454924550245512455224553245542455524556245572455824559245602456124562245632456424565245662456724568245692457024571245722457324574245752457624577245782457924580245812458224583245842458524586245872458824589245902459124592245932459424595245962459724598245992460024601246022460324604246052460624607246082460924610246112461224613246142461524616246172461824619246202462124622246232462424625246262462724628246292463024631246322463324634246352463624637246382463924640246412464224643246442464524646246472464824649246502465124652246532465424655246562465724658246592466024661246622466324664246652466624667246682466924670246712467224673246742467524676246772467824679246802468124682246832468424685246862468724688246892469024691246922469324694246952469624697246982469924700247012470224703247042470524706247072470824709247102471124712247132471424715247162471724718247192472024721247222472324724247252472624727247282472924730247312473224733247342473524736247372473824739247402474124742247432474424745247462474724748247492475024751247522475324754247552475624757247582475924760247612476224763247642476524766247672476824769247702477124772247732477424775247762477724778247792478024781247822478324784247852478624787247882478924790247912479224793247942479524796247972479824799248002480124802248032480424805248062480724808248092481024811248122481324814248152481624817248182481924820248212482224823248242482524826248272482824829248302483124832248332483424835248362483724838248392484024841248422484324844248452484624847248482484924850248512485224853248542485524856248572485824859248602486124862248632486424865248662486724868248692487024871248722487324874248752487624877248782487924880248812488224883248842488524886248872488824889248902489124892248932489424895248962489724898248992490024901249022490324904249052490624907249082490924910249112491224913249142491524916249172491824919249202492124922249232492424925249262492724928249292493024931249322493324934249352493624937249382493924940249412494224943249442494524946249472494824949249502495124952249532495424955249562495724958249592496024961249622496324964249652496624967249682496924970249712497224973249742497524976249772497824979249802498124982249832498424985249862498724988249892499024991249922499324994249952499624997249982499925000250012500225003250042500525006250072500825009250102501125012250132501425015250162501725018250192502025021250222502325024250252502625027250282502925030250312503225033250342503525036250372503825039250402504125042250432504425045250462504725048250492505025051250522505325054250552505625057250582505925060250612506225063250642506525066250672506825069250702507125072250732507425075250762507725078250792508025081250822508325084250852508625087250882508925090250912509225093250942509525096250972509825099251002510125102251032510425105251062510725108251092511025111251122511325114251152511625117251182511925120251212512225123251242512525126251272512825129251302513125132251332513425135251362513725138251392514025141251422514325144251452514625147251482514925150251512515225153251542515525156251572515825159251602516125162251632516425165251662516725168251692517025171251722517325174251752517625177251782517925180251812518225183251842518525186251872518825189251902519125192251932519425195251962519725198251992520025201252022520325204252052520625207252082520925210252112521225213252142521525216252172521825219252202522125222252232522425225252262522725228252292523025231252322523325234252352523625237252382523925240252412524225243252442524525246252472524825249252502525125252252532525425255252562525725258252592526025261252622526325264252652526625267252682526925270252712527225273252742527525276252772527825279252802528125282252832528425285252862528725288252892529025291252922529325294252952529625297252982529925300253012530225303253042530525306253072530825309253102531125312253132531425315253162531725318253192532025321253222532325324253252532625327253282532925330253312533225333253342533525336253372533825339253402534125342253432534425345253462534725348253492535025351253522535325354253552535625357253582535925360253612536225363253642536525366253672536825369253702537125372253732537425375253762537725378253792538025381253822538325384253852538625387253882538925390253912539225393253942539525396253972539825399254002540125402254032540425405254062540725408254092541025411254122541325414254152541625417254182541925420254212542225423254242542525426254272542825429254302543125432254332543425435254362543725438254392544025441254422544325444254452544625447254482544925450254512545225453254542545525456254572545825459254602546125462254632546425465254662546725468254692547025471254722547325474254752547625477254782547925480254812548225483254842548525486254872548825489254902549125492254932549425495254962549725498254992550025501255022550325504255052550625507255082550925510255112551225513255142551525516255172551825519255202552125522255232552425525255262552725528255292553025531255322553325534255352553625537255382553925540255412554225543255442554525546255472554825549255502555125552255532555425555255562555725558255592556025561255622556325564255652556625567255682556925570255712557225573255742557525576255772557825579255802558125582255832558425585255862558725588255892559025591255922559325594255952559625597255982559925600256012560225603256042560525606256072560825609256102561125612256132561425615256162561725618256192562025621256222562325624256252562625627256282562925630256312563225633256342563525636256372563825639256402564125642256432564425645256462564725648256492565025651256522565325654256552565625657256582565925660256612566225663256642566525666256672566825669256702567125672256732567425675256762567725678256792568025681256822568325684256852568625687256882568925690256912569225693256942569525696256972569825699257002570125702257032570425705257062570725708257092571025711257122571325714257152571625717257182571925720257212572225723257242572525726257272572825729257302573125732257332573425735257362573725738257392574025741257422574325744257452574625747257482574925750257512575225753257542575525756257572575825759257602576125762257632576425765257662576725768257692577025771257722577325774257752577625777257782577925780257812578225783257842578525786257872578825789257902579125792257932579425795257962579725798257992580025801258022580325804258052580625807258082580925810258112581225813258142581525816258172581825819258202582125822258232582425825258262582725828258292583025831258322583325834258352583625837258382583925840258412584225843258442584525846258472584825849258502585125852258532585425855258562585725858258592586025861258622586325864258652586625867258682586925870258712587225873258742587525876258772587825879258802588125882258832588425885258862588725888258892589025891258922589325894258952589625897258982589925900259012590225903259042590525906259072590825909259102591125912259132591425915259162591725918259192592025921259222592325924259252592625927259282592925930259312593225933259342593525936259372593825939259402594125942259432594425945259462594725948259492595025951259522595325954259552595625957259582595925960259612596225963259642596525966259672596825969259702597125972259732597425975259762597725978259792598025981259822598325984259852598625987259882598925990259912599225993259942599525996259972599825999260002600126002260032600426005260062600726008260092601026011260122601326014260152601626017260182601926020260212602226023260242602526026260272602826029260302603126032260332603426035260362603726038260392604026041260422604326044260452604626047260482604926050260512605226053260542605526056260572605826059260602606126062260632606426065260662606726068260692607026071260722607326074260752607626077260782607926080260812608226083260842608526086260872608826089260902609126092260932609426095260962609726098260992610026101261022610326104261052610626107261082610926110261112611226113261142611526116261172611826119261202612126122261232612426125261262612726128261292613026131261322613326134261352613626137261382613926140261412614226143261442614526146261472614826149261502615126152261532615426155261562615726158261592616026161261622616326164261652616626167261682616926170261712617226173261742617526176261772617826179261802618126182261832618426185261862618726188261892619026191261922619326194261952619626197261982619926200262012620226203262042620526206262072620826209262102621126212262132621426215262162621726218262192622026221262222622326224262252622626227262282622926230262312623226233262342623526236262372623826239262402624126242262432624426245262462624726248262492625026251262522625326254262552625626257262582625926260262612626226263262642626526266262672626826269262702627126272262732627426275262762627726278262792628026281262822628326284262852628626287262882628926290262912629226293262942629526296262972629826299263002630126302263032630426305263062630726308263092631026311263122631326314263152631626317263182631926320263212632226323263242632526326263272632826329263302633126332263332633426335263362633726338263392634026341263422634326344263452634626347263482634926350263512635226353263542635526356263572635826359263602636126362263632636426365263662636726368263692637026371263722637326374263752637626377263782637926380263812638226383263842638526386263872638826389263902639126392263932639426395263962639726398263992640026401264022640326404264052640626407264082640926410264112641226413264142641526416264172641826419264202642126422264232642426425264262642726428264292643026431264322643326434264352643626437264382643926440264412644226443264442644526446264472644826449264502645126452264532645426455264562645726458264592646026461264622646326464264652646626467264682646926470264712647226473264742647526476264772647826479264802648126482264832648426485264862648726488264892649026491264922649326494264952649626497264982649926500265012650226503265042650526506265072650826509265102651126512265132651426515265162651726518265192652026521265222652326524265252652626527265282652926530265312653226533265342653526536265372653826539265402654126542265432654426545265462654726548265492655026551265522655326554265552655626557265582655926560265612656226563265642656526566265672656826569265702657126572265732657426575265762657726578265792658026581265822658326584265852658626587265882658926590265912659226593265942659526596265972659826599266002660126602266032660426605266062660726608266092661026611266122661326614266152661626617266182661926620266212662226623266242662526626266272662826629266302663126632266332663426635266362663726638266392664026641266422664326644266452664626647266482664926650266512665226653266542665526656266572665826659266602666126662266632666426665266662666726668266692667026671266722667326674266752667626677266782667926680266812668226683266842668526686266872668826689266902669126692266932669426695266962669726698266992670026701267022670326704267052670626707267082670926710267112671226713267142671526716267172671826719267202672126722267232672426725267262672726728267292673026731267322673326734267352673626737267382673926740267412674226743267442674526746267472674826749267502675126752267532675426755267562675726758267592676026761267622676326764267652676626767267682676926770267712677226773267742677526776267772677826779267802678126782267832678426785267862678726788267892679026791267922679326794267952679626797267982679926800268012680226803268042680526806268072680826809268102681126812268132681426815268162681726818268192682026821268222682326824268252682626827268282682926830268312683226833268342683526836268372683826839268402684126842268432684426845268462684726848268492685026851268522685326854268552685626857268582685926860268612686226863268642686526866268672686826869268702687126872268732687426875268762687726878268792688026881268822688326884268852688626887268882688926890268912689226893268942689526896268972689826899269002690126902269032690426905269062690726908269092691026911269122691326914269152691626917269182691926920269212692226923269242692526926269272692826929269302693126932269332693426935269362693726938269392694026941269422694326944269452694626947269482694926950269512695226953269542695526956269572695826959269602696126962269632696426965269662696726968269692697026971269722697326974269752697626977269782697926980269812698226983269842698526986269872698826989269902699126992269932699426995269962699726998269992700027001270022700327004270052700627007270082700927010270112701227013270142701527016270172701827019270202702127022270232702427025270262702727028270292703027031270322703327034270352703627037270382703927040270412704227043270442704527046270472704827049270502705127052270532705427055270562705727058270592706027061270622706327064270652706627067270682706927070270712707227073270742707527076270772707827079270802708127082270832708427085270862708727088270892709027091270922709327094270952709627097270982709927100271012710227103271042710527106271072710827109271102711127112271132711427115271162711727118271192712027121271222712327124271252712627127271282712927130271312713227133271342713527136271372713827139271402714127142271432714427145271462714727148271492715027151271522715327154271552715627157271582715927160271612716227163271642716527166271672716827169271702717127172271732717427175271762717727178271792718027181271822718327184271852718627187271882718927190271912719227193271942719527196271972719827199272002720127202272032720427205272062720727208272092721027211272122721327214272152721627217272182721927220272212722227223272242722527226272272722827229272302723127232272332723427235272362723727238272392724027241272422724327244272452724627247272482724927250272512725227253272542725527256272572725827259272602726127262272632726427265272662726727268272692727027271272722727327274272752727627277272782727927280272812728227283272842728527286272872728827289272902729127292272932729427295272962729727298272992730027301273022730327304273052730627307273082730927310273112731227313273142731527316273172731827319273202732127322273232732427325273262732727328273292733027331273322733327334273352733627337273382733927340273412734227343273442734527346273472734827349273502735127352273532735427355273562735727358273592736027361273622736327364273652736627367273682736927370273712737227373273742737527376273772737827379273802738127382273832738427385273862738727388273892739027391273922739327394273952739627397273982739927400274012740227403274042740527406274072740827409274102741127412274132741427415274162741727418274192742027421274222742327424274252742627427274282742927430274312743227433274342743527436274372743827439274402744127442274432744427445274462744727448274492745027451274522745327454274552745627457274582745927460274612746227463274642746527466274672746827469274702747127472274732747427475274762747727478274792748027481274822748327484274852748627487274882748927490274912749227493274942749527496274972749827499275002750127502275032750427505275062750727508275092751027511275122751327514275152751627517275182751927520275212752227523275242752527526275272752827529275302753127532275332753427535275362753727538275392754027541275422754327544275452754627547275482754927550275512755227553275542755527556275572755827559275602756127562275632756427565275662756727568275692757027571275722757327574275752757627577275782757927580275812758227583275842758527586275872758827589275902759127592275932759427595275962759727598275992760027601276022760327604276052760627607276082760927610276112761227613276142761527616276172761827619276202762127622276232762427625276262762727628276292763027631276322763327634276352763627637276382763927640276412764227643276442764527646276472764827649276502765127652276532765427655276562765727658276592766027661276622766327664276652766627667276682766927670276712767227673276742767527676276772767827679276802768127682276832768427685276862768727688276892769027691276922769327694276952769627697276982769927700277012770227703277042770527706277072770827709277102771127712277132771427715277162771727718277192772027721277222772327724277252772627727277282772927730277312773227733277342773527736277372773827739277402774127742277432774427745277462774727748277492775027751277522775327754277552775627757277582775927760277612776227763277642776527766277672776827769277702777127772277732777427775277762777727778277792778027781277822778327784277852778627787277882778927790277912779227793277942779527796277972779827799278002780127802278032780427805278062780727808278092781027811278122781327814278152781627817278182781927820278212782227823278242782527826278272782827829278302783127832278332783427835278362783727838278392784027841278422784327844278452784627847278482784927850278512785227853278542785527856278572785827859278602786127862278632786427865278662786727868278692787027871278722787327874278752787627877278782787927880278812788227883278842788527886278872788827889278902789127892278932789427895278962789727898278992790027901279022790327904279052790627907279082790927910279112791227913279142791527916279172791827919279202792127922279232792427925279262792727928279292793027931279322793327934279352793627937279382793927940279412794227943279442794527946279472794827949279502795127952279532795427955279562795727958279592796027961279622796327964279652796627967279682796927970279712797227973279742797527976279772797827979279802798127982279832798427985279862798727988279892799027991279922799327994279952799627997279982799928000280012800228003280042800528006280072800828009280102801128012280132801428015280162801728018280192802028021280222802328024280252802628027280282802928030280312803228033280342803528036280372803828039280402804128042280432804428045280462804728048280492805028051280522805328054280552805628057280582805928060280612806228063280642806528066280672806828069280702807128072280732807428075280762807728078280792808028081280822808328084280852808628087280882808928090280912809228093280942809528096280972809828099281002810128102281032810428105281062810728108281092811028111281122811328114281152811628117281182811928120281212812228123281242812528126281272812828129281302813128132281332813428135281362813728138281392814028141281422814328144281452814628147281482814928150281512815228153281542815528156281572815828159281602816128162281632816428165281662816728168281692817028171281722817328174281752817628177281782817928180281812818228183281842818528186281872818828189281902819128192281932819428195281962819728198281992820028201282022820328204282052820628207282082820928210282112821228213282142821528216282172821828219282202822128222282232822428225282262822728228282292823028231282322823328234282352823628237282382823928240282412824228243282442824528246282472824828249282502825128252282532825428255282562825728258282592826028261282622826328264282652826628267282682826928270282712827228273282742827528276282772827828279282802828128282282832828428285282862828728288282892829028291282922829328294282952829628297282982829928300283012830228303283042830528306283072830828309283102831128312283132831428315283162831728318283192832028321283222832328324283252832628327283282832928330283312833228333283342833528336283372833828339283402834128342283432834428345283462834728348283492835028351283522835328354283552835628357283582835928360283612836228363283642836528366283672836828369283702837128372283732837428375283762837728378283792838028381283822838328384283852838628387283882838928390283912839228393283942839528396283972839828399284002840128402284032840428405284062840728408284092841028411284122841328414284152841628417284182841928420284212842228423284242842528426284272842828429284302843128432284332843428435284362843728438284392844028441284422844328444284452844628447284482844928450284512845228453284542845528456284572845828459284602846128462284632846428465284662846728468284692847028471284722847328474284752847628477284782847928480284812848228483284842848528486284872848828489284902849128492284932849428495284962849728498284992850028501285022850328504285052850628507285082850928510285112851228513285142851528516285172851828519285202852128522285232852428525285262852728528285292853028531285322853328534285352853628537285382853928540285412854228543285442854528546285472854828549285502855128552285532855428555285562855728558285592856028561285622856328564285652856628567285682856928570285712857228573285742857528576285772857828579285802858128582285832858428585285862858728588285892859028591285922859328594285952859628597285982859928600286012860228603286042860528606286072860828609286102861128612286132861428615286162861728618286192862028621286222862328624286252862628627286282862928630286312863228633286342863528636286372863828639286402864128642286432864428645286462864728648286492865028651286522865328654286552865628657286582865928660286612866228663286642866528666286672866828669286702867128672286732867428675286762867728678286792868028681286822868328684286852868628687286882868928690286912869228693286942869528696286972869828699287002870128702287032870428705287062870728708287092871028711287122871328714287152871628717287182871928720287212872228723287242872528726287272872828729287302873128732287332873428735287362873728738287392874028741287422874328744287452874628747287482874928750287512875228753287542875528756287572875828759287602876128762287632876428765287662876728768287692877028771287722877328774287752877628777287782877928780287812878228783287842878528786287872878828789287902879128792287932879428795287962879728798287992880028801288022880328804288052880628807288082880928810288112881228813288142881528816288172881828819288202882128822288232882428825288262882728828288292883028831288322883328834288352883628837288382883928840288412884228843288442884528846288472884828849288502885128852288532885428855288562885728858288592886028861288622886328864288652886628867288682886928870288712887228873288742887528876288772887828879288802888128882288832888428885288862888728888288892889028891288922889328894288952889628897288982889928900289012890228903289042890528906289072890828909289102891128912289132891428915289162891728918289192892028921289222892328924289252892628927289282892928930289312893228933289342893528936289372893828939289402894128942289432894428945289462894728948289492895028951289522895328954289552895628957289582895928960289612896228963289642896528966289672896828969289702897128972289732897428975289762897728978289792898028981289822898328984289852898628987289882898928990289912899228993289942899528996289972899828999290002900129002290032900429005290062900729008290092901029011290122901329014290152901629017290182901929020290212902229023290242902529026290272902829029290302903129032290332903429035290362903729038290392904029041290422904329044290452904629047290482904929050290512905229053290542905529056290572905829059290602906129062290632906429065290662906729068290692907029071290722907329074290752907629077290782907929080290812908229083290842908529086290872908829089290902909129092290932909429095290962909729098290992910029101291022910329104291052910629107291082910929110291112911229113291142911529116291172911829119291202912129122291232912429125291262912729128291292913029131291322913329134291352913629137291382913929140291412914229143291442914529146291472914829149291502915129152291532915429155291562915729158291592916029161291622916329164291652916629167291682916929170291712917229173291742917529176291772917829179291802918129182291832918429185291862918729188291892919029191291922919329194291952919629197291982919929200292012920229203292042920529206292072920829209292102921129212292132921429215292162921729218292192922029221292222922329224292252922629227292282922929230292312923229233292342923529236292372923829239292402924129242292432924429245292462924729248292492925029251292522925329254292552925629257292582925929260292612926229263292642926529266292672926829269292702927129272292732927429275292762927729278292792928029281292822928329284292852928629287292882928929290292912929229293292942929529296292972929829299293002930129302293032930429305293062930729308293092931029311293122931329314293152931629317293182931929320293212932229323293242932529326293272932829329293302933129332293332933429335293362933729338293392934029341293422934329344293452934629347293482934929350293512935229353293542935529356293572935829359293602936129362293632936429365293662936729368293692937029371293722937329374293752937629377293782937929380293812938229383293842938529386293872938829389293902939129392293932939429395293962939729398293992940029401294022940329404294052940629407294082940929410294112941229413294142941529416294172941829419294202942129422294232942429425294262942729428294292943029431294322943329434294352943629437294382943929440294412944229443294442944529446294472944829449294502945129452294532945429455294562945729458294592946029461294622946329464294652946629467294682946929470294712947229473294742947529476294772947829479294802948129482294832948429485294862948729488294892949029491294922949329494294952949629497294982949929500295012950229503295042950529506295072950829509295102951129512295132951429515295162951729518295192952029521295222952329524295252952629527295282952929530295312953229533295342953529536295372953829539295402954129542295432954429545295462954729548295492955029551295522955329554295552955629557295582955929560295612956229563295642956529566295672956829569295702957129572295732957429575295762957729578295792958029581295822958329584295852958629587295882958929590295912959229593295942959529596295972959829599296002960129602296032960429605296062960729608296092961029611296122961329614296152961629617296182961929620296212962229623296242962529626296272962829629296302963129632296332963429635296362963729638296392964029641296422964329644296452964629647296482964929650296512965229653296542965529656296572965829659296602966129662296632966429665296662966729668296692967029671296722967329674296752967629677296782967929680296812968229683296842968529686296872968829689296902969129692296932969429695296962969729698296992970029701297022970329704297052970629707297082970929710297112971229713297142971529716297172971829719297202972129722297232972429725297262972729728297292973029731297322973329734297352973629737297382973929740297412974229743297442974529746297472974829749297502975129752297532975429755297562975729758297592976029761297622976329764297652976629767297682976929770297712977229773297742977529776297772977829779297802978129782297832978429785297862978729788297892979029791297922979329794297952979629797297982979929800298012980229803298042980529806298072980829809298102981129812298132981429815298162981729818298192982029821298222982329824298252982629827298282982929830298312983229833298342983529836298372983829839298402984129842298432984429845298462984729848298492985029851298522985329854298552985629857298582985929860298612986229863298642986529866298672986829869298702987129872298732987429875298762987729878298792988029881298822988329884298852988629887298882988929890298912989229893298942989529896298972989829899299002990129902299032990429905299062990729908299092991029911299122991329914299152991629917299182991929920299212992229923299242992529926299272992829929299302993129932299332993429935299362993729938299392994029941299422994329944299452994629947299482994929950299512995229953299542995529956299572995829959299602996129962299632996429965299662996729968299692997029971299722997329974299752997629977299782997929980299812998229983299842998529986299872998829989299902999129992299932999429995299962999729998299993000030001300023000330004300053000630007300083000930010300113001230013300143001530016300173001830019300203002130022300233002430025300263002730028300293003030031300323003330034300353003630037300383003930040300413004230043300443004530046300473004830049300503005130052300533005430055300563005730058300593006030061300623006330064300653006630067300683006930070300713007230073300743007530076300773007830079300803008130082300833008430085300863008730088300893009030091300923009330094300953009630097300983009930100301013010230103301043010530106301073010830109301103011130112301133011430115301163011730118301193012030121301223012330124301253012630127301283012930130301313013230133301343013530136301373013830139301403014130142301433014430145301463014730148301493015030151301523015330154301553015630157301583015930160301613016230163301643016530166301673016830169301703017130172301733017430175301763017730178301793018030181301823018330184301853018630187301883018930190301913019230193301943019530196301973019830199302003020130202302033020430205302063020730208302093021030211302123021330214302153021630217302183021930220302213022230223302243022530226302273022830229302303023130232302333023430235302363023730238302393024030241302423024330244302453024630247302483024930250302513025230253302543025530256302573025830259302603026130262302633026430265302663026730268302693027030271302723027330274302753027630277302783027930280302813028230283302843028530286302873028830289302903029130292302933029430295302963029730298302993030030301303023030330304303053030630307303083030930310303113031230313303143031530316303173031830319303203032130322303233032430325303263032730328303293033030331303323033330334303353033630337303383033930340303413034230343303443034530346303473034830349303503035130352303533035430355303563035730358303593036030361303623036330364303653036630367303683036930370303713037230373303743037530376303773037830379303803038130382303833038430385303863038730388303893039030391303923039330394303953039630397303983039930400304013040230403304043040530406304073040830409304103041130412304133041430415304163041730418304193042030421304223042330424304253042630427304283042930430304313043230433304343043530436304373043830439304403044130442304433044430445304463044730448304493045030451304523045330454304553045630457304583045930460304613046230463304643046530466304673046830469304703047130472304733047430475304763047730478304793048030481304823048330484304853048630487304883048930490304913049230493304943049530496304973049830499305003050130502305033050430505305063050730508305093051030511305123051330514305153051630517305183051930520305213052230523305243052530526305273052830529305303053130532305333053430535305363053730538305393054030541305423054330544305453054630547305483054930550305513055230553305543055530556305573055830559305603056130562305633056430565305663056730568305693057030571305723057330574305753057630577305783057930580305813058230583305843058530586305873058830589305903059130592305933059430595305963059730598305993060030601306023060330604306053060630607306083060930610306113061230613306143061530616306173061830619306203062130622306233062430625306263062730628306293063030631306323063330634306353063630637306383063930640306413064230643306443064530646306473064830649306503065130652306533065430655306563065730658306593066030661306623066330664306653066630667306683066930670306713067230673306743067530676306773067830679306803068130682306833068430685306863068730688306893069030691306923069330694306953069630697306983069930700307013070230703307043070530706307073070830709307103071130712307133071430715307163071730718307193072030721307223072330724307253072630727307283072930730307313073230733307343073530736307373073830739307403074130742307433074430745307463074730748307493075030751307523075330754307553075630757307583075930760307613076230763307643076530766307673076830769307703077130772307733077430775307763077730778307793078030781307823078330784307853078630787307883078930790307913079230793307943079530796307973079830799308003080130802308033080430805308063080730808308093081030811308123081330814308153081630817308183081930820308213082230823308243082530826308273082830829308303083130832308333083430835308363083730838308393084030841308423084330844308453084630847308483084930850308513085230853308543085530856308573085830859308603086130862308633086430865308663086730868308693087030871308723087330874308753087630877308783087930880308813088230883308843088530886308873088830889308903089130892308933089430895308963089730898308993090030901309023090330904309053090630907309083090930910309113091230913309143091530916309173091830919309203092130922309233092430925309263092730928309293093030931309323093330934309353093630937309383093930940309413094230943309443094530946309473094830949309503095130952309533095430955309563095730958309593096030961309623096330964309653096630967309683096930970309713097230973309743097530976309773097830979309803098130982309833098430985309863098730988309893099030991309923099330994309953099630997309983099931000310013100231003310043100531006310073100831009310103101131012310133101431015310163101731018310193102031021310223102331024310253102631027310283102931030310313103231033310343103531036310373103831039310403104131042310433104431045310463104731048310493105031051310523105331054310553105631057310583105931060310613106231063310643106531066310673106831069310703107131072310733107431075310763107731078310793108031081310823108331084310853108631087310883108931090310913109231093310943109531096310973109831099311003110131102311033110431105311063110731108311093111031111311123111331114311153111631117311183111931120311213112231123311243112531126311273112831129311303113131132311333113431135311363113731138311393114031141311423114331144311453114631147311483114931150311513115231153311543115531156311573115831159311603116131162311633116431165311663116731168311693117031171311723117331174311753117631177311783117931180311813118231183311843118531186311873118831189311903119131192311933119431195311963119731198311993120031201312023120331204312053120631207312083120931210312113121231213312143121531216312173121831219312203122131222312233122431225312263122731228312293123031231312323123331234312353123631237312383123931240312413124231243312443124531246312473124831249312503125131252312533125431255312563125731258312593126031261312623126331264312653126631267312683126931270312713127231273312743127531276312773127831279312803128131282312833128431285312863128731288312893129031291312923129331294312953129631297312983129931300313013130231303313043130531306313073130831309313103131131312313133131431315313163131731318313193132031321313223132331324313253132631327313283132931330313313133231333313343133531336313373133831339313403134131342313433134431345313463134731348313493135031351313523135331354313553135631357313583135931360313613136231363313643136531366313673136831369313703137131372313733137431375313763137731378313793138031381313823138331384313853138631387313883138931390313913139231393313943139531396313973139831399314003140131402314033140431405314063140731408314093141031411314123141331414314153141631417314183141931420314213142231423314243142531426314273142831429314303143131432314333143431435314363143731438314393144031441314423144331444314453144631447314483144931450314513145231453314543145531456314573145831459314603146131462314633146431465314663146731468314693147031471314723147331474314753147631477314783147931480314813148231483314843148531486314873148831489314903149131492314933149431495314963149731498314993150031501315023150331504315053150631507315083150931510315113151231513315143151531516315173151831519315203152131522315233152431525315263152731528315293153031531315323153331534315353153631537315383153931540315413154231543315443154531546315473154831549315503155131552315533155431555315563155731558315593156031561315623156331564315653156631567315683156931570315713157231573315743157531576315773157831579315803158131582315833158431585315863158731588315893159031591315923159331594315953159631597315983159931600316013160231603316043160531606316073160831609316103161131612316133161431615316163161731618316193162031621316223162331624316253162631627316283162931630316313163231633316343163531636316373163831639316403164131642316433164431645316463164731648316493165031651316523165331654316553165631657316583165931660316613166231663316643166531666316673166831669316703167131672316733167431675316763167731678316793168031681316823168331684316853168631687316883168931690316913169231693316943169531696316973169831699317003170131702317033170431705317063170731708317093171031711317123171331714317153171631717317183171931720317213172231723317243172531726317273172831729317303173131732317333173431735317363173731738317393174031741317423174331744317453174631747317483174931750317513175231753317543175531756317573175831759317603176131762317633176431765317663176731768317693177031771317723177331774317753177631777317783177931780317813178231783317843178531786317873178831789317903179131792317933179431795317963179731798317993180031801318023180331804318053180631807318083180931810318113181231813318143181531816318173181831819318203182131822318233182431825318263182731828318293183031831318323183331834318353183631837318383183931840318413184231843318443184531846318473184831849318503185131852318533185431855318563185731858318593186031861318623186331864318653186631867318683186931870318713187231873318743187531876318773187831879318803188131882318833188431885318863188731888318893189031891318923189331894318953189631897318983189931900319013190231903319043190531906319073190831909319103191131912319133191431915319163191731918319193192031921319223192331924319253192631927319283192931930319313193231933319343193531936319373193831939319403194131942319433194431945319463194731948319493195031951319523195331954319553195631957319583195931960319613196231963319643196531966319673196831969319703197131972319733197431975319763197731978319793198031981319823198331984319853198631987319883198931990319913199231993319943199531996319973199831999320003200132002320033200432005320063200732008320093201032011320123201332014320153201632017320183201932020320213202232023320243202532026320273202832029320303203132032320333203432035320363203732038320393204032041320423204332044320453204632047320483204932050320513205232053320543205532056320573205832059320603206132062320633206432065320663206732068320693207032071320723207332074320753207632077320783207932080320813208232083320843208532086320873208832089320903209132092320933209432095320963209732098320993210032101321023210332104321053210632107321083210932110321113211232113321143211532116321173211832119321203212132122321233212432125321263212732128321293213032131321323213332134321353213632137321383213932140321413214232143321443214532146321473214832149321503215132152321533215432155321563215732158321593216032161321623216332164321653216632167321683216932170321713217232173321743217532176321773217832179321803218132182321833218432185321863218732188321893219032191321923219332194321953219632197321983219932200322013220232203322043220532206322073220832209322103221132212322133221432215322163221732218322193222032221322223222332224322253222632227322283222932230322313223232233322343223532236322373223832239322403224132242322433224432245322463224732248322493225032251322523225332254322553225632257322583225932260322613226232263322643226532266322673226832269322703227132272322733227432275322763227732278322793228032281322823228332284322853228632287322883228932290322913229232293322943229532296322973229832299323003230132302323033230432305323063230732308323093231032311323123231332314323153231632317323183231932320323213232232323323243232532326323273232832329323303233132332323333233432335323363233732338323393234032341323423234332344323453234632347323483234932350323513235232353323543235532356323573235832359323603236132362323633236432365323663236732368323693237032371323723237332374323753237632377323783237932380323813238232383323843238532386323873238832389323903239132392323933239432395323963239732398323993240032401324023240332404324053240632407324083240932410324113241232413324143241532416324173241832419324203242132422324233242432425324263242732428324293243032431324323243332434324353243632437324383243932440324413244232443324443244532446324473244832449324503245132452324533245432455324563245732458324593246032461324623246332464324653246632467324683246932470324713247232473324743247532476324773247832479324803248132482324833248432485324863248732488324893249032491324923249332494324953249632497324983249932500325013250232503325043250532506325073250832509325103251132512325133251432515325163251732518325193252032521325223252332524325253252632527325283252932530325313253232533325343253532536325373253832539325403254132542325433254432545325463254732548325493255032551325523255332554325553255632557325583255932560325613256232563325643256532566325673256832569325703257132572325733257432575325763257732578325793258032581325823258332584325853258632587325883258932590325913259232593325943259532596325973259832599326003260132602326033260432605326063260732608326093261032611326123261332614326153261632617326183261932620326213262232623326243262532626326273262832629326303263132632326333263432635326363263732638326393264032641326423264332644326453264632647326483264932650326513265232653326543265532656326573265832659326603266132662326633266432665326663266732668326693267032671326723267332674326753267632677326783267932680326813268232683326843268532686326873268832689326903269132692326933269432695326963269732698326993270032701327023270332704327053270632707327083270932710327113271232713327143271532716327173271832719327203272132722327233272432725327263272732728327293273032731327323273332734327353273632737327383273932740327413274232743327443274532746327473274832749327503275132752327533275432755327563275732758327593276032761327623276332764327653276632767327683276932770327713277232773327743277532776327773277832779327803278132782327833278432785327863278732788327893279032791327923279332794327953279632797327983279932800328013280232803328043280532806328073280832809328103281132812328133281432815328163281732818328193282032821328223282332824328253282632827328283282932830328313283232833328343283532836328373283832839328403284132842328433284432845328463284732848328493285032851328523285332854328553285632857328583285932860328613286232863328643286532866328673286832869328703287132872328733287432875328763287732878328793288032881328823288332884328853288632887328883288932890328913289232893328943289532896328973289832899329003290132902329033290432905329063290732908329093291032911329123291332914329153291632917329183291932920329213292232923329243292532926329273292832929329303293132932329333293432935329363293732938329393294032941329423294332944329453294632947329483294932950329513295232953329543295532956329573295832959329603296132962329633296432965329663296732968329693297032971329723297332974329753297632977329783297932980329813298232983329843298532986329873298832989329903299132992329933299432995329963299732998329993300033001330023300333004330053300633007330083300933010330113301233013330143301533016330173301833019330203302133022330233302433025330263302733028330293303033031330323303333034330353303633037330383303933040330413304233043330443304533046330473304833049330503305133052330533305433055330563305733058330593306033061330623306333064330653306633067330683306933070330713307233073330743307533076330773307833079330803308133082330833308433085330863308733088330893309033091330923309333094330953309633097330983309933100331013310233103331043310533106331073310833109331103311133112331133311433115331163311733118331193312033121331223312333124331253312633127331283312933130331313313233133331343313533136331373313833139331403314133142331433314433145331463314733148331493315033151331523315333154331553315633157331583315933160331613316233163331643316533166331673316833169331703317133172331733317433175331763317733178331793318033181331823318333184331853318633187331883318933190331913319233193331943319533196331973319833199332003320133202332033320433205332063320733208332093321033211332123321333214332153321633217332183321933220332213322233223332243322533226332273322833229332303323133232332333323433235332363323733238332393324033241332423324333244332453324633247332483324933250332513325233253332543325533256332573325833259332603326133262332633326433265332663326733268332693327033271332723327333274332753327633277332783327933280332813328233283332843328533286332873328833289332903329133292332933329433295332963329733298332993330033301333023330333304333053330633307333083330933310333113331233313333143331533316333173331833319333203332133322333233332433325333263332733328333293333033331333323333333334333353333633337333383333933340333413334233343333443334533346333473334833349333503335133352333533335433355333563335733358333593336033361333623336333364333653336633367333683336933370333713337233373333743337533376333773337833379333803338133382333833338433385333863338733388333893339033391333923339333394333953339633397333983339933400334013340233403334043340533406334073340833409334103341133412334133341433415334163341733418334193342033421334223342333424334253342633427334283342933430334313343233433334343343533436334373343833439334403344133442334433344433445334463344733448334493345033451334523345333454334553345633457334583345933460334613346233463334643346533466334673346833469334703347133472334733347433475334763347733478334793348033481334823348333484334853348633487334883348933490334913349233493334943349533496334973349833499335003350133502335033350433505335063350733508335093351033511335123351333514335153351633517335183351933520335213352233523335243352533526335273352833529335303353133532335333353433535335363353733538335393354033541335423354333544335453354633547335483354933550335513355233553335543355533556335573355833559335603356133562335633356433565335663356733568335693357033571335723357333574335753357633577335783357933580335813358233583335843358533586335873358833589335903359133592335933359433595335963359733598335993360033601336023360333604336053360633607336083360933610336113361233613336143361533616336173361833619336203362133622336233362433625336263362733628336293363033631336323363333634336353363633637336383363933640336413364233643336443364533646336473364833649336503365133652336533365433655336563365733658336593366033661336623366333664336653366633667336683366933670336713367233673336743367533676336773367833679336803368133682336833368433685336863368733688336893369033691336923369333694336953369633697336983369933700337013370233703337043370533706337073370833709337103371133712337133371433715337163371733718337193372033721337223372333724337253372633727337283372933730337313373233733337343373533736337373373833739337403374133742337433374433745337463374733748337493375033751337523375333754337553375633757337583375933760337613376233763337643376533766337673376833769337703377133772337733377433775337763377733778337793378033781337823378333784337853378633787337883378933790337913379233793337943379533796337973379833799338003380133802338033380433805338063380733808338093381033811338123381333814338153381633817338183381933820338213382233823338243382533826338273382833829338303383133832338333383433835338363383733838338393384033841338423384333844338453384633847338483384933850338513385233853338543385533856338573385833859338603386133862338633386433865338663386733868338693387033871338723387333874338753387633877338783387933880338813388233883338843388533886338873388833889338903389133892338933389433895338963389733898338993390033901339023390333904339053390633907339083390933910339113391233913339143391533916339173391833919339203392133922339233392433925339263392733928339293393033931339323393333934339353393633937339383393933940339413394233943339443394533946339473394833949339503395133952339533395433955339563395733958339593396033961339623396333964339653396633967339683396933970339713397233973339743397533976339773397833979339803398133982339833398433985339863398733988339893399033991339923399333994339953399633997339983399934000340013400234003340043400534006340073400834009340103401134012340133401434015340163401734018340193402034021340223402334024340253402634027340283402934030340313403234033340343403534036340373403834039340403404134042340433404434045340463404734048340493405034051340523405334054340553405634057340583405934060340613406234063340643406534066340673406834069340703407134072340733407434075340763407734078340793408034081340823408334084340853408634087340883408934090340913409234093340943409534096340973409834099341003410134102341033410434105341063410734108341093411034111341123411334114341153411634117341183411934120341213412234123341243412534126341273412834129341303413134132341333413434135341363413734138341393414034141341423414334144341453414634147341483414934150341513415234153341543415534156341573415834159341603416134162341633416434165341663416734168341693417034171341723417334174341753417634177341783417934180341813418234183341843418534186341873418834189341903419134192341933419434195341963419734198341993420034201342023420334204342053420634207342083420934210342113421234213342143421534216342173421834219342203422134222342233422434225342263422734228342293423034231342323423334234342353423634237342383423934240342413424234243342443424534246342473424834249342503425134252342533425434255342563425734258342593426034261342623426334264342653426634267342683426934270342713427234273342743427534276342773427834279342803428134282342833428434285342863428734288342893429034291342923429334294342953429634297342983429934300343013430234303343043430534306343073430834309343103431134312343133431434315343163431734318343193432034321343223432334324343253432634327343283432934330343313433234333343343433534336343373433834339343403434134342343433434434345343463434734348343493435034351343523435334354343553435634357343583435934360343613436234363343643436534366343673436834369343703437134372343733437434375343763437734378343793438034381343823438334384343853438634387343883438934390343913439234393343943439534396343973439834399344003440134402344033440434405344063440734408344093441034411344123441334414344153441634417344183441934420344213442234423344243442534426344273442834429344303443134432344333443434435344363443734438344393444034441344423444334444344453444634447344483444934450344513445234453344543445534456344573445834459344603446134462344633446434465344663446734468344693447034471344723447334474344753447634477344783447934480344813448234483344843448534486344873448834489344903449134492344933449434495344963449734498344993450034501345023450334504345053450634507345083450934510345113451234513345143451534516345173451834519345203452134522345233452434525345263452734528345293453034531345323453334534345353453634537345383453934540345413454234543345443454534546345473454834549345503455134552345533455434555345563455734558345593456034561345623456334564345653456634567345683456934570345713457234573345743457534576345773457834579345803458134582345833458434585345863458734588345893459034591345923459334594345953459634597345983459934600346013460234603346043460534606346073460834609346103461134612346133461434615346163461734618346193462034621346223462334624346253462634627346283462934630346313463234633346343463534636346373463834639346403464134642346433464434645346463464734648346493465034651346523465334654346553465634657346583465934660346613466234663346643466534666346673466834669346703467134672346733467434675346763467734678346793468034681346823468334684346853468634687346883468934690346913469234693346943469534696346973469834699347003470134702347033470434705347063470734708347093471034711347123471334714347153471634717347183471934720347213472234723347243472534726347273472834729347303473134732347333473434735347363473734738347393474034741347423474334744347453474634747347483474934750347513475234753347543475534756347573475834759347603476134762347633476434765347663476734768347693477034771347723477334774347753477634777347783477934780347813478234783347843478534786347873478834789347903479134792347933479434795347963479734798347993480034801348023480334804348053480634807348083480934810348113481234813348143481534816348173481834819348203482134822348233482434825348263482734828348293483034831348323483334834348353483634837348383483934840348413484234843348443484534846348473484834849348503485134852348533485434855348563485734858348593486034861348623486334864348653486634867348683486934870348713487234873348743487534876348773487834879348803488134882348833488434885348863488734888348893489034891348923489334894348953489634897348983489934900349013490234903349043490534906349073490834909349103491134912349133491434915349163491734918349193492034921349223492334924349253492634927349283492934930349313493234933349343493534936349373493834939349403494134942349433494434945349463494734948349493495034951349523495334954349553495634957349583495934960349613496234963349643496534966349673496834969349703497134972349733497434975349763497734978349793498034981349823498334984349853498634987349883498934990349913499234993349943499534996349973499834999350003500135002350033500435005350063500735008350093501035011350123501335014350153501635017350183501935020350213502235023350243502535026350273502835029350303503135032350333503435035350363503735038350393504035041350423504335044350453504635047350483504935050350513505235053350543505535056350573505835059350603506135062350633506435065350663506735068350693507035071350723507335074350753507635077350783507935080350813508235083350843508535086350873508835089350903509135092350933509435095350963509735098350993510035101351023510335104351053510635107351083510935110351113511235113351143511535116351173511835119351203512135122351233512435125351263512735128351293513035131351323513335134351353513635137351383513935140351413514235143351443514535146351473514835149351503515135152351533515435155351563515735158351593516035161351623516335164351653516635167351683516935170351713517235173351743517535176351773517835179351803518135182351833518435185351863518735188351893519035191351923519335194351953519635197351983519935200352013520235203352043520535206352073520835209352103521135212352133521435215352163521735218352193522035221352223522335224352253522635227352283522935230352313523235233352343523535236352373523835239352403524135242352433524435245352463524735248352493525035251352523525335254352553525635257352583525935260352613526235263352643526535266352673526835269352703527135272352733527435275352763527735278352793528035281352823528335284352853528635287352883528935290352913529235293352943529535296352973529835299353003530135302353033530435305353063530735308353093531035311353123531335314353153531635317353183531935320353213532235323353243532535326353273532835329353303533135332353333533435335353363533735338353393534035341353423534335344353453534635347353483534935350353513535235353353543535535356353573535835359353603536135362353633536435365353663536735368353693537035371353723537335374353753537635377353783537935380353813538235383353843538535386353873538835389353903539135392353933539435395353963539735398353993540035401354023540335404354053540635407354083540935410354113541235413354143541535416354173541835419354203542135422354233542435425354263542735428354293543035431354323543335434354353543635437354383543935440354413544235443354443544535446354473544835449354503545135452354533545435455354563545735458354593546035461354623546335464354653546635467354683546935470354713547235473354743547535476354773547835479354803548135482354833548435485354863548735488354893549035491354923549335494354953549635497354983549935500355013550235503355043550535506355073550835509355103551135512355133551435515355163551735518355193552035521355223552335524355253552635527355283552935530355313553235533355343553535536355373553835539355403554135542355433554435545355463554735548355493555035551355523555335554355553555635557355583555935560355613556235563355643556535566355673556835569355703557135572355733557435575355763557735578355793558035581355823558335584355853558635587355883558935590355913559235593355943559535596355973559835599356003560135602356033560435605356063560735608356093561035611356123561335614356153561635617356183561935620356213562235623356243562535626356273562835629356303563135632356333563435635356363563735638356393564035641356423564335644356453564635647356483564935650356513565235653356543565535656356573565835659356603566135662356633566435665356663566735668356693567035671356723567335674356753567635677356783567935680356813568235683356843568535686356873568835689356903569135692356933569435695356963569735698356993570035701357023570335704357053570635707357083570935710357113571235713357143571535716357173571835719357203572135722357233572435725357263572735728357293573035731357323573335734357353573635737357383573935740357413574235743357443574535746357473574835749357503575135752357533575435755357563575735758357593576035761357623576335764357653576635767357683576935770357713577235773357743577535776357773577835779357803578135782357833578435785357863578735788357893579035791357923579335794357953579635797357983579935800358013580235803358043580535806358073580835809358103581135812358133581435815358163581735818358193582035821358223582335824358253582635827358283582935830358313583235833358343583535836358373583835839358403584135842358433584435845358463584735848358493585035851358523585335854358553585635857358583585935860358613586235863358643586535866358673586835869358703587135872358733587435875358763587735878358793588035881358823588335884358853588635887358883588935890358913589235893358943589535896358973589835899359003590135902359033590435905359063590735908359093591035911359123591335914359153591635917359183591935920359213592235923359243592535926359273592835929359303593135932359333593435935359363593735938359393594035941359423594335944359453594635947359483594935950359513595235953359543595535956359573595835959359603596135962359633596435965359663596735968359693597035971359723597335974359753597635977359783597935980359813598235983359843598535986359873598835989359903599135992359933599435995359963599735998359993600036001360023600336004360053600636007360083600936010360113601236013360143601536016360173601836019360203602136022360233602436025360263602736028360293603036031360323603336034360353603636037360383603936040360413604236043360443604536046360473604836049360503605136052360533605436055360563605736058360593606036061360623606336064360653606636067360683606936070360713607236073360743607536076360773607836079360803608136082360833608436085360863608736088360893609036091360923609336094360953609636097360983609936100361013610236103361043610536106361073610836109361103611136112361133611436115361163611736118361193612036121361223612336124361253612636127361283612936130361313613236133361343613536136361373613836139361403614136142361433614436145361463614736148361493615036151361523615336154361553615636157361583615936160361613616236163361643616536166361673616836169361703617136172361733617436175361763617736178361793618036181361823618336184361853618636187361883618936190361913619236193361943619536196361973619836199362003620136202362033620436205362063620736208362093621036211362123621336214362153621636217362183621936220362213622236223362243622536226362273622836229362303623136232362333623436235362363623736238362393624036241362423624336244362453624636247362483624936250362513625236253362543625536256362573625836259362603626136262362633626436265362663626736268362693627036271362723627336274362753627636277362783627936280362813628236283362843628536286362873628836289362903629136292362933629436295362963629736298362993630036301363023630336304363053630636307363083630936310363113631236313363143631536316363173631836319363203632136322363233632436325363263632736328363293633036331363323633336334363353633636337363383633936340363413634236343363443634536346363473634836349363503635136352363533635436355363563635736358363593636036361363623636336364363653636636367363683636936370363713637236373363743637536376363773637836379363803638136382363833638436385363863638736388363893639036391363923639336394363953639636397363983639936400364013640236403364043640536406364073640836409364103641136412364133641436415364163641736418364193642036421364223642336424364253642636427364283642936430364313643236433364343643536436364373643836439364403644136442364433644436445364463644736448364493645036451364523645336454364553645636457364583645936460364613646236463364643646536466364673646836469364703647136472364733647436475364763647736478364793648036481364823648336484364853648636487364883648936490364913649236493364943649536496364973649836499365003650136502365033650436505365063650736508365093651036511365123651336514365153651636517365183651936520365213652236523365243652536526365273652836529365303653136532365333653436535365363653736538365393654036541365423654336544365453654636547365483654936550365513655236553365543655536556365573655836559365603656136562365633656436565365663656736568365693657036571365723657336574365753657636577365783657936580365813658236583365843658536586365873658836589365903659136592365933659436595365963659736598365993660036601366023660336604366053660636607366083660936610366113661236613366143661536616366173661836619366203662136622366233662436625366263662736628366293663036631366323663336634366353663636637366383663936640366413664236643366443664536646366473664836649366503665136652366533665436655366563665736658366593666036661366623666336664366653666636667366683666936670366713667236673366743667536676366773667836679366803668136682366833668436685366863668736688366893669036691366923669336694366953669636697366983669936700367013670236703367043670536706367073670836709367103671136712367133671436715367163671736718367193672036721367223672336724367253672636727367283672936730367313673236733367343673536736367373673836739367403674136742367433674436745367463674736748367493675036751367523675336754367553675636757367583675936760367613676236763367643676536766367673676836769367703677136772367733677436775367763677736778367793678036781367823678336784367853678636787367883678936790367913679236793367943679536796367973679836799368003680136802368033680436805368063680736808368093681036811368123681336814368153681636817368183681936820368213682236823368243682536826368273682836829368303683136832368333683436835368363683736838368393684036841368423684336844368453684636847368483684936850368513685236853368543685536856368573685836859368603686136862368633686436865368663686736868368693687036871368723687336874368753687636877368783687936880368813688236883368843688536886368873688836889368903689136892368933689436895368963689736898368993690036901369023690336904369053690636907369083690936910369113691236913369143691536916369173691836919369203692136922369233692436925369263692736928369293693036931369323693336934369353693636937369383693936940369413694236943369443694536946369473694836949369503695136952369533695436955369563695736958369593696036961369623696336964369653696636967369683696936970369713697236973369743697536976369773697836979369803698136982369833698436985369863698736988369893699036991369923699336994369953699636997369983699937000370013700237003370043700537006370073700837009370103701137012370133701437015370163701737018370193702037021370223702337024370253702637027370283702937030370313703237033370343703537036370373703837039370403704137042370433704437045370463704737048370493705037051370523705337054370553705637057370583705937060370613706237063370643706537066370673706837069370703707137072370733707437075370763707737078370793708037081370823708337084370853708637087370883708937090370913709237093370943709537096370973709837099371003710137102371033710437105371063710737108371093711037111371123711337114371153711637117371183711937120371213712237123371243712537126371273712837129371303713137132371333713437135371363713737138371393714037141371423714337144371453714637147371483714937150371513715237153371543715537156371573715837159371603716137162371633716437165371663716737168371693717037171371723717337174371753717637177371783717937180371813718237183371843718537186371873718837189371903719137192371933719437195371963719737198371993720037201372023720337204372053720637207372083720937210372113721237213372143721537216372173721837219372203722137222372233722437225372263722737228372293723037231372323723337234372353723637237372383723937240372413724237243372443724537246372473724837249372503725137252372533725437255372563725737258372593726037261372623726337264372653726637267372683726937270372713727237273372743727537276372773727837279372803728137282372833728437285372863728737288372893729037291372923729337294372953729637297372983729937300373013730237303373043730537306373073730837309373103731137312373133731437315373163731737318373193732037321373223732337324373253732637327373283732937330373313733237333373343733537336373373733837339373403734137342373433734437345373463734737348373493735037351373523735337354373553735637357373583735937360373613736237363373643736537366373673736837369373703737137372373733737437375373763737737378373793738037381373823738337384373853738637387373883738937390373913739237393373943739537396373973739837399374003740137402374033740437405374063740737408374093741037411374123741337414374153741637417374183741937420374213742237423374243742537426374273742837429374303743137432374333743437435374363743737438374393744037441374423744337444374453744637447374483744937450374513745237453374543745537456374573745837459374603746137462374633746437465374663746737468374693747037471374723747337474374753747637477374783747937480374813748237483374843748537486374873748837489374903749137492374933749437495374963749737498374993750037501375023750337504375053750637507375083750937510375113751237513375143751537516375173751837519375203752137522375233752437525375263752737528375293753037531375323753337534375353753637537375383753937540375413754237543375443754537546375473754837549375503755137552375533755437555375563755737558375593756037561375623756337564375653756637567375683756937570375713757237573375743757537576375773757837579375803758137582375833758437585375863758737588375893759037591375923759337594375953759637597375983759937600376013760237603376043760537606376073760837609376103761137612376133761437615376163761737618376193762037621376223762337624376253762637627376283762937630376313763237633376343763537636376373763837639376403764137642376433764437645376463764737648376493765037651376523765337654376553765637657376583765937660376613766237663376643766537666376673766837669376703767137672376733767437675376763767737678376793768037681376823768337684376853768637687376883768937690376913769237693376943769537696376973769837699377003770137702377033770437705377063770737708377093771037711377123771337714377153771637717377183771937720377213772237723377243772537726377273772837729377303773137732377333773437735377363773737738377393774037741377423774337744377453774637747377483774937750377513775237753377543775537756377573775837759377603776137762377633776437765377663776737768377693777037771377723777337774377753777637777377783777937780377813778237783377843778537786377873778837789377903779137792377933779437795377963779737798377993780037801378023780337804378053780637807378083780937810378113781237813378143781537816378173781837819378203782137822378233782437825378263782737828378293783037831378323783337834378353783637837378383783937840378413784237843378443784537846378473784837849378503785137852378533785437855378563785737858378593786037861378623786337864378653786637867378683786937870378713787237873378743787537876378773787837879378803788137882378833788437885378863788737888378893789037891378923789337894378953789637897378983789937900379013790237903379043790537906379073790837909379103791137912379133791437915379163791737918379193792037921379223792337924379253792637927379283792937930379313793237933379343793537936379373793837939379403794137942379433794437945379463794737948379493795037951379523795337954379553795637957379583795937960379613796237963379643796537966379673796837969379703797137972379733797437975379763797737978379793798037981379823798337984379853798637987379883798937990379913799237993379943799537996379973799837999380003800138002380033800438005380063800738008380093801038011380123801338014380153801638017380183801938020380213802238023380243802538026380273802838029380303803138032380333803438035380363803738038380393804038041380423804338044380453804638047380483804938050380513805238053380543805538056380573805838059380603806138062380633806438065380663806738068380693807038071380723807338074380753807638077380783807938080380813808238083380843808538086380873808838089380903809138092380933809438095380963809738098380993810038101381023810338104381053810638107381083810938110381113811238113381143811538116381173811838119381203812138122381233812438125381263812738128381293813038131381323813338134381353813638137381383813938140381413814238143381443814538146381473814838149381503815138152381533815438155381563815738158381593816038161381623816338164381653816638167381683816938170381713817238173381743817538176381773817838179381803818138182381833818438185381863818738188381893819038191381923819338194381953819638197381983819938200382013820238203382043820538206382073820838209382103821138212382133821438215382163821738218382193822038221382223822338224382253822638227382283822938230382313823238233382343823538236382373823838239382403824138242382433824438245382463824738248382493825038251382523825338254382553825638257382583825938260382613826238263382643826538266382673826838269382703827138272382733827438275382763827738278382793828038281382823828338284382853828638287382883828938290382913829238293382943829538296382973829838299383003830138302383033830438305383063830738308383093831038311383123831338314383153831638317383183831938320383213832238323383243832538326383273832838329383303833138332383333833438335383363833738338383393834038341383423834338344383453834638347383483834938350383513835238353383543835538356383573835838359383603836138362383633836438365383663836738368383693837038371383723837338374383753837638377383783837938380383813838238383383843838538386383873838838389383903839138392383933839438395383963839738398383993840038401384023840338404384053840638407384083840938410384113841238413384143841538416384173841838419384203842138422384233842438425384263842738428384293843038431384323843338434384353843638437384383843938440384413844238443384443844538446384473844838449384503845138452384533845438455384563845738458384593846038461384623846338464384653846638467384683846938470384713847238473384743847538476384773847838479384803848138482384833848438485384863848738488384893849038491384923849338494384953849638497384983849938500385013850238503385043850538506385073850838509385103851138512385133851438515385163851738518385193852038521385223852338524385253852638527385283852938530385313853238533385343853538536385373853838539385403854138542385433854438545385463854738548385493855038551385523855338554385553855638557385583855938560385613856238563385643856538566385673856838569385703857138572385733857438575385763857738578385793858038581385823858338584385853858638587385883858938590385913859238593385943859538596385973859838599386003860138602386033860438605386063860738608386093861038611386123861338614386153861638617386183861938620386213862238623386243862538626386273862838629386303863138632386333863438635386363863738638386393864038641386423864338644386453864638647386483864938650386513865238653386543865538656386573865838659386603866138662386633866438665386663866738668386693867038671386723867338674386753867638677386783867938680386813868238683386843868538686386873868838689386903869138692386933869438695386963869738698386993870038701387023870338704387053870638707387083870938710387113871238713387143871538716387173871838719387203872138722387233872438725387263872738728387293873038731387323873338734387353873638737387383873938740387413874238743387443874538746387473874838749387503875138752387533875438755387563875738758387593876038761387623876338764387653876638767387683876938770387713877238773387743877538776387773877838779387803878138782387833878438785387863878738788387893879038791387923879338794387953879638797387983879938800388013880238803388043880538806388073880838809388103881138812388133881438815388163881738818388193882038821388223882338824388253882638827388283882938830388313883238833388343883538836388373883838839388403884138842388433884438845388463884738848388493885038851388523885338854388553885638857388583885938860388613886238863388643886538866388673886838869388703887138872388733887438875388763887738878388793888038881388823888338884388853888638887388883888938890388913889238893388943889538896388973889838899389003890138902389033890438905389063890738908389093891038911389123891338914389153891638917389183891938920389213892238923389243892538926389273892838929389303893138932389333893438935389363893738938389393894038941389423894338944389453894638947389483894938950389513895238953389543895538956389573895838959389603896138962389633896438965389663896738968389693897038971389723897338974389753897638977389783897938980389813898238983389843898538986389873898838989389903899138992389933899438995389963899738998389993900039001390023900339004390053900639007390083900939010390113901239013390143901539016390173901839019390203902139022390233902439025390263902739028390293903039031390323903339034390353903639037390383903939040390413904239043390443904539046390473904839049390503905139052390533905439055390563905739058390593906039061390623906339064390653906639067390683906939070390713907239073390743907539076390773907839079390803908139082390833908439085390863908739088390893909039091390923909339094390953909639097390983909939100391013910239103391043910539106391073910839109391103911139112391133911439115391163911739118391193912039121391223912339124391253912639127391283912939130391313913239133391343913539136391373913839139391403914139142391433914439145391463914739148391493915039151391523915339154391553915639157391583915939160391613916239163391643916539166391673916839169391703917139172391733917439175391763917739178391793918039181391823918339184391853918639187391883918939190391913919239193391943919539196391973919839199392003920139202392033920439205392063920739208392093921039211392123921339214392153921639217392183921939220392213922239223392243922539226392273922839229392303923139232392333923439235392363923739238392393924039241392423924339244392453924639247392483924939250392513925239253392543925539256392573925839259392603926139262392633926439265392663926739268392693927039271392723927339274392753927639277392783927939280392813928239283392843928539286392873928839289392903929139292392933929439295392963929739298392993930039301393023930339304393053930639307393083930939310393113931239313393143931539316393173931839319393203932139322393233932439325393263932739328393293933039331393323933339334393353933639337393383933939340393413934239343393443934539346393473934839349393503935139352393533935439355393563935739358393593936039361393623936339364393653936639367393683936939370393713937239373393743937539376393773937839379393803938139382393833938439385393863938739388393893939039391393923939339394393953939639397393983939939400394013940239403394043940539406394073940839409394103941139412394133941439415394163941739418394193942039421394223942339424394253942639427394283942939430394313943239433394343943539436394373943839439394403944139442394433944439445394463944739448394493945039451394523945339454394553945639457394583945939460394613946239463394643946539466394673946839469394703947139472394733947439475394763947739478394793948039481394823948339484394853948639487394883948939490394913949239493394943949539496394973949839499395003950139502395033950439505395063950739508395093951039511395123951339514395153951639517395183951939520395213952239523395243952539526395273952839529395303953139532395333953439535395363953739538395393954039541395423954339544395453954639547395483954939550395513955239553395543955539556395573955839559395603956139562395633956439565395663956739568395693957039571395723957339574395753957639577395783957939580395813958239583395843958539586395873958839589395903959139592395933959439595395963959739598395993960039601396023960339604396053960639607396083960939610396113961239613396143961539616396173961839619396203962139622396233962439625396263962739628396293963039631396323963339634396353963639637396383963939640396413964239643396443964539646396473964839649396503965139652396533965439655396563965739658396593966039661396623966339664396653966639667396683966939670396713967239673396743967539676396773967839679396803968139682396833968439685396863968739688396893969039691396923969339694396953969639697396983969939700397013970239703397043970539706397073970839709397103971139712397133971439715397163971739718397193972039721397223972339724397253972639727397283972939730397313973239733397343973539736397373973839739397403974139742397433974439745397463974739748397493975039751397523975339754397553975639757397583975939760397613976239763397643976539766397673976839769397703977139772397733977439775397763977739778397793978039781397823978339784397853978639787397883978939790397913979239793397943979539796397973979839799398003980139802398033980439805398063980739808398093981039811398123981339814398153981639817398183981939820398213982239823398243982539826398273982839829398303983139832398333983439835398363983739838398393984039841398423984339844398453984639847398483984939850398513985239853398543985539856398573985839859398603986139862398633986439865398663986739868398693987039871398723987339874398753987639877398783987939880398813988239883398843988539886398873988839889398903989139892398933989439895398963989739898398993990039901399023990339904399053990639907399083990939910399113991239913399143991539916399173991839919399203992139922399233992439925399263992739928399293993039931399323993339934399353993639937399383993939940399413994239943399443994539946399473994839949399503995139952399533995439955399563995739958399593996039961399623996339964399653996639967399683996939970399713997239973399743997539976399773997839979399803998139982399833998439985399863998739988399893999039991399923999339994399953999639997399983999940000400014000240003400044000540006400074000840009400104001140012400134001440015400164001740018400194002040021400224002340024400254002640027400284002940030400314003240033400344003540036400374003840039400404004140042400434004440045400464004740048400494005040051400524005340054400554005640057400584005940060400614006240063400644006540066400674006840069400704007140072400734007440075400764007740078400794008040081400824008340084400854008640087400884008940090400914009240093400944009540096400974009840099401004010140102401034010440105401064010740108401094011040111401124011340114401154011640117401184011940120401214012240123401244012540126401274012840129401304013140132401334013440135401364013740138401394014040141401424014340144401454014640147401484014940150401514015240153401544015540156401574015840159401604016140162401634016440165401664016740168401694017040171401724017340174401754017640177401784017940180401814018240183401844018540186401874018840189401904019140192401934019440195401964019740198401994020040201402024020340204402054020640207402084020940210402114021240213402144021540216402174021840219402204022140222402234022440225402264022740228402294023040231402324023340234402354023640237402384023940240402414024240243402444024540246402474024840249402504025140252402534025440255402564025740258402594026040261402624026340264402654026640267402684026940270402714027240273402744027540276402774027840279402804028140282402834028440285402864028740288402894029040291402924029340294402954029640297402984029940300403014030240303403044030540306403074030840309403104031140312403134031440315403164031740318403194032040321403224032340324403254032640327403284032940330403314033240333403344033540336403374033840339403404034140342403434034440345403464034740348403494035040351403524035340354403554035640357403584035940360403614036240363403644036540366403674036840369403704037140372403734037440375403764037740378403794038040381403824038340384403854038640387403884038940390403914039240393403944039540396403974039840399404004040140402404034040440405404064040740408404094041040411404124041340414404154041640417404184041940420404214042240423404244042540426404274042840429404304043140432404334043440435404364043740438404394044040441404424044340444404454044640447404484044940450404514045240453404544045540456404574045840459404604046140462404634046440465404664046740468404694047040471404724047340474404754047640477404784047940480404814048240483404844048540486404874048840489404904049140492404934049440495404964049740498404994050040501405024050340504405054050640507405084050940510405114051240513405144051540516405174051840519405204052140522405234052440525405264052740528405294053040531405324053340534405354053640537405384053940540405414054240543405444054540546405474054840549405504055140552405534055440555405564055740558405594056040561405624056340564405654056640567405684056940570405714057240573405744057540576405774057840579405804058140582405834058440585405864058740588405894059040591405924059340594405954059640597405984059940600406014060240603406044060540606406074060840609406104061140612406134061440615406164061740618406194062040621406224062340624406254062640627406284062940630406314063240633406344063540636406374063840639406404064140642406434064440645406464064740648406494065040651406524065340654406554065640657406584065940660406614066240663406644066540666406674066840669406704067140672406734067440675406764067740678406794068040681406824068340684406854068640687406884068940690406914069240693406944069540696406974069840699407004070140702407034070440705407064070740708407094071040711407124071340714407154071640717407184071940720407214072240723407244072540726407274072840729407304073140732407334073440735407364073740738407394074040741407424074340744407454074640747407484074940750407514075240753407544075540756407574075840759407604076140762407634076440765407664076740768407694077040771407724077340774407754077640777407784077940780407814078240783407844078540786407874078840789407904079140792407934079440795407964079740798407994080040801408024080340804408054080640807408084080940810408114081240813408144081540816408174081840819408204082140822408234082440825408264082740828408294083040831408324083340834408354083640837408384083940840408414084240843408444084540846408474084840849408504085140852408534085440855408564085740858408594086040861408624086340864408654086640867408684086940870408714087240873408744087540876408774087840879408804088140882408834088440885408864088740888408894089040891408924089340894408954089640897408984089940900409014090240903409044090540906409074090840909409104091140912409134091440915409164091740918409194092040921409224092340924409254092640927409284092940930409314093240933409344093540936409374093840939409404094140942409434094440945409464094740948409494095040951409524095340954409554095640957409584095940960409614096240963409644096540966409674096840969409704097140972409734097440975409764097740978409794098040981409824098340984409854098640987409884098940990409914099240993409944099540996409974099840999410004100141002410034100441005410064100741008410094101041011410124101341014410154101641017410184101941020410214102241023410244102541026410274102841029410304103141032410334103441035410364103741038410394104041041410424104341044410454104641047410484104941050410514105241053410544105541056410574105841059410604106141062410634106441065410664106741068410694107041071410724107341074410754107641077410784107941080410814108241083410844108541086410874108841089410904109141092410934109441095410964109741098410994110041101411024110341104411054110641107411084110941110411114111241113411144111541116411174111841119411204112141122411234112441125411264112741128411294113041131411324113341134411354113641137411384113941140411414114241143411444114541146411474114841149411504115141152411534115441155411564115741158411594116041161411624116341164411654116641167411684116941170411714117241173411744117541176411774117841179411804118141182411834118441185411864118741188411894119041191411924119341194411954119641197411984119941200412014120241203412044120541206412074120841209412104121141212412134121441215412164121741218412194122041221412224122341224412254122641227412284122941230412314123241233412344123541236412374123841239412404124141242412434124441245412464124741248412494125041251412524125341254412554125641257412584125941260412614126241263412644126541266412674126841269412704127141272412734127441275412764127741278412794128041281412824128341284412854128641287412884128941290412914129241293412944129541296412974129841299413004130141302413034130441305413064130741308413094131041311413124131341314413154131641317413184131941320413214132241323413244132541326413274132841329413304133141332413334133441335413364133741338413394134041341413424134341344413454134641347413484134941350413514135241353413544135541356413574135841359413604136141362413634136441365413664136741368413694137041371413724137341374413754137641377413784137941380413814138241383413844138541386413874138841389413904139141392413934139441395413964139741398413994140041401414024140341404414054140641407414084140941410414114141241413414144141541416414174141841419414204142141422414234142441425414264142741428414294143041431414324143341434414354143641437414384143941440414414144241443414444144541446414474144841449414504145141452414534145441455414564145741458414594146041461414624146341464414654146641467414684146941470414714147241473414744147541476414774147841479414804148141482414834148441485414864148741488414894149041491414924149341494414954149641497414984149941500415014150241503415044150541506415074150841509415104151141512415134151441515415164151741518415194152041521415224152341524415254152641527415284152941530415314153241533415344153541536415374153841539415404154141542415434154441545415464154741548415494155041551415524155341554415554155641557415584155941560415614156241563415644156541566415674156841569415704157141572415734157441575415764157741578415794158041581415824158341584415854158641587415884158941590415914159241593415944159541596415974159841599416004160141602416034160441605416064160741608416094161041611416124161341614416154161641617416184161941620416214162241623416244162541626416274162841629416304163141632416334163441635416364163741638416394164041641416424164341644416454164641647416484164941650416514165241653416544165541656416574165841659416604166141662416634166441665416664166741668416694167041671416724167341674416754167641677416784167941680416814168241683416844168541686416874168841689416904169141692416934169441695416964169741698416994170041701417024170341704417054170641707417084170941710417114171241713417144171541716417174171841719417204172141722417234172441725417264172741728417294173041731417324173341734417354173641737417384173941740417414174241743417444174541746417474174841749417504175141752417534175441755417564175741758417594176041761417624176341764417654176641767417684176941770417714177241773417744177541776417774177841779417804178141782417834178441785417864178741788417894179041791417924179341794417954179641797417984179941800418014180241803418044180541806418074180841809418104181141812418134181441815418164181741818418194182041821418224182341824418254182641827418284182941830418314183241833418344183541836418374183841839418404184141842418434184441845418464184741848418494185041851418524185341854418554185641857418584185941860418614186241863418644186541866418674186841869418704187141872418734187441875418764187741878418794188041881418824188341884418854188641887418884188941890418914189241893418944189541896418974189841899419004190141902419034190441905419064190741908419094191041911419124191341914419154191641917419184191941920419214192241923419244192541926419274192841929419304193141932419334193441935419364193741938419394194041941419424194341944419454194641947419484194941950419514195241953419544195541956419574195841959419604196141962419634196441965419664196741968419694197041971419724197341974419754197641977419784197941980419814198241983419844198541986419874198841989419904199141992419934199441995419964199741998419994200042001420024200342004420054200642007420084200942010420114201242013420144201542016420174201842019420204202142022420234202442025420264202742028420294203042031420324203342034420354203642037420384203942040420414204242043420444204542046420474204842049420504205142052420534205442055420564205742058420594206042061420624206342064420654206642067420684206942070420714207242073420744207542076420774207842079420804208142082420834208442085420864208742088420894209042091420924209342094420954209642097420984209942100421014210242103421044210542106421074210842109421104211142112421134211442115421164211742118421194212042121421224212342124421254212642127421284212942130421314213242133421344213542136421374213842139421404214142142421434214442145421464214742148421494215042151421524215342154421554215642157421584215942160421614216242163421644216542166421674216842169421704217142172421734217442175421764217742178421794218042181421824218342184421854218642187421884218942190421914219242193421944219542196421974219842199422004220142202422034220442205422064220742208422094221042211422124221342214422154221642217422184221942220422214222242223422244222542226422274222842229422304223142232422334223442235422364223742238422394224042241422424224342244422454224642247422484224942250422514225242253422544225542256422574225842259422604226142262422634226442265422664226742268422694227042271422724227342274422754227642277422784227942280422814228242283422844228542286422874228842289422904229142292422934229442295422964229742298422994230042301423024230342304423054230642307423084230942310423114231242313423144231542316423174231842319423204232142322423234232442325423264232742328423294233042331423324233342334423354233642337423384233942340423414234242343423444234542346423474234842349423504235142352423534235442355423564235742358423594236042361423624236342364423654236642367423684236942370423714237242373423744237542376423774237842379423804238142382423834238442385423864238742388423894239042391423924239342394423954239642397423984239942400424014240242403424044240542406424074240842409424104241142412424134241442415424164241742418424194242042421424224242342424424254242642427424284242942430424314243242433424344243542436424374243842439424404244142442424434244442445424464244742448424494245042451424524245342454424554245642457424584245942460424614246242463424644246542466424674246842469424704247142472424734247442475424764247742478424794248042481424824248342484424854248642487424884248942490424914249242493424944249542496424974249842499425004250142502425034250442505425064250742508425094251042511425124251342514425154251642517425184251942520425214252242523425244252542526425274252842529425304253142532425334253442535425364253742538425394254042541425424254342544425454254642547425484254942550425514255242553425544255542556425574255842559425604256142562425634256442565425664256742568425694257042571425724257342574425754257642577425784257942580425814258242583425844258542586425874258842589425904259142592425934259442595425964259742598425994260042601426024260342604426054260642607426084260942610426114261242613426144261542616426174261842619426204262142622426234262442625426264262742628426294263042631426324263342634426354263642637426384263942640426414264242643426444264542646426474264842649426504265142652426534265442655426564265742658426594266042661426624266342664426654266642667426684266942670426714267242673426744267542676426774267842679426804268142682426834268442685426864268742688426894269042691426924269342694426954269642697426984269942700427014270242703427044270542706427074270842709427104271142712427134271442715427164271742718427194272042721427224272342724427254272642727427284272942730427314273242733427344273542736427374273842739427404274142742427434274442745427464274742748427494275042751427524275342754427554275642757427584275942760427614276242763427644276542766427674276842769427704277142772427734277442775427764277742778427794278042781427824278342784427854278642787427884278942790427914279242793427944279542796427974279842799428004280142802428034280442805428064280742808428094281042811428124281342814428154281642817428184281942820428214282242823428244282542826428274282842829428304283142832428334283442835428364283742838428394284042841428424284342844428454284642847428484284942850428514285242853428544285542856428574285842859428604286142862428634286442865428664286742868428694287042871428724287342874428754287642877428784287942880428814288242883428844288542886428874288842889428904289142892428934289442895428964289742898428994290042901429024290342904429054290642907429084290942910429114291242913429144291542916429174291842919429204292142922429234292442925429264292742928429294293042931429324293342934429354293642937429384293942940429414294242943429444294542946429474294842949429504295142952429534295442955429564295742958429594296042961429624296342964429654296642967429684296942970429714297242973429744297542976429774297842979429804298142982429834298442985429864298742988429894299042991429924299342994429954299642997429984299943000430014300243003430044300543006430074300843009430104301143012430134301443015430164301743018430194302043021430224302343024430254302643027430284302943030430314303243033430344303543036430374303843039430404304143042430434304443045430464304743048430494305043051430524305343054430554305643057430584305943060430614306243063430644306543066430674306843069430704307143072430734307443075430764307743078430794308043081430824308343084430854308643087430884308943090430914309243093430944309543096430974309843099431004310143102431034310443105431064310743108431094311043111431124311343114431154311643117431184311943120431214312243123431244312543126431274312843129431304313143132431334313443135431364313743138431394314043141431424314343144431454314643147431484314943150431514315243153431544315543156431574315843159431604316143162431634316443165431664316743168431694317043171431724317343174431754317643177431784317943180431814318243183431844318543186431874318843189431904319143192431934319443195431964319743198431994320043201432024320343204432054320643207432084320943210432114321243213432144321543216432174321843219432204322143222432234322443225432264322743228432294323043231432324323343234432354323643237432384323943240432414324243243432444324543246432474324843249432504325143252432534325443255432564325743258432594326043261432624326343264432654326643267432684326943270432714327243273432744327543276432774327843279432804328143282432834328443285432864328743288432894329043291432924329343294432954329643297432984329943300433014330243303433044330543306433074330843309433104331143312433134331443315433164331743318433194332043321433224332343324433254332643327433284332943330433314333243333433344333543336433374333843339433404334143342433434334443345433464334743348433494335043351433524335343354433554335643357433584335943360433614336243363433644336543366433674336843369433704337143372433734337443375433764337743378433794338043381433824338343384433854338643387433884338943390433914339243393433944339543396433974339843399434004340143402434034340443405434064340743408434094341043411434124341343414434154341643417434184341943420434214342243423434244342543426434274342843429434304343143432434334343443435434364343743438434394344043441434424344343444434454344643447434484344943450434514345243453434544345543456434574345843459434604346143462434634346443465434664346743468434694347043471434724347343474434754347643477434784347943480434814348243483434844348543486434874348843489434904349143492434934349443495434964349743498434994350043501435024350343504435054350643507435084350943510435114351243513435144351543516435174351843519435204352143522435234352443525435264352743528435294353043531435324353343534435354353643537435384353943540435414354243543435444354543546435474354843549435504355143552435534355443555435564355743558435594356043561435624356343564435654356643567435684356943570435714357243573435744357543576435774357843579435804358143582435834358443585435864358743588435894359043591435924359343594435954359643597435984359943600436014360243603436044360543606436074360843609436104361143612436134361443615436164361743618436194362043621436224362343624436254362643627436284362943630436314363243633436344363543636436374363843639436404364143642436434364443645436464364743648436494365043651436524365343654436554365643657436584365943660436614366243663436644366543666436674366843669436704367143672436734367443675436764367743678436794368043681436824368343684436854368643687436884368943690436914369243693436944369543696436974369843699437004370143702437034370443705437064370743708437094371043711437124371343714437154371643717437184371943720437214372243723437244372543726437274372843729437304373143732437334373443735437364373743738437394374043741437424374343744437454374643747437484374943750437514375243753437544375543756437574375843759437604376143762437634376443765437664376743768437694377043771437724377343774437754377643777437784377943780437814378243783437844378543786437874378843789437904379143792437934379443795437964379743798437994380043801438024380343804438054380643807438084380943810438114381243813438144381543816438174381843819438204382143822438234382443825438264382743828438294383043831438324383343834438354383643837438384383943840438414384243843438444384543846438474384843849438504385143852438534385443855438564385743858438594386043861438624386343864438654386643867438684386943870438714387243873438744387543876438774387843879438804388143882438834388443885438864388743888438894389043891438924389343894438954389643897438984389943900439014390243903439044390543906439074390843909439104391143912439134391443915439164391743918439194392043921439224392343924439254392643927439284392943930439314393243933439344393543936439374393843939439404394143942439434394443945439464394743948439494395043951439524395343954439554395643957439584395943960439614396243963439644396543966439674396843969439704397143972439734397443975439764397743978439794398043981439824398343984439854398643987439884398943990439914399243993439944399543996439974399843999440004400144002440034400444005440064400744008440094401044011440124401344014440154401644017440184401944020440214402244023440244402544026440274402844029440304403144032440334403444035440364403744038440394404044041440424404344044440454404644047440484404944050440514405244053440544405544056440574405844059440604406144062440634406444065440664406744068440694407044071440724407344074440754407644077440784407944080440814408244083440844408544086440874408844089440904409144092440934409444095440964409744098440994410044101441024410344104441054410644107441084410944110441114411244113441144411544116441174411844119441204412144122441234412444125441264412744128441294413044131441324413344134441354413644137441384413944140441414414244143441444414544146441474414844149441504415144152441534415444155441564415744158441594416044161441624416344164441654416644167441684416944170441714417244173441744417544176441774417844179441804418144182441834418444185441864418744188441894419044191441924419344194441954419644197441984419944200442014420244203442044420544206442074420844209442104421144212442134421444215442164421744218442194422044221442224422344224442254422644227442284422944230442314423244233442344423544236442374423844239442404424144242442434424444245442464424744248442494425044251442524425344254442554425644257442584425944260442614426244263442644426544266442674426844269442704427144272442734427444275442764427744278442794428044281442824428344284442854428644287442884428944290442914429244293442944429544296442974429844299443004430144302443034430444305443064430744308443094431044311443124431344314443154431644317443184431944320443214432244323443244432544326443274432844329443304433144332443334433444335443364433744338443394434044341443424434344344443454434644347443484434944350443514435244353443544435544356443574435844359443604436144362443634436444365443664436744368443694437044371443724437344374443754437644377443784437944380443814438244383443844438544386443874438844389443904439144392443934439444395443964439744398443994440044401444024440344404444054440644407444084440944410444114441244413444144441544416444174441844419444204442144422444234442444425444264442744428444294443044431444324443344434444354443644437444384443944440444414444244443444444444544446444474444844449444504445144452444534445444455444564445744458444594446044461444624446344464444654446644467444684446944470444714447244473444744447544476444774447844479444804448144482444834448444485444864448744488444894449044491444924449344494444954449644497444984449944500445014450244503445044450544506445074450844509445104451144512445134451444515445164451744518445194452044521445224452344524445254452644527445284452944530445314453244533445344453544536445374453844539445404454144542445434454444545445464454744548445494455044551445524455344554445554455644557445584455944560445614456244563445644456544566445674456844569445704457144572445734457444575445764457744578445794458044581445824458344584445854458644587445884458944590445914459244593445944459544596445974459844599446004460144602446034460444605446064460744608446094461044611446124461344614446154461644617446184461944620446214462244623446244462544626446274462844629446304463144632446334463444635446364463744638446394464044641446424464344644446454464644647446484464944650446514465244653446544465544656446574465844659446604466144662446634466444665446664466744668446694467044671446724467344674446754467644677446784467944680446814468244683446844468544686446874468844689446904469144692446934469444695446964469744698446994470044701447024470344704447054470644707447084470944710447114471244713447144471544716447174471844719447204472144722447234472444725447264472744728447294473044731447324473344734447354473644737447384473944740447414474244743447444474544746447474474844749447504475144752447534475444755447564475744758447594476044761447624476344764447654476644767447684476944770447714477244773447744477544776447774477844779447804478144782447834478444785447864478744788447894479044791447924479344794447954479644797447984479944800448014480244803448044480544806448074480844809448104481144812448134481444815448164481744818448194482044821448224482344824448254482644827448284482944830448314483244833448344483544836448374483844839448404484144842448434484444845448464484744848448494485044851448524485344854448554485644857448584485944860448614486244863448644486544866448674486844869448704487144872448734487444875448764487744878448794488044881448824488344884448854488644887448884488944890448914489244893448944489544896448974489844899449004490144902449034490444905449064490744908449094491044911449124491344914449154491644917449184491944920449214492244923449244492544926449274492844929449304493144932449334493444935449364493744938449394494044941449424494344944449454494644947449484494944950449514495244953449544495544956449574495844959449604496144962449634496444965449664496744968449694497044971449724497344974449754497644977449784497944980449814498244983449844498544986449874498844989449904499144992449934499444995449964499744998449994500045001450024500345004450054500645007450084500945010450114501245013450144501545016450174501845019450204502145022450234502445025450264502745028450294503045031450324503345034450354503645037450384503945040450414504245043450444504545046450474504845049450504505145052450534505445055450564505745058450594506045061450624506345064450654506645067450684506945070450714507245073450744507545076450774507845079450804508145082450834508445085450864508745088450894509045091450924509345094450954509645097450984509945100451014510245103451044510545106451074510845109451104511145112451134511445115451164511745118451194512045121451224512345124451254512645127451284512945130451314513245133451344513545136451374513845139451404514145142451434514445145451464514745148451494515045151451524515345154451554515645157451584515945160451614516245163451644516545166451674516845169451704517145172451734517445175451764517745178451794518045181451824518345184451854518645187451884518945190451914519245193451944519545196451974519845199452004520145202452034520445205452064520745208452094521045211452124521345214452154521645217452184521945220452214522245223452244522545226452274522845229452304523145232452334523445235452364523745238452394524045241452424524345244452454524645247452484524945250452514525245253452544525545256452574525845259452604526145262452634526445265452664526745268452694527045271452724527345274452754527645277452784527945280452814528245283452844528545286452874528845289452904529145292452934529445295452964529745298452994530045301453024530345304453054530645307453084530945310453114531245313453144531545316453174531845319453204532145322453234532445325453264532745328453294533045331453324533345334453354533645337453384533945340453414534245343453444534545346453474534845349453504535145352453534535445355453564535745358453594536045361453624536345364453654536645367453684536945370453714537245373453744537545376453774537845379453804538145382453834538445385453864538745388453894539045391453924539345394453954539645397453984539945400454014540245403454044540545406454074540845409454104541145412454134541445415454164541745418454194542045421454224542345424454254542645427454284542945430454314543245433454344543545436454374543845439454404544145442454434544445445454464544745448454494545045451454524545345454454554545645457454584545945460454614546245463454644546545466454674546845469454704547145472454734547445475454764547745478454794548045481454824548345484454854548645487454884548945490454914549245493454944549545496454974549845499455004550145502455034550445505455064550745508455094551045511455124551345514455154551645517455184551945520455214552245523455244552545526455274552845529455304553145532455334553445535455364553745538455394554045541455424554345544455454554645547455484554945550455514555245553455544555545556455574555845559455604556145562455634556445565455664556745568455694557045571455724557345574455754557645577455784557945580455814558245583455844558545586455874558845589455904559145592455934559445595455964559745598455994560045601456024560345604456054560645607456084560945610456114561245613456144561545616456174561845619456204562145622456234562445625456264562745628456294563045631456324563345634456354563645637456384563945640456414564245643456444564545646456474564845649456504565145652456534565445655456564565745658456594566045661456624566345664456654566645667456684566945670456714567245673456744567545676456774567845679456804568145682456834568445685456864568745688456894569045691456924569345694456954569645697456984569945700457014570245703457044570545706457074570845709457104571145712457134571445715457164571745718457194572045721457224572345724457254572645727457284572945730457314573245733457344573545736457374573845739457404574145742457434574445745457464574745748457494575045751457524575345754457554575645757457584575945760457614576245763457644576545766457674576845769457704577145772457734577445775457764577745778457794578045781457824578345784457854578645787457884578945790457914579245793457944579545796457974579845799458004580145802458034580445805458064580745808458094581045811458124581345814458154581645817458184581945820458214582245823458244582545826458274582845829458304583145832458334583445835458364583745838458394584045841458424584345844458454584645847458484584945850458514585245853458544585545856458574585845859458604586145862458634586445865458664586745868458694587045871458724587345874458754587645877458784587945880458814588245883458844588545886458874588845889458904589145892458934589445895458964589745898458994590045901459024590345904459054590645907459084590945910459114591245913459144591545916459174591845919459204592145922459234592445925459264592745928459294593045931459324593345934459354593645937459384593945940459414594245943459444594545946459474594845949459504595145952459534595445955459564595745958459594596045961459624596345964459654596645967459684596945970459714597245973459744597545976459774597845979459804598145982459834598445985459864598745988459894599045991459924599345994459954599645997459984599946000460014600246003460044600546006460074600846009460104601146012460134601446015460164601746018460194602046021460224602346024460254602646027460284602946030460314603246033460344603546036460374603846039460404604146042460434604446045460464604746048460494605046051460524605346054460554605646057460584605946060460614606246063460644606546066460674606846069460704607146072460734607446075460764607746078460794608046081460824608346084460854608646087460884608946090460914609246093460944609546096460974609846099461004610146102461034610446105461064610746108461094611046111461124611346114461154611646117461184611946120461214612246123461244612546126461274612846129461304613146132461334613446135461364613746138461394614046141461424614346144461454614646147461484614946150461514615246153461544615546156461574615846159461604616146162461634616446165461664616746168461694617046171461724617346174461754617646177461784617946180461814618246183461844618546186461874618846189461904619146192461934619446195461964619746198461994620046201462024620346204462054620646207462084620946210462114621246213462144621546216462174621846219462204622146222462234622446225462264622746228462294623046231462324623346234462354623646237462384623946240462414624246243462444624546246462474624846249462504625146252462534625446255462564625746258462594626046261462624626346264462654626646267462684626946270462714627246273462744627546276462774627846279462804628146282462834628446285462864628746288462894629046291462924629346294462954629646297462984629946300463014630246303463044630546306463074630846309463104631146312463134631446315463164631746318463194632046321463224632346324463254632646327463284632946330463314633246333463344633546336463374633846339463404634146342463434634446345463464634746348463494635046351463524635346354463554635646357463584635946360463614636246363463644636546366463674636846369463704637146372463734637446375463764637746378463794638046381463824638346384463854638646387463884638946390463914639246393463944639546396463974639846399464004640146402464034640446405464064640746408464094641046411464124641346414464154641646417464184641946420464214642246423464244642546426464274642846429464304643146432464334643446435464364643746438464394644046441464424644346444464454644646447464484644946450464514645246453464544645546456464574645846459464604646146462464634646446465464664646746468464694647046471464724647346474464754647646477464784647946480464814648246483464844648546486464874648846489464904649146492464934649446495464964649746498464994650046501465024650346504465054650646507465084650946510465114651246513465144651546516465174651846519465204652146522465234652446525465264652746528465294653046531465324653346534465354653646537465384653946540465414654246543465444654546546465474654846549465504655146552465534655446555465564655746558465594656046561465624656346564465654656646567465684656946570465714657246573465744657546576465774657846579465804658146582465834658446585465864658746588465894659046591465924659346594465954659646597465984659946600466014660246603466044660546606466074660846609466104661146612466134661446615466164661746618466194662046621466224662346624466254662646627466284662946630466314663246633466344663546636466374663846639466404664146642466434664446645466464664746648466494665046651466524665346654466554665646657466584665946660466614666246663466644666546666466674666846669466704667146672466734667446675466764667746678466794668046681466824668346684466854668646687466884668946690466914669246693466944669546696466974669846699467004670146702467034670446705467064670746708467094671046711467124671346714467154671646717467184671946720467214672246723467244672546726467274672846729467304673146732467334673446735467364673746738467394674046741467424674346744467454674646747467484674946750467514675246753467544675546756467574675846759467604676146762467634676446765467664676746768467694677046771467724677346774467754677646777467784677946780467814678246783467844678546786467874678846789467904679146792467934679446795467964679746798467994680046801468024680346804468054680646807468084680946810468114681246813468144681546816468174681846819468204682146822468234682446825468264682746828468294683046831468324683346834468354683646837468384683946840468414684246843468444684546846468474684846849468504685146852468534685446855468564685746858468594686046861468624686346864468654686646867468684686946870468714687246873468744687546876468774687846879468804688146882468834688446885468864688746888468894689046891468924689346894468954689646897468984689946900469014690246903469044690546906469074690846909469104691146912469134691446915469164691746918469194692046921469224692346924469254692646927469284692946930469314693246933469344693546936469374693846939469404694146942469434694446945469464694746948469494695046951469524695346954469554695646957469584695946960469614696246963469644696546966469674696846969469704697146972469734697446975469764697746978469794698046981469824698346984469854698646987469884698946990469914699246993469944699546996469974699846999470004700147002470034700447005470064700747008470094701047011470124701347014470154701647017470184701947020470214702247023470244702547026470274702847029470304703147032470334703447035470364703747038470394704047041470424704347044470454704647047470484704947050470514705247053470544705547056470574705847059470604706147062470634706447065470664706747068470694707047071470724707347074470754707647077470784707947080470814708247083470844708547086470874708847089470904709147092470934709447095470964709747098470994710047101471024710347104471054710647107471084710947110471114711247113471144711547116471174711847119471204712147122471234712447125471264712747128471294713047131471324713347134471354713647137471384713947140471414714247143471444714547146471474714847149471504715147152471534715447155471564715747158471594716047161471624716347164471654716647167471684716947170471714717247173471744717547176471774717847179471804718147182471834718447185471864718747188471894719047191471924719347194471954719647197471984719947200472014720247203472044720547206472074720847209472104721147212472134721447215472164721747218472194722047221472224722347224472254722647227472284722947230472314723247233472344723547236472374723847239472404724147242472434724447245472464724747248472494725047251472524725347254472554725647257472584725947260472614726247263472644726547266472674726847269472704727147272472734727447275472764727747278472794728047281472824728347284472854728647287472884728947290472914729247293472944729547296472974729847299473004730147302473034730447305473064730747308473094731047311473124731347314473154731647317473184731947320473214732247323473244732547326473274732847329473304733147332473334733447335473364733747338473394734047341473424734347344473454734647347473484734947350473514735247353473544735547356473574735847359473604736147362473634736447365473664736747368473694737047371473724737347374473754737647377473784737947380473814738247383473844738547386473874738847389473904739147392473934739447395473964739747398473994740047401474024740347404474054740647407474084740947410474114741247413474144741547416474174741847419474204742147422474234742447425474264742747428474294743047431474324743347434474354743647437474384743947440474414744247443474444744547446474474744847449474504745147452474534745447455474564745747458474594746047461474624746347464474654746647467474684746947470474714747247473474744747547476474774747847479474804748147482474834748447485474864748747488474894749047491474924749347494474954749647497474984749947500475014750247503475044750547506475074750847509475104751147512475134751447515475164751747518475194752047521475224752347524475254752647527475284752947530475314753247533475344753547536475374753847539475404754147542475434754447545475464754747548475494755047551475524755347554475554755647557475584755947560475614756247563475644756547566475674756847569475704757147572475734757447575475764757747578475794758047581475824758347584475854758647587475884758947590475914759247593475944759547596475974759847599476004760147602476034760447605476064760747608476094761047611476124761347614476154761647617476184761947620476214762247623476244762547626476274762847629476304763147632476334763447635476364763747638476394764047641476424764347644476454764647647476484764947650476514765247653476544765547656476574765847659476604766147662476634766447665476664766747668476694767047671476724767347674476754767647677476784767947680476814768247683476844768547686476874768847689476904769147692476934769447695476964769747698476994770047701477024770347704477054770647707477084770947710477114771247713477144771547716477174771847719477204772147722477234772447725477264772747728477294773047731477324773347734477354773647737477384773947740477414774247743477444774547746477474774847749477504775147752477534775447755477564775747758477594776047761477624776347764477654776647767477684776947770477714777247773477744777547776477774777847779477804778147782477834778447785477864778747788477894779047791477924779347794477954779647797477984779947800478014780247803478044780547806478074780847809478104781147812478134781447815478164781747818478194782047821478224782347824478254782647827478284782947830478314783247833478344783547836478374783847839478404784147842478434784447845478464784747848478494785047851478524785347854478554785647857478584785947860478614786247863478644786547866478674786847869478704787147872478734787447875478764787747878478794788047881478824788347884478854788647887478884788947890478914789247893478944789547896478974789847899479004790147902479034790447905479064790747908479094791047911479124791347914479154791647917479184791947920479214792247923479244792547926479274792847929479304793147932479334793447935479364793747938479394794047941479424794347944479454794647947479484794947950479514795247953479544795547956479574795847959479604796147962479634796447965479664796747968479694797047971479724797347974479754797647977479784797947980479814798247983479844798547986479874798847989479904799147992479934799447995479964799747998479994800048001480024800348004480054800648007480084800948010480114801248013480144801548016480174801848019480204802148022480234802448025480264802748028480294803048031480324803348034480354803648037480384803948040480414804248043480444804548046480474804848049480504805148052480534805448055480564805748058480594806048061480624806348064480654806648067480684806948070480714807248073480744807548076480774807848079480804808148082480834808448085480864808748088480894809048091480924809348094480954809648097480984809948100481014810248103481044810548106481074810848109481104811148112481134811448115481164811748118481194812048121481224812348124481254812648127481284812948130481314813248133481344813548136481374813848139481404814148142481434814448145481464814748148481494815048151481524815348154481554815648157481584815948160481614816248163481644816548166481674816848169481704817148172481734817448175481764817748178481794818048181481824818348184481854818648187481884818948190481914819248193481944819548196481974819848199482004820148202482034820448205482064820748208482094821048211482124821348214482154821648217482184821948220482214822248223482244822548226482274822848229482304823148232482334823448235482364823748238482394824048241482424824348244482454824648247482484824948250482514825248253482544825548256482574825848259482604826148262482634826448265482664826748268482694827048271482724827348274482754827648277482784827948280482814828248283482844828548286482874828848289482904829148292482934829448295482964829748298482994830048301483024830348304483054830648307483084830948310483114831248313483144831548316483174831848319483204832148322483234832448325483264832748328483294833048331483324833348334483354833648337483384833948340483414834248343483444834548346483474834848349483504835148352483534835448355483564835748358483594836048361483624836348364483654836648367483684836948370483714837248373483744837548376483774837848379483804838148382483834838448385483864838748388483894839048391483924839348394483954839648397483984839948400484014840248403484044840548406484074840848409484104841148412484134841448415484164841748418484194842048421484224842348424484254842648427484284842948430484314843248433484344843548436484374843848439484404844148442484434844448445484464844748448484494845048451484524845348454484554845648457484584845948460484614846248463484644846548466484674846848469484704847148472484734847448475484764847748478484794848048481484824848348484484854848648487484884848948490484914849248493484944849548496484974849848499485004850148502485034850448505485064850748508485094851048511485124851348514485154851648517485184851948520485214852248523485244852548526485274852848529485304853148532485334853448535485364853748538485394854048541485424854348544485454854648547485484854948550485514855248553485544855548556485574855848559485604856148562485634856448565485664856748568485694857048571485724857348574485754857648577485784857948580485814858248583485844858548586485874858848589485904859148592485934859448595485964859748598485994860048601486024860348604486054860648607486084860948610486114861248613486144861548616486174861848619486204862148622486234862448625486264862748628486294863048631486324863348634486354863648637486384863948640486414864248643486444864548646486474864848649486504865148652486534865448655486564865748658486594866048661486624866348664486654866648667486684866948670486714867248673486744867548676486774867848679486804868148682486834868448685486864868748688486894869048691486924869348694486954869648697486984869948700487014870248703487044870548706487074870848709487104871148712487134871448715487164871748718487194872048721487224872348724487254872648727487284872948730487314873248733487344873548736487374873848739487404874148742487434874448745487464874748748487494875048751487524875348754487554875648757487584875948760487614876248763487644876548766487674876848769487704877148772487734877448775487764877748778487794878048781487824878348784487854878648787487884878948790487914879248793487944879548796487974879848799488004880148802488034880448805488064880748808488094881048811488124881348814488154881648817488184881948820488214882248823488244882548826488274882848829488304883148832488334883448835488364883748838488394884048841488424884348844488454884648847488484884948850488514885248853488544885548856488574885848859488604886148862488634886448865488664886748868488694887048871488724887348874488754887648877488784887948880488814888248883488844888548886488874888848889488904889148892488934889448895488964889748898488994890048901489024890348904489054890648907489084890948910489114891248913489144891548916489174891848919489204892148922489234892448925489264892748928489294893048931489324893348934489354893648937489384893948940489414894248943489444894548946489474894848949489504895148952489534895448955489564895748958489594896048961489624896348964489654896648967489684896948970489714897248973489744897548976489774897848979489804898148982489834898448985489864898748988489894899048991489924899348994489954899648997489984899949000490014900249003490044900549006490074900849009490104901149012490134901449015490164901749018490194902049021490224902349024490254902649027490284902949030490314903249033490344903549036490374903849039490404904149042490434904449045490464904749048490494905049051490524905349054490554905649057490584905949060490614906249063490644906549066490674906849069490704907149072490734907449075490764907749078490794908049081490824908349084490854908649087490884908949090490914909249093490944909549096490974909849099491004910149102491034910449105491064910749108491094911049111491124911349114491154911649117491184911949120491214912249123491244912549126491274912849129491304913149132491334913449135491364913749138491394914049141491424914349144491454914649147491484914949150491514915249153491544915549156491574915849159491604916149162491634916449165491664916749168491694917049171491724917349174491754917649177491784917949180491814918249183491844918549186491874918849189491904919149192491934919449195491964919749198491994920049201492024920349204492054920649207492084920949210492114921249213492144921549216492174921849219492204922149222492234922449225492264922749228492294923049231492324923349234492354923649237492384923949240492414924249243492444924549246492474924849249492504925149252492534925449255492564925749258492594926049261492624926349264492654926649267492684926949270492714927249273492744927549276492774927849279492804928149282492834928449285492864928749288492894929049291492924929349294492954929649297492984929949300493014930249303493044930549306493074930849309493104931149312493134931449315493164931749318493194932049321493224932349324493254932649327493284932949330493314933249333493344933549336493374933849339493404934149342493434934449345493464934749348493494935049351493524935349354493554935649357493584935949360493614936249363493644936549366493674936849369493704937149372493734937449375493764937749378493794938049381493824938349384493854938649387493884938949390493914939249393493944939549396493974939849399494004940149402494034940449405494064940749408494094941049411494124941349414494154941649417494184941949420494214942249423494244942549426494274942849429494304943149432494334943449435494364943749438494394944049441494424944349444494454944649447494484944949450494514945249453494544945549456494574945849459494604946149462494634946449465494664946749468494694947049471494724947349474494754947649477494784947949480494814948249483494844948549486494874948849489494904949149492494934949449495494964949749498494994950049501495024950349504495054950649507495084950949510495114951249513495144951549516495174951849519495204952149522495234952449525495264952749528495294953049531495324953349534495354953649537495384953949540495414954249543495444954549546495474954849549495504955149552495534955449555495564955749558495594956049561495624956349564495654956649567495684956949570495714957249573495744957549576495774957849579495804958149582495834958449585495864958749588495894959049591495924959349594495954959649597495984959949600496014960249603496044960549606496074960849609496104961149612496134961449615496164961749618496194962049621496224962349624496254962649627496284962949630496314963249633496344963549636496374963849639496404964149642496434964449645496464964749648496494965049651496524965349654496554965649657496584965949660496614966249663496644966549666496674966849669496704967149672496734967449675496764967749678496794968049681496824968349684496854968649687496884968949690496914969249693496944969549696496974969849699497004970149702497034970449705497064970749708497094971049711497124971349714497154971649717497184971949720497214972249723497244972549726497274972849729497304973149732497334973449735497364973749738497394974049741497424974349744497454974649747497484974949750497514975249753497544975549756497574975849759497604976149762497634976449765497664976749768497694977049771497724977349774497754977649777497784977949780497814978249783497844978549786497874978849789497904979149792497934979449795497964979749798497994980049801498024980349804498054980649807498084980949810498114981249813498144981549816498174981849819498204982149822498234982449825498264982749828498294983049831498324983349834498354983649837498384983949840498414984249843498444984549846498474984849849498504985149852498534985449855498564985749858498594986049861498624986349864498654986649867498684986949870498714987249873498744987549876498774987849879498804988149882498834988449885498864988749888498894989049891498924989349894498954989649897498984989949900499014990249903499044990549906499074990849909499104991149912499134991449915499164991749918499194992049921499224992349924499254992649927499284992949930499314993249933499344993549936499374993849939499404994149942499434994449945499464994749948499494995049951499524995349954499554995649957499584995949960499614996249963499644996549966499674996849969499704997149972499734997449975499764997749978499794998049981499824998349984499854998649987499884998949990499914999249993499944999549996499974999849999500005000150002500035000450005500065000750008500095001050011500125001350014500155001650017500185001950020500215002250023500245002550026500275002850029500305003150032500335003450035500365003750038500395004050041500425004350044500455004650047500485004950050500515005250053500545005550056500575005850059500605006150062500635006450065500665006750068500695007050071500725007350074500755007650077500785007950080500815008250083500845008550086500875008850089500905009150092500935009450095500965009750098500995010050101501025010350104501055010650107501085010950110501115011250113501145011550116501175011850119501205012150122501235012450125501265012750128501295013050131501325013350134501355013650137501385013950140501415014250143501445014550146501475014850149501505015150152501535015450155501565015750158501595016050161501625016350164501655016650167501685016950170501715017250173501745017550176501775017850179501805018150182501835018450185501865018750188501895019050191501925019350194501955019650197501985019950200502015020250203502045020550206502075020850209502105021150212502135021450215502165021750218502195022050221502225022350224502255022650227502285022950230502315023250233502345023550236502375023850239502405024150242502435024450245502465024750248502495025050251502525025350254502555025650257502585025950260502615026250263502645026550266502675026850269502705027150272502735027450275502765027750278502795028050281502825028350284502855028650287502885028950290502915029250293502945029550296502975029850299503005030150302503035030450305503065030750308503095031050311503125031350314503155031650317503185031950320503215032250323503245032550326503275032850329503305033150332503335033450335503365033750338503395034050341503425034350344503455034650347503485034950350503515035250353503545035550356503575035850359503605036150362503635036450365503665036750368503695037050371503725037350374503755037650377503785037950380503815038250383503845038550386503875038850389503905039150392503935039450395503965039750398503995040050401504025040350404504055040650407504085040950410504115041250413504145041550416504175041850419504205042150422504235042450425504265042750428504295043050431504325043350434504355043650437504385043950440504415044250443504445044550446504475044850449504505045150452504535045450455504565045750458504595046050461504625046350464504655046650467504685046950470504715047250473504745047550476504775047850479504805048150482504835048450485504865048750488504895049050491504925049350494504955049650497504985049950500505015050250503505045050550506505075050850509505105051150512505135051450515505165051750518505195052050521505225052350524505255052650527505285052950530505315053250533505345053550536505375053850539505405054150542505435054450545505465054750548505495055050551505525055350554505555055650557505585055950560505615056250563505645056550566505675056850569505705057150572505735057450575505765057750578505795058050581505825058350584505855058650587505885058950590505915059250593505945059550596505975059850599506005060150602506035060450605506065060750608506095061050611506125061350614506155061650617506185061950620506215062250623506245062550626506275062850629506305063150632506335063450635506365063750638506395064050641506425064350644506455064650647506485064950650506515065250653506545065550656506575065850659506605066150662506635066450665506665066750668506695067050671506725067350674506755067650677506785067950680506815068250683506845068550686506875068850689506905069150692506935069450695506965069750698506995070050701507025070350704507055070650707507085070950710507115071250713507145071550716507175071850719507205072150722507235072450725507265072750728507295073050731507325073350734507355073650737507385073950740507415074250743507445074550746507475074850749507505075150752507535075450755507565075750758507595076050761507625076350764507655076650767507685076950770507715077250773507745077550776507775077850779507805078150782507835078450785507865078750788507895079050791507925079350794507955079650797507985079950800508015080250803508045080550806508075080850809508105081150812508135081450815508165081750818508195082050821508225082350824508255082650827508285082950830508315083250833508345083550836508375083850839508405084150842508435084450845508465084750848508495085050851508525085350854508555085650857508585085950860508615086250863508645086550866508675086850869508705087150872508735087450875508765087750878508795088050881508825088350884508855088650887508885088950890508915089250893508945089550896508975089850899509005090150902509035090450905509065090750908509095091050911509125091350914509155091650917509185091950920509215092250923509245092550926509275092850929509305093150932509335093450935509365093750938509395094050941509425094350944509455094650947509485094950950509515095250953509545095550956509575095850959509605096150962509635096450965509665096750968509695097050971509725097350974509755097650977509785097950980509815098250983509845098550986509875098850989509905099150992509935099450995509965099750998509995100051001510025100351004510055100651007510085100951010510115101251013510145101551016510175101851019510205102151022510235102451025510265102751028510295103051031510325103351034510355103651037510385103951040510415104251043510445104551046510475104851049510505105151052510535105451055510565105751058510595106051061510625106351064510655106651067510685106951070510715107251073510745107551076510775107851079510805108151082510835108451085510865108751088510895109051091510925109351094510955109651097510985109951100511015110251103511045110551106511075110851109511105111151112511135111451115511165111751118511195112051121511225112351124511255112651127511285112951130511315113251133511345113551136511375113851139511405114151142511435114451145511465114751148511495115051151511525115351154511555115651157511585115951160511615116251163511645116551166511675116851169511705117151172511735117451175511765117751178511795118051181511825118351184511855118651187511885118951190511915119251193511945119551196511975119851199512005120151202512035120451205512065120751208512095121051211512125121351214512155121651217512185121951220512215122251223512245122551226512275122851229512305123151232512335123451235512365123751238512395124051241512425124351244512455124651247512485124951250512515125251253512545125551256512575125851259512605126151262512635126451265512665126751268512695127051271512725127351274512755127651277512785127951280512815128251283512845128551286512875128851289512905129151292512935129451295512965129751298512995130051301513025130351304513055130651307513085130951310513115131251313513145131551316513175131851319513205132151322513235132451325513265132751328513295133051331513325133351334513355133651337513385133951340513415134251343513445134551346513475134851349513505135151352513535135451355513565135751358513595136051361513625136351364513655136651367513685136951370513715137251373513745137551376513775137851379513805138151382513835138451385513865138751388513895139051391513925139351394513955139651397513985139951400514015140251403514045140551406514075140851409514105141151412514135141451415514165141751418514195142051421514225142351424514255142651427514285142951430514315143251433514345143551436514375143851439514405144151442514435144451445514465144751448514495145051451514525145351454514555145651457514585145951460514615146251463514645146551466514675146851469514705147151472514735147451475514765147751478514795148051481514825148351484514855148651487514885148951490514915149251493514945149551496514975149851499515005150151502515035150451505515065150751508515095151051511515125151351514515155151651517515185151951520515215152251523515245152551526515275152851529515305153151532515335153451535515365153751538515395154051541515425154351544515455154651547515485154951550515515155251553515545155551556515575155851559515605156151562515635156451565515665156751568515695157051571515725157351574515755157651577515785157951580515815158251583515845158551586515875158851589515905159151592515935159451595515965159751598515995160051601516025160351604516055160651607516085160951610516115161251613516145161551616516175161851619516205162151622516235162451625516265162751628516295163051631516325163351634516355163651637516385163951640516415164251643516445164551646516475164851649516505165151652516535165451655516565165751658516595166051661516625166351664516655166651667516685166951670516715167251673516745167551676516775167851679516805168151682516835168451685516865168751688516895169051691516925169351694516955169651697516985169951700517015170251703517045170551706517075170851709517105171151712517135171451715517165171751718517195172051721517225172351724517255172651727517285172951730517315173251733517345173551736517375173851739517405174151742517435174451745517465174751748517495175051751517525175351754517555175651757517585175951760517615176251763517645176551766517675176851769517705177151772517735177451775517765177751778517795178051781517825178351784517855178651787517885178951790517915179251793517945179551796517975179851799518005180151802518035180451805518065180751808518095181051811518125181351814518155181651817518185181951820518215182251823518245182551826518275182851829518305183151832518335183451835518365183751838518395184051841518425184351844518455184651847518485184951850518515185251853518545185551856518575185851859518605186151862518635186451865518665186751868518695187051871518725187351874518755187651877518785187951880518815188251883518845188551886518875188851889518905189151892518935189451895518965189751898518995190051901519025190351904519055190651907519085190951910519115191251913519145191551916519175191851919519205192151922519235192451925519265192751928519295193051931519325193351934519355193651937519385193951940519415194251943519445194551946519475194851949519505195151952519535195451955519565195751958519595196051961519625196351964519655196651967519685196951970519715197251973519745197551976519775197851979519805198151982519835198451985519865198751988519895199051991519925199351994519955199651997519985199952000520015200252003520045200552006520075200852009520105201152012520135201452015520165201752018520195202052021520225202352024520255202652027520285202952030520315203252033520345203552036520375203852039520405204152042520435204452045520465204752048520495205052051520525205352054520555205652057520585205952060520615206252063520645206552066520675206852069520705207152072520735207452075520765207752078520795208052081520825208352084520855208652087520885208952090520915209252093520945209552096520975209852099521005210152102521035210452105521065210752108521095211052111521125211352114521155211652117521185211952120521215212252123521245212552126521275212852129521305213152132521335213452135521365213752138521395214052141521425214352144521455214652147521485214952150521515215252153521545215552156521575215852159521605216152162521635216452165521665216752168521695217052171521725217352174521755217652177521785217952180521815218252183521845218552186521875218852189521905219152192521935219452195521965219752198521995220052201522025220352204522055220652207522085220952210522115221252213522145221552216522175221852219522205222152222522235222452225522265222752228522295223052231522325223352234522355223652237522385223952240522415224252243522445224552246522475224852249522505225152252522535225452255522565225752258522595226052261522625226352264522655226652267522685226952270522715227252273522745227552276522775227852279522805228152282522835228452285522865228752288522895229052291522925229352294522955229652297522985229952300523015230252303523045230552306523075230852309523105231152312523135231452315523165231752318523195232052321523225232352324523255232652327523285232952330523315233252333523345233552336523375233852339523405234152342523435234452345523465234752348523495235052351523525235352354523555235652357523585235952360523615236252363523645236552366523675236852369523705237152372523735237452375523765237752378523795238052381523825238352384523855238652387523885238952390523915239252393523945239552396523975239852399524005240152402524035240452405524065240752408524095241052411524125241352414524155241652417524185241952420524215242252423524245242552426524275242852429524305243152432524335243452435524365243752438524395244052441524425244352444524455244652447524485244952450524515245252453524545245552456524575245852459524605246152462524635246452465524665246752468524695247052471524725247352474524755247652477524785247952480524815248252483524845248552486524875248852489524905249152492524935249452495524965249752498524995250052501525025250352504525055250652507525085250952510525115251252513525145251552516525175251852519525205252152522525235252452525525265252752528525295253052531525325253352534525355253652537525385253952540525415254252543525445254552546525475254852549525505255152552525535255452555525565255752558525595256052561525625256352564525655256652567525685256952570525715257252573525745257552576525775257852579525805258152582525835258452585525865258752588525895259052591525925259352594525955259652597525985259952600526015260252603526045260552606526075260852609526105261152612526135261452615526165261752618526195262052621526225262352624526255262652627526285262952630526315263252633526345263552636526375263852639526405264152642526435264452645526465264752648526495265052651526525265352654526555265652657526585265952660526615266252663526645266552666526675266852669526705267152672526735267452675526765267752678526795268052681526825268352684526855268652687526885268952690526915269252693526945269552696526975269852699527005270152702527035270452705527065270752708527095271052711527125271352714527155271652717527185271952720527215272252723527245272552726527275272852729527305273152732527335273452735527365273752738527395274052741527425274352744527455274652747527485274952750527515275252753527545275552756527575275852759527605276152762527635276452765527665276752768527695277052771527725277352774527755277652777527785277952780527815278252783527845278552786527875278852789527905279152792527935279452795527965279752798527995280052801528025280352804528055280652807528085280952810528115281252813528145281552816528175281852819528205282152822528235282452825528265282752828528295283052831528325283352834528355283652837528385283952840528415284252843528445284552846528475284852849528505285152852528535285452855528565285752858528595286052861528625286352864528655286652867528685286952870528715287252873528745287552876528775287852879528805288152882528835288452885528865288752888528895289052891528925289352894528955289652897528985289952900529015290252903529045290552906529075290852909529105291152912529135291452915529165291752918529195292052921529225292352924529255292652927529285292952930529315293252933529345293552936529375293852939529405294152942529435294452945529465294752948529495295052951529525295352954529555295652957529585295952960529615296252963529645296552966529675296852969529705297152972529735297452975529765297752978529795298052981529825298352984529855298652987529885298952990529915299252993529945299552996529975299852999530005300153002530035300453005530065300753008530095301053011530125301353014530155301653017530185301953020530215302253023530245302553026530275302853029530305303153032530335303453035530365303753038530395304053041530425304353044530455304653047530485304953050530515305253053530545305553056530575305853059530605306153062530635306453065530665306753068530695307053071530725307353074530755307653077530785307953080530815308253083530845308553086530875308853089530905309153092530935309453095530965309753098530995310053101531025310353104531055310653107531085310953110531115311253113531145311553116531175311853119531205312153122531235312453125531265312753128531295313053131531325313353134531355313653137531385313953140531415314253143531445314553146531475314853149531505315153152531535315453155531565315753158531595316053161531625316353164531655316653167531685316953170531715317253173531745317553176531775317853179531805318153182531835318453185531865318753188531895319053191531925319353194531955319653197531985319953200532015320253203532045320553206532075320853209532105321153212532135321453215532165321753218532195322053221532225322353224532255322653227532285322953230532315323253233532345323553236532375323853239532405324153242532435324453245532465324753248532495325053251532525325353254532555325653257532585325953260532615326253263532645326553266532675326853269532705327153272532735327453275532765327753278532795328053281532825328353284532855328653287532885328953290532915329253293532945329553296532975329853299533005330153302533035330453305533065330753308533095331053311533125331353314533155331653317533185331953320533215332253323533245332553326533275332853329533305333153332533335333453335533365333753338533395334053341533425334353344533455334653347533485334953350533515335253353533545335553356533575335853359533605336153362533635336453365533665336753368533695337053371533725337353374533755337653377533785337953380533815338253383533845338553386533875338853389533905339153392533935339453395533965339753398533995340053401534025340353404534055340653407534085340953410534115341253413534145341553416534175341853419534205342153422534235342453425534265342753428534295343053431534325343353434534355343653437534385343953440534415344253443534445344553446534475344853449534505345153452534535345453455534565345753458534595346053461534625346353464534655346653467534685346953470534715347253473534745347553476534775347853479534805348153482534835348453485534865348753488534895349053491534925349353494534955349653497534985349953500535015350253503535045350553506535075350853509535105351153512535135351453515535165351753518535195352053521535225352353524535255352653527535285352953530535315353253533535345353553536535375353853539535405354153542535435354453545535465354753548535495355053551535525355353554535555355653557535585355953560535615356253563535645356553566535675356853569535705357153572535735357453575535765357753578535795358053581535825358353584535855358653587535885358953590535915359253593535945359553596535975359853599536005360153602536035360453605536065360753608536095361053611536125361353614536155361653617536185361953620536215362253623536245362553626536275362853629536305363153632536335363453635536365363753638536395364053641536425364353644536455364653647536485364953650536515365253653536545365553656536575365853659536605366153662536635366453665536665366753668536695367053671536725367353674536755367653677536785367953680536815368253683536845368553686536875368853689536905369153692536935369453695536965369753698536995370053701537025370353704537055370653707537085370953710537115371253713537145371553716537175371853719537205372153722537235372453725537265372753728537295373053731537325373353734537355373653737537385373953740537415374253743537445374553746537475374853749537505375153752537535375453755537565375753758537595376053761537625376353764537655376653767537685376953770537715377253773537745377553776537775377853779537805378153782537835378453785537865378753788537895379053791537925379353794537955379653797537985379953800538015380253803538045380553806538075380853809538105381153812538135381453815538165381753818538195382053821538225382353824538255382653827538285382953830538315383253833538345383553836538375383853839538405384153842538435384453845538465384753848538495385053851538525385353854538555385653857538585385953860538615386253863538645386553866538675386853869538705387153872538735387453875538765387753878538795388053881538825388353884538855388653887538885388953890538915389253893538945389553896538975389853899539005390153902539035390453905539065390753908539095391053911539125391353914539155391653917539185391953920539215392253923539245392553926539275392853929539305393153932539335393453935539365393753938539395394053941539425394353944539455394653947539485394953950539515395253953539545395553956539575395853959539605396153962539635396453965539665396753968539695397053971539725397353974539755397653977539785397953980539815398253983539845398553986539875398853989539905399153992539935399453995539965399753998539995400054001540025400354004540055400654007540085400954010540115401254013540145401554016540175401854019540205402154022540235402454025540265402754028540295403054031540325403354034540355403654037540385403954040540415404254043540445404554046540475404854049540505405154052540535405454055540565405754058540595406054061540625406354064540655406654067540685406954070540715407254073540745407554076540775407854079540805408154082540835408454085540865408754088540895409054091540925409354094540955409654097540985409954100541015410254103541045410554106541075410854109541105411154112541135411454115541165411754118541195412054121541225412354124541255412654127541285412954130541315413254133541345413554136541375413854139541405414154142541435414454145541465414754148541495415054151541525415354154541555415654157541585415954160541615416254163541645416554166541675416854169541705417154172541735417454175541765417754178541795418054181541825418354184541855418654187541885418954190541915419254193541945419554196541975419854199542005420154202542035420454205542065420754208542095421054211542125421354214542155421654217542185421954220542215422254223542245422554226542275422854229542305423154232542335423454235542365423754238542395424054241542425424354244542455424654247542485424954250542515425254253542545425554256542575425854259542605426154262542635426454265542665426754268542695427054271542725427354274542755427654277542785427954280542815428254283542845428554286542875428854289542905429154292542935429454295542965429754298542995430054301543025430354304543055430654307543085430954310543115431254313543145431554316543175431854319543205432154322543235432454325543265432754328543295433054331543325433354334543355433654337543385433954340543415434254343543445434554346543475434854349543505435154352543535435454355543565435754358543595436054361543625436354364543655436654367543685436954370543715437254373543745437554376543775437854379543805438154382543835438454385543865438754388543895439054391543925439354394543955439654397543985439954400544015440254403544045440554406544075440854409544105441154412544135441454415544165441754418544195442054421544225442354424544255442654427544285442954430544315443254433544345443554436544375443854439544405444154442544435444454445544465444754448544495445054451544525445354454544555445654457544585445954460544615446254463544645446554466544675446854469544705447154472544735447454475544765447754478544795448054481544825448354484544855448654487544885448954490544915449254493544945449554496544975449854499545005450154502545035450454505545065450754508545095451054511545125451354514545155451654517545185451954520545215452254523545245452554526545275452854529545305453154532545335453454535545365453754538545395454054541545425454354544545455454654547545485454954550545515455254553545545455554556545575455854559545605456154562545635456454565545665456754568545695457054571545725457354574545755457654577545785457954580545815458254583545845458554586545875458854589545905459154592545935459454595545965459754598545995460054601546025460354604546055460654607546085460954610546115461254613546145461554616546175461854619546205462154622546235462454625546265462754628546295463054631546325463354634546355463654637546385463954640546415464254643546445464554646546475464854649546505465154652546535465454655546565465754658546595466054661546625466354664546655466654667546685466954670546715467254673546745467554676546775467854679546805468154682546835468454685546865468754688546895469054691546925469354694546955469654697546985469954700547015470254703547045470554706547075470854709547105471154712547135471454715547165471754718547195472054721547225472354724547255472654727547285472954730547315473254733547345473554736547375473854739547405474154742547435474454745547465474754748547495475054751547525475354754547555475654757547585475954760547615476254763547645476554766547675476854769547705477154772547735477454775547765477754778547795478054781547825478354784547855478654787547885478954790547915479254793547945479554796547975479854799548005480154802548035480454805548065480754808548095481054811548125481354814548155481654817548185481954820548215482254823548245482554826548275482854829548305483154832548335483454835548365483754838548395484054841548425484354844548455484654847548485484954850548515485254853548545485554856548575485854859548605486154862548635486454865548665486754868548695487054871548725487354874548755487654877548785487954880548815488254883548845488554886548875488854889548905489154892548935489454895548965489754898548995490054901549025490354904549055490654907549085490954910549115491254913549145491554916549175491854919549205492154922549235492454925549265492754928549295493054931549325493354934549355493654937549385493954940549415494254943549445494554946549475494854949549505495154952549535495454955549565495754958549595496054961549625496354964549655496654967549685496954970549715497254973549745497554976549775497854979549805498154982549835498454985549865498754988549895499054991549925499354994549955499654997549985499955000550015500255003550045500555006550075500855009550105501155012550135501455015550165501755018550195502055021550225502355024550255502655027550285502955030550315503255033550345503555036550375503855039550405504155042550435504455045550465504755048550495505055051550525505355054550555505655057550585505955060550615506255063550645506555066550675506855069550705507155072550735507455075550765507755078550795508055081550825508355084550855508655087550885508955090550915509255093550945509555096550975509855099551005510155102551035510455105551065510755108551095511055111551125511355114551155511655117551185511955120551215512255123551245512555126551275512855129551305513155132551335513455135551365513755138551395514055141551425514355144551455514655147551485514955150551515515255153551545515555156551575515855159551605516155162551635516455165551665516755168551695517055171551725517355174551755517655177551785517955180551815518255183551845518555186551875518855189551905519155192551935519455195551965519755198551995520055201552025520355204552055520655207552085520955210552115521255213552145521555216552175521855219552205522155222552235522455225552265522755228552295523055231552325523355234552355523655237552385523955240552415524255243552445524555246552475524855249552505525155252552535525455255552565525755258552595526055261552625526355264552655526655267552685526955270552715527255273552745527555276552775527855279552805528155282552835528455285552865528755288552895529055291552925529355294552955529655297552985529955300553015530255303553045530555306553075530855309553105531155312553135531455315553165531755318553195532055321553225532355324553255532655327553285532955330553315533255333553345533555336553375533855339553405534155342553435534455345553465534755348553495535055351553525535355354553555535655357553585535955360553615536255363553645536555366553675536855369553705537155372553735537455375553765537755378553795538055381553825538355384553855538655387553885538955390553915539255393553945539555396553975539855399554005540155402554035540455405554065540755408554095541055411554125541355414554155541655417554185541955420554215542255423554245542555426554275542855429554305543155432554335543455435554365543755438554395544055441554425544355444554455544655447554485544955450554515545255453554545545555456554575545855459554605546155462554635546455465554665546755468554695547055471554725547355474554755547655477554785547955480554815548255483554845548555486554875548855489554905549155492554935549455495554965549755498554995550055501555025550355504555055550655507555085550955510555115551255513555145551555516555175551855519555205552155522555235552455525555265552755528555295553055531555325553355534555355553655537555385553955540555415554255543555445554555546555475554855549555505555155552555535555455555555565555755558555595556055561555625556355564555655556655567555685556955570555715557255573555745557555576555775557855579555805558155582555835558455585555865558755588555895559055591555925559355594555955559655597555985559955600556015560255603556045560555606556075560855609556105561155612556135561455615556165561755618556195562055621556225562355624556255562655627556285562955630556315563255633556345563555636556375563855639556405564155642556435564455645556465564755648556495565055651556525565355654556555565655657556585565955660556615566255663556645566555666556675566855669556705567155672556735567455675556765567755678556795568055681556825568355684556855568655687556885568955690556915569255693556945569555696556975569855699557005570155702557035570455705557065570755708557095571055711557125571355714557155571655717557185571955720557215572255723557245572555726557275572855729557305573155732557335573455735557365573755738557395574055741557425574355744557455574655747557485574955750557515575255753557545575555756557575575855759557605576155762557635576455765557665576755768557695577055771557725577355774557755577655777557785577955780557815578255783557845578555786557875578855789557905579155792557935579455795557965579755798557995580055801558025580355804558055580655807558085580955810558115581255813558145581555816558175581855819558205582155822558235582455825558265582755828558295583055831558325583355834558355583655837558385583955840558415584255843558445584555846558475584855849558505585155852558535585455855558565585755858558595586055861558625586355864558655586655867558685586955870558715587255873558745587555876558775587855879558805588155882558835588455885558865588755888558895589055891558925589355894558955589655897558985589955900559015590255903559045590555906559075590855909559105591155912559135591455915559165591755918559195592055921559225592355924559255592655927559285592955930559315593255933559345593555936559375593855939559405594155942559435594455945559465594755948559495595055951559525595355954559555595655957559585595955960559615596255963559645596555966559675596855969559705597155972559735597455975559765597755978559795598055981559825598355984559855598655987559885598955990559915599255993559945599555996559975599855999560005600156002560035600456005560065600756008560095601056011560125601356014560155601656017560185601956020560215602256023560245602556026560275602856029560305603156032560335603456035560365603756038560395604056041560425604356044560455604656047560485604956050560515605256053560545605556056560575605856059560605606156062560635606456065560665606756068560695607056071560725607356074560755607656077560785607956080560815608256083560845608556086560875608856089560905609156092560935609456095560965609756098560995610056101561025610356104561055610656107561085610956110561115611256113561145611556116561175611856119561205612156122561235612456125561265612756128561295613056131561325613356134561355613656137561385613956140561415614256143561445614556146561475614856149561505615156152561535615456155561565615756158561595616056161561625616356164561655616656167561685616956170561715617256173561745617556176561775617856179561805618156182561835618456185561865618756188561895619056191561925619356194561955619656197561985619956200562015620256203562045620556206562075620856209562105621156212562135621456215562165621756218562195622056221562225622356224562255622656227562285622956230562315623256233562345623556236562375623856239562405624156242562435624456245562465624756248562495625056251562525625356254562555625656257562585625956260562615626256263562645626556266562675626856269562705627156272562735627456275562765627756278562795628056281562825628356284562855628656287562885628956290562915629256293562945629556296562975629856299563005630156302563035630456305563065630756308563095631056311563125631356314563155631656317563185631956320563215632256323563245632556326563275632856329563305633156332563335633456335563365633756338563395634056341563425634356344563455634656347563485634956350563515635256353563545635556356563575635856359563605636156362563635636456365563665636756368563695637056371563725637356374563755637656377563785637956380563815638256383563845638556386563875638856389563905639156392563935639456395563965639756398563995640056401564025640356404564055640656407564085640956410564115641256413564145641556416564175641856419564205642156422564235642456425564265642756428564295643056431564325643356434564355643656437564385643956440564415644256443564445644556446564475644856449564505645156452564535645456455564565645756458564595646056461564625646356464564655646656467564685646956470564715647256473564745647556476564775647856479564805648156482564835648456485564865648756488564895649056491564925649356494564955649656497564985649956500565015650256503565045650556506565075650856509565105651156512565135651456515565165651756518565195652056521565225652356524565255652656527565285652956530565315653256533565345653556536565375653856539565405654156542565435654456545565465654756548565495655056551565525655356554565555655656557565585655956560565615656256563565645656556566565675656856569565705657156572565735657456575565765657756578565795658056581565825658356584565855658656587565885658956590565915659256593565945659556596565975659856599566005660156602566035660456605566065660756608566095661056611566125661356614566155661656617566185661956620566215662256623566245662556626566275662856629566305663156632566335663456635566365663756638566395664056641566425664356644566455664656647566485664956650566515665256653566545665556656566575665856659566605666156662566635666456665566665666756668566695667056671566725667356674566755667656677566785667956680566815668256683566845668556686566875668856689566905669156692566935669456695566965669756698566995670056701567025670356704567055670656707567085670956710567115671256713567145671556716567175671856719567205672156722567235672456725567265672756728567295673056731567325673356734567355673656737567385673956740567415674256743567445674556746567475674856749567505675156752567535675456755567565675756758567595676056761567625676356764567655676656767567685676956770567715677256773567745677556776567775677856779567805678156782567835678456785567865678756788567895679056791567925679356794567955679656797567985679956800568015680256803568045680556806568075680856809568105681156812568135681456815568165681756818568195682056821568225682356824568255682656827568285682956830568315683256833568345683556836568375683856839568405684156842568435684456845568465684756848568495685056851568525685356854568555685656857568585685956860568615686256863568645686556866568675686856869568705687156872568735687456875568765687756878568795688056881568825688356884568855688656887568885688956890568915689256893568945689556896568975689856899569005690156902569035690456905569065690756908569095691056911569125691356914569155691656917569185691956920569215692256923569245692556926569275692856929569305693156932569335693456935569365693756938569395694056941569425694356944569455694656947569485694956950569515695256953569545695556956569575695856959569605696156962569635696456965569665696756968569695697056971569725697356974569755697656977569785697956980569815698256983569845698556986569875698856989569905699156992569935699456995569965699756998569995700057001570025700357004570055700657007570085700957010570115701257013570145701557016570175701857019570205702157022570235702457025570265702757028570295703057031570325703357034570355703657037570385703957040570415704257043570445704557046570475704857049570505705157052570535705457055570565705757058570595706057061570625706357064570655706657067570685706957070570715707257073570745707557076570775707857079570805708157082570835708457085570865708757088570895709057091570925709357094570955709657097570985709957100571015710257103571045710557106571075710857109571105711157112571135711457115571165711757118571195712057121571225712357124571255712657127571285712957130571315713257133571345713557136571375713857139571405714157142571435714457145571465714757148571495715057151571525715357154571555715657157571585715957160571615716257163571645716557166571675716857169571705717157172571735717457175571765717757178571795718057181571825718357184571855718657187571885718957190571915719257193571945719557196571975719857199572005720157202572035720457205572065720757208572095721057211572125721357214572155721657217572185721957220572215722257223572245722557226572275722857229572305723157232572335723457235572365723757238572395724057241572425724357244572455724657247572485724957250572515725257253572545725557256572575725857259572605726157262572635726457265572665726757268572695727057271572725727357274572755727657277572785727957280572815728257283572845728557286572875728857289572905729157292572935729457295572965729757298572995730057301573025730357304573055730657307573085730957310573115731257313573145731557316573175731857319573205732157322573235732457325573265732757328573295733057331573325733357334573355733657337573385733957340573415734257343573445734557346573475734857349573505735157352573535735457355573565735757358573595736057361573625736357364573655736657367573685736957370573715737257373573745737557376573775737857379573805738157382573835738457385573865738757388573895739057391573925739357394573955739657397573985739957400574015740257403574045740557406574075740857409574105741157412574135741457415574165741757418574195742057421574225742357424574255742657427574285742957430574315743257433574345743557436574375743857439574405744157442574435744457445574465744757448574495745057451574525745357454574555745657457574585745957460574615746257463574645746557466574675746857469574705747157472574735747457475574765747757478574795748057481574825748357484574855748657487574885748957490574915749257493574945749557496574975749857499575005750157502575035750457505575065750757508575095751057511575125751357514575155751657517575185751957520575215752257523575245752557526575275752857529575305753157532575335753457535575365753757538575395754057541575425754357544575455754657547575485754957550575515755257553575545755557556575575755857559575605756157562575635756457565575665756757568575695757057571575725757357574575755757657577575785757957580575815758257583575845758557586575875758857589575905759157592575935759457595575965759757598575995760057601576025760357604576055760657607576085760957610576115761257613576145761557616576175761857619576205762157622576235762457625576265762757628576295763057631576325763357634576355763657637576385763957640576415764257643576445764557646576475764857649576505765157652576535765457655576565765757658576595766057661576625766357664576655766657667576685766957670576715767257673576745767557676576775767857679576805768157682576835768457685576865768757688576895769057691576925769357694576955769657697576985769957700577015770257703577045770557706577075770857709577105771157712577135771457715577165771757718577195772057721577225772357724577255772657727577285772957730577315773257733577345773557736577375773857739577405774157742577435774457745577465774757748577495775057751577525775357754577555775657757577585775957760577615776257763577645776557766577675776857769577705777157772577735777457775577765777757778577795778057781577825778357784577855778657787577885778957790577915779257793577945779557796577975779857799578005780157802578035780457805578065780757808578095781057811578125781357814578155781657817578185781957820578215782257823578245782557826578275782857829578305783157832578335783457835578365783757838578395784057841578425784357844578455784657847578485784957850578515785257853578545785557856578575785857859578605786157862578635786457865578665786757868578695787057871578725787357874578755787657877578785787957880578815788257883578845788557886578875788857889578905789157892578935789457895578965789757898578995790057901579025790357904579055790657907579085790957910579115791257913579145791557916579175791857919579205792157922579235792457925579265792757928579295793057931579325793357934579355793657937579385793957940579415794257943579445794557946579475794857949579505795157952579535795457955579565795757958579595796057961579625796357964579655796657967579685796957970579715797257973579745797557976579775797857979579805798157982579835798457985579865798757988579895799057991579925799357994579955799657997579985799958000580015800258003580045800558006580075800858009580105801158012580135801458015580165801758018580195802058021580225802358024580255802658027580285802958030580315803258033580345803558036580375803858039580405804158042580435804458045580465804758048580495805058051580525805358054580555805658057580585805958060580615806258063580645806558066580675806858069580705807158072580735807458075580765807758078580795808058081580825808358084580855808658087580885808958090580915809258093580945809558096580975809858099581005810158102581035810458105581065810758108581095811058111581125811358114581155811658117581185811958120581215812258123581245812558126581275812858129581305813158132581335813458135581365813758138581395814058141581425814358144581455814658147581485814958150581515815258153581545815558156581575815858159581605816158162581635816458165581665816758168581695817058171581725817358174581755817658177581785817958180581815818258183581845818558186581875818858189581905819158192581935819458195581965819758198581995820058201582025820358204582055820658207582085820958210582115821258213582145821558216582175821858219582205822158222582235822458225582265822758228582295823058231582325823358234582355823658237582385823958240582415824258243582445824558246582475824858249582505825158252582535825458255582565825758258582595826058261582625826358264582655826658267582685826958270582715827258273582745827558276582775827858279582805828158282582835828458285582865828758288582895829058291582925829358294582955829658297582985829958300583015830258303583045830558306583075830858309583105831158312583135831458315583165831758318583195832058321583225832358324583255832658327583285832958330583315833258333583345833558336583375833858339583405834158342583435834458345583465834758348583495835058351583525835358354583555835658357583585835958360583615836258363583645836558366583675836858369583705837158372583735837458375583765837758378583795838058381583825838358384583855838658387583885838958390583915839258393583945839558396583975839858399584005840158402584035840458405584065840758408584095841058411584125841358414584155841658417584185841958420584215842258423584245842558426584275842858429584305843158432584335843458435584365843758438584395844058441584425844358444584455844658447584485844958450584515845258453584545845558456584575845858459584605846158462584635846458465584665846758468584695847058471584725847358474584755847658477584785847958480584815848258483584845848558486584875848858489584905849158492584935849458495584965849758498584995850058501585025850358504585055850658507585085850958510585115851258513585145851558516585175851858519585205852158522585235852458525585265852758528585295853058531585325853358534585355853658537585385853958540585415854258543585445854558546585475854858549585505855158552585535855458555585565855758558585595856058561585625856358564585655856658567585685856958570585715857258573585745857558576585775857858579585805858158582585835858458585585865858758588585895859058591585925859358594585955859658597585985859958600586015860258603586045860558606586075860858609586105861158612586135861458615586165861758618586195862058621586225862358624586255862658627586285862958630586315863258633586345863558636586375863858639586405864158642586435864458645586465864758648586495865058651586525865358654586555865658657586585865958660586615866258663586645866558666586675866858669586705867158672586735867458675586765867758678586795868058681586825868358684586855868658687586885868958690586915869258693586945869558696586975869858699587005870158702587035870458705587065870758708587095871058711587125871358714587155871658717587185871958720587215872258723587245872558726587275872858729587305873158732587335873458735587365873758738587395874058741587425874358744587455874658747587485874958750587515875258753587545875558756587575875858759587605876158762587635876458765587665876758768587695877058771587725877358774587755877658777587785877958780587815878258783587845878558786587875878858789587905879158792587935879458795587965879758798587995880058801588025880358804588055880658807588085880958810588115881258813588145881558816588175881858819588205882158822588235882458825588265882758828588295883058831588325883358834588355883658837588385883958840588415884258843588445884558846588475884858849588505885158852588535885458855588565885758858588595886058861588625886358864588655886658867588685886958870588715887258873588745887558876588775887858879588805888158882588835888458885588865888758888588895889058891588925889358894588955889658897588985889958900589015890258903589045890558906589075890858909589105891158912589135891458915589165891758918589195892058921589225892358924589255892658927589285892958930589315893258933589345893558936589375893858939589405894158942589435894458945589465894758948589495895058951589525895358954589555895658957589585895958960589615896258963589645896558966589675896858969589705897158972589735897458975589765897758978589795898058981589825898358984589855898658987589885898958990589915899258993589945899558996589975899858999590005900159002590035900459005590065900759008590095901059011590125901359014590155901659017590185901959020590215902259023590245902559026590275902859029590305903159032590335903459035590365903759038590395904059041590425904359044590455904659047590485904959050590515905259053590545905559056590575905859059590605906159062590635906459065590665906759068590695907059071590725907359074590755907659077590785907959080590815908259083590845908559086590875908859089590905909159092590935909459095590965909759098590995910059101591025910359104591055910659107
  1. /**
  2. * @license
  3. * Copyright 2010-2025 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. * Zero curvature ending for animations.
  1032. *
  1033. * @type {number}
  1034. * @constant
  1035. */
  1036. const ZeroCurvatureEnding = 2400;
  1037. /**
  1038. * Zero slope ending for animations.
  1039. *
  1040. * @type {number}
  1041. * @constant
  1042. */
  1043. const ZeroSlopeEnding = 2401;
  1044. /**
  1045. * Wrap around ending for animations.
  1046. *
  1047. * @type {number}
  1048. * @constant
  1049. */
  1050. const WrapAroundEnding = 2402;
  1051. /**
  1052. * Default animation blend mode.
  1053. *
  1054. * @type {number}
  1055. * @constant
  1056. */
  1057. const NormalAnimationBlendMode = 2500;
  1058. /**
  1059. * Additive animation blend mode. Can be used to layer motions on top of
  1060. * each other to build complex performances from smaller re-usable assets.
  1061. *
  1062. * @type {number}
  1063. * @constant
  1064. */
  1065. const AdditiveAnimationBlendMode = 2501;
  1066. /**
  1067. * For every three vertices draw a single triangle.
  1068. *
  1069. * @type {number}
  1070. * @constant
  1071. */
  1072. const TrianglesDrawMode = 0;
  1073. /**
  1074. * For each vertex draw a triangle from the last three vertices.
  1075. *
  1076. * @type {number}
  1077. * @constant
  1078. */
  1079. const TriangleStripDrawMode = 1;
  1080. /**
  1081. * For each vertex draw a triangle from the first vertex and the last two vertices.
  1082. *
  1083. * @type {number}
  1084. * @constant
  1085. */
  1086. const TriangleFanDrawMode = 2;
  1087. /**
  1088. * The depth value is inverted (1.0 - z) for visualization purposes.
  1089. *
  1090. * @type {number}
  1091. * @constant
  1092. */
  1093. const BasicDepthPacking = 3200;
  1094. /**
  1095. * The depth value is packed into 32 bit RGBA.
  1096. *
  1097. * @type {number}
  1098. * @constant
  1099. */
  1100. const RGBADepthPacking = 3201;
  1101. /**
  1102. * The depth value is packed into 24 bit RGB.
  1103. *
  1104. * @type {number}
  1105. * @constant
  1106. */
  1107. const RGBDepthPacking = 3202;
  1108. /**
  1109. * The depth value is packed into 16 bit RG.
  1110. *
  1111. * @type {number}
  1112. * @constant
  1113. */
  1114. const RGDepthPacking = 3203;
  1115. /**
  1116. * Normal information is relative to the underlying surface.
  1117. *
  1118. * @type {number}
  1119. * @constant
  1120. */
  1121. const TangentSpaceNormalMap = 0;
  1122. /**
  1123. * Normal information is relative to the object orientation.
  1124. *
  1125. * @type {number}
  1126. * @constant
  1127. */
  1128. const ObjectSpaceNormalMap = 1;
  1129. // Color space string identifiers, matching CSS Color Module Level 4 and WebGPU names where available.
  1130. /**
  1131. * No color space.
  1132. *
  1133. * @type {string}
  1134. * @constant
  1135. */
  1136. const NoColorSpace = '';
  1137. /**
  1138. * sRGB color space.
  1139. *
  1140. * @type {string}
  1141. * @constant
  1142. */
  1143. const SRGBColorSpace = 'srgb';
  1144. /**
  1145. * sRGB-linear color space.
  1146. *
  1147. * @type {string}
  1148. * @constant
  1149. */
  1150. const LinearSRGBColorSpace = 'srgb-linear';
  1151. /**
  1152. * Linear transfer function.
  1153. *
  1154. * @type {string}
  1155. * @constant
  1156. */
  1157. const LinearTransfer = 'linear';
  1158. /**
  1159. * sRGB transfer function.
  1160. *
  1161. * @type {string}
  1162. * @constant
  1163. */
  1164. const SRGBTransfer = 'srgb';
  1165. /**
  1166. * No normal map packing.
  1167. *
  1168. * @type {string}
  1169. * @constant
  1170. */
  1171. const NoNormalPacking = '';
  1172. /**
  1173. * Normal RG packing.
  1174. *
  1175. * @type {string}
  1176. * @constant
  1177. */
  1178. const NormalRGPacking = 'rg';
  1179. /**
  1180. * Normal GA packing.
  1181. *
  1182. * @type {string}
  1183. * @constant
  1184. */
  1185. const NormalGAPacking = 'ga';
  1186. /**
  1187. * Sets the stencil buffer value to `0`.
  1188. *
  1189. * @type {number}
  1190. * @constant
  1191. */
  1192. const ZeroStencilOp = 0;
  1193. /**
  1194. * Keeps the current value.
  1195. *
  1196. * @type {number}
  1197. * @constant
  1198. */
  1199. const KeepStencilOp = 7680;
  1200. /**
  1201. * Sets the stencil buffer value to the specified reference value.
  1202. *
  1203. * @type {number}
  1204. * @constant
  1205. */
  1206. const ReplaceStencilOp = 7681;
  1207. /**
  1208. * Increments the current stencil buffer value. Clamps to the maximum representable unsigned value.
  1209. *
  1210. * @type {number}
  1211. * @constant
  1212. */
  1213. const IncrementStencilOp = 7682;
  1214. /**
  1215. * Decrements the current stencil buffer value. Clamps to `0`.
  1216. *
  1217. * @type {number}
  1218. * @constant
  1219. */
  1220. const DecrementStencilOp = 7683;
  1221. /**
  1222. * Increments the current stencil buffer value. Wraps stencil buffer value to zero when incrementing
  1223. * the maximum representable unsigned value.
  1224. *
  1225. * @type {number}
  1226. * @constant
  1227. */
  1228. const IncrementWrapStencilOp = 34055;
  1229. /**
  1230. * Decrements the current stencil buffer value. Wraps stencil buffer value to the maximum representable
  1231. * unsigned value when decrementing a stencil buffer value of `0`.
  1232. *
  1233. * @type {number}
  1234. * @constant
  1235. */
  1236. const DecrementWrapStencilOp = 34056;
  1237. /**
  1238. * Inverts the current stencil buffer value bitwise.
  1239. *
  1240. * @type {number}
  1241. * @constant
  1242. */
  1243. const InvertStencilOp = 5386;
  1244. /**
  1245. * Will never return true.
  1246. *
  1247. * @type {number}
  1248. * @constant
  1249. */
  1250. const NeverStencilFunc = 512;
  1251. /**
  1252. * Will return true if the stencil reference value is less than the current stencil value.
  1253. *
  1254. * @type {number}
  1255. * @constant
  1256. */
  1257. const LessStencilFunc = 513;
  1258. /**
  1259. * Will return true if the stencil reference value is equal to the current stencil value.
  1260. *
  1261. * @type {number}
  1262. * @constant
  1263. */
  1264. const EqualStencilFunc = 514;
  1265. /**
  1266. * Will return true if the stencil reference value is less than or equal to the current stencil value.
  1267. *
  1268. * @type {number}
  1269. * @constant
  1270. */
  1271. const LessEqualStencilFunc = 515;
  1272. /**
  1273. * Will return true if the stencil reference value is greater than the current stencil value.
  1274. *
  1275. * @type {number}
  1276. * @constant
  1277. */
  1278. const GreaterStencilFunc = 516;
  1279. /**
  1280. * Will return true if the stencil reference value is not equal to the current stencil value.
  1281. *
  1282. * @type {number}
  1283. * @constant
  1284. */
  1285. const NotEqualStencilFunc = 517;
  1286. /**
  1287. * Will return true if the stencil reference value is greater than or equal to the current stencil value.
  1288. *
  1289. * @type {number}
  1290. * @constant
  1291. */
  1292. const GreaterEqualStencilFunc = 518;
  1293. /**
  1294. * Will always return true.
  1295. *
  1296. * @type {number}
  1297. * @constant
  1298. */
  1299. const AlwaysStencilFunc = 519;
  1300. /**
  1301. * Never pass.
  1302. *
  1303. * @type {number}
  1304. * @constant
  1305. */
  1306. const NeverCompare = 512;
  1307. /**
  1308. * Pass if the incoming value is less than the texture value.
  1309. *
  1310. * @type {number}
  1311. * @constant
  1312. */
  1313. const LessCompare = 513;
  1314. /**
  1315. * Pass if the incoming value equals the texture value.
  1316. *
  1317. * @type {number}
  1318. * @constant
  1319. */
  1320. const EqualCompare = 514;
  1321. /**
  1322. * Pass if the incoming value is less than or equal to the texture value.
  1323. *
  1324. * @type {number}
  1325. * @constant
  1326. */
  1327. const LessEqualCompare = 515;
  1328. /**
  1329. * Pass if the incoming value is greater than the texture value.
  1330. *
  1331. * @type {number}
  1332. * @constant
  1333. */
  1334. const GreaterCompare = 516;
  1335. /**
  1336. * Pass if the incoming value is not equal to the texture value.
  1337. *
  1338. * @type {number}
  1339. * @constant
  1340. */
  1341. const NotEqualCompare = 517;
  1342. /**
  1343. * Pass if the incoming value is greater than or equal to the texture value.
  1344. *
  1345. * @type {number}
  1346. * @constant
  1347. */
  1348. const GreaterEqualCompare = 518;
  1349. /**
  1350. * Always pass.
  1351. *
  1352. * @type {number}
  1353. * @constant
  1354. */
  1355. const AlwaysCompare = 519;
  1356. /**
  1357. * The contents are intended to be specified once by the application, and used many
  1358. * times as the source for drawing and image specification commands.
  1359. *
  1360. * @type {number}
  1361. * @constant
  1362. */
  1363. const StaticDrawUsage = 35044;
  1364. /**
  1365. * The contents are intended to be respecified repeatedly by the application, and
  1366. * used many times as the source for drawing and image specification commands.
  1367. *
  1368. * @type {number}
  1369. * @constant
  1370. */
  1371. const DynamicDrawUsage = 35048;
  1372. /**
  1373. * The contents are intended to be specified once by the application, and used at most
  1374. * a few times as the source for drawing and image specification commands.
  1375. *
  1376. * @type {number}
  1377. * @constant
  1378. */
  1379. const StreamDrawUsage = 35040;
  1380. /**
  1381. * The contents are intended to be specified once by reading data from the 3D API, and queried
  1382. * many times by the application.
  1383. *
  1384. * @type {number}
  1385. * @constant
  1386. */
  1387. const StaticReadUsage = 35045;
  1388. /**
  1389. * The contents are intended to be respecified repeatedly by reading data from the 3D API, and queried
  1390. * many times by the application.
  1391. *
  1392. * @type {number}
  1393. * @constant
  1394. */
  1395. const DynamicReadUsage = 35049;
  1396. /**
  1397. * The contents are intended to be specified once by reading data from the 3D API, and queried at most
  1398. * a few times by the application
  1399. *
  1400. * @type {number}
  1401. * @constant
  1402. */
  1403. const StreamReadUsage = 35041;
  1404. /**
  1405. * The contents are intended to be specified once by reading data from the 3D API, and used many times as
  1406. * the source for WebGL drawing and image specification commands.
  1407. *
  1408. * @type {number}
  1409. * @constant
  1410. */
  1411. const StaticCopyUsage = 35046;
  1412. /**
  1413. * The contents are intended to be respecified repeatedly by reading data from the 3D API, and used many times
  1414. * as the source for WebGL drawing and image specification commands.
  1415. *
  1416. * @type {number}
  1417. * @constant
  1418. */
  1419. const DynamicCopyUsage = 35050;
  1420. /**
  1421. * The contents are intended to be specified once by reading data from the 3D API, and used at most a few times
  1422. * as the source for WebGL drawing and image specification commands.
  1423. *
  1424. * @type {number}
  1425. * @constant
  1426. */
  1427. const StreamCopyUsage = 35042;
  1428. /**
  1429. * GLSL 1 shader code.
  1430. *
  1431. * @type {string}
  1432. * @constant
  1433. */
  1434. const GLSL1 = '100';
  1435. /**
  1436. * GLSL 3 shader code.
  1437. *
  1438. * @type {string}
  1439. * @constant
  1440. */
  1441. const GLSL3 = '300 es';
  1442. /**
  1443. * WebGL coordinate system.
  1444. *
  1445. * @type {number}
  1446. * @constant
  1447. */
  1448. const WebGLCoordinateSystem = 2000;
  1449. /**
  1450. * WebGPU coordinate system.
  1451. *
  1452. * @type {number}
  1453. * @constant
  1454. */
  1455. const WebGPUCoordinateSystem = 2001;
  1456. /**
  1457. * Represents the different timestamp query types.
  1458. *
  1459. * @type {ConstantsTimestampQuery}
  1460. * @constant
  1461. */
  1462. const TimestampQuery = {
  1463. COMPUTE: 'compute',
  1464. RENDER: 'render'
  1465. };
  1466. /**
  1467. * Represents mouse buttons and interaction types in context of controls.
  1468. *
  1469. * @type {ConstantsInterpolationSamplingType}
  1470. * @constant
  1471. */
  1472. const InterpolationSamplingType = {
  1473. PERSPECTIVE: 'perspective',
  1474. LINEAR: 'linear',
  1475. FLAT: 'flat'
  1476. };
  1477. /**
  1478. * Represents the different interpolation sampling modes.
  1479. *
  1480. * @type {ConstantsInterpolationSamplingMode}
  1481. * @constant
  1482. */
  1483. const InterpolationSamplingMode = {
  1484. NORMAL: 'normal',
  1485. CENTROID: 'centroid',
  1486. SAMPLE: 'sample',
  1487. FIRST: 'first',
  1488. EITHER: 'either'
  1489. };
  1490. /**
  1491. * Compatibility flags for features that may not be supported across all platforms.
  1492. *
  1493. * @type {Object}
  1494. * @constant
  1495. */
  1496. const Compatibility = {
  1497. TEXTURE_COMPARE: 'depthTextureCompare'
  1498. };
  1499. /**
  1500. * This type represents mouse buttons and interaction types in context of controls.
  1501. *
  1502. * @typedef {Object} ConstantsMouse
  1503. * @property {number} MIDDLE - The left mouse button.
  1504. * @property {number} LEFT - The middle mouse button.
  1505. * @property {number} RIGHT - The right mouse button.
  1506. * @property {number} ROTATE - A rotate interaction.
  1507. * @property {number} DOLLY - A dolly interaction.
  1508. * @property {number} PAN - A pan interaction.
  1509. **/
  1510. /**
  1511. * This type represents touch interaction types in context of controls.
  1512. *
  1513. * @typedef {Object} ConstantsTouch
  1514. * @property {number} ROTATE - A rotate interaction.
  1515. * @property {number} PAN - A pan interaction.
  1516. * @property {number} DOLLY_PAN - The dolly-pan interaction.
  1517. * @property {number} DOLLY_ROTATE - A dolly-rotate interaction.
  1518. **/
  1519. /**
  1520. * This type represents the different timestamp query types.
  1521. *
  1522. * @typedef {Object} ConstantsTimestampQuery
  1523. * @property {string} COMPUTE - A `compute` timestamp query.
  1524. * @property {string} RENDER - A `render` timestamp query.
  1525. **/
  1526. /**
  1527. * Represents the different interpolation sampling types.
  1528. *
  1529. * @typedef {Object} ConstantsInterpolationSamplingType
  1530. * @property {string} PERSPECTIVE - Perspective-correct interpolation.
  1531. * @property {string} LINEAR - Linear interpolation.
  1532. * @property {string} FLAT - Flat interpolation.
  1533. */
  1534. /**
  1535. * Represents the different interpolation sampling modes.
  1536. *
  1537. * @typedef {Object} ConstantsInterpolationSamplingMode
  1538. * @property {string} NORMAL - Normal sampling mode.
  1539. * @property {string} CENTROID - Centroid sampling mode.
  1540. * @property {string} SAMPLE - Sample-specific sampling mode.
  1541. * @property {string} FIRST - Flat interpolation using the first vertex.
  1542. * @property {string} EITHER - Flat interpolation using either vertex.
  1543. */
  1544. function arrayNeedsUint32( array ) {
  1545. // assumes larger values usually on last
  1546. for ( let i = array.length - 1; i >= 0; -- i ) {
  1547. if ( array[ i ] >= 65535 ) return true; // account for PRIMITIVE_RESTART_FIXED_INDEX, #24565
  1548. }
  1549. return false;
  1550. }
  1551. const TYPED_ARRAYS = {
  1552. Int8Array: Int8Array,
  1553. Uint8Array: Uint8Array,
  1554. Uint8ClampedArray: Uint8ClampedArray,
  1555. Int16Array: Int16Array,
  1556. Uint16Array: Uint16Array,
  1557. Int32Array: Int32Array,
  1558. Uint32Array: Uint32Array,
  1559. Float32Array: Float32Array,
  1560. Float64Array: Float64Array
  1561. };
  1562. function getTypedArray( type, buffer ) {
  1563. return new TYPED_ARRAYS[ type ]( buffer );
  1564. }
  1565. /**
  1566. * Returns `true` if the given object is a typed array.
  1567. *
  1568. * @param {any} array - The object to check.
  1569. * @return {boolean} Whether the given object is a typed array.
  1570. */
  1571. function isTypedArray( array ) {
  1572. return ArrayBuffer.isView( array ) && ! ( array instanceof DataView );
  1573. }
  1574. function createElementNS( name ) {
  1575. return document.createElementNS( 'http://www.w3.org/1999/xhtml', name );
  1576. }
  1577. function createCanvasElement() {
  1578. const canvas = createElementNS( 'canvas' );
  1579. canvas.style.display = 'block';
  1580. return canvas;
  1581. }
  1582. const _cache = {};
  1583. let _setConsoleFunction = null;
  1584. function setConsoleFunction( fn ) {
  1585. _setConsoleFunction = fn;
  1586. }
  1587. function getConsoleFunction() {
  1588. return _setConsoleFunction;
  1589. }
  1590. function log( ...params ) {
  1591. const message = 'THREE.' + params.shift();
  1592. if ( _setConsoleFunction ) {
  1593. _setConsoleFunction( 'log', message, ...params );
  1594. } else {
  1595. console.log( message, ...params );
  1596. }
  1597. }
  1598. function warn( ...params ) {
  1599. const message = 'THREE.' + params.shift();
  1600. if ( _setConsoleFunction ) {
  1601. _setConsoleFunction( 'warn', message, ...params );
  1602. } else {
  1603. console.warn( message, ...params );
  1604. }
  1605. }
  1606. function error( ...params ) {
  1607. const message = 'THREE.' + params.shift();
  1608. if ( _setConsoleFunction ) {
  1609. _setConsoleFunction( 'error', message, ...params );
  1610. } else {
  1611. console.error( message, ...params );
  1612. }
  1613. }
  1614. function warnOnce( ...params ) {
  1615. const message = params.join( ' ' );
  1616. if ( message in _cache ) return;
  1617. _cache[ message ] = true;
  1618. warn( ...params );
  1619. }
  1620. function probeAsync( gl, sync, interval ) {
  1621. return new Promise( function ( resolve, reject ) {
  1622. function probe() {
  1623. switch ( gl.clientWaitSync( sync, gl.SYNC_FLUSH_COMMANDS_BIT, 0 ) ) {
  1624. case gl.WAIT_FAILED:
  1625. reject();
  1626. break;
  1627. case gl.TIMEOUT_EXPIRED:
  1628. setTimeout( probe, interval );
  1629. break;
  1630. default:
  1631. resolve();
  1632. }
  1633. }
  1634. setTimeout( probe, interval );
  1635. } );
  1636. }
  1637. /**
  1638. * This modules allows to dispatch event objects on custom JavaScript objects.
  1639. *
  1640. * Main repository: [eventdispatcher.js](https://github.com/mrdoob/eventdispatcher.js/)
  1641. *
  1642. * Code Example:
  1643. * ```js
  1644. * class Car extends EventDispatcher {
  1645. * start() {
  1646. * this.dispatchEvent( { type: 'start', message: 'vroom vroom!' } );
  1647. * }
  1648. *};
  1649. *
  1650. * // Using events with the custom object
  1651. * const car = new Car();
  1652. * car.addEventListener( 'start', function ( event ) {
  1653. * alert( event.message );
  1654. * } );
  1655. *
  1656. * car.start();
  1657. * ```
  1658. */
  1659. class EventDispatcher {
  1660. /**
  1661. * Adds the given event listener to the given event type.
  1662. *
  1663. * @param {string} type - The type of event to listen to.
  1664. * @param {Function} listener - The function that gets called when the event is fired.
  1665. */
  1666. addEventListener( type, listener ) {
  1667. if ( this._listeners === undefined ) this._listeners = {};
  1668. const listeners = this._listeners;
  1669. if ( listeners[ type ] === undefined ) {
  1670. listeners[ type ] = [];
  1671. }
  1672. if ( listeners[ type ].indexOf( listener ) === -1 ) {
  1673. listeners[ type ].push( listener );
  1674. }
  1675. }
  1676. /**
  1677. * Returns `true` if the given event listener has been added to the given event type.
  1678. *
  1679. * @param {string} type - The type of event.
  1680. * @param {Function} listener - The listener to check.
  1681. * @return {boolean} Whether the given event listener has been added to the given event type.
  1682. */
  1683. hasEventListener( type, listener ) {
  1684. const listeners = this._listeners;
  1685. if ( listeners === undefined ) return false;
  1686. return listeners[ type ] !== undefined && listeners[ type ].indexOf( listener ) !== -1;
  1687. }
  1688. /**
  1689. * Removes the given event listener from the given event type.
  1690. *
  1691. * @param {string} type - The type of event.
  1692. * @param {Function} listener - The listener to remove.
  1693. */
  1694. removeEventListener( type, listener ) {
  1695. const listeners = this._listeners;
  1696. if ( listeners === undefined ) return;
  1697. const listenerArray = listeners[ type ];
  1698. if ( listenerArray !== undefined ) {
  1699. const index = listenerArray.indexOf( listener );
  1700. if ( index !== -1 ) {
  1701. listenerArray.splice( index, 1 );
  1702. }
  1703. }
  1704. }
  1705. /**
  1706. * Dispatches an event object.
  1707. *
  1708. * @param {Object} event - The event that gets fired.
  1709. */
  1710. dispatchEvent( event ) {
  1711. const listeners = this._listeners;
  1712. if ( listeners === undefined ) return;
  1713. const listenerArray = listeners[ event.type ];
  1714. if ( listenerArray !== undefined ) {
  1715. event.target = this;
  1716. // Make a copy, in case listeners are removed while iterating.
  1717. const array = listenerArray.slice( 0 );
  1718. for ( let i = 0, l = array.length; i < l; i ++ ) {
  1719. array[ i ].call( this, event );
  1720. }
  1721. event.target = null;
  1722. }
  1723. }
  1724. }
  1725. 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' ];
  1726. let _seed = 1234567;
  1727. const DEG2RAD = Math.PI / 180;
  1728. const RAD2DEG = 180 / Math.PI;
  1729. /**
  1730. * Generate a [UUID](https://en.wikipedia.org/wiki/Universally_unique_identifier)
  1731. * (universally unique identifier).
  1732. *
  1733. * @return {string} The UUID.
  1734. */
  1735. function generateUUID() {
  1736. // http://stackoverflow.com/questions/105034/how-to-create-a-guid-uuid-in-javascript/21963136#21963136
  1737. const d0 = Math.random() * 0xffffffff | 0;
  1738. const d1 = Math.random() * 0xffffffff | 0;
  1739. const d2 = Math.random() * 0xffffffff | 0;
  1740. const d3 = Math.random() * 0xffffffff | 0;
  1741. const uuid = _lut[ d0 & 0xff ] + _lut[ d0 >> 8 & 0xff ] + _lut[ d0 >> 16 & 0xff ] + _lut[ d0 >> 24 & 0xff ] + '-' +
  1742. _lut[ d1 & 0xff ] + _lut[ d1 >> 8 & 0xff ] + '-' + _lut[ d1 >> 16 & 0x0f | 0x40 ] + _lut[ d1 >> 24 & 0xff ] + '-' +
  1743. _lut[ d2 & 0x3f | 0x80 ] + _lut[ d2 >> 8 & 0xff ] + '-' + _lut[ d2 >> 16 & 0xff ] + _lut[ d2 >> 24 & 0xff ] +
  1744. _lut[ d3 & 0xff ] + _lut[ d3 >> 8 & 0xff ] + _lut[ d3 >> 16 & 0xff ] + _lut[ d3 >> 24 & 0xff ];
  1745. // .toLowerCase() here flattens concatenated strings to save heap memory space.
  1746. return uuid.toLowerCase();
  1747. }
  1748. /**
  1749. * Clamps the given value between min and max.
  1750. *
  1751. * @param {number} value - The value to clamp.
  1752. * @param {number} min - The min value.
  1753. * @param {number} max - The max value.
  1754. * @return {number} The clamped value.
  1755. */
  1756. function clamp( value, min, max ) {
  1757. return Math.max( min, Math.min( max, value ) );
  1758. }
  1759. /**
  1760. * Computes the Euclidean modulo of the given parameters that
  1761. * is `( ( n % m ) + m ) % m`.
  1762. *
  1763. * @param {number} n - The first parameter.
  1764. * @param {number} m - The second parameter.
  1765. * @return {number} The Euclidean modulo.
  1766. */
  1767. function euclideanModulo( n, m ) {
  1768. // https://en.wikipedia.org/wiki/Modulo_operation
  1769. return ( ( n % m ) + m ) % m;
  1770. }
  1771. /**
  1772. * Performs a linear mapping from range `<a1, a2>` to range `<b1, b2>`
  1773. * for the given value.
  1774. *
  1775. * @param {number} x - The value to be mapped.
  1776. * @param {number} a1 - Minimum value for range A.
  1777. * @param {number} a2 - Maximum value for range A.
  1778. * @param {number} b1 - Minimum value for range B.
  1779. * @param {number} b2 - Maximum value for range B.
  1780. * @return {number} The mapped value.
  1781. */
  1782. function mapLinear( x, a1, a2, b1, b2 ) {
  1783. return b1 + ( x - a1 ) * ( b2 - b1 ) / ( a2 - a1 );
  1784. }
  1785. /**
  1786. * Returns the percentage in the closed interval `[0, 1]` of the given value
  1787. * between the start and end point.
  1788. *
  1789. * @param {number} x - The start point
  1790. * @param {number} y - The end point.
  1791. * @param {number} value - A value between start and end.
  1792. * @return {number} The interpolation factor.
  1793. */
  1794. function inverseLerp( x, y, value ) {
  1795. // https://www.gamedev.net/tutorials/programming/general-and-gameplay-programming/inverse-lerp-a-super-useful-yet-often-overlooked-function-r5230/
  1796. if ( x !== y ) {
  1797. return ( value - x ) / ( y - x );
  1798. } else {
  1799. return 0;
  1800. }
  1801. }
  1802. /**
  1803. * Returns a value linearly interpolated from two known points based on the given interval -
  1804. * `t = 0` will return `x` and `t = 1` will return `y`.
  1805. *
  1806. * @param {number} x - The start point
  1807. * @param {number} y - The end point.
  1808. * @param {number} t - The interpolation factor in the closed interval `[0, 1]`.
  1809. * @return {number} The interpolated value.
  1810. */
  1811. function lerp( x, y, t ) {
  1812. return ( 1 - t ) * x + t * y;
  1813. }
  1814. /**
  1815. * Smoothly interpolate a number from `x` to `y` in a spring-like manner using a delta
  1816. * time to maintain frame rate independent movement. For details, see
  1817. * [Frame rate independent damping using lerp](http://www.rorydriscoll.com/2016/03/07/frame-rate-independent-damping-using-lerp/).
  1818. *
  1819. * @param {number} x - The current point.
  1820. * @param {number} y - The target point.
  1821. * @param {number} lambda - A higher lambda value will make the movement more sudden,
  1822. * and a lower value will make the movement more gradual.
  1823. * @param {number} dt - Delta time in seconds.
  1824. * @return {number} The interpolated value.
  1825. */
  1826. function damp( x, y, lambda, dt ) {
  1827. return lerp( x, y, 1 - Math.exp( - lambda * dt ) );
  1828. }
  1829. /**
  1830. * Returns a value that alternates between `0` and the given `length` parameter.
  1831. *
  1832. * @param {number} x - The value to pingpong.
  1833. * @param {number} [length=1] - The positive value the function will pingpong to.
  1834. * @return {number} The alternated value.
  1835. */
  1836. function pingpong( x, length = 1 ) {
  1837. // https://www.desmos.com/calculator/vcsjnyz7x4
  1838. return length - Math.abs( euclideanModulo( x, length * 2 ) - length );
  1839. }
  1840. /**
  1841. * Returns a value in the range `[0,1]` that represents the percentage that `x` has
  1842. * moved between `min` and `max`, but smoothed or slowed down the closer `x` is to
  1843. * the `min` and `max`.
  1844. *
  1845. * See [Smoothstep](http://en.wikipedia.org/wiki/Smoothstep) for more details.
  1846. *
  1847. * @param {number} x - The value to evaluate based on its position between min and max.
  1848. * @param {number} min - The min value. Any x value below min will be `0`.
  1849. * @param {number} max - The max value. Any x value above max will be `1`.
  1850. * @return {number} The alternated value.
  1851. */
  1852. function smoothstep( x, min, max ) {
  1853. if ( x <= min ) return 0;
  1854. if ( x >= max ) return 1;
  1855. x = ( x - min ) / ( max - min );
  1856. return x * x * ( 3 - 2 * x );
  1857. }
  1858. /**
  1859. * A [variation on smoothstep](https://en.wikipedia.org/wiki/Smoothstep#Variations)
  1860. * that has zero 1st and 2nd order derivatives at x=0 and x=1.
  1861. *
  1862. * @param {number} x - The value to evaluate based on its position between min and max.
  1863. * @param {number} min - The min value. Any x value below min will be `0`.
  1864. * @param {number} max - The max value. Any x value above max will be `1`.
  1865. * @return {number} The alternated value.
  1866. */
  1867. function smootherstep( x, min, max ) {
  1868. if ( x <= min ) return 0;
  1869. if ( x >= max ) return 1;
  1870. x = ( x - min ) / ( max - min );
  1871. return x * x * x * ( x * ( x * 6 - 15 ) + 10 );
  1872. }
  1873. /**
  1874. * Returns a random integer from `<low, high>` interval.
  1875. *
  1876. * @param {number} low - The lower value boundary.
  1877. * @param {number} high - The upper value boundary
  1878. * @return {number} A random integer.
  1879. */
  1880. function randInt( low, high ) {
  1881. return low + Math.floor( Math.random() * ( high - low + 1 ) );
  1882. }
  1883. /**
  1884. * Returns a random float from `<low, high>` interval.
  1885. *
  1886. * @param {number} low - The lower value boundary.
  1887. * @param {number} high - The upper value boundary
  1888. * @return {number} A random float.
  1889. */
  1890. function randFloat( low, high ) {
  1891. return low + Math.random() * ( high - low );
  1892. }
  1893. /**
  1894. * Returns a random integer from `<-range/2, range/2>` interval.
  1895. *
  1896. * @param {number} range - Defines the value range.
  1897. * @return {number} A random float.
  1898. */
  1899. function randFloatSpread( range ) {
  1900. return range * ( 0.5 - Math.random() );
  1901. }
  1902. /**
  1903. * Returns a deterministic pseudo-random float in the interval `[0, 1]`.
  1904. *
  1905. * @param {number} [s] - The integer seed.
  1906. * @return {number} A random float.
  1907. */
  1908. function seededRandom( s ) {
  1909. if ( s !== undefined ) _seed = s;
  1910. // Mulberry32 generator
  1911. let t = _seed += 0x6D2B79F5;
  1912. t = Math.imul( t ^ t >>> 15, t | 1 );
  1913. t ^= t + Math.imul( t ^ t >>> 7, t | 61 );
  1914. return ( ( t ^ t >>> 14 ) >>> 0 ) / 4294967296;
  1915. }
  1916. /**
  1917. * Converts degrees to radians.
  1918. *
  1919. * @param {number} degrees - A value in degrees.
  1920. * @return {number} The converted value in radians.
  1921. */
  1922. function degToRad( degrees ) {
  1923. return degrees * DEG2RAD;
  1924. }
  1925. /**
  1926. * Converts radians to degrees.
  1927. *
  1928. * @param {number} radians - A value in radians.
  1929. * @return {number} The converted value in degrees.
  1930. */
  1931. function radToDeg( radians ) {
  1932. return radians * RAD2DEG;
  1933. }
  1934. /**
  1935. * Returns `true` if the given number is a power of two.
  1936. *
  1937. * @param {number} value - The value to check.
  1938. * @return {boolean} Whether the given number is a power of two or not.
  1939. */
  1940. function isPowerOfTwo( value ) {
  1941. return ( value & ( value - 1 ) ) === 0 && value !== 0;
  1942. }
  1943. /**
  1944. * Returns the smallest power of two that is greater than or equal to the given number.
  1945. *
  1946. * @param {number} value - The value to find a POT for.
  1947. * @return {number} The smallest power of two that is greater than or equal to the given number.
  1948. */
  1949. function ceilPowerOfTwo( value ) {
  1950. return Math.pow( 2, Math.ceil( Math.log( value ) / Math.LN2 ) );
  1951. }
  1952. /**
  1953. * Returns the largest power of two that is less than or equal to the given number.
  1954. *
  1955. * @param {number} value - The value to find a POT for.
  1956. * @return {number} The largest power of two that is less than or equal to the given number.
  1957. */
  1958. function floorPowerOfTwo( value ) {
  1959. return Math.pow( 2, Math.floor( Math.log( value ) / Math.LN2 ) );
  1960. }
  1961. /**
  1962. * Sets the given quaternion from the [Intrinsic Proper Euler Angles](https://en.wikipedia.org/wiki/Euler_angles)
  1963. * defined by the given angles and order.
  1964. *
  1965. * Rotations are applied to the axes in the order specified by order:
  1966. * rotation by angle `a` is applied first, then by angle `b`, then by angle `c`.
  1967. *
  1968. * @param {Quaternion} q - The quaternion to set.
  1969. * @param {number} a - The rotation applied to the first axis, in radians.
  1970. * @param {number} b - The rotation applied to the second axis, in radians.
  1971. * @param {number} c - The rotation applied to the third axis, in radians.
  1972. * @param {('XYX'|'XZX'|'YXY'|'YZY'|'ZXZ'|'ZYZ')} order - A string specifying the axes order.
  1973. */
  1974. function setQuaternionFromProperEuler( q, a, b, c, order ) {
  1975. const cos = Math.cos;
  1976. const sin = Math.sin;
  1977. const c2 = cos( b / 2 );
  1978. const s2 = sin( b / 2 );
  1979. const c13 = cos( ( a + c ) / 2 );
  1980. const s13 = sin( ( a + c ) / 2 );
  1981. const c1_3 = cos( ( a - c ) / 2 );
  1982. const s1_3 = sin( ( a - c ) / 2 );
  1983. const c3_1 = cos( ( c - a ) / 2 );
  1984. const s3_1 = sin( ( c - a ) / 2 );
  1985. switch ( order ) {
  1986. case 'XYX':
  1987. q.set( c2 * s13, s2 * c1_3, s2 * s1_3, c2 * c13 );
  1988. break;
  1989. case 'YZY':
  1990. q.set( s2 * s1_3, c2 * s13, s2 * c1_3, c2 * c13 );
  1991. break;
  1992. case 'ZXZ':
  1993. q.set( s2 * c1_3, s2 * s1_3, c2 * s13, c2 * c13 );
  1994. break;
  1995. case 'XZX':
  1996. q.set( c2 * s13, s2 * s3_1, s2 * c3_1, c2 * c13 );
  1997. break;
  1998. case 'YXY':
  1999. q.set( s2 * c3_1, c2 * s13, s2 * s3_1, c2 * c13 );
  2000. break;
  2001. case 'ZYZ':
  2002. q.set( s2 * s3_1, s2 * c3_1, c2 * s13, c2 * c13 );
  2003. break;
  2004. default:
  2005. warn( 'MathUtils: .setQuaternionFromProperEuler() encountered an unknown order: ' + order );
  2006. }
  2007. }
  2008. /**
  2009. * Denormalizes the given value according to the given typed array.
  2010. *
  2011. * @param {number} value - The value to denormalize.
  2012. * @param {TypedArray} array - The typed array that defines the data type of the value.
  2013. * @return {number} The denormalize (float) value in the range `[0,1]`.
  2014. */
  2015. function denormalize( value, array ) {
  2016. switch ( array.constructor ) {
  2017. case Float32Array:
  2018. return value;
  2019. case Uint32Array:
  2020. return value / 4294967295.0;
  2021. case Uint16Array:
  2022. return value / 65535.0;
  2023. case Uint8Array:
  2024. return value / 255.0;
  2025. case Int32Array:
  2026. return Math.max( value / 2147483647.0, -1 );
  2027. case Int16Array:
  2028. return Math.max( value / 32767.0, -1 );
  2029. case Int8Array:
  2030. return Math.max( value / 127.0, -1 );
  2031. default:
  2032. throw new Error( 'Invalid component type.' );
  2033. }
  2034. }
  2035. /**
  2036. * Normalizes the given value according to the given typed array.
  2037. *
  2038. * @param {number} value - The float value in the range `[0,1]` to normalize.
  2039. * @param {TypedArray} array - The typed array that defines the data type of the value.
  2040. * @return {number} The normalize value.
  2041. */
  2042. function normalize( value, array ) {
  2043. switch ( array.constructor ) {
  2044. case Float32Array:
  2045. return value;
  2046. case Uint32Array:
  2047. return Math.round( value * 4294967295.0 );
  2048. case Uint16Array:
  2049. return Math.round( value * 65535.0 );
  2050. case Uint8Array:
  2051. return Math.round( value * 255.0 );
  2052. case Int32Array:
  2053. return Math.round( value * 2147483647.0 );
  2054. case Int16Array:
  2055. return Math.round( value * 32767.0 );
  2056. case Int8Array:
  2057. return Math.round( value * 127.0 );
  2058. default:
  2059. throw new Error( 'Invalid component type.' );
  2060. }
  2061. }
  2062. /**
  2063. * @class
  2064. * @classdesc A collection of math utility functions.
  2065. * @hideconstructor
  2066. */
  2067. const MathUtils = {
  2068. DEG2RAD: DEG2RAD,
  2069. RAD2DEG: RAD2DEG,
  2070. /**
  2071. * Generate a [UUID](https://en.wikipedia.org/wiki/Universally_unique_identifier)
  2072. * (universally unique identifier).
  2073. *
  2074. * @static
  2075. * @method
  2076. * @return {string} The UUID.
  2077. */
  2078. generateUUID: generateUUID,
  2079. /**
  2080. * Clamps the given value between min and max.
  2081. *
  2082. * @static
  2083. * @method
  2084. * @param {number} value - The value to clamp.
  2085. * @param {number} min - The min value.
  2086. * @param {number} max - The max value.
  2087. * @return {number} The clamped value.
  2088. */
  2089. clamp: clamp,
  2090. /**
  2091. * Computes the Euclidean modulo of the given parameters that
  2092. * is `( ( n % m ) + m ) % m`.
  2093. *
  2094. * @static
  2095. * @method
  2096. * @param {number} n - The first parameter.
  2097. * @param {number} m - The second parameter.
  2098. * @return {number} The Euclidean modulo.
  2099. */
  2100. euclideanModulo: euclideanModulo,
  2101. /**
  2102. * Performs a linear mapping from range `<a1, a2>` to range `<b1, b2>`
  2103. * for the given value.
  2104. *
  2105. * @static
  2106. * @method
  2107. * @param {number} x - The value to be mapped.
  2108. * @param {number} a1 - Minimum value for range A.
  2109. * @param {number} a2 - Maximum value for range A.
  2110. * @param {number} b1 - Minimum value for range B.
  2111. * @param {number} b2 - Maximum value for range B.
  2112. * @return {number} The mapped value.
  2113. */
  2114. mapLinear: mapLinear,
  2115. /**
  2116. * Returns the percentage in the closed interval `[0, 1]` of the given value
  2117. * between the start and end point.
  2118. *
  2119. * @static
  2120. * @method
  2121. * @param {number} x - The start point
  2122. * @param {number} y - The end point.
  2123. * @param {number} value - A value between start and end.
  2124. * @return {number} The interpolation factor.
  2125. */
  2126. inverseLerp: inverseLerp,
  2127. /**
  2128. * Returns a value linearly interpolated from two known points based on the given interval -
  2129. * `t = 0` will return `x` and `t = 1` will return `y`.
  2130. *
  2131. * @static
  2132. * @method
  2133. * @param {number} x - The start point
  2134. * @param {number} y - The end point.
  2135. * @param {number} t - The interpolation factor in the closed interval `[0, 1]`.
  2136. * @return {number} The interpolated value.
  2137. */
  2138. lerp: lerp,
  2139. /**
  2140. * Smoothly interpolate a number from `x` to `y` in a spring-like manner using a delta
  2141. * time to maintain frame rate independent movement. For details, see
  2142. * [Frame rate independent damping using lerp](http://www.rorydriscoll.com/2016/03/07/frame-rate-independent-damping-using-lerp/).
  2143. *
  2144. * @static
  2145. * @method
  2146. * @param {number} x - The current point.
  2147. * @param {number} y - The target point.
  2148. * @param {number} lambda - A higher lambda value will make the movement more sudden,
  2149. * and a lower value will make the movement more gradual.
  2150. * @param {number} dt - Delta time in seconds.
  2151. * @return {number} The interpolated value.
  2152. */
  2153. damp: damp,
  2154. /**
  2155. * Returns a value that alternates between `0` and the given `length` parameter.
  2156. *
  2157. * @static
  2158. * @method
  2159. * @param {number} x - The value to pingpong.
  2160. * @param {number} [length=1] - The positive value the function will pingpong to.
  2161. * @return {number} The alternated value.
  2162. */
  2163. pingpong: pingpong,
  2164. /**
  2165. * Returns a value in the range `[0,1]` that represents the percentage that `x` has
  2166. * moved between `min` and `max`, but smoothed or slowed down the closer `x` is to
  2167. * the `min` and `max`.
  2168. *
  2169. * See [Smoothstep](http://en.wikipedia.org/wiki/Smoothstep) for more details.
  2170. *
  2171. * @static
  2172. * @method
  2173. * @param {number} x - The value to evaluate based on its position between min and max.
  2174. * @param {number} min - The min value. Any x value below min will be `0`.
  2175. * @param {number} max - The max value. Any x value above max will be `1`.
  2176. * @return {number} The alternated value.
  2177. */
  2178. smoothstep: smoothstep,
  2179. /**
  2180. * A [variation on smoothstep](https://en.wikipedia.org/wiki/Smoothstep#Variations)
  2181. * that has zero 1st and 2nd order derivatives at x=0 and x=1.
  2182. *
  2183. * @static
  2184. * @method
  2185. * @param {number} x - The value to evaluate based on its position between min and max.
  2186. * @param {number} min - The min value. Any x value below min will be `0`.
  2187. * @param {number} max - The max value. Any x value above max will be `1`.
  2188. * @return {number} The alternated value.
  2189. */
  2190. smootherstep: smootherstep,
  2191. /**
  2192. * Returns a random integer from `<low, high>` interval.
  2193. *
  2194. * @static
  2195. * @method
  2196. * @param {number} low - The lower value boundary.
  2197. * @param {number} high - The upper value boundary
  2198. * @return {number} A random integer.
  2199. */
  2200. randInt: randInt,
  2201. /**
  2202. * Returns a random float from `<low, high>` interval.
  2203. *
  2204. * @static
  2205. * @method
  2206. * @param {number} low - The lower value boundary.
  2207. * @param {number} high - The upper value boundary
  2208. * @return {number} A random float.
  2209. */
  2210. randFloat: randFloat,
  2211. /**
  2212. * Returns a random integer from `<-range/2, range/2>` interval.
  2213. *
  2214. * @static
  2215. * @method
  2216. * @param {number} range - Defines the value range.
  2217. * @return {number} A random float.
  2218. */
  2219. randFloatSpread: randFloatSpread,
  2220. /**
  2221. * Returns a deterministic pseudo-random float in the interval `[0, 1]`.
  2222. *
  2223. * @static
  2224. * @method
  2225. * @param {number} [s] - The integer seed.
  2226. * @return {number} A random float.
  2227. */
  2228. seededRandom: seededRandom,
  2229. /**
  2230. * Converts degrees to radians.
  2231. *
  2232. * @static
  2233. * @method
  2234. * @param {number} degrees - A value in degrees.
  2235. * @return {number} The converted value in radians.
  2236. */
  2237. degToRad: degToRad,
  2238. /**
  2239. * Converts radians to degrees.
  2240. *
  2241. * @static
  2242. * @method
  2243. * @param {number} radians - A value in radians.
  2244. * @return {number} The converted value in degrees.
  2245. */
  2246. radToDeg: radToDeg,
  2247. /**
  2248. * Returns `true` if the given number is a power of two.
  2249. *
  2250. * @static
  2251. * @method
  2252. * @param {number} value - The value to check.
  2253. * @return {boolean} Whether the given number is a power of two or not.
  2254. */
  2255. isPowerOfTwo: isPowerOfTwo,
  2256. /**
  2257. * Returns the smallest power of two that is greater than or equal to the given number.
  2258. *
  2259. * @static
  2260. * @method
  2261. * @param {number} value - The value to find a POT for.
  2262. * @return {number} The smallest power of two that is greater than or equal to the given number.
  2263. */
  2264. ceilPowerOfTwo: ceilPowerOfTwo,
  2265. /**
  2266. * Returns the largest power of two that is less than or equal to the given number.
  2267. *
  2268. * @static
  2269. * @method
  2270. * @param {number} value - The value to find a POT for.
  2271. * @return {number} The largest power of two that is less than or equal to the given number.
  2272. */
  2273. floorPowerOfTwo: floorPowerOfTwo,
  2274. /**
  2275. * Sets the given quaternion from the [Intrinsic Proper Euler Angles](https://en.wikipedia.org/wiki/Euler_angles)
  2276. * defined by the given angles and order.
  2277. *
  2278. * Rotations are applied to the axes in the order specified by order:
  2279. * rotation by angle `a` is applied first, then by angle `b`, then by angle `c`.
  2280. *
  2281. * @static
  2282. * @method
  2283. * @param {Quaternion} q - The quaternion to set.
  2284. * @param {number} a - The rotation applied to the first axis, in radians.
  2285. * @param {number} b - The rotation applied to the second axis, in radians.
  2286. * @param {number} c - The rotation applied to the third axis, in radians.
  2287. * @param {('XYX'|'XZX'|'YXY'|'YZY'|'ZXZ'|'ZYZ')} order - A string specifying the axes order.
  2288. */
  2289. setQuaternionFromProperEuler: setQuaternionFromProperEuler,
  2290. /**
  2291. * Normalizes the given value according to the given typed array.
  2292. *
  2293. * @static
  2294. * @method
  2295. * @param {number} value - The float value in the range `[0,1]` to normalize.
  2296. * @param {TypedArray} array - The typed array that defines the data type of the value.
  2297. * @return {number} The normalize value.
  2298. */
  2299. normalize: normalize,
  2300. /**
  2301. * Denormalizes the given value according to the given typed array.
  2302. *
  2303. * @static
  2304. * @method
  2305. * @param {number} value - The value to denormalize.
  2306. * @param {TypedArray} array - The typed array that defines the data type of the value.
  2307. * @return {number} The denormalize (float) value in the range `[0,1]`.
  2308. */
  2309. denormalize: denormalize
  2310. };
  2311. /**
  2312. * Class representing a 2D vector. A 2D vector is an ordered pair of numbers
  2313. * (labeled x and y), which can be used to represent a number of things, such as:
  2314. *
  2315. * - A point in 2D space (i.e. a position on a plane).
  2316. * - A direction and length across a plane. In three.js the length will
  2317. * always be the Euclidean distance(straight-line distance) from `(0, 0)` to `(x, y)`
  2318. * and the direction is also measured from `(0, 0)` towards `(x, y)`.
  2319. * - Any arbitrary ordered pair of numbers.
  2320. *
  2321. * There are other things a 2D vector can be used to represent, such as
  2322. * momentum vectors, complex numbers and so on, however these are the most
  2323. * common uses in three.js.
  2324. *
  2325. * Iterating through a vector instance will yield its components `(x, y)` in
  2326. * the corresponding order.
  2327. * ```js
  2328. * const a = new THREE.Vector2( 0, 1 );
  2329. *
  2330. * //no arguments; will be initialised to (0, 0)
  2331. * const b = new THREE.Vector2( );
  2332. *
  2333. * const d = a.distanceTo( b );
  2334. * ```
  2335. */
  2336. class Vector2 {
  2337. /**
  2338. * Constructs a new 2D vector.
  2339. *
  2340. * @param {number} [x=0] - The x value of this vector.
  2341. * @param {number} [y=0] - The y value of this vector.
  2342. */
  2343. constructor( x = 0, y = 0 ) {
  2344. /**
  2345. * This flag can be used for type testing.
  2346. *
  2347. * @type {boolean}
  2348. * @readonly
  2349. * @default true
  2350. */
  2351. Vector2.prototype.isVector2 = true;
  2352. /**
  2353. * The x value of this vector.
  2354. *
  2355. * @type {number}
  2356. */
  2357. this.x = x;
  2358. /**
  2359. * The y value of this vector.
  2360. *
  2361. * @type {number}
  2362. */
  2363. this.y = y;
  2364. }
  2365. /**
  2366. * Alias for {@link Vector2#x}.
  2367. *
  2368. * @type {number}
  2369. */
  2370. get width() {
  2371. return this.x;
  2372. }
  2373. set width( value ) {
  2374. this.x = value;
  2375. }
  2376. /**
  2377. * Alias for {@link Vector2#y}.
  2378. *
  2379. * @type {number}
  2380. */
  2381. get height() {
  2382. return this.y;
  2383. }
  2384. set height( value ) {
  2385. this.y = value;
  2386. }
  2387. /**
  2388. * Sets the vector components.
  2389. *
  2390. * @param {number} x - The value of the x component.
  2391. * @param {number} y - The value of the y component.
  2392. * @return {Vector2} A reference to this vector.
  2393. */
  2394. set( x, y ) {
  2395. this.x = x;
  2396. this.y = y;
  2397. return this;
  2398. }
  2399. /**
  2400. * Sets the vector components to the same value.
  2401. *
  2402. * @param {number} scalar - The value to set for all vector components.
  2403. * @return {Vector2} A reference to this vector.
  2404. */
  2405. setScalar( scalar ) {
  2406. this.x = scalar;
  2407. this.y = scalar;
  2408. return this;
  2409. }
  2410. /**
  2411. * Sets the vector's x component to the given value
  2412. *
  2413. * @param {number} x - The value to set.
  2414. * @return {Vector2} A reference to this vector.
  2415. */
  2416. setX( x ) {
  2417. this.x = x;
  2418. return this;
  2419. }
  2420. /**
  2421. * Sets the vector's y component to the given value
  2422. *
  2423. * @param {number} y - The value to set.
  2424. * @return {Vector2} A reference to this vector.
  2425. */
  2426. setY( y ) {
  2427. this.y = y;
  2428. return this;
  2429. }
  2430. /**
  2431. * Allows to set a vector component with an index.
  2432. *
  2433. * @param {number} index - The component index. `0` equals to x, `1` equals to y.
  2434. * @param {number} value - The value to set.
  2435. * @return {Vector2} A reference to this vector.
  2436. */
  2437. setComponent( index, value ) {
  2438. switch ( index ) {
  2439. case 0: this.x = value; break;
  2440. case 1: this.y = value; break;
  2441. default: throw new Error( 'index is out of range: ' + index );
  2442. }
  2443. return this;
  2444. }
  2445. /**
  2446. * Returns the value of the vector component which matches the given index.
  2447. *
  2448. * @param {number} index - The component index. `0` equals to x, `1` equals to y.
  2449. * @return {number} A vector component value.
  2450. */
  2451. getComponent( index ) {
  2452. switch ( index ) {
  2453. case 0: return this.x;
  2454. case 1: return this.y;
  2455. default: throw new Error( 'index is out of range: ' + index );
  2456. }
  2457. }
  2458. /**
  2459. * Returns a new vector with copied values from this instance.
  2460. *
  2461. * @return {Vector2} A clone of this instance.
  2462. */
  2463. clone() {
  2464. return new this.constructor( this.x, this.y );
  2465. }
  2466. /**
  2467. * Copies the values of the given vector to this instance.
  2468. *
  2469. * @param {Vector2} v - The vector to copy.
  2470. * @return {Vector2} A reference to this vector.
  2471. */
  2472. copy( v ) {
  2473. this.x = v.x;
  2474. this.y = v.y;
  2475. return this;
  2476. }
  2477. /**
  2478. * Adds the given vector to this instance.
  2479. *
  2480. * @param {Vector2} v - The vector to add.
  2481. * @return {Vector2} A reference to this vector.
  2482. */
  2483. add( v ) {
  2484. this.x += v.x;
  2485. this.y += v.y;
  2486. return this;
  2487. }
  2488. /**
  2489. * Adds the given scalar value to all components of this instance.
  2490. *
  2491. * @param {number} s - The scalar to add.
  2492. * @return {Vector2} A reference to this vector.
  2493. */
  2494. addScalar( s ) {
  2495. this.x += s;
  2496. this.y += s;
  2497. return this;
  2498. }
  2499. /**
  2500. * Adds the given vectors and stores the result in this instance.
  2501. *
  2502. * @param {Vector2} a - The first vector.
  2503. * @param {Vector2} b - The second vector.
  2504. * @return {Vector2} A reference to this vector.
  2505. */
  2506. addVectors( a, b ) {
  2507. this.x = a.x + b.x;
  2508. this.y = a.y + b.y;
  2509. return this;
  2510. }
  2511. /**
  2512. * Adds the given vector scaled by the given factor to this instance.
  2513. *
  2514. * @param {Vector2} v - The vector.
  2515. * @param {number} s - The factor that scales `v`.
  2516. * @return {Vector2} A reference to this vector.
  2517. */
  2518. addScaledVector( v, s ) {
  2519. this.x += v.x * s;
  2520. this.y += v.y * s;
  2521. return this;
  2522. }
  2523. /**
  2524. * Subtracts the given vector from this instance.
  2525. *
  2526. * @param {Vector2} v - The vector to subtract.
  2527. * @return {Vector2} A reference to this vector.
  2528. */
  2529. sub( v ) {
  2530. this.x -= v.x;
  2531. this.y -= v.y;
  2532. return this;
  2533. }
  2534. /**
  2535. * Subtracts the given scalar value from all components of this instance.
  2536. *
  2537. * @param {number} s - The scalar to subtract.
  2538. * @return {Vector2} A reference to this vector.
  2539. */
  2540. subScalar( s ) {
  2541. this.x -= s;
  2542. this.y -= s;
  2543. return this;
  2544. }
  2545. /**
  2546. * Subtracts the given vectors and stores the result in this instance.
  2547. *
  2548. * @param {Vector2} a - The first vector.
  2549. * @param {Vector2} b - The second vector.
  2550. * @return {Vector2} A reference to this vector.
  2551. */
  2552. subVectors( a, b ) {
  2553. this.x = a.x - b.x;
  2554. this.y = a.y - b.y;
  2555. return this;
  2556. }
  2557. /**
  2558. * Multiplies the given vector with this instance.
  2559. *
  2560. * @param {Vector2} v - The vector to multiply.
  2561. * @return {Vector2} A reference to this vector.
  2562. */
  2563. multiply( v ) {
  2564. this.x *= v.x;
  2565. this.y *= v.y;
  2566. return this;
  2567. }
  2568. /**
  2569. * Multiplies the given scalar value with all components of this instance.
  2570. *
  2571. * @param {number} scalar - The scalar to multiply.
  2572. * @return {Vector2} A reference to this vector.
  2573. */
  2574. multiplyScalar( scalar ) {
  2575. this.x *= scalar;
  2576. this.y *= scalar;
  2577. return this;
  2578. }
  2579. /**
  2580. * Divides this instance by the given vector.
  2581. *
  2582. * @param {Vector2} v - The vector to divide.
  2583. * @return {Vector2} A reference to this vector.
  2584. */
  2585. divide( v ) {
  2586. this.x /= v.x;
  2587. this.y /= v.y;
  2588. return this;
  2589. }
  2590. /**
  2591. * Divides this vector by the given scalar.
  2592. *
  2593. * @param {number} scalar - The scalar to divide.
  2594. * @return {Vector2} A reference to this vector.
  2595. */
  2596. divideScalar( scalar ) {
  2597. return this.multiplyScalar( 1 / scalar );
  2598. }
  2599. /**
  2600. * Multiplies this vector (with an implicit 1 as the 3rd component) by
  2601. * the given 3x3 matrix.
  2602. *
  2603. * @param {Matrix3} m - The matrix to apply.
  2604. * @return {Vector2} A reference to this vector.
  2605. */
  2606. applyMatrix3( m ) {
  2607. const x = this.x, y = this.y;
  2608. const e = m.elements;
  2609. this.x = e[ 0 ] * x + e[ 3 ] * y + e[ 6 ];
  2610. this.y = e[ 1 ] * x + e[ 4 ] * y + e[ 7 ];
  2611. return this;
  2612. }
  2613. /**
  2614. * If this vector's x or y value is greater than the given vector's x or y
  2615. * value, replace that value with the corresponding min value.
  2616. *
  2617. * @param {Vector2} v - The vector.
  2618. * @return {Vector2} A reference to this vector.
  2619. */
  2620. min( v ) {
  2621. this.x = Math.min( this.x, v.x );
  2622. this.y = Math.min( this.y, v.y );
  2623. return this;
  2624. }
  2625. /**
  2626. * If this vector's x or y value is less than the given vector's x or y
  2627. * value, replace that value with the corresponding max value.
  2628. *
  2629. * @param {Vector2} v - The vector.
  2630. * @return {Vector2} A reference to this vector.
  2631. */
  2632. max( v ) {
  2633. this.x = Math.max( this.x, v.x );
  2634. this.y = Math.max( this.y, v.y );
  2635. return this;
  2636. }
  2637. /**
  2638. * If this vector's x or y value is greater than the max vector's x or y
  2639. * value, it is replaced by the corresponding value.
  2640. * If this vector's x or y value is less than the min vector's x or y value,
  2641. * it is replaced by the corresponding value.
  2642. *
  2643. * @param {Vector2} min - The minimum x and y values.
  2644. * @param {Vector2} max - The maximum x and y values in the desired range.
  2645. * @return {Vector2} A reference to this vector.
  2646. */
  2647. clamp( min, max ) {
  2648. // assumes min < max, componentwise
  2649. this.x = clamp( this.x, min.x, max.x );
  2650. this.y = clamp( this.y, min.y, max.y );
  2651. return this;
  2652. }
  2653. /**
  2654. * If this vector's x or y values are greater than the max value, they are
  2655. * replaced by the max value.
  2656. * If this vector's x or y values are less than the min value, they are
  2657. * replaced by the min value.
  2658. *
  2659. * @param {number} minVal - The minimum value the components will be clamped to.
  2660. * @param {number} maxVal - The maximum value the components will be clamped to.
  2661. * @return {Vector2} A reference to this vector.
  2662. */
  2663. clampScalar( minVal, maxVal ) {
  2664. this.x = clamp( this.x, minVal, maxVal );
  2665. this.y = clamp( this.y, minVal, maxVal );
  2666. return this;
  2667. }
  2668. /**
  2669. * If this vector's length is greater than the max value, it is replaced by
  2670. * the max value.
  2671. * If this vector's length is less than the min value, it is replaced by the
  2672. * min value.
  2673. *
  2674. * @param {number} min - The minimum value the vector length will be clamped to.
  2675. * @param {number} max - The maximum value the vector length will be clamped to.
  2676. * @return {Vector2} A reference to this vector.
  2677. */
  2678. clampLength( min, max ) {
  2679. const length = this.length();
  2680. return this.divideScalar( length || 1 ).multiplyScalar( clamp( length, min, max ) );
  2681. }
  2682. /**
  2683. * The components of this vector are rounded down to the nearest integer value.
  2684. *
  2685. * @return {Vector2} A reference to this vector.
  2686. */
  2687. floor() {
  2688. this.x = Math.floor( this.x );
  2689. this.y = Math.floor( this.y );
  2690. return this;
  2691. }
  2692. /**
  2693. * The components of this vector are rounded up to the nearest integer value.
  2694. *
  2695. * @return {Vector2} A reference to this vector.
  2696. */
  2697. ceil() {
  2698. this.x = Math.ceil( this.x );
  2699. this.y = Math.ceil( this.y );
  2700. return this;
  2701. }
  2702. /**
  2703. * The components of this vector are rounded to the nearest integer value
  2704. *
  2705. * @return {Vector2} A reference to this vector.
  2706. */
  2707. round() {
  2708. this.x = Math.round( this.x );
  2709. this.y = Math.round( this.y );
  2710. return this;
  2711. }
  2712. /**
  2713. * The components of this vector are rounded towards zero (up if negative,
  2714. * down if positive) to an integer value.
  2715. *
  2716. * @return {Vector2} A reference to this vector.
  2717. */
  2718. roundToZero() {
  2719. this.x = Math.trunc( this.x );
  2720. this.y = Math.trunc( this.y );
  2721. return this;
  2722. }
  2723. /**
  2724. * Inverts this vector - i.e. sets x = -x and y = -y.
  2725. *
  2726. * @return {Vector2} A reference to this vector.
  2727. */
  2728. negate() {
  2729. this.x = - this.x;
  2730. this.y = - this.y;
  2731. return this;
  2732. }
  2733. /**
  2734. * Calculates the dot product of the given vector with this instance.
  2735. *
  2736. * @param {Vector2} v - The vector to compute the dot product with.
  2737. * @return {number} The result of the dot product.
  2738. */
  2739. dot( v ) {
  2740. return this.x * v.x + this.y * v.y;
  2741. }
  2742. /**
  2743. * Calculates the cross product of the given vector with this instance.
  2744. *
  2745. * @param {Vector2} v - The vector to compute the cross product with.
  2746. * @return {number} The result of the cross product.
  2747. */
  2748. cross( v ) {
  2749. return this.x * v.y - this.y * v.x;
  2750. }
  2751. /**
  2752. * Computes the square of the Euclidean length (straight-line length) from
  2753. * (0, 0) to (x, y). If you are comparing the lengths of vectors, you should
  2754. * compare the length squared instead as it is slightly more efficient to calculate.
  2755. *
  2756. * @return {number} The square length of this vector.
  2757. */
  2758. lengthSq() {
  2759. return this.x * this.x + this.y * this.y;
  2760. }
  2761. /**
  2762. * Computes the Euclidean length (straight-line length) from (0, 0) to (x, y).
  2763. *
  2764. * @return {number} The length of this vector.
  2765. */
  2766. length() {
  2767. return Math.sqrt( this.x * this.x + this.y * this.y );
  2768. }
  2769. /**
  2770. * Computes the Manhattan length of this vector.
  2771. *
  2772. * @return {number} The length of this vector.
  2773. */
  2774. manhattanLength() {
  2775. return Math.abs( this.x ) + Math.abs( this.y );
  2776. }
  2777. /**
  2778. * Converts this vector to a unit vector - that is, sets it equal to a vector
  2779. * with the same direction as this one, but with a vector length of `1`.
  2780. *
  2781. * @return {Vector2} A reference to this vector.
  2782. */
  2783. normalize() {
  2784. return this.divideScalar( this.length() || 1 );
  2785. }
  2786. /**
  2787. * Computes the angle in radians of this vector with respect to the positive x-axis.
  2788. *
  2789. * @return {number} The angle in radians.
  2790. */
  2791. angle() {
  2792. const angle = Math.atan2( - this.y, - this.x ) + Math.PI;
  2793. return angle;
  2794. }
  2795. /**
  2796. * Returns the angle between the given vector and this instance in radians.
  2797. *
  2798. * @param {Vector2} v - The vector to compute the angle with.
  2799. * @return {number} The angle in radians.
  2800. */
  2801. angleTo( v ) {
  2802. const denominator = Math.sqrt( this.lengthSq() * v.lengthSq() );
  2803. if ( denominator === 0 ) return Math.PI / 2;
  2804. const theta = this.dot( v ) / denominator;
  2805. // clamp, to handle numerical problems
  2806. return Math.acos( clamp( theta, -1, 1 ) );
  2807. }
  2808. /**
  2809. * Computes the distance from the given vector to this instance.
  2810. *
  2811. * @param {Vector2} v - The vector to compute the distance to.
  2812. * @return {number} The distance.
  2813. */
  2814. distanceTo( v ) {
  2815. return Math.sqrt( this.distanceToSquared( v ) );
  2816. }
  2817. /**
  2818. * Computes the squared distance from the given vector to this instance.
  2819. * If you are just comparing the distance with another distance, you should compare
  2820. * the distance squared instead as it is slightly more efficient to calculate.
  2821. *
  2822. * @param {Vector2} v - The vector to compute the squared distance to.
  2823. * @return {number} The squared distance.
  2824. */
  2825. distanceToSquared( v ) {
  2826. const dx = this.x - v.x, dy = this.y - v.y;
  2827. return dx * dx + dy * dy;
  2828. }
  2829. /**
  2830. * Computes the Manhattan distance from the given vector to this instance.
  2831. *
  2832. * @param {Vector2} v - The vector to compute the Manhattan distance to.
  2833. * @return {number} The Manhattan distance.
  2834. */
  2835. manhattanDistanceTo( v ) {
  2836. return Math.abs( this.x - v.x ) + Math.abs( this.y - v.y );
  2837. }
  2838. /**
  2839. * Sets this vector to a vector with the same direction as this one, but
  2840. * with the specified length.
  2841. *
  2842. * @param {number} length - The new length of this vector.
  2843. * @return {Vector2} A reference to this vector.
  2844. */
  2845. setLength( length ) {
  2846. return this.normalize().multiplyScalar( length );
  2847. }
  2848. /**
  2849. * Linearly interpolates between the given vector and this instance, where
  2850. * alpha is the percent distance along the line - alpha = 0 will be this
  2851. * vector, and alpha = 1 will be the given one.
  2852. *
  2853. * @param {Vector2} v - The vector to interpolate towards.
  2854. * @param {number} alpha - The interpolation factor, typically in the closed interval `[0, 1]`.
  2855. * @return {Vector2} A reference to this vector.
  2856. */
  2857. lerp( v, alpha ) {
  2858. this.x += ( v.x - this.x ) * alpha;
  2859. this.y += ( v.y - this.y ) * alpha;
  2860. return this;
  2861. }
  2862. /**
  2863. * Linearly interpolates between the given vectors, where alpha is the percent
  2864. * distance along the line - alpha = 0 will be first vector, and alpha = 1 will
  2865. * be the second one. The result is stored in this instance.
  2866. *
  2867. * @param {Vector2} v1 - The first vector.
  2868. * @param {Vector2} v2 - The second vector.
  2869. * @param {number} alpha - The interpolation factor, typically in the closed interval `[0, 1]`.
  2870. * @return {Vector2} A reference to this vector.
  2871. */
  2872. lerpVectors( v1, v2, alpha ) {
  2873. this.x = v1.x + ( v2.x - v1.x ) * alpha;
  2874. this.y = v1.y + ( v2.y - v1.y ) * alpha;
  2875. return this;
  2876. }
  2877. /**
  2878. * Returns `true` if this vector is equal with the given one.
  2879. *
  2880. * @param {Vector2} v - The vector to test for equality.
  2881. * @return {boolean} Whether this vector is equal with the given one.
  2882. */
  2883. equals( v ) {
  2884. return ( ( v.x === this.x ) && ( v.y === this.y ) );
  2885. }
  2886. /**
  2887. * Sets this vector's x value to be `array[ offset ]` and y
  2888. * value to be `array[ offset + 1 ]`.
  2889. *
  2890. * @param {Array<number>} array - An array holding the vector component values.
  2891. * @param {number} [offset=0] - The offset into the array.
  2892. * @return {Vector2} A reference to this vector.
  2893. */
  2894. fromArray( array, offset = 0 ) {
  2895. this.x = array[ offset ];
  2896. this.y = array[ offset + 1 ];
  2897. return this;
  2898. }
  2899. /**
  2900. * Writes the components of this vector to the given array. If no array is provided,
  2901. * the method returns a new instance.
  2902. *
  2903. * @param {Array<number>} [array=[]] - The target array holding the vector components.
  2904. * @param {number} [offset=0] - Index of the first element in the array.
  2905. * @return {Array<number>} The vector components.
  2906. */
  2907. toArray( array = [], offset = 0 ) {
  2908. array[ offset ] = this.x;
  2909. array[ offset + 1 ] = this.y;
  2910. return array;
  2911. }
  2912. /**
  2913. * Sets the components of this vector from the given buffer attribute.
  2914. *
  2915. * @param {BufferAttribute} attribute - The buffer attribute holding vector data.
  2916. * @param {number} index - The index into the attribute.
  2917. * @return {Vector2} A reference to this vector.
  2918. */
  2919. fromBufferAttribute( attribute, index ) {
  2920. this.x = attribute.getX( index );
  2921. this.y = attribute.getY( index );
  2922. return this;
  2923. }
  2924. /**
  2925. * Rotates this vector around the given center by the given angle.
  2926. *
  2927. * @param {Vector2} center - The point around which to rotate.
  2928. * @param {number} angle - The angle to rotate, in radians.
  2929. * @return {Vector2} A reference to this vector.
  2930. */
  2931. rotateAround( center, angle ) {
  2932. const c = Math.cos( angle ), s = Math.sin( angle );
  2933. const x = this.x - center.x;
  2934. const y = this.y - center.y;
  2935. this.x = x * c - y * s + center.x;
  2936. this.y = x * s + y * c + center.y;
  2937. return this;
  2938. }
  2939. /**
  2940. * Sets each component of this vector to a pseudo-random value between `0` and
  2941. * `1`, excluding `1`.
  2942. *
  2943. * @return {Vector2} A reference to this vector.
  2944. */
  2945. random() {
  2946. this.x = Math.random();
  2947. this.y = Math.random();
  2948. return this;
  2949. }
  2950. *[ Symbol.iterator ]() {
  2951. yield this.x;
  2952. yield this.y;
  2953. }
  2954. }
  2955. /**
  2956. * Class for representing a Quaternion. Quaternions are used in three.js to represent rotations.
  2957. *
  2958. * Iterating through a vector instance will yield its components `(x, y, z, w)` in
  2959. * the corresponding order.
  2960. *
  2961. * Note that three.js expects Quaternions to be normalized.
  2962. * ```js
  2963. * const quaternion = new THREE.Quaternion();
  2964. * quaternion.setFromAxisAngle( new THREE.Vector3( 0, 1, 0 ), Math.PI / 2 );
  2965. *
  2966. * const vector = new THREE.Vector3( 1, 0, 0 );
  2967. * vector.applyQuaternion( quaternion );
  2968. * ```
  2969. */
  2970. class Quaternion {
  2971. /**
  2972. * Constructs a new quaternion.
  2973. *
  2974. * @param {number} [x=0] - The x value of this quaternion.
  2975. * @param {number} [y=0] - The y value of this quaternion.
  2976. * @param {number} [z=0] - The z value of this quaternion.
  2977. * @param {number} [w=1] - The w value of this quaternion.
  2978. */
  2979. constructor( x = 0, y = 0, z = 0, w = 1 ) {
  2980. /**
  2981. * This flag can be used for type testing.
  2982. *
  2983. * @type {boolean}
  2984. * @readonly
  2985. * @default true
  2986. */
  2987. this.isQuaternion = true;
  2988. this._x = x;
  2989. this._y = y;
  2990. this._z = z;
  2991. this._w = w;
  2992. }
  2993. /**
  2994. * Interpolates between two quaternions via SLERP. This implementation assumes the
  2995. * quaternion data are managed in flat arrays.
  2996. *
  2997. * @param {Array<number>} dst - The destination array.
  2998. * @param {number} dstOffset - An offset into the destination array.
  2999. * @param {Array<number>} src0 - The source array of the first quaternion.
  3000. * @param {number} srcOffset0 - An offset into the first source array.
  3001. * @param {Array<number>} src1 - The source array of the second quaternion.
  3002. * @param {number} srcOffset1 - An offset into the second source array.
  3003. * @param {number} t - The interpolation factor. A value in the range `[0,1]` will interpolate. A value outside the range `[0,1]` will extrapolate.
  3004. * @see {@link Quaternion#slerp}
  3005. */
  3006. static slerpFlat( dst, dstOffset, src0, srcOffset0, src1, srcOffset1, t ) {
  3007. let x0 = src0[ srcOffset0 + 0 ],
  3008. y0 = src0[ srcOffset0 + 1 ],
  3009. z0 = src0[ srcOffset0 + 2 ],
  3010. w0 = src0[ srcOffset0 + 3 ];
  3011. let x1 = src1[ srcOffset1 + 0 ],
  3012. y1 = src1[ srcOffset1 + 1 ],
  3013. z1 = src1[ srcOffset1 + 2 ],
  3014. w1 = src1[ srcOffset1 + 3 ];
  3015. if ( w0 !== w1 || x0 !== x1 || y0 !== y1 || z0 !== z1 ) {
  3016. let dot = x0 * x1 + y0 * y1 + z0 * z1 + w0 * w1;
  3017. if ( dot < 0 ) {
  3018. x1 = - x1;
  3019. y1 = - y1;
  3020. z1 = - z1;
  3021. w1 = - w1;
  3022. dot = - dot;
  3023. }
  3024. let s = 1 - t;
  3025. if ( dot < 0.9995 ) {
  3026. // slerp
  3027. const theta = Math.acos( dot );
  3028. const sin = Math.sin( theta );
  3029. s = Math.sin( s * theta ) / sin;
  3030. t = Math.sin( t * theta ) / sin;
  3031. x0 = x0 * s + x1 * t;
  3032. y0 = y0 * s + y1 * t;
  3033. z0 = z0 * s + z1 * t;
  3034. w0 = w0 * s + w1 * t;
  3035. } else {
  3036. // for small angles, lerp then normalize
  3037. x0 = x0 * s + x1 * t;
  3038. y0 = y0 * s + y1 * t;
  3039. z0 = z0 * s + z1 * t;
  3040. w0 = w0 * s + w1 * t;
  3041. const f = 1 / Math.sqrt( x0 * x0 + y0 * y0 + z0 * z0 + w0 * w0 );
  3042. x0 *= f;
  3043. y0 *= f;
  3044. z0 *= f;
  3045. w0 *= f;
  3046. }
  3047. }
  3048. dst[ dstOffset ] = x0;
  3049. dst[ dstOffset + 1 ] = y0;
  3050. dst[ dstOffset + 2 ] = z0;
  3051. dst[ dstOffset + 3 ] = w0;
  3052. }
  3053. /**
  3054. * Multiplies two quaternions. This implementation assumes the quaternion data are managed
  3055. * in flat arrays.
  3056. *
  3057. * @param {Array<number>} dst - The destination array.
  3058. * @param {number} dstOffset - An offset into the destination array.
  3059. * @param {Array<number>} src0 - The source array of the first quaternion.
  3060. * @param {number} srcOffset0 - An offset into the first source array.
  3061. * @param {Array<number>} src1 - The source array of the second quaternion.
  3062. * @param {number} srcOffset1 - An offset into the second source array.
  3063. * @return {Array<number>} The destination array.
  3064. * @see {@link Quaternion#multiplyQuaternions}.
  3065. */
  3066. static multiplyQuaternionsFlat( dst, dstOffset, src0, srcOffset0, src1, srcOffset1 ) {
  3067. const x0 = src0[ srcOffset0 ];
  3068. const y0 = src0[ srcOffset0 + 1 ];
  3069. const z0 = src0[ srcOffset0 + 2 ];
  3070. const w0 = src0[ srcOffset0 + 3 ];
  3071. const x1 = src1[ srcOffset1 ];
  3072. const y1 = src1[ srcOffset1 + 1 ];
  3073. const z1 = src1[ srcOffset1 + 2 ];
  3074. const w1 = src1[ srcOffset1 + 3 ];
  3075. dst[ dstOffset ] = x0 * w1 + w0 * x1 + y0 * z1 - z0 * y1;
  3076. dst[ dstOffset + 1 ] = y0 * w1 + w0 * y1 + z0 * x1 - x0 * z1;
  3077. dst[ dstOffset + 2 ] = z0 * w1 + w0 * z1 + x0 * y1 - y0 * x1;
  3078. dst[ dstOffset + 3 ] = w0 * w1 - x0 * x1 - y0 * y1 - z0 * z1;
  3079. return dst;
  3080. }
  3081. /**
  3082. * The x value of this quaternion.
  3083. *
  3084. * @type {number}
  3085. * @default 0
  3086. */
  3087. get x() {
  3088. return this._x;
  3089. }
  3090. set x( value ) {
  3091. this._x = value;
  3092. this._onChangeCallback();
  3093. }
  3094. /**
  3095. * The y value of this quaternion.
  3096. *
  3097. * @type {number}
  3098. * @default 0
  3099. */
  3100. get y() {
  3101. return this._y;
  3102. }
  3103. set y( value ) {
  3104. this._y = value;
  3105. this._onChangeCallback();
  3106. }
  3107. /**
  3108. * The z value of this quaternion.
  3109. *
  3110. * @type {number}
  3111. * @default 0
  3112. */
  3113. get z() {
  3114. return this._z;
  3115. }
  3116. set z( value ) {
  3117. this._z = value;
  3118. this._onChangeCallback();
  3119. }
  3120. /**
  3121. * The w value of this quaternion.
  3122. *
  3123. * @type {number}
  3124. * @default 1
  3125. */
  3126. get w() {
  3127. return this._w;
  3128. }
  3129. set w( value ) {
  3130. this._w = value;
  3131. this._onChangeCallback();
  3132. }
  3133. /**
  3134. * Sets the quaternion components.
  3135. *
  3136. * @param {number} x - The x value of this quaternion.
  3137. * @param {number} y - The y value of this quaternion.
  3138. * @param {number} z - The z value of this quaternion.
  3139. * @param {number} w - The w value of this quaternion.
  3140. * @return {Quaternion} A reference to this quaternion.
  3141. */
  3142. set( x, y, z, w ) {
  3143. this._x = x;
  3144. this._y = y;
  3145. this._z = z;
  3146. this._w = w;
  3147. this._onChangeCallback();
  3148. return this;
  3149. }
  3150. /**
  3151. * Returns a new quaternion with copied values from this instance.
  3152. *
  3153. * @return {Quaternion} A clone of this instance.
  3154. */
  3155. clone() {
  3156. return new this.constructor( this._x, this._y, this._z, this._w );
  3157. }
  3158. /**
  3159. * Copies the values of the given quaternion to this instance.
  3160. *
  3161. * @param {Quaternion} quaternion - The quaternion to copy.
  3162. * @return {Quaternion} A reference to this quaternion.
  3163. */
  3164. copy( quaternion ) {
  3165. this._x = quaternion.x;
  3166. this._y = quaternion.y;
  3167. this._z = quaternion.z;
  3168. this._w = quaternion.w;
  3169. this._onChangeCallback();
  3170. return this;
  3171. }
  3172. /**
  3173. * Sets this quaternion from the rotation specified by the given
  3174. * Euler angles.
  3175. *
  3176. * @param {Euler} euler - The Euler angles.
  3177. * @param {boolean} [update=true] - Whether the internal `onChange` callback should be executed or not.
  3178. * @return {Quaternion} A reference to this quaternion.
  3179. */
  3180. setFromEuler( euler, update = true ) {
  3181. const x = euler._x, y = euler._y, z = euler._z, order = euler._order;
  3182. // http://www.mathworks.com/matlabcentral/fileexchange/
  3183. // 20696-function-to-convert-between-dcm-euler-angles-quaternions-and-euler-vectors/
  3184. // content/SpinCalc.m
  3185. const cos = Math.cos;
  3186. const sin = Math.sin;
  3187. const c1 = cos( x / 2 );
  3188. const c2 = cos( y / 2 );
  3189. const c3 = cos( z / 2 );
  3190. const s1 = sin( x / 2 );
  3191. const s2 = sin( y / 2 );
  3192. const s3 = sin( z / 2 );
  3193. switch ( order ) {
  3194. case 'XYZ':
  3195. this._x = s1 * c2 * c3 + c1 * s2 * s3;
  3196. this._y = c1 * s2 * c3 - s1 * c2 * s3;
  3197. this._z = c1 * c2 * s3 + s1 * s2 * c3;
  3198. this._w = c1 * c2 * c3 - s1 * s2 * s3;
  3199. break;
  3200. case 'YXZ':
  3201. this._x = s1 * c2 * c3 + c1 * s2 * s3;
  3202. this._y = c1 * s2 * c3 - s1 * c2 * s3;
  3203. this._z = c1 * c2 * s3 - s1 * s2 * c3;
  3204. this._w = c1 * c2 * c3 + s1 * s2 * s3;
  3205. break;
  3206. case 'ZXY':
  3207. this._x = s1 * c2 * c3 - c1 * s2 * s3;
  3208. this._y = c1 * s2 * c3 + s1 * c2 * s3;
  3209. this._z = c1 * c2 * s3 + s1 * s2 * c3;
  3210. this._w = c1 * c2 * c3 - s1 * s2 * s3;
  3211. break;
  3212. case 'ZYX':
  3213. this._x = s1 * c2 * c3 - c1 * s2 * s3;
  3214. this._y = c1 * s2 * c3 + s1 * c2 * s3;
  3215. this._z = c1 * c2 * s3 - s1 * s2 * c3;
  3216. this._w = c1 * c2 * c3 + s1 * s2 * s3;
  3217. break;
  3218. case 'YZX':
  3219. this._x = s1 * c2 * c3 + c1 * s2 * s3;
  3220. this._y = c1 * s2 * c3 + s1 * c2 * s3;
  3221. this._z = c1 * c2 * s3 - s1 * s2 * c3;
  3222. this._w = c1 * c2 * c3 - s1 * s2 * s3;
  3223. break;
  3224. case 'XZY':
  3225. this._x = s1 * c2 * c3 - c1 * s2 * s3;
  3226. this._y = c1 * s2 * c3 - s1 * c2 * s3;
  3227. this._z = c1 * c2 * s3 + s1 * s2 * c3;
  3228. this._w = c1 * c2 * c3 + s1 * s2 * s3;
  3229. break;
  3230. default:
  3231. warn( 'Quaternion: .setFromEuler() encountered an unknown order: ' + order );
  3232. }
  3233. if ( update === true ) this._onChangeCallback();
  3234. return this;
  3235. }
  3236. /**
  3237. * Sets this quaternion from the given axis and angle.
  3238. *
  3239. * @param {Vector3} axis - The normalized axis.
  3240. * @param {number} angle - The angle in radians.
  3241. * @return {Quaternion} A reference to this quaternion.
  3242. */
  3243. setFromAxisAngle( axis, angle ) {
  3244. // http://www.euclideanspace.com/maths/geometry/rotations/conversions/angleToQuaternion/index.htm
  3245. const halfAngle = angle / 2, s = Math.sin( halfAngle );
  3246. this._x = axis.x * s;
  3247. this._y = axis.y * s;
  3248. this._z = axis.z * s;
  3249. this._w = Math.cos( halfAngle );
  3250. this._onChangeCallback();
  3251. return this;
  3252. }
  3253. /**
  3254. * Sets this quaternion from the given rotation matrix.
  3255. *
  3256. * @param {Matrix4} m - A 4x4 matrix of which the upper 3x3 of matrix is a pure rotation matrix (i.e. unscaled).
  3257. * @return {Quaternion} A reference to this quaternion.
  3258. */
  3259. setFromRotationMatrix( m ) {
  3260. // http://www.euclideanspace.com/maths/geometry/rotations/conversions/matrixToQuaternion/index.htm
  3261. // assumes the upper 3x3 of m is a pure rotation matrix (i.e, unscaled)
  3262. const te = m.elements,
  3263. m11 = te[ 0 ], m12 = te[ 4 ], m13 = te[ 8 ],
  3264. m21 = te[ 1 ], m22 = te[ 5 ], m23 = te[ 9 ],
  3265. m31 = te[ 2 ], m32 = te[ 6 ], m33 = te[ 10 ],
  3266. trace = m11 + m22 + m33;
  3267. if ( trace > 0 ) {
  3268. const s = 0.5 / Math.sqrt( trace + 1.0 );
  3269. this._w = 0.25 / s;
  3270. this._x = ( m32 - m23 ) * s;
  3271. this._y = ( m13 - m31 ) * s;
  3272. this._z = ( m21 - m12 ) * s;
  3273. } else if ( m11 > m22 && m11 > m33 ) {
  3274. const s = 2.0 * Math.sqrt( 1.0 + m11 - m22 - m33 );
  3275. this._w = ( m32 - m23 ) / s;
  3276. this._x = 0.25 * s;
  3277. this._y = ( m12 + m21 ) / s;
  3278. this._z = ( m13 + m31 ) / s;
  3279. } else if ( m22 > m33 ) {
  3280. const s = 2.0 * Math.sqrt( 1.0 + m22 - m11 - m33 );
  3281. this._w = ( m13 - m31 ) / s;
  3282. this._x = ( m12 + m21 ) / s;
  3283. this._y = 0.25 * s;
  3284. this._z = ( m23 + m32 ) / s;
  3285. } else {
  3286. const s = 2.0 * Math.sqrt( 1.0 + m33 - m11 - m22 );
  3287. this._w = ( m21 - m12 ) / s;
  3288. this._x = ( m13 + m31 ) / s;
  3289. this._y = ( m23 + m32 ) / s;
  3290. this._z = 0.25 * s;
  3291. }
  3292. this._onChangeCallback();
  3293. return this;
  3294. }
  3295. /**
  3296. * Sets this quaternion to the rotation required to rotate the direction vector
  3297. * `vFrom` to the direction vector `vTo`.
  3298. *
  3299. * @param {Vector3} vFrom - The first (normalized) direction vector.
  3300. * @param {Vector3} vTo - The second (normalized) direction vector.
  3301. * @return {Quaternion} A reference to this quaternion.
  3302. */
  3303. setFromUnitVectors( vFrom, vTo ) {
  3304. // assumes direction vectors vFrom and vTo are normalized
  3305. let r = vFrom.dot( vTo ) + 1;
  3306. if ( r < 1e-8 ) { // the epsilon value has been discussed in #31286
  3307. // vFrom and vTo point in opposite directions
  3308. r = 0;
  3309. if ( Math.abs( vFrom.x ) > Math.abs( vFrom.z ) ) {
  3310. this._x = - vFrom.y;
  3311. this._y = vFrom.x;
  3312. this._z = 0;
  3313. this._w = r;
  3314. } else {
  3315. this._x = 0;
  3316. this._y = - vFrom.z;
  3317. this._z = vFrom.y;
  3318. this._w = r;
  3319. }
  3320. } else {
  3321. // crossVectors( vFrom, vTo ); // inlined to avoid cyclic dependency on Vector3
  3322. this._x = vFrom.y * vTo.z - vFrom.z * vTo.y;
  3323. this._y = vFrom.z * vTo.x - vFrom.x * vTo.z;
  3324. this._z = vFrom.x * vTo.y - vFrom.y * vTo.x;
  3325. this._w = r;
  3326. }
  3327. return this.normalize();
  3328. }
  3329. /**
  3330. * Returns the angle between this quaternion and the given one in radians.
  3331. *
  3332. * @param {Quaternion} q - The quaternion to compute the angle with.
  3333. * @return {number} The angle in radians.
  3334. */
  3335. angleTo( q ) {
  3336. return 2 * Math.acos( Math.abs( clamp( this.dot( q ), -1, 1 ) ) );
  3337. }
  3338. /**
  3339. * Rotates this quaternion by a given angular step to the given quaternion.
  3340. * The method ensures that the final quaternion will not overshoot `q`.
  3341. *
  3342. * @param {Quaternion} q - The target quaternion.
  3343. * @param {number} step - The angular step in radians.
  3344. * @return {Quaternion} A reference to this quaternion.
  3345. */
  3346. rotateTowards( q, step ) {
  3347. const angle = this.angleTo( q );
  3348. if ( angle === 0 ) return this;
  3349. const t = Math.min( 1, step / angle );
  3350. this.slerp( q, t );
  3351. return this;
  3352. }
  3353. /**
  3354. * Sets this quaternion to the identity quaternion; that is, to the
  3355. * quaternion that represents "no rotation".
  3356. *
  3357. * @return {Quaternion} A reference to this quaternion.
  3358. */
  3359. identity() {
  3360. return this.set( 0, 0, 0, 1 );
  3361. }
  3362. /**
  3363. * Inverts this quaternion via {@link Quaternion#conjugate}. The
  3364. * quaternion is assumed to have unit length.
  3365. *
  3366. * @return {Quaternion} A reference to this quaternion.
  3367. */
  3368. invert() {
  3369. return this.conjugate();
  3370. }
  3371. /**
  3372. * Returns the rotational conjugate of this quaternion. The conjugate of a
  3373. * quaternion represents the same rotation in the opposite direction about
  3374. * the rotational axis.
  3375. *
  3376. * @return {Quaternion} A reference to this quaternion.
  3377. */
  3378. conjugate() {
  3379. this._x *= -1;
  3380. this._y *= -1;
  3381. this._z *= -1;
  3382. this._onChangeCallback();
  3383. return this;
  3384. }
  3385. /**
  3386. * Calculates the dot product of this quaternion and the given one.
  3387. *
  3388. * @param {Quaternion} v - The quaternion to compute the dot product with.
  3389. * @return {number} The result of the dot product.
  3390. */
  3391. dot( v ) {
  3392. return this._x * v._x + this._y * v._y + this._z * v._z + this._w * v._w;
  3393. }
  3394. /**
  3395. * Computes the squared Euclidean length (straight-line length) of this quaternion,
  3396. * considered as a 4 dimensional vector. This can be useful if you are comparing the
  3397. * lengths of two quaternions, as this is a slightly more efficient calculation than
  3398. * {@link Quaternion#length}.
  3399. *
  3400. * @return {number} The squared Euclidean length.
  3401. */
  3402. lengthSq() {
  3403. return this._x * this._x + this._y * this._y + this._z * this._z + this._w * this._w;
  3404. }
  3405. /**
  3406. * Computes the Euclidean length (straight-line length) of this quaternion,
  3407. * considered as a 4 dimensional vector.
  3408. *
  3409. * @return {number} The Euclidean length.
  3410. */
  3411. length() {
  3412. return Math.sqrt( this._x * this._x + this._y * this._y + this._z * this._z + this._w * this._w );
  3413. }
  3414. /**
  3415. * Normalizes this quaternion - that is, calculated the quaternion that performs
  3416. * the same rotation as this one, but has a length equal to `1`.
  3417. *
  3418. * @return {Quaternion} A reference to this quaternion.
  3419. */
  3420. normalize() {
  3421. let l = this.length();
  3422. if ( l === 0 ) {
  3423. this._x = 0;
  3424. this._y = 0;
  3425. this._z = 0;
  3426. this._w = 1;
  3427. } else {
  3428. l = 1 / l;
  3429. this._x = this._x * l;
  3430. this._y = this._y * l;
  3431. this._z = this._z * l;
  3432. this._w = this._w * l;
  3433. }
  3434. this._onChangeCallback();
  3435. return this;
  3436. }
  3437. /**
  3438. * Multiplies this quaternion by the given one.
  3439. *
  3440. * @param {Quaternion} q - The quaternion.
  3441. * @return {Quaternion} A reference to this quaternion.
  3442. */
  3443. multiply( q ) {
  3444. return this.multiplyQuaternions( this, q );
  3445. }
  3446. /**
  3447. * Pre-multiplies this quaternion by the given one.
  3448. *
  3449. * @param {Quaternion} q - The quaternion.
  3450. * @return {Quaternion} A reference to this quaternion.
  3451. */
  3452. premultiply( q ) {
  3453. return this.multiplyQuaternions( q, this );
  3454. }
  3455. /**
  3456. * Multiplies the given quaternions and stores the result in this instance.
  3457. *
  3458. * @param {Quaternion} a - The first quaternion.
  3459. * @param {Quaternion} b - The second quaternion.
  3460. * @return {Quaternion} A reference to this quaternion.
  3461. */
  3462. multiplyQuaternions( a, b ) {
  3463. // from http://www.euclideanspace.com/maths/algebra/realNormedAlgebra/quaternions/code/index.htm
  3464. const qax = a._x, qay = a._y, qaz = a._z, qaw = a._w;
  3465. const qbx = b._x, qby = b._y, qbz = b._z, qbw = b._w;
  3466. this._x = qax * qbw + qaw * qbx + qay * qbz - qaz * qby;
  3467. this._y = qay * qbw + qaw * qby + qaz * qbx - qax * qbz;
  3468. this._z = qaz * qbw + qaw * qbz + qax * qby - qay * qbx;
  3469. this._w = qaw * qbw - qax * qbx - qay * qby - qaz * qbz;
  3470. this._onChangeCallback();
  3471. return this;
  3472. }
  3473. /**
  3474. * Performs a spherical linear interpolation between this quaternion and the target quaternion.
  3475. *
  3476. * @param {Quaternion} qb - The target quaternion.
  3477. * @param {number} t - The interpolation factor. A value in the range `[0,1]` will interpolate. A value outside the range `[0,1]` will extrapolate.
  3478. * @return {Quaternion} A reference to this quaternion.
  3479. */
  3480. slerp( qb, t ) {
  3481. let x = qb._x, y = qb._y, z = qb._z, w = qb._w;
  3482. let dot = this.dot( qb );
  3483. if ( dot < 0 ) {
  3484. x = - x;
  3485. y = - y;
  3486. z = - z;
  3487. w = - w;
  3488. dot = - dot;
  3489. }
  3490. let s = 1 - t;
  3491. if ( dot < 0.9995 ) {
  3492. // slerp
  3493. const theta = Math.acos( dot );
  3494. const sin = Math.sin( theta );
  3495. s = Math.sin( s * theta ) / sin;
  3496. t = Math.sin( t * theta ) / sin;
  3497. this._x = this._x * s + x * t;
  3498. this._y = this._y * s + y * t;
  3499. this._z = this._z * s + z * t;
  3500. this._w = this._w * s + w * t;
  3501. this._onChangeCallback();
  3502. } else {
  3503. // for small angles, lerp then normalize
  3504. this._x = this._x * s + x * t;
  3505. this._y = this._y * s + y * t;
  3506. this._z = this._z * s + z * t;
  3507. this._w = this._w * s + w * t;
  3508. this.normalize(); // normalize calls _onChangeCallback()
  3509. }
  3510. return this;
  3511. }
  3512. /**
  3513. * Performs a spherical linear interpolation between the given quaternions
  3514. * and stores the result in this quaternion.
  3515. *
  3516. * @param {Quaternion} qa - The source quaternion.
  3517. * @param {Quaternion} qb - The target quaternion.
  3518. * @param {number} t - The interpolation factor in the closed interval `[0, 1]`.
  3519. * @return {Quaternion} A reference to this quaternion.
  3520. */
  3521. slerpQuaternions( qa, qb, t ) {
  3522. return this.copy( qa ).slerp( qb, t );
  3523. }
  3524. /**
  3525. * Sets this quaternion to a uniformly random, normalized quaternion.
  3526. *
  3527. * @return {Quaternion} A reference to this quaternion.
  3528. */
  3529. random() {
  3530. // Ken Shoemake
  3531. // Uniform random rotations
  3532. // D. Kirk, editor, Graphics Gems III, pages 124-132. Academic Press, New York, 1992.
  3533. const theta1 = 2 * Math.PI * Math.random();
  3534. const theta2 = 2 * Math.PI * Math.random();
  3535. const x0 = Math.random();
  3536. const r1 = Math.sqrt( 1 - x0 );
  3537. const r2 = Math.sqrt( x0 );
  3538. return this.set(
  3539. r1 * Math.sin( theta1 ),
  3540. r1 * Math.cos( theta1 ),
  3541. r2 * Math.sin( theta2 ),
  3542. r2 * Math.cos( theta2 ),
  3543. );
  3544. }
  3545. /**
  3546. * Returns `true` if this quaternion is equal with the given one.
  3547. *
  3548. * @param {Quaternion} quaternion - The quaternion to test for equality.
  3549. * @return {boolean} Whether this quaternion is equal with the given one.
  3550. */
  3551. equals( quaternion ) {
  3552. return ( quaternion._x === this._x ) && ( quaternion._y === this._y ) && ( quaternion._z === this._z ) && ( quaternion._w === this._w );
  3553. }
  3554. /**
  3555. * Sets this quaternion's components from the given array.
  3556. *
  3557. * @param {Array<number>} array - An array holding the quaternion component values.
  3558. * @param {number} [offset=0] - The offset into the array.
  3559. * @return {Quaternion} A reference to this quaternion.
  3560. */
  3561. fromArray( array, offset = 0 ) {
  3562. this._x = array[ offset ];
  3563. this._y = array[ offset + 1 ];
  3564. this._z = array[ offset + 2 ];
  3565. this._w = array[ offset + 3 ];
  3566. this._onChangeCallback();
  3567. return this;
  3568. }
  3569. /**
  3570. * Writes the components of this quaternion to the given array. If no array is provided,
  3571. * the method returns a new instance.
  3572. *
  3573. * @param {Array<number>} [array=[]] - The target array holding the quaternion components.
  3574. * @param {number} [offset=0] - Index of the first element in the array.
  3575. * @return {Array<number>} The quaternion components.
  3576. */
  3577. toArray( array = [], offset = 0 ) {
  3578. array[ offset ] = this._x;
  3579. array[ offset + 1 ] = this._y;
  3580. array[ offset + 2 ] = this._z;
  3581. array[ offset + 3 ] = this._w;
  3582. return array;
  3583. }
  3584. /**
  3585. * Sets the components of this quaternion from the given buffer attribute.
  3586. *
  3587. * @param {BufferAttribute} attribute - The buffer attribute holding quaternion data.
  3588. * @param {number} index - The index into the attribute.
  3589. * @return {Quaternion} A reference to this quaternion.
  3590. */
  3591. fromBufferAttribute( attribute, index ) {
  3592. this._x = attribute.getX( index );
  3593. this._y = attribute.getY( index );
  3594. this._z = attribute.getZ( index );
  3595. this._w = attribute.getW( index );
  3596. this._onChangeCallback();
  3597. return this;
  3598. }
  3599. /**
  3600. * This methods defines the serialization result of this class. Returns the
  3601. * numerical elements of this quaternion in an array of format `[x, y, z, w]`.
  3602. *
  3603. * @return {Array<number>} The serialized quaternion.
  3604. */
  3605. toJSON() {
  3606. return this.toArray();
  3607. }
  3608. _onChange( callback ) {
  3609. this._onChangeCallback = callback;
  3610. return this;
  3611. }
  3612. _onChangeCallback() {}
  3613. *[ Symbol.iterator ]() {
  3614. yield this._x;
  3615. yield this._y;
  3616. yield this._z;
  3617. yield this._w;
  3618. }
  3619. }
  3620. /**
  3621. * Class representing a 3D vector. A 3D vector is an ordered triplet of numbers
  3622. * (labeled x, y and z), which can be used to represent a number of things, such as:
  3623. *
  3624. * - A point in 3D space.
  3625. * - A direction and length in 3D space. In three.js the length will
  3626. * always be the Euclidean distance(straight-line distance) from `(0, 0, 0)` to `(x, y, z)`
  3627. * and the direction is also measured from `(0, 0, 0)` towards `(x, y, z)`.
  3628. * - Any arbitrary ordered triplet of numbers.
  3629. *
  3630. * There are other things a 3D vector can be used to represent, such as
  3631. * momentum vectors and so on, however these are the most
  3632. * common uses in three.js.
  3633. *
  3634. * Iterating through a vector instance will yield its components `(x, y, z)` in
  3635. * the corresponding order.
  3636. * ```js
  3637. * const a = new THREE.Vector3( 0, 1, 0 );
  3638. *
  3639. * //no arguments; will be initialised to (0, 0, 0)
  3640. * const b = new THREE.Vector3( );
  3641. *
  3642. * const d = a.distanceTo( b );
  3643. * ```
  3644. */
  3645. class Vector3 {
  3646. /**
  3647. * Constructs a new 3D vector.
  3648. *
  3649. * @param {number} [x=0] - The x value of this vector.
  3650. * @param {number} [y=0] - The y value of this vector.
  3651. * @param {number} [z=0] - The z value of this vector.
  3652. */
  3653. constructor( x = 0, y = 0, z = 0 ) {
  3654. /**
  3655. * This flag can be used for type testing.
  3656. *
  3657. * @type {boolean}
  3658. * @readonly
  3659. * @default true
  3660. */
  3661. Vector3.prototype.isVector3 = true;
  3662. /**
  3663. * The x value of this vector.
  3664. *
  3665. * @type {number}
  3666. */
  3667. this.x = x;
  3668. /**
  3669. * The y value of this vector.
  3670. *
  3671. * @type {number}
  3672. */
  3673. this.y = y;
  3674. /**
  3675. * The z value of this vector.
  3676. *
  3677. * @type {number}
  3678. */
  3679. this.z = z;
  3680. }
  3681. /**
  3682. * Sets the vector components.
  3683. *
  3684. * @param {number} x - The value of the x component.
  3685. * @param {number} y - The value of the y component.
  3686. * @param {number} z - The value of the z component.
  3687. * @return {Vector3} A reference to this vector.
  3688. */
  3689. set( x, y, z ) {
  3690. if ( z === undefined ) z = this.z; // sprite.scale.set(x,y)
  3691. this.x = x;
  3692. this.y = y;
  3693. this.z = z;
  3694. return this;
  3695. }
  3696. /**
  3697. * Sets the vector components to the same value.
  3698. *
  3699. * @param {number} scalar - The value to set for all vector components.
  3700. * @return {Vector3} A reference to this vector.
  3701. */
  3702. setScalar( scalar ) {
  3703. this.x = scalar;
  3704. this.y = scalar;
  3705. this.z = scalar;
  3706. return this;
  3707. }
  3708. /**
  3709. * Sets the vector's x component to the given value.
  3710. *
  3711. * @param {number} x - The value to set.
  3712. * @return {Vector3} A reference to this vector.
  3713. */
  3714. setX( x ) {
  3715. this.x = x;
  3716. return this;
  3717. }
  3718. /**
  3719. * Sets the vector's y component to the given value.
  3720. *
  3721. * @param {number} y - The value to set.
  3722. * @return {Vector3} A reference to this vector.
  3723. */
  3724. setY( y ) {
  3725. this.y = y;
  3726. return this;
  3727. }
  3728. /**
  3729. * Sets the vector's z component to the given value.
  3730. *
  3731. * @param {number} z - The value to set.
  3732. * @return {Vector3} A reference to this vector.
  3733. */
  3734. setZ( z ) {
  3735. this.z = z;
  3736. return this;
  3737. }
  3738. /**
  3739. * Allows to set a vector component with an index.
  3740. *
  3741. * @param {number} index - The component index. `0` equals to x, `1` equals to y, `2` equals to z.
  3742. * @param {number} value - The value to set.
  3743. * @return {Vector3} A reference to this vector.
  3744. */
  3745. setComponent( index, value ) {
  3746. switch ( index ) {
  3747. case 0: this.x = value; break;
  3748. case 1: this.y = value; break;
  3749. case 2: this.z = value; break;
  3750. default: throw new Error( 'index is out of range: ' + index );
  3751. }
  3752. return this;
  3753. }
  3754. /**
  3755. * Returns the value of the vector component which matches the given index.
  3756. *
  3757. * @param {number} index - The component index. `0` equals to x, `1` equals to y, `2` equals to z.
  3758. * @return {number} A vector component value.
  3759. */
  3760. getComponent( index ) {
  3761. switch ( index ) {
  3762. case 0: return this.x;
  3763. case 1: return this.y;
  3764. case 2: return this.z;
  3765. default: throw new Error( 'index is out of range: ' + index );
  3766. }
  3767. }
  3768. /**
  3769. * Returns a new vector with copied values from this instance.
  3770. *
  3771. * @return {Vector3} A clone of this instance.
  3772. */
  3773. clone() {
  3774. return new this.constructor( this.x, this.y, this.z );
  3775. }
  3776. /**
  3777. * Copies the values of the given vector to this instance.
  3778. *
  3779. * @param {Vector3} v - The vector to copy.
  3780. * @return {Vector3} A reference to this vector.
  3781. */
  3782. copy( v ) {
  3783. this.x = v.x;
  3784. this.y = v.y;
  3785. this.z = v.z;
  3786. return this;
  3787. }
  3788. /**
  3789. * Adds the given vector to this instance.
  3790. *
  3791. * @param {Vector3} v - The vector to add.
  3792. * @return {Vector3} A reference to this vector.
  3793. */
  3794. add( v ) {
  3795. this.x += v.x;
  3796. this.y += v.y;
  3797. this.z += v.z;
  3798. return this;
  3799. }
  3800. /**
  3801. * Adds the given scalar value to all components of this instance.
  3802. *
  3803. * @param {number} s - The scalar to add.
  3804. * @return {Vector3} A reference to this vector.
  3805. */
  3806. addScalar( s ) {
  3807. this.x += s;
  3808. this.y += s;
  3809. this.z += s;
  3810. return this;
  3811. }
  3812. /**
  3813. * Adds the given vectors and stores the result in this instance.
  3814. *
  3815. * @param {Vector3} a - The first vector.
  3816. * @param {Vector3} b - The second vector.
  3817. * @return {Vector3} A reference to this vector.
  3818. */
  3819. addVectors( a, b ) {
  3820. this.x = a.x + b.x;
  3821. this.y = a.y + b.y;
  3822. this.z = a.z + b.z;
  3823. return this;
  3824. }
  3825. /**
  3826. * Adds the given vector scaled by the given factor to this instance.
  3827. *
  3828. * @param {Vector3|Vector4} v - The vector.
  3829. * @param {number} s - The factor that scales `v`.
  3830. * @return {Vector3} A reference to this vector.
  3831. */
  3832. addScaledVector( v, s ) {
  3833. this.x += v.x * s;
  3834. this.y += v.y * s;
  3835. this.z += v.z * s;
  3836. return this;
  3837. }
  3838. /**
  3839. * Subtracts the given vector from this instance.
  3840. *
  3841. * @param {Vector3} v - The vector to subtract.
  3842. * @return {Vector3} A reference to this vector.
  3843. */
  3844. sub( v ) {
  3845. this.x -= v.x;
  3846. this.y -= v.y;
  3847. this.z -= v.z;
  3848. return this;
  3849. }
  3850. /**
  3851. * Subtracts the given scalar value from all components of this instance.
  3852. *
  3853. * @param {number} s - The scalar to subtract.
  3854. * @return {Vector3} A reference to this vector.
  3855. */
  3856. subScalar( s ) {
  3857. this.x -= s;
  3858. this.y -= s;
  3859. this.z -= s;
  3860. return this;
  3861. }
  3862. /**
  3863. * Subtracts the given vectors and stores the result in this instance.
  3864. *
  3865. * @param {Vector3} a - The first vector.
  3866. * @param {Vector3} b - The second vector.
  3867. * @return {Vector3} A reference to this vector.
  3868. */
  3869. subVectors( a, b ) {
  3870. this.x = a.x - b.x;
  3871. this.y = a.y - b.y;
  3872. this.z = a.z - b.z;
  3873. return this;
  3874. }
  3875. /**
  3876. * Multiplies the given vector with this instance.
  3877. *
  3878. * @param {Vector3} v - The vector to multiply.
  3879. * @return {Vector3} A reference to this vector.
  3880. */
  3881. multiply( v ) {
  3882. this.x *= v.x;
  3883. this.y *= v.y;
  3884. this.z *= v.z;
  3885. return this;
  3886. }
  3887. /**
  3888. * Multiplies the given scalar value with all components of this instance.
  3889. *
  3890. * @param {number} scalar - The scalar to multiply.
  3891. * @return {Vector3} A reference to this vector.
  3892. */
  3893. multiplyScalar( scalar ) {
  3894. this.x *= scalar;
  3895. this.y *= scalar;
  3896. this.z *= scalar;
  3897. return this;
  3898. }
  3899. /**
  3900. * Multiplies the given vectors and stores the result in this instance.
  3901. *
  3902. * @param {Vector3} a - The first vector.
  3903. * @param {Vector3} b - The second vector.
  3904. * @return {Vector3} A reference to this vector.
  3905. */
  3906. multiplyVectors( a, b ) {
  3907. this.x = a.x * b.x;
  3908. this.y = a.y * b.y;
  3909. this.z = a.z * b.z;
  3910. return this;
  3911. }
  3912. /**
  3913. * Applies the given Euler rotation to this vector.
  3914. *
  3915. * @param {Euler} euler - The Euler angles.
  3916. * @return {Vector3} A reference to this vector.
  3917. */
  3918. applyEuler( euler ) {
  3919. return this.applyQuaternion( _quaternion$4.setFromEuler( euler ) );
  3920. }
  3921. /**
  3922. * Applies a rotation specified by an axis and an angle to this vector.
  3923. *
  3924. * @param {Vector3} axis - A normalized vector representing the rotation axis.
  3925. * @param {number} angle - The angle in radians.
  3926. * @return {Vector3} A reference to this vector.
  3927. */
  3928. applyAxisAngle( axis, angle ) {
  3929. return this.applyQuaternion( _quaternion$4.setFromAxisAngle( axis, angle ) );
  3930. }
  3931. /**
  3932. * Multiplies this vector with the given 3x3 matrix.
  3933. *
  3934. * @param {Matrix3} m - The 3x3 matrix.
  3935. * @return {Vector3} A reference to this vector.
  3936. */
  3937. applyMatrix3( m ) {
  3938. const x = this.x, y = this.y, z = this.z;
  3939. const e = m.elements;
  3940. this.x = e[ 0 ] * x + e[ 3 ] * y + e[ 6 ] * z;
  3941. this.y = e[ 1 ] * x + e[ 4 ] * y + e[ 7 ] * z;
  3942. this.z = e[ 2 ] * x + e[ 5 ] * y + e[ 8 ] * z;
  3943. return this;
  3944. }
  3945. /**
  3946. * Multiplies this vector by the given normal matrix and normalizes
  3947. * the result.
  3948. *
  3949. * @param {Matrix3} m - The normal matrix.
  3950. * @return {Vector3} A reference to this vector.
  3951. */
  3952. applyNormalMatrix( m ) {
  3953. return this.applyMatrix3( m ).normalize();
  3954. }
  3955. /**
  3956. * Multiplies this vector (with an implicit 1 in the 4th dimension) by m, and
  3957. * divides by perspective.
  3958. *
  3959. * @param {Matrix4} m - The matrix to apply.
  3960. * @return {Vector3} A reference to this vector.
  3961. */
  3962. applyMatrix4( m ) {
  3963. const x = this.x, y = this.y, z = this.z;
  3964. const e = m.elements;
  3965. const w = 1 / ( e[ 3 ] * x + e[ 7 ] * y + e[ 11 ] * z + e[ 15 ] );
  3966. this.x = ( e[ 0 ] * x + e[ 4 ] * y + e[ 8 ] * z + e[ 12 ] ) * w;
  3967. this.y = ( e[ 1 ] * x + e[ 5 ] * y + e[ 9 ] * z + e[ 13 ] ) * w;
  3968. this.z = ( e[ 2 ] * x + e[ 6 ] * y + e[ 10 ] * z + e[ 14 ] ) * w;
  3969. return this;
  3970. }
  3971. /**
  3972. * Applies the given Quaternion to this vector.
  3973. *
  3974. * @param {Quaternion} q - The Quaternion.
  3975. * @return {Vector3} A reference to this vector.
  3976. */
  3977. applyQuaternion( q ) {
  3978. // quaternion q is assumed to have unit length
  3979. const vx = this.x, vy = this.y, vz = this.z;
  3980. const qx = q.x, qy = q.y, qz = q.z, qw = q.w;
  3981. // t = 2 * cross( q.xyz, v );
  3982. const tx = 2 * ( qy * vz - qz * vy );
  3983. const ty = 2 * ( qz * vx - qx * vz );
  3984. const tz = 2 * ( qx * vy - qy * vx );
  3985. // v + q.w * t + cross( q.xyz, t );
  3986. this.x = vx + qw * tx + qy * tz - qz * ty;
  3987. this.y = vy + qw * ty + qz * tx - qx * tz;
  3988. this.z = vz + qw * tz + qx * ty - qy * tx;
  3989. return this;
  3990. }
  3991. /**
  3992. * Projects this vector from world space into the camera's normalized
  3993. * device coordinate (NDC) space.
  3994. *
  3995. * @param {Camera} camera - The camera.
  3996. * @return {Vector3} A reference to this vector.
  3997. */
  3998. project( camera ) {
  3999. return this.applyMatrix4( camera.matrixWorldInverse ).applyMatrix4( camera.projectionMatrix );
  4000. }
  4001. /**
  4002. * Unprojects this vector from the camera's normalized device coordinate (NDC)
  4003. * space into world space.
  4004. *
  4005. * @param {Camera} camera - The camera.
  4006. * @return {Vector3} A reference to this vector.
  4007. */
  4008. unproject( camera ) {
  4009. return this.applyMatrix4( camera.projectionMatrixInverse ).applyMatrix4( camera.matrixWorld );
  4010. }
  4011. /**
  4012. * Transforms the direction of this vector by a matrix (the upper left 3 x 3
  4013. * subset of the given 4x4 matrix and then normalizes the result.
  4014. *
  4015. * @param {Matrix4} m - The matrix.
  4016. * @return {Vector3} A reference to this vector.
  4017. */
  4018. transformDirection( m ) {
  4019. // input: THREE.Matrix4 affine matrix
  4020. // vector interpreted as a direction
  4021. const x = this.x, y = this.y, z = this.z;
  4022. const e = m.elements;
  4023. this.x = e[ 0 ] * x + e[ 4 ] * y + e[ 8 ] * z;
  4024. this.y = e[ 1 ] * x + e[ 5 ] * y + e[ 9 ] * z;
  4025. this.z = e[ 2 ] * x + e[ 6 ] * y + e[ 10 ] * z;
  4026. return this.normalize();
  4027. }
  4028. /**
  4029. * Divides this instance by the given vector.
  4030. *
  4031. * @param {Vector3} v - The vector to divide.
  4032. * @return {Vector3} A reference to this vector.
  4033. */
  4034. divide( v ) {
  4035. this.x /= v.x;
  4036. this.y /= v.y;
  4037. this.z /= v.z;
  4038. return this;
  4039. }
  4040. /**
  4041. * Divides this vector by the given scalar.
  4042. *
  4043. * @param {number} scalar - The scalar to divide.
  4044. * @return {Vector3} A reference to this vector.
  4045. */
  4046. divideScalar( scalar ) {
  4047. return this.multiplyScalar( 1 / scalar );
  4048. }
  4049. /**
  4050. * If this vector's x, y or z value is greater than the given vector's x, y or z
  4051. * value, replace that value with the corresponding min value.
  4052. *
  4053. * @param {Vector3} v - The vector.
  4054. * @return {Vector3} A reference to this vector.
  4055. */
  4056. min( v ) {
  4057. this.x = Math.min( this.x, v.x );
  4058. this.y = Math.min( this.y, v.y );
  4059. this.z = Math.min( this.z, v.z );
  4060. return this;
  4061. }
  4062. /**
  4063. * If this vector's x, y or z value is less than the given vector's x, y or z
  4064. * value, replace that value with the corresponding max value.
  4065. *
  4066. * @param {Vector3} v - The vector.
  4067. * @return {Vector3} A reference to this vector.
  4068. */
  4069. max( v ) {
  4070. this.x = Math.max( this.x, v.x );
  4071. this.y = Math.max( this.y, v.y );
  4072. this.z = Math.max( this.z, v.z );
  4073. return this;
  4074. }
  4075. /**
  4076. * If this vector's x, y or z value is greater than the max vector's x, y or z
  4077. * value, it is replaced by the corresponding value.
  4078. * If this vector's x, y or z value is less than the min vector's x, y or z value,
  4079. * it is replaced by the corresponding value.
  4080. *
  4081. * @param {Vector3} min - The minimum x, y and z values.
  4082. * @param {Vector3} max - The maximum x, y and z values in the desired range.
  4083. * @return {Vector3} A reference to this vector.
  4084. */
  4085. clamp( min, max ) {
  4086. // assumes min < max, componentwise
  4087. this.x = clamp( this.x, min.x, max.x );
  4088. this.y = clamp( this.y, min.y, max.y );
  4089. this.z = clamp( this.z, min.z, max.z );
  4090. return this;
  4091. }
  4092. /**
  4093. * If this vector's x, y or z values are greater than the max value, they are
  4094. * replaced by the max value.
  4095. * If this vector's x, y or z values are less than the min value, they are
  4096. * replaced by the min value.
  4097. *
  4098. * @param {number} minVal - The minimum value the components will be clamped to.
  4099. * @param {number} maxVal - The maximum value the components will be clamped to.
  4100. * @return {Vector3} A reference to this vector.
  4101. */
  4102. clampScalar( minVal, maxVal ) {
  4103. this.x = clamp( this.x, minVal, maxVal );
  4104. this.y = clamp( this.y, minVal, maxVal );
  4105. this.z = clamp( this.z, minVal, maxVal );
  4106. return this;
  4107. }
  4108. /**
  4109. * If this vector's length is greater than the max value, it is replaced by
  4110. * the max value.
  4111. * If this vector's length is less than the min value, it is replaced by the
  4112. * min value.
  4113. *
  4114. * @param {number} min - The minimum value the vector length will be clamped to.
  4115. * @param {number} max - The maximum value the vector length will be clamped to.
  4116. * @return {Vector3} A reference to this vector.
  4117. */
  4118. clampLength( min, max ) {
  4119. const length = this.length();
  4120. return this.divideScalar( length || 1 ).multiplyScalar( clamp( length, min, max ) );
  4121. }
  4122. /**
  4123. * The components of this vector are rounded down to the nearest integer value.
  4124. *
  4125. * @return {Vector3} A reference to this vector.
  4126. */
  4127. floor() {
  4128. this.x = Math.floor( this.x );
  4129. this.y = Math.floor( this.y );
  4130. this.z = Math.floor( this.z );
  4131. return this;
  4132. }
  4133. /**
  4134. * The components of this vector are rounded up to the nearest integer value.
  4135. *
  4136. * @return {Vector3} A reference to this vector.
  4137. */
  4138. ceil() {
  4139. this.x = Math.ceil( this.x );
  4140. this.y = Math.ceil( this.y );
  4141. this.z = Math.ceil( this.z );
  4142. return this;
  4143. }
  4144. /**
  4145. * The components of this vector are rounded to the nearest integer value
  4146. *
  4147. * @return {Vector3} A reference to this vector.
  4148. */
  4149. round() {
  4150. this.x = Math.round( this.x );
  4151. this.y = Math.round( this.y );
  4152. this.z = Math.round( this.z );
  4153. return this;
  4154. }
  4155. /**
  4156. * The components of this vector are rounded towards zero (up if negative,
  4157. * down if positive) to an integer value.
  4158. *
  4159. * @return {Vector3} A reference to this vector.
  4160. */
  4161. roundToZero() {
  4162. this.x = Math.trunc( this.x );
  4163. this.y = Math.trunc( this.y );
  4164. this.z = Math.trunc( this.z );
  4165. return this;
  4166. }
  4167. /**
  4168. * Inverts this vector - i.e. sets x = -x, y = -y and z = -z.
  4169. *
  4170. * @return {Vector3} A reference to this vector.
  4171. */
  4172. negate() {
  4173. this.x = - this.x;
  4174. this.y = - this.y;
  4175. this.z = - this.z;
  4176. return this;
  4177. }
  4178. /**
  4179. * Calculates the dot product of the given vector with this instance.
  4180. *
  4181. * @param {Vector3} v - The vector to compute the dot product with.
  4182. * @return {number} The result of the dot product.
  4183. */
  4184. dot( v ) {
  4185. return this.x * v.x + this.y * v.y + this.z * v.z;
  4186. }
  4187. /**
  4188. * Computes the square of the Euclidean length (straight-line length) from
  4189. * (0, 0, 0) to (x, y, z). If you are comparing the lengths of vectors, you should
  4190. * compare the length squared instead as it is slightly more efficient to calculate.
  4191. *
  4192. * @return {number} The square length of this vector.
  4193. */
  4194. lengthSq() {
  4195. return this.x * this.x + this.y * this.y + this.z * this.z;
  4196. }
  4197. /**
  4198. * Computes the Euclidean length (straight-line length) from (0, 0, 0) to (x, y, z).
  4199. *
  4200. * @return {number} The length of this vector.
  4201. */
  4202. length() {
  4203. return Math.sqrt( this.x * this.x + this.y * this.y + this.z * this.z );
  4204. }
  4205. /**
  4206. * Computes the Manhattan length of this vector.
  4207. *
  4208. * @return {number} The length of this vector.
  4209. */
  4210. manhattanLength() {
  4211. return Math.abs( this.x ) + Math.abs( this.y ) + Math.abs( this.z );
  4212. }
  4213. /**
  4214. * Converts this vector to a unit vector - that is, sets it equal to a vector
  4215. * with the same direction as this one, but with a vector length of `1`.
  4216. *
  4217. * @return {Vector3} A reference to this vector.
  4218. */
  4219. normalize() {
  4220. return this.divideScalar( this.length() || 1 );
  4221. }
  4222. /**
  4223. * Sets this vector to a vector with the same direction as this one, but
  4224. * with the specified length.
  4225. *
  4226. * @param {number} length - The new length of this vector.
  4227. * @return {Vector3} A reference to this vector.
  4228. */
  4229. setLength( length ) {
  4230. return this.normalize().multiplyScalar( length );
  4231. }
  4232. /**
  4233. * Linearly interpolates between the given vector and this instance, where
  4234. * alpha is the percent distance along the line - alpha = 0 will be this
  4235. * vector, and alpha = 1 will be the given one.
  4236. *
  4237. * @param {Vector3} v - The vector to interpolate towards.
  4238. * @param {number} alpha - The interpolation factor, typically in the closed interval `[0, 1]`.
  4239. * @return {Vector3} A reference to this vector.
  4240. */
  4241. lerp( v, alpha ) {
  4242. this.x += ( v.x - this.x ) * alpha;
  4243. this.y += ( v.y - this.y ) * alpha;
  4244. this.z += ( v.z - this.z ) * alpha;
  4245. return this;
  4246. }
  4247. /**
  4248. * Linearly interpolates between the given vectors, where alpha is the percent
  4249. * distance along the line - alpha = 0 will be first vector, and alpha = 1 will
  4250. * be the second one. The result is stored in this instance.
  4251. *
  4252. * @param {Vector3} v1 - The first vector.
  4253. * @param {Vector3} v2 - The second vector.
  4254. * @param {number} alpha - The interpolation factor, typically in the closed interval `[0, 1]`.
  4255. * @return {Vector3} A reference to this vector.
  4256. */
  4257. lerpVectors( v1, v2, alpha ) {
  4258. this.x = v1.x + ( v2.x - v1.x ) * alpha;
  4259. this.y = v1.y + ( v2.y - v1.y ) * alpha;
  4260. this.z = v1.z + ( v2.z - v1.z ) * alpha;
  4261. return this;
  4262. }
  4263. /**
  4264. * Calculates the cross product of the given vector with this instance.
  4265. *
  4266. * @param {Vector3} v - The vector to compute the cross product with.
  4267. * @return {Vector3} The result of the cross product.
  4268. */
  4269. cross( v ) {
  4270. return this.crossVectors( this, v );
  4271. }
  4272. /**
  4273. * Calculates the cross product of the given vectors and stores the result
  4274. * in this instance.
  4275. *
  4276. * @param {Vector3} a - The first vector.
  4277. * @param {Vector3} b - The second vector.
  4278. * @return {Vector3} A reference to this vector.
  4279. */
  4280. crossVectors( a, b ) {
  4281. const ax = a.x, ay = a.y, az = a.z;
  4282. const bx = b.x, by = b.y, bz = b.z;
  4283. this.x = ay * bz - az * by;
  4284. this.y = az * bx - ax * bz;
  4285. this.z = ax * by - ay * bx;
  4286. return this;
  4287. }
  4288. /**
  4289. * Projects this vector onto the given one.
  4290. *
  4291. * @param {Vector3} v - The vector to project to.
  4292. * @return {Vector3} A reference to this vector.
  4293. */
  4294. projectOnVector( v ) {
  4295. const denominator = v.lengthSq();
  4296. if ( denominator === 0 ) return this.set( 0, 0, 0 );
  4297. const scalar = v.dot( this ) / denominator;
  4298. return this.copy( v ).multiplyScalar( scalar );
  4299. }
  4300. /**
  4301. * Projects this vector onto a plane by subtracting this
  4302. * vector projected onto the plane's normal from this vector.
  4303. *
  4304. * @param {Vector3} planeNormal - The plane normal.
  4305. * @return {Vector3} A reference to this vector.
  4306. */
  4307. projectOnPlane( planeNormal ) {
  4308. _vector$c.copy( this ).projectOnVector( planeNormal );
  4309. return this.sub( _vector$c );
  4310. }
  4311. /**
  4312. * Reflects this vector off a plane orthogonal to the given normal vector.
  4313. *
  4314. * @param {Vector3} normal - The (normalized) normal vector.
  4315. * @return {Vector3} A reference to this vector.
  4316. */
  4317. reflect( normal ) {
  4318. return this.sub( _vector$c.copy( normal ).multiplyScalar( 2 * this.dot( normal ) ) );
  4319. }
  4320. /**
  4321. * Returns the angle between the given vector and this instance in radians.
  4322. *
  4323. * @param {Vector3} v - The vector to compute the angle with.
  4324. * @return {number} The angle in radians.
  4325. */
  4326. angleTo( v ) {
  4327. const denominator = Math.sqrt( this.lengthSq() * v.lengthSq() );
  4328. if ( denominator === 0 ) return Math.PI / 2;
  4329. const theta = this.dot( v ) / denominator;
  4330. // clamp, to handle numerical problems
  4331. return Math.acos( clamp( theta, -1, 1 ) );
  4332. }
  4333. /**
  4334. * Computes the distance from the given vector to this instance.
  4335. *
  4336. * @param {Vector3} v - The vector to compute the distance to.
  4337. * @return {number} The distance.
  4338. */
  4339. distanceTo( v ) {
  4340. return Math.sqrt( this.distanceToSquared( v ) );
  4341. }
  4342. /**
  4343. * Computes the squared distance from the given vector to this instance.
  4344. * If you are just comparing the distance with another distance, you should compare
  4345. * the distance squared instead as it is slightly more efficient to calculate.
  4346. *
  4347. * @param {Vector3} v - The vector to compute the squared distance to.
  4348. * @return {number} The squared distance.
  4349. */
  4350. distanceToSquared( v ) {
  4351. const dx = this.x - v.x, dy = this.y - v.y, dz = this.z - v.z;
  4352. return dx * dx + dy * dy + dz * dz;
  4353. }
  4354. /**
  4355. * Computes the Manhattan distance from the given vector to this instance.
  4356. *
  4357. * @param {Vector3} v - The vector to compute the Manhattan distance to.
  4358. * @return {number} The Manhattan distance.
  4359. */
  4360. manhattanDistanceTo( v ) {
  4361. return Math.abs( this.x - v.x ) + Math.abs( this.y - v.y ) + Math.abs( this.z - v.z );
  4362. }
  4363. /**
  4364. * Sets the vector components from the given spherical coordinates.
  4365. *
  4366. * @param {Spherical} s - The spherical coordinates.
  4367. * @return {Vector3} A reference to this vector.
  4368. */
  4369. setFromSpherical( s ) {
  4370. return this.setFromSphericalCoords( s.radius, s.phi, s.theta );
  4371. }
  4372. /**
  4373. * Sets the vector components from the given spherical coordinates.
  4374. *
  4375. * @param {number} radius - The radius.
  4376. * @param {number} phi - The phi angle in radians.
  4377. * @param {number} theta - The theta angle in radians.
  4378. * @return {Vector3} A reference to this vector.
  4379. */
  4380. setFromSphericalCoords( radius, phi, theta ) {
  4381. const sinPhiRadius = Math.sin( phi ) * radius;
  4382. this.x = sinPhiRadius * Math.sin( theta );
  4383. this.y = Math.cos( phi ) * radius;
  4384. this.z = sinPhiRadius * Math.cos( theta );
  4385. return this;
  4386. }
  4387. /**
  4388. * Sets the vector components from the given cylindrical coordinates.
  4389. *
  4390. * @param {Cylindrical} c - The cylindrical coordinates.
  4391. * @return {Vector3} A reference to this vector.
  4392. */
  4393. setFromCylindrical( c ) {
  4394. return this.setFromCylindricalCoords( c.radius, c.theta, c.y );
  4395. }
  4396. /**
  4397. * Sets the vector components from the given cylindrical coordinates.
  4398. *
  4399. * @param {number} radius - The radius.
  4400. * @param {number} theta - The theta angle in radians.
  4401. * @param {number} y - The y value.
  4402. * @return {Vector3} A reference to this vector.
  4403. */
  4404. setFromCylindricalCoords( radius, theta, y ) {
  4405. this.x = radius * Math.sin( theta );
  4406. this.y = y;
  4407. this.z = radius * Math.cos( theta );
  4408. return this;
  4409. }
  4410. /**
  4411. * Sets the vector components to the position elements of the
  4412. * given transformation matrix.
  4413. *
  4414. * @param {Matrix4} m - The 4x4 matrix.
  4415. * @return {Vector3} A reference to this vector.
  4416. */
  4417. setFromMatrixPosition( m ) {
  4418. const e = m.elements;
  4419. this.x = e[ 12 ];
  4420. this.y = e[ 13 ];
  4421. this.z = e[ 14 ];
  4422. return this;
  4423. }
  4424. /**
  4425. * Sets the vector components to the scale elements of the
  4426. * given transformation matrix.
  4427. *
  4428. * @param {Matrix4} m - The 4x4 matrix.
  4429. * @return {Vector3} A reference to this vector.
  4430. */
  4431. setFromMatrixScale( m ) {
  4432. const sx = this.setFromMatrixColumn( m, 0 ).length();
  4433. const sy = this.setFromMatrixColumn( m, 1 ).length();
  4434. const sz = this.setFromMatrixColumn( m, 2 ).length();
  4435. this.x = sx;
  4436. this.y = sy;
  4437. this.z = sz;
  4438. return this;
  4439. }
  4440. /**
  4441. * Sets the vector components from the specified matrix column.
  4442. *
  4443. * @param {Matrix4} m - The 4x4 matrix.
  4444. * @param {number} index - The column index.
  4445. * @return {Vector3} A reference to this vector.
  4446. */
  4447. setFromMatrixColumn( m, index ) {
  4448. return this.fromArray( m.elements, index * 4 );
  4449. }
  4450. /**
  4451. * Sets the vector components from the specified matrix column.
  4452. *
  4453. * @param {Matrix3} m - The 3x3 matrix.
  4454. * @param {number} index - The column index.
  4455. * @return {Vector3} A reference to this vector.
  4456. */
  4457. setFromMatrix3Column( m, index ) {
  4458. return this.fromArray( m.elements, index * 3 );
  4459. }
  4460. /**
  4461. * Sets the vector components from the given Euler angles.
  4462. *
  4463. * @param {Euler} e - The Euler angles to set.
  4464. * @return {Vector3} A reference to this vector.
  4465. */
  4466. setFromEuler( e ) {
  4467. this.x = e._x;
  4468. this.y = e._y;
  4469. this.z = e._z;
  4470. return this;
  4471. }
  4472. /**
  4473. * Sets the vector components from the RGB components of the
  4474. * given color.
  4475. *
  4476. * @param {Color} c - The color to set.
  4477. * @return {Vector3} A reference to this vector.
  4478. */
  4479. setFromColor( c ) {
  4480. this.x = c.r;
  4481. this.y = c.g;
  4482. this.z = c.b;
  4483. return this;
  4484. }
  4485. /**
  4486. * Returns `true` if this vector is equal with the given one.
  4487. *
  4488. * @param {Vector3} v - The vector to test for equality.
  4489. * @return {boolean} Whether this vector is equal with the given one.
  4490. */
  4491. equals( v ) {
  4492. return ( ( v.x === this.x ) && ( v.y === this.y ) && ( v.z === this.z ) );
  4493. }
  4494. /**
  4495. * Sets this vector's x value to be `array[ offset ]`, y value to be `array[ offset + 1 ]`
  4496. * and z value to be `array[ offset + 2 ]`.
  4497. *
  4498. * @param {Array<number>} array - An array holding the vector component values.
  4499. * @param {number} [offset=0] - The offset into the array.
  4500. * @return {Vector3} A reference to this vector.
  4501. */
  4502. fromArray( array, offset = 0 ) {
  4503. this.x = array[ offset ];
  4504. this.y = array[ offset + 1 ];
  4505. this.z = array[ offset + 2 ];
  4506. return this;
  4507. }
  4508. /**
  4509. * Writes the components of this vector to the given array. If no array is provided,
  4510. * the method returns a new instance.
  4511. *
  4512. * @param {Array<number>} [array=[]] - The target array holding the vector components.
  4513. * @param {number} [offset=0] - Index of the first element in the array.
  4514. * @return {Array<number>} The vector components.
  4515. */
  4516. toArray( array = [], offset = 0 ) {
  4517. array[ offset ] = this.x;
  4518. array[ offset + 1 ] = this.y;
  4519. array[ offset + 2 ] = this.z;
  4520. return array;
  4521. }
  4522. /**
  4523. * Sets the components of this vector from the given buffer attribute.
  4524. *
  4525. * @param {BufferAttribute} attribute - The buffer attribute holding vector data.
  4526. * @param {number} index - The index into the attribute.
  4527. * @return {Vector3} A reference to this vector.
  4528. */
  4529. fromBufferAttribute( attribute, index ) {
  4530. this.x = attribute.getX( index );
  4531. this.y = attribute.getY( index );
  4532. this.z = attribute.getZ( index );
  4533. return this;
  4534. }
  4535. /**
  4536. * Sets each component of this vector to a pseudo-random value between `0` and
  4537. * `1`, excluding `1`.
  4538. *
  4539. * @return {Vector3} A reference to this vector.
  4540. */
  4541. random() {
  4542. this.x = Math.random();
  4543. this.y = Math.random();
  4544. this.z = Math.random();
  4545. return this;
  4546. }
  4547. /**
  4548. * Sets this vector to a uniformly random point on a unit sphere.
  4549. *
  4550. * @return {Vector3} A reference to this vector.
  4551. */
  4552. randomDirection() {
  4553. // https://mathworld.wolfram.com/SpherePointPicking.html
  4554. const theta = Math.random() * Math.PI * 2;
  4555. const u = Math.random() * 2 - 1;
  4556. const c = Math.sqrt( 1 - u * u );
  4557. this.x = c * Math.cos( theta );
  4558. this.y = u;
  4559. this.z = c * Math.sin( theta );
  4560. return this;
  4561. }
  4562. *[ Symbol.iterator ]() {
  4563. yield this.x;
  4564. yield this.y;
  4565. yield this.z;
  4566. }
  4567. }
  4568. const _vector$c = /*@__PURE__*/ new Vector3();
  4569. const _quaternion$4 = /*@__PURE__*/ new Quaternion();
  4570. /**
  4571. * Represents a 3x3 matrix.
  4572. *
  4573. * A Note on Row-Major and Column-Major Ordering:
  4574. *
  4575. * The constructor and {@link Matrix3#set} method take arguments in
  4576. * [row-major](https://en.wikipedia.org/wiki/Row-_and_column-major_order#Column-major_order)
  4577. * order, while internally they are stored in the {@link Matrix3#elements} array in column-major order.
  4578. * This means that calling:
  4579. * ```js
  4580. * const m = new THREE.Matrix();
  4581. * m.set( 11, 12, 13,
  4582. * 21, 22, 23,
  4583. * 31, 32, 33 );
  4584. * ```
  4585. * will result in the elements array containing:
  4586. * ```js
  4587. * m.elements = [ 11, 21, 31,
  4588. * 12, 22, 32,
  4589. * 13, 23, 33 ];
  4590. * ```
  4591. * and internally all calculations are performed using column-major ordering.
  4592. * However, as the actual ordering makes no difference mathematically and
  4593. * most people are used to thinking about matrices in row-major order, the
  4594. * three.js documentation shows matrices in row-major order. Just bear in
  4595. * mind that if you are reading the source code, you'll have to take the
  4596. * transpose of any matrices outlined here to make sense of the calculations.
  4597. */
  4598. class Matrix3 {
  4599. /**
  4600. * Constructs a new 3x3 matrix. The arguments are supposed to be
  4601. * in row-major order. If no arguments are provided, the constructor
  4602. * initializes the matrix as an identity matrix.
  4603. *
  4604. * @param {number} [n11] - 1-1 matrix element.
  4605. * @param {number} [n12] - 1-2 matrix element.
  4606. * @param {number} [n13] - 1-3 matrix element.
  4607. * @param {number} [n21] - 2-1 matrix element.
  4608. * @param {number} [n22] - 2-2 matrix element.
  4609. * @param {number} [n23] - 2-3 matrix element.
  4610. * @param {number} [n31] - 3-1 matrix element.
  4611. * @param {number} [n32] - 3-2 matrix element.
  4612. * @param {number} [n33] - 3-3 matrix element.
  4613. */
  4614. constructor( n11, n12, n13, n21, n22, n23, n31, n32, n33 ) {
  4615. /**
  4616. * This flag can be used for type testing.
  4617. *
  4618. * @type {boolean}
  4619. * @readonly
  4620. * @default true
  4621. */
  4622. Matrix3.prototype.isMatrix3 = true;
  4623. /**
  4624. * A column-major list of matrix values.
  4625. *
  4626. * @type {Array<number>}
  4627. */
  4628. this.elements = [
  4629. 1, 0, 0,
  4630. 0, 1, 0,
  4631. 0, 0, 1
  4632. ];
  4633. if ( n11 !== undefined ) {
  4634. this.set( n11, n12, n13, n21, n22, n23, n31, n32, n33 );
  4635. }
  4636. }
  4637. /**
  4638. * Sets the elements of the matrix.The arguments are supposed to be
  4639. * in row-major order.
  4640. *
  4641. * @param {number} [n11] - 1-1 matrix element.
  4642. * @param {number} [n12] - 1-2 matrix element.
  4643. * @param {number} [n13] - 1-3 matrix element.
  4644. * @param {number} [n21] - 2-1 matrix element.
  4645. * @param {number} [n22] - 2-2 matrix element.
  4646. * @param {number} [n23] - 2-3 matrix element.
  4647. * @param {number} [n31] - 3-1 matrix element.
  4648. * @param {number} [n32] - 3-2 matrix element.
  4649. * @param {number} [n33] - 3-3 matrix element.
  4650. * @return {Matrix3} A reference to this matrix.
  4651. */
  4652. set( n11, n12, n13, n21, n22, n23, n31, n32, n33 ) {
  4653. const te = this.elements;
  4654. te[ 0 ] = n11; te[ 1 ] = n21; te[ 2 ] = n31;
  4655. te[ 3 ] = n12; te[ 4 ] = n22; te[ 5 ] = n32;
  4656. te[ 6 ] = n13; te[ 7 ] = n23; te[ 8 ] = n33;
  4657. return this;
  4658. }
  4659. /**
  4660. * Sets this matrix to the 3x3 identity matrix.
  4661. *
  4662. * @return {Matrix3} A reference to this matrix.
  4663. */
  4664. identity() {
  4665. this.set(
  4666. 1, 0, 0,
  4667. 0, 1, 0,
  4668. 0, 0, 1
  4669. );
  4670. return this;
  4671. }
  4672. /**
  4673. * Copies the values of the given matrix to this instance.
  4674. *
  4675. * @param {Matrix3} m - The matrix to copy.
  4676. * @return {Matrix3} A reference to this matrix.
  4677. */
  4678. copy( m ) {
  4679. const te = this.elements;
  4680. const me = m.elements;
  4681. te[ 0 ] = me[ 0 ]; te[ 1 ] = me[ 1 ]; te[ 2 ] = me[ 2 ];
  4682. te[ 3 ] = me[ 3 ]; te[ 4 ] = me[ 4 ]; te[ 5 ] = me[ 5 ];
  4683. te[ 6 ] = me[ 6 ]; te[ 7 ] = me[ 7 ]; te[ 8 ] = me[ 8 ];
  4684. return this;
  4685. }
  4686. /**
  4687. * Extracts the basis of this matrix into the three axis vectors provided.
  4688. *
  4689. * @param {Vector3} xAxis - The basis's x axis.
  4690. * @param {Vector3} yAxis - The basis's y axis.
  4691. * @param {Vector3} zAxis - The basis's z axis.
  4692. * @return {Matrix3} A reference to this matrix.
  4693. */
  4694. extractBasis( xAxis, yAxis, zAxis ) {
  4695. xAxis.setFromMatrix3Column( this, 0 );
  4696. yAxis.setFromMatrix3Column( this, 1 );
  4697. zAxis.setFromMatrix3Column( this, 2 );
  4698. return this;
  4699. }
  4700. /**
  4701. * Set this matrix to the upper 3x3 matrix of the given 4x4 matrix.
  4702. *
  4703. * @param {Matrix4} m - The 4x4 matrix.
  4704. * @return {Matrix3} A reference to this matrix.
  4705. */
  4706. setFromMatrix4( m ) {
  4707. const me = m.elements;
  4708. this.set(
  4709. me[ 0 ], me[ 4 ], me[ 8 ],
  4710. me[ 1 ], me[ 5 ], me[ 9 ],
  4711. me[ 2 ], me[ 6 ], me[ 10 ]
  4712. );
  4713. return this;
  4714. }
  4715. /**
  4716. * Post-multiplies this matrix by the given 3x3 matrix.
  4717. *
  4718. * @param {Matrix3} m - The matrix to multiply with.
  4719. * @return {Matrix3} A reference to this matrix.
  4720. */
  4721. multiply( m ) {
  4722. return this.multiplyMatrices( this, m );
  4723. }
  4724. /**
  4725. * Pre-multiplies this matrix by the given 3x3 matrix.
  4726. *
  4727. * @param {Matrix3} m - The matrix to multiply with.
  4728. * @return {Matrix3} A reference to this matrix.
  4729. */
  4730. premultiply( m ) {
  4731. return this.multiplyMatrices( m, this );
  4732. }
  4733. /**
  4734. * Multiples the given 3x3 matrices and stores the result
  4735. * in this matrix.
  4736. *
  4737. * @param {Matrix3} a - The first matrix.
  4738. * @param {Matrix3} b - The second matrix.
  4739. * @return {Matrix3} A reference to this matrix.
  4740. */
  4741. multiplyMatrices( a, b ) {
  4742. const ae = a.elements;
  4743. const be = b.elements;
  4744. const te = this.elements;
  4745. const a11 = ae[ 0 ], a12 = ae[ 3 ], a13 = ae[ 6 ];
  4746. const a21 = ae[ 1 ], a22 = ae[ 4 ], a23 = ae[ 7 ];
  4747. const a31 = ae[ 2 ], a32 = ae[ 5 ], a33 = ae[ 8 ];
  4748. const b11 = be[ 0 ], b12 = be[ 3 ], b13 = be[ 6 ];
  4749. const b21 = be[ 1 ], b22 = be[ 4 ], b23 = be[ 7 ];
  4750. const b31 = be[ 2 ], b32 = be[ 5 ], b33 = be[ 8 ];
  4751. te[ 0 ] = a11 * b11 + a12 * b21 + a13 * b31;
  4752. te[ 3 ] = a11 * b12 + a12 * b22 + a13 * b32;
  4753. te[ 6 ] = a11 * b13 + a12 * b23 + a13 * b33;
  4754. te[ 1 ] = a21 * b11 + a22 * b21 + a23 * b31;
  4755. te[ 4 ] = a21 * b12 + a22 * b22 + a23 * b32;
  4756. te[ 7 ] = a21 * b13 + a22 * b23 + a23 * b33;
  4757. te[ 2 ] = a31 * b11 + a32 * b21 + a33 * b31;
  4758. te[ 5 ] = a31 * b12 + a32 * b22 + a33 * b32;
  4759. te[ 8 ] = a31 * b13 + a32 * b23 + a33 * b33;
  4760. return this;
  4761. }
  4762. /**
  4763. * Multiplies every component of the matrix by the given scalar.
  4764. *
  4765. * @param {number} s - The scalar.
  4766. * @return {Matrix3} A reference to this matrix.
  4767. */
  4768. multiplyScalar( s ) {
  4769. const te = this.elements;
  4770. te[ 0 ] *= s; te[ 3 ] *= s; te[ 6 ] *= s;
  4771. te[ 1 ] *= s; te[ 4 ] *= s; te[ 7 ] *= s;
  4772. te[ 2 ] *= s; te[ 5 ] *= s; te[ 8 ] *= s;
  4773. return this;
  4774. }
  4775. /**
  4776. * Computes and returns the determinant of this matrix.
  4777. *
  4778. * @return {number} The determinant.
  4779. */
  4780. determinant() {
  4781. const te = this.elements;
  4782. const a = te[ 0 ], b = te[ 1 ], c = te[ 2 ],
  4783. d = te[ 3 ], e = te[ 4 ], f = te[ 5 ],
  4784. g = te[ 6 ], h = te[ 7 ], i = te[ 8 ];
  4785. return a * e * i - a * f * h - b * d * i + b * f * g + c * d * h - c * e * g;
  4786. }
  4787. /**
  4788. * Inverts this matrix, using the [analytic method](https://en.wikipedia.org/wiki/Invertible_matrix#Analytic_solution).
  4789. * You can not invert with a determinant of zero. If you attempt this, the method produces
  4790. * a zero matrix instead.
  4791. *
  4792. * @return {Matrix3} A reference to this matrix.
  4793. */
  4794. invert() {
  4795. const te = this.elements,
  4796. n11 = te[ 0 ], n21 = te[ 1 ], n31 = te[ 2 ],
  4797. n12 = te[ 3 ], n22 = te[ 4 ], n32 = te[ 5 ],
  4798. n13 = te[ 6 ], n23 = te[ 7 ], n33 = te[ 8 ],
  4799. t11 = n33 * n22 - n32 * n23,
  4800. t12 = n32 * n13 - n33 * n12,
  4801. t13 = n23 * n12 - n22 * n13,
  4802. det = n11 * t11 + n21 * t12 + n31 * t13;
  4803. if ( det === 0 ) return this.set( 0, 0, 0, 0, 0, 0, 0, 0, 0 );
  4804. const detInv = 1 / det;
  4805. te[ 0 ] = t11 * detInv;
  4806. te[ 1 ] = ( n31 * n23 - n33 * n21 ) * detInv;
  4807. te[ 2 ] = ( n32 * n21 - n31 * n22 ) * detInv;
  4808. te[ 3 ] = t12 * detInv;
  4809. te[ 4 ] = ( n33 * n11 - n31 * n13 ) * detInv;
  4810. te[ 5 ] = ( n31 * n12 - n32 * n11 ) * detInv;
  4811. te[ 6 ] = t13 * detInv;
  4812. te[ 7 ] = ( n21 * n13 - n23 * n11 ) * detInv;
  4813. te[ 8 ] = ( n22 * n11 - n21 * n12 ) * detInv;
  4814. return this;
  4815. }
  4816. /**
  4817. * Transposes this matrix in place.
  4818. *
  4819. * @return {Matrix3} A reference to this matrix.
  4820. */
  4821. transpose() {
  4822. let tmp;
  4823. const m = this.elements;
  4824. tmp = m[ 1 ]; m[ 1 ] = m[ 3 ]; m[ 3 ] = tmp;
  4825. tmp = m[ 2 ]; m[ 2 ] = m[ 6 ]; m[ 6 ] = tmp;
  4826. tmp = m[ 5 ]; m[ 5 ] = m[ 7 ]; m[ 7 ] = tmp;
  4827. return this;
  4828. }
  4829. /**
  4830. * Computes the normal matrix which is the inverse transpose of the upper
  4831. * left 3x3 portion of the given 4x4 matrix.
  4832. *
  4833. * @param {Matrix4} matrix4 - The 4x4 matrix.
  4834. * @return {Matrix3} A reference to this matrix.
  4835. */
  4836. getNormalMatrix( matrix4 ) {
  4837. return this.setFromMatrix4( matrix4 ).invert().transpose();
  4838. }
  4839. /**
  4840. * Transposes this matrix into the supplied array, and returns itself unchanged.
  4841. *
  4842. * @param {Array<number>} r - An array to store the transposed matrix elements.
  4843. * @return {Matrix3} A reference to this matrix.
  4844. */
  4845. transposeIntoArray( r ) {
  4846. const m = this.elements;
  4847. r[ 0 ] = m[ 0 ];
  4848. r[ 1 ] = m[ 3 ];
  4849. r[ 2 ] = m[ 6 ];
  4850. r[ 3 ] = m[ 1 ];
  4851. r[ 4 ] = m[ 4 ];
  4852. r[ 5 ] = m[ 7 ];
  4853. r[ 6 ] = m[ 2 ];
  4854. r[ 7 ] = m[ 5 ];
  4855. r[ 8 ] = m[ 8 ];
  4856. return this;
  4857. }
  4858. /**
  4859. * Sets the UV transform matrix from offset, repeat, rotation, and center.
  4860. *
  4861. * @param {number} tx - Offset x.
  4862. * @param {number} ty - Offset y.
  4863. * @param {number} sx - Repeat x.
  4864. * @param {number} sy - Repeat y.
  4865. * @param {number} rotation - Rotation, in radians. Positive values rotate counterclockwise.
  4866. * @param {number} cx - Center x of rotation.
  4867. * @param {number} cy - Center y of rotation
  4868. * @return {Matrix3} A reference to this matrix.
  4869. */
  4870. setUvTransform( tx, ty, sx, sy, rotation, cx, cy ) {
  4871. const c = Math.cos( rotation );
  4872. const s = Math.sin( rotation );
  4873. this.set(
  4874. sx * c, sx * s, - sx * ( c * cx + s * cy ) + cx + tx,
  4875. - sy * s, sy * c, - sy * ( - s * cx + c * cy ) + cy + ty,
  4876. 0, 0, 1
  4877. );
  4878. return this;
  4879. }
  4880. /**
  4881. * Scales this matrix with the given scalar values.
  4882. *
  4883. * @param {number} sx - The amount to scale in the X axis.
  4884. * @param {number} sy - The amount to scale in the Y axis.
  4885. * @return {Matrix3} A reference to this matrix.
  4886. */
  4887. scale( sx, sy ) {
  4888. this.premultiply( _m3.makeScale( sx, sy ) );
  4889. return this;
  4890. }
  4891. /**
  4892. * Rotates this matrix by the given angle.
  4893. *
  4894. * @param {number} theta - The rotation in radians.
  4895. * @return {Matrix3} A reference to this matrix.
  4896. */
  4897. rotate( theta ) {
  4898. this.premultiply( _m3.makeRotation( - theta ) );
  4899. return this;
  4900. }
  4901. /**
  4902. * Translates this matrix by the given scalar values.
  4903. *
  4904. * @param {number} tx - The amount to translate in the X axis.
  4905. * @param {number} ty - The amount to translate in the Y axis.
  4906. * @return {Matrix3} A reference to this matrix.
  4907. */
  4908. translate( tx, ty ) {
  4909. this.premultiply( _m3.makeTranslation( tx, ty ) );
  4910. return this;
  4911. }
  4912. // for 2D Transforms
  4913. /**
  4914. * Sets this matrix as a 2D translation transform.
  4915. *
  4916. * @param {number|Vector2} x - The amount to translate in the X axis or alternatively a translation vector.
  4917. * @param {number} y - The amount to translate in the Y axis.
  4918. * @return {Matrix3} A reference to this matrix.
  4919. */
  4920. makeTranslation( x, y ) {
  4921. if ( x.isVector2 ) {
  4922. this.set(
  4923. 1, 0, x.x,
  4924. 0, 1, x.y,
  4925. 0, 0, 1
  4926. );
  4927. } else {
  4928. this.set(
  4929. 1, 0, x,
  4930. 0, 1, y,
  4931. 0, 0, 1
  4932. );
  4933. }
  4934. return this;
  4935. }
  4936. /**
  4937. * Sets this matrix as a 2D rotational transformation.
  4938. *
  4939. * @param {number} theta - The rotation in radians.
  4940. * @return {Matrix3} A reference to this matrix.
  4941. */
  4942. makeRotation( theta ) {
  4943. // counterclockwise
  4944. const c = Math.cos( theta );
  4945. const s = Math.sin( theta );
  4946. this.set(
  4947. c, - s, 0,
  4948. s, c, 0,
  4949. 0, 0, 1
  4950. );
  4951. return this;
  4952. }
  4953. /**
  4954. * Sets this matrix as a 2D scale transform.
  4955. *
  4956. * @param {number} x - The amount to scale in the X axis.
  4957. * @param {number} y - The amount to scale in the Y axis.
  4958. * @return {Matrix3} A reference to this matrix.
  4959. */
  4960. makeScale( x, y ) {
  4961. this.set(
  4962. x, 0, 0,
  4963. 0, y, 0,
  4964. 0, 0, 1
  4965. );
  4966. return this;
  4967. }
  4968. /**
  4969. * Returns `true` if this matrix is equal with the given one.
  4970. *
  4971. * @param {Matrix3} matrix - The matrix to test for equality.
  4972. * @return {boolean} Whether this matrix is equal with the given one.
  4973. */
  4974. equals( matrix ) {
  4975. const te = this.elements;
  4976. const me = matrix.elements;
  4977. for ( let i = 0; i < 9; i ++ ) {
  4978. if ( te[ i ] !== me[ i ] ) return false;
  4979. }
  4980. return true;
  4981. }
  4982. /**
  4983. * Sets the elements of the matrix from the given array.
  4984. *
  4985. * @param {Array<number>} array - The matrix elements in column-major order.
  4986. * @param {number} [offset=0] - Index of the first element in the array.
  4987. * @return {Matrix3} A reference to this matrix.
  4988. */
  4989. fromArray( array, offset = 0 ) {
  4990. for ( let i = 0; i < 9; i ++ ) {
  4991. this.elements[ i ] = array[ i + offset ];
  4992. }
  4993. return this;
  4994. }
  4995. /**
  4996. * Writes the elements of this matrix to the given array. If no array is provided,
  4997. * the method returns a new instance.
  4998. *
  4999. * @param {Array<number>} [array=[]] - The target array holding the matrix elements in column-major order.
  5000. * @param {number} [offset=0] - Index of the first element in the array.
  5001. * @return {Array<number>} The matrix elements in column-major order.
  5002. */
  5003. toArray( array = [], offset = 0 ) {
  5004. const te = this.elements;
  5005. array[ offset ] = te[ 0 ];
  5006. array[ offset + 1 ] = te[ 1 ];
  5007. array[ offset + 2 ] = te[ 2 ];
  5008. array[ offset + 3 ] = te[ 3 ];
  5009. array[ offset + 4 ] = te[ 4 ];
  5010. array[ offset + 5 ] = te[ 5 ];
  5011. array[ offset + 6 ] = te[ 6 ];
  5012. array[ offset + 7 ] = te[ 7 ];
  5013. array[ offset + 8 ] = te[ 8 ];
  5014. return array;
  5015. }
  5016. /**
  5017. * Returns a matrix with copied values from this instance.
  5018. *
  5019. * @return {Matrix3} A clone of this instance.
  5020. */
  5021. clone() {
  5022. return new this.constructor().fromArray( this.elements );
  5023. }
  5024. }
  5025. const _m3 = /*@__PURE__*/ new Matrix3();
  5026. const LINEAR_REC709_TO_XYZ = /*@__PURE__*/ new Matrix3().set(
  5027. 0.4123908, 0.3575843, 0.1804808,
  5028. 0.2126390, 0.7151687, 0.0721923,
  5029. 0.0193308, 0.1191948, 0.9505322
  5030. );
  5031. const XYZ_TO_LINEAR_REC709 = /*@__PURE__*/ new Matrix3().set(
  5032. 3.2409699, -1.5373832, -0.4986108,
  5033. -0.9692436, 1.8759675, 0.0415551,
  5034. 0.0556301, -0.203977, 1.0569715
  5035. );
  5036. function createColorManagement() {
  5037. const ColorManagement = {
  5038. enabled: true,
  5039. workingColorSpace: LinearSRGBColorSpace,
  5040. /**
  5041. * Implementations of supported color spaces.
  5042. *
  5043. * Required:
  5044. * - primaries: chromaticity coordinates [ rx ry gx gy bx by ]
  5045. * - whitePoint: reference white [ x y ]
  5046. * - transfer: transfer function (pre-defined)
  5047. * - toXYZ: Matrix3 RGB to XYZ transform
  5048. * - fromXYZ: Matrix3 XYZ to RGB transform
  5049. * - luminanceCoefficients: RGB luminance coefficients
  5050. *
  5051. * Optional:
  5052. * - outputColorSpaceConfig: { drawingBufferColorSpace: ColorSpace, toneMappingMode: 'extended' | 'standard' }
  5053. * - workingColorSpaceConfig: { unpackColorSpace: ColorSpace }
  5054. *
  5055. * Reference:
  5056. * - https://www.russellcottrell.com/photo/matrixCalculator.htm
  5057. */
  5058. spaces: {},
  5059. convert: function ( color, sourceColorSpace, targetColorSpace ) {
  5060. if ( this.enabled === false || sourceColorSpace === targetColorSpace || ! sourceColorSpace || ! targetColorSpace ) {
  5061. return color;
  5062. }
  5063. if ( this.spaces[ sourceColorSpace ].transfer === SRGBTransfer ) {
  5064. color.r = SRGBToLinear( color.r );
  5065. color.g = SRGBToLinear( color.g );
  5066. color.b = SRGBToLinear( color.b );
  5067. }
  5068. if ( this.spaces[ sourceColorSpace ].primaries !== this.spaces[ targetColorSpace ].primaries ) {
  5069. color.applyMatrix3( this.spaces[ sourceColorSpace ].toXYZ );
  5070. color.applyMatrix3( this.spaces[ targetColorSpace ].fromXYZ );
  5071. }
  5072. if ( this.spaces[ targetColorSpace ].transfer === SRGBTransfer ) {
  5073. color.r = LinearToSRGB( color.r );
  5074. color.g = LinearToSRGB( color.g );
  5075. color.b = LinearToSRGB( color.b );
  5076. }
  5077. return color;
  5078. },
  5079. workingToColorSpace: function ( color, targetColorSpace ) {
  5080. return this.convert( color, this.workingColorSpace, targetColorSpace );
  5081. },
  5082. colorSpaceToWorking: function ( color, sourceColorSpace ) {
  5083. return this.convert( color, sourceColorSpace, this.workingColorSpace );
  5084. },
  5085. getPrimaries: function ( colorSpace ) {
  5086. return this.spaces[ colorSpace ].primaries;
  5087. },
  5088. getTransfer: function ( colorSpace ) {
  5089. if ( colorSpace === NoColorSpace ) return LinearTransfer;
  5090. return this.spaces[ colorSpace ].transfer;
  5091. },
  5092. getToneMappingMode: function ( colorSpace ) {
  5093. return this.spaces[ colorSpace ].outputColorSpaceConfig.toneMappingMode || 'standard';
  5094. },
  5095. getLuminanceCoefficients: function ( target, colorSpace = this.workingColorSpace ) {
  5096. return target.fromArray( this.spaces[ colorSpace ].luminanceCoefficients );
  5097. },
  5098. define: function ( colorSpaces ) {
  5099. Object.assign( this.spaces, colorSpaces );
  5100. },
  5101. // Internal APIs
  5102. _getMatrix: function ( targetMatrix, sourceColorSpace, targetColorSpace ) {
  5103. return targetMatrix
  5104. .copy( this.spaces[ sourceColorSpace ].toXYZ )
  5105. .multiply( this.spaces[ targetColorSpace ].fromXYZ );
  5106. },
  5107. _getDrawingBufferColorSpace: function ( colorSpace ) {
  5108. return this.spaces[ colorSpace ].outputColorSpaceConfig.drawingBufferColorSpace;
  5109. },
  5110. _getUnpackColorSpace: function ( colorSpace = this.workingColorSpace ) {
  5111. return this.spaces[ colorSpace ].workingColorSpaceConfig.unpackColorSpace;
  5112. },
  5113. // Deprecated
  5114. fromWorkingColorSpace: function ( color, targetColorSpace ) {
  5115. warnOnce( 'ColorManagement: .fromWorkingColorSpace() has been renamed to .workingToColorSpace().' ); // @deprecated, r177
  5116. return ColorManagement.workingToColorSpace( color, targetColorSpace );
  5117. },
  5118. toWorkingColorSpace: function ( color, sourceColorSpace ) {
  5119. warnOnce( 'ColorManagement: .toWorkingColorSpace() has been renamed to .colorSpaceToWorking().' ); // @deprecated, r177
  5120. return ColorManagement.colorSpaceToWorking( color, sourceColorSpace );
  5121. },
  5122. };
  5123. /******************************************************************************
  5124. * sRGB definitions
  5125. */
  5126. const REC709_PRIMARIES = [ 0.640, 0.330, 0.300, 0.600, 0.150, 0.060 ];
  5127. const REC709_LUMINANCE_COEFFICIENTS = [ 0.2126, 0.7152, 0.0722 ];
  5128. const D65 = [ 0.3127, 0.3290 ];
  5129. ColorManagement.define( {
  5130. [ LinearSRGBColorSpace ]: {
  5131. primaries: REC709_PRIMARIES,
  5132. whitePoint: D65,
  5133. transfer: LinearTransfer,
  5134. toXYZ: LINEAR_REC709_TO_XYZ,
  5135. fromXYZ: XYZ_TO_LINEAR_REC709,
  5136. luminanceCoefficients: REC709_LUMINANCE_COEFFICIENTS,
  5137. workingColorSpaceConfig: { unpackColorSpace: SRGBColorSpace },
  5138. outputColorSpaceConfig: { drawingBufferColorSpace: SRGBColorSpace }
  5139. },
  5140. [ SRGBColorSpace ]: {
  5141. primaries: REC709_PRIMARIES,
  5142. whitePoint: D65,
  5143. transfer: SRGBTransfer,
  5144. toXYZ: LINEAR_REC709_TO_XYZ,
  5145. fromXYZ: XYZ_TO_LINEAR_REC709,
  5146. luminanceCoefficients: REC709_LUMINANCE_COEFFICIENTS,
  5147. outputColorSpaceConfig: { drawingBufferColorSpace: SRGBColorSpace }
  5148. },
  5149. } );
  5150. return ColorManagement;
  5151. }
  5152. const ColorManagement = /*@__PURE__*/ createColorManagement();
  5153. function SRGBToLinear( c ) {
  5154. return ( c < 0.04045 ) ? c * 0.0773993808 : Math.pow( c * 0.9478672986 + 0.0521327014, 2.4 );
  5155. }
  5156. function LinearToSRGB( c ) {
  5157. return ( c < 0.0031308 ) ? c * 12.92 : 1.055 * ( Math.pow( c, 0.41666 ) ) - 0.055;
  5158. }
  5159. let _canvas;
  5160. /**
  5161. * A class containing utility functions for images.
  5162. *
  5163. * @hideconstructor
  5164. */
  5165. class ImageUtils {
  5166. /**
  5167. * Returns a data URI containing a representation of the given image.
  5168. *
  5169. * @param {(HTMLImageElement|HTMLCanvasElement)} image - The image object.
  5170. * @param {string} [type='image/png'] - Indicates the image format.
  5171. * @return {string} The data URI.
  5172. */
  5173. static getDataURL( image, type = 'image/png' ) {
  5174. if ( /^data:/i.test( image.src ) ) {
  5175. return image.src;
  5176. }
  5177. if ( typeof HTMLCanvasElement === 'undefined' ) {
  5178. return image.src;
  5179. }
  5180. let canvas;
  5181. if ( image instanceof HTMLCanvasElement ) {
  5182. canvas = image;
  5183. } else {
  5184. if ( _canvas === undefined ) _canvas = createElementNS( 'canvas' );
  5185. _canvas.width = image.width;
  5186. _canvas.height = image.height;
  5187. const context = _canvas.getContext( '2d' );
  5188. if ( image instanceof ImageData ) {
  5189. context.putImageData( image, 0, 0 );
  5190. } else {
  5191. context.drawImage( image, 0, 0, image.width, image.height );
  5192. }
  5193. canvas = _canvas;
  5194. }
  5195. return canvas.toDataURL( type );
  5196. }
  5197. /**
  5198. * Converts the given sRGB image data to linear color space.
  5199. *
  5200. * @param {(HTMLImageElement|HTMLCanvasElement|ImageBitmap|Object)} image - The image object.
  5201. * @return {HTMLCanvasElement|Object} The converted image.
  5202. */
  5203. static sRGBToLinear( image ) {
  5204. if ( ( typeof HTMLImageElement !== 'undefined' && image instanceof HTMLImageElement ) ||
  5205. ( typeof HTMLCanvasElement !== 'undefined' && image instanceof HTMLCanvasElement ) ||
  5206. ( typeof ImageBitmap !== 'undefined' && image instanceof ImageBitmap ) ) {
  5207. const canvas = createElementNS( 'canvas' );
  5208. canvas.width = image.width;
  5209. canvas.height = image.height;
  5210. const context = canvas.getContext( '2d' );
  5211. context.drawImage( image, 0, 0, image.width, image.height );
  5212. const imageData = context.getImageData( 0, 0, image.width, image.height );
  5213. const data = imageData.data;
  5214. for ( let i = 0; i < data.length; i ++ ) {
  5215. data[ i ] = SRGBToLinear( data[ i ] / 255 ) * 255;
  5216. }
  5217. context.putImageData( imageData, 0, 0 );
  5218. return canvas;
  5219. } else if ( image.data ) {
  5220. const data = image.data.slice( 0 );
  5221. for ( let i = 0; i < data.length; i ++ ) {
  5222. if ( data instanceof Uint8Array || data instanceof Uint8ClampedArray ) {
  5223. data[ i ] = Math.floor( SRGBToLinear( data[ i ] / 255 ) * 255 );
  5224. } else {
  5225. // assuming float
  5226. data[ i ] = SRGBToLinear( data[ i ] );
  5227. }
  5228. }
  5229. return {
  5230. data: data,
  5231. width: image.width,
  5232. height: image.height
  5233. };
  5234. } else {
  5235. warn( 'ImageUtils.sRGBToLinear(): Unsupported image type. No color space conversion applied.' );
  5236. return image;
  5237. }
  5238. }
  5239. }
  5240. let _sourceId = 0;
  5241. /**
  5242. * Represents the data source of a texture.
  5243. *
  5244. * The main purpose of this class is to decouple the data definition from the texture
  5245. * definition so the same data can be used with multiple texture instances.
  5246. */
  5247. class Source {
  5248. /**
  5249. * Constructs a new video texture.
  5250. *
  5251. * @param {any} [data=null] - The data definition of a texture.
  5252. */
  5253. constructor( data = null ) {
  5254. /**
  5255. * This flag can be used for type testing.
  5256. *
  5257. * @type {boolean}
  5258. * @readonly
  5259. * @default true
  5260. */
  5261. this.isSource = true;
  5262. /**
  5263. * The ID of the source.
  5264. *
  5265. * @name Source#id
  5266. * @type {number}
  5267. * @readonly
  5268. */
  5269. Object.defineProperty( this, 'id', { value: _sourceId ++ } );
  5270. /**
  5271. * The UUID of the source.
  5272. *
  5273. * @type {string}
  5274. * @readonly
  5275. */
  5276. this.uuid = generateUUID();
  5277. /**
  5278. * The data definition of a texture.
  5279. *
  5280. * @type {any}
  5281. */
  5282. this.data = data;
  5283. /**
  5284. * This property is only relevant when {@link Source#needsUpdate} is set to `true` and
  5285. * provides more control on how texture data should be processed. When `dataReady` is set
  5286. * to `false`, the engine performs the memory allocation (if necessary) but does not transfer
  5287. * the data into the GPU memory.
  5288. *
  5289. * @type {boolean}
  5290. * @default true
  5291. */
  5292. this.dataReady = true;
  5293. /**
  5294. * This starts at `0` and counts how many times {@link Source#needsUpdate} is set to `true`.
  5295. *
  5296. * @type {number}
  5297. * @readonly
  5298. * @default 0
  5299. */
  5300. this.version = 0;
  5301. }
  5302. /**
  5303. * Returns the dimensions of the source into the given target vector.
  5304. *
  5305. * @param {(Vector2|Vector3)} target - The target object the result is written into.
  5306. * @return {(Vector2|Vector3)} The dimensions of the source.
  5307. */
  5308. getSize( target ) {
  5309. const data = this.data;
  5310. if ( ( typeof HTMLVideoElement !== 'undefined' ) && ( data instanceof HTMLVideoElement ) ) {
  5311. target.set( data.videoWidth, data.videoHeight, 0 );
  5312. } else if ( ( typeof VideoFrame !== 'undefined' ) && ( data instanceof VideoFrame ) ) {
  5313. target.set( data.displayHeight, data.displayWidth, 0 );
  5314. } else if ( data !== null ) {
  5315. target.set( data.width, data.height, data.depth || 0 );
  5316. } else {
  5317. target.set( 0, 0, 0 );
  5318. }
  5319. return target;
  5320. }
  5321. /**
  5322. * When the property is set to `true`, the engine allocates the memory
  5323. * for the texture (if necessary) and triggers the actual texture upload
  5324. * to the GPU next time the source is used.
  5325. *
  5326. * @type {boolean}
  5327. * @default false
  5328. * @param {boolean} value
  5329. */
  5330. set needsUpdate( value ) {
  5331. if ( value === true ) this.version ++;
  5332. }
  5333. /**
  5334. * Serializes the source into JSON.
  5335. *
  5336. * @param {?(Object|string)} meta - An optional value holding meta information about the serialization.
  5337. * @return {Object} A JSON object representing the serialized source.
  5338. * @see {@link ObjectLoader#parse}
  5339. */
  5340. toJSON( meta ) {
  5341. const isRootObject = ( meta === undefined || typeof meta === 'string' );
  5342. if ( ! isRootObject && meta.images[ this.uuid ] !== undefined ) {
  5343. return meta.images[ this.uuid ];
  5344. }
  5345. const output = {
  5346. uuid: this.uuid,
  5347. url: ''
  5348. };
  5349. const data = this.data;
  5350. if ( data !== null ) {
  5351. let url;
  5352. if ( Array.isArray( data ) ) {
  5353. // cube texture
  5354. url = [];
  5355. for ( let i = 0, l = data.length; i < l; i ++ ) {
  5356. if ( data[ i ].isDataTexture ) {
  5357. url.push( serializeImage( data[ i ].image ) );
  5358. } else {
  5359. url.push( serializeImage( data[ i ] ) );
  5360. }
  5361. }
  5362. } else {
  5363. // texture
  5364. url = serializeImage( data );
  5365. }
  5366. output.url = url;
  5367. }
  5368. if ( ! isRootObject ) {
  5369. meta.images[ this.uuid ] = output;
  5370. }
  5371. return output;
  5372. }
  5373. }
  5374. function serializeImage( image ) {
  5375. if ( ( typeof HTMLImageElement !== 'undefined' && image instanceof HTMLImageElement ) ||
  5376. ( typeof HTMLCanvasElement !== 'undefined' && image instanceof HTMLCanvasElement ) ||
  5377. ( typeof ImageBitmap !== 'undefined' && image instanceof ImageBitmap ) ) {
  5378. // default images
  5379. return ImageUtils.getDataURL( image );
  5380. } else {
  5381. if ( image.data ) {
  5382. // images of DataTexture
  5383. return {
  5384. data: Array.from( image.data ),
  5385. width: image.width,
  5386. height: image.height,
  5387. type: image.data.constructor.name
  5388. };
  5389. } else {
  5390. warn( 'Texture: Unable to serialize Texture.' );
  5391. return {};
  5392. }
  5393. }
  5394. }
  5395. let _textureId = 0;
  5396. const _tempVec3 = /*@__PURE__*/ new Vector3();
  5397. /**
  5398. * Base class for all textures.
  5399. *
  5400. * Note: After the initial use of a texture, its dimensions, format, and type
  5401. * cannot be changed. Instead, call {@link Texture#dispose} on the texture and instantiate a new one.
  5402. *
  5403. * @augments EventDispatcher
  5404. */
  5405. class Texture extends EventDispatcher {
  5406. /**
  5407. * Constructs a new texture.
  5408. *
  5409. * @param {?Object} [image=Texture.DEFAULT_IMAGE] - The image holding the texture data.
  5410. * @param {number} [mapping=Texture.DEFAULT_MAPPING] - The texture mapping.
  5411. * @param {number} [wrapS=ClampToEdgeWrapping] - The wrapS value.
  5412. * @param {number} [wrapT=ClampToEdgeWrapping] - The wrapT value.
  5413. * @param {number} [magFilter=LinearFilter] - The mag filter value.
  5414. * @param {number} [minFilter=LinearMipmapLinearFilter] - The min filter value.
  5415. * @param {number} [format=RGBAFormat] - The texture format.
  5416. * @param {number} [type=UnsignedByteType] - The texture type.
  5417. * @param {number} [anisotropy=Texture.DEFAULT_ANISOTROPY] - The anisotropy value.
  5418. * @param {string} [colorSpace=NoColorSpace] - The color space.
  5419. */
  5420. 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 ) {
  5421. super();
  5422. /**
  5423. * This flag can be used for type testing.
  5424. *
  5425. * @type {boolean}
  5426. * @readonly
  5427. * @default true
  5428. */
  5429. this.isTexture = true;
  5430. /**
  5431. * The ID of the texture.
  5432. *
  5433. * @name Texture#id
  5434. * @type {number}
  5435. * @readonly
  5436. */
  5437. Object.defineProperty( this, 'id', { value: _textureId ++ } );
  5438. /**
  5439. * The UUID of the texture.
  5440. *
  5441. * @type {string}
  5442. * @readonly
  5443. */
  5444. this.uuid = generateUUID();
  5445. /**
  5446. * The name of the texture.
  5447. *
  5448. * @type {string}
  5449. */
  5450. this.name = '';
  5451. /**
  5452. * The data definition of a texture. A reference to the data source can be
  5453. * shared across textures. This is often useful in context of spritesheets
  5454. * where multiple textures render the same data but with different texture
  5455. * transformations.
  5456. *
  5457. * @type {Source}
  5458. */
  5459. this.source = new Source( image );
  5460. /**
  5461. * An array holding user-defined mipmaps.
  5462. *
  5463. * @type {Array<Object>}
  5464. */
  5465. this.mipmaps = [];
  5466. /**
  5467. * How the texture is applied to the object. The value `UVMapping`
  5468. * is the default, where texture or uv coordinates are used to apply the map.
  5469. *
  5470. * @type {(UVMapping|CubeReflectionMapping|CubeRefractionMapping|EquirectangularReflectionMapping|EquirectangularRefractionMapping|CubeUVReflectionMapping)}
  5471. * @default UVMapping
  5472. */
  5473. this.mapping = mapping;
  5474. /**
  5475. * Lets you select the uv attribute to map the texture to. `0` for `uv`,
  5476. * `1` for `uv1`, `2` for `uv2` and `3` for `uv3`.
  5477. *
  5478. * @type {number}
  5479. * @default 0
  5480. */
  5481. this.channel = 0;
  5482. /**
  5483. * This defines how the texture is wrapped horizontally and corresponds to
  5484. * *U* in UV mapping.
  5485. *
  5486. * @type {(RepeatWrapping|ClampToEdgeWrapping|MirroredRepeatWrapping)}
  5487. * @default ClampToEdgeWrapping
  5488. */
  5489. this.wrapS = wrapS;
  5490. /**
  5491. * This defines how the texture is wrapped horizontally and corresponds to
  5492. * *V* in UV mapping.
  5493. *
  5494. * @type {(RepeatWrapping|ClampToEdgeWrapping|MirroredRepeatWrapping)}
  5495. * @default ClampToEdgeWrapping
  5496. */
  5497. this.wrapT = wrapT;
  5498. /**
  5499. * How the texture is sampled when a texel covers more than one pixel.
  5500. *
  5501. * @type {(NearestFilter|NearestMipmapNearestFilter|NearestMipmapLinearFilter|LinearFilter|LinearMipmapNearestFilter|LinearMipmapLinearFilter)}
  5502. * @default LinearFilter
  5503. */
  5504. this.magFilter = magFilter;
  5505. /**
  5506. * How the texture is sampled when a texel covers less than one pixel.
  5507. *
  5508. * @type {(NearestFilter|NearestMipmapNearestFilter|NearestMipmapLinearFilter|LinearFilter|LinearMipmapNearestFilter|LinearMipmapLinearFilter)}
  5509. * @default LinearMipmapLinearFilter
  5510. */
  5511. this.minFilter = minFilter;
  5512. /**
  5513. * The number of samples taken along the axis through the pixel that has the
  5514. * highest density of texels. By default, this value is `1`. A higher value
  5515. * gives a less blurry result than a basic mipmap, at the cost of more
  5516. * texture samples being used.
  5517. *
  5518. * @type {number}
  5519. * @default Texture.DEFAULT_ANISOTROPY
  5520. */
  5521. this.anisotropy = anisotropy;
  5522. /**
  5523. * The format of the texture.
  5524. *
  5525. * @type {number}
  5526. * @default RGBAFormat
  5527. */
  5528. this.format = format;
  5529. /**
  5530. * The default internal format is derived from {@link Texture#format} and {@link Texture#type} and
  5531. * defines how the texture data is going to be stored on the GPU.
  5532. *
  5533. * This property allows to overwrite the default format.
  5534. *
  5535. * @type {?string}
  5536. * @default null
  5537. */
  5538. this.internalFormat = null;
  5539. /**
  5540. * The data type of the texture.
  5541. *
  5542. * @type {number}
  5543. * @default UnsignedByteType
  5544. */
  5545. this.type = type;
  5546. /**
  5547. * How much a single repetition of the texture is offset from the beginning,
  5548. * in each direction U and V. Typical range is `0.0` to `1.0`.
  5549. *
  5550. * @type {Vector2}
  5551. * @default (0,0)
  5552. */
  5553. this.offset = new Vector2( 0, 0 );
  5554. /**
  5555. * How many times the texture is repeated across the surface, in each
  5556. * direction U and V. If repeat is set greater than `1` in either direction,
  5557. * the corresponding wrap parameter should also be set to `RepeatWrapping`
  5558. * or `MirroredRepeatWrapping` to achieve the desired tiling effect.
  5559. *
  5560. * @type {Vector2}
  5561. * @default (1,1)
  5562. */
  5563. this.repeat = new Vector2( 1, 1 );
  5564. /**
  5565. * The point around which rotation occurs. A value of `(0.5, 0.5)` corresponds
  5566. * to the center of the texture. Default is `(0, 0)`, the lower left.
  5567. *
  5568. * @type {Vector2}
  5569. * @default (0,0)
  5570. */
  5571. this.center = new Vector2( 0, 0 );
  5572. /**
  5573. * How much the texture is rotated around the center point, in radians.
  5574. * Positive values are counter-clockwise.
  5575. *
  5576. * @type {number}
  5577. * @default 0
  5578. */
  5579. this.rotation = 0;
  5580. /**
  5581. * Whether to update the texture's uv-transformation {@link Texture#matrix}
  5582. * from the properties {@link Texture#offset}, {@link Texture#repeat},
  5583. * {@link Texture#rotation}, and {@link Texture#center}.
  5584. *
  5585. * Set this to `false` if you are specifying the uv-transform matrix directly.
  5586. *
  5587. * @type {boolean}
  5588. * @default true
  5589. */
  5590. this.matrixAutoUpdate = true;
  5591. /**
  5592. * The uv-transformation matrix of the texture.
  5593. *
  5594. * @type {Matrix3}
  5595. */
  5596. this.matrix = new Matrix3();
  5597. /**
  5598. * Whether to generate mipmaps (if possible) for a texture.
  5599. *
  5600. * Set this to `false` if you are creating mipmaps manually.
  5601. *
  5602. * @type {boolean}
  5603. * @default true
  5604. */
  5605. this.generateMipmaps = true;
  5606. /**
  5607. * If set to `true`, the alpha channel, if present, is multiplied into the
  5608. * color channels when the texture is uploaded to the GPU.
  5609. *
  5610. * Note that this property has no effect when using `ImageBitmap`. You need to
  5611. * configure premultiply alpha on bitmap creation instead.
  5612. *
  5613. * @type {boolean}
  5614. * @default false
  5615. */
  5616. this.premultiplyAlpha = false;
  5617. /**
  5618. * If set to `true`, the texture is flipped along the vertical axis when
  5619. * uploaded to the GPU.
  5620. *
  5621. * Note that this property has no effect when using `ImageBitmap`. You need to
  5622. * configure the flip on bitmap creation instead.
  5623. *
  5624. * @type {boolean}
  5625. * @default true
  5626. */
  5627. this.flipY = true;
  5628. /**
  5629. * Specifies the alignment requirements for the start of each pixel row in memory.
  5630. * The allowable values are `1` (byte-alignment), `2` (rows aligned to even-numbered bytes),
  5631. * `4` (word-alignment), and `8` (rows start on double-word boundaries).
  5632. *
  5633. * @type {number}
  5634. * @default 4
  5635. */
  5636. this.unpackAlignment = 4; // valid values: 1, 2, 4, 8 (see http://www.khronos.org/opengles/sdk/docs/man/xhtml/glPixelStorei.xml)
  5637. /**
  5638. * Textures containing color data should be annotated with `SRGBColorSpace` or `LinearSRGBColorSpace`.
  5639. *
  5640. * @type {string}
  5641. * @default NoColorSpace
  5642. */
  5643. this.colorSpace = colorSpace;
  5644. /**
  5645. * An object that can be used to store custom data about the texture. It
  5646. * should not hold references to functions as these will not be cloned.
  5647. *
  5648. * @type {Object}
  5649. */
  5650. this.userData = {};
  5651. /**
  5652. * This can be used to only update a subregion or specific rows of the texture (for example, just the
  5653. * first 3 rows). Use the `addUpdateRange()` function to add ranges to this array.
  5654. *
  5655. * @type {Array<Object>}
  5656. */
  5657. this.updateRanges = [];
  5658. /**
  5659. * This starts at `0` and counts how many times {@link Texture#needsUpdate} is set to `true`.
  5660. *
  5661. * @type {number}
  5662. * @readonly
  5663. * @default 0
  5664. */
  5665. this.version = 0;
  5666. /**
  5667. * A callback function, called when the texture is updated (e.g., when
  5668. * {@link Texture#needsUpdate} has been set to true and then the texture is used).
  5669. *
  5670. * @type {?Function}
  5671. * @default null
  5672. */
  5673. this.onUpdate = null;
  5674. /**
  5675. * An optional back reference to the textures render target.
  5676. *
  5677. * @type {?(RenderTarget|WebGLRenderTarget)}
  5678. * @default null
  5679. */
  5680. this.renderTarget = null;
  5681. /**
  5682. * Indicates whether a texture belongs to a render target or not.
  5683. *
  5684. * @type {boolean}
  5685. * @readonly
  5686. * @default false
  5687. */
  5688. this.isRenderTargetTexture = false;
  5689. /**
  5690. * Indicates if a texture should be handled like a texture array.
  5691. *
  5692. * @type {boolean}
  5693. * @readonly
  5694. * @default false
  5695. */
  5696. this.isArrayTexture = image && image.depth && image.depth > 1 ? true : false;
  5697. /**
  5698. * Indicates whether this texture should be processed by `PMREMGenerator` or not
  5699. * (only relevant for render target textures).
  5700. *
  5701. * @type {number}
  5702. * @readonly
  5703. * @default 0
  5704. */
  5705. this.pmremVersion = 0;
  5706. }
  5707. /**
  5708. * The width of the texture in pixels.
  5709. */
  5710. get width() {
  5711. return this.source.getSize( _tempVec3 ).x;
  5712. }
  5713. /**
  5714. * The height of the texture in pixels.
  5715. */
  5716. get height() {
  5717. return this.source.getSize( _tempVec3 ).y;
  5718. }
  5719. /**
  5720. * The depth of the texture in pixels.
  5721. */
  5722. get depth() {
  5723. return this.source.getSize( _tempVec3 ).z;
  5724. }
  5725. /**
  5726. * The image object holding the texture data.
  5727. *
  5728. * @type {?Object}
  5729. */
  5730. get image() {
  5731. return this.source.data;
  5732. }
  5733. set image( value = null ) {
  5734. this.source.data = value;
  5735. }
  5736. /**
  5737. * Updates the texture transformation matrix from the from the properties {@link Texture#offset},
  5738. * {@link Texture#repeat}, {@link Texture#rotation}, and {@link Texture#center}.
  5739. */
  5740. updateMatrix() {
  5741. this.matrix.setUvTransform( this.offset.x, this.offset.y, this.repeat.x, this.repeat.y, this.rotation, this.center.x, this.center.y );
  5742. }
  5743. /**
  5744. * Adds a range of data in the data texture to be updated on the GPU.
  5745. *
  5746. * @param {number} start - Position at which to start update.
  5747. * @param {number} count - The number of components to update.
  5748. */
  5749. addUpdateRange( start, count ) {
  5750. this.updateRanges.push( { start, count } );
  5751. }
  5752. /**
  5753. * Clears the update ranges.
  5754. */
  5755. clearUpdateRanges() {
  5756. this.updateRanges.length = 0;
  5757. }
  5758. /**
  5759. * Returns a new texture with copied values from this instance.
  5760. *
  5761. * @return {Texture} A clone of this instance.
  5762. */
  5763. clone() {
  5764. return new this.constructor().copy( this );
  5765. }
  5766. /**
  5767. * Copies the values of the given texture to this instance.
  5768. *
  5769. * @param {Texture} source - The texture to copy.
  5770. * @return {Texture} A reference to this instance.
  5771. */
  5772. copy( source ) {
  5773. this.name = source.name;
  5774. this.source = source.source;
  5775. this.mipmaps = source.mipmaps.slice( 0 );
  5776. this.mapping = source.mapping;
  5777. this.channel = source.channel;
  5778. this.wrapS = source.wrapS;
  5779. this.wrapT = source.wrapT;
  5780. this.magFilter = source.magFilter;
  5781. this.minFilter = source.minFilter;
  5782. this.anisotropy = source.anisotropy;
  5783. this.format = source.format;
  5784. this.internalFormat = source.internalFormat;
  5785. this.type = source.type;
  5786. this.offset.copy( source.offset );
  5787. this.repeat.copy( source.repeat );
  5788. this.center.copy( source.center );
  5789. this.rotation = source.rotation;
  5790. this.matrixAutoUpdate = source.matrixAutoUpdate;
  5791. this.matrix.copy( source.matrix );
  5792. this.generateMipmaps = source.generateMipmaps;
  5793. this.premultiplyAlpha = source.premultiplyAlpha;
  5794. this.flipY = source.flipY;
  5795. this.unpackAlignment = source.unpackAlignment;
  5796. this.colorSpace = source.colorSpace;
  5797. this.renderTarget = source.renderTarget;
  5798. this.isRenderTargetTexture = source.isRenderTargetTexture;
  5799. this.isArrayTexture = source.isArrayTexture;
  5800. this.userData = JSON.parse( JSON.stringify( source.userData ) );
  5801. this.needsUpdate = true;
  5802. return this;
  5803. }
  5804. /**
  5805. * Sets this texture's properties based on `values`.
  5806. * @param {Object} values - A container with texture parameters.
  5807. */
  5808. setValues( values ) {
  5809. for ( const key in values ) {
  5810. const newValue = values[ key ];
  5811. if ( newValue === undefined ) {
  5812. warn( `Texture.setValues(): parameter '${ key }' has value of undefined.` );
  5813. continue;
  5814. }
  5815. const currentValue = this[ key ];
  5816. if ( currentValue === undefined ) {
  5817. warn( `Texture.setValues(): property '${ key }' does not exist.` );
  5818. continue;
  5819. }
  5820. if ( ( currentValue && newValue ) && ( currentValue.isVector2 && newValue.isVector2 ) ) {
  5821. currentValue.copy( newValue );
  5822. } else if ( ( currentValue && newValue ) && ( currentValue.isVector3 && newValue.isVector3 ) ) {
  5823. currentValue.copy( newValue );
  5824. } else if ( ( currentValue && newValue ) && ( currentValue.isMatrix3 && newValue.isMatrix3 ) ) {
  5825. currentValue.copy( newValue );
  5826. } else {
  5827. this[ key ] = newValue;
  5828. }
  5829. }
  5830. }
  5831. /**
  5832. * Serializes the texture into JSON.
  5833. *
  5834. * @param {?(Object|string)} meta - An optional value holding meta information about the serialization.
  5835. * @return {Object} A JSON object representing the serialized texture.
  5836. * @see {@link ObjectLoader#parse}
  5837. */
  5838. toJSON( meta ) {
  5839. const isRootObject = ( meta === undefined || typeof meta === 'string' );
  5840. if ( ! isRootObject && meta.textures[ this.uuid ] !== undefined ) {
  5841. return meta.textures[ this.uuid ];
  5842. }
  5843. const output = {
  5844. metadata: {
  5845. version: 4.7,
  5846. type: 'Texture',
  5847. generator: 'Texture.toJSON'
  5848. },
  5849. uuid: this.uuid,
  5850. name: this.name,
  5851. image: this.source.toJSON( meta ).uuid,
  5852. mapping: this.mapping,
  5853. channel: this.channel,
  5854. repeat: [ this.repeat.x, this.repeat.y ],
  5855. offset: [ this.offset.x, this.offset.y ],
  5856. center: [ this.center.x, this.center.y ],
  5857. rotation: this.rotation,
  5858. wrap: [ this.wrapS, this.wrapT ],
  5859. format: this.format,
  5860. internalFormat: this.internalFormat,
  5861. type: this.type,
  5862. colorSpace: this.colorSpace,
  5863. minFilter: this.minFilter,
  5864. magFilter: this.magFilter,
  5865. anisotropy: this.anisotropy,
  5866. flipY: this.flipY,
  5867. generateMipmaps: this.generateMipmaps,
  5868. premultiplyAlpha: this.premultiplyAlpha,
  5869. unpackAlignment: this.unpackAlignment
  5870. };
  5871. if ( Object.keys( this.userData ).length > 0 ) output.userData = this.userData;
  5872. if ( ! isRootObject ) {
  5873. meta.textures[ this.uuid ] = output;
  5874. }
  5875. return output;
  5876. }
  5877. /**
  5878. * Frees the GPU-related resources allocated by this instance. Call this
  5879. * method whenever this instance is no longer used in your app.
  5880. *
  5881. * @fires Texture#dispose
  5882. */
  5883. dispose() {
  5884. /**
  5885. * Fires when the texture has been disposed of.
  5886. *
  5887. * @event Texture#dispose
  5888. * @type {Object}
  5889. */
  5890. this.dispatchEvent( { type: 'dispose' } );
  5891. }
  5892. /**
  5893. * Transforms the given uv vector with the textures uv transformation matrix.
  5894. *
  5895. * @param {Vector2} uv - The uv vector.
  5896. * @return {Vector2} The transformed uv vector.
  5897. */
  5898. transformUv( uv ) {
  5899. if ( this.mapping !== UVMapping ) return uv;
  5900. uv.applyMatrix3( this.matrix );
  5901. if ( uv.x < 0 || uv.x > 1 ) {
  5902. switch ( this.wrapS ) {
  5903. case RepeatWrapping:
  5904. uv.x = uv.x - Math.floor( uv.x );
  5905. break;
  5906. case ClampToEdgeWrapping:
  5907. uv.x = uv.x < 0 ? 0 : 1;
  5908. break;
  5909. case MirroredRepeatWrapping:
  5910. if ( Math.abs( Math.floor( uv.x ) % 2 ) === 1 ) {
  5911. uv.x = Math.ceil( uv.x ) - uv.x;
  5912. } else {
  5913. uv.x = uv.x - Math.floor( uv.x );
  5914. }
  5915. break;
  5916. }
  5917. }
  5918. if ( uv.y < 0 || uv.y > 1 ) {
  5919. switch ( this.wrapT ) {
  5920. case RepeatWrapping:
  5921. uv.y = uv.y - Math.floor( uv.y );
  5922. break;
  5923. case ClampToEdgeWrapping:
  5924. uv.y = uv.y < 0 ? 0 : 1;
  5925. break;
  5926. case MirroredRepeatWrapping:
  5927. if ( Math.abs( Math.floor( uv.y ) % 2 ) === 1 ) {
  5928. uv.y = Math.ceil( uv.y ) - uv.y;
  5929. } else {
  5930. uv.y = uv.y - Math.floor( uv.y );
  5931. }
  5932. break;
  5933. }
  5934. }
  5935. if ( this.flipY ) {
  5936. uv.y = 1 - uv.y;
  5937. }
  5938. return uv;
  5939. }
  5940. /**
  5941. * Setting this property to `true` indicates the engine the texture
  5942. * must be updated in the next render. This triggers a texture upload
  5943. * to the GPU and ensures correct texture parameter configuration.
  5944. *
  5945. * @type {boolean}
  5946. * @default false
  5947. * @param {boolean} value
  5948. */
  5949. set needsUpdate( value ) {
  5950. if ( value === true ) {
  5951. this.version ++;
  5952. this.source.needsUpdate = true;
  5953. }
  5954. }
  5955. /**
  5956. * Setting this property to `true` indicates the engine the PMREM
  5957. * must be regenerated.
  5958. *
  5959. * @type {boolean}
  5960. * @default false
  5961. * @param {boolean} value
  5962. */
  5963. set needsPMREMUpdate( value ) {
  5964. if ( value === true ) {
  5965. this.pmremVersion ++;
  5966. }
  5967. }
  5968. }
  5969. /**
  5970. * The default image for all textures.
  5971. *
  5972. * @static
  5973. * @type {?Image}
  5974. * @default null
  5975. */
  5976. Texture.DEFAULT_IMAGE = null;
  5977. /**
  5978. * The default mapping for all textures.
  5979. *
  5980. * @static
  5981. * @type {number}
  5982. * @default UVMapping
  5983. */
  5984. Texture.DEFAULT_MAPPING = UVMapping;
  5985. /**
  5986. * The default anisotropy value for all textures.
  5987. *
  5988. * @static
  5989. * @type {number}
  5990. * @default 1
  5991. */
  5992. Texture.DEFAULT_ANISOTROPY = 1;
  5993. /**
  5994. * Class representing a 4D vector. A 4D vector is an ordered quadruplet of numbers
  5995. * (labeled x, y, z and w), which can be used to represent a number of things, such as:
  5996. *
  5997. * - A point in 4D space.
  5998. * - A direction and length in 4D space. In three.js the length will
  5999. * always be the Euclidean distance(straight-line distance) from `(0, 0, 0, 0)` to `(x, y, z, w)`
  6000. * and the direction is also measured from `(0, 0, 0, 0)` towards `(x, y, z, w)`.
  6001. * - Any arbitrary ordered quadruplet of numbers.
  6002. *
  6003. * There are other things a 4D vector can be used to represent, however these
  6004. * are the most common uses in *three.js*.
  6005. *
  6006. * Iterating through a vector instance will yield its components `(x, y, z, w)` in
  6007. * the corresponding order.
  6008. * ```js
  6009. * const a = new THREE.Vector4( 0, 1, 0, 0 );
  6010. *
  6011. * //no arguments; will be initialised to (0, 0, 0, 1)
  6012. * const b = new THREE.Vector4( );
  6013. *
  6014. * const d = a.dot( b );
  6015. * ```
  6016. */
  6017. class Vector4 {
  6018. /**
  6019. * Constructs a new 4D vector.
  6020. *
  6021. * @param {number} [x=0] - The x value of this vector.
  6022. * @param {number} [y=0] - The y value of this vector.
  6023. * @param {number} [z=0] - The z value of this vector.
  6024. * @param {number} [w=1] - The w value of this vector.
  6025. */
  6026. constructor( x = 0, y = 0, z = 0, w = 1 ) {
  6027. /**
  6028. * This flag can be used for type testing.
  6029. *
  6030. * @type {boolean}
  6031. * @readonly
  6032. * @default true
  6033. */
  6034. Vector4.prototype.isVector4 = true;
  6035. /**
  6036. * The x value of this vector.
  6037. *
  6038. * @type {number}
  6039. */
  6040. this.x = x;
  6041. /**
  6042. * The y value of this vector.
  6043. *
  6044. * @type {number}
  6045. */
  6046. this.y = y;
  6047. /**
  6048. * The z value of this vector.
  6049. *
  6050. * @type {number}
  6051. */
  6052. this.z = z;
  6053. /**
  6054. * The w value of this vector.
  6055. *
  6056. * @type {number}
  6057. */
  6058. this.w = w;
  6059. }
  6060. /**
  6061. * Alias for {@link Vector4#z}.
  6062. *
  6063. * @type {number}
  6064. */
  6065. get width() {
  6066. return this.z;
  6067. }
  6068. set width( value ) {
  6069. this.z = value;
  6070. }
  6071. /**
  6072. * Alias for {@link Vector4#w}.
  6073. *
  6074. * @type {number}
  6075. */
  6076. get height() {
  6077. return this.w;
  6078. }
  6079. set height( value ) {
  6080. this.w = value;
  6081. }
  6082. /**
  6083. * Sets the vector components.
  6084. *
  6085. * @param {number} x - The value of the x component.
  6086. * @param {number} y - The value of the y component.
  6087. * @param {number} z - The value of the z component.
  6088. * @param {number} w - The value of the w component.
  6089. * @return {Vector4} A reference to this vector.
  6090. */
  6091. set( x, y, z, w ) {
  6092. this.x = x;
  6093. this.y = y;
  6094. this.z = z;
  6095. this.w = w;
  6096. return this;
  6097. }
  6098. /**
  6099. * Sets the vector components to the same value.
  6100. *
  6101. * @param {number} scalar - The value to set for all vector components.
  6102. * @return {Vector4} A reference to this vector.
  6103. */
  6104. setScalar( scalar ) {
  6105. this.x = scalar;
  6106. this.y = scalar;
  6107. this.z = scalar;
  6108. this.w = scalar;
  6109. return this;
  6110. }
  6111. /**
  6112. * Sets the vector's x component to the given value
  6113. *
  6114. * @param {number} x - The value to set.
  6115. * @return {Vector4} A reference to this vector.
  6116. */
  6117. setX( x ) {
  6118. this.x = x;
  6119. return this;
  6120. }
  6121. /**
  6122. * Sets the vector's y component to the given value
  6123. *
  6124. * @param {number} y - The value to set.
  6125. * @return {Vector4} A reference to this vector.
  6126. */
  6127. setY( y ) {
  6128. this.y = y;
  6129. return this;
  6130. }
  6131. /**
  6132. * Sets the vector's z component to the given value
  6133. *
  6134. * @param {number} z - The value to set.
  6135. * @return {Vector4} A reference to this vector.
  6136. */
  6137. setZ( z ) {
  6138. this.z = z;
  6139. return this;
  6140. }
  6141. /**
  6142. * Sets the vector's w component to the given value
  6143. *
  6144. * @param {number} w - The value to set.
  6145. * @return {Vector4} A reference to this vector.
  6146. */
  6147. setW( w ) {
  6148. this.w = w;
  6149. return this;
  6150. }
  6151. /**
  6152. * Allows to set a vector component with an index.
  6153. *
  6154. * @param {number} index - The component index. `0` equals to x, `1` equals to y,
  6155. * `2` equals to z, `3` equals to w.
  6156. * @param {number} value - The value to set.
  6157. * @return {Vector4} A reference to this vector.
  6158. */
  6159. setComponent( index, value ) {
  6160. switch ( index ) {
  6161. case 0: this.x = value; break;
  6162. case 1: this.y = value; break;
  6163. case 2: this.z = value; break;
  6164. case 3: this.w = value; break;
  6165. default: throw new Error( 'index is out of range: ' + index );
  6166. }
  6167. return this;
  6168. }
  6169. /**
  6170. * Returns the value of the vector component which matches the given index.
  6171. *
  6172. * @param {number} index - The component index. `0` equals to x, `1` equals to y,
  6173. * `2` equals to z, `3` equals to w.
  6174. * @return {number} A vector component value.
  6175. */
  6176. getComponent( index ) {
  6177. switch ( index ) {
  6178. case 0: return this.x;
  6179. case 1: return this.y;
  6180. case 2: return this.z;
  6181. case 3: return this.w;
  6182. default: throw new Error( 'index is out of range: ' + index );
  6183. }
  6184. }
  6185. /**
  6186. * Returns a new vector with copied values from this instance.
  6187. *
  6188. * @return {Vector4} A clone of this instance.
  6189. */
  6190. clone() {
  6191. return new this.constructor( this.x, this.y, this.z, this.w );
  6192. }
  6193. /**
  6194. * Copies the values of the given vector to this instance.
  6195. *
  6196. * @param {Vector3|Vector4} v - The vector to copy.
  6197. * @return {Vector4} A reference to this vector.
  6198. */
  6199. copy( v ) {
  6200. this.x = v.x;
  6201. this.y = v.y;
  6202. this.z = v.z;
  6203. this.w = ( v.w !== undefined ) ? v.w : 1;
  6204. return this;
  6205. }
  6206. /**
  6207. * Adds the given vector to this instance.
  6208. *
  6209. * @param {Vector4} v - The vector to add.
  6210. * @return {Vector4} A reference to this vector.
  6211. */
  6212. add( v ) {
  6213. this.x += v.x;
  6214. this.y += v.y;
  6215. this.z += v.z;
  6216. this.w += v.w;
  6217. return this;
  6218. }
  6219. /**
  6220. * Adds the given scalar value to all components of this instance.
  6221. *
  6222. * @param {number} s - The scalar to add.
  6223. * @return {Vector4} A reference to this vector.
  6224. */
  6225. addScalar( s ) {
  6226. this.x += s;
  6227. this.y += s;
  6228. this.z += s;
  6229. this.w += s;
  6230. return this;
  6231. }
  6232. /**
  6233. * Adds the given vectors and stores the result in this instance.
  6234. *
  6235. * @param {Vector4} a - The first vector.
  6236. * @param {Vector4} b - The second vector.
  6237. * @return {Vector4} A reference to this vector.
  6238. */
  6239. addVectors( a, b ) {
  6240. this.x = a.x + b.x;
  6241. this.y = a.y + b.y;
  6242. this.z = a.z + b.z;
  6243. this.w = a.w + b.w;
  6244. return this;
  6245. }
  6246. /**
  6247. * Adds the given vector scaled by the given factor to this instance.
  6248. *
  6249. * @param {Vector4} v - The vector.
  6250. * @param {number} s - The factor that scales `v`.
  6251. * @return {Vector4} A reference to this vector.
  6252. */
  6253. addScaledVector( v, s ) {
  6254. this.x += v.x * s;
  6255. this.y += v.y * s;
  6256. this.z += v.z * s;
  6257. this.w += v.w * s;
  6258. return this;
  6259. }
  6260. /**
  6261. * Subtracts the given vector from this instance.
  6262. *
  6263. * @param {Vector4} v - The vector to subtract.
  6264. * @return {Vector4} A reference to this vector.
  6265. */
  6266. sub( v ) {
  6267. this.x -= v.x;
  6268. this.y -= v.y;
  6269. this.z -= v.z;
  6270. this.w -= v.w;
  6271. return this;
  6272. }
  6273. /**
  6274. * Subtracts the given scalar value from all components of this instance.
  6275. *
  6276. * @param {number} s - The scalar to subtract.
  6277. * @return {Vector4} A reference to this vector.
  6278. */
  6279. subScalar( s ) {
  6280. this.x -= s;
  6281. this.y -= s;
  6282. this.z -= s;
  6283. this.w -= s;
  6284. return this;
  6285. }
  6286. /**
  6287. * Subtracts the given vectors and stores the result in this instance.
  6288. *
  6289. * @param {Vector4} a - The first vector.
  6290. * @param {Vector4} b - The second vector.
  6291. * @return {Vector4} A reference to this vector.
  6292. */
  6293. subVectors( a, b ) {
  6294. this.x = a.x - b.x;
  6295. this.y = a.y - b.y;
  6296. this.z = a.z - b.z;
  6297. this.w = a.w - b.w;
  6298. return this;
  6299. }
  6300. /**
  6301. * Multiplies the given vector with this instance.
  6302. *
  6303. * @param {Vector4} v - The vector to multiply.
  6304. * @return {Vector4} A reference to this vector.
  6305. */
  6306. multiply( v ) {
  6307. this.x *= v.x;
  6308. this.y *= v.y;
  6309. this.z *= v.z;
  6310. this.w *= v.w;
  6311. return this;
  6312. }
  6313. /**
  6314. * Multiplies the given scalar value with all components of this instance.
  6315. *
  6316. * @param {number} scalar - The scalar to multiply.
  6317. * @return {Vector4} A reference to this vector.
  6318. */
  6319. multiplyScalar( scalar ) {
  6320. this.x *= scalar;
  6321. this.y *= scalar;
  6322. this.z *= scalar;
  6323. this.w *= scalar;
  6324. return this;
  6325. }
  6326. /**
  6327. * Multiplies this vector with the given 4x4 matrix.
  6328. *
  6329. * @param {Matrix4} m - The 4x4 matrix.
  6330. * @return {Vector4} A reference to this vector.
  6331. */
  6332. applyMatrix4( m ) {
  6333. const x = this.x, y = this.y, z = this.z, w = this.w;
  6334. const e = m.elements;
  6335. this.x = e[ 0 ] * x + e[ 4 ] * y + e[ 8 ] * z + e[ 12 ] * w;
  6336. this.y = e[ 1 ] * x + e[ 5 ] * y + e[ 9 ] * z + e[ 13 ] * w;
  6337. this.z = e[ 2 ] * x + e[ 6 ] * y + e[ 10 ] * z + e[ 14 ] * w;
  6338. this.w = e[ 3 ] * x + e[ 7 ] * y + e[ 11 ] * z + e[ 15 ] * w;
  6339. return this;
  6340. }
  6341. /**
  6342. * Divides this instance by the given vector.
  6343. *
  6344. * @param {Vector4} v - The vector to divide.
  6345. * @return {Vector4} A reference to this vector.
  6346. */
  6347. divide( v ) {
  6348. this.x /= v.x;
  6349. this.y /= v.y;
  6350. this.z /= v.z;
  6351. this.w /= v.w;
  6352. return this;
  6353. }
  6354. /**
  6355. * Divides this vector by the given scalar.
  6356. *
  6357. * @param {number} scalar - The scalar to divide.
  6358. * @return {Vector4} A reference to this vector.
  6359. */
  6360. divideScalar( scalar ) {
  6361. return this.multiplyScalar( 1 / scalar );
  6362. }
  6363. /**
  6364. * Sets the x, y and z components of this
  6365. * vector to the quaternion's axis and w to the angle.
  6366. *
  6367. * @param {Quaternion} q - The Quaternion to set.
  6368. * @return {Vector4} A reference to this vector.
  6369. */
  6370. setAxisAngleFromQuaternion( q ) {
  6371. // http://www.euclideanspace.com/maths/geometry/rotations/conversions/quaternionToAngle/index.htm
  6372. // q is assumed to be normalized
  6373. this.w = 2 * Math.acos( q.w );
  6374. const s = Math.sqrt( 1 - q.w * q.w );
  6375. if ( s < 0.0001 ) {
  6376. this.x = 1;
  6377. this.y = 0;
  6378. this.z = 0;
  6379. } else {
  6380. this.x = q.x / s;
  6381. this.y = q.y / s;
  6382. this.z = q.z / s;
  6383. }
  6384. return this;
  6385. }
  6386. /**
  6387. * Sets the x, y and z components of this
  6388. * vector to the axis of rotation and w to the angle.
  6389. *
  6390. * @param {Matrix4} m - A 4x4 matrix of which the upper left 3x3 matrix is a pure rotation matrix.
  6391. * @return {Vector4} A reference to this vector.
  6392. */
  6393. setAxisAngleFromRotationMatrix( m ) {
  6394. // http://www.euclideanspace.com/maths/geometry/rotations/conversions/matrixToAngle/index.htm
  6395. // assumes the upper 3x3 of m is a pure rotation matrix (i.e, unscaled)
  6396. let angle, x, y, z; // variables for result
  6397. const epsilon = 0.01, // margin to allow for rounding errors
  6398. epsilon2 = 0.1, // margin to distinguish between 0 and 180 degrees
  6399. te = m.elements,
  6400. m11 = te[ 0 ], m12 = te[ 4 ], m13 = te[ 8 ],
  6401. m21 = te[ 1 ], m22 = te[ 5 ], m23 = te[ 9 ],
  6402. m31 = te[ 2 ], m32 = te[ 6 ], m33 = te[ 10 ];
  6403. if ( ( Math.abs( m12 - m21 ) < epsilon ) &&
  6404. ( Math.abs( m13 - m31 ) < epsilon ) &&
  6405. ( Math.abs( m23 - m32 ) < epsilon ) ) {
  6406. // singularity found
  6407. // first check for identity matrix which must have +1 for all terms
  6408. // in leading diagonal and zero in other terms
  6409. if ( ( Math.abs( m12 + m21 ) < epsilon2 ) &&
  6410. ( Math.abs( m13 + m31 ) < epsilon2 ) &&
  6411. ( Math.abs( m23 + m32 ) < epsilon2 ) &&
  6412. ( Math.abs( m11 + m22 + m33 - 3 ) < epsilon2 ) ) {
  6413. // this singularity is identity matrix so angle = 0
  6414. this.set( 1, 0, 0, 0 );
  6415. return this; // zero angle, arbitrary axis
  6416. }
  6417. // otherwise this singularity is angle = 180
  6418. angle = Math.PI;
  6419. const xx = ( m11 + 1 ) / 2;
  6420. const yy = ( m22 + 1 ) / 2;
  6421. const zz = ( m33 + 1 ) / 2;
  6422. const xy = ( m12 + m21 ) / 4;
  6423. const xz = ( m13 + m31 ) / 4;
  6424. const yz = ( m23 + m32 ) / 4;
  6425. if ( ( xx > yy ) && ( xx > zz ) ) {
  6426. // m11 is the largest diagonal term
  6427. if ( xx < epsilon ) {
  6428. x = 0;
  6429. y = 0.707106781;
  6430. z = 0.707106781;
  6431. } else {
  6432. x = Math.sqrt( xx );
  6433. y = xy / x;
  6434. z = xz / x;
  6435. }
  6436. } else if ( yy > zz ) {
  6437. // m22 is the largest diagonal term
  6438. if ( yy < epsilon ) {
  6439. x = 0.707106781;
  6440. y = 0;
  6441. z = 0.707106781;
  6442. } else {
  6443. y = Math.sqrt( yy );
  6444. x = xy / y;
  6445. z = yz / y;
  6446. }
  6447. } else {
  6448. // m33 is the largest diagonal term so base result on this
  6449. if ( zz < epsilon ) {
  6450. x = 0.707106781;
  6451. y = 0.707106781;
  6452. z = 0;
  6453. } else {
  6454. z = Math.sqrt( zz );
  6455. x = xz / z;
  6456. y = yz / z;
  6457. }
  6458. }
  6459. this.set( x, y, z, angle );
  6460. return this; // return 180 deg rotation
  6461. }
  6462. // as we have reached here there are no singularities so we can handle normally
  6463. let s = Math.sqrt( ( m32 - m23 ) * ( m32 - m23 ) +
  6464. ( m13 - m31 ) * ( m13 - m31 ) +
  6465. ( m21 - m12 ) * ( m21 - m12 ) ); // used to normalize
  6466. if ( Math.abs( s ) < 0.001 ) s = 1;
  6467. // prevent divide by zero, should not happen if matrix is orthogonal and should be
  6468. // caught by singularity test above, but I've left it in just in case
  6469. this.x = ( m32 - m23 ) / s;
  6470. this.y = ( m13 - m31 ) / s;
  6471. this.z = ( m21 - m12 ) / s;
  6472. this.w = Math.acos( ( m11 + m22 + m33 - 1 ) / 2 );
  6473. return this;
  6474. }
  6475. /**
  6476. * Sets the vector components to the position elements of the
  6477. * given transformation matrix.
  6478. *
  6479. * @param {Matrix4} m - The 4x4 matrix.
  6480. * @return {Vector4} A reference to this vector.
  6481. */
  6482. setFromMatrixPosition( m ) {
  6483. const e = m.elements;
  6484. this.x = e[ 12 ];
  6485. this.y = e[ 13 ];
  6486. this.z = e[ 14 ];
  6487. this.w = e[ 15 ];
  6488. return this;
  6489. }
  6490. /**
  6491. * If this vector's x, y, z or w value is greater than the given vector's x, y, z or w
  6492. * value, replace that value with the corresponding min value.
  6493. *
  6494. * @param {Vector4} v - The vector.
  6495. * @return {Vector4} A reference to this vector.
  6496. */
  6497. min( v ) {
  6498. this.x = Math.min( this.x, v.x );
  6499. this.y = Math.min( this.y, v.y );
  6500. this.z = Math.min( this.z, v.z );
  6501. this.w = Math.min( this.w, v.w );
  6502. return this;
  6503. }
  6504. /**
  6505. * If this vector's x, y, z or w value is less than the given vector's x, y, z or w
  6506. * value, replace that value with the corresponding max value.
  6507. *
  6508. * @param {Vector4} v - The vector.
  6509. * @return {Vector4} A reference to this vector.
  6510. */
  6511. max( v ) {
  6512. this.x = Math.max( this.x, v.x );
  6513. this.y = Math.max( this.y, v.y );
  6514. this.z = Math.max( this.z, v.z );
  6515. this.w = Math.max( this.w, v.w );
  6516. return this;
  6517. }
  6518. /**
  6519. * If this vector's x, y, z or w value is greater than the max vector's x, y, z or w
  6520. * value, it is replaced by the corresponding value.
  6521. * If this vector's x, y, z or w value is less than the min vector's x, y, z or w value,
  6522. * it is replaced by the corresponding value.
  6523. *
  6524. * @param {Vector4} min - The minimum x, y and z values.
  6525. * @param {Vector4} max - The maximum x, y and z values in the desired range.
  6526. * @return {Vector4} A reference to this vector.
  6527. */
  6528. clamp( min, max ) {
  6529. // assumes min < max, componentwise
  6530. this.x = clamp( this.x, min.x, max.x );
  6531. this.y = clamp( this.y, min.y, max.y );
  6532. this.z = clamp( this.z, min.z, max.z );
  6533. this.w = clamp( this.w, min.w, max.w );
  6534. return this;
  6535. }
  6536. /**
  6537. * If this vector's x, y, z or w values are greater than the max value, they are
  6538. * replaced by the max value.
  6539. * If this vector's x, y, z or w values are less than the min value, they are
  6540. * replaced by the min value.
  6541. *
  6542. * @param {number} minVal - The minimum value the components will be clamped to.
  6543. * @param {number} maxVal - The maximum value the components will be clamped to.
  6544. * @return {Vector4} A reference to this vector.
  6545. */
  6546. clampScalar( minVal, maxVal ) {
  6547. this.x = clamp( this.x, minVal, maxVal );
  6548. this.y = clamp( this.y, minVal, maxVal );
  6549. this.z = clamp( this.z, minVal, maxVal );
  6550. this.w = clamp( this.w, minVal, maxVal );
  6551. return this;
  6552. }
  6553. /**
  6554. * If this vector's length is greater than the max value, it is replaced by
  6555. * the max value.
  6556. * If this vector's length is less than the min value, it is replaced by the
  6557. * min value.
  6558. *
  6559. * @param {number} min - The minimum value the vector length will be clamped to.
  6560. * @param {number} max - The maximum value the vector length will be clamped to.
  6561. * @return {Vector4} A reference to this vector.
  6562. */
  6563. clampLength( min, max ) {
  6564. const length = this.length();
  6565. return this.divideScalar( length || 1 ).multiplyScalar( clamp( length, min, max ) );
  6566. }
  6567. /**
  6568. * The components of this vector are rounded down to the nearest integer value.
  6569. *
  6570. * @return {Vector4} A reference to this vector.
  6571. */
  6572. floor() {
  6573. this.x = Math.floor( this.x );
  6574. this.y = Math.floor( this.y );
  6575. this.z = Math.floor( this.z );
  6576. this.w = Math.floor( this.w );
  6577. return this;
  6578. }
  6579. /**
  6580. * The components of this vector are rounded up to the nearest integer value.
  6581. *
  6582. * @return {Vector4} A reference to this vector.
  6583. */
  6584. ceil() {
  6585. this.x = Math.ceil( this.x );
  6586. this.y = Math.ceil( this.y );
  6587. this.z = Math.ceil( this.z );
  6588. this.w = Math.ceil( this.w );
  6589. return this;
  6590. }
  6591. /**
  6592. * The components of this vector are rounded to the nearest integer value
  6593. *
  6594. * @return {Vector4} A reference to this vector.
  6595. */
  6596. round() {
  6597. this.x = Math.round( this.x );
  6598. this.y = Math.round( this.y );
  6599. this.z = Math.round( this.z );
  6600. this.w = Math.round( this.w );
  6601. return this;
  6602. }
  6603. /**
  6604. * The components of this vector are rounded towards zero (up if negative,
  6605. * down if positive) to an integer value.
  6606. *
  6607. * @return {Vector4} A reference to this vector.
  6608. */
  6609. roundToZero() {
  6610. this.x = Math.trunc( this.x );
  6611. this.y = Math.trunc( this.y );
  6612. this.z = Math.trunc( this.z );
  6613. this.w = Math.trunc( this.w );
  6614. return this;
  6615. }
  6616. /**
  6617. * Inverts this vector - i.e. sets x = -x, y = -y, z = -z, w = -w.
  6618. *
  6619. * @return {Vector4} A reference to this vector.
  6620. */
  6621. negate() {
  6622. this.x = - this.x;
  6623. this.y = - this.y;
  6624. this.z = - this.z;
  6625. this.w = - this.w;
  6626. return this;
  6627. }
  6628. /**
  6629. * Calculates the dot product of the given vector with this instance.
  6630. *
  6631. * @param {Vector4} v - The vector to compute the dot product with.
  6632. * @return {number} The result of the dot product.
  6633. */
  6634. dot( v ) {
  6635. return this.x * v.x + this.y * v.y + this.z * v.z + this.w * v.w;
  6636. }
  6637. /**
  6638. * Computes the square of the Euclidean length (straight-line length) from
  6639. * (0, 0, 0, 0) to (x, y, z, w). If you are comparing the lengths of vectors, you should
  6640. * compare the length squared instead as it is slightly more efficient to calculate.
  6641. *
  6642. * @return {number} The square length of this vector.
  6643. */
  6644. lengthSq() {
  6645. return this.x * this.x + this.y * this.y + this.z * this.z + this.w * this.w;
  6646. }
  6647. /**
  6648. * Computes the Euclidean length (straight-line length) from (0, 0, 0, 0) to (x, y, z, w).
  6649. *
  6650. * @return {number} The length of this vector.
  6651. */
  6652. length() {
  6653. return Math.sqrt( this.x * this.x + this.y * this.y + this.z * this.z + this.w * this.w );
  6654. }
  6655. /**
  6656. * Computes the Manhattan length of this vector.
  6657. *
  6658. * @return {number} The length of this vector.
  6659. */
  6660. manhattanLength() {
  6661. return Math.abs( this.x ) + Math.abs( this.y ) + Math.abs( this.z ) + Math.abs( this.w );
  6662. }
  6663. /**
  6664. * Converts this vector to a unit vector - that is, sets it equal to a vector
  6665. * with the same direction as this one, but with a vector length of `1`.
  6666. *
  6667. * @return {Vector4} A reference to this vector.
  6668. */
  6669. normalize() {
  6670. return this.divideScalar( this.length() || 1 );
  6671. }
  6672. /**
  6673. * Sets this vector to a vector with the same direction as this one, but
  6674. * with the specified length.
  6675. *
  6676. * @param {number} length - The new length of this vector.
  6677. * @return {Vector4} A reference to this vector.
  6678. */
  6679. setLength( length ) {
  6680. return this.normalize().multiplyScalar( length );
  6681. }
  6682. /**
  6683. * Linearly interpolates between the given vector and this instance, where
  6684. * alpha is the percent distance along the line - alpha = 0 will be this
  6685. * vector, and alpha = 1 will be the given one.
  6686. *
  6687. * @param {Vector4} v - The vector to interpolate towards.
  6688. * @param {number} alpha - The interpolation factor, typically in the closed interval `[0, 1]`.
  6689. * @return {Vector4} A reference to this vector.
  6690. */
  6691. lerp( v, alpha ) {
  6692. this.x += ( v.x - this.x ) * alpha;
  6693. this.y += ( v.y - this.y ) * alpha;
  6694. this.z += ( v.z - this.z ) * alpha;
  6695. this.w += ( v.w - this.w ) * alpha;
  6696. return this;
  6697. }
  6698. /**
  6699. * Linearly interpolates between the given vectors, where alpha is the percent
  6700. * distance along the line - alpha = 0 will be first vector, and alpha = 1 will
  6701. * be the second one. The result is stored in this instance.
  6702. *
  6703. * @param {Vector4} v1 - The first vector.
  6704. * @param {Vector4} v2 - The second vector.
  6705. * @param {number} alpha - The interpolation factor, typically in the closed interval `[0, 1]`.
  6706. * @return {Vector4} A reference to this vector.
  6707. */
  6708. lerpVectors( v1, v2, alpha ) {
  6709. this.x = v1.x + ( v2.x - v1.x ) * alpha;
  6710. this.y = v1.y + ( v2.y - v1.y ) * alpha;
  6711. this.z = v1.z + ( v2.z - v1.z ) * alpha;
  6712. this.w = v1.w + ( v2.w - v1.w ) * alpha;
  6713. return this;
  6714. }
  6715. /**
  6716. * Returns `true` if this vector is equal with the given one.
  6717. *
  6718. * @param {Vector4} v - The vector to test for equality.
  6719. * @return {boolean} Whether this vector is equal with the given one.
  6720. */
  6721. equals( v ) {
  6722. return ( ( v.x === this.x ) && ( v.y === this.y ) && ( v.z === this.z ) && ( v.w === this.w ) );
  6723. }
  6724. /**
  6725. * Sets this vector's x value to be `array[ offset ]`, y value to be `array[ offset + 1 ]`,
  6726. * z value to be `array[ offset + 2 ]`, w value to be `array[ offset + 3 ]`.
  6727. *
  6728. * @param {Array<number>} array - An array holding the vector component values.
  6729. * @param {number} [offset=0] - The offset into the array.
  6730. * @return {Vector4} A reference to this vector.
  6731. */
  6732. fromArray( array, offset = 0 ) {
  6733. this.x = array[ offset ];
  6734. this.y = array[ offset + 1 ];
  6735. this.z = array[ offset + 2 ];
  6736. this.w = array[ offset + 3 ];
  6737. return this;
  6738. }
  6739. /**
  6740. * Writes the components of this vector to the given array. If no array is provided,
  6741. * the method returns a new instance.
  6742. *
  6743. * @param {Array<number>} [array=[]] - The target array holding the vector components.
  6744. * @param {number} [offset=0] - Index of the first element in the array.
  6745. * @return {Array<number>} The vector components.
  6746. */
  6747. toArray( array = [], offset = 0 ) {
  6748. array[ offset ] = this.x;
  6749. array[ offset + 1 ] = this.y;
  6750. array[ offset + 2 ] = this.z;
  6751. array[ offset + 3 ] = this.w;
  6752. return array;
  6753. }
  6754. /**
  6755. * Sets the components of this vector from the given buffer attribute.
  6756. *
  6757. * @param {BufferAttribute} attribute - The buffer attribute holding vector data.
  6758. * @param {number} index - The index into the attribute.
  6759. * @return {Vector4} A reference to this vector.
  6760. */
  6761. fromBufferAttribute( attribute, index ) {
  6762. this.x = attribute.getX( index );
  6763. this.y = attribute.getY( index );
  6764. this.z = attribute.getZ( index );
  6765. this.w = attribute.getW( index );
  6766. return this;
  6767. }
  6768. /**
  6769. * Sets each component of this vector to a pseudo-random value between `0` and
  6770. * `1`, excluding `1`.
  6771. *
  6772. * @return {Vector4} A reference to this vector.
  6773. */
  6774. random() {
  6775. this.x = Math.random();
  6776. this.y = Math.random();
  6777. this.z = Math.random();
  6778. this.w = Math.random();
  6779. return this;
  6780. }
  6781. *[ Symbol.iterator ]() {
  6782. yield this.x;
  6783. yield this.y;
  6784. yield this.z;
  6785. yield this.w;
  6786. }
  6787. }
  6788. /**
  6789. * A render target is a buffer where the video card draws pixels for a scene
  6790. * that is being rendered in the background. It is used in different effects,
  6791. * such as applying postprocessing to a rendered image before displaying it
  6792. * on the screen.
  6793. *
  6794. * @augments EventDispatcher
  6795. */
  6796. class RenderTarget extends EventDispatcher {
  6797. /**
  6798. * Render target options.
  6799. *
  6800. * @typedef {Object} RenderTarget~Options
  6801. * @property {boolean} [generateMipmaps=false] - Whether to generate mipmaps or not.
  6802. * @property {number} [magFilter=LinearFilter] - The mag filter.
  6803. * @property {number} [minFilter=LinearFilter] - The min filter.
  6804. * @property {number} [format=RGBAFormat] - The texture format.
  6805. * @property {number} [type=UnsignedByteType] - The texture type.
  6806. * @property {?string} [internalFormat=null] - The texture's internal format.
  6807. * @property {number} [wrapS=ClampToEdgeWrapping] - The texture's uv wrapping mode.
  6808. * @property {number} [wrapT=ClampToEdgeWrapping] - The texture's uv wrapping mode.
  6809. * @property {number} [anisotropy=1] - The texture's anisotropy value.
  6810. * @property {string} [colorSpace=NoColorSpace] - The texture's color space.
  6811. * @property {boolean} [depthBuffer=true] - Whether to allocate a depth buffer or not.
  6812. * @property {boolean} [stencilBuffer=false] - Whether to allocate a stencil buffer or not.
  6813. * @property {boolean} [resolveDepthBuffer=true] - Whether to resolve the depth buffer or not.
  6814. * @property {boolean} [resolveStencilBuffer=true] - Whether to resolve the stencil buffer or not.
  6815. * @property {?Texture} [depthTexture=null] - Reference to a depth texture.
  6816. * @property {number} [samples=0] - The MSAA samples count.
  6817. * @property {number} [count=1] - Defines the number of color attachments . Must be at least `1`.
  6818. * @property {number} [depth=1] - The texture depth.
  6819. * @property {boolean} [multiview=false] - Whether this target is used for multiview rendering.
  6820. */
  6821. /**
  6822. * Constructs a new render target.
  6823. *
  6824. * @param {number} [width=1] - The width of the render target.
  6825. * @param {number} [height=1] - The height of the render target.
  6826. * @param {RenderTarget~Options} [options] - The configuration object.
  6827. */
  6828. constructor( width = 1, height = 1, options = {} ) {
  6829. super();
  6830. options = Object.assign( {
  6831. generateMipmaps: false,
  6832. internalFormat: null,
  6833. minFilter: LinearFilter,
  6834. depthBuffer: true,
  6835. stencilBuffer: false,
  6836. resolveDepthBuffer: true,
  6837. resolveStencilBuffer: true,
  6838. depthTexture: null,
  6839. samples: 0,
  6840. count: 1,
  6841. depth: 1,
  6842. multiview: false
  6843. }, options );
  6844. /**
  6845. * This flag can be used for type testing.
  6846. *
  6847. * @type {boolean}
  6848. * @readonly
  6849. * @default true
  6850. */
  6851. this.isRenderTarget = true;
  6852. /**
  6853. * The width of the render target.
  6854. *
  6855. * @type {number}
  6856. * @default 1
  6857. */
  6858. this.width = width;
  6859. /**
  6860. * The height of the render target.
  6861. *
  6862. * @type {number}
  6863. * @default 1
  6864. */
  6865. this.height = height;
  6866. /**
  6867. * The depth of the render target.
  6868. *
  6869. * @type {number}
  6870. * @default 1
  6871. */
  6872. this.depth = options.depth;
  6873. /**
  6874. * A rectangular area inside the render target's viewport. Fragments that are
  6875. * outside the area will be discarded.
  6876. *
  6877. * @type {Vector4}
  6878. * @default (0,0,width,height)
  6879. */
  6880. this.scissor = new Vector4( 0, 0, width, height );
  6881. /**
  6882. * Indicates whether the scissor test should be enabled when rendering into
  6883. * this render target or not.
  6884. *
  6885. * @type {boolean}
  6886. * @default false
  6887. */
  6888. this.scissorTest = false;
  6889. /**
  6890. * A rectangular area representing the render target's viewport.
  6891. *
  6892. * @type {Vector4}
  6893. * @default (0,0,width,height)
  6894. */
  6895. this.viewport = new Vector4( 0, 0, width, height );
  6896. const image = { width: width, height: height, depth: options.depth };
  6897. const texture = new Texture( image );
  6898. /**
  6899. * An array of textures. Each color attachment is represented as a separate texture.
  6900. * Has at least a single entry for the default color attachment.
  6901. *
  6902. * @type {Array<Texture>}
  6903. */
  6904. this.textures = [];
  6905. const count = options.count;
  6906. for ( let i = 0; i < count; i ++ ) {
  6907. this.textures[ i ] = texture.clone();
  6908. this.textures[ i ].isRenderTargetTexture = true;
  6909. this.textures[ i ].renderTarget = this;
  6910. }
  6911. this._setTextureOptions( options );
  6912. /**
  6913. * Whether to allocate a depth buffer or not.
  6914. *
  6915. * @type {boolean}
  6916. * @default true
  6917. */
  6918. this.depthBuffer = options.depthBuffer;
  6919. /**
  6920. * Whether to allocate a stencil buffer or not.
  6921. *
  6922. * @type {boolean}
  6923. * @default false
  6924. */
  6925. this.stencilBuffer = options.stencilBuffer;
  6926. /**
  6927. * Whether to resolve the depth buffer or not.
  6928. *
  6929. * @type {boolean}
  6930. * @default true
  6931. */
  6932. this.resolveDepthBuffer = options.resolveDepthBuffer;
  6933. /**
  6934. * Whether to resolve the stencil buffer or not.
  6935. *
  6936. * @type {boolean}
  6937. * @default true
  6938. */
  6939. this.resolveStencilBuffer = options.resolveStencilBuffer;
  6940. this._depthTexture = null;
  6941. this.depthTexture = options.depthTexture;
  6942. /**
  6943. * The number of MSAA samples.
  6944. *
  6945. * A value of `0` disables MSAA.
  6946. *
  6947. * @type {number}
  6948. * @default 0
  6949. */
  6950. this.samples = options.samples;
  6951. /**
  6952. * Whether to this target is used in multiview rendering.
  6953. *
  6954. * @type {boolean}
  6955. * @default false
  6956. */
  6957. this.multiview = options.multiview;
  6958. }
  6959. _setTextureOptions( options = {} ) {
  6960. const values = {
  6961. minFilter: LinearFilter,
  6962. generateMipmaps: false,
  6963. flipY: false,
  6964. internalFormat: null
  6965. };
  6966. if ( options.mapping !== undefined ) values.mapping = options.mapping;
  6967. if ( options.wrapS !== undefined ) values.wrapS = options.wrapS;
  6968. if ( options.wrapT !== undefined ) values.wrapT = options.wrapT;
  6969. if ( options.wrapR !== undefined ) values.wrapR = options.wrapR;
  6970. if ( options.magFilter !== undefined ) values.magFilter = options.magFilter;
  6971. if ( options.minFilter !== undefined ) values.minFilter = options.minFilter;
  6972. if ( options.format !== undefined ) values.format = options.format;
  6973. if ( options.type !== undefined ) values.type = options.type;
  6974. if ( options.anisotropy !== undefined ) values.anisotropy = options.anisotropy;
  6975. if ( options.colorSpace !== undefined ) values.colorSpace = options.colorSpace;
  6976. if ( options.flipY !== undefined ) values.flipY = options.flipY;
  6977. if ( options.generateMipmaps !== undefined ) values.generateMipmaps = options.generateMipmaps;
  6978. if ( options.internalFormat !== undefined ) values.internalFormat = options.internalFormat;
  6979. for ( let i = 0; i < this.textures.length; i ++ ) {
  6980. const texture = this.textures[ i ];
  6981. texture.setValues( values );
  6982. }
  6983. }
  6984. /**
  6985. * The texture representing the default color attachment.
  6986. *
  6987. * @type {Texture}
  6988. */
  6989. get texture() {
  6990. return this.textures[ 0 ];
  6991. }
  6992. set texture( value ) {
  6993. this.textures[ 0 ] = value;
  6994. }
  6995. set depthTexture( current ) {
  6996. if ( this._depthTexture !== null ) this._depthTexture.renderTarget = null;
  6997. if ( current !== null ) current.renderTarget = this;
  6998. this._depthTexture = current;
  6999. }
  7000. /**
  7001. * Instead of saving the depth in a renderbuffer, a texture
  7002. * can be used instead which is useful for further processing
  7003. * e.g. in context of post-processing.
  7004. *
  7005. * @type {?DepthTexture}
  7006. * @default null
  7007. */
  7008. get depthTexture() {
  7009. return this._depthTexture;
  7010. }
  7011. /**
  7012. * Sets the size of this render target.
  7013. *
  7014. * @param {number} width - The width.
  7015. * @param {number} height - The height.
  7016. * @param {number} [depth=1] - The depth.
  7017. */
  7018. setSize( width, height, depth = 1 ) {
  7019. if ( this.width !== width || this.height !== height || this.depth !== depth ) {
  7020. this.width = width;
  7021. this.height = height;
  7022. this.depth = depth;
  7023. for ( let i = 0, il = this.textures.length; i < il; i ++ ) {
  7024. this.textures[ i ].image.width = width;
  7025. this.textures[ i ].image.height = height;
  7026. this.textures[ i ].image.depth = depth;
  7027. if ( this.textures[ i ].isData3DTexture !== true ) { // Fix for #31693
  7028. // TODO: Reconsider setting isArrayTexture flag here and in the ctor of Texture.
  7029. // Maybe a method `isArrayTexture()` or just a getter could replace a flag since
  7030. // both are evaluated on each call?
  7031. this.textures[ i ].isArrayTexture = this.textures[ i ].image.depth > 1;
  7032. }
  7033. }
  7034. this.dispose();
  7035. }
  7036. this.viewport.set( 0, 0, width, height );
  7037. this.scissor.set( 0, 0, width, height );
  7038. }
  7039. /**
  7040. * Returns a new render target with copied values from this instance.
  7041. *
  7042. * @return {RenderTarget} A clone of this instance.
  7043. */
  7044. clone() {
  7045. return new this.constructor().copy( this );
  7046. }
  7047. /**
  7048. * Copies the settings of the given render target. This is a structural copy so
  7049. * no resources are shared between render targets after the copy. That includes
  7050. * all MRT textures and the depth texture.
  7051. *
  7052. * @param {RenderTarget} source - The render target to copy.
  7053. * @return {RenderTarget} A reference to this instance.
  7054. */
  7055. copy( source ) {
  7056. this.width = source.width;
  7057. this.height = source.height;
  7058. this.depth = source.depth;
  7059. this.scissor.copy( source.scissor );
  7060. this.scissorTest = source.scissorTest;
  7061. this.viewport.copy( source.viewport );
  7062. this.textures.length = 0;
  7063. for ( let i = 0, il = source.textures.length; i < il; i ++ ) {
  7064. this.textures[ i ] = source.textures[ i ].clone();
  7065. this.textures[ i ].isRenderTargetTexture = true;
  7066. this.textures[ i ].renderTarget = this;
  7067. // ensure image object is not shared, see #20328
  7068. const image = Object.assign( {}, source.textures[ i ].image );
  7069. this.textures[ i ].source = new Source( image );
  7070. }
  7071. this.depthBuffer = source.depthBuffer;
  7072. this.stencilBuffer = source.stencilBuffer;
  7073. this.resolveDepthBuffer = source.resolveDepthBuffer;
  7074. this.resolveStencilBuffer = source.resolveStencilBuffer;
  7075. if ( source.depthTexture !== null ) this.depthTexture = source.depthTexture.clone();
  7076. this.samples = source.samples;
  7077. return this;
  7078. }
  7079. /**
  7080. * Frees the GPU-related resources allocated by this instance. Call this
  7081. * method whenever this instance is no longer used in your app.
  7082. *
  7083. * @fires RenderTarget#dispose
  7084. */
  7085. dispose() {
  7086. this.dispatchEvent( { type: 'dispose' } );
  7087. }
  7088. }
  7089. /**
  7090. * A render target used in context of {@link WebGLRenderer}.
  7091. *
  7092. * @augments RenderTarget
  7093. */
  7094. class WebGLRenderTarget extends RenderTarget {
  7095. /**
  7096. * Constructs a new 3D render target.
  7097. *
  7098. * @param {number} [width=1] - The width of the render target.
  7099. * @param {number} [height=1] - The height of the render target.
  7100. * @param {RenderTarget~Options} [options] - The configuration object.
  7101. */
  7102. constructor( width = 1, height = 1, options = {} ) {
  7103. super( width, height, options );
  7104. /**
  7105. * This flag can be used for type testing.
  7106. *
  7107. * @type {boolean}
  7108. * @readonly
  7109. * @default true
  7110. */
  7111. this.isWebGLRenderTarget = true;
  7112. }
  7113. }
  7114. /**
  7115. * Creates an array of textures directly from raw buffer data.
  7116. *
  7117. * @augments Texture
  7118. */
  7119. class DataArrayTexture extends Texture {
  7120. /**
  7121. * Constructs a new data array texture.
  7122. *
  7123. * @param {?TypedArray} [data=null] - The buffer data.
  7124. * @param {number} [width=1] - The width of the texture.
  7125. * @param {number} [height=1] - The height of the texture.
  7126. * @param {number} [depth=1] - The depth of the texture.
  7127. */
  7128. constructor( data = null, width = 1, height = 1, depth = 1 ) {
  7129. super( null );
  7130. /**
  7131. * This flag can be used for type testing.
  7132. *
  7133. * @type {boolean}
  7134. * @readonly
  7135. * @default true
  7136. */
  7137. this.isDataArrayTexture = true;
  7138. /**
  7139. * The image definition of a data texture.
  7140. *
  7141. * @type {{data:TypedArray,width:number,height:number,depth:number}}
  7142. */
  7143. this.image = { data, width, height, depth };
  7144. /**
  7145. * How the texture is sampled when a texel covers more than one pixel.
  7146. *
  7147. * Overwritten and set to `NearestFilter` by default.
  7148. *
  7149. * @type {(NearestFilter|NearestMipmapNearestFilter|NearestMipmapLinearFilter|LinearFilter|LinearMipmapNearestFilter|LinearMipmapLinearFilter)}
  7150. * @default NearestFilter
  7151. */
  7152. this.magFilter = NearestFilter;
  7153. /**
  7154. * How the texture is sampled when a texel covers less than one pixel.
  7155. *
  7156. * Overwritten and set to `NearestFilter` by default.
  7157. *
  7158. * @type {(NearestFilter|NearestMipmapNearestFilter|NearestMipmapLinearFilter|LinearFilter|LinearMipmapNearestFilter|LinearMipmapLinearFilter)}
  7159. * @default NearestFilter
  7160. */
  7161. this.minFilter = NearestFilter;
  7162. /**
  7163. * This defines how the texture is wrapped in the depth and corresponds to
  7164. * *W* in UVW mapping.
  7165. *
  7166. * @type {(RepeatWrapping|ClampToEdgeWrapping|MirroredRepeatWrapping)}
  7167. * @default ClampToEdgeWrapping
  7168. */
  7169. this.wrapR = ClampToEdgeWrapping;
  7170. /**
  7171. * Whether to generate mipmaps (if possible) for a texture.
  7172. *
  7173. * Overwritten and set to `false` by default.
  7174. *
  7175. * @type {boolean}
  7176. * @default false
  7177. */
  7178. this.generateMipmaps = false;
  7179. /**
  7180. * If set to `true`, the texture is flipped along the vertical axis when
  7181. * uploaded to the GPU.
  7182. *
  7183. * Overwritten and set to `false` by default.
  7184. *
  7185. * @type {boolean}
  7186. * @default false
  7187. */
  7188. this.flipY = false;
  7189. /**
  7190. * Specifies the alignment requirements for the start of each pixel row in memory.
  7191. *
  7192. * Overwritten and set to `1` by default.
  7193. *
  7194. * @type {boolean}
  7195. * @default 1
  7196. */
  7197. this.unpackAlignment = 1;
  7198. /**
  7199. * A set of all layers which need to be updated in the texture.
  7200. *
  7201. * @type {Set<number>}
  7202. */
  7203. this.layerUpdates = new Set();
  7204. }
  7205. /**
  7206. * Describes that a specific layer of the texture needs to be updated.
  7207. * Normally when {@link Texture#needsUpdate} is set to `true`, the
  7208. * entire data texture array is sent to the GPU. Marking specific
  7209. * layers will only transmit subsets of all mipmaps associated with a
  7210. * specific depth in the array which is often much more performant.
  7211. *
  7212. * @param {number} layerIndex - The layer index that should be updated.
  7213. */
  7214. addLayerUpdate( layerIndex ) {
  7215. this.layerUpdates.add( layerIndex );
  7216. }
  7217. /**
  7218. * Resets the layer updates registry.
  7219. */
  7220. clearLayerUpdates() {
  7221. this.layerUpdates.clear();
  7222. }
  7223. }
  7224. /**
  7225. * An array render target used in context of {@link WebGLRenderer}.
  7226. *
  7227. * @augments WebGLRenderTarget
  7228. */
  7229. class WebGLArrayRenderTarget extends WebGLRenderTarget {
  7230. /**
  7231. * Constructs a new array render target.
  7232. *
  7233. * @param {number} [width=1] - The width of the render target.
  7234. * @param {number} [height=1] - The height of the render target.
  7235. * @param {number} [depth=1] - The height of the render target.
  7236. * @param {RenderTarget~Options} [options] - The configuration object.
  7237. */
  7238. constructor( width = 1, height = 1, depth = 1, options = {} ) {
  7239. super( width, height, options );
  7240. /**
  7241. * This flag can be used for type testing.
  7242. *
  7243. * @type {boolean}
  7244. * @readonly
  7245. * @default true
  7246. */
  7247. this.isWebGLArrayRenderTarget = true;
  7248. this.depth = depth;
  7249. /**
  7250. * Overwritten with a different texture type.
  7251. *
  7252. * @type {DataArrayTexture}
  7253. */
  7254. this.texture = new DataArrayTexture( null, width, height, depth );
  7255. this._setTextureOptions( options );
  7256. this.texture.isRenderTargetTexture = true;
  7257. }
  7258. }
  7259. /**
  7260. * Creates a three-dimensional texture from raw data, with parameters to
  7261. * divide it into width, height, and depth.
  7262. *
  7263. * @augments Texture
  7264. */
  7265. class Data3DTexture extends Texture {
  7266. /**
  7267. * Constructs a new data array texture.
  7268. *
  7269. * @param {?TypedArray} [data=null] - The buffer data.
  7270. * @param {number} [width=1] - The width of the texture.
  7271. * @param {number} [height=1] - The height of the texture.
  7272. * @param {number} [depth=1] - The depth of the texture.
  7273. */
  7274. constructor( data = null, width = 1, height = 1, depth = 1 ) {
  7275. // We're going to add .setXXX() methods for setting properties later.
  7276. // Users can still set in Data3DTexture directly.
  7277. //
  7278. // const texture = new THREE.Data3DTexture( data, width, height, depth );
  7279. // texture.anisotropy = 16;
  7280. //
  7281. // See #14839
  7282. super( null );
  7283. /**
  7284. * This flag can be used for type testing.
  7285. *
  7286. * @type {boolean}
  7287. * @readonly
  7288. * @default true
  7289. */
  7290. this.isData3DTexture = true;
  7291. /**
  7292. * The image definition of a data texture.
  7293. *
  7294. * @type {{data:TypedArray,width:number,height:number,depth:number}}
  7295. */
  7296. this.image = { data, width, height, depth };
  7297. /**
  7298. * How the texture is sampled when a texel covers more than one pixel.
  7299. *
  7300. * Overwritten and set to `NearestFilter` by default.
  7301. *
  7302. * @type {(NearestFilter|NearestMipmapNearestFilter|NearestMipmapLinearFilter|LinearFilter|LinearMipmapNearestFilter|LinearMipmapLinearFilter)}
  7303. * @default NearestFilter
  7304. */
  7305. this.magFilter = NearestFilter;
  7306. /**
  7307. * How the texture is sampled when a texel covers less than one pixel.
  7308. *
  7309. * Overwritten and set to `NearestFilter` by default.
  7310. *
  7311. * @type {(NearestFilter|NearestMipmapNearestFilter|NearestMipmapLinearFilter|LinearFilter|LinearMipmapNearestFilter|LinearMipmapLinearFilter)}
  7312. * @default NearestFilter
  7313. */
  7314. this.minFilter = NearestFilter;
  7315. /**
  7316. * This defines how the texture is wrapped in the depth and corresponds to
  7317. * *W* in UVW mapping.
  7318. *
  7319. * @type {(RepeatWrapping|ClampToEdgeWrapping|MirroredRepeatWrapping)}
  7320. * @default ClampToEdgeWrapping
  7321. */
  7322. this.wrapR = ClampToEdgeWrapping;
  7323. /**
  7324. * Whether to generate mipmaps (if possible) for a texture.
  7325. *
  7326. * Overwritten and set to `false` by default.
  7327. *
  7328. * @type {boolean}
  7329. * @default false
  7330. */
  7331. this.generateMipmaps = false;
  7332. /**
  7333. * If set to `true`, the texture is flipped along the vertical axis when
  7334. * uploaded to the GPU.
  7335. *
  7336. * Overwritten and set to `false` by default.
  7337. *
  7338. * @type {boolean}
  7339. * @default false
  7340. */
  7341. this.flipY = false;
  7342. /**
  7343. * Specifies the alignment requirements for the start of each pixel row in memory.
  7344. *
  7345. * Overwritten and set to `1` by default.
  7346. *
  7347. * @type {boolean}
  7348. * @default 1
  7349. */
  7350. this.unpackAlignment = 1;
  7351. }
  7352. }
  7353. /**
  7354. * A 3D render target used in context of {@link WebGLRenderer}.
  7355. *
  7356. * @augments WebGLRenderTarget
  7357. */
  7358. class WebGL3DRenderTarget extends WebGLRenderTarget {
  7359. /**
  7360. * Constructs a new 3D render target.
  7361. *
  7362. * @param {number} [width=1] - The width of the render target.
  7363. * @param {number} [height=1] - The height of the render target.
  7364. * @param {number} [depth=1] - The height of the render target.
  7365. * @param {RenderTarget~Options} [options] - The configuration object.
  7366. */
  7367. constructor( width = 1, height = 1, depth = 1, options = {} ) {
  7368. super( width, height, options );
  7369. /**
  7370. * This flag can be used for type testing.
  7371. *
  7372. * @type {boolean}
  7373. * @readonly
  7374. * @default true
  7375. */
  7376. this.isWebGL3DRenderTarget = true;
  7377. this.depth = depth;
  7378. /**
  7379. * Overwritten with a different texture type.
  7380. *
  7381. * @type {Data3DTexture}
  7382. */
  7383. this.texture = new Data3DTexture( null, width, height, depth );
  7384. this._setTextureOptions( options );
  7385. this.texture.isRenderTargetTexture = true;
  7386. }
  7387. }
  7388. /**
  7389. * Represents an axis-aligned bounding box (AABB) in 3D space.
  7390. */
  7391. class Box3 {
  7392. /**
  7393. * Constructs a new bounding box.
  7394. *
  7395. * @param {Vector3} [min=(Infinity,Infinity,Infinity)] - A vector representing the lower boundary of the box.
  7396. * @param {Vector3} [max=(-Infinity,-Infinity,-Infinity)] - A vector representing the upper boundary of the box.
  7397. */
  7398. constructor( min = new Vector3( + Infinity, + Infinity, + Infinity ), max = new Vector3( - Infinity, - Infinity, - Infinity ) ) {
  7399. /**
  7400. * This flag can be used for type testing.
  7401. *
  7402. * @type {boolean}
  7403. * @readonly
  7404. * @default true
  7405. */
  7406. this.isBox3 = true;
  7407. /**
  7408. * The lower boundary of the box.
  7409. *
  7410. * @type {Vector3}
  7411. */
  7412. this.min = min;
  7413. /**
  7414. * The upper boundary of the box.
  7415. *
  7416. * @type {Vector3}
  7417. */
  7418. this.max = max;
  7419. }
  7420. /**
  7421. * Sets the lower and upper boundaries of this box.
  7422. * Please note that this method only copies the values from the given objects.
  7423. *
  7424. * @param {Vector3} min - The lower boundary of the box.
  7425. * @param {Vector3} max - The upper boundary of the box.
  7426. * @return {Box3} A reference to this bounding box.
  7427. */
  7428. set( min, max ) {
  7429. this.min.copy( min );
  7430. this.max.copy( max );
  7431. return this;
  7432. }
  7433. /**
  7434. * Sets the upper and lower bounds of this box so it encloses the position data
  7435. * in the given array.
  7436. *
  7437. * @param {Array<number>} array - An array holding 3D position data.
  7438. * @return {Box3} A reference to this bounding box.
  7439. */
  7440. setFromArray( array ) {
  7441. this.makeEmpty();
  7442. for ( let i = 0, il = array.length; i < il; i += 3 ) {
  7443. this.expandByPoint( _vector$b.fromArray( array, i ) );
  7444. }
  7445. return this;
  7446. }
  7447. /**
  7448. * Sets the upper and lower bounds of this box so it encloses the position data
  7449. * in the given buffer attribute.
  7450. *
  7451. * @param {BufferAttribute} attribute - A buffer attribute holding 3D position data.
  7452. * @return {Box3} A reference to this bounding box.
  7453. */
  7454. setFromBufferAttribute( attribute ) {
  7455. this.makeEmpty();
  7456. for ( let i = 0, il = attribute.count; i < il; i ++ ) {
  7457. this.expandByPoint( _vector$b.fromBufferAttribute( attribute, i ) );
  7458. }
  7459. return this;
  7460. }
  7461. /**
  7462. * Sets the upper and lower bounds of this box so it encloses the position data
  7463. * in the given array.
  7464. *
  7465. * @param {Array<Vector3>} points - An array holding 3D position data as instances of {@link Vector3}.
  7466. * @return {Box3} A reference to this bounding box.
  7467. */
  7468. setFromPoints( points ) {
  7469. this.makeEmpty();
  7470. for ( let i = 0, il = points.length; i < il; i ++ ) {
  7471. this.expandByPoint( points[ i ] );
  7472. }
  7473. return this;
  7474. }
  7475. /**
  7476. * Centers this box on the given center vector and sets this box's width, height and
  7477. * depth to the given size values.
  7478. *
  7479. * @param {Vector3} center - The center of the box.
  7480. * @param {Vector3} size - The x, y and z dimensions of the box.
  7481. * @return {Box3} A reference to this bounding box.
  7482. */
  7483. setFromCenterAndSize( center, size ) {
  7484. const halfSize = _vector$b.copy( size ).multiplyScalar( 0.5 );
  7485. this.min.copy( center ).sub( halfSize );
  7486. this.max.copy( center ).add( halfSize );
  7487. return this;
  7488. }
  7489. /**
  7490. * Computes the world-axis-aligned bounding box for the given 3D object
  7491. * (including its children), accounting for the object's, and children's,
  7492. * world transforms. The function may result in a larger box than strictly necessary.
  7493. *
  7494. * @param {Object3D} object - The 3D object to compute the bounding box for.
  7495. * @param {boolean} [precise=false] - If set to `true`, the method computes the smallest
  7496. * world-axis-aligned bounding box at the expense of more computation.
  7497. * @return {Box3} A reference to this bounding box.
  7498. */
  7499. setFromObject( object, precise = false ) {
  7500. this.makeEmpty();
  7501. return this.expandByObject( object, precise );
  7502. }
  7503. /**
  7504. * Returns a new box with copied values from this instance.
  7505. *
  7506. * @return {Box3} A clone of this instance.
  7507. */
  7508. clone() {
  7509. return new this.constructor().copy( this );
  7510. }
  7511. /**
  7512. * Copies the values of the given box to this instance.
  7513. *
  7514. * @param {Box3} box - The box to copy.
  7515. * @return {Box3} A reference to this bounding box.
  7516. */
  7517. copy( box ) {
  7518. this.min.copy( box.min );
  7519. this.max.copy( box.max );
  7520. return this;
  7521. }
  7522. /**
  7523. * Makes this box empty which means in encloses a zero space in 3D.
  7524. *
  7525. * @return {Box3} A reference to this bounding box.
  7526. */
  7527. makeEmpty() {
  7528. this.min.x = this.min.y = this.min.z = + Infinity;
  7529. this.max.x = this.max.y = this.max.z = - Infinity;
  7530. return this;
  7531. }
  7532. /**
  7533. * Returns true if this box includes zero points within its bounds.
  7534. * Note that a box with equal lower and upper bounds still includes one
  7535. * point, the one both bounds share.
  7536. *
  7537. * @return {boolean} Whether this box is empty or not.
  7538. */
  7539. isEmpty() {
  7540. // this is a more robust check for empty than ( volume <= 0 ) because volume can get positive with two negative axes
  7541. return ( this.max.x < this.min.x ) || ( this.max.y < this.min.y ) || ( this.max.z < this.min.z );
  7542. }
  7543. /**
  7544. * Returns the center point of this box.
  7545. *
  7546. * @param {Vector3} target - The target vector that is used to store the method's result.
  7547. * @return {Vector3} The center point.
  7548. */
  7549. getCenter( target ) {
  7550. return this.isEmpty() ? target.set( 0, 0, 0 ) : target.addVectors( this.min, this.max ).multiplyScalar( 0.5 );
  7551. }
  7552. /**
  7553. * Returns the dimensions of this box.
  7554. *
  7555. * @param {Vector3} target - The target vector that is used to store the method's result.
  7556. * @return {Vector3} The size.
  7557. */
  7558. getSize( target ) {
  7559. return this.isEmpty() ? target.set( 0, 0, 0 ) : target.subVectors( this.max, this.min );
  7560. }
  7561. /**
  7562. * Expands the boundaries of this box to include the given point.
  7563. *
  7564. * @param {Vector3} point - The point that should be included by the bounding box.
  7565. * @return {Box3} A reference to this bounding box.
  7566. */
  7567. expandByPoint( point ) {
  7568. this.min.min( point );
  7569. this.max.max( point );
  7570. return this;
  7571. }
  7572. /**
  7573. * Expands this box equilaterally by the given vector. The width of this
  7574. * box will be expanded by the x component of the vector in both
  7575. * directions. The height of this box will be expanded by the y component of
  7576. * the vector in both directions. The depth of this box will be
  7577. * expanded by the z component of the vector in both directions.
  7578. *
  7579. * @param {Vector3} vector - The vector that should expand the bounding box.
  7580. * @return {Box3} A reference to this bounding box.
  7581. */
  7582. expandByVector( vector ) {
  7583. this.min.sub( vector );
  7584. this.max.add( vector );
  7585. return this;
  7586. }
  7587. /**
  7588. * Expands each dimension of the box by the given scalar. If negative, the
  7589. * dimensions of the box will be contracted.
  7590. *
  7591. * @param {number} scalar - The scalar value that should expand the bounding box.
  7592. * @return {Box3} A reference to this bounding box.
  7593. */
  7594. expandByScalar( scalar ) {
  7595. this.min.addScalar( - scalar );
  7596. this.max.addScalar( scalar );
  7597. return this;
  7598. }
  7599. /**
  7600. * Expands the boundaries of this box to include the given 3D object and
  7601. * its children, accounting for the object's, and children's, world
  7602. * transforms. The function may result in a larger box than strictly
  7603. * necessary (unless the precise parameter is set to true).
  7604. *
  7605. * @param {Object3D} object - The 3D object that should expand the bounding box.
  7606. * @param {boolean} precise - If set to `true`, the method expands the bounding box
  7607. * as little as necessary at the expense of more computation.
  7608. * @return {Box3} A reference to this bounding box.
  7609. */
  7610. expandByObject( object, precise = false ) {
  7611. // Computes the world-axis-aligned bounding box of an object (including its children),
  7612. // accounting for both the object's, and children's, world transforms
  7613. object.updateWorldMatrix( false, false );
  7614. const geometry = object.geometry;
  7615. if ( geometry !== undefined ) {
  7616. const positionAttribute = geometry.getAttribute( 'position' );
  7617. // precise AABB computation based on vertex data requires at least a position attribute.
  7618. // instancing isn't supported so far and uses the normal (conservative) code path.
  7619. if ( precise === true && positionAttribute !== undefined && object.isInstancedMesh !== true ) {
  7620. for ( let i = 0, l = positionAttribute.count; i < l; i ++ ) {
  7621. if ( object.isMesh === true ) {
  7622. object.getVertexPosition( i, _vector$b );
  7623. } else {
  7624. _vector$b.fromBufferAttribute( positionAttribute, i );
  7625. }
  7626. _vector$b.applyMatrix4( object.matrixWorld );
  7627. this.expandByPoint( _vector$b );
  7628. }
  7629. } else {
  7630. if ( object.boundingBox !== undefined ) {
  7631. // object-level bounding box
  7632. if ( object.boundingBox === null ) {
  7633. object.computeBoundingBox();
  7634. }
  7635. _box$4.copy( object.boundingBox );
  7636. } else {
  7637. // geometry-level bounding box
  7638. if ( geometry.boundingBox === null ) {
  7639. geometry.computeBoundingBox();
  7640. }
  7641. _box$4.copy( geometry.boundingBox );
  7642. }
  7643. _box$4.applyMatrix4( object.matrixWorld );
  7644. this.union( _box$4 );
  7645. }
  7646. }
  7647. const children = object.children;
  7648. for ( let i = 0, l = children.length; i < l; i ++ ) {
  7649. this.expandByObject( children[ i ], precise );
  7650. }
  7651. return this;
  7652. }
  7653. /**
  7654. * Returns `true` if the given point lies within or on the boundaries of this box.
  7655. *
  7656. * @param {Vector3} point - The point to test.
  7657. * @return {boolean} Whether the bounding box contains the given point or not.
  7658. */
  7659. containsPoint( point ) {
  7660. return point.x >= this.min.x && point.x <= this.max.x &&
  7661. point.y >= this.min.y && point.y <= this.max.y &&
  7662. point.z >= this.min.z && point.z <= this.max.z;
  7663. }
  7664. /**
  7665. * Returns `true` if this bounding box includes the entirety of the given bounding box.
  7666. * If this box and the given one are identical, this function also returns `true`.
  7667. *
  7668. * @param {Box3} box - The bounding box to test.
  7669. * @return {boolean} Whether the bounding box contains the given bounding box or not.
  7670. */
  7671. containsBox( box ) {
  7672. return this.min.x <= box.min.x && box.max.x <= this.max.x &&
  7673. this.min.y <= box.min.y && box.max.y <= this.max.y &&
  7674. this.min.z <= box.min.z && box.max.z <= this.max.z;
  7675. }
  7676. /**
  7677. * Returns a point as a proportion of this box's width, height and depth.
  7678. *
  7679. * @param {Vector3} point - A point in 3D space.
  7680. * @param {Vector3} target - The target vector that is used to store the method's result.
  7681. * @return {Vector3} A point as a proportion of this box's width, height and depth.
  7682. */
  7683. getParameter( point, target ) {
  7684. // This can potentially have a divide by zero if the box
  7685. // has a size dimension of 0.
  7686. return target.set(
  7687. ( point.x - this.min.x ) / ( this.max.x - this.min.x ),
  7688. ( point.y - this.min.y ) / ( this.max.y - this.min.y ),
  7689. ( point.z - this.min.z ) / ( this.max.z - this.min.z )
  7690. );
  7691. }
  7692. /**
  7693. * Returns `true` if the given bounding box intersects with this bounding box.
  7694. *
  7695. * @param {Box3} box - The bounding box to test.
  7696. * @return {boolean} Whether the given bounding box intersects with this bounding box.
  7697. */
  7698. intersectsBox( box ) {
  7699. // using 6 splitting planes to rule out intersections.
  7700. return box.max.x >= this.min.x && box.min.x <= this.max.x &&
  7701. box.max.y >= this.min.y && box.min.y <= this.max.y &&
  7702. box.max.z >= this.min.z && box.min.z <= this.max.z;
  7703. }
  7704. /**
  7705. * Returns `true` if the given bounding sphere intersects with this bounding box.
  7706. *
  7707. * @param {Sphere} sphere - The bounding sphere to test.
  7708. * @return {boolean} Whether the given bounding sphere intersects with this bounding box.
  7709. */
  7710. intersectsSphere( sphere ) {
  7711. // Find the point on the AABB closest to the sphere center.
  7712. this.clampPoint( sphere.center, _vector$b );
  7713. // If that point is inside the sphere, the AABB and sphere intersect.
  7714. return _vector$b.distanceToSquared( sphere.center ) <= ( sphere.radius * sphere.radius );
  7715. }
  7716. /**
  7717. * Returns `true` if the given plane intersects with this bounding box.
  7718. *
  7719. * @param {Plane} plane - The plane to test.
  7720. * @return {boolean} Whether the given plane intersects with this bounding box.
  7721. */
  7722. intersectsPlane( plane ) {
  7723. // We compute the minimum and maximum dot product values. If those values
  7724. // are on the same side (back or front) of the plane, then there is no intersection.
  7725. let min, max;
  7726. if ( plane.normal.x > 0 ) {
  7727. min = plane.normal.x * this.min.x;
  7728. max = plane.normal.x * this.max.x;
  7729. } else {
  7730. min = plane.normal.x * this.max.x;
  7731. max = plane.normal.x * this.min.x;
  7732. }
  7733. if ( plane.normal.y > 0 ) {
  7734. min += plane.normal.y * this.min.y;
  7735. max += plane.normal.y * this.max.y;
  7736. } else {
  7737. min += plane.normal.y * this.max.y;
  7738. max += plane.normal.y * this.min.y;
  7739. }
  7740. if ( plane.normal.z > 0 ) {
  7741. min += plane.normal.z * this.min.z;
  7742. max += plane.normal.z * this.max.z;
  7743. } else {
  7744. min += plane.normal.z * this.max.z;
  7745. max += plane.normal.z * this.min.z;
  7746. }
  7747. return ( min <= - plane.constant && max >= - plane.constant );
  7748. }
  7749. /**
  7750. * Returns `true` if the given triangle intersects with this bounding box.
  7751. *
  7752. * @param {Triangle} triangle - The triangle to test.
  7753. * @return {boolean} Whether the given triangle intersects with this bounding box.
  7754. */
  7755. intersectsTriangle( triangle ) {
  7756. if ( this.isEmpty() ) {
  7757. return false;
  7758. }
  7759. // compute box center and extents
  7760. this.getCenter( _center );
  7761. _extents.subVectors( this.max, _center );
  7762. // translate triangle to aabb origin
  7763. _v0$2.subVectors( triangle.a, _center );
  7764. _v1$7.subVectors( triangle.b, _center );
  7765. _v2$4.subVectors( triangle.c, _center );
  7766. // compute edge vectors for triangle
  7767. _f0.subVectors( _v1$7, _v0$2 );
  7768. _f1.subVectors( _v2$4, _v1$7 );
  7769. _f2.subVectors( _v0$2, _v2$4 );
  7770. // test against axes that are given by cross product combinations of the edges of the triangle and the edges of the aabb
  7771. // 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
  7772. // axis_ij = u_i x f_j (u0, u1, u2 = face normals of aabb = x,y,z axes vectors since aabb is axis aligned)
  7773. let axes = [
  7774. 0, - _f0.z, _f0.y, 0, - _f1.z, _f1.y, 0, - _f2.z, _f2.y,
  7775. _f0.z, 0, - _f0.x, _f1.z, 0, - _f1.x, _f2.z, 0, - _f2.x,
  7776. - _f0.y, _f0.x, 0, - _f1.y, _f1.x, 0, - _f2.y, _f2.x, 0
  7777. ];
  7778. if ( ! satForAxes( axes, _v0$2, _v1$7, _v2$4, _extents ) ) {
  7779. return false;
  7780. }
  7781. // test 3 face normals from the aabb
  7782. axes = [ 1, 0, 0, 0, 1, 0, 0, 0, 1 ];
  7783. if ( ! satForAxes( axes, _v0$2, _v1$7, _v2$4, _extents ) ) {
  7784. return false;
  7785. }
  7786. // finally testing the face normal of the triangle
  7787. // use already existing triangle edge vectors here
  7788. _triangleNormal.crossVectors( _f0, _f1 );
  7789. axes = [ _triangleNormal.x, _triangleNormal.y, _triangleNormal.z ];
  7790. return satForAxes( axes, _v0$2, _v1$7, _v2$4, _extents );
  7791. }
  7792. /**
  7793. * Clamps the given point within the bounds of this box.
  7794. *
  7795. * @param {Vector3} point - The point to clamp.
  7796. * @param {Vector3} target - The target vector that is used to store the method's result.
  7797. * @return {Vector3} The clamped point.
  7798. */
  7799. clampPoint( point, target ) {
  7800. return target.copy( point ).clamp( this.min, this.max );
  7801. }
  7802. /**
  7803. * Returns the euclidean distance from any edge of this box to the specified point. If
  7804. * the given point lies inside of this box, the distance will be `0`.
  7805. *
  7806. * @param {Vector3} point - The point to compute the distance to.
  7807. * @return {number} The euclidean distance.
  7808. */
  7809. distanceToPoint( point ) {
  7810. return this.clampPoint( point, _vector$b ).distanceTo( point );
  7811. }
  7812. /**
  7813. * Returns a bounding sphere that encloses this bounding box.
  7814. *
  7815. * @param {Sphere} target - The target sphere that is used to store the method's result.
  7816. * @return {Sphere} The bounding sphere that encloses this bounding box.
  7817. */
  7818. getBoundingSphere( target ) {
  7819. if ( this.isEmpty() ) {
  7820. target.makeEmpty();
  7821. } else {
  7822. this.getCenter( target.center );
  7823. target.radius = this.getSize( _vector$b ).length() * 0.5;
  7824. }
  7825. return target;
  7826. }
  7827. /**
  7828. * Computes the intersection of this bounding box and the given one, setting the upper
  7829. * bound of this box to the lesser of the two boxes' upper bounds and the
  7830. * lower bound of this box to the greater of the two boxes' lower bounds. If
  7831. * there's no overlap, makes this box empty.
  7832. *
  7833. * @param {Box3} box - The bounding box to intersect with.
  7834. * @return {Box3} A reference to this bounding box.
  7835. */
  7836. intersect( box ) {
  7837. this.min.max( box.min );
  7838. this.max.min( box.max );
  7839. // 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.
  7840. if ( this.isEmpty() ) this.makeEmpty();
  7841. return this;
  7842. }
  7843. /**
  7844. * Computes the union of this box and another and the given one, setting the upper
  7845. * bound of this box to the greater of the two boxes' upper bounds and the
  7846. * lower bound of this box to the lesser of the two boxes' lower bounds.
  7847. *
  7848. * @param {Box3} box - The bounding box that will be unioned with this instance.
  7849. * @return {Box3} A reference to this bounding box.
  7850. */
  7851. union( box ) {
  7852. this.min.min( box.min );
  7853. this.max.max( box.max );
  7854. return this;
  7855. }
  7856. /**
  7857. * Transforms this bounding box by the given 4x4 transformation matrix.
  7858. *
  7859. * @param {Matrix4} matrix - The transformation matrix.
  7860. * @return {Box3} A reference to this bounding box.
  7861. */
  7862. applyMatrix4( matrix ) {
  7863. // transform of empty box is an empty box.
  7864. if ( this.isEmpty() ) return this;
  7865. // NOTE: I am using a binary pattern to specify all 2^3 combinations below
  7866. _points[ 0 ].set( this.min.x, this.min.y, this.min.z ).applyMatrix4( matrix ); // 000
  7867. _points[ 1 ].set( this.min.x, this.min.y, this.max.z ).applyMatrix4( matrix ); // 001
  7868. _points[ 2 ].set( this.min.x, this.max.y, this.min.z ).applyMatrix4( matrix ); // 010
  7869. _points[ 3 ].set( this.min.x, this.max.y, this.max.z ).applyMatrix4( matrix ); // 011
  7870. _points[ 4 ].set( this.max.x, this.min.y, this.min.z ).applyMatrix4( matrix ); // 100
  7871. _points[ 5 ].set( this.max.x, this.min.y, this.max.z ).applyMatrix4( matrix ); // 101
  7872. _points[ 6 ].set( this.max.x, this.max.y, this.min.z ).applyMatrix4( matrix ); // 110
  7873. _points[ 7 ].set( this.max.x, this.max.y, this.max.z ).applyMatrix4( matrix ); // 111
  7874. this.setFromPoints( _points );
  7875. return this;
  7876. }
  7877. /**
  7878. * Adds the given offset to both the upper and lower bounds of this bounding box,
  7879. * effectively moving it in 3D space.
  7880. *
  7881. * @param {Vector3} offset - The offset that should be used to translate the bounding box.
  7882. * @return {Box3} A reference to this bounding box.
  7883. */
  7884. translate( offset ) {
  7885. this.min.add( offset );
  7886. this.max.add( offset );
  7887. return this;
  7888. }
  7889. /**
  7890. * Returns `true` if this bounding box is equal with the given one.
  7891. *
  7892. * @param {Box3} box - The box to test for equality.
  7893. * @return {boolean} Whether this bounding box is equal with the given one.
  7894. */
  7895. equals( box ) {
  7896. return box.min.equals( this.min ) && box.max.equals( this.max );
  7897. }
  7898. /**
  7899. * Returns a serialized structure of the bounding box.
  7900. *
  7901. * @return {Object} Serialized structure with fields representing the object state.
  7902. */
  7903. toJSON() {
  7904. return {
  7905. min: this.min.toArray(),
  7906. max: this.max.toArray()
  7907. };
  7908. }
  7909. /**
  7910. * Returns a serialized structure of the bounding box.
  7911. *
  7912. * @param {Object} json - The serialized json to set the box from.
  7913. * @return {Box3} A reference to this bounding box.
  7914. */
  7915. fromJSON( json ) {
  7916. this.min.fromArray( json.min );
  7917. this.max.fromArray( json.max );
  7918. return this;
  7919. }
  7920. }
  7921. const _points = [
  7922. /*@__PURE__*/ new Vector3(),
  7923. /*@__PURE__*/ new Vector3(),
  7924. /*@__PURE__*/ new Vector3(),
  7925. /*@__PURE__*/ new Vector3(),
  7926. /*@__PURE__*/ new Vector3(),
  7927. /*@__PURE__*/ new Vector3(),
  7928. /*@__PURE__*/ new Vector3(),
  7929. /*@__PURE__*/ new Vector3()
  7930. ];
  7931. const _vector$b = /*@__PURE__*/ new Vector3();
  7932. const _box$4 = /*@__PURE__*/ new Box3();
  7933. // triangle centered vertices
  7934. const _v0$2 = /*@__PURE__*/ new Vector3();
  7935. const _v1$7 = /*@__PURE__*/ new Vector3();
  7936. const _v2$4 = /*@__PURE__*/ new Vector3();
  7937. // triangle edge vectors
  7938. const _f0 = /*@__PURE__*/ new Vector3();
  7939. const _f1 = /*@__PURE__*/ new Vector3();
  7940. const _f2 = /*@__PURE__*/ new Vector3();
  7941. const _center = /*@__PURE__*/ new Vector3();
  7942. const _extents = /*@__PURE__*/ new Vector3();
  7943. const _triangleNormal = /*@__PURE__*/ new Vector3();
  7944. const _testAxis = /*@__PURE__*/ new Vector3();
  7945. function satForAxes( axes, v0, v1, v2, extents ) {
  7946. for ( let i = 0, j = axes.length - 3; i <= j; i += 3 ) {
  7947. _testAxis.fromArray( axes, i );
  7948. // project the aabb onto the separating axis
  7949. const r = extents.x * Math.abs( _testAxis.x ) + extents.y * Math.abs( _testAxis.y ) + extents.z * Math.abs( _testAxis.z );
  7950. // project all 3 vertices of the triangle onto the separating axis
  7951. const p0 = v0.dot( _testAxis );
  7952. const p1 = v1.dot( _testAxis );
  7953. const p2 = v2.dot( _testAxis );
  7954. // actual test, basically see if either of the most extreme of the triangle points intersects r
  7955. if ( Math.max( - Math.max( p0, p1, p2 ), Math.min( p0, p1, p2 ) ) > r ) {
  7956. // points of the projected triangle are outside the projected half-length of the aabb
  7957. // the axis is separating and we can exit
  7958. return false;
  7959. }
  7960. }
  7961. return true;
  7962. }
  7963. const _box$3 = /*@__PURE__*/ new Box3();
  7964. const _v1$6 = /*@__PURE__*/ new Vector3();
  7965. const _v2$3 = /*@__PURE__*/ new Vector3();
  7966. /**
  7967. * An analytical 3D sphere defined by a center and radius. This class is mainly
  7968. * used as a Bounding Sphere for 3D objects.
  7969. */
  7970. class Sphere {
  7971. /**
  7972. * Constructs a new sphere.
  7973. *
  7974. * @param {Vector3} [center=(0,0,0)] - The center of the sphere
  7975. * @param {number} [radius=-1] - The radius of the sphere.
  7976. */
  7977. constructor( center = new Vector3(), radius = -1 ) {
  7978. /**
  7979. * This flag can be used for type testing.
  7980. *
  7981. * @type {boolean}
  7982. * @readonly
  7983. * @default true
  7984. */
  7985. this.isSphere = true;
  7986. /**
  7987. * The center of the sphere
  7988. *
  7989. * @type {Vector3}
  7990. */
  7991. this.center = center;
  7992. /**
  7993. * The radius of the sphere.
  7994. *
  7995. * @type {number}
  7996. */
  7997. this.radius = radius;
  7998. }
  7999. /**
  8000. * Sets the sphere's components by copying the given values.
  8001. *
  8002. * @param {Vector3} center - The center.
  8003. * @param {number} radius - The radius.
  8004. * @return {Sphere} A reference to this sphere.
  8005. */
  8006. set( center, radius ) {
  8007. this.center.copy( center );
  8008. this.radius = radius;
  8009. return this;
  8010. }
  8011. /**
  8012. * Computes the minimum bounding sphere for list of points.
  8013. * If the optional center point is given, it is used as the sphere's
  8014. * center. Otherwise, the center of the axis-aligned bounding box
  8015. * encompassing the points is calculated.
  8016. *
  8017. * @param {Array<Vector3>} points - A list of points in 3D space.
  8018. * @param {Vector3} [optionalCenter] - The center of the sphere.
  8019. * @return {Sphere} A reference to this sphere.
  8020. */
  8021. setFromPoints( points, optionalCenter ) {
  8022. const center = this.center;
  8023. if ( optionalCenter !== undefined ) {
  8024. center.copy( optionalCenter );
  8025. } else {
  8026. _box$3.setFromPoints( points ).getCenter( center );
  8027. }
  8028. let maxRadiusSq = 0;
  8029. for ( let i = 0, il = points.length; i < il; i ++ ) {
  8030. maxRadiusSq = Math.max( maxRadiusSq, center.distanceToSquared( points[ i ] ) );
  8031. }
  8032. this.radius = Math.sqrt( maxRadiusSq );
  8033. return this;
  8034. }
  8035. /**
  8036. * Copies the values of the given sphere to this instance.
  8037. *
  8038. * @param {Sphere} sphere - The sphere to copy.
  8039. * @return {Sphere} A reference to this sphere.
  8040. */
  8041. copy( sphere ) {
  8042. this.center.copy( sphere.center );
  8043. this.radius = sphere.radius;
  8044. return this;
  8045. }
  8046. /**
  8047. * Returns `true` if the sphere is empty (the radius set to a negative number).
  8048. *
  8049. * Spheres with a radius of `0` contain only their center point and are not
  8050. * considered to be empty.
  8051. *
  8052. * @return {boolean} Whether this sphere is empty or not.
  8053. */
  8054. isEmpty() {
  8055. return ( this.radius < 0 );
  8056. }
  8057. /**
  8058. * Makes this sphere empty which means in encloses a zero space in 3D.
  8059. *
  8060. * @return {Sphere} A reference to this sphere.
  8061. */
  8062. makeEmpty() {
  8063. this.center.set( 0, 0, 0 );
  8064. this.radius = -1;
  8065. return this;
  8066. }
  8067. /**
  8068. * Returns `true` if this sphere contains the given point inclusive of
  8069. * the surface of the sphere.
  8070. *
  8071. * @param {Vector3} point - The point to check.
  8072. * @return {boolean} Whether this sphere contains the given point or not.
  8073. */
  8074. containsPoint( point ) {
  8075. return ( point.distanceToSquared( this.center ) <= ( this.radius * this.radius ) );
  8076. }
  8077. /**
  8078. * Returns the closest distance from the boundary of the sphere to the
  8079. * given point. If the sphere contains the point, the distance will
  8080. * be negative.
  8081. *
  8082. * @param {Vector3} point - The point to compute the distance to.
  8083. * @return {number} The distance to the point.
  8084. */
  8085. distanceToPoint( point ) {
  8086. return ( point.distanceTo( this.center ) - this.radius );
  8087. }
  8088. /**
  8089. * Returns `true` if this sphere intersects with the given one.
  8090. *
  8091. * @param {Sphere} sphere - The sphere to test.
  8092. * @return {boolean} Whether this sphere intersects with the given one or not.
  8093. */
  8094. intersectsSphere( sphere ) {
  8095. const radiusSum = this.radius + sphere.radius;
  8096. return sphere.center.distanceToSquared( this.center ) <= ( radiusSum * radiusSum );
  8097. }
  8098. /**
  8099. * Returns `true` if this sphere intersects with the given box.
  8100. *
  8101. * @param {Box3} box - The box to test.
  8102. * @return {boolean} Whether this sphere intersects with the given box or not.
  8103. */
  8104. intersectsBox( box ) {
  8105. return box.intersectsSphere( this );
  8106. }
  8107. /**
  8108. * Returns `true` if this sphere intersects with the given plane.
  8109. *
  8110. * @param {Plane} plane - The plane to test.
  8111. * @return {boolean} Whether this sphere intersects with the given plane or not.
  8112. */
  8113. intersectsPlane( plane ) {
  8114. return Math.abs( plane.distanceToPoint( this.center ) ) <= this.radius;
  8115. }
  8116. /**
  8117. * Clamps a point within the sphere. If the point is outside the sphere, it
  8118. * will clamp it to the closest point on the edge of the sphere. Points
  8119. * already inside the sphere will not be affected.
  8120. *
  8121. * @param {Vector3} point - The plane to clamp.
  8122. * @param {Vector3} target - The target vector that is used to store the method's result.
  8123. * @return {Vector3} The clamped point.
  8124. */
  8125. clampPoint( point, target ) {
  8126. const deltaLengthSq = this.center.distanceToSquared( point );
  8127. target.copy( point );
  8128. if ( deltaLengthSq > ( this.radius * this.radius ) ) {
  8129. target.sub( this.center ).normalize();
  8130. target.multiplyScalar( this.radius ).add( this.center );
  8131. }
  8132. return target;
  8133. }
  8134. /**
  8135. * Returns a bounding box that encloses this sphere.
  8136. *
  8137. * @param {Box3} target - The target box that is used to store the method's result.
  8138. * @return {Box3} The bounding box that encloses this sphere.
  8139. */
  8140. getBoundingBox( target ) {
  8141. if ( this.isEmpty() ) {
  8142. // Empty sphere produces empty bounding box
  8143. target.makeEmpty();
  8144. return target;
  8145. }
  8146. target.set( this.center, this.center );
  8147. target.expandByScalar( this.radius );
  8148. return target;
  8149. }
  8150. /**
  8151. * Transforms this sphere with the given 4x4 transformation matrix.
  8152. *
  8153. * @param {Matrix4} matrix - The transformation matrix.
  8154. * @return {Sphere} A reference to this sphere.
  8155. */
  8156. applyMatrix4( matrix ) {
  8157. this.center.applyMatrix4( matrix );
  8158. this.radius = this.radius * matrix.getMaxScaleOnAxis();
  8159. return this;
  8160. }
  8161. /**
  8162. * Translates the sphere's center by the given offset.
  8163. *
  8164. * @param {Vector3} offset - The offset.
  8165. * @return {Sphere} A reference to this sphere.
  8166. */
  8167. translate( offset ) {
  8168. this.center.add( offset );
  8169. return this;
  8170. }
  8171. /**
  8172. * Expands the boundaries of this sphere to include the given point.
  8173. *
  8174. * @param {Vector3} point - The point to include.
  8175. * @return {Sphere} A reference to this sphere.
  8176. */
  8177. expandByPoint( point ) {
  8178. if ( this.isEmpty() ) {
  8179. this.center.copy( point );
  8180. this.radius = 0;
  8181. return this;
  8182. }
  8183. _v1$6.subVectors( point, this.center );
  8184. const lengthSq = _v1$6.lengthSq();
  8185. if ( lengthSq > ( this.radius * this.radius ) ) {
  8186. // calculate the minimal sphere
  8187. const length = Math.sqrt( lengthSq );
  8188. const delta = ( length - this.radius ) * 0.5;
  8189. this.center.addScaledVector( _v1$6, delta / length );
  8190. this.radius += delta;
  8191. }
  8192. return this;
  8193. }
  8194. /**
  8195. * Expands this sphere to enclose both the original sphere and the given sphere.
  8196. *
  8197. * @param {Sphere} sphere - The sphere to include.
  8198. * @return {Sphere} A reference to this sphere.
  8199. */
  8200. union( sphere ) {
  8201. if ( sphere.isEmpty() ) {
  8202. return this;
  8203. }
  8204. if ( this.isEmpty() ) {
  8205. this.copy( sphere );
  8206. return this;
  8207. }
  8208. if ( this.center.equals( sphere.center ) === true ) {
  8209. this.radius = Math.max( this.radius, sphere.radius );
  8210. } else {
  8211. _v2$3.subVectors( sphere.center, this.center ).setLength( sphere.radius );
  8212. this.expandByPoint( _v1$6.copy( sphere.center ).add( _v2$3 ) );
  8213. this.expandByPoint( _v1$6.copy( sphere.center ).sub( _v2$3 ) );
  8214. }
  8215. return this;
  8216. }
  8217. /**
  8218. * Returns `true` if this sphere is equal with the given one.
  8219. *
  8220. * @param {Sphere} sphere - The sphere to test for equality.
  8221. * @return {boolean} Whether this bounding sphere is equal with the given one.
  8222. */
  8223. equals( sphere ) {
  8224. return sphere.center.equals( this.center ) && ( sphere.radius === this.radius );
  8225. }
  8226. /**
  8227. * Returns a new sphere with copied values from this instance.
  8228. *
  8229. * @return {Sphere} A clone of this instance.
  8230. */
  8231. clone() {
  8232. return new this.constructor().copy( this );
  8233. }
  8234. /**
  8235. * Returns a serialized structure of the bounding sphere.
  8236. *
  8237. * @return {Object} Serialized structure with fields representing the object state.
  8238. */
  8239. toJSON() {
  8240. return {
  8241. radius: this.radius,
  8242. center: this.center.toArray()
  8243. };
  8244. }
  8245. /**
  8246. * Returns a serialized structure of the bounding sphere.
  8247. *
  8248. * @param {Object} json - The serialized json to set the sphere from.
  8249. * @return {Sphere} A reference to this bounding sphere.
  8250. */
  8251. fromJSON( json ) {
  8252. this.radius = json.radius;
  8253. this.center.fromArray( json.center );
  8254. return this;
  8255. }
  8256. }
  8257. const _vector$a = /*@__PURE__*/ new Vector3();
  8258. const _segCenter = /*@__PURE__*/ new Vector3();
  8259. const _segDir = /*@__PURE__*/ new Vector3();
  8260. const _diff = /*@__PURE__*/ new Vector3();
  8261. const _edge1 = /*@__PURE__*/ new Vector3();
  8262. const _edge2 = /*@__PURE__*/ new Vector3();
  8263. const _normal$1 = /*@__PURE__*/ new Vector3();
  8264. /**
  8265. * A ray that emits from an origin in a certain direction. The class is used by
  8266. * {@link Raycaster} to assist with raycasting. Raycasting is used for
  8267. * mouse picking (working out what objects in the 3D space the mouse is over)
  8268. * amongst other things.
  8269. */
  8270. class Ray {
  8271. /**
  8272. * Constructs a new ray.
  8273. *
  8274. * @param {Vector3} [origin=(0,0,0)] - The origin of the ray.
  8275. * @param {Vector3} [direction=(0,0,-1)] - The (normalized) direction of the ray.
  8276. */
  8277. constructor( origin = new Vector3(), direction = new Vector3( 0, 0, -1 ) ) {
  8278. /**
  8279. * The origin of the ray.
  8280. *
  8281. * @type {Vector3}
  8282. */
  8283. this.origin = origin;
  8284. /**
  8285. * The (normalized) direction of the ray.
  8286. *
  8287. * @type {Vector3}
  8288. */
  8289. this.direction = direction;
  8290. }
  8291. /**
  8292. * Sets the ray's components by copying the given values.
  8293. *
  8294. * @param {Vector3} origin - The origin.
  8295. * @param {Vector3} direction - The direction.
  8296. * @return {Ray} A reference to this ray.
  8297. */
  8298. set( origin, direction ) {
  8299. this.origin.copy( origin );
  8300. this.direction.copy( direction );
  8301. return this;
  8302. }
  8303. /**
  8304. * Copies the values of the given ray to this instance.
  8305. *
  8306. * @param {Ray} ray - The ray to copy.
  8307. * @return {Ray} A reference to this ray.
  8308. */
  8309. copy( ray ) {
  8310. this.origin.copy( ray.origin );
  8311. this.direction.copy( ray.direction );
  8312. return this;
  8313. }
  8314. /**
  8315. * Returns a vector that is located at a given distance along this ray.
  8316. *
  8317. * @param {number} t - The distance along the ray to retrieve a position for.
  8318. * @param {Vector3} target - The target vector that is used to store the method's result.
  8319. * @return {Vector3} A position on the ray.
  8320. */
  8321. at( t, target ) {
  8322. return target.copy( this.origin ).addScaledVector( this.direction, t );
  8323. }
  8324. /**
  8325. * Adjusts the direction of the ray to point at the given vector in world space.
  8326. *
  8327. * @param {Vector3} v - The target position.
  8328. * @return {Ray} A reference to this ray.
  8329. */
  8330. lookAt( v ) {
  8331. this.direction.copy( v ).sub( this.origin ).normalize();
  8332. return this;
  8333. }
  8334. /**
  8335. * Shift the origin of this ray along its direction by the given distance.
  8336. *
  8337. * @param {number} t - The distance along the ray to interpolate.
  8338. * @return {Ray} A reference to this ray.
  8339. */
  8340. recast( t ) {
  8341. this.origin.copy( this.at( t, _vector$a ) );
  8342. return this;
  8343. }
  8344. /**
  8345. * Returns the point along this ray that is closest to the given point.
  8346. *
  8347. * @param {Vector3} point - A point in 3D space to get the closet location on the ray for.
  8348. * @param {Vector3} target - The target vector that is used to store the method's result.
  8349. * @return {Vector3} The closest point on this ray.
  8350. */
  8351. closestPointToPoint( point, target ) {
  8352. target.subVectors( point, this.origin );
  8353. const directionDistance = target.dot( this.direction );
  8354. if ( directionDistance < 0 ) {
  8355. return target.copy( this.origin );
  8356. }
  8357. return target.copy( this.origin ).addScaledVector( this.direction, directionDistance );
  8358. }
  8359. /**
  8360. * Returns the distance of the closest approach between this ray and the given point.
  8361. *
  8362. * @param {Vector3} point - A point in 3D space to compute the distance to.
  8363. * @return {number} The distance.
  8364. */
  8365. distanceToPoint( point ) {
  8366. return Math.sqrt( this.distanceSqToPoint( point ) );
  8367. }
  8368. /**
  8369. * Returns the squared distance of the closest approach between this ray and the given point.
  8370. *
  8371. * @param {Vector3} point - A point in 3D space to compute the distance to.
  8372. * @return {number} The squared distance.
  8373. */
  8374. distanceSqToPoint( point ) {
  8375. const directionDistance = _vector$a.subVectors( point, this.origin ).dot( this.direction );
  8376. // point behind the ray
  8377. if ( directionDistance < 0 ) {
  8378. return this.origin.distanceToSquared( point );
  8379. }
  8380. _vector$a.copy( this.origin ).addScaledVector( this.direction, directionDistance );
  8381. return _vector$a.distanceToSquared( point );
  8382. }
  8383. /**
  8384. * Returns the squared distance between this ray and the given line segment.
  8385. *
  8386. * @param {Vector3} v0 - The start point of the line segment.
  8387. * @param {Vector3} v1 - The end point of the line segment.
  8388. * @param {Vector3} [optionalPointOnRay] - When provided, it receives the point on this ray that is closest to the segment.
  8389. * @param {Vector3} [optionalPointOnSegment] - When provided, it receives the point on the line segment that is closest to this ray.
  8390. * @return {number} The squared distance.
  8391. */
  8392. distanceSqToSegment( v0, v1, optionalPointOnRay, optionalPointOnSegment ) {
  8393. // from https://github.com/pmjoniak/GeometricTools/blob/master/GTEngine/Include/Mathematics/GteDistRaySegment.h
  8394. // It returns the min distance between the ray and the segment
  8395. // defined by v0 and v1
  8396. // It can also set two optional targets :
  8397. // - The closest point on the ray
  8398. // - The closest point on the segment
  8399. _segCenter.copy( v0 ).add( v1 ).multiplyScalar( 0.5 );
  8400. _segDir.copy( v1 ).sub( v0 ).normalize();
  8401. _diff.copy( this.origin ).sub( _segCenter );
  8402. const segExtent = v0.distanceTo( v1 ) * 0.5;
  8403. const a01 = - this.direction.dot( _segDir );
  8404. const b0 = _diff.dot( this.direction );
  8405. const b1 = - _diff.dot( _segDir );
  8406. const c = _diff.lengthSq();
  8407. const det = Math.abs( 1 - a01 * a01 );
  8408. let s0, s1, sqrDist, extDet;
  8409. if ( det > 0 ) {
  8410. // The ray and segment are not parallel.
  8411. s0 = a01 * b1 - b0;
  8412. s1 = a01 * b0 - b1;
  8413. extDet = segExtent * det;
  8414. if ( s0 >= 0 ) {
  8415. if ( s1 >= - extDet ) {
  8416. if ( s1 <= extDet ) {
  8417. // region 0
  8418. // Minimum at interior points of ray and segment.
  8419. const invDet = 1 / det;
  8420. s0 *= invDet;
  8421. s1 *= invDet;
  8422. sqrDist = s0 * ( s0 + a01 * s1 + 2 * b0 ) + s1 * ( a01 * s0 + s1 + 2 * b1 ) + c;
  8423. } else {
  8424. // region 1
  8425. s1 = segExtent;
  8426. s0 = Math.max( 0, - ( a01 * s1 + b0 ) );
  8427. sqrDist = - s0 * s0 + s1 * ( s1 + 2 * b1 ) + c;
  8428. }
  8429. } else {
  8430. // region 5
  8431. s1 = - segExtent;
  8432. s0 = Math.max( 0, - ( a01 * s1 + b0 ) );
  8433. sqrDist = - s0 * s0 + s1 * ( s1 + 2 * b1 ) + c;
  8434. }
  8435. } else {
  8436. if ( s1 <= - extDet ) {
  8437. // region 4
  8438. s0 = Math.max( 0, - ( - a01 * segExtent + b0 ) );
  8439. s1 = ( s0 > 0 ) ? - segExtent : Math.min( Math.max( - segExtent, - b1 ), segExtent );
  8440. sqrDist = - s0 * s0 + s1 * ( s1 + 2 * b1 ) + c;
  8441. } else if ( s1 <= extDet ) {
  8442. // region 3
  8443. s0 = 0;
  8444. s1 = Math.min( Math.max( - segExtent, - b1 ), segExtent );
  8445. sqrDist = s1 * ( s1 + 2 * b1 ) + c;
  8446. } else {
  8447. // region 2
  8448. s0 = Math.max( 0, - ( a01 * segExtent + b0 ) );
  8449. s1 = ( s0 > 0 ) ? segExtent : Math.min( Math.max( - segExtent, - b1 ), segExtent );
  8450. sqrDist = - s0 * s0 + s1 * ( s1 + 2 * b1 ) + c;
  8451. }
  8452. }
  8453. } else {
  8454. // Ray and segment are parallel.
  8455. s1 = ( a01 > 0 ) ? - segExtent : segExtent;
  8456. s0 = Math.max( 0, - ( a01 * s1 + b0 ) );
  8457. sqrDist = - s0 * s0 + s1 * ( s1 + 2 * b1 ) + c;
  8458. }
  8459. if ( optionalPointOnRay ) {
  8460. optionalPointOnRay.copy( this.origin ).addScaledVector( this.direction, s0 );
  8461. }
  8462. if ( optionalPointOnSegment ) {
  8463. optionalPointOnSegment.copy( _segCenter ).addScaledVector( _segDir, s1 );
  8464. }
  8465. return sqrDist;
  8466. }
  8467. /**
  8468. * Intersects this ray with the given sphere, returning the intersection
  8469. * point or `null` if there is no intersection.
  8470. *
  8471. * @param {Sphere} sphere - The sphere to intersect.
  8472. * @param {Vector3} target - The target vector that is used to store the method's result.
  8473. * @return {?Vector3} The intersection point.
  8474. */
  8475. intersectSphere( sphere, target ) {
  8476. _vector$a.subVectors( sphere.center, this.origin );
  8477. const tca = _vector$a.dot( this.direction );
  8478. const d2 = _vector$a.dot( _vector$a ) - tca * tca;
  8479. const radius2 = sphere.radius * sphere.radius;
  8480. if ( d2 > radius2 ) return null;
  8481. const thc = Math.sqrt( radius2 - d2 );
  8482. // t0 = first intersect point - entrance on front of sphere
  8483. const t0 = tca - thc;
  8484. // t1 = second intersect point - exit point on back of sphere
  8485. const t1 = tca + thc;
  8486. // test to see if t1 is behind the ray - if so, return null
  8487. if ( t1 < 0 ) return null;
  8488. // test to see if t0 is behind the ray:
  8489. // if it is, the ray is inside the sphere, so return the second exit point scaled by t1,
  8490. // in order to always return an intersect point that is in front of the ray.
  8491. if ( t0 < 0 ) return this.at( t1, target );
  8492. // else t0 is in front of the ray, so return the first collision point scaled by t0
  8493. return this.at( t0, target );
  8494. }
  8495. /**
  8496. * Returns `true` if this ray intersects with the given sphere.
  8497. *
  8498. * @param {Sphere} sphere - The sphere to intersect.
  8499. * @return {boolean} Whether this ray intersects with the given sphere or not.
  8500. */
  8501. intersectsSphere( sphere ) {
  8502. if ( sphere.radius < 0 ) return false; // handle empty spheres, see #31187
  8503. return this.distanceSqToPoint( sphere.center ) <= ( sphere.radius * sphere.radius );
  8504. }
  8505. /**
  8506. * Computes the distance from the ray's origin to the given plane. Returns `null` if the ray
  8507. * does not intersect with the plane.
  8508. *
  8509. * @param {Plane} plane - The plane to compute the distance to.
  8510. * @return {?number} Whether this ray intersects with the given sphere or not.
  8511. */
  8512. distanceToPlane( plane ) {
  8513. const denominator = plane.normal.dot( this.direction );
  8514. if ( denominator === 0 ) {
  8515. // line is coplanar, return origin
  8516. if ( plane.distanceToPoint( this.origin ) === 0 ) {
  8517. return 0;
  8518. }
  8519. // Null is preferable to undefined since undefined means.... it is undefined
  8520. return null;
  8521. }
  8522. const t = - ( this.origin.dot( plane.normal ) + plane.constant ) / denominator;
  8523. // Return if the ray never intersects the plane
  8524. return t >= 0 ? t : null;
  8525. }
  8526. /**
  8527. * Intersects this ray with the given plane, returning the intersection
  8528. * point or `null` if there is no intersection.
  8529. *
  8530. * @param {Plane} plane - The plane to intersect.
  8531. * @param {Vector3} target - The target vector that is used to store the method's result.
  8532. * @return {?Vector3} The intersection point.
  8533. */
  8534. intersectPlane( plane, target ) {
  8535. const t = this.distanceToPlane( plane );
  8536. if ( t === null ) {
  8537. return null;
  8538. }
  8539. return this.at( t, target );
  8540. }
  8541. /**
  8542. * Returns `true` if this ray intersects with the given plane.
  8543. *
  8544. * @param {Plane} plane - The plane to intersect.
  8545. * @return {boolean} Whether this ray intersects with the given plane or not.
  8546. */
  8547. intersectsPlane( plane ) {
  8548. // check if the ray lies on the plane first
  8549. const distToPoint = plane.distanceToPoint( this.origin );
  8550. if ( distToPoint === 0 ) {
  8551. return true;
  8552. }
  8553. const denominator = plane.normal.dot( this.direction );
  8554. if ( denominator * distToPoint < 0 ) {
  8555. return true;
  8556. }
  8557. // ray origin is behind the plane (and is pointing behind it)
  8558. return false;
  8559. }
  8560. /**
  8561. * Intersects this ray with the given bounding box, returning the intersection
  8562. * point or `null` if there is no intersection.
  8563. *
  8564. * @param {Box3} box - The box to intersect.
  8565. * @param {Vector3} target - The target vector that is used to store the method's result.
  8566. * @return {?Vector3} The intersection point.
  8567. */
  8568. intersectBox( box, target ) {
  8569. let tmin, tmax, tymin, tymax, tzmin, tzmax;
  8570. const invdirx = 1 / this.direction.x,
  8571. invdiry = 1 / this.direction.y,
  8572. invdirz = 1 / this.direction.z;
  8573. const origin = this.origin;
  8574. if ( invdirx >= 0 ) {
  8575. tmin = ( box.min.x - origin.x ) * invdirx;
  8576. tmax = ( box.max.x - origin.x ) * invdirx;
  8577. } else {
  8578. tmin = ( box.max.x - origin.x ) * invdirx;
  8579. tmax = ( box.min.x - origin.x ) * invdirx;
  8580. }
  8581. if ( invdiry >= 0 ) {
  8582. tymin = ( box.min.y - origin.y ) * invdiry;
  8583. tymax = ( box.max.y - origin.y ) * invdiry;
  8584. } else {
  8585. tymin = ( box.max.y - origin.y ) * invdiry;
  8586. tymax = ( box.min.y - origin.y ) * invdiry;
  8587. }
  8588. if ( ( tmin > tymax ) || ( tymin > tmax ) ) return null;
  8589. if ( tymin > tmin || isNaN( tmin ) ) tmin = tymin;
  8590. if ( tymax < tmax || isNaN( tmax ) ) tmax = tymax;
  8591. if ( invdirz >= 0 ) {
  8592. tzmin = ( box.min.z - origin.z ) * invdirz;
  8593. tzmax = ( box.max.z - origin.z ) * invdirz;
  8594. } else {
  8595. tzmin = ( box.max.z - origin.z ) * invdirz;
  8596. tzmax = ( box.min.z - origin.z ) * invdirz;
  8597. }
  8598. if ( ( tmin > tzmax ) || ( tzmin > tmax ) ) return null;
  8599. if ( tzmin > tmin || tmin !== tmin ) tmin = tzmin;
  8600. if ( tzmax < tmax || tmax !== tmax ) tmax = tzmax;
  8601. //return point closest to the ray (positive side)
  8602. if ( tmax < 0 ) return null;
  8603. return this.at( tmin >= 0 ? tmin : tmax, target );
  8604. }
  8605. /**
  8606. * Returns `true` if this ray intersects with the given box.
  8607. *
  8608. * @param {Box3} box - The box to intersect.
  8609. * @return {boolean} Whether this ray intersects with the given box or not.
  8610. */
  8611. intersectsBox( box ) {
  8612. return this.intersectBox( box, _vector$a ) !== null;
  8613. }
  8614. /**
  8615. * Intersects this ray with the given triangle, returning the intersection
  8616. * point or `null` if there is no intersection.
  8617. *
  8618. * @param {Vector3} a - The first vertex of the triangle.
  8619. * @param {Vector3} b - The second vertex of the triangle.
  8620. * @param {Vector3} c - The third vertex of the triangle.
  8621. * @param {boolean} backfaceCulling - Whether to use backface culling or not.
  8622. * @param {Vector3} target - The target vector that is used to store the method's result.
  8623. * @return {?Vector3} The intersection point.
  8624. */
  8625. intersectTriangle( a, b, c, backfaceCulling, target ) {
  8626. // Compute the offset origin, edges, and normal.
  8627. // from https://github.com/pmjoniak/GeometricTools/blob/master/GTEngine/Include/Mathematics/GteIntrRay3Triangle3.h
  8628. _edge1.subVectors( b, a );
  8629. _edge2.subVectors( c, a );
  8630. _normal$1.crossVectors( _edge1, _edge2 );
  8631. // Solve Q + t*D = b1*E1 + b2*E2 (Q = kDiff, D = ray direction,
  8632. // E1 = kEdge1, E2 = kEdge2, N = Cross(E1,E2)) by
  8633. // |Dot(D,N)|*b1 = sign(Dot(D,N))*Dot(D,Cross(Q,E2))
  8634. // |Dot(D,N)|*b2 = sign(Dot(D,N))*Dot(D,Cross(E1,Q))
  8635. // |Dot(D,N)|*t = -sign(Dot(D,N))*Dot(Q,N)
  8636. let DdN = this.direction.dot( _normal$1 );
  8637. let sign;
  8638. if ( DdN > 0 ) {
  8639. if ( backfaceCulling ) return null;
  8640. sign = 1;
  8641. } else if ( DdN < 0 ) {
  8642. sign = -1;
  8643. DdN = - DdN;
  8644. } else {
  8645. return null;
  8646. }
  8647. _diff.subVectors( this.origin, a );
  8648. const DdQxE2 = sign * this.direction.dot( _edge2.crossVectors( _diff, _edge2 ) );
  8649. // b1 < 0, no intersection
  8650. if ( DdQxE2 < 0 ) {
  8651. return null;
  8652. }
  8653. const DdE1xQ = sign * this.direction.dot( _edge1.cross( _diff ) );
  8654. // b2 < 0, no intersection
  8655. if ( DdE1xQ < 0 ) {
  8656. return null;
  8657. }
  8658. // b1+b2 > 1, no intersection
  8659. if ( DdQxE2 + DdE1xQ > DdN ) {
  8660. return null;
  8661. }
  8662. // Line intersects triangle, check if ray does.
  8663. const QdN = - sign * _diff.dot( _normal$1 );
  8664. // t < 0, no intersection
  8665. if ( QdN < 0 ) {
  8666. return null;
  8667. }
  8668. // Ray intersects triangle.
  8669. return this.at( QdN / DdN, target );
  8670. }
  8671. /**
  8672. * Transforms this ray with the given 4x4 transformation matrix.
  8673. *
  8674. * @param {Matrix4} matrix4 - The transformation matrix.
  8675. * @return {Ray} A reference to this ray.
  8676. */
  8677. applyMatrix4( matrix4 ) {
  8678. this.origin.applyMatrix4( matrix4 );
  8679. this.direction.transformDirection( matrix4 );
  8680. return this;
  8681. }
  8682. /**
  8683. * Returns `true` if this ray is equal with the given one.
  8684. *
  8685. * @param {Ray} ray - The ray to test for equality.
  8686. * @return {boolean} Whether this ray is equal with the given one.
  8687. */
  8688. equals( ray ) {
  8689. return ray.origin.equals( this.origin ) && ray.direction.equals( this.direction );
  8690. }
  8691. /**
  8692. * Returns a new ray with copied values from this instance.
  8693. *
  8694. * @return {Ray} A clone of this instance.
  8695. */
  8696. clone() {
  8697. return new this.constructor().copy( this );
  8698. }
  8699. }
  8700. /**
  8701. * Represents a 4x4 matrix.
  8702. *
  8703. * The most common use of a 4x4 matrix in 3D computer graphics is as a transformation matrix.
  8704. * For an introduction to transformation matrices as used in WebGL, check out [this tutorial](https://www.opengl-tutorial.org/beginners-tutorials/tutorial-3-matrices)
  8705. *
  8706. * This allows a 3D vector representing a point in 3D space to undergo
  8707. * transformations such as translation, rotation, shear, scale, reflection,
  8708. * orthogonal or perspective projection and so on, by being multiplied by the
  8709. * matrix. This is known as `applying` the matrix to the vector.
  8710. *
  8711. * A Note on Row-Major and Column-Major Ordering:
  8712. *
  8713. * The constructor and {@link Matrix3#set} method take arguments in
  8714. * [row-major](https://en.wikipedia.org/wiki/Row-_and_column-major_order#Column-major_order)
  8715. * order, while internally they are stored in the {@link Matrix3#elements} array in column-major order.
  8716. * This means that calling:
  8717. * ```js
  8718. * const m = new THREE.Matrix4();
  8719. * m.set( 11, 12, 13, 14,
  8720. * 21, 22, 23, 24,
  8721. * 31, 32, 33, 34,
  8722. * 41, 42, 43, 44 );
  8723. * ```
  8724. * will result in the elements array containing:
  8725. * ```js
  8726. * m.elements = [ 11, 21, 31, 41,
  8727. * 12, 22, 32, 42,
  8728. * 13, 23, 33, 43,
  8729. * 14, 24, 34, 44 ];
  8730. * ```
  8731. * and internally all calculations are performed using column-major ordering.
  8732. * However, as the actual ordering makes no difference mathematically and
  8733. * most people are used to thinking about matrices in row-major order, the
  8734. * three.js documentation shows matrices in row-major order. Just bear in
  8735. * mind that if you are reading the source code, you'll have to take the
  8736. * transpose of any matrices outlined here to make sense of the calculations.
  8737. */
  8738. class Matrix4 {
  8739. /**
  8740. * Constructs a new 4x4 matrix. The arguments are supposed to be
  8741. * in row-major order. If no arguments are provided, the constructor
  8742. * initializes the matrix as an identity matrix.
  8743. *
  8744. * @param {number} [n11] - 1-1 matrix element.
  8745. * @param {number} [n12] - 1-2 matrix element.
  8746. * @param {number} [n13] - 1-3 matrix element.
  8747. * @param {number} [n14] - 1-4 matrix element.
  8748. * @param {number} [n21] - 2-1 matrix element.
  8749. * @param {number} [n22] - 2-2 matrix element.
  8750. * @param {number} [n23] - 2-3 matrix element.
  8751. * @param {number} [n24] - 2-4 matrix element.
  8752. * @param {number} [n31] - 3-1 matrix element.
  8753. * @param {number} [n32] - 3-2 matrix element.
  8754. * @param {number} [n33] - 3-3 matrix element.
  8755. * @param {number} [n34] - 3-4 matrix element.
  8756. * @param {number} [n41] - 4-1 matrix element.
  8757. * @param {number} [n42] - 4-2 matrix element.
  8758. * @param {number} [n43] - 4-3 matrix element.
  8759. * @param {number} [n44] - 4-4 matrix element.
  8760. */
  8761. constructor( n11, n12, n13, n14, n21, n22, n23, n24, n31, n32, n33, n34, n41, n42, n43, n44 ) {
  8762. /**
  8763. * This flag can be used for type testing.
  8764. *
  8765. * @type {boolean}
  8766. * @readonly
  8767. * @default true
  8768. */
  8769. Matrix4.prototype.isMatrix4 = true;
  8770. /**
  8771. * A column-major list of matrix values.
  8772. *
  8773. * @type {Array<number>}
  8774. */
  8775. this.elements = [
  8776. 1, 0, 0, 0,
  8777. 0, 1, 0, 0,
  8778. 0, 0, 1, 0,
  8779. 0, 0, 0, 1
  8780. ];
  8781. if ( n11 !== undefined ) {
  8782. this.set( n11, n12, n13, n14, n21, n22, n23, n24, n31, n32, n33, n34, n41, n42, n43, n44 );
  8783. }
  8784. }
  8785. /**
  8786. * Sets the elements of the matrix.The arguments are supposed to be
  8787. * in row-major order.
  8788. *
  8789. * @param {number} [n11] - 1-1 matrix element.
  8790. * @param {number} [n12] - 1-2 matrix element.
  8791. * @param {number} [n13] - 1-3 matrix element.
  8792. * @param {number} [n14] - 1-4 matrix element.
  8793. * @param {number} [n21] - 2-1 matrix element.
  8794. * @param {number} [n22] - 2-2 matrix element.
  8795. * @param {number} [n23] - 2-3 matrix element.
  8796. * @param {number} [n24] - 2-4 matrix element.
  8797. * @param {number} [n31] - 3-1 matrix element.
  8798. * @param {number} [n32] - 3-2 matrix element.
  8799. * @param {number} [n33] - 3-3 matrix element.
  8800. * @param {number} [n34] - 3-4 matrix element.
  8801. * @param {number} [n41] - 4-1 matrix element.
  8802. * @param {number} [n42] - 4-2 matrix element.
  8803. * @param {number} [n43] - 4-3 matrix element.
  8804. * @param {number} [n44] - 4-4 matrix element.
  8805. * @return {Matrix4} A reference to this matrix.
  8806. */
  8807. set( n11, n12, n13, n14, n21, n22, n23, n24, n31, n32, n33, n34, n41, n42, n43, n44 ) {
  8808. const te = this.elements;
  8809. te[ 0 ] = n11; te[ 4 ] = n12; te[ 8 ] = n13; te[ 12 ] = n14;
  8810. te[ 1 ] = n21; te[ 5 ] = n22; te[ 9 ] = n23; te[ 13 ] = n24;
  8811. te[ 2 ] = n31; te[ 6 ] = n32; te[ 10 ] = n33; te[ 14 ] = n34;
  8812. te[ 3 ] = n41; te[ 7 ] = n42; te[ 11 ] = n43; te[ 15 ] = n44;
  8813. return this;
  8814. }
  8815. /**
  8816. * Sets this matrix to the 4x4 identity matrix.
  8817. *
  8818. * @return {Matrix4} A reference to this matrix.
  8819. */
  8820. identity() {
  8821. this.set(
  8822. 1, 0, 0, 0,
  8823. 0, 1, 0, 0,
  8824. 0, 0, 1, 0,
  8825. 0, 0, 0, 1
  8826. );
  8827. return this;
  8828. }
  8829. /**
  8830. * Returns a matrix with copied values from this instance.
  8831. *
  8832. * @return {Matrix4} A clone of this instance.
  8833. */
  8834. clone() {
  8835. return new Matrix4().fromArray( this.elements );
  8836. }
  8837. /**
  8838. * Copies the values of the given matrix to this instance.
  8839. *
  8840. * @param {Matrix4} m - The matrix to copy.
  8841. * @return {Matrix4} A reference to this matrix.
  8842. */
  8843. copy( m ) {
  8844. const te = this.elements;
  8845. const me = m.elements;
  8846. te[ 0 ] = me[ 0 ]; te[ 1 ] = me[ 1 ]; te[ 2 ] = me[ 2 ]; te[ 3 ] = me[ 3 ];
  8847. te[ 4 ] = me[ 4 ]; te[ 5 ] = me[ 5 ]; te[ 6 ] = me[ 6 ]; te[ 7 ] = me[ 7 ];
  8848. te[ 8 ] = me[ 8 ]; te[ 9 ] = me[ 9 ]; te[ 10 ] = me[ 10 ]; te[ 11 ] = me[ 11 ];
  8849. te[ 12 ] = me[ 12 ]; te[ 13 ] = me[ 13 ]; te[ 14 ] = me[ 14 ]; te[ 15 ] = me[ 15 ];
  8850. return this;
  8851. }
  8852. /**
  8853. * Copies the translation component of the given matrix
  8854. * into this matrix's translation component.
  8855. *
  8856. * @param {Matrix4} m - The matrix to copy the translation component.
  8857. * @return {Matrix4} A reference to this matrix.
  8858. */
  8859. copyPosition( m ) {
  8860. const te = this.elements, me = m.elements;
  8861. te[ 12 ] = me[ 12 ];
  8862. te[ 13 ] = me[ 13 ];
  8863. te[ 14 ] = me[ 14 ];
  8864. return this;
  8865. }
  8866. /**
  8867. * Set the upper 3x3 elements of this matrix to the values of given 3x3 matrix.
  8868. *
  8869. * @param {Matrix3} m - The 3x3 matrix.
  8870. * @return {Matrix4} A reference to this matrix.
  8871. */
  8872. setFromMatrix3( m ) {
  8873. const me = m.elements;
  8874. this.set(
  8875. me[ 0 ], me[ 3 ], me[ 6 ], 0,
  8876. me[ 1 ], me[ 4 ], me[ 7 ], 0,
  8877. me[ 2 ], me[ 5 ], me[ 8 ], 0,
  8878. 0, 0, 0, 1
  8879. );
  8880. return this;
  8881. }
  8882. /**
  8883. * Extracts the basis of this matrix into the three axis vectors provided.
  8884. *
  8885. * @param {Vector3} xAxis - The basis's x axis.
  8886. * @param {Vector3} yAxis - The basis's y axis.
  8887. * @param {Vector3} zAxis - The basis's z axis.
  8888. * @return {Matrix4} A reference to this matrix.
  8889. */
  8890. extractBasis( xAxis, yAxis, zAxis ) {
  8891. if ( this.determinant() === 0 ) {
  8892. xAxis.set( 1, 0, 0 );
  8893. yAxis.set( 0, 1, 0 );
  8894. zAxis.set( 0, 0, 1 );
  8895. return this;
  8896. }
  8897. xAxis.setFromMatrixColumn( this, 0 );
  8898. yAxis.setFromMatrixColumn( this, 1 );
  8899. zAxis.setFromMatrixColumn( this, 2 );
  8900. return this;
  8901. }
  8902. /**
  8903. * Sets the given basis vectors to this matrix.
  8904. *
  8905. * @param {Vector3} xAxis - The basis's x axis.
  8906. * @param {Vector3} yAxis - The basis's y axis.
  8907. * @param {Vector3} zAxis - The basis's z axis.
  8908. * @return {Matrix4} A reference to this matrix.
  8909. */
  8910. makeBasis( xAxis, yAxis, zAxis ) {
  8911. this.set(
  8912. xAxis.x, yAxis.x, zAxis.x, 0,
  8913. xAxis.y, yAxis.y, zAxis.y, 0,
  8914. xAxis.z, yAxis.z, zAxis.z, 0,
  8915. 0, 0, 0, 1
  8916. );
  8917. return this;
  8918. }
  8919. /**
  8920. * Extracts the rotation component of the given matrix
  8921. * into this matrix's rotation component.
  8922. *
  8923. * Note: This method does not support reflection matrices.
  8924. *
  8925. * @param {Matrix4} m - The matrix.
  8926. * @return {Matrix4} A reference to this matrix.
  8927. */
  8928. extractRotation( m ) {
  8929. if ( m.determinant() === 0 ) {
  8930. return this.identity();
  8931. }
  8932. const te = this.elements;
  8933. const me = m.elements;
  8934. const scaleX = 1 / _v1$5.setFromMatrixColumn( m, 0 ).length();
  8935. const scaleY = 1 / _v1$5.setFromMatrixColumn( m, 1 ).length();
  8936. const scaleZ = 1 / _v1$5.setFromMatrixColumn( m, 2 ).length();
  8937. te[ 0 ] = me[ 0 ] * scaleX;
  8938. te[ 1 ] = me[ 1 ] * scaleX;
  8939. te[ 2 ] = me[ 2 ] * scaleX;
  8940. te[ 3 ] = 0;
  8941. te[ 4 ] = me[ 4 ] * scaleY;
  8942. te[ 5 ] = me[ 5 ] * scaleY;
  8943. te[ 6 ] = me[ 6 ] * scaleY;
  8944. te[ 7 ] = 0;
  8945. te[ 8 ] = me[ 8 ] * scaleZ;
  8946. te[ 9 ] = me[ 9 ] * scaleZ;
  8947. te[ 10 ] = me[ 10 ] * scaleZ;
  8948. te[ 11 ] = 0;
  8949. te[ 12 ] = 0;
  8950. te[ 13 ] = 0;
  8951. te[ 14 ] = 0;
  8952. te[ 15 ] = 1;
  8953. return this;
  8954. }
  8955. /**
  8956. * Sets the rotation component (the upper left 3x3 matrix) of this matrix to
  8957. * the rotation specified by the given Euler angles. The rest of
  8958. * the matrix is set to the identity. Depending on the {@link Euler#order},
  8959. * there are six possible outcomes. See [this page](https://en.wikipedia.org/wiki/Euler_angles#Rotation_matrix)
  8960. * for a complete list.
  8961. *
  8962. * @param {Euler} euler - The Euler angles.
  8963. * @return {Matrix4} A reference to this matrix.
  8964. */
  8965. makeRotationFromEuler( euler ) {
  8966. const te = this.elements;
  8967. const x = euler.x, y = euler.y, z = euler.z;
  8968. const a = Math.cos( x ), b = Math.sin( x );
  8969. const c = Math.cos( y ), d = Math.sin( y );
  8970. const e = Math.cos( z ), f = Math.sin( z );
  8971. if ( euler.order === 'XYZ' ) {
  8972. const ae = a * e, af = a * f, be = b * e, bf = b * f;
  8973. te[ 0 ] = c * e;
  8974. te[ 4 ] = - c * f;
  8975. te[ 8 ] = d;
  8976. te[ 1 ] = af + be * d;
  8977. te[ 5 ] = ae - bf * d;
  8978. te[ 9 ] = - b * c;
  8979. te[ 2 ] = bf - ae * d;
  8980. te[ 6 ] = be + af * d;
  8981. te[ 10 ] = a * c;
  8982. } else if ( euler.order === 'YXZ' ) {
  8983. const ce = c * e, cf = c * f, de = d * e, df = d * f;
  8984. te[ 0 ] = ce + df * b;
  8985. te[ 4 ] = de * b - cf;
  8986. te[ 8 ] = a * d;
  8987. te[ 1 ] = a * f;
  8988. te[ 5 ] = a * e;
  8989. te[ 9 ] = - b;
  8990. te[ 2 ] = cf * b - de;
  8991. te[ 6 ] = df + ce * b;
  8992. te[ 10 ] = a * c;
  8993. } else if ( euler.order === 'ZXY' ) {
  8994. const ce = c * e, cf = c * f, de = d * e, df = d * f;
  8995. te[ 0 ] = ce - df * b;
  8996. te[ 4 ] = - a * f;
  8997. te[ 8 ] = de + cf * b;
  8998. te[ 1 ] = cf + de * b;
  8999. te[ 5 ] = a * e;
  9000. te[ 9 ] = df - ce * b;
  9001. te[ 2 ] = - a * d;
  9002. te[ 6 ] = b;
  9003. te[ 10 ] = a * c;
  9004. } else if ( euler.order === 'ZYX' ) {
  9005. const ae = a * e, af = a * f, be = b * e, bf = b * f;
  9006. te[ 0 ] = c * e;
  9007. te[ 4 ] = be * d - af;
  9008. te[ 8 ] = ae * d + bf;
  9009. te[ 1 ] = c * f;
  9010. te[ 5 ] = bf * d + ae;
  9011. te[ 9 ] = af * d - be;
  9012. te[ 2 ] = - d;
  9013. te[ 6 ] = b * c;
  9014. te[ 10 ] = a * c;
  9015. } else if ( euler.order === 'YZX' ) {
  9016. const ac = a * c, ad = a * d, bc = b * c, bd = b * d;
  9017. te[ 0 ] = c * e;
  9018. te[ 4 ] = bd - ac * f;
  9019. te[ 8 ] = bc * f + ad;
  9020. te[ 1 ] = f;
  9021. te[ 5 ] = a * e;
  9022. te[ 9 ] = - b * e;
  9023. te[ 2 ] = - d * e;
  9024. te[ 6 ] = ad * f + bc;
  9025. te[ 10 ] = ac - bd * f;
  9026. } else if ( euler.order === 'XZY' ) {
  9027. const ac = a * c, ad = a * d, bc = b * c, bd = b * d;
  9028. te[ 0 ] = c * e;
  9029. te[ 4 ] = - f;
  9030. te[ 8 ] = d * e;
  9031. te[ 1 ] = ac * f + bd;
  9032. te[ 5 ] = a * e;
  9033. te[ 9 ] = ad * f - bc;
  9034. te[ 2 ] = bc * f - ad;
  9035. te[ 6 ] = b * e;
  9036. te[ 10 ] = bd * f + ac;
  9037. }
  9038. // bottom row
  9039. te[ 3 ] = 0;
  9040. te[ 7 ] = 0;
  9041. te[ 11 ] = 0;
  9042. // last column
  9043. te[ 12 ] = 0;
  9044. te[ 13 ] = 0;
  9045. te[ 14 ] = 0;
  9046. te[ 15 ] = 1;
  9047. return this;
  9048. }
  9049. /**
  9050. * Sets the rotation component of this matrix to the rotation specified by
  9051. * the given Quaternion as outlined [here](https://en.wikipedia.org/wiki/Rotation_matrix#Quaternion)
  9052. * The rest of the matrix is set to the identity.
  9053. *
  9054. * @param {Quaternion} q - The Quaternion.
  9055. * @return {Matrix4} A reference to this matrix.
  9056. */
  9057. makeRotationFromQuaternion( q ) {
  9058. return this.compose( _zero, q, _one );
  9059. }
  9060. /**
  9061. * Sets the rotation component of the transformation matrix, looking from `eye` towards
  9062. * `target`, and oriented by the up-direction.
  9063. *
  9064. * @param {Vector3} eye - The eye vector.
  9065. * @param {Vector3} target - The target vector.
  9066. * @param {Vector3} up - The up vector.
  9067. * @return {Matrix4} A reference to this matrix.
  9068. */
  9069. lookAt( eye, target, up ) {
  9070. const te = this.elements;
  9071. _z.subVectors( eye, target );
  9072. if ( _z.lengthSq() === 0 ) {
  9073. // eye and target are in the same position
  9074. _z.z = 1;
  9075. }
  9076. _z.normalize();
  9077. _x.crossVectors( up, _z );
  9078. if ( _x.lengthSq() === 0 ) {
  9079. // up and z are parallel
  9080. if ( Math.abs( up.z ) === 1 ) {
  9081. _z.x += 0.0001;
  9082. } else {
  9083. _z.z += 0.0001;
  9084. }
  9085. _z.normalize();
  9086. _x.crossVectors( up, _z );
  9087. }
  9088. _x.normalize();
  9089. _y.crossVectors( _z, _x );
  9090. te[ 0 ] = _x.x; te[ 4 ] = _y.x; te[ 8 ] = _z.x;
  9091. te[ 1 ] = _x.y; te[ 5 ] = _y.y; te[ 9 ] = _z.y;
  9092. te[ 2 ] = _x.z; te[ 6 ] = _y.z; te[ 10 ] = _z.z;
  9093. return this;
  9094. }
  9095. /**
  9096. * Post-multiplies this matrix by the given 4x4 matrix.
  9097. *
  9098. * @param {Matrix4} m - The matrix to multiply with.
  9099. * @return {Matrix4} A reference to this matrix.
  9100. */
  9101. multiply( m ) {
  9102. return this.multiplyMatrices( this, m );
  9103. }
  9104. /**
  9105. * Pre-multiplies this matrix by the given 4x4 matrix.
  9106. *
  9107. * @param {Matrix4} m - The matrix to multiply with.
  9108. * @return {Matrix4} A reference to this matrix.
  9109. */
  9110. premultiply( m ) {
  9111. return this.multiplyMatrices( m, this );
  9112. }
  9113. /**
  9114. * Multiples the given 4x4 matrices and stores the result
  9115. * in this matrix.
  9116. *
  9117. * @param {Matrix4} a - The first matrix.
  9118. * @param {Matrix4} b - The second matrix.
  9119. * @return {Matrix4} A reference to this matrix.
  9120. */
  9121. multiplyMatrices( a, b ) {
  9122. const ae = a.elements;
  9123. const be = b.elements;
  9124. const te = this.elements;
  9125. const a11 = ae[ 0 ], a12 = ae[ 4 ], a13 = ae[ 8 ], a14 = ae[ 12 ];
  9126. const a21 = ae[ 1 ], a22 = ae[ 5 ], a23 = ae[ 9 ], a24 = ae[ 13 ];
  9127. const a31 = ae[ 2 ], a32 = ae[ 6 ], a33 = ae[ 10 ], a34 = ae[ 14 ];
  9128. const a41 = ae[ 3 ], a42 = ae[ 7 ], a43 = ae[ 11 ], a44 = ae[ 15 ];
  9129. const b11 = be[ 0 ], b12 = be[ 4 ], b13 = be[ 8 ], b14 = be[ 12 ];
  9130. const b21 = be[ 1 ], b22 = be[ 5 ], b23 = be[ 9 ], b24 = be[ 13 ];
  9131. const b31 = be[ 2 ], b32 = be[ 6 ], b33 = be[ 10 ], b34 = be[ 14 ];
  9132. const b41 = be[ 3 ], b42 = be[ 7 ], b43 = be[ 11 ], b44 = be[ 15 ];
  9133. te[ 0 ] = a11 * b11 + a12 * b21 + a13 * b31 + a14 * b41;
  9134. te[ 4 ] = a11 * b12 + a12 * b22 + a13 * b32 + a14 * b42;
  9135. te[ 8 ] = a11 * b13 + a12 * b23 + a13 * b33 + a14 * b43;
  9136. te[ 12 ] = a11 * b14 + a12 * b24 + a13 * b34 + a14 * b44;
  9137. te[ 1 ] = a21 * b11 + a22 * b21 + a23 * b31 + a24 * b41;
  9138. te[ 5 ] = a21 * b12 + a22 * b22 + a23 * b32 + a24 * b42;
  9139. te[ 9 ] = a21 * b13 + a22 * b23 + a23 * b33 + a24 * b43;
  9140. te[ 13 ] = a21 * b14 + a22 * b24 + a23 * b34 + a24 * b44;
  9141. te[ 2 ] = a31 * b11 + a32 * b21 + a33 * b31 + a34 * b41;
  9142. te[ 6 ] = a31 * b12 + a32 * b22 + a33 * b32 + a34 * b42;
  9143. te[ 10 ] = a31 * b13 + a32 * b23 + a33 * b33 + a34 * b43;
  9144. te[ 14 ] = a31 * b14 + a32 * b24 + a33 * b34 + a34 * b44;
  9145. te[ 3 ] = a41 * b11 + a42 * b21 + a43 * b31 + a44 * b41;
  9146. te[ 7 ] = a41 * b12 + a42 * b22 + a43 * b32 + a44 * b42;
  9147. te[ 11 ] = a41 * b13 + a42 * b23 + a43 * b33 + a44 * b43;
  9148. te[ 15 ] = a41 * b14 + a42 * b24 + a43 * b34 + a44 * b44;
  9149. return this;
  9150. }
  9151. /**
  9152. * Multiplies every component of the matrix by the given scalar.
  9153. *
  9154. * @param {number} s - The scalar.
  9155. * @return {Matrix4} A reference to this matrix.
  9156. */
  9157. multiplyScalar( s ) {
  9158. const te = this.elements;
  9159. te[ 0 ] *= s; te[ 4 ] *= s; te[ 8 ] *= s; te[ 12 ] *= s;
  9160. te[ 1 ] *= s; te[ 5 ] *= s; te[ 9 ] *= s; te[ 13 ] *= s;
  9161. te[ 2 ] *= s; te[ 6 ] *= s; te[ 10 ] *= s; te[ 14 ] *= s;
  9162. te[ 3 ] *= s; te[ 7 ] *= s; te[ 11 ] *= s; te[ 15 ] *= s;
  9163. return this;
  9164. }
  9165. /**
  9166. * Computes and returns the determinant of this matrix.
  9167. *
  9168. * Based on the method outlined [here](http://www.euclideanspace.com/maths/algebra/matrix/functions/inverse/fourD/index.html).
  9169. *
  9170. * @return {number} The determinant.
  9171. */
  9172. determinant() {
  9173. const te = this.elements;
  9174. const n11 = te[ 0 ], n12 = te[ 4 ], n13 = te[ 8 ], n14 = te[ 12 ];
  9175. const n21 = te[ 1 ], n22 = te[ 5 ], n23 = te[ 9 ], n24 = te[ 13 ];
  9176. const n31 = te[ 2 ], n32 = te[ 6 ], n33 = te[ 10 ], n34 = te[ 14 ];
  9177. const n41 = te[ 3 ], n42 = te[ 7 ], n43 = te[ 11 ], n44 = te[ 15 ];
  9178. const t11 = n23 * n34 - n24 * n33;
  9179. const t12 = n22 * n34 - n24 * n32;
  9180. const t13 = n22 * n33 - n23 * n32;
  9181. const t21 = n21 * n34 - n24 * n31;
  9182. const t22 = n21 * n33 - n23 * n31;
  9183. const t23 = n21 * n32 - n22 * n31;
  9184. return n11 * ( n42 * t11 - n43 * t12 + n44 * t13 ) -
  9185. n12 * ( n41 * t11 - n43 * t21 + n44 * t22 ) +
  9186. n13 * ( n41 * t12 - n42 * t21 + n44 * t23 ) -
  9187. n14 * ( n41 * t13 - n42 * t22 + n43 * t23 );
  9188. }
  9189. /**
  9190. * Transposes this matrix in place.
  9191. *
  9192. * @return {Matrix4} A reference to this matrix.
  9193. */
  9194. transpose() {
  9195. const te = this.elements;
  9196. let tmp;
  9197. tmp = te[ 1 ]; te[ 1 ] = te[ 4 ]; te[ 4 ] = tmp;
  9198. tmp = te[ 2 ]; te[ 2 ] = te[ 8 ]; te[ 8 ] = tmp;
  9199. tmp = te[ 6 ]; te[ 6 ] = te[ 9 ]; te[ 9 ] = tmp;
  9200. tmp = te[ 3 ]; te[ 3 ] = te[ 12 ]; te[ 12 ] = tmp;
  9201. tmp = te[ 7 ]; te[ 7 ] = te[ 13 ]; te[ 13 ] = tmp;
  9202. tmp = te[ 11 ]; te[ 11 ] = te[ 14 ]; te[ 14 ] = tmp;
  9203. return this;
  9204. }
  9205. /**
  9206. * Sets the position component for this matrix from the given vector,
  9207. * without affecting the rest of the matrix.
  9208. *
  9209. * @param {number|Vector3} x - The x component of the vector or alternatively the vector object.
  9210. * @param {number} y - The y component of the vector.
  9211. * @param {number} z - The z component of the vector.
  9212. * @return {Matrix4} A reference to this matrix.
  9213. */
  9214. setPosition( x, y, z ) {
  9215. const te = this.elements;
  9216. if ( x.isVector3 ) {
  9217. te[ 12 ] = x.x;
  9218. te[ 13 ] = x.y;
  9219. te[ 14 ] = x.z;
  9220. } else {
  9221. te[ 12 ] = x;
  9222. te[ 13 ] = y;
  9223. te[ 14 ] = z;
  9224. }
  9225. return this;
  9226. }
  9227. /**
  9228. * Inverts this matrix, using the [analytic method](https://en.wikipedia.org/wiki/Invertible_matrix#Analytic_solution).
  9229. * You can not invert with a determinant of zero. If you attempt this, the method produces
  9230. * a zero matrix instead.
  9231. *
  9232. * @return {Matrix4} A reference to this matrix.
  9233. */
  9234. invert() {
  9235. // based on https://github.com/toji/gl-matrix
  9236. const te = this.elements,
  9237. n11 = te[ 0 ], n21 = te[ 1 ], n31 = te[ 2 ], n41 = te[ 3 ],
  9238. n12 = te[ 4 ], n22 = te[ 5 ], n32 = te[ 6 ], n42 = te[ 7 ],
  9239. n13 = te[ 8 ], n23 = te[ 9 ], n33 = te[ 10 ], n43 = te[ 11 ],
  9240. n14 = te[ 12 ], n24 = te[ 13 ], n34 = te[ 14 ], n44 = te[ 15 ],
  9241. t1 = n11 * n22 - n21 * n12,
  9242. t2 = n11 * n32 - n31 * n12,
  9243. t3 = n11 * n42 - n41 * n12,
  9244. t4 = n21 * n32 - n31 * n22,
  9245. t5 = n21 * n42 - n41 * n22,
  9246. t6 = n31 * n42 - n41 * n32,
  9247. t7 = n13 * n24 - n23 * n14,
  9248. t8 = n13 * n34 - n33 * n14,
  9249. t9 = n13 * n44 - n43 * n14,
  9250. t10 = n23 * n34 - n33 * n24,
  9251. t11 = n23 * n44 - n43 * n24,
  9252. t12 = n33 * n44 - n43 * n34;
  9253. const det = t1 * t12 - t2 * t11 + t3 * t10 + t4 * t9 - t5 * t8 + t6 * t7;
  9254. if ( det === 0 ) return this.set( 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0 );
  9255. const detInv = 1 / det;
  9256. te[ 0 ] = ( n22 * t12 - n32 * t11 + n42 * t10 ) * detInv;
  9257. te[ 1 ] = ( n31 * t11 - n21 * t12 - n41 * t10 ) * detInv;
  9258. te[ 2 ] = ( n24 * t6 - n34 * t5 + n44 * t4 ) * detInv;
  9259. te[ 3 ] = ( n33 * t5 - n23 * t6 - n43 * t4 ) * detInv;
  9260. te[ 4 ] = ( n32 * t9 - n12 * t12 - n42 * t8 ) * detInv;
  9261. te[ 5 ] = ( n11 * t12 - n31 * t9 + n41 * t8 ) * detInv;
  9262. te[ 6 ] = ( n34 * t3 - n14 * t6 - n44 * t2 ) * detInv;
  9263. te[ 7 ] = ( n13 * t6 - n33 * t3 + n43 * t2 ) * detInv;
  9264. te[ 8 ] = ( n12 * t11 - n22 * t9 + n42 * t7 ) * detInv;
  9265. te[ 9 ] = ( n21 * t9 - n11 * t11 - n41 * t7 ) * detInv;
  9266. te[ 10 ] = ( n14 * t5 - n24 * t3 + n44 * t1 ) * detInv;
  9267. te[ 11 ] = ( n23 * t3 - n13 * t5 - n43 * t1 ) * detInv;
  9268. te[ 12 ] = ( n22 * t8 - n12 * t10 - n32 * t7 ) * detInv;
  9269. te[ 13 ] = ( n11 * t10 - n21 * t8 + n31 * t7 ) * detInv;
  9270. te[ 14 ] = ( n24 * t2 - n14 * t4 - n34 * t1 ) * detInv;
  9271. te[ 15 ] = ( n13 * t4 - n23 * t2 + n33 * t1 ) * detInv;
  9272. return this;
  9273. }
  9274. /**
  9275. * Multiplies the columns of this matrix by the given vector.
  9276. *
  9277. * @param {Vector3} v - The scale vector.
  9278. * @return {Matrix4} A reference to this matrix.
  9279. */
  9280. scale( v ) {
  9281. const te = this.elements;
  9282. const x = v.x, y = v.y, z = v.z;
  9283. te[ 0 ] *= x; te[ 4 ] *= y; te[ 8 ] *= z;
  9284. te[ 1 ] *= x; te[ 5 ] *= y; te[ 9 ] *= z;
  9285. te[ 2 ] *= x; te[ 6 ] *= y; te[ 10 ] *= z;
  9286. te[ 3 ] *= x; te[ 7 ] *= y; te[ 11 ] *= z;
  9287. return this;
  9288. }
  9289. /**
  9290. * Gets the maximum scale value of the three axes.
  9291. *
  9292. * @return {number} The maximum scale.
  9293. */
  9294. getMaxScaleOnAxis() {
  9295. const te = this.elements;
  9296. const scaleXSq = te[ 0 ] * te[ 0 ] + te[ 1 ] * te[ 1 ] + te[ 2 ] * te[ 2 ];
  9297. const scaleYSq = te[ 4 ] * te[ 4 ] + te[ 5 ] * te[ 5 ] + te[ 6 ] * te[ 6 ];
  9298. const scaleZSq = te[ 8 ] * te[ 8 ] + te[ 9 ] * te[ 9 ] + te[ 10 ] * te[ 10 ];
  9299. return Math.sqrt( Math.max( scaleXSq, scaleYSq, scaleZSq ) );
  9300. }
  9301. /**
  9302. * Sets this matrix as a translation transform from the given vector.
  9303. *
  9304. * @param {number|Vector3} x - The amount to translate in the X axis or alternatively a translation vector.
  9305. * @param {number} y - The amount to translate in the Y axis.
  9306. * @param {number} z - The amount to translate in the z axis.
  9307. * @return {Matrix4} A reference to this matrix.
  9308. */
  9309. makeTranslation( x, y, z ) {
  9310. if ( x.isVector3 ) {
  9311. this.set(
  9312. 1, 0, 0, x.x,
  9313. 0, 1, 0, x.y,
  9314. 0, 0, 1, x.z,
  9315. 0, 0, 0, 1
  9316. );
  9317. } else {
  9318. this.set(
  9319. 1, 0, 0, x,
  9320. 0, 1, 0, y,
  9321. 0, 0, 1, z,
  9322. 0, 0, 0, 1
  9323. );
  9324. }
  9325. return this;
  9326. }
  9327. /**
  9328. * Sets this matrix as a rotational transformation around the X axis by
  9329. * the given angle.
  9330. *
  9331. * @param {number} theta - The rotation in radians.
  9332. * @return {Matrix4} A reference to this matrix.
  9333. */
  9334. makeRotationX( theta ) {
  9335. const c = Math.cos( theta ), s = Math.sin( theta );
  9336. this.set(
  9337. 1, 0, 0, 0,
  9338. 0, c, - s, 0,
  9339. 0, s, c, 0,
  9340. 0, 0, 0, 1
  9341. );
  9342. return this;
  9343. }
  9344. /**
  9345. * Sets this matrix as a rotational transformation around the Y axis by
  9346. * the given angle.
  9347. *
  9348. * @param {number} theta - The rotation in radians.
  9349. * @return {Matrix4} A reference to this matrix.
  9350. */
  9351. makeRotationY( theta ) {
  9352. const c = Math.cos( theta ), s = Math.sin( theta );
  9353. this.set(
  9354. c, 0, s, 0,
  9355. 0, 1, 0, 0,
  9356. - s, 0, c, 0,
  9357. 0, 0, 0, 1
  9358. );
  9359. return this;
  9360. }
  9361. /**
  9362. * Sets this matrix as a rotational transformation around the Z axis by
  9363. * the given angle.
  9364. *
  9365. * @param {number} theta - The rotation in radians.
  9366. * @return {Matrix4} A reference to this matrix.
  9367. */
  9368. makeRotationZ( theta ) {
  9369. const c = Math.cos( theta ), s = Math.sin( theta );
  9370. this.set(
  9371. c, - s, 0, 0,
  9372. s, c, 0, 0,
  9373. 0, 0, 1, 0,
  9374. 0, 0, 0, 1
  9375. );
  9376. return this;
  9377. }
  9378. /**
  9379. * Sets this matrix as a rotational transformation around the given axis by
  9380. * the given angle.
  9381. *
  9382. * This is a somewhat controversial but mathematically sound alternative to
  9383. * rotating via Quaternions. See the discussion [here](https://www.gamedev.net/articles/programming/math-and-physics/do-we-really-need-quaternions-r1199).
  9384. *
  9385. * @param {Vector3} axis - The normalized rotation axis.
  9386. * @param {number} angle - The rotation in radians.
  9387. * @return {Matrix4} A reference to this matrix.
  9388. */
  9389. makeRotationAxis( axis, angle ) {
  9390. // Based on http://www.gamedev.net/reference/articles/article1199.asp
  9391. const c = Math.cos( angle );
  9392. const s = Math.sin( angle );
  9393. const t = 1 - c;
  9394. const x = axis.x, y = axis.y, z = axis.z;
  9395. const tx = t * x, ty = t * y;
  9396. this.set(
  9397. tx * x + c, tx * y - s * z, tx * z + s * y, 0,
  9398. tx * y + s * z, ty * y + c, ty * z - s * x, 0,
  9399. tx * z - s * y, ty * z + s * x, t * z * z + c, 0,
  9400. 0, 0, 0, 1
  9401. );
  9402. return this;
  9403. }
  9404. /**
  9405. * Sets this matrix as a scale transformation.
  9406. *
  9407. * @param {number} x - The amount to scale in the X axis.
  9408. * @param {number} y - The amount to scale in the Y axis.
  9409. * @param {number} z - The amount to scale in the Z axis.
  9410. * @return {Matrix4} A reference to this matrix.
  9411. */
  9412. makeScale( x, y, z ) {
  9413. this.set(
  9414. x, 0, 0, 0,
  9415. 0, y, 0, 0,
  9416. 0, 0, z, 0,
  9417. 0, 0, 0, 1
  9418. );
  9419. return this;
  9420. }
  9421. /**
  9422. * Sets this matrix as a shear transformation.
  9423. *
  9424. * @param {number} xy - The amount to shear X by Y.
  9425. * @param {number} xz - The amount to shear X by Z.
  9426. * @param {number} yx - The amount to shear Y by X.
  9427. * @param {number} yz - The amount to shear Y by Z.
  9428. * @param {number} zx - The amount to shear Z by X.
  9429. * @param {number} zy - The amount to shear Z by Y.
  9430. * @return {Matrix4} A reference to this matrix.
  9431. */
  9432. makeShear( xy, xz, yx, yz, zx, zy ) {
  9433. this.set(
  9434. 1, yx, zx, 0,
  9435. xy, 1, zy, 0,
  9436. xz, yz, 1, 0,
  9437. 0, 0, 0, 1
  9438. );
  9439. return this;
  9440. }
  9441. /**
  9442. * Sets this matrix to the transformation composed of the given position,
  9443. * rotation (Quaternion) and scale.
  9444. *
  9445. * @param {Vector3} position - The position vector.
  9446. * @param {Quaternion} quaternion - The rotation as a Quaternion.
  9447. * @param {Vector3} scale - The scale vector.
  9448. * @return {Matrix4} A reference to this matrix.
  9449. */
  9450. compose( position, quaternion, scale ) {
  9451. const te = this.elements;
  9452. const x = quaternion._x, y = quaternion._y, z = quaternion._z, w = quaternion._w;
  9453. const x2 = x + x, y2 = y + y, z2 = z + z;
  9454. const xx = x * x2, xy = x * y2, xz = x * z2;
  9455. const yy = y * y2, yz = y * z2, zz = z * z2;
  9456. const wx = w * x2, wy = w * y2, wz = w * z2;
  9457. const sx = scale.x, sy = scale.y, sz = scale.z;
  9458. te[ 0 ] = ( 1 - ( yy + zz ) ) * sx;
  9459. te[ 1 ] = ( xy + wz ) * sx;
  9460. te[ 2 ] = ( xz - wy ) * sx;
  9461. te[ 3 ] = 0;
  9462. te[ 4 ] = ( xy - wz ) * sy;
  9463. te[ 5 ] = ( 1 - ( xx + zz ) ) * sy;
  9464. te[ 6 ] = ( yz + wx ) * sy;
  9465. te[ 7 ] = 0;
  9466. te[ 8 ] = ( xz + wy ) * sz;
  9467. te[ 9 ] = ( yz - wx ) * sz;
  9468. te[ 10 ] = ( 1 - ( xx + yy ) ) * sz;
  9469. te[ 11 ] = 0;
  9470. te[ 12 ] = position.x;
  9471. te[ 13 ] = position.y;
  9472. te[ 14 ] = position.z;
  9473. te[ 15 ] = 1;
  9474. return this;
  9475. }
  9476. /**
  9477. * Decomposes this matrix into its position, rotation and scale components
  9478. * and provides the result in the given objects.
  9479. *
  9480. * Note: Not all matrices are decomposable in this way. For example, if an
  9481. * object has a non-uniformly scaled parent, then the object's world matrix
  9482. * may not be decomposable, and this method may not be appropriate.
  9483. *
  9484. * @param {Vector3} position - The position vector.
  9485. * @param {Quaternion} quaternion - The rotation as a Quaternion.
  9486. * @param {Vector3} scale - The scale vector.
  9487. * @return {Matrix4} A reference to this matrix.
  9488. */
  9489. decompose( position, quaternion, scale ) {
  9490. const te = this.elements;
  9491. position.x = te[ 12 ];
  9492. position.y = te[ 13 ];
  9493. position.z = te[ 14 ];
  9494. const det = this.determinant();
  9495. if ( det === 0 ) {
  9496. scale.set( 1, 1, 1 );
  9497. quaternion.identity();
  9498. return this;
  9499. }
  9500. let sx = _v1$5.set( te[ 0 ], te[ 1 ], te[ 2 ] ).length();
  9501. const sy = _v1$5.set( te[ 4 ], te[ 5 ], te[ 6 ] ).length();
  9502. const sz = _v1$5.set( te[ 8 ], te[ 9 ], te[ 10 ] ).length();
  9503. // if determinant is negative, we need to invert one scale
  9504. if ( det < 0 ) sx = - sx;
  9505. // scale the rotation part
  9506. _m1$2.copy( this );
  9507. const invSX = 1 / sx;
  9508. const invSY = 1 / sy;
  9509. const invSZ = 1 / sz;
  9510. _m1$2.elements[ 0 ] *= invSX;
  9511. _m1$2.elements[ 1 ] *= invSX;
  9512. _m1$2.elements[ 2 ] *= invSX;
  9513. _m1$2.elements[ 4 ] *= invSY;
  9514. _m1$2.elements[ 5 ] *= invSY;
  9515. _m1$2.elements[ 6 ] *= invSY;
  9516. _m1$2.elements[ 8 ] *= invSZ;
  9517. _m1$2.elements[ 9 ] *= invSZ;
  9518. _m1$2.elements[ 10 ] *= invSZ;
  9519. quaternion.setFromRotationMatrix( _m1$2 );
  9520. scale.x = sx;
  9521. scale.y = sy;
  9522. scale.z = sz;
  9523. return this;
  9524. }
  9525. /**
  9526. * Creates a perspective projection matrix. This is used internally by
  9527. * {@link PerspectiveCamera#updateProjectionMatrix}.
  9528. * @param {number} left - Left boundary of the viewing frustum at the near plane.
  9529. * @param {number} right - Right boundary of the viewing frustum at the near plane.
  9530. * @param {number} top - Top boundary of the viewing frustum at the near plane.
  9531. * @param {number} bottom - Bottom boundary of the viewing frustum at the near plane.
  9532. * @param {number} near - The distance from the camera to the near plane.
  9533. * @param {number} far - The distance from the camera to the far plane.
  9534. * @param {(WebGLCoordinateSystem|WebGPUCoordinateSystem)} [coordinateSystem=WebGLCoordinateSystem] - The coordinate system.
  9535. * @param {boolean} [reversedDepth=false] - Whether to use a reversed depth.
  9536. * @return {Matrix4} A reference to this matrix.
  9537. */
  9538. makePerspective( left, right, top, bottom, near, far, coordinateSystem = WebGLCoordinateSystem, reversedDepth = false ) {
  9539. const te = this.elements;
  9540. const x = 2 * near / ( right - left );
  9541. const y = 2 * near / ( top - bottom );
  9542. const a = ( right + left ) / ( right - left );
  9543. const b = ( top + bottom ) / ( top - bottom );
  9544. let c, d;
  9545. if ( reversedDepth ) {
  9546. c = near / ( far - near );
  9547. d = ( far * near ) / ( far - near );
  9548. } else {
  9549. if ( coordinateSystem === WebGLCoordinateSystem ) {
  9550. c = - ( far + near ) / ( far - near );
  9551. d = ( -2 * far * near ) / ( far - near );
  9552. } else if ( coordinateSystem === WebGPUCoordinateSystem ) {
  9553. c = - far / ( far - near );
  9554. d = ( - far * near ) / ( far - near );
  9555. } else {
  9556. throw new Error( 'THREE.Matrix4.makePerspective(): Invalid coordinate system: ' + coordinateSystem );
  9557. }
  9558. }
  9559. te[ 0 ] = x; te[ 4 ] = 0; te[ 8 ] = a; te[ 12 ] = 0;
  9560. te[ 1 ] = 0; te[ 5 ] = y; te[ 9 ] = b; te[ 13 ] = 0;
  9561. te[ 2 ] = 0; te[ 6 ] = 0; te[ 10 ] = c; te[ 14 ] = d;
  9562. te[ 3 ] = 0; te[ 7 ] = 0; te[ 11 ] = -1; te[ 15 ] = 0;
  9563. return this;
  9564. }
  9565. /**
  9566. * Creates a orthographic projection matrix. This is used internally by
  9567. * {@link OrthographicCamera#updateProjectionMatrix}.
  9568. * @param {number} left - Left boundary of the viewing frustum at the near plane.
  9569. * @param {number} right - Right boundary of the viewing frustum at the near plane.
  9570. * @param {number} top - Top boundary of the viewing frustum at the near plane.
  9571. * @param {number} bottom - Bottom boundary of the viewing frustum at the near plane.
  9572. * @param {number} near - The distance from the camera to the near plane.
  9573. * @param {number} far - The distance from the camera to the far plane.
  9574. * @param {(WebGLCoordinateSystem|WebGPUCoordinateSystem)} [coordinateSystem=WebGLCoordinateSystem] - The coordinate system.
  9575. * @param {boolean} [reversedDepth=false] - Whether to use a reversed depth.
  9576. * @return {Matrix4} A reference to this matrix.
  9577. */
  9578. makeOrthographic( left, right, top, bottom, near, far, coordinateSystem = WebGLCoordinateSystem, reversedDepth = false ) {
  9579. const te = this.elements;
  9580. const x = 2 / ( right - left );
  9581. const y = 2 / ( top - bottom );
  9582. const a = - ( right + left ) / ( right - left );
  9583. const b = - ( top + bottom ) / ( top - bottom );
  9584. let c, d;
  9585. if ( reversedDepth ) {
  9586. c = 1 / ( far - near );
  9587. d = far / ( far - near );
  9588. } else {
  9589. if ( coordinateSystem === WebGLCoordinateSystem ) {
  9590. c = -2 / ( far - near );
  9591. d = - ( far + near ) / ( far - near );
  9592. } else if ( coordinateSystem === WebGPUCoordinateSystem ) {
  9593. c = -1 / ( far - near );
  9594. d = - near / ( far - near );
  9595. } else {
  9596. throw new Error( 'THREE.Matrix4.makeOrthographic(): Invalid coordinate system: ' + coordinateSystem );
  9597. }
  9598. }
  9599. te[ 0 ] = x; te[ 4 ] = 0; te[ 8 ] = 0; te[ 12 ] = a;
  9600. te[ 1 ] = 0; te[ 5 ] = y; te[ 9 ] = 0; te[ 13 ] = b;
  9601. te[ 2 ] = 0; te[ 6 ] = 0; te[ 10 ] = c; te[ 14 ] = d;
  9602. te[ 3 ] = 0; te[ 7 ] = 0; te[ 11 ] = 0; te[ 15 ] = 1;
  9603. return this;
  9604. }
  9605. /**
  9606. * Returns `true` if this matrix is equal with the given one.
  9607. *
  9608. * @param {Matrix4} matrix - The matrix to test for equality.
  9609. * @return {boolean} Whether this matrix is equal with the given one.
  9610. */
  9611. equals( matrix ) {
  9612. const te = this.elements;
  9613. const me = matrix.elements;
  9614. for ( let i = 0; i < 16; i ++ ) {
  9615. if ( te[ i ] !== me[ i ] ) return false;
  9616. }
  9617. return true;
  9618. }
  9619. /**
  9620. * Sets the elements of the matrix from the given array.
  9621. *
  9622. * @param {Array<number>} array - The matrix elements in column-major order.
  9623. * @param {number} [offset=0] - Index of the first element in the array.
  9624. * @return {Matrix4} A reference to this matrix.
  9625. */
  9626. fromArray( array, offset = 0 ) {
  9627. for ( let i = 0; i < 16; i ++ ) {
  9628. this.elements[ i ] = array[ i + offset ];
  9629. }
  9630. return this;
  9631. }
  9632. /**
  9633. * Writes the elements of this matrix to the given array. If no array is provided,
  9634. * the method returns a new instance.
  9635. *
  9636. * @param {Array<number>} [array=[]] - The target array holding the matrix elements in column-major order.
  9637. * @param {number} [offset=0] - Index of the first element in the array.
  9638. * @return {Array<number>} The matrix elements in column-major order.
  9639. */
  9640. toArray( array = [], offset = 0 ) {
  9641. const te = this.elements;
  9642. array[ offset ] = te[ 0 ];
  9643. array[ offset + 1 ] = te[ 1 ];
  9644. array[ offset + 2 ] = te[ 2 ];
  9645. array[ offset + 3 ] = te[ 3 ];
  9646. array[ offset + 4 ] = te[ 4 ];
  9647. array[ offset + 5 ] = te[ 5 ];
  9648. array[ offset + 6 ] = te[ 6 ];
  9649. array[ offset + 7 ] = te[ 7 ];
  9650. array[ offset + 8 ] = te[ 8 ];
  9651. array[ offset + 9 ] = te[ 9 ];
  9652. array[ offset + 10 ] = te[ 10 ];
  9653. array[ offset + 11 ] = te[ 11 ];
  9654. array[ offset + 12 ] = te[ 12 ];
  9655. array[ offset + 13 ] = te[ 13 ];
  9656. array[ offset + 14 ] = te[ 14 ];
  9657. array[ offset + 15 ] = te[ 15 ];
  9658. return array;
  9659. }
  9660. }
  9661. const _v1$5 = /*@__PURE__*/ new Vector3();
  9662. const _m1$2 = /*@__PURE__*/ new Matrix4();
  9663. const _zero = /*@__PURE__*/ new Vector3( 0, 0, 0 );
  9664. const _one = /*@__PURE__*/ new Vector3( 1, 1, 1 );
  9665. const _x = /*@__PURE__*/ new Vector3();
  9666. const _y = /*@__PURE__*/ new Vector3();
  9667. const _z = /*@__PURE__*/ new Vector3();
  9668. const _matrix$2 = /*@__PURE__*/ new Matrix4();
  9669. const _quaternion$3 = /*@__PURE__*/ new Quaternion();
  9670. /**
  9671. * A class representing Euler angles.
  9672. *
  9673. * Euler angles describe a rotational transformation by rotating an object on
  9674. * its various axes in specified amounts per axis, and a specified axis
  9675. * order.
  9676. *
  9677. * Iterating through an instance will yield its components (x, y, z,
  9678. * order) in the corresponding order.
  9679. *
  9680. * ```js
  9681. * const a = new THREE.Euler( 0, 1, 1.57, 'XYZ' );
  9682. * const b = new THREE.Vector3( 1, 0, 1 );
  9683. * b.applyEuler(a);
  9684. * ```
  9685. */
  9686. class Euler {
  9687. /**
  9688. * Constructs a new euler instance.
  9689. *
  9690. * @param {number} [x=0] - The angle of the x axis in radians.
  9691. * @param {number} [y=0] - The angle of the y axis in radians.
  9692. * @param {number} [z=0] - The angle of the z axis in radians.
  9693. * @param {string} [order=Euler.DEFAULT_ORDER] - A string representing the order that the rotations are applied.
  9694. */
  9695. constructor( x = 0, y = 0, z = 0, order = Euler.DEFAULT_ORDER ) {
  9696. /**
  9697. * This flag can be used for type testing.
  9698. *
  9699. * @type {boolean}
  9700. * @readonly
  9701. * @default true
  9702. */
  9703. this.isEuler = true;
  9704. this._x = x;
  9705. this._y = y;
  9706. this._z = z;
  9707. this._order = order;
  9708. }
  9709. /**
  9710. * The angle of the x axis in radians.
  9711. *
  9712. * @type {number}
  9713. * @default 0
  9714. */
  9715. get x() {
  9716. return this._x;
  9717. }
  9718. set x( value ) {
  9719. this._x = value;
  9720. this._onChangeCallback();
  9721. }
  9722. /**
  9723. * The angle of the y axis in radians.
  9724. *
  9725. * @type {number}
  9726. * @default 0
  9727. */
  9728. get y() {
  9729. return this._y;
  9730. }
  9731. set y( value ) {
  9732. this._y = value;
  9733. this._onChangeCallback();
  9734. }
  9735. /**
  9736. * The angle of the z axis in radians.
  9737. *
  9738. * @type {number}
  9739. * @default 0
  9740. */
  9741. get z() {
  9742. return this._z;
  9743. }
  9744. set z( value ) {
  9745. this._z = value;
  9746. this._onChangeCallback();
  9747. }
  9748. /**
  9749. * A string representing the order that the rotations are applied.
  9750. *
  9751. * @type {string}
  9752. * @default 'XYZ'
  9753. */
  9754. get order() {
  9755. return this._order;
  9756. }
  9757. set order( value ) {
  9758. this._order = value;
  9759. this._onChangeCallback();
  9760. }
  9761. /**
  9762. * Sets the Euler components.
  9763. *
  9764. * @param {number} x - The angle of the x axis in radians.
  9765. * @param {number} y - The angle of the y axis in radians.
  9766. * @param {number} z - The angle of the z axis in radians.
  9767. * @param {string} [order] - A string representing the order that the rotations are applied.
  9768. * @return {Euler} A reference to this Euler instance.
  9769. */
  9770. set( x, y, z, order = this._order ) {
  9771. this._x = x;
  9772. this._y = y;
  9773. this._z = z;
  9774. this._order = order;
  9775. this._onChangeCallback();
  9776. return this;
  9777. }
  9778. /**
  9779. * Returns a new Euler instance with copied values from this instance.
  9780. *
  9781. * @return {Euler} A clone of this instance.
  9782. */
  9783. clone() {
  9784. return new this.constructor( this._x, this._y, this._z, this._order );
  9785. }
  9786. /**
  9787. * Copies the values of the given Euler instance to this instance.
  9788. *
  9789. * @param {Euler} euler - The Euler instance to copy.
  9790. * @return {Euler} A reference to this Euler instance.
  9791. */
  9792. copy( euler ) {
  9793. this._x = euler._x;
  9794. this._y = euler._y;
  9795. this._z = euler._z;
  9796. this._order = euler._order;
  9797. this._onChangeCallback();
  9798. return this;
  9799. }
  9800. /**
  9801. * Sets the angles of this Euler instance from a pure rotation matrix.
  9802. *
  9803. * @param {Matrix4} m - A 4x4 matrix of which the upper 3x3 of matrix is a pure rotation matrix (i.e. unscaled).
  9804. * @param {string} [order] - A string representing the order that the rotations are applied.
  9805. * @param {boolean} [update=true] - Whether the internal `onChange` callback should be executed or not.
  9806. * @return {Euler} A reference to this Euler instance.
  9807. */
  9808. setFromRotationMatrix( m, order = this._order, update = true ) {
  9809. const te = m.elements;
  9810. const m11 = te[ 0 ], m12 = te[ 4 ], m13 = te[ 8 ];
  9811. const m21 = te[ 1 ], m22 = te[ 5 ], m23 = te[ 9 ];
  9812. const m31 = te[ 2 ], m32 = te[ 6 ], m33 = te[ 10 ];
  9813. switch ( order ) {
  9814. case 'XYZ':
  9815. this._y = Math.asin( clamp( m13, -1, 1 ) );
  9816. if ( Math.abs( m13 ) < 0.9999999 ) {
  9817. this._x = Math.atan2( - m23, m33 );
  9818. this._z = Math.atan2( - m12, m11 );
  9819. } else {
  9820. this._x = Math.atan2( m32, m22 );
  9821. this._z = 0;
  9822. }
  9823. break;
  9824. case 'YXZ':
  9825. this._x = Math.asin( - clamp( m23, -1, 1 ) );
  9826. if ( Math.abs( m23 ) < 0.9999999 ) {
  9827. this._y = Math.atan2( m13, m33 );
  9828. this._z = Math.atan2( m21, m22 );
  9829. } else {
  9830. this._y = Math.atan2( - m31, m11 );
  9831. this._z = 0;
  9832. }
  9833. break;
  9834. case 'ZXY':
  9835. this._x = Math.asin( clamp( m32, -1, 1 ) );
  9836. if ( Math.abs( m32 ) < 0.9999999 ) {
  9837. this._y = Math.atan2( - m31, m33 );
  9838. this._z = Math.atan2( - m12, m22 );
  9839. } else {
  9840. this._y = 0;
  9841. this._z = Math.atan2( m21, m11 );
  9842. }
  9843. break;
  9844. case 'ZYX':
  9845. this._y = Math.asin( - clamp( m31, -1, 1 ) );
  9846. if ( Math.abs( m31 ) < 0.9999999 ) {
  9847. this._x = Math.atan2( m32, m33 );
  9848. this._z = Math.atan2( m21, m11 );
  9849. } else {
  9850. this._x = 0;
  9851. this._z = Math.atan2( - m12, m22 );
  9852. }
  9853. break;
  9854. case 'YZX':
  9855. this._z = Math.asin( clamp( m21, -1, 1 ) );
  9856. if ( Math.abs( m21 ) < 0.9999999 ) {
  9857. this._x = Math.atan2( - m23, m22 );
  9858. this._y = Math.atan2( - m31, m11 );
  9859. } else {
  9860. this._x = 0;
  9861. this._y = Math.atan2( m13, m33 );
  9862. }
  9863. break;
  9864. case 'XZY':
  9865. this._z = Math.asin( - clamp( m12, -1, 1 ) );
  9866. if ( Math.abs( m12 ) < 0.9999999 ) {
  9867. this._x = Math.atan2( m32, m22 );
  9868. this._y = Math.atan2( m13, m11 );
  9869. } else {
  9870. this._x = Math.atan2( - m23, m33 );
  9871. this._y = 0;
  9872. }
  9873. break;
  9874. default:
  9875. warn( 'Euler: .setFromRotationMatrix() encountered an unknown order: ' + order );
  9876. }
  9877. this._order = order;
  9878. if ( update === true ) this._onChangeCallback();
  9879. return this;
  9880. }
  9881. /**
  9882. * Sets the angles of this Euler instance from a normalized quaternion.
  9883. *
  9884. * @param {Quaternion} q - A normalized Quaternion.
  9885. * @param {string} [order] - A string representing the order that the rotations are applied.
  9886. * @param {boolean} [update=true] - Whether the internal `onChange` callback should be executed or not.
  9887. * @return {Euler} A reference to this Euler instance.
  9888. */
  9889. setFromQuaternion( q, order, update ) {
  9890. _matrix$2.makeRotationFromQuaternion( q );
  9891. return this.setFromRotationMatrix( _matrix$2, order, update );
  9892. }
  9893. /**
  9894. * Sets the angles of this Euler instance from the given vector.
  9895. *
  9896. * @param {Vector3} v - The vector.
  9897. * @param {string} [order] - A string representing the order that the rotations are applied.
  9898. * @return {Euler} A reference to this Euler instance.
  9899. */
  9900. setFromVector3( v, order = this._order ) {
  9901. return this.set( v.x, v.y, v.z, order );
  9902. }
  9903. /**
  9904. * Resets the euler angle with a new order by creating a quaternion from this
  9905. * euler angle and then setting this euler angle with the quaternion and the
  9906. * new order.
  9907. *
  9908. * Warning: This discards revolution information.
  9909. *
  9910. * @param {string} [newOrder] - A string representing the new order that the rotations are applied.
  9911. * @return {Euler} A reference to this Euler instance.
  9912. */
  9913. reorder( newOrder ) {
  9914. _quaternion$3.setFromEuler( this );
  9915. return this.setFromQuaternion( _quaternion$3, newOrder );
  9916. }
  9917. /**
  9918. * Returns `true` if this Euler instance is equal with the given one.
  9919. *
  9920. * @param {Euler} euler - The Euler instance to test for equality.
  9921. * @return {boolean} Whether this Euler instance is equal with the given one.
  9922. */
  9923. equals( euler ) {
  9924. return ( euler._x === this._x ) && ( euler._y === this._y ) && ( euler._z === this._z ) && ( euler._order === this._order );
  9925. }
  9926. /**
  9927. * Sets this Euler instance's components to values from the given array. The first three
  9928. * entries of the array are assign to the x,y and z components. An optional fourth entry
  9929. * defines the Euler order.
  9930. *
  9931. * @param {Array<number,number,number,?string>} array - An array holding the Euler component values.
  9932. * @return {Euler} A reference to this Euler instance.
  9933. */
  9934. fromArray( array ) {
  9935. this._x = array[ 0 ];
  9936. this._y = array[ 1 ];
  9937. this._z = array[ 2 ];
  9938. if ( array[ 3 ] !== undefined ) this._order = array[ 3 ];
  9939. this._onChangeCallback();
  9940. return this;
  9941. }
  9942. /**
  9943. * Writes the components of this Euler instance to the given array. If no array is provided,
  9944. * the method returns a new instance.
  9945. *
  9946. * @param {Array<number,number,number,string>} [array=[]] - The target array holding the Euler components.
  9947. * @param {number} [offset=0] - Index of the first element in the array.
  9948. * @return {Array<number,number,number,string>} The Euler components.
  9949. */
  9950. toArray( array = [], offset = 0 ) {
  9951. array[ offset ] = this._x;
  9952. array[ offset + 1 ] = this._y;
  9953. array[ offset + 2 ] = this._z;
  9954. array[ offset + 3 ] = this._order;
  9955. return array;
  9956. }
  9957. _onChange( callback ) {
  9958. this._onChangeCallback = callback;
  9959. return this;
  9960. }
  9961. _onChangeCallback() {}
  9962. *[ Symbol.iterator ]() {
  9963. yield this._x;
  9964. yield this._y;
  9965. yield this._z;
  9966. yield this._order;
  9967. }
  9968. }
  9969. /**
  9970. * The default Euler angle order.
  9971. *
  9972. * @static
  9973. * @type {string}
  9974. * @default 'XYZ'
  9975. */
  9976. Euler.DEFAULT_ORDER = 'XYZ';
  9977. /**
  9978. * A layers object assigns an 3D object to 1 or more of 32
  9979. * layers numbered `0` to `31` - internally the layers are stored as a
  9980. * bit mask], and by default all 3D objects are a member of layer `0`.
  9981. *
  9982. * This can be used to control visibility - an object must share a layer with
  9983. * a camera to be visible when that camera's view is
  9984. * rendered.
  9985. *
  9986. * All classes that inherit from {@link Object3D} have an `layers` property which
  9987. * is an instance of this class.
  9988. */
  9989. class Layers {
  9990. /**
  9991. * Constructs a new layers instance, with membership
  9992. * initially set to layer `0`.
  9993. */
  9994. constructor() {
  9995. /**
  9996. * A bit mask storing which of the 32 layers this layers object is currently
  9997. * a member of.
  9998. *
  9999. * @type {number}
  10000. */
  10001. this.mask = 1 | 0;
  10002. }
  10003. /**
  10004. * Sets membership to the given layer, and remove membership all other layers.
  10005. *
  10006. * @param {number} layer - The layer to set.
  10007. */
  10008. set( layer ) {
  10009. this.mask = ( 1 << layer | 0 ) >>> 0;
  10010. }
  10011. /**
  10012. * Adds membership of the given layer.
  10013. *
  10014. * @param {number} layer - The layer to enable.
  10015. */
  10016. enable( layer ) {
  10017. this.mask |= 1 << layer | 0;
  10018. }
  10019. /**
  10020. * Adds membership to all layers.
  10021. */
  10022. enableAll() {
  10023. this.mask = 0xffffffff | 0;
  10024. }
  10025. /**
  10026. * Toggles the membership of the given layer.
  10027. *
  10028. * @param {number} layer - The layer to toggle.
  10029. */
  10030. toggle( layer ) {
  10031. this.mask ^= 1 << layer | 0;
  10032. }
  10033. /**
  10034. * Removes membership of the given layer.
  10035. *
  10036. * @param {number} layer - The layer to enable.
  10037. */
  10038. disable( layer ) {
  10039. this.mask &= ~ ( 1 << layer | 0 );
  10040. }
  10041. /**
  10042. * Removes the membership from all layers.
  10043. */
  10044. disableAll() {
  10045. this.mask = 0;
  10046. }
  10047. /**
  10048. * Returns `true` if this and the given layers object have at least one
  10049. * layer in common.
  10050. *
  10051. * @param {Layers} layers - The layers to test.
  10052. * @return {boolean } Whether this and the given layers object have at least one layer in common or not.
  10053. */
  10054. test( layers ) {
  10055. return ( this.mask & layers.mask ) !== 0;
  10056. }
  10057. /**
  10058. * Returns `true` if the given layer is enabled.
  10059. *
  10060. * @param {number} layer - The layer to test.
  10061. * @return {boolean } Whether the given layer is enabled or not.
  10062. */
  10063. isEnabled( layer ) {
  10064. return ( this.mask & ( 1 << layer | 0 ) ) !== 0;
  10065. }
  10066. }
  10067. let _object3DId = 0;
  10068. const _v1$4 = /*@__PURE__*/ new Vector3();
  10069. const _q1 = /*@__PURE__*/ new Quaternion();
  10070. const _m1$1 = /*@__PURE__*/ new Matrix4();
  10071. const _target = /*@__PURE__*/ new Vector3();
  10072. const _position$3 = /*@__PURE__*/ new Vector3();
  10073. const _scale$2 = /*@__PURE__*/ new Vector3();
  10074. const _quaternion$2 = /*@__PURE__*/ new Quaternion();
  10075. const _xAxis = /*@__PURE__*/ new Vector3( 1, 0, 0 );
  10076. const _yAxis = /*@__PURE__*/ new Vector3( 0, 1, 0 );
  10077. const _zAxis = /*@__PURE__*/ new Vector3( 0, 0, 1 );
  10078. /**
  10079. * Fires when the object has been added to its parent object.
  10080. *
  10081. * @event Object3D#added
  10082. * @type {Object}
  10083. */
  10084. const _addedEvent = { type: 'added' };
  10085. /**
  10086. * Fires when the object has been removed from its parent object.
  10087. *
  10088. * @event Object3D#removed
  10089. * @type {Object}
  10090. */
  10091. const _removedEvent = { type: 'removed' };
  10092. /**
  10093. * Fires when a new child object has been added.
  10094. *
  10095. * @event Object3D#childadded
  10096. * @type {Object}
  10097. */
  10098. const _childaddedEvent = { type: 'childadded', child: null };
  10099. /**
  10100. * Fires when a child object has been removed.
  10101. *
  10102. * @event Object3D#childremoved
  10103. * @type {Object}
  10104. */
  10105. const _childremovedEvent = { type: 'childremoved', child: null };
  10106. /**
  10107. * This is the base class for most objects in three.js and provides a set of
  10108. * properties and methods for manipulating objects in 3D space.
  10109. *
  10110. * @augments EventDispatcher
  10111. */
  10112. class Object3D extends EventDispatcher {
  10113. /**
  10114. * Constructs a new 3D object.
  10115. */
  10116. constructor() {
  10117. super();
  10118. /**
  10119. * This flag can be used for type testing.
  10120. *
  10121. * @type {boolean}
  10122. * @readonly
  10123. * @default true
  10124. */
  10125. this.isObject3D = true;
  10126. /**
  10127. * The ID of the 3D object.
  10128. *
  10129. * @name Object3D#id
  10130. * @type {number}
  10131. * @readonly
  10132. */
  10133. Object.defineProperty( this, 'id', { value: _object3DId ++ } );
  10134. /**
  10135. * The UUID of the 3D object.
  10136. *
  10137. * @type {string}
  10138. * @readonly
  10139. */
  10140. this.uuid = generateUUID();
  10141. /**
  10142. * The name of the 3D object.
  10143. *
  10144. * @type {string}
  10145. */
  10146. this.name = '';
  10147. /**
  10148. * The type property is used for detecting the object type
  10149. * in context of serialization/deserialization.
  10150. *
  10151. * @type {string}
  10152. * @readonly
  10153. */
  10154. this.type = 'Object3D';
  10155. /**
  10156. * A reference to the parent object.
  10157. *
  10158. * @type {?Object3D}
  10159. * @default null
  10160. */
  10161. this.parent = null;
  10162. /**
  10163. * An array holding the child 3D objects of this instance.
  10164. *
  10165. * @type {Array<Object3D>}
  10166. */
  10167. this.children = [];
  10168. /**
  10169. * Defines the `up` direction of the 3D object which influences
  10170. * the orientation via methods like {@link Object3D#lookAt}.
  10171. *
  10172. * The default values for all 3D objects is defined by `Object3D.DEFAULT_UP`.
  10173. *
  10174. * @type {Vector3}
  10175. */
  10176. this.up = Object3D.DEFAULT_UP.clone();
  10177. const position = new Vector3();
  10178. const rotation = new Euler();
  10179. const quaternion = new Quaternion();
  10180. const scale = new Vector3( 1, 1, 1 );
  10181. function onRotationChange() {
  10182. quaternion.setFromEuler( rotation, false );
  10183. }
  10184. function onQuaternionChange() {
  10185. rotation.setFromQuaternion( quaternion, undefined, false );
  10186. }
  10187. rotation._onChange( onRotationChange );
  10188. quaternion._onChange( onQuaternionChange );
  10189. Object.defineProperties( this, {
  10190. /**
  10191. * Represents the object's local position.
  10192. *
  10193. * @name Object3D#position
  10194. * @type {Vector3}
  10195. * @default (0,0,0)
  10196. */
  10197. position: {
  10198. configurable: true,
  10199. enumerable: true,
  10200. value: position
  10201. },
  10202. /**
  10203. * Represents the object's local rotation as Euler angles, in radians.
  10204. *
  10205. * @name Object3D#rotation
  10206. * @type {Euler}
  10207. * @default (0,0,0)
  10208. */
  10209. rotation: {
  10210. configurable: true,
  10211. enumerable: true,
  10212. value: rotation
  10213. },
  10214. /**
  10215. * Represents the object's local rotation as Quaternions.
  10216. *
  10217. * @name Object3D#quaternion
  10218. * @type {Quaternion}
  10219. */
  10220. quaternion: {
  10221. configurable: true,
  10222. enumerable: true,
  10223. value: quaternion
  10224. },
  10225. /**
  10226. * Represents the object's local scale.
  10227. *
  10228. * @name Object3D#scale
  10229. * @type {Vector3}
  10230. * @default (1,1,1)
  10231. */
  10232. scale: {
  10233. configurable: true,
  10234. enumerable: true,
  10235. value: scale
  10236. },
  10237. /**
  10238. * Represents the object's model-view matrix.
  10239. *
  10240. * @name Object3D#modelViewMatrix
  10241. * @type {Matrix4}
  10242. */
  10243. modelViewMatrix: {
  10244. value: new Matrix4()
  10245. },
  10246. /**
  10247. * Represents the object's normal matrix.
  10248. *
  10249. * @name Object3D#normalMatrix
  10250. * @type {Matrix3}
  10251. */
  10252. normalMatrix: {
  10253. value: new Matrix3()
  10254. }
  10255. } );
  10256. /**
  10257. * Represents the object's transformation matrix in local space.
  10258. *
  10259. * @type {Matrix4}
  10260. */
  10261. this.matrix = new Matrix4();
  10262. /**
  10263. * Represents the object's transformation matrix in world space.
  10264. * If the 3D object has no parent, then it's identical to the local transformation matrix
  10265. *
  10266. * @type {Matrix4}
  10267. */
  10268. this.matrixWorld = new Matrix4();
  10269. /**
  10270. * When set to `true`, the engine automatically computes the local matrix from position,
  10271. * rotation and scale every frame.
  10272. *
  10273. * The default values for all 3D objects is defined by `Object3D.DEFAULT_MATRIX_AUTO_UPDATE`.
  10274. *
  10275. * @type {boolean}
  10276. * @default true
  10277. */
  10278. this.matrixAutoUpdate = Object3D.DEFAULT_MATRIX_AUTO_UPDATE;
  10279. /**
  10280. * When set to `true`, the engine automatically computes the world matrix from the current local
  10281. * matrix and the object's transformation hierarchy.
  10282. *
  10283. * The default values for all 3D objects is defined by `Object3D.DEFAULT_MATRIX_WORLD_AUTO_UPDATE`.
  10284. *
  10285. * @type {boolean}
  10286. * @default true
  10287. */
  10288. this.matrixWorldAutoUpdate = Object3D.DEFAULT_MATRIX_WORLD_AUTO_UPDATE; // checked by the renderer
  10289. /**
  10290. * When set to `true`, it calculates the world matrix in that frame and resets this property
  10291. * to `false`.
  10292. *
  10293. * @type {boolean}
  10294. * @default false
  10295. */
  10296. this.matrixWorldNeedsUpdate = false;
  10297. /**
  10298. * The layer membership of the 3D object. The 3D object is only visible if it has
  10299. * at least one layer in common with the camera in use. This property can also be
  10300. * used to filter out unwanted objects in ray-intersection tests when using {@link Raycaster}.
  10301. *
  10302. * @type {Layers}
  10303. */
  10304. this.layers = new Layers();
  10305. /**
  10306. * When set to `true`, the 3D object gets rendered.
  10307. *
  10308. * @type {boolean}
  10309. * @default true
  10310. */
  10311. this.visible = true;
  10312. /**
  10313. * When set to `true`, the 3D object gets rendered into shadow maps.
  10314. *
  10315. * @type {boolean}
  10316. * @default false
  10317. */
  10318. this.castShadow = false;
  10319. /**
  10320. * When set to `true`, the 3D object is affected by shadows in the scene.
  10321. *
  10322. * @type {boolean}
  10323. * @default false
  10324. */
  10325. this.receiveShadow = false;
  10326. /**
  10327. * When set to `true`, the 3D object is honored by view frustum culling.
  10328. *
  10329. * @type {boolean}
  10330. * @default true
  10331. */
  10332. this.frustumCulled = true;
  10333. /**
  10334. * This value allows the default rendering order of scene graph objects to be
  10335. * overridden although opaque and transparent objects remain sorted independently.
  10336. * When this property is set for an instance of {@link Group},all descendants
  10337. * objects will be sorted and rendered together. Sorting is from lowest to highest
  10338. * render order.
  10339. *
  10340. * @type {number}
  10341. * @default 0
  10342. */
  10343. this.renderOrder = 0;
  10344. /**
  10345. * An array holding the animation clips of the 3D object.
  10346. *
  10347. * @type {Array<AnimationClip>}
  10348. */
  10349. this.animations = [];
  10350. /**
  10351. * Custom depth material to be used when rendering to the depth map. Can only be used
  10352. * in context of meshes. When shadow-casting with a {@link DirectionalLight} or {@link SpotLight},
  10353. * if you are modifying vertex positions in the vertex shader you must specify a custom depth
  10354. * material for proper shadows.
  10355. *
  10356. * Only relevant in context of {@link WebGLRenderer}.
  10357. *
  10358. * @type {(Material|undefined)}
  10359. * @default undefined
  10360. */
  10361. this.customDepthMaterial = undefined;
  10362. /**
  10363. * Same as {@link Object3D#customDepthMaterial}, but used with {@link PointLight}.
  10364. *
  10365. * Only relevant in context of {@link WebGLRenderer}.
  10366. *
  10367. * @type {(Material|undefined)}
  10368. * @default undefined
  10369. */
  10370. this.customDistanceMaterial = undefined;
  10371. /**
  10372. * An object that can be used to store custom data about the 3D object. It
  10373. * should not hold references to functions as these will not be cloned.
  10374. *
  10375. * @type {Object}
  10376. */
  10377. this.userData = {};
  10378. }
  10379. /**
  10380. * A callback that is executed immediately before a 3D object is rendered to a shadow map.
  10381. *
  10382. * @param {Renderer|WebGLRenderer} renderer - The renderer.
  10383. * @param {Object3D} object - The 3D object.
  10384. * @param {Camera} camera - The camera that is used to render the scene.
  10385. * @param {Camera} shadowCamera - The shadow camera.
  10386. * @param {BufferGeometry} geometry - The 3D object's geometry.
  10387. * @param {Material} depthMaterial - The depth material.
  10388. * @param {Object} group - The geometry group data.
  10389. */
  10390. onBeforeShadow( /* renderer, object, camera, shadowCamera, geometry, depthMaterial, group */ ) {}
  10391. /**
  10392. * A callback that is executed immediately after a 3D object is rendered to a shadow map.
  10393. *
  10394. * @param {Renderer|WebGLRenderer} renderer - The renderer.
  10395. * @param {Object3D} object - The 3D object.
  10396. * @param {Camera} camera - The camera that is used to render the scene.
  10397. * @param {Camera} shadowCamera - The shadow camera.
  10398. * @param {BufferGeometry} geometry - The 3D object's geometry.
  10399. * @param {Material} depthMaterial - The depth material.
  10400. * @param {Object} group - The geometry group data.
  10401. */
  10402. onAfterShadow( /* renderer, object, camera, shadowCamera, geometry, depthMaterial, group */ ) {}
  10403. /**
  10404. * A callback that is executed immediately before a 3D object is rendered.
  10405. *
  10406. * @param {Renderer|WebGLRenderer} renderer - The renderer.
  10407. * @param {Object3D} object - The 3D object.
  10408. * @param {Camera} camera - The camera that is used to render the scene.
  10409. * @param {BufferGeometry} geometry - The 3D object's geometry.
  10410. * @param {Material} material - The 3D object's material.
  10411. * @param {Object} group - The geometry group data.
  10412. */
  10413. onBeforeRender( /* renderer, scene, camera, geometry, material, group */ ) {}
  10414. /**
  10415. * A callback that is executed immediately after a 3D object is rendered.
  10416. *
  10417. * @param {Renderer|WebGLRenderer} renderer - The renderer.
  10418. * @param {Object3D} object - The 3D object.
  10419. * @param {Camera} camera - The camera that is used to render the scene.
  10420. * @param {BufferGeometry} geometry - The 3D object's geometry.
  10421. * @param {Material} material - The 3D object's material.
  10422. * @param {Object} group - The geometry group data.
  10423. */
  10424. onAfterRender( /* renderer, scene, camera, geometry, material, group */ ) {}
  10425. /**
  10426. * Applies the given transformation matrix to the object and updates the object's position,
  10427. * rotation and scale.
  10428. *
  10429. * @param {Matrix4} matrix - The transformation matrix.
  10430. */
  10431. applyMatrix4( matrix ) {
  10432. if ( this.matrixAutoUpdate ) this.updateMatrix();
  10433. this.matrix.premultiply( matrix );
  10434. this.matrix.decompose( this.position, this.quaternion, this.scale );
  10435. }
  10436. /**
  10437. * Applies a rotation represented by given the quaternion to the 3D object.
  10438. *
  10439. * @param {Quaternion} q - The quaternion.
  10440. * @return {Object3D} A reference to this instance.
  10441. */
  10442. applyQuaternion( q ) {
  10443. this.quaternion.premultiply( q );
  10444. return this;
  10445. }
  10446. /**
  10447. * Sets the given rotation represented as an axis/angle couple to the 3D object.
  10448. *
  10449. * @param {Vector3} axis - The (normalized) axis vector.
  10450. * @param {number} angle - The angle in radians.
  10451. */
  10452. setRotationFromAxisAngle( axis, angle ) {
  10453. // assumes axis is normalized
  10454. this.quaternion.setFromAxisAngle( axis, angle );
  10455. }
  10456. /**
  10457. * Sets the given rotation represented as Euler angles to the 3D object.
  10458. *
  10459. * @param {Euler} euler - The Euler angles.
  10460. */
  10461. setRotationFromEuler( euler ) {
  10462. this.quaternion.setFromEuler( euler, true );
  10463. }
  10464. /**
  10465. * Sets the given rotation represented as rotation matrix to the 3D object.
  10466. *
  10467. * @param {Matrix4} m - Although a 4x4 matrix is expected, the upper 3x3 portion must be
  10468. * a pure rotation matrix (i.e, unscaled).
  10469. */
  10470. setRotationFromMatrix( m ) {
  10471. // assumes the upper 3x3 of m is a pure rotation matrix (i.e, unscaled)
  10472. this.quaternion.setFromRotationMatrix( m );
  10473. }
  10474. /**
  10475. * Sets the given rotation represented as a Quaternion to the 3D object.
  10476. *
  10477. * @param {Quaternion} q - The Quaternion
  10478. */
  10479. setRotationFromQuaternion( q ) {
  10480. // assumes q is normalized
  10481. this.quaternion.copy( q );
  10482. }
  10483. /**
  10484. * Rotates the 3D object along an axis in local space.
  10485. *
  10486. * @param {Vector3} axis - The (normalized) axis vector.
  10487. * @param {number} angle - The angle in radians.
  10488. * @return {Object3D} A reference to this instance.
  10489. */
  10490. rotateOnAxis( axis, angle ) {
  10491. // rotate object on axis in object space
  10492. // axis is assumed to be normalized
  10493. _q1.setFromAxisAngle( axis, angle );
  10494. this.quaternion.multiply( _q1 );
  10495. return this;
  10496. }
  10497. /**
  10498. * Rotates the 3D object along an axis in world space.
  10499. *
  10500. * @param {Vector3} axis - The (normalized) axis vector.
  10501. * @param {number} angle - The angle in radians.
  10502. * @return {Object3D} A reference to this instance.
  10503. */
  10504. rotateOnWorldAxis( axis, angle ) {
  10505. // rotate object on axis in world space
  10506. // axis is assumed to be normalized
  10507. // method assumes no rotated parent
  10508. _q1.setFromAxisAngle( axis, angle );
  10509. this.quaternion.premultiply( _q1 );
  10510. return this;
  10511. }
  10512. /**
  10513. * Rotates the 3D object around its X axis in local space.
  10514. *
  10515. * @param {number} angle - The angle in radians.
  10516. * @return {Object3D} A reference to this instance.
  10517. */
  10518. rotateX( angle ) {
  10519. return this.rotateOnAxis( _xAxis, angle );
  10520. }
  10521. /**
  10522. * Rotates the 3D object around its Y axis in local space.
  10523. *
  10524. * @param {number} angle - The angle in radians.
  10525. * @return {Object3D} A reference to this instance.
  10526. */
  10527. rotateY( angle ) {
  10528. return this.rotateOnAxis( _yAxis, angle );
  10529. }
  10530. /**
  10531. * Rotates the 3D object around its Z axis in local space.
  10532. *
  10533. * @param {number} angle - The angle in radians.
  10534. * @return {Object3D} A reference to this instance.
  10535. */
  10536. rotateZ( angle ) {
  10537. return this.rotateOnAxis( _zAxis, angle );
  10538. }
  10539. /**
  10540. * Translate the 3D object by a distance along the given axis in local space.
  10541. *
  10542. * @param {Vector3} axis - The (normalized) axis vector.
  10543. * @param {number} distance - The distance in world units.
  10544. * @return {Object3D} A reference to this instance.
  10545. */
  10546. translateOnAxis( axis, distance ) {
  10547. // translate object by distance along axis in object space
  10548. // axis is assumed to be normalized
  10549. _v1$4.copy( axis ).applyQuaternion( this.quaternion );
  10550. this.position.add( _v1$4.multiplyScalar( distance ) );
  10551. return this;
  10552. }
  10553. /**
  10554. * Translate the 3D object by a distance along its X-axis in local space.
  10555. *
  10556. * @param {number} distance - The distance in world units.
  10557. * @return {Object3D} A reference to this instance.
  10558. */
  10559. translateX( distance ) {
  10560. return this.translateOnAxis( _xAxis, distance );
  10561. }
  10562. /**
  10563. * Translate the 3D object by a distance along its Y-axis in local space.
  10564. *
  10565. * @param {number} distance - The distance in world units.
  10566. * @return {Object3D} A reference to this instance.
  10567. */
  10568. translateY( distance ) {
  10569. return this.translateOnAxis( _yAxis, distance );
  10570. }
  10571. /**
  10572. * Translate the 3D object by a distance along its Z-axis in local space.
  10573. *
  10574. * @param {number} distance - The distance in world units.
  10575. * @return {Object3D} A reference to this instance.
  10576. */
  10577. translateZ( distance ) {
  10578. return this.translateOnAxis( _zAxis, distance );
  10579. }
  10580. /**
  10581. * Converts the given vector from this 3D object's local space to world space.
  10582. *
  10583. * @param {Vector3} vector - The vector to convert.
  10584. * @return {Vector3} The converted vector.
  10585. */
  10586. localToWorld( vector ) {
  10587. this.updateWorldMatrix( true, false );
  10588. return vector.applyMatrix4( this.matrixWorld );
  10589. }
  10590. /**
  10591. * Converts the given vector from this 3D object's world space to local space.
  10592. *
  10593. * @param {Vector3} vector - The vector to convert.
  10594. * @return {Vector3} The converted vector.
  10595. */
  10596. worldToLocal( vector ) {
  10597. this.updateWorldMatrix( true, false );
  10598. return vector.applyMatrix4( _m1$1.copy( this.matrixWorld ).invert() );
  10599. }
  10600. /**
  10601. * Rotates the object to face a point in world space.
  10602. *
  10603. * This method does not support objects having non-uniformly-scaled parent(s).
  10604. *
  10605. * @param {number|Vector3} x - The x coordinate in world space. Alternatively, a vector representing a position in world space
  10606. * @param {number} [y] - The y coordinate in world space.
  10607. * @param {number} [z] - The z coordinate in world space.
  10608. */
  10609. lookAt( x, y, z ) {
  10610. // This method does not support objects having non-uniformly-scaled parent(s)
  10611. if ( x.isVector3 ) {
  10612. _target.copy( x );
  10613. } else {
  10614. _target.set( x, y, z );
  10615. }
  10616. const parent = this.parent;
  10617. this.updateWorldMatrix( true, false );
  10618. _position$3.setFromMatrixPosition( this.matrixWorld );
  10619. if ( this.isCamera || this.isLight ) {
  10620. _m1$1.lookAt( _position$3, _target, this.up );
  10621. } else {
  10622. _m1$1.lookAt( _target, _position$3, this.up );
  10623. }
  10624. this.quaternion.setFromRotationMatrix( _m1$1 );
  10625. if ( parent ) {
  10626. _m1$1.extractRotation( parent.matrixWorld );
  10627. _q1.setFromRotationMatrix( _m1$1 );
  10628. this.quaternion.premultiply( _q1.invert() );
  10629. }
  10630. }
  10631. /**
  10632. * Adds the given 3D object as a child to this 3D object. An arbitrary number of
  10633. * objects may be added. Any current parent on an object passed in here will be
  10634. * removed, since an object can have at most one parent.
  10635. *
  10636. * @fires Object3D#added
  10637. * @fires Object3D#childadded
  10638. * @param {Object3D} object - The 3D object to add.
  10639. * @return {Object3D} A reference to this instance.
  10640. */
  10641. add( object ) {
  10642. if ( arguments.length > 1 ) {
  10643. for ( let i = 0; i < arguments.length; i ++ ) {
  10644. this.add( arguments[ i ] );
  10645. }
  10646. return this;
  10647. }
  10648. if ( object === this ) {
  10649. error( 'Object3D.add: object can\'t be added as a child of itself.', object );
  10650. return this;
  10651. }
  10652. if ( object && object.isObject3D ) {
  10653. object.removeFromParent();
  10654. object.parent = this;
  10655. this.children.push( object );
  10656. object.dispatchEvent( _addedEvent );
  10657. _childaddedEvent.child = object;
  10658. this.dispatchEvent( _childaddedEvent );
  10659. _childaddedEvent.child = null;
  10660. } else {
  10661. error( 'Object3D.add: object not an instance of THREE.Object3D.', object );
  10662. }
  10663. return this;
  10664. }
  10665. /**
  10666. * Removes the given 3D object as child from this 3D object.
  10667. * An arbitrary number of objects may be removed.
  10668. *
  10669. * @fires Object3D#removed
  10670. * @fires Object3D#childremoved
  10671. * @param {Object3D} object - The 3D object to remove.
  10672. * @return {Object3D} A reference to this instance.
  10673. */
  10674. remove( object ) {
  10675. if ( arguments.length > 1 ) {
  10676. for ( let i = 0; i < arguments.length; i ++ ) {
  10677. this.remove( arguments[ i ] );
  10678. }
  10679. return this;
  10680. }
  10681. const index = this.children.indexOf( object );
  10682. if ( index !== -1 ) {
  10683. object.parent = null;
  10684. this.children.splice( index, 1 );
  10685. object.dispatchEvent( _removedEvent );
  10686. _childremovedEvent.child = object;
  10687. this.dispatchEvent( _childremovedEvent );
  10688. _childremovedEvent.child = null;
  10689. }
  10690. return this;
  10691. }
  10692. /**
  10693. * Removes this 3D object from its current parent.
  10694. *
  10695. * @fires Object3D#removed
  10696. * @fires Object3D#childremoved
  10697. * @return {Object3D} A reference to this instance.
  10698. */
  10699. removeFromParent() {
  10700. const parent = this.parent;
  10701. if ( parent !== null ) {
  10702. parent.remove( this );
  10703. }
  10704. return this;
  10705. }
  10706. /**
  10707. * Removes all child objects.
  10708. *
  10709. * @fires Object3D#removed
  10710. * @fires Object3D#childremoved
  10711. * @return {Object3D} A reference to this instance.
  10712. */
  10713. clear() {
  10714. return this.remove( ... this.children );
  10715. }
  10716. /**
  10717. * Adds the given 3D object as a child of this 3D object, while maintaining the object's world
  10718. * transform. This method does not support scene graphs having non-uniformly-scaled nodes(s).
  10719. *
  10720. * @fires Object3D#added
  10721. * @fires Object3D#childadded
  10722. * @param {Object3D} object - The 3D object to attach.
  10723. * @return {Object3D} A reference to this instance.
  10724. */
  10725. attach( object ) {
  10726. // adds object as a child of this, while maintaining the object's world transform
  10727. // Note: This method does not support scene graphs having non-uniformly-scaled nodes(s)
  10728. this.updateWorldMatrix( true, false );
  10729. _m1$1.copy( this.matrixWorld ).invert();
  10730. if ( object.parent !== null ) {
  10731. object.parent.updateWorldMatrix( true, false );
  10732. _m1$1.multiply( object.parent.matrixWorld );
  10733. }
  10734. object.applyMatrix4( _m1$1 );
  10735. object.removeFromParent();
  10736. object.parent = this;
  10737. this.children.push( object );
  10738. object.updateWorldMatrix( false, true );
  10739. object.dispatchEvent( _addedEvent );
  10740. _childaddedEvent.child = object;
  10741. this.dispatchEvent( _childaddedEvent );
  10742. _childaddedEvent.child = null;
  10743. return this;
  10744. }
  10745. /**
  10746. * Searches through the 3D object and its children, starting with the 3D object
  10747. * itself, and returns the first with a matching ID.
  10748. *
  10749. * @param {number} id - The id.
  10750. * @return {Object3D|undefined} The found 3D object. Returns `undefined` if no 3D object has been found.
  10751. */
  10752. getObjectById( id ) {
  10753. return this.getObjectByProperty( 'id', id );
  10754. }
  10755. /**
  10756. * Searches through the 3D object and its children, starting with the 3D object
  10757. * itself, and returns the first with a matching name.
  10758. *
  10759. * @param {string} name - The name.
  10760. * @return {Object3D|undefined} The found 3D object. Returns `undefined` if no 3D object has been found.
  10761. */
  10762. getObjectByName( name ) {
  10763. return this.getObjectByProperty( 'name', name );
  10764. }
  10765. /**
  10766. * Searches through the 3D object and its children, starting with the 3D object
  10767. * itself, and returns the first with a matching property value.
  10768. *
  10769. * @param {string} name - The name of the property.
  10770. * @param {any} value - The value.
  10771. * @return {Object3D|undefined} The found 3D object. Returns `undefined` if no 3D object has been found.
  10772. */
  10773. getObjectByProperty( name, value ) {
  10774. if ( this[ name ] === value ) return this;
  10775. for ( let i = 0, l = this.children.length; i < l; i ++ ) {
  10776. const child = this.children[ i ];
  10777. const object = child.getObjectByProperty( name, value );
  10778. if ( object !== undefined ) {
  10779. return object;
  10780. }
  10781. }
  10782. return undefined;
  10783. }
  10784. /**
  10785. * Searches through the 3D object and its children, starting with the 3D object
  10786. * itself, and returns all 3D objects with a matching property value.
  10787. *
  10788. * @param {string} name - The name of the property.
  10789. * @param {any} value - The value.
  10790. * @param {Array<Object3D>} result - The method stores the result in this array.
  10791. * @return {Array<Object3D>} The found 3D objects.
  10792. */
  10793. getObjectsByProperty( name, value, result = [] ) {
  10794. if ( this[ name ] === value ) result.push( this );
  10795. const children = this.children;
  10796. for ( let i = 0, l = children.length; i < l; i ++ ) {
  10797. children[ i ].getObjectsByProperty( name, value, result );
  10798. }
  10799. return result;
  10800. }
  10801. /**
  10802. * Returns a vector representing the position of the 3D object in world space.
  10803. *
  10804. * @param {Vector3} target - The target vector the result is stored to.
  10805. * @return {Vector3} The 3D object's position in world space.
  10806. */
  10807. getWorldPosition( target ) {
  10808. this.updateWorldMatrix( true, false );
  10809. return target.setFromMatrixPosition( this.matrixWorld );
  10810. }
  10811. /**
  10812. * Returns a Quaternion representing the position of the 3D object in world space.
  10813. *
  10814. * @param {Quaternion} target - The target Quaternion the result is stored to.
  10815. * @return {Quaternion} The 3D object's rotation in world space.
  10816. */
  10817. getWorldQuaternion( target ) {
  10818. this.updateWorldMatrix( true, false );
  10819. this.matrixWorld.decompose( _position$3, target, _scale$2 );
  10820. return target;
  10821. }
  10822. /**
  10823. * Returns a vector representing the scale of the 3D object in world space.
  10824. *
  10825. * @param {Vector3} target - The target vector the result is stored to.
  10826. * @return {Vector3} The 3D object's scale in world space.
  10827. */
  10828. getWorldScale( target ) {
  10829. this.updateWorldMatrix( true, false );
  10830. this.matrixWorld.decompose( _position$3, _quaternion$2, target );
  10831. return target;
  10832. }
  10833. /**
  10834. * Returns a vector representing the ("look") direction of the 3D object in world space.
  10835. *
  10836. * @param {Vector3} target - The target vector the result is stored to.
  10837. * @return {Vector3} The 3D object's direction in world space.
  10838. */
  10839. getWorldDirection( target ) {
  10840. this.updateWorldMatrix( true, false );
  10841. const e = this.matrixWorld.elements;
  10842. return target.set( e[ 8 ], e[ 9 ], e[ 10 ] ).normalize();
  10843. }
  10844. /**
  10845. * Abstract method to get intersections between a casted ray and this
  10846. * 3D object. Renderable 3D objects such as {@link Mesh}, {@link Line} or {@link Points}
  10847. * implement this method in order to use raycasting.
  10848. *
  10849. * @abstract
  10850. * @param {Raycaster} raycaster - The raycaster.
  10851. * @param {Array<Object>} intersects - An array holding the result of the method.
  10852. */
  10853. raycast( /* raycaster, intersects */ ) {}
  10854. /**
  10855. * Executes the callback on this 3D object and all descendants.
  10856. *
  10857. * Note: Modifying the scene graph inside the callback is discouraged.
  10858. *
  10859. * @param {Function} callback - A callback function that allows to process the current 3D object.
  10860. */
  10861. traverse( callback ) {
  10862. callback( this );
  10863. const children = this.children;
  10864. for ( let i = 0, l = children.length; i < l; i ++ ) {
  10865. children[ i ].traverse( callback );
  10866. }
  10867. }
  10868. /**
  10869. * Like {@link Object3D#traverse}, but the callback will only be executed for visible 3D objects.
  10870. * Descendants of invisible 3D objects are not traversed.
  10871. *
  10872. * Note: Modifying the scene graph inside the callback is discouraged.
  10873. *
  10874. * @param {Function} callback - A callback function that allows to process the current 3D object.
  10875. */
  10876. traverseVisible( callback ) {
  10877. if ( this.visible === false ) return;
  10878. callback( this );
  10879. const children = this.children;
  10880. for ( let i = 0, l = children.length; i < l; i ++ ) {
  10881. children[ i ].traverseVisible( callback );
  10882. }
  10883. }
  10884. /**
  10885. * Like {@link Object3D#traverse}, but the callback will only be executed for all ancestors.
  10886. *
  10887. * Note: Modifying the scene graph inside the callback is discouraged.
  10888. *
  10889. * @param {Function} callback - A callback function that allows to process the current 3D object.
  10890. */
  10891. traverseAncestors( callback ) {
  10892. const parent = this.parent;
  10893. if ( parent !== null ) {
  10894. callback( parent );
  10895. parent.traverseAncestors( callback );
  10896. }
  10897. }
  10898. /**
  10899. * Updates the transformation matrix in local space by computing it from the current
  10900. * position, rotation and scale values.
  10901. */
  10902. updateMatrix() {
  10903. this.matrix.compose( this.position, this.quaternion, this.scale );
  10904. this.matrixWorldNeedsUpdate = true;
  10905. }
  10906. /**
  10907. * Updates the transformation matrix in world space of this 3D objects and its descendants.
  10908. *
  10909. * To ensure correct results, this method also recomputes the 3D object's transformation matrix in
  10910. * local space. The computation of the local and world matrix can be controlled with the
  10911. * {@link Object3D#matrixAutoUpdate} and {@link Object3D#matrixWorldAutoUpdate} flags which are both
  10912. * `true` by default. Set these flags to `false` if you need more control over the update matrix process.
  10913. *
  10914. * @param {boolean} [force=false] - When set to `true`, a recomputation of world matrices is forced even
  10915. * when {@link Object3D#matrixWorldAutoUpdate} is set to `false`.
  10916. */
  10917. updateMatrixWorld( force ) {
  10918. if ( this.matrixAutoUpdate ) this.updateMatrix();
  10919. if ( this.matrixWorldNeedsUpdate || force ) {
  10920. if ( this.matrixWorldAutoUpdate === true ) {
  10921. if ( this.parent === null ) {
  10922. this.matrixWorld.copy( this.matrix );
  10923. } else {
  10924. this.matrixWorld.multiplyMatrices( this.parent.matrixWorld, this.matrix );
  10925. }
  10926. }
  10927. this.matrixWorldNeedsUpdate = false;
  10928. force = true;
  10929. }
  10930. // make sure descendants are updated if required
  10931. const children = this.children;
  10932. for ( let i = 0, l = children.length; i < l; i ++ ) {
  10933. const child = children[ i ];
  10934. child.updateMatrixWorld( force );
  10935. }
  10936. }
  10937. /**
  10938. * An alternative version of {@link Object3D#updateMatrixWorld} with more control over the
  10939. * update of ancestor and descendant nodes.
  10940. *
  10941. * @param {boolean} [updateParents=false] Whether ancestor nodes should be updated or not.
  10942. * @param {boolean} [updateChildren=false] Whether descendant nodes should be updated or not.
  10943. */
  10944. updateWorldMatrix( updateParents, updateChildren ) {
  10945. const parent = this.parent;
  10946. if ( updateParents === true && parent !== null ) {
  10947. parent.updateWorldMatrix( true, false );
  10948. }
  10949. if ( this.matrixAutoUpdate ) this.updateMatrix();
  10950. if ( this.matrixWorldAutoUpdate === true ) {
  10951. if ( this.parent === null ) {
  10952. this.matrixWorld.copy( this.matrix );
  10953. } else {
  10954. this.matrixWorld.multiplyMatrices( this.parent.matrixWorld, this.matrix );
  10955. }
  10956. }
  10957. // make sure descendants are updated
  10958. if ( updateChildren === true ) {
  10959. const children = this.children;
  10960. for ( let i = 0, l = children.length; i < l; i ++ ) {
  10961. const child = children[ i ];
  10962. child.updateWorldMatrix( false, true );
  10963. }
  10964. }
  10965. }
  10966. /**
  10967. * Serializes the 3D object into JSON.
  10968. *
  10969. * @param {?(Object|string)} meta - An optional value holding meta information about the serialization.
  10970. * @return {Object} A JSON object representing the serialized 3D object.
  10971. * @see {@link ObjectLoader#parse}
  10972. */
  10973. toJSON( meta ) {
  10974. // meta is a string when called from JSON.stringify
  10975. const isRootObject = ( meta === undefined || typeof meta === 'string' );
  10976. const output = {};
  10977. // meta is a hash used to collect geometries, materials.
  10978. // not providing it implies that this is the root object
  10979. // being serialized.
  10980. if ( isRootObject ) {
  10981. // initialize meta obj
  10982. meta = {
  10983. geometries: {},
  10984. materials: {},
  10985. textures: {},
  10986. images: {},
  10987. shapes: {},
  10988. skeletons: {},
  10989. animations: {},
  10990. nodes: {}
  10991. };
  10992. output.metadata = {
  10993. version: 4.7,
  10994. type: 'Object',
  10995. generator: 'Object3D.toJSON'
  10996. };
  10997. }
  10998. // standard Object3D serialization
  10999. const object = {};
  11000. object.uuid = this.uuid;
  11001. object.type = this.type;
  11002. if ( this.name !== '' ) object.name = this.name;
  11003. if ( this.castShadow === true ) object.castShadow = true;
  11004. if ( this.receiveShadow === true ) object.receiveShadow = true;
  11005. if ( this.visible === false ) object.visible = false;
  11006. if ( this.frustumCulled === false ) object.frustumCulled = false;
  11007. if ( this.renderOrder !== 0 ) object.renderOrder = this.renderOrder;
  11008. if ( Object.keys( this.userData ).length > 0 ) object.userData = this.userData;
  11009. object.layers = this.layers.mask;
  11010. object.matrix = this.matrix.toArray();
  11011. object.up = this.up.toArray();
  11012. if ( this.matrixAutoUpdate === false ) object.matrixAutoUpdate = false;
  11013. // object specific properties
  11014. if ( this.isInstancedMesh ) {
  11015. object.type = 'InstancedMesh';
  11016. object.count = this.count;
  11017. object.instanceMatrix = this.instanceMatrix.toJSON();
  11018. if ( this.instanceColor !== null ) object.instanceColor = this.instanceColor.toJSON();
  11019. }
  11020. if ( this.isBatchedMesh ) {
  11021. object.type = 'BatchedMesh';
  11022. object.perObjectFrustumCulled = this.perObjectFrustumCulled;
  11023. object.sortObjects = this.sortObjects;
  11024. object.drawRanges = this._drawRanges;
  11025. object.reservedRanges = this._reservedRanges;
  11026. object.geometryInfo = this._geometryInfo.map( info => ( {
  11027. ...info,
  11028. boundingBox: info.boundingBox ? info.boundingBox.toJSON() : undefined,
  11029. boundingSphere: info.boundingSphere ? info.boundingSphere.toJSON() : undefined
  11030. } ) );
  11031. object.instanceInfo = this._instanceInfo.map( info => ( { ...info } ) );
  11032. object.availableInstanceIds = this._availableInstanceIds.slice();
  11033. object.availableGeometryIds = this._availableGeometryIds.slice();
  11034. object.nextIndexStart = this._nextIndexStart;
  11035. object.nextVertexStart = this._nextVertexStart;
  11036. object.geometryCount = this._geometryCount;
  11037. object.maxInstanceCount = this._maxInstanceCount;
  11038. object.maxVertexCount = this._maxVertexCount;
  11039. object.maxIndexCount = this._maxIndexCount;
  11040. object.geometryInitialized = this._geometryInitialized;
  11041. object.matricesTexture = this._matricesTexture.toJSON( meta );
  11042. object.indirectTexture = this._indirectTexture.toJSON( meta );
  11043. if ( this._colorsTexture !== null ) {
  11044. object.colorsTexture = this._colorsTexture.toJSON( meta );
  11045. }
  11046. if ( this.boundingSphere !== null ) {
  11047. object.boundingSphere = this.boundingSphere.toJSON();
  11048. }
  11049. if ( this.boundingBox !== null ) {
  11050. object.boundingBox = this.boundingBox.toJSON();
  11051. }
  11052. }
  11053. //
  11054. function serialize( library, element ) {
  11055. if ( library[ element.uuid ] === undefined ) {
  11056. library[ element.uuid ] = element.toJSON( meta );
  11057. }
  11058. return element.uuid;
  11059. }
  11060. if ( this.isScene ) {
  11061. if ( this.background ) {
  11062. if ( this.background.isColor ) {
  11063. object.background = this.background.toJSON();
  11064. } else if ( this.background.isTexture ) {
  11065. object.background = this.background.toJSON( meta ).uuid;
  11066. }
  11067. }
  11068. if ( this.environment && this.environment.isTexture && this.environment.isRenderTargetTexture !== true ) {
  11069. object.environment = this.environment.toJSON( meta ).uuid;
  11070. }
  11071. } else if ( this.isMesh || this.isLine || this.isPoints ) {
  11072. object.geometry = serialize( meta.geometries, this.geometry );
  11073. const parameters = this.geometry.parameters;
  11074. if ( parameters !== undefined && parameters.shapes !== undefined ) {
  11075. const shapes = parameters.shapes;
  11076. if ( Array.isArray( shapes ) ) {
  11077. for ( let i = 0, l = shapes.length; i < l; i ++ ) {
  11078. const shape = shapes[ i ];
  11079. serialize( meta.shapes, shape );
  11080. }
  11081. } else {
  11082. serialize( meta.shapes, shapes );
  11083. }
  11084. }
  11085. }
  11086. if ( this.isSkinnedMesh ) {
  11087. object.bindMode = this.bindMode;
  11088. object.bindMatrix = this.bindMatrix.toArray();
  11089. if ( this.skeleton !== undefined ) {
  11090. serialize( meta.skeletons, this.skeleton );
  11091. object.skeleton = this.skeleton.uuid;
  11092. }
  11093. }
  11094. if ( this.material !== undefined ) {
  11095. if ( Array.isArray( this.material ) ) {
  11096. const uuids = [];
  11097. for ( let i = 0, l = this.material.length; i < l; i ++ ) {
  11098. uuids.push( serialize( meta.materials, this.material[ i ] ) );
  11099. }
  11100. object.material = uuids;
  11101. } else {
  11102. object.material = serialize( meta.materials, this.material );
  11103. }
  11104. }
  11105. //
  11106. if ( this.children.length > 0 ) {
  11107. object.children = [];
  11108. for ( let i = 0; i < this.children.length; i ++ ) {
  11109. object.children.push( this.children[ i ].toJSON( meta ).object );
  11110. }
  11111. }
  11112. //
  11113. if ( this.animations.length > 0 ) {
  11114. object.animations = [];
  11115. for ( let i = 0; i < this.animations.length; i ++ ) {
  11116. const animation = this.animations[ i ];
  11117. object.animations.push( serialize( meta.animations, animation ) );
  11118. }
  11119. }
  11120. if ( isRootObject ) {
  11121. const geometries = extractFromCache( meta.geometries );
  11122. const materials = extractFromCache( meta.materials );
  11123. const textures = extractFromCache( meta.textures );
  11124. const images = extractFromCache( meta.images );
  11125. const shapes = extractFromCache( meta.shapes );
  11126. const skeletons = extractFromCache( meta.skeletons );
  11127. const animations = extractFromCache( meta.animations );
  11128. const nodes = extractFromCache( meta.nodes );
  11129. if ( geometries.length > 0 ) output.geometries = geometries;
  11130. if ( materials.length > 0 ) output.materials = materials;
  11131. if ( textures.length > 0 ) output.textures = textures;
  11132. if ( images.length > 0 ) output.images = images;
  11133. if ( shapes.length > 0 ) output.shapes = shapes;
  11134. if ( skeletons.length > 0 ) output.skeletons = skeletons;
  11135. if ( animations.length > 0 ) output.animations = animations;
  11136. if ( nodes.length > 0 ) output.nodes = nodes;
  11137. }
  11138. output.object = object;
  11139. return output;
  11140. // extract data from the cache hash
  11141. // remove metadata on each item
  11142. // and return as array
  11143. function extractFromCache( cache ) {
  11144. const values = [];
  11145. for ( const key in cache ) {
  11146. const data = cache[ key ];
  11147. delete data.metadata;
  11148. values.push( data );
  11149. }
  11150. return values;
  11151. }
  11152. }
  11153. /**
  11154. * Returns a new 3D object with copied values from this instance.
  11155. *
  11156. * @param {boolean} [recursive=true] - When set to `true`, descendants of the 3D object are also cloned.
  11157. * @return {Object3D} A clone of this instance.
  11158. */
  11159. clone( recursive ) {
  11160. return new this.constructor().copy( this, recursive );
  11161. }
  11162. /**
  11163. * Copies the values of the given 3D object to this instance.
  11164. *
  11165. * @param {Object3D} source - The 3D object to copy.
  11166. * @param {boolean} [recursive=true] - When set to `true`, descendants of the 3D object are cloned.
  11167. * @return {Object3D} A reference to this instance.
  11168. */
  11169. copy( source, recursive = true ) {
  11170. this.name = source.name;
  11171. this.up.copy( source.up );
  11172. this.position.copy( source.position );
  11173. this.rotation.order = source.rotation.order;
  11174. this.quaternion.copy( source.quaternion );
  11175. this.scale.copy( source.scale );
  11176. this.matrix.copy( source.matrix );
  11177. this.matrixWorld.copy( source.matrixWorld );
  11178. this.matrixAutoUpdate = source.matrixAutoUpdate;
  11179. this.matrixWorldAutoUpdate = source.matrixWorldAutoUpdate;
  11180. this.matrixWorldNeedsUpdate = source.matrixWorldNeedsUpdate;
  11181. this.layers.mask = source.layers.mask;
  11182. this.visible = source.visible;
  11183. this.castShadow = source.castShadow;
  11184. this.receiveShadow = source.receiveShadow;
  11185. this.frustumCulled = source.frustumCulled;
  11186. this.renderOrder = source.renderOrder;
  11187. this.animations = source.animations.slice();
  11188. this.userData = JSON.parse( JSON.stringify( source.userData ) );
  11189. if ( recursive === true ) {
  11190. for ( let i = 0; i < source.children.length; i ++ ) {
  11191. const child = source.children[ i ];
  11192. this.add( child.clone() );
  11193. }
  11194. }
  11195. return this;
  11196. }
  11197. }
  11198. /**
  11199. * The default up direction for objects, also used as the default
  11200. * position for {@link DirectionalLight} and {@link HemisphereLight}.
  11201. *
  11202. * @static
  11203. * @type {Vector3}
  11204. * @default (0,1,0)
  11205. */
  11206. Object3D.DEFAULT_UP = /*@__PURE__*/ new Vector3( 0, 1, 0 );
  11207. /**
  11208. * The default setting for {@link Object3D#matrixAutoUpdate} for
  11209. * newly created 3D objects.
  11210. *
  11211. * @static
  11212. * @type {boolean}
  11213. * @default true
  11214. */
  11215. Object3D.DEFAULT_MATRIX_AUTO_UPDATE = true;
  11216. /**
  11217. * The default setting for {@link Object3D#matrixWorldAutoUpdate} for
  11218. * newly created 3D objects.
  11219. *
  11220. * @static
  11221. * @type {boolean}
  11222. * @default true
  11223. */
  11224. Object3D.DEFAULT_MATRIX_WORLD_AUTO_UPDATE = true;
  11225. const _v0$1 = /*@__PURE__*/ new Vector3();
  11226. const _v1$3 = /*@__PURE__*/ new Vector3();
  11227. const _v2$2 = /*@__PURE__*/ new Vector3();
  11228. const _v3$2 = /*@__PURE__*/ new Vector3();
  11229. const _vab = /*@__PURE__*/ new Vector3();
  11230. const _vac = /*@__PURE__*/ new Vector3();
  11231. const _vbc = /*@__PURE__*/ new Vector3();
  11232. const _vap = /*@__PURE__*/ new Vector3();
  11233. const _vbp = /*@__PURE__*/ new Vector3();
  11234. const _vcp = /*@__PURE__*/ new Vector3();
  11235. const _v40 = /*@__PURE__*/ new Vector4();
  11236. const _v41 = /*@__PURE__*/ new Vector4();
  11237. const _v42 = /*@__PURE__*/ new Vector4();
  11238. /**
  11239. * A geometric triangle as defined by three vectors representing its three corners.
  11240. */
  11241. class Triangle {
  11242. /**
  11243. * Constructs a new triangle.
  11244. *
  11245. * @param {Vector3} [a=(0,0,0)] - The first corner of the triangle.
  11246. * @param {Vector3} [b=(0,0,0)] - The second corner of the triangle.
  11247. * @param {Vector3} [c=(0,0,0)] - The third corner of the triangle.
  11248. */
  11249. constructor( a = new Vector3(), b = new Vector3(), c = new Vector3() ) {
  11250. /**
  11251. * The first corner of the triangle.
  11252. *
  11253. * @type {Vector3}
  11254. */
  11255. this.a = a;
  11256. /**
  11257. * The second corner of the triangle.
  11258. *
  11259. * @type {Vector3}
  11260. */
  11261. this.b = b;
  11262. /**
  11263. * The third corner of the triangle.
  11264. *
  11265. * @type {Vector3}
  11266. */
  11267. this.c = c;
  11268. }
  11269. /**
  11270. * Computes the normal vector of a triangle.
  11271. *
  11272. * @param {Vector3} a - The first corner of the triangle.
  11273. * @param {Vector3} b - The second corner of the triangle.
  11274. * @param {Vector3} c - The third corner of the triangle.
  11275. * @param {Vector3} target - The target vector that is used to store the method's result.
  11276. * @return {Vector3} The triangle's normal.
  11277. */
  11278. static getNormal( a, b, c, target ) {
  11279. target.subVectors( c, b );
  11280. _v0$1.subVectors( a, b );
  11281. target.cross( _v0$1 );
  11282. const targetLengthSq = target.lengthSq();
  11283. if ( targetLengthSq > 0 ) {
  11284. return target.multiplyScalar( 1 / Math.sqrt( targetLengthSq ) );
  11285. }
  11286. return target.set( 0, 0, 0 );
  11287. }
  11288. /**
  11289. * Computes a barycentric coordinates from the given vector.
  11290. * Returns `null` if the triangle is degenerate.
  11291. *
  11292. * @param {Vector3} point - A point in 3D space.
  11293. * @param {Vector3} a - The first corner of the triangle.
  11294. * @param {Vector3} b - The second corner of the triangle.
  11295. * @param {Vector3} c - The third corner of the triangle.
  11296. * @param {Vector3} target - The target vector that is used to store the method's result.
  11297. * @return {?Vector3} The barycentric coordinates for the given point
  11298. */
  11299. static getBarycoord( point, a, b, c, target ) {
  11300. // based on: http://www.blackpawn.com/texts/pointinpoly/default.html
  11301. _v0$1.subVectors( c, a );
  11302. _v1$3.subVectors( b, a );
  11303. _v2$2.subVectors( point, a );
  11304. const dot00 = _v0$1.dot( _v0$1 );
  11305. const dot01 = _v0$1.dot( _v1$3 );
  11306. const dot02 = _v0$1.dot( _v2$2 );
  11307. const dot11 = _v1$3.dot( _v1$3 );
  11308. const dot12 = _v1$3.dot( _v2$2 );
  11309. const denom = ( dot00 * dot11 - dot01 * dot01 );
  11310. // collinear or singular triangle
  11311. if ( denom === 0 ) {
  11312. target.set( 0, 0, 0 );
  11313. return null;
  11314. }
  11315. const invDenom = 1 / denom;
  11316. const u = ( dot11 * dot02 - dot01 * dot12 ) * invDenom;
  11317. const v = ( dot00 * dot12 - dot01 * dot02 ) * invDenom;
  11318. // barycentric coordinates must always sum to 1
  11319. return target.set( 1 - u - v, v, u );
  11320. }
  11321. /**
  11322. * Returns `true` if the given point, when projected onto the plane of the
  11323. * triangle, lies within the triangle.
  11324. *
  11325. * @param {Vector3} point - The point in 3D space to test.
  11326. * @param {Vector3} a - The first corner of the triangle.
  11327. * @param {Vector3} b - The second corner of the triangle.
  11328. * @param {Vector3} c - The third corner of the triangle.
  11329. * @return {boolean} Whether the given point, when projected onto the plane of the
  11330. * triangle, lies within the triangle or not.
  11331. */
  11332. static containsPoint( point, a, b, c ) {
  11333. // if the triangle is degenerate then we can't contain a point
  11334. if ( this.getBarycoord( point, a, b, c, _v3$2 ) === null ) {
  11335. return false;
  11336. }
  11337. return ( _v3$2.x >= 0 ) && ( _v3$2.y >= 0 ) && ( ( _v3$2.x + _v3$2.y ) <= 1 );
  11338. }
  11339. /**
  11340. * Computes the value barycentrically interpolated for the given point on the
  11341. * triangle. Returns `null` if the triangle is degenerate.
  11342. *
  11343. * @param {Vector3} point - Position of interpolated point.
  11344. * @param {Vector3} p1 - The first corner of the triangle.
  11345. * @param {Vector3} p2 - The second corner of the triangle.
  11346. * @param {Vector3} p3 - The third corner of the triangle.
  11347. * @param {Vector3} v1 - Value to interpolate of first vertex.
  11348. * @param {Vector3} v2 - Value to interpolate of second vertex.
  11349. * @param {Vector3} v3 - Value to interpolate of third vertex.
  11350. * @param {Vector3} target - The target vector that is used to store the method's result.
  11351. * @return {?Vector3} The interpolated value.
  11352. */
  11353. static getInterpolation( point, p1, p2, p3, v1, v2, v3, target ) {
  11354. if ( this.getBarycoord( point, p1, p2, p3, _v3$2 ) === null ) {
  11355. target.x = 0;
  11356. target.y = 0;
  11357. if ( 'z' in target ) target.z = 0;
  11358. if ( 'w' in target ) target.w = 0;
  11359. return null;
  11360. }
  11361. target.setScalar( 0 );
  11362. target.addScaledVector( v1, _v3$2.x );
  11363. target.addScaledVector( v2, _v3$2.y );
  11364. target.addScaledVector( v3, _v3$2.z );
  11365. return target;
  11366. }
  11367. /**
  11368. * Computes the value barycentrically interpolated for the given attribute and indices.
  11369. *
  11370. * @param {BufferAttribute} attr - The attribute to interpolate.
  11371. * @param {number} i1 - Index of first vertex.
  11372. * @param {number} i2 - Index of second vertex.
  11373. * @param {number} i3 - Index of third vertex.
  11374. * @param {Vector3} barycoord - The barycoordinate value to use to interpolate.
  11375. * @param {Vector3} target - The target vector that is used to store the method's result.
  11376. * @return {Vector3} The interpolated attribute value.
  11377. */
  11378. static getInterpolatedAttribute( attr, i1, i2, i3, barycoord, target ) {
  11379. _v40.setScalar( 0 );
  11380. _v41.setScalar( 0 );
  11381. _v42.setScalar( 0 );
  11382. _v40.fromBufferAttribute( attr, i1 );
  11383. _v41.fromBufferAttribute( attr, i2 );
  11384. _v42.fromBufferAttribute( attr, i3 );
  11385. target.setScalar( 0 );
  11386. target.addScaledVector( _v40, barycoord.x );
  11387. target.addScaledVector( _v41, barycoord.y );
  11388. target.addScaledVector( _v42, barycoord.z );
  11389. return target;
  11390. }
  11391. /**
  11392. * Returns `true` if the triangle is oriented towards the given direction.
  11393. *
  11394. * @param {Vector3} a - The first corner of the triangle.
  11395. * @param {Vector3} b - The second corner of the triangle.
  11396. * @param {Vector3} c - The third corner of the triangle.
  11397. * @param {Vector3} direction - The (normalized) direction vector.
  11398. * @return {boolean} Whether the triangle is oriented towards the given direction or not.
  11399. */
  11400. static isFrontFacing( a, b, c, direction ) {
  11401. _v0$1.subVectors( c, b );
  11402. _v1$3.subVectors( a, b );
  11403. // strictly front facing
  11404. return ( _v0$1.cross( _v1$3 ).dot( direction ) < 0 ) ? true : false;
  11405. }
  11406. /**
  11407. * Sets the triangle's vertices by copying the given values.
  11408. *
  11409. * @param {Vector3} a - The first corner of the triangle.
  11410. * @param {Vector3} b - The second corner of the triangle.
  11411. * @param {Vector3} c - The third corner of the triangle.
  11412. * @return {Triangle} A reference to this triangle.
  11413. */
  11414. set( a, b, c ) {
  11415. this.a.copy( a );
  11416. this.b.copy( b );
  11417. this.c.copy( c );
  11418. return this;
  11419. }
  11420. /**
  11421. * Sets the triangle's vertices by copying the given array values.
  11422. *
  11423. * @param {Array<Vector3>} points - An array with 3D points.
  11424. * @param {number} i0 - The array index representing the first corner of the triangle.
  11425. * @param {number} i1 - The array index representing the second corner of the triangle.
  11426. * @param {number} i2 - The array index representing the third corner of the triangle.
  11427. * @return {Triangle} A reference to this triangle.
  11428. */
  11429. setFromPointsAndIndices( points, i0, i1, i2 ) {
  11430. this.a.copy( points[ i0 ] );
  11431. this.b.copy( points[ i1 ] );
  11432. this.c.copy( points[ i2 ] );
  11433. return this;
  11434. }
  11435. /**
  11436. * Sets the triangle's vertices by copying the given attribute values.
  11437. *
  11438. * @param {BufferAttribute} attribute - A buffer attribute with 3D points data.
  11439. * @param {number} i0 - The attribute index representing the first corner of the triangle.
  11440. * @param {number} i1 - The attribute index representing the second corner of the triangle.
  11441. * @param {number} i2 - The attribute index representing the third corner of the triangle.
  11442. * @return {Triangle} A reference to this triangle.
  11443. */
  11444. setFromAttributeAndIndices( attribute, i0, i1, i2 ) {
  11445. this.a.fromBufferAttribute( attribute, i0 );
  11446. this.b.fromBufferAttribute( attribute, i1 );
  11447. this.c.fromBufferAttribute( attribute, i2 );
  11448. return this;
  11449. }
  11450. /**
  11451. * Returns a new triangle with copied values from this instance.
  11452. *
  11453. * @return {Triangle} A clone of this instance.
  11454. */
  11455. clone() {
  11456. return new this.constructor().copy( this );
  11457. }
  11458. /**
  11459. * Copies the values of the given triangle to this instance.
  11460. *
  11461. * @param {Triangle} triangle - The triangle to copy.
  11462. * @return {Triangle} A reference to this triangle.
  11463. */
  11464. copy( triangle ) {
  11465. this.a.copy( triangle.a );
  11466. this.b.copy( triangle.b );
  11467. this.c.copy( triangle.c );
  11468. return this;
  11469. }
  11470. /**
  11471. * Computes the area of the triangle.
  11472. *
  11473. * @return {number} The triangle's area.
  11474. */
  11475. getArea() {
  11476. _v0$1.subVectors( this.c, this.b );
  11477. _v1$3.subVectors( this.a, this.b );
  11478. return _v0$1.cross( _v1$3 ).length() * 0.5;
  11479. }
  11480. /**
  11481. * Computes the midpoint of the triangle.
  11482. *
  11483. * @param {Vector3} target - The target vector that is used to store the method's result.
  11484. * @return {Vector3} The triangle's midpoint.
  11485. */
  11486. getMidpoint( target ) {
  11487. return target.addVectors( this.a, this.b ).add( this.c ).multiplyScalar( 1 / 3 );
  11488. }
  11489. /**
  11490. * Computes the normal of the triangle.
  11491. *
  11492. * @param {Vector3} target - The target vector that is used to store the method's result.
  11493. * @return {Vector3} The triangle's normal.
  11494. */
  11495. getNormal( target ) {
  11496. return Triangle.getNormal( this.a, this.b, this.c, target );
  11497. }
  11498. /**
  11499. * Computes a plane the triangle lies within.
  11500. *
  11501. * @param {Plane} target - The target vector that is used to store the method's result.
  11502. * @return {Plane} The plane the triangle lies within.
  11503. */
  11504. getPlane( target ) {
  11505. return target.setFromCoplanarPoints( this.a, this.b, this.c );
  11506. }
  11507. /**
  11508. * Computes a barycentric coordinates from the given vector.
  11509. * Returns `null` if the triangle is degenerate.
  11510. *
  11511. * @param {Vector3} point - A point in 3D space.
  11512. * @param {Vector3} target - The target vector that is used to store the method's result.
  11513. * @return {?Vector3} The barycentric coordinates for the given point
  11514. */
  11515. getBarycoord( point, target ) {
  11516. return Triangle.getBarycoord( point, this.a, this.b, this.c, target );
  11517. }
  11518. /**
  11519. * Computes the value barycentrically interpolated for the given point on the
  11520. * triangle. Returns `null` if the triangle is degenerate.
  11521. *
  11522. * @param {Vector3} point - Position of interpolated point.
  11523. * @param {Vector3} v1 - Value to interpolate of first vertex.
  11524. * @param {Vector3} v2 - Value to interpolate of second vertex.
  11525. * @param {Vector3} v3 - Value to interpolate of third vertex.
  11526. * @param {Vector3} target - The target vector that is used to store the method's result.
  11527. * @return {?Vector3} The interpolated value.
  11528. */
  11529. getInterpolation( point, v1, v2, v3, target ) {
  11530. return Triangle.getInterpolation( point, this.a, this.b, this.c, v1, v2, v3, target );
  11531. }
  11532. /**
  11533. * Returns `true` if the given point, when projected onto the plane of the
  11534. * triangle, lies within the triangle.
  11535. *
  11536. * @param {Vector3} point - The point in 3D space to test.
  11537. * @return {boolean} Whether the given point, when projected onto the plane of the
  11538. * triangle, lies within the triangle or not.
  11539. */
  11540. containsPoint( point ) {
  11541. return Triangle.containsPoint( point, this.a, this.b, this.c );
  11542. }
  11543. /**
  11544. * Returns `true` if the triangle is oriented towards the given direction.
  11545. *
  11546. * @param {Vector3} direction - The (normalized) direction vector.
  11547. * @return {boolean} Whether the triangle is oriented towards the given direction or not.
  11548. */
  11549. isFrontFacing( direction ) {
  11550. return Triangle.isFrontFacing( this.a, this.b, this.c, direction );
  11551. }
  11552. /**
  11553. * Returns `true` if this triangle intersects with the given box.
  11554. *
  11555. * @param {Box3} box - The box to intersect.
  11556. * @return {boolean} Whether this triangle intersects with the given box or not.
  11557. */
  11558. intersectsBox( box ) {
  11559. return box.intersectsTriangle( this );
  11560. }
  11561. /**
  11562. * Returns the closest point on the triangle to the given point.
  11563. *
  11564. * @param {Vector3} p - The point to compute the closest point for.
  11565. * @param {Vector3} target - The target vector that is used to store the method's result.
  11566. * @return {Vector3} The closest point on the triangle.
  11567. */
  11568. closestPointToPoint( p, target ) {
  11569. const a = this.a, b = this.b, c = this.c;
  11570. let v, w;
  11571. // algorithm thanks to Real-Time Collision Detection by Christer Ericson,
  11572. // published by Morgan Kaufmann Publishers, (c) 2005 Elsevier Inc.,
  11573. // under the accompanying license; see chapter 5.1.5 for detailed explanation.
  11574. // basically, we're distinguishing which of the voronoi regions of the triangle
  11575. // the point lies in with the minimum amount of redundant computation.
  11576. _vab.subVectors( b, a );
  11577. _vac.subVectors( c, a );
  11578. _vap.subVectors( p, a );
  11579. const d1 = _vab.dot( _vap );
  11580. const d2 = _vac.dot( _vap );
  11581. if ( d1 <= 0 && d2 <= 0 ) {
  11582. // vertex region of A; barycentric coords (1, 0, 0)
  11583. return target.copy( a );
  11584. }
  11585. _vbp.subVectors( p, b );
  11586. const d3 = _vab.dot( _vbp );
  11587. const d4 = _vac.dot( _vbp );
  11588. if ( d3 >= 0 && d4 <= d3 ) {
  11589. // vertex region of B; barycentric coords (0, 1, 0)
  11590. return target.copy( b );
  11591. }
  11592. const vc = d1 * d4 - d3 * d2;
  11593. if ( vc <= 0 && d1 >= 0 && d3 <= 0 ) {
  11594. v = d1 / ( d1 - d3 );
  11595. // edge region of AB; barycentric coords (1-v, v, 0)
  11596. return target.copy( a ).addScaledVector( _vab, v );
  11597. }
  11598. _vcp.subVectors( p, c );
  11599. const d5 = _vab.dot( _vcp );
  11600. const d6 = _vac.dot( _vcp );
  11601. if ( d6 >= 0 && d5 <= d6 ) {
  11602. // vertex region of C; barycentric coords (0, 0, 1)
  11603. return target.copy( c );
  11604. }
  11605. const vb = d5 * d2 - d1 * d6;
  11606. if ( vb <= 0 && d2 >= 0 && d6 <= 0 ) {
  11607. w = d2 / ( d2 - d6 );
  11608. // edge region of AC; barycentric coords (1-w, 0, w)
  11609. return target.copy( a ).addScaledVector( _vac, w );
  11610. }
  11611. const va = d3 * d6 - d5 * d4;
  11612. if ( va <= 0 && ( d4 - d3 ) >= 0 && ( d5 - d6 ) >= 0 ) {
  11613. _vbc.subVectors( c, b );
  11614. w = ( d4 - d3 ) / ( ( d4 - d3 ) + ( d5 - d6 ) );
  11615. // edge region of BC; barycentric coords (0, 1-w, w)
  11616. return target.copy( b ).addScaledVector( _vbc, w ); // edge region of BC
  11617. }
  11618. // face region
  11619. const denom = 1 / ( va + vb + vc );
  11620. // u = va * denom
  11621. v = vb * denom;
  11622. w = vc * denom;
  11623. return target.copy( a ).addScaledVector( _vab, v ).addScaledVector( _vac, w );
  11624. }
  11625. /**
  11626. * Returns `true` if this triangle is equal with the given one.
  11627. *
  11628. * @param {Triangle} triangle - The triangle to test for equality.
  11629. * @return {boolean} Whether this triangle is equal with the given one.
  11630. */
  11631. equals( triangle ) {
  11632. return triangle.a.equals( this.a ) && triangle.b.equals( this.b ) && triangle.c.equals( this.c );
  11633. }
  11634. }
  11635. const _colorKeywords = { 'aliceblue': 0xF0F8FF, 'antiquewhite': 0xFAEBD7, 'aqua': 0x00FFFF, 'aquamarine': 0x7FFFD4, 'azure': 0xF0FFFF,
  11636. 'beige': 0xF5F5DC, 'bisque': 0xFFE4C4, 'black': 0x000000, 'blanchedalmond': 0xFFEBCD, 'blue': 0x0000FF, 'blueviolet': 0x8A2BE2,
  11637. 'brown': 0xA52A2A, 'burlywood': 0xDEB887, 'cadetblue': 0x5F9EA0, 'chartreuse': 0x7FFF00, 'chocolate': 0xD2691E, 'coral': 0xFF7F50,
  11638. 'cornflowerblue': 0x6495ED, 'cornsilk': 0xFFF8DC, 'crimson': 0xDC143C, 'cyan': 0x00FFFF, 'darkblue': 0x00008B, 'darkcyan': 0x008B8B,
  11639. 'darkgoldenrod': 0xB8860B, 'darkgray': 0xA9A9A9, 'darkgreen': 0x006400, 'darkgrey': 0xA9A9A9, 'darkkhaki': 0xBDB76B, 'darkmagenta': 0x8B008B,
  11640. 'darkolivegreen': 0x556B2F, 'darkorange': 0xFF8C00, 'darkorchid': 0x9932CC, 'darkred': 0x8B0000, 'darksalmon': 0xE9967A, 'darkseagreen': 0x8FBC8F,
  11641. 'darkslateblue': 0x483D8B, 'darkslategray': 0x2F4F4F, 'darkslategrey': 0x2F4F4F, 'darkturquoise': 0x00CED1, 'darkviolet': 0x9400D3,
  11642. 'deeppink': 0xFF1493, 'deepskyblue': 0x00BFFF, 'dimgray': 0x696969, 'dimgrey': 0x696969, 'dodgerblue': 0x1E90FF, 'firebrick': 0xB22222,
  11643. 'floralwhite': 0xFFFAF0, 'forestgreen': 0x228B22, 'fuchsia': 0xFF00FF, 'gainsboro': 0xDCDCDC, 'ghostwhite': 0xF8F8FF, 'gold': 0xFFD700,
  11644. 'goldenrod': 0xDAA520, 'gray': 0x808080, 'green': 0x008000, 'greenyellow': 0xADFF2F, 'grey': 0x808080, 'honeydew': 0xF0FFF0, 'hotpink': 0xFF69B4,
  11645. 'indianred': 0xCD5C5C, 'indigo': 0x4B0082, 'ivory': 0xFFFFF0, 'khaki': 0xF0E68C, 'lavender': 0xE6E6FA, 'lavenderblush': 0xFFF0F5, 'lawngreen': 0x7CFC00,
  11646. 'lemonchiffon': 0xFFFACD, 'lightblue': 0xADD8E6, 'lightcoral': 0xF08080, 'lightcyan': 0xE0FFFF, 'lightgoldenrodyellow': 0xFAFAD2, 'lightgray': 0xD3D3D3,
  11647. 'lightgreen': 0x90EE90, 'lightgrey': 0xD3D3D3, 'lightpink': 0xFFB6C1, 'lightsalmon': 0xFFA07A, 'lightseagreen': 0x20B2AA, 'lightskyblue': 0x87CEFA,
  11648. 'lightslategray': 0x778899, 'lightslategrey': 0x778899, 'lightsteelblue': 0xB0C4DE, 'lightyellow': 0xFFFFE0, 'lime': 0x00FF00, 'limegreen': 0x32CD32,
  11649. 'linen': 0xFAF0E6, 'magenta': 0xFF00FF, 'maroon': 0x800000, 'mediumaquamarine': 0x66CDAA, 'mediumblue': 0x0000CD, 'mediumorchid': 0xBA55D3,
  11650. 'mediumpurple': 0x9370DB, 'mediumseagreen': 0x3CB371, 'mediumslateblue': 0x7B68EE, 'mediumspringgreen': 0x00FA9A, 'mediumturquoise': 0x48D1CC,
  11651. 'mediumvioletred': 0xC71585, 'midnightblue': 0x191970, 'mintcream': 0xF5FFFA, 'mistyrose': 0xFFE4E1, 'moccasin': 0xFFE4B5, 'navajowhite': 0xFFDEAD,
  11652. 'navy': 0x000080, 'oldlace': 0xFDF5E6, 'olive': 0x808000, 'olivedrab': 0x6B8E23, 'orange': 0xFFA500, 'orangered': 0xFF4500, 'orchid': 0xDA70D6,
  11653. 'palegoldenrod': 0xEEE8AA, 'palegreen': 0x98FB98, 'paleturquoise': 0xAFEEEE, 'palevioletred': 0xDB7093, 'papayawhip': 0xFFEFD5, 'peachpuff': 0xFFDAB9,
  11654. 'peru': 0xCD853F, 'pink': 0xFFC0CB, 'plum': 0xDDA0DD, 'powderblue': 0xB0E0E6, 'purple': 0x800080, 'rebeccapurple': 0x663399, 'red': 0xFF0000, 'rosybrown': 0xBC8F8F,
  11655. 'royalblue': 0x4169E1, 'saddlebrown': 0x8B4513, 'salmon': 0xFA8072, 'sandybrown': 0xF4A460, 'seagreen': 0x2E8B57, 'seashell': 0xFFF5EE,
  11656. 'sienna': 0xA0522D, 'silver': 0xC0C0C0, 'skyblue': 0x87CEEB, 'slateblue': 0x6A5ACD, 'slategray': 0x708090, 'slategrey': 0x708090, 'snow': 0xFFFAFA,
  11657. 'springgreen': 0x00FF7F, 'steelblue': 0x4682B4, 'tan': 0xD2B48C, 'teal': 0x008080, 'thistle': 0xD8BFD8, 'tomato': 0xFF6347, 'turquoise': 0x40E0D0,
  11658. 'violet': 0xEE82EE, 'wheat': 0xF5DEB3, 'white': 0xFFFFFF, 'whitesmoke': 0xF5F5F5, 'yellow': 0xFFFF00, 'yellowgreen': 0x9ACD32 };
  11659. const _hslA = { h: 0, s: 0, l: 0 };
  11660. const _hslB = { h: 0, s: 0, l: 0 };
  11661. function hue2rgb( p, q, t ) {
  11662. if ( t < 0 ) t += 1;
  11663. if ( t > 1 ) t -= 1;
  11664. if ( t < 1 / 6 ) return p + ( q - p ) * 6 * t;
  11665. if ( t < 1 / 2 ) return q;
  11666. if ( t < 2 / 3 ) return p + ( q - p ) * 6 * ( 2 / 3 - t );
  11667. return p;
  11668. }
  11669. /**
  11670. * A Color instance is represented by RGB components in the linear <i>working
  11671. * color space</i>, which defaults to `LinearSRGBColorSpace`. Inputs
  11672. * conventionally using `SRGBColorSpace` (such as hexadecimals and CSS
  11673. * strings) are converted to the working color space automatically.
  11674. *
  11675. * ```js
  11676. * // converted automatically from SRGBColorSpace to LinearSRGBColorSpace
  11677. * const color = new THREE.Color().setHex( 0x112233 );
  11678. * ```
  11679. * Source color spaces may be specified explicitly, to ensure correct conversions.
  11680. * ```js
  11681. * // assumed already LinearSRGBColorSpace; no conversion
  11682. * const color = new THREE.Color().setRGB( 0.5, 0.5, 0.5 );
  11683. *
  11684. * // converted explicitly from SRGBColorSpace to LinearSRGBColorSpace
  11685. * const color = new THREE.Color().setRGB( 0.5, 0.5, 0.5, SRGBColorSpace );
  11686. * ```
  11687. * If THREE.ColorManagement is disabled, no conversions occur. For details,
  11688. * see <i>Color management</i>. Iterating through a Color instance will yield
  11689. * its components (r, g, b) in the corresponding order. A Color can be initialised
  11690. * in any of the following ways:
  11691. * ```js
  11692. * //empty constructor - will default white
  11693. * const color1 = new THREE.Color();
  11694. *
  11695. * //Hexadecimal color (recommended)
  11696. * const color2 = new THREE.Color( 0xff0000 );
  11697. *
  11698. * //RGB string
  11699. * const color3 = new THREE.Color("rgb(255, 0, 0)");
  11700. * const color4 = new THREE.Color("rgb(100%, 0%, 0%)");
  11701. *
  11702. * //X11 color name - all 140 color names are supported.
  11703. * //Note the lack of CamelCase in the name
  11704. * const color5 = new THREE.Color( 'skyblue' );
  11705. * //HSL string
  11706. * const color6 = new THREE.Color("hsl(0, 100%, 50%)");
  11707. *
  11708. * //Separate RGB values between 0 and 1
  11709. * const color7 = new THREE.Color( 1, 0, 0 );
  11710. * ```
  11711. */
  11712. class Color {
  11713. /**
  11714. * Constructs a new color.
  11715. *
  11716. * Note that standard method of specifying color in three.js is with a hexadecimal triplet,
  11717. * and that method is used throughout the rest of the documentation.
  11718. *
  11719. * @param {(number|string|Color)} [r] - The red component of the color. If `g` and `b` are
  11720. * not provided, it can be hexadecimal triplet, a CSS-style string or another `Color` instance.
  11721. * @param {number} [g] - The green component.
  11722. * @param {number} [b] - The blue component.
  11723. */
  11724. constructor( r, g, b ) {
  11725. /**
  11726. * This flag can be used for type testing.
  11727. *
  11728. * @type {boolean}
  11729. * @readonly
  11730. * @default true
  11731. */
  11732. this.isColor = true;
  11733. /**
  11734. * The red component.
  11735. *
  11736. * @type {number}
  11737. * @default 1
  11738. */
  11739. this.r = 1;
  11740. /**
  11741. * The green component.
  11742. *
  11743. * @type {number}
  11744. * @default 1
  11745. */
  11746. this.g = 1;
  11747. /**
  11748. * The blue component.
  11749. *
  11750. * @type {number}
  11751. * @default 1
  11752. */
  11753. this.b = 1;
  11754. return this.set( r, g, b );
  11755. }
  11756. /**
  11757. * Sets the colors's components from the given values.
  11758. *
  11759. * @param {(number|string|Color)} [r] - The red component of the color. If `g` and `b` are
  11760. * not provided, it can be hexadecimal triplet, a CSS-style string or another `Color` instance.
  11761. * @param {number} [g] - The green component.
  11762. * @param {number} [b] - The blue component.
  11763. * @return {Color} A reference to this color.
  11764. */
  11765. set( r, g, b ) {
  11766. if ( g === undefined && b === undefined ) {
  11767. // r is THREE.Color, hex or string
  11768. const value = r;
  11769. if ( value && value.isColor ) {
  11770. this.copy( value );
  11771. } else if ( typeof value === 'number' ) {
  11772. this.setHex( value );
  11773. } else if ( typeof value === 'string' ) {
  11774. this.setStyle( value );
  11775. }
  11776. } else {
  11777. this.setRGB( r, g, b );
  11778. }
  11779. return this;
  11780. }
  11781. /**
  11782. * Sets the colors's components to the given scalar value.
  11783. *
  11784. * @param {number} scalar - The scalar value.
  11785. * @return {Color} A reference to this color.
  11786. */
  11787. setScalar( scalar ) {
  11788. this.r = scalar;
  11789. this.g = scalar;
  11790. this.b = scalar;
  11791. return this;
  11792. }
  11793. /**
  11794. * Sets this color from a hexadecimal value.
  11795. *
  11796. * @param {number} hex - The hexadecimal value.
  11797. * @param {string} [colorSpace=SRGBColorSpace] - The color space.
  11798. * @return {Color} A reference to this color.
  11799. */
  11800. setHex( hex, colorSpace = SRGBColorSpace ) {
  11801. hex = Math.floor( hex );
  11802. this.r = ( hex >> 16 & 255 ) / 255;
  11803. this.g = ( hex >> 8 & 255 ) / 255;
  11804. this.b = ( hex & 255 ) / 255;
  11805. ColorManagement.colorSpaceToWorking( this, colorSpace );
  11806. return this;
  11807. }
  11808. /**
  11809. * Sets this color from RGB values.
  11810. *
  11811. * @param {number} r - Red channel value between `0.0` and `1.0`.
  11812. * @param {number} g - Green channel value between `0.0` and `1.0`.
  11813. * @param {number} b - Blue channel value between `0.0` and `1.0`.
  11814. * @param {string} [colorSpace=ColorManagement.workingColorSpace] - The color space.
  11815. * @return {Color} A reference to this color.
  11816. */
  11817. setRGB( r, g, b, colorSpace = ColorManagement.workingColorSpace ) {
  11818. this.r = r;
  11819. this.g = g;
  11820. this.b = b;
  11821. ColorManagement.colorSpaceToWorking( this, colorSpace );
  11822. return this;
  11823. }
  11824. /**
  11825. * Sets this color from RGB values.
  11826. *
  11827. * @param {number} h - Hue value between `0.0` and `1.0`.
  11828. * @param {number} s - Saturation value between `0.0` and `1.0`.
  11829. * @param {number} l - Lightness value between `0.0` and `1.0`.
  11830. * @param {string} [colorSpace=ColorManagement.workingColorSpace] - The color space.
  11831. * @return {Color} A reference to this color.
  11832. */
  11833. setHSL( h, s, l, colorSpace = ColorManagement.workingColorSpace ) {
  11834. // h,s,l ranges are in 0.0 - 1.0
  11835. h = euclideanModulo( h, 1 );
  11836. s = clamp( s, 0, 1 );
  11837. l = clamp( l, 0, 1 );
  11838. if ( s === 0 ) {
  11839. this.r = this.g = this.b = l;
  11840. } else {
  11841. const p = l <= 0.5 ? l * ( 1 + s ) : l + s - ( l * s );
  11842. const q = ( 2 * l ) - p;
  11843. this.r = hue2rgb( q, p, h + 1 / 3 );
  11844. this.g = hue2rgb( q, p, h );
  11845. this.b = hue2rgb( q, p, h - 1 / 3 );
  11846. }
  11847. ColorManagement.colorSpaceToWorking( this, colorSpace );
  11848. return this;
  11849. }
  11850. /**
  11851. * Sets this color from a CSS-style string. For example, `rgb(250, 0,0)`,
  11852. * `rgb(100%, 0%, 0%)`, `hsl(0, 100%, 50%)`, `#ff0000`, `#f00`, or `red` ( or
  11853. * any [X11 color name](https://en.wikipedia.org/wiki/X11_color_names#Color_name_chart) -
  11854. * all 140 color names are supported).
  11855. *
  11856. * @param {string} style - Color as a CSS-style string.
  11857. * @param {string} [colorSpace=SRGBColorSpace] - The color space.
  11858. * @return {Color} A reference to this color.
  11859. */
  11860. setStyle( style, colorSpace = SRGBColorSpace ) {
  11861. function handleAlpha( string ) {
  11862. if ( string === undefined ) return;
  11863. if ( parseFloat( string ) < 1 ) {
  11864. warn( 'Color: Alpha component of ' + style + ' will be ignored.' );
  11865. }
  11866. }
  11867. let m;
  11868. if ( m = /^(\w+)\(([^\)]*)\)/.exec( style ) ) {
  11869. // rgb / hsl
  11870. let color;
  11871. const name = m[ 1 ];
  11872. const components = m[ 2 ];
  11873. switch ( name ) {
  11874. case 'rgb':
  11875. case 'rgba':
  11876. if ( color = /^\s*(\d+)\s*,\s*(\d+)\s*,\s*(\d+)\s*(?:,\s*(\d*\.?\d+)\s*)?$/.exec( components ) ) {
  11877. // rgb(255,0,0) rgba(255,0,0,0.5)
  11878. handleAlpha( color[ 4 ] );
  11879. return this.setRGB(
  11880. Math.min( 255, parseInt( color[ 1 ], 10 ) ) / 255,
  11881. Math.min( 255, parseInt( color[ 2 ], 10 ) ) / 255,
  11882. Math.min( 255, parseInt( color[ 3 ], 10 ) ) / 255,
  11883. colorSpace
  11884. );
  11885. }
  11886. if ( color = /^\s*(\d+)\%\s*,\s*(\d+)\%\s*,\s*(\d+)\%\s*(?:,\s*(\d*\.?\d+)\s*)?$/.exec( components ) ) {
  11887. // rgb(100%,0%,0%) rgba(100%,0%,0%,0.5)
  11888. handleAlpha( color[ 4 ] );
  11889. return this.setRGB(
  11890. Math.min( 100, parseInt( color[ 1 ], 10 ) ) / 100,
  11891. Math.min( 100, parseInt( color[ 2 ], 10 ) ) / 100,
  11892. Math.min( 100, parseInt( color[ 3 ], 10 ) ) / 100,
  11893. colorSpace
  11894. );
  11895. }
  11896. break;
  11897. case 'hsl':
  11898. case 'hsla':
  11899. if ( color = /^\s*(\d*\.?\d+)\s*,\s*(\d*\.?\d+)\%\s*,\s*(\d*\.?\d+)\%\s*(?:,\s*(\d*\.?\d+)\s*)?$/.exec( components ) ) {
  11900. // hsl(120,50%,50%) hsla(120,50%,50%,0.5)
  11901. handleAlpha( color[ 4 ] );
  11902. return this.setHSL(
  11903. parseFloat( color[ 1 ] ) / 360,
  11904. parseFloat( color[ 2 ] ) / 100,
  11905. parseFloat( color[ 3 ] ) / 100,
  11906. colorSpace
  11907. );
  11908. }
  11909. break;
  11910. default:
  11911. warn( 'Color: Unknown color model ' + style );
  11912. }
  11913. } else if ( m = /^\#([A-Fa-f\d]+)$/.exec( style ) ) {
  11914. // hex color
  11915. const hex = m[ 1 ];
  11916. const size = hex.length;
  11917. if ( size === 3 ) {
  11918. // #ff0
  11919. return this.setRGB(
  11920. parseInt( hex.charAt( 0 ), 16 ) / 15,
  11921. parseInt( hex.charAt( 1 ), 16 ) / 15,
  11922. parseInt( hex.charAt( 2 ), 16 ) / 15,
  11923. colorSpace
  11924. );
  11925. } else if ( size === 6 ) {
  11926. // #ff0000
  11927. return this.setHex( parseInt( hex, 16 ), colorSpace );
  11928. } else {
  11929. warn( 'Color: Invalid hex color ' + style );
  11930. }
  11931. } else if ( style && style.length > 0 ) {
  11932. return this.setColorName( style, colorSpace );
  11933. }
  11934. return this;
  11935. }
  11936. /**
  11937. * Sets this color from a color name. Faster than {@link Color#setStyle} if
  11938. * you don't need the other CSS-style formats.
  11939. *
  11940. * For convenience, the list of names is exposed in `Color.NAMES` as a hash.
  11941. * ```js
  11942. * Color.NAMES.aliceblue // returns 0xF0F8FF
  11943. * ```
  11944. *
  11945. * @param {string} style - The color name.
  11946. * @param {string} [colorSpace=SRGBColorSpace] - The color space.
  11947. * @return {Color} A reference to this color.
  11948. */
  11949. setColorName( style, colorSpace = SRGBColorSpace ) {
  11950. // color keywords
  11951. const hex = _colorKeywords[ style.toLowerCase() ];
  11952. if ( hex !== undefined ) {
  11953. // red
  11954. this.setHex( hex, colorSpace );
  11955. } else {
  11956. // unknown color
  11957. warn( 'Color: Unknown color ' + style );
  11958. }
  11959. return this;
  11960. }
  11961. /**
  11962. * Returns a new color with copied values from this instance.
  11963. *
  11964. * @return {Color} A clone of this instance.
  11965. */
  11966. clone() {
  11967. return new this.constructor( this.r, this.g, this.b );
  11968. }
  11969. /**
  11970. * Copies the values of the given color to this instance.
  11971. *
  11972. * @param {Color} color - The color to copy.
  11973. * @return {Color} A reference to this color.
  11974. */
  11975. copy( color ) {
  11976. this.r = color.r;
  11977. this.g = color.g;
  11978. this.b = color.b;
  11979. return this;
  11980. }
  11981. /**
  11982. * Copies the given color into this color, and then converts this color from
  11983. * `SRGBColorSpace` to `LinearSRGBColorSpace`.
  11984. *
  11985. * @param {Color} color - The color to copy/convert.
  11986. * @return {Color} A reference to this color.
  11987. */
  11988. copySRGBToLinear( color ) {
  11989. this.r = SRGBToLinear( color.r );
  11990. this.g = SRGBToLinear( color.g );
  11991. this.b = SRGBToLinear( color.b );
  11992. return this;
  11993. }
  11994. /**
  11995. * Copies the given color into this color, and then converts this color from
  11996. * `LinearSRGBColorSpace` to `SRGBColorSpace`.
  11997. *
  11998. * @param {Color} color - The color to copy/convert.
  11999. * @return {Color} A reference to this color.
  12000. */
  12001. copyLinearToSRGB( color ) {
  12002. this.r = LinearToSRGB( color.r );
  12003. this.g = LinearToSRGB( color.g );
  12004. this.b = LinearToSRGB( color.b );
  12005. return this;
  12006. }
  12007. /**
  12008. * Converts this color from `SRGBColorSpace` to `LinearSRGBColorSpace`.
  12009. *
  12010. * @return {Color} A reference to this color.
  12011. */
  12012. convertSRGBToLinear() {
  12013. this.copySRGBToLinear( this );
  12014. return this;
  12015. }
  12016. /**
  12017. * Converts this color from `LinearSRGBColorSpace` to `SRGBColorSpace`.
  12018. *
  12019. * @return {Color} A reference to this color.
  12020. */
  12021. convertLinearToSRGB() {
  12022. this.copyLinearToSRGB( this );
  12023. return this;
  12024. }
  12025. /**
  12026. * Returns the hexadecimal value of this color.
  12027. *
  12028. * @param {string} [colorSpace=SRGBColorSpace] - The color space.
  12029. * @return {number} The hexadecimal value.
  12030. */
  12031. getHex( colorSpace = SRGBColorSpace ) {
  12032. ColorManagement.workingToColorSpace( _color.copy( this ), colorSpace );
  12033. 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 ) );
  12034. }
  12035. /**
  12036. * Returns the hexadecimal value of this color as a string (for example, 'FFFFFF').
  12037. *
  12038. * @param {string} [colorSpace=SRGBColorSpace] - The color space.
  12039. * @return {string} The hexadecimal value as a string.
  12040. */
  12041. getHexString( colorSpace = SRGBColorSpace ) {
  12042. return ( '000000' + this.getHex( colorSpace ).toString( 16 ) ).slice( -6 );
  12043. }
  12044. /**
  12045. * Converts the colors RGB values into the HSL format and stores them into the
  12046. * given target object.
  12047. *
  12048. * @param {{h:number,s:number,l:number}} target - The target object that is used to store the method's result.
  12049. * @param {string} [colorSpace=ColorManagement.workingColorSpace] - The color space.
  12050. * @return {{h:number,s:number,l:number}} The HSL representation of this color.
  12051. */
  12052. getHSL( target, colorSpace = ColorManagement.workingColorSpace ) {
  12053. // h,s,l ranges are in 0.0 - 1.0
  12054. ColorManagement.workingToColorSpace( _color.copy( this ), colorSpace );
  12055. const r = _color.r, g = _color.g, b = _color.b;
  12056. const max = Math.max( r, g, b );
  12057. const min = Math.min( r, g, b );
  12058. let hue, saturation;
  12059. const lightness = ( min + max ) / 2.0;
  12060. if ( min === max ) {
  12061. hue = 0;
  12062. saturation = 0;
  12063. } else {
  12064. const delta = max - min;
  12065. saturation = lightness <= 0.5 ? delta / ( max + min ) : delta / ( 2 - max - min );
  12066. switch ( max ) {
  12067. case r: hue = ( g - b ) / delta + ( g < b ? 6 : 0 ); break;
  12068. case g: hue = ( b - r ) / delta + 2; break;
  12069. case b: hue = ( r - g ) / delta + 4; break;
  12070. }
  12071. hue /= 6;
  12072. }
  12073. target.h = hue;
  12074. target.s = saturation;
  12075. target.l = lightness;
  12076. return target;
  12077. }
  12078. /**
  12079. * Returns the RGB values of this color and stores them into the given target object.
  12080. *
  12081. * @param {Color} target - The target color that is used to store the method's result.
  12082. * @param {string} [colorSpace=ColorManagement.workingColorSpace] - The color space.
  12083. * @return {Color} The RGB representation of this color.
  12084. */
  12085. getRGB( target, colorSpace = ColorManagement.workingColorSpace ) {
  12086. ColorManagement.workingToColorSpace( _color.copy( this ), colorSpace );
  12087. target.r = _color.r;
  12088. target.g = _color.g;
  12089. target.b = _color.b;
  12090. return target;
  12091. }
  12092. /**
  12093. * Returns the value of this color as a CSS style string. Example: `rgb(255,0,0)`.
  12094. *
  12095. * @param {string} [colorSpace=SRGBColorSpace] - The color space.
  12096. * @return {string} The CSS representation of this color.
  12097. */
  12098. getStyle( colorSpace = SRGBColorSpace ) {
  12099. ColorManagement.workingToColorSpace( _color.copy( this ), colorSpace );
  12100. const r = _color.r, g = _color.g, b = _color.b;
  12101. if ( colorSpace !== SRGBColorSpace ) {
  12102. // Requires CSS Color Module Level 4 (https://www.w3.org/TR/css-color-4/).
  12103. return `color(${ colorSpace } ${ r.toFixed( 3 ) } ${ g.toFixed( 3 ) } ${ b.toFixed( 3 ) })`;
  12104. }
  12105. return `rgb(${ Math.round( r * 255 ) },${ Math.round( g * 255 ) },${ Math.round( b * 255 ) })`;
  12106. }
  12107. /**
  12108. * Adds the given HSL values to this color's values.
  12109. * Internally, this converts the color's RGB values to HSL, adds HSL
  12110. * and then converts the color back to RGB.
  12111. *
  12112. * @param {number} h - Hue value between `0.0` and `1.0`.
  12113. * @param {number} s - Saturation value between `0.0` and `1.0`.
  12114. * @param {number} l - Lightness value between `0.0` and `1.0`.
  12115. * @return {Color} A reference to this color.
  12116. */
  12117. offsetHSL( h, s, l ) {
  12118. this.getHSL( _hslA );
  12119. return this.setHSL( _hslA.h + h, _hslA.s + s, _hslA.l + l );
  12120. }
  12121. /**
  12122. * Adds the RGB values of the given color to the RGB values of this color.
  12123. *
  12124. * @param {Color} color - The color to add.
  12125. * @return {Color} A reference to this color.
  12126. */
  12127. add( color ) {
  12128. this.r += color.r;
  12129. this.g += color.g;
  12130. this.b += color.b;
  12131. return this;
  12132. }
  12133. /**
  12134. * Adds the RGB values of the given colors and stores the result in this instance.
  12135. *
  12136. * @param {Color} color1 - The first color.
  12137. * @param {Color} color2 - The second color.
  12138. * @return {Color} A reference to this color.
  12139. */
  12140. addColors( color1, color2 ) {
  12141. this.r = color1.r + color2.r;
  12142. this.g = color1.g + color2.g;
  12143. this.b = color1.b + color2.b;
  12144. return this;
  12145. }
  12146. /**
  12147. * Adds the given scalar value to the RGB values of this color.
  12148. *
  12149. * @param {number} s - The scalar to add.
  12150. * @return {Color} A reference to this color.
  12151. */
  12152. addScalar( s ) {
  12153. this.r += s;
  12154. this.g += s;
  12155. this.b += s;
  12156. return this;
  12157. }
  12158. /**
  12159. * Subtracts the RGB values of the given color from the RGB values of this color.
  12160. *
  12161. * @param {Color} color - The color to subtract.
  12162. * @return {Color} A reference to this color.
  12163. */
  12164. sub( color ) {
  12165. this.r = Math.max( 0, this.r - color.r );
  12166. this.g = Math.max( 0, this.g - color.g );
  12167. this.b = Math.max( 0, this.b - color.b );
  12168. return this;
  12169. }
  12170. /**
  12171. * Multiplies the RGB values of the given color with the RGB values of this color.
  12172. *
  12173. * @param {Color} color - The color to multiply.
  12174. * @return {Color} A reference to this color.
  12175. */
  12176. multiply( color ) {
  12177. this.r *= color.r;
  12178. this.g *= color.g;
  12179. this.b *= color.b;
  12180. return this;
  12181. }
  12182. /**
  12183. * Multiplies the given scalar value with the RGB values of this color.
  12184. *
  12185. * @param {number} s - The scalar to multiply.
  12186. * @return {Color} A reference to this color.
  12187. */
  12188. multiplyScalar( s ) {
  12189. this.r *= s;
  12190. this.g *= s;
  12191. this.b *= s;
  12192. return this;
  12193. }
  12194. /**
  12195. * Linearly interpolates this color's RGB values toward the RGB values of the
  12196. * given color. The alpha argument can be thought of as the ratio between
  12197. * the two colors, where `0.0` is this color and `1.0` is the first argument.
  12198. *
  12199. * @param {Color} color - The color to converge on.
  12200. * @param {number} alpha - The interpolation factor in the closed interval `[0,1]`.
  12201. * @return {Color} A reference to this color.
  12202. */
  12203. lerp( color, alpha ) {
  12204. this.r += ( color.r - this.r ) * alpha;
  12205. this.g += ( color.g - this.g ) * alpha;
  12206. this.b += ( color.b - this.b ) * alpha;
  12207. return this;
  12208. }
  12209. /**
  12210. * Linearly interpolates between the given colors and stores the result in this instance.
  12211. * The alpha argument can be thought of as the ratio between the two colors, where `0.0`
  12212. * is the first and `1.0` is the second color.
  12213. *
  12214. * @param {Color} color1 - The first color.
  12215. * @param {Color} color2 - The second color.
  12216. * @param {number} alpha - The interpolation factor in the closed interval `[0,1]`.
  12217. * @return {Color} A reference to this color.
  12218. */
  12219. lerpColors( color1, color2, alpha ) {
  12220. this.r = color1.r + ( color2.r - color1.r ) * alpha;
  12221. this.g = color1.g + ( color2.g - color1.g ) * alpha;
  12222. this.b = color1.b + ( color2.b - color1.b ) * alpha;
  12223. return this;
  12224. }
  12225. /**
  12226. * Linearly interpolates this color's HSL values toward the HSL values of the
  12227. * given color. It differs from {@link Color#lerp} by not interpolating straight
  12228. * from one color to the other, but instead going through all the hues in between
  12229. * those two colors. The alpha argument can be thought of as the ratio between
  12230. * the two colors, where 0.0 is this color and 1.0 is the first argument.
  12231. *
  12232. * @param {Color} color - The color to converge on.
  12233. * @param {number} alpha - The interpolation factor in the closed interval `[0,1]`.
  12234. * @return {Color} A reference to this color.
  12235. */
  12236. lerpHSL( color, alpha ) {
  12237. this.getHSL( _hslA );
  12238. color.getHSL( _hslB );
  12239. const h = lerp( _hslA.h, _hslB.h, alpha );
  12240. const s = lerp( _hslA.s, _hslB.s, alpha );
  12241. const l = lerp( _hslA.l, _hslB.l, alpha );
  12242. this.setHSL( h, s, l );
  12243. return this;
  12244. }
  12245. /**
  12246. * Sets the color's RGB components from the given 3D vector.
  12247. *
  12248. * @param {Vector3} v - The vector to set.
  12249. * @return {Color} A reference to this color.
  12250. */
  12251. setFromVector3( v ) {
  12252. this.r = v.x;
  12253. this.g = v.y;
  12254. this.b = v.z;
  12255. return this;
  12256. }
  12257. /**
  12258. * Transforms this color with the given 3x3 matrix.
  12259. *
  12260. * @param {Matrix3} m - The matrix.
  12261. * @return {Color} A reference to this color.
  12262. */
  12263. applyMatrix3( m ) {
  12264. const r = this.r, g = this.g, b = this.b;
  12265. const e = m.elements;
  12266. this.r = e[ 0 ] * r + e[ 3 ] * g + e[ 6 ] * b;
  12267. this.g = e[ 1 ] * r + e[ 4 ] * g + e[ 7 ] * b;
  12268. this.b = e[ 2 ] * r + e[ 5 ] * g + e[ 8 ] * b;
  12269. return this;
  12270. }
  12271. /**
  12272. * Returns `true` if this color is equal with the given one.
  12273. *
  12274. * @param {Color} c - The color to test for equality.
  12275. * @return {boolean} Whether this bounding color is equal with the given one.
  12276. */
  12277. equals( c ) {
  12278. return ( c.r === this.r ) && ( c.g === this.g ) && ( c.b === this.b );
  12279. }
  12280. /**
  12281. * Sets this color's RGB components from the given array.
  12282. *
  12283. * @param {Array<number>} array - An array holding the RGB values.
  12284. * @param {number} [offset=0] - The offset into the array.
  12285. * @return {Color} A reference to this color.
  12286. */
  12287. fromArray( array, offset = 0 ) {
  12288. this.r = array[ offset ];
  12289. this.g = array[ offset + 1 ];
  12290. this.b = array[ offset + 2 ];
  12291. return this;
  12292. }
  12293. /**
  12294. * Writes the RGB components of this color to the given array. If no array is provided,
  12295. * the method returns a new instance.
  12296. *
  12297. * @param {Array<number>} [array=[]] - The target array holding the color components.
  12298. * @param {number} [offset=0] - Index of the first element in the array.
  12299. * @return {Array<number>} The color components.
  12300. */
  12301. toArray( array = [], offset = 0 ) {
  12302. array[ offset ] = this.r;
  12303. array[ offset + 1 ] = this.g;
  12304. array[ offset + 2 ] = this.b;
  12305. return array;
  12306. }
  12307. /**
  12308. * Sets the components of this color from the given buffer attribute.
  12309. *
  12310. * @param {BufferAttribute} attribute - The buffer attribute holding color data.
  12311. * @param {number} index - The index into the attribute.
  12312. * @return {Color} A reference to this color.
  12313. */
  12314. fromBufferAttribute( attribute, index ) {
  12315. this.r = attribute.getX( index );
  12316. this.g = attribute.getY( index );
  12317. this.b = attribute.getZ( index );
  12318. return this;
  12319. }
  12320. /**
  12321. * This methods defines the serialization result of this class. Returns the color
  12322. * as a hexadecimal value.
  12323. *
  12324. * @return {number} The hexadecimal value.
  12325. */
  12326. toJSON() {
  12327. return this.getHex();
  12328. }
  12329. *[ Symbol.iterator ]() {
  12330. yield this.r;
  12331. yield this.g;
  12332. yield this.b;
  12333. }
  12334. }
  12335. const _color = /*@__PURE__*/ new Color();
  12336. /**
  12337. * A dictionary with X11 color names.
  12338. *
  12339. * Note that multiple words such as Dark Orange become the string 'darkorange'.
  12340. *
  12341. * @static
  12342. * @type {Object}
  12343. */
  12344. Color.NAMES = _colorKeywords;
  12345. let _materialId = 0;
  12346. /**
  12347. * Abstract base class for materials.
  12348. *
  12349. * Materials define the appearance of renderable 3D objects.
  12350. *
  12351. * @abstract
  12352. * @augments EventDispatcher
  12353. */
  12354. class Material extends EventDispatcher {
  12355. /**
  12356. * Constructs a new material.
  12357. */
  12358. constructor() {
  12359. super();
  12360. /**
  12361. * This flag can be used for type testing.
  12362. *
  12363. * @type {boolean}
  12364. * @readonly
  12365. * @default true
  12366. */
  12367. this.isMaterial = true;
  12368. /**
  12369. * The ID of the material.
  12370. *
  12371. * @name Material#id
  12372. * @type {number}
  12373. * @readonly
  12374. */
  12375. Object.defineProperty( this, 'id', { value: _materialId ++ } );
  12376. /**
  12377. * The UUID of the material.
  12378. *
  12379. * @type {string}
  12380. * @readonly
  12381. */
  12382. this.uuid = generateUUID();
  12383. /**
  12384. * The name of the material.
  12385. *
  12386. * @type {string}
  12387. */
  12388. this.name = '';
  12389. /**
  12390. * The type property is used for detecting the object type
  12391. * in context of serialization/deserialization.
  12392. *
  12393. * @type {string}
  12394. * @readonly
  12395. */
  12396. this.type = 'Material';
  12397. /**
  12398. * Defines the blending type of the material.
  12399. *
  12400. * It must be set to `CustomBlending` if custom blending properties like
  12401. * {@link Material#blendSrc}, {@link Material#blendDst} or {@link Material#blendEquation}
  12402. * should have any effect.
  12403. *
  12404. * @type {(NoBlending|NormalBlending|AdditiveBlending|SubtractiveBlending|MultiplyBlending|CustomBlending)}
  12405. * @default NormalBlending
  12406. */
  12407. this.blending = NormalBlending;
  12408. /**
  12409. * Defines which side of faces will be rendered - front, back or both.
  12410. *
  12411. * @type {(FrontSide|BackSide|DoubleSide)}
  12412. * @default FrontSide
  12413. */
  12414. this.side = FrontSide;
  12415. /**
  12416. * If set to `true`, vertex colors should be used.
  12417. *
  12418. * The engine supports RGB and RGBA vertex colors depending on whether a three (RGB) or
  12419. * four (RGBA) component color buffer attribute is used.
  12420. *
  12421. * @type {boolean}
  12422. * @default false
  12423. */
  12424. this.vertexColors = false;
  12425. /**
  12426. * Defines how transparent the material is.
  12427. * A value of `0.0` indicates fully transparent, `1.0` is fully opaque.
  12428. *
  12429. * If the {@link Material#transparent} is not set to `true`,
  12430. * the material will remain fully opaque and this value will only affect its color.
  12431. *
  12432. * @type {number}
  12433. * @default 1
  12434. */
  12435. this.opacity = 1;
  12436. /**
  12437. * Defines whether this material is transparent. This has an effect on
  12438. * rendering as transparent objects need special treatment and are rendered
  12439. * after non-transparent objects.
  12440. *
  12441. * When set to true, the extent to which the material is transparent is
  12442. * controlled by {@link Material#opacity}.
  12443. *
  12444. * @type {boolean}
  12445. * @default false
  12446. */
  12447. this.transparent = false;
  12448. /**
  12449. * Enables alpha hashed transparency, an alternative to {@link Material#transparent} or
  12450. * {@link Material#alphaTest}. The material will not be rendered if opacity is lower than
  12451. * a random threshold. Randomization introduces some grain or noise, but approximates alpha
  12452. * blending without the associated problems of sorting. Using TAA can reduce the resulting noise.
  12453. *
  12454. * @type {boolean}
  12455. * @default false
  12456. */
  12457. this.alphaHash = false;
  12458. /**
  12459. * Defines the blending source factor.
  12460. *
  12461. * @type {(ZeroFactor|OneFactor|SrcColorFactor|OneMinusSrcColorFactor|SrcAlphaFactor|OneMinusSrcAlphaFactor|DstAlphaFactor|OneMinusDstAlphaFactor|DstColorFactor|OneMinusDstColorFactor|SrcAlphaSaturateFactor|ConstantColorFactor|OneMinusConstantColorFactor|ConstantAlphaFactor|OneMinusConstantAlphaFactor)}
  12462. * @default SrcAlphaFactor
  12463. */
  12464. this.blendSrc = SrcAlphaFactor;
  12465. /**
  12466. * Defines the blending destination factor.
  12467. *
  12468. * @type {(ZeroFactor|OneFactor|SrcColorFactor|OneMinusSrcColorFactor|SrcAlphaFactor|OneMinusSrcAlphaFactor|DstAlphaFactor|OneMinusDstAlphaFactor|DstColorFactor|OneMinusDstColorFactor|SrcAlphaSaturateFactor|ConstantColorFactor|OneMinusConstantColorFactor|ConstantAlphaFactor|OneMinusConstantAlphaFactor)}
  12469. * @default OneMinusSrcAlphaFactor
  12470. */
  12471. this.blendDst = OneMinusSrcAlphaFactor;
  12472. /**
  12473. * Defines the blending equation.
  12474. *
  12475. * @type {(AddEquation|SubtractEquation|ReverseSubtractEquation|MinEquation|MaxEquation)}
  12476. * @default AddEquation
  12477. */
  12478. this.blendEquation = AddEquation;
  12479. /**
  12480. * Defines the blending source alpha factor.
  12481. *
  12482. * @type {?(ZeroFactor|OneFactor|SrcColorFactor|OneMinusSrcColorFactor|SrcAlphaFactor|OneMinusSrcAlphaFactor|DstAlphaFactor|OneMinusDstAlphaFactor|DstColorFactor|OneMinusDstColorFactor|SrcAlphaSaturateFactor|ConstantColorFactor|OneMinusConstantColorFactor|ConstantAlphaFactor|OneMinusConstantAlphaFactor)}
  12483. * @default null
  12484. */
  12485. this.blendSrcAlpha = null;
  12486. /**
  12487. * Defines the blending destination alpha factor.
  12488. *
  12489. * @type {?(ZeroFactor|OneFactor|SrcColorFactor|OneMinusSrcColorFactor|SrcAlphaFactor|OneMinusSrcAlphaFactor|DstAlphaFactor|OneMinusDstAlphaFactor|DstColorFactor|OneMinusDstColorFactor|SrcAlphaSaturateFactor|ConstantColorFactor|OneMinusConstantColorFactor|ConstantAlphaFactor|OneMinusConstantAlphaFactor)}
  12490. * @default null
  12491. */
  12492. this.blendDstAlpha = null;
  12493. /**
  12494. * Defines the blending equation of the alpha channel.
  12495. *
  12496. * @type {?(AddEquation|SubtractEquation|ReverseSubtractEquation|MinEquation|MaxEquation)}
  12497. * @default null
  12498. */
  12499. this.blendEquationAlpha = null;
  12500. /**
  12501. * Represents the RGB values of the constant blend color.
  12502. *
  12503. * This property has only an effect when using custom blending with `ConstantColor` or `OneMinusConstantColor`.
  12504. *
  12505. * @type {Color}
  12506. * @default (0,0,0)
  12507. */
  12508. this.blendColor = new Color( 0, 0, 0 );
  12509. /**
  12510. * Represents the alpha value of the constant blend color.
  12511. *
  12512. * This property has only an effect when using custom blending with `ConstantAlpha` or `OneMinusConstantAlpha`.
  12513. *
  12514. * @type {number}
  12515. * @default 0
  12516. */
  12517. this.blendAlpha = 0;
  12518. /**
  12519. * Defines the depth function.
  12520. *
  12521. * @type {(NeverDepth|AlwaysDepth|LessDepth|LessEqualDepth|EqualDepth|GreaterEqualDepth|GreaterDepth|NotEqualDepth)}
  12522. * @default LessEqualDepth
  12523. */
  12524. this.depthFunc = LessEqualDepth;
  12525. /**
  12526. * Whether to have depth test enabled when rendering this material.
  12527. * When the depth test is disabled, the depth write will also be implicitly disabled.
  12528. *
  12529. * @type {boolean}
  12530. * @default true
  12531. */
  12532. this.depthTest = true;
  12533. /**
  12534. * Whether rendering this material has any effect on the depth buffer.
  12535. *
  12536. * When drawing 2D overlays it can be useful to disable the depth writing in
  12537. * order to layer several things together without creating z-index artifacts.
  12538. *
  12539. * @type {boolean}
  12540. * @default true
  12541. */
  12542. this.depthWrite = true;
  12543. /**
  12544. * The bit mask to use when writing to the stencil buffer.
  12545. *
  12546. * @type {number}
  12547. * @default 0xff
  12548. */
  12549. this.stencilWriteMask = 0xff;
  12550. /**
  12551. * The stencil comparison function to use.
  12552. *
  12553. * @type {NeverStencilFunc|LessStencilFunc|EqualStencilFunc|LessEqualStencilFunc|GreaterStencilFunc|NotEqualStencilFunc|GreaterEqualStencilFunc|AlwaysStencilFunc}
  12554. * @default AlwaysStencilFunc
  12555. */
  12556. this.stencilFunc = AlwaysStencilFunc;
  12557. /**
  12558. * The value to use when performing stencil comparisons or stencil operations.
  12559. *
  12560. * @type {number}
  12561. * @default 0
  12562. */
  12563. this.stencilRef = 0;
  12564. /**
  12565. * The bit mask to use when comparing against the stencil buffer.
  12566. *
  12567. * @type {number}
  12568. * @default 0xff
  12569. */
  12570. this.stencilFuncMask = 0xff;
  12571. /**
  12572. * Which stencil operation to perform when the comparison function returns `false`.
  12573. *
  12574. * @type {ZeroStencilOp|KeepStencilOp|ReplaceStencilOp|IncrementStencilOp|DecrementStencilOp|IncrementWrapStencilOp|DecrementWrapStencilOp|InvertStencilOp}
  12575. * @default KeepStencilOp
  12576. */
  12577. this.stencilFail = KeepStencilOp;
  12578. /**
  12579. * Which stencil operation to perform when the comparison function returns
  12580. * `true` but the depth test fails.
  12581. *
  12582. * @type {ZeroStencilOp|KeepStencilOp|ReplaceStencilOp|IncrementStencilOp|DecrementStencilOp|IncrementWrapStencilOp|DecrementWrapStencilOp|InvertStencilOp}
  12583. * @default KeepStencilOp
  12584. */
  12585. this.stencilZFail = KeepStencilOp;
  12586. /**
  12587. * Which stencil operation to perform when the comparison function returns
  12588. * `true` and the depth test passes.
  12589. *
  12590. * @type {ZeroStencilOp|KeepStencilOp|ReplaceStencilOp|IncrementStencilOp|DecrementStencilOp|IncrementWrapStencilOp|DecrementWrapStencilOp|InvertStencilOp}
  12591. * @default KeepStencilOp
  12592. */
  12593. this.stencilZPass = KeepStencilOp;
  12594. /**
  12595. * Whether stencil operations are performed against the stencil buffer. In
  12596. * order to perform writes or comparisons against the stencil buffer this
  12597. * value must be `true`.
  12598. *
  12599. * @type {boolean}
  12600. * @default false
  12601. */
  12602. this.stencilWrite = false;
  12603. /**
  12604. * User-defined clipping planes specified as THREE.Plane objects in world
  12605. * space. These planes apply to the objects this material is attached to.
  12606. * Points in space whose signed distance to the plane is negative are clipped
  12607. * (not rendered). This requires {@link WebGLRenderer#localClippingEnabled} to
  12608. * be `true`.
  12609. *
  12610. * @type {?Array<Plane>}
  12611. * @default null
  12612. */
  12613. this.clippingPlanes = null;
  12614. /**
  12615. * Changes the behavior of clipping planes so that only their intersection is
  12616. * clipped, rather than their union.
  12617. *
  12618. * @type {boolean}
  12619. * @default false
  12620. */
  12621. this.clipIntersection = false;
  12622. /**
  12623. * Defines whether to clip shadows according to the clipping planes specified
  12624. * on this material.
  12625. *
  12626. * @type {boolean}
  12627. * @default false
  12628. */
  12629. this.clipShadows = false;
  12630. /**
  12631. * Defines which side of faces cast shadows. If `null`, the side casting shadows
  12632. * is determined as follows:
  12633. *
  12634. * - When {@link Material#side} is set to `FrontSide`, the back side cast shadows.
  12635. * - When {@link Material#side} is set to `BackSide`, the front side cast shadows.
  12636. * - When {@link Material#side} is set to `DoubleSide`, both sides cast shadows.
  12637. *
  12638. * @type {?(FrontSide|BackSide|DoubleSide)}
  12639. * @default null
  12640. */
  12641. this.shadowSide = null;
  12642. /**
  12643. * Whether to render the material's color.
  12644. *
  12645. * This can be used in conjunction with {@link Object3D#renderOder} to create invisible
  12646. * objects that occlude other objects.
  12647. *
  12648. * @type {boolean}
  12649. * @default true
  12650. */
  12651. this.colorWrite = true;
  12652. /**
  12653. * Override the renderer's default precision for this material.
  12654. *
  12655. * @type {?('highp'|'mediump'|'lowp')}
  12656. * @default null
  12657. */
  12658. this.precision = null;
  12659. /**
  12660. * Whether to use polygon offset or not. When enabled, each fragment's depth value will
  12661. * be offset after it is interpolated from the depth values of the appropriate vertices.
  12662. * The offset is added before the depth test is performed and before the value is written
  12663. * into the depth buffer.
  12664. *
  12665. * Can be useful for rendering hidden-line images, for applying decals to surfaces, and for
  12666. * rendering solids with highlighted edges.
  12667. *
  12668. * @type {boolean}
  12669. * @default false
  12670. */
  12671. this.polygonOffset = false;
  12672. /**
  12673. * Specifies a scale factor that is used to create a variable depth offset for each polygon.
  12674. *
  12675. * @type {number}
  12676. * @default 0
  12677. */
  12678. this.polygonOffsetFactor = 0;
  12679. /**
  12680. * Is multiplied by an implementation-specific value to create a constant depth offset.
  12681. *
  12682. * @type {number}
  12683. * @default 0
  12684. */
  12685. this.polygonOffsetUnits = 0;
  12686. /**
  12687. * Whether to apply dithering to the color to remove the appearance of banding.
  12688. *
  12689. * @type {boolean}
  12690. * @default false
  12691. */
  12692. this.dithering = false;
  12693. /**
  12694. * Whether alpha to coverage should be enabled or not. Can only be used with MSAA-enabled contexts
  12695. * (meaning when the renderer was created with *antialias* parameter set to `true`). Enabling this
  12696. * will smooth aliasing on clip plane edges and alphaTest-clipped edges.
  12697. *
  12698. * @type {boolean}
  12699. * @default false
  12700. */
  12701. this.alphaToCoverage = false;
  12702. /**
  12703. * Whether to premultiply the alpha (transparency) value.
  12704. *
  12705. * @type {boolean}
  12706. * @default false
  12707. */
  12708. this.premultipliedAlpha = false;
  12709. /**
  12710. * Whether double-sided, transparent objects should be rendered with a single pass or not.
  12711. *
  12712. * The engine renders double-sided, transparent objects with two draw calls (back faces first,
  12713. * then front faces) to mitigate transparency artifacts. There are scenarios however where this
  12714. * approach produces no quality gains but still doubles draw calls e.g. when rendering flat
  12715. * vegetation like grass sprites. In these cases, set the `forceSinglePass` flag to `true` to
  12716. * disable the two pass rendering to avoid performance issues.
  12717. *
  12718. * @type {boolean}
  12719. * @default false
  12720. */
  12721. this.forceSinglePass = false;
  12722. /**
  12723. * Whether it's possible to override the material with {@link Scene#overrideMaterial} or not.
  12724. *
  12725. * @type {boolean}
  12726. * @default true
  12727. */
  12728. this.allowOverride = true;
  12729. /**
  12730. * Defines whether 3D objects using this material are visible.
  12731. *
  12732. * @type {boolean}
  12733. * @default true
  12734. */
  12735. this.visible = true;
  12736. /**
  12737. * Defines whether this material is tone mapped according to the renderer's tone mapping setting.
  12738. *
  12739. * It is ignored when rendering to a render target or using post processing or when using
  12740. * `WebGPURenderer`. In all these cases, all materials are honored by tone mapping.
  12741. *
  12742. * @type {boolean}
  12743. * @default true
  12744. */
  12745. this.toneMapped = true;
  12746. /**
  12747. * An object that can be used to store custom data about the Material. It
  12748. * should not hold references to functions as these will not be cloned.
  12749. *
  12750. * @type {Object}
  12751. */
  12752. this.userData = {};
  12753. /**
  12754. * This starts at `0` and counts how many times {@link Material#needsUpdate} is set to `true`.
  12755. *
  12756. * @type {number}
  12757. * @readonly
  12758. * @default 0
  12759. */
  12760. this.version = 0;
  12761. this._alphaTest = 0;
  12762. }
  12763. /**
  12764. * Sets the alpha value to be used when running an alpha test. The material
  12765. * will not be rendered if the opacity is lower than this value.
  12766. *
  12767. * @type {number}
  12768. * @readonly
  12769. * @default 0
  12770. */
  12771. get alphaTest() {
  12772. return this._alphaTest;
  12773. }
  12774. set alphaTest( value ) {
  12775. if ( this._alphaTest > 0 !== value > 0 ) {
  12776. this.version ++;
  12777. }
  12778. this._alphaTest = value;
  12779. }
  12780. /**
  12781. * An optional callback that is executed immediately before the material is used to render a 3D object.
  12782. *
  12783. * This method can only be used when rendering with {@link WebGLRenderer}.
  12784. *
  12785. * @param {WebGLRenderer} renderer - The renderer.
  12786. * @param {Scene} scene - The scene.
  12787. * @param {Camera} camera - The camera that is used to render the scene.
  12788. * @param {BufferGeometry} geometry - The 3D object's geometry.
  12789. * @param {Object3D} object - The 3D object.
  12790. * @param {Object} group - The geometry group data.
  12791. */
  12792. onBeforeRender( /* renderer, scene, camera, geometry, object, group */ ) {}
  12793. /**
  12794. * An optional callback that is executed immediately before the shader
  12795. * program is compiled. This function is called with the shader source code
  12796. * as a parameter. Useful for the modification of built-in materials.
  12797. *
  12798. * This method can only be used when rendering with {@link WebGLRenderer}. The
  12799. * recommended approach when customizing materials is to use `WebGPURenderer` with the new
  12800. * Node Material system and [TSL](https://github.com/mrdoob/three.js/wiki/Three.js-Shading-Language).
  12801. *
  12802. * @param {{vertexShader:string,fragmentShader:string,uniforms:Object}} shaderobject - The object holds the uniforms and the vertex and fragment shader source.
  12803. * @param {WebGLRenderer} renderer - A reference to the renderer.
  12804. */
  12805. onBeforeCompile( /* shaderobject, renderer */ ) {}
  12806. /**
  12807. * In case {@link Material#onBeforeCompile} is used, this callback can be used to identify
  12808. * values of settings used in `onBeforeCompile()`, so three.js can reuse a cached
  12809. * shader or recompile the shader for this material as needed.
  12810. *
  12811. * This method can only be used when rendering with {@link WebGLRenderer}.
  12812. *
  12813. * @return {string} The custom program cache key.
  12814. */
  12815. customProgramCacheKey() {
  12816. return this.onBeforeCompile.toString();
  12817. }
  12818. /**
  12819. * This method can be used to set default values from parameter objects.
  12820. * It is a generic implementation so it can be used with different types
  12821. * of materials.
  12822. *
  12823. * @param {Object} [values] - The material values to set.
  12824. */
  12825. setValues( values ) {
  12826. if ( values === undefined ) return;
  12827. for ( const key in values ) {
  12828. const newValue = values[ key ];
  12829. if ( newValue === undefined ) {
  12830. warn( `Material: parameter '${ key }' has value of undefined.` );
  12831. continue;
  12832. }
  12833. const currentValue = this[ key ];
  12834. if ( currentValue === undefined ) {
  12835. warn( `Material: '${ key }' is not a property of THREE.${ this.type }.` );
  12836. continue;
  12837. }
  12838. if ( currentValue && currentValue.isColor ) {
  12839. currentValue.set( newValue );
  12840. } else if ( ( currentValue && currentValue.isVector3 ) && ( newValue && newValue.isVector3 ) ) {
  12841. currentValue.copy( newValue );
  12842. } else {
  12843. this[ key ] = newValue;
  12844. }
  12845. }
  12846. }
  12847. /**
  12848. * Serializes the material into JSON.
  12849. *
  12850. * @param {?(Object|string)} meta - An optional value holding meta information about the serialization.
  12851. * @return {Object} A JSON object representing the serialized material.
  12852. * @see {@link ObjectLoader#parse}
  12853. */
  12854. toJSON( meta ) {
  12855. const isRootObject = ( meta === undefined || typeof meta === 'string' );
  12856. if ( isRootObject ) {
  12857. meta = {
  12858. textures: {},
  12859. images: {}
  12860. };
  12861. }
  12862. const data = {
  12863. metadata: {
  12864. version: 4.7,
  12865. type: 'Material',
  12866. generator: 'Material.toJSON'
  12867. }
  12868. };
  12869. // standard Material serialization
  12870. data.uuid = this.uuid;
  12871. data.type = this.type;
  12872. if ( this.name !== '' ) data.name = this.name;
  12873. if ( this.color && this.color.isColor ) data.color = this.color.getHex();
  12874. if ( this.roughness !== undefined ) data.roughness = this.roughness;
  12875. if ( this.metalness !== undefined ) data.metalness = this.metalness;
  12876. if ( this.sheen !== undefined ) data.sheen = this.sheen;
  12877. if ( this.sheenColor && this.sheenColor.isColor ) data.sheenColor = this.sheenColor.getHex();
  12878. if ( this.sheenRoughness !== undefined ) data.sheenRoughness = this.sheenRoughness;
  12879. if ( this.emissive && this.emissive.isColor ) data.emissive = this.emissive.getHex();
  12880. if ( this.emissiveIntensity !== undefined && this.emissiveIntensity !== 1 ) data.emissiveIntensity = this.emissiveIntensity;
  12881. if ( this.specular && this.specular.isColor ) data.specular = this.specular.getHex();
  12882. if ( this.specularIntensity !== undefined ) data.specularIntensity = this.specularIntensity;
  12883. if ( this.specularColor && this.specularColor.isColor ) data.specularColor = this.specularColor.getHex();
  12884. if ( this.shininess !== undefined ) data.shininess = this.shininess;
  12885. if ( this.clearcoat !== undefined ) data.clearcoat = this.clearcoat;
  12886. if ( this.clearcoatRoughness !== undefined ) data.clearcoatRoughness = this.clearcoatRoughness;
  12887. if ( this.clearcoatMap && this.clearcoatMap.isTexture ) {
  12888. data.clearcoatMap = this.clearcoatMap.toJSON( meta ).uuid;
  12889. }
  12890. if ( this.clearcoatRoughnessMap && this.clearcoatRoughnessMap.isTexture ) {
  12891. data.clearcoatRoughnessMap = this.clearcoatRoughnessMap.toJSON( meta ).uuid;
  12892. }
  12893. if ( this.clearcoatNormalMap && this.clearcoatNormalMap.isTexture ) {
  12894. data.clearcoatNormalMap = this.clearcoatNormalMap.toJSON( meta ).uuid;
  12895. data.clearcoatNormalScale = this.clearcoatNormalScale.toArray();
  12896. }
  12897. if ( this.sheenColorMap && this.sheenColorMap.isTexture ) {
  12898. data.sheenColorMap = this.sheenColorMap.toJSON( meta ).uuid;
  12899. }
  12900. if ( this.sheenRoughnessMap && this.sheenRoughnessMap.isTexture ) {
  12901. data.sheenRoughnessMap = this.sheenRoughnessMap.toJSON( meta ).uuid;
  12902. }
  12903. if ( this.dispersion !== undefined ) data.dispersion = this.dispersion;
  12904. if ( this.iridescence !== undefined ) data.iridescence = this.iridescence;
  12905. if ( this.iridescenceIOR !== undefined ) data.iridescenceIOR = this.iridescenceIOR;
  12906. if ( this.iridescenceThicknessRange !== undefined ) data.iridescenceThicknessRange = this.iridescenceThicknessRange;
  12907. if ( this.iridescenceMap && this.iridescenceMap.isTexture ) {
  12908. data.iridescenceMap = this.iridescenceMap.toJSON( meta ).uuid;
  12909. }
  12910. if ( this.iridescenceThicknessMap && this.iridescenceThicknessMap.isTexture ) {
  12911. data.iridescenceThicknessMap = this.iridescenceThicknessMap.toJSON( meta ).uuid;
  12912. }
  12913. if ( this.anisotropy !== undefined ) data.anisotropy = this.anisotropy;
  12914. if ( this.anisotropyRotation !== undefined ) data.anisotropyRotation = this.anisotropyRotation;
  12915. if ( this.anisotropyMap && this.anisotropyMap.isTexture ) {
  12916. data.anisotropyMap = this.anisotropyMap.toJSON( meta ).uuid;
  12917. }
  12918. if ( this.map && this.map.isTexture ) data.map = this.map.toJSON( meta ).uuid;
  12919. if ( this.matcap && this.matcap.isTexture ) data.matcap = this.matcap.toJSON( meta ).uuid;
  12920. if ( this.alphaMap && this.alphaMap.isTexture ) data.alphaMap = this.alphaMap.toJSON( meta ).uuid;
  12921. if ( this.lightMap && this.lightMap.isTexture ) {
  12922. data.lightMap = this.lightMap.toJSON( meta ).uuid;
  12923. data.lightMapIntensity = this.lightMapIntensity;
  12924. }
  12925. if ( this.aoMap && this.aoMap.isTexture ) {
  12926. data.aoMap = this.aoMap.toJSON( meta ).uuid;
  12927. data.aoMapIntensity = this.aoMapIntensity;
  12928. }
  12929. if ( this.bumpMap && this.bumpMap.isTexture ) {
  12930. data.bumpMap = this.bumpMap.toJSON( meta ).uuid;
  12931. data.bumpScale = this.bumpScale;
  12932. }
  12933. if ( this.normalMap && this.normalMap.isTexture ) {
  12934. data.normalMap = this.normalMap.toJSON( meta ).uuid;
  12935. data.normalMapType = this.normalMapType;
  12936. data.normalScale = this.normalScale.toArray();
  12937. }
  12938. if ( this.displacementMap && this.displacementMap.isTexture ) {
  12939. data.displacementMap = this.displacementMap.toJSON( meta ).uuid;
  12940. data.displacementScale = this.displacementScale;
  12941. data.displacementBias = this.displacementBias;
  12942. }
  12943. if ( this.roughnessMap && this.roughnessMap.isTexture ) data.roughnessMap = this.roughnessMap.toJSON( meta ).uuid;
  12944. if ( this.metalnessMap && this.metalnessMap.isTexture ) data.metalnessMap = this.metalnessMap.toJSON( meta ).uuid;
  12945. if ( this.emissiveMap && this.emissiveMap.isTexture ) data.emissiveMap = this.emissiveMap.toJSON( meta ).uuid;
  12946. if ( this.specularMap && this.specularMap.isTexture ) data.specularMap = this.specularMap.toJSON( meta ).uuid;
  12947. if ( this.specularIntensityMap && this.specularIntensityMap.isTexture ) data.specularIntensityMap = this.specularIntensityMap.toJSON( meta ).uuid;
  12948. if ( this.specularColorMap && this.specularColorMap.isTexture ) data.specularColorMap = this.specularColorMap.toJSON( meta ).uuid;
  12949. if ( this.envMap && this.envMap.isTexture ) {
  12950. data.envMap = this.envMap.toJSON( meta ).uuid;
  12951. if ( this.combine !== undefined ) data.combine = this.combine;
  12952. }
  12953. if ( this.envMapRotation !== undefined ) data.envMapRotation = this.envMapRotation.toArray();
  12954. if ( this.envMapIntensity !== undefined ) data.envMapIntensity = this.envMapIntensity;
  12955. if ( this.reflectivity !== undefined ) data.reflectivity = this.reflectivity;
  12956. if ( this.refractionRatio !== undefined ) data.refractionRatio = this.refractionRatio;
  12957. if ( this.gradientMap && this.gradientMap.isTexture ) {
  12958. data.gradientMap = this.gradientMap.toJSON( meta ).uuid;
  12959. }
  12960. if ( this.transmission !== undefined ) data.transmission = this.transmission;
  12961. if ( this.transmissionMap && this.transmissionMap.isTexture ) data.transmissionMap = this.transmissionMap.toJSON( meta ).uuid;
  12962. if ( this.thickness !== undefined ) data.thickness = this.thickness;
  12963. if ( this.thicknessMap && this.thicknessMap.isTexture ) data.thicknessMap = this.thicknessMap.toJSON( meta ).uuid;
  12964. if ( this.attenuationDistance !== undefined && this.attenuationDistance !== Infinity ) data.attenuationDistance = this.attenuationDistance;
  12965. if ( this.attenuationColor !== undefined ) data.attenuationColor = this.attenuationColor.getHex();
  12966. if ( this.size !== undefined ) data.size = this.size;
  12967. if ( this.shadowSide !== null ) data.shadowSide = this.shadowSide;
  12968. if ( this.sizeAttenuation !== undefined ) data.sizeAttenuation = this.sizeAttenuation;
  12969. if ( this.blending !== NormalBlending ) data.blending = this.blending;
  12970. if ( this.side !== FrontSide ) data.side = this.side;
  12971. if ( this.vertexColors === true ) data.vertexColors = true;
  12972. if ( this.opacity < 1 ) data.opacity = this.opacity;
  12973. if ( this.transparent === true ) data.transparent = true;
  12974. if ( this.blendSrc !== SrcAlphaFactor ) data.blendSrc = this.blendSrc;
  12975. if ( this.blendDst !== OneMinusSrcAlphaFactor ) data.blendDst = this.blendDst;
  12976. if ( this.blendEquation !== AddEquation ) data.blendEquation = this.blendEquation;
  12977. if ( this.blendSrcAlpha !== null ) data.blendSrcAlpha = this.blendSrcAlpha;
  12978. if ( this.blendDstAlpha !== null ) data.blendDstAlpha = this.blendDstAlpha;
  12979. if ( this.blendEquationAlpha !== null ) data.blendEquationAlpha = this.blendEquationAlpha;
  12980. if ( this.blendColor && this.blendColor.isColor ) data.blendColor = this.blendColor.getHex();
  12981. if ( this.blendAlpha !== 0 ) data.blendAlpha = this.blendAlpha;
  12982. if ( this.depthFunc !== LessEqualDepth ) data.depthFunc = this.depthFunc;
  12983. if ( this.depthTest === false ) data.depthTest = this.depthTest;
  12984. if ( this.depthWrite === false ) data.depthWrite = this.depthWrite;
  12985. if ( this.colorWrite === false ) data.colorWrite = this.colorWrite;
  12986. if ( this.stencilWriteMask !== 0xff ) data.stencilWriteMask = this.stencilWriteMask;
  12987. if ( this.stencilFunc !== AlwaysStencilFunc ) data.stencilFunc = this.stencilFunc;
  12988. if ( this.stencilRef !== 0 ) data.stencilRef = this.stencilRef;
  12989. if ( this.stencilFuncMask !== 0xff ) data.stencilFuncMask = this.stencilFuncMask;
  12990. if ( this.stencilFail !== KeepStencilOp ) data.stencilFail = this.stencilFail;
  12991. if ( this.stencilZFail !== KeepStencilOp ) data.stencilZFail = this.stencilZFail;
  12992. if ( this.stencilZPass !== KeepStencilOp ) data.stencilZPass = this.stencilZPass;
  12993. if ( this.stencilWrite === true ) data.stencilWrite = this.stencilWrite;
  12994. // rotation (SpriteMaterial)
  12995. if ( this.rotation !== undefined && this.rotation !== 0 ) data.rotation = this.rotation;
  12996. if ( this.polygonOffset === true ) data.polygonOffset = true;
  12997. if ( this.polygonOffsetFactor !== 0 ) data.polygonOffsetFactor = this.polygonOffsetFactor;
  12998. if ( this.polygonOffsetUnits !== 0 ) data.polygonOffsetUnits = this.polygonOffsetUnits;
  12999. if ( this.linewidth !== undefined && this.linewidth !== 1 ) data.linewidth = this.linewidth;
  13000. if ( this.dashSize !== undefined ) data.dashSize = this.dashSize;
  13001. if ( this.gapSize !== undefined ) data.gapSize = this.gapSize;
  13002. if ( this.scale !== undefined ) data.scale = this.scale;
  13003. if ( this.dithering === true ) data.dithering = true;
  13004. if ( this.alphaTest > 0 ) data.alphaTest = this.alphaTest;
  13005. if ( this.alphaHash === true ) data.alphaHash = true;
  13006. if ( this.alphaToCoverage === true ) data.alphaToCoverage = true;
  13007. if ( this.premultipliedAlpha === true ) data.premultipliedAlpha = true;
  13008. if ( this.forceSinglePass === true ) data.forceSinglePass = true;
  13009. if ( this.allowOverride === false ) data.allowOverride = false;
  13010. if ( this.wireframe === true ) data.wireframe = true;
  13011. if ( this.wireframeLinewidth > 1 ) data.wireframeLinewidth = this.wireframeLinewidth;
  13012. if ( this.wireframeLinecap !== 'round' ) data.wireframeLinecap = this.wireframeLinecap;
  13013. if ( this.wireframeLinejoin !== 'round' ) data.wireframeLinejoin = this.wireframeLinejoin;
  13014. if ( this.flatShading === true ) data.flatShading = true;
  13015. if ( this.visible === false ) data.visible = false;
  13016. if ( this.toneMapped === false ) data.toneMapped = false;
  13017. if ( this.fog === false ) data.fog = false;
  13018. if ( Object.keys( this.userData ).length > 0 ) data.userData = this.userData;
  13019. // TODO: Copied from Object3D.toJSON
  13020. function extractFromCache( cache ) {
  13021. const values = [];
  13022. for ( const key in cache ) {
  13023. const data = cache[ key ];
  13024. delete data.metadata;
  13025. values.push( data );
  13026. }
  13027. return values;
  13028. }
  13029. if ( isRootObject ) {
  13030. const textures = extractFromCache( meta.textures );
  13031. const images = extractFromCache( meta.images );
  13032. if ( textures.length > 0 ) data.textures = textures;
  13033. if ( images.length > 0 ) data.images = images;
  13034. }
  13035. return data;
  13036. }
  13037. /**
  13038. * Returns a new material with copied values from this instance.
  13039. *
  13040. * @return {Material} A clone of this instance.
  13041. */
  13042. clone() {
  13043. return new this.constructor().copy( this );
  13044. }
  13045. /**
  13046. * Copies the values of the given material to this instance.
  13047. *
  13048. * @param {Material} source - The material to copy.
  13049. * @return {Material} A reference to this instance.
  13050. */
  13051. copy( source ) {
  13052. this.name = source.name;
  13053. this.blending = source.blending;
  13054. this.side = source.side;
  13055. this.vertexColors = source.vertexColors;
  13056. this.opacity = source.opacity;
  13057. this.transparent = source.transparent;
  13058. this.blendSrc = source.blendSrc;
  13059. this.blendDst = source.blendDst;
  13060. this.blendEquation = source.blendEquation;
  13061. this.blendSrcAlpha = source.blendSrcAlpha;
  13062. this.blendDstAlpha = source.blendDstAlpha;
  13063. this.blendEquationAlpha = source.blendEquationAlpha;
  13064. this.blendColor.copy( source.blendColor );
  13065. this.blendAlpha = source.blendAlpha;
  13066. this.depthFunc = source.depthFunc;
  13067. this.depthTest = source.depthTest;
  13068. this.depthWrite = source.depthWrite;
  13069. this.stencilWriteMask = source.stencilWriteMask;
  13070. this.stencilFunc = source.stencilFunc;
  13071. this.stencilRef = source.stencilRef;
  13072. this.stencilFuncMask = source.stencilFuncMask;
  13073. this.stencilFail = source.stencilFail;
  13074. this.stencilZFail = source.stencilZFail;
  13075. this.stencilZPass = source.stencilZPass;
  13076. this.stencilWrite = source.stencilWrite;
  13077. const srcPlanes = source.clippingPlanes;
  13078. let dstPlanes = null;
  13079. if ( srcPlanes !== null ) {
  13080. const n = srcPlanes.length;
  13081. dstPlanes = new Array( n );
  13082. for ( let i = 0; i !== n; ++ i ) {
  13083. dstPlanes[ i ] = srcPlanes[ i ].clone();
  13084. }
  13085. }
  13086. this.clippingPlanes = dstPlanes;
  13087. this.clipIntersection = source.clipIntersection;
  13088. this.clipShadows = source.clipShadows;
  13089. this.shadowSide = source.shadowSide;
  13090. this.colorWrite = source.colorWrite;
  13091. this.precision = source.precision;
  13092. this.polygonOffset = source.polygonOffset;
  13093. this.polygonOffsetFactor = source.polygonOffsetFactor;
  13094. this.polygonOffsetUnits = source.polygonOffsetUnits;
  13095. this.dithering = source.dithering;
  13096. this.alphaTest = source.alphaTest;
  13097. this.alphaHash = source.alphaHash;
  13098. this.alphaToCoverage = source.alphaToCoverage;
  13099. this.premultipliedAlpha = source.premultipliedAlpha;
  13100. this.forceSinglePass = source.forceSinglePass;
  13101. this.allowOverride = source.allowOverride;
  13102. this.visible = source.visible;
  13103. this.toneMapped = source.toneMapped;
  13104. this.userData = JSON.parse( JSON.stringify( source.userData ) );
  13105. return this;
  13106. }
  13107. /**
  13108. * Frees the GPU-related resources allocated by this instance. Call this
  13109. * method whenever this instance is no longer used in your app.
  13110. *
  13111. * @fires Material#dispose
  13112. */
  13113. dispose() {
  13114. /**
  13115. * Fires when the material has been disposed of.
  13116. *
  13117. * @event Material#dispose
  13118. * @type {Object}
  13119. */
  13120. this.dispatchEvent( { type: 'dispose' } );
  13121. }
  13122. /**
  13123. * Setting this property to `true` indicates the engine the material
  13124. * needs to be recompiled.
  13125. *
  13126. * @type {boolean}
  13127. * @default false
  13128. * @param {boolean} value
  13129. */
  13130. set needsUpdate( value ) {
  13131. if ( value === true ) this.version ++;
  13132. }
  13133. }
  13134. /**
  13135. * A material for drawing geometries in a simple shaded (flat or wireframe) way.
  13136. *
  13137. * This material is not affected by lights.
  13138. *
  13139. * @augments Material
  13140. * @demo scenes/material-browser.html#MeshBasicMaterial
  13141. */
  13142. class MeshBasicMaterial extends Material {
  13143. /**
  13144. * Constructs a new mesh basic material.
  13145. *
  13146. * @param {Object} [parameters] - An object with one or more properties
  13147. * defining the material's appearance. Any property of the material
  13148. * (including any property from inherited materials) can be passed
  13149. * in here. Color values can be passed any type of value accepted
  13150. * by {@link Color#set}.
  13151. */
  13152. constructor( parameters ) {
  13153. super();
  13154. /**
  13155. * This flag can be used for type testing.
  13156. *
  13157. * @type {boolean}
  13158. * @readonly
  13159. * @default true
  13160. */
  13161. this.isMeshBasicMaterial = true;
  13162. this.type = 'MeshBasicMaterial';
  13163. /**
  13164. * Color of the material.
  13165. *
  13166. * @type {Color}
  13167. * @default (1,1,1)
  13168. */
  13169. this.color = new Color( 0xffffff ); // diffuse
  13170. /**
  13171. * The color map. May optionally include an alpha channel, typically combined
  13172. * with {@link Material#transparent} or {@link Material#alphaTest}. The texture map
  13173. * color is modulated by the diffuse `color`.
  13174. *
  13175. * @type {?Texture}
  13176. * @default null
  13177. */
  13178. this.map = null;
  13179. /**
  13180. * The light map. Requires a second set of UVs.
  13181. *
  13182. * @type {?Texture}
  13183. * @default null
  13184. */
  13185. this.lightMap = null;
  13186. /**
  13187. * Intensity of the baked light.
  13188. *
  13189. * @type {number}
  13190. * @default 1
  13191. */
  13192. this.lightMapIntensity = 1.0;
  13193. /**
  13194. * The red channel of this texture is used as the ambient occlusion map.
  13195. * Requires a second set of UVs.
  13196. *
  13197. * @type {?Texture}
  13198. * @default null
  13199. */
  13200. this.aoMap = null;
  13201. /**
  13202. * Intensity of the ambient occlusion effect. Range is `[0,1]`, where `0`
  13203. * disables ambient occlusion. Where intensity is `1` and the AO map's
  13204. * red channel is also `1`, ambient light is fully occluded on a surface.
  13205. *
  13206. * @type {number}
  13207. * @default 1
  13208. */
  13209. this.aoMapIntensity = 1.0;
  13210. /**
  13211. * Specular map used by the material.
  13212. *
  13213. * @type {?Texture}
  13214. * @default null
  13215. */
  13216. this.specularMap = null;
  13217. /**
  13218. * The alpha map is a grayscale texture that controls the opacity across the
  13219. * surface (black: fully transparent; white: fully opaque).
  13220. *
  13221. * Only the color of the texture is used, ignoring the alpha channel if one
  13222. * exists. For RGB and RGBA textures, the renderer will use the green channel
  13223. * when sampling this texture due to the extra bit of precision provided for
  13224. * green in DXT-compressed and uncompressed RGB 565 formats. Luminance-only and
  13225. * luminance/alpha textures will also still work as expected.
  13226. *
  13227. * @type {?Texture}
  13228. * @default null
  13229. */
  13230. this.alphaMap = null;
  13231. /**
  13232. * The environment map.
  13233. *
  13234. * @type {?Texture}
  13235. * @default null
  13236. */
  13237. this.envMap = null;
  13238. /**
  13239. * The rotation of the environment map in radians.
  13240. *
  13241. * @type {Euler}
  13242. * @default (0,0,0)
  13243. */
  13244. this.envMapRotation = new Euler();
  13245. /**
  13246. * How to combine the result of the surface's color with the environment map, if any.
  13247. *
  13248. * When set to `MixOperation`, the {@link MeshBasicMaterial#reflectivity} is used to
  13249. * blend between the two colors.
  13250. *
  13251. * @type {(MultiplyOperation|MixOperation|AddOperation)}
  13252. * @default MultiplyOperation
  13253. */
  13254. this.combine = MultiplyOperation;
  13255. /**
  13256. * How much the environment map affects the surface.
  13257. * The valid range is between `0` (no reflections) and `1` (full reflections).
  13258. *
  13259. * @type {number}
  13260. * @default 1
  13261. */
  13262. this.reflectivity = 1;
  13263. /**
  13264. * The index of refraction (IOR) of air (approximately 1) divided by the
  13265. * index of refraction of the material. It is used with environment mapping
  13266. * modes {@link CubeRefractionMapping} and {@link EquirectangularRefractionMapping}.
  13267. * The refraction ratio should not exceed `1`.
  13268. *
  13269. * @type {number}
  13270. * @default 0.98
  13271. */
  13272. this.refractionRatio = 0.98;
  13273. /**
  13274. * Renders the geometry as a wireframe.
  13275. *
  13276. * @type {boolean}
  13277. * @default false
  13278. */
  13279. this.wireframe = false;
  13280. /**
  13281. * Controls the thickness of the wireframe.
  13282. *
  13283. * Can only be used with {@link SVGRenderer}.
  13284. *
  13285. * @type {number}
  13286. * @default 1
  13287. */
  13288. this.wireframeLinewidth = 1;
  13289. /**
  13290. * Defines appearance of wireframe ends.
  13291. *
  13292. * Can only be used with {@link SVGRenderer}.
  13293. *
  13294. * @type {('round'|'bevel'|'miter')}
  13295. * @default 'round'
  13296. */
  13297. this.wireframeLinecap = 'round';
  13298. /**
  13299. * Defines appearance of wireframe joints.
  13300. *
  13301. * Can only be used with {@link SVGRenderer}.
  13302. *
  13303. * @type {('round'|'bevel'|'miter')}
  13304. * @default 'round'
  13305. */
  13306. this.wireframeLinejoin = 'round';
  13307. /**
  13308. * Whether the material is affected by fog or not.
  13309. *
  13310. * @type {boolean}
  13311. * @default true
  13312. */
  13313. this.fog = true;
  13314. this.setValues( parameters );
  13315. }
  13316. copy( source ) {
  13317. super.copy( source );
  13318. this.color.copy( source.color );
  13319. this.map = source.map;
  13320. this.lightMap = source.lightMap;
  13321. this.lightMapIntensity = source.lightMapIntensity;
  13322. this.aoMap = source.aoMap;
  13323. this.aoMapIntensity = source.aoMapIntensity;
  13324. this.specularMap = source.specularMap;
  13325. this.alphaMap = source.alphaMap;
  13326. this.envMap = source.envMap;
  13327. this.envMapRotation.copy( source.envMapRotation );
  13328. this.combine = source.combine;
  13329. this.reflectivity = source.reflectivity;
  13330. this.refractionRatio = source.refractionRatio;
  13331. this.wireframe = source.wireframe;
  13332. this.wireframeLinewidth = source.wireframeLinewidth;
  13333. this.wireframeLinecap = source.wireframeLinecap;
  13334. this.wireframeLinejoin = source.wireframeLinejoin;
  13335. this.fog = source.fog;
  13336. return this;
  13337. }
  13338. }
  13339. // Fast Half Float Conversions, http://www.fox-toolkit.org/ftp/fasthalffloatconversion.pdf
  13340. const _tables = /*@__PURE__*/ _generateTables();
  13341. function _generateTables() {
  13342. // float32 to float16 helpers
  13343. const buffer = new ArrayBuffer( 4 );
  13344. const floatView = new Float32Array( buffer );
  13345. const uint32View = new Uint32Array( buffer );
  13346. const baseTable = new Uint32Array( 512 );
  13347. const shiftTable = new Uint32Array( 512 );
  13348. for ( let i = 0; i < 256; ++ i ) {
  13349. const e = i - 127;
  13350. // very small number (0, -0)
  13351. if ( e < -27 ) {
  13352. baseTable[ i ] = 0x0000;
  13353. baseTable[ i | 0x100 ] = 0x8000;
  13354. shiftTable[ i ] = 24;
  13355. shiftTable[ i | 0x100 ] = 24;
  13356. // small number (denorm)
  13357. } else if ( e < -14 ) {
  13358. baseTable[ i ] = 0x0400 >> ( - e - 14 );
  13359. baseTable[ i | 0x100 ] = ( 0x0400 >> ( - e - 14 ) ) | 0x8000;
  13360. shiftTable[ i ] = - e - 1;
  13361. shiftTable[ i | 0x100 ] = - e - 1;
  13362. // normal number
  13363. } else if ( e <= 15 ) {
  13364. baseTable[ i ] = ( e + 15 ) << 10;
  13365. baseTable[ i | 0x100 ] = ( ( e + 15 ) << 10 ) | 0x8000;
  13366. shiftTable[ i ] = 13;
  13367. shiftTable[ i | 0x100 ] = 13;
  13368. // large number (Infinity, -Infinity)
  13369. } else if ( e < 128 ) {
  13370. baseTable[ i ] = 0x7c00;
  13371. baseTable[ i | 0x100 ] = 0xfc00;
  13372. shiftTable[ i ] = 24;
  13373. shiftTable[ i | 0x100 ] = 24;
  13374. // stay (NaN, Infinity, -Infinity)
  13375. } else {
  13376. baseTable[ i ] = 0x7c00;
  13377. baseTable[ i | 0x100 ] = 0xfc00;
  13378. shiftTable[ i ] = 13;
  13379. shiftTable[ i | 0x100 ] = 13;
  13380. }
  13381. }
  13382. // float16 to float32 helpers
  13383. const mantissaTable = new Uint32Array( 2048 );
  13384. const exponentTable = new Uint32Array( 64 );
  13385. const offsetTable = new Uint32Array( 64 );
  13386. for ( let i = 1; i < 1024; ++ i ) {
  13387. let m = i << 13; // zero pad mantissa bits
  13388. let e = 0; // zero exponent
  13389. // normalized
  13390. while ( ( m & 0x00800000 ) === 0 ) {
  13391. m <<= 1;
  13392. e -= 0x00800000; // decrement exponent
  13393. }
  13394. m &= -8388609; // clear leading 1 bit
  13395. e += 0x38800000; // adjust bias
  13396. mantissaTable[ i ] = m | e;
  13397. }
  13398. for ( let i = 1024; i < 2048; ++ i ) {
  13399. mantissaTable[ i ] = 0x38000000 + ( ( i - 1024 ) << 13 );
  13400. }
  13401. for ( let i = 1; i < 31; ++ i ) {
  13402. exponentTable[ i ] = i << 23;
  13403. }
  13404. exponentTable[ 31 ] = 0x47800000;
  13405. exponentTable[ 32 ] = 0x80000000;
  13406. for ( let i = 33; i < 63; ++ i ) {
  13407. exponentTable[ i ] = 0x80000000 + ( ( i - 32 ) << 23 );
  13408. }
  13409. exponentTable[ 63 ] = 0xc7800000;
  13410. for ( let i = 1; i < 64; ++ i ) {
  13411. if ( i !== 32 ) {
  13412. offsetTable[ i ] = 1024;
  13413. }
  13414. }
  13415. return {
  13416. floatView: floatView,
  13417. uint32View: uint32View,
  13418. baseTable: baseTable,
  13419. shiftTable: shiftTable,
  13420. mantissaTable: mantissaTable,
  13421. exponentTable: exponentTable,
  13422. offsetTable: offsetTable
  13423. };
  13424. }
  13425. /**
  13426. * Returns a half precision floating point value (FP16) from the given single
  13427. * precision floating point value (FP32).
  13428. *
  13429. * @param {number} val - A single precision floating point value.
  13430. * @return {number} The FP16 value.
  13431. */
  13432. function toHalfFloat( val ) {
  13433. if ( Math.abs( val ) > 65504 ) warn( 'DataUtils.toHalfFloat(): Value out of range.' );
  13434. val = clamp( val, -65504, 65504 );
  13435. _tables.floatView[ 0 ] = val;
  13436. const f = _tables.uint32View[ 0 ];
  13437. const e = ( f >> 23 ) & 0x1ff;
  13438. return _tables.baseTable[ e ] + ( ( f & 0x007fffff ) >> _tables.shiftTable[ e ] );
  13439. }
  13440. /**
  13441. * Returns a single precision floating point value (FP32) from the given half
  13442. * precision floating point value (FP16).
  13443. *
  13444. * @param {number} val - A half precision floating point value.
  13445. * @return {number} The FP32 value.
  13446. */
  13447. function fromHalfFloat( val ) {
  13448. const m = val >> 10;
  13449. _tables.uint32View[ 0 ] = _tables.mantissaTable[ _tables.offsetTable[ m ] + ( val & 0x3ff ) ] + _tables.exponentTable[ m ];
  13450. return _tables.floatView[ 0 ];
  13451. }
  13452. /**
  13453. * A class containing utility functions for data.
  13454. *
  13455. * @hideconstructor
  13456. */
  13457. class DataUtils {
  13458. /**
  13459. * Returns a half precision floating point value (FP16) from the given single
  13460. * precision floating point value (FP32).
  13461. *
  13462. * @param {number} val - A single precision floating point value.
  13463. * @return {number} The FP16 value.
  13464. */
  13465. static toHalfFloat( val ) {
  13466. return toHalfFloat( val );
  13467. }
  13468. /**
  13469. * Returns a single precision floating point value (FP32) from the given half
  13470. * precision floating point value (FP16).
  13471. *
  13472. * @param {number} val - A half precision floating point value.
  13473. * @return {number} The FP32 value.
  13474. */
  13475. static fromHalfFloat( val ) {
  13476. return fromHalfFloat( val );
  13477. }
  13478. }
  13479. const _vector$9 = /*@__PURE__*/ new Vector3();
  13480. const _vector2$1 = /*@__PURE__*/ new Vector2();
  13481. let _id$2 = 0;
  13482. /**
  13483. * This class stores data for an attribute (such as vertex positions, face
  13484. * indices, normals, colors, UVs, and any custom attributes ) associated with
  13485. * a geometry, which allows for more efficient passing of data to the GPU.
  13486. *
  13487. * When working with vector-like data, the `fromBufferAttribute( attribute, index )`
  13488. * helper methods on vector and color class might be helpful. E.g. {@link Vector3#fromBufferAttribute}.
  13489. */
  13490. class BufferAttribute {
  13491. /**
  13492. * Constructs a new buffer attribute.
  13493. *
  13494. * @param {TypedArray} array - The array holding the attribute data.
  13495. * @param {number} itemSize - The item size.
  13496. * @param {boolean} [normalized=false] - Whether the data are normalized or not.
  13497. */
  13498. constructor( array, itemSize, normalized = false ) {
  13499. if ( Array.isArray( array ) ) {
  13500. throw new TypeError( 'THREE.BufferAttribute: array should be a Typed Array.' );
  13501. }
  13502. /**
  13503. * This flag can be used for type testing.
  13504. *
  13505. * @type {boolean}
  13506. * @readonly
  13507. * @default true
  13508. */
  13509. this.isBufferAttribute = true;
  13510. /**
  13511. * The ID of the buffer attribute.
  13512. *
  13513. * @name BufferAttribute#id
  13514. * @type {number}
  13515. * @readonly
  13516. */
  13517. Object.defineProperty( this, 'id', { value: _id$2 ++ } );
  13518. /**
  13519. * The name of the buffer attribute.
  13520. *
  13521. * @type {string}
  13522. */
  13523. this.name = '';
  13524. /**
  13525. * The array holding the attribute data. It should have `itemSize * numVertices`
  13526. * elements, where `numVertices` is the number of vertices in the associated geometry.
  13527. *
  13528. * @type {TypedArray}
  13529. */
  13530. this.array = array;
  13531. /**
  13532. * The number of values of the array that should be associated with a particular vertex.
  13533. * For instance, if this attribute is storing a 3-component vector (such as a position,
  13534. * normal, or color), then the value should be `3`.
  13535. *
  13536. * @type {number}
  13537. */
  13538. this.itemSize = itemSize;
  13539. /**
  13540. * Represents the number of items this buffer attribute stores. It is internally computed
  13541. * by dividing the `array` length by the `itemSize`.
  13542. *
  13543. * @type {number}
  13544. * @readonly
  13545. */
  13546. this.count = array !== undefined ? array.length / itemSize : 0;
  13547. /**
  13548. * Applies to integer data only. Indicates how the underlying data in the buffer maps to
  13549. * the values in the GLSL code. For instance, if `array` is an instance of `UInt16Array`,
  13550. * and `normalized` is `true`, the values `0 - +65535` in the array data will be mapped to
  13551. * `0.0f - +1.0f` in the GLSL attribute. If `normalized` is `false`, the values will be converted
  13552. * to floats unmodified, i.e. `65535` becomes `65535.0f`.
  13553. *
  13554. * @type {boolean}
  13555. */
  13556. this.normalized = normalized;
  13557. /**
  13558. * Defines the intended usage pattern of the data store for optimization purposes.
  13559. *
  13560. * Note: After the initial use of a buffer, its usage cannot be changed. Instead,
  13561. * instantiate a new one and set the desired usage before the next render.
  13562. *
  13563. * @type {(StaticDrawUsage|DynamicDrawUsage|StreamDrawUsage|StaticReadUsage|DynamicReadUsage|StreamReadUsage|StaticCopyUsage|DynamicCopyUsage|StreamCopyUsage)}
  13564. * @default StaticDrawUsage
  13565. */
  13566. this.usage = StaticDrawUsage;
  13567. /**
  13568. * This can be used to only update some components of stored vectors (for example, just the
  13569. * component related to color). Use the `addUpdateRange()` function to add ranges to this array.
  13570. *
  13571. * @type {Array<Object>}
  13572. */
  13573. this.updateRanges = [];
  13574. /**
  13575. * Configures the bound GPU type for use in shaders.
  13576. *
  13577. * Note: this only has an effect for integer arrays and is not configurable for float arrays.
  13578. * For lower precision float types, use `Float16BufferAttribute`.
  13579. *
  13580. * @type {(FloatType|IntType)}
  13581. * @default FloatType
  13582. */
  13583. this.gpuType = FloatType;
  13584. /**
  13585. * A version number, incremented every time the `needsUpdate` is set to `true`.
  13586. *
  13587. * @type {number}
  13588. */
  13589. this.version = 0;
  13590. }
  13591. /**
  13592. * A callback function that is executed after the renderer has transferred the attribute
  13593. * array data to the GPU.
  13594. */
  13595. onUploadCallback() {}
  13596. /**
  13597. * Flag to indicate that this attribute has changed and should be re-sent to
  13598. * the GPU. Set this to `true` when you modify the value of the array.
  13599. *
  13600. * @type {number}
  13601. * @default false
  13602. * @param {boolean} value
  13603. */
  13604. set needsUpdate( value ) {
  13605. if ( value === true ) this.version ++;
  13606. }
  13607. /**
  13608. * Sets the usage of this buffer attribute.
  13609. *
  13610. * @param {(StaticDrawUsage|DynamicDrawUsage|StreamDrawUsage|StaticReadUsage|DynamicReadUsage|StreamReadUsage|StaticCopyUsage|DynamicCopyUsage|StreamCopyUsage)} value - The usage to set.
  13611. * @return {BufferAttribute} A reference to this buffer attribute.
  13612. */
  13613. setUsage( value ) {
  13614. this.usage = value;
  13615. return this;
  13616. }
  13617. /**
  13618. * Adds a range of data in the data array to be updated on the GPU.
  13619. *
  13620. * @param {number} start - Position at which to start update.
  13621. * @param {number} count - The number of components to update.
  13622. */
  13623. addUpdateRange( start, count ) {
  13624. this.updateRanges.push( { start, count } );
  13625. }
  13626. /**
  13627. * Clears the update ranges.
  13628. */
  13629. clearUpdateRanges() {
  13630. this.updateRanges.length = 0;
  13631. }
  13632. /**
  13633. * Copies the values of the given buffer attribute to this instance.
  13634. *
  13635. * @param {BufferAttribute} source - The buffer attribute to copy.
  13636. * @return {BufferAttribute} A reference to this instance.
  13637. */
  13638. copy( source ) {
  13639. this.name = source.name;
  13640. this.array = new source.array.constructor( source.array );
  13641. this.itemSize = source.itemSize;
  13642. this.count = source.count;
  13643. this.normalized = source.normalized;
  13644. this.usage = source.usage;
  13645. this.gpuType = source.gpuType;
  13646. return this;
  13647. }
  13648. /**
  13649. * Copies a vector from the given buffer attribute to this one. The start
  13650. * and destination position in the attribute buffers are represented by the
  13651. * given indices.
  13652. *
  13653. * @param {number} index1 - The destination index into this buffer attribute.
  13654. * @param {BufferAttribute} attribute - The buffer attribute to copy from.
  13655. * @param {number} index2 - The source index into the given buffer attribute.
  13656. * @return {BufferAttribute} A reference to this instance.
  13657. */
  13658. copyAt( index1, attribute, index2 ) {
  13659. index1 *= this.itemSize;
  13660. index2 *= attribute.itemSize;
  13661. for ( let i = 0, l = this.itemSize; i < l; i ++ ) {
  13662. this.array[ index1 + i ] = attribute.array[ index2 + i ];
  13663. }
  13664. return this;
  13665. }
  13666. /**
  13667. * Copies the given array data into this buffer attribute.
  13668. *
  13669. * @param {(TypedArray|Array)} array - The array to copy.
  13670. * @return {BufferAttribute} A reference to this instance.
  13671. */
  13672. copyArray( array ) {
  13673. this.array.set( array );
  13674. return this;
  13675. }
  13676. /**
  13677. * Applies the given 3x3 matrix to the given attribute. Works with
  13678. * item size `2` and `3`.
  13679. *
  13680. * @param {Matrix3} m - The matrix to apply.
  13681. * @return {BufferAttribute} A reference to this instance.
  13682. */
  13683. applyMatrix3( m ) {
  13684. if ( this.itemSize === 2 ) {
  13685. for ( let i = 0, l = this.count; i < l; i ++ ) {
  13686. _vector2$1.fromBufferAttribute( this, i );
  13687. _vector2$1.applyMatrix3( m );
  13688. this.setXY( i, _vector2$1.x, _vector2$1.y );
  13689. }
  13690. } else if ( this.itemSize === 3 ) {
  13691. for ( let i = 0, l = this.count; i < l; i ++ ) {
  13692. _vector$9.fromBufferAttribute( this, i );
  13693. _vector$9.applyMatrix3( m );
  13694. this.setXYZ( i, _vector$9.x, _vector$9.y, _vector$9.z );
  13695. }
  13696. }
  13697. return this;
  13698. }
  13699. /**
  13700. * Applies the given 4x4 matrix to the given attribute. Only works with
  13701. * item size `3`.
  13702. *
  13703. * @param {Matrix4} m - The matrix to apply.
  13704. * @return {BufferAttribute} A reference to this instance.
  13705. */
  13706. applyMatrix4( m ) {
  13707. for ( let i = 0, l = this.count; i < l; i ++ ) {
  13708. _vector$9.fromBufferAttribute( this, i );
  13709. _vector$9.applyMatrix4( m );
  13710. this.setXYZ( i, _vector$9.x, _vector$9.y, _vector$9.z );
  13711. }
  13712. return this;
  13713. }
  13714. /**
  13715. * Applies the given 3x3 normal matrix to the given attribute. Only works with
  13716. * item size `3`.
  13717. *
  13718. * @param {Matrix3} m - The normal matrix to apply.
  13719. * @return {BufferAttribute} A reference to this instance.
  13720. */
  13721. applyNormalMatrix( m ) {
  13722. for ( let i = 0, l = this.count; i < l; i ++ ) {
  13723. _vector$9.fromBufferAttribute( this, i );
  13724. _vector$9.applyNormalMatrix( m );
  13725. this.setXYZ( i, _vector$9.x, _vector$9.y, _vector$9.z );
  13726. }
  13727. return this;
  13728. }
  13729. /**
  13730. * Applies the given 4x4 matrix to the given attribute. Only works with
  13731. * item size `3` and with direction vectors.
  13732. *
  13733. * @param {Matrix4} m - The matrix to apply.
  13734. * @return {BufferAttribute} A reference to this instance.
  13735. */
  13736. transformDirection( m ) {
  13737. for ( let i = 0, l = this.count; i < l; i ++ ) {
  13738. _vector$9.fromBufferAttribute( this, i );
  13739. _vector$9.transformDirection( m );
  13740. this.setXYZ( i, _vector$9.x, _vector$9.y, _vector$9.z );
  13741. }
  13742. return this;
  13743. }
  13744. /**
  13745. * Sets the given array data in the buffer attribute.
  13746. *
  13747. * @param {(TypedArray|Array)} value - The array data to set.
  13748. * @param {number} [offset=0] - The offset in this buffer attribute's array.
  13749. * @return {BufferAttribute} A reference to this instance.
  13750. */
  13751. set( value, offset = 0 ) {
  13752. // Matching BufferAttribute constructor, do not normalize the array.
  13753. this.array.set( value, offset );
  13754. return this;
  13755. }
  13756. /**
  13757. * Returns the given component of the vector at the given index.
  13758. *
  13759. * @param {number} index - The index into the buffer attribute.
  13760. * @param {number} component - The component index.
  13761. * @return {number} The returned value.
  13762. */
  13763. getComponent( index, component ) {
  13764. let value = this.array[ index * this.itemSize + component ];
  13765. if ( this.normalized ) value = denormalize( value, this.array );
  13766. return value;
  13767. }
  13768. /**
  13769. * Sets the given value to the given component of the vector at the given index.
  13770. *
  13771. * @param {number} index - The index into the buffer attribute.
  13772. * @param {number} component - The component index.
  13773. * @param {number} value - The value to set.
  13774. * @return {BufferAttribute} A reference to this instance.
  13775. */
  13776. setComponent( index, component, value ) {
  13777. if ( this.normalized ) value = normalize( value, this.array );
  13778. this.array[ index * this.itemSize + component ] = value;
  13779. return this;
  13780. }
  13781. /**
  13782. * Returns the x component of the vector at the given index.
  13783. *
  13784. * @param {number} index - The index into the buffer attribute.
  13785. * @return {number} The x component.
  13786. */
  13787. getX( index ) {
  13788. let x = this.array[ index * this.itemSize ];
  13789. if ( this.normalized ) x = denormalize( x, this.array );
  13790. return x;
  13791. }
  13792. /**
  13793. * Sets the x component of the vector at the given index.
  13794. *
  13795. * @param {number} index - The index into the buffer attribute.
  13796. * @param {number} x - The value to set.
  13797. * @return {BufferAttribute} A reference to this instance.
  13798. */
  13799. setX( index, x ) {
  13800. if ( this.normalized ) x = normalize( x, this.array );
  13801. this.array[ index * this.itemSize ] = x;
  13802. return this;
  13803. }
  13804. /**
  13805. * Returns the y component of the vector at the given index.
  13806. *
  13807. * @param {number} index - The index into the buffer attribute.
  13808. * @return {number} The y component.
  13809. */
  13810. getY( index ) {
  13811. let y = this.array[ index * this.itemSize + 1 ];
  13812. if ( this.normalized ) y = denormalize( y, this.array );
  13813. return y;
  13814. }
  13815. /**
  13816. * Sets the y component of the vector at the given index.
  13817. *
  13818. * @param {number} index - The index into the buffer attribute.
  13819. * @param {number} y - The value to set.
  13820. * @return {BufferAttribute} A reference to this instance.
  13821. */
  13822. setY( index, y ) {
  13823. if ( this.normalized ) y = normalize( y, this.array );
  13824. this.array[ index * this.itemSize + 1 ] = y;
  13825. return this;
  13826. }
  13827. /**
  13828. * Returns the z component of the vector at the given index.
  13829. *
  13830. * @param {number} index - The index into the buffer attribute.
  13831. * @return {number} The z component.
  13832. */
  13833. getZ( index ) {
  13834. let z = this.array[ index * this.itemSize + 2 ];
  13835. if ( this.normalized ) z = denormalize( z, this.array );
  13836. return z;
  13837. }
  13838. /**
  13839. * Sets the z component of the vector at the given index.
  13840. *
  13841. * @param {number} index - The index into the buffer attribute.
  13842. * @param {number} z - The value to set.
  13843. * @return {BufferAttribute} A reference to this instance.
  13844. */
  13845. setZ( index, z ) {
  13846. if ( this.normalized ) z = normalize( z, this.array );
  13847. this.array[ index * this.itemSize + 2 ] = z;
  13848. return this;
  13849. }
  13850. /**
  13851. * Returns the w component of the vector at the given index.
  13852. *
  13853. * @param {number} index - The index into the buffer attribute.
  13854. * @return {number} The w component.
  13855. */
  13856. getW( index ) {
  13857. let w = this.array[ index * this.itemSize + 3 ];
  13858. if ( this.normalized ) w = denormalize( w, this.array );
  13859. return w;
  13860. }
  13861. /**
  13862. * Sets the w component of the vector at the given index.
  13863. *
  13864. * @param {number} index - The index into the buffer attribute.
  13865. * @param {number} w - The value to set.
  13866. * @return {BufferAttribute} A reference to this instance.
  13867. */
  13868. setW( index, w ) {
  13869. if ( this.normalized ) w = normalize( w, this.array );
  13870. this.array[ index * this.itemSize + 3 ] = w;
  13871. return this;
  13872. }
  13873. /**
  13874. * Sets the x and y component of the vector at the given index.
  13875. *
  13876. * @param {number} index - The index into the buffer attribute.
  13877. * @param {number} x - The value for the x component to set.
  13878. * @param {number} y - The value for the y component to set.
  13879. * @return {BufferAttribute} A reference to this instance.
  13880. */
  13881. setXY( index, x, y ) {
  13882. index *= this.itemSize;
  13883. if ( this.normalized ) {
  13884. x = normalize( x, this.array );
  13885. y = normalize( y, this.array );
  13886. }
  13887. this.array[ index + 0 ] = x;
  13888. this.array[ index + 1 ] = y;
  13889. return this;
  13890. }
  13891. /**
  13892. * Sets the x, y and z component of the vector at the given index.
  13893. *
  13894. * @param {number} index - The index into the buffer attribute.
  13895. * @param {number} x - The value for the x component to set.
  13896. * @param {number} y - The value for the y component to set.
  13897. * @param {number} z - The value for the z component to set.
  13898. * @return {BufferAttribute} A reference to this instance.
  13899. */
  13900. setXYZ( index, x, y, z ) {
  13901. index *= this.itemSize;
  13902. if ( this.normalized ) {
  13903. x = normalize( x, this.array );
  13904. y = normalize( y, this.array );
  13905. z = normalize( z, this.array );
  13906. }
  13907. this.array[ index + 0 ] = x;
  13908. this.array[ index + 1 ] = y;
  13909. this.array[ index + 2 ] = z;
  13910. return this;
  13911. }
  13912. /**
  13913. * Sets the x, y, z and w component of the vector at the given index.
  13914. *
  13915. * @param {number} index - The index into the buffer attribute.
  13916. * @param {number} x - The value for the x component to set.
  13917. * @param {number} y - The value for the y component to set.
  13918. * @param {number} z - The value for the z component to set.
  13919. * @param {number} w - The value for the w component to set.
  13920. * @return {BufferAttribute} A reference to this instance.
  13921. */
  13922. setXYZW( index, x, y, z, w ) {
  13923. index *= this.itemSize;
  13924. if ( this.normalized ) {
  13925. x = normalize( x, this.array );
  13926. y = normalize( y, this.array );
  13927. z = normalize( z, this.array );
  13928. w = normalize( w, this.array );
  13929. }
  13930. this.array[ index + 0 ] = x;
  13931. this.array[ index + 1 ] = y;
  13932. this.array[ index + 2 ] = z;
  13933. this.array[ index + 3 ] = w;
  13934. return this;
  13935. }
  13936. /**
  13937. * Sets the given callback function that is executed after the Renderer has transferred
  13938. * the attribute array data to the GPU. Can be used to perform clean-up operations after
  13939. * the upload when attribute data are not needed anymore on the CPU side.
  13940. *
  13941. * @param {Function} callback - The `onUpload()` callback.
  13942. * @return {BufferAttribute} A reference to this instance.
  13943. */
  13944. onUpload( callback ) {
  13945. this.onUploadCallback = callback;
  13946. return this;
  13947. }
  13948. /**
  13949. * Returns a new buffer attribute with copied values from this instance.
  13950. *
  13951. * @return {BufferAttribute} A clone of this instance.
  13952. */
  13953. clone() {
  13954. return new this.constructor( this.array, this.itemSize ).copy( this );
  13955. }
  13956. /**
  13957. * Serializes the buffer attribute into JSON.
  13958. *
  13959. * @return {Object} A JSON object representing the serialized buffer attribute.
  13960. */
  13961. toJSON() {
  13962. const data = {
  13963. itemSize: this.itemSize,
  13964. type: this.array.constructor.name,
  13965. array: Array.from( this.array ),
  13966. normalized: this.normalized
  13967. };
  13968. if ( this.name !== '' ) data.name = this.name;
  13969. if ( this.usage !== StaticDrawUsage ) data.usage = this.usage;
  13970. return data;
  13971. }
  13972. }
  13973. /**
  13974. * Convenient class that can be used when creating a `Int8` buffer attribute with
  13975. * a plain `Array` instance.
  13976. *
  13977. * @augments BufferAttribute
  13978. */
  13979. class Int8BufferAttribute extends BufferAttribute {
  13980. /**
  13981. * Constructs a new buffer attribute.
  13982. *
  13983. * @param {(Array<number>|Int8Array)} array - The array holding the attribute data.
  13984. * @param {number} itemSize - The item size.
  13985. * @param {boolean} [normalized=false] - Whether the data are normalized or not.
  13986. */
  13987. constructor( array, itemSize, normalized ) {
  13988. super( new Int8Array( array ), itemSize, normalized );
  13989. }
  13990. }
  13991. /**
  13992. * Convenient class that can be used when creating a `UInt8` buffer attribute with
  13993. * a plain `Array` instance.
  13994. *
  13995. * @augments BufferAttribute
  13996. */
  13997. class Uint8BufferAttribute extends BufferAttribute {
  13998. /**
  13999. * Constructs a new buffer attribute.
  14000. *
  14001. * @param {(Array<number>|Uint8Array)} array - The array holding the attribute data.
  14002. * @param {number} itemSize - The item size.
  14003. * @param {boolean} [normalized=false] - Whether the data are normalized or not.
  14004. */
  14005. constructor( array, itemSize, normalized ) {
  14006. super( new Uint8Array( array ), itemSize, normalized );
  14007. }
  14008. }
  14009. /**
  14010. * Convenient class that can be used when creating a `UInt8Clamped` buffer attribute with
  14011. * a plain `Array` instance.
  14012. *
  14013. * @augments BufferAttribute
  14014. */
  14015. class Uint8ClampedBufferAttribute extends BufferAttribute {
  14016. /**
  14017. * Constructs a new buffer attribute.
  14018. *
  14019. * @param {(Array<number>|Uint8ClampedArray)} array - The array holding the attribute data.
  14020. * @param {number} itemSize - The item size.
  14021. * @param {boolean} [normalized=false] - Whether the data are normalized or not.
  14022. */
  14023. constructor( array, itemSize, normalized ) {
  14024. super( new Uint8ClampedArray( array ), itemSize, normalized );
  14025. }
  14026. }
  14027. /**
  14028. * Convenient class that can be used when creating a `Int16` buffer attribute with
  14029. * a plain `Array` instance.
  14030. *
  14031. * @augments BufferAttribute
  14032. */
  14033. class Int16BufferAttribute extends BufferAttribute {
  14034. /**
  14035. * Constructs a new buffer attribute.
  14036. *
  14037. * @param {(Array<number>|Int16Array)} array - The array holding the attribute data.
  14038. * @param {number} itemSize - The item size.
  14039. * @param {boolean} [normalized=false] - Whether the data are normalized or not.
  14040. */
  14041. constructor( array, itemSize, normalized ) {
  14042. super( new Int16Array( array ), itemSize, normalized );
  14043. }
  14044. }
  14045. /**
  14046. * Convenient class that can be used when creating a `UInt16` buffer attribute with
  14047. * a plain `Array` instance.
  14048. *
  14049. * @augments BufferAttribute
  14050. */
  14051. class Uint16BufferAttribute extends BufferAttribute {
  14052. /**
  14053. * Constructs a new buffer attribute.
  14054. *
  14055. * @param {(Array<number>|Uint16Array)} array - The array holding the attribute data.
  14056. * @param {number} itemSize - The item size.
  14057. * @param {boolean} [normalized=false] - Whether the data are normalized or not.
  14058. */
  14059. constructor( array, itemSize, normalized ) {
  14060. super( new Uint16Array( array ), itemSize, normalized );
  14061. }
  14062. }
  14063. /**
  14064. * Convenient class that can be used when creating a `Int32` buffer attribute with
  14065. * a plain `Array` instance.
  14066. *
  14067. * @augments BufferAttribute
  14068. */
  14069. class Int32BufferAttribute extends BufferAttribute {
  14070. /**
  14071. * Constructs a new buffer attribute.
  14072. *
  14073. * @param {(Array<number>|Int32Array)} array - The array holding the attribute data.
  14074. * @param {number} itemSize - The item size.
  14075. * @param {boolean} [normalized=false] - Whether the data are normalized or not.
  14076. */
  14077. constructor( array, itemSize, normalized ) {
  14078. super( new Int32Array( array ), itemSize, normalized );
  14079. }
  14080. }
  14081. /**
  14082. * Convenient class that can be used when creating a `UInt32` buffer attribute with
  14083. * a plain `Array` instance.
  14084. *
  14085. * @augments BufferAttribute
  14086. */
  14087. class Uint32BufferAttribute extends BufferAttribute {
  14088. /**
  14089. * Constructs a new buffer attribute.
  14090. *
  14091. * @param {(Array<number>|Uint32Array)} array - The array holding the attribute data.
  14092. * @param {number} itemSize - The item size.
  14093. * @param {boolean} [normalized=false] - Whether the data are normalized or not.
  14094. */
  14095. constructor( array, itemSize, normalized ) {
  14096. super( new Uint32Array( array ), itemSize, normalized );
  14097. }
  14098. }
  14099. /**
  14100. * Convenient class that can be used when creating a `Float16` buffer attribute with
  14101. * a plain `Array` instance.
  14102. *
  14103. * This class automatically converts to and from FP16 via `Uint16Array` since `Float16Array`
  14104. * browser support is still problematic.
  14105. *
  14106. * @augments BufferAttribute
  14107. */
  14108. class Float16BufferAttribute extends BufferAttribute {
  14109. /**
  14110. * Constructs a new buffer attribute.
  14111. *
  14112. * @param {(Array<number>|Uint16Array)} array - The array holding the attribute data.
  14113. * @param {number} itemSize - The item size.
  14114. * @param {boolean} [normalized=false] - Whether the data are normalized or not.
  14115. */
  14116. constructor( array, itemSize, normalized ) {
  14117. super( new Uint16Array( array ), itemSize, normalized );
  14118. this.isFloat16BufferAttribute = true;
  14119. }
  14120. getX( index ) {
  14121. let x = fromHalfFloat( this.array[ index * this.itemSize ] );
  14122. if ( this.normalized ) x = denormalize( x, this.array );
  14123. return x;
  14124. }
  14125. setX( index, x ) {
  14126. if ( this.normalized ) x = normalize( x, this.array );
  14127. this.array[ index * this.itemSize ] = toHalfFloat( x );
  14128. return this;
  14129. }
  14130. getY( index ) {
  14131. let y = fromHalfFloat( this.array[ index * this.itemSize + 1 ] );
  14132. if ( this.normalized ) y = denormalize( y, this.array );
  14133. return y;
  14134. }
  14135. setY( index, y ) {
  14136. if ( this.normalized ) y = normalize( y, this.array );
  14137. this.array[ index * this.itemSize + 1 ] = toHalfFloat( y );
  14138. return this;
  14139. }
  14140. getZ( index ) {
  14141. let z = fromHalfFloat( this.array[ index * this.itemSize + 2 ] );
  14142. if ( this.normalized ) z = denormalize( z, this.array );
  14143. return z;
  14144. }
  14145. setZ( index, z ) {
  14146. if ( this.normalized ) z = normalize( z, this.array );
  14147. this.array[ index * this.itemSize + 2 ] = toHalfFloat( z );
  14148. return this;
  14149. }
  14150. getW( index ) {
  14151. let w = fromHalfFloat( this.array[ index * this.itemSize + 3 ] );
  14152. if ( this.normalized ) w = denormalize( w, this.array );
  14153. return w;
  14154. }
  14155. setW( index, w ) {
  14156. if ( this.normalized ) w = normalize( w, this.array );
  14157. this.array[ index * this.itemSize + 3 ] = toHalfFloat( w );
  14158. return this;
  14159. }
  14160. setXY( index, x, y ) {
  14161. index *= this.itemSize;
  14162. if ( this.normalized ) {
  14163. x = normalize( x, this.array );
  14164. y = normalize( y, this.array );
  14165. }
  14166. this.array[ index + 0 ] = toHalfFloat( x );
  14167. this.array[ index + 1 ] = toHalfFloat( y );
  14168. return this;
  14169. }
  14170. setXYZ( index, x, y, z ) {
  14171. index *= this.itemSize;
  14172. if ( this.normalized ) {
  14173. x = normalize( x, this.array );
  14174. y = normalize( y, this.array );
  14175. z = normalize( z, this.array );
  14176. }
  14177. this.array[ index + 0 ] = toHalfFloat( x );
  14178. this.array[ index + 1 ] = toHalfFloat( y );
  14179. this.array[ index + 2 ] = toHalfFloat( z );
  14180. return this;
  14181. }
  14182. setXYZW( index, x, y, z, w ) {
  14183. index *= this.itemSize;
  14184. if ( this.normalized ) {
  14185. x = normalize( x, this.array );
  14186. y = normalize( y, this.array );
  14187. z = normalize( z, this.array );
  14188. w = normalize( w, this.array );
  14189. }
  14190. this.array[ index + 0 ] = toHalfFloat( x );
  14191. this.array[ index + 1 ] = toHalfFloat( y );
  14192. this.array[ index + 2 ] = toHalfFloat( z );
  14193. this.array[ index + 3 ] = toHalfFloat( w );
  14194. return this;
  14195. }
  14196. }
  14197. /**
  14198. * Convenient class that can be used when creating a `Float32` buffer attribute with
  14199. * a plain `Array` instance.
  14200. *
  14201. * @augments BufferAttribute
  14202. */
  14203. class Float32BufferAttribute extends BufferAttribute {
  14204. /**
  14205. * Constructs a new buffer attribute.
  14206. *
  14207. * @param {(Array<number>|Float32Array)} array - The array holding the attribute data.
  14208. * @param {number} itemSize - The item size.
  14209. * @param {boolean} [normalized=false] - Whether the data are normalized or not.
  14210. */
  14211. constructor( array, itemSize, normalized ) {
  14212. super( new Float32Array( array ), itemSize, normalized );
  14213. }
  14214. }
  14215. let _id$1 = 0;
  14216. const _m1 = /*@__PURE__*/ new Matrix4();
  14217. const _obj = /*@__PURE__*/ new Object3D();
  14218. const _offset = /*@__PURE__*/ new Vector3();
  14219. const _box$2 = /*@__PURE__*/ new Box3();
  14220. const _boxMorphTargets = /*@__PURE__*/ new Box3();
  14221. const _vector$8 = /*@__PURE__*/ new Vector3();
  14222. /**
  14223. * A representation of mesh, line, or point geometry. Includes vertex
  14224. * positions, face indices, normals, colors, UVs, and custom attributes
  14225. * within buffers, reducing the cost of passing all this data to the GPU.
  14226. *
  14227. * ```js
  14228. * const geometry = new THREE.BufferGeometry();
  14229. * // create a simple square shape. We duplicate the top left and bottom right
  14230. * // vertices because each vertex needs to appear once per triangle.
  14231. * const vertices = new Float32Array( [
  14232. * -1.0, -1.0, 1.0, // v0
  14233. * 1.0, -1.0, 1.0, // v1
  14234. * 1.0, 1.0, 1.0, // v2
  14235. *
  14236. * 1.0, 1.0, 1.0, // v3
  14237. * -1.0, 1.0, 1.0, // v4
  14238. * -1.0, -1.0, 1.0 // v5
  14239. * ] );
  14240. * // itemSize = 3 because there are 3 values (components) per vertex
  14241. * geometry.setAttribute( 'position', new THREE.BufferAttribute( vertices, 3 ) );
  14242. * const material = new THREE.MeshBasicMaterial( { color: 0xff0000 } );
  14243. * const mesh = new THREE.Mesh( geometry, material );
  14244. * ```
  14245. *
  14246. * @augments EventDispatcher
  14247. */
  14248. class BufferGeometry extends EventDispatcher {
  14249. /**
  14250. * Constructs a new geometry.
  14251. */
  14252. constructor() {
  14253. super();
  14254. /**
  14255. * This flag can be used for type testing.
  14256. *
  14257. * @type {boolean}
  14258. * @readonly
  14259. * @default true
  14260. */
  14261. this.isBufferGeometry = true;
  14262. /**
  14263. * The ID of the geometry.
  14264. *
  14265. * @name BufferGeometry#id
  14266. * @type {number}
  14267. * @readonly
  14268. */
  14269. Object.defineProperty( this, 'id', { value: _id$1 ++ } );
  14270. /**
  14271. * The UUID of the geometry.
  14272. *
  14273. * @type {string}
  14274. * @readonly
  14275. */
  14276. this.uuid = generateUUID();
  14277. /**
  14278. * The name of the geometry.
  14279. *
  14280. * @type {string}
  14281. */
  14282. this.name = '';
  14283. this.type = 'BufferGeometry';
  14284. /**
  14285. * Allows for vertices to be re-used across multiple triangles; this is
  14286. * called using "indexed triangles". Each triangle is associated with the
  14287. * indices of three vertices. This attribute therefore stores the index of
  14288. * each vertex for each triangular face. If this attribute is not set, the
  14289. * renderer assumes that each three contiguous positions represent a single triangle.
  14290. *
  14291. * @type {?BufferAttribute}
  14292. * @default null
  14293. */
  14294. this.index = null;
  14295. /**
  14296. * A (storage) buffer attribute which was generated with a compute shader and
  14297. * now defines indirect draw calls.
  14298. *
  14299. * Can only be used with {@link WebGPURenderer} and a WebGPU backend.
  14300. *
  14301. * @type {?BufferAttribute}
  14302. * @default null
  14303. */
  14304. this.indirect = null;
  14305. /**
  14306. * 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.
  14307. *
  14308. * Can only be used with {@link WebGPURenderer} and a WebGPU backend.
  14309. *
  14310. * @type {number|Array<number>}
  14311. * @default 0
  14312. */
  14313. this.indirectOffset = 0;
  14314. /**
  14315. * This dictionary has as id the name of the attribute to be set and as value
  14316. * the buffer attribute to set it to. Rather than accessing this property directly,
  14317. * use `setAttribute()` and `getAttribute()` to access attributes of this geometry.
  14318. *
  14319. * @type {Object<string,(BufferAttribute|InterleavedBufferAttribute)>}
  14320. */
  14321. this.attributes = {};
  14322. /**
  14323. * This dictionary holds the morph targets of the geometry.
  14324. *
  14325. * Note: Once the geometry has been rendered, the morph attribute data cannot
  14326. * be changed. You will have to call `dispose()`, and create a new geometry instance.
  14327. *
  14328. * @type {Object}
  14329. */
  14330. this.morphAttributes = {};
  14331. /**
  14332. * Used to control the morph target behavior; when set to `true`, the morph
  14333. * target data is treated as relative offsets, rather than as absolute
  14334. * positions/normals.
  14335. *
  14336. * @type {boolean}
  14337. * @default false
  14338. */
  14339. this.morphTargetsRelative = false;
  14340. /**
  14341. * Split the geometry into groups, each of which will be rendered in a
  14342. * separate draw call. This allows an array of materials to be used with the geometry.
  14343. *
  14344. * Use `addGroup()` and `clearGroups()` to edit groups, rather than modifying this array directly.
  14345. *
  14346. * Every vertex and index must belong to exactly one group — groups must not share vertices or
  14347. * indices, and must not leave vertices or indices unused.
  14348. *
  14349. * @type {Array<Object>}
  14350. */
  14351. this.groups = [];
  14352. /**
  14353. * Bounding box for the geometry which can be calculated with `computeBoundingBox()`.
  14354. *
  14355. * @type {?Box3}
  14356. * @default null
  14357. */
  14358. this.boundingBox = null;
  14359. /**
  14360. * Bounding sphere for the geometry which can be calculated with `computeBoundingSphere()`.
  14361. *
  14362. * @type {?Sphere}
  14363. * @default null
  14364. */
  14365. this.boundingSphere = null;
  14366. /**
  14367. * Determines the part of the geometry to render. This should not be set directly,
  14368. * instead use `setDrawRange()`.
  14369. *
  14370. * @type {{start:number,count:number}}
  14371. */
  14372. this.drawRange = { start: 0, count: Infinity };
  14373. /**
  14374. * An object that can be used to store custom data about the geometry.
  14375. * It should not hold references to functions as these will not be cloned.
  14376. *
  14377. * @type {Object}
  14378. */
  14379. this.userData = {};
  14380. }
  14381. /**
  14382. * Returns the index of this geometry.
  14383. *
  14384. * @return {?BufferAttribute} The index. Returns `null` if no index is defined.
  14385. */
  14386. getIndex() {
  14387. return this.index;
  14388. }
  14389. /**
  14390. * Sets the given index to this geometry.
  14391. *
  14392. * @param {Array<number>|BufferAttribute} index - The index to set.
  14393. * @return {BufferGeometry} A reference to this instance.
  14394. */
  14395. setIndex( index ) {
  14396. if ( Array.isArray( index ) ) {
  14397. this.index = new ( arrayNeedsUint32( index ) ? Uint32BufferAttribute : Uint16BufferAttribute )( index, 1 );
  14398. } else {
  14399. this.index = index;
  14400. }
  14401. return this;
  14402. }
  14403. /**
  14404. * Sets the given indirect attribute to this geometry.
  14405. *
  14406. * @param {BufferAttribute} indirect - The attribute holding indirect draw calls.
  14407. * @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.
  14408. * @return {BufferGeometry} A reference to this instance.
  14409. */
  14410. setIndirect( indirect, indirectOffset = 0 ) {
  14411. this.indirect = indirect;
  14412. this.indirectOffset = indirectOffset;
  14413. return this;
  14414. }
  14415. /**
  14416. * Returns the indirect attribute of this geometry.
  14417. *
  14418. * @return {?BufferAttribute} The indirect attribute. Returns `null` if no indirect attribute is defined.
  14419. */
  14420. getIndirect() {
  14421. return this.indirect;
  14422. }
  14423. /**
  14424. * Returns the buffer attribute for the given name.
  14425. *
  14426. * @param {string} name - The attribute name.
  14427. * @return {BufferAttribute|InterleavedBufferAttribute|undefined} The buffer attribute.
  14428. * Returns `undefined` if not attribute has been found.
  14429. */
  14430. getAttribute( name ) {
  14431. return this.attributes[ name ];
  14432. }
  14433. /**
  14434. * Sets the given attribute for the given name.
  14435. *
  14436. * @param {string} name - The attribute name.
  14437. * @param {BufferAttribute|InterleavedBufferAttribute} attribute - The attribute to set.
  14438. * @return {BufferGeometry} A reference to this instance.
  14439. */
  14440. setAttribute( name, attribute ) {
  14441. this.attributes[ name ] = attribute;
  14442. return this;
  14443. }
  14444. /**
  14445. * Deletes the attribute for the given name.
  14446. *
  14447. * @param {string} name - The attribute name to delete.
  14448. * @return {BufferGeometry} A reference to this instance.
  14449. */
  14450. deleteAttribute( name ) {
  14451. delete this.attributes[ name ];
  14452. return this;
  14453. }
  14454. /**
  14455. * Returns `true` if this geometry has an attribute for the given name.
  14456. *
  14457. * @param {string} name - The attribute name.
  14458. * @return {boolean} Whether this geometry has an attribute for the given name or not.
  14459. */
  14460. hasAttribute( name ) {
  14461. return this.attributes[ name ] !== undefined;
  14462. }
  14463. /**
  14464. * Adds a group to this geometry.
  14465. *
  14466. * @param {number} start - The first element in this draw call. That is the first
  14467. * vertex for non-indexed geometry, otherwise the first triangle index.
  14468. * @param {number} count - Specifies how many vertices (or indices) are part of this group.
  14469. * @param {number} [materialIndex=0] - The material array index to use.
  14470. */
  14471. addGroup( start, count, materialIndex = 0 ) {
  14472. this.groups.push( {
  14473. start: start,
  14474. count: count,
  14475. materialIndex: materialIndex
  14476. } );
  14477. }
  14478. /**
  14479. * Clears all groups.
  14480. */
  14481. clearGroups() {
  14482. this.groups = [];
  14483. }
  14484. /**
  14485. * Sets the draw range for this geometry.
  14486. *
  14487. * @param {number} start - The first vertex for non-indexed geometry, otherwise the first triangle index.
  14488. * @param {number} count - For non-indexed BufferGeometry, `count` is the number of vertices to render.
  14489. * For indexed BufferGeometry, `count` is the number of indices to render.
  14490. */
  14491. setDrawRange( start, count ) {
  14492. this.drawRange.start = start;
  14493. this.drawRange.count = count;
  14494. }
  14495. /**
  14496. * Applies the given 4x4 transformation matrix to the geometry.
  14497. *
  14498. * @param {Matrix4} matrix - The matrix to apply.
  14499. * @return {BufferGeometry} A reference to this instance.
  14500. */
  14501. applyMatrix4( matrix ) {
  14502. const position = this.attributes.position;
  14503. if ( position !== undefined ) {
  14504. position.applyMatrix4( matrix );
  14505. position.needsUpdate = true;
  14506. }
  14507. const normal = this.attributes.normal;
  14508. if ( normal !== undefined ) {
  14509. const normalMatrix = new Matrix3().getNormalMatrix( matrix );
  14510. normal.applyNormalMatrix( normalMatrix );
  14511. normal.needsUpdate = true;
  14512. }
  14513. const tangent = this.attributes.tangent;
  14514. if ( tangent !== undefined ) {
  14515. tangent.transformDirection( matrix );
  14516. tangent.needsUpdate = true;
  14517. }
  14518. if ( this.boundingBox !== null ) {
  14519. this.computeBoundingBox();
  14520. }
  14521. if ( this.boundingSphere !== null ) {
  14522. this.computeBoundingSphere();
  14523. }
  14524. return this;
  14525. }
  14526. /**
  14527. * Applies the rotation represented by the Quaternion to the geometry.
  14528. *
  14529. * @param {Quaternion} q - The Quaternion to apply.
  14530. * @return {BufferGeometry} A reference to this instance.
  14531. */
  14532. applyQuaternion( q ) {
  14533. _m1.makeRotationFromQuaternion( q );
  14534. this.applyMatrix4( _m1 );
  14535. return this;
  14536. }
  14537. /**
  14538. * Rotates the geometry about the X axis. This is typically done as a one time
  14539. * operation, and not during a loop. Use {@link Object3D#rotation} for typical
  14540. * real-time mesh rotation.
  14541. *
  14542. * @param {number} angle - The angle in radians.
  14543. * @return {BufferGeometry} A reference to this instance.
  14544. */
  14545. rotateX( angle ) {
  14546. // rotate geometry around world x-axis
  14547. _m1.makeRotationX( angle );
  14548. this.applyMatrix4( _m1 );
  14549. return this;
  14550. }
  14551. /**
  14552. * Rotates the geometry about the Y axis. This is typically done as a one time
  14553. * operation, and not during a loop. Use {@link Object3D#rotation} for typical
  14554. * real-time mesh rotation.
  14555. *
  14556. * @param {number} angle - The angle in radians.
  14557. * @return {BufferGeometry} A reference to this instance.
  14558. */
  14559. rotateY( angle ) {
  14560. // rotate geometry around world y-axis
  14561. _m1.makeRotationY( angle );
  14562. this.applyMatrix4( _m1 );
  14563. return this;
  14564. }
  14565. /**
  14566. * Rotates the geometry about the Z axis. This is typically done as a one time
  14567. * operation, and not during a loop. Use {@link Object3D#rotation} for typical
  14568. * real-time mesh rotation.
  14569. *
  14570. * @param {number} angle - The angle in radians.
  14571. * @return {BufferGeometry} A reference to this instance.
  14572. */
  14573. rotateZ( angle ) {
  14574. // rotate geometry around world z-axis
  14575. _m1.makeRotationZ( angle );
  14576. this.applyMatrix4( _m1 );
  14577. return this;
  14578. }
  14579. /**
  14580. * Translates the geometry. This is typically done as a one time
  14581. * operation, and not during a loop. Use {@link Object3D#position} for typical
  14582. * real-time mesh rotation.
  14583. *
  14584. * @param {number} x - The x offset.
  14585. * @param {number} y - The y offset.
  14586. * @param {number} z - The z offset.
  14587. * @return {BufferGeometry} A reference to this instance.
  14588. */
  14589. translate( x, y, z ) {
  14590. // translate geometry
  14591. _m1.makeTranslation( x, y, z );
  14592. this.applyMatrix4( _m1 );
  14593. return this;
  14594. }
  14595. /**
  14596. * Scales the geometry. This is typically done as a one time
  14597. * operation, and not during a loop. Use {@link Object3D#scale} for typical
  14598. * real-time mesh rotation.
  14599. *
  14600. * @param {number} x - The x scale.
  14601. * @param {number} y - The y scale.
  14602. * @param {number} z - The z scale.
  14603. * @return {BufferGeometry} A reference to this instance.
  14604. */
  14605. scale( x, y, z ) {
  14606. // scale geometry
  14607. _m1.makeScale( x, y, z );
  14608. this.applyMatrix4( _m1 );
  14609. return this;
  14610. }
  14611. /**
  14612. * Rotates the geometry to face a point in 3D space. This is typically done as a one time
  14613. * operation, and not during a loop. Use {@link Object3D#lookAt} for typical
  14614. * real-time mesh rotation.
  14615. *
  14616. * @param {Vector3} vector - The target point.
  14617. * @return {BufferGeometry} A reference to this instance.
  14618. */
  14619. lookAt( vector ) {
  14620. _obj.lookAt( vector );
  14621. _obj.updateMatrix();
  14622. this.applyMatrix4( _obj.matrix );
  14623. return this;
  14624. }
  14625. /**
  14626. * Center the geometry based on its bounding box.
  14627. *
  14628. * @return {BufferGeometry} A reference to this instance.
  14629. */
  14630. center() {
  14631. this.computeBoundingBox();
  14632. this.boundingBox.getCenter( _offset ).negate();
  14633. this.translate( _offset.x, _offset.y, _offset.z );
  14634. return this;
  14635. }
  14636. /**
  14637. * Defines a geometry by creating a `position` attribute based on the given array of points. The array
  14638. * can hold 2D or 3D vectors. When using two-dimensional data, the `z` coordinate for all vertices is
  14639. * set to `0`.
  14640. *
  14641. * If the method is used with an existing `position` attribute, the vertex data are overwritten with the
  14642. * data from the array. The length of the array must match the vertex count.
  14643. *
  14644. * @param {Array<Vector2>|Array<Vector3>} points - The points.
  14645. * @return {BufferGeometry} A reference to this instance.
  14646. */
  14647. setFromPoints( points ) {
  14648. const positionAttribute = this.getAttribute( 'position' );
  14649. if ( positionAttribute === undefined ) {
  14650. const position = [];
  14651. for ( let i = 0, l = points.length; i < l; i ++ ) {
  14652. const point = points[ i ];
  14653. position.push( point.x, point.y, point.z || 0 );
  14654. }
  14655. this.setAttribute( 'position', new Float32BufferAttribute( position, 3 ) );
  14656. } else {
  14657. const l = Math.min( points.length, positionAttribute.count ); // make sure data do not exceed buffer size
  14658. for ( let i = 0; i < l; i ++ ) {
  14659. const point = points[ i ];
  14660. positionAttribute.setXYZ( i, point.x, point.y, point.z || 0 );
  14661. }
  14662. if ( points.length > positionAttribute.count ) {
  14663. warn( 'BufferGeometry: Buffer size too small for points data. Use .dispose() and create a new geometry.' );
  14664. }
  14665. positionAttribute.needsUpdate = true;
  14666. }
  14667. return this;
  14668. }
  14669. /**
  14670. * Computes the bounding box of the geometry, and updates the `boundingBox` member.
  14671. * The bounding box is not computed by the engine; it must be computed by your app.
  14672. * You may need to recompute the bounding box if the geometry vertices are modified.
  14673. */
  14674. computeBoundingBox() {
  14675. if ( this.boundingBox === null ) {
  14676. this.boundingBox = new Box3();
  14677. }
  14678. const position = this.attributes.position;
  14679. const morphAttributesPosition = this.morphAttributes.position;
  14680. if ( position && position.isGLBufferAttribute ) {
  14681. error( 'BufferGeometry.computeBoundingBox(): GLBufferAttribute requires a manual bounding box.', this );
  14682. this.boundingBox.set(
  14683. new Vector3( - Infinity, - Infinity, - Infinity ),
  14684. new Vector3( + Infinity, + Infinity, + Infinity )
  14685. );
  14686. return;
  14687. }
  14688. if ( position !== undefined ) {
  14689. this.boundingBox.setFromBufferAttribute( position );
  14690. // process morph attributes if present
  14691. if ( morphAttributesPosition ) {
  14692. for ( let i = 0, il = morphAttributesPosition.length; i < il; i ++ ) {
  14693. const morphAttribute = morphAttributesPosition[ i ];
  14694. _box$2.setFromBufferAttribute( morphAttribute );
  14695. if ( this.morphTargetsRelative ) {
  14696. _vector$8.addVectors( this.boundingBox.min, _box$2.min );
  14697. this.boundingBox.expandByPoint( _vector$8 );
  14698. _vector$8.addVectors( this.boundingBox.max, _box$2.max );
  14699. this.boundingBox.expandByPoint( _vector$8 );
  14700. } else {
  14701. this.boundingBox.expandByPoint( _box$2.min );
  14702. this.boundingBox.expandByPoint( _box$2.max );
  14703. }
  14704. }
  14705. }
  14706. } else {
  14707. this.boundingBox.makeEmpty();
  14708. }
  14709. if ( isNaN( this.boundingBox.min.x ) || isNaN( this.boundingBox.min.y ) || isNaN( this.boundingBox.min.z ) ) {
  14710. error( 'BufferGeometry.computeBoundingBox(): Computed min/max have NaN values. The "position" attribute is likely to have NaN values.', this );
  14711. }
  14712. }
  14713. /**
  14714. * Computes the bounding sphere of the geometry, and updates the `boundingSphere` member.
  14715. * The engine automatically computes the bounding sphere when it is needed, e.g., for ray casting or view frustum culling.
  14716. * You may need to recompute the bounding sphere if the geometry vertices are modified.
  14717. */
  14718. computeBoundingSphere() {
  14719. if ( this.boundingSphere === null ) {
  14720. this.boundingSphere = new Sphere();
  14721. }
  14722. const position = this.attributes.position;
  14723. const morphAttributesPosition = this.morphAttributes.position;
  14724. if ( position && position.isGLBufferAttribute ) {
  14725. error( 'BufferGeometry.computeBoundingSphere(): GLBufferAttribute requires a manual bounding sphere.', this );
  14726. this.boundingSphere.set( new Vector3(), Infinity );
  14727. return;
  14728. }
  14729. if ( position ) {
  14730. // first, find the center of the bounding sphere
  14731. const center = this.boundingSphere.center;
  14732. _box$2.setFromBufferAttribute( position );
  14733. // process morph attributes if present
  14734. if ( morphAttributesPosition ) {
  14735. for ( let i = 0, il = morphAttributesPosition.length; i < il; i ++ ) {
  14736. const morphAttribute = morphAttributesPosition[ i ];
  14737. _boxMorphTargets.setFromBufferAttribute( morphAttribute );
  14738. if ( this.morphTargetsRelative ) {
  14739. _vector$8.addVectors( _box$2.min, _boxMorphTargets.min );
  14740. _box$2.expandByPoint( _vector$8 );
  14741. _vector$8.addVectors( _box$2.max, _boxMorphTargets.max );
  14742. _box$2.expandByPoint( _vector$8 );
  14743. } else {
  14744. _box$2.expandByPoint( _boxMorphTargets.min );
  14745. _box$2.expandByPoint( _boxMorphTargets.max );
  14746. }
  14747. }
  14748. }
  14749. _box$2.getCenter( center );
  14750. // second, try to find a boundingSphere with a radius smaller than the
  14751. // boundingSphere of the boundingBox: sqrt(3) smaller in the best case
  14752. let maxRadiusSq = 0;
  14753. for ( let i = 0, il = position.count; i < il; i ++ ) {
  14754. _vector$8.fromBufferAttribute( position, i );
  14755. maxRadiusSq = Math.max( maxRadiusSq, center.distanceToSquared( _vector$8 ) );
  14756. }
  14757. // process morph attributes if present
  14758. if ( morphAttributesPosition ) {
  14759. for ( let i = 0, il = morphAttributesPosition.length; i < il; i ++ ) {
  14760. const morphAttribute = morphAttributesPosition[ i ];
  14761. const morphTargetsRelative = this.morphTargetsRelative;
  14762. for ( let j = 0, jl = morphAttribute.count; j < jl; j ++ ) {
  14763. _vector$8.fromBufferAttribute( morphAttribute, j );
  14764. if ( morphTargetsRelative ) {
  14765. _offset.fromBufferAttribute( position, j );
  14766. _vector$8.add( _offset );
  14767. }
  14768. maxRadiusSq = Math.max( maxRadiusSq, center.distanceToSquared( _vector$8 ) );
  14769. }
  14770. }
  14771. }
  14772. this.boundingSphere.radius = Math.sqrt( maxRadiusSq );
  14773. if ( isNaN( this.boundingSphere.radius ) ) {
  14774. error( 'BufferGeometry.computeBoundingSphere(): Computed radius is NaN. The "position" attribute is likely to have NaN values.', this );
  14775. }
  14776. }
  14777. }
  14778. /**
  14779. * Calculates and adds a tangent attribute to this geometry.
  14780. *
  14781. * The computation is only supported for indexed geometries and if position, normal, and uv attributes
  14782. * are defined. When using a tangent space normal map, prefer the MikkTSpace algorithm provided by
  14783. * {@link BufferGeometryUtils#computeMikkTSpaceTangents} instead.
  14784. */
  14785. computeTangents() {
  14786. const index = this.index;
  14787. const attributes = this.attributes;
  14788. // based on http://www.terathon.com/code/tangent.html
  14789. // (per vertex tangents)
  14790. if ( index === null ||
  14791. attributes.position === undefined ||
  14792. attributes.normal === undefined ||
  14793. attributes.uv === undefined ) {
  14794. error( 'BufferGeometry: .computeTangents() failed. Missing required attributes (index, position, normal or uv)' );
  14795. return;
  14796. }
  14797. const positionAttribute = attributes.position;
  14798. const normalAttribute = attributes.normal;
  14799. const uvAttribute = attributes.uv;
  14800. if ( this.hasAttribute( 'tangent' ) === false ) {
  14801. this.setAttribute( 'tangent', new BufferAttribute( new Float32Array( 4 * positionAttribute.count ), 4 ) );
  14802. }
  14803. const tangentAttribute = this.getAttribute( 'tangent' );
  14804. const tan1 = [], tan2 = [];
  14805. for ( let i = 0; i < positionAttribute.count; i ++ ) {
  14806. tan1[ i ] = new Vector3();
  14807. tan2[ i ] = new Vector3();
  14808. }
  14809. const vA = new Vector3(),
  14810. vB = new Vector3(),
  14811. vC = new Vector3(),
  14812. uvA = new Vector2(),
  14813. uvB = new Vector2(),
  14814. uvC = new Vector2(),
  14815. sdir = new Vector3(),
  14816. tdir = new Vector3();
  14817. function handleTriangle( a, b, c ) {
  14818. vA.fromBufferAttribute( positionAttribute, a );
  14819. vB.fromBufferAttribute( positionAttribute, b );
  14820. vC.fromBufferAttribute( positionAttribute, c );
  14821. uvA.fromBufferAttribute( uvAttribute, a );
  14822. uvB.fromBufferAttribute( uvAttribute, b );
  14823. uvC.fromBufferAttribute( uvAttribute, c );
  14824. vB.sub( vA );
  14825. vC.sub( vA );
  14826. uvB.sub( uvA );
  14827. uvC.sub( uvA );
  14828. const r = 1.0 / ( uvB.x * uvC.y - uvC.x * uvB.y );
  14829. // silently ignore degenerate uv triangles having coincident or colinear vertices
  14830. if ( ! isFinite( r ) ) return;
  14831. sdir.copy( vB ).multiplyScalar( uvC.y ).addScaledVector( vC, - uvB.y ).multiplyScalar( r );
  14832. tdir.copy( vC ).multiplyScalar( uvB.x ).addScaledVector( vB, - uvC.x ).multiplyScalar( r );
  14833. tan1[ a ].add( sdir );
  14834. tan1[ b ].add( sdir );
  14835. tan1[ c ].add( sdir );
  14836. tan2[ a ].add( tdir );
  14837. tan2[ b ].add( tdir );
  14838. tan2[ c ].add( tdir );
  14839. }
  14840. let groups = this.groups;
  14841. if ( groups.length === 0 ) {
  14842. groups = [ {
  14843. start: 0,
  14844. count: index.count
  14845. } ];
  14846. }
  14847. for ( let i = 0, il = groups.length; i < il; ++ i ) {
  14848. const group = groups[ i ];
  14849. const start = group.start;
  14850. const count = group.count;
  14851. for ( let j = start, jl = start + count; j < jl; j += 3 ) {
  14852. handleTriangle(
  14853. index.getX( j + 0 ),
  14854. index.getX( j + 1 ),
  14855. index.getX( j + 2 )
  14856. );
  14857. }
  14858. }
  14859. const tmp = new Vector3(), tmp2 = new Vector3();
  14860. const n = new Vector3(), n2 = new Vector3();
  14861. function handleVertex( v ) {
  14862. n.fromBufferAttribute( normalAttribute, v );
  14863. n2.copy( n );
  14864. const t = tan1[ v ];
  14865. // Gram-Schmidt orthogonalize
  14866. tmp.copy( t );
  14867. tmp.sub( n.multiplyScalar( n.dot( t ) ) ).normalize();
  14868. // Calculate handedness
  14869. tmp2.crossVectors( n2, t );
  14870. const test = tmp2.dot( tan2[ v ] );
  14871. const w = ( test < 0.0 ) ? -1 : 1.0;
  14872. tangentAttribute.setXYZW( v, tmp.x, tmp.y, tmp.z, w );
  14873. }
  14874. for ( let i = 0, il = groups.length; i < il; ++ i ) {
  14875. const group = groups[ i ];
  14876. const start = group.start;
  14877. const count = group.count;
  14878. for ( let j = start, jl = start + count; j < jl; j += 3 ) {
  14879. handleVertex( index.getX( j + 0 ) );
  14880. handleVertex( index.getX( j + 1 ) );
  14881. handleVertex( index.getX( j + 2 ) );
  14882. }
  14883. }
  14884. }
  14885. /**
  14886. * Computes vertex normals for the given vertex data. For indexed geometries, the method sets
  14887. * each vertex normal to be the average of the face normals of the faces that share that vertex.
  14888. * For non-indexed geometries, vertices are not shared, and the method sets each vertex normal
  14889. * to be the same as the face normal.
  14890. */
  14891. computeVertexNormals() {
  14892. const index = this.index;
  14893. const positionAttribute = this.getAttribute( 'position' );
  14894. if ( positionAttribute !== undefined ) {
  14895. let normalAttribute = this.getAttribute( 'normal' );
  14896. if ( normalAttribute === undefined ) {
  14897. normalAttribute = new BufferAttribute( new Float32Array( positionAttribute.count * 3 ), 3 );
  14898. this.setAttribute( 'normal', normalAttribute );
  14899. } else {
  14900. // reset existing normals to zero
  14901. for ( let i = 0, il = normalAttribute.count; i < il; i ++ ) {
  14902. normalAttribute.setXYZ( i, 0, 0, 0 );
  14903. }
  14904. }
  14905. const pA = new Vector3(), pB = new Vector3(), pC = new Vector3();
  14906. const nA = new Vector3(), nB = new Vector3(), nC = new Vector3();
  14907. const cb = new Vector3(), ab = new Vector3();
  14908. // indexed elements
  14909. if ( index ) {
  14910. for ( let i = 0, il = index.count; i < il; i += 3 ) {
  14911. const vA = index.getX( i + 0 );
  14912. const vB = index.getX( i + 1 );
  14913. const vC = index.getX( i + 2 );
  14914. pA.fromBufferAttribute( positionAttribute, vA );
  14915. pB.fromBufferAttribute( positionAttribute, vB );
  14916. pC.fromBufferAttribute( positionAttribute, vC );
  14917. cb.subVectors( pC, pB );
  14918. ab.subVectors( pA, pB );
  14919. cb.cross( ab );
  14920. nA.fromBufferAttribute( normalAttribute, vA );
  14921. nB.fromBufferAttribute( normalAttribute, vB );
  14922. nC.fromBufferAttribute( normalAttribute, vC );
  14923. nA.add( cb );
  14924. nB.add( cb );
  14925. nC.add( cb );
  14926. normalAttribute.setXYZ( vA, nA.x, nA.y, nA.z );
  14927. normalAttribute.setXYZ( vB, nB.x, nB.y, nB.z );
  14928. normalAttribute.setXYZ( vC, nC.x, nC.y, nC.z );
  14929. }
  14930. } else {
  14931. // non-indexed elements (unconnected triangle soup)
  14932. for ( let i = 0, il = positionAttribute.count; i < il; i += 3 ) {
  14933. pA.fromBufferAttribute( positionAttribute, i + 0 );
  14934. pB.fromBufferAttribute( positionAttribute, i + 1 );
  14935. pC.fromBufferAttribute( positionAttribute, i + 2 );
  14936. cb.subVectors( pC, pB );
  14937. ab.subVectors( pA, pB );
  14938. cb.cross( ab );
  14939. normalAttribute.setXYZ( i + 0, cb.x, cb.y, cb.z );
  14940. normalAttribute.setXYZ( i + 1, cb.x, cb.y, cb.z );
  14941. normalAttribute.setXYZ( i + 2, cb.x, cb.y, cb.z );
  14942. }
  14943. }
  14944. this.normalizeNormals();
  14945. normalAttribute.needsUpdate = true;
  14946. }
  14947. }
  14948. /**
  14949. * Ensures every normal vector in a geometry will have a magnitude of `1`. This will
  14950. * correct lighting on the geometry surfaces.
  14951. */
  14952. normalizeNormals() {
  14953. const normals = this.attributes.normal;
  14954. for ( let i = 0, il = normals.count; i < il; i ++ ) {
  14955. _vector$8.fromBufferAttribute( normals, i );
  14956. _vector$8.normalize();
  14957. normals.setXYZ( i, _vector$8.x, _vector$8.y, _vector$8.z );
  14958. }
  14959. }
  14960. /**
  14961. * Return a new non-index version of this indexed geometry. If the geometry
  14962. * is already non-indexed, the method is a NOOP.
  14963. *
  14964. * @return {BufferGeometry} The non-indexed version of this indexed geometry.
  14965. */
  14966. toNonIndexed() {
  14967. function convertBufferAttribute( attribute, indices ) {
  14968. const array = attribute.array;
  14969. const itemSize = attribute.itemSize;
  14970. const normalized = attribute.normalized;
  14971. const array2 = new array.constructor( indices.length * itemSize );
  14972. let index = 0, index2 = 0;
  14973. for ( let i = 0, l = indices.length; i < l; i ++ ) {
  14974. if ( attribute.isInterleavedBufferAttribute ) {
  14975. index = indices[ i ] * attribute.data.stride + attribute.offset;
  14976. } else {
  14977. index = indices[ i ] * itemSize;
  14978. }
  14979. for ( let j = 0; j < itemSize; j ++ ) {
  14980. array2[ index2 ++ ] = array[ index ++ ];
  14981. }
  14982. }
  14983. return new BufferAttribute( array2, itemSize, normalized );
  14984. }
  14985. //
  14986. if ( this.index === null ) {
  14987. warn( 'BufferGeometry.toNonIndexed(): BufferGeometry is already non-indexed.' );
  14988. return this;
  14989. }
  14990. const geometry2 = new BufferGeometry();
  14991. const indices = this.index.array;
  14992. const attributes = this.attributes;
  14993. // attributes
  14994. for ( const name in attributes ) {
  14995. const attribute = attributes[ name ];
  14996. const newAttribute = convertBufferAttribute( attribute, indices );
  14997. geometry2.setAttribute( name, newAttribute );
  14998. }
  14999. // morph attributes
  15000. const morphAttributes = this.morphAttributes;
  15001. for ( const name in morphAttributes ) {
  15002. const morphArray = [];
  15003. const morphAttribute = morphAttributes[ name ]; // morphAttribute: array of Float32BufferAttributes
  15004. for ( let i = 0, il = morphAttribute.length; i < il; i ++ ) {
  15005. const attribute = morphAttribute[ i ];
  15006. const newAttribute = convertBufferAttribute( attribute, indices );
  15007. morphArray.push( newAttribute );
  15008. }
  15009. geometry2.morphAttributes[ name ] = morphArray;
  15010. }
  15011. geometry2.morphTargetsRelative = this.morphTargetsRelative;
  15012. // groups
  15013. const groups = this.groups;
  15014. for ( let i = 0, l = groups.length; i < l; i ++ ) {
  15015. const group = groups[ i ];
  15016. geometry2.addGroup( group.start, group.count, group.materialIndex );
  15017. }
  15018. return geometry2;
  15019. }
  15020. /**
  15021. * Serializes the geometry into JSON.
  15022. *
  15023. * @return {Object} A JSON object representing the serialized geometry.
  15024. */
  15025. toJSON() {
  15026. const data = {
  15027. metadata: {
  15028. version: 4.7,
  15029. type: 'BufferGeometry',
  15030. generator: 'BufferGeometry.toJSON'
  15031. }
  15032. };
  15033. // standard BufferGeometry serialization
  15034. data.uuid = this.uuid;
  15035. data.type = this.type;
  15036. if ( this.name !== '' ) data.name = this.name;
  15037. if ( Object.keys( this.userData ).length > 0 ) data.userData = this.userData;
  15038. if ( this.parameters !== undefined ) {
  15039. const parameters = this.parameters;
  15040. for ( const key in parameters ) {
  15041. if ( parameters[ key ] !== undefined ) data[ key ] = parameters[ key ];
  15042. }
  15043. return data;
  15044. }
  15045. // for simplicity the code assumes attributes are not shared across geometries, see #15811
  15046. data.data = { attributes: {} };
  15047. const index = this.index;
  15048. if ( index !== null ) {
  15049. data.data.index = {
  15050. type: index.array.constructor.name,
  15051. array: Array.prototype.slice.call( index.array )
  15052. };
  15053. }
  15054. const attributes = this.attributes;
  15055. for ( const key in attributes ) {
  15056. const attribute = attributes[ key ];
  15057. data.data.attributes[ key ] = attribute.toJSON( data.data );
  15058. }
  15059. const morphAttributes = {};
  15060. let hasMorphAttributes = false;
  15061. for ( const key in this.morphAttributes ) {
  15062. const attributeArray = this.morphAttributes[ key ];
  15063. const array = [];
  15064. for ( let i = 0, il = attributeArray.length; i < il; i ++ ) {
  15065. const attribute = attributeArray[ i ];
  15066. array.push( attribute.toJSON( data.data ) );
  15067. }
  15068. if ( array.length > 0 ) {
  15069. morphAttributes[ key ] = array;
  15070. hasMorphAttributes = true;
  15071. }
  15072. }
  15073. if ( hasMorphAttributes ) {
  15074. data.data.morphAttributes = morphAttributes;
  15075. data.data.morphTargetsRelative = this.morphTargetsRelative;
  15076. }
  15077. const groups = this.groups;
  15078. if ( groups.length > 0 ) {
  15079. data.data.groups = JSON.parse( JSON.stringify( groups ) );
  15080. }
  15081. const boundingSphere = this.boundingSphere;
  15082. if ( boundingSphere !== null ) {
  15083. data.data.boundingSphere = boundingSphere.toJSON();
  15084. }
  15085. return data;
  15086. }
  15087. /**
  15088. * Returns a new geometry with copied values from this instance.
  15089. *
  15090. * @return {BufferGeometry} A clone of this instance.
  15091. */
  15092. clone() {
  15093. return new this.constructor().copy( this );
  15094. }
  15095. /**
  15096. * Copies the values of the given geometry to this instance.
  15097. *
  15098. * @param {BufferGeometry} source - The geometry to copy.
  15099. * @return {BufferGeometry} A reference to this instance.
  15100. */
  15101. copy( source ) {
  15102. // reset
  15103. this.index = null;
  15104. this.attributes = {};
  15105. this.morphAttributes = {};
  15106. this.groups = [];
  15107. this.boundingBox = null;
  15108. this.boundingSphere = null;
  15109. // used for storing cloned, shared data
  15110. const data = {};
  15111. // name
  15112. this.name = source.name;
  15113. // index
  15114. const index = source.index;
  15115. if ( index !== null ) {
  15116. this.setIndex( index.clone() );
  15117. }
  15118. // attributes
  15119. const attributes = source.attributes;
  15120. for ( const name in attributes ) {
  15121. const attribute = attributes[ name ];
  15122. this.setAttribute( name, attribute.clone( data ) );
  15123. }
  15124. // morph attributes
  15125. const morphAttributes = source.morphAttributes;
  15126. for ( const name in morphAttributes ) {
  15127. const array = [];
  15128. const morphAttribute = morphAttributes[ name ]; // morphAttribute: array of Float32BufferAttributes
  15129. for ( let i = 0, l = morphAttribute.length; i < l; i ++ ) {
  15130. array.push( morphAttribute[ i ].clone( data ) );
  15131. }
  15132. this.morphAttributes[ name ] = array;
  15133. }
  15134. this.morphTargetsRelative = source.morphTargetsRelative;
  15135. // groups
  15136. const groups = source.groups;
  15137. for ( let i = 0, l = groups.length; i < l; i ++ ) {
  15138. const group = groups[ i ];
  15139. this.addGroup( group.start, group.count, group.materialIndex );
  15140. }
  15141. // bounding box
  15142. const boundingBox = source.boundingBox;
  15143. if ( boundingBox !== null ) {
  15144. this.boundingBox = boundingBox.clone();
  15145. }
  15146. // bounding sphere
  15147. const boundingSphere = source.boundingSphere;
  15148. if ( boundingSphere !== null ) {
  15149. this.boundingSphere = boundingSphere.clone();
  15150. }
  15151. // draw range
  15152. this.drawRange.start = source.drawRange.start;
  15153. this.drawRange.count = source.drawRange.count;
  15154. // user data
  15155. this.userData = source.userData;
  15156. return this;
  15157. }
  15158. /**
  15159. * Frees the GPU-related resources allocated by this instance. Call this
  15160. * method whenever this instance is no longer used in your app.
  15161. *
  15162. * @fires BufferGeometry#dispose
  15163. */
  15164. dispose() {
  15165. this.dispatchEvent( { type: 'dispose' } );
  15166. }
  15167. }
  15168. const _inverseMatrix$3 = /*@__PURE__*/ new Matrix4();
  15169. const _ray$3 = /*@__PURE__*/ new Ray();
  15170. const _sphere$6 = /*@__PURE__*/ new Sphere();
  15171. const _sphereHitAt = /*@__PURE__*/ new Vector3();
  15172. const _vA$1 = /*@__PURE__*/ new Vector3();
  15173. const _vB$1 = /*@__PURE__*/ new Vector3();
  15174. const _vC$1 = /*@__PURE__*/ new Vector3();
  15175. const _tempA = /*@__PURE__*/ new Vector3();
  15176. const _morphA = /*@__PURE__*/ new Vector3();
  15177. const _intersectionPoint = /*@__PURE__*/ new Vector3();
  15178. const _intersectionPointWorld = /*@__PURE__*/ new Vector3();
  15179. /**
  15180. * Class representing triangular polygon mesh based objects.
  15181. *
  15182. * ```js
  15183. * const geometry = new THREE.BoxGeometry( 1, 1, 1 );
  15184. * const material = new THREE.MeshBasicMaterial( { color: 0xffff00 } );
  15185. * const mesh = new THREE.Mesh( geometry, material );
  15186. * scene.add( mesh );
  15187. * ```
  15188. *
  15189. * @augments Object3D
  15190. */
  15191. class Mesh extends Object3D {
  15192. /**
  15193. * Constructs a new mesh.
  15194. *
  15195. * @param {BufferGeometry} [geometry] - The mesh geometry.
  15196. * @param {Material|Array<Material>} [material] - The mesh material.
  15197. */
  15198. constructor( geometry = new BufferGeometry(), material = new MeshBasicMaterial() ) {
  15199. super();
  15200. /**
  15201. * This flag can be used for type testing.
  15202. *
  15203. * @type {boolean}
  15204. * @readonly
  15205. * @default true
  15206. */
  15207. this.isMesh = true;
  15208. this.type = 'Mesh';
  15209. /**
  15210. * The mesh geometry.
  15211. *
  15212. * @type {BufferGeometry}
  15213. */
  15214. this.geometry = geometry;
  15215. /**
  15216. * The mesh material.
  15217. *
  15218. * @type {Material|Array<Material>}
  15219. * @default MeshBasicMaterial
  15220. */
  15221. this.material = material;
  15222. /**
  15223. * A dictionary representing the morph targets in the geometry. The key is the
  15224. * morph targets name, the value its attribute index. This member is `undefined`
  15225. * by default and only set when morph targets are detected in the geometry.
  15226. *
  15227. * @type {Object<string,number>|undefined}
  15228. * @default undefined
  15229. */
  15230. this.morphTargetDictionary = undefined;
  15231. /**
  15232. * An array of weights typically in the range `[0,1]` that specify how much of the morph
  15233. * is applied. This member is `undefined` by default and only set when morph targets are
  15234. * detected in the geometry.
  15235. *
  15236. * @type {Array<number>|undefined}
  15237. * @default undefined
  15238. */
  15239. this.morphTargetInfluences = undefined;
  15240. /**
  15241. * The number of instances of this mesh.
  15242. * Can only be used with {@link WebGPURenderer}.
  15243. *
  15244. * @type {number}
  15245. * @default 1
  15246. */
  15247. this.count = 1;
  15248. this.updateMorphTargets();
  15249. }
  15250. copy( source, recursive ) {
  15251. super.copy( source, recursive );
  15252. if ( source.morphTargetInfluences !== undefined ) {
  15253. this.morphTargetInfluences = source.morphTargetInfluences.slice();
  15254. }
  15255. if ( source.morphTargetDictionary !== undefined ) {
  15256. this.morphTargetDictionary = Object.assign( {}, source.morphTargetDictionary );
  15257. }
  15258. this.material = Array.isArray( source.material ) ? source.material.slice() : source.material;
  15259. this.geometry = source.geometry;
  15260. return this;
  15261. }
  15262. /**
  15263. * Sets the values of {@link Mesh#morphTargetDictionary} and {@link Mesh#morphTargetInfluences}
  15264. * to make sure existing morph targets can influence this 3D object.
  15265. */
  15266. updateMorphTargets() {
  15267. const geometry = this.geometry;
  15268. const morphAttributes = geometry.morphAttributes;
  15269. const keys = Object.keys( morphAttributes );
  15270. if ( keys.length > 0 ) {
  15271. const morphAttribute = morphAttributes[ keys[ 0 ] ];
  15272. if ( morphAttribute !== undefined ) {
  15273. this.morphTargetInfluences = [];
  15274. this.morphTargetDictionary = {};
  15275. for ( let m = 0, ml = morphAttribute.length; m < ml; m ++ ) {
  15276. const name = morphAttribute[ m ].name || String( m );
  15277. this.morphTargetInfluences.push( 0 );
  15278. this.morphTargetDictionary[ name ] = m;
  15279. }
  15280. }
  15281. }
  15282. }
  15283. /**
  15284. * Returns the local-space position of the vertex at the given index, taking into
  15285. * account the current animation state of both morph targets and skinning.
  15286. *
  15287. * @param {number} index - The vertex index.
  15288. * @param {Vector3} target - The target object that is used to store the method's result.
  15289. * @return {Vector3} The vertex position in local space.
  15290. */
  15291. getVertexPosition( index, target ) {
  15292. const geometry = this.geometry;
  15293. const position = geometry.attributes.position;
  15294. const morphPosition = geometry.morphAttributes.position;
  15295. const morphTargetsRelative = geometry.morphTargetsRelative;
  15296. target.fromBufferAttribute( position, index );
  15297. const morphInfluences = this.morphTargetInfluences;
  15298. if ( morphPosition && morphInfluences ) {
  15299. _morphA.set( 0, 0, 0 );
  15300. for ( let i = 0, il = morphPosition.length; i < il; i ++ ) {
  15301. const influence = morphInfluences[ i ];
  15302. const morphAttribute = morphPosition[ i ];
  15303. if ( influence === 0 ) continue;
  15304. _tempA.fromBufferAttribute( morphAttribute, index );
  15305. if ( morphTargetsRelative ) {
  15306. _morphA.addScaledVector( _tempA, influence );
  15307. } else {
  15308. _morphA.addScaledVector( _tempA.sub( target ), influence );
  15309. }
  15310. }
  15311. target.add( _morphA );
  15312. }
  15313. return target;
  15314. }
  15315. /**
  15316. * Computes intersection points between a casted ray and this line.
  15317. *
  15318. * @param {Raycaster} raycaster - The raycaster.
  15319. * @param {Array<Object>} intersects - The target array that holds the intersection points.
  15320. */
  15321. raycast( raycaster, intersects ) {
  15322. const geometry = this.geometry;
  15323. const material = this.material;
  15324. const matrixWorld = this.matrixWorld;
  15325. if ( material === undefined ) return;
  15326. // test with bounding sphere in world space
  15327. if ( geometry.boundingSphere === null ) geometry.computeBoundingSphere();
  15328. _sphere$6.copy( geometry.boundingSphere );
  15329. _sphere$6.applyMatrix4( matrixWorld );
  15330. // check distance from ray origin to bounding sphere
  15331. _ray$3.copy( raycaster.ray ).recast( raycaster.near );
  15332. if ( _sphere$6.containsPoint( _ray$3.origin ) === false ) {
  15333. if ( _ray$3.intersectSphere( _sphere$6, _sphereHitAt ) === null ) return;
  15334. if ( _ray$3.origin.distanceToSquared( _sphereHitAt ) > ( raycaster.far - raycaster.near ) ** 2 ) return;
  15335. }
  15336. // convert ray to local space of mesh
  15337. _inverseMatrix$3.copy( matrixWorld ).invert();
  15338. _ray$3.copy( raycaster.ray ).applyMatrix4( _inverseMatrix$3 );
  15339. // test with bounding box in local space
  15340. if ( geometry.boundingBox !== null ) {
  15341. if ( _ray$3.intersectsBox( geometry.boundingBox ) === false ) return;
  15342. }
  15343. // test for intersections with geometry
  15344. this._computeIntersections( raycaster, intersects, _ray$3 );
  15345. }
  15346. _computeIntersections( raycaster, intersects, rayLocalSpace ) {
  15347. let intersection;
  15348. const geometry = this.geometry;
  15349. const material = this.material;
  15350. const index = geometry.index;
  15351. const position = geometry.attributes.position;
  15352. const uv = geometry.attributes.uv;
  15353. const uv1 = geometry.attributes.uv1;
  15354. const normal = geometry.attributes.normal;
  15355. const groups = geometry.groups;
  15356. const drawRange = geometry.drawRange;
  15357. if ( index !== null ) {
  15358. // indexed buffer geometry
  15359. if ( Array.isArray( material ) ) {
  15360. for ( let i = 0, il = groups.length; i < il; i ++ ) {
  15361. const group = groups[ i ];
  15362. const groupMaterial = material[ group.materialIndex ];
  15363. const start = Math.max( group.start, drawRange.start );
  15364. const end = Math.min( index.count, Math.min( ( group.start + group.count ), ( drawRange.start + drawRange.count ) ) );
  15365. for ( let j = start, jl = end; j < jl; j += 3 ) {
  15366. const a = index.getX( j );
  15367. const b = index.getX( j + 1 );
  15368. const c = index.getX( j + 2 );
  15369. intersection = checkGeometryIntersection( this, groupMaterial, raycaster, rayLocalSpace, uv, uv1, normal, a, b, c );
  15370. if ( intersection ) {
  15371. intersection.faceIndex = Math.floor( j / 3 ); // triangle number in indexed buffer semantics
  15372. intersection.face.materialIndex = group.materialIndex;
  15373. intersects.push( intersection );
  15374. }
  15375. }
  15376. }
  15377. } else {
  15378. const start = Math.max( 0, drawRange.start );
  15379. const end = Math.min( index.count, ( drawRange.start + drawRange.count ) );
  15380. for ( let i = start, il = end; i < il; i += 3 ) {
  15381. const a = index.getX( i );
  15382. const b = index.getX( i + 1 );
  15383. const c = index.getX( i + 2 );
  15384. intersection = checkGeometryIntersection( this, material, raycaster, rayLocalSpace, uv, uv1, normal, a, b, c );
  15385. if ( intersection ) {
  15386. intersection.faceIndex = Math.floor( i / 3 ); // triangle number in indexed buffer semantics
  15387. intersects.push( intersection );
  15388. }
  15389. }
  15390. }
  15391. } else if ( position !== undefined ) {
  15392. // non-indexed buffer geometry
  15393. if ( Array.isArray( material ) ) {
  15394. for ( let i = 0, il = groups.length; i < il; i ++ ) {
  15395. const group = groups[ i ];
  15396. const groupMaterial = material[ group.materialIndex ];
  15397. const start = Math.max( group.start, drawRange.start );
  15398. const end = Math.min( position.count, Math.min( ( group.start + group.count ), ( drawRange.start + drawRange.count ) ) );
  15399. for ( let j = start, jl = end; j < jl; j += 3 ) {
  15400. const a = j;
  15401. const b = j + 1;
  15402. const c = j + 2;
  15403. intersection = checkGeometryIntersection( this, groupMaterial, raycaster, rayLocalSpace, uv, uv1, normal, a, b, c );
  15404. if ( intersection ) {
  15405. intersection.faceIndex = Math.floor( j / 3 ); // triangle number in non-indexed buffer semantics
  15406. intersection.face.materialIndex = group.materialIndex;
  15407. intersects.push( intersection );
  15408. }
  15409. }
  15410. }
  15411. } else {
  15412. const start = Math.max( 0, drawRange.start );
  15413. const end = Math.min( position.count, ( drawRange.start + drawRange.count ) );
  15414. for ( let i = start, il = end; i < il; i += 3 ) {
  15415. const a = i;
  15416. const b = i + 1;
  15417. const c = i + 2;
  15418. intersection = checkGeometryIntersection( this, material, raycaster, rayLocalSpace, uv, uv1, normal, a, b, c );
  15419. if ( intersection ) {
  15420. intersection.faceIndex = Math.floor( i / 3 ); // triangle number in non-indexed buffer semantics
  15421. intersects.push( intersection );
  15422. }
  15423. }
  15424. }
  15425. }
  15426. }
  15427. }
  15428. function checkIntersection$1( object, material, raycaster, ray, pA, pB, pC, point ) {
  15429. let intersect;
  15430. if ( material.side === BackSide ) {
  15431. intersect = ray.intersectTriangle( pC, pB, pA, true, point );
  15432. } else {
  15433. intersect = ray.intersectTriangle( pA, pB, pC, ( material.side === FrontSide ), point );
  15434. }
  15435. if ( intersect === null ) return null;
  15436. _intersectionPointWorld.copy( point );
  15437. _intersectionPointWorld.applyMatrix4( object.matrixWorld );
  15438. const distance = raycaster.ray.origin.distanceTo( _intersectionPointWorld );
  15439. if ( distance < raycaster.near || distance > raycaster.far ) return null;
  15440. return {
  15441. distance: distance,
  15442. point: _intersectionPointWorld.clone(),
  15443. object: object
  15444. };
  15445. }
  15446. function checkGeometryIntersection( object, material, raycaster, ray, uv, uv1, normal, a, b, c ) {
  15447. object.getVertexPosition( a, _vA$1 );
  15448. object.getVertexPosition( b, _vB$1 );
  15449. object.getVertexPosition( c, _vC$1 );
  15450. const intersection = checkIntersection$1( object, material, raycaster, ray, _vA$1, _vB$1, _vC$1, _intersectionPoint );
  15451. if ( intersection ) {
  15452. const barycoord = new Vector3();
  15453. Triangle.getBarycoord( _intersectionPoint, _vA$1, _vB$1, _vC$1, barycoord );
  15454. if ( uv ) {
  15455. intersection.uv = Triangle.getInterpolatedAttribute( uv, a, b, c, barycoord, new Vector2() );
  15456. }
  15457. if ( uv1 ) {
  15458. intersection.uv1 = Triangle.getInterpolatedAttribute( uv1, a, b, c, barycoord, new Vector2() );
  15459. }
  15460. if ( normal ) {
  15461. intersection.normal = Triangle.getInterpolatedAttribute( normal, a, b, c, barycoord, new Vector3() );
  15462. if ( intersection.normal.dot( ray.direction ) > 0 ) {
  15463. intersection.normal.multiplyScalar( -1 );
  15464. }
  15465. }
  15466. const face = {
  15467. a: a,
  15468. b: b,
  15469. c: c,
  15470. normal: new Vector3(),
  15471. materialIndex: 0
  15472. };
  15473. Triangle.getNormal( _vA$1, _vB$1, _vC$1, face.normal );
  15474. intersection.face = face;
  15475. intersection.barycoord = barycoord;
  15476. }
  15477. return intersection;
  15478. }
  15479. /**
  15480. * A geometry class for a rectangular cuboid with a given width, height, and depth.
  15481. * On creation, the cuboid is centred on the origin, with each edge parallel to one
  15482. * of the axes.
  15483. *
  15484. * ```js
  15485. * const geometry = new THREE.BoxGeometry( 1, 1, 1 );
  15486. * const material = new THREE.MeshBasicMaterial( { color: 0x00ff00 } );
  15487. * const cube = new THREE.Mesh( geometry, material );
  15488. * scene.add( cube );
  15489. * ```
  15490. *
  15491. * @augments BufferGeometry
  15492. * @demo scenes/geometry-browser.html#BoxGeometry
  15493. */
  15494. class BoxGeometry extends BufferGeometry {
  15495. /**
  15496. * Constructs a new box geometry.
  15497. *
  15498. * @param {number} [width=1] - The width. That is, the length of the edges parallel to the X axis.
  15499. * @param {number} [height=1] - The height. That is, the length of the edges parallel to the Y axis.
  15500. * @param {number} [depth=1] - The depth. That is, the length of the edges parallel to the Z axis.
  15501. * @param {number} [widthSegments=1] - Number of segmented rectangular faces along the width of the sides.
  15502. * @param {number} [heightSegments=1] - Number of segmented rectangular faces along the height of the sides.
  15503. * @param {number} [depthSegments=1] - Number of segmented rectangular faces along the depth of the sides.
  15504. */
  15505. constructor( width = 1, height = 1, depth = 1, widthSegments = 1, heightSegments = 1, depthSegments = 1 ) {
  15506. super();
  15507. this.type = 'BoxGeometry';
  15508. /**
  15509. * Holds the constructor parameters that have been
  15510. * used to generate the geometry. Any modification
  15511. * after instantiation does not change the geometry.
  15512. *
  15513. * @type {Object}
  15514. */
  15515. this.parameters = {
  15516. width: width,
  15517. height: height,
  15518. depth: depth,
  15519. widthSegments: widthSegments,
  15520. heightSegments: heightSegments,
  15521. depthSegments: depthSegments
  15522. };
  15523. const scope = this;
  15524. // segments
  15525. widthSegments = Math.floor( widthSegments );
  15526. heightSegments = Math.floor( heightSegments );
  15527. depthSegments = Math.floor( depthSegments );
  15528. // buffers
  15529. const indices = [];
  15530. const vertices = [];
  15531. const normals = [];
  15532. const uvs = [];
  15533. // helper variables
  15534. let numberOfVertices = 0;
  15535. let groupStart = 0;
  15536. // build each side of the box geometry
  15537. buildPlane( 'z', 'y', 'x', -1, -1, depth, height, width, depthSegments, heightSegments, 0 ); // px
  15538. buildPlane( 'z', 'y', 'x', 1, -1, depth, height, - width, depthSegments, heightSegments, 1 ); // nx
  15539. buildPlane( 'x', 'z', 'y', 1, 1, width, depth, height, widthSegments, depthSegments, 2 ); // py
  15540. buildPlane( 'x', 'z', 'y', 1, -1, width, depth, - height, widthSegments, depthSegments, 3 ); // ny
  15541. buildPlane( 'x', 'y', 'z', 1, -1, width, height, depth, widthSegments, heightSegments, 4 ); // pz
  15542. buildPlane( 'x', 'y', 'z', -1, -1, width, height, - depth, widthSegments, heightSegments, 5 ); // nz
  15543. // build geometry
  15544. this.setIndex( indices );
  15545. this.setAttribute( 'position', new Float32BufferAttribute( vertices, 3 ) );
  15546. this.setAttribute( 'normal', new Float32BufferAttribute( normals, 3 ) );
  15547. this.setAttribute( 'uv', new Float32BufferAttribute( uvs, 2 ) );
  15548. function buildPlane( u, v, w, udir, vdir, width, height, depth, gridX, gridY, materialIndex ) {
  15549. const segmentWidth = width / gridX;
  15550. const segmentHeight = height / gridY;
  15551. const widthHalf = width / 2;
  15552. const heightHalf = height / 2;
  15553. const depthHalf = depth / 2;
  15554. const gridX1 = gridX + 1;
  15555. const gridY1 = gridY + 1;
  15556. let vertexCounter = 0;
  15557. let groupCount = 0;
  15558. const vector = new Vector3();
  15559. // generate vertices, normals and uvs
  15560. for ( let iy = 0; iy < gridY1; iy ++ ) {
  15561. const y = iy * segmentHeight - heightHalf;
  15562. for ( let ix = 0; ix < gridX1; ix ++ ) {
  15563. const x = ix * segmentWidth - widthHalf;
  15564. // set values to correct vector component
  15565. vector[ u ] = x * udir;
  15566. vector[ v ] = y * vdir;
  15567. vector[ w ] = depthHalf;
  15568. // now apply vector to vertex buffer
  15569. vertices.push( vector.x, vector.y, vector.z );
  15570. // set values to correct vector component
  15571. vector[ u ] = 0;
  15572. vector[ v ] = 0;
  15573. vector[ w ] = depth > 0 ? 1 : -1;
  15574. // now apply vector to normal buffer
  15575. normals.push( vector.x, vector.y, vector.z );
  15576. // uvs
  15577. uvs.push( ix / gridX );
  15578. uvs.push( 1 - ( iy / gridY ) );
  15579. // counters
  15580. vertexCounter += 1;
  15581. }
  15582. }
  15583. // indices
  15584. // 1. you need three indices to draw a single face
  15585. // 2. a single segment consists of two faces
  15586. // 3. so we need to generate six (2*3) indices per segment
  15587. for ( let iy = 0; iy < gridY; iy ++ ) {
  15588. for ( let ix = 0; ix < gridX; ix ++ ) {
  15589. const a = numberOfVertices + ix + gridX1 * iy;
  15590. const b = numberOfVertices + ix + gridX1 * ( iy + 1 );
  15591. const c = numberOfVertices + ( ix + 1 ) + gridX1 * ( iy + 1 );
  15592. const d = numberOfVertices + ( ix + 1 ) + gridX1 * iy;
  15593. // faces
  15594. indices.push( a, b, d );
  15595. indices.push( b, c, d );
  15596. // increase counter
  15597. groupCount += 6;
  15598. }
  15599. }
  15600. // add a group to the geometry. this will ensure multi material support
  15601. scope.addGroup( groupStart, groupCount, materialIndex );
  15602. // calculate new start value for groups
  15603. groupStart += groupCount;
  15604. // update total number of vertices
  15605. numberOfVertices += vertexCounter;
  15606. }
  15607. }
  15608. copy( source ) {
  15609. super.copy( source );
  15610. this.parameters = Object.assign( {}, source.parameters );
  15611. return this;
  15612. }
  15613. /**
  15614. * Factory method for creating an instance of this class from the given
  15615. * JSON object.
  15616. *
  15617. * @param {Object} data - A JSON object representing the serialized geometry.
  15618. * @return {BoxGeometry} A new instance.
  15619. */
  15620. static fromJSON( data ) {
  15621. return new BoxGeometry( data.width, data.height, data.depth, data.widthSegments, data.heightSegments, data.depthSegments );
  15622. }
  15623. }
  15624. /**
  15625. * Provides utility functions for managing uniforms.
  15626. *
  15627. * @module UniformsUtils
  15628. */
  15629. /**
  15630. * Clones the given uniform definitions by performing a deep-copy. That means
  15631. * if the value of a uniform refers to an object like a Vector3 or Texture,
  15632. * the cloned uniform will refer to a new object reference.
  15633. *
  15634. * @param {Object} src - An object representing uniform definitions.
  15635. * @return {Object} The cloned uniforms.
  15636. */
  15637. function cloneUniforms( src ) {
  15638. const dst = {};
  15639. for ( const u in src ) {
  15640. dst[ u ] = {};
  15641. for ( const p in src[ u ] ) {
  15642. const property = src[ u ][ p ];
  15643. if ( property && ( property.isColor ||
  15644. property.isMatrix3 || property.isMatrix4 ||
  15645. property.isVector2 || property.isVector3 || property.isVector4 ||
  15646. property.isTexture || property.isQuaternion ) ) {
  15647. if ( property.isRenderTargetTexture ) {
  15648. warn( 'UniformsUtils: Textures of render targets cannot be cloned via cloneUniforms() or mergeUniforms().' );
  15649. dst[ u ][ p ] = null;
  15650. } else {
  15651. dst[ u ][ p ] = property.clone();
  15652. }
  15653. } else if ( Array.isArray( property ) ) {
  15654. dst[ u ][ p ] = property.slice();
  15655. } else {
  15656. dst[ u ][ p ] = property;
  15657. }
  15658. }
  15659. }
  15660. return dst;
  15661. }
  15662. /**
  15663. * Merges the given uniform definitions into a single object. Since the
  15664. * method internally uses cloneUniforms(), it performs a deep-copy when
  15665. * producing the merged uniform definitions.
  15666. *
  15667. * @param {Array} uniforms - An array of objects containing uniform definitions.
  15668. * @return {Object} The merged uniforms.
  15669. */
  15670. function mergeUniforms( uniforms ) {
  15671. const merged = {};
  15672. for ( let u = 0; u < uniforms.length; u ++ ) {
  15673. const tmp = cloneUniforms( uniforms[ u ] );
  15674. for ( const p in tmp ) {
  15675. merged[ p ] = tmp[ p ];
  15676. }
  15677. }
  15678. return merged;
  15679. }
  15680. function cloneUniformsGroups( src ) {
  15681. const dst = [];
  15682. for ( let u = 0; u < src.length; u ++ ) {
  15683. dst.push( src[ u ].clone() );
  15684. }
  15685. return dst;
  15686. }
  15687. function getUnlitUniformColorSpace( renderer ) {
  15688. const currentRenderTarget = renderer.getRenderTarget();
  15689. if ( currentRenderTarget === null ) {
  15690. // https://github.com/mrdoob/three.js/pull/23937#issuecomment-1111067398
  15691. return renderer.outputColorSpace;
  15692. }
  15693. // https://github.com/mrdoob/three.js/issues/27868
  15694. if ( currentRenderTarget.isXRRenderTarget === true ) {
  15695. return currentRenderTarget.texture.colorSpace;
  15696. }
  15697. return ColorManagement.workingColorSpace;
  15698. }
  15699. // Legacy
  15700. const UniformsUtils = { clone: cloneUniforms, merge: mergeUniforms };
  15701. var default_vertex = "void main() {\n\tgl_Position = projectionMatrix * modelViewMatrix * vec4( position, 1.0 );\n}";
  15702. var default_fragment = "void main() {\n\tgl_FragColor = vec4( 1.0, 0.0, 0.0, 1.0 );\n}";
  15703. /**
  15704. * A material rendered with custom shaders. A shader is a small program written in GLSL.
  15705. * that runs on the GPU. You may want to use a custom shader if you need to implement an
  15706. * effect not included with any of the built-in materials.
  15707. *
  15708. * There are the following notes to bear in mind when using a `ShaderMaterial`:
  15709. *
  15710. * - `ShaderMaterial` can only be used with {@link WebGLRenderer}.
  15711. * - Built in attributes and uniforms are passed to the shaders along with your code. If
  15712. * you don't want that, use {@link RawShaderMaterial} instead.
  15713. * - You can use the directive `#pragma unroll_loop_start` and `#pragma unroll_loop_end`
  15714. * in order to unroll a `for` loop in GLSL by the shader preprocessor. The directive has
  15715. * to be placed right above the loop. The loop formatting has to correspond to a defined standard.
  15716. * - The loop has to be [normalized](https://en.wikipedia.org/wiki/Normalized_loop).
  15717. * - The loop variable has to be *i*.
  15718. * - The value `UNROLLED_LOOP_INDEX` will be replaced with the explicitly
  15719. * value of *i* for the given iteration and can be used in preprocessor
  15720. * statements.
  15721. *
  15722. * ```js
  15723. * const material = new THREE.ShaderMaterial( {
  15724. * uniforms: {
  15725. * time: { value: 1.0 },
  15726. * resolution: { value: new THREE.Vector2() }
  15727. * },
  15728. * vertexShader: document.getElementById( 'vertexShader' ).textContent,
  15729. * fragmentShader: document.getElementById( 'fragmentShader' ).textContent
  15730. * } );
  15731. * ```
  15732. *
  15733. * @augments Material
  15734. */
  15735. class ShaderMaterial extends Material {
  15736. /**
  15737. * Constructs a new shader material.
  15738. *
  15739. * @param {Object} [parameters] - An object with one or more properties
  15740. * defining the material's appearance. Any property of the material
  15741. * (including any property from inherited materials) can be passed
  15742. * in here. Color values can be passed any type of value accepted
  15743. * by {@link Color#set}.
  15744. */
  15745. constructor( parameters ) {
  15746. super();
  15747. /**
  15748. * This flag can be used for type testing.
  15749. *
  15750. * @type {boolean}
  15751. * @readonly
  15752. * @default true
  15753. */
  15754. this.isShaderMaterial = true;
  15755. this.type = 'ShaderMaterial';
  15756. /**
  15757. * Defines custom constants using `#define` directives within the GLSL code
  15758. * for both the vertex shader and the fragment shader; each key/value pair
  15759. * yields another directive.
  15760. * ```js
  15761. * defines: {
  15762. * FOO: 15,
  15763. * BAR: true
  15764. * }
  15765. * ```
  15766. * Yields the lines:
  15767. * ```
  15768. * #define FOO 15
  15769. * #define BAR true
  15770. * ```
  15771. *
  15772. * @type {Object}
  15773. */
  15774. this.defines = {};
  15775. /**
  15776. * An object of the form:
  15777. * ```js
  15778. * {
  15779. * "uniform1": { value: 1.0 },
  15780. * "uniform2": { value: 2 }
  15781. * }
  15782. * ```
  15783. * specifying the uniforms to be passed to the shader code; keys are uniform
  15784. * names, values are definitions of the form
  15785. * ```
  15786. * {
  15787. * value: 1.0
  15788. * }
  15789. * ```
  15790. * where `value` is the value of the uniform. Names must match the name of
  15791. * the uniform, as defined in the GLSL code. Note that uniforms are refreshed
  15792. * on every frame, so updating the value of the uniform will immediately
  15793. * update the value available to the GLSL code.
  15794. *
  15795. * @type {Object}
  15796. */
  15797. this.uniforms = {};
  15798. /**
  15799. * An array holding uniforms groups for configuring UBOs.
  15800. *
  15801. * @type {Array<UniformsGroup>}
  15802. */
  15803. this.uniformsGroups = [];
  15804. /**
  15805. * Vertex shader GLSL code. This is the actual code for the shader.
  15806. *
  15807. * @type {string}
  15808. */
  15809. this.vertexShader = default_vertex;
  15810. /**
  15811. * Fragment shader GLSL code. This is the actual code for the shader.
  15812. *
  15813. * @type {string}
  15814. */
  15815. this.fragmentShader = default_fragment;
  15816. /**
  15817. * Controls line thickness or lines.
  15818. *
  15819. * WebGL and WebGPU ignore this setting and always render line primitives with a
  15820. * width of one pixel.
  15821. *
  15822. * @type {number}
  15823. * @default 1
  15824. */
  15825. this.linewidth = 1;
  15826. /**
  15827. * Renders the geometry as a wireframe.
  15828. *
  15829. * @type {boolean}
  15830. * @default false
  15831. */
  15832. this.wireframe = false;
  15833. /**
  15834. * Controls the thickness of the wireframe.
  15835. *
  15836. * WebGL and WebGPU ignore this property and always render
  15837. * 1 pixel wide lines.
  15838. *
  15839. * @type {number}
  15840. * @default 1
  15841. */
  15842. this.wireframeLinewidth = 1;
  15843. /**
  15844. * Defines whether the material color is affected by global fog settings; `true`
  15845. * to pass fog uniforms to the shader.
  15846. *
  15847. * Setting this property to `true` requires the definition of fog uniforms. It is
  15848. * recommended to use `UniformsUtils.merge()` to combine the custom shader uniforms
  15849. * with predefined fog uniforms.
  15850. *
  15851. * ```js
  15852. * const material = new ShaderMaterial( {
  15853. * uniforms: UniformsUtils.merge( [ UniformsLib[ 'fog' ], shaderUniforms ] );
  15854. * vertexShader: vertexShader,
  15855. * fragmentShader: fragmentShader,
  15856. * fog: true
  15857. * } );
  15858. * ```
  15859. *
  15860. * @type {boolean}
  15861. * @default false
  15862. */
  15863. this.fog = false;
  15864. /**
  15865. * Defines whether this material uses lighting; `true` to pass uniform data
  15866. * related to lighting to this shader.
  15867. *
  15868. * @type {boolean}
  15869. * @default false
  15870. */
  15871. this.lights = false;
  15872. /**
  15873. * Defines whether this material supports clipping; `true` to let the renderer
  15874. * pass the clippingPlanes uniform.
  15875. *
  15876. * @type {boolean}
  15877. * @default false
  15878. */
  15879. this.clipping = false;
  15880. /**
  15881. * Overwritten and set to `true` by default.
  15882. *
  15883. * @type {boolean}
  15884. * @default true
  15885. */
  15886. this.forceSinglePass = true;
  15887. /**
  15888. * This object allows to enable certain WebGL 2 extensions.
  15889. *
  15890. * - clipCullDistance: set to `true` to use vertex shader clipping
  15891. * - multiDraw: set to `true` to use vertex shader multi_draw / enable gl_DrawID
  15892. *
  15893. * @type {{clipCullDistance:false,multiDraw:false}}
  15894. */
  15895. this.extensions = {
  15896. clipCullDistance: false, // set to use vertex shader clipping
  15897. multiDraw: false // set to use vertex shader multi_draw / enable gl_DrawID
  15898. };
  15899. /**
  15900. * When the rendered geometry doesn't include these attributes but the
  15901. * material does, these default values will be passed to the shaders. This
  15902. * avoids errors when buffer data is missing.
  15903. *
  15904. * - color: [ 1, 1, 1 ]
  15905. * - uv: [ 0, 0 ]
  15906. * - uv1: [ 0, 0 ]
  15907. *
  15908. * @type {Object}
  15909. */
  15910. this.defaultAttributeValues = {
  15911. 'color': [ 1, 1, 1 ],
  15912. 'uv': [ 0, 0 ],
  15913. 'uv1': [ 0, 0 ]
  15914. };
  15915. /**
  15916. * If set, this calls [gl.bindAttribLocation](https://developer.mozilla.org/en-US/docs/Web/API/WebGLRenderingContext/bindAttribLocation)
  15917. * to bind a generic vertex index to an attribute variable.
  15918. *
  15919. * @type {string|undefined}
  15920. * @default undefined
  15921. */
  15922. this.index0AttributeName = undefined;
  15923. /**
  15924. * Can be used to force a uniform update while changing uniforms in
  15925. * {@link Object3D#onBeforeRender}.
  15926. *
  15927. * @type {boolean}
  15928. * @default false
  15929. */
  15930. this.uniformsNeedUpdate = false;
  15931. /**
  15932. * Defines the GLSL version of custom shader code.
  15933. *
  15934. * @type {?(GLSL1|GLSL3)}
  15935. * @default null
  15936. */
  15937. this.glslVersion = null;
  15938. if ( parameters !== undefined ) {
  15939. this.setValues( parameters );
  15940. }
  15941. }
  15942. copy( source ) {
  15943. super.copy( source );
  15944. this.fragmentShader = source.fragmentShader;
  15945. this.vertexShader = source.vertexShader;
  15946. this.uniforms = cloneUniforms( source.uniforms );
  15947. this.uniformsGroups = cloneUniformsGroups( source.uniformsGroups );
  15948. this.defines = Object.assign( {}, source.defines );
  15949. this.wireframe = source.wireframe;
  15950. this.wireframeLinewidth = source.wireframeLinewidth;
  15951. this.fog = source.fog;
  15952. this.lights = source.lights;
  15953. this.clipping = source.clipping;
  15954. this.extensions = Object.assign( {}, source.extensions );
  15955. this.glslVersion = source.glslVersion;
  15956. this.defaultAttributeValues = Object.assign( {}, source.defaultAttributeValues );
  15957. this.index0AttributeName = source.index0AttributeName;
  15958. this.uniformsNeedUpdate = source.uniformsNeedUpdate;
  15959. return this;
  15960. }
  15961. toJSON( meta ) {
  15962. const data = super.toJSON( meta );
  15963. data.glslVersion = this.glslVersion;
  15964. data.uniforms = {};
  15965. for ( const name in this.uniforms ) {
  15966. const uniform = this.uniforms[ name ];
  15967. const value = uniform.value;
  15968. if ( value && value.isTexture ) {
  15969. data.uniforms[ name ] = {
  15970. type: 't',
  15971. value: value.toJSON( meta ).uuid
  15972. };
  15973. } else if ( value && value.isColor ) {
  15974. data.uniforms[ name ] = {
  15975. type: 'c',
  15976. value: value.getHex()
  15977. };
  15978. } else if ( value && value.isVector2 ) {
  15979. data.uniforms[ name ] = {
  15980. type: 'v2',
  15981. value: value.toArray()
  15982. };
  15983. } else if ( value && value.isVector3 ) {
  15984. data.uniforms[ name ] = {
  15985. type: 'v3',
  15986. value: value.toArray()
  15987. };
  15988. } else if ( value && value.isVector4 ) {
  15989. data.uniforms[ name ] = {
  15990. type: 'v4',
  15991. value: value.toArray()
  15992. };
  15993. } else if ( value && value.isMatrix3 ) {
  15994. data.uniforms[ name ] = {
  15995. type: 'm3',
  15996. value: value.toArray()
  15997. };
  15998. } else if ( value && value.isMatrix4 ) {
  15999. data.uniforms[ name ] = {
  16000. type: 'm4',
  16001. value: value.toArray()
  16002. };
  16003. } else {
  16004. data.uniforms[ name ] = {
  16005. value: value
  16006. };
  16007. // note: the array variants v2v, v3v, v4v, m4v and tv are not supported so far
  16008. }
  16009. }
  16010. if ( Object.keys( this.defines ).length > 0 ) data.defines = this.defines;
  16011. data.vertexShader = this.vertexShader;
  16012. data.fragmentShader = this.fragmentShader;
  16013. data.lights = this.lights;
  16014. data.clipping = this.clipping;
  16015. const extensions = {};
  16016. for ( const key in this.extensions ) {
  16017. if ( this.extensions[ key ] === true ) extensions[ key ] = true;
  16018. }
  16019. if ( Object.keys( extensions ).length > 0 ) data.extensions = extensions;
  16020. return data;
  16021. }
  16022. }
  16023. /**
  16024. * Abstract base class for cameras. This class should always be inherited
  16025. * when you build a new camera.
  16026. *
  16027. * @abstract
  16028. * @augments Object3D
  16029. */
  16030. class Camera extends Object3D {
  16031. /**
  16032. * Constructs a new camera.
  16033. */
  16034. constructor() {
  16035. super();
  16036. /**
  16037. * This flag can be used for type testing.
  16038. *
  16039. * @type {boolean}
  16040. * @readonly
  16041. * @default true
  16042. */
  16043. this.isCamera = true;
  16044. this.type = 'Camera';
  16045. /**
  16046. * The inverse of the camera's world matrix.
  16047. *
  16048. * @type {Matrix4}
  16049. */
  16050. this.matrixWorldInverse = new Matrix4();
  16051. /**
  16052. * The camera's projection matrix.
  16053. *
  16054. * @type {Matrix4}
  16055. */
  16056. this.projectionMatrix = new Matrix4();
  16057. /**
  16058. * The inverse of the camera's projection matrix.
  16059. *
  16060. * @type {Matrix4}
  16061. */
  16062. this.projectionMatrixInverse = new Matrix4();
  16063. /**
  16064. * The coordinate system in which the camera is used.
  16065. *
  16066. * @type {(WebGLCoordinateSystem|WebGPUCoordinateSystem)}
  16067. */
  16068. this.coordinateSystem = WebGLCoordinateSystem;
  16069. this._reversedDepth = false;
  16070. }
  16071. /**
  16072. * The flag that indicates whether the camera uses a reversed depth buffer.
  16073. *
  16074. * @type {boolean}
  16075. * @default false
  16076. */
  16077. get reversedDepth() {
  16078. return this._reversedDepth;
  16079. }
  16080. copy( source, recursive ) {
  16081. super.copy( source, recursive );
  16082. this.matrixWorldInverse.copy( source.matrixWorldInverse );
  16083. this.projectionMatrix.copy( source.projectionMatrix );
  16084. this.projectionMatrixInverse.copy( source.projectionMatrixInverse );
  16085. this.coordinateSystem = source.coordinateSystem;
  16086. return this;
  16087. }
  16088. /**
  16089. * Returns a vector representing the ("look") direction of the 3D object in world space.
  16090. *
  16091. * This method is overwritten since cameras have a different forward vector compared to other
  16092. * 3D objects. A camera looks down its local, negative z-axis by default.
  16093. *
  16094. * @param {Vector3} target - The target vector the result is stored to.
  16095. * @return {Vector3} The 3D object's direction in world space.
  16096. */
  16097. getWorldDirection( target ) {
  16098. return super.getWorldDirection( target ).negate();
  16099. }
  16100. updateMatrixWorld( force ) {
  16101. super.updateMatrixWorld( force );
  16102. this.matrixWorldInverse.copy( this.matrixWorld ).invert();
  16103. }
  16104. updateWorldMatrix( updateParents, updateChildren ) {
  16105. super.updateWorldMatrix( updateParents, updateChildren );
  16106. this.matrixWorldInverse.copy( this.matrixWorld ).invert();
  16107. }
  16108. clone() {
  16109. return new this.constructor().copy( this );
  16110. }
  16111. }
  16112. const _v3$1 = /*@__PURE__*/ new Vector3();
  16113. const _minTarget = /*@__PURE__*/ new Vector2();
  16114. const _maxTarget = /*@__PURE__*/ new Vector2();
  16115. /**
  16116. * Camera that uses [perspective projection](https://en.wikipedia.org/wiki/Perspective_(graphical)).
  16117. *
  16118. * This projection mode is designed to mimic the way the human eye sees. It
  16119. * is the most common projection mode used for rendering a 3D scene.
  16120. *
  16121. * ```js
  16122. * const camera = new THREE.PerspectiveCamera( 45, width / height, 1, 1000 );
  16123. * scene.add( camera );
  16124. * ```
  16125. *
  16126. * @augments Camera
  16127. */
  16128. class PerspectiveCamera extends Camera {
  16129. /**
  16130. * Constructs a new perspective camera.
  16131. *
  16132. * @param {number} [fov=50] - The vertical field of view.
  16133. * @param {number} [aspect=1] - The aspect ratio.
  16134. * @param {number} [near=0.1] - The camera's near plane.
  16135. * @param {number} [far=2000] - The camera's far plane.
  16136. */
  16137. constructor( fov = 50, aspect = 1, near = 0.1, far = 2000 ) {
  16138. super();
  16139. /**
  16140. * This flag can be used for type testing.
  16141. *
  16142. * @type {boolean}
  16143. * @readonly
  16144. * @default true
  16145. */
  16146. this.isPerspectiveCamera = true;
  16147. this.type = 'PerspectiveCamera';
  16148. /**
  16149. * The vertical field of view, from bottom to top of view,
  16150. * in degrees.
  16151. *
  16152. * @type {number}
  16153. * @default 50
  16154. */
  16155. this.fov = fov;
  16156. /**
  16157. * The zoom factor of the camera.
  16158. *
  16159. * @type {number}
  16160. * @default 1
  16161. */
  16162. this.zoom = 1;
  16163. /**
  16164. * The camera's near plane. The valid range is greater than `0`
  16165. * and less than the current value of {@link PerspectiveCamera#far}.
  16166. *
  16167. * Note that, unlike for the {@link OrthographicCamera}, `0` is <em>not</em> a
  16168. * valid value for a perspective camera's near plane.
  16169. *
  16170. * @type {number}
  16171. * @default 0.1
  16172. */
  16173. this.near = near;
  16174. /**
  16175. * The camera's far plane. Must be greater than the
  16176. * current value of {@link PerspectiveCamera#near}.
  16177. *
  16178. * @type {number}
  16179. * @default 2000
  16180. */
  16181. this.far = far;
  16182. /**
  16183. * Object distance used for stereoscopy and depth-of-field effects. This
  16184. * parameter does not influence the projection matrix unless a
  16185. * {@link StereoCamera} is being used.
  16186. *
  16187. * @type {number}
  16188. * @default 10
  16189. */
  16190. this.focus = 10;
  16191. /**
  16192. * The aspect ratio, usually the canvas width / canvas height.
  16193. *
  16194. * @type {number}
  16195. * @default 1
  16196. */
  16197. this.aspect = aspect;
  16198. /**
  16199. * Represents the frustum window specification. This property should not be edited
  16200. * directly but via {@link PerspectiveCamera#setViewOffset} and {@link PerspectiveCamera#clearViewOffset}.
  16201. *
  16202. * @type {?Object}
  16203. * @default null
  16204. */
  16205. this.view = null;
  16206. /**
  16207. * Film size used for the larger axis. Default is `35` (millimeters). This
  16208. * parameter does not influence the projection matrix unless {@link PerspectiveCamera#filmOffset}
  16209. * is set to a nonzero value.
  16210. *
  16211. * @type {number}
  16212. * @default 35
  16213. */
  16214. this.filmGauge = 35;
  16215. /**
  16216. * Horizontal off-center offset in the same unit as {@link PerspectiveCamera#filmGauge}.
  16217. *
  16218. * @type {number}
  16219. * @default 0
  16220. */
  16221. this.filmOffset = 0;
  16222. this.updateProjectionMatrix();
  16223. }
  16224. copy( source, recursive ) {
  16225. super.copy( source, recursive );
  16226. this.fov = source.fov;
  16227. this.zoom = source.zoom;
  16228. this.near = source.near;
  16229. this.far = source.far;
  16230. this.focus = source.focus;
  16231. this.aspect = source.aspect;
  16232. this.view = source.view === null ? null : Object.assign( {}, source.view );
  16233. this.filmGauge = source.filmGauge;
  16234. this.filmOffset = source.filmOffset;
  16235. return this;
  16236. }
  16237. /**
  16238. * Sets the FOV by focal length in respect to the current {@link PerspectiveCamera#filmGauge}.
  16239. *
  16240. * The default film gauge is 35, so that the focal length can be specified for
  16241. * a 35mm (full frame) camera.
  16242. *
  16243. * @param {number} focalLength - Values for focal length and film gauge must have the same unit.
  16244. */
  16245. setFocalLength( focalLength ) {
  16246. /** see {@link http://www.bobatkins.com/photography/technical/field_of_view.html} */
  16247. const vExtentSlope = 0.5 * this.getFilmHeight() / focalLength;
  16248. this.fov = RAD2DEG * 2 * Math.atan( vExtentSlope );
  16249. this.updateProjectionMatrix();
  16250. }
  16251. /**
  16252. * Returns the focal length from the current {@link PerspectiveCamera#fov} and
  16253. * {@link PerspectiveCamera#filmGauge}.
  16254. *
  16255. * @return {number} The computed focal length.
  16256. */
  16257. getFocalLength() {
  16258. const vExtentSlope = Math.tan( DEG2RAD * 0.5 * this.fov );
  16259. return 0.5 * this.getFilmHeight() / vExtentSlope;
  16260. }
  16261. /**
  16262. * Returns the current vertical field of view angle in degrees considering {@link PerspectiveCamera#zoom}.
  16263. *
  16264. * @return {number} The effective FOV.
  16265. */
  16266. getEffectiveFOV() {
  16267. return RAD2DEG * 2 * Math.atan(
  16268. Math.tan( DEG2RAD * 0.5 * this.fov ) / this.zoom );
  16269. }
  16270. /**
  16271. * Returns the width of the image on the film. If {@link PerspectiveCamera#aspect} is greater than or
  16272. * equal to one (landscape format), the result equals {@link PerspectiveCamera#filmGauge}.
  16273. *
  16274. * @return {number} The film width.
  16275. */
  16276. getFilmWidth() {
  16277. // film not completely covered in portrait format (aspect < 1)
  16278. return this.filmGauge * Math.min( this.aspect, 1 );
  16279. }
  16280. /**
  16281. * Returns the height of the image on the film. If {@link PerspectiveCamera#aspect} is greater than or
  16282. * equal to one (landscape format), the result equals {@link PerspectiveCamera#filmGauge}.
  16283. *
  16284. * @return {number} The film width.
  16285. */
  16286. getFilmHeight() {
  16287. // film not completely covered in landscape format (aspect > 1)
  16288. return this.filmGauge / Math.max( this.aspect, 1 );
  16289. }
  16290. /**
  16291. * Computes the 2D bounds of the camera's viewable rectangle at a given distance along the viewing direction.
  16292. * Sets `minTarget` and `maxTarget` to the coordinates of the lower-left and upper-right corners of the view rectangle.
  16293. *
  16294. * @param {number} distance - The viewing distance.
  16295. * @param {Vector2} minTarget - The lower-left corner of the view rectangle is written into this vector.
  16296. * @param {Vector2} maxTarget - The upper-right corner of the view rectangle is written into this vector.
  16297. */
  16298. getViewBounds( distance, minTarget, maxTarget ) {
  16299. _v3$1.set( -1, -1, 0.5 ).applyMatrix4( this.projectionMatrixInverse );
  16300. minTarget.set( _v3$1.x, _v3$1.y ).multiplyScalar( - distance / _v3$1.z );
  16301. _v3$1.set( 1, 1, 0.5 ).applyMatrix4( this.projectionMatrixInverse );
  16302. maxTarget.set( _v3$1.x, _v3$1.y ).multiplyScalar( - distance / _v3$1.z );
  16303. }
  16304. /**
  16305. * Computes the width and height of the camera's viewable rectangle at a given distance along the viewing direction.
  16306. *
  16307. * @param {number} distance - The viewing distance.
  16308. * @param {Vector2} target - The target vector that is used to store result where x is width and y is height.
  16309. * @returns {Vector2} The view size.
  16310. */
  16311. getViewSize( distance, target ) {
  16312. this.getViewBounds( distance, _minTarget, _maxTarget );
  16313. return target.subVectors( _maxTarget, _minTarget );
  16314. }
  16315. /**
  16316. * Sets an offset in a larger frustum. This is useful for multi-window or
  16317. * multi-monitor/multi-machine setups.
  16318. *
  16319. * For example, if you have 3x2 monitors and each monitor is 1920x1080 and
  16320. * the monitors are in grid like this
  16321. *```
  16322. * +---+---+---+
  16323. * | A | B | C |
  16324. * +---+---+---+
  16325. * | D | E | F |
  16326. * +---+---+---+
  16327. *```
  16328. * then for each monitor you would call it like this:
  16329. *```js
  16330. * const w = 1920;
  16331. * const h = 1080;
  16332. * const fullWidth = w * 3;
  16333. * const fullHeight = h * 2;
  16334. *
  16335. * // --A--
  16336. * camera.setViewOffset( fullWidth, fullHeight, w * 0, h * 0, w, h );
  16337. * // --B--
  16338. * camera.setViewOffset( fullWidth, fullHeight, w * 1, h * 0, w, h );
  16339. * // --C--
  16340. * camera.setViewOffset( fullWidth, fullHeight, w * 2, h * 0, w, h );
  16341. * // --D--
  16342. * camera.setViewOffset( fullWidth, fullHeight, w * 0, h * 1, w, h );
  16343. * // --E--
  16344. * camera.setViewOffset( fullWidth, fullHeight, w * 1, h * 1, w, h );
  16345. * // --F--
  16346. * camera.setViewOffset( fullWidth, fullHeight, w * 2, h * 1, w, h );
  16347. * ```
  16348. *
  16349. * Note there is no reason monitors have to be the same size or in a grid.
  16350. *
  16351. * @param {number} fullWidth - The full width of multiview setup.
  16352. * @param {number} fullHeight - The full height of multiview setup.
  16353. * @param {number} x - The horizontal offset of the subcamera.
  16354. * @param {number} y - The vertical offset of the subcamera.
  16355. * @param {number} width - The width of subcamera.
  16356. * @param {number} height - The height of subcamera.
  16357. */
  16358. setViewOffset( fullWidth, fullHeight, x, y, width, height ) {
  16359. this.aspect = fullWidth / fullHeight;
  16360. if ( this.view === null ) {
  16361. this.view = {
  16362. enabled: true,
  16363. fullWidth: 1,
  16364. fullHeight: 1,
  16365. offsetX: 0,
  16366. offsetY: 0,
  16367. width: 1,
  16368. height: 1
  16369. };
  16370. }
  16371. this.view.enabled = true;
  16372. this.view.fullWidth = fullWidth;
  16373. this.view.fullHeight = fullHeight;
  16374. this.view.offsetX = x;
  16375. this.view.offsetY = y;
  16376. this.view.width = width;
  16377. this.view.height = height;
  16378. this.updateProjectionMatrix();
  16379. }
  16380. /**
  16381. * Removes the view offset from the projection matrix.
  16382. */
  16383. clearViewOffset() {
  16384. if ( this.view !== null ) {
  16385. this.view.enabled = false;
  16386. }
  16387. this.updateProjectionMatrix();
  16388. }
  16389. /**
  16390. * Updates the camera's projection matrix. Must be called after any change of
  16391. * camera properties.
  16392. */
  16393. updateProjectionMatrix() {
  16394. const near = this.near;
  16395. let top = near * Math.tan( DEG2RAD * 0.5 * this.fov ) / this.zoom;
  16396. let height = 2 * top;
  16397. let width = this.aspect * height;
  16398. let left = -0.5 * width;
  16399. const view = this.view;
  16400. if ( this.view !== null && this.view.enabled ) {
  16401. const fullWidth = view.fullWidth,
  16402. fullHeight = view.fullHeight;
  16403. left += view.offsetX * width / fullWidth;
  16404. top -= view.offsetY * height / fullHeight;
  16405. width *= view.width / fullWidth;
  16406. height *= view.height / fullHeight;
  16407. }
  16408. const skew = this.filmOffset;
  16409. if ( skew !== 0 ) left += near * skew / this.getFilmWidth();
  16410. this.projectionMatrix.makePerspective( left, left + width, top, top - height, near, this.far, this.coordinateSystem, this.reversedDepth );
  16411. this.projectionMatrixInverse.copy( this.projectionMatrix ).invert();
  16412. }
  16413. toJSON( meta ) {
  16414. const data = super.toJSON( meta );
  16415. data.object.fov = this.fov;
  16416. data.object.zoom = this.zoom;
  16417. data.object.near = this.near;
  16418. data.object.far = this.far;
  16419. data.object.focus = this.focus;
  16420. data.object.aspect = this.aspect;
  16421. if ( this.view !== null ) data.object.view = Object.assign( {}, this.view );
  16422. data.object.filmGauge = this.filmGauge;
  16423. data.object.filmOffset = this.filmOffset;
  16424. return data;
  16425. }
  16426. }
  16427. const fov = -90; // negative fov is not an error
  16428. const aspect = 1;
  16429. /**
  16430. * A special type of camera that is positioned in 3D space to render its surroundings into a
  16431. * cube render target. The render target can then be used as an environment map for rendering
  16432. * realtime reflections in your scene.
  16433. *
  16434. * ```js
  16435. * // Create cube render target
  16436. * const cubeRenderTarget = new THREE.WebGLCubeRenderTarget( 256, { generateMipmaps: true, minFilter: THREE.LinearMipmapLinearFilter } );
  16437. *
  16438. * // Create cube camera
  16439. * const cubeCamera = new THREE.CubeCamera( 1, 100000, cubeRenderTarget );
  16440. * scene.add( cubeCamera );
  16441. *
  16442. * // Create car
  16443. * const chromeMaterial = new THREE.MeshLambertMaterial( { color: 0xffffff, envMap: cubeRenderTarget.texture } );
  16444. * const car = new THREE.Mesh( carGeometry, chromeMaterial );
  16445. * scene.add( car );
  16446. *
  16447. * // Update the render target cube
  16448. * car.visible = false;
  16449. * cubeCamera.position.copy( car.position );
  16450. * cubeCamera.update( renderer, scene );
  16451. *
  16452. * // Render the scene
  16453. * car.visible = true;
  16454. * renderer.render( scene, camera );
  16455. * ```
  16456. *
  16457. * @augments Object3D
  16458. */
  16459. class CubeCamera extends Object3D {
  16460. /**
  16461. * Constructs a new cube camera.
  16462. *
  16463. * @param {number} near - The camera's near plane.
  16464. * @param {number} far - The camera's far plane.
  16465. * @param {WebGLCubeRenderTarget} renderTarget - The cube render target.
  16466. */
  16467. constructor( near, far, renderTarget ) {
  16468. super();
  16469. this.type = 'CubeCamera';
  16470. /**
  16471. * A reference to the cube render target.
  16472. *
  16473. * @type {WebGLCubeRenderTarget}
  16474. */
  16475. this.renderTarget = renderTarget;
  16476. /**
  16477. * The current active coordinate system.
  16478. *
  16479. * @type {?(WebGLCoordinateSystem|WebGPUCoordinateSystem)}
  16480. * @default null
  16481. */
  16482. this.coordinateSystem = null;
  16483. /**
  16484. * The current active mipmap level
  16485. *
  16486. * @type {number}
  16487. * @default 0
  16488. */
  16489. this.activeMipmapLevel = 0;
  16490. const cameraPX = new PerspectiveCamera( fov, aspect, near, far );
  16491. cameraPX.layers = this.layers;
  16492. this.add( cameraPX );
  16493. const cameraNX = new PerspectiveCamera( fov, aspect, near, far );
  16494. cameraNX.layers = this.layers;
  16495. this.add( cameraNX );
  16496. const cameraPY = new PerspectiveCamera( fov, aspect, near, far );
  16497. cameraPY.layers = this.layers;
  16498. this.add( cameraPY );
  16499. const cameraNY = new PerspectiveCamera( fov, aspect, near, far );
  16500. cameraNY.layers = this.layers;
  16501. this.add( cameraNY );
  16502. const cameraPZ = new PerspectiveCamera( fov, aspect, near, far );
  16503. cameraPZ.layers = this.layers;
  16504. this.add( cameraPZ );
  16505. const cameraNZ = new PerspectiveCamera( fov, aspect, near, far );
  16506. cameraNZ.layers = this.layers;
  16507. this.add( cameraNZ );
  16508. }
  16509. /**
  16510. * Must be called when the coordinate system of the cube camera is changed.
  16511. */
  16512. updateCoordinateSystem() {
  16513. const coordinateSystem = this.coordinateSystem;
  16514. const cameras = this.children.concat();
  16515. const [ cameraPX, cameraNX, cameraPY, cameraNY, cameraPZ, cameraNZ ] = cameras;
  16516. for ( const camera of cameras ) this.remove( camera );
  16517. if ( coordinateSystem === WebGLCoordinateSystem ) {
  16518. cameraPX.up.set( 0, 1, 0 );
  16519. cameraPX.lookAt( 1, 0, 0 );
  16520. cameraNX.up.set( 0, 1, 0 );
  16521. cameraNX.lookAt( -1, 0, 0 );
  16522. cameraPY.up.set( 0, 0, -1 );
  16523. cameraPY.lookAt( 0, 1, 0 );
  16524. cameraNY.up.set( 0, 0, 1 );
  16525. cameraNY.lookAt( 0, -1, 0 );
  16526. cameraPZ.up.set( 0, 1, 0 );
  16527. cameraPZ.lookAt( 0, 0, 1 );
  16528. cameraNZ.up.set( 0, 1, 0 );
  16529. cameraNZ.lookAt( 0, 0, -1 );
  16530. } else if ( coordinateSystem === WebGPUCoordinateSystem ) {
  16531. cameraPX.up.set( 0, -1, 0 );
  16532. cameraPX.lookAt( -1, 0, 0 );
  16533. cameraNX.up.set( 0, -1, 0 );
  16534. cameraNX.lookAt( 1, 0, 0 );
  16535. cameraPY.up.set( 0, 0, 1 );
  16536. cameraPY.lookAt( 0, 1, 0 );
  16537. cameraNY.up.set( 0, 0, -1 );
  16538. cameraNY.lookAt( 0, -1, 0 );
  16539. cameraPZ.up.set( 0, -1, 0 );
  16540. cameraPZ.lookAt( 0, 0, 1 );
  16541. cameraNZ.up.set( 0, -1, 0 );
  16542. cameraNZ.lookAt( 0, 0, -1 );
  16543. } else {
  16544. throw new Error( 'THREE.CubeCamera.updateCoordinateSystem(): Invalid coordinate system: ' + coordinateSystem );
  16545. }
  16546. for ( const camera of cameras ) {
  16547. this.add( camera );
  16548. camera.updateMatrixWorld();
  16549. }
  16550. }
  16551. /**
  16552. * Calling this method will render the given scene with the given renderer
  16553. * into the cube render target of the camera.
  16554. *
  16555. * @param {(Renderer|WebGLRenderer)} renderer - The renderer.
  16556. * @param {Scene} scene - The scene to render.
  16557. */
  16558. update( renderer, scene ) {
  16559. if ( this.parent === null ) this.updateMatrixWorld();
  16560. const { renderTarget, activeMipmapLevel } = this;
  16561. if ( this.coordinateSystem !== renderer.coordinateSystem ) {
  16562. this.coordinateSystem = renderer.coordinateSystem;
  16563. this.updateCoordinateSystem();
  16564. }
  16565. const [ cameraPX, cameraNX, cameraPY, cameraNY, cameraPZ, cameraNZ ] = this.children;
  16566. const currentRenderTarget = renderer.getRenderTarget();
  16567. const currentActiveCubeFace = renderer.getActiveCubeFace();
  16568. const currentActiveMipmapLevel = renderer.getActiveMipmapLevel();
  16569. const currentXrEnabled = renderer.xr.enabled;
  16570. renderer.xr.enabled = false;
  16571. const generateMipmaps = renderTarget.texture.generateMipmaps;
  16572. renderTarget.texture.generateMipmaps = false;
  16573. renderer.setRenderTarget( renderTarget, 0, activeMipmapLevel );
  16574. renderer.render( scene, cameraPX );
  16575. renderer.setRenderTarget( renderTarget, 1, activeMipmapLevel );
  16576. renderer.render( scene, cameraNX );
  16577. renderer.setRenderTarget( renderTarget, 2, activeMipmapLevel );
  16578. renderer.render( scene, cameraPY );
  16579. renderer.setRenderTarget( renderTarget, 3, activeMipmapLevel );
  16580. renderer.render( scene, cameraNY );
  16581. renderer.setRenderTarget( renderTarget, 4, activeMipmapLevel );
  16582. renderer.render( scene, cameraPZ );
  16583. // mipmaps are generated during the last call of render()
  16584. // at this point, all sides of the cube render target are defined
  16585. renderTarget.texture.generateMipmaps = generateMipmaps;
  16586. renderer.setRenderTarget( renderTarget, 5, activeMipmapLevel );
  16587. renderer.render( scene, cameraNZ );
  16588. renderer.setRenderTarget( currentRenderTarget, currentActiveCubeFace, currentActiveMipmapLevel );
  16589. renderer.xr.enabled = currentXrEnabled;
  16590. renderTarget.texture.needsPMREMUpdate = true;
  16591. }
  16592. }
  16593. /**
  16594. * Creates a cube texture made up of six images.
  16595. *
  16596. * ```js
  16597. * const loader = new THREE.CubeTextureLoader();
  16598. * loader.setPath( 'textures/cube/pisa/' );
  16599. *
  16600. * const textureCube = loader.load( [
  16601. * 'px.png', 'nx.png', 'py.png', 'ny.png', 'pz.png', 'nz.png'
  16602. * ] );
  16603. *
  16604. * const material = new THREE.MeshBasicMaterial( { color: 0xffffff, envMap: textureCube } );
  16605. * ```
  16606. *
  16607. * @augments Texture
  16608. */
  16609. class CubeTexture extends Texture {
  16610. /**
  16611. * Constructs a new cube texture.
  16612. *
  16613. * @param {Array<Image>} [images=[]] - An array holding a image for each side of a cube.
  16614. * @param {number} [mapping=CubeReflectionMapping] - The texture mapping.
  16615. * @param {number} [wrapS=ClampToEdgeWrapping] - The wrapS value.
  16616. * @param {number} [wrapT=ClampToEdgeWrapping] - The wrapT value.
  16617. * @param {number} [magFilter=LinearFilter] - The mag filter value.
  16618. * @param {number} [minFilter=LinearMipmapLinearFilter] - The min filter value.
  16619. * @param {number} [format=RGBAFormat] - The texture format.
  16620. * @param {number} [type=UnsignedByteType] - The texture type.
  16621. * @param {number} [anisotropy=Texture.DEFAULT_ANISOTROPY] - The anisotropy value.
  16622. * @param {string} [colorSpace=NoColorSpace] - The color space value.
  16623. */
  16624. constructor( images = [], mapping = CubeReflectionMapping, wrapS, wrapT, magFilter, minFilter, format, type, anisotropy, colorSpace ) {
  16625. super( images, mapping, wrapS, wrapT, magFilter, minFilter, format, type, anisotropy, colorSpace );
  16626. /**
  16627. * This flag can be used for type testing.
  16628. *
  16629. * @type {boolean}
  16630. * @readonly
  16631. * @default true
  16632. */
  16633. this.isCubeTexture = true;
  16634. /**
  16635. * If set to `true`, the texture is flipped along the vertical axis when
  16636. * uploaded to the GPU.
  16637. *
  16638. * Overwritten and set to `false` by default.
  16639. *
  16640. * @type {boolean}
  16641. * @default false
  16642. */
  16643. this.flipY = false;
  16644. }
  16645. /**
  16646. * Alias for {@link CubeTexture#image}.
  16647. *
  16648. * @type {Array<Image>}
  16649. */
  16650. get images() {
  16651. return this.image;
  16652. }
  16653. set images( value ) {
  16654. this.image = value;
  16655. }
  16656. }
  16657. /**
  16658. * A cube render target used in context of {@link WebGLRenderer}.
  16659. *
  16660. * @augments WebGLRenderTarget
  16661. */
  16662. class WebGLCubeRenderTarget extends WebGLRenderTarget {
  16663. /**
  16664. * Constructs a new cube render target.
  16665. *
  16666. * @param {number} [size=1] - The size of the render target.
  16667. * @param {RenderTarget~Options} [options] - The configuration object.
  16668. */
  16669. constructor( size = 1, options = {} ) {
  16670. super( size, size, options );
  16671. /**
  16672. * This flag can be used for type testing.
  16673. *
  16674. * @type {boolean}
  16675. * @readonly
  16676. * @default true
  16677. */
  16678. this.isWebGLCubeRenderTarget = true;
  16679. const image = { width: size, height: size, depth: 1 };
  16680. const images = [ image, image, image, image, image, image ];
  16681. /**
  16682. * Overwritten with a different texture type.
  16683. *
  16684. * @type {DataArrayTexture}
  16685. */
  16686. this.texture = new CubeTexture( images );
  16687. this._setTextureOptions( options );
  16688. // By convention -- likely based on the RenderMan spec from the 1990's -- cube maps are specified by WebGL (and three.js)
  16689. // in a coordinate system in which positive-x is to the right when looking up the positive-z axis -- in other words,
  16690. // in a left-handed coordinate system. By continuing this convention, preexisting cube maps continued to render correctly.
  16691. // three.js uses a right-handed coordinate system. So environment maps used in three.js appear to have px and nx swapped
  16692. // and the flag isRenderTargetTexture controls this conversion. The flip is not required when using WebGLCubeRenderTarget.texture
  16693. // as a cube texture (this is detected when isRenderTargetTexture is set to true for cube textures).
  16694. this.texture.isRenderTargetTexture = true;
  16695. }
  16696. /**
  16697. * Converts the given equirectangular texture to a cube map.
  16698. *
  16699. * @param {WebGLRenderer} renderer - The renderer.
  16700. * @param {Texture} texture - The equirectangular texture.
  16701. * @return {WebGLCubeRenderTarget} A reference to this cube render target.
  16702. */
  16703. fromEquirectangularTexture( renderer, texture ) {
  16704. this.texture.type = texture.type;
  16705. this.texture.colorSpace = texture.colorSpace;
  16706. this.texture.generateMipmaps = texture.generateMipmaps;
  16707. this.texture.minFilter = texture.minFilter;
  16708. this.texture.magFilter = texture.magFilter;
  16709. const shader = {
  16710. uniforms: {
  16711. tEquirect: { value: null },
  16712. },
  16713. vertexShader: /* glsl */`
  16714. varying vec3 vWorldDirection;
  16715. vec3 transformDirection( in vec3 dir, in mat4 matrix ) {
  16716. return normalize( ( matrix * vec4( dir, 0.0 ) ).xyz );
  16717. }
  16718. void main() {
  16719. vWorldDirection = transformDirection( position, modelMatrix );
  16720. #include <begin_vertex>
  16721. #include <project_vertex>
  16722. }
  16723. `,
  16724. fragmentShader: /* glsl */`
  16725. uniform sampler2D tEquirect;
  16726. varying vec3 vWorldDirection;
  16727. #include <common>
  16728. void main() {
  16729. vec3 direction = normalize( vWorldDirection );
  16730. vec2 sampleUV = equirectUv( direction );
  16731. gl_FragColor = texture2D( tEquirect, sampleUV );
  16732. }
  16733. `
  16734. };
  16735. const geometry = new BoxGeometry( 5, 5, 5 );
  16736. const material = new ShaderMaterial( {
  16737. name: 'CubemapFromEquirect',
  16738. uniforms: cloneUniforms( shader.uniforms ),
  16739. vertexShader: shader.vertexShader,
  16740. fragmentShader: shader.fragmentShader,
  16741. side: BackSide,
  16742. blending: NoBlending
  16743. } );
  16744. material.uniforms.tEquirect.value = texture;
  16745. const mesh = new Mesh( geometry, material );
  16746. const currentMinFilter = texture.minFilter;
  16747. // Avoid blurred poles
  16748. if ( texture.minFilter === LinearMipmapLinearFilter ) texture.minFilter = LinearFilter;
  16749. const camera = new CubeCamera( 1, 10, this );
  16750. camera.update( renderer, mesh );
  16751. texture.minFilter = currentMinFilter;
  16752. mesh.geometry.dispose();
  16753. mesh.material.dispose();
  16754. return this;
  16755. }
  16756. /**
  16757. * Clears this cube render target.
  16758. *
  16759. * @param {WebGLRenderer} renderer - The renderer.
  16760. * @param {boolean} [color=true] - Whether the color buffer should be cleared or not.
  16761. * @param {boolean} [depth=true] - Whether the depth buffer should be cleared or not.
  16762. * @param {boolean} [stencil=true] - Whether the stencil buffer should be cleared or not.
  16763. */
  16764. clear( renderer, color = true, depth = true, stencil = true ) {
  16765. const currentRenderTarget = renderer.getRenderTarget();
  16766. for ( let i = 0; i < 6; i ++ ) {
  16767. renderer.setRenderTarget( this, i );
  16768. renderer.clear( color, depth, stencil );
  16769. }
  16770. renderer.setRenderTarget( currentRenderTarget );
  16771. }
  16772. }
  16773. /**
  16774. * This is almost identical to an {@link Object3D}. Its purpose is to
  16775. * make working with groups of objects syntactically clearer.
  16776. *
  16777. * ```js
  16778. * // Create a group and add the two cubes.
  16779. * // These cubes can now be rotated / scaled etc as a group.
  16780. * const group = new THREE.Group();
  16781. *
  16782. * group.add( meshA );
  16783. * group.add( meshB );
  16784. *
  16785. * scene.add( group );
  16786. * ```
  16787. *
  16788. * @augments Object3D
  16789. */
  16790. class Group extends Object3D {
  16791. constructor() {
  16792. super();
  16793. /**
  16794. * This flag can be used for type testing.
  16795. *
  16796. * @type {boolean}
  16797. * @readonly
  16798. * @default true
  16799. */
  16800. this.isGroup = true;
  16801. this.type = 'Group';
  16802. }
  16803. }
  16804. const _moveEvent = { type: 'move' };
  16805. /**
  16806. * Class for representing a XR controller with its
  16807. * different coordinate systems.
  16808. *
  16809. * @private
  16810. */
  16811. class WebXRController {
  16812. /**
  16813. * Constructs a new XR controller.
  16814. */
  16815. constructor() {
  16816. /**
  16817. * A group representing the target ray space
  16818. * of the XR controller.
  16819. *
  16820. * @private
  16821. * @type {?Group}
  16822. * @default null
  16823. */
  16824. this._targetRay = null;
  16825. /**
  16826. * A group representing the grip space
  16827. * of the XR controller.
  16828. *
  16829. * @private
  16830. * @type {?Group}
  16831. * @default null
  16832. */
  16833. this._grip = null;
  16834. /**
  16835. * A group representing the hand space
  16836. * of the XR controller.
  16837. *
  16838. * @private
  16839. * @type {?Group}
  16840. * @default null
  16841. */
  16842. this._hand = null;
  16843. }
  16844. /**
  16845. * Returns a group representing the hand space of the XR controller.
  16846. *
  16847. * @return {Group} A group representing the hand space of the XR controller.
  16848. */
  16849. getHandSpace() {
  16850. if ( this._hand === null ) {
  16851. this._hand = new Group();
  16852. this._hand.matrixAutoUpdate = false;
  16853. this._hand.visible = false;
  16854. this._hand.joints = {};
  16855. this._hand.inputState = { pinching: false };
  16856. }
  16857. return this._hand;
  16858. }
  16859. /**
  16860. * Returns a group representing the target ray space of the XR controller.
  16861. *
  16862. * @return {Group} A group representing the target ray space of the XR controller.
  16863. */
  16864. getTargetRaySpace() {
  16865. if ( this._targetRay === null ) {
  16866. this._targetRay = new Group();
  16867. this._targetRay.matrixAutoUpdate = false;
  16868. this._targetRay.visible = false;
  16869. this._targetRay.hasLinearVelocity = false;
  16870. this._targetRay.linearVelocity = new Vector3();
  16871. this._targetRay.hasAngularVelocity = false;
  16872. this._targetRay.angularVelocity = new Vector3();
  16873. }
  16874. return this._targetRay;
  16875. }
  16876. /**
  16877. * Returns a group representing the grip space of the XR controller.
  16878. *
  16879. * @return {Group} A group representing the grip space of the XR controller.
  16880. */
  16881. getGripSpace() {
  16882. if ( this._grip === null ) {
  16883. this._grip = new Group();
  16884. this._grip.matrixAutoUpdate = false;
  16885. this._grip.visible = false;
  16886. this._grip.hasLinearVelocity = false;
  16887. this._grip.linearVelocity = new Vector3();
  16888. this._grip.hasAngularVelocity = false;
  16889. this._grip.angularVelocity = new Vector3();
  16890. }
  16891. return this._grip;
  16892. }
  16893. /**
  16894. * Dispatches the given event to the groups representing
  16895. * the different coordinate spaces of the XR controller.
  16896. *
  16897. * @param {Object} event - The event to dispatch.
  16898. * @return {WebXRController} A reference to this instance.
  16899. */
  16900. dispatchEvent( event ) {
  16901. if ( this._targetRay !== null ) {
  16902. this._targetRay.dispatchEvent( event );
  16903. }
  16904. if ( this._grip !== null ) {
  16905. this._grip.dispatchEvent( event );
  16906. }
  16907. if ( this._hand !== null ) {
  16908. this._hand.dispatchEvent( event );
  16909. }
  16910. return this;
  16911. }
  16912. /**
  16913. * Connects the controller with the given XR input source.
  16914. *
  16915. * @param {XRInputSource} inputSource - The input source.
  16916. * @return {WebXRController} A reference to this instance.
  16917. */
  16918. connect( inputSource ) {
  16919. if ( inputSource && inputSource.hand ) {
  16920. const hand = this._hand;
  16921. if ( hand ) {
  16922. for ( const inputjoint of inputSource.hand.values() ) {
  16923. // Initialize hand with joints when connected
  16924. this._getHandJoint( hand, inputjoint );
  16925. }
  16926. }
  16927. }
  16928. this.dispatchEvent( { type: 'connected', data: inputSource } );
  16929. return this;
  16930. }
  16931. /**
  16932. * Disconnects the controller from the given XR input source.
  16933. *
  16934. * @param {XRInputSource} inputSource - The input source.
  16935. * @return {WebXRController} A reference to this instance.
  16936. */
  16937. disconnect( inputSource ) {
  16938. this.dispatchEvent( { type: 'disconnected', data: inputSource } );
  16939. if ( this._targetRay !== null ) {
  16940. this._targetRay.visible = false;
  16941. }
  16942. if ( this._grip !== null ) {
  16943. this._grip.visible = false;
  16944. }
  16945. if ( this._hand !== null ) {
  16946. this._hand.visible = false;
  16947. }
  16948. return this;
  16949. }
  16950. /**
  16951. * Updates the controller with the given input source, XR frame and reference space.
  16952. * This updates the transformations of the groups that represent the different
  16953. * coordinate systems of the controller.
  16954. *
  16955. * @param {XRInputSource} inputSource - The input source.
  16956. * @param {XRFrame} frame - The XR frame.
  16957. * @param {XRReferenceSpace} referenceSpace - The reference space.
  16958. * @return {WebXRController} A reference to this instance.
  16959. */
  16960. update( inputSource, frame, referenceSpace ) {
  16961. let inputPose = null;
  16962. let gripPose = null;
  16963. let handPose = null;
  16964. const targetRay = this._targetRay;
  16965. const grip = this._grip;
  16966. const hand = this._hand;
  16967. if ( inputSource && frame.session.visibilityState !== 'visible-blurred' ) {
  16968. if ( hand && inputSource.hand ) {
  16969. handPose = true;
  16970. for ( const inputjoint of inputSource.hand.values() ) {
  16971. // Update the joints groups with the XRJoint poses
  16972. const jointPose = frame.getJointPose( inputjoint, referenceSpace );
  16973. // The transform of this joint will be updated with the joint pose on each frame
  16974. const joint = this._getHandJoint( hand, inputjoint );
  16975. if ( jointPose !== null ) {
  16976. joint.matrix.fromArray( jointPose.transform.matrix );
  16977. joint.matrix.decompose( joint.position, joint.rotation, joint.scale );
  16978. joint.matrixWorldNeedsUpdate = true;
  16979. joint.jointRadius = jointPose.radius;
  16980. }
  16981. joint.visible = jointPose !== null;
  16982. }
  16983. // Custom events
  16984. // Check pinchz
  16985. const indexTip = hand.joints[ 'index-finger-tip' ];
  16986. const thumbTip = hand.joints[ 'thumb-tip' ];
  16987. const distance = indexTip.position.distanceTo( thumbTip.position );
  16988. const distanceToPinch = 0.02;
  16989. const threshold = 0.005;
  16990. if ( hand.inputState.pinching && distance > distanceToPinch + threshold ) {
  16991. hand.inputState.pinching = false;
  16992. this.dispatchEvent( {
  16993. type: 'pinchend',
  16994. handedness: inputSource.handedness,
  16995. target: this
  16996. } );
  16997. } else if ( ! hand.inputState.pinching && distance <= distanceToPinch - threshold ) {
  16998. hand.inputState.pinching = true;
  16999. this.dispatchEvent( {
  17000. type: 'pinchstart',
  17001. handedness: inputSource.handedness,
  17002. target: this
  17003. } );
  17004. }
  17005. } else {
  17006. if ( grip !== null && inputSource.gripSpace ) {
  17007. gripPose = frame.getPose( inputSource.gripSpace, referenceSpace );
  17008. if ( gripPose !== null ) {
  17009. grip.matrix.fromArray( gripPose.transform.matrix );
  17010. grip.matrix.decompose( grip.position, grip.rotation, grip.scale );
  17011. grip.matrixWorldNeedsUpdate = true;
  17012. if ( gripPose.linearVelocity ) {
  17013. grip.hasLinearVelocity = true;
  17014. grip.linearVelocity.copy( gripPose.linearVelocity );
  17015. } else {
  17016. grip.hasLinearVelocity = false;
  17017. }
  17018. if ( gripPose.angularVelocity ) {
  17019. grip.hasAngularVelocity = true;
  17020. grip.angularVelocity.copy( gripPose.angularVelocity );
  17021. } else {
  17022. grip.hasAngularVelocity = false;
  17023. }
  17024. }
  17025. }
  17026. }
  17027. if ( targetRay !== null ) {
  17028. inputPose = frame.getPose( inputSource.targetRaySpace, referenceSpace );
  17029. // Some runtimes (namely Vive Cosmos with Vive OpenXR Runtime) have only grip space and ray space is equal to it
  17030. if ( inputPose === null && gripPose !== null ) {
  17031. inputPose = gripPose;
  17032. }
  17033. if ( inputPose !== null ) {
  17034. targetRay.matrix.fromArray( inputPose.transform.matrix );
  17035. targetRay.matrix.decompose( targetRay.position, targetRay.rotation, targetRay.scale );
  17036. targetRay.matrixWorldNeedsUpdate = true;
  17037. if ( inputPose.linearVelocity ) {
  17038. targetRay.hasLinearVelocity = true;
  17039. targetRay.linearVelocity.copy( inputPose.linearVelocity );
  17040. } else {
  17041. targetRay.hasLinearVelocity = false;
  17042. }
  17043. if ( inputPose.angularVelocity ) {
  17044. targetRay.hasAngularVelocity = true;
  17045. targetRay.angularVelocity.copy( inputPose.angularVelocity );
  17046. } else {
  17047. targetRay.hasAngularVelocity = false;
  17048. }
  17049. this.dispatchEvent( _moveEvent );
  17050. }
  17051. }
  17052. }
  17053. if ( targetRay !== null ) {
  17054. targetRay.visible = ( inputPose !== null );
  17055. }
  17056. if ( grip !== null ) {
  17057. grip.visible = ( gripPose !== null );
  17058. }
  17059. if ( hand !== null ) {
  17060. hand.visible = ( handPose !== null );
  17061. }
  17062. return this;
  17063. }
  17064. /**
  17065. * Returns a group representing the hand joint for the given input joint.
  17066. *
  17067. * @private
  17068. * @param {Group} hand - The group representing the hand space.
  17069. * @param {XRJointSpace} inputjoint - The hand joint data.
  17070. * @return {Group} A group representing the hand joint for the given input joint.
  17071. */
  17072. _getHandJoint( hand, inputjoint ) {
  17073. if ( hand.joints[ inputjoint.jointName ] === undefined ) {
  17074. const joint = new Group();
  17075. joint.matrixAutoUpdate = false;
  17076. joint.visible = false;
  17077. hand.joints[ inputjoint.jointName ] = joint;
  17078. hand.add( joint );
  17079. }
  17080. return hand.joints[ inputjoint.jointName ];
  17081. }
  17082. }
  17083. /**
  17084. * This class can be used to define an exponential squared fog,
  17085. * which gives a clear view near the camera and a faster than exponentially
  17086. * densening fog farther from the camera.
  17087. *
  17088. * ```js
  17089. * const scene = new THREE.Scene();
  17090. * scene.fog = new THREE.FogExp2( 0xcccccc, 0.002 );
  17091. * ```
  17092. */
  17093. class FogExp2 {
  17094. /**
  17095. * Constructs a new fog.
  17096. *
  17097. * @param {number|Color} color - The fog's color.
  17098. * @param {number} [density=0.00025] - Defines how fast the fog will grow dense.
  17099. */
  17100. constructor( color, density = 0.00025 ) {
  17101. /**
  17102. * This flag can be used for type testing.
  17103. *
  17104. * @type {boolean}
  17105. * @readonly
  17106. * @default true
  17107. */
  17108. this.isFogExp2 = true;
  17109. /**
  17110. * The name of the fog.
  17111. *
  17112. * @type {string}
  17113. */
  17114. this.name = '';
  17115. /**
  17116. * The fog's color.
  17117. *
  17118. * @type {Color}
  17119. */
  17120. this.color = new Color( color );
  17121. /**
  17122. * Defines how fast the fog will grow dense.
  17123. *
  17124. * @type {number}
  17125. * @default 0.00025
  17126. */
  17127. this.density = density;
  17128. }
  17129. /**
  17130. * Returns a new fog with copied values from this instance.
  17131. *
  17132. * @return {FogExp2} A clone of this instance.
  17133. */
  17134. clone() {
  17135. return new FogExp2( this.color, this.density );
  17136. }
  17137. /**
  17138. * Serializes the fog into JSON.
  17139. *
  17140. * @param {?(Object|string)} meta - An optional value holding meta information about the serialization.
  17141. * @return {Object} A JSON object representing the serialized fog
  17142. */
  17143. toJSON( /* meta */ ) {
  17144. return {
  17145. type: 'FogExp2',
  17146. name: this.name,
  17147. color: this.color.getHex(),
  17148. density: this.density
  17149. };
  17150. }
  17151. }
  17152. /**
  17153. * This class can be used to define a linear fog that grows linearly denser
  17154. * with the distance.
  17155. *
  17156. * ```js
  17157. * const scene = new THREE.Scene();
  17158. * scene.fog = new THREE.Fog( 0xcccccc, 10, 15 );
  17159. * ```
  17160. */
  17161. class Fog {
  17162. /**
  17163. * Constructs a new fog.
  17164. *
  17165. * @param {number|Color} color - The fog's color.
  17166. * @param {number} [near=1] - The minimum distance to start applying fog.
  17167. * @param {number} [far=1000] - The maximum distance at which fog stops being calculated and applied.
  17168. */
  17169. constructor( color, near = 1, far = 1000 ) {
  17170. /**
  17171. * This flag can be used for type testing.
  17172. *
  17173. * @type {boolean}
  17174. * @readonly
  17175. * @default true
  17176. */
  17177. this.isFog = true;
  17178. /**
  17179. * The name of the fog.
  17180. *
  17181. * @type {string}
  17182. */
  17183. this.name = '';
  17184. /**
  17185. * The fog's color.
  17186. *
  17187. * @type {Color}
  17188. */
  17189. this.color = new Color( color );
  17190. /**
  17191. * The minimum distance to start applying fog. Objects that are less than
  17192. * `near` units from the active camera won't be affected by fog.
  17193. *
  17194. * @type {number}
  17195. * @default 1
  17196. */
  17197. this.near = near;
  17198. /**
  17199. * The maximum distance at which fog stops being calculated and applied.
  17200. * Objects that are more than `far` units away from the active camera won't
  17201. * be affected by fog.
  17202. *
  17203. * @type {number}
  17204. * @default 1000
  17205. */
  17206. this.far = far;
  17207. }
  17208. /**
  17209. * Returns a new fog with copied values from this instance.
  17210. *
  17211. * @return {Fog} A clone of this instance.
  17212. */
  17213. clone() {
  17214. return new Fog( this.color, this.near, this.far );
  17215. }
  17216. /**
  17217. * Serializes the fog into JSON.
  17218. *
  17219. * @param {?(Object|string)} meta - An optional value holding meta information about the serialization.
  17220. * @return {Object} A JSON object representing the serialized fog
  17221. */
  17222. toJSON( /* meta */ ) {
  17223. return {
  17224. type: 'Fog',
  17225. name: this.name,
  17226. color: this.color.getHex(),
  17227. near: this.near,
  17228. far: this.far
  17229. };
  17230. }
  17231. }
  17232. /**
  17233. * Scenes allow you to set up what is to be rendered and where by three.js.
  17234. * This is where you place 3D objects like meshes, lines or lights.
  17235. *
  17236. * @augments Object3D
  17237. */
  17238. class Scene extends Object3D {
  17239. /**
  17240. * Constructs a new scene.
  17241. */
  17242. constructor() {
  17243. super();
  17244. /**
  17245. * This flag can be used for type testing.
  17246. *
  17247. * @type {boolean}
  17248. * @readonly
  17249. * @default true
  17250. */
  17251. this.isScene = true;
  17252. this.type = 'Scene';
  17253. /**
  17254. * Defines the background of the scene. Valid inputs are:
  17255. *
  17256. * - A color for defining a uniform colored background.
  17257. * - A texture for defining a (flat) textured background.
  17258. * - Cube textures or equirectangular textures for defining a skybox.
  17259. *
  17260. * @type {?(Color|Texture)}
  17261. * @default null
  17262. */
  17263. this.background = null;
  17264. /**
  17265. * Sets the environment map for all physical materials in the scene. However,
  17266. * it's not possible to overwrite an existing texture assigned to the `envMap`
  17267. * material property.
  17268. *
  17269. * @type {?Texture}
  17270. * @default null
  17271. */
  17272. this.environment = null;
  17273. /**
  17274. * A fog instance defining the type of fog that affects everything
  17275. * rendered in the scene.
  17276. *
  17277. * @type {?(Fog|FogExp2)}
  17278. * @default null
  17279. */
  17280. this.fog = null;
  17281. /**
  17282. * Sets the blurriness of the background. Only influences environment maps
  17283. * assigned to {@link Scene#background}. Valid input is a float between `0`
  17284. * and `1`.
  17285. *
  17286. * @type {number}
  17287. * @default 0
  17288. */
  17289. this.backgroundBlurriness = 0;
  17290. /**
  17291. * Attenuates the color of the background. Only applies to background textures.
  17292. *
  17293. * @type {number}
  17294. * @default 1
  17295. */
  17296. this.backgroundIntensity = 1;
  17297. /**
  17298. * The rotation of the background in radians. Only influences environment maps
  17299. * assigned to {@link Scene#background}.
  17300. *
  17301. * @type {Euler}
  17302. * @default (0,0,0)
  17303. */
  17304. this.backgroundRotation = new Euler();
  17305. /**
  17306. * Attenuates the color of the environment. Only influences environment maps
  17307. * assigned to {@link Scene#environment}.
  17308. *
  17309. * @type {number}
  17310. * @default 1
  17311. */
  17312. this.environmentIntensity = 1;
  17313. /**
  17314. * The rotation of the environment map in radians. Only influences physical materials
  17315. * in the scene when {@link Scene#environment} is used.
  17316. *
  17317. * @type {Euler}
  17318. * @default (0,0,0)
  17319. */
  17320. this.environmentRotation = new Euler();
  17321. /**
  17322. * Forces everything in the scene to be rendered with the defined material. It is possible
  17323. * to exclude materials from override by setting {@link Material#allowOverride} to `false`.
  17324. *
  17325. * @type {?Material}
  17326. * @default null
  17327. */
  17328. this.overrideMaterial = null;
  17329. if ( typeof __THREE_DEVTOOLS__ !== 'undefined' ) {
  17330. __THREE_DEVTOOLS__.dispatchEvent( new CustomEvent( 'observe', { detail: this } ) );
  17331. }
  17332. }
  17333. copy( source, recursive ) {
  17334. super.copy( source, recursive );
  17335. if ( source.background !== null ) this.background = source.background.clone();
  17336. if ( source.environment !== null ) this.environment = source.environment.clone();
  17337. if ( source.fog !== null ) this.fog = source.fog.clone();
  17338. this.backgroundBlurriness = source.backgroundBlurriness;
  17339. this.backgroundIntensity = source.backgroundIntensity;
  17340. this.backgroundRotation.copy( source.backgroundRotation );
  17341. this.environmentIntensity = source.environmentIntensity;
  17342. this.environmentRotation.copy( source.environmentRotation );
  17343. if ( source.overrideMaterial !== null ) this.overrideMaterial = source.overrideMaterial.clone();
  17344. this.matrixAutoUpdate = source.matrixAutoUpdate;
  17345. return this;
  17346. }
  17347. toJSON( meta ) {
  17348. const data = super.toJSON( meta );
  17349. if ( this.fog !== null ) data.object.fog = this.fog.toJSON();
  17350. if ( this.backgroundBlurriness > 0 ) data.object.backgroundBlurriness = this.backgroundBlurriness;
  17351. if ( this.backgroundIntensity !== 1 ) data.object.backgroundIntensity = this.backgroundIntensity;
  17352. data.object.backgroundRotation = this.backgroundRotation.toArray();
  17353. if ( this.environmentIntensity !== 1 ) data.object.environmentIntensity = this.environmentIntensity;
  17354. data.object.environmentRotation = this.environmentRotation.toArray();
  17355. return data;
  17356. }
  17357. }
  17358. /**
  17359. * "Interleaved" means that multiple attributes, possibly of different types,
  17360. * (e.g., position, normal, uv, color) are packed into a single array buffer.
  17361. *
  17362. * An introduction into interleaved arrays can be found here: [Interleaved array basics](https://blog.tojicode.com/2011/05/interleaved-array-basics.html)
  17363. */
  17364. class InterleavedBuffer {
  17365. /**
  17366. * Constructs a new interleaved buffer.
  17367. *
  17368. * @param {TypedArray} array - A typed array with a shared buffer storing attribute data.
  17369. * @param {number} stride - The number of typed-array elements per vertex.
  17370. */
  17371. constructor( array, stride ) {
  17372. /**
  17373. * This flag can be used for type testing.
  17374. *
  17375. * @type {boolean}
  17376. * @readonly
  17377. * @default true
  17378. */
  17379. this.isInterleavedBuffer = true;
  17380. /**
  17381. * A typed array with a shared buffer storing attribute data.
  17382. *
  17383. * @type {TypedArray}
  17384. */
  17385. this.array = array;
  17386. /**
  17387. * The number of typed-array elements per vertex.
  17388. *
  17389. * @type {number}
  17390. */
  17391. this.stride = stride;
  17392. /**
  17393. * The total number of elements in the array
  17394. *
  17395. * @type {number}
  17396. * @readonly
  17397. */
  17398. this.count = array !== undefined ? array.length / stride : 0;
  17399. /**
  17400. * Defines the intended usage pattern of the data store for optimization purposes.
  17401. *
  17402. * Note: After the initial use of a buffer, its usage cannot be changed. Instead,
  17403. * instantiate a new one and set the desired usage before the next render.
  17404. *
  17405. * @type {(StaticDrawUsage|DynamicDrawUsage|StreamDrawUsage|StaticReadUsage|DynamicReadUsage|StreamReadUsage|StaticCopyUsage|DynamicCopyUsage|StreamCopyUsage)}
  17406. * @default StaticDrawUsage
  17407. */
  17408. this.usage = StaticDrawUsage;
  17409. /**
  17410. * This can be used to only update some components of stored vectors (for example, just the
  17411. * component related to color). Use the `addUpdateRange()` function to add ranges to this array.
  17412. *
  17413. * @type {Array<Object>}
  17414. */
  17415. this.updateRanges = [];
  17416. /**
  17417. * A version number, incremented every time the `needsUpdate` is set to `true`.
  17418. *
  17419. * @type {number}
  17420. */
  17421. this.version = 0;
  17422. /**
  17423. * The UUID of the interleaved buffer.
  17424. *
  17425. * @type {string}
  17426. * @readonly
  17427. */
  17428. this.uuid = generateUUID();
  17429. }
  17430. /**
  17431. * A callback function that is executed after the renderer has transferred the attribute array
  17432. * data to the GPU.
  17433. */
  17434. onUploadCallback() {}
  17435. /**
  17436. * Flag to indicate that this attribute has changed and should be re-sent to
  17437. * the GPU. Set this to `true` when you modify the value of the array.
  17438. *
  17439. * @type {number}
  17440. * @default false
  17441. * @param {boolean} value
  17442. */
  17443. set needsUpdate( value ) {
  17444. if ( value === true ) this.version ++;
  17445. }
  17446. /**
  17447. * Sets the usage of this interleaved buffer.
  17448. *
  17449. * @param {(StaticDrawUsage|DynamicDrawUsage|StreamDrawUsage|StaticReadUsage|DynamicReadUsage|StreamReadUsage|StaticCopyUsage|DynamicCopyUsage|StreamCopyUsage)} value - The usage to set.
  17450. * @return {InterleavedBuffer} A reference to this interleaved buffer.
  17451. */
  17452. setUsage( value ) {
  17453. this.usage = value;
  17454. return this;
  17455. }
  17456. /**
  17457. * Adds a range of data in the data array to be updated on the GPU.
  17458. *
  17459. * @param {number} start - Position at which to start update.
  17460. * @param {number} count - The number of components to update.
  17461. */
  17462. addUpdateRange( start, count ) {
  17463. this.updateRanges.push( { start, count } );
  17464. }
  17465. /**
  17466. * Clears the update ranges.
  17467. */
  17468. clearUpdateRanges() {
  17469. this.updateRanges.length = 0;
  17470. }
  17471. /**
  17472. * Copies the values of the given interleaved buffer to this instance.
  17473. *
  17474. * @param {InterleavedBuffer} source - The interleaved buffer to copy.
  17475. * @return {InterleavedBuffer} A reference to this instance.
  17476. */
  17477. copy( source ) {
  17478. this.array = new source.array.constructor( source.array );
  17479. this.count = source.count;
  17480. this.stride = source.stride;
  17481. this.usage = source.usage;
  17482. return this;
  17483. }
  17484. /**
  17485. * Copies a vector from the given interleaved buffer to this one. The start
  17486. * and destination position in the attribute buffers are represented by the
  17487. * given indices.
  17488. *
  17489. * @param {number} index1 - The destination index into this interleaved buffer.
  17490. * @param {InterleavedBuffer} interleavedBuffer - The interleaved buffer to copy from.
  17491. * @param {number} index2 - The source index into the given interleaved buffer.
  17492. * @return {InterleavedBuffer} A reference to this instance.
  17493. */
  17494. copyAt( index1, interleavedBuffer, index2 ) {
  17495. index1 *= this.stride;
  17496. index2 *= interleavedBuffer.stride;
  17497. for ( let i = 0, l = this.stride; i < l; i ++ ) {
  17498. this.array[ index1 + i ] = interleavedBuffer.array[ index2 + i ];
  17499. }
  17500. return this;
  17501. }
  17502. /**
  17503. * Sets the given array data in the interleaved buffer.
  17504. *
  17505. * @param {(TypedArray|Array)} value - The array data to set.
  17506. * @param {number} [offset=0] - The offset in this interleaved buffer's array.
  17507. * @return {InterleavedBuffer} A reference to this instance.
  17508. */
  17509. set( value, offset = 0 ) {
  17510. this.array.set( value, offset );
  17511. return this;
  17512. }
  17513. /**
  17514. * Returns a new interleaved buffer with copied values from this instance.
  17515. *
  17516. * @param {Object} [data] - An object with shared array buffers that allows to retain shared structures.
  17517. * @return {InterleavedBuffer} A clone of this instance.
  17518. */
  17519. clone( data ) {
  17520. if ( data.arrayBuffers === undefined ) {
  17521. data.arrayBuffers = {};
  17522. }
  17523. if ( this.array.buffer._uuid === undefined ) {
  17524. this.array.buffer._uuid = generateUUID();
  17525. }
  17526. if ( data.arrayBuffers[ this.array.buffer._uuid ] === undefined ) {
  17527. data.arrayBuffers[ this.array.buffer._uuid ] = this.array.slice( 0 ).buffer;
  17528. }
  17529. const array = new this.array.constructor( data.arrayBuffers[ this.array.buffer._uuid ] );
  17530. const ib = new this.constructor( array, this.stride );
  17531. ib.setUsage( this.usage );
  17532. return ib;
  17533. }
  17534. /**
  17535. * Sets the given callback function that is executed after the Renderer has transferred
  17536. * the array data to the GPU. Can be used to perform clean-up operations after
  17537. * the upload when data are not needed anymore on the CPU side.
  17538. *
  17539. * @param {Function} callback - The `onUpload()` callback.
  17540. * @return {InterleavedBuffer} A reference to this instance.
  17541. */
  17542. onUpload( callback ) {
  17543. this.onUploadCallback = callback;
  17544. return this;
  17545. }
  17546. /**
  17547. * Serializes the interleaved buffer into JSON.
  17548. *
  17549. * @param {Object} [data] - An optional value holding meta information about the serialization.
  17550. * @return {Object} A JSON object representing the serialized interleaved buffer.
  17551. */
  17552. toJSON( data ) {
  17553. if ( data.arrayBuffers === undefined ) {
  17554. data.arrayBuffers = {};
  17555. }
  17556. // generate UUID for array buffer if necessary
  17557. if ( this.array.buffer._uuid === undefined ) {
  17558. this.array.buffer._uuid = generateUUID();
  17559. }
  17560. if ( data.arrayBuffers[ this.array.buffer._uuid ] === undefined ) {
  17561. data.arrayBuffers[ this.array.buffer._uuid ] = Array.from( new Uint32Array( this.array.buffer ) );
  17562. }
  17563. //
  17564. return {
  17565. uuid: this.uuid,
  17566. buffer: this.array.buffer._uuid,
  17567. type: this.array.constructor.name,
  17568. stride: this.stride
  17569. };
  17570. }
  17571. }
  17572. const _vector$7 = /*@__PURE__*/ new Vector3();
  17573. /**
  17574. * An alternative version of a buffer attribute with interleaved data. Interleaved
  17575. * attributes share a common interleaved data storage ({@link InterleavedBuffer}) and refer with
  17576. * different offsets into the buffer.
  17577. */
  17578. class InterleavedBufferAttribute {
  17579. /**
  17580. * Constructs a new interleaved buffer attribute.
  17581. *
  17582. * @param {InterleavedBuffer} interleavedBuffer - The buffer holding the interleaved data.
  17583. * @param {number} itemSize - The item size.
  17584. * @param {number} offset - The attribute offset into the buffer.
  17585. * @param {boolean} [normalized=false] - Whether the data are normalized or not.
  17586. */
  17587. constructor( interleavedBuffer, itemSize, offset, normalized = false ) {
  17588. /**
  17589. * This flag can be used for type testing.
  17590. *
  17591. * @type {boolean}
  17592. * @readonly
  17593. * @default true
  17594. */
  17595. this.isInterleavedBufferAttribute = true;
  17596. /**
  17597. * The name of the buffer attribute.
  17598. *
  17599. * @type {string}
  17600. */
  17601. this.name = '';
  17602. /**
  17603. * The buffer holding the interleaved data.
  17604. *
  17605. * @type {InterleavedBuffer}
  17606. */
  17607. this.data = interleavedBuffer;
  17608. /**
  17609. * The item size, see {@link BufferAttribute#itemSize}.
  17610. *
  17611. * @type {number}
  17612. */
  17613. this.itemSize = itemSize;
  17614. /**
  17615. * The attribute offset into the buffer.
  17616. *
  17617. * @type {number}
  17618. */
  17619. this.offset = offset;
  17620. /**
  17621. * Whether the data are normalized or not, see {@link BufferAttribute#normalized}
  17622. *
  17623. * @type {InterleavedBuffer}
  17624. */
  17625. this.normalized = normalized;
  17626. }
  17627. /**
  17628. * The item count of this buffer attribute.
  17629. *
  17630. * @type {number}
  17631. * @readonly
  17632. */
  17633. get count() {
  17634. return this.data.count;
  17635. }
  17636. /**
  17637. * The array holding the interleaved buffer attribute data.
  17638. *
  17639. * @type {TypedArray}
  17640. */
  17641. get array() {
  17642. return this.data.array;
  17643. }
  17644. /**
  17645. * Flag to indicate that this attribute has changed and should be re-sent to
  17646. * the GPU. Set this to `true` when you modify the value of the array.
  17647. *
  17648. * @type {number}
  17649. * @default false
  17650. * @param {boolean} value
  17651. */
  17652. set needsUpdate( value ) {
  17653. this.data.needsUpdate = value;
  17654. }
  17655. /**
  17656. * Applies the given 4x4 matrix to the given attribute. Only works with
  17657. * item size `3`.
  17658. *
  17659. * @param {Matrix4} m - The matrix to apply.
  17660. * @return {InterleavedBufferAttribute} A reference to this instance.
  17661. */
  17662. applyMatrix4( m ) {
  17663. for ( let i = 0, l = this.data.count; i < l; i ++ ) {
  17664. _vector$7.fromBufferAttribute( this, i );
  17665. _vector$7.applyMatrix4( m );
  17666. this.setXYZ( i, _vector$7.x, _vector$7.y, _vector$7.z );
  17667. }
  17668. return this;
  17669. }
  17670. /**
  17671. * Applies the given 3x3 normal matrix to the given attribute. Only works with
  17672. * item size `3`.
  17673. *
  17674. * @param {Matrix3} m - The normal matrix to apply.
  17675. * @return {InterleavedBufferAttribute} A reference to this instance.
  17676. */
  17677. applyNormalMatrix( m ) {
  17678. for ( let i = 0, l = this.count; i < l; i ++ ) {
  17679. _vector$7.fromBufferAttribute( this, i );
  17680. _vector$7.applyNormalMatrix( m );
  17681. this.setXYZ( i, _vector$7.x, _vector$7.y, _vector$7.z );
  17682. }
  17683. return this;
  17684. }
  17685. /**
  17686. * Applies the given 4x4 matrix to the given attribute. Only works with
  17687. * item size `3` and with direction vectors.
  17688. *
  17689. * @param {Matrix4} m - The matrix to apply.
  17690. * @return {InterleavedBufferAttribute} A reference to this instance.
  17691. */
  17692. transformDirection( m ) {
  17693. for ( let i = 0, l = this.count; i < l; i ++ ) {
  17694. _vector$7.fromBufferAttribute( this, i );
  17695. _vector$7.transformDirection( m );
  17696. this.setXYZ( i, _vector$7.x, _vector$7.y, _vector$7.z );
  17697. }
  17698. return this;
  17699. }
  17700. /**
  17701. * Returns the given component of the vector at the given index.
  17702. *
  17703. * @param {number} index - The index into the buffer attribute.
  17704. * @param {number} component - The component index.
  17705. * @return {number} The returned value.
  17706. */
  17707. getComponent( index, component ) {
  17708. let value = this.array[ index * this.data.stride + this.offset + component ];
  17709. if ( this.normalized ) value = denormalize( value, this.array );
  17710. return value;
  17711. }
  17712. /**
  17713. * Sets the given value to the given component of the vector at the given index.
  17714. *
  17715. * @param {number} index - The index into the buffer attribute.
  17716. * @param {number} component - The component index.
  17717. * @param {number} value - The value to set.
  17718. * @return {InterleavedBufferAttribute} A reference to this instance.
  17719. */
  17720. setComponent( index, component, value ) {
  17721. if ( this.normalized ) value = normalize( value, this.array );
  17722. this.data.array[ index * this.data.stride + this.offset + component ] = value;
  17723. return this;
  17724. }
  17725. /**
  17726. * Sets the x component of the vector at the given index.
  17727. *
  17728. * @param {number} index - The index into the buffer attribute.
  17729. * @param {number} x - The value to set.
  17730. * @return {InterleavedBufferAttribute} A reference to this instance.
  17731. */
  17732. setX( index, x ) {
  17733. if ( this.normalized ) x = normalize( x, this.array );
  17734. this.data.array[ index * this.data.stride + this.offset ] = x;
  17735. return this;
  17736. }
  17737. /**
  17738. * Sets the y component of the vector at the given index.
  17739. *
  17740. * @param {number} index - The index into the buffer attribute.
  17741. * @param {number} y - The value to set.
  17742. * @return {InterleavedBufferAttribute} A reference to this instance.
  17743. */
  17744. setY( index, y ) {
  17745. if ( this.normalized ) y = normalize( y, this.array );
  17746. this.data.array[ index * this.data.stride + this.offset + 1 ] = y;
  17747. return this;
  17748. }
  17749. /**
  17750. * Sets the z component of the vector at the given index.
  17751. *
  17752. * @param {number} index - The index into the buffer attribute.
  17753. * @param {number} z - The value to set.
  17754. * @return {InterleavedBufferAttribute} A reference to this instance.
  17755. */
  17756. setZ( index, z ) {
  17757. if ( this.normalized ) z = normalize( z, this.array );
  17758. this.data.array[ index * this.data.stride + this.offset + 2 ] = z;
  17759. return this;
  17760. }
  17761. /**
  17762. * Sets the w component of the vector at the given index.
  17763. *
  17764. * @param {number} index - The index into the buffer attribute.
  17765. * @param {number} w - The value to set.
  17766. * @return {InterleavedBufferAttribute} A reference to this instance.
  17767. */
  17768. setW( index, w ) {
  17769. if ( this.normalized ) w = normalize( w, this.array );
  17770. this.data.array[ index * this.data.stride + this.offset + 3 ] = w;
  17771. return this;
  17772. }
  17773. /**
  17774. * Returns the x component of the vector at the given index.
  17775. *
  17776. * @param {number} index - The index into the buffer attribute.
  17777. * @return {number} The x component.
  17778. */
  17779. getX( index ) {
  17780. let x = this.data.array[ index * this.data.stride + this.offset ];
  17781. if ( this.normalized ) x = denormalize( x, this.array );
  17782. return x;
  17783. }
  17784. /**
  17785. * Returns the y component of the vector at the given index.
  17786. *
  17787. * @param {number} index - The index into the buffer attribute.
  17788. * @return {number} The y component.
  17789. */
  17790. getY( index ) {
  17791. let y = this.data.array[ index * this.data.stride + this.offset + 1 ];
  17792. if ( this.normalized ) y = denormalize( y, this.array );
  17793. return y;
  17794. }
  17795. /**
  17796. * Returns the z component of the vector at the given index.
  17797. *
  17798. * @param {number} index - The index into the buffer attribute.
  17799. * @return {number} The z component.
  17800. */
  17801. getZ( index ) {
  17802. let z = this.data.array[ index * this.data.stride + this.offset + 2 ];
  17803. if ( this.normalized ) z = denormalize( z, this.array );
  17804. return z;
  17805. }
  17806. /**
  17807. * Returns the w component of the vector at the given index.
  17808. *
  17809. * @param {number} index - The index into the buffer attribute.
  17810. * @return {number} The w component.
  17811. */
  17812. getW( index ) {
  17813. let w = this.data.array[ index * this.data.stride + this.offset + 3 ];
  17814. if ( this.normalized ) w = denormalize( w, this.array );
  17815. return w;
  17816. }
  17817. /**
  17818. * Sets the x and y component of the vector at the given index.
  17819. *
  17820. * @param {number} index - The index into the buffer attribute.
  17821. * @param {number} x - The value for the x component to set.
  17822. * @param {number} y - The value for the y component to set.
  17823. * @return {InterleavedBufferAttribute} A reference to this instance.
  17824. */
  17825. setXY( index, x, y ) {
  17826. index = index * this.data.stride + this.offset;
  17827. if ( this.normalized ) {
  17828. x = normalize( x, this.array );
  17829. y = normalize( y, this.array );
  17830. }
  17831. this.data.array[ index + 0 ] = x;
  17832. this.data.array[ index + 1 ] = y;
  17833. return this;
  17834. }
  17835. /**
  17836. * Sets the x, y and z component of the vector at the given index.
  17837. *
  17838. * @param {number} index - The index into the buffer attribute.
  17839. * @param {number} x - The value for the x component to set.
  17840. * @param {number} y - The value for the y component to set.
  17841. * @param {number} z - The value for the z component to set.
  17842. * @return {InterleavedBufferAttribute} A reference to this instance.
  17843. */
  17844. setXYZ( index, x, y, z ) {
  17845. index = index * this.data.stride + this.offset;
  17846. if ( this.normalized ) {
  17847. x = normalize( x, this.array );
  17848. y = normalize( y, this.array );
  17849. z = normalize( z, this.array );
  17850. }
  17851. this.data.array[ index + 0 ] = x;
  17852. this.data.array[ index + 1 ] = y;
  17853. this.data.array[ index + 2 ] = z;
  17854. return this;
  17855. }
  17856. /**
  17857. * Sets the x, y, z and w component of the vector at the given index.
  17858. *
  17859. * @param {number} index - The index into the buffer attribute.
  17860. * @param {number} x - The value for the x component to set.
  17861. * @param {number} y - The value for the y component to set.
  17862. * @param {number} z - The value for the z component to set.
  17863. * @param {number} w - The value for the w component to set.
  17864. * @return {InterleavedBufferAttribute} A reference to this instance.
  17865. */
  17866. setXYZW( index, x, y, z, w ) {
  17867. index = index * this.data.stride + this.offset;
  17868. if ( this.normalized ) {
  17869. x = normalize( x, this.array );
  17870. y = normalize( y, this.array );
  17871. z = normalize( z, this.array );
  17872. w = normalize( w, this.array );
  17873. }
  17874. this.data.array[ index + 0 ] = x;
  17875. this.data.array[ index + 1 ] = y;
  17876. this.data.array[ index + 2 ] = z;
  17877. this.data.array[ index + 3 ] = w;
  17878. return this;
  17879. }
  17880. /**
  17881. * Returns a new buffer attribute with copied values from this instance.
  17882. *
  17883. * If no parameter is provided, cloning an interleaved buffer attribute will de-interleave buffer data.
  17884. *
  17885. * @param {Object} [data] - An object with interleaved buffers that allows to retain the interleaved property.
  17886. * @return {BufferAttribute|InterleavedBufferAttribute} A clone of this instance.
  17887. */
  17888. clone( data ) {
  17889. if ( data === undefined ) {
  17890. log( 'InterleavedBufferAttribute.clone(): Cloning an interleaved buffer attribute will de-interleave buffer data.' );
  17891. const array = [];
  17892. for ( let i = 0; i < this.count; i ++ ) {
  17893. const index = i * this.data.stride + this.offset;
  17894. for ( let j = 0; j < this.itemSize; j ++ ) {
  17895. array.push( this.data.array[ index + j ] );
  17896. }
  17897. }
  17898. return new BufferAttribute( new this.array.constructor( array ), this.itemSize, this.normalized );
  17899. } else {
  17900. if ( data.interleavedBuffers === undefined ) {
  17901. data.interleavedBuffers = {};
  17902. }
  17903. if ( data.interleavedBuffers[ this.data.uuid ] === undefined ) {
  17904. data.interleavedBuffers[ this.data.uuid ] = this.data.clone( data );
  17905. }
  17906. return new InterleavedBufferAttribute( data.interleavedBuffers[ this.data.uuid ], this.itemSize, this.offset, this.normalized );
  17907. }
  17908. }
  17909. /**
  17910. * Serializes the buffer attribute into JSON.
  17911. *
  17912. * If no parameter is provided, cloning an interleaved buffer attribute will de-interleave buffer data.
  17913. *
  17914. * @param {Object} [data] - An optional value holding meta information about the serialization.
  17915. * @return {Object} A JSON object representing the serialized buffer attribute.
  17916. */
  17917. toJSON( data ) {
  17918. if ( data === undefined ) {
  17919. log( 'InterleavedBufferAttribute.toJSON(): Serializing an interleaved buffer attribute will de-interleave buffer data.' );
  17920. const array = [];
  17921. for ( let i = 0; i < this.count; i ++ ) {
  17922. const index = i * this.data.stride + this.offset;
  17923. for ( let j = 0; j < this.itemSize; j ++ ) {
  17924. array.push( this.data.array[ index + j ] );
  17925. }
  17926. }
  17927. // de-interleave data and save it as an ordinary buffer attribute for now
  17928. return {
  17929. itemSize: this.itemSize,
  17930. type: this.array.constructor.name,
  17931. array: array,
  17932. normalized: this.normalized
  17933. };
  17934. } else {
  17935. // save as true interleaved attribute
  17936. if ( data.interleavedBuffers === undefined ) {
  17937. data.interleavedBuffers = {};
  17938. }
  17939. if ( data.interleavedBuffers[ this.data.uuid ] === undefined ) {
  17940. data.interleavedBuffers[ this.data.uuid ] = this.data.toJSON( data );
  17941. }
  17942. return {
  17943. isInterleavedBufferAttribute: true,
  17944. itemSize: this.itemSize,
  17945. data: this.data.uuid,
  17946. offset: this.offset,
  17947. normalized: this.normalized
  17948. };
  17949. }
  17950. }
  17951. }
  17952. /**
  17953. * A material for rendering instances of {@link Sprite}.
  17954. *
  17955. * ```js
  17956. * const map = new THREE.TextureLoader().load( 'textures/sprite.png' );
  17957. * const material = new THREE.SpriteMaterial( { map: map, color: 0xffffff } );
  17958. *
  17959. * const sprite = new THREE.Sprite( material );
  17960. * sprite.scale.set(200, 200, 1)
  17961. * scene.add( sprite );
  17962. * ```
  17963. *
  17964. * @augments Material
  17965. */
  17966. class SpriteMaterial extends Material {
  17967. /**
  17968. * Constructs a new sprite material.
  17969. *
  17970. * @param {Object} [parameters] - An object with one or more properties
  17971. * defining the material's appearance. Any property of the material
  17972. * (including any property from inherited materials) can be passed
  17973. * in here. Color values can be passed any type of value accepted
  17974. * by {@link Color#set}.
  17975. */
  17976. constructor( parameters ) {
  17977. super();
  17978. /**
  17979. * This flag can be used for type testing.
  17980. *
  17981. * @type {boolean}
  17982. * @readonly
  17983. * @default true
  17984. */
  17985. this.isSpriteMaterial = true;
  17986. this.type = 'SpriteMaterial';
  17987. /**
  17988. * Color of the material.
  17989. *
  17990. * @type {Color}
  17991. * @default (1,1,1)
  17992. */
  17993. this.color = new Color( 0xffffff );
  17994. /**
  17995. * The color map. May optionally include an alpha channel, typically combined
  17996. * with {@link Material#transparent} or {@link Material#alphaTest}. The texture map
  17997. * color is modulated by the diffuse `color`.
  17998. *
  17999. * @type {?Texture}
  18000. * @default null
  18001. */
  18002. this.map = null;
  18003. /**
  18004. * The alpha map is a grayscale texture that controls the opacity across the
  18005. * surface (black: fully transparent; white: fully opaque).
  18006. *
  18007. * Only the color of the texture is used, ignoring the alpha channel if one
  18008. * exists. For RGB and RGBA textures, the renderer will use the green channel
  18009. * when sampling this texture due to the extra bit of precision provided for
  18010. * green in DXT-compressed and uncompressed RGB 565 formats. Luminance-only and
  18011. * luminance/alpha textures will also still work as expected.
  18012. *
  18013. * @type {?Texture}
  18014. * @default null
  18015. */
  18016. this.alphaMap = null;
  18017. /**
  18018. * The rotation of the sprite in radians.
  18019. *
  18020. * @type {number}
  18021. * @default 0
  18022. */
  18023. this.rotation = 0;
  18024. /**
  18025. * Specifies whether size of the sprite is attenuated by the camera depth (perspective camera only).
  18026. *
  18027. * @type {boolean}
  18028. * @default true
  18029. */
  18030. this.sizeAttenuation = true;
  18031. /**
  18032. * Overwritten since sprite materials are transparent
  18033. * by default.
  18034. *
  18035. * @type {boolean}
  18036. * @default true
  18037. */
  18038. this.transparent = true;
  18039. /**
  18040. * Whether the material is affected by fog or not.
  18041. *
  18042. * @type {boolean}
  18043. * @default true
  18044. */
  18045. this.fog = true;
  18046. this.setValues( parameters );
  18047. }
  18048. copy( source ) {
  18049. super.copy( source );
  18050. this.color.copy( source.color );
  18051. this.map = source.map;
  18052. this.alphaMap = source.alphaMap;
  18053. this.rotation = source.rotation;
  18054. this.sizeAttenuation = source.sizeAttenuation;
  18055. this.fog = source.fog;
  18056. return this;
  18057. }
  18058. }
  18059. let _geometry;
  18060. const _intersectPoint = /*@__PURE__*/ new Vector3();
  18061. const _worldScale = /*@__PURE__*/ new Vector3();
  18062. const _mvPosition = /*@__PURE__*/ new Vector3();
  18063. const _alignedPosition = /*@__PURE__*/ new Vector2();
  18064. const _rotatedPosition = /*@__PURE__*/ new Vector2();
  18065. const _viewWorldMatrix = /*@__PURE__*/ new Matrix4();
  18066. const _vA = /*@__PURE__*/ new Vector3();
  18067. const _vB = /*@__PURE__*/ new Vector3();
  18068. const _vC = /*@__PURE__*/ new Vector3();
  18069. const _uvA = /*@__PURE__*/ new Vector2();
  18070. const _uvB = /*@__PURE__*/ new Vector2();
  18071. const _uvC = /*@__PURE__*/ new Vector2();
  18072. /**
  18073. * A sprite is a plane that always faces towards the camera, generally with a
  18074. * partially transparent texture applied.
  18075. *
  18076. * Sprites do not cast shadows, setting {@link Object3D#castShadow} to `true` will
  18077. * have no effect.
  18078. *
  18079. * ```js
  18080. * const map = new THREE.TextureLoader().load( 'sprite.png' );
  18081. * const material = new THREE.SpriteMaterial( { map: map } );
  18082. *
  18083. * const sprite = new THREE.Sprite( material );
  18084. * scene.add( sprite );
  18085. * ```
  18086. *
  18087. * @augments Object3D
  18088. */
  18089. class Sprite extends Object3D {
  18090. /**
  18091. * Constructs a new sprite.
  18092. *
  18093. * @param {(SpriteMaterial|SpriteNodeMaterial)} [material] - The sprite material.
  18094. */
  18095. constructor( material = new SpriteMaterial() ) {
  18096. super();
  18097. /**
  18098. * This flag can be used for type testing.
  18099. *
  18100. * @type {boolean}
  18101. * @readonly
  18102. * @default true
  18103. */
  18104. this.isSprite = true;
  18105. this.type = 'Sprite';
  18106. if ( _geometry === undefined ) {
  18107. _geometry = new BufferGeometry();
  18108. const float32Array = new Float32Array( [
  18109. -0.5, -0.5, 0, 0, 0,
  18110. 0.5, -0.5, 0, 1, 0,
  18111. 0.5, 0.5, 0, 1, 1,
  18112. -0.5, 0.5, 0, 0, 1
  18113. ] );
  18114. const interleavedBuffer = new InterleavedBuffer( float32Array, 5 );
  18115. _geometry.setIndex( [ 0, 1, 2, 0, 2, 3 ] );
  18116. _geometry.setAttribute( 'position', new InterleavedBufferAttribute( interleavedBuffer, 3, 0, false ) );
  18117. _geometry.setAttribute( 'uv', new InterleavedBufferAttribute( interleavedBuffer, 2, 3, false ) );
  18118. }
  18119. /**
  18120. * The sprite geometry.
  18121. *
  18122. * @type {BufferGeometry}
  18123. */
  18124. this.geometry = _geometry;
  18125. /**
  18126. * The sprite material.
  18127. *
  18128. * @type {(SpriteMaterial|SpriteNodeMaterial)}
  18129. */
  18130. this.material = material;
  18131. /**
  18132. * The sprite's anchor point, and the point around which the sprite rotates.
  18133. * A value of `(0.5, 0.5)` corresponds to the midpoint of the sprite. A value
  18134. * of `(0, 0)` corresponds to the lower left corner of the sprite.
  18135. *
  18136. * @type {Vector2}
  18137. * @default (0.5,0.5)
  18138. */
  18139. this.center = new Vector2( 0.5, 0.5 );
  18140. /**
  18141. * The number of instances of this sprite.
  18142. * Can only be used with {@link WebGPURenderer}.
  18143. *
  18144. * @type {number}
  18145. * @default 1
  18146. */
  18147. this.count = 1;
  18148. }
  18149. /**
  18150. * Computes intersection points between a casted ray and this sprite.
  18151. *
  18152. * @param {Raycaster} raycaster - The raycaster.
  18153. * @param {Array<Object>} intersects - The target array that holds the intersection points.
  18154. */
  18155. raycast( raycaster, intersects ) {
  18156. if ( raycaster.camera === null ) {
  18157. error( 'Sprite: "Raycaster.camera" needs to be set in order to raycast against sprites.' );
  18158. }
  18159. _worldScale.setFromMatrixScale( this.matrixWorld );
  18160. _viewWorldMatrix.copy( raycaster.camera.matrixWorld );
  18161. this.modelViewMatrix.multiplyMatrices( raycaster.camera.matrixWorldInverse, this.matrixWorld );
  18162. _mvPosition.setFromMatrixPosition( this.modelViewMatrix );
  18163. if ( raycaster.camera.isPerspectiveCamera && this.material.sizeAttenuation === false ) {
  18164. _worldScale.multiplyScalar( - _mvPosition.z );
  18165. }
  18166. const rotation = this.material.rotation;
  18167. let sin, cos;
  18168. if ( rotation !== 0 ) {
  18169. cos = Math.cos( rotation );
  18170. sin = Math.sin( rotation );
  18171. }
  18172. const center = this.center;
  18173. transformVertex( _vA.set( -0.5, -0.5, 0 ), _mvPosition, center, _worldScale, sin, cos );
  18174. transformVertex( _vB.set( 0.5, -0.5, 0 ), _mvPosition, center, _worldScale, sin, cos );
  18175. transformVertex( _vC.set( 0.5, 0.5, 0 ), _mvPosition, center, _worldScale, sin, cos );
  18176. _uvA.set( 0, 0 );
  18177. _uvB.set( 1, 0 );
  18178. _uvC.set( 1, 1 );
  18179. // check first triangle
  18180. let intersect = raycaster.ray.intersectTriangle( _vA, _vB, _vC, false, _intersectPoint );
  18181. if ( intersect === null ) {
  18182. // check second triangle
  18183. transformVertex( _vB.set( -0.5, 0.5, 0 ), _mvPosition, center, _worldScale, sin, cos );
  18184. _uvB.set( 0, 1 );
  18185. intersect = raycaster.ray.intersectTriangle( _vA, _vC, _vB, false, _intersectPoint );
  18186. if ( intersect === null ) {
  18187. return;
  18188. }
  18189. }
  18190. const distance = raycaster.ray.origin.distanceTo( _intersectPoint );
  18191. if ( distance < raycaster.near || distance > raycaster.far ) return;
  18192. intersects.push( {
  18193. distance: distance,
  18194. point: _intersectPoint.clone(),
  18195. uv: Triangle.getInterpolation( _intersectPoint, _vA, _vB, _vC, _uvA, _uvB, _uvC, new Vector2() ),
  18196. face: null,
  18197. object: this
  18198. } );
  18199. }
  18200. copy( source, recursive ) {
  18201. super.copy( source, recursive );
  18202. if ( source.center !== undefined ) this.center.copy( source.center );
  18203. this.material = source.material;
  18204. return this;
  18205. }
  18206. }
  18207. function transformVertex( vertexPosition, mvPosition, center, scale, sin, cos ) {
  18208. // compute position in camera space
  18209. _alignedPosition.subVectors( vertexPosition, center ).addScalar( 0.5 ).multiply( scale );
  18210. // to check if rotation is not zero
  18211. if ( sin !== undefined ) {
  18212. _rotatedPosition.x = ( cos * _alignedPosition.x ) - ( sin * _alignedPosition.y );
  18213. _rotatedPosition.y = ( sin * _alignedPosition.x ) + ( cos * _alignedPosition.y );
  18214. } else {
  18215. _rotatedPosition.copy( _alignedPosition );
  18216. }
  18217. vertexPosition.copy( mvPosition );
  18218. vertexPosition.x += _rotatedPosition.x;
  18219. vertexPosition.y += _rotatedPosition.y;
  18220. // transform to world space
  18221. vertexPosition.applyMatrix4( _viewWorldMatrix );
  18222. }
  18223. const _v1$2 = /*@__PURE__*/ new Vector3();
  18224. const _v2$1 = /*@__PURE__*/ new Vector3();
  18225. /**
  18226. * A component for providing a basic Level of Detail (LOD) mechanism.
  18227. *
  18228. * Every LOD level is associated with an object, and rendering can be switched
  18229. * between them at the distances specified. Typically you would create, say,
  18230. * three meshes, one for far away (low detail), one for mid range (medium
  18231. * detail) and one for close up (high detail).
  18232. *
  18233. * ```js
  18234. * const lod = new THREE.LOD();
  18235. * const material = new THREE.MeshBasicMaterial( { color: 0xffff00 } );
  18236. *
  18237. * //Create spheres with 3 levels of detail and create new LOD levels for them
  18238. * for( let i = 0; i < 3; i++ ) {
  18239. *
  18240. * const geometry = new THREE.IcosahedronGeometry( 10, 3 - i );
  18241. * const mesh = new THREE.Mesh( geometry, material );
  18242. * lod.addLevel( mesh, i * 75 );
  18243. *
  18244. * }
  18245. *
  18246. * scene.add( lod );
  18247. * ```
  18248. *
  18249. * @augments Object3D
  18250. */
  18251. class LOD extends Object3D {
  18252. /**
  18253. * Constructs a new LOD.
  18254. */
  18255. constructor() {
  18256. super();
  18257. /**
  18258. * This flag can be used for type testing.
  18259. *
  18260. * @type {boolean}
  18261. * @readonly
  18262. * @default true
  18263. */
  18264. this.isLOD = true;
  18265. /**
  18266. * The current LOD index.
  18267. *
  18268. * @private
  18269. * @type {number}
  18270. * @default 0
  18271. */
  18272. this._currentLevel = 0;
  18273. this.type = 'LOD';
  18274. Object.defineProperties( this, {
  18275. /**
  18276. * This array holds the LOD levels.
  18277. *
  18278. * @name LOD#levels
  18279. * @type {Array<{object:Object3D,distance:number,hysteresis:number}>}
  18280. */
  18281. levels: {
  18282. enumerable: true,
  18283. value: []
  18284. }
  18285. } );
  18286. /**
  18287. * Whether the LOD object is updated automatically by the renderer per frame
  18288. * or not. If set to `false`, you have to call {@link LOD#update} in the
  18289. * render loop by yourself.
  18290. *
  18291. * @type {boolean}
  18292. * @default true
  18293. */
  18294. this.autoUpdate = true;
  18295. }
  18296. copy( source ) {
  18297. super.copy( source, false );
  18298. const levels = source.levels;
  18299. for ( let i = 0, l = levels.length; i < l; i ++ ) {
  18300. const level = levels[ i ];
  18301. this.addLevel( level.object.clone(), level.distance, level.hysteresis );
  18302. }
  18303. this.autoUpdate = source.autoUpdate;
  18304. return this;
  18305. }
  18306. /**
  18307. * Adds a mesh that will display at a certain distance and greater. Typically
  18308. * the further away the distance, the lower the detail on the mesh.
  18309. *
  18310. * @param {Object3D} object - The 3D object to display at this level.
  18311. * @param {number} [distance=0] - The distance at which to display this level of detail.
  18312. * @param {number} [hysteresis=0] - Threshold used to avoid flickering at LOD boundaries, as a fraction of distance.
  18313. * @return {LOD} A reference to this instance.
  18314. */
  18315. addLevel( object, distance = 0, hysteresis = 0 ) {
  18316. distance = Math.abs( distance );
  18317. const levels = this.levels;
  18318. let l;
  18319. for ( l = 0; l < levels.length; l ++ ) {
  18320. if ( distance < levels[ l ].distance ) {
  18321. break;
  18322. }
  18323. }
  18324. levels.splice( l, 0, { distance: distance, hysteresis: hysteresis, object: object } );
  18325. this.add( object );
  18326. return this;
  18327. }
  18328. /**
  18329. * Removes an existing level, based on the distance from the camera.
  18330. * Returns `true` when the level has been removed. Otherwise `false`.
  18331. *
  18332. * @param {number} distance - Distance of the level to remove.
  18333. * @return {boolean} Whether the level has been removed or not.
  18334. */
  18335. removeLevel( distance ) {
  18336. const levels = this.levels;
  18337. for ( let i = 0; i < levels.length; i ++ ) {
  18338. if ( levels[ i ].distance === distance ) {
  18339. const removedElements = levels.splice( i, 1 );
  18340. this.remove( removedElements[ 0 ].object );
  18341. return true;
  18342. }
  18343. }
  18344. return false;
  18345. }
  18346. /**
  18347. * Returns the currently active LOD level index.
  18348. *
  18349. * @return {number} The current active LOD level index.
  18350. */
  18351. getCurrentLevel() {
  18352. return this._currentLevel;
  18353. }
  18354. /**
  18355. * Returns a reference to the first 3D object that is greater than
  18356. * the given distance.
  18357. *
  18358. * @param {number} distance - The LOD distance.
  18359. * @return {?Object3D} The found 3D object. `null` if no 3D object has been found.
  18360. */
  18361. getObjectForDistance( distance ) {
  18362. const levels = this.levels;
  18363. if ( levels.length > 0 ) {
  18364. let i, l;
  18365. for ( i = 1, l = levels.length; i < l; i ++ ) {
  18366. let levelDistance = levels[ i ].distance;
  18367. if ( levels[ i ].object.visible ) {
  18368. levelDistance -= levelDistance * levels[ i ].hysteresis;
  18369. }
  18370. if ( distance < levelDistance ) {
  18371. break;
  18372. }
  18373. }
  18374. return levels[ i - 1 ].object;
  18375. }
  18376. return null;
  18377. }
  18378. /**
  18379. * Computes intersection points between a casted ray and this LOD.
  18380. *
  18381. * @param {Raycaster} raycaster - The raycaster.
  18382. * @param {Array<Object>} intersects - The target array that holds the intersection points.
  18383. */
  18384. raycast( raycaster, intersects ) {
  18385. const levels = this.levels;
  18386. if ( levels.length > 0 ) {
  18387. _v1$2.setFromMatrixPosition( this.matrixWorld );
  18388. const distance = raycaster.ray.origin.distanceTo( _v1$2 );
  18389. this.getObjectForDistance( distance ).raycast( raycaster, intersects );
  18390. }
  18391. }
  18392. /**
  18393. * Updates the LOD by computing which LOD level should be visible according
  18394. * to the current distance of the given camera.
  18395. *
  18396. * @param {Camera} camera - The camera the scene is rendered with.
  18397. */
  18398. update( camera ) {
  18399. const levels = this.levels;
  18400. if ( levels.length > 1 ) {
  18401. _v1$2.setFromMatrixPosition( camera.matrixWorld );
  18402. _v2$1.setFromMatrixPosition( this.matrixWorld );
  18403. const distance = _v1$2.distanceTo( _v2$1 ) / camera.zoom;
  18404. levels[ 0 ].object.visible = true;
  18405. let i, l;
  18406. for ( i = 1, l = levels.length; i < l; i ++ ) {
  18407. let levelDistance = levels[ i ].distance;
  18408. if ( levels[ i ].object.visible ) {
  18409. levelDistance -= levelDistance * levels[ i ].hysteresis;
  18410. }
  18411. if ( distance >= levelDistance ) {
  18412. levels[ i - 1 ].object.visible = false;
  18413. levels[ i ].object.visible = true;
  18414. } else {
  18415. break;
  18416. }
  18417. }
  18418. this._currentLevel = i - 1;
  18419. for ( ; i < l; i ++ ) {
  18420. levels[ i ].object.visible = false;
  18421. }
  18422. }
  18423. }
  18424. toJSON( meta ) {
  18425. const data = super.toJSON( meta );
  18426. if ( this.autoUpdate === false ) data.object.autoUpdate = false;
  18427. data.object.levels = [];
  18428. const levels = this.levels;
  18429. for ( let i = 0, l = levels.length; i < l; i ++ ) {
  18430. const level = levels[ i ];
  18431. data.object.levels.push( {
  18432. object: level.object.uuid,
  18433. distance: level.distance,
  18434. hysteresis: level.hysteresis
  18435. } );
  18436. }
  18437. return data;
  18438. }
  18439. }
  18440. const _basePosition = /*@__PURE__*/ new Vector3();
  18441. const _skinIndex = /*@__PURE__*/ new Vector4();
  18442. const _skinWeight = /*@__PURE__*/ new Vector4();
  18443. const _vector3 = /*@__PURE__*/ new Vector3();
  18444. const _matrix4 = /*@__PURE__*/ new Matrix4();
  18445. const _vertex = /*@__PURE__*/ new Vector3();
  18446. const _sphere$5 = /*@__PURE__*/ new Sphere();
  18447. const _inverseMatrix$2 = /*@__PURE__*/ new Matrix4();
  18448. const _ray$2 = /*@__PURE__*/ new Ray();
  18449. /**
  18450. * A mesh that has a {@link Skeleton} that can then be used to animate the
  18451. * vertices of the geometry with skinning/skeleton animation.
  18452. *
  18453. * Next to a valid skeleton, the skinned mesh requires skin indices and weights
  18454. * as buffer attributes in its geometry. These attribute define which bones affect a single
  18455. * vertex to a certain extend.
  18456. *
  18457. * Typically skinned meshes are not created manually but loaders like {@link GLTFLoader}
  18458. * or {@link FBXLoader } import respective models.
  18459. *
  18460. * @augments Mesh
  18461. * @demo scenes/bones-browser.html
  18462. */
  18463. class SkinnedMesh extends Mesh {
  18464. /**
  18465. * Constructs a new skinned mesh.
  18466. *
  18467. * @param {BufferGeometry} [geometry] - The mesh geometry.
  18468. * @param {Material|Array<Material>} [material] - The mesh material.
  18469. */
  18470. constructor( geometry, material ) {
  18471. super( geometry, material );
  18472. /**
  18473. * This flag can be used for type testing.
  18474. *
  18475. * @type {boolean}
  18476. * @readonly
  18477. * @default true
  18478. */
  18479. this.isSkinnedMesh = true;
  18480. this.type = 'SkinnedMesh';
  18481. /**
  18482. * `AttachedBindMode` means the skinned mesh shares the same world space as the skeleton.
  18483. * This is not true when using `DetachedBindMode` which is useful when sharing a skeleton
  18484. * across multiple skinned meshes.
  18485. *
  18486. * @type {(AttachedBindMode|DetachedBindMode)}
  18487. * @default AttachedBindMode
  18488. */
  18489. this.bindMode = AttachedBindMode;
  18490. /**
  18491. * The base matrix that is used for the bound bone transforms.
  18492. *
  18493. * @type {Matrix4}
  18494. */
  18495. this.bindMatrix = new Matrix4();
  18496. /**
  18497. * The base matrix that is used for resetting the bound bone transforms.
  18498. *
  18499. * @type {Matrix4}
  18500. */
  18501. this.bindMatrixInverse = new Matrix4();
  18502. /**
  18503. * The bounding box of the skinned mesh. Can be computed via {@link SkinnedMesh#computeBoundingBox}.
  18504. *
  18505. * @type {?Box3}
  18506. * @default null
  18507. */
  18508. this.boundingBox = null;
  18509. /**
  18510. * The bounding sphere of the skinned mesh. Can be computed via {@link SkinnedMesh#computeBoundingSphere}.
  18511. *
  18512. * @type {?Sphere}
  18513. * @default null
  18514. */
  18515. this.boundingSphere = null;
  18516. }
  18517. /**
  18518. * Computes the bounding box of the skinned mesh, and updates {@link SkinnedMesh#boundingBox}.
  18519. * The bounding box is not automatically computed by the engine; this method must be called by your app.
  18520. * If the skinned mesh is animated, the bounding box should be recomputed per frame in order to reflect
  18521. * the current animation state.
  18522. */
  18523. computeBoundingBox() {
  18524. const geometry = this.geometry;
  18525. if ( this.boundingBox === null ) {
  18526. this.boundingBox = new Box3();
  18527. }
  18528. this.boundingBox.makeEmpty();
  18529. const positionAttribute = geometry.getAttribute( 'position' );
  18530. for ( let i = 0; i < positionAttribute.count; i ++ ) {
  18531. this.getVertexPosition( i, _vertex );
  18532. this.boundingBox.expandByPoint( _vertex );
  18533. }
  18534. }
  18535. /**
  18536. * Computes the bounding sphere of the skinned mesh, and updates {@link SkinnedMesh#boundingSphere}.
  18537. * The bounding sphere is automatically computed by the engine once when it is needed, e.g., for ray casting
  18538. * and view frustum culling. If the skinned mesh is animated, the bounding sphere should be recomputed
  18539. * per frame in order to reflect the current animation state.
  18540. */
  18541. computeBoundingSphere() {
  18542. const geometry = this.geometry;
  18543. if ( this.boundingSphere === null ) {
  18544. this.boundingSphere = new Sphere();
  18545. }
  18546. this.boundingSphere.makeEmpty();
  18547. const positionAttribute = geometry.getAttribute( 'position' );
  18548. for ( let i = 0; i < positionAttribute.count; i ++ ) {
  18549. this.getVertexPosition( i, _vertex );
  18550. this.boundingSphere.expandByPoint( _vertex );
  18551. }
  18552. }
  18553. copy( source, recursive ) {
  18554. super.copy( source, recursive );
  18555. this.bindMode = source.bindMode;
  18556. this.bindMatrix.copy( source.bindMatrix );
  18557. this.bindMatrixInverse.copy( source.bindMatrixInverse );
  18558. this.skeleton = source.skeleton;
  18559. if ( source.boundingBox !== null ) this.boundingBox = source.boundingBox.clone();
  18560. if ( source.boundingSphere !== null ) this.boundingSphere = source.boundingSphere.clone();
  18561. return this;
  18562. }
  18563. raycast( raycaster, intersects ) {
  18564. const material = this.material;
  18565. const matrixWorld = this.matrixWorld;
  18566. if ( material === undefined ) return;
  18567. // test with bounding sphere in world space
  18568. if ( this.boundingSphere === null ) this.computeBoundingSphere();
  18569. _sphere$5.copy( this.boundingSphere );
  18570. _sphere$5.applyMatrix4( matrixWorld );
  18571. if ( raycaster.ray.intersectsSphere( _sphere$5 ) === false ) return;
  18572. // convert ray to local space of skinned mesh
  18573. _inverseMatrix$2.copy( matrixWorld ).invert();
  18574. _ray$2.copy( raycaster.ray ).applyMatrix4( _inverseMatrix$2 );
  18575. // test with bounding box in local space
  18576. if ( this.boundingBox !== null ) {
  18577. if ( _ray$2.intersectsBox( this.boundingBox ) === false ) return;
  18578. }
  18579. // test for intersections with geometry
  18580. this._computeIntersections( raycaster, intersects, _ray$2 );
  18581. }
  18582. getVertexPosition( index, target ) {
  18583. super.getVertexPosition( index, target );
  18584. this.applyBoneTransform( index, target );
  18585. return target;
  18586. }
  18587. /**
  18588. * Binds the given skeleton to the skinned mesh.
  18589. *
  18590. * @param {Skeleton} skeleton - The skeleton to bind.
  18591. * @param {Matrix4} [bindMatrix] - The bind matrix. If no bind matrix is provided,
  18592. * the skinned mesh's world matrix will be used instead.
  18593. */
  18594. bind( skeleton, bindMatrix ) {
  18595. this.skeleton = skeleton;
  18596. if ( bindMatrix === undefined ) {
  18597. this.updateMatrixWorld( true );
  18598. this.skeleton.calculateInverses();
  18599. bindMatrix = this.matrixWorld;
  18600. }
  18601. this.bindMatrix.copy( bindMatrix );
  18602. this.bindMatrixInverse.copy( bindMatrix ).invert();
  18603. }
  18604. /**
  18605. * This method sets the skinned mesh in the rest pose).
  18606. */
  18607. pose() {
  18608. this.skeleton.pose();
  18609. }
  18610. /**
  18611. * Normalizes the skin weights which are defined as a buffer attribute
  18612. * in the skinned mesh's geometry.
  18613. */
  18614. normalizeSkinWeights() {
  18615. const vector = new Vector4();
  18616. const skinWeight = this.geometry.attributes.skinWeight;
  18617. for ( let i = 0, l = skinWeight.count; i < l; i ++ ) {
  18618. vector.fromBufferAttribute( skinWeight, i );
  18619. const scale = 1.0 / vector.manhattanLength();
  18620. if ( scale !== Infinity ) {
  18621. vector.multiplyScalar( scale );
  18622. } else {
  18623. vector.set( 1, 0, 0, 0 ); // do something reasonable
  18624. }
  18625. skinWeight.setXYZW( i, vector.x, vector.y, vector.z, vector.w );
  18626. }
  18627. }
  18628. updateMatrixWorld( force ) {
  18629. super.updateMatrixWorld( force );
  18630. if ( this.bindMode === AttachedBindMode ) {
  18631. this.bindMatrixInverse.copy( this.matrixWorld ).invert();
  18632. } else if ( this.bindMode === DetachedBindMode ) {
  18633. this.bindMatrixInverse.copy( this.bindMatrix ).invert();
  18634. } else {
  18635. warn( 'SkinnedMesh: Unrecognized bindMode: ' + this.bindMode );
  18636. }
  18637. }
  18638. /**
  18639. * Applies the bone transform associated with the given index to the given
  18640. * vertex position. Returns the updated vector.
  18641. *
  18642. * @param {number} index - The vertex index.
  18643. * @param {Vector3} target - The target object that is used to store the method's result.
  18644. * the skinned mesh's world matrix will be used instead.
  18645. * @return {Vector3} The updated vertex position.
  18646. */
  18647. applyBoneTransform( index, target ) {
  18648. const skeleton = this.skeleton;
  18649. const geometry = this.geometry;
  18650. _skinIndex.fromBufferAttribute( geometry.attributes.skinIndex, index );
  18651. _skinWeight.fromBufferAttribute( geometry.attributes.skinWeight, index );
  18652. _basePosition.copy( target ).applyMatrix4( this.bindMatrix );
  18653. target.set( 0, 0, 0 );
  18654. for ( let i = 0; i < 4; i ++ ) {
  18655. const weight = _skinWeight.getComponent( i );
  18656. if ( weight !== 0 ) {
  18657. const boneIndex = _skinIndex.getComponent( i );
  18658. _matrix4.multiplyMatrices( skeleton.bones[ boneIndex ].matrixWorld, skeleton.boneInverses[ boneIndex ] );
  18659. target.addScaledVector( _vector3.copy( _basePosition ).applyMatrix4( _matrix4 ), weight );
  18660. }
  18661. }
  18662. return target.applyMatrix4( this.bindMatrixInverse );
  18663. }
  18664. }
  18665. /**
  18666. * A bone which is part of a {@link Skeleton}. The skeleton in turn is used by
  18667. * the {@link SkinnedMesh}.
  18668. *
  18669. * ```js
  18670. * const root = new THREE.Bone();
  18671. * const child = new THREE.Bone();
  18672. *
  18673. * root.add( child );
  18674. * child.position.y = 5;
  18675. * ```
  18676. *
  18677. * @augments Object3D
  18678. */
  18679. class Bone extends Object3D {
  18680. /**
  18681. * Constructs a new bone.
  18682. */
  18683. constructor() {
  18684. super();
  18685. /**
  18686. * This flag can be used for type testing.
  18687. *
  18688. * @type {boolean}
  18689. * @readonly
  18690. * @default true
  18691. */
  18692. this.isBone = true;
  18693. this.type = 'Bone';
  18694. }
  18695. }
  18696. /**
  18697. * Creates a texture directly from raw buffer data.
  18698. *
  18699. * The interpretation of the data depends on type and format: If the type is
  18700. * `UnsignedByteType`, a `Uint8Array` will be useful for addressing the
  18701. * texel data. If the format is `RGBAFormat`, data needs four values for
  18702. * one texel; Red, Green, Blue and Alpha (typically the opacity).
  18703. *
  18704. * @augments Texture
  18705. */
  18706. class DataTexture extends Texture {
  18707. /**
  18708. * Constructs a new data texture.
  18709. *
  18710. * @param {?TypedArray} [data=null] - The buffer data.
  18711. * @param {number} [width=1] - The width of the texture.
  18712. * @param {number} [height=1] - The height of the texture.
  18713. * @param {number} [format=RGBAFormat] - The texture format.
  18714. * @param {number} [type=UnsignedByteType] - The texture type.
  18715. * @param {number} [mapping=Texture.DEFAULT_MAPPING] - The texture mapping.
  18716. * @param {number} [wrapS=ClampToEdgeWrapping] - The wrapS value.
  18717. * @param {number} [wrapT=ClampToEdgeWrapping] - The wrapT value.
  18718. * @param {number} [magFilter=NearestFilter] - The mag filter value.
  18719. * @param {number} [minFilter=NearestFilter] - The min filter value.
  18720. * @param {number} [anisotropy=Texture.DEFAULT_ANISOTROPY] - The anisotropy value.
  18721. * @param {string} [colorSpace=NoColorSpace] - The color space.
  18722. */
  18723. constructor( data = null, width = 1, height = 1, format, type, mapping, wrapS, wrapT, magFilter = NearestFilter, minFilter = NearestFilter, anisotropy, colorSpace ) {
  18724. super( null, mapping, wrapS, wrapT, magFilter, minFilter, format, type, anisotropy, colorSpace );
  18725. /**
  18726. * This flag can be used for type testing.
  18727. *
  18728. * @type {boolean}
  18729. * @readonly
  18730. * @default true
  18731. */
  18732. this.isDataTexture = true;
  18733. /**
  18734. * The image definition of a data texture.
  18735. *
  18736. * @type {{data:TypedArray,width:number,height:number}}
  18737. */
  18738. this.image = { data: data, width: width, height: height };
  18739. /**
  18740. * Whether to generate mipmaps (if possible) for a texture.
  18741. *
  18742. * Overwritten and set to `false` by default.
  18743. *
  18744. * @type {boolean}
  18745. * @default false
  18746. */
  18747. this.generateMipmaps = false;
  18748. /**
  18749. * If set to `true`, the texture is flipped along the vertical axis when
  18750. * uploaded to the GPU.
  18751. *
  18752. * Overwritten and set to `false` by default.
  18753. *
  18754. * @type {boolean}
  18755. * @default false
  18756. */
  18757. this.flipY = false;
  18758. /**
  18759. * Specifies the alignment requirements for the start of each pixel row in memory.
  18760. *
  18761. * Overwritten and set to `1` by default.
  18762. *
  18763. * @type {boolean}
  18764. * @default 1
  18765. */
  18766. this.unpackAlignment = 1;
  18767. }
  18768. }
  18769. const _offsetMatrix = /*@__PURE__*/ new Matrix4();
  18770. const _identityMatrix = /*@__PURE__*/ new Matrix4();
  18771. /**
  18772. * Class for representing the armatures in `three.js`. The skeleton
  18773. * is defined by a hierarchy of bones.
  18774. *
  18775. * ```js
  18776. * const bones = [];
  18777. *
  18778. * const shoulder = new THREE.Bone();
  18779. * const elbow = new THREE.Bone();
  18780. * const hand = new THREE.Bone();
  18781. *
  18782. * shoulder.add( elbow );
  18783. * elbow.add( hand );
  18784. *
  18785. * bones.push( shoulder , elbow, hand);
  18786. *
  18787. * shoulder.position.y = -5;
  18788. * elbow.position.y = 0;
  18789. * hand.position.y = 5;
  18790. *
  18791. * const armSkeleton = new THREE.Skeleton( bones );
  18792. * ```
  18793. */
  18794. class Skeleton {
  18795. /**
  18796. * Constructs a new skeleton.
  18797. *
  18798. * @param {Array<Bone>} [bones] - An array of bones.
  18799. * @param {Array<Matrix4>} [boneInverses] - An array of bone inverse matrices.
  18800. * If not provided, these matrices will be computed automatically via {@link Skeleton#calculateInverses}.
  18801. */
  18802. constructor( bones = [], boneInverses = [] ) {
  18803. this.uuid = generateUUID();
  18804. /**
  18805. * An array of bones defining the skeleton.
  18806. *
  18807. * @type {Array<Bone>}
  18808. */
  18809. this.bones = bones.slice( 0 );
  18810. /**
  18811. * An array of bone inverse matrices.
  18812. *
  18813. * @type {Array<Matrix4>}
  18814. */
  18815. this.boneInverses = boneInverses;
  18816. /**
  18817. * An array buffer holding the bone data.
  18818. * Input data for {@link Skeleton#boneTexture}.
  18819. *
  18820. * @type {?Float32Array}
  18821. * @default null
  18822. */
  18823. this.boneMatrices = null;
  18824. /**
  18825. * An array buffer holding the bone data of the previous frame.
  18826. * Required for computing velocity. Maintained in {@link SkinningNode}.
  18827. *
  18828. * @type {?Float32Array}
  18829. * @default null
  18830. */
  18831. this.previousBoneMatrices = null;
  18832. /**
  18833. * A texture holding the bone data for use
  18834. * in the vertex shader.
  18835. *
  18836. * @type {?DataTexture}
  18837. * @default null
  18838. */
  18839. this.boneTexture = null;
  18840. this.init();
  18841. }
  18842. /**
  18843. * Initializes the skeleton. This method gets automatically called by the constructor
  18844. * but depending on how the skeleton is created it might be necessary to call this method
  18845. * manually.
  18846. */
  18847. init() {
  18848. const bones = this.bones;
  18849. const boneInverses = this.boneInverses;
  18850. this.boneMatrices = new Float32Array( bones.length * 16 );
  18851. // calculate inverse bone matrices if necessary
  18852. if ( boneInverses.length === 0 ) {
  18853. this.calculateInverses();
  18854. } else {
  18855. // handle special case
  18856. if ( bones.length !== boneInverses.length ) {
  18857. warn( 'Skeleton: Number of inverse bone matrices does not match amount of bones.' );
  18858. this.boneInverses = [];
  18859. for ( let i = 0, il = this.bones.length; i < il; i ++ ) {
  18860. this.boneInverses.push( new Matrix4() );
  18861. }
  18862. }
  18863. }
  18864. }
  18865. /**
  18866. * Computes the bone inverse matrices. This method resets {@link Skeleton#boneInverses}
  18867. * and fills it with new matrices.
  18868. */
  18869. calculateInverses() {
  18870. this.boneInverses.length = 0;
  18871. for ( let i = 0, il = this.bones.length; i < il; i ++ ) {
  18872. const inverse = new Matrix4();
  18873. if ( this.bones[ i ] ) {
  18874. inverse.copy( this.bones[ i ].matrixWorld ).invert();
  18875. }
  18876. this.boneInverses.push( inverse );
  18877. }
  18878. }
  18879. /**
  18880. * Resets the skeleton to the base pose.
  18881. */
  18882. pose() {
  18883. // recover the bind-time world matrices
  18884. for ( let i = 0, il = this.bones.length; i < il; i ++ ) {
  18885. const bone = this.bones[ i ];
  18886. if ( bone ) {
  18887. bone.matrixWorld.copy( this.boneInverses[ i ] ).invert();
  18888. }
  18889. }
  18890. // compute the local matrices, positions, rotations and scales
  18891. for ( let i = 0, il = this.bones.length; i < il; i ++ ) {
  18892. const bone = this.bones[ i ];
  18893. if ( bone ) {
  18894. if ( bone.parent && bone.parent.isBone ) {
  18895. bone.matrix.copy( bone.parent.matrixWorld ).invert();
  18896. bone.matrix.multiply( bone.matrixWorld );
  18897. } else {
  18898. bone.matrix.copy( bone.matrixWorld );
  18899. }
  18900. bone.matrix.decompose( bone.position, bone.quaternion, bone.scale );
  18901. }
  18902. }
  18903. }
  18904. /**
  18905. * Resets the skeleton to the base pose.
  18906. */
  18907. update() {
  18908. const bones = this.bones;
  18909. const boneInverses = this.boneInverses;
  18910. const boneMatrices = this.boneMatrices;
  18911. const boneTexture = this.boneTexture;
  18912. // flatten bone matrices to array
  18913. for ( let i = 0, il = bones.length; i < il; i ++ ) {
  18914. // compute the offset between the current and the original transform
  18915. const matrix = bones[ i ] ? bones[ i ].matrixWorld : _identityMatrix;
  18916. _offsetMatrix.multiplyMatrices( matrix, boneInverses[ i ] );
  18917. _offsetMatrix.toArray( boneMatrices, i * 16 );
  18918. }
  18919. if ( boneTexture !== null ) {
  18920. boneTexture.needsUpdate = true;
  18921. }
  18922. }
  18923. /**
  18924. * Returns a new skeleton with copied values from this instance.
  18925. *
  18926. * @return {Skeleton} A clone of this instance.
  18927. */
  18928. clone() {
  18929. return new Skeleton( this.bones, this.boneInverses );
  18930. }
  18931. /**
  18932. * Computes a data texture for passing bone data to the vertex shader.
  18933. *
  18934. * @return {Skeleton} A reference of this instance.
  18935. */
  18936. computeBoneTexture() {
  18937. // layout (1 matrix = 4 pixels)
  18938. // RGBA RGBA RGBA RGBA (=> column1, column2, column3, column4)
  18939. // with 8x8 pixel texture max 16 bones * 4 pixels = (8 * 8)
  18940. // 16x16 pixel texture max 64 bones * 4 pixels = (16 * 16)
  18941. // 32x32 pixel texture max 256 bones * 4 pixels = (32 * 32)
  18942. // 64x64 pixel texture max 1024 bones * 4 pixels = (64 * 64)
  18943. let size = Math.sqrt( this.bones.length * 4 ); // 4 pixels needed for 1 matrix
  18944. size = Math.ceil( size / 4 ) * 4;
  18945. size = Math.max( size, 4 );
  18946. const boneMatrices = new Float32Array( size * size * 4 ); // 4 floats per RGBA pixel
  18947. boneMatrices.set( this.boneMatrices ); // copy current values
  18948. const boneTexture = new DataTexture( boneMatrices, size, size, RGBAFormat, FloatType );
  18949. boneTexture.needsUpdate = true;
  18950. this.boneMatrices = boneMatrices;
  18951. this.boneTexture = boneTexture;
  18952. return this;
  18953. }
  18954. /**
  18955. * Searches through the skeleton's bone array and returns the first with a
  18956. * matching name.
  18957. *
  18958. * @param {string} name - The name of the bone.
  18959. * @return {Bone|undefined} The found bone. `undefined` if no bone has been found.
  18960. */
  18961. getBoneByName( name ) {
  18962. for ( let i = 0, il = this.bones.length; i < il; i ++ ) {
  18963. const bone = this.bones[ i ];
  18964. if ( bone.name === name ) {
  18965. return bone;
  18966. }
  18967. }
  18968. return undefined;
  18969. }
  18970. /**
  18971. * Frees the GPU-related resources allocated by this instance. Call this
  18972. * method whenever this instance is no longer used in your app.
  18973. */
  18974. dispose( ) {
  18975. if ( this.boneTexture !== null ) {
  18976. this.boneTexture.dispose();
  18977. this.boneTexture = null;
  18978. }
  18979. }
  18980. /**
  18981. * Setups the skeleton by the given JSON and bones.
  18982. *
  18983. * @param {Object} json - The skeleton as serialized JSON.
  18984. * @param {Object<string, Bone>} bones - An array of bones.
  18985. * @return {Skeleton} A reference of this instance.
  18986. */
  18987. fromJSON( json, bones ) {
  18988. this.uuid = json.uuid;
  18989. for ( let i = 0, l = json.bones.length; i < l; i ++ ) {
  18990. const uuid = json.bones[ i ];
  18991. let bone = bones[ uuid ];
  18992. if ( bone === undefined ) {
  18993. warn( 'Skeleton: No bone found with UUID:', uuid );
  18994. bone = new Bone();
  18995. }
  18996. this.bones.push( bone );
  18997. this.boneInverses.push( new Matrix4().fromArray( json.boneInverses[ i ] ) );
  18998. }
  18999. this.init();
  19000. return this;
  19001. }
  19002. /**
  19003. * Serializes the skeleton into JSON.
  19004. *
  19005. * @return {Object} A JSON object representing the serialized skeleton.
  19006. * @see {@link ObjectLoader#parse}
  19007. */
  19008. toJSON() {
  19009. const data = {
  19010. metadata: {
  19011. version: 4.7,
  19012. type: 'Skeleton',
  19013. generator: 'Skeleton.toJSON'
  19014. },
  19015. bones: [],
  19016. boneInverses: []
  19017. };
  19018. data.uuid = this.uuid;
  19019. const bones = this.bones;
  19020. const boneInverses = this.boneInverses;
  19021. for ( let i = 0, l = bones.length; i < l; i ++ ) {
  19022. const bone = bones[ i ];
  19023. data.bones.push( bone.uuid );
  19024. const boneInverse = boneInverses[ i ];
  19025. data.boneInverses.push( boneInverse.toArray() );
  19026. }
  19027. return data;
  19028. }
  19029. }
  19030. /**
  19031. * An instanced version of a buffer attribute.
  19032. *
  19033. * @augments BufferAttribute
  19034. */
  19035. class InstancedBufferAttribute extends BufferAttribute {
  19036. /**
  19037. * Constructs a new instanced buffer attribute.
  19038. *
  19039. * @param {TypedArray} array - The array holding the attribute data.
  19040. * @param {number} itemSize - The item size.
  19041. * @param {boolean} [normalized=false] - Whether the data are normalized or not.
  19042. * @param {number} [meshPerAttribute=1] - How often a value of this buffer attribute should be repeated.
  19043. */
  19044. constructor( array, itemSize, normalized, meshPerAttribute = 1 ) {
  19045. super( array, itemSize, normalized );
  19046. /**
  19047. * This flag can be used for type testing.
  19048. *
  19049. * @type {boolean}
  19050. * @readonly
  19051. * @default true
  19052. */
  19053. this.isInstancedBufferAttribute = true;
  19054. /**
  19055. * Defines how often a value of this buffer attribute should be repeated. A
  19056. * value of one means that each value of the instanced attribute is used for
  19057. * a single instance. A value of two means that each value is used for two
  19058. * consecutive instances (and so on).
  19059. *
  19060. * @type {number}
  19061. * @default 1
  19062. */
  19063. this.meshPerAttribute = meshPerAttribute;
  19064. }
  19065. copy( source ) {
  19066. super.copy( source );
  19067. this.meshPerAttribute = source.meshPerAttribute;
  19068. return this;
  19069. }
  19070. toJSON() {
  19071. const data = super.toJSON();
  19072. data.meshPerAttribute = this.meshPerAttribute;
  19073. data.isInstancedBufferAttribute = true;
  19074. return data;
  19075. }
  19076. }
  19077. const _instanceLocalMatrix = /*@__PURE__*/ new Matrix4();
  19078. const _instanceWorldMatrix = /*@__PURE__*/ new Matrix4();
  19079. const _instanceIntersects = [];
  19080. const _box3 = /*@__PURE__*/ new Box3();
  19081. const _identity = /*@__PURE__*/ new Matrix4();
  19082. const _mesh$1 = /*@__PURE__*/ new Mesh();
  19083. const _sphere$4 = /*@__PURE__*/ new Sphere();
  19084. /**
  19085. * A special version of a mesh with instanced rendering support. Use
  19086. * this class if you have to render a large number of objects with the same
  19087. * geometry and material(s) but with different world transformations. The usage
  19088. * of 'InstancedMesh' will help you to reduce the number of draw calls and thus
  19089. * improve the overall rendering performance in your application.
  19090. *
  19091. * @augments Mesh
  19092. */
  19093. class InstancedMesh extends Mesh {
  19094. /**
  19095. * Constructs a new instanced mesh.
  19096. *
  19097. * @param {BufferGeometry} [geometry] - The mesh geometry.
  19098. * @param {Material|Array<Material>} [material] - The mesh material.
  19099. * @param {number} count - The number of instances.
  19100. */
  19101. constructor( geometry, material, count ) {
  19102. super( geometry, material );
  19103. /**
  19104. * This flag can be used for type testing.
  19105. *
  19106. * @type {boolean}
  19107. * @readonly
  19108. * @default true
  19109. */
  19110. this.isInstancedMesh = true;
  19111. /**
  19112. * Represents the local transformation of all instances. You have to set its
  19113. * {@link BufferAttribute#needsUpdate} flag to true if you modify instanced data
  19114. * via {@link InstancedMesh#setMatrixAt}.
  19115. *
  19116. * @type {InstancedBufferAttribute}
  19117. */
  19118. this.instanceMatrix = new InstancedBufferAttribute( new Float32Array( count * 16 ), 16 );
  19119. /**
  19120. * Represents the local transformation of all instances of the previous frame.
  19121. * Required for computing velocity. Maintained in {@link InstanceNode}.
  19122. *
  19123. * @type {?InstancedBufferAttribute}
  19124. * @default null
  19125. */
  19126. this.previousInstanceMatrix = null;
  19127. /**
  19128. * Represents the color of all instances. You have to set its
  19129. * {@link BufferAttribute#needsUpdate} flag to true if you modify instanced data
  19130. * via {@link InstancedMesh#setColorAt}.
  19131. *
  19132. * @type {?InstancedBufferAttribute}
  19133. * @default null
  19134. */
  19135. this.instanceColor = null;
  19136. /**
  19137. * Represents the morph target weights of all instances. You have to set its
  19138. * {@link Texture#needsUpdate} flag to true if you modify instanced data
  19139. * via {@link InstancedMesh#setMorphAt}.
  19140. *
  19141. * @type {?DataTexture}
  19142. * @default null
  19143. */
  19144. this.morphTexture = null;
  19145. /**
  19146. * The number of instances.
  19147. *
  19148. * @type {number}
  19149. */
  19150. this.count = count;
  19151. /**
  19152. * The bounding box of the instanced mesh. Can be computed via {@link InstancedMesh#computeBoundingBox}.
  19153. *
  19154. * @type {?Box3}
  19155. * @default null
  19156. */
  19157. this.boundingBox = null;
  19158. /**
  19159. * The bounding sphere of the instanced mesh. Can be computed via {@link InstancedMesh#computeBoundingSphere}.
  19160. *
  19161. * @type {?Sphere}
  19162. * @default null
  19163. */
  19164. this.boundingSphere = null;
  19165. for ( let i = 0; i < count; i ++ ) {
  19166. this.setMatrixAt( i, _identity );
  19167. }
  19168. }
  19169. /**
  19170. * Computes the bounding box of the instanced mesh, and updates {@link InstancedMesh#boundingBox}.
  19171. * The bounding box is not automatically computed by the engine; this method must be called by your app.
  19172. * You may need to recompute the bounding box if an instance is transformed via {@link InstancedMesh#setMatrixAt}.
  19173. */
  19174. computeBoundingBox() {
  19175. const geometry = this.geometry;
  19176. const count = this.count;
  19177. if ( this.boundingBox === null ) {
  19178. this.boundingBox = new Box3();
  19179. }
  19180. if ( geometry.boundingBox === null ) {
  19181. geometry.computeBoundingBox();
  19182. }
  19183. this.boundingBox.makeEmpty();
  19184. for ( let i = 0; i < count; i ++ ) {
  19185. this.getMatrixAt( i, _instanceLocalMatrix );
  19186. _box3.copy( geometry.boundingBox ).applyMatrix4( _instanceLocalMatrix );
  19187. this.boundingBox.union( _box3 );
  19188. }
  19189. }
  19190. /**
  19191. * Computes the bounding sphere of the instanced mesh, and updates {@link InstancedMesh#boundingSphere}
  19192. * The engine automatically computes the bounding sphere when it is needed, e.g., for ray casting or view frustum culling.
  19193. * You may need to recompute the bounding sphere if an instance is transformed via {@link InstancedMesh#setMatrixAt}.
  19194. */
  19195. computeBoundingSphere() {
  19196. const geometry = this.geometry;
  19197. const count = this.count;
  19198. if ( this.boundingSphere === null ) {
  19199. this.boundingSphere = new Sphere();
  19200. }
  19201. if ( geometry.boundingSphere === null ) {
  19202. geometry.computeBoundingSphere();
  19203. }
  19204. this.boundingSphere.makeEmpty();
  19205. for ( let i = 0; i < count; i ++ ) {
  19206. this.getMatrixAt( i, _instanceLocalMatrix );
  19207. _sphere$4.copy( geometry.boundingSphere ).applyMatrix4( _instanceLocalMatrix );
  19208. this.boundingSphere.union( _sphere$4 );
  19209. }
  19210. }
  19211. copy( source, recursive ) {
  19212. super.copy( source, recursive );
  19213. this.instanceMatrix.copy( source.instanceMatrix );
  19214. if ( source.previousInstanceMatrix !== null ) this.previousInstanceMatrix = source.previousInstanceMatrix.clone();
  19215. if ( source.morphTexture !== null ) this.morphTexture = source.morphTexture.clone();
  19216. if ( source.instanceColor !== null ) this.instanceColor = source.instanceColor.clone();
  19217. this.count = source.count;
  19218. if ( source.boundingBox !== null ) this.boundingBox = source.boundingBox.clone();
  19219. if ( source.boundingSphere !== null ) this.boundingSphere = source.boundingSphere.clone();
  19220. return this;
  19221. }
  19222. /**
  19223. * Gets the color of the defined instance.
  19224. *
  19225. * @param {number} index - The instance index.
  19226. * @param {Color} color - The target object that is used to store the method's result.
  19227. */
  19228. getColorAt( index, color ) {
  19229. color.fromArray( this.instanceColor.array, index * 3 );
  19230. }
  19231. /**
  19232. * Gets the local transformation matrix of the defined instance.
  19233. *
  19234. * @param {number} index - The instance index.
  19235. * @param {Matrix4} matrix - The target object that is used to store the method's result.
  19236. */
  19237. getMatrixAt( index, matrix ) {
  19238. matrix.fromArray( this.instanceMatrix.array, index * 16 );
  19239. }
  19240. /**
  19241. * Gets the morph target weights of the defined instance.
  19242. *
  19243. * @param {number} index - The instance index.
  19244. * @param {Mesh} object - The target object that is used to store the method's result.
  19245. */
  19246. getMorphAt( index, object ) {
  19247. const objectInfluences = object.morphTargetInfluences;
  19248. const array = this.morphTexture.source.data.data;
  19249. const len = objectInfluences.length + 1; // All influences + the baseInfluenceSum
  19250. const dataIndex = index * len + 1; // Skip the baseInfluenceSum at the beginning
  19251. for ( let i = 0; i < objectInfluences.length; i ++ ) {
  19252. objectInfluences[ i ] = array[ dataIndex + i ];
  19253. }
  19254. }
  19255. raycast( raycaster, intersects ) {
  19256. const matrixWorld = this.matrixWorld;
  19257. const raycastTimes = this.count;
  19258. _mesh$1.geometry = this.geometry;
  19259. _mesh$1.material = this.material;
  19260. if ( _mesh$1.material === undefined ) return;
  19261. // test with bounding sphere first
  19262. if ( this.boundingSphere === null ) this.computeBoundingSphere();
  19263. _sphere$4.copy( this.boundingSphere );
  19264. _sphere$4.applyMatrix4( matrixWorld );
  19265. if ( raycaster.ray.intersectsSphere( _sphere$4 ) === false ) return;
  19266. // now test each instance
  19267. for ( let instanceId = 0; instanceId < raycastTimes; instanceId ++ ) {
  19268. // calculate the world matrix for each instance
  19269. this.getMatrixAt( instanceId, _instanceLocalMatrix );
  19270. _instanceWorldMatrix.multiplyMatrices( matrixWorld, _instanceLocalMatrix );
  19271. // the mesh represents this single instance
  19272. _mesh$1.matrixWorld = _instanceWorldMatrix;
  19273. _mesh$1.raycast( raycaster, _instanceIntersects );
  19274. // process the result of raycast
  19275. for ( let i = 0, l = _instanceIntersects.length; i < l; i ++ ) {
  19276. const intersect = _instanceIntersects[ i ];
  19277. intersect.instanceId = instanceId;
  19278. intersect.object = this;
  19279. intersects.push( intersect );
  19280. }
  19281. _instanceIntersects.length = 0;
  19282. }
  19283. }
  19284. /**
  19285. * Sets the given color to the defined instance. Make sure you set the `needsUpdate` flag of
  19286. * {@link InstancedMesh#instanceColor} to `true` after updating all the colors.
  19287. *
  19288. * @param {number} index - The instance index.
  19289. * @param {Color} color - The instance color.
  19290. */
  19291. setColorAt( index, color ) {
  19292. if ( this.instanceColor === null ) {
  19293. this.instanceColor = new InstancedBufferAttribute( new Float32Array( this.instanceMatrix.count * 3 ).fill( 1 ), 3 );
  19294. }
  19295. color.toArray( this.instanceColor.array, index * 3 );
  19296. }
  19297. /**
  19298. * Sets the given local transformation matrix to the defined instance. Make sure you set the `needsUpdate` flag of
  19299. * {@link InstancedMesh#instanceMatrix} to `true` after updating all the colors.
  19300. *
  19301. * @param {number} index - The instance index.
  19302. * @param {Matrix4} matrix - The local transformation.
  19303. */
  19304. setMatrixAt( index, matrix ) {
  19305. matrix.toArray( this.instanceMatrix.array, index * 16 );
  19306. }
  19307. /**
  19308. * Sets the morph target weights to the defined instance. Make sure you set the `needsUpdate` flag of
  19309. * {@link InstancedMesh#morphTexture} to `true` after updating all the influences.
  19310. *
  19311. * @param {number} index - The instance index.
  19312. * @param {Mesh} object - A mesh which `morphTargetInfluences` property containing the morph target weights
  19313. * of a single instance.
  19314. */
  19315. setMorphAt( index, object ) {
  19316. const objectInfluences = object.morphTargetInfluences;
  19317. const len = objectInfluences.length + 1; // morphBaseInfluence + all influences
  19318. if ( this.morphTexture === null ) {
  19319. this.morphTexture = new DataTexture( new Float32Array( len * this.count ), len, this.count, RedFormat, FloatType );
  19320. }
  19321. const array = this.morphTexture.source.data.data;
  19322. let morphInfluencesSum = 0;
  19323. for ( let i = 0; i < objectInfluences.length; i ++ ) {
  19324. morphInfluencesSum += objectInfluences[ i ];
  19325. }
  19326. const morphBaseInfluence = this.geometry.morphTargetsRelative ? 1 : 1 - morphInfluencesSum;
  19327. const dataIndex = len * index;
  19328. array[ dataIndex ] = morphBaseInfluence;
  19329. array.set( objectInfluences, dataIndex + 1 );
  19330. }
  19331. updateMorphTargets() {
  19332. }
  19333. /**
  19334. * Frees the GPU-related resources allocated by this instance. Call this
  19335. * method whenever this instance is no longer used in your app.
  19336. */
  19337. dispose() {
  19338. this.dispatchEvent( { type: 'dispose' } );
  19339. if ( this.morphTexture !== null ) {
  19340. this.morphTexture.dispose();
  19341. this.morphTexture = null;
  19342. }
  19343. }
  19344. }
  19345. const _vector1 = /*@__PURE__*/ new Vector3();
  19346. const _vector2 = /*@__PURE__*/ new Vector3();
  19347. const _normalMatrix = /*@__PURE__*/ new Matrix3();
  19348. /**
  19349. * A two dimensional surface that extends infinitely in 3D space, represented
  19350. * in [Hessian normal form](http://mathworld.wolfram.com/HessianNormalForm.html)
  19351. * by a unit length normal vector and a constant.
  19352. */
  19353. class Plane {
  19354. /**
  19355. * Constructs a new plane.
  19356. *
  19357. * @param {Vector3} [normal=(1,0,0)] - A unit length vector defining the normal of the plane.
  19358. * @param {number} [constant=0] - The signed distance from the origin to the plane.
  19359. */
  19360. constructor( normal = new Vector3( 1, 0, 0 ), constant = 0 ) {
  19361. /**
  19362. * This flag can be used for type testing.
  19363. *
  19364. * @type {boolean}
  19365. * @readonly
  19366. * @default true
  19367. */
  19368. this.isPlane = true;
  19369. /**
  19370. * A unit length vector defining the normal of the plane.
  19371. *
  19372. * @type {Vector3}
  19373. */
  19374. this.normal = normal;
  19375. /**
  19376. * The signed distance from the origin to the plane.
  19377. *
  19378. * @type {number}
  19379. * @default 0
  19380. */
  19381. this.constant = constant;
  19382. }
  19383. /**
  19384. * Sets the plane components by copying the given values.
  19385. *
  19386. * @param {Vector3} normal - The normal.
  19387. * @param {number} constant - The constant.
  19388. * @return {Plane} A reference to this plane.
  19389. */
  19390. set( normal, constant ) {
  19391. this.normal.copy( normal );
  19392. this.constant = constant;
  19393. return this;
  19394. }
  19395. /**
  19396. * Sets the plane components by defining `x`, `y`, `z` as the
  19397. * plane normal and `w` as the constant.
  19398. *
  19399. * @param {number} x - The value for the normal's x component.
  19400. * @param {number} y - The value for the normal's y component.
  19401. * @param {number} z - The value for the normal's z component.
  19402. * @param {number} w - The constant value.
  19403. * @return {Plane} A reference to this plane.
  19404. */
  19405. setComponents( x, y, z, w ) {
  19406. this.normal.set( x, y, z );
  19407. this.constant = w;
  19408. return this;
  19409. }
  19410. /**
  19411. * Sets the plane from the given normal and coplanar point (that is a point
  19412. * that lies onto the plane).
  19413. *
  19414. * @param {Vector3} normal - The normal.
  19415. * @param {Vector3} point - A coplanar point.
  19416. * @return {Plane} A reference to this plane.
  19417. */
  19418. setFromNormalAndCoplanarPoint( normal, point ) {
  19419. this.normal.copy( normal );
  19420. this.constant = - point.dot( this.normal );
  19421. return this;
  19422. }
  19423. /**
  19424. * Sets the plane from three coplanar points. The winding order is
  19425. * assumed to be counter-clockwise, and determines the direction of
  19426. * the plane normal.
  19427. *
  19428. * @param {Vector3} a - The first coplanar point.
  19429. * @param {Vector3} b - The second coplanar point.
  19430. * @param {Vector3} c - The third coplanar point.
  19431. * @return {Plane} A reference to this plane.
  19432. */
  19433. setFromCoplanarPoints( a, b, c ) {
  19434. const normal = _vector1.subVectors( c, b ).cross( _vector2.subVectors( a, b ) ).normalize();
  19435. // Q: should an error be thrown if normal is zero (e.g. degenerate plane)?
  19436. this.setFromNormalAndCoplanarPoint( normal, a );
  19437. return this;
  19438. }
  19439. /**
  19440. * Copies the values of the given plane to this instance.
  19441. *
  19442. * @param {Plane} plane - The plane to copy.
  19443. * @return {Plane} A reference to this plane.
  19444. */
  19445. copy( plane ) {
  19446. this.normal.copy( plane.normal );
  19447. this.constant = plane.constant;
  19448. return this;
  19449. }
  19450. /**
  19451. * Normalizes the plane normal and adjusts the constant accordingly.
  19452. *
  19453. * @return {Plane} A reference to this plane.
  19454. */
  19455. normalize() {
  19456. // Note: will lead to a divide by zero if the plane is invalid.
  19457. const inverseNormalLength = 1.0 / this.normal.length();
  19458. this.normal.multiplyScalar( inverseNormalLength );
  19459. this.constant *= inverseNormalLength;
  19460. return this;
  19461. }
  19462. /**
  19463. * Negates both the plane normal and the constant.
  19464. *
  19465. * @return {Plane} A reference to this plane.
  19466. */
  19467. negate() {
  19468. this.constant *= -1;
  19469. this.normal.negate();
  19470. return this;
  19471. }
  19472. /**
  19473. * Returns the signed distance from the given point to this plane.
  19474. *
  19475. * @param {Vector3} point - The point to compute the distance for.
  19476. * @return {number} The signed distance.
  19477. */
  19478. distanceToPoint( point ) {
  19479. return this.normal.dot( point ) + this.constant;
  19480. }
  19481. /**
  19482. * Returns the signed distance from the given sphere to this plane.
  19483. *
  19484. * @param {Sphere} sphere - The sphere to compute the distance for.
  19485. * @return {number} The signed distance.
  19486. */
  19487. distanceToSphere( sphere ) {
  19488. return this.distanceToPoint( sphere.center ) - sphere.radius;
  19489. }
  19490. /**
  19491. * Projects a the given point onto the plane.
  19492. *
  19493. * @param {Vector3} point - The point to project.
  19494. * @param {Vector3} target - The target vector that is used to store the method's result.
  19495. * @return {Vector3} The projected point on the plane.
  19496. */
  19497. projectPoint( point, target ) {
  19498. return target.copy( point ).addScaledVector( this.normal, - this.distanceToPoint( point ) );
  19499. }
  19500. /**
  19501. * Returns the intersection point of the passed line and the plane. Returns
  19502. * `null` if the line does not intersect. Returns the line's starting point if
  19503. * the line is coplanar with the plane.
  19504. *
  19505. * @param {Line3} line - The line to compute the intersection for.
  19506. * @param {Vector3} target - The target vector that is used to store the method's result.
  19507. * @return {?Vector3} The intersection point.
  19508. */
  19509. intersectLine( line, target ) {
  19510. const direction = line.delta( _vector1 );
  19511. const denominator = this.normal.dot( direction );
  19512. if ( denominator === 0 ) {
  19513. // line is coplanar, return origin
  19514. if ( this.distanceToPoint( line.start ) === 0 ) {
  19515. return target.copy( line.start );
  19516. }
  19517. // Unsure if this is the correct method to handle this case.
  19518. return null;
  19519. }
  19520. const t = - ( line.start.dot( this.normal ) + this.constant ) / denominator;
  19521. if ( t < 0 || t > 1 ) {
  19522. return null;
  19523. }
  19524. return target.copy( line.start ).addScaledVector( direction, t );
  19525. }
  19526. /**
  19527. * Returns `true` if the given line segment intersects with (passes through) the plane.
  19528. *
  19529. * @param {Line3} line - The line to test.
  19530. * @return {boolean} Whether the given line segment intersects with the plane or not.
  19531. */
  19532. intersectsLine( line ) {
  19533. // Note: this tests if a line intersects the plane, not whether it (or its end-points) are coplanar with it.
  19534. const startSign = this.distanceToPoint( line.start );
  19535. const endSign = this.distanceToPoint( line.end );
  19536. return ( startSign < 0 && endSign > 0 ) || ( endSign < 0 && startSign > 0 );
  19537. }
  19538. /**
  19539. * Returns `true` if the given bounding box intersects with the plane.
  19540. *
  19541. * @param {Box3} box - The bounding box to test.
  19542. * @return {boolean} Whether the given bounding box intersects with the plane or not.
  19543. */
  19544. intersectsBox( box ) {
  19545. return box.intersectsPlane( this );
  19546. }
  19547. /**
  19548. * Returns `true` if the given bounding sphere intersects with the plane.
  19549. *
  19550. * @param {Sphere} sphere - The bounding sphere to test.
  19551. * @return {boolean} Whether the given bounding sphere intersects with the plane or not.
  19552. */
  19553. intersectsSphere( sphere ) {
  19554. return sphere.intersectsPlane( this );
  19555. }
  19556. /**
  19557. * Returns a coplanar vector to the plane, by calculating the
  19558. * projection of the normal at the origin onto the plane.
  19559. *
  19560. * @param {Vector3} target - The target vector that is used to store the method's result.
  19561. * @return {Vector3} The coplanar point.
  19562. */
  19563. coplanarPoint( target ) {
  19564. return target.copy( this.normal ).multiplyScalar( - this.constant );
  19565. }
  19566. /**
  19567. * Apply a 4x4 matrix to the plane. The matrix must be an affine, homogeneous transform.
  19568. *
  19569. * The optional normal matrix can be pre-computed like so:
  19570. * ```js
  19571. * const optionalNormalMatrix = new THREE.Matrix3().getNormalMatrix( matrix );
  19572. * ```
  19573. *
  19574. * @param {Matrix4} matrix - The transformation matrix.
  19575. * @param {Matrix4} [optionalNormalMatrix] - A pre-computed normal matrix.
  19576. * @return {Plane} A reference to this plane.
  19577. */
  19578. applyMatrix4( matrix, optionalNormalMatrix ) {
  19579. const normalMatrix = optionalNormalMatrix || _normalMatrix.getNormalMatrix( matrix );
  19580. const referencePoint = this.coplanarPoint( _vector1 ).applyMatrix4( matrix );
  19581. const normal = this.normal.applyMatrix3( normalMatrix ).normalize();
  19582. this.constant = - referencePoint.dot( normal );
  19583. return this;
  19584. }
  19585. /**
  19586. * Translates the plane by the distance defined by the given offset vector.
  19587. * Note that this only affects the plane constant and will not affect the normal vector.
  19588. *
  19589. * @param {Vector3} offset - The offset vector.
  19590. * @return {Plane} A reference to this plane.
  19591. */
  19592. translate( offset ) {
  19593. this.constant -= offset.dot( this.normal );
  19594. return this;
  19595. }
  19596. /**
  19597. * Returns `true` if this plane is equal with the given one.
  19598. *
  19599. * @param {Plane} plane - The plane to test for equality.
  19600. * @return {boolean} Whether this plane is equal with the given one.
  19601. */
  19602. equals( plane ) {
  19603. return plane.normal.equals( this.normal ) && ( plane.constant === this.constant );
  19604. }
  19605. /**
  19606. * Returns a new plane with copied values from this instance.
  19607. *
  19608. * @return {Plane} A clone of this instance.
  19609. */
  19610. clone() {
  19611. return new this.constructor().copy( this );
  19612. }
  19613. }
  19614. const _sphere$3 = /*@__PURE__*/ new Sphere();
  19615. const _defaultSpriteCenter = /*@__PURE__*/ new Vector2( 0.5, 0.5 );
  19616. const _vector$6 = /*@__PURE__*/ new Vector3();
  19617. /**
  19618. * Frustums are used to determine what is inside the camera's field of view.
  19619. * They help speed up the rendering process - objects which lie outside a camera's
  19620. * frustum can safely be excluded from rendering.
  19621. *
  19622. * This class is mainly intended for use internally by a renderer.
  19623. */
  19624. class Frustum {
  19625. /**
  19626. * Constructs a new frustum.
  19627. *
  19628. * @param {Plane} [p0] - The first plane that encloses the frustum.
  19629. * @param {Plane} [p1] - The second plane that encloses the frustum.
  19630. * @param {Plane} [p2] - The third plane that encloses the frustum.
  19631. * @param {Plane} [p3] - The fourth plane that encloses the frustum.
  19632. * @param {Plane} [p4] - The fifth plane that encloses the frustum.
  19633. * @param {Plane} [p5] - The sixth plane that encloses the frustum.
  19634. */
  19635. constructor( p0 = new Plane(), p1 = new Plane(), p2 = new Plane(), p3 = new Plane(), p4 = new Plane(), p5 = new Plane() ) {
  19636. /**
  19637. * This array holds the planes that enclose the frustum.
  19638. *
  19639. * @type {Array<Plane>}
  19640. */
  19641. this.planes = [ p0, p1, p2, p3, p4, p5 ];
  19642. }
  19643. /**
  19644. * Sets the frustum planes by copying the given planes.
  19645. *
  19646. * @param {Plane} [p0] - The first plane that encloses the frustum.
  19647. * @param {Plane} [p1] - The second plane that encloses the frustum.
  19648. * @param {Plane} [p2] - The third plane that encloses the frustum.
  19649. * @param {Plane} [p3] - The fourth plane that encloses the frustum.
  19650. * @param {Plane} [p4] - The fifth plane that encloses the frustum.
  19651. * @param {Plane} [p5] - The sixth plane that encloses the frustum.
  19652. * @return {Frustum} A reference to this frustum.
  19653. */
  19654. set( p0, p1, p2, p3, p4, p5 ) {
  19655. const planes = this.planes;
  19656. planes[ 0 ].copy( p0 );
  19657. planes[ 1 ].copy( p1 );
  19658. planes[ 2 ].copy( p2 );
  19659. planes[ 3 ].copy( p3 );
  19660. planes[ 4 ].copy( p4 );
  19661. planes[ 5 ].copy( p5 );
  19662. return this;
  19663. }
  19664. /**
  19665. * Copies the values of the given frustum to this instance.
  19666. *
  19667. * @param {Frustum} frustum - The frustum to copy.
  19668. * @return {Frustum} A reference to this frustum.
  19669. */
  19670. copy( frustum ) {
  19671. const planes = this.planes;
  19672. for ( let i = 0; i < 6; i ++ ) {
  19673. planes[ i ].copy( frustum.planes[ i ] );
  19674. }
  19675. return this;
  19676. }
  19677. /**
  19678. * Sets the frustum planes from the given projection matrix.
  19679. *
  19680. * @param {Matrix4} m - The projection matrix.
  19681. * @param {(WebGLCoordinateSystem|WebGPUCoordinateSystem)} coordinateSystem - The coordinate system.
  19682. * @param {boolean} [reversedDepth=false] - Whether to use a reversed depth.
  19683. * @return {Frustum} A reference to this frustum.
  19684. */
  19685. setFromProjectionMatrix( m, coordinateSystem = WebGLCoordinateSystem, reversedDepth = false ) {
  19686. const planes = this.planes;
  19687. const me = m.elements;
  19688. const me0 = me[ 0 ], me1 = me[ 1 ], me2 = me[ 2 ], me3 = me[ 3 ];
  19689. const me4 = me[ 4 ], me5 = me[ 5 ], me6 = me[ 6 ], me7 = me[ 7 ];
  19690. const me8 = me[ 8 ], me9 = me[ 9 ], me10 = me[ 10 ], me11 = me[ 11 ];
  19691. const me12 = me[ 12 ], me13 = me[ 13 ], me14 = me[ 14 ], me15 = me[ 15 ];
  19692. planes[ 0 ].setComponents( me3 - me0, me7 - me4, me11 - me8, me15 - me12 ).normalize();
  19693. planes[ 1 ].setComponents( me3 + me0, me7 + me4, me11 + me8, me15 + me12 ).normalize();
  19694. planes[ 2 ].setComponents( me3 + me1, me7 + me5, me11 + me9, me15 + me13 ).normalize();
  19695. planes[ 3 ].setComponents( me3 - me1, me7 - me5, me11 - me9, me15 - me13 ).normalize();
  19696. if ( reversedDepth ) {
  19697. planes[ 4 ].setComponents( me2, me6, me10, me14 ).normalize(); // far
  19698. planes[ 5 ].setComponents( me3 - me2, me7 - me6, me11 - me10, me15 - me14 ).normalize(); // near
  19699. } else {
  19700. planes[ 4 ].setComponents( me3 - me2, me7 - me6, me11 - me10, me15 - me14 ).normalize(); // far
  19701. if ( coordinateSystem === WebGLCoordinateSystem ) {
  19702. planes[ 5 ].setComponents( me3 + me2, me7 + me6, me11 + me10, me15 + me14 ).normalize(); // near
  19703. } else if ( coordinateSystem === WebGPUCoordinateSystem ) {
  19704. planes[ 5 ].setComponents( me2, me6, me10, me14 ).normalize(); // near
  19705. } else {
  19706. throw new Error( 'THREE.Frustum.setFromProjectionMatrix(): Invalid coordinate system: ' + coordinateSystem );
  19707. }
  19708. }
  19709. return this;
  19710. }
  19711. /**
  19712. * Returns `true` if the 3D object's bounding sphere is intersecting this frustum.
  19713. *
  19714. * Note that the 3D object must have a geometry so that the bounding sphere can be calculated.
  19715. *
  19716. * @param {Object3D} object - The 3D object to test.
  19717. * @return {boolean} Whether the 3D object's bounding sphere is intersecting this frustum or not.
  19718. */
  19719. intersectsObject( object ) {
  19720. if ( object.boundingSphere !== undefined ) {
  19721. if ( object.boundingSphere === null ) object.computeBoundingSphere();
  19722. _sphere$3.copy( object.boundingSphere ).applyMatrix4( object.matrixWorld );
  19723. } else {
  19724. const geometry = object.geometry;
  19725. if ( geometry.boundingSphere === null ) geometry.computeBoundingSphere();
  19726. _sphere$3.copy( geometry.boundingSphere ).applyMatrix4( object.matrixWorld );
  19727. }
  19728. return this.intersectsSphere( _sphere$3 );
  19729. }
  19730. /**
  19731. * Returns `true` if the given sprite is intersecting this frustum.
  19732. *
  19733. * @param {Sprite} sprite - The sprite to test.
  19734. * @return {boolean} Whether the sprite is intersecting this frustum or not.
  19735. */
  19736. intersectsSprite( sprite ) {
  19737. _sphere$3.center.set( 0, 0, 0 );
  19738. const offset = _defaultSpriteCenter.distanceTo( sprite.center );
  19739. _sphere$3.radius = 0.7071067811865476 + offset;
  19740. _sphere$3.applyMatrix4( sprite.matrixWorld );
  19741. return this.intersectsSphere( _sphere$3 );
  19742. }
  19743. /**
  19744. * Returns `true` if the given bounding sphere is intersecting this frustum.
  19745. *
  19746. * @param {Sphere} sphere - The bounding sphere to test.
  19747. * @return {boolean} Whether the bounding sphere is intersecting this frustum or not.
  19748. */
  19749. intersectsSphere( sphere ) {
  19750. const planes = this.planes;
  19751. const center = sphere.center;
  19752. const negRadius = - sphere.radius;
  19753. for ( let i = 0; i < 6; i ++ ) {
  19754. const distance = planes[ i ].distanceToPoint( center );
  19755. if ( distance < negRadius ) {
  19756. return false;
  19757. }
  19758. }
  19759. return true;
  19760. }
  19761. /**
  19762. * Returns `true` if the given bounding box is intersecting this frustum.
  19763. *
  19764. * @param {Box3} box - The bounding box to test.
  19765. * @return {boolean} Whether the bounding box is intersecting this frustum or not.
  19766. */
  19767. intersectsBox( box ) {
  19768. const planes = this.planes;
  19769. for ( let i = 0; i < 6; i ++ ) {
  19770. const plane = planes[ i ];
  19771. // corner at max distance
  19772. _vector$6.x = plane.normal.x > 0 ? box.max.x : box.min.x;
  19773. _vector$6.y = plane.normal.y > 0 ? box.max.y : box.min.y;
  19774. _vector$6.z = plane.normal.z > 0 ? box.max.z : box.min.z;
  19775. if ( plane.distanceToPoint( _vector$6 ) < 0 ) {
  19776. return false;
  19777. }
  19778. }
  19779. return true;
  19780. }
  19781. /**
  19782. * Returns `true` if the given point lies within the frustum.
  19783. *
  19784. * @param {Vector3} point - The point to test.
  19785. * @return {boolean} Whether the point lies within this frustum or not.
  19786. */
  19787. containsPoint( point ) {
  19788. const planes = this.planes;
  19789. for ( let i = 0; i < 6; i ++ ) {
  19790. if ( planes[ i ].distanceToPoint( point ) < 0 ) {
  19791. return false;
  19792. }
  19793. }
  19794. return true;
  19795. }
  19796. /**
  19797. * Returns a new frustum with copied values from this instance.
  19798. *
  19799. * @return {Frustum} A clone of this instance.
  19800. */
  19801. clone() {
  19802. return new this.constructor().copy( this );
  19803. }
  19804. }
  19805. const _projScreenMatrix$1 = /*@__PURE__*/ new Matrix4();
  19806. const _frustum$1 = /*@__PURE__*/ new Frustum();
  19807. /**
  19808. * FrustumArray is used to determine if an object is visible in at least one camera
  19809. * from an array of cameras. This is particularly useful for multi-view renderers.
  19810. */
  19811. class FrustumArray {
  19812. /**
  19813. * Constructs a new frustum array.
  19814. *
  19815. */
  19816. constructor() {
  19817. /**
  19818. * The coordinate system to use.
  19819. *
  19820. * @type {WebGLCoordinateSystem|WebGPUCoordinateSystem}
  19821. * @default WebGLCoordinateSystem
  19822. */
  19823. this.coordinateSystem = WebGLCoordinateSystem;
  19824. }
  19825. /**
  19826. * Returns `true` if the 3D object's bounding sphere is intersecting any frustum
  19827. * from the camera array.
  19828. *
  19829. * @param {Object3D} object - The 3D object to test.
  19830. * @param {Object} cameraArray - An object with a cameras property containing an array of cameras.
  19831. * @return {boolean} Whether the 3D object is visible in any camera.
  19832. */
  19833. intersectsObject( object, cameraArray ) {
  19834. if ( ! cameraArray.isArrayCamera || cameraArray.cameras.length === 0 ) {
  19835. return false;
  19836. }
  19837. for ( let i = 0; i < cameraArray.cameras.length; i ++ ) {
  19838. const camera = cameraArray.cameras[ i ];
  19839. _projScreenMatrix$1.multiplyMatrices(
  19840. camera.projectionMatrix,
  19841. camera.matrixWorldInverse
  19842. );
  19843. _frustum$1.setFromProjectionMatrix(
  19844. _projScreenMatrix$1,
  19845. camera.coordinateSystem,
  19846. camera.reversedDepth
  19847. );
  19848. if ( _frustum$1.intersectsObject( object ) ) {
  19849. return true; // Object is visible in at least one camera
  19850. }
  19851. }
  19852. return false; // Not visible in any camera
  19853. }
  19854. /**
  19855. * Returns `true` if the given sprite is intersecting any frustum
  19856. * from the camera array.
  19857. *
  19858. * @param {Sprite} sprite - The sprite to test.
  19859. * @param {Object} cameraArray - An object with a cameras property containing an array of cameras.
  19860. * @return {boolean} Whether the sprite is visible in any camera.
  19861. */
  19862. intersectsSprite( sprite, cameraArray ) {
  19863. if ( ! cameraArray || ! cameraArray.cameras || cameraArray.cameras.length === 0 ) {
  19864. return false;
  19865. }
  19866. for ( let i = 0; i < cameraArray.cameras.length; i ++ ) {
  19867. const camera = cameraArray.cameras[ i ];
  19868. _projScreenMatrix$1.multiplyMatrices(
  19869. camera.projectionMatrix,
  19870. camera.matrixWorldInverse
  19871. );
  19872. _frustum$1.setFromProjectionMatrix(
  19873. _projScreenMatrix$1,
  19874. camera.coordinateSystem,
  19875. camera.reversedDepth
  19876. );
  19877. if ( _frustum$1.intersectsSprite( sprite ) ) {
  19878. return true; // Sprite is visible in at least one camera
  19879. }
  19880. }
  19881. return false; // Not visible in any camera
  19882. }
  19883. /**
  19884. * Returns `true` if the given bounding sphere is intersecting any frustum
  19885. * from the camera array.
  19886. *
  19887. * @param {Sphere} sphere - The bounding sphere to test.
  19888. * @param {Object} cameraArray - An object with a cameras property containing an array of cameras.
  19889. * @return {boolean} Whether the sphere is visible in any camera.
  19890. */
  19891. intersectsSphere( sphere, cameraArray ) {
  19892. if ( ! cameraArray || ! cameraArray.cameras || cameraArray.cameras.length === 0 ) {
  19893. return false;
  19894. }
  19895. for ( let i = 0; i < cameraArray.cameras.length; i ++ ) {
  19896. const camera = cameraArray.cameras[ i ];
  19897. _projScreenMatrix$1.multiplyMatrices(
  19898. camera.projectionMatrix,
  19899. camera.matrixWorldInverse
  19900. );
  19901. _frustum$1.setFromProjectionMatrix(
  19902. _projScreenMatrix$1,
  19903. camera.coordinateSystem,
  19904. camera.reversedDepth
  19905. );
  19906. if ( _frustum$1.intersectsSphere( sphere ) ) {
  19907. return true; // Sphere is visible in at least one camera
  19908. }
  19909. }
  19910. return false; // Not visible in any camera
  19911. }
  19912. /**
  19913. * Returns `true` if the given bounding box is intersecting any frustum
  19914. * from the camera array.
  19915. *
  19916. * @param {Box3} box - The bounding box to test.
  19917. * @param {Object} cameraArray - An object with a cameras property containing an array of cameras.
  19918. * @return {boolean} Whether the box is visible in any camera.
  19919. */
  19920. intersectsBox( box, cameraArray ) {
  19921. if ( ! cameraArray || ! cameraArray.cameras || cameraArray.cameras.length === 0 ) {
  19922. return false;
  19923. }
  19924. for ( let i = 0; i < cameraArray.cameras.length; i ++ ) {
  19925. const camera = cameraArray.cameras[ i ];
  19926. _projScreenMatrix$1.multiplyMatrices(
  19927. camera.projectionMatrix,
  19928. camera.matrixWorldInverse
  19929. );
  19930. _frustum$1.setFromProjectionMatrix(
  19931. _projScreenMatrix$1,
  19932. camera.coordinateSystem,
  19933. camera.reversedDepth
  19934. );
  19935. if ( _frustum$1.intersectsBox( box ) ) {
  19936. return true; // Box is visible in at least one camera
  19937. }
  19938. }
  19939. return false; // Not visible in any camera
  19940. }
  19941. /**
  19942. * Returns `true` if the given point lies within any frustum
  19943. * from the camera array.
  19944. *
  19945. * @param {Vector3} point - The point to test.
  19946. * @param {Object} cameraArray - An object with a cameras property containing an array of cameras.
  19947. * @return {boolean} Whether the point is visible in any camera.
  19948. */
  19949. containsPoint( point, cameraArray ) {
  19950. if ( ! cameraArray || ! cameraArray.cameras || cameraArray.cameras.length === 0 ) {
  19951. return false;
  19952. }
  19953. for ( let i = 0; i < cameraArray.cameras.length; i ++ ) {
  19954. const camera = cameraArray.cameras[ i ];
  19955. _projScreenMatrix$1.multiplyMatrices(
  19956. camera.projectionMatrix,
  19957. camera.matrixWorldInverse
  19958. );
  19959. _frustum$1.setFromProjectionMatrix(
  19960. _projScreenMatrix$1,
  19961. camera.coordinateSystem,
  19962. camera.reversedDepth
  19963. );
  19964. if ( _frustum$1.containsPoint( point ) ) {
  19965. return true; // Point is visible in at least one camera
  19966. }
  19967. }
  19968. return false; // Not visible in any camera
  19969. }
  19970. /**
  19971. * Returns a new frustum array with copied values from this instance.
  19972. *
  19973. * @return {FrustumArray} A clone of this instance.
  19974. */
  19975. clone() {
  19976. return new FrustumArray();
  19977. }
  19978. }
  19979. function ascIdSort( a, b ) {
  19980. return a - b;
  19981. }
  19982. function sortOpaque( a, b ) {
  19983. return a.z - b.z;
  19984. }
  19985. function sortTransparent( a, b ) {
  19986. return b.z - a.z;
  19987. }
  19988. class MultiDrawRenderList {
  19989. constructor() {
  19990. this.index = 0;
  19991. this.pool = [];
  19992. this.list = [];
  19993. }
  19994. push( start, count, z, index ) {
  19995. const pool = this.pool;
  19996. const list = this.list;
  19997. if ( this.index >= pool.length ) {
  19998. pool.push( {
  19999. start: -1,
  20000. count: -1,
  20001. z: -1,
  20002. index: -1,
  20003. } );
  20004. }
  20005. const item = pool[ this.index ];
  20006. list.push( item );
  20007. this.index ++;
  20008. item.start = start;
  20009. item.count = count;
  20010. item.z = z;
  20011. item.index = index;
  20012. }
  20013. reset() {
  20014. this.list.length = 0;
  20015. this.index = 0;
  20016. }
  20017. }
  20018. const _matrix$1 = /*@__PURE__*/ new Matrix4();
  20019. const _whiteColor = /*@__PURE__*/ new Color( 1, 1, 1 );
  20020. const _frustum = /*@__PURE__*/ new Frustum();
  20021. const _frustumArray = /*@__PURE__*/ new FrustumArray();
  20022. const _box$1 = /*@__PURE__*/ new Box3();
  20023. const _sphere$2 = /*@__PURE__*/ new Sphere();
  20024. const _vector$5 = /*@__PURE__*/ new Vector3();
  20025. const _forward$1 = /*@__PURE__*/ new Vector3();
  20026. const _temp = /*@__PURE__*/ new Vector3();
  20027. const _renderList = /*@__PURE__*/ new MultiDrawRenderList();
  20028. const _mesh = /*@__PURE__*/ new Mesh();
  20029. const _batchIntersects = [];
  20030. // copies data from attribute "src" into "target" starting at "targetOffset"
  20031. function copyAttributeData( src, target, targetOffset = 0 ) {
  20032. const itemSize = target.itemSize;
  20033. if ( src.isInterleavedBufferAttribute || src.array.constructor !== target.array.constructor ) {
  20034. // use the component getters and setters if the array data cannot
  20035. // be copied directly
  20036. const vertexCount = src.count;
  20037. for ( let i = 0; i < vertexCount; i ++ ) {
  20038. for ( let c = 0; c < itemSize; c ++ ) {
  20039. target.setComponent( i + targetOffset, c, src.getComponent( i, c ) );
  20040. }
  20041. }
  20042. } else {
  20043. // faster copy approach using typed array set function
  20044. target.array.set( src.array, targetOffset * itemSize );
  20045. }
  20046. target.needsUpdate = true;
  20047. }
  20048. // safely copies array contents to a potentially smaller array
  20049. function copyArrayContents( src, target ) {
  20050. if ( src.constructor !== target.constructor ) {
  20051. // if arrays are of a different type (eg due to index size increasing) then data must be per-element copied
  20052. const len = Math.min( src.length, target.length );
  20053. for ( let i = 0; i < len; i ++ ) {
  20054. target[ i ] = src[ i ];
  20055. }
  20056. } else {
  20057. // if the arrays use the same data layout we can use a fast block copy
  20058. const len = Math.min( src.length, target.length );
  20059. target.set( new src.constructor( src.buffer, 0, len ) );
  20060. }
  20061. }
  20062. /**
  20063. * A special version of a mesh with multi draw batch rendering support. Use
  20064. * this class if you have to render a large number of objects with the same
  20065. * material but with different geometries or world transformations. The usage of
  20066. * `BatchedMesh` will help you to reduce the number of draw calls and thus improve the overall
  20067. * rendering performance in your application.
  20068. *
  20069. * ```js
  20070. * const box = new THREE.BoxGeometry( 1, 1, 1 );
  20071. * const sphere = new THREE.SphereGeometry( 1, 12, 12 );
  20072. * const material = new THREE.MeshBasicMaterial( { color: 0x00ff00 } );
  20073. *
  20074. * // initialize and add geometries into the batched mesh
  20075. * const batchedMesh = new BatchedMesh( 10, 5000, 10000, material );
  20076. * const boxGeometryId = batchedMesh.addGeometry( box );
  20077. * const sphereGeometryId = batchedMesh.addGeometry( sphere );
  20078. *
  20079. * // create instances of those geometries
  20080. * const boxInstancedId1 = batchedMesh.addInstance( boxGeometryId );
  20081. * const boxInstancedId2 = batchedMesh.addInstance( boxGeometryId );
  20082. *
  20083. * const sphereInstancedId1 = batchedMesh.addInstance( sphereGeometryId );
  20084. * const sphereInstancedId2 = batchedMesh.addInstance( sphereGeometryId );
  20085. *
  20086. * // position the geometries
  20087. * batchedMesh.setMatrixAt( boxInstancedId1, boxMatrix1 );
  20088. * batchedMesh.setMatrixAt( boxInstancedId2, boxMatrix2 );
  20089. *
  20090. * batchedMesh.setMatrixAt( sphereInstancedId1, sphereMatrix1 );
  20091. * batchedMesh.setMatrixAt( sphereInstancedId2, sphereMatrix2 );
  20092. *
  20093. * scene.add( batchedMesh );
  20094. * ```
  20095. *
  20096. * @augments Mesh
  20097. */
  20098. class BatchedMesh extends Mesh {
  20099. /**
  20100. * Constructs a new batched mesh.
  20101. *
  20102. * @param {number} maxInstanceCount - The maximum number of individual instances planned to be added and rendered.
  20103. * @param {number} maxVertexCount - The maximum number of vertices to be used by all unique geometries.
  20104. * @param {number} [maxIndexCount=maxVertexCount*2] - The maximum number of indices to be used by all unique geometries
  20105. * @param {Material|Array<Material>} [material] - The mesh material.
  20106. */
  20107. constructor( maxInstanceCount, maxVertexCount, maxIndexCount = maxVertexCount * 2, material ) {
  20108. super( new BufferGeometry(), material );
  20109. /**
  20110. * This flag can be used for type testing.
  20111. *
  20112. * @type {boolean}
  20113. * @readonly
  20114. * @default true
  20115. */
  20116. this.isBatchedMesh = true;
  20117. /**
  20118. * When set ot `true`, the individual objects of a batch are frustum culled.
  20119. *
  20120. * @type {boolean}
  20121. * @default true
  20122. */
  20123. this.perObjectFrustumCulled = true;
  20124. /**
  20125. * When set to `true`, the individual objects of a batch are sorted to improve overdraw-related artifacts.
  20126. * If the material is marked as "transparent" objects are rendered back to front and if not then they are
  20127. * rendered front to back.
  20128. *
  20129. * @type {boolean}
  20130. * @default true
  20131. */
  20132. this.sortObjects = true;
  20133. /**
  20134. * The bounding box of the batched mesh. Can be computed via {@link BatchedMesh#computeBoundingBox}.
  20135. *
  20136. * @type {?Box3}
  20137. * @default null
  20138. */
  20139. this.boundingBox = null;
  20140. /**
  20141. * The bounding sphere of the batched mesh. Can be computed via {@link BatchedMesh#computeBoundingSphere}.
  20142. *
  20143. * @type {?Sphere}
  20144. * @default null
  20145. */
  20146. this.boundingSphere = null;
  20147. /**
  20148. * Takes a sort a function that is run before render. The function takes a list of instances to
  20149. * sort and a camera. The objects in the list include a "z" field to perform a depth-ordered
  20150. * sort with.
  20151. *
  20152. * @type {?Function}
  20153. * @default null
  20154. */
  20155. this.customSort = null;
  20156. // stores visible, active, and geometry id per instance and reserved buffer ranges for geometries
  20157. this._instanceInfo = [];
  20158. this._geometryInfo = [];
  20159. // instance, geometry ids that have been set as inactive, and are available to be overwritten
  20160. this._availableInstanceIds = [];
  20161. this._availableGeometryIds = [];
  20162. // used to track where the next point is that geometry should be inserted
  20163. this._nextIndexStart = 0;
  20164. this._nextVertexStart = 0;
  20165. this._geometryCount = 0;
  20166. // flags
  20167. this._visibilityChanged = true;
  20168. this._geometryInitialized = false;
  20169. // cached user options
  20170. this._maxInstanceCount = maxInstanceCount;
  20171. this._maxVertexCount = maxVertexCount;
  20172. this._maxIndexCount = maxIndexCount;
  20173. // buffers for multi draw
  20174. this._multiDrawCounts = new Int32Array( maxInstanceCount );
  20175. this._multiDrawStarts = new Int32Array( maxInstanceCount );
  20176. this._multiDrawCount = 0;
  20177. this._multiDrawInstances = null;
  20178. // Local matrix per geometry by using data texture
  20179. this._matricesTexture = null;
  20180. this._indirectTexture = null;
  20181. this._colorsTexture = null;
  20182. this._initMatricesTexture();
  20183. this._initIndirectTexture();
  20184. }
  20185. /**
  20186. * The maximum number of individual instances that can be stored in the batch.
  20187. *
  20188. * @type {number}
  20189. * @readonly
  20190. */
  20191. get maxInstanceCount() {
  20192. return this._maxInstanceCount;
  20193. }
  20194. /**
  20195. * The instance count.
  20196. *
  20197. * @type {number}
  20198. * @readonly
  20199. */
  20200. get instanceCount() {
  20201. return this._instanceInfo.length - this._availableInstanceIds.length;
  20202. }
  20203. /**
  20204. * The number of unused vertices.
  20205. *
  20206. * @type {number}
  20207. * @readonly
  20208. */
  20209. get unusedVertexCount() {
  20210. return this._maxVertexCount - this._nextVertexStart;
  20211. }
  20212. /**
  20213. * The number of unused indices.
  20214. *
  20215. * @type {number}
  20216. * @readonly
  20217. */
  20218. get unusedIndexCount() {
  20219. return this._maxIndexCount - this._nextIndexStart;
  20220. }
  20221. _initMatricesTexture() {
  20222. // layout (1 matrix = 4 pixels)
  20223. // RGBA RGBA RGBA RGBA (=> column1, column2, column3, column4)
  20224. // with 8x8 pixel texture max 16 matrices * 4 pixels = (8 * 8)
  20225. // 16x16 pixel texture max 64 matrices * 4 pixels = (16 * 16)
  20226. // 32x32 pixel texture max 256 matrices * 4 pixels = (32 * 32)
  20227. // 64x64 pixel texture max 1024 matrices * 4 pixels = (64 * 64)
  20228. let size = Math.sqrt( this._maxInstanceCount * 4 ); // 4 pixels needed for 1 matrix
  20229. size = Math.ceil( size / 4 ) * 4;
  20230. size = Math.max( size, 4 );
  20231. const matricesArray = new Float32Array( size * size * 4 ); // 4 floats per RGBA pixel
  20232. const matricesTexture = new DataTexture( matricesArray, size, size, RGBAFormat, FloatType );
  20233. this._matricesTexture = matricesTexture;
  20234. }
  20235. _initIndirectTexture() {
  20236. let size = Math.sqrt( this._maxInstanceCount );
  20237. size = Math.ceil( size );
  20238. const indirectArray = new Uint32Array( size * size );
  20239. const indirectTexture = new DataTexture( indirectArray, size, size, RedIntegerFormat, UnsignedIntType );
  20240. this._indirectTexture = indirectTexture;
  20241. }
  20242. _initColorsTexture() {
  20243. let size = Math.sqrt( this._maxInstanceCount );
  20244. size = Math.ceil( size );
  20245. // 4 floats per RGBA pixel initialized to white
  20246. const colorsArray = new Float32Array( size * size * 4 ).fill( 1 );
  20247. const colorsTexture = new DataTexture( colorsArray, size, size, RGBAFormat, FloatType );
  20248. colorsTexture.colorSpace = ColorManagement.workingColorSpace;
  20249. this._colorsTexture = colorsTexture;
  20250. }
  20251. _initializeGeometry( reference ) {
  20252. const geometry = this.geometry;
  20253. const maxVertexCount = this._maxVertexCount;
  20254. const maxIndexCount = this._maxIndexCount;
  20255. if ( this._geometryInitialized === false ) {
  20256. for ( const attributeName in reference.attributes ) {
  20257. const srcAttribute = reference.getAttribute( attributeName );
  20258. const { array, itemSize, normalized } = srcAttribute;
  20259. const dstArray = new array.constructor( maxVertexCount * itemSize );
  20260. const dstAttribute = new BufferAttribute( dstArray, itemSize, normalized );
  20261. geometry.setAttribute( attributeName, dstAttribute );
  20262. }
  20263. if ( reference.getIndex() !== null ) {
  20264. // Reserve last u16 index for primitive restart.
  20265. const indexArray = maxVertexCount > 65535
  20266. ? new Uint32Array( maxIndexCount )
  20267. : new Uint16Array( maxIndexCount );
  20268. geometry.setIndex( new BufferAttribute( indexArray, 1 ) );
  20269. }
  20270. this._geometryInitialized = true;
  20271. }
  20272. }
  20273. // Make sure the geometry is compatible with the existing combined geometry attributes
  20274. _validateGeometry( geometry ) {
  20275. // check to ensure the geometries are using consistent attributes and indices
  20276. const batchGeometry = this.geometry;
  20277. if ( Boolean( geometry.getIndex() ) !== Boolean( batchGeometry.getIndex() ) ) {
  20278. throw new Error( 'THREE.BatchedMesh: All geometries must consistently have "index".' );
  20279. }
  20280. for ( const attributeName in batchGeometry.attributes ) {
  20281. if ( ! geometry.hasAttribute( attributeName ) ) {
  20282. throw new Error( `THREE.BatchedMesh: Added geometry missing "${ attributeName }". All geometries must have consistent attributes.` );
  20283. }
  20284. const srcAttribute = geometry.getAttribute( attributeName );
  20285. const dstAttribute = batchGeometry.getAttribute( attributeName );
  20286. if ( srcAttribute.itemSize !== dstAttribute.itemSize || srcAttribute.normalized !== dstAttribute.normalized ) {
  20287. throw new Error( 'THREE.BatchedMesh: All attributes must have a consistent itemSize and normalized value.' );
  20288. }
  20289. }
  20290. }
  20291. /**
  20292. * Validates the instance defined by the given ID.
  20293. *
  20294. * @param {number} instanceId - The instance to validate.
  20295. */
  20296. validateInstanceId( instanceId ) {
  20297. const instanceInfo = this._instanceInfo;
  20298. if ( instanceId < 0 || instanceId >= instanceInfo.length || instanceInfo[ instanceId ].active === false ) {
  20299. throw new Error( `THREE.BatchedMesh: Invalid instanceId ${instanceId}. Instance is either out of range or has been deleted.` );
  20300. }
  20301. }
  20302. /**
  20303. * Validates the geometry defined by the given ID.
  20304. *
  20305. * @param {number} geometryId - The geometry to validate.
  20306. */
  20307. validateGeometryId( geometryId ) {
  20308. const geometryInfoList = this._geometryInfo;
  20309. if ( geometryId < 0 || geometryId >= geometryInfoList.length || geometryInfoList[ geometryId ].active === false ) {
  20310. throw new Error( `THREE.BatchedMesh: Invalid geometryId ${geometryId}. Geometry is either out of range or has been deleted.` );
  20311. }
  20312. }
  20313. /**
  20314. * Takes a sort a function that is run before render. The function takes a list of instances to
  20315. * sort and a camera. The objects in the list include a "z" field to perform a depth-ordered sort with.
  20316. *
  20317. * @param {Function} func - The custom sort function.
  20318. * @return {BatchedMesh} A reference to this batched mesh.
  20319. */
  20320. setCustomSort( func ) {
  20321. this.customSort = func;
  20322. return this;
  20323. }
  20324. /**
  20325. * Computes the bounding box, updating {@link BatchedMesh#boundingBox}.
  20326. * Bounding boxes aren't computed by default. They need to be explicitly computed,
  20327. * otherwise they are `null`.
  20328. */
  20329. computeBoundingBox() {
  20330. if ( this.boundingBox === null ) {
  20331. this.boundingBox = new Box3();
  20332. }
  20333. const boundingBox = this.boundingBox;
  20334. const instanceInfo = this._instanceInfo;
  20335. boundingBox.makeEmpty();
  20336. for ( let i = 0, l = instanceInfo.length; i < l; i ++ ) {
  20337. if ( instanceInfo[ i ].active === false ) continue;
  20338. const geometryId = instanceInfo[ i ].geometryIndex;
  20339. this.getMatrixAt( i, _matrix$1 );
  20340. this.getBoundingBoxAt( geometryId, _box$1 ).applyMatrix4( _matrix$1 );
  20341. boundingBox.union( _box$1 );
  20342. }
  20343. }
  20344. /**
  20345. * Computes the bounding sphere, updating {@link BatchedMesh#boundingSphere}.
  20346. * Bounding spheres aren't computed by default. They need to be explicitly computed,
  20347. * otherwise they are `null`.
  20348. */
  20349. computeBoundingSphere() {
  20350. if ( this.boundingSphere === null ) {
  20351. this.boundingSphere = new Sphere();
  20352. }
  20353. const boundingSphere = this.boundingSphere;
  20354. const instanceInfo = this._instanceInfo;
  20355. boundingSphere.makeEmpty();
  20356. for ( let i = 0, l = instanceInfo.length; i < l; i ++ ) {
  20357. if ( instanceInfo[ i ].active === false ) continue;
  20358. const geometryId = instanceInfo[ i ].geometryIndex;
  20359. this.getMatrixAt( i, _matrix$1 );
  20360. this.getBoundingSphereAt( geometryId, _sphere$2 ).applyMatrix4( _matrix$1 );
  20361. boundingSphere.union( _sphere$2 );
  20362. }
  20363. }
  20364. /**
  20365. * Adds a new instance to the batch using the geometry of the given ID and returns
  20366. * a new id referring to the new instance to be used by other functions.
  20367. *
  20368. * @param {number} geometryId - The ID of a previously added geometry via {@link BatchedMesh#addGeometry}.
  20369. * @return {number} The instance ID.
  20370. */
  20371. addInstance( geometryId ) {
  20372. const atCapacity = this._instanceInfo.length >= this.maxInstanceCount;
  20373. // ensure we're not over geometry
  20374. if ( atCapacity && this._availableInstanceIds.length === 0 ) {
  20375. throw new Error( 'THREE.BatchedMesh: Maximum item count reached.' );
  20376. }
  20377. const instanceInfo = {
  20378. visible: true,
  20379. active: true,
  20380. geometryIndex: geometryId,
  20381. };
  20382. let drawId = null;
  20383. // Prioritize using previously freed instance ids
  20384. if ( this._availableInstanceIds.length > 0 ) {
  20385. this._availableInstanceIds.sort( ascIdSort );
  20386. drawId = this._availableInstanceIds.shift();
  20387. this._instanceInfo[ drawId ] = instanceInfo;
  20388. } else {
  20389. drawId = this._instanceInfo.length;
  20390. this._instanceInfo.push( instanceInfo );
  20391. }
  20392. const matricesTexture = this._matricesTexture;
  20393. _matrix$1.identity().toArray( matricesTexture.image.data, drawId * 16 );
  20394. matricesTexture.needsUpdate = true;
  20395. const colorsTexture = this._colorsTexture;
  20396. if ( colorsTexture ) {
  20397. _whiteColor.toArray( colorsTexture.image.data, drawId * 4 );
  20398. colorsTexture.needsUpdate = true;
  20399. }
  20400. this._visibilityChanged = true;
  20401. return drawId;
  20402. }
  20403. /**
  20404. * Adds the given geometry to the batch and returns the associated
  20405. * geometry id referring to it to be used in other functions.
  20406. *
  20407. * @param {BufferGeometry} geometry - The geometry to add.
  20408. * @param {number} [reservedVertexCount=-1] - Optional parameter specifying the amount of
  20409. * vertex buffer space to reserve for the added geometry. This is necessary if it is planned
  20410. * to set a new geometry at this index at a later time that is larger than the original geometry.
  20411. * Defaults to the length of the given geometry vertex buffer.
  20412. * @param {number} [reservedIndexCount=-1] - Optional parameter specifying the amount of index
  20413. * buffer space to reserve for the added geometry. This is necessary if it is planned to set a
  20414. * new geometry at this index at a later time that is larger than the original geometry. Defaults to
  20415. * the length of the given geometry index buffer.
  20416. * @return {number} The geometry ID.
  20417. */
  20418. addGeometry( geometry, reservedVertexCount = -1, reservedIndexCount = -1 ) {
  20419. this._initializeGeometry( geometry );
  20420. this._validateGeometry( geometry );
  20421. const geometryInfo = {
  20422. // geometry information
  20423. vertexStart: -1,
  20424. vertexCount: -1,
  20425. reservedVertexCount: -1,
  20426. indexStart: -1,
  20427. indexCount: -1,
  20428. reservedIndexCount: -1,
  20429. // draw range information
  20430. start: -1,
  20431. count: -1,
  20432. // state
  20433. boundingBox: null,
  20434. boundingSphere: null,
  20435. active: true,
  20436. };
  20437. const geometryInfoList = this._geometryInfo;
  20438. geometryInfo.vertexStart = this._nextVertexStart;
  20439. geometryInfo.reservedVertexCount = reservedVertexCount === -1 ? geometry.getAttribute( 'position' ).count : reservedVertexCount;
  20440. const index = geometry.getIndex();
  20441. const hasIndex = index !== null;
  20442. if ( hasIndex ) {
  20443. geometryInfo.indexStart = this._nextIndexStart;
  20444. geometryInfo.reservedIndexCount = reservedIndexCount === -1 ? index.count : reservedIndexCount;
  20445. }
  20446. if (
  20447. geometryInfo.indexStart !== -1 &&
  20448. geometryInfo.indexStart + geometryInfo.reservedIndexCount > this._maxIndexCount ||
  20449. geometryInfo.vertexStart + geometryInfo.reservedVertexCount > this._maxVertexCount
  20450. ) {
  20451. throw new Error( 'THREE.BatchedMesh: Reserved space request exceeds the maximum buffer size.' );
  20452. }
  20453. // update id
  20454. let geometryId;
  20455. if ( this._availableGeometryIds.length > 0 ) {
  20456. this._availableGeometryIds.sort( ascIdSort );
  20457. geometryId = this._availableGeometryIds.shift();
  20458. geometryInfoList[ geometryId ] = geometryInfo;
  20459. } else {
  20460. geometryId = this._geometryCount;
  20461. this._geometryCount ++;
  20462. geometryInfoList.push( geometryInfo );
  20463. }
  20464. // update the geometry
  20465. this.setGeometryAt( geometryId, geometry );
  20466. // increment the next geometry position
  20467. this._nextIndexStart = geometryInfo.indexStart + geometryInfo.reservedIndexCount;
  20468. this._nextVertexStart = geometryInfo.vertexStart + geometryInfo.reservedVertexCount;
  20469. return geometryId;
  20470. }
  20471. /**
  20472. * Replaces the geometry at the given ID with the provided geometry. Throws an error if there
  20473. * is not enough space reserved for geometry. Calling this will change all instances that are
  20474. * rendering that geometry.
  20475. *
  20476. * @param {number} geometryId - The ID of the geometry that should be replaced with the given geometry.
  20477. * @param {BufferGeometry} geometry - The new geometry.
  20478. * @return {number} The geometry ID.
  20479. */
  20480. setGeometryAt( geometryId, geometry ) {
  20481. if ( geometryId >= this._geometryCount ) {
  20482. throw new Error( 'THREE.BatchedMesh: Maximum geometry count reached.' );
  20483. }
  20484. this._validateGeometry( geometry );
  20485. const batchGeometry = this.geometry;
  20486. const hasIndex = batchGeometry.getIndex() !== null;
  20487. const dstIndex = batchGeometry.getIndex();
  20488. const srcIndex = geometry.getIndex();
  20489. const geometryInfo = this._geometryInfo[ geometryId ];
  20490. if (
  20491. hasIndex &&
  20492. srcIndex.count > geometryInfo.reservedIndexCount ||
  20493. geometry.attributes.position.count > geometryInfo.reservedVertexCount
  20494. ) {
  20495. throw new Error( 'THREE.BatchedMesh: Reserved space not large enough for provided geometry.' );
  20496. }
  20497. // copy geometry buffer data over
  20498. const vertexStart = geometryInfo.vertexStart;
  20499. const reservedVertexCount = geometryInfo.reservedVertexCount;
  20500. geometryInfo.vertexCount = geometry.getAttribute( 'position' ).count;
  20501. for ( const attributeName in batchGeometry.attributes ) {
  20502. // copy attribute data
  20503. const srcAttribute = geometry.getAttribute( attributeName );
  20504. const dstAttribute = batchGeometry.getAttribute( attributeName );
  20505. copyAttributeData( srcAttribute, dstAttribute, vertexStart );
  20506. // fill the rest in with zeroes
  20507. const itemSize = srcAttribute.itemSize;
  20508. for ( let i = srcAttribute.count, l = reservedVertexCount; i < l; i ++ ) {
  20509. const index = vertexStart + i;
  20510. for ( let c = 0; c < itemSize; c ++ ) {
  20511. dstAttribute.setComponent( index, c, 0 );
  20512. }
  20513. }
  20514. dstAttribute.needsUpdate = true;
  20515. dstAttribute.addUpdateRange( vertexStart * itemSize, reservedVertexCount * itemSize );
  20516. }
  20517. // copy index
  20518. if ( hasIndex ) {
  20519. const indexStart = geometryInfo.indexStart;
  20520. const reservedIndexCount = geometryInfo.reservedIndexCount;
  20521. geometryInfo.indexCount = geometry.getIndex().count;
  20522. // copy index data over
  20523. for ( let i = 0; i < srcIndex.count; i ++ ) {
  20524. dstIndex.setX( indexStart + i, vertexStart + srcIndex.getX( i ) );
  20525. }
  20526. // fill the rest in with zeroes
  20527. for ( let i = srcIndex.count, l = reservedIndexCount; i < l; i ++ ) {
  20528. dstIndex.setX( indexStart + i, vertexStart );
  20529. }
  20530. dstIndex.needsUpdate = true;
  20531. dstIndex.addUpdateRange( indexStart, geometryInfo.reservedIndexCount );
  20532. }
  20533. // update the draw range
  20534. geometryInfo.start = hasIndex ? geometryInfo.indexStart : geometryInfo.vertexStart;
  20535. geometryInfo.count = hasIndex ? geometryInfo.indexCount : geometryInfo.vertexCount;
  20536. // store the bounding boxes
  20537. geometryInfo.boundingBox = null;
  20538. if ( geometry.boundingBox !== null ) {
  20539. geometryInfo.boundingBox = geometry.boundingBox.clone();
  20540. }
  20541. geometryInfo.boundingSphere = null;
  20542. if ( geometry.boundingSphere !== null ) {
  20543. geometryInfo.boundingSphere = geometry.boundingSphere.clone();
  20544. }
  20545. this._visibilityChanged = true;
  20546. return geometryId;
  20547. }
  20548. /**
  20549. * Deletes the geometry defined by the given ID from this batch. Any instances referencing
  20550. * this geometry will also be removed as a side effect.
  20551. *
  20552. * @param {number} geometryId - The ID of the geometry to remove from the batch.
  20553. * @return {BatchedMesh} A reference to this batched mesh.
  20554. */
  20555. deleteGeometry( geometryId ) {
  20556. const geometryInfoList = this._geometryInfo;
  20557. if ( geometryId >= geometryInfoList.length || geometryInfoList[ geometryId ].active === false ) {
  20558. return this;
  20559. }
  20560. // delete any instances associated with this geometry
  20561. const instanceInfo = this._instanceInfo;
  20562. for ( let i = 0, l = instanceInfo.length; i < l; i ++ ) {
  20563. if ( instanceInfo[ i ].active && instanceInfo[ i ].geometryIndex === geometryId ) {
  20564. this.deleteInstance( i );
  20565. }
  20566. }
  20567. geometryInfoList[ geometryId ].active = false;
  20568. this._availableGeometryIds.push( geometryId );
  20569. this._visibilityChanged = true;
  20570. return this;
  20571. }
  20572. /**
  20573. * Deletes an existing instance from the batch using the given ID.
  20574. *
  20575. * @param {number} instanceId - The ID of the instance to remove from the batch.
  20576. * @return {BatchedMesh} A reference to this batched mesh.
  20577. */
  20578. deleteInstance( instanceId ) {
  20579. this.validateInstanceId( instanceId );
  20580. this._instanceInfo[ instanceId ].active = false;
  20581. this._availableInstanceIds.push( instanceId );
  20582. this._visibilityChanged = true;
  20583. return this;
  20584. }
  20585. /**
  20586. * Repacks the sub geometries in BatchedMesh to remove any unused space remaining from
  20587. * previously deleted geometry, freeing up space to add new geometry.
  20588. *
  20589. * @return {BatchedMesh} A reference to this batched mesh.
  20590. */
  20591. optimize() {
  20592. // track the next indices to copy data to
  20593. let nextVertexStart = 0;
  20594. let nextIndexStart = 0;
  20595. // Iterate over all geometry ranges in order sorted from earliest in the geometry buffer to latest
  20596. // in the geometry buffer. Because draw range objects can be reused there is no guarantee of their order.
  20597. const geometryInfoList = this._geometryInfo;
  20598. const indices = geometryInfoList
  20599. .map( ( e, i ) => i )
  20600. .sort( ( a, b ) => {
  20601. return geometryInfoList[ a ].vertexStart - geometryInfoList[ b ].vertexStart;
  20602. } );
  20603. const geometry = this.geometry;
  20604. for ( let i = 0, l = geometryInfoList.length; i < l; i ++ ) {
  20605. // if a geometry range is inactive then don't copy anything
  20606. const index = indices[ i ];
  20607. const geometryInfo = geometryInfoList[ index ];
  20608. if ( geometryInfo.active === false ) {
  20609. continue;
  20610. }
  20611. // if a geometry contains an index buffer then shift it, as well
  20612. if ( geometry.index !== null ) {
  20613. if ( geometryInfo.indexStart !== nextIndexStart ) {
  20614. const { indexStart, vertexStart, reservedIndexCount } = geometryInfo;
  20615. const index = geometry.index;
  20616. const array = index.array;
  20617. // shift the index pointers based on how the vertex data will shift
  20618. // adjusting the index must happen first so the original vertex start value is available
  20619. const elementDelta = nextVertexStart - vertexStart;
  20620. for ( let j = indexStart; j < indexStart + reservedIndexCount; j ++ ) {
  20621. array[ j ] = array[ j ] + elementDelta;
  20622. }
  20623. index.array.copyWithin( nextIndexStart, indexStart, indexStart + reservedIndexCount );
  20624. index.addUpdateRange( nextIndexStart, reservedIndexCount );
  20625. index.needsUpdate = true;
  20626. geometryInfo.indexStart = nextIndexStart;
  20627. }
  20628. nextIndexStart += geometryInfo.reservedIndexCount;
  20629. }
  20630. // if a geometry needs to be moved then copy attribute data to overwrite unused space
  20631. if ( geometryInfo.vertexStart !== nextVertexStart ) {
  20632. const { vertexStart, reservedVertexCount } = geometryInfo;
  20633. const attributes = geometry.attributes;
  20634. for ( const key in attributes ) {
  20635. const attribute = attributes[ key ];
  20636. const { array, itemSize } = attribute;
  20637. array.copyWithin( nextVertexStart * itemSize, vertexStart * itemSize, ( vertexStart + reservedVertexCount ) * itemSize );
  20638. attribute.addUpdateRange( nextVertexStart * itemSize, reservedVertexCount * itemSize );
  20639. attribute.needsUpdate = true;
  20640. }
  20641. geometryInfo.vertexStart = nextVertexStart;
  20642. }
  20643. nextVertexStart += geometryInfo.reservedVertexCount;
  20644. geometryInfo.start = geometry.index ? geometryInfo.indexStart : geometryInfo.vertexStart;
  20645. // step the next geometry points to the shifted position
  20646. this._nextIndexStart = geometry.index ? geometryInfo.indexStart + geometryInfo.reservedIndexCount : 0;
  20647. this._nextVertexStart = geometryInfo.vertexStart + geometryInfo.reservedVertexCount;
  20648. }
  20649. this._visibilityChanged = true;
  20650. return this;
  20651. }
  20652. /**
  20653. * Returns the bounding box for the given geometry.
  20654. *
  20655. * @param {number} geometryId - The ID of the geometry to return the bounding box for.
  20656. * @param {Box3} target - The target object that is used to store the method's result.
  20657. * @return {?Box3} The geometry's bounding box. Returns `null` if no geometry has been found for the given ID.
  20658. */
  20659. getBoundingBoxAt( geometryId, target ) {
  20660. if ( geometryId >= this._geometryCount ) {
  20661. return null;
  20662. }
  20663. // compute bounding box
  20664. const geometry = this.geometry;
  20665. const geometryInfo = this._geometryInfo[ geometryId ];
  20666. if ( geometryInfo.boundingBox === null ) {
  20667. const box = new Box3();
  20668. const index = geometry.index;
  20669. const position = geometry.attributes.position;
  20670. for ( let i = geometryInfo.start, l = geometryInfo.start + geometryInfo.count; i < l; i ++ ) {
  20671. let iv = i;
  20672. if ( index ) {
  20673. iv = index.getX( iv );
  20674. }
  20675. box.expandByPoint( _vector$5.fromBufferAttribute( position, iv ) );
  20676. }
  20677. geometryInfo.boundingBox = box;
  20678. }
  20679. target.copy( geometryInfo.boundingBox );
  20680. return target;
  20681. }
  20682. /**
  20683. * Returns the bounding sphere for the given geometry.
  20684. *
  20685. * @param {number} geometryId - The ID of the geometry to return the bounding sphere for.
  20686. * @param {Sphere} target - The target object that is used to store the method's result.
  20687. * @return {?Sphere} The geometry's bounding sphere. Returns `null` if no geometry has been found for the given ID.
  20688. */
  20689. getBoundingSphereAt( geometryId, target ) {
  20690. if ( geometryId >= this._geometryCount ) {
  20691. return null;
  20692. }
  20693. // compute bounding sphere
  20694. const geometry = this.geometry;
  20695. const geometryInfo = this._geometryInfo[ geometryId ];
  20696. if ( geometryInfo.boundingSphere === null ) {
  20697. const sphere = new Sphere();
  20698. this.getBoundingBoxAt( geometryId, _box$1 );
  20699. _box$1.getCenter( sphere.center );
  20700. const index = geometry.index;
  20701. const position = geometry.attributes.position;
  20702. let maxRadiusSq = 0;
  20703. for ( let i = geometryInfo.start, l = geometryInfo.start + geometryInfo.count; i < l; i ++ ) {
  20704. let iv = i;
  20705. if ( index ) {
  20706. iv = index.getX( iv );
  20707. }
  20708. _vector$5.fromBufferAttribute( position, iv );
  20709. maxRadiusSq = Math.max( maxRadiusSq, sphere.center.distanceToSquared( _vector$5 ) );
  20710. }
  20711. sphere.radius = Math.sqrt( maxRadiusSq );
  20712. geometryInfo.boundingSphere = sphere;
  20713. }
  20714. target.copy( geometryInfo.boundingSphere );
  20715. return target;
  20716. }
  20717. /**
  20718. * Sets the given local transformation matrix to the defined instance.
  20719. * Negatively scaled matrices are not supported.
  20720. *
  20721. * @param {number} instanceId - The ID of an instance to set the matrix of.
  20722. * @param {Matrix4} matrix - A 4x4 matrix representing the local transformation of a single instance.
  20723. * @return {BatchedMesh} A reference to this batched mesh.
  20724. */
  20725. setMatrixAt( instanceId, matrix ) {
  20726. this.validateInstanceId( instanceId );
  20727. const matricesTexture = this._matricesTexture;
  20728. const matricesArray = this._matricesTexture.image.data;
  20729. matrix.toArray( matricesArray, instanceId * 16 );
  20730. matricesTexture.needsUpdate = true;
  20731. return this;
  20732. }
  20733. /**
  20734. * Returns the local transformation matrix of the defined instance.
  20735. *
  20736. * @param {number} instanceId - The ID of an instance to get the matrix of.
  20737. * @param {Matrix4} matrix - The target object that is used to store the method's result.
  20738. * @return {Matrix4} The instance's local transformation matrix.
  20739. */
  20740. getMatrixAt( instanceId, matrix ) {
  20741. this.validateInstanceId( instanceId );
  20742. return matrix.fromArray( this._matricesTexture.image.data, instanceId * 16 );
  20743. }
  20744. /**
  20745. * Sets the given color to the defined instance.
  20746. *
  20747. * @param {number} instanceId - The ID of an instance to set the color of.
  20748. * @param {Color} color - The color to set the instance to.
  20749. * @return {BatchedMesh} A reference to this batched mesh.
  20750. */
  20751. setColorAt( instanceId, color ) {
  20752. this.validateInstanceId( instanceId );
  20753. if ( this._colorsTexture === null ) {
  20754. this._initColorsTexture();
  20755. }
  20756. color.toArray( this._colorsTexture.image.data, instanceId * 4 );
  20757. this._colorsTexture.needsUpdate = true;
  20758. return this;
  20759. }
  20760. /**
  20761. * Returns the color of the defined instance.
  20762. *
  20763. * @param {number} instanceId - The ID of an instance to get the color of.
  20764. * @param {Color} color - The target object that is used to store the method's result.
  20765. * @return {Color} The instance's color.
  20766. */
  20767. getColorAt( instanceId, color ) {
  20768. this.validateInstanceId( instanceId );
  20769. return color.fromArray( this._colorsTexture.image.data, instanceId * 4 );
  20770. }
  20771. /**
  20772. * Sets the visibility of the instance.
  20773. *
  20774. * @param {number} instanceId - The id of the instance to set the visibility of.
  20775. * @param {boolean} visible - Whether the instance is visible or not.
  20776. * @return {BatchedMesh} A reference to this batched mesh.
  20777. */
  20778. setVisibleAt( instanceId, visible ) {
  20779. this.validateInstanceId( instanceId );
  20780. if ( this._instanceInfo[ instanceId ].visible === visible ) {
  20781. return this;
  20782. }
  20783. this._instanceInfo[ instanceId ].visible = visible;
  20784. this._visibilityChanged = true;
  20785. return this;
  20786. }
  20787. /**
  20788. * Returns the visibility state of the defined instance.
  20789. *
  20790. * @param {number} instanceId - The ID of an instance to get the visibility state of.
  20791. * @return {boolean} Whether the instance is visible or not.
  20792. */
  20793. getVisibleAt( instanceId ) {
  20794. this.validateInstanceId( instanceId );
  20795. return this._instanceInfo[ instanceId ].visible;
  20796. }
  20797. /**
  20798. * Sets the geometry ID of the instance at the given index.
  20799. *
  20800. * @param {number} instanceId - The ID of the instance to set the geometry ID of.
  20801. * @param {number} geometryId - The geometry ID to be use by the instance.
  20802. * @return {BatchedMesh} A reference to this batched mesh.
  20803. */
  20804. setGeometryIdAt( instanceId, geometryId ) {
  20805. this.validateInstanceId( instanceId );
  20806. this.validateGeometryId( geometryId );
  20807. this._instanceInfo[ instanceId ].geometryIndex = geometryId;
  20808. return this;
  20809. }
  20810. /**
  20811. * Returns the geometry ID of the defined instance.
  20812. *
  20813. * @param {number} instanceId - The ID of an instance to get the geometry ID of.
  20814. * @return {number} The instance's geometry ID.
  20815. */
  20816. getGeometryIdAt( instanceId ) {
  20817. this.validateInstanceId( instanceId );
  20818. return this._instanceInfo[ instanceId ].geometryIndex;
  20819. }
  20820. /**
  20821. * Get the range representing the subset of triangles related to the attached geometry,
  20822. * indicating the starting offset and count, or `null` if invalid.
  20823. *
  20824. * @param {number} geometryId - The id of the geometry to get the range of.
  20825. * @param {Object} [target] - The target object that is used to store the method's result.
  20826. * @return {{
  20827. * vertexStart:number,vertexCount:number,reservedVertexCount:number,
  20828. * indexStart:number,indexCount:number,reservedIndexCount:number,
  20829. * start:number,count:number
  20830. * }} The result object with range data.
  20831. */
  20832. getGeometryRangeAt( geometryId, target = {} ) {
  20833. this.validateGeometryId( geometryId );
  20834. const geometryInfo = this._geometryInfo[ geometryId ];
  20835. target.vertexStart = geometryInfo.vertexStart;
  20836. target.vertexCount = geometryInfo.vertexCount;
  20837. target.reservedVertexCount = geometryInfo.reservedVertexCount;
  20838. target.indexStart = geometryInfo.indexStart;
  20839. target.indexCount = geometryInfo.indexCount;
  20840. target.reservedIndexCount = geometryInfo.reservedIndexCount;
  20841. target.start = geometryInfo.start;
  20842. target.count = geometryInfo.count;
  20843. return target;
  20844. }
  20845. /**
  20846. * Resizes the necessary buffers to support the provided number of instances.
  20847. * If the provided arguments shrink the number of instances but there are not enough
  20848. * unused Ids at the end of the list then an error is thrown.
  20849. *
  20850. * @param {number} maxInstanceCount - The max number of individual instances that can be added and rendered by the batch.
  20851. */
  20852. setInstanceCount( maxInstanceCount ) {
  20853. // shrink the available instances as much as possible
  20854. const availableInstanceIds = this._availableInstanceIds;
  20855. const instanceInfo = this._instanceInfo;
  20856. availableInstanceIds.sort( ascIdSort );
  20857. while ( availableInstanceIds[ availableInstanceIds.length - 1 ] === instanceInfo.length - 1 ) {
  20858. instanceInfo.pop();
  20859. availableInstanceIds.pop();
  20860. }
  20861. // throw an error if it can't be shrunk to the desired size
  20862. if ( maxInstanceCount < instanceInfo.length ) {
  20863. throw new Error( `BatchedMesh: Instance ids outside the range ${ maxInstanceCount } are being used. Cannot shrink instance count.` );
  20864. }
  20865. // copy the multi draw counts
  20866. const multiDrawCounts = new Int32Array( maxInstanceCount );
  20867. const multiDrawStarts = new Int32Array( maxInstanceCount );
  20868. copyArrayContents( this._multiDrawCounts, multiDrawCounts );
  20869. copyArrayContents( this._multiDrawStarts, multiDrawStarts );
  20870. this._multiDrawCounts = multiDrawCounts;
  20871. this._multiDrawStarts = multiDrawStarts;
  20872. this._maxInstanceCount = maxInstanceCount;
  20873. // update texture data for instance sampling
  20874. const indirectTexture = this._indirectTexture;
  20875. const matricesTexture = this._matricesTexture;
  20876. const colorsTexture = this._colorsTexture;
  20877. indirectTexture.dispose();
  20878. this._initIndirectTexture();
  20879. copyArrayContents( indirectTexture.image.data, this._indirectTexture.image.data );
  20880. matricesTexture.dispose();
  20881. this._initMatricesTexture();
  20882. copyArrayContents( matricesTexture.image.data, this._matricesTexture.image.data );
  20883. if ( colorsTexture ) {
  20884. colorsTexture.dispose();
  20885. this._initColorsTexture();
  20886. copyArrayContents( colorsTexture.image.data, this._colorsTexture.image.data );
  20887. }
  20888. }
  20889. /**
  20890. * Resizes the available space in the batch's vertex and index buffer attributes to the provided sizes.
  20891. * If the provided arguments shrink the geometry buffers but there is not enough unused space at the
  20892. * end of the geometry attributes then an error is thrown.
  20893. *
  20894. * @param {number} maxVertexCount - The maximum number of vertices to be used by all unique geometries to resize to.
  20895. * @param {number} maxIndexCount - The maximum number of indices to be used by all unique geometries to resize to.
  20896. */
  20897. setGeometrySize( maxVertexCount, maxIndexCount ) {
  20898. // Check if we can shrink to the requested vertex attribute size
  20899. const validRanges = [ ...this._geometryInfo ].filter( info => info.active );
  20900. const requiredVertexLength = Math.max( ...validRanges.map( range => range.vertexStart + range.reservedVertexCount ) );
  20901. if ( requiredVertexLength > maxVertexCount ) {
  20902. throw new Error( `BatchedMesh: Geometry vertex values are being used outside the range ${ maxIndexCount }. Cannot shrink further.` );
  20903. }
  20904. // Check if we can shrink to the requested index attribute size
  20905. if ( this.geometry.index ) {
  20906. const requiredIndexLength = Math.max( ...validRanges.map( range => range.indexStart + range.reservedIndexCount ) );
  20907. if ( requiredIndexLength > maxIndexCount ) {
  20908. throw new Error( `BatchedMesh: Geometry index values are being used outside the range ${ maxIndexCount }. Cannot shrink further.` );
  20909. }
  20910. }
  20911. //
  20912. // dispose of the previous geometry
  20913. const oldGeometry = this.geometry;
  20914. oldGeometry.dispose();
  20915. // recreate the geometry needed based on the previous variant
  20916. this._maxVertexCount = maxVertexCount;
  20917. this._maxIndexCount = maxIndexCount;
  20918. if ( this._geometryInitialized ) {
  20919. this._geometryInitialized = false;
  20920. this.geometry = new BufferGeometry();
  20921. this._initializeGeometry( oldGeometry );
  20922. }
  20923. // copy data from the previous geometry
  20924. const geometry = this.geometry;
  20925. if ( oldGeometry.index ) {
  20926. copyArrayContents( oldGeometry.index.array, geometry.index.array );
  20927. }
  20928. for ( const key in oldGeometry.attributes ) {
  20929. copyArrayContents( oldGeometry.attributes[ key ].array, geometry.attributes[ key ].array );
  20930. }
  20931. }
  20932. raycast( raycaster, intersects ) {
  20933. const instanceInfo = this._instanceInfo;
  20934. const geometryInfoList = this._geometryInfo;
  20935. const matrixWorld = this.matrixWorld;
  20936. const batchGeometry = this.geometry;
  20937. // iterate over each geometry
  20938. _mesh.material = this.material;
  20939. _mesh.geometry.index = batchGeometry.index;
  20940. _mesh.geometry.attributes = batchGeometry.attributes;
  20941. if ( _mesh.geometry.boundingBox === null ) {
  20942. _mesh.geometry.boundingBox = new Box3();
  20943. }
  20944. if ( _mesh.geometry.boundingSphere === null ) {
  20945. _mesh.geometry.boundingSphere = new Sphere();
  20946. }
  20947. for ( let i = 0, l = instanceInfo.length; i < l; i ++ ) {
  20948. if ( ! instanceInfo[ i ].visible || ! instanceInfo[ i ].active ) {
  20949. continue;
  20950. }
  20951. const geometryId = instanceInfo[ i ].geometryIndex;
  20952. const geometryInfo = geometryInfoList[ geometryId ];
  20953. _mesh.geometry.setDrawRange( geometryInfo.start, geometryInfo.count );
  20954. // get the intersects
  20955. this.getMatrixAt( i, _mesh.matrixWorld ).premultiply( matrixWorld );
  20956. this.getBoundingBoxAt( geometryId, _mesh.geometry.boundingBox );
  20957. this.getBoundingSphereAt( geometryId, _mesh.geometry.boundingSphere );
  20958. _mesh.raycast( raycaster, _batchIntersects );
  20959. // add batch id to the intersects
  20960. for ( let j = 0, l = _batchIntersects.length; j < l; j ++ ) {
  20961. const intersect = _batchIntersects[ j ];
  20962. intersect.object = this;
  20963. intersect.batchId = i;
  20964. intersects.push( intersect );
  20965. }
  20966. _batchIntersects.length = 0;
  20967. }
  20968. _mesh.material = null;
  20969. _mesh.geometry.index = null;
  20970. _mesh.geometry.attributes = {};
  20971. _mesh.geometry.setDrawRange( 0, Infinity );
  20972. }
  20973. copy( source ) {
  20974. super.copy( source );
  20975. this.geometry = source.geometry.clone();
  20976. this.perObjectFrustumCulled = source.perObjectFrustumCulled;
  20977. this.sortObjects = source.sortObjects;
  20978. this.boundingBox = source.boundingBox !== null ? source.boundingBox.clone() : null;
  20979. this.boundingSphere = source.boundingSphere !== null ? source.boundingSphere.clone() : null;
  20980. this._geometryInfo = source._geometryInfo.map( info => ( {
  20981. ...info,
  20982. boundingBox: info.boundingBox !== null ? info.boundingBox.clone() : null,
  20983. boundingSphere: info.boundingSphere !== null ? info.boundingSphere.clone() : null,
  20984. } ) );
  20985. this._instanceInfo = source._instanceInfo.map( info => ( { ...info } ) );
  20986. this._availableInstanceIds = source._availableInstanceIds.slice();
  20987. this._availableGeometryIds = source._availableGeometryIds.slice();
  20988. this._nextIndexStart = source._nextIndexStart;
  20989. this._nextVertexStart = source._nextVertexStart;
  20990. this._geometryCount = source._geometryCount;
  20991. this._maxInstanceCount = source._maxInstanceCount;
  20992. this._maxVertexCount = source._maxVertexCount;
  20993. this._maxIndexCount = source._maxIndexCount;
  20994. this._geometryInitialized = source._geometryInitialized;
  20995. this._multiDrawCounts = source._multiDrawCounts.slice();
  20996. this._multiDrawStarts = source._multiDrawStarts.slice();
  20997. this._indirectTexture = source._indirectTexture.clone();
  20998. this._indirectTexture.image.data = this._indirectTexture.image.data.slice();
  20999. this._matricesTexture = source._matricesTexture.clone();
  21000. this._matricesTexture.image.data = this._matricesTexture.image.data.slice();
  21001. if ( this._colorsTexture !== null ) {
  21002. this._colorsTexture = source._colorsTexture.clone();
  21003. this._colorsTexture.image.data = this._colorsTexture.image.data.slice();
  21004. }
  21005. return this;
  21006. }
  21007. /**
  21008. * Frees the GPU-related resources allocated by this instance. Call this
  21009. * method whenever this instance is no longer used in your app.
  21010. */
  21011. dispose() {
  21012. // Assuming the geometry is not shared with other meshes
  21013. this.geometry.dispose();
  21014. this._matricesTexture.dispose();
  21015. this._matricesTexture = null;
  21016. this._indirectTexture.dispose();
  21017. this._indirectTexture = null;
  21018. if ( this._colorsTexture !== null ) {
  21019. this._colorsTexture.dispose();
  21020. this._colorsTexture = null;
  21021. }
  21022. }
  21023. onBeforeRender( renderer, scene, camera, geometry, material/*, _group*/ ) {
  21024. // if visibility has not changed and frustum culling and object sorting is not required
  21025. // then skip iterating over all items
  21026. if ( ! this._visibilityChanged && ! this.perObjectFrustumCulled && ! this.sortObjects ) {
  21027. return;
  21028. }
  21029. // the indexed version of the multi draw function requires specifying the start
  21030. // offset in bytes.
  21031. const index = geometry.getIndex();
  21032. const bytesPerElement = index === null ? 1 : index.array.BYTES_PER_ELEMENT;
  21033. const instanceInfo = this._instanceInfo;
  21034. const multiDrawStarts = this._multiDrawStarts;
  21035. const multiDrawCounts = this._multiDrawCounts;
  21036. const geometryInfoList = this._geometryInfo;
  21037. const perObjectFrustumCulled = this.perObjectFrustumCulled;
  21038. const indirectTexture = this._indirectTexture;
  21039. const indirectArray = indirectTexture.image.data;
  21040. const frustum = camera.isArrayCamera ? _frustumArray : _frustum;
  21041. // prepare the frustum in the local frame
  21042. if ( perObjectFrustumCulled && ! camera.isArrayCamera ) {
  21043. _matrix$1
  21044. .multiplyMatrices( camera.projectionMatrix, camera.matrixWorldInverse )
  21045. .multiply( this.matrixWorld );
  21046. _frustum.setFromProjectionMatrix(
  21047. _matrix$1,
  21048. camera.coordinateSystem,
  21049. camera.reversedDepth
  21050. );
  21051. }
  21052. let multiDrawCount = 0;
  21053. if ( this.sortObjects ) {
  21054. // get the camera position in the local frame
  21055. _matrix$1.copy( this.matrixWorld ).invert();
  21056. _vector$5.setFromMatrixPosition( camera.matrixWorld ).applyMatrix4( _matrix$1 );
  21057. _forward$1.set( 0, 0, -1 ).transformDirection( camera.matrixWorld ).transformDirection( _matrix$1 );
  21058. for ( let i = 0, l = instanceInfo.length; i < l; i ++ ) {
  21059. if ( instanceInfo[ i ].visible && instanceInfo[ i ].active ) {
  21060. const geometryId = instanceInfo[ i ].geometryIndex;
  21061. // get the bounds in world space
  21062. this.getMatrixAt( i, _matrix$1 );
  21063. this.getBoundingSphereAt( geometryId, _sphere$2 ).applyMatrix4( _matrix$1 );
  21064. // determine whether the batched geometry is within the frustum
  21065. let culled = false;
  21066. if ( perObjectFrustumCulled ) {
  21067. culled = ! frustum.intersectsSphere( _sphere$2, camera );
  21068. }
  21069. if ( ! culled ) {
  21070. // get the distance from camera used for sorting
  21071. const geometryInfo = geometryInfoList[ geometryId ];
  21072. const z = _temp.subVectors( _sphere$2.center, _vector$5 ).dot( _forward$1 );
  21073. _renderList.push( geometryInfo.start, geometryInfo.count, z, i );
  21074. }
  21075. }
  21076. }
  21077. // Sort the draw ranges and prep for rendering
  21078. const list = _renderList.list;
  21079. const customSort = this.customSort;
  21080. if ( customSort === null ) {
  21081. list.sort( material.transparent ? sortTransparent : sortOpaque );
  21082. } else {
  21083. customSort.call( this, list, camera );
  21084. }
  21085. for ( let i = 0, l = list.length; i < l; i ++ ) {
  21086. const item = list[ i ];
  21087. multiDrawStarts[ multiDrawCount ] = item.start * bytesPerElement;
  21088. multiDrawCounts[ multiDrawCount ] = item.count;
  21089. indirectArray[ multiDrawCount ] = item.index;
  21090. multiDrawCount ++;
  21091. }
  21092. _renderList.reset();
  21093. } else {
  21094. for ( let i = 0, l = instanceInfo.length; i < l; i ++ ) {
  21095. if ( instanceInfo[ i ].visible && instanceInfo[ i ].active ) {
  21096. const geometryId = instanceInfo[ i ].geometryIndex;
  21097. // determine whether the batched geometry is within the frustum
  21098. let culled = false;
  21099. if ( perObjectFrustumCulled ) {
  21100. // get the bounds in world space
  21101. this.getMatrixAt( i, _matrix$1 );
  21102. this.getBoundingSphereAt( geometryId, _sphere$2 ).applyMatrix4( _matrix$1 );
  21103. culled = ! frustum.intersectsSphere( _sphere$2, camera );
  21104. }
  21105. if ( ! culled ) {
  21106. const geometryInfo = geometryInfoList[ geometryId ];
  21107. multiDrawStarts[ multiDrawCount ] = geometryInfo.start * bytesPerElement;
  21108. multiDrawCounts[ multiDrawCount ] = geometryInfo.count;
  21109. indirectArray[ multiDrawCount ] = i;
  21110. multiDrawCount ++;
  21111. }
  21112. }
  21113. }
  21114. }
  21115. indirectTexture.needsUpdate = true;
  21116. this._multiDrawCount = multiDrawCount;
  21117. this._visibilityChanged = false;
  21118. }
  21119. onBeforeShadow( renderer, object, camera, shadowCamera, geometry, depthMaterial/* , group */ ) {
  21120. this.onBeforeRender( renderer, null, shadowCamera, geometry, depthMaterial );
  21121. }
  21122. }
  21123. /**
  21124. * A material for rendering line primitives.
  21125. *
  21126. * Materials define the appearance of renderable 3D objects.
  21127. *
  21128. * ```js
  21129. * const material = new THREE.LineBasicMaterial( { color: 0xffffff } );
  21130. * ```
  21131. *
  21132. * @augments Material
  21133. */
  21134. class LineBasicMaterial extends Material {
  21135. /**
  21136. * Constructs a new line basic material.
  21137. *
  21138. * @param {Object} [parameters] - An object with one or more properties
  21139. * defining the material's appearance. Any property of the material
  21140. * (including any property from inherited materials) can be passed
  21141. * in here. Color values can be passed any type of value accepted
  21142. * by {@link Color#set}.
  21143. */
  21144. constructor( parameters ) {
  21145. super();
  21146. /**
  21147. * This flag can be used for type testing.
  21148. *
  21149. * @type {boolean}
  21150. * @readonly
  21151. * @default true
  21152. */
  21153. this.isLineBasicMaterial = true;
  21154. this.type = 'LineBasicMaterial';
  21155. /**
  21156. * Color of the material.
  21157. *
  21158. * @type {Color}
  21159. * @default (1,1,1)
  21160. */
  21161. this.color = new Color( 0xffffff );
  21162. /**
  21163. * Sets the color of the lines using data from a texture. The texture map
  21164. * color is modulated by the diffuse `color`.
  21165. *
  21166. * @type {?Texture}
  21167. * @default null
  21168. */
  21169. this.map = null;
  21170. /**
  21171. * Controls line thickness or lines.
  21172. *
  21173. * Can only be used with {@link SVGRenderer}. WebGL and WebGPU
  21174. * ignore this setting and always render line primitives with a
  21175. * width of one pixel.
  21176. *
  21177. * @type {number}
  21178. * @default 1
  21179. */
  21180. this.linewidth = 1;
  21181. /**
  21182. * Defines appearance of line ends.
  21183. *
  21184. * Can only be used with {@link SVGRenderer}.
  21185. *
  21186. * @type {('butt'|'round'|'square')}
  21187. * @default 'round'
  21188. */
  21189. this.linecap = 'round';
  21190. /**
  21191. * Defines appearance of line joints.
  21192. *
  21193. * Can only be used with {@link SVGRenderer}.
  21194. *
  21195. * @type {('round'|'bevel'|'miter')}
  21196. * @default 'round'
  21197. */
  21198. this.linejoin = 'round';
  21199. /**
  21200. * Whether the material is affected by fog or not.
  21201. *
  21202. * @type {boolean}
  21203. * @default true
  21204. */
  21205. this.fog = true;
  21206. this.setValues( parameters );
  21207. }
  21208. copy( source ) {
  21209. super.copy( source );
  21210. this.color.copy( source.color );
  21211. this.map = source.map;
  21212. this.linewidth = source.linewidth;
  21213. this.linecap = source.linecap;
  21214. this.linejoin = source.linejoin;
  21215. this.fog = source.fog;
  21216. return this;
  21217. }
  21218. }
  21219. const _vStart = /*@__PURE__*/ new Vector3();
  21220. const _vEnd = /*@__PURE__*/ new Vector3();
  21221. const _inverseMatrix$1 = /*@__PURE__*/ new Matrix4();
  21222. const _ray$1 = /*@__PURE__*/ new Ray();
  21223. const _sphere$1 = /*@__PURE__*/ new Sphere();
  21224. const _intersectPointOnRay = /*@__PURE__*/ new Vector3();
  21225. const _intersectPointOnSegment = /*@__PURE__*/ new Vector3();
  21226. /**
  21227. * A continuous line. The line are rendered by connecting consecutive
  21228. * vertices with straight lines.
  21229. *
  21230. * ```js
  21231. * const material = new THREE.LineBasicMaterial( { color: 0x0000ff } );
  21232. *
  21233. * const points = [];
  21234. * points.push( new THREE.Vector3( - 10, 0, 0 ) );
  21235. * points.push( new THREE.Vector3( 0, 10, 0 ) );
  21236. * points.push( new THREE.Vector3( 10, 0, 0 ) );
  21237. *
  21238. * const geometry = new THREE.BufferGeometry().setFromPoints( points );
  21239. *
  21240. * const line = new THREE.Line( geometry, material );
  21241. * scene.add( line );
  21242. * ```
  21243. *
  21244. * @augments Object3D
  21245. */
  21246. class Line extends Object3D {
  21247. /**
  21248. * Constructs a new line.
  21249. *
  21250. * @param {BufferGeometry} [geometry] - The line geometry.
  21251. * @param {Material|Array<Material>} [material] - The line material.
  21252. */
  21253. constructor( geometry = new BufferGeometry(), material = new LineBasicMaterial() ) {
  21254. super();
  21255. /**
  21256. * This flag can be used for type testing.
  21257. *
  21258. * @type {boolean}
  21259. * @readonly
  21260. * @default true
  21261. */
  21262. this.isLine = true;
  21263. this.type = 'Line';
  21264. /**
  21265. * The line geometry.
  21266. *
  21267. * @type {BufferGeometry}
  21268. */
  21269. this.geometry = geometry;
  21270. /**
  21271. * The line material.
  21272. *
  21273. * @type {Material|Array<Material>}
  21274. * @default LineBasicMaterial
  21275. */
  21276. this.material = material;
  21277. /**
  21278. * A dictionary representing the morph targets in the geometry. The key is the
  21279. * morph targets name, the value its attribute index. This member is `undefined`
  21280. * by default and only set when morph targets are detected in the geometry.
  21281. *
  21282. * @type {Object<string,number>|undefined}
  21283. * @default undefined
  21284. */
  21285. this.morphTargetDictionary = undefined;
  21286. /**
  21287. * An array of weights typically in the range `[0,1]` that specify how much of the morph
  21288. * is applied. This member is `undefined` by default and only set when morph targets are
  21289. * detected in the geometry.
  21290. *
  21291. * @type {Array<number>|undefined}
  21292. * @default undefined
  21293. */
  21294. this.morphTargetInfluences = undefined;
  21295. this.updateMorphTargets();
  21296. }
  21297. copy( source, recursive ) {
  21298. super.copy( source, recursive );
  21299. this.material = Array.isArray( source.material ) ? source.material.slice() : source.material;
  21300. this.geometry = source.geometry;
  21301. return this;
  21302. }
  21303. /**
  21304. * Computes an array of distance values which are necessary for rendering dashed lines.
  21305. * For each vertex in the geometry, the method calculates the cumulative length from the
  21306. * current point to the very beginning of the line.
  21307. *
  21308. * @return {Line} A reference to this line.
  21309. */
  21310. computeLineDistances() {
  21311. const geometry = this.geometry;
  21312. // we assume non-indexed geometry
  21313. if ( geometry.index === null ) {
  21314. const positionAttribute = geometry.attributes.position;
  21315. const lineDistances = [ 0 ];
  21316. for ( let i = 1, l = positionAttribute.count; i < l; i ++ ) {
  21317. _vStart.fromBufferAttribute( positionAttribute, i - 1 );
  21318. _vEnd.fromBufferAttribute( positionAttribute, i );
  21319. lineDistances[ i ] = lineDistances[ i - 1 ];
  21320. lineDistances[ i ] += _vStart.distanceTo( _vEnd );
  21321. }
  21322. geometry.setAttribute( 'lineDistance', new Float32BufferAttribute( lineDistances, 1 ) );
  21323. } else {
  21324. warn( 'Line.computeLineDistances(): Computation only possible with non-indexed BufferGeometry.' );
  21325. }
  21326. return this;
  21327. }
  21328. /**
  21329. * Computes intersection points between a casted ray and this line.
  21330. *
  21331. * @param {Raycaster} raycaster - The raycaster.
  21332. * @param {Array<Object>} intersects - The target array that holds the intersection points.
  21333. */
  21334. raycast( raycaster, intersects ) {
  21335. const geometry = this.geometry;
  21336. const matrixWorld = this.matrixWorld;
  21337. const threshold = raycaster.params.Line.threshold;
  21338. const drawRange = geometry.drawRange;
  21339. // Checking boundingSphere distance to ray
  21340. if ( geometry.boundingSphere === null ) geometry.computeBoundingSphere();
  21341. _sphere$1.copy( geometry.boundingSphere );
  21342. _sphere$1.applyMatrix4( matrixWorld );
  21343. _sphere$1.radius += threshold;
  21344. if ( raycaster.ray.intersectsSphere( _sphere$1 ) === false ) return;
  21345. //
  21346. _inverseMatrix$1.copy( matrixWorld ).invert();
  21347. _ray$1.copy( raycaster.ray ).applyMatrix4( _inverseMatrix$1 );
  21348. const localThreshold = threshold / ( ( this.scale.x + this.scale.y + this.scale.z ) / 3 );
  21349. const localThresholdSq = localThreshold * localThreshold;
  21350. const step = this.isLineSegments ? 2 : 1;
  21351. const index = geometry.index;
  21352. const attributes = geometry.attributes;
  21353. const positionAttribute = attributes.position;
  21354. if ( index !== null ) {
  21355. const start = Math.max( 0, drawRange.start );
  21356. const end = Math.min( index.count, ( drawRange.start + drawRange.count ) );
  21357. for ( let i = start, l = end - 1; i < l; i += step ) {
  21358. const a = index.getX( i );
  21359. const b = index.getX( i + 1 );
  21360. const intersect = checkIntersection( this, raycaster, _ray$1, localThresholdSq, a, b, i );
  21361. if ( intersect ) {
  21362. intersects.push( intersect );
  21363. }
  21364. }
  21365. if ( this.isLineLoop ) {
  21366. const a = index.getX( end - 1 );
  21367. const b = index.getX( start );
  21368. const intersect = checkIntersection( this, raycaster, _ray$1, localThresholdSq, a, b, end - 1 );
  21369. if ( intersect ) {
  21370. intersects.push( intersect );
  21371. }
  21372. }
  21373. } else {
  21374. const start = Math.max( 0, drawRange.start );
  21375. const end = Math.min( positionAttribute.count, ( drawRange.start + drawRange.count ) );
  21376. for ( let i = start, l = end - 1; i < l; i += step ) {
  21377. const intersect = checkIntersection( this, raycaster, _ray$1, localThresholdSq, i, i + 1, i );
  21378. if ( intersect ) {
  21379. intersects.push( intersect );
  21380. }
  21381. }
  21382. if ( this.isLineLoop ) {
  21383. const intersect = checkIntersection( this, raycaster, _ray$1, localThresholdSq, end - 1, start, end - 1 );
  21384. if ( intersect ) {
  21385. intersects.push( intersect );
  21386. }
  21387. }
  21388. }
  21389. }
  21390. /**
  21391. * Sets the values of {@link Line#morphTargetDictionary} and {@link Line#morphTargetInfluences}
  21392. * to make sure existing morph targets can influence this 3D object.
  21393. */
  21394. updateMorphTargets() {
  21395. const geometry = this.geometry;
  21396. const morphAttributes = geometry.morphAttributes;
  21397. const keys = Object.keys( morphAttributes );
  21398. if ( keys.length > 0 ) {
  21399. const morphAttribute = morphAttributes[ keys[ 0 ] ];
  21400. if ( morphAttribute !== undefined ) {
  21401. this.morphTargetInfluences = [];
  21402. this.morphTargetDictionary = {};
  21403. for ( let m = 0, ml = morphAttribute.length; m < ml; m ++ ) {
  21404. const name = morphAttribute[ m ].name || String( m );
  21405. this.morphTargetInfluences.push( 0 );
  21406. this.morphTargetDictionary[ name ] = m;
  21407. }
  21408. }
  21409. }
  21410. }
  21411. }
  21412. function checkIntersection( object, raycaster, ray, thresholdSq, a, b, i ) {
  21413. const positionAttribute = object.geometry.attributes.position;
  21414. _vStart.fromBufferAttribute( positionAttribute, a );
  21415. _vEnd.fromBufferAttribute( positionAttribute, b );
  21416. const distSq = ray.distanceSqToSegment( _vStart, _vEnd, _intersectPointOnRay, _intersectPointOnSegment );
  21417. if ( distSq > thresholdSq ) return;
  21418. _intersectPointOnRay.applyMatrix4( object.matrixWorld ); // Move back to world space for distance calculation
  21419. const distance = raycaster.ray.origin.distanceTo( _intersectPointOnRay );
  21420. if ( distance < raycaster.near || distance > raycaster.far ) return;
  21421. return {
  21422. distance: distance,
  21423. // What do we want? intersection point on the ray or on the segment??
  21424. // point: raycaster.ray.at( distance ),
  21425. point: _intersectPointOnSegment.clone().applyMatrix4( object.matrixWorld ),
  21426. index: i,
  21427. face: null,
  21428. faceIndex: null,
  21429. barycoord: null,
  21430. object: object
  21431. };
  21432. }
  21433. const _start = /*@__PURE__*/ new Vector3();
  21434. const _end = /*@__PURE__*/ new Vector3();
  21435. /**
  21436. * A series of lines drawn between pairs of vertices.
  21437. *
  21438. * @augments Line
  21439. */
  21440. class LineSegments extends Line {
  21441. /**
  21442. * Constructs a new line segments.
  21443. *
  21444. * @param {BufferGeometry} [geometry] - The line geometry.
  21445. * @param {Material|Array<Material>} [material] - The line material.
  21446. */
  21447. constructor( geometry, material ) {
  21448. super( geometry, material );
  21449. /**
  21450. * This flag can be used for type testing.
  21451. *
  21452. * @type {boolean}
  21453. * @readonly
  21454. * @default true
  21455. */
  21456. this.isLineSegments = true;
  21457. this.type = 'LineSegments';
  21458. }
  21459. computeLineDistances() {
  21460. const geometry = this.geometry;
  21461. // we assume non-indexed geometry
  21462. if ( geometry.index === null ) {
  21463. const positionAttribute = geometry.attributes.position;
  21464. const lineDistances = [];
  21465. for ( let i = 0, l = positionAttribute.count; i < l; i += 2 ) {
  21466. _start.fromBufferAttribute( positionAttribute, i );
  21467. _end.fromBufferAttribute( positionAttribute, i + 1 );
  21468. lineDistances[ i ] = ( i === 0 ) ? 0 : lineDistances[ i - 1 ];
  21469. lineDistances[ i + 1 ] = lineDistances[ i ] + _start.distanceTo( _end );
  21470. }
  21471. geometry.setAttribute( 'lineDistance', new Float32BufferAttribute( lineDistances, 1 ) );
  21472. } else {
  21473. warn( 'LineSegments.computeLineDistances(): Computation only possible with non-indexed BufferGeometry.' );
  21474. }
  21475. return this;
  21476. }
  21477. }
  21478. /**
  21479. * A continuous line. This is nearly the same as {@link Line} the only difference
  21480. * is that the last vertex is connected with the first vertex in order to close
  21481. * the line to form a loop.
  21482. *
  21483. * @augments Line
  21484. */
  21485. class LineLoop extends Line {
  21486. /**
  21487. * Constructs a new line loop.
  21488. *
  21489. * @param {BufferGeometry} [geometry] - The line geometry.
  21490. * @param {Material|Array<Material>} [material] - The line material.
  21491. */
  21492. constructor( geometry, material ) {
  21493. super( geometry, material );
  21494. /**
  21495. * This flag can be used for type testing.
  21496. *
  21497. * @type {boolean}
  21498. * @readonly
  21499. * @default true
  21500. */
  21501. this.isLineLoop = true;
  21502. this.type = 'LineLoop';
  21503. }
  21504. }
  21505. /**
  21506. * A material for rendering point primitives.
  21507. *
  21508. * Materials define the appearance of renderable 3D objects.
  21509. *
  21510. * ```js
  21511. * const vertices = [];
  21512. *
  21513. * for ( let i = 0; i < 10000; i ++ ) {
  21514. * const x = THREE.MathUtils.randFloatSpread( 2000 );
  21515. * const y = THREE.MathUtils.randFloatSpread( 2000 );
  21516. * const z = THREE.MathUtils.randFloatSpread( 2000 );
  21517. *
  21518. * vertices.push( x, y, z );
  21519. * }
  21520. *
  21521. * const geometry = new THREE.BufferGeometry();
  21522. * geometry.setAttribute( 'position', new THREE.Float32BufferAttribute( vertices, 3 ) );
  21523. * const material = new THREE.PointsMaterial( { color: 0x888888 } );
  21524. * const points = new THREE.Points( geometry, material );
  21525. * scene.add( points );
  21526. * ```
  21527. *
  21528. * @augments Material
  21529. */
  21530. class PointsMaterial extends Material {
  21531. /**
  21532. * Constructs a new points material.
  21533. *
  21534. * @param {Object} [parameters] - An object with one or more properties
  21535. * defining the material's appearance. Any property of the material
  21536. * (including any property from inherited materials) can be passed
  21537. * in here. Color values can be passed any type of value accepted
  21538. * by {@link Color#set}.
  21539. */
  21540. constructor( parameters ) {
  21541. super();
  21542. /**
  21543. * This flag can be used for type testing.
  21544. *
  21545. * @type {boolean}
  21546. * @readonly
  21547. * @default true
  21548. */
  21549. this.isPointsMaterial = true;
  21550. this.type = 'PointsMaterial';
  21551. /**
  21552. * Color of the material.
  21553. *
  21554. * @type {Color}
  21555. * @default (1,1,1)
  21556. */
  21557. this.color = new Color( 0xffffff );
  21558. /**
  21559. * The color map. May optionally include an alpha channel, typically combined
  21560. * with {@link Material#transparent} or {@link Material#alphaTest}. The texture map
  21561. * color is modulated by the diffuse `color`.
  21562. *
  21563. * @type {?Texture}
  21564. * @default null
  21565. */
  21566. this.map = null;
  21567. /**
  21568. * The alpha map is a grayscale texture that controls the opacity across the
  21569. * surface (black: fully transparent; white: fully opaque).
  21570. *
  21571. * Only the color of the texture is used, ignoring the alpha channel if one
  21572. * exists. For RGB and RGBA textures, the renderer will use the green channel
  21573. * when sampling this texture due to the extra bit of precision provided for
  21574. * green in DXT-compressed and uncompressed RGB 565 formats. Luminance-only and
  21575. * luminance/alpha textures will also still work as expected.
  21576. *
  21577. * @type {?Texture}
  21578. * @default null
  21579. */
  21580. this.alphaMap = null;
  21581. /**
  21582. * Defines the size of the points in pixels.
  21583. *
  21584. * 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).
  21585. *
  21586. * @type {number}
  21587. * @default 1
  21588. */
  21589. this.size = 1;
  21590. /**
  21591. * Specifies whether size of individual points is attenuated by the camera depth (perspective camera only).
  21592. *
  21593. * @type {boolean}
  21594. * @default true
  21595. */
  21596. this.sizeAttenuation = true;
  21597. /**
  21598. * Whether the material is affected by fog or not.
  21599. *
  21600. * @type {boolean}
  21601. * @default true
  21602. */
  21603. this.fog = true;
  21604. this.setValues( parameters );
  21605. }
  21606. copy( source ) {
  21607. super.copy( source );
  21608. this.color.copy( source.color );
  21609. this.map = source.map;
  21610. this.alphaMap = source.alphaMap;
  21611. this.size = source.size;
  21612. this.sizeAttenuation = source.sizeAttenuation;
  21613. this.fog = source.fog;
  21614. return this;
  21615. }
  21616. }
  21617. const _inverseMatrix = /*@__PURE__*/ new Matrix4();
  21618. const _ray = /*@__PURE__*/ new Ray();
  21619. const _sphere = /*@__PURE__*/ new Sphere();
  21620. const _position$2 = /*@__PURE__*/ new Vector3();
  21621. /**
  21622. * A class for displaying points or point clouds.
  21623. *
  21624. * @augments Object3D
  21625. */
  21626. class Points extends Object3D {
  21627. /**
  21628. * Constructs a new point cloud.
  21629. *
  21630. * @param {BufferGeometry} [geometry] - The points geometry.
  21631. * @param {Material|Array<Material>} [material] - The points material.
  21632. */
  21633. constructor( geometry = new BufferGeometry(), material = new PointsMaterial() ) {
  21634. super();
  21635. /**
  21636. * This flag can be used for type testing.
  21637. *
  21638. * @type {boolean}
  21639. * @readonly
  21640. * @default true
  21641. */
  21642. this.isPoints = true;
  21643. this.type = 'Points';
  21644. /**
  21645. * The points geometry.
  21646. *
  21647. * @type {BufferGeometry}
  21648. */
  21649. this.geometry = geometry;
  21650. /**
  21651. * The line material.
  21652. *
  21653. * @type {Material|Array<Material>}
  21654. * @default PointsMaterial
  21655. */
  21656. this.material = material;
  21657. /**
  21658. * A dictionary representing the morph targets in the geometry. The key is the
  21659. * morph targets name, the value its attribute index. This member is `undefined`
  21660. * by default and only set when morph targets are detected in the geometry.
  21661. *
  21662. * @type {Object<string,number>|undefined}
  21663. * @default undefined
  21664. */
  21665. this.morphTargetDictionary = undefined;
  21666. /**
  21667. * An array of weights typically in the range `[0,1]` that specify how much of the morph
  21668. * is applied. This member is `undefined` by default and only set when morph targets are
  21669. * detected in the geometry.
  21670. *
  21671. * @type {Array<number>|undefined}
  21672. * @default undefined
  21673. */
  21674. this.morphTargetInfluences = undefined;
  21675. this.updateMorphTargets();
  21676. }
  21677. copy( source, recursive ) {
  21678. super.copy( source, recursive );
  21679. this.material = Array.isArray( source.material ) ? source.material.slice() : source.material;
  21680. this.geometry = source.geometry;
  21681. return this;
  21682. }
  21683. /**
  21684. * Computes intersection points between a casted ray and this point cloud.
  21685. *
  21686. * @param {Raycaster} raycaster - The raycaster.
  21687. * @param {Array<Object>} intersects - The target array that holds the intersection points.
  21688. */
  21689. raycast( raycaster, intersects ) {
  21690. const geometry = this.geometry;
  21691. const matrixWorld = this.matrixWorld;
  21692. const threshold = raycaster.params.Points.threshold;
  21693. const drawRange = geometry.drawRange;
  21694. // Checking boundingSphere distance to ray
  21695. if ( geometry.boundingSphere === null ) geometry.computeBoundingSphere();
  21696. _sphere.copy( geometry.boundingSphere );
  21697. _sphere.applyMatrix4( matrixWorld );
  21698. _sphere.radius += threshold;
  21699. if ( raycaster.ray.intersectsSphere( _sphere ) === false ) return;
  21700. //
  21701. _inverseMatrix.copy( matrixWorld ).invert();
  21702. _ray.copy( raycaster.ray ).applyMatrix4( _inverseMatrix );
  21703. const localThreshold = threshold / ( ( this.scale.x + this.scale.y + this.scale.z ) / 3 );
  21704. const localThresholdSq = localThreshold * localThreshold;
  21705. const index = geometry.index;
  21706. const attributes = geometry.attributes;
  21707. const positionAttribute = attributes.position;
  21708. if ( index !== null ) {
  21709. const start = Math.max( 0, drawRange.start );
  21710. const end = Math.min( index.count, ( drawRange.start + drawRange.count ) );
  21711. for ( let i = start, il = end; i < il; i ++ ) {
  21712. const a = index.getX( i );
  21713. _position$2.fromBufferAttribute( positionAttribute, a );
  21714. testPoint( _position$2, a, localThresholdSq, matrixWorld, raycaster, intersects, this );
  21715. }
  21716. } else {
  21717. const start = Math.max( 0, drawRange.start );
  21718. const end = Math.min( positionAttribute.count, ( drawRange.start + drawRange.count ) );
  21719. for ( let i = start, l = end; i < l; i ++ ) {
  21720. _position$2.fromBufferAttribute( positionAttribute, i );
  21721. testPoint( _position$2, i, localThresholdSq, matrixWorld, raycaster, intersects, this );
  21722. }
  21723. }
  21724. }
  21725. /**
  21726. * Sets the values of {@link Points#morphTargetDictionary} and {@link Points#morphTargetInfluences}
  21727. * to make sure existing morph targets can influence this 3D object.
  21728. */
  21729. updateMorphTargets() {
  21730. const geometry = this.geometry;
  21731. const morphAttributes = geometry.morphAttributes;
  21732. const keys = Object.keys( morphAttributes );
  21733. if ( keys.length > 0 ) {
  21734. const morphAttribute = morphAttributes[ keys[ 0 ] ];
  21735. if ( morphAttribute !== undefined ) {
  21736. this.morphTargetInfluences = [];
  21737. this.morphTargetDictionary = {};
  21738. for ( let m = 0, ml = morphAttribute.length; m < ml; m ++ ) {
  21739. const name = morphAttribute[ m ].name || String( m );
  21740. this.morphTargetInfluences.push( 0 );
  21741. this.morphTargetDictionary[ name ] = m;
  21742. }
  21743. }
  21744. }
  21745. }
  21746. }
  21747. function testPoint( point, index, localThresholdSq, matrixWorld, raycaster, intersects, object ) {
  21748. const rayPointDistanceSq = _ray.distanceSqToPoint( point );
  21749. if ( rayPointDistanceSq < localThresholdSq ) {
  21750. const intersectPoint = new Vector3();
  21751. _ray.closestPointToPoint( point, intersectPoint );
  21752. intersectPoint.applyMatrix4( matrixWorld );
  21753. const distance = raycaster.ray.origin.distanceTo( intersectPoint );
  21754. if ( distance < raycaster.near || distance > raycaster.far ) return;
  21755. intersects.push( {
  21756. distance: distance,
  21757. distanceToRay: Math.sqrt( rayPointDistanceSq ),
  21758. point: intersectPoint,
  21759. index: index,
  21760. face: null,
  21761. faceIndex: null,
  21762. barycoord: null,
  21763. object: object
  21764. } );
  21765. }
  21766. }
  21767. /**
  21768. * A texture for use with a video.
  21769. *
  21770. * ```js
  21771. * // assuming you have created a HTML video element with id="video"
  21772. * const video = document.getElementById( 'video' );
  21773. * const texture = new THREE.VideoTexture( video );
  21774. * ```
  21775. *
  21776. * Note: When using video textures with {@link WebGPURenderer}, {@link Texture#colorSpace} must be
  21777. * set to THREE.SRGBColorSpace.
  21778. *
  21779. * Note: After the initial use of a texture, its dimensions, format, and type
  21780. * cannot be changed. Instead, call {@link Texture#dispose} on the texture and instantiate a new one.
  21781. *
  21782. * @augments Texture
  21783. */
  21784. class VideoTexture extends Texture {
  21785. /**
  21786. * Constructs a new video texture.
  21787. *
  21788. * @param {HTMLVideoElement} video - The video element to use as a data source for the texture.
  21789. * @param {number} [mapping=Texture.DEFAULT_MAPPING] - The texture mapping.
  21790. * @param {number} [wrapS=ClampToEdgeWrapping] - The wrapS value.
  21791. * @param {number} [wrapT=ClampToEdgeWrapping] - The wrapT value.
  21792. * @param {number} [magFilter=LinearFilter] - The mag filter value.
  21793. * @param {number} [minFilter=LinearFilter] - The min filter value.
  21794. * @param {number} [format=RGBAFormat] - The texture format.
  21795. * @param {number} [type=UnsignedByteType] - The texture type.
  21796. * @param {number} [anisotropy=Texture.DEFAULT_ANISOTROPY] - The anisotropy value.
  21797. */
  21798. constructor( video, mapping, wrapS, wrapT, magFilter = LinearFilter, minFilter = LinearFilter, format, type, anisotropy ) {
  21799. super( video, mapping, wrapS, wrapT, magFilter, minFilter, format, type, anisotropy );
  21800. /**
  21801. * This flag can be used for type testing.
  21802. *
  21803. * @type {boolean}
  21804. * @readonly
  21805. * @default true
  21806. */
  21807. this.isVideoTexture = true;
  21808. /**
  21809. * Whether to generate mipmaps (if possible) for a texture.
  21810. *
  21811. * Overwritten and set to `false` by default.
  21812. *
  21813. * @type {boolean}
  21814. * @default false
  21815. */
  21816. this.generateMipmaps = false;
  21817. /**
  21818. * The video frame request callback identifier, which is a positive integer.
  21819. *
  21820. * Value of 0 represents no scheduled rVFC.
  21821. *
  21822. * @private
  21823. * @type {number}
  21824. */
  21825. this._requestVideoFrameCallbackId = 0;
  21826. const scope = this;
  21827. function updateVideo() {
  21828. scope.needsUpdate = true;
  21829. scope._requestVideoFrameCallbackId = video.requestVideoFrameCallback( updateVideo );
  21830. }
  21831. if ( 'requestVideoFrameCallback' in video ) {
  21832. this._requestVideoFrameCallbackId = video.requestVideoFrameCallback( updateVideo );
  21833. }
  21834. }
  21835. clone() {
  21836. return new this.constructor( this.image ).copy( this );
  21837. }
  21838. /**
  21839. * This method is called automatically by the renderer and sets {@link Texture#needsUpdate}
  21840. * to `true` every time a new frame is available.
  21841. *
  21842. * Only relevant if `requestVideoFrameCallback` is not supported in the browser.
  21843. */
  21844. update() {
  21845. const video = this.image;
  21846. const hasVideoFrameCallback = 'requestVideoFrameCallback' in video;
  21847. if ( hasVideoFrameCallback === false && video.readyState >= video.HAVE_CURRENT_DATA ) {
  21848. this.needsUpdate = true;
  21849. }
  21850. }
  21851. dispose() {
  21852. if ( this._requestVideoFrameCallbackId !== 0 ) {
  21853. this.source.data.cancelVideoFrameCallback( this._requestVideoFrameCallbackId );
  21854. this._requestVideoFrameCallbackId = 0;
  21855. }
  21856. super.dispose();
  21857. }
  21858. }
  21859. /**
  21860. * This class can be used as an alternative way to define video data. Instead of using
  21861. * an instance of `HTMLVideoElement` like with `VideoTexture`, `VideoFrameTexture` expects each frame is
  21862. * defined manually via {@link VideoFrameTexture#setFrame}. A typical use case for this module is when
  21863. * video frames are decoded with the WebCodecs API.
  21864. *
  21865. * ```js
  21866. * const texture = new THREE.VideoFrameTexture();
  21867. * texture.setFrame( frame );
  21868. * ```
  21869. *
  21870. * @augments VideoTexture
  21871. */
  21872. class VideoFrameTexture extends VideoTexture {
  21873. /**
  21874. * Constructs a new video frame texture.
  21875. *
  21876. * @param {number} [mapping=Texture.DEFAULT_MAPPING] - The texture mapping.
  21877. * @param {number} [wrapS=ClampToEdgeWrapping] - The wrapS value.
  21878. * @param {number} [wrapT=ClampToEdgeWrapping] - The wrapT value.
  21879. * @param {number} [magFilter=LinearFilter] - The mag filter value.
  21880. * @param {number} [minFilter=LinearFilter] - The min filter value.
  21881. * @param {number} [format=RGBAFormat] - The texture format.
  21882. * @param {number} [type=UnsignedByteType] - The texture type.
  21883. * @param {number} [anisotropy=Texture.DEFAULT_ANISOTROPY] - The anisotropy value.
  21884. */
  21885. constructor( mapping, wrapS, wrapT, magFilter, minFilter, format, type, anisotropy ) {
  21886. super( {}, mapping, wrapS, wrapT, magFilter, minFilter, format, type, anisotropy );
  21887. /**
  21888. * This flag can be used for type testing.
  21889. *
  21890. * @type {boolean}
  21891. * @readonly
  21892. * @default true
  21893. */
  21894. this.isVideoFrameTexture = true;
  21895. }
  21896. /**
  21897. * This method overwritten with an empty implementation since
  21898. * this type of texture is updated via `setFrame()`.
  21899. */
  21900. update() {}
  21901. clone() {
  21902. return new this.constructor().copy( this ); // restoring Texture.clone()
  21903. }
  21904. /**
  21905. * Sets the current frame of the video. This will automatically update the texture
  21906. * so the data can be used for rendering.
  21907. *
  21908. * @param {VideoFrame} frame - The video frame.
  21909. */
  21910. setFrame( frame ) {
  21911. this.image = frame;
  21912. this.needsUpdate = true;
  21913. }
  21914. }
  21915. /**
  21916. * This class can only be used in combination with `copyFramebufferToTexture()` methods
  21917. * of renderers. It extracts the contents of the current bound framebuffer and provides it
  21918. * as a texture for further usage.
  21919. *
  21920. * ```js
  21921. * const pixelRatio = window.devicePixelRatio;
  21922. * const textureSize = 128 * pixelRatio;
  21923. *
  21924. * const frameTexture = new FramebufferTexture( textureSize, textureSize );
  21925. *
  21926. * // calculate start position for copying part of the frame data
  21927. * const vector = new Vector2();
  21928. * vector.x = ( window.innerWidth * pixelRatio / 2 ) - ( textureSize / 2 );
  21929. * vector.y = ( window.innerHeight * pixelRatio / 2 ) - ( textureSize / 2 );
  21930. *
  21931. * renderer.render( scene, camera );
  21932. *
  21933. * // copy part of the rendered frame into the framebuffer texture
  21934. * renderer.copyFramebufferToTexture( frameTexture, vector );
  21935. * ```
  21936. *
  21937. * @augments Texture
  21938. */
  21939. class FramebufferTexture extends Texture {
  21940. /**
  21941. * Constructs a new framebuffer texture.
  21942. *
  21943. * @param {number} [width] - The width of the texture.
  21944. * @param {number} [height] - The height of the texture.
  21945. */
  21946. constructor( width, height ) {
  21947. super( { width, height } );
  21948. /**
  21949. * This flag can be used for type testing.
  21950. *
  21951. * @type {boolean}
  21952. * @readonly
  21953. * @default true
  21954. */
  21955. this.isFramebufferTexture = true;
  21956. /**
  21957. * How the texture is sampled when a texel covers more than one pixel.
  21958. *
  21959. * Overwritten and set to `NearestFilter` by default to disable filtering.
  21960. *
  21961. * @type {(NearestFilter|NearestMipmapNearestFilter|NearestMipmapLinearFilter|LinearFilter|LinearMipmapNearestFilter|LinearMipmapLinearFilter)}
  21962. * @default NearestFilter
  21963. */
  21964. this.magFilter = NearestFilter;
  21965. /**
  21966. * How the texture is sampled when a texel covers less than one pixel.
  21967. *
  21968. * Overwritten and set to `NearestFilter` by default to disable filtering.
  21969. *
  21970. * @type {(NearestFilter|NearestMipmapNearestFilter|NearestMipmapLinearFilter|LinearFilter|LinearMipmapNearestFilter|LinearMipmapLinearFilter)}
  21971. * @default NearestFilter
  21972. */
  21973. this.minFilter = NearestFilter;
  21974. /**
  21975. * Whether to generate mipmaps (if possible) for a texture.
  21976. *
  21977. * Overwritten and set to `false` by default.
  21978. *
  21979. * @type {boolean}
  21980. * @default false
  21981. */
  21982. this.generateMipmaps = false;
  21983. this.needsUpdate = true;
  21984. }
  21985. }
  21986. /**
  21987. * Creates a texture based on data in compressed form.
  21988. *
  21989. * These texture are usually loaded with {@link CompressedTextureLoader}.
  21990. *
  21991. * @augments Texture
  21992. */
  21993. class CompressedTexture extends Texture {
  21994. /**
  21995. * Constructs a new compressed texture.
  21996. *
  21997. * @param {Array<Object>} mipmaps - This array holds for all mipmaps (including the bases mip)
  21998. * the data and dimensions.
  21999. * @param {number} width - The width of the texture.
  22000. * @param {number} height - The height of the texture.
  22001. * @param {number} [format=RGBAFormat] - The texture format.
  22002. * @param {number} [type=UnsignedByteType] - The texture type.
  22003. * @param {number} [mapping=Texture.DEFAULT_MAPPING] - The texture mapping.
  22004. * @param {number} [wrapS=ClampToEdgeWrapping] - The wrapS value.
  22005. * @param {number} [wrapT=ClampToEdgeWrapping] - The wrapT value.
  22006. * @param {number} [magFilter=LinearFilter] - The mag filter value.
  22007. * @param {number} [minFilter=LinearMipmapLinearFilter] - The min filter value.
  22008. * @param {number} [anisotropy=Texture.DEFAULT_ANISOTROPY] - The anisotropy value.
  22009. * @param {string} [colorSpace=NoColorSpace] - The color space.
  22010. */
  22011. constructor( mipmaps, width, height, format, type, mapping, wrapS, wrapT, magFilter, minFilter, anisotropy, colorSpace ) {
  22012. super( null, mapping, wrapS, wrapT, magFilter, minFilter, format, type, anisotropy, colorSpace );
  22013. /**
  22014. * This flag can be used for type testing.
  22015. *
  22016. * @type {boolean}
  22017. * @readonly
  22018. * @default true
  22019. */
  22020. this.isCompressedTexture = true;
  22021. /**
  22022. * The image property of a compressed texture just defines its dimensions.
  22023. *
  22024. * @type {{width:number,height:number}}
  22025. */
  22026. this.image = { width: width, height: height };
  22027. /**
  22028. * This array holds for all mipmaps (including the bases mip) the data and dimensions.
  22029. *
  22030. * @type {Array<Object>}
  22031. */
  22032. this.mipmaps = mipmaps;
  22033. /**
  22034. * If set to `true`, the texture is flipped along the vertical axis when
  22035. * uploaded to the GPU.
  22036. *
  22037. * Overwritten and set to `false` by default since it is not possible to
  22038. * flip compressed textures.
  22039. *
  22040. * @type {boolean}
  22041. * @default false
  22042. * @readonly
  22043. */
  22044. this.flipY = false;
  22045. /**
  22046. * Whether to generate mipmaps (if possible) for a texture.
  22047. *
  22048. * Overwritten and set to `false` by default since it is not
  22049. * possible to generate mipmaps for compressed data. Mipmaps
  22050. * must be embedded in the compressed texture file.
  22051. *
  22052. * @type {boolean}
  22053. * @default false
  22054. * @readonly
  22055. */
  22056. this.generateMipmaps = false;
  22057. }
  22058. }
  22059. /**
  22060. * Creates a texture 2D array based on data in compressed form.
  22061. *
  22062. * These texture are usually loaded with {@link CompressedTextureLoader}.
  22063. *
  22064. * @augments CompressedTexture
  22065. */
  22066. class CompressedArrayTexture extends CompressedTexture {
  22067. /**
  22068. * Constructs a new compressed array texture.
  22069. *
  22070. * @param {Array<Object>} mipmaps - This array holds for all mipmaps (including the bases mip)
  22071. * the data and dimensions.
  22072. * @param {number} width - The width of the texture.
  22073. * @param {number} height - The height of the texture.
  22074. * @param {number} depth - The depth of the texture.
  22075. * @param {number} [format=RGBAFormat] - The min filter value.
  22076. * @param {number} [type=UnsignedByteType] - The min filter value.
  22077. */
  22078. constructor( mipmaps, width, height, depth, format, type ) {
  22079. super( mipmaps, width, height, format, type );
  22080. /**
  22081. * This flag can be used for type testing.
  22082. *
  22083. * @type {boolean}
  22084. * @readonly
  22085. * @default true
  22086. */
  22087. this.isCompressedArrayTexture = true;
  22088. /**
  22089. * The image property of a compressed texture just defines its dimensions.
  22090. *
  22091. * @name CompressedArrayTexture#image
  22092. * @type {{width:number,height:number,depth:number}}
  22093. */
  22094. this.image.depth = depth;
  22095. /**
  22096. * This defines how the texture is wrapped in the depth and corresponds to
  22097. * *W* in UVW mapping.
  22098. *
  22099. * @type {(RepeatWrapping|ClampToEdgeWrapping|MirroredRepeatWrapping)}
  22100. * @default ClampToEdgeWrapping
  22101. */
  22102. this.wrapR = ClampToEdgeWrapping;
  22103. /**
  22104. * A set of all layers which need to be updated in the texture.
  22105. *
  22106. * @type {Set<number>}
  22107. */
  22108. this.layerUpdates = new Set();
  22109. }
  22110. /**
  22111. * Describes that a specific layer of the texture needs to be updated.
  22112. * Normally when {@link Texture#needsUpdate} is set to `true`, the
  22113. * entire compressed texture array is sent to the GPU. Marking specific
  22114. * layers will only transmit subsets of all mipmaps associated with a
  22115. * specific depth in the array which is often much more performant.
  22116. *
  22117. * @param {number} layerIndex - The layer index that should be updated.
  22118. */
  22119. addLayerUpdate( layerIndex ) {
  22120. this.layerUpdates.add( layerIndex );
  22121. }
  22122. /**
  22123. * Resets the layer updates registry.
  22124. */
  22125. clearLayerUpdates() {
  22126. this.layerUpdates.clear();
  22127. }
  22128. }
  22129. /**
  22130. * Creates a cube texture based on data in compressed form.
  22131. *
  22132. * These texture are usually loaded with {@link CompressedTextureLoader}.
  22133. *
  22134. * @augments CompressedTexture
  22135. */
  22136. class CompressedCubeTexture extends CompressedTexture {
  22137. /**
  22138. * Constructs a new compressed texture.
  22139. *
  22140. * @param {Array<CompressedTexture>} images - An array of compressed textures.
  22141. * @param {number} [format=RGBAFormat] - The texture format.
  22142. * @param {number} [type=UnsignedByteType] - The texture type.
  22143. */
  22144. constructor( images, format, type ) {
  22145. super( undefined, images[ 0 ].width, images[ 0 ].height, format, type, CubeReflectionMapping );
  22146. /**
  22147. * This flag can be used for type testing.
  22148. *
  22149. * @type {boolean}
  22150. * @readonly
  22151. * @default true
  22152. */
  22153. this.isCompressedCubeTexture = true;
  22154. /**
  22155. * This flag can be used for type testing.
  22156. *
  22157. * @type {boolean}
  22158. * @readonly
  22159. * @default true
  22160. */
  22161. this.isCubeTexture = true;
  22162. this.image = images;
  22163. }
  22164. }
  22165. /**
  22166. * Creates a texture from a canvas element.
  22167. *
  22168. * This is almost the same as the base texture class, except that it sets {@link Texture#needsUpdate}
  22169. * to `true` immediately since a canvas can directly be used for rendering.
  22170. *
  22171. * @augments Texture
  22172. */
  22173. class CanvasTexture extends Texture {
  22174. /**
  22175. * Constructs a new texture.
  22176. *
  22177. * @param {HTMLCanvasElement} [canvas] - The HTML canvas element.
  22178. * @param {number} [mapping=Texture.DEFAULT_MAPPING] - The texture mapping.
  22179. * @param {number} [wrapS=ClampToEdgeWrapping] - The wrapS value.
  22180. * @param {number} [wrapT=ClampToEdgeWrapping] - The wrapT value.
  22181. * @param {number} [magFilter=LinearFilter] - The mag filter value.
  22182. * @param {number} [minFilter=LinearMipmapLinearFilter] - The min filter value.
  22183. * @param {number} [format=RGBAFormat] - The texture format.
  22184. * @param {number} [type=UnsignedByteType] - The texture type.
  22185. * @param {number} [anisotropy=Texture.DEFAULT_ANISOTROPY] - The anisotropy value.
  22186. */
  22187. constructor( canvas, mapping, wrapS, wrapT, magFilter, minFilter, format, type, anisotropy ) {
  22188. super( canvas, mapping, wrapS, wrapT, magFilter, minFilter, format, type, anisotropy );
  22189. /**
  22190. * This flag can be used for type testing.
  22191. *
  22192. * @type {boolean}
  22193. * @readonly
  22194. * @default true
  22195. */
  22196. this.isCanvasTexture = true;
  22197. this.needsUpdate = true;
  22198. }
  22199. }
  22200. /**
  22201. * This class can be used to automatically save the depth information of a
  22202. * rendering into a texture.
  22203. *
  22204. * @augments Texture
  22205. */
  22206. class DepthTexture extends Texture {
  22207. /**
  22208. * Constructs a new depth texture.
  22209. *
  22210. * @param {number} width - The width of the texture.
  22211. * @param {number} height - The height of the texture.
  22212. * @param {number} [type=UnsignedIntType] - The texture type.
  22213. * @param {number} [mapping=Texture.DEFAULT_MAPPING] - The texture mapping.
  22214. * @param {number} [wrapS=ClampToEdgeWrapping] - The wrapS value.
  22215. * @param {number} [wrapT=ClampToEdgeWrapping] - The wrapT value.
  22216. * @param {number} [magFilter=LinearFilter] - The mag filter value.
  22217. * @param {number} [minFilter=LinearFilter] - The min filter value.
  22218. * @param {number} [anisotropy=Texture.DEFAULT_ANISOTROPY] - The anisotropy value.
  22219. * @param {number} [format=DepthFormat] - The texture format.
  22220. * @param {number} [depth=1] - The depth of the texture.
  22221. */
  22222. constructor( width, height, type = UnsignedIntType, mapping, wrapS, wrapT, magFilter = NearestFilter, minFilter = NearestFilter, anisotropy, format = DepthFormat, depth = 1 ) {
  22223. if ( format !== DepthFormat && format !== DepthStencilFormat ) {
  22224. throw new Error( 'DepthTexture format must be either THREE.DepthFormat or THREE.DepthStencilFormat' );
  22225. }
  22226. const image = { width: width, height: height, depth: depth };
  22227. super( image, mapping, wrapS, wrapT, magFilter, minFilter, format, type, anisotropy );
  22228. /**
  22229. * This flag can be used for type testing.
  22230. *
  22231. * @type {boolean}
  22232. * @readonly
  22233. * @default true
  22234. */
  22235. this.isDepthTexture = true;
  22236. /**
  22237. * If set to `true`, the texture is flipped along the vertical axis when
  22238. * uploaded to the GPU.
  22239. *
  22240. * Overwritten and set to `false` by default.
  22241. *
  22242. * @type {boolean}
  22243. * @default false
  22244. */
  22245. this.flipY = false;
  22246. /**
  22247. * Whether to generate mipmaps (if possible) for a texture.
  22248. *
  22249. * Overwritten and set to `false` by default.
  22250. *
  22251. * @type {boolean}
  22252. * @default false
  22253. */
  22254. this.generateMipmaps = false;
  22255. /**
  22256. * Code corresponding to the depth compare function.
  22257. *
  22258. * @type {?(NeverCompare|LessCompare|EqualCompare|LessEqualCompare|GreaterCompare|NotEqualCompare|GreaterEqualCompare|AlwaysCompare)}
  22259. * @default null
  22260. */
  22261. this.compareFunction = null;
  22262. }
  22263. copy( source ) {
  22264. super.copy( source );
  22265. this.source = new Source( Object.assign( {}, source.image ) ); // see #30540
  22266. this.compareFunction = source.compareFunction;
  22267. return this;
  22268. }
  22269. toJSON( meta ) {
  22270. const data = super.toJSON( meta );
  22271. if ( this.compareFunction !== null ) data.compareFunction = this.compareFunction;
  22272. return data;
  22273. }
  22274. }
  22275. /**
  22276. * This class can be used to automatically save the depth information of a
  22277. * cube rendering into a cube texture with depth format. Used for PointLight shadows.
  22278. *
  22279. * @augments DepthTexture
  22280. */
  22281. class CubeDepthTexture extends DepthTexture {
  22282. /**
  22283. * Constructs a new cube depth texture.
  22284. *
  22285. * @param {number} size - The size (width and height) of each cube face.
  22286. * @param {number} [type=UnsignedIntType] - The texture type.
  22287. * @param {number} [mapping=CubeReflectionMapping] - The texture mapping.
  22288. * @param {number} [wrapS=ClampToEdgeWrapping] - The wrapS value.
  22289. * @param {number} [wrapT=ClampToEdgeWrapping] - The wrapT value.
  22290. * @param {number} [magFilter=NearestFilter] - The mag filter value.
  22291. * @param {number} [minFilter=NearestFilter] - The min filter value.
  22292. * @param {number} [anisotropy=Texture.DEFAULT_ANISOTROPY] - The anisotropy value.
  22293. * @param {number} [format=DepthFormat] - The texture format.
  22294. */
  22295. constructor( size, type = UnsignedIntType, mapping = CubeReflectionMapping, wrapS, wrapT, magFilter = NearestFilter, minFilter = NearestFilter, anisotropy, format = DepthFormat ) {
  22296. // Create 6 identical image descriptors for the cube faces
  22297. const image = { width: size, height: size, depth: 1 };
  22298. const images = [ image, image, image, image, image, image ];
  22299. // Call DepthTexture constructor with width, height
  22300. super( size, size, type, mapping, wrapS, wrapT, magFilter, minFilter, anisotropy, format );
  22301. // Replace the single image with the array of 6 images
  22302. this.image = images;
  22303. /**
  22304. * This flag can be used for type testing.
  22305. *
  22306. * @type {boolean}
  22307. * @readonly
  22308. * @default true
  22309. */
  22310. this.isCubeDepthTexture = true;
  22311. /**
  22312. * Set to true for cube texture handling in WebGLTextures.
  22313. *
  22314. * @type {boolean}
  22315. * @readonly
  22316. * @default true
  22317. */
  22318. this.isCubeTexture = true;
  22319. }
  22320. /**
  22321. * Alias for {@link CubeDepthTexture#image}.
  22322. *
  22323. * @type {Array<Image>}
  22324. */
  22325. get images() {
  22326. return this.image;
  22327. }
  22328. set images( value ) {
  22329. this.image = value;
  22330. }
  22331. }
  22332. /**
  22333. * Represents a texture created externally with the same renderer context.
  22334. *
  22335. * This may be a texture from a protected media stream, device camera feed,
  22336. * or other data feeds like a depth sensor.
  22337. *
  22338. * Note that this class is only supported in {@link WebGLRenderer}, and in
  22339. * the {@link WebGPURenderer} WebGPU backend.
  22340. *
  22341. * @augments Texture
  22342. */
  22343. class ExternalTexture extends Texture {
  22344. /**
  22345. * Creates a new raw texture.
  22346. *
  22347. * @param {?(WebGLTexture|GPUTexture)} [sourceTexture=null] - The external texture.
  22348. */
  22349. constructor( sourceTexture = null ) {
  22350. super();
  22351. /**
  22352. * The external source texture.
  22353. *
  22354. * @type {?(WebGLTexture|GPUTexture)}
  22355. * @default null
  22356. */
  22357. this.sourceTexture = sourceTexture;
  22358. /**
  22359. * This flag can be used for type testing.
  22360. *
  22361. * @type {boolean}
  22362. * @readonly
  22363. * @default true
  22364. */
  22365. this.isExternalTexture = true;
  22366. }
  22367. copy( source ) {
  22368. super.copy( source );
  22369. this.sourceTexture = source.sourceTexture;
  22370. return this;
  22371. }
  22372. }
  22373. /**
  22374. * A geometry class for representing a capsule.
  22375. *
  22376. * ```js
  22377. * const geometry = new THREE.CapsuleGeometry( 1, 1, 4, 8, 1 );
  22378. * const material = new THREE.MeshBasicMaterial( { color: 0x00ff00 } );
  22379. * const capsule = new THREE.Mesh( geometry, material );
  22380. * scene.add( capsule );
  22381. * ```
  22382. *
  22383. * @augments BufferGeometry
  22384. * @demo scenes/geometry-browser.html#CapsuleGeometry
  22385. */
  22386. class CapsuleGeometry extends BufferGeometry {
  22387. /**
  22388. * Constructs a new capsule geometry.
  22389. *
  22390. * @param {number} [radius=1] - Radius of the capsule.
  22391. * @param {number} [height=1] - Height of the middle section.
  22392. * @param {number} [capSegments=4] - Number of curve segments used to build each cap.
  22393. * @param {number} [radialSegments=8] - Number of segmented faces around the circumference of the capsule. Must be an integer >= 3.
  22394. * @param {number} [heightSegments=1] - Number of rows of faces along the height of the middle section. Must be an integer >= 1.
  22395. */
  22396. constructor( radius = 1, height = 1, capSegments = 4, radialSegments = 8, heightSegments = 1 ) {
  22397. super();
  22398. this.type = 'CapsuleGeometry';
  22399. /**
  22400. * Holds the constructor parameters that have been
  22401. * used to generate the geometry. Any modification
  22402. * after instantiation does not change the geometry.
  22403. *
  22404. * @type {Object}
  22405. */
  22406. this.parameters = {
  22407. radius: radius,
  22408. height: height,
  22409. capSegments: capSegments,
  22410. radialSegments: radialSegments,
  22411. heightSegments: heightSegments,
  22412. };
  22413. height = Math.max( 0, height );
  22414. capSegments = Math.max( 1, Math.floor( capSegments ) );
  22415. radialSegments = Math.max( 3, Math.floor( radialSegments ) );
  22416. heightSegments = Math.max( 1, Math.floor( heightSegments ) );
  22417. // buffers
  22418. const indices = [];
  22419. const vertices = [];
  22420. const normals = [];
  22421. const uvs = [];
  22422. // helper variables
  22423. const halfHeight = height / 2;
  22424. const capArcLength = ( Math.PI / 2 ) * radius;
  22425. const cylinderPartLength = height;
  22426. const totalArcLength = 2 * capArcLength + cylinderPartLength;
  22427. const numVerticalSegments = capSegments * 2 + heightSegments;
  22428. const verticesPerRow = radialSegments + 1;
  22429. const normal = new Vector3();
  22430. const vertex = new Vector3();
  22431. // generate vertices, normals, and uvs
  22432. for ( let iy = 0; iy <= numVerticalSegments; iy ++ ) {
  22433. let currentArcLength = 0;
  22434. let profileY = 0;
  22435. let profileRadius = 0;
  22436. let normalYComponent = 0;
  22437. if ( iy <= capSegments ) {
  22438. // bottom cap
  22439. const segmentProgress = iy / capSegments;
  22440. const angle = ( segmentProgress * Math.PI ) / 2;
  22441. profileY = - halfHeight - radius * Math.cos( angle );
  22442. profileRadius = radius * Math.sin( angle );
  22443. normalYComponent = - radius * Math.cos( angle );
  22444. currentArcLength = segmentProgress * capArcLength;
  22445. } else if ( iy <= capSegments + heightSegments ) {
  22446. // middle section
  22447. const segmentProgress = ( iy - capSegments ) / heightSegments;
  22448. profileY = - halfHeight + segmentProgress * height;
  22449. profileRadius = radius;
  22450. normalYComponent = 0;
  22451. currentArcLength = capArcLength + segmentProgress * cylinderPartLength;
  22452. } else {
  22453. // top cap
  22454. const segmentProgress =
  22455. ( iy - capSegments - heightSegments ) / capSegments;
  22456. const angle = ( segmentProgress * Math.PI ) / 2;
  22457. profileY = halfHeight + radius * Math.sin( angle );
  22458. profileRadius = radius * Math.cos( angle );
  22459. normalYComponent = radius * Math.sin( angle );
  22460. currentArcLength =
  22461. capArcLength + cylinderPartLength + segmentProgress * capArcLength;
  22462. }
  22463. const v = Math.max( 0, Math.min( 1, currentArcLength / totalArcLength ) );
  22464. // special case for the poles
  22465. let uOffset = 0;
  22466. if ( iy === 0 ) {
  22467. uOffset = 0.5 / radialSegments;
  22468. } else if ( iy === numVerticalSegments ) {
  22469. uOffset = -0.5 / radialSegments;
  22470. }
  22471. for ( let ix = 0; ix <= radialSegments; ix ++ ) {
  22472. const u = ix / radialSegments;
  22473. const theta = u * Math.PI * 2;
  22474. const sinTheta = Math.sin( theta );
  22475. const cosTheta = Math.cos( theta );
  22476. // vertex
  22477. vertex.x = - profileRadius * cosTheta;
  22478. vertex.y = profileY;
  22479. vertex.z = profileRadius * sinTheta;
  22480. vertices.push( vertex.x, vertex.y, vertex.z );
  22481. // normal
  22482. normal.set(
  22483. - profileRadius * cosTheta,
  22484. normalYComponent,
  22485. profileRadius * sinTheta
  22486. );
  22487. normal.normalize();
  22488. normals.push( normal.x, normal.y, normal.z );
  22489. // uv
  22490. uvs.push( u + uOffset, v );
  22491. }
  22492. if ( iy > 0 ) {
  22493. const prevIndexRow = ( iy - 1 ) * verticesPerRow;
  22494. for ( let ix = 0; ix < radialSegments; ix ++ ) {
  22495. const i1 = prevIndexRow + ix;
  22496. const i2 = prevIndexRow + ix + 1;
  22497. const i3 = iy * verticesPerRow + ix;
  22498. const i4 = iy * verticesPerRow + ix + 1;
  22499. indices.push( i1, i2, i3 );
  22500. indices.push( i2, i4, i3 );
  22501. }
  22502. }
  22503. }
  22504. // build geometry
  22505. this.setIndex( indices );
  22506. this.setAttribute( 'position', new Float32BufferAttribute( vertices, 3 ) );
  22507. this.setAttribute( 'normal', new Float32BufferAttribute( normals, 3 ) );
  22508. this.setAttribute( 'uv', new Float32BufferAttribute( uvs, 2 ) );
  22509. }
  22510. copy( source ) {
  22511. super.copy( source );
  22512. this.parameters = Object.assign( {}, source.parameters );
  22513. return this;
  22514. }
  22515. /**
  22516. * Factory method for creating an instance of this class from the given
  22517. * JSON object.
  22518. *
  22519. * @param {Object} data - A JSON object representing the serialized geometry.
  22520. * @return {CapsuleGeometry} A new instance.
  22521. */
  22522. static fromJSON( data ) {
  22523. return new CapsuleGeometry( data.radius, data.height, data.capSegments, data.radialSegments, data.heightSegments );
  22524. }
  22525. }
  22526. /**
  22527. * A simple shape of Euclidean geometry. It is constructed from a
  22528. * number of triangular segments that are oriented around a central point and
  22529. * extend as far out as a given radius. It is built counter-clockwise from a
  22530. * start angle and a given central angle. It can also be used to create
  22531. * regular polygons, where the number of segments determines the number of
  22532. * sides.
  22533. *
  22534. * ```js
  22535. * const geometry = new THREE.CircleGeometry( 5, 32 );
  22536. * const material = new THREE.MeshBasicMaterial( { color: 0xffff00 } );
  22537. * const circle = new THREE.Mesh( geometry, material );
  22538. * scene.add( circle )
  22539. * ```
  22540. *
  22541. * @augments BufferGeometry
  22542. * @demo scenes/geometry-browser.html#CircleGeometry
  22543. */
  22544. class CircleGeometry extends BufferGeometry {
  22545. /**
  22546. * Constructs a new circle geometry.
  22547. *
  22548. * @param {number} [radius=1] - Radius of the circle.
  22549. * @param {number} [segments=32] - Number of segments (triangles), minimum = `3`.
  22550. * @param {number} [thetaStart=0] - Start angle for first segment in radians.
  22551. * @param {number} [thetaLength=Math.PI*2] - The central angle, often called theta,
  22552. * of the circular sector in radians. The default value results in a complete circle.
  22553. */
  22554. constructor( radius = 1, segments = 32, thetaStart = 0, thetaLength = Math.PI * 2 ) {
  22555. super();
  22556. this.type = 'CircleGeometry';
  22557. /**
  22558. * Holds the constructor parameters that have been
  22559. * used to generate the geometry. Any modification
  22560. * after instantiation does not change the geometry.
  22561. *
  22562. * @type {Object}
  22563. */
  22564. this.parameters = {
  22565. radius: radius,
  22566. segments: segments,
  22567. thetaStart: thetaStart,
  22568. thetaLength: thetaLength
  22569. };
  22570. segments = Math.max( 3, segments );
  22571. // buffers
  22572. const indices = [];
  22573. const vertices = [];
  22574. const normals = [];
  22575. const uvs = [];
  22576. // helper variables
  22577. const vertex = new Vector3();
  22578. const uv = new Vector2();
  22579. // center point
  22580. vertices.push( 0, 0, 0 );
  22581. normals.push( 0, 0, 1 );
  22582. uvs.push( 0.5, 0.5 );
  22583. for ( let s = 0, i = 3; s <= segments; s ++, i += 3 ) {
  22584. const segment = thetaStart + s / segments * thetaLength;
  22585. // vertex
  22586. vertex.x = radius * Math.cos( segment );
  22587. vertex.y = radius * Math.sin( segment );
  22588. vertices.push( vertex.x, vertex.y, vertex.z );
  22589. // normal
  22590. normals.push( 0, 0, 1 );
  22591. // uvs
  22592. uv.x = ( vertices[ i ] / radius + 1 ) / 2;
  22593. uv.y = ( vertices[ i + 1 ] / radius + 1 ) / 2;
  22594. uvs.push( uv.x, uv.y );
  22595. }
  22596. // indices
  22597. for ( let i = 1; i <= segments; i ++ ) {
  22598. indices.push( i, i + 1, 0 );
  22599. }
  22600. // build geometry
  22601. this.setIndex( indices );
  22602. this.setAttribute( 'position', new Float32BufferAttribute( vertices, 3 ) );
  22603. this.setAttribute( 'normal', new Float32BufferAttribute( normals, 3 ) );
  22604. this.setAttribute( 'uv', new Float32BufferAttribute( uvs, 2 ) );
  22605. }
  22606. copy( source ) {
  22607. super.copy( source );
  22608. this.parameters = Object.assign( {}, source.parameters );
  22609. return this;
  22610. }
  22611. /**
  22612. * Factory method for creating an instance of this class from the given
  22613. * JSON object.
  22614. *
  22615. * @param {Object} data - A JSON object representing the serialized geometry.
  22616. * @return {CircleGeometry} A new instance.
  22617. */
  22618. static fromJSON( data ) {
  22619. return new CircleGeometry( data.radius, data.segments, data.thetaStart, data.thetaLength );
  22620. }
  22621. }
  22622. /**
  22623. * A geometry class for representing a cylinder.
  22624. *
  22625. * ```js
  22626. * const geometry = new THREE.CylinderGeometry( 5, 5, 20, 32 );
  22627. * const material = new THREE.MeshBasicMaterial( { color: 0xffff00 } );
  22628. * const cylinder = new THREE.Mesh( geometry, material );
  22629. * scene.add( cylinder );
  22630. * ```
  22631. *
  22632. * @augments BufferGeometry
  22633. * @demo scenes/geometry-browser.html#CylinderGeometry
  22634. */
  22635. class CylinderGeometry extends BufferGeometry {
  22636. /**
  22637. * Constructs a new cylinder geometry.
  22638. *
  22639. * @param {number} [radiusTop=1] - Radius of the cylinder at the top.
  22640. * @param {number} [radiusBottom=1] - Radius of the cylinder at the bottom.
  22641. * @param {number} [height=1] - Height of the cylinder.
  22642. * @param {number} [radialSegments=32] - Number of segmented faces around the circumference of the cylinder.
  22643. * @param {number} [heightSegments=1] - Number of rows of faces along the height of the cylinder.
  22644. * @param {boolean} [openEnded=false] - Whether the base of the cylinder is open or capped.
  22645. * @param {number} [thetaStart=0] - Start angle for first segment, in radians.
  22646. * @param {number} [thetaLength=Math.PI*2] - The central angle, often called theta, of the circular sector, in radians.
  22647. * The default value results in a complete cylinder.
  22648. */
  22649. constructor( radiusTop = 1, radiusBottom = 1, height = 1, radialSegments = 32, heightSegments = 1, openEnded = false, thetaStart = 0, thetaLength = Math.PI * 2 ) {
  22650. super();
  22651. this.type = 'CylinderGeometry';
  22652. /**
  22653. * Holds the constructor parameters that have been
  22654. * used to generate the geometry. Any modification
  22655. * after instantiation does not change the geometry.
  22656. *
  22657. * @type {Object}
  22658. */
  22659. this.parameters = {
  22660. radiusTop: radiusTop,
  22661. radiusBottom: radiusBottom,
  22662. height: height,
  22663. radialSegments: radialSegments,
  22664. heightSegments: heightSegments,
  22665. openEnded: openEnded,
  22666. thetaStart: thetaStart,
  22667. thetaLength: thetaLength
  22668. };
  22669. const scope = this;
  22670. radialSegments = Math.floor( radialSegments );
  22671. heightSegments = Math.floor( heightSegments );
  22672. // buffers
  22673. const indices = [];
  22674. const vertices = [];
  22675. const normals = [];
  22676. const uvs = [];
  22677. // helper variables
  22678. let index = 0;
  22679. const indexArray = [];
  22680. const halfHeight = height / 2;
  22681. let groupStart = 0;
  22682. // generate geometry
  22683. generateTorso();
  22684. if ( openEnded === false ) {
  22685. if ( radiusTop > 0 ) generateCap( true );
  22686. if ( radiusBottom > 0 ) generateCap( false );
  22687. }
  22688. // build geometry
  22689. this.setIndex( indices );
  22690. this.setAttribute( 'position', new Float32BufferAttribute( vertices, 3 ) );
  22691. this.setAttribute( 'normal', new Float32BufferAttribute( normals, 3 ) );
  22692. this.setAttribute( 'uv', new Float32BufferAttribute( uvs, 2 ) );
  22693. function generateTorso() {
  22694. const normal = new Vector3();
  22695. const vertex = new Vector3();
  22696. let groupCount = 0;
  22697. // this will be used to calculate the normal
  22698. const slope = ( radiusBottom - radiusTop ) / height;
  22699. // generate vertices, normals and uvs
  22700. for ( let y = 0; y <= heightSegments; y ++ ) {
  22701. const indexRow = [];
  22702. const v = y / heightSegments;
  22703. // calculate the radius of the current row
  22704. const radius = v * ( radiusBottom - radiusTop ) + radiusTop;
  22705. for ( let x = 0; x <= radialSegments; x ++ ) {
  22706. const u = x / radialSegments;
  22707. const theta = u * thetaLength + thetaStart;
  22708. const sinTheta = Math.sin( theta );
  22709. const cosTheta = Math.cos( theta );
  22710. // vertex
  22711. vertex.x = radius * sinTheta;
  22712. vertex.y = - v * height + halfHeight;
  22713. vertex.z = radius * cosTheta;
  22714. vertices.push( vertex.x, vertex.y, vertex.z );
  22715. // normal
  22716. normal.set( sinTheta, slope, cosTheta ).normalize();
  22717. normals.push( normal.x, normal.y, normal.z );
  22718. // uv
  22719. uvs.push( u, 1 - v );
  22720. // save index of vertex in respective row
  22721. indexRow.push( index ++ );
  22722. }
  22723. // now save vertices of the row in our index array
  22724. indexArray.push( indexRow );
  22725. }
  22726. // generate indices
  22727. for ( let x = 0; x < radialSegments; x ++ ) {
  22728. for ( let y = 0; y < heightSegments; y ++ ) {
  22729. // we use the index array to access the correct indices
  22730. const a = indexArray[ y ][ x ];
  22731. const b = indexArray[ y + 1 ][ x ];
  22732. const c = indexArray[ y + 1 ][ x + 1 ];
  22733. const d = indexArray[ y ][ x + 1 ];
  22734. // faces
  22735. if ( radiusTop > 0 || y !== 0 ) {
  22736. indices.push( a, b, d );
  22737. groupCount += 3;
  22738. }
  22739. if ( radiusBottom > 0 || y !== heightSegments - 1 ) {
  22740. indices.push( b, c, d );
  22741. groupCount += 3;
  22742. }
  22743. }
  22744. }
  22745. // add a group to the geometry. this will ensure multi material support
  22746. scope.addGroup( groupStart, groupCount, 0 );
  22747. // calculate new start value for groups
  22748. groupStart += groupCount;
  22749. }
  22750. function generateCap( top ) {
  22751. // save the index of the first center vertex
  22752. const centerIndexStart = index;
  22753. const uv = new Vector2();
  22754. const vertex = new Vector3();
  22755. let groupCount = 0;
  22756. const radius = ( top === true ) ? radiusTop : radiusBottom;
  22757. const sign = ( top === true ) ? 1 : -1;
  22758. // first we generate the center vertex data of the cap.
  22759. // because the geometry needs one set of uvs per face,
  22760. // we must generate a center vertex per face/segment
  22761. for ( let x = 1; x <= radialSegments; x ++ ) {
  22762. // vertex
  22763. vertices.push( 0, halfHeight * sign, 0 );
  22764. // normal
  22765. normals.push( 0, sign, 0 );
  22766. // uv
  22767. uvs.push( 0.5, 0.5 );
  22768. // increase index
  22769. index ++;
  22770. }
  22771. // save the index of the last center vertex
  22772. const centerIndexEnd = index;
  22773. // now we generate the surrounding vertices, normals and uvs
  22774. for ( let x = 0; x <= radialSegments; x ++ ) {
  22775. const u = x / radialSegments;
  22776. const theta = u * thetaLength + thetaStart;
  22777. const cosTheta = Math.cos( theta );
  22778. const sinTheta = Math.sin( theta );
  22779. // vertex
  22780. vertex.x = radius * sinTheta;
  22781. vertex.y = halfHeight * sign;
  22782. vertex.z = radius * cosTheta;
  22783. vertices.push( vertex.x, vertex.y, vertex.z );
  22784. // normal
  22785. normals.push( 0, sign, 0 );
  22786. // uv
  22787. uv.x = ( cosTheta * 0.5 ) + 0.5;
  22788. uv.y = ( sinTheta * 0.5 * sign ) + 0.5;
  22789. uvs.push( uv.x, uv.y );
  22790. // increase index
  22791. index ++;
  22792. }
  22793. // generate indices
  22794. for ( let x = 0; x < radialSegments; x ++ ) {
  22795. const c = centerIndexStart + x;
  22796. const i = centerIndexEnd + x;
  22797. if ( top === true ) {
  22798. // face top
  22799. indices.push( i, i + 1, c );
  22800. } else {
  22801. // face bottom
  22802. indices.push( i + 1, i, c );
  22803. }
  22804. groupCount += 3;
  22805. }
  22806. // add a group to the geometry. this will ensure multi material support
  22807. scope.addGroup( groupStart, groupCount, top === true ? 1 : 2 );
  22808. // calculate new start value for groups
  22809. groupStart += groupCount;
  22810. }
  22811. }
  22812. copy( source ) {
  22813. super.copy( source );
  22814. this.parameters = Object.assign( {}, source.parameters );
  22815. return this;
  22816. }
  22817. /**
  22818. * Factory method for creating an instance of this class from the given
  22819. * JSON object.
  22820. *
  22821. * @param {Object} data - A JSON object representing the serialized geometry.
  22822. * @return {CylinderGeometry} A new instance.
  22823. */
  22824. static fromJSON( data ) {
  22825. return new CylinderGeometry( data.radiusTop, data.radiusBottom, data.height, data.radialSegments, data.heightSegments, data.openEnded, data.thetaStart, data.thetaLength );
  22826. }
  22827. }
  22828. /**
  22829. * A geometry class for representing a cone.
  22830. *
  22831. * ```js
  22832. * const geometry = new THREE.ConeGeometry( 5, 20, 32 );
  22833. * const material = new THREE.MeshBasicMaterial( { color: 0xffff00 } );
  22834. * const cone = new THREE.Mesh(geometry, material );
  22835. * scene.add( cone );
  22836. * ```
  22837. *
  22838. * @augments CylinderGeometry
  22839. * @demo scenes/geometry-browser.html#ConeGeometry
  22840. */
  22841. class ConeGeometry extends CylinderGeometry {
  22842. /**
  22843. * Constructs a new cone geometry.
  22844. *
  22845. * @param {number} [radius=1] - Radius of the cone base.
  22846. * @param {number} [height=1] - Height of the cone.
  22847. * @param {number} [radialSegments=32] - Number of segmented faces around the circumference of the cone.
  22848. * @param {number} [heightSegments=1] - Number of rows of faces along the height of the cone.
  22849. * @param {boolean} [openEnded=false] - Whether the base of the cone is open or capped.
  22850. * @param {number} [thetaStart=0] - Start angle for first segment, in radians.
  22851. * @param {number} [thetaLength=Math.PI*2] - The central angle, often called theta, of the circular sector, in radians.
  22852. * The default value results in a complete cone.
  22853. */
  22854. constructor( radius = 1, height = 1, radialSegments = 32, heightSegments = 1, openEnded = false, thetaStart = 0, thetaLength = Math.PI * 2 ) {
  22855. super( 0, radius, height, radialSegments, heightSegments, openEnded, thetaStart, thetaLength );
  22856. this.type = 'ConeGeometry';
  22857. /**
  22858. * Holds the constructor parameters that have been
  22859. * used to generate the geometry. Any modification
  22860. * after instantiation does not change the geometry.
  22861. *
  22862. * @type {Object}
  22863. */
  22864. this.parameters = {
  22865. radius: radius,
  22866. height: height,
  22867. radialSegments: radialSegments,
  22868. heightSegments: heightSegments,
  22869. openEnded: openEnded,
  22870. thetaStart: thetaStart,
  22871. thetaLength: thetaLength
  22872. };
  22873. }
  22874. /**
  22875. * Factory method for creating an instance of this class from the given
  22876. * JSON object.
  22877. *
  22878. * @param {Object} data - A JSON object representing the serialized geometry.
  22879. * @return {ConeGeometry} A new instance.
  22880. */
  22881. static fromJSON( data ) {
  22882. return new ConeGeometry( data.radius, data.height, data.radialSegments, data.heightSegments, data.openEnded, data.thetaStart, data.thetaLength );
  22883. }
  22884. }
  22885. /**
  22886. * A polyhedron is a solid in three dimensions with flat faces. This class
  22887. * will take an array of vertices, project them onto a sphere, and then
  22888. * divide them up to the desired level of detail.
  22889. *
  22890. * @augments BufferGeometry
  22891. */
  22892. class PolyhedronGeometry extends BufferGeometry {
  22893. /**
  22894. * Constructs a new polyhedron geometry.
  22895. *
  22896. * @param {Array<number>} [vertices] - A flat array of vertices describing the base shape.
  22897. * @param {Array<number>} [indices] - A flat array of indices describing the base shape.
  22898. * @param {number} [radius=1] - The radius of the shape.
  22899. * @param {number} [detail=0] - How many levels to subdivide the geometry. The more detail, the smoother the shape.
  22900. */
  22901. constructor( vertices = [], indices = [], radius = 1, detail = 0 ) {
  22902. super();
  22903. this.type = 'PolyhedronGeometry';
  22904. /**
  22905. * Holds the constructor parameters that have been
  22906. * used to generate the geometry. Any modification
  22907. * after instantiation does not change the geometry.
  22908. *
  22909. * @type {Object}
  22910. */
  22911. this.parameters = {
  22912. vertices: vertices,
  22913. indices: indices,
  22914. radius: radius,
  22915. detail: detail
  22916. };
  22917. // default buffer data
  22918. const vertexBuffer = [];
  22919. const uvBuffer = [];
  22920. // the subdivision creates the vertex buffer data
  22921. subdivide( detail );
  22922. // all vertices should lie on a conceptual sphere with a given radius
  22923. applyRadius( radius );
  22924. // finally, create the uv data
  22925. generateUVs();
  22926. // build non-indexed geometry
  22927. this.setAttribute( 'position', new Float32BufferAttribute( vertexBuffer, 3 ) );
  22928. this.setAttribute( 'normal', new Float32BufferAttribute( vertexBuffer.slice(), 3 ) );
  22929. this.setAttribute( 'uv', new Float32BufferAttribute( uvBuffer, 2 ) );
  22930. if ( detail === 0 ) {
  22931. this.computeVertexNormals(); // flat normals
  22932. } else {
  22933. this.normalizeNormals(); // smooth normals
  22934. }
  22935. // helper functions
  22936. function subdivide( detail ) {
  22937. const a = new Vector3();
  22938. const b = new Vector3();
  22939. const c = new Vector3();
  22940. // iterate over all faces and apply a subdivision with the given detail value
  22941. for ( let i = 0; i < indices.length; i += 3 ) {
  22942. // get the vertices of the face
  22943. getVertexByIndex( indices[ i + 0 ], a );
  22944. getVertexByIndex( indices[ i + 1 ], b );
  22945. getVertexByIndex( indices[ i + 2 ], c );
  22946. // perform subdivision
  22947. subdivideFace( a, b, c, detail );
  22948. }
  22949. }
  22950. function subdivideFace( a, b, c, detail ) {
  22951. const cols = detail + 1;
  22952. // we use this multidimensional array as a data structure for creating the subdivision
  22953. const v = [];
  22954. // construct all of the vertices for this subdivision
  22955. for ( let i = 0; i <= cols; i ++ ) {
  22956. v[ i ] = [];
  22957. const aj = a.clone().lerp( c, i / cols );
  22958. const bj = b.clone().lerp( c, i / cols );
  22959. const rows = cols - i;
  22960. for ( let j = 0; j <= rows; j ++ ) {
  22961. if ( j === 0 && i === cols ) {
  22962. v[ i ][ j ] = aj;
  22963. } else {
  22964. v[ i ][ j ] = aj.clone().lerp( bj, j / rows );
  22965. }
  22966. }
  22967. }
  22968. // construct all of the faces
  22969. for ( let i = 0; i < cols; i ++ ) {
  22970. for ( let j = 0; j < 2 * ( cols - i ) - 1; j ++ ) {
  22971. const k = Math.floor( j / 2 );
  22972. if ( j % 2 === 0 ) {
  22973. pushVertex( v[ i ][ k + 1 ] );
  22974. pushVertex( v[ i + 1 ][ k ] );
  22975. pushVertex( v[ i ][ k ] );
  22976. } else {
  22977. pushVertex( v[ i ][ k + 1 ] );
  22978. pushVertex( v[ i + 1 ][ k + 1 ] );
  22979. pushVertex( v[ i + 1 ][ k ] );
  22980. }
  22981. }
  22982. }
  22983. }
  22984. function applyRadius( radius ) {
  22985. const vertex = new Vector3();
  22986. // iterate over the entire buffer and apply the radius to each vertex
  22987. for ( let i = 0; i < vertexBuffer.length; i += 3 ) {
  22988. vertex.x = vertexBuffer[ i + 0 ];
  22989. vertex.y = vertexBuffer[ i + 1 ];
  22990. vertex.z = vertexBuffer[ i + 2 ];
  22991. vertex.normalize().multiplyScalar( radius );
  22992. vertexBuffer[ i + 0 ] = vertex.x;
  22993. vertexBuffer[ i + 1 ] = vertex.y;
  22994. vertexBuffer[ i + 2 ] = vertex.z;
  22995. }
  22996. }
  22997. function generateUVs() {
  22998. const vertex = new Vector3();
  22999. for ( let i = 0; i < vertexBuffer.length; i += 3 ) {
  23000. vertex.x = vertexBuffer[ i + 0 ];
  23001. vertex.y = vertexBuffer[ i + 1 ];
  23002. vertex.z = vertexBuffer[ i + 2 ];
  23003. const u = azimuth( vertex ) / 2 / Math.PI + 0.5;
  23004. const v = inclination( vertex ) / Math.PI + 0.5;
  23005. uvBuffer.push( u, 1 - v );
  23006. }
  23007. correctUVs();
  23008. correctSeam();
  23009. }
  23010. function correctSeam() {
  23011. // handle case when face straddles the seam, see #3269
  23012. for ( let i = 0; i < uvBuffer.length; i += 6 ) {
  23013. // uv data of a single face
  23014. const x0 = uvBuffer[ i + 0 ];
  23015. const x1 = uvBuffer[ i + 2 ];
  23016. const x2 = uvBuffer[ i + 4 ];
  23017. const max = Math.max( x0, x1, x2 );
  23018. const min = Math.min( x0, x1, x2 );
  23019. // 0.9 is somewhat arbitrary
  23020. if ( max > 0.9 && min < 0.1 ) {
  23021. if ( x0 < 0.2 ) uvBuffer[ i + 0 ] += 1;
  23022. if ( x1 < 0.2 ) uvBuffer[ i + 2 ] += 1;
  23023. if ( x2 < 0.2 ) uvBuffer[ i + 4 ] += 1;
  23024. }
  23025. }
  23026. }
  23027. function pushVertex( vertex ) {
  23028. vertexBuffer.push( vertex.x, vertex.y, vertex.z );
  23029. }
  23030. function getVertexByIndex( index, vertex ) {
  23031. const stride = index * 3;
  23032. vertex.x = vertices[ stride + 0 ];
  23033. vertex.y = vertices[ stride + 1 ];
  23034. vertex.z = vertices[ stride + 2 ];
  23035. }
  23036. function correctUVs() {
  23037. const a = new Vector3();
  23038. const b = new Vector3();
  23039. const c = new Vector3();
  23040. const centroid = new Vector3();
  23041. const uvA = new Vector2();
  23042. const uvB = new Vector2();
  23043. const uvC = new Vector2();
  23044. for ( let i = 0, j = 0; i < vertexBuffer.length; i += 9, j += 6 ) {
  23045. a.set( vertexBuffer[ i + 0 ], vertexBuffer[ i + 1 ], vertexBuffer[ i + 2 ] );
  23046. b.set( vertexBuffer[ i + 3 ], vertexBuffer[ i + 4 ], vertexBuffer[ i + 5 ] );
  23047. c.set( vertexBuffer[ i + 6 ], vertexBuffer[ i + 7 ], vertexBuffer[ i + 8 ] );
  23048. uvA.set( uvBuffer[ j + 0 ], uvBuffer[ j + 1 ] );
  23049. uvB.set( uvBuffer[ j + 2 ], uvBuffer[ j + 3 ] );
  23050. uvC.set( uvBuffer[ j + 4 ], uvBuffer[ j + 5 ] );
  23051. centroid.copy( a ).add( b ).add( c ).divideScalar( 3 );
  23052. const azi = azimuth( centroid );
  23053. correctUV( uvA, j + 0, a, azi );
  23054. correctUV( uvB, j + 2, b, azi );
  23055. correctUV( uvC, j + 4, c, azi );
  23056. }
  23057. }
  23058. function correctUV( uv, stride, vector, azimuth ) {
  23059. if ( ( azimuth < 0 ) && ( uv.x === 1 ) ) {
  23060. uvBuffer[ stride ] = uv.x - 1;
  23061. }
  23062. if ( ( vector.x === 0 ) && ( vector.z === 0 ) ) {
  23063. uvBuffer[ stride ] = azimuth / 2 / Math.PI + 0.5;
  23064. }
  23065. }
  23066. // Angle around the Y axis, counter-clockwise when looking from above.
  23067. function azimuth( vector ) {
  23068. return Math.atan2( vector.z, - vector.x );
  23069. }
  23070. // Angle above the XZ plane.
  23071. function inclination( vector ) {
  23072. return Math.atan2( - vector.y, Math.sqrt( ( vector.x * vector.x ) + ( vector.z * vector.z ) ) );
  23073. }
  23074. }
  23075. copy( source ) {
  23076. super.copy( source );
  23077. this.parameters = Object.assign( {}, source.parameters );
  23078. return this;
  23079. }
  23080. /**
  23081. * Factory method for creating an instance of this class from the given
  23082. * JSON object.
  23083. *
  23084. * @param {Object} data - A JSON object representing the serialized geometry.
  23085. * @return {PolyhedronGeometry} A new instance.
  23086. */
  23087. static fromJSON( data ) {
  23088. return new PolyhedronGeometry( data.vertices, data.indices, data.radius, data.detail );
  23089. }
  23090. }
  23091. /**
  23092. * A geometry class for representing a dodecahedron.
  23093. *
  23094. * ```js
  23095. * const geometry = new THREE.DodecahedronGeometry();
  23096. * const material = new THREE.MeshBasicMaterial( { color: 0xffff00 } );
  23097. * const dodecahedron = new THREE.Mesh( geometry, material );
  23098. * scene.add( dodecahedron );
  23099. * ```
  23100. *
  23101. * @augments PolyhedronGeometry
  23102. * @demo scenes/geometry-browser.html#DodecahedronGeometry
  23103. */
  23104. class DodecahedronGeometry extends PolyhedronGeometry {
  23105. /**
  23106. * Constructs a new dodecahedron geometry.
  23107. *
  23108. * @param {number} [radius=1] - Radius of the dodecahedron.
  23109. * @param {number} [detail=0] - Setting this to a value greater than `0` adds vertices making it no longer a dodecahedron.
  23110. */
  23111. constructor( radius = 1, detail = 0 ) {
  23112. const t = ( 1 + Math.sqrt( 5 ) ) / 2;
  23113. const r = 1 / t;
  23114. const vertices = [
  23115. // (±1, ±1, ±1)
  23116. -1, -1, -1, -1, -1, 1,
  23117. -1, 1, -1, -1, 1, 1,
  23118. 1, -1, -1, 1, -1, 1,
  23119. 1, 1, -1, 1, 1, 1,
  23120. // (0, ±1/φ, ±φ)
  23121. 0, - r, - t, 0, - r, t,
  23122. 0, r, - t, 0, r, t,
  23123. // (±1/φ, ±φ, 0)
  23124. - r, - t, 0, - r, t, 0,
  23125. r, - t, 0, r, t, 0,
  23126. // (±φ, 0, ±1/φ)
  23127. - t, 0, - r, t, 0, - r,
  23128. - t, 0, r, t, 0, r
  23129. ];
  23130. const indices = [
  23131. 3, 11, 7, 3, 7, 15, 3, 15, 13,
  23132. 7, 19, 17, 7, 17, 6, 7, 6, 15,
  23133. 17, 4, 8, 17, 8, 10, 17, 10, 6,
  23134. 8, 0, 16, 8, 16, 2, 8, 2, 10,
  23135. 0, 12, 1, 0, 1, 18, 0, 18, 16,
  23136. 6, 10, 2, 6, 2, 13, 6, 13, 15,
  23137. 2, 16, 18, 2, 18, 3, 2, 3, 13,
  23138. 18, 1, 9, 18, 9, 11, 18, 11, 3,
  23139. 4, 14, 12, 4, 12, 0, 4, 0, 8,
  23140. 11, 9, 5, 11, 5, 19, 11, 19, 7,
  23141. 19, 5, 14, 19, 14, 4, 19, 4, 17,
  23142. 1, 12, 14, 1, 14, 5, 1, 5, 9
  23143. ];
  23144. super( vertices, indices, radius, detail );
  23145. this.type = 'DodecahedronGeometry';
  23146. /**
  23147. * Holds the constructor parameters that have been
  23148. * used to generate the geometry. Any modification
  23149. * after instantiation does not change the geometry.
  23150. *
  23151. * @type {Object}
  23152. */
  23153. this.parameters = {
  23154. radius: radius,
  23155. detail: detail
  23156. };
  23157. }
  23158. /**
  23159. * Factory method for creating an instance of this class from the given
  23160. * JSON object.
  23161. *
  23162. * @param {Object} data - A JSON object representing the serialized geometry.
  23163. * @return {DodecahedronGeometry} A new instance.
  23164. */
  23165. static fromJSON( data ) {
  23166. return new DodecahedronGeometry( data.radius, data.detail );
  23167. }
  23168. }
  23169. const _v0 = /*@__PURE__*/ new Vector3();
  23170. const _v1$1 = /*@__PURE__*/ new Vector3();
  23171. const _normal = /*@__PURE__*/ new Vector3();
  23172. const _triangle = /*@__PURE__*/ new Triangle();
  23173. /**
  23174. * Can be used as a helper object to view the edges of a geometry.
  23175. *
  23176. * ```js
  23177. * const geometry = new THREE.BoxGeometry();
  23178. * const edges = new THREE.EdgesGeometry( geometry );
  23179. * const line = new THREE.LineSegments( edges );
  23180. * scene.add( line );
  23181. * ```
  23182. *
  23183. * Note: It is not yet possible to serialize/deserialize instances of this class.
  23184. *
  23185. * @augments BufferGeometry
  23186. */
  23187. class EdgesGeometry extends BufferGeometry {
  23188. /**
  23189. * Constructs a new edges geometry.
  23190. *
  23191. * @param {?BufferGeometry} [geometry=null] - The geometry.
  23192. * @param {number} [thresholdAngle=1] - An edge is only rendered if the angle (in degrees)
  23193. * between the face normals of the adjoining faces exceeds this value.
  23194. */
  23195. constructor( geometry = null, thresholdAngle = 1 ) {
  23196. super();
  23197. this.type = 'EdgesGeometry';
  23198. /**
  23199. * Holds the constructor parameters that have been
  23200. * used to generate the geometry. Any modification
  23201. * after instantiation does not change the geometry.
  23202. *
  23203. * @type {Object}
  23204. */
  23205. this.parameters = {
  23206. geometry: geometry,
  23207. thresholdAngle: thresholdAngle
  23208. };
  23209. if ( geometry !== null ) {
  23210. const precisionPoints = 4;
  23211. const precision = Math.pow( 10, precisionPoints );
  23212. const thresholdDot = Math.cos( DEG2RAD * thresholdAngle );
  23213. const indexAttr = geometry.getIndex();
  23214. const positionAttr = geometry.getAttribute( 'position' );
  23215. const indexCount = indexAttr ? indexAttr.count : positionAttr.count;
  23216. const indexArr = [ 0, 0, 0 ];
  23217. const vertKeys = [ 'a', 'b', 'c' ];
  23218. const hashes = new Array( 3 );
  23219. const edgeData = {};
  23220. const vertices = [];
  23221. for ( let i = 0; i < indexCount; i += 3 ) {
  23222. if ( indexAttr ) {
  23223. indexArr[ 0 ] = indexAttr.getX( i );
  23224. indexArr[ 1 ] = indexAttr.getX( i + 1 );
  23225. indexArr[ 2 ] = indexAttr.getX( i + 2 );
  23226. } else {
  23227. indexArr[ 0 ] = i;
  23228. indexArr[ 1 ] = i + 1;
  23229. indexArr[ 2 ] = i + 2;
  23230. }
  23231. const { a, b, c } = _triangle;
  23232. a.fromBufferAttribute( positionAttr, indexArr[ 0 ] );
  23233. b.fromBufferAttribute( positionAttr, indexArr[ 1 ] );
  23234. c.fromBufferAttribute( positionAttr, indexArr[ 2 ] );
  23235. _triangle.getNormal( _normal );
  23236. // create hashes for the edge from the vertices
  23237. hashes[ 0 ] = `${ Math.round( a.x * precision ) },${ Math.round( a.y * precision ) },${ Math.round( a.z * precision ) }`;
  23238. hashes[ 1 ] = `${ Math.round( b.x * precision ) },${ Math.round( b.y * precision ) },${ Math.round( b.z * precision ) }`;
  23239. hashes[ 2 ] = `${ Math.round( c.x * precision ) },${ Math.round( c.y * precision ) },${ Math.round( c.z * precision ) }`;
  23240. // skip degenerate triangles
  23241. if ( hashes[ 0 ] === hashes[ 1 ] || hashes[ 1 ] === hashes[ 2 ] || hashes[ 2 ] === hashes[ 0 ] ) {
  23242. continue;
  23243. }
  23244. // iterate over every edge
  23245. for ( let j = 0; j < 3; j ++ ) {
  23246. // get the first and next vertex making up the edge
  23247. const jNext = ( j + 1 ) % 3;
  23248. const vecHash0 = hashes[ j ];
  23249. const vecHash1 = hashes[ jNext ];
  23250. const v0 = _triangle[ vertKeys[ j ] ];
  23251. const v1 = _triangle[ vertKeys[ jNext ] ];
  23252. const hash = `${ vecHash0 }_${ vecHash1 }`;
  23253. const reverseHash = `${ vecHash1 }_${ vecHash0 }`;
  23254. if ( reverseHash in edgeData && edgeData[ reverseHash ] ) {
  23255. // if we found a sibling edge add it into the vertex array if
  23256. // it meets the angle threshold and delete the edge from the map.
  23257. if ( _normal.dot( edgeData[ reverseHash ].normal ) <= thresholdDot ) {
  23258. vertices.push( v0.x, v0.y, v0.z );
  23259. vertices.push( v1.x, v1.y, v1.z );
  23260. }
  23261. edgeData[ reverseHash ] = null;
  23262. } else if ( ! ( hash in edgeData ) ) {
  23263. // if we've already got an edge here then skip adding a new one
  23264. edgeData[ hash ] = {
  23265. index0: indexArr[ j ],
  23266. index1: indexArr[ jNext ],
  23267. normal: _normal.clone(),
  23268. };
  23269. }
  23270. }
  23271. }
  23272. // iterate over all remaining, unmatched edges and add them to the vertex array
  23273. for ( const key in edgeData ) {
  23274. if ( edgeData[ key ] ) {
  23275. const { index0, index1 } = edgeData[ key ];
  23276. _v0.fromBufferAttribute( positionAttr, index0 );
  23277. _v1$1.fromBufferAttribute( positionAttr, index1 );
  23278. vertices.push( _v0.x, _v0.y, _v0.z );
  23279. vertices.push( _v1$1.x, _v1$1.y, _v1$1.z );
  23280. }
  23281. }
  23282. this.setAttribute( 'position', new Float32BufferAttribute( vertices, 3 ) );
  23283. }
  23284. }
  23285. copy( source ) {
  23286. super.copy( source );
  23287. this.parameters = Object.assign( {}, source.parameters );
  23288. return this;
  23289. }
  23290. }
  23291. /**
  23292. * An abstract base class for creating an analytic curve object that contains methods
  23293. * for interpolation.
  23294. *
  23295. * @abstract
  23296. */
  23297. class Curve {
  23298. /**
  23299. * Constructs a new curve.
  23300. */
  23301. constructor() {
  23302. /**
  23303. * The type property is used for detecting the object type
  23304. * in context of serialization/deserialization.
  23305. *
  23306. * @type {string}
  23307. * @readonly
  23308. */
  23309. this.type = 'Curve';
  23310. /**
  23311. * This value determines the amount of divisions when calculating the
  23312. * cumulative segment lengths of a curve via {@link Curve#getLengths}. To ensure
  23313. * precision when using methods like {@link Curve#getSpacedPoints}, it is
  23314. * recommended to increase the value of this property if the curve is very large.
  23315. *
  23316. * @type {number}
  23317. * @default 200
  23318. */
  23319. this.arcLengthDivisions = 200;
  23320. /**
  23321. * Must be set to `true` if the curve parameters have changed.
  23322. *
  23323. * @type {boolean}
  23324. * @default false
  23325. */
  23326. this.needsUpdate = false;
  23327. /**
  23328. * An internal cache that holds precomputed curve length values.
  23329. *
  23330. * @private
  23331. * @type {?Array<number>}
  23332. * @default null
  23333. */
  23334. this.cacheArcLengths = null;
  23335. }
  23336. /**
  23337. * This method returns a vector in 2D or 3D space (depending on the curve definition)
  23338. * for the given interpolation factor.
  23339. *
  23340. * @abstract
  23341. * @param {number} t - A interpolation factor representing a position on the curve. Must be in the range `[0,1]`.
  23342. * @param {(Vector2|Vector3)} [optionalTarget] - The optional target vector the result is written to.
  23343. * @return {(Vector2|Vector3)} The position on the curve. It can be a 2D or 3D vector depending on the curve definition.
  23344. */
  23345. getPoint( /* t, optionalTarget */ ) {
  23346. warn( 'Curve: .getPoint() not implemented.' );
  23347. }
  23348. /**
  23349. * This method returns a vector in 2D or 3D space (depending on the curve definition)
  23350. * for the given interpolation factor. Unlike {@link Curve#getPoint}, this method honors the length
  23351. * of the curve which equidistant samples.
  23352. *
  23353. * @param {number} u - A interpolation factor representing a position on the curve. Must be in the range `[0,1]`.
  23354. * @param {(Vector2|Vector3)} [optionalTarget] - The optional target vector the result is written to.
  23355. * @return {(Vector2|Vector3)} The position on the curve. It can be a 2D or 3D vector depending on the curve definition.
  23356. */
  23357. getPointAt( u, optionalTarget ) {
  23358. const t = this.getUtoTmapping( u );
  23359. return this.getPoint( t, optionalTarget );
  23360. }
  23361. /**
  23362. * This method samples the curve via {@link Curve#getPoint} and returns an array of points representing
  23363. * the curve shape.
  23364. *
  23365. * @param {number} [divisions=5] - The number of divisions.
  23366. * @return {Array<(Vector2|Vector3)>} An array holding the sampled curve values. The number of points is `divisions + 1`.
  23367. */
  23368. getPoints( divisions = 5 ) {
  23369. const points = [];
  23370. for ( let d = 0; d <= divisions; d ++ ) {
  23371. points.push( this.getPoint( d / divisions ) );
  23372. }
  23373. return points;
  23374. }
  23375. // Get sequence of points using getPointAt( u )
  23376. /**
  23377. * This method samples the curve via {@link Curve#getPointAt} and returns an array of points representing
  23378. * the curve shape. Unlike {@link Curve#getPoints}, this method returns equi-spaced points across the entire
  23379. * curve.
  23380. *
  23381. * @param {number} [divisions=5] - The number of divisions.
  23382. * @return {Array<(Vector2|Vector3)>} An array holding the sampled curve values. The number of points is `divisions + 1`.
  23383. */
  23384. getSpacedPoints( divisions = 5 ) {
  23385. const points = [];
  23386. for ( let d = 0; d <= divisions; d ++ ) {
  23387. points.push( this.getPointAt( d / divisions ) );
  23388. }
  23389. return points;
  23390. }
  23391. /**
  23392. * Returns the total arc length of the curve.
  23393. *
  23394. * @return {number} The length of the curve.
  23395. */
  23396. getLength() {
  23397. const lengths = this.getLengths();
  23398. return lengths[ lengths.length - 1 ];
  23399. }
  23400. /**
  23401. * Returns an array of cumulative segment lengths of the curve.
  23402. *
  23403. * @param {number} [divisions=this.arcLengthDivisions] - The number of divisions.
  23404. * @return {Array<number>} An array holding the cumulative segment lengths.
  23405. */
  23406. getLengths( divisions = this.arcLengthDivisions ) {
  23407. if ( this.cacheArcLengths &&
  23408. ( this.cacheArcLengths.length === divisions + 1 ) &&
  23409. ! this.needsUpdate ) {
  23410. return this.cacheArcLengths;
  23411. }
  23412. this.needsUpdate = false;
  23413. const cache = [];
  23414. let current, last = this.getPoint( 0 );
  23415. let sum = 0;
  23416. cache.push( 0 );
  23417. for ( let p = 1; p <= divisions; p ++ ) {
  23418. current = this.getPoint( p / divisions );
  23419. sum += current.distanceTo( last );
  23420. cache.push( sum );
  23421. last = current;
  23422. }
  23423. this.cacheArcLengths = cache;
  23424. return cache; // { sums: cache, sum: sum }; Sum is in the last element.
  23425. }
  23426. /**
  23427. * Update the cumulative segment distance cache. The method must be called
  23428. * every time curve parameters are changed. If an updated curve is part of a
  23429. * composed curve like {@link CurvePath}, this method must be called on the
  23430. * composed curve, too.
  23431. */
  23432. updateArcLengths() {
  23433. this.needsUpdate = true;
  23434. this.getLengths();
  23435. }
  23436. /**
  23437. * Given an interpolation factor in the range `[0,1]`, this method returns an updated
  23438. * interpolation factor in the same range that can be ued to sample equidistant points
  23439. * from a curve.
  23440. *
  23441. * @param {number} u - The interpolation factor.
  23442. * @param {?number} distance - An optional distance on the curve.
  23443. * @return {number} The updated interpolation factor.
  23444. */
  23445. getUtoTmapping( u, distance = null ) {
  23446. const arcLengths = this.getLengths();
  23447. let i = 0;
  23448. const il = arcLengths.length;
  23449. let targetArcLength; // The targeted u distance value to get
  23450. if ( distance ) {
  23451. targetArcLength = distance;
  23452. } else {
  23453. targetArcLength = u * arcLengths[ il - 1 ];
  23454. }
  23455. // binary search for the index with largest value smaller than target u distance
  23456. let low = 0, high = il - 1, comparison;
  23457. while ( low <= high ) {
  23458. 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
  23459. comparison = arcLengths[ i ] - targetArcLength;
  23460. if ( comparison < 0 ) {
  23461. low = i + 1;
  23462. } else if ( comparison > 0 ) {
  23463. high = i - 1;
  23464. } else {
  23465. high = i;
  23466. break;
  23467. // DONE
  23468. }
  23469. }
  23470. i = high;
  23471. if ( arcLengths[ i ] === targetArcLength ) {
  23472. return i / ( il - 1 );
  23473. }
  23474. // we could get finer grain at lengths, or use simple interpolation between two points
  23475. const lengthBefore = arcLengths[ i ];
  23476. const lengthAfter = arcLengths[ i + 1 ];
  23477. const segmentLength = lengthAfter - lengthBefore;
  23478. // determine where we are between the 'before' and 'after' points
  23479. const segmentFraction = ( targetArcLength - lengthBefore ) / segmentLength;
  23480. // add that fractional amount to t
  23481. const t = ( i + segmentFraction ) / ( il - 1 );
  23482. return t;
  23483. }
  23484. /**
  23485. * Returns a unit vector tangent for the given interpolation factor.
  23486. * If the derived curve does not implement its tangent derivation,
  23487. * two points a small delta apart will be used to find its gradient
  23488. * which seems to give a reasonable approximation.
  23489. *
  23490. * @param {number} t - The interpolation factor.
  23491. * @param {(Vector2|Vector3)} [optionalTarget] - The optional target vector the result is written to.
  23492. * @return {(Vector2|Vector3)} The tangent vector.
  23493. */
  23494. getTangent( t, optionalTarget ) {
  23495. const delta = 0.0001;
  23496. let t1 = t - delta;
  23497. let t2 = t + delta;
  23498. // Capping in case of danger
  23499. if ( t1 < 0 ) t1 = 0;
  23500. if ( t2 > 1 ) t2 = 1;
  23501. const pt1 = this.getPoint( t1 );
  23502. const pt2 = this.getPoint( t2 );
  23503. const tangent = optionalTarget || ( ( pt1.isVector2 ) ? new Vector2() : new Vector3() );
  23504. tangent.copy( pt2 ).sub( pt1 ).normalize();
  23505. return tangent;
  23506. }
  23507. /**
  23508. * Same as {@link Curve#getTangent} but with equidistant samples.
  23509. *
  23510. * @param {number} u - The interpolation factor.
  23511. * @param {(Vector2|Vector3)} [optionalTarget] - The optional target vector the result is written to.
  23512. * @return {(Vector2|Vector3)} The tangent vector.
  23513. * @see {@link Curve#getPointAt}
  23514. */
  23515. getTangentAt( u, optionalTarget ) {
  23516. const t = this.getUtoTmapping( u );
  23517. return this.getTangent( t, optionalTarget );
  23518. }
  23519. /**
  23520. * Generates the Frenet Frames. Requires a curve definition in 3D space. Used
  23521. * in geometries like {@link TubeGeometry} or {@link ExtrudeGeometry}.
  23522. *
  23523. * @param {number} segments - The number of segments.
  23524. * @param {boolean} [closed=false] - Whether the curve is closed or not.
  23525. * @return {{tangents: Array<Vector3>, normals: Array<Vector3>, binormals: Array<Vector3>}} The Frenet Frames.
  23526. */
  23527. computeFrenetFrames( segments, closed = false ) {
  23528. // see http://www.cs.indiana.edu/pub/techreports/TR425.pdf
  23529. const normal = new Vector3();
  23530. const tangents = [];
  23531. const normals = [];
  23532. const binormals = [];
  23533. const vec = new Vector3();
  23534. const mat = new Matrix4();
  23535. // compute the tangent vectors for each segment on the curve
  23536. for ( let i = 0; i <= segments; i ++ ) {
  23537. const u = i / segments;
  23538. tangents[ i ] = this.getTangentAt( u, new Vector3() );
  23539. }
  23540. // select an initial normal vector perpendicular to the first tangent vector,
  23541. // and in the direction of the minimum tangent xyz component
  23542. normals[ 0 ] = new Vector3();
  23543. binormals[ 0 ] = new Vector3();
  23544. let min = Number.MAX_VALUE;
  23545. const tx = Math.abs( tangents[ 0 ].x );
  23546. const ty = Math.abs( tangents[ 0 ].y );
  23547. const tz = Math.abs( tangents[ 0 ].z );
  23548. if ( tx <= min ) {
  23549. min = tx;
  23550. normal.set( 1, 0, 0 );
  23551. }
  23552. if ( ty <= min ) {
  23553. min = ty;
  23554. normal.set( 0, 1, 0 );
  23555. }
  23556. if ( tz <= min ) {
  23557. normal.set( 0, 0, 1 );
  23558. }
  23559. vec.crossVectors( tangents[ 0 ], normal ).normalize();
  23560. normals[ 0 ].crossVectors( tangents[ 0 ], vec );
  23561. binormals[ 0 ].crossVectors( tangents[ 0 ], normals[ 0 ] );
  23562. // compute the slowly-varying normal and binormal vectors for each segment on the curve
  23563. for ( let i = 1; i <= segments; i ++ ) {
  23564. normals[ i ] = normals[ i - 1 ].clone();
  23565. binormals[ i ] = binormals[ i - 1 ].clone();
  23566. vec.crossVectors( tangents[ i - 1 ], tangents[ i ] );
  23567. if ( vec.length() > Number.EPSILON ) {
  23568. vec.normalize();
  23569. const theta = Math.acos( clamp( tangents[ i - 1 ].dot( tangents[ i ] ), -1, 1 ) ); // clamp for floating pt errors
  23570. normals[ i ].applyMatrix4( mat.makeRotationAxis( vec, theta ) );
  23571. }
  23572. binormals[ i ].crossVectors( tangents[ i ], normals[ i ] );
  23573. }
  23574. // if the curve is closed, postprocess the vectors so the first and last normal vectors are the same
  23575. if ( closed === true ) {
  23576. let theta = Math.acos( clamp( normals[ 0 ].dot( normals[ segments ] ), -1, 1 ) );
  23577. theta /= segments;
  23578. if ( tangents[ 0 ].dot( vec.crossVectors( normals[ 0 ], normals[ segments ] ) ) > 0 ) {
  23579. theta = - theta;
  23580. }
  23581. for ( let i = 1; i <= segments; i ++ ) {
  23582. // twist a little...
  23583. normals[ i ].applyMatrix4( mat.makeRotationAxis( tangents[ i ], theta * i ) );
  23584. binormals[ i ].crossVectors( tangents[ i ], normals[ i ] );
  23585. }
  23586. }
  23587. return {
  23588. tangents: tangents,
  23589. normals: normals,
  23590. binormals: binormals
  23591. };
  23592. }
  23593. /**
  23594. * Returns a new curve with copied values from this instance.
  23595. *
  23596. * @return {Curve} A clone of this instance.
  23597. */
  23598. clone() {
  23599. return new this.constructor().copy( this );
  23600. }
  23601. /**
  23602. * Copies the values of the given curve to this instance.
  23603. *
  23604. * @param {Curve} source - The curve to copy.
  23605. * @return {Curve} A reference to this curve.
  23606. */
  23607. copy( source ) {
  23608. this.arcLengthDivisions = source.arcLengthDivisions;
  23609. return this;
  23610. }
  23611. /**
  23612. * Serializes the curve into JSON.
  23613. *
  23614. * @return {Object} A JSON object representing the serialized curve.
  23615. * @see {@link ObjectLoader#parse}
  23616. */
  23617. toJSON() {
  23618. const data = {
  23619. metadata: {
  23620. version: 4.7,
  23621. type: 'Curve',
  23622. generator: 'Curve.toJSON'
  23623. }
  23624. };
  23625. data.arcLengthDivisions = this.arcLengthDivisions;
  23626. data.type = this.type;
  23627. return data;
  23628. }
  23629. /**
  23630. * Deserializes the curve from the given JSON.
  23631. *
  23632. * @param {Object} json - The JSON holding the serialized curve.
  23633. * @return {Curve} A reference to this curve.
  23634. */
  23635. fromJSON( json ) {
  23636. this.arcLengthDivisions = json.arcLengthDivisions;
  23637. return this;
  23638. }
  23639. }
  23640. /**
  23641. * A curve representing an ellipse.
  23642. *
  23643. * ```js
  23644. * const curve = new THREE.EllipseCurve(
  23645. * 0, 0,
  23646. * 10, 10,
  23647. * 0, 2 * Math.PI,
  23648. * false,
  23649. * 0
  23650. * );
  23651. *
  23652. * const points = curve.getPoints( 50 );
  23653. * const geometry = new THREE.BufferGeometry().setFromPoints( points );
  23654. *
  23655. * const material = new THREE.LineBasicMaterial( { color: 0xff0000 } );
  23656. *
  23657. * // Create the final object to add to the scene
  23658. * const ellipse = new THREE.Line( geometry, material );
  23659. * ```
  23660. *
  23661. * @augments Curve
  23662. */
  23663. class EllipseCurve extends Curve {
  23664. /**
  23665. * Constructs a new ellipse curve.
  23666. *
  23667. * @param {number} [aX=0] - The X center of the ellipse.
  23668. * @param {number} [aY=0] - The Y center of the ellipse.
  23669. * @param {number} [xRadius=1] - The radius of the ellipse in the x direction.
  23670. * @param {number} [yRadius=1] - The radius of the ellipse in the y direction.
  23671. * @param {number} [aStartAngle=0] - The start angle of the curve in radians starting from the positive X axis.
  23672. * @param {number} [aEndAngle=Math.PI*2] - The end angle of the curve in radians starting from the positive X axis.
  23673. * @param {boolean} [aClockwise=false] - Whether the ellipse is drawn clockwise or not.
  23674. * @param {number} [aRotation=0] - The rotation angle of the ellipse in radians, counterclockwise from the positive X axis.
  23675. */
  23676. constructor( aX = 0, aY = 0, xRadius = 1, yRadius = 1, aStartAngle = 0, aEndAngle = Math.PI * 2, aClockwise = false, aRotation = 0 ) {
  23677. super();
  23678. /**
  23679. * This flag can be used for type testing.
  23680. *
  23681. * @type {boolean}
  23682. * @readonly
  23683. * @default true
  23684. */
  23685. this.isEllipseCurve = true;
  23686. this.type = 'EllipseCurve';
  23687. /**
  23688. * The X center of the ellipse.
  23689. *
  23690. * @type {number}
  23691. * @default 0
  23692. */
  23693. this.aX = aX;
  23694. /**
  23695. * The Y center of the ellipse.
  23696. *
  23697. * @type {number}
  23698. * @default 0
  23699. */
  23700. this.aY = aY;
  23701. /**
  23702. * The radius of the ellipse in the x direction.
  23703. * Setting the this value equal to the {@link EllipseCurve#yRadius} will result in a circle.
  23704. *
  23705. * @type {number}
  23706. * @default 1
  23707. */
  23708. this.xRadius = xRadius;
  23709. /**
  23710. * The radius of the ellipse in the y direction.
  23711. * Setting the this value equal to the {@link EllipseCurve#xRadius} will result in a circle.
  23712. *
  23713. * @type {number}
  23714. * @default 1
  23715. */
  23716. this.yRadius = yRadius;
  23717. /**
  23718. * The start angle of the curve in radians starting from the positive X axis.
  23719. *
  23720. * @type {number}
  23721. * @default 0
  23722. */
  23723. this.aStartAngle = aStartAngle;
  23724. /**
  23725. * The end angle of the curve in radians starting from the positive X axis.
  23726. *
  23727. * @type {number}
  23728. * @default Math.PI*2
  23729. */
  23730. this.aEndAngle = aEndAngle;
  23731. /**
  23732. * Whether the ellipse is drawn clockwise or not.
  23733. *
  23734. * @type {boolean}
  23735. * @default false
  23736. */
  23737. this.aClockwise = aClockwise;
  23738. /**
  23739. * The rotation angle of the ellipse in radians, counterclockwise from the positive X axis.
  23740. *
  23741. * @type {number}
  23742. * @default 0
  23743. */
  23744. this.aRotation = aRotation;
  23745. }
  23746. /**
  23747. * Returns a point on the curve.
  23748. *
  23749. * @param {number} t - A interpolation factor representing a position on the curve. Must be in the range `[0,1]`.
  23750. * @param {Vector2} [optionalTarget] - The optional target vector the result is written to.
  23751. * @return {Vector2} The position on the curve.
  23752. */
  23753. getPoint( t, optionalTarget = new Vector2() ) {
  23754. const point = optionalTarget;
  23755. const twoPi = Math.PI * 2;
  23756. let deltaAngle = this.aEndAngle - this.aStartAngle;
  23757. const samePoints = Math.abs( deltaAngle ) < Number.EPSILON;
  23758. // ensures that deltaAngle is 0 .. 2 PI
  23759. while ( deltaAngle < 0 ) deltaAngle += twoPi;
  23760. while ( deltaAngle > twoPi ) deltaAngle -= twoPi;
  23761. if ( deltaAngle < Number.EPSILON ) {
  23762. if ( samePoints ) {
  23763. deltaAngle = 0;
  23764. } else {
  23765. deltaAngle = twoPi;
  23766. }
  23767. }
  23768. if ( this.aClockwise === true && ! samePoints ) {
  23769. if ( deltaAngle === twoPi ) {
  23770. deltaAngle = - twoPi;
  23771. } else {
  23772. deltaAngle = deltaAngle - twoPi;
  23773. }
  23774. }
  23775. const angle = this.aStartAngle + t * deltaAngle;
  23776. let x = this.aX + this.xRadius * Math.cos( angle );
  23777. let y = this.aY + this.yRadius * Math.sin( angle );
  23778. if ( this.aRotation !== 0 ) {
  23779. const cos = Math.cos( this.aRotation );
  23780. const sin = Math.sin( this.aRotation );
  23781. const tx = x - this.aX;
  23782. const ty = y - this.aY;
  23783. // Rotate the point about the center of the ellipse.
  23784. x = tx * cos - ty * sin + this.aX;
  23785. y = tx * sin + ty * cos + this.aY;
  23786. }
  23787. return point.set( x, y );
  23788. }
  23789. copy( source ) {
  23790. super.copy( source );
  23791. this.aX = source.aX;
  23792. this.aY = source.aY;
  23793. this.xRadius = source.xRadius;
  23794. this.yRadius = source.yRadius;
  23795. this.aStartAngle = source.aStartAngle;
  23796. this.aEndAngle = source.aEndAngle;
  23797. this.aClockwise = source.aClockwise;
  23798. this.aRotation = source.aRotation;
  23799. return this;
  23800. }
  23801. toJSON() {
  23802. const data = super.toJSON();
  23803. data.aX = this.aX;
  23804. data.aY = this.aY;
  23805. data.xRadius = this.xRadius;
  23806. data.yRadius = this.yRadius;
  23807. data.aStartAngle = this.aStartAngle;
  23808. data.aEndAngle = this.aEndAngle;
  23809. data.aClockwise = this.aClockwise;
  23810. data.aRotation = this.aRotation;
  23811. return data;
  23812. }
  23813. fromJSON( json ) {
  23814. super.fromJSON( json );
  23815. this.aX = json.aX;
  23816. this.aY = json.aY;
  23817. this.xRadius = json.xRadius;
  23818. this.yRadius = json.yRadius;
  23819. this.aStartAngle = json.aStartAngle;
  23820. this.aEndAngle = json.aEndAngle;
  23821. this.aClockwise = json.aClockwise;
  23822. this.aRotation = json.aRotation;
  23823. return this;
  23824. }
  23825. }
  23826. /**
  23827. * A curve representing an arc.
  23828. *
  23829. * @augments EllipseCurve
  23830. */
  23831. class ArcCurve extends EllipseCurve {
  23832. /**
  23833. * Constructs a new arc curve.
  23834. *
  23835. * @param {number} [aX=0] - The X center of the ellipse.
  23836. * @param {number} [aY=0] - The Y center of the ellipse.
  23837. * @param {number} [aRadius=1] - The radius of the ellipse in the x direction.
  23838. * @param {number} [aStartAngle=0] - The start angle of the curve in radians starting from the positive X axis.
  23839. * @param {number} [aEndAngle=Math.PI*2] - The end angle of the curve in radians starting from the positive X axis.
  23840. * @param {boolean} [aClockwise=false] - Whether the ellipse is drawn clockwise or not.
  23841. */
  23842. constructor( aX, aY, aRadius, aStartAngle, aEndAngle, aClockwise ) {
  23843. super( aX, aY, aRadius, aRadius, aStartAngle, aEndAngle, aClockwise );
  23844. /**
  23845. * This flag can be used for type testing.
  23846. *
  23847. * @type {boolean}
  23848. * @readonly
  23849. * @default true
  23850. */
  23851. this.isArcCurve = true;
  23852. this.type = 'ArcCurve';
  23853. }
  23854. }
  23855. function CubicPoly() {
  23856. /**
  23857. * Centripetal CatmullRom Curve - which is useful for avoiding
  23858. * cusps and self-intersections in non-uniform catmull rom curves.
  23859. * http://www.cemyuksel.com/research/catmullrom_param/catmullrom.pdf
  23860. *
  23861. * curve.type accepts centripetal(default), chordal and catmullrom
  23862. * curve.tension is used for catmullrom which defaults to 0.5
  23863. */
  23864. /*
  23865. Based on an optimized c++ solution in
  23866. - http://stackoverflow.com/questions/9489736/catmull-rom-curve-with-no-cusps-and-no-self-intersections/
  23867. - http://ideone.com/NoEbVM
  23868. This CubicPoly class could be used for reusing some variables and calculations,
  23869. but for three.js curve use, it could be possible inlined and flatten into a single function call
  23870. which can be placed in CurveUtils.
  23871. */
  23872. let c0 = 0, c1 = 0, c2 = 0, c3 = 0;
  23873. /*
  23874. * Compute coefficients for a cubic polynomial
  23875. * p(s) = c0 + c1*s + c2*s^2 + c3*s^3
  23876. * such that
  23877. * p(0) = x0, p(1) = x1
  23878. * and
  23879. * p'(0) = t0, p'(1) = t1.
  23880. */
  23881. function init( x0, x1, t0, t1 ) {
  23882. c0 = x0;
  23883. c1 = t0;
  23884. c2 = -3 * x0 + 3 * x1 - 2 * t0 - t1;
  23885. c3 = 2 * x0 - 2 * x1 + t0 + t1;
  23886. }
  23887. return {
  23888. initCatmullRom: function ( x0, x1, x2, x3, tension ) {
  23889. init( x1, x2, tension * ( x2 - x0 ), tension * ( x3 - x1 ) );
  23890. },
  23891. initNonuniformCatmullRom: function ( x0, x1, x2, x3, dt0, dt1, dt2 ) {
  23892. // compute tangents when parameterized in [t1,t2]
  23893. let t1 = ( x1 - x0 ) / dt0 - ( x2 - x0 ) / ( dt0 + dt1 ) + ( x2 - x1 ) / dt1;
  23894. let t2 = ( x2 - x1 ) / dt1 - ( x3 - x1 ) / ( dt1 + dt2 ) + ( x3 - x2 ) / dt2;
  23895. // rescale tangents for parametrization in [0,1]
  23896. t1 *= dt1;
  23897. t2 *= dt1;
  23898. init( x1, x2, t1, t2 );
  23899. },
  23900. calc: function ( t ) {
  23901. const t2 = t * t;
  23902. const t3 = t2 * t;
  23903. return c0 + c1 * t + c2 * t2 + c3 * t3;
  23904. }
  23905. };
  23906. }
  23907. //
  23908. const tmp = /*@__PURE__*/ new Vector3();
  23909. const px = /*@__PURE__*/ new CubicPoly();
  23910. const py = /*@__PURE__*/ new CubicPoly();
  23911. const pz = /*@__PURE__*/ new CubicPoly();
  23912. /**
  23913. * A curve representing a Catmull-Rom spline.
  23914. *
  23915. * ```js
  23916. * //Create a closed wavey loop
  23917. * const curve = new THREE.CatmullRomCurve3( [
  23918. * new THREE.Vector3( -10, 0, 10 ),
  23919. * new THREE.Vector3( -5, 5, 5 ),
  23920. * new THREE.Vector3( 0, 0, 0 ),
  23921. * new THREE.Vector3( 5, -5, 5 ),
  23922. * new THREE.Vector3( 10, 0, 10 )
  23923. * ] );
  23924. *
  23925. * const points = curve.getPoints( 50 );
  23926. * const geometry = new THREE.BufferGeometry().setFromPoints( points );
  23927. *
  23928. * const material = new THREE.LineBasicMaterial( { color: 0xff0000 } );
  23929. *
  23930. * // Create the final object to add to the scene
  23931. * const curveObject = new THREE.Line( geometry, material );
  23932. * ```
  23933. *
  23934. * @augments Curve
  23935. */
  23936. class CatmullRomCurve3 extends Curve {
  23937. /**
  23938. * Constructs a new Catmull-Rom curve.
  23939. *
  23940. * @param {Array<Vector3>} [points] - An array of 3D points defining the curve.
  23941. * @param {boolean} [closed=false] - Whether the curve is closed or not.
  23942. * @param {('centripetal'|'chordal'|'catmullrom')} [curveType='centripetal'] - The curve type.
  23943. * @param {number} [tension=0.5] - Tension of the curve.
  23944. */
  23945. constructor( points = [], closed = false, curveType = 'centripetal', tension = 0.5 ) {
  23946. super();
  23947. /**
  23948. * This flag can be used for type testing.
  23949. *
  23950. * @type {boolean}
  23951. * @readonly
  23952. * @default true
  23953. */
  23954. this.isCatmullRomCurve3 = true;
  23955. this.type = 'CatmullRomCurve3';
  23956. /**
  23957. * An array of 3D points defining the curve.
  23958. *
  23959. * @type {Array<Vector3>}
  23960. */
  23961. this.points = points;
  23962. /**
  23963. * Whether the curve is closed or not.
  23964. *
  23965. * @type {boolean}
  23966. * @default false
  23967. */
  23968. this.closed = closed;
  23969. /**
  23970. * The curve type.
  23971. *
  23972. * @type {('centripetal'|'chordal'|'catmullrom')}
  23973. * @default 'centripetal'
  23974. */
  23975. this.curveType = curveType;
  23976. /**
  23977. * Tension of the curve.
  23978. *
  23979. * @type {number}
  23980. * @default 0.5
  23981. */
  23982. this.tension = tension;
  23983. }
  23984. /**
  23985. * Returns a point on the curve.
  23986. *
  23987. * @param {number} t - A interpolation factor representing a position on the curve. Must be in the range `[0,1]`.
  23988. * @param {Vector3} [optionalTarget] - The optional target vector the result is written to.
  23989. * @return {Vector3} The position on the curve.
  23990. */
  23991. getPoint( t, optionalTarget = new Vector3() ) {
  23992. const point = optionalTarget;
  23993. const points = this.points;
  23994. const l = points.length;
  23995. const p = ( l - ( this.closed ? 0 : 1 ) ) * t;
  23996. let intPoint = Math.floor( p );
  23997. let weight = p - intPoint;
  23998. if ( this.closed ) {
  23999. intPoint += intPoint > 0 ? 0 : ( Math.floor( Math.abs( intPoint ) / l ) + 1 ) * l;
  24000. } else if ( weight === 0 && intPoint === l - 1 ) {
  24001. intPoint = l - 2;
  24002. weight = 1;
  24003. }
  24004. let p0, p3; // 4 points (p1 & p2 defined below)
  24005. if ( this.closed || intPoint > 0 ) {
  24006. p0 = points[ ( intPoint - 1 ) % l ];
  24007. } else {
  24008. // extrapolate first point
  24009. tmp.subVectors( points[ 0 ], points[ 1 ] ).add( points[ 0 ] );
  24010. p0 = tmp;
  24011. }
  24012. const p1 = points[ intPoint % l ];
  24013. const p2 = points[ ( intPoint + 1 ) % l ];
  24014. if ( this.closed || intPoint + 2 < l ) {
  24015. p3 = points[ ( intPoint + 2 ) % l ];
  24016. } else {
  24017. // extrapolate last point
  24018. tmp.subVectors( points[ l - 1 ], points[ l - 2 ] ).add( points[ l - 1 ] );
  24019. p3 = tmp;
  24020. }
  24021. if ( this.curveType === 'centripetal' || this.curveType === 'chordal' ) {
  24022. // init Centripetal / Chordal Catmull-Rom
  24023. const pow = this.curveType === 'chordal' ? 0.5 : 0.25;
  24024. let dt0 = Math.pow( p0.distanceToSquared( p1 ), pow );
  24025. let dt1 = Math.pow( p1.distanceToSquared( p2 ), pow );
  24026. let dt2 = Math.pow( p2.distanceToSquared( p3 ), pow );
  24027. // safety check for repeated points
  24028. if ( dt1 < 1e-4 ) dt1 = 1.0;
  24029. if ( dt0 < 1e-4 ) dt0 = dt1;
  24030. if ( dt2 < 1e-4 ) dt2 = dt1;
  24031. px.initNonuniformCatmullRom( p0.x, p1.x, p2.x, p3.x, dt0, dt1, dt2 );
  24032. py.initNonuniformCatmullRom( p0.y, p1.y, p2.y, p3.y, dt0, dt1, dt2 );
  24033. pz.initNonuniformCatmullRom( p0.z, p1.z, p2.z, p3.z, dt0, dt1, dt2 );
  24034. } else if ( this.curveType === 'catmullrom' ) {
  24035. px.initCatmullRom( p0.x, p1.x, p2.x, p3.x, this.tension );
  24036. py.initCatmullRom( p0.y, p1.y, p2.y, p3.y, this.tension );
  24037. pz.initCatmullRom( p0.z, p1.z, p2.z, p3.z, this.tension );
  24038. }
  24039. point.set(
  24040. px.calc( weight ),
  24041. py.calc( weight ),
  24042. pz.calc( weight )
  24043. );
  24044. return point;
  24045. }
  24046. copy( source ) {
  24047. super.copy( source );
  24048. this.points = [];
  24049. for ( let i = 0, l = source.points.length; i < l; i ++ ) {
  24050. const point = source.points[ i ];
  24051. this.points.push( point.clone() );
  24052. }
  24053. this.closed = source.closed;
  24054. this.curveType = source.curveType;
  24055. this.tension = source.tension;
  24056. return this;
  24057. }
  24058. toJSON() {
  24059. const data = super.toJSON();
  24060. data.points = [];
  24061. for ( let i = 0, l = this.points.length; i < l; i ++ ) {
  24062. const point = this.points[ i ];
  24063. data.points.push( point.toArray() );
  24064. }
  24065. data.closed = this.closed;
  24066. data.curveType = this.curveType;
  24067. data.tension = this.tension;
  24068. return data;
  24069. }
  24070. fromJSON( json ) {
  24071. super.fromJSON( json );
  24072. this.points = [];
  24073. for ( let i = 0, l = json.points.length; i < l; i ++ ) {
  24074. const point = json.points[ i ];
  24075. this.points.push( new Vector3().fromArray( point ) );
  24076. }
  24077. this.closed = json.closed;
  24078. this.curveType = json.curveType;
  24079. this.tension = json.tension;
  24080. return this;
  24081. }
  24082. }
  24083. /**
  24084. * Interpolations contains spline and Bézier functions internally used by concrete curve classes.
  24085. *
  24086. * Bezier Curves formulas obtained from: https://en.wikipedia.org/wiki/B%C3%A9zier_curve
  24087. *
  24088. * @module Interpolations
  24089. */
  24090. /**
  24091. * Computes a point on a Catmull-Rom spline.
  24092. *
  24093. * @param {number} t - The interpolation factor.
  24094. * @param {number} p0 - The first control point.
  24095. * @param {number} p1 - The second control point.
  24096. * @param {number} p2 - The third control point.
  24097. * @param {number} p3 - The fourth control point.
  24098. * @return {number} The calculated point on a Catmull-Rom spline.
  24099. */
  24100. function CatmullRom( t, p0, p1, p2, p3 ) {
  24101. const v0 = ( p2 - p0 ) * 0.5;
  24102. const v1 = ( p3 - p1 ) * 0.5;
  24103. const t2 = t * t;
  24104. const t3 = t * t2;
  24105. return ( 2 * p1 - 2 * p2 + v0 + v1 ) * t3 + ( -3 * p1 + 3 * p2 - 2 * v0 - v1 ) * t2 + v0 * t + p1;
  24106. }
  24107. //
  24108. function QuadraticBezierP0( t, p ) {
  24109. const k = 1 - t;
  24110. return k * k * p;
  24111. }
  24112. function QuadraticBezierP1( t, p ) {
  24113. return 2 * ( 1 - t ) * t * p;
  24114. }
  24115. function QuadraticBezierP2( t, p ) {
  24116. return t * t * p;
  24117. }
  24118. /**
  24119. * Computes a point on a Quadratic Bezier curve.
  24120. *
  24121. * @param {number} t - The interpolation factor.
  24122. * @param {number} p0 - The first control point.
  24123. * @param {number} p1 - The second control point.
  24124. * @param {number} p2 - The third control point.
  24125. * @return {number} The calculated point on a Quadratic Bezier curve.
  24126. */
  24127. function QuadraticBezier( t, p0, p1, p2 ) {
  24128. return QuadraticBezierP0( t, p0 ) + QuadraticBezierP1( t, p1 ) +
  24129. QuadraticBezierP2( t, p2 );
  24130. }
  24131. //
  24132. function CubicBezierP0( t, p ) {
  24133. const k = 1 - t;
  24134. return k * k * k * p;
  24135. }
  24136. function CubicBezierP1( t, p ) {
  24137. const k = 1 - t;
  24138. return 3 * k * k * t * p;
  24139. }
  24140. function CubicBezierP2( t, p ) {
  24141. return 3 * ( 1 - t ) * t * t * p;
  24142. }
  24143. function CubicBezierP3( t, p ) {
  24144. return t * t * t * p;
  24145. }
  24146. /**
  24147. * Computes a point on a Cubic Bezier curve.
  24148. *
  24149. * @param {number} t - The interpolation factor.
  24150. * @param {number} p0 - The first control point.
  24151. * @param {number} p1 - The second control point.
  24152. * @param {number} p2 - The third control point.
  24153. * @param {number} p3 - The fourth control point.
  24154. * @return {number} The calculated point on a Cubic Bezier curve.
  24155. */
  24156. function CubicBezier( t, p0, p1, p2, p3 ) {
  24157. return CubicBezierP0( t, p0 ) + CubicBezierP1( t, p1 ) + CubicBezierP2( t, p2 ) +
  24158. CubicBezierP3( t, p3 );
  24159. }
  24160. /**
  24161. * A curve representing a 2D Cubic Bezier curve.
  24162. *
  24163. * ```js
  24164. * const curve = new THREE.CubicBezierCurve(
  24165. * new THREE.Vector2( - 0, 0 ),
  24166. * new THREE.Vector2( - 5, 15 ),
  24167. * new THREE.Vector2( 20, 15 ),
  24168. * new THREE.Vector2( 10, 0 )
  24169. * );
  24170. *
  24171. * const points = curve.getPoints( 50 );
  24172. * const geometry = new THREE.BufferGeometry().setFromPoints( points );
  24173. *
  24174. * const material = new THREE.LineBasicMaterial( { color: 0xff0000 } );
  24175. *
  24176. * // Create the final object to add to the scene
  24177. * const curveObject = new THREE.Line( geometry, material );
  24178. * ```
  24179. *
  24180. * @augments Curve
  24181. */
  24182. class CubicBezierCurve extends Curve {
  24183. /**
  24184. * Constructs a new Cubic Bezier curve.
  24185. *
  24186. * @param {Vector2} [v0] - The start point.
  24187. * @param {Vector2} [v1] - The first control point.
  24188. * @param {Vector2} [v2] - The second control point.
  24189. * @param {Vector2} [v3] - The end point.
  24190. */
  24191. constructor( v0 = new Vector2(), v1 = new Vector2(), v2 = new Vector2(), v3 = new Vector2() ) {
  24192. super();
  24193. /**
  24194. * This flag can be used for type testing.
  24195. *
  24196. * @type {boolean}
  24197. * @readonly
  24198. * @default true
  24199. */
  24200. this.isCubicBezierCurve = true;
  24201. this.type = 'CubicBezierCurve';
  24202. /**
  24203. * The start point.
  24204. *
  24205. * @type {Vector2}
  24206. */
  24207. this.v0 = v0;
  24208. /**
  24209. * The first control point.
  24210. *
  24211. * @type {Vector2}
  24212. */
  24213. this.v1 = v1;
  24214. /**
  24215. * The second control point.
  24216. *
  24217. * @type {Vector2}
  24218. */
  24219. this.v2 = v2;
  24220. /**
  24221. * The end point.
  24222. *
  24223. * @type {Vector2}
  24224. */
  24225. this.v3 = v3;
  24226. }
  24227. /**
  24228. * Returns a point on the curve.
  24229. *
  24230. * @param {number} t - A interpolation factor representing a position on the curve. Must be in the range `[0,1]`.
  24231. * @param {Vector2} [optionalTarget] - The optional target vector the result is written to.
  24232. * @return {Vector2} The position on the curve.
  24233. */
  24234. getPoint( t, optionalTarget = new Vector2() ) {
  24235. const point = optionalTarget;
  24236. const v0 = this.v0, v1 = this.v1, v2 = this.v2, v3 = this.v3;
  24237. point.set(
  24238. CubicBezier( t, v0.x, v1.x, v2.x, v3.x ),
  24239. CubicBezier( t, v0.y, v1.y, v2.y, v3.y )
  24240. );
  24241. return point;
  24242. }
  24243. copy( source ) {
  24244. super.copy( source );
  24245. this.v0.copy( source.v0 );
  24246. this.v1.copy( source.v1 );
  24247. this.v2.copy( source.v2 );
  24248. this.v3.copy( source.v3 );
  24249. return this;
  24250. }
  24251. toJSON() {
  24252. const data = super.toJSON();
  24253. data.v0 = this.v0.toArray();
  24254. data.v1 = this.v1.toArray();
  24255. data.v2 = this.v2.toArray();
  24256. data.v3 = this.v3.toArray();
  24257. return data;
  24258. }
  24259. fromJSON( json ) {
  24260. super.fromJSON( json );
  24261. this.v0.fromArray( json.v0 );
  24262. this.v1.fromArray( json.v1 );
  24263. this.v2.fromArray( json.v2 );
  24264. this.v3.fromArray( json.v3 );
  24265. return this;
  24266. }
  24267. }
  24268. /**
  24269. * A curve representing a 3D Cubic Bezier curve.
  24270. *
  24271. * @augments Curve
  24272. */
  24273. class CubicBezierCurve3 extends Curve {
  24274. /**
  24275. * Constructs a new Cubic Bezier curve.
  24276. *
  24277. * @param {Vector3} [v0] - The start point.
  24278. * @param {Vector3} [v1] - The first control point.
  24279. * @param {Vector3} [v2] - The second control point.
  24280. * @param {Vector3} [v3] - The end point.
  24281. */
  24282. constructor( v0 = new Vector3(), v1 = new Vector3(), v2 = new Vector3(), v3 = new Vector3() ) {
  24283. super();
  24284. /**
  24285. * This flag can be used for type testing.
  24286. *
  24287. * @type {boolean}
  24288. * @readonly
  24289. * @default true
  24290. */
  24291. this.isCubicBezierCurve3 = true;
  24292. this.type = 'CubicBezierCurve3';
  24293. /**
  24294. * The start point.
  24295. *
  24296. * @type {Vector3}
  24297. */
  24298. this.v0 = v0;
  24299. /**
  24300. * The first control point.
  24301. *
  24302. * @type {Vector3}
  24303. */
  24304. this.v1 = v1;
  24305. /**
  24306. * The second control point.
  24307. *
  24308. * @type {Vector3}
  24309. */
  24310. this.v2 = v2;
  24311. /**
  24312. * The end point.
  24313. *
  24314. * @type {Vector3}
  24315. */
  24316. this.v3 = v3;
  24317. }
  24318. /**
  24319. * Returns a point on the curve.
  24320. *
  24321. * @param {number} t - A interpolation factor representing a position on the curve. Must be in the range `[0,1]`.
  24322. * @param {Vector3} [optionalTarget] - The optional target vector the result is written to.
  24323. * @return {Vector3} The position on the curve.
  24324. */
  24325. getPoint( t, optionalTarget = new Vector3() ) {
  24326. const point = optionalTarget;
  24327. const v0 = this.v0, v1 = this.v1, v2 = this.v2, v3 = this.v3;
  24328. point.set(
  24329. CubicBezier( t, v0.x, v1.x, v2.x, v3.x ),
  24330. CubicBezier( t, v0.y, v1.y, v2.y, v3.y ),
  24331. CubicBezier( t, v0.z, v1.z, v2.z, v3.z )
  24332. );
  24333. return point;
  24334. }
  24335. copy( source ) {
  24336. super.copy( source );
  24337. this.v0.copy( source.v0 );
  24338. this.v1.copy( source.v1 );
  24339. this.v2.copy( source.v2 );
  24340. this.v3.copy( source.v3 );
  24341. return this;
  24342. }
  24343. toJSON() {
  24344. const data = super.toJSON();
  24345. data.v0 = this.v0.toArray();
  24346. data.v1 = this.v1.toArray();
  24347. data.v2 = this.v2.toArray();
  24348. data.v3 = this.v3.toArray();
  24349. return data;
  24350. }
  24351. fromJSON( json ) {
  24352. super.fromJSON( json );
  24353. this.v0.fromArray( json.v0 );
  24354. this.v1.fromArray( json.v1 );
  24355. this.v2.fromArray( json.v2 );
  24356. this.v3.fromArray( json.v3 );
  24357. return this;
  24358. }
  24359. }
  24360. /**
  24361. * A curve representing a 2D line segment.
  24362. *
  24363. * @augments Curve
  24364. */
  24365. class LineCurve extends Curve {
  24366. /**
  24367. * Constructs a new line curve.
  24368. *
  24369. * @param {Vector2} [v1] - The start point.
  24370. * @param {Vector2} [v2] - The end point.
  24371. */
  24372. constructor( v1 = new Vector2(), v2 = new Vector2() ) {
  24373. super();
  24374. /**
  24375. * This flag can be used for type testing.
  24376. *
  24377. * @type {boolean}
  24378. * @readonly
  24379. * @default true
  24380. */
  24381. this.isLineCurve = true;
  24382. this.type = 'LineCurve';
  24383. /**
  24384. * The start point.
  24385. *
  24386. * @type {Vector2}
  24387. */
  24388. this.v1 = v1;
  24389. /**
  24390. * The end point.
  24391. *
  24392. * @type {Vector2}
  24393. */
  24394. this.v2 = v2;
  24395. }
  24396. /**
  24397. * Returns a point on the line.
  24398. *
  24399. * @param {number} t - A interpolation factor representing a position on the line. Must be in the range `[0,1]`.
  24400. * @param {Vector2} [optionalTarget] - The optional target vector the result is written to.
  24401. * @return {Vector2} The position on the line.
  24402. */
  24403. getPoint( t, optionalTarget = new Vector2() ) {
  24404. const point = optionalTarget;
  24405. if ( t === 1 ) {
  24406. point.copy( this.v2 );
  24407. } else {
  24408. point.copy( this.v2 ).sub( this.v1 );
  24409. point.multiplyScalar( t ).add( this.v1 );
  24410. }
  24411. return point;
  24412. }
  24413. // Line curve is linear, so we can overwrite default getPointAt
  24414. getPointAt( u, optionalTarget ) {
  24415. return this.getPoint( u, optionalTarget );
  24416. }
  24417. getTangent( t, optionalTarget = new Vector2() ) {
  24418. return optionalTarget.subVectors( this.v2, this.v1 ).normalize();
  24419. }
  24420. getTangentAt( u, optionalTarget ) {
  24421. return this.getTangent( u, optionalTarget );
  24422. }
  24423. copy( source ) {
  24424. super.copy( source );
  24425. this.v1.copy( source.v1 );
  24426. this.v2.copy( source.v2 );
  24427. return this;
  24428. }
  24429. toJSON() {
  24430. const data = super.toJSON();
  24431. data.v1 = this.v1.toArray();
  24432. data.v2 = this.v2.toArray();
  24433. return data;
  24434. }
  24435. fromJSON( json ) {
  24436. super.fromJSON( json );
  24437. this.v1.fromArray( json.v1 );
  24438. this.v2.fromArray( json.v2 );
  24439. return this;
  24440. }
  24441. }
  24442. /**
  24443. * A curve representing a 3D line segment.
  24444. *
  24445. * @augments Curve
  24446. */
  24447. class LineCurve3 extends Curve {
  24448. /**
  24449. * Constructs a new line curve.
  24450. *
  24451. * @param {Vector3} [v1] - The start point.
  24452. * @param {Vector3} [v2] - The end point.
  24453. */
  24454. constructor( v1 = new Vector3(), v2 = new Vector3() ) {
  24455. super();
  24456. /**
  24457. * This flag can be used for type testing.
  24458. *
  24459. * @type {boolean}
  24460. * @readonly
  24461. * @default true
  24462. */
  24463. this.isLineCurve3 = true;
  24464. this.type = 'LineCurve3';
  24465. /**
  24466. * The start point.
  24467. *
  24468. * @type {Vector3}
  24469. */
  24470. this.v1 = v1;
  24471. /**
  24472. * The end point.
  24473. *
  24474. * @type {Vector2}
  24475. */
  24476. this.v2 = v2;
  24477. }
  24478. /**
  24479. * Returns a point on the line.
  24480. *
  24481. * @param {number} t - A interpolation factor representing a position on the line. Must be in the range `[0,1]`.
  24482. * @param {Vector3} [optionalTarget] - The optional target vector the result is written to.
  24483. * @return {Vector3} The position on the line.
  24484. */
  24485. getPoint( t, optionalTarget = new Vector3() ) {
  24486. const point = optionalTarget;
  24487. if ( t === 1 ) {
  24488. point.copy( this.v2 );
  24489. } else {
  24490. point.copy( this.v2 ).sub( this.v1 );
  24491. point.multiplyScalar( t ).add( this.v1 );
  24492. }
  24493. return point;
  24494. }
  24495. // Line curve is linear, so we can overwrite default getPointAt
  24496. getPointAt( u, optionalTarget ) {
  24497. return this.getPoint( u, optionalTarget );
  24498. }
  24499. getTangent( t, optionalTarget = new Vector3() ) {
  24500. return optionalTarget.subVectors( this.v2, this.v1 ).normalize();
  24501. }
  24502. getTangentAt( u, optionalTarget ) {
  24503. return this.getTangent( u, optionalTarget );
  24504. }
  24505. copy( source ) {
  24506. super.copy( source );
  24507. this.v1.copy( source.v1 );
  24508. this.v2.copy( source.v2 );
  24509. return this;
  24510. }
  24511. toJSON() {
  24512. const data = super.toJSON();
  24513. data.v1 = this.v1.toArray();
  24514. data.v2 = this.v2.toArray();
  24515. return data;
  24516. }
  24517. fromJSON( json ) {
  24518. super.fromJSON( json );
  24519. this.v1.fromArray( json.v1 );
  24520. this.v2.fromArray( json.v2 );
  24521. return this;
  24522. }
  24523. }
  24524. /**
  24525. * A curve representing a 2D Quadratic Bezier curve.
  24526. *
  24527. * ```js
  24528. * const curve = new THREE.QuadraticBezierCurve(
  24529. * new THREE.Vector2( - 10, 0 ),
  24530. * new THREE.Vector2( 20, 15 ),
  24531. * new THREE.Vector2( 10, 0 )
  24532. * )
  24533. *
  24534. * const points = curve.getPoints( 50 );
  24535. * const geometry = new THREE.BufferGeometry().setFromPoints( points );
  24536. *
  24537. * const material = new THREE.LineBasicMaterial( { color: 0xff0000 } );
  24538. *
  24539. * // Create the final object to add to the scene
  24540. * const curveObject = new THREE.Line( geometry, material );
  24541. * ```
  24542. *
  24543. * @augments Curve
  24544. */
  24545. class QuadraticBezierCurve extends Curve {
  24546. /**
  24547. * Constructs a new Quadratic Bezier curve.
  24548. *
  24549. * @param {Vector2} [v0] - The start point.
  24550. * @param {Vector2} [v1] - The control point.
  24551. * @param {Vector2} [v2] - The end point.
  24552. */
  24553. constructor( v0 = new Vector2(), v1 = new Vector2(), v2 = new Vector2() ) {
  24554. super();
  24555. /**
  24556. * This flag can be used for type testing.
  24557. *
  24558. * @type {boolean}
  24559. * @readonly
  24560. * @default true
  24561. */
  24562. this.isQuadraticBezierCurve = true;
  24563. this.type = 'QuadraticBezierCurve';
  24564. /**
  24565. * The start point.
  24566. *
  24567. * @type {Vector2}
  24568. */
  24569. this.v0 = v0;
  24570. /**
  24571. * The control point.
  24572. *
  24573. * @type {Vector2}
  24574. */
  24575. this.v1 = v1;
  24576. /**
  24577. * The end point.
  24578. *
  24579. * @type {Vector2}
  24580. */
  24581. this.v2 = v2;
  24582. }
  24583. /**
  24584. * Returns a point on the curve.
  24585. *
  24586. * @param {number} t - A interpolation factor representing a position on the curve. Must be in the range `[0,1]`.
  24587. * @param {Vector2} [optionalTarget] - The optional target vector the result is written to.
  24588. * @return {Vector2} The position on the curve.
  24589. */
  24590. getPoint( t, optionalTarget = new Vector2() ) {
  24591. const point = optionalTarget;
  24592. const v0 = this.v0, v1 = this.v1, v2 = this.v2;
  24593. point.set(
  24594. QuadraticBezier( t, v0.x, v1.x, v2.x ),
  24595. QuadraticBezier( t, v0.y, v1.y, v2.y )
  24596. );
  24597. return point;
  24598. }
  24599. copy( source ) {
  24600. super.copy( source );
  24601. this.v0.copy( source.v0 );
  24602. this.v1.copy( source.v1 );
  24603. this.v2.copy( source.v2 );
  24604. return this;
  24605. }
  24606. toJSON() {
  24607. const data = super.toJSON();
  24608. data.v0 = this.v0.toArray();
  24609. data.v1 = this.v1.toArray();
  24610. data.v2 = this.v2.toArray();
  24611. return data;
  24612. }
  24613. fromJSON( json ) {
  24614. super.fromJSON( json );
  24615. this.v0.fromArray( json.v0 );
  24616. this.v1.fromArray( json.v1 );
  24617. this.v2.fromArray( json.v2 );
  24618. return this;
  24619. }
  24620. }
  24621. /**
  24622. * A curve representing a 3D Quadratic Bezier curve.
  24623. *
  24624. * @augments Curve
  24625. */
  24626. class QuadraticBezierCurve3 extends Curve {
  24627. /**
  24628. * Constructs a new Quadratic Bezier curve.
  24629. *
  24630. * @param {Vector3} [v0] - The start point.
  24631. * @param {Vector3} [v1] - The control point.
  24632. * @param {Vector3} [v2] - The end point.
  24633. */
  24634. constructor( v0 = new Vector3(), v1 = new Vector3(), v2 = new Vector3() ) {
  24635. super();
  24636. /**
  24637. * This flag can be used for type testing.
  24638. *
  24639. * @type {boolean}
  24640. * @readonly
  24641. * @default true
  24642. */
  24643. this.isQuadraticBezierCurve3 = true;
  24644. this.type = 'QuadraticBezierCurve3';
  24645. /**
  24646. * The start point.
  24647. *
  24648. * @type {Vector3}
  24649. */
  24650. this.v0 = v0;
  24651. /**
  24652. * The control point.
  24653. *
  24654. * @type {Vector3}
  24655. */
  24656. this.v1 = v1;
  24657. /**
  24658. * The end point.
  24659. *
  24660. * @type {Vector3}
  24661. */
  24662. this.v2 = v2;
  24663. }
  24664. /**
  24665. * Returns a point on the curve.
  24666. *
  24667. * @param {number} t - A interpolation factor representing a position on the curve. Must be in the range `[0,1]`.
  24668. * @param {Vector3} [optionalTarget] - The optional target vector the result is written to.
  24669. * @return {Vector3} The position on the curve.
  24670. */
  24671. getPoint( t, optionalTarget = new Vector3() ) {
  24672. const point = optionalTarget;
  24673. const v0 = this.v0, v1 = this.v1, v2 = this.v2;
  24674. point.set(
  24675. QuadraticBezier( t, v0.x, v1.x, v2.x ),
  24676. QuadraticBezier( t, v0.y, v1.y, v2.y ),
  24677. QuadraticBezier( t, v0.z, v1.z, v2.z )
  24678. );
  24679. return point;
  24680. }
  24681. copy( source ) {
  24682. super.copy( source );
  24683. this.v0.copy( source.v0 );
  24684. this.v1.copy( source.v1 );
  24685. this.v2.copy( source.v2 );
  24686. return this;
  24687. }
  24688. toJSON() {
  24689. const data = super.toJSON();
  24690. data.v0 = this.v0.toArray();
  24691. data.v1 = this.v1.toArray();
  24692. data.v2 = this.v2.toArray();
  24693. return data;
  24694. }
  24695. fromJSON( json ) {
  24696. super.fromJSON( json );
  24697. this.v0.fromArray( json.v0 );
  24698. this.v1.fromArray( json.v1 );
  24699. this.v2.fromArray( json.v2 );
  24700. return this;
  24701. }
  24702. }
  24703. /**
  24704. * A curve representing a 2D spline curve.
  24705. *
  24706. * ```js
  24707. * // Create a sine-like wave
  24708. * const curve = new THREE.SplineCurve( [
  24709. * new THREE.Vector2( -10, 0 ),
  24710. * new THREE.Vector2( -5, 5 ),
  24711. * new THREE.Vector2( 0, 0 ),
  24712. * new THREE.Vector2( 5, -5 ),
  24713. * new THREE.Vector2( 10, 0 )
  24714. * ] );
  24715. *
  24716. * const points = curve.getPoints( 50 );
  24717. * const geometry = new THREE.BufferGeometry().setFromPoints( points );
  24718. *
  24719. * const material = new THREE.LineBasicMaterial( { color: 0xff0000 } );
  24720. *
  24721. * // Create the final object to add to the scene
  24722. * const splineObject = new THREE.Line( geometry, material );
  24723. * ```
  24724. *
  24725. * @augments Curve
  24726. */
  24727. class SplineCurve extends Curve {
  24728. /**
  24729. * Constructs a new 2D spline curve.
  24730. *
  24731. * @param {Array<Vector2>} [points] - An array of 2D points defining the curve.
  24732. */
  24733. constructor( points = [] ) {
  24734. super();
  24735. /**
  24736. * This flag can be used for type testing.
  24737. *
  24738. * @type {boolean}
  24739. * @readonly
  24740. * @default true
  24741. */
  24742. this.isSplineCurve = true;
  24743. this.type = 'SplineCurve';
  24744. /**
  24745. * An array of 2D points defining the curve.
  24746. *
  24747. * @type {Array<Vector2>}
  24748. */
  24749. this.points = points;
  24750. }
  24751. /**
  24752. * Returns a point on the curve.
  24753. *
  24754. * @param {number} t - A interpolation factor representing a position on the curve. Must be in the range `[0,1]`.
  24755. * @param {Vector2} [optionalTarget] - The optional target vector the result is written to.
  24756. * @return {Vector2} The position on the curve.
  24757. */
  24758. getPoint( t, optionalTarget = new Vector2() ) {
  24759. const point = optionalTarget;
  24760. const points = this.points;
  24761. const p = ( points.length - 1 ) * t;
  24762. const intPoint = Math.floor( p );
  24763. const weight = p - intPoint;
  24764. const p0 = points[ intPoint === 0 ? intPoint : intPoint - 1 ];
  24765. const p1 = points[ intPoint ];
  24766. const p2 = points[ intPoint > points.length - 2 ? points.length - 1 : intPoint + 1 ];
  24767. const p3 = points[ intPoint > points.length - 3 ? points.length - 1 : intPoint + 2 ];
  24768. point.set(
  24769. CatmullRom( weight, p0.x, p1.x, p2.x, p3.x ),
  24770. CatmullRom( weight, p0.y, p1.y, p2.y, p3.y )
  24771. );
  24772. return point;
  24773. }
  24774. copy( source ) {
  24775. super.copy( source );
  24776. this.points = [];
  24777. for ( let i = 0, l = source.points.length; i < l; i ++ ) {
  24778. const point = source.points[ i ];
  24779. this.points.push( point.clone() );
  24780. }
  24781. return this;
  24782. }
  24783. toJSON() {
  24784. const data = super.toJSON();
  24785. data.points = [];
  24786. for ( let i = 0, l = this.points.length; i < l; i ++ ) {
  24787. const point = this.points[ i ];
  24788. data.points.push( point.toArray() );
  24789. }
  24790. return data;
  24791. }
  24792. fromJSON( json ) {
  24793. super.fromJSON( json );
  24794. this.points = [];
  24795. for ( let i = 0, l = json.points.length; i < l; i ++ ) {
  24796. const point = json.points[ i ];
  24797. this.points.push( new Vector2().fromArray( point ) );
  24798. }
  24799. return this;
  24800. }
  24801. }
  24802. var Curves = /*#__PURE__*/Object.freeze({
  24803. __proto__: null,
  24804. ArcCurve: ArcCurve,
  24805. CatmullRomCurve3: CatmullRomCurve3,
  24806. CubicBezierCurve: CubicBezierCurve,
  24807. CubicBezierCurve3: CubicBezierCurve3,
  24808. EllipseCurve: EllipseCurve,
  24809. LineCurve: LineCurve,
  24810. LineCurve3: LineCurve3,
  24811. QuadraticBezierCurve: QuadraticBezierCurve,
  24812. QuadraticBezierCurve3: QuadraticBezierCurve3,
  24813. SplineCurve: SplineCurve
  24814. });
  24815. /**
  24816. * A base class extending {@link Curve}. `CurvePath` is simply an
  24817. * array of connected curves, but retains the API of a curve.
  24818. *
  24819. * @augments Curve
  24820. */
  24821. class CurvePath extends Curve {
  24822. /**
  24823. * Constructs a new curve path.
  24824. */
  24825. constructor() {
  24826. super();
  24827. this.type = 'CurvePath';
  24828. /**
  24829. * An array of curves defining the
  24830. * path.
  24831. *
  24832. * @type {Array<Curve>}
  24833. */
  24834. this.curves = [];
  24835. /**
  24836. * Whether the path should automatically be closed
  24837. * by a line curve.
  24838. *
  24839. * @type {boolean}
  24840. * @default false
  24841. */
  24842. this.autoClose = false;
  24843. }
  24844. /**
  24845. * Adds a curve to this curve path.
  24846. *
  24847. * @param {Curve} curve - The curve to add.
  24848. */
  24849. add( curve ) {
  24850. this.curves.push( curve );
  24851. }
  24852. /**
  24853. * Adds a line curve to close the path.
  24854. *
  24855. * @return {CurvePath} A reference to this curve path.
  24856. */
  24857. closePath() {
  24858. // Add a line curve if start and end of lines are not connected
  24859. const startPoint = this.curves[ 0 ].getPoint( 0 );
  24860. const endPoint = this.curves[ this.curves.length - 1 ].getPoint( 1 );
  24861. if ( ! startPoint.equals( endPoint ) ) {
  24862. const lineType = ( startPoint.isVector2 === true ) ? 'LineCurve' : 'LineCurve3';
  24863. this.curves.push( new Curves[ lineType ]( endPoint, startPoint ) );
  24864. }
  24865. return this;
  24866. }
  24867. /**
  24868. * This method returns a vector in 2D or 3D space (depending on the curve definitions)
  24869. * for the given interpolation factor.
  24870. *
  24871. * @param {number} t - A interpolation factor representing a position on the curve. Must be in the range `[0,1]`.
  24872. * @param {(Vector2|Vector3)} [optionalTarget] - The optional target vector the result is written to.
  24873. * @return {?(Vector2|Vector3)} The position on the curve. It can be a 2D or 3D vector depending on the curve definition.
  24874. */
  24875. getPoint( t, optionalTarget ) {
  24876. // To get accurate point with reference to
  24877. // entire path distance at time t,
  24878. // following has to be done:
  24879. // 1. Length of each sub path have to be known
  24880. // 2. Locate and identify type of curve
  24881. // 3. Get t for the curve
  24882. // 4. Return curve.getPointAt(t')
  24883. const d = t * this.getLength();
  24884. const curveLengths = this.getCurveLengths();
  24885. let i = 0;
  24886. // To think about boundaries points.
  24887. while ( i < curveLengths.length ) {
  24888. if ( curveLengths[ i ] >= d ) {
  24889. const diff = curveLengths[ i ] - d;
  24890. const curve = this.curves[ i ];
  24891. const segmentLength = curve.getLength();
  24892. const u = segmentLength === 0 ? 0 : 1 - diff / segmentLength;
  24893. return curve.getPointAt( u, optionalTarget );
  24894. }
  24895. i ++;
  24896. }
  24897. return null;
  24898. // loop where sum != 0, sum > d , sum+1 <d
  24899. }
  24900. getLength() {
  24901. // We cannot use the default THREE.Curve getPoint() with getLength() because in
  24902. // THREE.Curve, getLength() depends on getPoint() but in THREE.CurvePath
  24903. // getPoint() depends on getLength
  24904. const lens = this.getCurveLengths();
  24905. return lens[ lens.length - 1 ];
  24906. }
  24907. updateArcLengths() {
  24908. // cacheLengths must be recalculated.
  24909. this.needsUpdate = true;
  24910. this.cacheLengths = null;
  24911. this.getCurveLengths();
  24912. }
  24913. /**
  24914. * Returns list of cumulative curve lengths of the defined curves.
  24915. *
  24916. * @return {Array<number>} The curve lengths.
  24917. */
  24918. getCurveLengths() {
  24919. // Compute lengths and cache them
  24920. // We cannot overwrite getLengths() because UtoT mapping uses it.
  24921. // We use cache values if curves and cache array are same length
  24922. if ( this.cacheLengths && this.cacheLengths.length === this.curves.length ) {
  24923. return this.cacheLengths;
  24924. }
  24925. // Get length of sub-curve
  24926. // Push sums into cached array
  24927. const lengths = [];
  24928. let sums = 0;
  24929. for ( let i = 0, l = this.curves.length; i < l; i ++ ) {
  24930. sums += this.curves[ i ].getLength();
  24931. lengths.push( sums );
  24932. }
  24933. this.cacheLengths = lengths;
  24934. return lengths;
  24935. }
  24936. getSpacedPoints( divisions = 40 ) {
  24937. const points = [];
  24938. for ( let i = 0; i <= divisions; i ++ ) {
  24939. points.push( this.getPoint( i / divisions ) );
  24940. }
  24941. if ( this.autoClose ) {
  24942. points.push( points[ 0 ] );
  24943. }
  24944. return points;
  24945. }
  24946. getPoints( divisions = 12 ) {
  24947. const points = [];
  24948. let last;
  24949. for ( let i = 0, curves = this.curves; i < curves.length; i ++ ) {
  24950. const curve = curves[ i ];
  24951. const resolution = curve.isEllipseCurve ? divisions * 2
  24952. : ( curve.isLineCurve || curve.isLineCurve3 ) ? 1
  24953. : curve.isSplineCurve ? divisions * curve.points.length
  24954. : divisions;
  24955. const pts = curve.getPoints( resolution );
  24956. for ( let j = 0; j < pts.length; j ++ ) {
  24957. const point = pts[ j ];
  24958. if ( last && last.equals( point ) ) continue; // ensures no consecutive points are duplicates
  24959. points.push( point );
  24960. last = point;
  24961. }
  24962. }
  24963. if ( this.autoClose && points.length > 1 && ! points[ points.length - 1 ].equals( points[ 0 ] ) ) {
  24964. points.push( points[ 0 ] );
  24965. }
  24966. return points;
  24967. }
  24968. copy( source ) {
  24969. super.copy( source );
  24970. this.curves = [];
  24971. for ( let i = 0, l = source.curves.length; i < l; i ++ ) {
  24972. const curve = source.curves[ i ];
  24973. this.curves.push( curve.clone() );
  24974. }
  24975. this.autoClose = source.autoClose;
  24976. return this;
  24977. }
  24978. toJSON() {
  24979. const data = super.toJSON();
  24980. data.autoClose = this.autoClose;
  24981. data.curves = [];
  24982. for ( let i = 0, l = this.curves.length; i < l; i ++ ) {
  24983. const curve = this.curves[ i ];
  24984. data.curves.push( curve.toJSON() );
  24985. }
  24986. return data;
  24987. }
  24988. fromJSON( json ) {
  24989. super.fromJSON( json );
  24990. this.autoClose = json.autoClose;
  24991. this.curves = [];
  24992. for ( let i = 0, l = json.curves.length; i < l; i ++ ) {
  24993. const curve = json.curves[ i ];
  24994. this.curves.push( new Curves[ curve.type ]().fromJSON( curve ) );
  24995. }
  24996. return this;
  24997. }
  24998. }
  24999. /**
  25000. * A 2D path representation. The class provides methods for creating paths
  25001. * and contours of 2D shapes similar to the 2D Canvas API.
  25002. *
  25003. * ```js
  25004. * const path = new THREE.Path();
  25005. *
  25006. * path.lineTo( 0, 0.8 );
  25007. * path.quadraticCurveTo( 0, 1, 0.2, 1 );
  25008. * path.lineTo( 1, 1 );
  25009. *
  25010. * const points = path.getPoints();
  25011. *
  25012. * const geometry = new THREE.BufferGeometry().setFromPoints( points );
  25013. * const material = new THREE.LineBasicMaterial( { color: 0xffffff } );
  25014. *
  25015. * const line = new THREE.Line( geometry, material );
  25016. * scene.add( line );
  25017. * ```
  25018. *
  25019. * @augments CurvePath
  25020. */
  25021. class Path extends CurvePath {
  25022. /**
  25023. * Constructs a new path.
  25024. *
  25025. * @param {Array<Vector2>} [points] - An array of 2D points defining the path.
  25026. */
  25027. constructor( points ) {
  25028. super();
  25029. this.type = 'Path';
  25030. /**
  25031. * The current offset of the path. Any new curve added will start here.
  25032. *
  25033. * @type {Vector2}
  25034. */
  25035. this.currentPoint = new Vector2();
  25036. if ( points ) {
  25037. this.setFromPoints( points );
  25038. }
  25039. }
  25040. /**
  25041. * Creates a path from the given list of points. The points are added
  25042. * to the path as instances of {@link LineCurve}.
  25043. *
  25044. * @param {Array<Vector2>} points - An array of 2D points.
  25045. * @return {Path} A reference to this path.
  25046. */
  25047. setFromPoints( points ) {
  25048. this.moveTo( points[ 0 ].x, points[ 0 ].y );
  25049. for ( let i = 1, l = points.length; i < l; i ++ ) {
  25050. this.lineTo( points[ i ].x, points[ i ].y );
  25051. }
  25052. return this;
  25053. }
  25054. /**
  25055. * Moves {@link Path#currentPoint} to the given point.
  25056. *
  25057. * @param {number} x - The x coordinate.
  25058. * @param {number} y - The y coordinate.
  25059. * @return {Path} A reference to this path.
  25060. */
  25061. moveTo( x, y ) {
  25062. this.currentPoint.set( x, y ); // TODO consider referencing vectors instead of copying?
  25063. return this;
  25064. }
  25065. /**
  25066. * Adds an instance of {@link LineCurve} to the path by connecting
  25067. * the current point with the given one.
  25068. *
  25069. * @param {number} x - The x coordinate of the end point.
  25070. * @param {number} y - The y coordinate of the end point.
  25071. * @return {Path} A reference to this path.
  25072. */
  25073. lineTo( x, y ) {
  25074. const curve = new LineCurve( this.currentPoint.clone(), new Vector2( x, y ) );
  25075. this.curves.push( curve );
  25076. this.currentPoint.set( x, y );
  25077. return this;
  25078. }
  25079. /**
  25080. * Adds an instance of {@link QuadraticBezierCurve} to the path by connecting
  25081. * the current point with the given one.
  25082. *
  25083. * @param {number} aCPx - The x coordinate of the control point.
  25084. * @param {number} aCPy - The y coordinate of the control point.
  25085. * @param {number} aX - The x coordinate of the end point.
  25086. * @param {number} aY - The y coordinate of the end point.
  25087. * @return {Path} A reference to this path.
  25088. */
  25089. quadraticCurveTo( aCPx, aCPy, aX, aY ) {
  25090. const curve = new QuadraticBezierCurve(
  25091. this.currentPoint.clone(),
  25092. new Vector2( aCPx, aCPy ),
  25093. new Vector2( aX, aY )
  25094. );
  25095. this.curves.push( curve );
  25096. this.currentPoint.set( aX, aY );
  25097. return this;
  25098. }
  25099. /**
  25100. * Adds an instance of {@link CubicBezierCurve} to the path by connecting
  25101. * the current point with the given one.
  25102. *
  25103. * @param {number} aCP1x - The x coordinate of the first control point.
  25104. * @param {number} aCP1y - The y coordinate of the first control point.
  25105. * @param {number} aCP2x - The x coordinate of the second control point.
  25106. * @param {number} aCP2y - The y coordinate of the second control point.
  25107. * @param {number} aX - The x coordinate of the end point.
  25108. * @param {number} aY - The y coordinate of the end point.
  25109. * @return {Path} A reference to this path.
  25110. */
  25111. bezierCurveTo( aCP1x, aCP1y, aCP2x, aCP2y, aX, aY ) {
  25112. const curve = new CubicBezierCurve(
  25113. this.currentPoint.clone(),
  25114. new Vector2( aCP1x, aCP1y ),
  25115. new Vector2( aCP2x, aCP2y ),
  25116. new Vector2( aX, aY )
  25117. );
  25118. this.curves.push( curve );
  25119. this.currentPoint.set( aX, aY );
  25120. return this;
  25121. }
  25122. /**
  25123. * Adds an instance of {@link SplineCurve} to the path by connecting
  25124. * the current point with the given list of points.
  25125. *
  25126. * @param {Array<Vector2>} pts - An array of points in 2D space.
  25127. * @return {Path} A reference to this path.
  25128. */
  25129. splineThru( pts ) {
  25130. const npts = [ this.currentPoint.clone() ].concat( pts );
  25131. const curve = new SplineCurve( npts );
  25132. this.curves.push( curve );
  25133. this.currentPoint.copy( pts[ pts.length - 1 ] );
  25134. return this;
  25135. }
  25136. /**
  25137. * Adds an arc as an instance of {@link EllipseCurve} to the path, positioned relative
  25138. * to the current point.
  25139. *
  25140. * @param {number} [aX=0] - The x coordinate of the center of the arc offsetted from the previous curve.
  25141. * @param {number} [aY=0] - The y coordinate of the center of the arc offsetted from the previous curve.
  25142. * @param {number} [aRadius=1] - The radius of the arc.
  25143. * @param {number} [aStartAngle=0] - The start angle in radians.
  25144. * @param {number} [aEndAngle=Math.PI*2] - The end angle in radians.
  25145. * @param {boolean} [aClockwise=false] - Whether to sweep the arc clockwise or not.
  25146. * @return {Path} A reference to this path.
  25147. */
  25148. arc( aX, aY, aRadius, aStartAngle, aEndAngle, aClockwise ) {
  25149. const x0 = this.currentPoint.x;
  25150. const y0 = this.currentPoint.y;
  25151. this.absarc( aX + x0, aY + y0, aRadius,
  25152. aStartAngle, aEndAngle, aClockwise );
  25153. return this;
  25154. }
  25155. /**
  25156. * Adds an absolutely positioned arc as an instance of {@link EllipseCurve} to the path.
  25157. *
  25158. * @param {number} [aX=0] - The x coordinate of the center of the arc.
  25159. * @param {number} [aY=0] - The y coordinate of the center of the arc.
  25160. * @param {number} [aRadius=1] - The radius of the arc.
  25161. * @param {number} [aStartAngle=0] - The start angle in radians.
  25162. * @param {number} [aEndAngle=Math.PI*2] - The end angle in radians.
  25163. * @param {boolean} [aClockwise=false] - Whether to sweep the arc clockwise or not.
  25164. * @return {Path} A reference to this path.
  25165. */
  25166. absarc( aX, aY, aRadius, aStartAngle, aEndAngle, aClockwise ) {
  25167. this.absellipse( aX, aY, aRadius, aRadius, aStartAngle, aEndAngle, aClockwise );
  25168. return this;
  25169. }
  25170. /**
  25171. * Adds an ellipse as an instance of {@link EllipseCurve} to the path, positioned relative
  25172. * to the current point
  25173. *
  25174. * @param {number} [aX=0] - The x coordinate of the center of the ellipse offsetted from the previous curve.
  25175. * @param {number} [aY=0] - The y coordinate of the center of the ellipse offsetted from the previous curve.
  25176. * @param {number} [xRadius=1] - The radius of the ellipse in the x axis.
  25177. * @param {number} [yRadius=1] - The radius of the ellipse in the y axis.
  25178. * @param {number} [aStartAngle=0] - The start angle in radians.
  25179. * @param {number} [aEndAngle=Math.PI*2] - The end angle in radians.
  25180. * @param {boolean} [aClockwise=false] - Whether to sweep the ellipse clockwise or not.
  25181. * @param {number} [aRotation=0] - The rotation angle of the ellipse in radians, counterclockwise from the positive X axis.
  25182. * @return {Path} A reference to this path.
  25183. */
  25184. ellipse( aX, aY, xRadius, yRadius, aStartAngle, aEndAngle, aClockwise, aRotation ) {
  25185. const x0 = this.currentPoint.x;
  25186. const y0 = this.currentPoint.y;
  25187. this.absellipse( aX + x0, aY + y0, xRadius, yRadius, aStartAngle, aEndAngle, aClockwise, aRotation );
  25188. return this;
  25189. }
  25190. /**
  25191. * Adds an absolutely positioned ellipse as an instance of {@link EllipseCurve} to the path.
  25192. *
  25193. * @param {number} [aX=0] - The x coordinate of the absolute center of the ellipse.
  25194. * @param {number} [aY=0] - The y coordinate of the absolute center of the ellipse.
  25195. * @param {number} [xRadius=1] - The radius of the ellipse in the x axis.
  25196. * @param {number} [yRadius=1] - The radius of the ellipse in the y axis.
  25197. * @param {number} [aStartAngle=0] - The start angle in radians.
  25198. * @param {number} [aEndAngle=Math.PI*2] - The end angle in radians.
  25199. * @param {boolean} [aClockwise=false] - Whether to sweep the ellipse clockwise or not.
  25200. * @param {number} [aRotation=0] - The rotation angle of the ellipse in radians, counterclockwise from the positive X axis.
  25201. * @return {Path} A reference to this path.
  25202. */
  25203. absellipse( aX, aY, xRadius, yRadius, aStartAngle, aEndAngle, aClockwise, aRotation ) {
  25204. const curve = new EllipseCurve( aX, aY, xRadius, yRadius, aStartAngle, aEndAngle, aClockwise, aRotation );
  25205. if ( this.curves.length > 0 ) {
  25206. // if a previous curve is present, attempt to join
  25207. const firstPoint = curve.getPoint( 0 );
  25208. if ( ! firstPoint.equals( this.currentPoint ) ) {
  25209. this.lineTo( firstPoint.x, firstPoint.y );
  25210. }
  25211. }
  25212. this.curves.push( curve );
  25213. const lastPoint = curve.getPoint( 1 );
  25214. this.currentPoint.copy( lastPoint );
  25215. return this;
  25216. }
  25217. copy( source ) {
  25218. super.copy( source );
  25219. this.currentPoint.copy( source.currentPoint );
  25220. return this;
  25221. }
  25222. toJSON() {
  25223. const data = super.toJSON();
  25224. data.currentPoint = this.currentPoint.toArray();
  25225. return data;
  25226. }
  25227. fromJSON( json ) {
  25228. super.fromJSON( json );
  25229. this.currentPoint.fromArray( json.currentPoint );
  25230. return this;
  25231. }
  25232. }
  25233. /**
  25234. * Defines an arbitrary 2d shape plane using paths with optional holes. It
  25235. * can be used with {@link ExtrudeGeometry}, {@link ShapeGeometry}, to get
  25236. * points, or to get triangulated faces.
  25237. *
  25238. * ```js
  25239. * const heartShape = new THREE.Shape();
  25240. *
  25241. * heartShape.moveTo( 25, 25 );
  25242. * heartShape.bezierCurveTo( 25, 25, 20, 0, 0, 0 );
  25243. * heartShape.bezierCurveTo( - 30, 0, - 30, 35, - 30, 35 );
  25244. * heartShape.bezierCurveTo( - 30, 55, - 10, 77, 25, 95 );
  25245. * heartShape.bezierCurveTo( 60, 77, 80, 55, 80, 35 );
  25246. * heartShape.bezierCurveTo( 80, 35, 80, 0, 50, 0 );
  25247. * heartShape.bezierCurveTo( 35, 0, 25, 25, 25, 25 );
  25248. *
  25249. * const extrudeSettings = {
  25250. * depth: 8,
  25251. * bevelEnabled: true,
  25252. * bevelSegments: 2,
  25253. * steps: 2,
  25254. * bevelSize: 1,
  25255. * bevelThickness: 1
  25256. * };
  25257. *
  25258. * const geometry = new THREE.ExtrudeGeometry( heartShape, extrudeSettings );
  25259. * const mesh = new THREE.Mesh( geometry, new THREE.MeshBasicMaterial() );
  25260. * ```
  25261. *
  25262. * @augments Path
  25263. */
  25264. class Shape extends Path {
  25265. /**
  25266. * Constructs a new shape.
  25267. *
  25268. * @param {Array<Vector2>} [points] - An array of 2D points defining the shape.
  25269. */
  25270. constructor( points ) {
  25271. super( points );
  25272. /**
  25273. * The UUID of the shape.
  25274. *
  25275. * @type {string}
  25276. * @readonly
  25277. */
  25278. this.uuid = generateUUID();
  25279. this.type = 'Shape';
  25280. /**
  25281. * Defines the holes in the shape. Hole definitions must use the
  25282. * opposite winding order (CW/CCW) than the outer shape.
  25283. *
  25284. * @type {Array<Path>}
  25285. * @readonly
  25286. */
  25287. this.holes = [];
  25288. }
  25289. /**
  25290. * Returns an array representing each contour of the holes
  25291. * as a list of 2D points.
  25292. *
  25293. * @param {number} divisions - The fineness of the result.
  25294. * @return {Array<Array<Vector2>>} The holes as a series of 2D points.
  25295. */
  25296. getPointsHoles( divisions ) {
  25297. const holesPts = [];
  25298. for ( let i = 0, l = this.holes.length; i < l; i ++ ) {
  25299. holesPts[ i ] = this.holes[ i ].getPoints( divisions );
  25300. }
  25301. return holesPts;
  25302. }
  25303. // get points of shape and holes (keypoints based on segments parameter)
  25304. /**
  25305. * Returns an object that holds contour data for the shape and its holes as
  25306. * arrays of 2D points.
  25307. *
  25308. * @param {number} divisions - The fineness of the result.
  25309. * @return {{shape:Array<Vector2>,holes:Array<Array<Vector2>>}} An object with contour data.
  25310. */
  25311. extractPoints( divisions ) {
  25312. return {
  25313. shape: this.getPoints( divisions ),
  25314. holes: this.getPointsHoles( divisions )
  25315. };
  25316. }
  25317. copy( source ) {
  25318. super.copy( source );
  25319. this.holes = [];
  25320. for ( let i = 0, l = source.holes.length; i < l; i ++ ) {
  25321. const hole = source.holes[ i ];
  25322. this.holes.push( hole.clone() );
  25323. }
  25324. return this;
  25325. }
  25326. toJSON() {
  25327. const data = super.toJSON();
  25328. data.uuid = this.uuid;
  25329. data.holes = [];
  25330. for ( let i = 0, l = this.holes.length; i < l; i ++ ) {
  25331. const hole = this.holes[ i ];
  25332. data.holes.push( hole.toJSON() );
  25333. }
  25334. return data;
  25335. }
  25336. fromJSON( json ) {
  25337. super.fromJSON( json );
  25338. this.uuid = json.uuid;
  25339. this.holes = [];
  25340. for ( let i = 0, l = json.holes.length; i < l; i ++ ) {
  25341. const hole = json.holes[ i ];
  25342. this.holes.push( new Path().fromJSON( hole ) );
  25343. }
  25344. return this;
  25345. }
  25346. }
  25347. /* eslint-disable */
  25348. // copy of mapbox/earcut version 3.0.2
  25349. // https://github.com/mapbox/earcut/tree/v3.0.2
  25350. function earcut(data, holeIndices, dim = 2) {
  25351. const hasHoles = holeIndices && holeIndices.length;
  25352. const outerLen = hasHoles ? holeIndices[0] * dim : data.length;
  25353. let outerNode = linkedList(data, 0, outerLen, dim, true);
  25354. const triangles = [];
  25355. if (!outerNode || outerNode.next === outerNode.prev) return triangles;
  25356. let minX, minY, invSize;
  25357. if (hasHoles) outerNode = eliminateHoles(data, holeIndices, outerNode, dim);
  25358. // if the shape is not too simple, we'll use z-order curve hash later; calculate polygon bbox
  25359. if (data.length > 80 * dim) {
  25360. minX = data[0];
  25361. minY = data[1];
  25362. let maxX = minX;
  25363. let maxY = minY;
  25364. for (let i = dim; i < outerLen; i += dim) {
  25365. const x = data[i];
  25366. const y = data[i + 1];
  25367. if (x < minX) minX = x;
  25368. if (y < minY) minY = y;
  25369. if (x > maxX) maxX = x;
  25370. if (y > maxY) maxY = y;
  25371. }
  25372. // minX, minY and invSize are later used to transform coords into integers for z-order calculation
  25373. invSize = Math.max(maxX - minX, maxY - minY);
  25374. invSize = invSize !== 0 ? 32767 / invSize : 0;
  25375. }
  25376. earcutLinked(outerNode, triangles, dim, minX, minY, invSize, 0);
  25377. return triangles;
  25378. }
  25379. // create a circular doubly linked list from polygon points in the specified winding order
  25380. function linkedList(data, start, end, dim, clockwise) {
  25381. let last;
  25382. if (clockwise === (signedArea(data, start, end, dim) > 0)) {
  25383. for (let i = start; i < end; i += dim) last = insertNode(i / dim | 0, data[i], data[i + 1], last);
  25384. } else {
  25385. for (let i = end - dim; i >= start; i -= dim) last = insertNode(i / dim | 0, data[i], data[i + 1], last);
  25386. }
  25387. if (last && equals(last, last.next)) {
  25388. removeNode(last);
  25389. last = last.next;
  25390. }
  25391. return last;
  25392. }
  25393. // eliminate colinear or duplicate points
  25394. function filterPoints(start, end) {
  25395. if (!start) return start;
  25396. if (!end) end = start;
  25397. let p = start,
  25398. again;
  25399. do {
  25400. again = false;
  25401. if (!p.steiner && (equals(p, p.next) || area(p.prev, p, p.next) === 0)) {
  25402. removeNode(p);
  25403. p = end = p.prev;
  25404. if (p === p.next) break;
  25405. again = true;
  25406. } else {
  25407. p = p.next;
  25408. }
  25409. } while (again || p !== end);
  25410. return end;
  25411. }
  25412. // main ear slicing loop which triangulates a polygon (given as a linked list)
  25413. function earcutLinked(ear, triangles, dim, minX, minY, invSize, pass) {
  25414. if (!ear) return;
  25415. // interlink polygon nodes in z-order
  25416. if (!pass && invSize) indexCurve(ear, minX, minY, invSize);
  25417. let stop = ear;
  25418. // iterate through ears, slicing them one by one
  25419. while (ear.prev !== ear.next) {
  25420. const prev = ear.prev;
  25421. const next = ear.next;
  25422. if (invSize ? isEarHashed(ear, minX, minY, invSize) : isEar(ear)) {
  25423. triangles.push(prev.i, ear.i, next.i); // cut off the triangle
  25424. removeNode(ear);
  25425. // skipping the next vertex leads to less sliver triangles
  25426. ear = next.next;
  25427. stop = next.next;
  25428. continue;
  25429. }
  25430. ear = next;
  25431. // if we looped through the whole remaining polygon and can't find any more ears
  25432. if (ear === stop) {
  25433. // try filtering points and slicing again
  25434. if (!pass) {
  25435. earcutLinked(filterPoints(ear), triangles, dim, minX, minY, invSize, 1);
  25436. // if this didn't work, try curing all small self-intersections locally
  25437. } else if (pass === 1) {
  25438. ear = cureLocalIntersections(filterPoints(ear), triangles);
  25439. earcutLinked(ear, triangles, dim, minX, minY, invSize, 2);
  25440. // as a last resort, try splitting the remaining polygon into two
  25441. } else if (pass === 2) {
  25442. splitEarcut(ear, triangles, dim, minX, minY, invSize);
  25443. }
  25444. break;
  25445. }
  25446. }
  25447. }
  25448. // check whether a polygon node forms a valid ear with adjacent nodes
  25449. function isEar(ear) {
  25450. const a = ear.prev,
  25451. b = ear,
  25452. c = ear.next;
  25453. if (area(a, b, c) >= 0) return false; // reflex, can't be an ear
  25454. // now make sure we don't have other points inside the potential ear
  25455. const ax = a.x, bx = b.x, cx = c.x, ay = a.y, by = b.y, cy = c.y;
  25456. // triangle bbox
  25457. const x0 = Math.min(ax, bx, cx),
  25458. y0 = Math.min(ay, by, cy),
  25459. x1 = Math.max(ax, bx, cx),
  25460. y1 = Math.max(ay, by, cy);
  25461. let p = c.next;
  25462. while (p !== a) {
  25463. if (p.x >= x0 && p.x <= x1 && p.y >= y0 && p.y <= y1 &&
  25464. pointInTriangleExceptFirst(ax, ay, bx, by, cx, cy, p.x, p.y) &&
  25465. area(p.prev, p, p.next) >= 0) return false;
  25466. p = p.next;
  25467. }
  25468. return true;
  25469. }
  25470. function isEarHashed(ear, minX, minY, invSize) {
  25471. const a = ear.prev,
  25472. b = ear,
  25473. c = ear.next;
  25474. if (area(a, b, c) >= 0) return false; // reflex, can't be an ear
  25475. const ax = a.x, bx = b.x, cx = c.x, ay = a.y, by = b.y, cy = c.y;
  25476. // triangle bbox
  25477. const x0 = Math.min(ax, bx, cx),
  25478. y0 = Math.min(ay, by, cy),
  25479. x1 = Math.max(ax, bx, cx),
  25480. y1 = Math.max(ay, by, cy);
  25481. // z-order range for the current triangle bbox;
  25482. const minZ = zOrder(x0, y0, minX, minY, invSize),
  25483. maxZ = zOrder(x1, y1, minX, minY, invSize);
  25484. let p = ear.prevZ,
  25485. n = ear.nextZ;
  25486. // look for points inside the triangle in both directions
  25487. while (p && p.z >= minZ && n && n.z <= maxZ) {
  25488. if (p.x >= x0 && p.x <= x1 && p.y >= y0 && p.y <= y1 && p !== a && p !== c &&
  25489. pointInTriangleExceptFirst(ax, ay, bx, by, cx, cy, p.x, p.y) && area(p.prev, p, p.next) >= 0) return false;
  25490. p = p.prevZ;
  25491. if (n.x >= x0 && n.x <= x1 && n.y >= y0 && n.y <= y1 && n !== a && n !== c &&
  25492. pointInTriangleExceptFirst(ax, ay, bx, by, cx, cy, n.x, n.y) && area(n.prev, n, n.next) >= 0) return false;
  25493. n = n.nextZ;
  25494. }
  25495. // look for remaining points in decreasing z-order
  25496. while (p && p.z >= minZ) {
  25497. if (p.x >= x0 && p.x <= x1 && p.y >= y0 && p.y <= y1 && p !== a && p !== c &&
  25498. pointInTriangleExceptFirst(ax, ay, bx, by, cx, cy, p.x, p.y) && area(p.prev, p, p.next) >= 0) return false;
  25499. p = p.prevZ;
  25500. }
  25501. // look for remaining points in increasing z-order
  25502. while (n && n.z <= maxZ) {
  25503. if (n.x >= x0 && n.x <= x1 && n.y >= y0 && n.y <= y1 && n !== a && n !== c &&
  25504. pointInTriangleExceptFirst(ax, ay, bx, by, cx, cy, n.x, n.y) && area(n.prev, n, n.next) >= 0) return false;
  25505. n = n.nextZ;
  25506. }
  25507. return true;
  25508. }
  25509. // go through all polygon nodes and cure small local self-intersections
  25510. function cureLocalIntersections(start, triangles) {
  25511. let p = start;
  25512. do {
  25513. const a = p.prev,
  25514. b = p.next.next;
  25515. if (!equals(a, b) && intersects(a, p, p.next, b) && locallyInside(a, b) && locallyInside(b, a)) {
  25516. triangles.push(a.i, p.i, b.i);
  25517. // remove two nodes involved
  25518. removeNode(p);
  25519. removeNode(p.next);
  25520. p = start = b;
  25521. }
  25522. p = p.next;
  25523. } while (p !== start);
  25524. return filterPoints(p);
  25525. }
  25526. // try splitting polygon into two and triangulate them independently
  25527. function splitEarcut(start, triangles, dim, minX, minY, invSize) {
  25528. // look for a valid diagonal that divides the polygon into two
  25529. let a = start;
  25530. do {
  25531. let b = a.next.next;
  25532. while (b !== a.prev) {
  25533. if (a.i !== b.i && isValidDiagonal(a, b)) {
  25534. // split the polygon in two by the diagonal
  25535. let c = splitPolygon(a, b);
  25536. // filter colinear points around the cuts
  25537. a = filterPoints(a, a.next);
  25538. c = filterPoints(c, c.next);
  25539. // run earcut on each half
  25540. earcutLinked(a, triangles, dim, minX, minY, invSize, 0);
  25541. earcutLinked(c, triangles, dim, minX, minY, invSize, 0);
  25542. return;
  25543. }
  25544. b = b.next;
  25545. }
  25546. a = a.next;
  25547. } while (a !== start);
  25548. }
  25549. // link every hole into the outer loop, producing a single-ring polygon without holes
  25550. function eliminateHoles(data, holeIndices, outerNode, dim) {
  25551. const queue = [];
  25552. for (let i = 0, len = holeIndices.length; i < len; i++) {
  25553. const start = holeIndices[i] * dim;
  25554. const end = i < len - 1 ? holeIndices[i + 1] * dim : data.length;
  25555. const list = linkedList(data, start, end, dim, false);
  25556. if (list === list.next) list.steiner = true;
  25557. queue.push(getLeftmost(list));
  25558. }
  25559. queue.sort(compareXYSlope);
  25560. // process holes from left to right
  25561. for (let i = 0; i < queue.length; i++) {
  25562. outerNode = eliminateHole(queue[i], outerNode);
  25563. }
  25564. return outerNode;
  25565. }
  25566. function compareXYSlope(a, b) {
  25567. let result = a.x - b.x;
  25568. // when the left-most point of 2 holes meet at a vertex, sort the holes counterclockwise so that when we find
  25569. // the bridge to the outer shell is always the point that they meet at.
  25570. if (result === 0) {
  25571. result = a.y - b.y;
  25572. if (result === 0) {
  25573. const aSlope = (a.next.y - a.y) / (a.next.x - a.x);
  25574. const bSlope = (b.next.y - b.y) / (b.next.x - b.x);
  25575. result = aSlope - bSlope;
  25576. }
  25577. }
  25578. return result;
  25579. }
  25580. // find a bridge between vertices that connects hole with an outer ring and link it
  25581. function eliminateHole(hole, outerNode) {
  25582. const bridge = findHoleBridge(hole, outerNode);
  25583. if (!bridge) {
  25584. return outerNode;
  25585. }
  25586. const bridgeReverse = splitPolygon(bridge, hole);
  25587. // filter collinear points around the cuts
  25588. filterPoints(bridgeReverse, bridgeReverse.next);
  25589. return filterPoints(bridge, bridge.next);
  25590. }
  25591. // David Eberly's algorithm for finding a bridge between hole and outer polygon
  25592. function findHoleBridge(hole, outerNode) {
  25593. let p = outerNode;
  25594. const hx = hole.x;
  25595. const hy = hole.y;
  25596. let qx = -Infinity;
  25597. let m;
  25598. // find a segment intersected by a ray from the hole's leftmost point to the left;
  25599. // segment's endpoint with lesser x will be potential connection point
  25600. // unless they intersect at a vertex, then choose the vertex
  25601. if (equals(hole, p)) return p;
  25602. do {
  25603. if (equals(hole, p.next)) return p.next;
  25604. else if (hy <= p.y && hy >= p.next.y && p.next.y !== p.y) {
  25605. const x = p.x + (hy - p.y) * (p.next.x - p.x) / (p.next.y - p.y);
  25606. if (x <= hx && x > qx) {
  25607. qx = x;
  25608. m = p.x < p.next.x ? p : p.next;
  25609. if (x === hx) return m; // hole touches outer segment; pick leftmost endpoint
  25610. }
  25611. }
  25612. p = p.next;
  25613. } while (p !== outerNode);
  25614. if (!m) return null;
  25615. // look for points inside the triangle of hole point, segment intersection and endpoint;
  25616. // if there are no points found, we have a valid connection;
  25617. // otherwise choose the point of the minimum angle with the ray as connection point
  25618. const stop = m;
  25619. const mx = m.x;
  25620. const my = m.y;
  25621. let tanMin = Infinity;
  25622. p = m;
  25623. do {
  25624. if (hx >= p.x && p.x >= mx && hx !== p.x &&
  25625. pointInTriangle(hy < my ? hx : qx, hy, mx, my, hy < my ? qx : hx, hy, p.x, p.y)) {
  25626. const tan = Math.abs(hy - p.y) / (hx - p.x); // tangential
  25627. if (locallyInside(p, hole) &&
  25628. (tan < tanMin || (tan === tanMin && (p.x > m.x || (p.x === m.x && sectorContainsSector(m, p)))))) {
  25629. m = p;
  25630. tanMin = tan;
  25631. }
  25632. }
  25633. p = p.next;
  25634. } while (p !== stop);
  25635. return m;
  25636. }
  25637. // whether sector in vertex m contains sector in vertex p in the same coordinates
  25638. function sectorContainsSector(m, p) {
  25639. return area(m.prev, m, p.prev) < 0 && area(p.next, m, m.next) < 0;
  25640. }
  25641. // interlink polygon nodes in z-order
  25642. function indexCurve(start, minX, minY, invSize) {
  25643. let p = start;
  25644. do {
  25645. if (p.z === 0) p.z = zOrder(p.x, p.y, minX, minY, invSize);
  25646. p.prevZ = p.prev;
  25647. p.nextZ = p.next;
  25648. p = p.next;
  25649. } while (p !== start);
  25650. p.prevZ.nextZ = null;
  25651. p.prevZ = null;
  25652. sortLinked(p);
  25653. }
  25654. // Simon Tatham's linked list merge sort algorithm
  25655. // http://www.chiark.greenend.org.uk/~sgtatham/algorithms/listsort.html
  25656. function sortLinked(list) {
  25657. let numMerges;
  25658. let inSize = 1;
  25659. do {
  25660. let p = list;
  25661. let e;
  25662. list = null;
  25663. let tail = null;
  25664. numMerges = 0;
  25665. while (p) {
  25666. numMerges++;
  25667. let q = p;
  25668. let pSize = 0;
  25669. for (let i = 0; i < inSize; i++) {
  25670. pSize++;
  25671. q = q.nextZ;
  25672. if (!q) break;
  25673. }
  25674. let qSize = inSize;
  25675. while (pSize > 0 || (qSize > 0 && q)) {
  25676. if (pSize !== 0 && (qSize === 0 || !q || p.z <= q.z)) {
  25677. e = p;
  25678. p = p.nextZ;
  25679. pSize--;
  25680. } else {
  25681. e = q;
  25682. q = q.nextZ;
  25683. qSize--;
  25684. }
  25685. if (tail) tail.nextZ = e;
  25686. else list = e;
  25687. e.prevZ = tail;
  25688. tail = e;
  25689. }
  25690. p = q;
  25691. }
  25692. tail.nextZ = null;
  25693. inSize *= 2;
  25694. } while (numMerges > 1);
  25695. return list;
  25696. }
  25697. // z-order of a point given coords and inverse of the longer side of data bbox
  25698. function zOrder(x, y, minX, minY, invSize) {
  25699. // coords are transformed into non-negative 15-bit integer range
  25700. x = (x - minX) * invSize | 0;
  25701. y = (y - minY) * invSize | 0;
  25702. x = (x | (x << 8)) & 0x00FF00FF;
  25703. x = (x | (x << 4)) & 0x0F0F0F0F;
  25704. x = (x | (x << 2)) & 0x33333333;
  25705. x = (x | (x << 1)) & 0x55555555;
  25706. y = (y | (y << 8)) & 0x00FF00FF;
  25707. y = (y | (y << 4)) & 0x0F0F0F0F;
  25708. y = (y | (y << 2)) & 0x33333333;
  25709. y = (y | (y << 1)) & 0x55555555;
  25710. return x | (y << 1);
  25711. }
  25712. // find the leftmost node of a polygon ring
  25713. function getLeftmost(start) {
  25714. let p = start,
  25715. leftmost = start;
  25716. do {
  25717. if (p.x < leftmost.x || (p.x === leftmost.x && p.y < leftmost.y)) leftmost = p;
  25718. p = p.next;
  25719. } while (p !== start);
  25720. return leftmost;
  25721. }
  25722. // check if a point lies within a convex triangle
  25723. function pointInTriangle(ax, ay, bx, by, cx, cy, px, py) {
  25724. return (cx - px) * (ay - py) >= (ax - px) * (cy - py) &&
  25725. (ax - px) * (by - py) >= (bx - px) * (ay - py) &&
  25726. (bx - px) * (cy - py) >= (cx - px) * (by - py);
  25727. }
  25728. // check if a point lies within a convex triangle but false if its equal to the first point of the triangle
  25729. function pointInTriangleExceptFirst(ax, ay, bx, by, cx, cy, px, py) {
  25730. return !(ax === px && ay === py) && pointInTriangle(ax, ay, bx, by, cx, cy, px, py);
  25731. }
  25732. // check if a diagonal between two polygon nodes is valid (lies in polygon interior)
  25733. function isValidDiagonal(a, b) {
  25734. return a.next.i !== b.i && a.prev.i !== b.i && !intersectsPolygon(a, b) && // doesn't intersect other edges
  25735. (locallyInside(a, b) && locallyInside(b, a) && middleInside(a, b) && // locally visible
  25736. (area(a.prev, a, b.prev) || area(a, b.prev, b)) || // does not create opposite-facing sectors
  25737. equals(a, b) && area(a.prev, a, a.next) > 0 && area(b.prev, b, b.next) > 0); // special zero-length case
  25738. }
  25739. // signed area of a triangle
  25740. function area(p, q, r) {
  25741. return (q.y - p.y) * (r.x - q.x) - (q.x - p.x) * (r.y - q.y);
  25742. }
  25743. // check if two points are equal
  25744. function equals(p1, p2) {
  25745. return p1.x === p2.x && p1.y === p2.y;
  25746. }
  25747. // check if two segments intersect
  25748. function intersects(p1, q1, p2, q2) {
  25749. const o1 = sign(area(p1, q1, p2));
  25750. const o2 = sign(area(p1, q1, q2));
  25751. const o3 = sign(area(p2, q2, p1));
  25752. const o4 = sign(area(p2, q2, q1));
  25753. if (o1 !== o2 && o3 !== o4) return true; // general case
  25754. if (o1 === 0 && onSegment(p1, p2, q1)) return true; // p1, q1 and p2 are collinear and p2 lies on p1q1
  25755. if (o2 === 0 && onSegment(p1, q2, q1)) return true; // p1, q1 and q2 are collinear and q2 lies on p1q1
  25756. if (o3 === 0 && onSegment(p2, p1, q2)) return true; // p2, q2 and p1 are collinear and p1 lies on p2q2
  25757. if (o4 === 0 && onSegment(p2, q1, q2)) return true; // p2, q2 and q1 are collinear and q1 lies on p2q2
  25758. return false;
  25759. }
  25760. // for collinear points p, q, r, check if point q lies on segment pr
  25761. function onSegment(p, q, r) {
  25762. 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);
  25763. }
  25764. function sign(num) {
  25765. return num > 0 ? 1 : num < 0 ? -1 : 0;
  25766. }
  25767. // check if a polygon diagonal intersects any polygon segments
  25768. function intersectsPolygon(a, b) {
  25769. let p = a;
  25770. do {
  25771. if (p.i !== a.i && p.next.i !== a.i && p.i !== b.i && p.next.i !== b.i &&
  25772. intersects(p, p.next, a, b)) return true;
  25773. p = p.next;
  25774. } while (p !== a);
  25775. return false;
  25776. }
  25777. // check if a polygon diagonal is locally inside the polygon
  25778. function locallyInside(a, b) {
  25779. return area(a.prev, a, a.next) < 0 ?
  25780. area(a, b, a.next) >= 0 && area(a, a.prev, b) >= 0 :
  25781. area(a, b, a.prev) < 0 || area(a, a.next, b) < 0;
  25782. }
  25783. // check if the middle point of a polygon diagonal is inside the polygon
  25784. function middleInside(a, b) {
  25785. let p = a;
  25786. let inside = false;
  25787. const px = (a.x + b.x) / 2;
  25788. const py = (a.y + b.y) / 2;
  25789. do {
  25790. if (((p.y > py) !== (p.next.y > py)) && p.next.y !== p.y &&
  25791. (px < (p.next.x - p.x) * (py - p.y) / (p.next.y - p.y) + p.x))
  25792. inside = !inside;
  25793. p = p.next;
  25794. } while (p !== a);
  25795. return inside;
  25796. }
  25797. // link two polygon vertices with a bridge; if the vertices belong to the same ring, it splits polygon into two;
  25798. // if one belongs to the outer ring and another to a hole, it merges it into a single ring
  25799. function splitPolygon(a, b) {
  25800. const a2 = createNode(a.i, a.x, a.y),
  25801. b2 = createNode(b.i, b.x, b.y),
  25802. an = a.next,
  25803. bp = b.prev;
  25804. a.next = b;
  25805. b.prev = a;
  25806. a2.next = an;
  25807. an.prev = a2;
  25808. b2.next = a2;
  25809. a2.prev = b2;
  25810. bp.next = b2;
  25811. b2.prev = bp;
  25812. return b2;
  25813. }
  25814. // create a node and optionally link it with previous one (in a circular doubly linked list)
  25815. function insertNode(i, x, y, last) {
  25816. const p = createNode(i, x, y);
  25817. if (!last) {
  25818. p.prev = p;
  25819. p.next = p;
  25820. } else {
  25821. p.next = last.next;
  25822. p.prev = last;
  25823. last.next.prev = p;
  25824. last.next = p;
  25825. }
  25826. return p;
  25827. }
  25828. function removeNode(p) {
  25829. p.next.prev = p.prev;
  25830. p.prev.next = p.next;
  25831. if (p.prevZ) p.prevZ.nextZ = p.nextZ;
  25832. if (p.nextZ) p.nextZ.prevZ = p.prevZ;
  25833. }
  25834. function createNode(i, x, y) {
  25835. return {
  25836. i, // vertex index in coordinates array
  25837. x, y, // vertex coordinates
  25838. prev: null, // previous and next vertex nodes in a polygon ring
  25839. next: null,
  25840. z: 0, // z-order curve value
  25841. prevZ: null, // previous and next nodes in z-order
  25842. nextZ: null,
  25843. steiner: false // indicates whether this is a steiner point
  25844. };
  25845. }
  25846. function signedArea(data, start, end, dim) {
  25847. let sum = 0;
  25848. for (let i = start, j = end - dim; i < end; i += dim) {
  25849. sum += (data[j] - data[i]) * (data[i + 1] + data[j + 1]);
  25850. j = i;
  25851. }
  25852. return sum;
  25853. }
  25854. /**
  25855. * An implementation of the earcut polygon triangulation algorithm.
  25856. * The code is a port of [mapbox/earcut](https://github.com/mapbox/earcut).
  25857. *
  25858. * @see https://github.com/mapbox/earcut
  25859. */
  25860. class Earcut {
  25861. /**
  25862. * Triangulates the given shape definition by returning an array of triangles.
  25863. *
  25864. * @param {Array<number>} data - An array with 2D points.
  25865. * @param {Array<number>} holeIndices - An array with indices defining holes.
  25866. * @param {number} [dim=2] - The number of coordinates per vertex in the input array.
  25867. * @return {Array<number>} An array representing the triangulated faces. Each face is defined by three consecutive numbers
  25868. * representing vertex indices.
  25869. */
  25870. static triangulate( data, holeIndices, dim = 2 ) {
  25871. return earcut( data, holeIndices, dim );
  25872. }
  25873. }
  25874. /**
  25875. * A class containing utility functions for shapes.
  25876. *
  25877. * @hideconstructor
  25878. */
  25879. class ShapeUtils {
  25880. /**
  25881. * Calculate area of a ( 2D ) contour polygon.
  25882. *
  25883. * @param {Array<Vector2>} contour - An array of 2D points.
  25884. * @return {number} The area.
  25885. */
  25886. static area( contour ) {
  25887. const n = contour.length;
  25888. let a = 0.0;
  25889. for ( let p = n - 1, q = 0; q < n; p = q ++ ) {
  25890. a += contour[ p ].x * contour[ q ].y - contour[ q ].x * contour[ p ].y;
  25891. }
  25892. return a * 0.5;
  25893. }
  25894. /**
  25895. * Returns `true` if the given contour uses a clockwise winding order.
  25896. *
  25897. * @param {Array<Vector2>} pts - An array of 2D points defining a polygon.
  25898. * @return {boolean} Whether the given contour uses a clockwise winding order or not.
  25899. */
  25900. static isClockWise( pts ) {
  25901. return ShapeUtils.area( pts ) < 0;
  25902. }
  25903. /**
  25904. * Triangulates the given shape definition.
  25905. *
  25906. * @param {Array<Vector2>} contour - An array of 2D points defining the contour.
  25907. * @param {Array<Array<Vector2>>} holes - An array that holds arrays of 2D points defining the holes.
  25908. * @return {Array<Array<number>>} An array that holds for each face definition an array with three indices.
  25909. */
  25910. static triangulateShape( contour, holes ) {
  25911. const vertices = []; // flat array of vertices like [ x0,y0, x1,y1, x2,y2, ... ]
  25912. const holeIndices = []; // array of hole indices
  25913. const faces = []; // final array of vertex indices like [ [ a,b,d ], [ b,c,d ] ]
  25914. removeDupEndPts( contour );
  25915. addContour( vertices, contour );
  25916. //
  25917. let holeIndex = contour.length;
  25918. holes.forEach( removeDupEndPts );
  25919. for ( let i = 0; i < holes.length; i ++ ) {
  25920. holeIndices.push( holeIndex );
  25921. holeIndex += holes[ i ].length;
  25922. addContour( vertices, holes[ i ] );
  25923. }
  25924. //
  25925. const triangles = Earcut.triangulate( vertices, holeIndices );
  25926. //
  25927. for ( let i = 0; i < triangles.length; i += 3 ) {
  25928. faces.push( triangles.slice( i, i + 3 ) );
  25929. }
  25930. return faces;
  25931. }
  25932. }
  25933. function removeDupEndPts( points ) {
  25934. const l = points.length;
  25935. if ( l > 2 && points[ l - 1 ].equals( points[ 0 ] ) ) {
  25936. points.pop();
  25937. }
  25938. }
  25939. function addContour( vertices, contour ) {
  25940. for ( let i = 0; i < contour.length; i ++ ) {
  25941. vertices.push( contour[ i ].x );
  25942. vertices.push( contour[ i ].y );
  25943. }
  25944. }
  25945. /**
  25946. * Creates extruded geometry from a path shape.
  25947. *
  25948. * ```js
  25949. * const length = 12, width = 8;
  25950. *
  25951. * const shape = new THREE.Shape();
  25952. * shape.moveTo( 0,0 );
  25953. * shape.lineTo( 0, width );
  25954. * shape.lineTo( length, width );
  25955. * shape.lineTo( length, 0 );
  25956. * shape.lineTo( 0, 0 );
  25957. *
  25958. * const geometry = new THREE.ExtrudeGeometry( shape );
  25959. * const material = new THREE.MeshBasicMaterial( { color: 0x00ff00 } );
  25960. * const mesh = new THREE.Mesh( geometry, material ) ;
  25961. * scene.add( mesh );
  25962. * ```
  25963. *
  25964. * @augments BufferGeometry
  25965. * @demo scenes/geometry-browser.html#ExtrudeGeometry
  25966. */
  25967. class ExtrudeGeometry extends BufferGeometry {
  25968. /**
  25969. * Constructs a new extrude geometry.
  25970. *
  25971. * @param {Shape|Array<Shape>} [shapes] - A shape or an array of shapes.
  25972. * @param {ExtrudeGeometry~Options} [options] - The extrude settings.
  25973. */
  25974. 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 = {} ) {
  25975. super();
  25976. this.type = 'ExtrudeGeometry';
  25977. /**
  25978. * Holds the constructor parameters that have been
  25979. * used to generate the geometry. Any modification
  25980. * after instantiation does not change the geometry.
  25981. *
  25982. * @type {Object}
  25983. */
  25984. this.parameters = {
  25985. shapes: shapes,
  25986. options: options
  25987. };
  25988. shapes = Array.isArray( shapes ) ? shapes : [ shapes ];
  25989. const scope = this;
  25990. const verticesArray = [];
  25991. const uvArray = [];
  25992. for ( let i = 0, l = shapes.length; i < l; i ++ ) {
  25993. const shape = shapes[ i ];
  25994. addShape( shape );
  25995. }
  25996. // build geometry
  25997. this.setAttribute( 'position', new Float32BufferAttribute( verticesArray, 3 ) );
  25998. this.setAttribute( 'uv', new Float32BufferAttribute( uvArray, 2 ) );
  25999. this.computeVertexNormals();
  26000. // functions
  26001. function addShape( shape ) {
  26002. const placeholder = [];
  26003. // options
  26004. const curveSegments = options.curveSegments !== undefined ? options.curveSegments : 12;
  26005. const steps = options.steps !== undefined ? options.steps : 1;
  26006. const depth = options.depth !== undefined ? options.depth : 1;
  26007. let bevelEnabled = options.bevelEnabled !== undefined ? options.bevelEnabled : true;
  26008. let bevelThickness = options.bevelThickness !== undefined ? options.bevelThickness : 0.2;
  26009. let bevelSize = options.bevelSize !== undefined ? options.bevelSize : bevelThickness - 0.1;
  26010. let bevelOffset = options.bevelOffset !== undefined ? options.bevelOffset : 0;
  26011. let bevelSegments = options.bevelSegments !== undefined ? options.bevelSegments : 3;
  26012. const extrudePath = options.extrudePath;
  26013. const uvgen = options.UVGenerator !== undefined ? options.UVGenerator : WorldUVGenerator;
  26014. //
  26015. let extrudePts, extrudeByPath = false;
  26016. let splineTube, binormal, normal, position2;
  26017. if ( extrudePath ) {
  26018. extrudePts = extrudePath.getSpacedPoints( steps );
  26019. extrudeByPath = true;
  26020. bevelEnabled = false; // bevels not supported for path extrusion
  26021. // SETUP TNB variables
  26022. const isClosed = extrudePath.isCatmullRomCurve3 ? extrudePath.closed : false;
  26023. splineTube = extrudePath.computeFrenetFrames( steps, isClosed );
  26024. // log(splineTube, 'splineTube', splineTube.normals.length, 'steps', steps, 'extrudePts', extrudePts.length);
  26025. binormal = new Vector3();
  26026. normal = new Vector3();
  26027. position2 = new Vector3();
  26028. }
  26029. // Safeguards if bevels are not enabled
  26030. if ( ! bevelEnabled ) {
  26031. bevelSegments = 0;
  26032. bevelThickness = 0;
  26033. bevelSize = 0;
  26034. bevelOffset = 0;
  26035. }
  26036. // Variables initialization
  26037. const shapePoints = shape.extractPoints( curveSegments );
  26038. let vertices = shapePoints.shape;
  26039. const holes = shapePoints.holes;
  26040. const reverse = ! ShapeUtils.isClockWise( vertices );
  26041. if ( reverse ) {
  26042. vertices = vertices.reverse();
  26043. // Maybe we should also check if holes are in the opposite direction, just to be safe ...
  26044. for ( let h = 0, hl = holes.length; h < hl; h ++ ) {
  26045. const ahole = holes[ h ];
  26046. if ( ShapeUtils.isClockWise( ahole ) ) {
  26047. holes[ h ] = ahole.reverse();
  26048. }
  26049. }
  26050. }
  26051. /**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.
  26052. * @param {Array<Vector2>} points
  26053. */
  26054. function mergeOverlappingPoints( points ) {
  26055. const THRESHOLD = 1e-10;
  26056. const THRESHOLD_SQ = THRESHOLD * THRESHOLD;
  26057. let prevPos = points[ 0 ];
  26058. for ( let i = 1; i <= points.length; i ++ ) {
  26059. const currentIndex = i % points.length;
  26060. const currentPos = points[ currentIndex ];
  26061. const dx = currentPos.x - prevPos.x;
  26062. const dy = currentPos.y - prevPos.y;
  26063. const distSq = dx * dx + dy * dy;
  26064. const scalingFactorSqrt = Math.max(
  26065. Math.abs( currentPos.x ),
  26066. Math.abs( currentPos.y ),
  26067. Math.abs( prevPos.x ),
  26068. Math.abs( prevPos.y )
  26069. );
  26070. const thresholdSqScaled = THRESHOLD_SQ * scalingFactorSqrt * scalingFactorSqrt;
  26071. if ( distSq <= thresholdSqScaled ) {
  26072. points.splice( currentIndex, 1 );
  26073. i --;
  26074. continue;
  26075. }
  26076. prevPos = currentPos;
  26077. }
  26078. }
  26079. mergeOverlappingPoints( vertices );
  26080. holes.forEach( mergeOverlappingPoints );
  26081. const numHoles = holes.length;
  26082. /* Vertices */
  26083. const contour = vertices; // vertices has all points but contour has only points of circumference
  26084. for ( let h = 0; h < numHoles; h ++ ) {
  26085. const ahole = holes[ h ];
  26086. vertices = vertices.concat( ahole );
  26087. }
  26088. function scalePt2( pt, vec, size ) {
  26089. if ( ! vec ) error( 'ExtrudeGeometry: vec does not exist' );
  26090. return pt.clone().addScaledVector( vec, size );
  26091. }
  26092. const vlen = vertices.length;
  26093. // Find directions for point movement
  26094. function getBevelVec( inPt, inPrev, inNext ) {
  26095. // computes for inPt the corresponding point inPt' on a new contour
  26096. // shifted by 1 unit (length of normalized vector) to the left
  26097. // if we walk along contour clockwise, this new contour is outside the old one
  26098. //
  26099. // inPt' is the intersection of the two lines parallel to the two
  26100. // adjacent edges of inPt at a distance of 1 unit on the left side.
  26101. let v_trans_x, v_trans_y, shrink_by; // resulting translation vector for inPt
  26102. // good reading for geometry algorithms (here: line-line intersection)
  26103. // http://geomalgorithms.com/a05-_intersect-1.html
  26104. const v_prev_x = inPt.x - inPrev.x,
  26105. v_prev_y = inPt.y - inPrev.y;
  26106. const v_next_x = inNext.x - inPt.x,
  26107. v_next_y = inNext.y - inPt.y;
  26108. const v_prev_lensq = ( v_prev_x * v_prev_x + v_prev_y * v_prev_y );
  26109. // check for collinear edges
  26110. const collinear0 = ( v_prev_x * v_next_y - v_prev_y * v_next_x );
  26111. if ( Math.abs( collinear0 ) > Number.EPSILON ) {
  26112. // not collinear
  26113. // length of vectors for normalizing
  26114. const v_prev_len = Math.sqrt( v_prev_lensq );
  26115. const v_next_len = Math.sqrt( v_next_x * v_next_x + v_next_y * v_next_y );
  26116. // shift adjacent points by unit vectors to the left
  26117. const ptPrevShift_x = ( inPrev.x - v_prev_y / v_prev_len );
  26118. const ptPrevShift_y = ( inPrev.y + v_prev_x / v_prev_len );
  26119. const ptNextShift_x = ( inNext.x - v_next_y / v_next_len );
  26120. const ptNextShift_y = ( inNext.y + v_next_x / v_next_len );
  26121. // scaling factor for v_prev to intersection point
  26122. const sf = ( ( ptNextShift_x - ptPrevShift_x ) * v_next_y -
  26123. ( ptNextShift_y - ptPrevShift_y ) * v_next_x ) /
  26124. ( v_prev_x * v_next_y - v_prev_y * v_next_x );
  26125. // vector from inPt to intersection point
  26126. v_trans_x = ( ptPrevShift_x + v_prev_x * sf - inPt.x );
  26127. v_trans_y = ( ptPrevShift_y + v_prev_y * sf - inPt.y );
  26128. // Don't normalize!, otherwise sharp corners become ugly
  26129. // but prevent crazy spikes
  26130. const v_trans_lensq = ( v_trans_x * v_trans_x + v_trans_y * v_trans_y );
  26131. if ( v_trans_lensq <= 2 ) {
  26132. return new Vector2( v_trans_x, v_trans_y );
  26133. } else {
  26134. shrink_by = Math.sqrt( v_trans_lensq / 2 );
  26135. }
  26136. } else {
  26137. // handle special case of collinear edges
  26138. let direction_eq = false; // assumes: opposite
  26139. if ( v_prev_x > Number.EPSILON ) {
  26140. if ( v_next_x > Number.EPSILON ) {
  26141. direction_eq = true;
  26142. }
  26143. } else {
  26144. if ( v_prev_x < - Number.EPSILON ) {
  26145. if ( v_next_x < - Number.EPSILON ) {
  26146. direction_eq = true;
  26147. }
  26148. } else {
  26149. if ( Math.sign( v_prev_y ) === Math.sign( v_next_y ) ) {
  26150. direction_eq = true;
  26151. }
  26152. }
  26153. }
  26154. if ( direction_eq ) {
  26155. // log("Warning: lines are a straight sequence");
  26156. v_trans_x = - v_prev_y;
  26157. v_trans_y = v_prev_x;
  26158. shrink_by = Math.sqrt( v_prev_lensq );
  26159. } else {
  26160. // log("Warning: lines are a straight spike");
  26161. v_trans_x = v_prev_x;
  26162. v_trans_y = v_prev_y;
  26163. shrink_by = Math.sqrt( v_prev_lensq / 2 );
  26164. }
  26165. }
  26166. return new Vector2( v_trans_x / shrink_by, v_trans_y / shrink_by );
  26167. }
  26168. const contourMovements = [];
  26169. for ( let i = 0, il = contour.length, j = il - 1, k = i + 1; i < il; i ++, j ++, k ++ ) {
  26170. if ( j === il ) j = 0;
  26171. if ( k === il ) k = 0;
  26172. // (j)---(i)---(k)
  26173. // log('i,j,k', i, j , k)
  26174. contourMovements[ i ] = getBevelVec( contour[ i ], contour[ j ], contour[ k ] );
  26175. }
  26176. const holesMovements = [];
  26177. let oneHoleMovements, verticesMovements = contourMovements.concat();
  26178. for ( let h = 0, hl = numHoles; h < hl; h ++ ) {
  26179. const ahole = holes[ h ];
  26180. oneHoleMovements = [];
  26181. for ( let i = 0, il = ahole.length, j = il - 1, k = i + 1; i < il; i ++, j ++, k ++ ) {
  26182. if ( j === il ) j = 0;
  26183. if ( k === il ) k = 0;
  26184. // (j)---(i)---(k)
  26185. oneHoleMovements[ i ] = getBevelVec( ahole[ i ], ahole[ j ], ahole[ k ] );
  26186. }
  26187. holesMovements.push( oneHoleMovements );
  26188. verticesMovements = verticesMovements.concat( oneHoleMovements );
  26189. }
  26190. let faces;
  26191. if ( bevelSegments === 0 ) {
  26192. faces = ShapeUtils.triangulateShape( contour, holes );
  26193. } else {
  26194. const contractedContourVertices = [];
  26195. const expandedHoleVertices = [];
  26196. // Loop bevelSegments, 1 for the front, 1 for the back
  26197. for ( let b = 0; b < bevelSegments; b ++ ) {
  26198. //for ( b = bevelSegments; b > 0; b -- ) {
  26199. const t = b / bevelSegments;
  26200. const z = bevelThickness * Math.cos( t * Math.PI / 2 );
  26201. const bs = bevelSize * Math.sin( t * Math.PI / 2 ) + bevelOffset;
  26202. // contract shape
  26203. for ( let i = 0, il = contour.length; i < il; i ++ ) {
  26204. const vert = scalePt2( contour[ i ], contourMovements[ i ], bs );
  26205. v( vert.x, vert.y, - z );
  26206. if ( t === 0 ) contractedContourVertices.push( vert );
  26207. }
  26208. // expand holes
  26209. for ( let h = 0, hl = numHoles; h < hl; h ++ ) {
  26210. const ahole = holes[ h ];
  26211. oneHoleMovements = holesMovements[ h ];
  26212. const oneHoleVertices = [];
  26213. for ( let i = 0, il = ahole.length; i < il; i ++ ) {
  26214. const vert = scalePt2( ahole[ i ], oneHoleMovements[ i ], bs );
  26215. v( vert.x, vert.y, - z );
  26216. if ( t === 0 ) oneHoleVertices.push( vert );
  26217. }
  26218. if ( t === 0 ) expandedHoleVertices.push( oneHoleVertices );
  26219. }
  26220. }
  26221. faces = ShapeUtils.triangulateShape( contractedContourVertices, expandedHoleVertices );
  26222. }
  26223. const flen = faces.length;
  26224. const bs = bevelSize + bevelOffset;
  26225. // Back facing vertices
  26226. for ( let i = 0; i < vlen; i ++ ) {
  26227. const vert = bevelEnabled ? scalePt2( vertices[ i ], verticesMovements[ i ], bs ) : vertices[ i ];
  26228. if ( ! extrudeByPath ) {
  26229. v( vert.x, vert.y, 0 );
  26230. } else {
  26231. // v( vert.x, vert.y + extrudePts[ 0 ].y, extrudePts[ 0 ].x );
  26232. normal.copy( splineTube.normals[ 0 ] ).multiplyScalar( vert.x );
  26233. binormal.copy( splineTube.binormals[ 0 ] ).multiplyScalar( vert.y );
  26234. position2.copy( extrudePts[ 0 ] ).add( normal ).add( binormal );
  26235. v( position2.x, position2.y, position2.z );
  26236. }
  26237. }
  26238. // Add stepped vertices...
  26239. // Including front facing vertices
  26240. for ( let s = 1; s <= steps; s ++ ) {
  26241. for ( let i = 0; i < vlen; i ++ ) {
  26242. const vert = bevelEnabled ? scalePt2( vertices[ i ], verticesMovements[ i ], bs ) : vertices[ i ];
  26243. if ( ! extrudeByPath ) {
  26244. v( vert.x, vert.y, depth / steps * s );
  26245. } else {
  26246. // v( vert.x, vert.y + extrudePts[ s - 1 ].y, extrudePts[ s - 1 ].x );
  26247. normal.copy( splineTube.normals[ s ] ).multiplyScalar( vert.x );
  26248. binormal.copy( splineTube.binormals[ s ] ).multiplyScalar( vert.y );
  26249. position2.copy( extrudePts[ s ] ).add( normal ).add( binormal );
  26250. v( position2.x, position2.y, position2.z );
  26251. }
  26252. }
  26253. }
  26254. // Add bevel segments planes
  26255. //for ( b = 1; b <= bevelSegments; b ++ ) {
  26256. for ( let b = bevelSegments - 1; b >= 0; b -- ) {
  26257. const t = b / bevelSegments;
  26258. const z = bevelThickness * Math.cos( t * Math.PI / 2 );
  26259. const bs = bevelSize * Math.sin( t * Math.PI / 2 ) + bevelOffset;
  26260. // contract shape
  26261. for ( let i = 0, il = contour.length; i < il; i ++ ) {
  26262. const vert = scalePt2( contour[ i ], contourMovements[ i ], bs );
  26263. v( vert.x, vert.y, depth + z );
  26264. }
  26265. // expand holes
  26266. for ( let h = 0, hl = holes.length; h < hl; h ++ ) {
  26267. const ahole = holes[ h ];
  26268. oneHoleMovements = holesMovements[ h ];
  26269. for ( let i = 0, il = ahole.length; i < il; i ++ ) {
  26270. const vert = scalePt2( ahole[ i ], oneHoleMovements[ i ], bs );
  26271. if ( ! extrudeByPath ) {
  26272. v( vert.x, vert.y, depth + z );
  26273. } else {
  26274. v( vert.x, vert.y + extrudePts[ steps - 1 ].y, extrudePts[ steps - 1 ].x + z );
  26275. }
  26276. }
  26277. }
  26278. }
  26279. /* Faces */
  26280. // Top and bottom faces
  26281. buildLidFaces();
  26282. // Sides faces
  26283. buildSideFaces();
  26284. ///// Internal functions
  26285. function buildLidFaces() {
  26286. const start = verticesArray.length / 3;
  26287. if ( bevelEnabled ) {
  26288. let layer = 0; // steps + 1
  26289. let offset = vlen * layer;
  26290. // Bottom faces
  26291. for ( let i = 0; i < flen; i ++ ) {
  26292. const face = faces[ i ];
  26293. f3( face[ 2 ] + offset, face[ 1 ] + offset, face[ 0 ] + offset );
  26294. }
  26295. layer = steps + bevelSegments * 2;
  26296. offset = vlen * layer;
  26297. // Top faces
  26298. for ( let i = 0; i < flen; i ++ ) {
  26299. const face = faces[ i ];
  26300. f3( face[ 0 ] + offset, face[ 1 ] + offset, face[ 2 ] + offset );
  26301. }
  26302. } else {
  26303. // Bottom faces
  26304. for ( let i = 0; i < flen; i ++ ) {
  26305. const face = faces[ i ];
  26306. f3( face[ 2 ], face[ 1 ], face[ 0 ] );
  26307. }
  26308. // Top faces
  26309. for ( let i = 0; i < flen; i ++ ) {
  26310. const face = faces[ i ];
  26311. f3( face[ 0 ] + vlen * steps, face[ 1 ] + vlen * steps, face[ 2 ] + vlen * steps );
  26312. }
  26313. }
  26314. scope.addGroup( start, verticesArray.length / 3 - start, 0 );
  26315. }
  26316. // Create faces for the z-sides of the shape
  26317. function buildSideFaces() {
  26318. const start = verticesArray.length / 3;
  26319. let layeroffset = 0;
  26320. sidewalls( contour, layeroffset );
  26321. layeroffset += contour.length;
  26322. for ( let h = 0, hl = holes.length; h < hl; h ++ ) {
  26323. const ahole = holes[ h ];
  26324. sidewalls( ahole, layeroffset );
  26325. //, true
  26326. layeroffset += ahole.length;
  26327. }
  26328. scope.addGroup( start, verticesArray.length / 3 - start, 1 );
  26329. }
  26330. function sidewalls( contour, layeroffset ) {
  26331. let i = contour.length;
  26332. while ( -- i >= 0 ) {
  26333. const j = i;
  26334. let k = i - 1;
  26335. if ( k < 0 ) k = contour.length - 1;
  26336. //log('b', i,j, i-1, k,vertices.length);
  26337. for ( let s = 0, sl = ( steps + bevelSegments * 2 ); s < sl; s ++ ) {
  26338. const slen1 = vlen * s;
  26339. const slen2 = vlen * ( s + 1 );
  26340. const a = layeroffset + j + slen1,
  26341. b = layeroffset + k + slen1,
  26342. c = layeroffset + k + slen2,
  26343. d = layeroffset + j + slen2;
  26344. f4( a, b, c, d );
  26345. }
  26346. }
  26347. }
  26348. function v( x, y, z ) {
  26349. placeholder.push( x );
  26350. placeholder.push( y );
  26351. placeholder.push( z );
  26352. }
  26353. function f3( a, b, c ) {
  26354. addVertex( a );
  26355. addVertex( b );
  26356. addVertex( c );
  26357. const nextIndex = verticesArray.length / 3;
  26358. const uvs = uvgen.generateTopUV( scope, verticesArray, nextIndex - 3, nextIndex - 2, nextIndex - 1 );
  26359. addUV( uvs[ 0 ] );
  26360. addUV( uvs[ 1 ] );
  26361. addUV( uvs[ 2 ] );
  26362. }
  26363. function f4( a, b, c, d ) {
  26364. addVertex( a );
  26365. addVertex( b );
  26366. addVertex( d );
  26367. addVertex( b );
  26368. addVertex( c );
  26369. addVertex( d );
  26370. const nextIndex = verticesArray.length / 3;
  26371. const uvs = uvgen.generateSideWallUV( scope, verticesArray, nextIndex - 6, nextIndex - 3, nextIndex - 2, nextIndex - 1 );
  26372. addUV( uvs[ 0 ] );
  26373. addUV( uvs[ 1 ] );
  26374. addUV( uvs[ 3 ] );
  26375. addUV( uvs[ 1 ] );
  26376. addUV( uvs[ 2 ] );
  26377. addUV( uvs[ 3 ] );
  26378. }
  26379. function addVertex( index ) {
  26380. verticesArray.push( placeholder[ index * 3 + 0 ] );
  26381. verticesArray.push( placeholder[ index * 3 + 1 ] );
  26382. verticesArray.push( placeholder[ index * 3 + 2 ] );
  26383. }
  26384. function addUV( vector2 ) {
  26385. uvArray.push( vector2.x );
  26386. uvArray.push( vector2.y );
  26387. }
  26388. }
  26389. }
  26390. copy( source ) {
  26391. super.copy( source );
  26392. this.parameters = Object.assign( {}, source.parameters );
  26393. return this;
  26394. }
  26395. toJSON() {
  26396. const data = super.toJSON();
  26397. const shapes = this.parameters.shapes;
  26398. const options = this.parameters.options;
  26399. return toJSON$1( shapes, options, data );
  26400. }
  26401. /**
  26402. * Factory method for creating an instance of this class from the given
  26403. * JSON object.
  26404. *
  26405. * @param {Object} data - A JSON object representing the serialized geometry.
  26406. * @param {Array<Shape>} shapes - An array of shapes.
  26407. * @return {ExtrudeGeometry} A new instance.
  26408. */
  26409. static fromJSON( data, shapes ) {
  26410. const geometryShapes = [];
  26411. for ( let j = 0, jl = data.shapes.length; j < jl; j ++ ) {
  26412. const shape = shapes[ data.shapes[ j ] ];
  26413. geometryShapes.push( shape );
  26414. }
  26415. const extrudePath = data.options.extrudePath;
  26416. if ( extrudePath !== undefined ) {
  26417. data.options.extrudePath = new Curves[ extrudePath.type ]().fromJSON( extrudePath );
  26418. }
  26419. return new ExtrudeGeometry( geometryShapes, data.options );
  26420. }
  26421. }
  26422. const WorldUVGenerator = {
  26423. generateTopUV: function ( geometry, vertices, indexA, indexB, indexC ) {
  26424. const a_x = vertices[ indexA * 3 ];
  26425. const a_y = vertices[ indexA * 3 + 1 ];
  26426. const b_x = vertices[ indexB * 3 ];
  26427. const b_y = vertices[ indexB * 3 + 1 ];
  26428. const c_x = vertices[ indexC * 3 ];
  26429. const c_y = vertices[ indexC * 3 + 1 ];
  26430. return [
  26431. new Vector2( a_x, a_y ),
  26432. new Vector2( b_x, b_y ),
  26433. new Vector2( c_x, c_y )
  26434. ];
  26435. },
  26436. generateSideWallUV: function ( geometry, vertices, indexA, indexB, indexC, indexD ) {
  26437. const a_x = vertices[ indexA * 3 ];
  26438. const a_y = vertices[ indexA * 3 + 1 ];
  26439. const a_z = vertices[ indexA * 3 + 2 ];
  26440. const b_x = vertices[ indexB * 3 ];
  26441. const b_y = vertices[ indexB * 3 + 1 ];
  26442. const b_z = vertices[ indexB * 3 + 2 ];
  26443. const c_x = vertices[ indexC * 3 ];
  26444. const c_y = vertices[ indexC * 3 + 1 ];
  26445. const c_z = vertices[ indexC * 3 + 2 ];
  26446. const d_x = vertices[ indexD * 3 ];
  26447. const d_y = vertices[ indexD * 3 + 1 ];
  26448. const d_z = vertices[ indexD * 3 + 2 ];
  26449. if ( Math.abs( a_y - b_y ) < Math.abs( a_x - b_x ) ) {
  26450. return [
  26451. new Vector2( a_x, 1 - a_z ),
  26452. new Vector2( b_x, 1 - b_z ),
  26453. new Vector2( c_x, 1 - c_z ),
  26454. new Vector2( d_x, 1 - d_z )
  26455. ];
  26456. } else {
  26457. return [
  26458. new Vector2( a_y, 1 - a_z ),
  26459. new Vector2( b_y, 1 - b_z ),
  26460. new Vector2( c_y, 1 - c_z ),
  26461. new Vector2( d_y, 1 - d_z )
  26462. ];
  26463. }
  26464. }
  26465. };
  26466. function toJSON$1( shapes, options, data ) {
  26467. data.shapes = [];
  26468. if ( Array.isArray( shapes ) ) {
  26469. for ( let i = 0, l = shapes.length; i < l; i ++ ) {
  26470. const shape = shapes[ i ];
  26471. data.shapes.push( shape.uuid );
  26472. }
  26473. } else {
  26474. data.shapes.push( shapes.uuid );
  26475. }
  26476. data.options = Object.assign( {}, options );
  26477. if ( options.extrudePath !== undefined ) data.options.extrudePath = options.extrudePath.toJSON();
  26478. return data;
  26479. }
  26480. /**
  26481. * A geometry class for representing an icosahedron.
  26482. *
  26483. * ```js
  26484. * const geometry = new THREE.IcosahedronGeometry();
  26485. * const material = new THREE.MeshBasicMaterial( { color: 0xffff00 } );
  26486. * const icosahedron = new THREE.Mesh( geometry, material );
  26487. * scene.add( icosahedron );
  26488. * ```
  26489. *
  26490. * @augments PolyhedronGeometry
  26491. * @demo scenes/geometry-browser.html#IcosahedronGeometry
  26492. */
  26493. class IcosahedronGeometry extends PolyhedronGeometry {
  26494. /**
  26495. * Constructs a new icosahedron geometry.
  26496. *
  26497. * @param {number} [radius=1] - Radius of the icosahedron.
  26498. * @param {number} [detail=0] - Setting this to a value greater than `0` adds vertices making it no longer a icosahedron.
  26499. */
  26500. constructor( radius = 1, detail = 0 ) {
  26501. const t = ( 1 + Math.sqrt( 5 ) ) / 2;
  26502. const vertices = [
  26503. -1, t, 0, 1, t, 0, -1, - t, 0, 1, - t, 0,
  26504. 0, -1, t, 0, 1, t, 0, -1, - t, 0, 1, - t,
  26505. t, 0, -1, t, 0, 1, - t, 0, -1, - t, 0, 1
  26506. ];
  26507. const indices = [
  26508. 0, 11, 5, 0, 5, 1, 0, 1, 7, 0, 7, 10, 0, 10, 11,
  26509. 1, 5, 9, 5, 11, 4, 11, 10, 2, 10, 7, 6, 7, 1, 8,
  26510. 3, 9, 4, 3, 4, 2, 3, 2, 6, 3, 6, 8, 3, 8, 9,
  26511. 4, 9, 5, 2, 4, 11, 6, 2, 10, 8, 6, 7, 9, 8, 1
  26512. ];
  26513. super( vertices, indices, radius, detail );
  26514. this.type = 'IcosahedronGeometry';
  26515. /**
  26516. * Holds the constructor parameters that have been
  26517. * used to generate the geometry. Any modification
  26518. * after instantiation does not change the geometry.
  26519. *
  26520. * @type {Object}
  26521. */
  26522. this.parameters = {
  26523. radius: radius,
  26524. detail: detail
  26525. };
  26526. }
  26527. /**
  26528. * Factory method for creating an instance of this class from the given
  26529. * JSON object.
  26530. *
  26531. * @param {Object} data - A JSON object representing the serialized geometry.
  26532. * @return {IcosahedronGeometry} A new instance.
  26533. */
  26534. static fromJSON( data ) {
  26535. return new IcosahedronGeometry( data.radius, data.detail );
  26536. }
  26537. }
  26538. /**
  26539. * Creates meshes with axial symmetry like vases. The lathe rotates around the Y axis.
  26540. *
  26541. * ```js
  26542. * const points = [];
  26543. * for ( let i = 0; i < 10; i ++ ) {
  26544. * points.push( new THREE.Vector2( Math.sin( i * 0.2 ) * 10 + 5, ( i - 5 ) * 2 ) );
  26545. * }
  26546. * const geometry = new THREE.LatheGeometry( points );
  26547. * const material = new THREE.MeshBasicMaterial( { color: 0xffff00 } );
  26548. * const lathe = new THREE.Mesh( geometry, material );
  26549. * scene.add( lathe );
  26550. * ```
  26551. *
  26552. * @augments BufferGeometry
  26553. * @demo scenes/geometry-browser.html#LatheGeometry
  26554. */
  26555. class LatheGeometry extends BufferGeometry {
  26556. /**
  26557. * Constructs a new lathe geometry.
  26558. *
  26559. * @param {Array<Vector2|Vector3>} [points] - An array of points in 2D space. The x-coordinate of each point
  26560. * must be greater than zero.
  26561. * @param {number} [segments=12] - The number of circumference segments to generate.
  26562. * @param {number} [phiStart=0] - The starting angle in radians.
  26563. * @param {number} [phiLength=Math.PI*2] - The radian (0 to 2PI) range of the lathed section 2PI is a
  26564. * closed lathe, less than 2PI is a portion.
  26565. */
  26566. 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 ) {
  26567. super();
  26568. this.type = 'LatheGeometry';
  26569. /**
  26570. * Holds the constructor parameters that have been
  26571. * used to generate the geometry. Any modification
  26572. * after instantiation does not change the geometry.
  26573. *
  26574. * @type {Object}
  26575. */
  26576. this.parameters = {
  26577. points: points,
  26578. segments: segments,
  26579. phiStart: phiStart,
  26580. phiLength: phiLength
  26581. };
  26582. segments = Math.floor( segments );
  26583. // clamp phiLength so it's in range of [ 0, 2PI ]
  26584. phiLength = clamp( phiLength, 0, Math.PI * 2 );
  26585. // buffers
  26586. const indices = [];
  26587. const vertices = [];
  26588. const uvs = [];
  26589. const initNormals = [];
  26590. const normals = [];
  26591. // helper variables
  26592. const inverseSegments = 1.0 / segments;
  26593. const vertex = new Vector3();
  26594. const uv = new Vector2();
  26595. const normal = new Vector3();
  26596. const curNormal = new Vector3();
  26597. const prevNormal = new Vector3();
  26598. let dx = 0;
  26599. let dy = 0;
  26600. // pre-compute normals for initial "meridian"
  26601. for ( let j = 0; j <= ( points.length - 1 ); j ++ ) {
  26602. switch ( j ) {
  26603. case 0: // special handling for 1st vertex on path
  26604. dx = points[ j + 1 ].x - points[ j ].x;
  26605. dy = points[ j + 1 ].y - points[ j ].y;
  26606. normal.x = dy * 1.0;
  26607. normal.y = - dx;
  26608. normal.z = dy * 0.0;
  26609. prevNormal.copy( normal );
  26610. normal.normalize();
  26611. initNormals.push( normal.x, normal.y, normal.z );
  26612. break;
  26613. case ( points.length - 1 ): // special handling for last Vertex on path
  26614. initNormals.push( prevNormal.x, prevNormal.y, prevNormal.z );
  26615. break;
  26616. default: // default handling for all vertices in between
  26617. dx = points[ j + 1 ].x - points[ j ].x;
  26618. dy = points[ j + 1 ].y - points[ j ].y;
  26619. normal.x = dy * 1.0;
  26620. normal.y = - dx;
  26621. normal.z = dy * 0.0;
  26622. curNormal.copy( normal );
  26623. normal.x += prevNormal.x;
  26624. normal.y += prevNormal.y;
  26625. normal.z += prevNormal.z;
  26626. normal.normalize();
  26627. initNormals.push( normal.x, normal.y, normal.z );
  26628. prevNormal.copy( curNormal );
  26629. }
  26630. }
  26631. // generate vertices, uvs and normals
  26632. for ( let i = 0; i <= segments; i ++ ) {
  26633. const phi = phiStart + i * inverseSegments * phiLength;
  26634. const sin = Math.sin( phi );
  26635. const cos = Math.cos( phi );
  26636. for ( let j = 0; j <= ( points.length - 1 ); j ++ ) {
  26637. // vertex
  26638. vertex.x = points[ j ].x * sin;
  26639. vertex.y = points[ j ].y;
  26640. vertex.z = points[ j ].x * cos;
  26641. vertices.push( vertex.x, vertex.y, vertex.z );
  26642. // uv
  26643. uv.x = i / segments;
  26644. uv.y = j / ( points.length - 1 );
  26645. uvs.push( uv.x, uv.y );
  26646. // normal
  26647. const x = initNormals[ 3 * j + 0 ] * sin;
  26648. const y = initNormals[ 3 * j + 1 ];
  26649. const z = initNormals[ 3 * j + 0 ] * cos;
  26650. normals.push( x, y, z );
  26651. }
  26652. }
  26653. // indices
  26654. for ( let i = 0; i < segments; i ++ ) {
  26655. for ( let j = 0; j < ( points.length - 1 ); j ++ ) {
  26656. const base = j + i * points.length;
  26657. const a = base;
  26658. const b = base + points.length;
  26659. const c = base + points.length + 1;
  26660. const d = base + 1;
  26661. // faces
  26662. indices.push( a, b, d );
  26663. indices.push( c, d, b );
  26664. }
  26665. }
  26666. // build geometry
  26667. this.setIndex( indices );
  26668. this.setAttribute( 'position', new Float32BufferAttribute( vertices, 3 ) );
  26669. this.setAttribute( 'uv', new Float32BufferAttribute( uvs, 2 ) );
  26670. this.setAttribute( 'normal', new Float32BufferAttribute( normals, 3 ) );
  26671. }
  26672. copy( source ) {
  26673. super.copy( source );
  26674. this.parameters = Object.assign( {}, source.parameters );
  26675. return this;
  26676. }
  26677. /**
  26678. * Factory method for creating an instance of this class from the given
  26679. * JSON object.
  26680. *
  26681. * @param {Object} data - A JSON object representing the serialized geometry.
  26682. * @return {LatheGeometry} A new instance.
  26683. */
  26684. static fromJSON( data ) {
  26685. return new LatheGeometry( data.points, data.segments, data.phiStart, data.phiLength );
  26686. }
  26687. }
  26688. /**
  26689. * A geometry class for representing an octahedron.
  26690. *
  26691. * ```js
  26692. * const geometry = new THREE.OctahedronGeometry();
  26693. * const material = new THREE.MeshBasicMaterial( { color: 0xffff00 } );
  26694. * const octahedron = new THREE.Mesh( geometry, material );
  26695. * scene.add( octahedron );
  26696. * ```
  26697. *
  26698. * @augments PolyhedronGeometry
  26699. * @demo scenes/geometry-browser.html#OctahedronGeometry
  26700. */
  26701. class OctahedronGeometry extends PolyhedronGeometry {
  26702. /**
  26703. * Constructs a new octahedron geometry.
  26704. *
  26705. * @param {number} [radius=1] - Radius of the octahedron.
  26706. * @param {number} [detail=0] - Setting this to a value greater than `0` adds vertices making it no longer a octahedron.
  26707. */
  26708. constructor( radius = 1, detail = 0 ) {
  26709. const vertices = [
  26710. 1, 0, 0, -1, 0, 0, 0, 1, 0,
  26711. 0, -1, 0, 0, 0, 1, 0, 0, -1
  26712. ];
  26713. const indices = [
  26714. 0, 2, 4, 0, 4, 3, 0, 3, 5,
  26715. 0, 5, 2, 1, 2, 5, 1, 5, 3,
  26716. 1, 3, 4, 1, 4, 2
  26717. ];
  26718. super( vertices, indices, radius, detail );
  26719. this.type = 'OctahedronGeometry';
  26720. /**
  26721. * Holds the constructor parameters that have been
  26722. * used to generate the geometry. Any modification
  26723. * after instantiation does not change the geometry.
  26724. *
  26725. * @type {Object}
  26726. */
  26727. this.parameters = {
  26728. radius: radius,
  26729. detail: detail
  26730. };
  26731. }
  26732. /**
  26733. * Factory method for creating an instance of this class from the given
  26734. * JSON object.
  26735. *
  26736. * @param {Object} data - A JSON object representing the serialized geometry.
  26737. * @return {OctahedronGeometry} A new instance.
  26738. */
  26739. static fromJSON( data ) {
  26740. return new OctahedronGeometry( data.radius, data.detail );
  26741. }
  26742. }
  26743. /**
  26744. * A geometry class for representing a plane.
  26745. *
  26746. * ```js
  26747. * const geometry = new THREE.PlaneGeometry( 1, 1 );
  26748. * const material = new THREE.MeshBasicMaterial( { color: 0xffff00, side: THREE.DoubleSide } );
  26749. * const plane = new THREE.Mesh( geometry, material );
  26750. * scene.add( plane );
  26751. * ```
  26752. *
  26753. * @augments BufferGeometry
  26754. * @demo scenes/geometry-browser.html#PlaneGeometry
  26755. */
  26756. class PlaneGeometry extends BufferGeometry {
  26757. /**
  26758. * Constructs a new plane geometry.
  26759. *
  26760. * @param {number} [width=1] - The width along the X axis.
  26761. * @param {number} [height=1] - The height along the Y axis
  26762. * @param {number} [widthSegments=1] - The number of segments along the X axis.
  26763. * @param {number} [heightSegments=1] - The number of segments along the Y axis.
  26764. */
  26765. constructor( width = 1, height = 1, widthSegments = 1, heightSegments = 1 ) {
  26766. super();
  26767. this.type = 'PlaneGeometry';
  26768. /**
  26769. * Holds the constructor parameters that have been
  26770. * used to generate the geometry. Any modification
  26771. * after instantiation does not change the geometry.
  26772. *
  26773. * @type {Object}
  26774. */
  26775. this.parameters = {
  26776. width: width,
  26777. height: height,
  26778. widthSegments: widthSegments,
  26779. heightSegments: heightSegments
  26780. };
  26781. const width_half = width / 2;
  26782. const height_half = height / 2;
  26783. const gridX = Math.floor( widthSegments );
  26784. const gridY = Math.floor( heightSegments );
  26785. const gridX1 = gridX + 1;
  26786. const gridY1 = gridY + 1;
  26787. const segment_width = width / gridX;
  26788. const segment_height = height / gridY;
  26789. //
  26790. const indices = [];
  26791. const vertices = [];
  26792. const normals = [];
  26793. const uvs = [];
  26794. for ( let iy = 0; iy < gridY1; iy ++ ) {
  26795. const y = iy * segment_height - height_half;
  26796. for ( let ix = 0; ix < gridX1; ix ++ ) {
  26797. const x = ix * segment_width - width_half;
  26798. vertices.push( x, - y, 0 );
  26799. normals.push( 0, 0, 1 );
  26800. uvs.push( ix / gridX );
  26801. uvs.push( 1 - ( iy / gridY ) );
  26802. }
  26803. }
  26804. for ( let iy = 0; iy < gridY; iy ++ ) {
  26805. for ( let ix = 0; ix < gridX; ix ++ ) {
  26806. const a = ix + gridX1 * iy;
  26807. const b = ix + gridX1 * ( iy + 1 );
  26808. const c = ( ix + 1 ) + gridX1 * ( iy + 1 );
  26809. const d = ( ix + 1 ) + gridX1 * iy;
  26810. indices.push( a, b, d );
  26811. indices.push( b, c, d );
  26812. }
  26813. }
  26814. this.setIndex( indices );
  26815. this.setAttribute( 'position', new Float32BufferAttribute( vertices, 3 ) );
  26816. this.setAttribute( 'normal', new Float32BufferAttribute( normals, 3 ) );
  26817. this.setAttribute( 'uv', new Float32BufferAttribute( uvs, 2 ) );
  26818. }
  26819. copy( source ) {
  26820. super.copy( source );
  26821. this.parameters = Object.assign( {}, source.parameters );
  26822. return this;
  26823. }
  26824. /**
  26825. * Factory method for creating an instance of this class from the given
  26826. * JSON object.
  26827. *
  26828. * @param {Object} data - A JSON object representing the serialized geometry.
  26829. * @return {PlaneGeometry} A new instance.
  26830. */
  26831. static fromJSON( data ) {
  26832. return new PlaneGeometry( data.width, data.height, data.widthSegments, data.heightSegments );
  26833. }
  26834. }
  26835. /**
  26836. * A class for generating a two-dimensional ring geometry.
  26837. *
  26838. * ```js
  26839. * const geometry = new THREE.RingGeometry( 1, 5, 32 );
  26840. * const material = new THREE.MeshBasicMaterial( { color: 0xffff00, side: THREE.DoubleSide } );
  26841. * const mesh = new THREE.Mesh( geometry, material );
  26842. * scene.add( mesh );
  26843. * ```
  26844. *
  26845. * @augments BufferGeometry
  26846. * @demo scenes/geometry-browser.html#RingGeometry
  26847. */
  26848. class RingGeometry extends BufferGeometry {
  26849. /**
  26850. * Constructs a new ring geometry.
  26851. *
  26852. * @param {number} [innerRadius=0.5] - The inner radius of the ring.
  26853. * @param {number} [outerRadius=1] - The outer radius of the ring.
  26854. * @param {number} [thetaSegments=32] - Number of segments. A higher number means the ring will be more round. Minimum is `3`.
  26855. * @param {number} [phiSegments=1] - Number of segments per ring segment. Minimum is `1`.
  26856. * @param {number} [thetaStart=0] - Starting angle in radians.
  26857. * @param {number} [thetaLength=Math.PI*2] - Central angle in radians.
  26858. */
  26859. constructor( innerRadius = 0.5, outerRadius = 1, thetaSegments = 32, phiSegments = 1, thetaStart = 0, thetaLength = Math.PI * 2 ) {
  26860. super();
  26861. this.type = 'RingGeometry';
  26862. /**
  26863. * Holds the constructor parameters that have been
  26864. * used to generate the geometry. Any modification
  26865. * after instantiation does not change the geometry.
  26866. *
  26867. * @type {Object}
  26868. */
  26869. this.parameters = {
  26870. innerRadius: innerRadius,
  26871. outerRadius: outerRadius,
  26872. thetaSegments: thetaSegments,
  26873. phiSegments: phiSegments,
  26874. thetaStart: thetaStart,
  26875. thetaLength: thetaLength
  26876. };
  26877. thetaSegments = Math.max( 3, thetaSegments );
  26878. phiSegments = Math.max( 1, phiSegments );
  26879. // buffers
  26880. const indices = [];
  26881. const vertices = [];
  26882. const normals = [];
  26883. const uvs = [];
  26884. // some helper variables
  26885. let radius = innerRadius;
  26886. const radiusStep = ( ( outerRadius - innerRadius ) / phiSegments );
  26887. const vertex = new Vector3();
  26888. const uv = new Vector2();
  26889. // generate vertices, normals and uvs
  26890. for ( let j = 0; j <= phiSegments; j ++ ) {
  26891. for ( let i = 0; i <= thetaSegments; i ++ ) {
  26892. // values are generate from the inside of the ring to the outside
  26893. const segment = thetaStart + i / thetaSegments * thetaLength;
  26894. // vertex
  26895. vertex.x = radius * Math.cos( segment );
  26896. vertex.y = radius * Math.sin( segment );
  26897. vertices.push( vertex.x, vertex.y, vertex.z );
  26898. // normal
  26899. normals.push( 0, 0, 1 );
  26900. // uv
  26901. uv.x = ( vertex.x / outerRadius + 1 ) / 2;
  26902. uv.y = ( vertex.y / outerRadius + 1 ) / 2;
  26903. uvs.push( uv.x, uv.y );
  26904. }
  26905. // increase the radius for next row of vertices
  26906. radius += radiusStep;
  26907. }
  26908. // indices
  26909. for ( let j = 0; j < phiSegments; j ++ ) {
  26910. const thetaSegmentLevel = j * ( thetaSegments + 1 );
  26911. for ( let i = 0; i < thetaSegments; i ++ ) {
  26912. const segment = i + thetaSegmentLevel;
  26913. const a = segment;
  26914. const b = segment + thetaSegments + 1;
  26915. const c = segment + thetaSegments + 2;
  26916. const d = segment + 1;
  26917. // faces
  26918. indices.push( a, b, d );
  26919. indices.push( b, c, d );
  26920. }
  26921. }
  26922. // build geometry
  26923. this.setIndex( indices );
  26924. this.setAttribute( 'position', new Float32BufferAttribute( vertices, 3 ) );
  26925. this.setAttribute( 'normal', new Float32BufferAttribute( normals, 3 ) );
  26926. this.setAttribute( 'uv', new Float32BufferAttribute( uvs, 2 ) );
  26927. }
  26928. copy( source ) {
  26929. super.copy( source );
  26930. this.parameters = Object.assign( {}, source.parameters );
  26931. return this;
  26932. }
  26933. /**
  26934. * Factory method for creating an instance of this class from the given
  26935. * JSON object.
  26936. *
  26937. * @param {Object} data - A JSON object representing the serialized geometry.
  26938. * @return {RingGeometry} A new instance.
  26939. */
  26940. static fromJSON( data ) {
  26941. return new RingGeometry( data.innerRadius, data.outerRadius, data.thetaSegments, data.phiSegments, data.thetaStart, data.thetaLength );
  26942. }
  26943. }
  26944. /**
  26945. * Creates an one-sided polygonal geometry from one or more path shapes.
  26946. *
  26947. * ```js
  26948. * const arcShape = new THREE.Shape()
  26949. * .moveTo( 5, 1 )
  26950. * .absarc( 1, 1, 4, 0, Math.PI * 2, false );
  26951. *
  26952. * const geometry = new THREE.ShapeGeometry( arcShape );
  26953. * const material = new THREE.MeshBasicMaterial( { color: 0x00ff00, side: THREE.DoubleSide } );
  26954. * const mesh = new THREE.Mesh( geometry, material ) ;
  26955. * scene.add( mesh );
  26956. * ```
  26957. *
  26958. * @augments BufferGeometry
  26959. * @demo scenes/geometry-browser.html#ShapeGeometry
  26960. */
  26961. class ShapeGeometry extends BufferGeometry {
  26962. /**
  26963. * Constructs a new shape geometry.
  26964. *
  26965. * @param {Shape|Array<Shape>} [shapes] - A shape or an array of shapes.
  26966. * @param {number} [curveSegments=12] - Number of segments per shape.
  26967. */
  26968. constructor( shapes = new Shape( [ new Vector2( 0, 0.5 ), new Vector2( -0.5, -0.5 ), new Vector2( 0.5, -0.5 ) ] ), curveSegments = 12 ) {
  26969. super();
  26970. this.type = 'ShapeGeometry';
  26971. /**
  26972. * Holds the constructor parameters that have been
  26973. * used to generate the geometry. Any modification
  26974. * after instantiation does not change the geometry.
  26975. *
  26976. * @type {Object}
  26977. */
  26978. this.parameters = {
  26979. shapes: shapes,
  26980. curveSegments: curveSegments
  26981. };
  26982. // buffers
  26983. const indices = [];
  26984. const vertices = [];
  26985. const normals = [];
  26986. const uvs = [];
  26987. // helper variables
  26988. let groupStart = 0;
  26989. let groupCount = 0;
  26990. // allow single and array values for "shapes" parameter
  26991. if ( Array.isArray( shapes ) === false ) {
  26992. addShape( shapes );
  26993. } else {
  26994. for ( let i = 0; i < shapes.length; i ++ ) {
  26995. addShape( shapes[ i ] );
  26996. this.addGroup( groupStart, groupCount, i ); // enables MultiMaterial support
  26997. groupStart += groupCount;
  26998. groupCount = 0;
  26999. }
  27000. }
  27001. // build geometry
  27002. this.setIndex( indices );
  27003. this.setAttribute( 'position', new Float32BufferAttribute( vertices, 3 ) );
  27004. this.setAttribute( 'normal', new Float32BufferAttribute( normals, 3 ) );
  27005. this.setAttribute( 'uv', new Float32BufferAttribute( uvs, 2 ) );
  27006. // helper functions
  27007. function addShape( shape ) {
  27008. const indexOffset = vertices.length / 3;
  27009. const points = shape.extractPoints( curveSegments );
  27010. let shapeVertices = points.shape;
  27011. const shapeHoles = points.holes;
  27012. // check direction of vertices
  27013. if ( ShapeUtils.isClockWise( shapeVertices ) === false ) {
  27014. shapeVertices = shapeVertices.reverse();
  27015. }
  27016. for ( let i = 0, l = shapeHoles.length; i < l; i ++ ) {
  27017. const shapeHole = shapeHoles[ i ];
  27018. if ( ShapeUtils.isClockWise( shapeHole ) === true ) {
  27019. shapeHoles[ i ] = shapeHole.reverse();
  27020. }
  27021. }
  27022. const faces = ShapeUtils.triangulateShape( shapeVertices, shapeHoles );
  27023. // join vertices of inner and outer paths to a single array
  27024. for ( let i = 0, l = shapeHoles.length; i < l; i ++ ) {
  27025. const shapeHole = shapeHoles[ i ];
  27026. shapeVertices = shapeVertices.concat( shapeHole );
  27027. }
  27028. // vertices, normals, uvs
  27029. for ( let i = 0, l = shapeVertices.length; i < l; i ++ ) {
  27030. const vertex = shapeVertices[ i ];
  27031. vertices.push( vertex.x, vertex.y, 0 );
  27032. normals.push( 0, 0, 1 );
  27033. uvs.push( vertex.x, vertex.y ); // world uvs
  27034. }
  27035. // indices
  27036. for ( let i = 0, l = faces.length; i < l; i ++ ) {
  27037. const face = faces[ i ];
  27038. const a = face[ 0 ] + indexOffset;
  27039. const b = face[ 1 ] + indexOffset;
  27040. const c = face[ 2 ] + indexOffset;
  27041. indices.push( a, b, c );
  27042. groupCount += 3;
  27043. }
  27044. }
  27045. }
  27046. copy( source ) {
  27047. super.copy( source );
  27048. this.parameters = Object.assign( {}, source.parameters );
  27049. return this;
  27050. }
  27051. toJSON() {
  27052. const data = super.toJSON();
  27053. const shapes = this.parameters.shapes;
  27054. return toJSON( shapes, data );
  27055. }
  27056. /**
  27057. * Factory method for creating an instance of this class from the given
  27058. * JSON object.
  27059. *
  27060. * @param {Object} data - A JSON object representing the serialized geometry.
  27061. * @param {Array<Shape>} shapes - An array of shapes.
  27062. * @return {ShapeGeometry} A new instance.
  27063. */
  27064. static fromJSON( data, shapes ) {
  27065. const geometryShapes = [];
  27066. for ( let j = 0, jl = data.shapes.length; j < jl; j ++ ) {
  27067. const shape = shapes[ data.shapes[ j ] ];
  27068. geometryShapes.push( shape );
  27069. }
  27070. return new ShapeGeometry( geometryShapes, data.curveSegments );
  27071. }
  27072. }
  27073. function toJSON( shapes, data ) {
  27074. data.shapes = [];
  27075. if ( Array.isArray( shapes ) ) {
  27076. for ( let i = 0, l = shapes.length; i < l; i ++ ) {
  27077. const shape = shapes[ i ];
  27078. data.shapes.push( shape.uuid );
  27079. }
  27080. } else {
  27081. data.shapes.push( shapes.uuid );
  27082. }
  27083. return data;
  27084. }
  27085. /**
  27086. * A class for generating a sphere geometry.
  27087. *
  27088. * ```js
  27089. * const geometry = new THREE.SphereGeometry( 15, 32, 16 );
  27090. * const material = new THREE.MeshBasicMaterial( { color: 0xffff00 } );
  27091. * const sphere = new THREE.Mesh( geometry, material );
  27092. * scene.add( sphere );
  27093. * ```
  27094. *
  27095. * @augments BufferGeometry
  27096. * @demo scenes/geometry-browser.html#SphereGeometry
  27097. */
  27098. class SphereGeometry extends BufferGeometry {
  27099. /**
  27100. * Constructs a new sphere geometry.
  27101. *
  27102. * @param {number} [radius=1] - The sphere radius.
  27103. * @param {number} [widthSegments=32] - The number of horizontal segments. Minimum value is `3`.
  27104. * @param {number} [heightSegments=16] - The number of vertical segments. Minimum value is `2`.
  27105. * @param {number} [phiStart=0] - The horizontal starting angle in radians.
  27106. * @param {number} [phiLength=Math.PI*2] - The horizontal sweep angle size.
  27107. * @param {number} [thetaStart=0] - The vertical starting angle in radians.
  27108. * @param {number} [thetaLength=Math.PI] - The vertical sweep angle size.
  27109. */
  27110. constructor( radius = 1, widthSegments = 32, heightSegments = 16, phiStart = 0, phiLength = Math.PI * 2, thetaStart = 0, thetaLength = Math.PI ) {
  27111. super();
  27112. this.type = 'SphereGeometry';
  27113. /**
  27114. * Holds the constructor parameters that have been
  27115. * used to generate the geometry. Any modification
  27116. * after instantiation does not change the geometry.
  27117. *
  27118. * @type {Object}
  27119. */
  27120. this.parameters = {
  27121. radius: radius,
  27122. widthSegments: widthSegments,
  27123. heightSegments: heightSegments,
  27124. phiStart: phiStart,
  27125. phiLength: phiLength,
  27126. thetaStart: thetaStart,
  27127. thetaLength: thetaLength
  27128. };
  27129. widthSegments = Math.max( 3, Math.floor( widthSegments ) );
  27130. heightSegments = Math.max( 2, Math.floor( heightSegments ) );
  27131. const thetaEnd = Math.min( thetaStart + thetaLength, Math.PI );
  27132. let index = 0;
  27133. const grid = [];
  27134. const vertex = new Vector3();
  27135. const normal = new Vector3();
  27136. // buffers
  27137. const indices = [];
  27138. const vertices = [];
  27139. const normals = [];
  27140. const uvs = [];
  27141. // generate vertices, normals and uvs
  27142. for ( let iy = 0; iy <= heightSegments; iy ++ ) {
  27143. const verticesRow = [];
  27144. const v = iy / heightSegments;
  27145. // special case for the poles
  27146. let uOffset = 0;
  27147. if ( iy === 0 && thetaStart === 0 ) {
  27148. uOffset = 0.5 / widthSegments;
  27149. } else if ( iy === heightSegments && thetaEnd === Math.PI ) {
  27150. uOffset = -0.5 / widthSegments;
  27151. }
  27152. for ( let ix = 0; ix <= widthSegments; ix ++ ) {
  27153. const u = ix / widthSegments;
  27154. // vertex
  27155. vertex.x = - radius * Math.cos( phiStart + u * phiLength ) * Math.sin( thetaStart + v * thetaLength );
  27156. vertex.y = radius * Math.cos( thetaStart + v * thetaLength );
  27157. vertex.z = radius * Math.sin( phiStart + u * phiLength ) * Math.sin( thetaStart + v * thetaLength );
  27158. vertices.push( vertex.x, vertex.y, vertex.z );
  27159. // normal
  27160. normal.copy( vertex ).normalize();
  27161. normals.push( normal.x, normal.y, normal.z );
  27162. // uv
  27163. uvs.push( u + uOffset, 1 - v );
  27164. verticesRow.push( index ++ );
  27165. }
  27166. grid.push( verticesRow );
  27167. }
  27168. // indices
  27169. for ( let iy = 0; iy < heightSegments; iy ++ ) {
  27170. for ( let ix = 0; ix < widthSegments; ix ++ ) {
  27171. const a = grid[ iy ][ ix + 1 ];
  27172. const b = grid[ iy ][ ix ];
  27173. const c = grid[ iy + 1 ][ ix ];
  27174. const d = grid[ iy + 1 ][ ix + 1 ];
  27175. if ( iy !== 0 || thetaStart > 0 ) indices.push( a, b, d );
  27176. if ( iy !== heightSegments - 1 || thetaEnd < Math.PI ) indices.push( b, c, d );
  27177. }
  27178. }
  27179. // build geometry
  27180. this.setIndex( indices );
  27181. this.setAttribute( 'position', new Float32BufferAttribute( vertices, 3 ) );
  27182. this.setAttribute( 'normal', new Float32BufferAttribute( normals, 3 ) );
  27183. this.setAttribute( 'uv', new Float32BufferAttribute( uvs, 2 ) );
  27184. }
  27185. copy( source ) {
  27186. super.copy( source );
  27187. this.parameters = Object.assign( {}, source.parameters );
  27188. return this;
  27189. }
  27190. /**
  27191. * Factory method for creating an instance of this class from the given
  27192. * JSON object.
  27193. *
  27194. * @param {Object} data - A JSON object representing the serialized geometry.
  27195. * @return {SphereGeometry} A new instance.
  27196. */
  27197. static fromJSON( data ) {
  27198. return new SphereGeometry( data.radius, data.widthSegments, data.heightSegments, data.phiStart, data.phiLength, data.thetaStart, data.thetaLength );
  27199. }
  27200. }
  27201. /**
  27202. * A geometry class for representing an tetrahedron.
  27203. *
  27204. * ```js
  27205. * const geometry = new THREE.TetrahedronGeometry();
  27206. * const material = new THREE.MeshBasicMaterial( { color: 0xffff00 } );
  27207. * const tetrahedron = new THREE.Mesh( geometry, material );
  27208. * scene.add( tetrahedron );
  27209. * ```
  27210. *
  27211. * @augments PolyhedronGeometry
  27212. * @demo scenes/geometry-browser.html#TetrahedronGeometry
  27213. */
  27214. class TetrahedronGeometry extends PolyhedronGeometry {
  27215. /**
  27216. * Constructs a new tetrahedron geometry.
  27217. *
  27218. * @param {number} [radius=1] - Radius of the tetrahedron.
  27219. * @param {number} [detail=0] - Setting this to a value greater than `0` adds vertices making it no longer a tetrahedron.
  27220. */
  27221. constructor( radius = 1, detail = 0 ) {
  27222. const vertices = [
  27223. 1, 1, 1, -1, -1, 1, -1, 1, -1, 1, -1, -1
  27224. ];
  27225. const indices = [
  27226. 2, 1, 0, 0, 3, 2, 1, 3, 0, 2, 3, 1
  27227. ];
  27228. super( vertices, indices, radius, detail );
  27229. this.type = 'TetrahedronGeometry';
  27230. /**
  27231. * Holds the constructor parameters that have been
  27232. * used to generate the geometry. Any modification
  27233. * after instantiation does not change the geometry.
  27234. *
  27235. * @type {Object}
  27236. */
  27237. this.parameters = {
  27238. radius: radius,
  27239. detail: detail
  27240. };
  27241. }
  27242. /**
  27243. * Factory method for creating an instance of this class from the given
  27244. * JSON object.
  27245. *
  27246. * @param {Object} data - A JSON object representing the serialized geometry.
  27247. * @return {TetrahedronGeometry} A new instance.
  27248. */
  27249. static fromJSON( data ) {
  27250. return new TetrahedronGeometry( data.radius, data.detail );
  27251. }
  27252. }
  27253. /**
  27254. * A geometry class for representing an torus.
  27255. *
  27256. * ```js
  27257. * const geometry = new THREE.TorusGeometry( 10, 3, 16, 100 );
  27258. * const material = new THREE.MeshBasicMaterial( { color: 0xffff00 } );
  27259. * const torus = new THREE.Mesh( geometry, material );
  27260. * scene.add( torus );
  27261. * ```
  27262. *
  27263. * @augments BufferGeometry
  27264. * @demo scenes/geometry-browser.html#TorusGeometry
  27265. */
  27266. class TorusGeometry extends BufferGeometry {
  27267. /**
  27268. * Constructs a new torus geometry.
  27269. *
  27270. * @param {number} [radius=1] - Radius of the torus, from the center of the torus to the center of the tube.
  27271. * @param {number} [tube=0.4] - Radius of the tube. Must be smaller than `radius`.
  27272. * @param {number} [radialSegments=12] - The number of radial segments.
  27273. * @param {number} [tubularSegments=48] - The number of tubular segments.
  27274. * @param {number} [arc=Math.PI*2] - Central angle in radians.
  27275. */
  27276. constructor( radius = 1, tube = 0.4, radialSegments = 12, tubularSegments = 48, arc = Math.PI * 2 ) {
  27277. super();
  27278. this.type = 'TorusGeometry';
  27279. /**
  27280. * Holds the constructor parameters that have been
  27281. * used to generate the geometry. Any modification
  27282. * after instantiation does not change the geometry.
  27283. *
  27284. * @type {Object}
  27285. */
  27286. this.parameters = {
  27287. radius: radius,
  27288. tube: tube,
  27289. radialSegments: radialSegments,
  27290. tubularSegments: tubularSegments,
  27291. arc: arc
  27292. };
  27293. radialSegments = Math.floor( radialSegments );
  27294. tubularSegments = Math.floor( tubularSegments );
  27295. // buffers
  27296. const indices = [];
  27297. const vertices = [];
  27298. const normals = [];
  27299. const uvs = [];
  27300. // helper variables
  27301. const center = new Vector3();
  27302. const vertex = new Vector3();
  27303. const normal = new Vector3();
  27304. // generate vertices, normals and uvs
  27305. for ( let j = 0; j <= radialSegments; j ++ ) {
  27306. for ( let i = 0; i <= tubularSegments; i ++ ) {
  27307. const u = i / tubularSegments * arc;
  27308. const v = j / radialSegments * Math.PI * 2;
  27309. // vertex
  27310. vertex.x = ( radius + tube * Math.cos( v ) ) * Math.cos( u );
  27311. vertex.y = ( radius + tube * Math.cos( v ) ) * Math.sin( u );
  27312. vertex.z = tube * Math.sin( v );
  27313. vertices.push( vertex.x, vertex.y, vertex.z );
  27314. // normal
  27315. center.x = radius * Math.cos( u );
  27316. center.y = radius * Math.sin( u );
  27317. normal.subVectors( vertex, center ).normalize();
  27318. normals.push( normal.x, normal.y, normal.z );
  27319. // uv
  27320. uvs.push( i / tubularSegments );
  27321. uvs.push( j / radialSegments );
  27322. }
  27323. }
  27324. // generate indices
  27325. for ( let j = 1; j <= radialSegments; j ++ ) {
  27326. for ( let i = 1; i <= tubularSegments; i ++ ) {
  27327. // indices
  27328. const a = ( tubularSegments + 1 ) * j + i - 1;
  27329. const b = ( tubularSegments + 1 ) * ( j - 1 ) + i - 1;
  27330. const c = ( tubularSegments + 1 ) * ( j - 1 ) + i;
  27331. const d = ( tubularSegments + 1 ) * j + i;
  27332. // faces
  27333. indices.push( a, b, d );
  27334. indices.push( b, c, d );
  27335. }
  27336. }
  27337. // build geometry
  27338. this.setIndex( indices );
  27339. this.setAttribute( 'position', new Float32BufferAttribute( vertices, 3 ) );
  27340. this.setAttribute( 'normal', new Float32BufferAttribute( normals, 3 ) );
  27341. this.setAttribute( 'uv', new Float32BufferAttribute( uvs, 2 ) );
  27342. }
  27343. copy( source ) {
  27344. super.copy( source );
  27345. this.parameters = Object.assign( {}, source.parameters );
  27346. return this;
  27347. }
  27348. /**
  27349. * Factory method for creating an instance of this class from the given
  27350. * JSON object.
  27351. *
  27352. * @param {Object} data - A JSON object representing the serialized geometry.
  27353. * @return {TorusGeometry} A new instance.
  27354. */
  27355. static fromJSON( data ) {
  27356. return new TorusGeometry( data.radius, data.tube, data.radialSegments, data.tubularSegments, data.arc );
  27357. }
  27358. }
  27359. /**
  27360. * Creates a torus knot, the particular shape of which is defined by a pair
  27361. * of coprime integers, p and q. If p and q are not coprime, the result will
  27362. * be a torus link.
  27363. *
  27364. * ```js
  27365. * const geometry = new THREE.TorusKnotGeometry( 10, 3, 100, 16 );
  27366. * const material = new THREE.MeshBasicMaterial( { color: 0xffff00 } );
  27367. * const torusKnot = new THREE.Mesh( geometry, material );
  27368. * scene.add( torusKnot );
  27369. * ```
  27370. *
  27371. * @augments BufferGeometry
  27372. * @demo scenes/geometry-browser.html#TorusKnotGeometry
  27373. */
  27374. class TorusKnotGeometry extends BufferGeometry {
  27375. /**
  27376. * Constructs a new torus knot geometry.
  27377. *
  27378. * @param {number} [radius=1] - Radius of the torus knot.
  27379. * @param {number} [tube=0.4] - Radius of the tube.
  27380. * @param {number} [tubularSegments=64] - The number of tubular segments.
  27381. * @param {number} [radialSegments=8] - The number of radial segments.
  27382. * @param {number} [p=2] - This value determines, how many times the geometry winds around its axis of rotational symmetry.
  27383. * @param {number} [q=3] - This value determines, how many times the geometry winds around a circle in the interior of the torus.
  27384. */
  27385. constructor( radius = 1, tube = 0.4, tubularSegments = 64, radialSegments = 8, p = 2, q = 3 ) {
  27386. super();
  27387. this.type = 'TorusKnotGeometry';
  27388. /**
  27389. * Holds the constructor parameters that have been
  27390. * used to generate the geometry. Any modification
  27391. * after instantiation does not change the geometry.
  27392. *
  27393. * @type {Object}
  27394. */
  27395. this.parameters = {
  27396. radius: radius,
  27397. tube: tube,
  27398. tubularSegments: tubularSegments,
  27399. radialSegments: radialSegments,
  27400. p: p,
  27401. q: q
  27402. };
  27403. tubularSegments = Math.floor( tubularSegments );
  27404. radialSegments = Math.floor( radialSegments );
  27405. // buffers
  27406. const indices = [];
  27407. const vertices = [];
  27408. const normals = [];
  27409. const uvs = [];
  27410. // helper variables
  27411. const vertex = new Vector3();
  27412. const normal = new Vector3();
  27413. const P1 = new Vector3();
  27414. const P2 = new Vector3();
  27415. const B = new Vector3();
  27416. const T = new Vector3();
  27417. const N = new Vector3();
  27418. // generate vertices, normals and uvs
  27419. for ( let i = 0; i <= tubularSegments; ++ i ) {
  27420. // the radian "u" is used to calculate the position on the torus curve of the current tubular segment
  27421. const u = i / tubularSegments * p * Math.PI * 2;
  27422. // now we calculate two points. P1 is our current position on the curve, P2 is a little farther ahead.
  27423. // these points are used to create a special "coordinate space", which is necessary to calculate the correct vertex positions
  27424. calculatePositionOnCurve( u, p, q, radius, P1 );
  27425. calculatePositionOnCurve( u + 0.01, p, q, radius, P2 );
  27426. // calculate orthonormal basis
  27427. T.subVectors( P2, P1 );
  27428. N.addVectors( P2, P1 );
  27429. B.crossVectors( T, N );
  27430. N.crossVectors( B, T );
  27431. // normalize B, N. T can be ignored, we don't use it
  27432. B.normalize();
  27433. N.normalize();
  27434. for ( let j = 0; j <= radialSegments; ++ j ) {
  27435. // now calculate the vertices. they are nothing more than an extrusion of the torus curve.
  27436. // because we extrude a shape in the xy-plane, there is no need to calculate a z-value.
  27437. const v = j / radialSegments * Math.PI * 2;
  27438. const cx = - tube * Math.cos( v );
  27439. const cy = tube * Math.sin( v );
  27440. // now calculate the final vertex position.
  27441. // first we orient the extrusion with our basis vectors, then we add it to the current position on the curve
  27442. vertex.x = P1.x + ( cx * N.x + cy * B.x );
  27443. vertex.y = P1.y + ( cx * N.y + cy * B.y );
  27444. vertex.z = P1.z + ( cx * N.z + cy * B.z );
  27445. vertices.push( vertex.x, vertex.y, vertex.z );
  27446. // normal (P1 is always the center/origin of the extrusion, thus we can use it to calculate the normal)
  27447. normal.subVectors( vertex, P1 ).normalize();
  27448. normals.push( normal.x, normal.y, normal.z );
  27449. // uv
  27450. uvs.push( i / tubularSegments );
  27451. uvs.push( j / radialSegments );
  27452. }
  27453. }
  27454. // generate indices
  27455. for ( let j = 1; j <= tubularSegments; j ++ ) {
  27456. for ( let i = 1; i <= radialSegments; i ++ ) {
  27457. // indices
  27458. const a = ( radialSegments + 1 ) * ( j - 1 ) + ( i - 1 );
  27459. const b = ( radialSegments + 1 ) * j + ( i - 1 );
  27460. const c = ( radialSegments + 1 ) * j + i;
  27461. const d = ( radialSegments + 1 ) * ( j - 1 ) + i;
  27462. // faces
  27463. indices.push( a, b, d );
  27464. indices.push( b, c, d );
  27465. }
  27466. }
  27467. // build geometry
  27468. this.setIndex( indices );
  27469. this.setAttribute( 'position', new Float32BufferAttribute( vertices, 3 ) );
  27470. this.setAttribute( 'normal', new Float32BufferAttribute( normals, 3 ) );
  27471. this.setAttribute( 'uv', new Float32BufferAttribute( uvs, 2 ) );
  27472. // this function calculates the current position on the torus curve
  27473. function calculatePositionOnCurve( u, p, q, radius, position ) {
  27474. const cu = Math.cos( u );
  27475. const su = Math.sin( u );
  27476. const quOverP = q / p * u;
  27477. const cs = Math.cos( quOverP );
  27478. position.x = radius * ( 2 + cs ) * 0.5 * cu;
  27479. position.y = radius * ( 2 + cs ) * su * 0.5;
  27480. position.z = radius * Math.sin( quOverP ) * 0.5;
  27481. }
  27482. }
  27483. copy( source ) {
  27484. super.copy( source );
  27485. this.parameters = Object.assign( {}, source.parameters );
  27486. return this;
  27487. }
  27488. /**
  27489. * Factory method for creating an instance of this class from the given
  27490. * JSON object.
  27491. *
  27492. * @param {Object} data - A JSON object representing the serialized geometry.
  27493. * @return {TorusKnotGeometry} A new instance.
  27494. */
  27495. static fromJSON( data ) {
  27496. return new TorusKnotGeometry( data.radius, data.tube, data.tubularSegments, data.radialSegments, data.p, data.q );
  27497. }
  27498. }
  27499. /**
  27500. * Creates a tube that extrudes along a 3D curve.
  27501. *
  27502. * ```js
  27503. * class CustomSinCurve extends THREE.Curve {
  27504. *
  27505. * getPoint( t, optionalTarget = new THREE.Vector3() ) {
  27506. *
  27507. * const tx = t * 3 - 1.5;
  27508. * const ty = Math.sin( 2 * Math.PI * t );
  27509. * const tz = 0;
  27510. *
  27511. * return optionalTarget.set( tx, ty, tz );
  27512. * }
  27513. *
  27514. * }
  27515. *
  27516. * const path = new CustomSinCurve( 10 );
  27517. * const geometry = new THREE.TubeGeometry( path, 20, 2, 8, false );
  27518. * const material = new THREE.MeshBasicMaterial( { color: 0x00ff00 } );
  27519. * const mesh = new THREE.Mesh( geometry, material );
  27520. * scene.add( mesh );
  27521. * ```
  27522. *
  27523. * @augments BufferGeometry
  27524. * @demo scenes/geometry-browser.html#TubeGeometry
  27525. */
  27526. class TubeGeometry extends BufferGeometry {
  27527. /**
  27528. * Constructs a new tube geometry.
  27529. *
  27530. * @param {Curve} [path=QuadraticBezierCurve3] - A 3D curve defining the path of the tube.
  27531. * @param {number} [tubularSegments=64] - The number of segments that make up the tube.
  27532. * @param {number} [radius=1] -The radius of the tube.
  27533. * @param {number} [radialSegments=8] - The number of segments that make up the cross-section.
  27534. * @param {boolean} [closed=false] - Whether the tube is closed or not.
  27535. */
  27536. 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 ) {
  27537. super();
  27538. this.type = 'TubeGeometry';
  27539. /**
  27540. * Holds the constructor parameters that have been
  27541. * used to generate the geometry. Any modification
  27542. * after instantiation does not change the geometry.
  27543. *
  27544. * @type {Object}
  27545. */
  27546. this.parameters = {
  27547. path: path,
  27548. tubularSegments: tubularSegments,
  27549. radius: radius,
  27550. radialSegments: radialSegments,
  27551. closed: closed
  27552. };
  27553. const frames = path.computeFrenetFrames( tubularSegments, closed );
  27554. // expose internals
  27555. this.tangents = frames.tangents;
  27556. this.normals = frames.normals;
  27557. this.binormals = frames.binormals;
  27558. // helper variables
  27559. const vertex = new Vector3();
  27560. const normal = new Vector3();
  27561. const uv = new Vector2();
  27562. let P = new Vector3();
  27563. // buffer
  27564. const vertices = [];
  27565. const normals = [];
  27566. const uvs = [];
  27567. const indices = [];
  27568. // create buffer data
  27569. generateBufferData();
  27570. // build geometry
  27571. this.setIndex( indices );
  27572. this.setAttribute( 'position', new Float32BufferAttribute( vertices, 3 ) );
  27573. this.setAttribute( 'normal', new Float32BufferAttribute( normals, 3 ) );
  27574. this.setAttribute( 'uv', new Float32BufferAttribute( uvs, 2 ) );
  27575. // functions
  27576. function generateBufferData() {
  27577. for ( let i = 0; i < tubularSegments; i ++ ) {
  27578. generateSegment( i );
  27579. }
  27580. // if the geometry is not closed, generate the last row of vertices and normals
  27581. // at the regular position on the given path
  27582. //
  27583. // if the geometry is closed, duplicate the first row of vertices and normals (uvs will differ)
  27584. generateSegment( ( closed === false ) ? tubularSegments : 0 );
  27585. // uvs are generated in a separate function.
  27586. // this makes it easy compute correct values for closed geometries
  27587. generateUVs();
  27588. // finally create faces
  27589. generateIndices();
  27590. }
  27591. function generateSegment( i ) {
  27592. // we use getPointAt to sample evenly distributed points from the given path
  27593. P = path.getPointAt( i / tubularSegments, P );
  27594. // retrieve corresponding normal and binormal
  27595. const N = frames.normals[ i ];
  27596. const B = frames.binormals[ i ];
  27597. // generate normals and vertices for the current segment
  27598. for ( let j = 0; j <= radialSegments; j ++ ) {
  27599. const v = j / radialSegments * Math.PI * 2;
  27600. const sin = Math.sin( v );
  27601. const cos = - Math.cos( v );
  27602. // normal
  27603. normal.x = ( cos * N.x + sin * B.x );
  27604. normal.y = ( cos * N.y + sin * B.y );
  27605. normal.z = ( cos * N.z + sin * B.z );
  27606. normal.normalize();
  27607. normals.push( normal.x, normal.y, normal.z );
  27608. // vertex
  27609. vertex.x = P.x + radius * normal.x;
  27610. vertex.y = P.y + radius * normal.y;
  27611. vertex.z = P.z + radius * normal.z;
  27612. vertices.push( vertex.x, vertex.y, vertex.z );
  27613. }
  27614. }
  27615. function generateIndices() {
  27616. for ( let j = 1; j <= tubularSegments; j ++ ) {
  27617. for ( let i = 1; i <= radialSegments; i ++ ) {
  27618. const a = ( radialSegments + 1 ) * ( j - 1 ) + ( i - 1 );
  27619. const b = ( radialSegments + 1 ) * j + ( i - 1 );
  27620. const c = ( radialSegments + 1 ) * j + i;
  27621. const d = ( radialSegments + 1 ) * ( j - 1 ) + i;
  27622. // faces
  27623. indices.push( a, b, d );
  27624. indices.push( b, c, d );
  27625. }
  27626. }
  27627. }
  27628. function generateUVs() {
  27629. for ( let i = 0; i <= tubularSegments; i ++ ) {
  27630. for ( let j = 0; j <= radialSegments; j ++ ) {
  27631. uv.x = i / tubularSegments;
  27632. uv.y = j / radialSegments;
  27633. uvs.push( uv.x, uv.y );
  27634. }
  27635. }
  27636. }
  27637. }
  27638. copy( source ) {
  27639. super.copy( source );
  27640. this.parameters = Object.assign( {}, source.parameters );
  27641. return this;
  27642. }
  27643. toJSON() {
  27644. const data = super.toJSON();
  27645. data.path = this.parameters.path.toJSON();
  27646. return data;
  27647. }
  27648. /**
  27649. * Factory method for creating an instance of this class from the given
  27650. * JSON object.
  27651. *
  27652. * @param {Object} data - A JSON object representing the serialized geometry.
  27653. * @return {TubeGeometry} A new instance.
  27654. */
  27655. static fromJSON( data ) {
  27656. // This only works for built-in curves (e.g. CatmullRomCurve3).
  27657. // User defined curves or instances of CurvePath will not be deserialized.
  27658. return new TubeGeometry(
  27659. new Curves[ data.path.type ]().fromJSON( data.path ),
  27660. data.tubularSegments,
  27661. data.radius,
  27662. data.radialSegments,
  27663. data.closed
  27664. );
  27665. }
  27666. }
  27667. /**
  27668. * Can be used as a helper object to visualize a geometry as a wireframe.
  27669. *
  27670. * ```js
  27671. * const geometry = new THREE.SphereGeometry();
  27672. *
  27673. * const wireframe = new THREE.WireframeGeometry( geometry );
  27674. *
  27675. * const line = new THREE.LineSegments( wireframe );
  27676. * line.material.depthWrite = false;
  27677. * line.material.opacity = 0.25;
  27678. * line.material.transparent = true;
  27679. *
  27680. * scene.add( line );
  27681. * ```
  27682. *
  27683. * Note: It is not yet possible to serialize/deserialize instances of this class.
  27684. *
  27685. * @augments BufferGeometry
  27686. */
  27687. class WireframeGeometry extends BufferGeometry {
  27688. /**
  27689. * Constructs a new wireframe geometry.
  27690. *
  27691. * @param {?BufferGeometry} [geometry=null] - The geometry.
  27692. */
  27693. constructor( geometry = null ) {
  27694. super();
  27695. this.type = 'WireframeGeometry';
  27696. /**
  27697. * Holds the constructor parameters that have been
  27698. * used to generate the geometry. Any modification
  27699. * after instantiation does not change the geometry.
  27700. *
  27701. * @type {Object}
  27702. */
  27703. this.parameters = {
  27704. geometry: geometry
  27705. };
  27706. if ( geometry !== null ) {
  27707. // buffer
  27708. const vertices = [];
  27709. const edges = new Set();
  27710. // helper variables
  27711. const start = new Vector3();
  27712. const end = new Vector3();
  27713. if ( geometry.index !== null ) {
  27714. // indexed BufferGeometry
  27715. const position = geometry.attributes.position;
  27716. const indices = geometry.index;
  27717. let groups = geometry.groups;
  27718. if ( groups.length === 0 ) {
  27719. groups = [ { start: 0, count: indices.count, materialIndex: 0 } ];
  27720. }
  27721. // create a data structure that contains all edges without duplicates
  27722. for ( let o = 0, ol = groups.length; o < ol; ++ o ) {
  27723. const group = groups[ o ];
  27724. const groupStart = group.start;
  27725. const groupCount = group.count;
  27726. for ( let i = groupStart, l = ( groupStart + groupCount ); i < l; i += 3 ) {
  27727. for ( let j = 0; j < 3; j ++ ) {
  27728. const index1 = indices.getX( i + j );
  27729. const index2 = indices.getX( i + ( j + 1 ) % 3 );
  27730. start.fromBufferAttribute( position, index1 );
  27731. end.fromBufferAttribute( position, index2 );
  27732. if ( isUniqueEdge( start, end, edges ) === true ) {
  27733. vertices.push( start.x, start.y, start.z );
  27734. vertices.push( end.x, end.y, end.z );
  27735. }
  27736. }
  27737. }
  27738. }
  27739. } else {
  27740. // non-indexed BufferGeometry
  27741. const position = geometry.attributes.position;
  27742. for ( let i = 0, l = ( position.count / 3 ); i < l; i ++ ) {
  27743. for ( let j = 0; j < 3; j ++ ) {
  27744. // three edges per triangle, an edge is represented as (index1, index2)
  27745. // e.g. the first triangle has the following edges: (0,1),(1,2),(2,0)
  27746. const index1 = 3 * i + j;
  27747. const index2 = 3 * i + ( ( j + 1 ) % 3 );
  27748. start.fromBufferAttribute( position, index1 );
  27749. end.fromBufferAttribute( position, index2 );
  27750. if ( isUniqueEdge( start, end, edges ) === true ) {
  27751. vertices.push( start.x, start.y, start.z );
  27752. vertices.push( end.x, end.y, end.z );
  27753. }
  27754. }
  27755. }
  27756. }
  27757. // build geometry
  27758. this.setAttribute( 'position', new Float32BufferAttribute( vertices, 3 ) );
  27759. }
  27760. }
  27761. copy( source ) {
  27762. super.copy( source );
  27763. this.parameters = Object.assign( {}, source.parameters );
  27764. return this;
  27765. }
  27766. }
  27767. function isUniqueEdge( start, end, edges ) {
  27768. const hash1 = `${start.x},${start.y},${start.z}-${end.x},${end.y},${end.z}`;
  27769. const hash2 = `${end.x},${end.y},${end.z}-${start.x},${start.y},${start.z}`; // coincident edge
  27770. if ( edges.has( hash1 ) === true || edges.has( hash2 ) === true ) {
  27771. return false;
  27772. } else {
  27773. edges.add( hash1 );
  27774. edges.add( hash2 );
  27775. return true;
  27776. }
  27777. }
  27778. var Geometries = /*#__PURE__*/Object.freeze({
  27779. __proto__: null,
  27780. BoxGeometry: BoxGeometry,
  27781. CapsuleGeometry: CapsuleGeometry,
  27782. CircleGeometry: CircleGeometry,
  27783. ConeGeometry: ConeGeometry,
  27784. CylinderGeometry: CylinderGeometry,
  27785. DodecahedronGeometry: DodecahedronGeometry,
  27786. EdgesGeometry: EdgesGeometry,
  27787. ExtrudeGeometry: ExtrudeGeometry,
  27788. IcosahedronGeometry: IcosahedronGeometry,
  27789. LatheGeometry: LatheGeometry,
  27790. OctahedronGeometry: OctahedronGeometry,
  27791. PlaneGeometry: PlaneGeometry,
  27792. PolyhedronGeometry: PolyhedronGeometry,
  27793. RingGeometry: RingGeometry,
  27794. ShapeGeometry: ShapeGeometry,
  27795. SphereGeometry: SphereGeometry,
  27796. TetrahedronGeometry: TetrahedronGeometry,
  27797. TorusGeometry: TorusGeometry,
  27798. TorusKnotGeometry: TorusKnotGeometry,
  27799. TubeGeometry: TubeGeometry,
  27800. WireframeGeometry: WireframeGeometry
  27801. });
  27802. /**
  27803. * This material can receive shadows, but otherwise is completely transparent.
  27804. *
  27805. * ```js
  27806. * const geometry = new THREE.PlaneGeometry( 2000, 2000 );
  27807. * geometry.rotateX( - Math.PI / 2 );
  27808. *
  27809. * const material = new THREE.ShadowMaterial();
  27810. * material.opacity = 0.2;
  27811. *
  27812. * const plane = new THREE.Mesh( geometry, material );
  27813. * plane.position.y = -200;
  27814. * plane.receiveShadow = true;
  27815. * scene.add( plane );
  27816. * ```
  27817. *
  27818. * @augments Material
  27819. */
  27820. class ShadowMaterial extends Material {
  27821. /**
  27822. * Constructs a new shadow material.
  27823. *
  27824. * @param {Object} [parameters] - An object with one or more properties
  27825. * defining the material's appearance. Any property of the material
  27826. * (including any property from inherited materials) can be passed
  27827. * in here. Color values can be passed any type of value accepted
  27828. * by {@link Color#set}.
  27829. */
  27830. constructor( parameters ) {
  27831. super();
  27832. /**
  27833. * This flag can be used for type testing.
  27834. *
  27835. * @type {boolean}
  27836. * @readonly
  27837. * @default true
  27838. */
  27839. this.isShadowMaterial = true;
  27840. this.type = 'ShadowMaterial';
  27841. /**
  27842. * Color of the material.
  27843. *
  27844. * @type {Color}
  27845. * @default (0,0,0)
  27846. */
  27847. this.color = new Color( 0x000000 );
  27848. /**
  27849. * Overwritten since shadow materials are transparent
  27850. * by default.
  27851. *
  27852. * @type {boolean}
  27853. * @default true
  27854. */
  27855. this.transparent = true;
  27856. /**
  27857. * Whether the material is affected by fog or not.
  27858. *
  27859. * @type {boolean}
  27860. * @default true
  27861. */
  27862. this.fog = true;
  27863. this.setValues( parameters );
  27864. }
  27865. copy( source ) {
  27866. super.copy( source );
  27867. this.color.copy( source.color );
  27868. this.fog = source.fog;
  27869. return this;
  27870. }
  27871. }
  27872. /**
  27873. * This class works just like {@link ShaderMaterial}, except that definitions
  27874. * of built-in uniforms and attributes are not automatically prepended to the
  27875. * GLSL shader code.
  27876. *
  27877. * `RawShaderMaterial` can only be used with {@link WebGLRenderer}.
  27878. *
  27879. * @augments ShaderMaterial
  27880. */
  27881. class RawShaderMaterial extends ShaderMaterial {
  27882. /**
  27883. * Constructs a new raw shader material.
  27884. *
  27885. * @param {Object} [parameters] - An object with one or more properties
  27886. * defining the material's appearance. Any property of the material
  27887. * (including any property from inherited materials) can be passed
  27888. * in here. Color values can be passed any type of value accepted
  27889. * by {@link Color#set}.
  27890. */
  27891. constructor( parameters ) {
  27892. super( parameters );
  27893. /**
  27894. * This flag can be used for type testing.
  27895. *
  27896. * @type {boolean}
  27897. * @readonly
  27898. * @default true
  27899. */
  27900. this.isRawShaderMaterial = true;
  27901. this.type = 'RawShaderMaterial';
  27902. }
  27903. }
  27904. /**
  27905. * A standard physically based material, using Metallic-Roughness workflow.
  27906. *
  27907. * Physically based rendering (PBR) has recently become the standard in many
  27908. * 3D applications, such as [Unity](https://blogs.unity3d.com/2014/10/29/physically-based-shading-in-unity-5-a-primer/),
  27909. * [Unreal](https://docs.unrealengine.com/latest/INT/Engine/Rendering/Materials/PhysicallyBased/) and
  27910. * [3D Studio Max](http://area.autodesk.com/blogs/the-3ds-max-blog/what039s-new-for-rendering-in-3ds-max-2017).
  27911. *
  27912. * This approach differs from older approaches in that instead of using
  27913. * approximations for the way in which light interacts with a surface, a
  27914. * physically correct model is used. The idea is that, instead of tweaking
  27915. * materials to look good under specific lighting, a material can be created
  27916. * that will react 'correctly' under all lighting scenarios.
  27917. *
  27918. * In practice this gives a more accurate and realistic looking result than
  27919. * the {@link MeshLambertMaterial} or {@link MeshPhongMaterial}, at the cost of
  27920. * being somewhat more computationally expensive. `MeshStandardMaterial` uses per-fragment
  27921. * shading.
  27922. *
  27923. * Note that for best results you should always specify an environment map when using this material.
  27924. *
  27925. * For a non-technical introduction to the concept of PBR and how to set up a
  27926. * PBR material, check out these articles by the people at [marmoset](https://www.marmoset.co):
  27927. *
  27928. * - [Basic Theory of Physically Based Rendering](https://www.marmoset.co/posts/basic-theory-of-physically-based-rendering/)
  27929. * - [Physically Based Rendering and You Can Too](https://www.marmoset.co/posts/physically-based-rendering-and-you-can-too/)
  27930. *
  27931. * Technical details of the approach used in three.js (and most other PBR systems) can be found is this
  27932. * [paper from Disney](https://media.disneyanimation.com/uploads/production/publication_asset/48/asset/s2012_pbs_disney_brdf_notes_v3.pdf)
  27933. * (pdf), by Brent Burley.
  27934. *
  27935. * @augments Material
  27936. * @demo scenes/material-browser.html#MeshStandardMaterial
  27937. */
  27938. class MeshStandardMaterial extends Material {
  27939. /**
  27940. * Constructs a new mesh standard material.
  27941. *
  27942. * @param {Object} [parameters] - An object with one or more properties
  27943. * defining the material's appearance. Any property of the material
  27944. * (including any property from inherited materials) can be passed
  27945. * in here. Color values can be passed any type of value accepted
  27946. * by {@link Color#set}.
  27947. */
  27948. constructor( parameters ) {
  27949. super();
  27950. /**
  27951. * This flag can be used for type testing.
  27952. *
  27953. * @type {boolean}
  27954. * @readonly
  27955. * @default true
  27956. */
  27957. this.isMeshStandardMaterial = true;
  27958. this.type = 'MeshStandardMaterial';
  27959. this.defines = { 'STANDARD': '' };
  27960. /**
  27961. * Color of the material.
  27962. *
  27963. * @type {Color}
  27964. * @default (1,1,1)
  27965. */
  27966. this.color = new Color( 0xffffff ); // diffuse
  27967. /**
  27968. * How rough the material appears. `0.0` means a smooth mirror reflection, `1.0`
  27969. * means fully diffuse. If `roughnessMap` is also provided,
  27970. * both values are multiplied.
  27971. *
  27972. * @type {number}
  27973. * @default 1
  27974. */
  27975. this.roughness = 1.0;
  27976. /**
  27977. * How much the material is like a metal. Non-metallic materials such as wood
  27978. * or stone use `0.0`, metallic use `1.0`, with nothing (usually) in between.
  27979. * A value between `0.0` and `1.0` could be used for a rusty metal look.
  27980. * If `metalnessMap` is also provided, both values are multiplied.
  27981. *
  27982. * @type {number}
  27983. * @default 0
  27984. */
  27985. this.metalness = 0.0;
  27986. /**
  27987. * The color map. May optionally include an alpha channel, typically combined
  27988. * with {@link Material#transparent} or {@link Material#alphaTest}. The texture map
  27989. * color is modulated by the diffuse `color`.
  27990. *
  27991. * @type {?Texture}
  27992. * @default null
  27993. */
  27994. this.map = null;
  27995. /**
  27996. * The light map. Requires a second set of UVs.
  27997. *
  27998. * @type {?Texture}
  27999. * @default null
  28000. */
  28001. this.lightMap = null;
  28002. /**
  28003. * Intensity of the baked light.
  28004. *
  28005. * @type {number}
  28006. * @default 1
  28007. */
  28008. this.lightMapIntensity = 1.0;
  28009. /**
  28010. * The red channel of this texture is used as the ambient occlusion map.
  28011. * Requires a second set of UVs.
  28012. *
  28013. * @type {?Texture}
  28014. * @default null
  28015. */
  28016. this.aoMap = null;
  28017. /**
  28018. * Intensity of the ambient occlusion effect. Range is `[0,1]`, where `0`
  28019. * disables ambient occlusion. Where intensity is `1` and the AO map's
  28020. * red channel is also `1`, ambient light is fully occluded on a surface.
  28021. *
  28022. * @type {number}
  28023. * @default 1
  28024. */
  28025. this.aoMapIntensity = 1.0;
  28026. /**
  28027. * Emissive (light) color of the material, essentially a solid color
  28028. * unaffected by other lighting.
  28029. *
  28030. * @type {Color}
  28031. * @default (0,0,0)
  28032. */
  28033. this.emissive = new Color( 0x000000 );
  28034. /**
  28035. * Intensity of the emissive light. Modulates the emissive color.
  28036. *
  28037. * @type {number}
  28038. * @default 1
  28039. */
  28040. this.emissiveIntensity = 1.0;
  28041. /**
  28042. * Set emissive (glow) map. The emissive map color is modulated by the
  28043. * emissive color and the emissive intensity. If you have an emissive map,
  28044. * be sure to set the emissive color to something other than black.
  28045. *
  28046. * @type {?Texture}
  28047. * @default null
  28048. */
  28049. this.emissiveMap = null;
  28050. /**
  28051. * The texture to create a bump map. The black and white values map to the
  28052. * perceived depth in relation to the lights. Bump doesn't actually affect
  28053. * the geometry of the object, only the lighting. If a normal map is defined
  28054. * this will be ignored.
  28055. *
  28056. * @type {?Texture}
  28057. * @default null
  28058. */
  28059. this.bumpMap = null;
  28060. /**
  28061. * How much the bump map affects the material. Typical range is `[0,1]`.
  28062. *
  28063. * @type {number}
  28064. * @default 1
  28065. */
  28066. this.bumpScale = 1;
  28067. /**
  28068. * The texture to create a normal map. The RGB values affect the surface
  28069. * normal for each pixel fragment and change the way the color is lit. Normal
  28070. * maps do not change the actual shape of the surface, only the lighting. In
  28071. * case the material has a normal map authored using the left handed
  28072. * convention, the `y` component of `normalScale` should be negated to compensate
  28073. * for the different handedness.
  28074. *
  28075. * @type {?Texture}
  28076. * @default null
  28077. */
  28078. this.normalMap = null;
  28079. /**
  28080. * The type of normal map.
  28081. *
  28082. * @type {(TangentSpaceNormalMap|ObjectSpaceNormalMap)}
  28083. * @default TangentSpaceNormalMap
  28084. */
  28085. this.normalMapType = TangentSpaceNormalMap;
  28086. /**
  28087. * How much the normal map affects the material. Typical value range is `[0,1]`.
  28088. *
  28089. * @type {Vector2}
  28090. * @default (1,1)
  28091. */
  28092. this.normalScale = new Vector2( 1, 1 );
  28093. /**
  28094. * The displacement map affects the position of the mesh's vertices. Unlike
  28095. * other maps which only affect the light and shade of the material the
  28096. * displaced vertices can cast shadows, block other objects, and otherwise
  28097. * act as real geometry. The displacement texture is an image where the value
  28098. * of each pixel (white being the highest) is mapped against, and
  28099. * repositions, the vertices of the mesh.
  28100. *
  28101. * @type {?Texture}
  28102. * @default null
  28103. */
  28104. this.displacementMap = null;
  28105. /**
  28106. * How much the displacement map affects the mesh (where black is no
  28107. * displacement, and white is maximum displacement). Without a displacement
  28108. * map set, this value is not applied.
  28109. *
  28110. * @type {number}
  28111. * @default 0
  28112. */
  28113. this.displacementScale = 1;
  28114. /**
  28115. * The offset of the displacement map's values on the mesh's vertices.
  28116. * The bias is added to the scaled sample of the displacement map.
  28117. * Without a displacement map set, this value is not applied.
  28118. *
  28119. * @type {number}
  28120. * @default 0
  28121. */
  28122. this.displacementBias = 0;
  28123. /**
  28124. * The green channel of this texture is used to alter the roughness of the
  28125. * material.
  28126. *
  28127. * @type {?Texture}
  28128. * @default null
  28129. */
  28130. this.roughnessMap = null;
  28131. /**
  28132. * The blue channel of this texture is used to alter the metalness of the
  28133. * material.
  28134. *
  28135. * @type {?Texture}
  28136. * @default null
  28137. */
  28138. this.metalnessMap = null;
  28139. /**
  28140. * The alpha map is a grayscale texture that controls the opacity across the
  28141. * surface (black: fully transparent; white: fully opaque).
  28142. *
  28143. * Only the color of the texture is used, ignoring the alpha channel if one
  28144. * exists. For RGB and RGBA textures, the renderer will use the green channel
  28145. * when sampling this texture due to the extra bit of precision provided for
  28146. * green in DXT-compressed and uncompressed RGB 565 formats. Luminance-only and
  28147. * luminance/alpha textures will also still work as expected.
  28148. *
  28149. * @type {?Texture}
  28150. * @default null
  28151. */
  28152. this.alphaMap = null;
  28153. /**
  28154. * The environment map. To ensure a physically correct rendering, environment maps
  28155. * are internally pre-processed with {@link PMREMGenerator}.
  28156. *
  28157. * @type {?Texture}
  28158. * @default null
  28159. */
  28160. this.envMap = null;
  28161. /**
  28162. * The rotation of the environment map in radians.
  28163. *
  28164. * @type {Euler}
  28165. * @default (0,0,0)
  28166. */
  28167. this.envMapRotation = new Euler();
  28168. /**
  28169. * Scales the effect of the environment map by multiplying its color.
  28170. *
  28171. * @type {number}
  28172. * @default 1
  28173. */
  28174. this.envMapIntensity = 1.0;
  28175. /**
  28176. * Renders the geometry as a wireframe.
  28177. *
  28178. * @type {boolean}
  28179. * @default false
  28180. */
  28181. this.wireframe = false;
  28182. /**
  28183. * Controls the thickness of the wireframe.
  28184. *
  28185. * Can only be used with {@link SVGRenderer}.
  28186. *
  28187. * @type {number}
  28188. * @default 1
  28189. */
  28190. this.wireframeLinewidth = 1;
  28191. /**
  28192. * Defines appearance of wireframe ends.
  28193. *
  28194. * Can only be used with {@link SVGRenderer}.
  28195. *
  28196. * @type {('round'|'bevel'|'miter')}
  28197. * @default 'round'
  28198. */
  28199. this.wireframeLinecap = 'round';
  28200. /**
  28201. * Defines appearance of wireframe joints.
  28202. *
  28203. * Can only be used with {@link SVGRenderer}.
  28204. *
  28205. * @type {('round'|'bevel'|'miter')}
  28206. * @default 'round'
  28207. */
  28208. this.wireframeLinejoin = 'round';
  28209. /**
  28210. * Whether the material is rendered with flat shading or not.
  28211. *
  28212. * @type {boolean}
  28213. * @default false
  28214. */
  28215. this.flatShading = false;
  28216. /**
  28217. * Whether the material is affected by fog or not.
  28218. *
  28219. * @type {boolean}
  28220. * @default true
  28221. */
  28222. this.fog = true;
  28223. this.setValues( parameters );
  28224. }
  28225. copy( source ) {
  28226. super.copy( source );
  28227. this.defines = { 'STANDARD': '' };
  28228. this.color.copy( source.color );
  28229. this.roughness = source.roughness;
  28230. this.metalness = source.metalness;
  28231. this.map = source.map;
  28232. this.lightMap = source.lightMap;
  28233. this.lightMapIntensity = source.lightMapIntensity;
  28234. this.aoMap = source.aoMap;
  28235. this.aoMapIntensity = source.aoMapIntensity;
  28236. this.emissive.copy( source.emissive );
  28237. this.emissiveMap = source.emissiveMap;
  28238. this.emissiveIntensity = source.emissiveIntensity;
  28239. this.bumpMap = source.bumpMap;
  28240. this.bumpScale = source.bumpScale;
  28241. this.normalMap = source.normalMap;
  28242. this.normalMapType = source.normalMapType;
  28243. this.normalScale.copy( source.normalScale );
  28244. this.displacementMap = source.displacementMap;
  28245. this.displacementScale = source.displacementScale;
  28246. this.displacementBias = source.displacementBias;
  28247. this.roughnessMap = source.roughnessMap;
  28248. this.metalnessMap = source.metalnessMap;
  28249. this.alphaMap = source.alphaMap;
  28250. this.envMap = source.envMap;
  28251. this.envMapRotation.copy( source.envMapRotation );
  28252. this.envMapIntensity = source.envMapIntensity;
  28253. this.wireframe = source.wireframe;
  28254. this.wireframeLinewidth = source.wireframeLinewidth;
  28255. this.wireframeLinecap = source.wireframeLinecap;
  28256. this.wireframeLinejoin = source.wireframeLinejoin;
  28257. this.flatShading = source.flatShading;
  28258. this.fog = source.fog;
  28259. return this;
  28260. }
  28261. }
  28262. /**
  28263. * An extension of the {@link MeshStandardMaterial}, providing more advanced
  28264. * physically-based rendering properties:
  28265. *
  28266. * - Anisotropy: Ability to represent the anisotropic property of materials
  28267. * as observable with brushed metals.
  28268. * - Clearcoat: Some materials — like car paints, carbon fiber, and wet surfaces — require
  28269. * a clear, reflective layer on top of another layer that may be irregular or rough.
  28270. * Clearcoat approximates this effect, without the need for a separate transparent surface.
  28271. * - Iridescence: Allows to render the effect where hue varies depending on the viewing
  28272. * angle and illumination angle. This can be seen on soap bubbles, oil films, or on the
  28273. * wings of many insects.
  28274. * - Physically-based transparency: One limitation of {@link Material#opacity} is that highly
  28275. * transparent materials are less reflective. Physically-based transmission provides a more
  28276. * realistic option for thin, transparent surfaces like glass.
  28277. * - Advanced reflectivity: More flexible reflectivity for non-metallic materials.
  28278. * - Sheen: Can be used for representing cloth and fabric materials.
  28279. *
  28280. * As a result of these complex shading features, `MeshPhysicalMaterial` has a
  28281. * higher performance cost, per pixel, than other three.js materials. Most
  28282. * effects are disabled by default, and add cost as they are enabled. For
  28283. * best results, always specify an environment map when using this material.
  28284. *
  28285. * @augments MeshStandardMaterial
  28286. * @demo scenes/material-browser.html#MeshPhysicalMaterial
  28287. */
  28288. class MeshPhysicalMaterial extends MeshStandardMaterial {
  28289. /**
  28290. * Constructs a new mesh physical material.
  28291. *
  28292. * @param {Object} [parameters] - An object with one or more properties
  28293. * defining the material's appearance. Any property of the material
  28294. * (including any property from inherited materials) can be passed
  28295. * in here. Color values can be passed any type of value accepted
  28296. * by {@link Color#set}.
  28297. */
  28298. constructor( parameters ) {
  28299. super();
  28300. /**
  28301. * This flag can be used for type testing.
  28302. *
  28303. * @type {boolean}
  28304. * @readonly
  28305. * @default true
  28306. */
  28307. this.isMeshPhysicalMaterial = true;
  28308. this.defines = {
  28309. 'STANDARD': '',
  28310. 'PHYSICAL': ''
  28311. };
  28312. this.type = 'MeshPhysicalMaterial';
  28313. /**
  28314. * The rotation of the anisotropy in tangent, bitangent space, measured in radians
  28315. * counter-clockwise from the tangent. When `anisotropyMap` is present, this
  28316. * property provides additional rotation to the vectors in the texture.
  28317. *
  28318. * @type {number}
  28319. * @default 1
  28320. */
  28321. this.anisotropyRotation = 0;
  28322. /**
  28323. * Red and green channels represent the anisotropy direction in `[-1, 1]` tangent,
  28324. * bitangent space, to be rotated by `anisotropyRotation`. The blue channel
  28325. * contains strength as `[0, 1]` to be multiplied by `anisotropy`.
  28326. *
  28327. * @type {?Texture}
  28328. * @default null
  28329. */
  28330. this.anisotropyMap = null;
  28331. /**
  28332. * The red channel of this texture is multiplied against `clearcoat`,
  28333. * for per-pixel control over a coating's intensity.
  28334. *
  28335. * @type {?Texture}
  28336. * @default null
  28337. */
  28338. this.clearcoatMap = null;
  28339. /**
  28340. * Roughness of the clear coat layer, from `0.0` to `1.0`.
  28341. *
  28342. * @type {number}
  28343. * @default 0
  28344. */
  28345. this.clearcoatRoughness = 0.0;
  28346. /**
  28347. * The green channel of this texture is multiplied against
  28348. * `clearcoatRoughness`, for per-pixel control over a coating's roughness.
  28349. *
  28350. * @type {?Texture}
  28351. * @default null
  28352. */
  28353. this.clearcoatRoughnessMap = null;
  28354. /**
  28355. * How much `clearcoatNormalMap` affects the clear coat layer, from
  28356. * `(0,0)` to `(1,1)`.
  28357. *
  28358. * @type {Vector2}
  28359. * @default (1,1)
  28360. */
  28361. this.clearcoatNormalScale = new Vector2( 1, 1 );
  28362. /**
  28363. * Can be used to enable independent normals for the clear coat layer.
  28364. *
  28365. * @type {?Texture}
  28366. * @default null
  28367. */
  28368. this.clearcoatNormalMap = null;
  28369. /**
  28370. * Index-of-refraction for non-metallic materials, from `1.0` to `2.333`.
  28371. *
  28372. * @type {number}
  28373. * @default 1.5
  28374. */
  28375. this.ior = 1.5;
  28376. /**
  28377. * Degree of reflectivity, from `0.0` to `1.0`. Default is `0.5`, which
  28378. * corresponds to an index-of-refraction of `1.5`.
  28379. *
  28380. * This models the reflectivity of non-metallic materials. It has no effect
  28381. * when `metalness` is `1.0`
  28382. *
  28383. * @name MeshPhysicalMaterial#reflectivity
  28384. * @type {number}
  28385. * @default 0.5
  28386. */
  28387. Object.defineProperty( this, 'reflectivity', {
  28388. get: function () {
  28389. return ( clamp( 2.5 * ( this.ior - 1 ) / ( this.ior + 1 ), 0, 1 ) );
  28390. },
  28391. set: function ( reflectivity ) {
  28392. this.ior = ( 1 + 0.4 * reflectivity ) / ( 1 - 0.4 * reflectivity );
  28393. }
  28394. } );
  28395. /**
  28396. * The red channel of this texture is multiplied against `iridescence`, for per-pixel
  28397. * control over iridescence.
  28398. *
  28399. * @type {?Texture}
  28400. * @default null
  28401. */
  28402. this.iridescenceMap = null;
  28403. /**
  28404. * Strength of the iridescence RGB color shift effect, represented by an index-of-refraction.
  28405. * Between `1.0` to `2.333`.
  28406. *
  28407. * @type {number}
  28408. * @default 1.3
  28409. */
  28410. this.iridescenceIOR = 1.3;
  28411. /**
  28412. *Array of exactly 2 elements, specifying minimum and maximum thickness of the iridescence layer.
  28413. Thickness of iridescence layer has an equivalent effect of the one `thickness` has on `ior`.
  28414. *
  28415. * @type {Array<number,number>}
  28416. * @default [100,400]
  28417. */
  28418. this.iridescenceThicknessRange = [ 100, 400 ];
  28419. /**
  28420. * A texture that defines the thickness of the iridescence layer, stored in the green channel.
  28421. * Minimum and maximum values of thickness are defined by `iridescenceThicknessRange` array:
  28422. * - `0.0` in the green channel will result in thickness equal to first element of the array.
  28423. * - `1.0` in the green channel will result in thickness equal to second element of the array.
  28424. * - Values in-between will linearly interpolate between the elements of the array.
  28425. *
  28426. * @type {?Texture}
  28427. * @default null
  28428. */
  28429. this.iridescenceThicknessMap = null;
  28430. /**
  28431. * The sheen tint.
  28432. *
  28433. * @type {Color}
  28434. * @default (0,0,0)
  28435. */
  28436. this.sheenColor = new Color( 0x000000 );
  28437. /**
  28438. * The RGB channels of this texture are multiplied against `sheenColor`, for per-pixel control
  28439. * over sheen tint.
  28440. *
  28441. * @type {?Texture}
  28442. * @default null
  28443. */
  28444. this.sheenColorMap = null;
  28445. /**
  28446. * Roughness of the sheen layer, from `0.0` to `1.0`.
  28447. *
  28448. * @type {number}
  28449. * @default 1
  28450. */
  28451. this.sheenRoughness = 1.0;
  28452. /**
  28453. * The alpha channel of this texture is multiplied against `sheenRoughness`, for per-pixel control
  28454. * over sheen roughness.
  28455. *
  28456. * @type {?Texture}
  28457. * @default null
  28458. */
  28459. this.sheenRoughnessMap = null;
  28460. /**
  28461. * The red channel of this texture is multiplied against `transmission`, for per-pixel control over
  28462. * optical transparency.
  28463. *
  28464. * @type {?Texture}
  28465. * @default null
  28466. */
  28467. this.transmissionMap = null;
  28468. /**
  28469. * The thickness of the volume beneath the surface. The value is given in the
  28470. * coordinate space of the mesh. If the value is `0` the material is
  28471. * thin-walled. Otherwise the material is a volume boundary.
  28472. *
  28473. * @type {number}
  28474. * @default 0
  28475. */
  28476. this.thickness = 0;
  28477. /**
  28478. * A texture that defines the thickness, stored in the green channel. This will
  28479. * be multiplied by `thickness`.
  28480. *
  28481. * @type {?Texture}
  28482. * @default null
  28483. */
  28484. this.thicknessMap = null;
  28485. /**
  28486. * Density of the medium given as the average distance that light travels in
  28487. * the medium before interacting with a particle. The value is given in world
  28488. * space units, and must be greater than zero.
  28489. *
  28490. * @type {number}
  28491. * @default Infinity
  28492. */
  28493. this.attenuationDistance = Infinity;
  28494. /**
  28495. * The color that white light turns into due to absorption when reaching the
  28496. * attenuation distance.
  28497. *
  28498. * @type {Color}
  28499. * @default (1,1,1)
  28500. */
  28501. this.attenuationColor = new Color( 1, 1, 1 );
  28502. /**
  28503. * A float that scales the amount of specular reflection for non-metals only.
  28504. * When set to zero, the model is effectively Lambertian. From `0.0` to `1.0`.
  28505. *
  28506. * @type {number}
  28507. * @default 1
  28508. */
  28509. this.specularIntensity = 1.0;
  28510. /**
  28511. * The alpha channel of this texture is multiplied against `specularIntensity`,
  28512. * for per-pixel control over specular intensity.
  28513. *
  28514. * @type {?Texture}
  28515. * @default null
  28516. */
  28517. this.specularIntensityMap = null;
  28518. /**
  28519. * Tints the specular reflection at normal incidence for non-metals only.
  28520. *
  28521. * @type {Color}
  28522. * @default (1,1,1)
  28523. */
  28524. this.specularColor = new Color( 1, 1, 1 );
  28525. /**
  28526. * The RGB channels of this texture are multiplied against `specularColor`,
  28527. * for per-pixel control over specular color.
  28528. *
  28529. * @type {?Texture}
  28530. * @default null
  28531. */
  28532. this.specularColorMap = null;
  28533. this._anisotropy = 0;
  28534. this._clearcoat = 0;
  28535. this._dispersion = 0;
  28536. this._iridescence = 0;
  28537. this._sheen = 0.0;
  28538. this._transmission = 0;
  28539. this.setValues( parameters );
  28540. }
  28541. /**
  28542. * The anisotropy strength, from `0.0` to `1.0`.
  28543. *
  28544. * @type {number}
  28545. * @default 0
  28546. */
  28547. get anisotropy() {
  28548. return this._anisotropy;
  28549. }
  28550. set anisotropy( value ) {
  28551. if ( this._anisotropy > 0 !== value > 0 ) {
  28552. this.version ++;
  28553. }
  28554. this._anisotropy = value;
  28555. }
  28556. /**
  28557. * Represents the intensity of the clear coat layer, from `0.0` to `1.0`. Use
  28558. * clear coat related properties to enable multilayer materials that have a
  28559. * thin translucent layer over the base layer.
  28560. *
  28561. * @type {number}
  28562. * @default 0
  28563. */
  28564. get clearcoat() {
  28565. return this._clearcoat;
  28566. }
  28567. set clearcoat( value ) {
  28568. if ( this._clearcoat > 0 !== value > 0 ) {
  28569. this.version ++;
  28570. }
  28571. this._clearcoat = value;
  28572. }
  28573. /**
  28574. * The intensity of the iridescence layer, simulating RGB color shift based on the angle between
  28575. * the surface and the viewer, from `0.0` to `1.0`.
  28576. *
  28577. * @type {number}
  28578. * @default 0
  28579. */
  28580. get iridescence() {
  28581. return this._iridescence;
  28582. }
  28583. set iridescence( value ) {
  28584. if ( this._iridescence > 0 !== value > 0 ) {
  28585. this.version ++;
  28586. }
  28587. this._iridescence = value;
  28588. }
  28589. /**
  28590. * Defines the strength of the angular separation of colors (chromatic aberration) transmitting
  28591. * through a relatively clear volume. Any value zero or larger is valid, the typical range of
  28592. * realistic values is `[0, 1]`. This property can be only be used with transmissive objects.
  28593. *
  28594. * @type {number}
  28595. * @default 0
  28596. */
  28597. get dispersion() {
  28598. return this._dispersion;
  28599. }
  28600. set dispersion( value ) {
  28601. if ( this._dispersion > 0 !== value > 0 ) {
  28602. this.version ++;
  28603. }
  28604. this._dispersion = value;
  28605. }
  28606. /**
  28607. * The intensity of the sheen layer, from `0.0` to `1.0`.
  28608. *
  28609. * @type {number}
  28610. * @default 0
  28611. */
  28612. get sheen() {
  28613. return this._sheen;
  28614. }
  28615. set sheen( value ) {
  28616. if ( this._sheen > 0 !== value > 0 ) {
  28617. this.version ++;
  28618. }
  28619. this._sheen = value;
  28620. }
  28621. /**
  28622. * Degree of transmission (or optical transparency), from `0.0` to `1.0`.
  28623. *
  28624. * Thin, transparent or semitransparent, plastic or glass materials remain
  28625. * largely reflective even if they are fully transmissive. The transmission
  28626. * property can be used to model these materials.
  28627. *
  28628. * When transmission is non-zero, `opacity` should be set to `1`.
  28629. *
  28630. * @type {number}
  28631. * @default 0
  28632. */
  28633. get transmission() {
  28634. return this._transmission;
  28635. }
  28636. set transmission( value ) {
  28637. if ( this._transmission > 0 !== value > 0 ) {
  28638. this.version ++;
  28639. }
  28640. this._transmission = value;
  28641. }
  28642. copy( source ) {
  28643. super.copy( source );
  28644. this.defines = {
  28645. 'STANDARD': '',
  28646. 'PHYSICAL': ''
  28647. };
  28648. this.anisotropy = source.anisotropy;
  28649. this.anisotropyRotation = source.anisotropyRotation;
  28650. this.anisotropyMap = source.anisotropyMap;
  28651. this.clearcoat = source.clearcoat;
  28652. this.clearcoatMap = source.clearcoatMap;
  28653. this.clearcoatRoughness = source.clearcoatRoughness;
  28654. this.clearcoatRoughnessMap = source.clearcoatRoughnessMap;
  28655. this.clearcoatNormalMap = source.clearcoatNormalMap;
  28656. this.clearcoatNormalScale.copy( source.clearcoatNormalScale );
  28657. this.dispersion = source.dispersion;
  28658. this.ior = source.ior;
  28659. this.iridescence = source.iridescence;
  28660. this.iridescenceMap = source.iridescenceMap;
  28661. this.iridescenceIOR = source.iridescenceIOR;
  28662. this.iridescenceThicknessRange = [ ...source.iridescenceThicknessRange ];
  28663. this.iridescenceThicknessMap = source.iridescenceThicknessMap;
  28664. this.sheen = source.sheen;
  28665. this.sheenColor.copy( source.sheenColor );
  28666. this.sheenColorMap = source.sheenColorMap;
  28667. this.sheenRoughness = source.sheenRoughness;
  28668. this.sheenRoughnessMap = source.sheenRoughnessMap;
  28669. this.transmission = source.transmission;
  28670. this.transmissionMap = source.transmissionMap;
  28671. this.thickness = source.thickness;
  28672. this.thicknessMap = source.thicknessMap;
  28673. this.attenuationDistance = source.attenuationDistance;
  28674. this.attenuationColor.copy( source.attenuationColor );
  28675. this.specularIntensity = source.specularIntensity;
  28676. this.specularIntensityMap = source.specularIntensityMap;
  28677. this.specularColor.copy( source.specularColor );
  28678. this.specularColorMap = source.specularColorMap;
  28679. return this;
  28680. }
  28681. }
  28682. /**
  28683. * A material for shiny surfaces with specular highlights.
  28684. *
  28685. * The material uses a non-physically based [Blinn-Phong](https://en.wikipedia.org/wiki/Blinn-Phong_shading_model)
  28686. * model for calculating reflectance. Unlike the Lambertian model used in the
  28687. * {@link MeshLambertMaterial} this can simulate shiny surfaces with specular
  28688. * highlights (such as varnished wood). `MeshPhongMaterial` uses per-fragment shading.
  28689. *
  28690. * Performance will generally be greater when using this material over the
  28691. * {@link MeshStandardMaterial} or {@link MeshPhysicalMaterial}, at the cost of
  28692. * some graphical accuracy.
  28693. *
  28694. * @augments Material
  28695. * @demo scenes/material-browser.html#MeshPhongMaterial
  28696. */
  28697. class MeshPhongMaterial extends Material {
  28698. /**
  28699. * Constructs a new mesh phong material.
  28700. *
  28701. * @param {Object} [parameters] - An object with one or more properties
  28702. * defining the material's appearance. Any property of the material
  28703. * (including any property from inherited materials) can be passed
  28704. * in here. Color values can be passed any type of value accepted
  28705. * by {@link Color#set}.
  28706. */
  28707. constructor( parameters ) {
  28708. super();
  28709. /**
  28710. * This flag can be used for type testing.
  28711. *
  28712. * @type {boolean}
  28713. * @readonly
  28714. * @default true
  28715. */
  28716. this.isMeshPhongMaterial = true;
  28717. this.type = 'MeshPhongMaterial';
  28718. /**
  28719. * Color of the material.
  28720. *
  28721. * @type {Color}
  28722. * @default (1,1,1)
  28723. */
  28724. this.color = new Color( 0xffffff ); // diffuse
  28725. /**
  28726. * Specular color of the material. The default color is set to `0x111111` (very dark grey)
  28727. *
  28728. * This defines how shiny the material is and the color of its shine.
  28729. *
  28730. * @type {Color}
  28731. */
  28732. this.specular = new Color( 0x111111 );
  28733. /**
  28734. * How shiny the specular highlight is; a higher value gives a sharper highlight.
  28735. *
  28736. * @type {number}
  28737. * @default 30
  28738. */
  28739. this.shininess = 30;
  28740. /**
  28741. * The color map. May optionally include an alpha channel, typically combined
  28742. * with {@link Material#transparent} or {@link Material#alphaTest}. The texture map
  28743. * color is modulated by the diffuse `color`.
  28744. *
  28745. * @type {?Texture}
  28746. * @default null
  28747. */
  28748. this.map = null;
  28749. /**
  28750. * The light map. Requires a second set of UVs.
  28751. *
  28752. * @type {?Texture}
  28753. * @default null
  28754. */
  28755. this.lightMap = null;
  28756. /**
  28757. * Intensity of the baked light.
  28758. *
  28759. * @type {number}
  28760. * @default 1
  28761. */
  28762. this.lightMapIntensity = 1.0;
  28763. /**
  28764. * The red channel of this texture is used as the ambient occlusion map.
  28765. * Requires a second set of UVs.
  28766. *
  28767. * @type {?Texture}
  28768. * @default null
  28769. */
  28770. this.aoMap = null;
  28771. /**
  28772. * Intensity of the ambient occlusion effect. Range is `[0,1]`, where `0`
  28773. * disables ambient occlusion. Where intensity is `1` and the AO map's
  28774. * red channel is also `1`, ambient light is fully occluded on a surface.
  28775. *
  28776. * @type {number}
  28777. * @default 1
  28778. */
  28779. this.aoMapIntensity = 1.0;
  28780. /**
  28781. * Emissive (light) color of the material, essentially a solid color
  28782. * unaffected by other lighting.
  28783. *
  28784. * @type {Color}
  28785. * @default (0,0,0)
  28786. */
  28787. this.emissive = new Color( 0x000000 );
  28788. /**
  28789. * Intensity of the emissive light. Modulates the emissive color.
  28790. *
  28791. * @type {number}
  28792. * @default 1
  28793. */
  28794. this.emissiveIntensity = 1.0;
  28795. /**
  28796. * Set emissive (glow) map. The emissive map color is modulated by the
  28797. * emissive color and the emissive intensity. If you have an emissive map,
  28798. * be sure to set the emissive color to something other than black.
  28799. *
  28800. * @type {?Texture}
  28801. * @default null
  28802. */
  28803. this.emissiveMap = null;
  28804. /**
  28805. * The texture to create a bump map. The black and white values map to the
  28806. * perceived depth in relation to the lights. Bump doesn't actually affect
  28807. * the geometry of the object, only the lighting. If a normal map is defined
  28808. * this will be ignored.
  28809. *
  28810. * @type {?Texture}
  28811. * @default null
  28812. */
  28813. this.bumpMap = null;
  28814. /**
  28815. * How much the bump map affects the material. Typical range is `[0,1]`.
  28816. *
  28817. * @type {number}
  28818. * @default 1
  28819. */
  28820. this.bumpScale = 1;
  28821. /**
  28822. * The texture to create a normal map. The RGB values affect the surface
  28823. * normal for each pixel fragment and change the way the color is lit. Normal
  28824. * maps do not change the actual shape of the surface, only the lighting. In
  28825. * case the material has a normal map authored using the left handed
  28826. * convention, the `y` component of `normalScale` should be negated to compensate
  28827. * for the different handedness.
  28828. *
  28829. * @type {?Texture}
  28830. * @default null
  28831. */
  28832. this.normalMap = null;
  28833. /**
  28834. * The type of normal map.
  28835. *
  28836. * @type {(TangentSpaceNormalMap|ObjectSpaceNormalMap)}
  28837. * @default TangentSpaceNormalMap
  28838. */
  28839. this.normalMapType = TangentSpaceNormalMap;
  28840. /**
  28841. * How much the normal map affects the material. Typical value range is `[0,1]`.
  28842. *
  28843. * @type {Vector2}
  28844. * @default (1,1)
  28845. */
  28846. this.normalScale = new Vector2( 1, 1 );
  28847. /**
  28848. * The displacement map affects the position of the mesh's vertices. Unlike
  28849. * other maps which only affect the light and shade of the material the
  28850. * displaced vertices can cast shadows, block other objects, and otherwise
  28851. * act as real geometry. The displacement texture is an image where the value
  28852. * of each pixel (white being the highest) is mapped against, and
  28853. * repositions, the vertices of the mesh.
  28854. *
  28855. * @type {?Texture}
  28856. * @default null
  28857. */
  28858. this.displacementMap = null;
  28859. /**
  28860. * How much the displacement map affects the mesh (where black is no
  28861. * displacement, and white is maximum displacement). Without a displacement
  28862. * map set, this value is not applied.
  28863. *
  28864. * @type {number}
  28865. * @default 0
  28866. */
  28867. this.displacementScale = 1;
  28868. /**
  28869. * The offset of the displacement map's values on the mesh's vertices.
  28870. * The bias is added to the scaled sample of the displacement map.
  28871. * Without a displacement map set, this value is not applied.
  28872. *
  28873. * @type {number}
  28874. * @default 0
  28875. */
  28876. this.displacementBias = 0;
  28877. /**
  28878. * The specular map value affects both how much the specular surface
  28879. * highlight contributes and how much of the environment map affects the
  28880. * surface.
  28881. *
  28882. * @type {?Texture}
  28883. * @default null
  28884. */
  28885. this.specularMap = null;
  28886. /**
  28887. * The alpha map is a grayscale texture that controls the opacity across the
  28888. * surface (black: fully transparent; white: fully opaque).
  28889. *
  28890. * Only the color of the texture is used, ignoring the alpha channel if one
  28891. * exists. For RGB and RGBA textures, the renderer will use the green channel
  28892. * when sampling this texture due to the extra bit of precision provided for
  28893. * green in DXT-compressed and uncompressed RGB 565 formats. Luminance-only and
  28894. * luminance/alpha textures will also still work as expected.
  28895. *
  28896. * @type {?Texture}
  28897. * @default null
  28898. */
  28899. this.alphaMap = null;
  28900. /**
  28901. * The environment map.
  28902. *
  28903. * @type {?Texture}
  28904. * @default null
  28905. */
  28906. this.envMap = null;
  28907. /**
  28908. * The rotation of the environment map in radians.
  28909. *
  28910. * @type {Euler}
  28911. * @default (0,0,0)
  28912. */
  28913. this.envMapRotation = new Euler();
  28914. /**
  28915. * How to combine the result of the surface's color with the environment map, if any.
  28916. *
  28917. * When set to `MixOperation`, the {@link MeshBasicMaterial#reflectivity} is used to
  28918. * blend between the two colors.
  28919. *
  28920. * @type {(MultiplyOperation|MixOperation|AddOperation)}
  28921. * @default MultiplyOperation
  28922. */
  28923. this.combine = MultiplyOperation;
  28924. /**
  28925. * How much the environment map affects the surface.
  28926. * The valid range is between `0` (no reflections) and `1` (full reflections).
  28927. *
  28928. * @type {number}
  28929. * @default 1
  28930. */
  28931. this.reflectivity = 1;
  28932. /**
  28933. * The index of refraction (IOR) of air (approximately 1) divided by the
  28934. * index of refraction of the material. It is used with environment mapping
  28935. * modes {@link CubeRefractionMapping} and {@link EquirectangularRefractionMapping}.
  28936. * The refraction ratio should not exceed `1`.
  28937. *
  28938. * @type {number}
  28939. * @default 0.98
  28940. */
  28941. this.refractionRatio = 0.98;
  28942. /**
  28943. * Renders the geometry as a wireframe.
  28944. *
  28945. * @type {boolean}
  28946. * @default false
  28947. */
  28948. this.wireframe = false;
  28949. /**
  28950. * Controls the thickness of the wireframe.
  28951. *
  28952. * Can only be used with {@link SVGRenderer}.
  28953. *
  28954. * @type {number}
  28955. * @default 1
  28956. */
  28957. this.wireframeLinewidth = 1;
  28958. /**
  28959. * Defines appearance of wireframe ends.
  28960. *
  28961. * Can only be used with {@link SVGRenderer}.
  28962. *
  28963. * @type {('round'|'bevel'|'miter')}
  28964. * @default 'round'
  28965. */
  28966. this.wireframeLinecap = 'round';
  28967. /**
  28968. * Defines appearance of wireframe joints.
  28969. *
  28970. * Can only be used with {@link SVGRenderer}.
  28971. *
  28972. * @type {('round'|'bevel'|'miter')}
  28973. * @default 'round'
  28974. */
  28975. this.wireframeLinejoin = 'round';
  28976. /**
  28977. * Whether the material is rendered with flat shading or not.
  28978. *
  28979. * @type {boolean}
  28980. * @default false
  28981. */
  28982. this.flatShading = false;
  28983. /**
  28984. * Whether the material is affected by fog or not.
  28985. *
  28986. * @type {boolean}
  28987. * @default true
  28988. */
  28989. this.fog = true;
  28990. this.setValues( parameters );
  28991. }
  28992. copy( source ) {
  28993. super.copy( source );
  28994. this.color.copy( source.color );
  28995. this.specular.copy( source.specular );
  28996. this.shininess = source.shininess;
  28997. this.map = source.map;
  28998. this.lightMap = source.lightMap;
  28999. this.lightMapIntensity = source.lightMapIntensity;
  29000. this.aoMap = source.aoMap;
  29001. this.aoMapIntensity = source.aoMapIntensity;
  29002. this.emissive.copy( source.emissive );
  29003. this.emissiveMap = source.emissiveMap;
  29004. this.emissiveIntensity = source.emissiveIntensity;
  29005. this.bumpMap = source.bumpMap;
  29006. this.bumpScale = source.bumpScale;
  29007. this.normalMap = source.normalMap;
  29008. this.normalMapType = source.normalMapType;
  29009. this.normalScale.copy( source.normalScale );
  29010. this.displacementMap = source.displacementMap;
  29011. this.displacementScale = source.displacementScale;
  29012. this.displacementBias = source.displacementBias;
  29013. this.specularMap = source.specularMap;
  29014. this.alphaMap = source.alphaMap;
  29015. this.envMap = source.envMap;
  29016. this.envMapRotation.copy( source.envMapRotation );
  29017. this.combine = source.combine;
  29018. this.reflectivity = source.reflectivity;
  29019. this.refractionRatio = source.refractionRatio;
  29020. this.wireframe = source.wireframe;
  29021. this.wireframeLinewidth = source.wireframeLinewidth;
  29022. this.wireframeLinecap = source.wireframeLinecap;
  29023. this.wireframeLinejoin = source.wireframeLinejoin;
  29024. this.flatShading = source.flatShading;
  29025. this.fog = source.fog;
  29026. return this;
  29027. }
  29028. }
  29029. /**
  29030. * A material implementing toon shading.
  29031. *
  29032. * @augments Material
  29033. * @demo scenes/material-browser.html#MeshToonMaterial
  29034. */
  29035. class MeshToonMaterial extends Material {
  29036. /**
  29037. * Constructs a new mesh toon material.
  29038. *
  29039. * @param {Object} [parameters] - An object with one or more properties
  29040. * defining the material's appearance. Any property of the material
  29041. * (including any property from inherited materials) can be passed
  29042. * in here. Color values can be passed any type of value accepted
  29043. * by {@link Color#set}.
  29044. */
  29045. constructor( parameters ) {
  29046. super();
  29047. /**
  29048. * This flag can be used for type testing.
  29049. *
  29050. * @type {boolean}
  29051. * @readonly
  29052. * @default true
  29053. */
  29054. this.isMeshToonMaterial = true;
  29055. this.defines = { 'TOON': '' };
  29056. this.type = 'MeshToonMaterial';
  29057. /**
  29058. * Color of the material.
  29059. *
  29060. * @type {Color}
  29061. * @default (1,1,1)
  29062. */
  29063. this.color = new Color( 0xffffff );
  29064. /**
  29065. * The color map. May optionally include an alpha channel, typically combined
  29066. * with {@link Material#transparent} or {@link Material#alphaTest}. The texture map
  29067. * color is modulated by the diffuse `color`.
  29068. *
  29069. * @type {?Texture}
  29070. * @default null
  29071. */
  29072. this.map = null;
  29073. /**
  29074. * Gradient map for toon shading. It's required to set
  29075. * {@link Texture#minFilter} and {@link Texture#magFilter} to {@linkNearestFilter}
  29076. * when using this type of texture.
  29077. *
  29078. * @type {?Texture}
  29079. * @default null
  29080. */
  29081. this.gradientMap = null;
  29082. /**
  29083. * The light map. Requires a second set of UVs.
  29084. *
  29085. * @type {?Texture}
  29086. * @default null
  29087. */
  29088. this.lightMap = null;
  29089. /**
  29090. * Intensity of the baked light.
  29091. *
  29092. * @type {number}
  29093. * @default 1
  29094. */
  29095. this.lightMapIntensity = 1.0;
  29096. /**
  29097. * The red channel of this texture is used as the ambient occlusion map.
  29098. * Requires a second set of UVs.
  29099. *
  29100. * @type {?Texture}
  29101. * @default null
  29102. */
  29103. this.aoMap = null;
  29104. /**
  29105. * Intensity of the ambient occlusion effect. Range is `[0,1]`, where `0`
  29106. * disables ambient occlusion. Where intensity is `1` and the AO map's
  29107. * red channel is also `1`, ambient light is fully occluded on a surface.
  29108. *
  29109. * @type {number}
  29110. * @default 1
  29111. */
  29112. this.aoMapIntensity = 1.0;
  29113. /**
  29114. * Emissive (light) color of the material, essentially a solid color
  29115. * unaffected by other lighting.
  29116. *
  29117. * @type {Color}
  29118. * @default (0,0,0)
  29119. */
  29120. this.emissive = new Color( 0x000000 );
  29121. /**
  29122. * Intensity of the emissive light. Modulates the emissive color.
  29123. *
  29124. * @type {number}
  29125. * @default 1
  29126. */
  29127. this.emissiveIntensity = 1.0;
  29128. /**
  29129. * Set emissive (glow) map. The emissive map color is modulated by the
  29130. * emissive color and the emissive intensity. If you have an emissive map,
  29131. * be sure to set the emissive color to something other than black.
  29132. *
  29133. * @type {?Texture}
  29134. * @default null
  29135. */
  29136. this.emissiveMap = null;
  29137. /**
  29138. * The texture to create a bump map. The black and white values map to the
  29139. * perceived depth in relation to the lights. Bump doesn't actually affect
  29140. * the geometry of the object, only the lighting. If a normal map is defined
  29141. * this will be ignored.
  29142. *
  29143. * @type {?Texture}
  29144. * @default null
  29145. */
  29146. this.bumpMap = null;
  29147. /**
  29148. * How much the bump map affects the material. Typical range is `[0,1]`.
  29149. *
  29150. * @type {number}
  29151. * @default 1
  29152. */
  29153. this.bumpScale = 1;
  29154. /**
  29155. * The texture to create a normal map. The RGB values affect the surface
  29156. * normal for each pixel fragment and change the way the color is lit. Normal
  29157. * maps do not change the actual shape of the surface, only the lighting. In
  29158. * case the material has a normal map authored using the left handed
  29159. * convention, the `y` component of `normalScale` should be negated to compensate
  29160. * for the different handedness.
  29161. *
  29162. * @type {?Texture}
  29163. * @default null
  29164. */
  29165. this.normalMap = null;
  29166. /**
  29167. * The type of normal map.
  29168. *
  29169. * @type {(TangentSpaceNormalMap|ObjectSpaceNormalMap)}
  29170. * @default TangentSpaceNormalMap
  29171. */
  29172. this.normalMapType = TangentSpaceNormalMap;
  29173. /**
  29174. * How much the normal map affects the material. Typical value range is `[0,1]`.
  29175. *
  29176. * @type {Vector2}
  29177. * @default (1,1)
  29178. */
  29179. this.normalScale = new Vector2( 1, 1 );
  29180. /**
  29181. * The displacement map affects the position of the mesh's vertices. Unlike
  29182. * other maps which only affect the light and shade of the material the
  29183. * displaced vertices can cast shadows, block other objects, and otherwise
  29184. * act as real geometry. The displacement texture is an image where the value
  29185. * of each pixel (white being the highest) is mapped against, and
  29186. * repositions, the vertices of the mesh.
  29187. *
  29188. * @type {?Texture}
  29189. * @default null
  29190. */
  29191. this.displacementMap = null;
  29192. /**
  29193. * How much the displacement map affects the mesh (where black is no
  29194. * displacement, and white is maximum displacement). Without a displacement
  29195. * map set, this value is not applied.
  29196. *
  29197. * @type {number}
  29198. * @default 0
  29199. */
  29200. this.displacementScale = 1;
  29201. /**
  29202. * The offset of the displacement map's values on the mesh's vertices.
  29203. * The bias is added to the scaled sample of the displacement map.
  29204. * Without a displacement map set, this value is not applied.
  29205. *
  29206. * @type {number}
  29207. * @default 0
  29208. */
  29209. this.displacementBias = 0;
  29210. /**
  29211. * The alpha map is a grayscale texture that controls the opacity across the
  29212. * surface (black: fully transparent; white: fully opaque).
  29213. *
  29214. * Only the color of the texture is used, ignoring the alpha channel if one
  29215. * exists. For RGB and RGBA textures, the renderer will use the green channel
  29216. * when sampling this texture due to the extra bit of precision provided for
  29217. * green in DXT-compressed and uncompressed RGB 565 formats. Luminance-only and
  29218. * luminance/alpha textures will also still work as expected.
  29219. *
  29220. * @type {?Texture}
  29221. * @default null
  29222. */
  29223. this.alphaMap = null;
  29224. /**
  29225. * Renders the geometry as a wireframe.
  29226. *
  29227. * @type {boolean}
  29228. * @default false
  29229. */
  29230. this.wireframe = false;
  29231. /**
  29232. * Controls the thickness of the wireframe.
  29233. *
  29234. * Can only be used with {@link SVGRenderer}.
  29235. *
  29236. * @type {number}
  29237. * @default 1
  29238. */
  29239. this.wireframeLinewidth = 1;
  29240. /**
  29241. * Defines appearance of wireframe ends.
  29242. *
  29243. * Can only be used with {@link SVGRenderer}.
  29244. *
  29245. * @type {('round'|'bevel'|'miter')}
  29246. * @default 'round'
  29247. */
  29248. this.wireframeLinecap = 'round';
  29249. /**
  29250. * Defines appearance of wireframe joints.
  29251. *
  29252. * Can only be used with {@link SVGRenderer}.
  29253. *
  29254. * @type {('round'|'bevel'|'miter')}
  29255. * @default 'round'
  29256. */
  29257. this.wireframeLinejoin = 'round';
  29258. /**
  29259. * Whether the material is affected by fog or not.
  29260. *
  29261. * @type {boolean}
  29262. * @default true
  29263. */
  29264. this.fog = true;
  29265. this.setValues( parameters );
  29266. }
  29267. copy( source ) {
  29268. super.copy( source );
  29269. this.color.copy( source.color );
  29270. this.map = source.map;
  29271. this.gradientMap = source.gradientMap;
  29272. this.lightMap = source.lightMap;
  29273. this.lightMapIntensity = source.lightMapIntensity;
  29274. this.aoMap = source.aoMap;
  29275. this.aoMapIntensity = source.aoMapIntensity;
  29276. this.emissive.copy( source.emissive );
  29277. this.emissiveMap = source.emissiveMap;
  29278. this.emissiveIntensity = source.emissiveIntensity;
  29279. this.bumpMap = source.bumpMap;
  29280. this.bumpScale = source.bumpScale;
  29281. this.normalMap = source.normalMap;
  29282. this.normalMapType = source.normalMapType;
  29283. this.normalScale.copy( source.normalScale );
  29284. this.displacementMap = source.displacementMap;
  29285. this.displacementScale = source.displacementScale;
  29286. this.displacementBias = source.displacementBias;
  29287. this.alphaMap = source.alphaMap;
  29288. this.wireframe = source.wireframe;
  29289. this.wireframeLinewidth = source.wireframeLinewidth;
  29290. this.wireframeLinecap = source.wireframeLinecap;
  29291. this.wireframeLinejoin = source.wireframeLinejoin;
  29292. this.fog = source.fog;
  29293. return this;
  29294. }
  29295. }
  29296. /**
  29297. * A material that maps the normal vectors to RGB colors.
  29298. *
  29299. * @augments Material
  29300. * @demo scenes/material-browser.html#MeshNormalMaterial
  29301. */
  29302. class MeshNormalMaterial extends Material {
  29303. /**
  29304. * Constructs a new mesh normal material.
  29305. *
  29306. * @param {Object} [parameters] - An object with one or more properties
  29307. * defining the material's appearance. Any property of the material
  29308. * (including any property from inherited materials) can be passed
  29309. * in here. Color values can be passed any type of value accepted
  29310. * by {@link Color#set}.
  29311. */
  29312. constructor( parameters ) {
  29313. super();
  29314. /**
  29315. * This flag can be used for type testing.
  29316. *
  29317. * @type {boolean}
  29318. * @readonly
  29319. * @default true
  29320. */
  29321. this.isMeshNormalMaterial = true;
  29322. this.type = 'MeshNormalMaterial';
  29323. /**
  29324. * The texture to create a bump map. The black and white values map to the
  29325. * perceived depth in relation to the lights. Bump doesn't actually affect
  29326. * the geometry of the object, only the lighting. If a normal map is defined
  29327. * this will be ignored.
  29328. *
  29329. * @type {?Texture}
  29330. * @default null
  29331. */
  29332. this.bumpMap = null;
  29333. /**
  29334. * How much the bump map affects the material. Typical range is `[0,1]`.
  29335. *
  29336. * @type {number}
  29337. * @default 1
  29338. */
  29339. this.bumpScale = 1;
  29340. /**
  29341. * The texture to create a normal map. The RGB values affect the surface
  29342. * normal for each pixel fragment and change the way the color is lit. Normal
  29343. * maps do not change the actual shape of the surface, only the lighting. In
  29344. * case the material has a normal map authored using the left handed
  29345. * convention, the `y` component of `normalScale` should be negated to compensate
  29346. * for the different handedness.
  29347. *
  29348. * @type {?Texture}
  29349. * @default null
  29350. */
  29351. this.normalMap = null;
  29352. /**
  29353. * The type of normal map.
  29354. *
  29355. * @type {(TangentSpaceNormalMap|ObjectSpaceNormalMap)}
  29356. * @default TangentSpaceNormalMap
  29357. */
  29358. this.normalMapType = TangentSpaceNormalMap;
  29359. /**
  29360. * How much the normal map affects the material. Typical value range is `[0,1]`.
  29361. *
  29362. * @type {Vector2}
  29363. * @default (1,1)
  29364. */
  29365. this.normalScale = new Vector2( 1, 1 );
  29366. /**
  29367. * The displacement map affects the position of the mesh's vertices. Unlike
  29368. * other maps which only affect the light and shade of the material the
  29369. * displaced vertices can cast shadows, block other objects, and otherwise
  29370. * act as real geometry. The displacement texture is an image where the value
  29371. * of each pixel (white being the highest) is mapped against, and
  29372. * repositions, the vertices of the mesh.
  29373. *
  29374. * @type {?Texture}
  29375. * @default null
  29376. */
  29377. this.displacementMap = null;
  29378. /**
  29379. * How much the displacement map affects the mesh (where black is no
  29380. * displacement, and white is maximum displacement). Without a displacement
  29381. * map set, this value is not applied.
  29382. *
  29383. * @type {number}
  29384. * @default 0
  29385. */
  29386. this.displacementScale = 1;
  29387. /**
  29388. * The offset of the displacement map's values on the mesh's vertices.
  29389. * The bias is added to the scaled sample of the displacement map.
  29390. * Without a displacement map set, this value is not applied.
  29391. *
  29392. * @type {number}
  29393. * @default 0
  29394. */
  29395. this.displacementBias = 0;
  29396. /**
  29397. * Renders the geometry as a wireframe.
  29398. *
  29399. * @type {boolean}
  29400. * @default false
  29401. */
  29402. this.wireframe = false;
  29403. /**
  29404. * Controls the thickness of the wireframe.
  29405. *
  29406. * WebGL and WebGPU ignore this property and always render
  29407. * 1 pixel wide lines.
  29408. *
  29409. * @type {number}
  29410. * @default 1
  29411. */
  29412. this.wireframeLinewidth = 1;
  29413. /**
  29414. * Whether the material is rendered with flat shading or not.
  29415. *
  29416. * @type {boolean}
  29417. * @default false
  29418. */
  29419. this.flatShading = false;
  29420. this.setValues( parameters );
  29421. }
  29422. copy( source ) {
  29423. super.copy( source );
  29424. this.bumpMap = source.bumpMap;
  29425. this.bumpScale = source.bumpScale;
  29426. this.normalMap = source.normalMap;
  29427. this.normalMapType = source.normalMapType;
  29428. this.normalScale.copy( source.normalScale );
  29429. this.displacementMap = source.displacementMap;
  29430. this.displacementScale = source.displacementScale;
  29431. this.displacementBias = source.displacementBias;
  29432. this.wireframe = source.wireframe;
  29433. this.wireframeLinewidth = source.wireframeLinewidth;
  29434. this.flatShading = source.flatShading;
  29435. return this;
  29436. }
  29437. }
  29438. /**
  29439. * A material for non-shiny surfaces, without specular highlights.
  29440. *
  29441. * The material uses a non-physically based [Lambertian](https://en.wikipedia.org/wiki/Lambertian_reflectance)
  29442. * model for calculating reflectance. This can simulate some surfaces (such
  29443. * as untreated wood or stone) well, but cannot simulate shiny surfaces with
  29444. * specular highlights (such as varnished wood). `MeshLambertMaterial` uses per-fragment
  29445. * shading.
  29446. *
  29447. * Due to the simplicity of the reflectance and illumination models,
  29448. * performance will be greater when using this material over the
  29449. * {@link MeshPhongMaterial}, {@link MeshStandardMaterial} or
  29450. * {@link MeshPhysicalMaterial}, at the cost of some graphical accuracy.
  29451. *
  29452. * @augments Material
  29453. * @demo scenes/material-browser.html#MeshLambertMaterial
  29454. */
  29455. class MeshLambertMaterial extends Material {
  29456. /**
  29457. * Constructs a new mesh lambert material.
  29458. *
  29459. * @param {Object} [parameters] - An object with one or more properties
  29460. * defining the material's appearance. Any property of the material
  29461. * (including any property from inherited materials) can be passed
  29462. * in here. Color values can be passed any type of value accepted
  29463. * by {@link Color#set}.
  29464. */
  29465. constructor( parameters ) {
  29466. super();
  29467. /**
  29468. * This flag can be used for type testing.
  29469. *
  29470. * @type {boolean}
  29471. * @readonly
  29472. * @default true
  29473. */
  29474. this.isMeshLambertMaterial = true;
  29475. this.type = 'MeshLambertMaterial';
  29476. /**
  29477. * Color of the material.
  29478. *
  29479. * @type {Color}
  29480. * @default (1,1,1)
  29481. */
  29482. this.color = new Color( 0xffffff ); // diffuse
  29483. /**
  29484. * The color map. May optionally include an alpha channel, typically combined
  29485. * with {@link Material#transparent} or {@link Material#alphaTest}. The texture map
  29486. * color is modulated by the diffuse `color`.
  29487. *
  29488. * @type {?Texture}
  29489. * @default null
  29490. */
  29491. this.map = null;
  29492. /**
  29493. * The light map. Requires a second set of UVs.
  29494. *
  29495. * @type {?Texture}
  29496. * @default null
  29497. */
  29498. this.lightMap = null;
  29499. /**
  29500. * Intensity of the baked light.
  29501. *
  29502. * @type {number}
  29503. * @default 1
  29504. */
  29505. this.lightMapIntensity = 1.0;
  29506. /**
  29507. * The red channel of this texture is used as the ambient occlusion map.
  29508. * Requires a second set of UVs.
  29509. *
  29510. * @type {?Texture}
  29511. * @default null
  29512. */
  29513. this.aoMap = null;
  29514. /**
  29515. * Intensity of the ambient occlusion effect. Range is `[0,1]`, where `0`
  29516. * disables ambient occlusion. Where intensity is `1` and the AO map's
  29517. * red channel is also `1`, ambient light is fully occluded on a surface.
  29518. *
  29519. * @type {number}
  29520. * @default 1
  29521. */
  29522. this.aoMapIntensity = 1.0;
  29523. /**
  29524. * Emissive (light) color of the material, essentially a solid color
  29525. * unaffected by other lighting.
  29526. *
  29527. * @type {Color}
  29528. * @default (0,0,0)
  29529. */
  29530. this.emissive = new Color( 0x000000 );
  29531. /**
  29532. * Intensity of the emissive light. Modulates the emissive color.
  29533. *
  29534. * @type {number}
  29535. * @default 1
  29536. */
  29537. this.emissiveIntensity = 1.0;
  29538. /**
  29539. * Set emissive (glow) map. The emissive map color is modulated by the
  29540. * emissive color and the emissive intensity. If you have an emissive map,
  29541. * be sure to set the emissive color to something other than black.
  29542. *
  29543. * @type {?Texture}
  29544. * @default null
  29545. */
  29546. this.emissiveMap = null;
  29547. /**
  29548. * The texture to create a bump map. The black and white values map to the
  29549. * perceived depth in relation to the lights. Bump doesn't actually affect
  29550. * the geometry of the object, only the lighting. If a normal map is defined
  29551. * this will be ignored.
  29552. *
  29553. * @type {?Texture}
  29554. * @default null
  29555. */
  29556. this.bumpMap = null;
  29557. /**
  29558. * How much the bump map affects the material. Typical range is `[0,1]`.
  29559. *
  29560. * @type {number}
  29561. * @default 1
  29562. */
  29563. this.bumpScale = 1;
  29564. /**
  29565. * The texture to create a normal map. The RGB values affect the surface
  29566. * normal for each pixel fragment and change the way the color is lit. Normal
  29567. * maps do not change the actual shape of the surface, only the lighting. In
  29568. * case the material has a normal map authored using the left handed
  29569. * convention, the `y` component of `normalScale` should be negated to compensate
  29570. * for the different handedness.
  29571. *
  29572. * @type {?Texture}
  29573. * @default null
  29574. */
  29575. this.normalMap = null;
  29576. /**
  29577. * The type of normal map.
  29578. *
  29579. * @type {(TangentSpaceNormalMap|ObjectSpaceNormalMap)}
  29580. * @default TangentSpaceNormalMap
  29581. */
  29582. this.normalMapType = TangentSpaceNormalMap;
  29583. /**
  29584. * How much the normal map affects the material. Typical value range is `[0,1]`.
  29585. *
  29586. * @type {Vector2}
  29587. * @default (1,1)
  29588. */
  29589. this.normalScale = new Vector2( 1, 1 );
  29590. /**
  29591. * The displacement map affects the position of the mesh's vertices. Unlike
  29592. * other maps which only affect the light and shade of the material the
  29593. * displaced vertices can cast shadows, block other objects, and otherwise
  29594. * act as real geometry. The displacement texture is an image where the value
  29595. * of each pixel (white being the highest) is mapped against, and
  29596. * repositions, the vertices of the mesh.
  29597. *
  29598. * @type {?Texture}
  29599. * @default null
  29600. */
  29601. this.displacementMap = null;
  29602. /**
  29603. * How much the displacement map affects the mesh (where black is no
  29604. * displacement, and white is maximum displacement). Without a displacement
  29605. * map set, this value is not applied.
  29606. *
  29607. * @type {number}
  29608. * @default 0
  29609. */
  29610. this.displacementScale = 1;
  29611. /**
  29612. * The offset of the displacement map's values on the mesh's vertices.
  29613. * The bias is added to the scaled sample of the displacement map.
  29614. * Without a displacement map set, this value is not applied.
  29615. *
  29616. * @type {number}
  29617. * @default 0
  29618. */
  29619. this.displacementBias = 0;
  29620. /**
  29621. * Specular map used by the material.
  29622. *
  29623. * @type {?Texture}
  29624. * @default null
  29625. */
  29626. this.specularMap = null;
  29627. /**
  29628. * The alpha map is a grayscale texture that controls the opacity across the
  29629. * surface (black: fully transparent; white: fully opaque).
  29630. *
  29631. * Only the color of the texture is used, ignoring the alpha channel if one
  29632. * exists. For RGB and RGBA textures, the renderer will use the green channel
  29633. * when sampling this texture due to the extra bit of precision provided for
  29634. * green in DXT-compressed and uncompressed RGB 565 formats. Luminance-only and
  29635. * luminance/alpha textures will also still work as expected.
  29636. *
  29637. * @type {?Texture}
  29638. * @default null
  29639. */
  29640. this.alphaMap = null;
  29641. /**
  29642. * The environment map.
  29643. *
  29644. * @type {?Texture}
  29645. * @default null
  29646. */
  29647. this.envMap = null;
  29648. /**
  29649. * The rotation of the environment map in radians.
  29650. *
  29651. * @type {Euler}
  29652. * @default (0,0,0)
  29653. */
  29654. this.envMapRotation = new Euler();
  29655. /**
  29656. * How to combine the result of the surface's color with the environment map, if any.
  29657. *
  29658. * When set to `MixOperation`, the {@link MeshBasicMaterial#reflectivity} is used to
  29659. * blend between the two colors.
  29660. *
  29661. * @type {(MultiplyOperation|MixOperation|AddOperation)}
  29662. * @default MultiplyOperation
  29663. */
  29664. this.combine = MultiplyOperation;
  29665. /**
  29666. * How much the environment map affects the surface.
  29667. * The valid range is between `0` (no reflections) and `1` (full reflections).
  29668. *
  29669. * @type {number}
  29670. * @default 1
  29671. */
  29672. this.reflectivity = 1;
  29673. /**
  29674. * The index of refraction (IOR) of air (approximately 1) divided by the
  29675. * index of refraction of the material. It is used with environment mapping
  29676. * modes {@link CubeRefractionMapping} and {@link EquirectangularRefractionMapping}.
  29677. * The refraction ratio should not exceed `1`.
  29678. *
  29679. * @type {number}
  29680. * @default 0.98
  29681. */
  29682. this.refractionRatio = 0.98;
  29683. /**
  29684. * Renders the geometry as a wireframe.
  29685. *
  29686. * @type {boolean}
  29687. * @default false
  29688. */
  29689. this.wireframe = false;
  29690. /**
  29691. * Controls the thickness of the wireframe.
  29692. *
  29693. * Can only be used with {@link SVGRenderer}.
  29694. *
  29695. * @type {number}
  29696. * @default 1
  29697. */
  29698. this.wireframeLinewidth = 1;
  29699. /**
  29700. * Defines appearance of wireframe ends.
  29701. *
  29702. * Can only be used with {@link SVGRenderer}.
  29703. *
  29704. * @type {('round'|'bevel'|'miter')}
  29705. * @default 'round'
  29706. */
  29707. this.wireframeLinecap = 'round';
  29708. /**
  29709. * Defines appearance of wireframe joints.
  29710. *
  29711. * Can only be used with {@link SVGRenderer}.
  29712. *
  29713. * @type {('round'|'bevel'|'miter')}
  29714. * @default 'round'
  29715. */
  29716. this.wireframeLinejoin = 'round';
  29717. /**
  29718. * Whether the material is rendered with flat shading or not.
  29719. *
  29720. * @type {boolean}
  29721. * @default false
  29722. */
  29723. this.flatShading = false;
  29724. /**
  29725. * Whether the material is affected by fog or not.
  29726. *
  29727. * @type {boolean}
  29728. * @default true
  29729. */
  29730. this.fog = true;
  29731. this.setValues( parameters );
  29732. }
  29733. copy( source ) {
  29734. super.copy( source );
  29735. this.color.copy( source.color );
  29736. this.map = source.map;
  29737. this.lightMap = source.lightMap;
  29738. this.lightMapIntensity = source.lightMapIntensity;
  29739. this.aoMap = source.aoMap;
  29740. this.aoMapIntensity = source.aoMapIntensity;
  29741. this.emissive.copy( source.emissive );
  29742. this.emissiveMap = source.emissiveMap;
  29743. this.emissiveIntensity = source.emissiveIntensity;
  29744. this.bumpMap = source.bumpMap;
  29745. this.bumpScale = source.bumpScale;
  29746. this.normalMap = source.normalMap;
  29747. this.normalMapType = source.normalMapType;
  29748. this.normalScale.copy( source.normalScale );
  29749. this.displacementMap = source.displacementMap;
  29750. this.displacementScale = source.displacementScale;
  29751. this.displacementBias = source.displacementBias;
  29752. this.specularMap = source.specularMap;
  29753. this.alphaMap = source.alphaMap;
  29754. this.envMap = source.envMap;
  29755. this.envMapRotation.copy( source.envMapRotation );
  29756. this.combine = source.combine;
  29757. this.reflectivity = source.reflectivity;
  29758. this.refractionRatio = source.refractionRatio;
  29759. this.wireframe = source.wireframe;
  29760. this.wireframeLinewidth = source.wireframeLinewidth;
  29761. this.wireframeLinecap = source.wireframeLinecap;
  29762. this.wireframeLinejoin = source.wireframeLinejoin;
  29763. this.flatShading = source.flatShading;
  29764. this.fog = source.fog;
  29765. return this;
  29766. }
  29767. }
  29768. /**
  29769. * A material for drawing geometry by depth. Depth is based off of the camera
  29770. * near and far plane. White is nearest, black is farthest.
  29771. *
  29772. * @augments Material
  29773. * @demo scenes/material-browser.html#MeshDepthMaterial
  29774. */
  29775. class MeshDepthMaterial extends Material {
  29776. /**
  29777. * Constructs a new mesh depth material.
  29778. *
  29779. * @param {Object} [parameters] - An object with one or more properties
  29780. * defining the material's appearance. Any property of the material
  29781. * (including any property from inherited materials) can be passed
  29782. * in here. Color values can be passed any type of value accepted
  29783. * by {@link Color#set}.
  29784. */
  29785. constructor( parameters ) {
  29786. super();
  29787. /**
  29788. * This flag can be used for type testing.
  29789. *
  29790. * @type {boolean}
  29791. * @readonly
  29792. * @default true
  29793. */
  29794. this.isMeshDepthMaterial = true;
  29795. this.type = 'MeshDepthMaterial';
  29796. /**
  29797. * Type for depth packing.
  29798. *
  29799. * @type {(BasicDepthPacking|RGBADepthPacking|RGBDepthPacking|RGDepthPacking)}
  29800. * @default BasicDepthPacking
  29801. */
  29802. this.depthPacking = BasicDepthPacking;
  29803. /**
  29804. * The color map. May optionally include an alpha channel, typically combined
  29805. * with {@link Material#transparent} or {@link Material#alphaTest}.
  29806. *
  29807. * @type {?Texture}
  29808. * @default null
  29809. */
  29810. this.map = null;
  29811. /**
  29812. * The alpha map is a grayscale texture that controls the opacity across the
  29813. * surface (black: fully transparent; white: fully opaque).
  29814. *
  29815. * Only the color of the texture is used, ignoring the alpha channel if one
  29816. * exists. For RGB and RGBA textures, the renderer will use the green channel
  29817. * when sampling this texture due to the extra bit of precision provided for
  29818. * green in DXT-compressed and uncompressed RGB 565 formats. Luminance-only and
  29819. * luminance/alpha textures will also still work as expected.
  29820. *
  29821. * @type {?Texture}
  29822. * @default null
  29823. */
  29824. this.alphaMap = null;
  29825. /**
  29826. * The displacement map affects the position of the mesh's vertices. Unlike
  29827. * other maps which only affect the light and shade of the material the
  29828. * displaced vertices can cast shadows, block other objects, and otherwise
  29829. * act as real geometry. The displacement texture is an image where the value
  29830. * of each pixel (white being the highest) is mapped against, and
  29831. * repositions, the vertices of the mesh.
  29832. *
  29833. * @type {?Texture}
  29834. * @default null
  29835. */
  29836. this.displacementMap = null;
  29837. /**
  29838. * How much the displacement map affects the mesh (where black is no
  29839. * displacement, and white is maximum displacement). Without a displacement
  29840. * map set, this value is not applied.
  29841. *
  29842. * @type {number}
  29843. * @default 0
  29844. */
  29845. this.displacementScale = 1;
  29846. /**
  29847. * The offset of the displacement map's values on the mesh's vertices.
  29848. * The bias is added to the scaled sample of the displacement map.
  29849. * Without a displacement map set, this value is not applied.
  29850. *
  29851. * @type {number}
  29852. * @default 0
  29853. */
  29854. this.displacementBias = 0;
  29855. /**
  29856. * Renders the geometry as a wireframe.
  29857. *
  29858. * @type {boolean}
  29859. * @default false
  29860. */
  29861. this.wireframe = false;
  29862. /**
  29863. * Controls the thickness of the wireframe.
  29864. *
  29865. * WebGL and WebGPU ignore this property and always render
  29866. * 1 pixel wide lines.
  29867. *
  29868. * @type {number}
  29869. * @default 1
  29870. */
  29871. this.wireframeLinewidth = 1;
  29872. this.setValues( parameters );
  29873. }
  29874. copy( source ) {
  29875. super.copy( source );
  29876. this.depthPacking = source.depthPacking;
  29877. this.map = source.map;
  29878. this.alphaMap = source.alphaMap;
  29879. this.displacementMap = source.displacementMap;
  29880. this.displacementScale = source.displacementScale;
  29881. this.displacementBias = source.displacementBias;
  29882. this.wireframe = source.wireframe;
  29883. this.wireframeLinewidth = source.wireframeLinewidth;
  29884. return this;
  29885. }
  29886. }
  29887. /**
  29888. * A material used internally for implementing shadow mapping with
  29889. * point lights.
  29890. *
  29891. * Can also be used to customize the shadow casting of an object by assigning
  29892. * an instance of `MeshDistanceMaterial` to {@link Object3D#customDistanceMaterial}.
  29893. * The following examples demonstrates this approach in order to ensure
  29894. * transparent parts of objects do not cast shadows.
  29895. *
  29896. * @augments Material
  29897. */
  29898. class MeshDistanceMaterial extends Material {
  29899. /**
  29900. * Constructs a new mesh distance material.
  29901. *
  29902. * @param {Object} [parameters] - An object with one or more properties
  29903. * defining the material's appearance. Any property of the material
  29904. * (including any property from inherited materials) can be passed
  29905. * in here. Color values can be passed any type of value accepted
  29906. * by {@link Color#set}.
  29907. */
  29908. constructor( parameters ) {
  29909. super();
  29910. /**
  29911. * This flag can be used for type testing.
  29912. *
  29913. * @type {boolean}
  29914. * @readonly
  29915. * @default true
  29916. */
  29917. this.isMeshDistanceMaterial = true;
  29918. this.type = 'MeshDistanceMaterial';
  29919. /**
  29920. * The color map. May optionally include an alpha channel, typically combined
  29921. * with {@link Material#transparent} or {@link Material#alphaTest}.
  29922. *
  29923. * @type {?Texture}
  29924. * @default null
  29925. */
  29926. this.map = null;
  29927. /**
  29928. * The alpha map is a grayscale texture that controls the opacity across the
  29929. * surface (black: fully transparent; white: fully opaque).
  29930. *
  29931. * Only the color of the texture is used, ignoring the alpha channel if one
  29932. * exists. For RGB and RGBA textures, the renderer will use the green channel
  29933. * when sampling this texture due to the extra bit of precision provided for
  29934. * green in DXT-compressed and uncompressed RGB 565 formats. Luminance-only and
  29935. * luminance/alpha textures will also still work as expected.
  29936. *
  29937. * @type {?Texture}
  29938. * @default null
  29939. */
  29940. this.alphaMap = null;
  29941. /**
  29942. * The displacement map affects the position of the mesh's vertices. Unlike
  29943. * other maps which only affect the light and shade of the material the
  29944. * displaced vertices can cast shadows, block other objects, and otherwise
  29945. * act as real geometry. The displacement texture is an image where the value
  29946. * of each pixel (white being the highest) is mapped against, and
  29947. * repositions, the vertices of the mesh.
  29948. *
  29949. * @type {?Texture}
  29950. * @default null
  29951. */
  29952. this.displacementMap = null;
  29953. /**
  29954. * How much the displacement map affects the mesh (where black is no
  29955. * displacement, and white is maximum displacement). Without a displacement
  29956. * map set, this value is not applied.
  29957. *
  29958. * @type {number}
  29959. * @default 0
  29960. */
  29961. this.displacementScale = 1;
  29962. /**
  29963. * The offset of the displacement map's values on the mesh's vertices.
  29964. * The bias is added to the scaled sample of the displacement map.
  29965. * Without a displacement map set, this value is not applied.
  29966. *
  29967. * @type {number}
  29968. * @default 0
  29969. */
  29970. this.displacementBias = 0;
  29971. this.setValues( parameters );
  29972. }
  29973. copy( source ) {
  29974. super.copy( source );
  29975. this.map = source.map;
  29976. this.alphaMap = source.alphaMap;
  29977. this.displacementMap = source.displacementMap;
  29978. this.displacementScale = source.displacementScale;
  29979. this.displacementBias = source.displacementBias;
  29980. return this;
  29981. }
  29982. }
  29983. /**
  29984. * This material is defined by a MatCap (or Lit Sphere) texture, which encodes the
  29985. * material color and shading.
  29986. *
  29987. * `MeshMatcapMaterial` does not respond to lights since the matcap image file encodes
  29988. * baked lighting. It will cast a shadow onto an object that receives shadows
  29989. * (and shadow clipping works), but it will not self-shadow or receive
  29990. * shadows.
  29991. *
  29992. * @augments Material
  29993. * @demo scenes/material-browser.html#MeshMatcapMaterial
  29994. */
  29995. class MeshMatcapMaterial extends Material {
  29996. /**
  29997. * Constructs a new mesh matcap material.
  29998. *
  29999. * @param {Object} [parameters] - An object with one or more properties
  30000. * defining the material's appearance. Any property of the material
  30001. * (including any property from inherited materials) can be passed
  30002. * in here. Color values can be passed any type of value accepted
  30003. * by {@link Color#set}.
  30004. */
  30005. constructor( parameters ) {
  30006. super();
  30007. /**
  30008. * This flag can be used for type testing.
  30009. *
  30010. * @type {boolean}
  30011. * @readonly
  30012. * @default true
  30013. */
  30014. this.isMeshMatcapMaterial = true;
  30015. this.defines = { 'MATCAP': '' };
  30016. this.type = 'MeshMatcapMaterial';
  30017. /**
  30018. * Color of the material.
  30019. *
  30020. * @type {Color}
  30021. * @default (1,1,1)
  30022. */
  30023. this.color = new Color( 0xffffff ); // diffuse
  30024. /**
  30025. * The matcap map.
  30026. *
  30027. * @type {?Texture}
  30028. * @default null
  30029. */
  30030. this.matcap = null;
  30031. /**
  30032. * The color map. May optionally include an alpha channel, typically combined
  30033. * with {@link Material#transparent} or {@link Material#alphaTest}. The texture map
  30034. * color is modulated by the diffuse `color`.
  30035. *
  30036. * @type {?Texture}
  30037. * @default null
  30038. */
  30039. this.map = null;
  30040. /**
  30041. * The texture to create a bump map. The black and white values map to the
  30042. * perceived depth in relation to the lights. Bump doesn't actually affect
  30043. * the geometry of the object, only the lighting. If a normal map is defined
  30044. * this will be ignored.
  30045. *
  30046. * @type {?Texture}
  30047. * @default null
  30048. */
  30049. this.bumpMap = null;
  30050. /**
  30051. * How much the bump map affects the material. Typical range is `[0,1]`.
  30052. *
  30053. * @type {number}
  30054. * @default 1
  30055. */
  30056. this.bumpScale = 1;
  30057. /**
  30058. * The texture to create a normal map. The RGB values affect the surface
  30059. * normal for each pixel fragment and change the way the color is lit. Normal
  30060. * maps do not change the actual shape of the surface, only the lighting. In
  30061. * case the material has a normal map authored using the left handed
  30062. * convention, the `y` component of `normalScale` should be negated to compensate
  30063. * for the different handedness.
  30064. *
  30065. * @type {?Texture}
  30066. * @default null
  30067. */
  30068. this.normalMap = null;
  30069. /**
  30070. * The type of normal map.
  30071. *
  30072. * @type {(TangentSpaceNormalMap|ObjectSpaceNormalMap)}
  30073. * @default TangentSpaceNormalMap
  30074. */
  30075. this.normalMapType = TangentSpaceNormalMap;
  30076. /**
  30077. * How much the normal map affects the material. Typical value range is `[0,1]`.
  30078. *
  30079. * @type {Vector2}
  30080. * @default (1,1)
  30081. */
  30082. this.normalScale = new Vector2( 1, 1 );
  30083. /**
  30084. * The displacement map affects the position of the mesh's vertices. Unlike
  30085. * other maps which only affect the light and shade of the material the
  30086. * displaced vertices can cast shadows, block other objects, and otherwise
  30087. * act as real geometry. The displacement texture is an image where the value
  30088. * of each pixel (white being the highest) is mapped against, and
  30089. * repositions, the vertices of the mesh.
  30090. *
  30091. * @type {?Texture}
  30092. * @default null
  30093. */
  30094. this.displacementMap = null;
  30095. /**
  30096. * How much the displacement map affects the mesh (where black is no
  30097. * displacement, and white is maximum displacement). Without a displacement
  30098. * map set, this value is not applied.
  30099. *
  30100. * @type {number}
  30101. * @default 0
  30102. */
  30103. this.displacementScale = 1;
  30104. /**
  30105. * The offset of the displacement map's values on the mesh's vertices.
  30106. * The bias is added to the scaled sample of the displacement map.
  30107. * Without a displacement map set, this value is not applied.
  30108. *
  30109. * @type {number}
  30110. * @default 0
  30111. */
  30112. this.displacementBias = 0;
  30113. /**
  30114. * The alpha map is a grayscale texture that controls the opacity across the
  30115. * surface (black: fully transparent; white: fully opaque).
  30116. *
  30117. * Only the color of the texture is used, ignoring the alpha channel if one
  30118. * exists. For RGB and RGBA textures, the renderer will use the green channel
  30119. * when sampling this texture due to the extra bit of precision provided for
  30120. * green in DXT-compressed and uncompressed RGB 565 formats. Luminance-only and
  30121. * luminance/alpha textures will also still work as expected.
  30122. *
  30123. * @type {?Texture}
  30124. * @default null
  30125. */
  30126. this.alphaMap = null;
  30127. /**
  30128. * Renders the geometry as a wireframe.
  30129. *
  30130. * @type {boolean}
  30131. * @default false
  30132. */
  30133. this.wireframe = false;
  30134. /**
  30135. * Controls the thickness of the wireframe.
  30136. *
  30137. * Can only be used with {@link SVGRenderer}.
  30138. *
  30139. * @type {number}
  30140. * @default 1
  30141. */
  30142. this.wireframeLinewidth = 1;
  30143. /**
  30144. * Whether the material is rendered with flat shading or not.
  30145. *
  30146. * @type {boolean}
  30147. * @default false
  30148. */
  30149. this.flatShading = false;
  30150. /**
  30151. * Whether the material is affected by fog or not.
  30152. *
  30153. * @type {boolean}
  30154. * @default true
  30155. */
  30156. this.fog = true;
  30157. this.setValues( parameters );
  30158. }
  30159. copy( source ) {
  30160. super.copy( source );
  30161. this.defines = { 'MATCAP': '' };
  30162. this.color.copy( source.color );
  30163. this.matcap = source.matcap;
  30164. this.map = source.map;
  30165. this.bumpMap = source.bumpMap;
  30166. this.bumpScale = source.bumpScale;
  30167. this.normalMap = source.normalMap;
  30168. this.normalMapType = source.normalMapType;
  30169. this.normalScale.copy( source.normalScale );
  30170. this.displacementMap = source.displacementMap;
  30171. this.displacementScale = source.displacementScale;
  30172. this.displacementBias = source.displacementBias;
  30173. this.alphaMap = source.alphaMap;
  30174. this.wireframe = source.wireframe;
  30175. this.wireframeLinewidth = source.wireframeLinewidth;
  30176. this.flatShading = source.flatShading;
  30177. this.fog = source.fog;
  30178. return this;
  30179. }
  30180. }
  30181. /**
  30182. * A material for rendering line primitives.
  30183. *
  30184. * Materials define the appearance of renderable 3D objects.
  30185. *
  30186. * ```js
  30187. * const material = new THREE.LineDashedMaterial( {
  30188. * color: 0xffffff,
  30189. * scale: 1,
  30190. * dashSize: 3,
  30191. * gapSize: 1,
  30192. * } );
  30193. * ```
  30194. *
  30195. * @augments LineBasicMaterial
  30196. */
  30197. class LineDashedMaterial extends LineBasicMaterial {
  30198. /**
  30199. * Constructs a new line dashed material.
  30200. *
  30201. * @param {Object} [parameters] - An object with one or more properties
  30202. * defining the material's appearance. Any property of the material
  30203. * (including any property from inherited materials) can be passed
  30204. * in here. Color values can be passed any type of value accepted
  30205. * by {@link Color#set}.
  30206. */
  30207. constructor( parameters ) {
  30208. super();
  30209. /**
  30210. * This flag can be used for type testing.
  30211. *
  30212. * @type {boolean}
  30213. * @readonly
  30214. * @default true
  30215. */
  30216. this.isLineDashedMaterial = true;
  30217. this.type = 'LineDashedMaterial';
  30218. /**
  30219. * The scale of the dashed part of a line.
  30220. *
  30221. * @type {number}
  30222. * @default 1
  30223. */
  30224. this.scale = 1;
  30225. /**
  30226. * The size of the dash. This is both the gap with the stroke.
  30227. *
  30228. * @type {number}
  30229. * @default 3
  30230. */
  30231. this.dashSize = 3;
  30232. /**
  30233. * The size of the gap.
  30234. *
  30235. * @type {number}
  30236. * @default 1
  30237. */
  30238. this.gapSize = 1;
  30239. this.setValues( parameters );
  30240. }
  30241. copy( source ) {
  30242. super.copy( source );
  30243. this.scale = source.scale;
  30244. this.dashSize = source.dashSize;
  30245. this.gapSize = source.gapSize;
  30246. return this;
  30247. }
  30248. }
  30249. /**
  30250. * Converts an array to a specific type.
  30251. *
  30252. * @param {TypedArray|Array} array - The array to convert.
  30253. * @param {TypedArray.constructor} type - The constructor of a typed array that defines the new type.
  30254. * @return {TypedArray} The converted array.
  30255. */
  30256. function convertArray( array, type ) {
  30257. if ( ! array || array.constructor === type ) return array;
  30258. if ( typeof type.BYTES_PER_ELEMENT === 'number' ) {
  30259. return new type( array ); // create typed array
  30260. }
  30261. return Array.prototype.slice.call( array ); // create Array
  30262. }
  30263. /**
  30264. * Returns an array by which times and values can be sorted.
  30265. *
  30266. * @param {Array<number>} times - The keyframe time values.
  30267. * @return {Array<number>} The array.
  30268. */
  30269. function getKeyframeOrder( times ) {
  30270. function compareTime( i, j ) {
  30271. return times[ i ] - times[ j ];
  30272. }
  30273. const n = times.length;
  30274. const result = new Array( n );
  30275. for ( let i = 0; i !== n; ++ i ) result[ i ] = i;
  30276. result.sort( compareTime );
  30277. return result;
  30278. }
  30279. /**
  30280. * Sorts the given array by the previously computed order via `getKeyframeOrder()`.
  30281. *
  30282. * @param {Array<number>} values - The values to sort.
  30283. * @param {number} stride - The stride.
  30284. * @param {Array<number>} order - The sort order.
  30285. * @return {Array<number>} The sorted values.
  30286. */
  30287. function sortedArray( values, stride, order ) {
  30288. const nValues = values.length;
  30289. const result = new values.constructor( nValues );
  30290. for ( let i = 0, dstOffset = 0; dstOffset !== nValues; ++ i ) {
  30291. const srcOffset = order[ i ] * stride;
  30292. for ( let j = 0; j !== stride; ++ j ) {
  30293. result[ dstOffset ++ ] = values[ srcOffset + j ];
  30294. }
  30295. }
  30296. return result;
  30297. }
  30298. /**
  30299. * Used for parsing AOS keyframe formats.
  30300. *
  30301. * @param {Array<number>} jsonKeys - A list of JSON keyframes.
  30302. * @param {Array<number>} times - This array will be filled with keyframe times by this function.
  30303. * @param {Array<number>} values - This array will be filled with keyframe values by this function.
  30304. * @param {string} valuePropertyName - The name of the property to use.
  30305. */
  30306. function flattenJSON( jsonKeys, times, values, valuePropertyName ) {
  30307. let i = 1, key = jsonKeys[ 0 ];
  30308. while ( key !== undefined && key[ valuePropertyName ] === undefined ) {
  30309. key = jsonKeys[ i ++ ];
  30310. }
  30311. if ( key === undefined ) return; // no data
  30312. let value = key[ valuePropertyName ];
  30313. if ( value === undefined ) return; // no data
  30314. if ( Array.isArray( value ) ) {
  30315. do {
  30316. value = key[ valuePropertyName ];
  30317. if ( value !== undefined ) {
  30318. times.push( key.time );
  30319. values.push( ...value ); // push all elements
  30320. }
  30321. key = jsonKeys[ i ++ ];
  30322. } while ( key !== undefined );
  30323. } else if ( value.toArray !== undefined ) {
  30324. // ...assume THREE.Math-ish
  30325. do {
  30326. value = key[ valuePropertyName ];
  30327. if ( value !== undefined ) {
  30328. times.push( key.time );
  30329. value.toArray( values, values.length );
  30330. }
  30331. key = jsonKeys[ i ++ ];
  30332. } while ( key !== undefined );
  30333. } else {
  30334. // otherwise push as-is
  30335. do {
  30336. value = key[ valuePropertyName ];
  30337. if ( value !== undefined ) {
  30338. times.push( key.time );
  30339. values.push( value );
  30340. }
  30341. key = jsonKeys[ i ++ ];
  30342. } while ( key !== undefined );
  30343. }
  30344. }
  30345. /**
  30346. * Creates a new clip, containing only the segment of the original clip between the given frames.
  30347. *
  30348. * @param {AnimationClip} sourceClip - The values to sort.
  30349. * @param {string} name - The name of the clip.
  30350. * @param {number} startFrame - The start frame.
  30351. * @param {number} endFrame - The end frame.
  30352. * @param {number} [fps=30] - The FPS.
  30353. * @return {AnimationClip} The new sub clip.
  30354. */
  30355. function subclip( sourceClip, name, startFrame, endFrame, fps = 30 ) {
  30356. const clip = sourceClip.clone();
  30357. clip.name = name;
  30358. const tracks = [];
  30359. for ( let i = 0; i < clip.tracks.length; ++ i ) {
  30360. const track = clip.tracks[ i ];
  30361. const valueSize = track.getValueSize();
  30362. const times = [];
  30363. const values = [];
  30364. for ( let j = 0; j < track.times.length; ++ j ) {
  30365. const frame = track.times[ j ] * fps;
  30366. if ( frame < startFrame || frame >= endFrame ) continue;
  30367. times.push( track.times[ j ] );
  30368. for ( let k = 0; k < valueSize; ++ k ) {
  30369. values.push( track.values[ j * valueSize + k ] );
  30370. }
  30371. }
  30372. if ( times.length === 0 ) continue;
  30373. track.times = convertArray( times, track.times.constructor );
  30374. track.values = convertArray( values, track.values.constructor );
  30375. tracks.push( track );
  30376. }
  30377. clip.tracks = tracks;
  30378. // find minimum .times value across all tracks in the trimmed clip
  30379. let minStartTime = Infinity;
  30380. for ( let i = 0; i < clip.tracks.length; ++ i ) {
  30381. if ( minStartTime > clip.tracks[ i ].times[ 0 ] ) {
  30382. minStartTime = clip.tracks[ i ].times[ 0 ];
  30383. }
  30384. }
  30385. // shift all tracks such that clip begins at t=0
  30386. for ( let i = 0; i < clip.tracks.length; ++ i ) {
  30387. clip.tracks[ i ].shift( -1 * minStartTime );
  30388. }
  30389. clip.resetDuration();
  30390. return clip;
  30391. }
  30392. /**
  30393. * Converts the keyframes of the given animation clip to an additive format.
  30394. *
  30395. * @param {AnimationClip} targetClip - The clip to make additive.
  30396. * @param {number} [referenceFrame=0] - The reference frame.
  30397. * @param {AnimationClip} [referenceClip=targetClip] - The reference clip.
  30398. * @param {number} [fps=30] - The FPS.
  30399. * @return {AnimationClip} The updated clip which is now additive.
  30400. */
  30401. function makeClipAdditive( targetClip, referenceFrame = 0, referenceClip = targetClip, fps = 30 ) {
  30402. if ( fps <= 0 ) fps = 30;
  30403. const numTracks = referenceClip.tracks.length;
  30404. const referenceTime = referenceFrame / fps;
  30405. // Make each track's values relative to the values at the reference frame
  30406. for ( let i = 0; i < numTracks; ++ i ) {
  30407. const referenceTrack = referenceClip.tracks[ i ];
  30408. const referenceTrackType = referenceTrack.ValueTypeName;
  30409. // Skip this track if it's non-numeric
  30410. if ( referenceTrackType === 'bool' || referenceTrackType === 'string' ) continue;
  30411. // Find the track in the target clip whose name and type matches the reference track
  30412. const targetTrack = targetClip.tracks.find( function ( track ) {
  30413. return track.name === referenceTrack.name
  30414. && track.ValueTypeName === referenceTrackType;
  30415. } );
  30416. if ( targetTrack === undefined ) continue;
  30417. let referenceOffset = 0;
  30418. const referenceValueSize = referenceTrack.getValueSize();
  30419. if ( referenceTrack.createInterpolant.isInterpolantFactoryMethodGLTFCubicSpline ) {
  30420. referenceOffset = referenceValueSize / 3;
  30421. }
  30422. let targetOffset = 0;
  30423. const targetValueSize = targetTrack.getValueSize();
  30424. if ( targetTrack.createInterpolant.isInterpolantFactoryMethodGLTFCubicSpline ) {
  30425. targetOffset = targetValueSize / 3;
  30426. }
  30427. const lastIndex = referenceTrack.times.length - 1;
  30428. let referenceValue;
  30429. // Find the value to subtract out of the track
  30430. if ( referenceTime <= referenceTrack.times[ 0 ] ) {
  30431. // Reference frame is earlier than the first keyframe, so just use the first keyframe
  30432. const startIndex = referenceOffset;
  30433. const endIndex = referenceValueSize - referenceOffset;
  30434. referenceValue = referenceTrack.values.slice( startIndex, endIndex );
  30435. } else if ( referenceTime >= referenceTrack.times[ lastIndex ] ) {
  30436. // Reference frame is after the last keyframe, so just use the last keyframe
  30437. const startIndex = lastIndex * referenceValueSize + referenceOffset;
  30438. const endIndex = startIndex + referenceValueSize - referenceOffset;
  30439. referenceValue = referenceTrack.values.slice( startIndex, endIndex );
  30440. } else {
  30441. // Interpolate to the reference value
  30442. const interpolant = referenceTrack.createInterpolant();
  30443. const startIndex = referenceOffset;
  30444. const endIndex = referenceValueSize - referenceOffset;
  30445. interpolant.evaluate( referenceTime );
  30446. referenceValue = interpolant.resultBuffer.slice( startIndex, endIndex );
  30447. }
  30448. // Conjugate the quaternion
  30449. if ( referenceTrackType === 'quaternion' ) {
  30450. const referenceQuat = new Quaternion().fromArray( referenceValue ).normalize().conjugate();
  30451. referenceQuat.toArray( referenceValue );
  30452. }
  30453. // Subtract the reference value from all of the track values
  30454. const numTimes = targetTrack.times.length;
  30455. for ( let j = 0; j < numTimes; ++ j ) {
  30456. const valueStart = j * targetValueSize + targetOffset;
  30457. if ( referenceTrackType === 'quaternion' ) {
  30458. // Multiply the conjugate for quaternion track types
  30459. Quaternion.multiplyQuaternionsFlat(
  30460. targetTrack.values,
  30461. valueStart,
  30462. referenceValue,
  30463. 0,
  30464. targetTrack.values,
  30465. valueStart
  30466. );
  30467. } else {
  30468. const valueEnd = targetValueSize - targetOffset * 2;
  30469. // Subtract each value for all other numeric track types
  30470. for ( let k = 0; k < valueEnd; ++ k ) {
  30471. targetTrack.values[ valueStart + k ] -= referenceValue[ k ];
  30472. }
  30473. }
  30474. }
  30475. }
  30476. targetClip.blendMode = AdditiveAnimationBlendMode;
  30477. return targetClip;
  30478. }
  30479. /**
  30480. * A class with various methods to assist with animations.
  30481. *
  30482. * @hideconstructor
  30483. */
  30484. class AnimationUtils {
  30485. /**
  30486. * Converts an array to a specific type
  30487. *
  30488. * @static
  30489. * @param {TypedArray|Array} array - The array to convert.
  30490. * @param {TypedArray.constructor} type - The constructor of a type array.
  30491. * @return {TypedArray} The converted array
  30492. */
  30493. static convertArray( array, type ) {
  30494. return convertArray( array, type );
  30495. }
  30496. /**
  30497. * Returns `true` if the given object is a typed array.
  30498. *
  30499. * @static
  30500. * @param {any} object - The object to check.
  30501. * @return {boolean} Whether the given object is a typed array.
  30502. */
  30503. static isTypedArray( object ) {
  30504. return isTypedArray( object );
  30505. }
  30506. /**
  30507. * Returns an array by which times and values can be sorted.
  30508. *
  30509. * @static
  30510. * @param {Array<number>} times - The keyframe time values.
  30511. * @return {Array<number>} The array.
  30512. */
  30513. static getKeyframeOrder( times ) {
  30514. return getKeyframeOrder( times );
  30515. }
  30516. /**
  30517. * Sorts the given array by the previously computed order via `getKeyframeOrder()`.
  30518. *
  30519. * @static
  30520. * @param {Array<number>} values - The values to sort.
  30521. * @param {number} stride - The stride.
  30522. * @param {Array<number>} order - The sort order.
  30523. * @return {Array<number>} The sorted values.
  30524. */
  30525. static sortedArray( values, stride, order ) {
  30526. return sortedArray( values, stride, order );
  30527. }
  30528. /**
  30529. * Used for parsing AOS keyframe formats.
  30530. *
  30531. * @static
  30532. * @param {Array<number>} jsonKeys - A list of JSON keyframes.
  30533. * @param {Array<number>} times - This array will be filled with keyframe times by this method.
  30534. * @param {Array<number>} values - This array will be filled with keyframe values by this method.
  30535. * @param {string} valuePropertyName - The name of the property to use.
  30536. */
  30537. static flattenJSON( jsonKeys, times, values, valuePropertyName ) {
  30538. flattenJSON( jsonKeys, times, values, valuePropertyName );
  30539. }
  30540. /**
  30541. * Creates a new clip, containing only the segment of the original clip between the given frames.
  30542. *
  30543. * @static
  30544. * @param {AnimationClip} sourceClip - The values to sort.
  30545. * @param {string} name - The name of the clip.
  30546. * @param {number} startFrame - The start frame.
  30547. * @param {number} endFrame - The end frame.
  30548. * @param {number} [fps=30] - The FPS.
  30549. * @return {AnimationClip} The new sub clip.
  30550. */
  30551. static subclip( sourceClip, name, startFrame, endFrame, fps = 30 ) {
  30552. return subclip( sourceClip, name, startFrame, endFrame, fps );
  30553. }
  30554. /**
  30555. * Converts the keyframes of the given animation clip to an additive format.
  30556. *
  30557. * @static
  30558. * @param {AnimationClip} targetClip - The clip to make additive.
  30559. * @param {number} [referenceFrame=0] - The reference frame.
  30560. * @param {AnimationClip} [referenceClip=targetClip] - The reference clip.
  30561. * @param {number} [fps=30] - The FPS.
  30562. * @return {AnimationClip} The updated clip which is now additive.
  30563. */
  30564. static makeClipAdditive( targetClip, referenceFrame = 0, referenceClip = targetClip, fps = 30 ) {
  30565. return makeClipAdditive( targetClip, referenceFrame, referenceClip, fps );
  30566. }
  30567. }
  30568. /**
  30569. * Abstract base class of interpolants over parametric samples.
  30570. *
  30571. * The parameter domain is one dimensional, typically the time or a path
  30572. * along a curve defined by the data.
  30573. *
  30574. * The sample values can have any dimensionality and derived classes may
  30575. * apply special interpretations to the data.
  30576. *
  30577. * This class provides the interval seek in a Template Method, deferring
  30578. * the actual interpolation to derived classes.
  30579. *
  30580. * Time complexity is O(1) for linear access crossing at most two points
  30581. * and O(log N) for random access, where N is the number of positions.
  30582. *
  30583. * References: {@link http://www.oodesign.com/template-method-pattern.html}
  30584. *
  30585. * @abstract
  30586. */
  30587. class Interpolant {
  30588. /**
  30589. * Constructs a new interpolant.
  30590. *
  30591. * @param {TypedArray} parameterPositions - The parameter positions hold the interpolation factors.
  30592. * @param {TypedArray} sampleValues - The sample values.
  30593. * @param {number} sampleSize - The sample size
  30594. * @param {TypedArray} [resultBuffer] - The result buffer.
  30595. */
  30596. constructor( parameterPositions, sampleValues, sampleSize, resultBuffer ) {
  30597. /**
  30598. * The parameter positions.
  30599. *
  30600. * @type {TypedArray}
  30601. */
  30602. this.parameterPositions = parameterPositions;
  30603. /**
  30604. * A cache index.
  30605. *
  30606. * @private
  30607. * @type {number}
  30608. * @default 0
  30609. */
  30610. this._cachedIndex = 0;
  30611. /**
  30612. * The result buffer.
  30613. *
  30614. * @type {TypedArray}
  30615. */
  30616. this.resultBuffer = resultBuffer !== undefined ? resultBuffer : new sampleValues.constructor( sampleSize );
  30617. /**
  30618. * The sample values.
  30619. *
  30620. * @type {TypedArray}
  30621. */
  30622. this.sampleValues = sampleValues;
  30623. /**
  30624. * The value size.
  30625. *
  30626. * @type {TypedArray}
  30627. */
  30628. this.valueSize = sampleSize;
  30629. /**
  30630. * The interpolation settings.
  30631. *
  30632. * @type {?Object}
  30633. * @default null
  30634. */
  30635. this.settings = null;
  30636. /**
  30637. * The default settings object.
  30638. *
  30639. * @type {Object}
  30640. */
  30641. this.DefaultSettings_ = {};
  30642. }
  30643. /**
  30644. * Evaluate the interpolant at position `t`.
  30645. *
  30646. * @param {number} t - The interpolation factor.
  30647. * @return {TypedArray} The result buffer.
  30648. */
  30649. evaluate( t ) {
  30650. const pp = this.parameterPositions;
  30651. let i1 = this._cachedIndex,
  30652. t1 = pp[ i1 ],
  30653. t0 = pp[ i1 - 1 ];
  30654. validate_interval: {
  30655. seek: {
  30656. let right;
  30657. linear_scan: {
  30658. //- See http://jsperf.com/comparison-to-undefined/3
  30659. //- slower code:
  30660. //-
  30661. //- if ( t >= t1 || t1 === undefined ) {
  30662. forward_scan: if ( ! ( t < t1 ) ) {
  30663. for ( let giveUpAt = i1 + 2; ; ) {
  30664. if ( t1 === undefined ) {
  30665. if ( t < t0 ) break forward_scan;
  30666. // after end
  30667. i1 = pp.length;
  30668. this._cachedIndex = i1;
  30669. return this.copySampleValue_( i1 - 1 );
  30670. }
  30671. if ( i1 === giveUpAt ) break; // this loop
  30672. t0 = t1;
  30673. t1 = pp[ ++ i1 ];
  30674. if ( t < t1 ) {
  30675. // we have arrived at the sought interval
  30676. break seek;
  30677. }
  30678. }
  30679. // prepare binary search on the right side of the index
  30680. right = pp.length;
  30681. break linear_scan;
  30682. }
  30683. //- slower code:
  30684. //- if ( t < t0 || t0 === undefined ) {
  30685. if ( ! ( t >= t0 ) ) {
  30686. // looping?
  30687. const t1global = pp[ 1 ];
  30688. if ( t < t1global ) {
  30689. i1 = 2; // + 1, using the scan for the details
  30690. t0 = t1global;
  30691. }
  30692. // linear reverse scan
  30693. for ( let giveUpAt = i1 - 2; ; ) {
  30694. if ( t0 === undefined ) {
  30695. // before start
  30696. this._cachedIndex = 0;
  30697. return this.copySampleValue_( 0 );
  30698. }
  30699. if ( i1 === giveUpAt ) break; // this loop
  30700. t1 = t0;
  30701. t0 = pp[ -- i1 - 1 ];
  30702. if ( t >= t0 ) {
  30703. // we have arrived at the sought interval
  30704. break seek;
  30705. }
  30706. }
  30707. // prepare binary search on the left side of the index
  30708. right = i1;
  30709. i1 = 0;
  30710. break linear_scan;
  30711. }
  30712. // the interval is valid
  30713. break validate_interval;
  30714. } // linear scan
  30715. // binary search
  30716. while ( i1 < right ) {
  30717. const mid = ( i1 + right ) >>> 1;
  30718. if ( t < pp[ mid ] ) {
  30719. right = mid;
  30720. } else {
  30721. i1 = mid + 1;
  30722. }
  30723. }
  30724. t1 = pp[ i1 ];
  30725. t0 = pp[ i1 - 1 ];
  30726. // check boundary cases, again
  30727. if ( t0 === undefined ) {
  30728. this._cachedIndex = 0;
  30729. return this.copySampleValue_( 0 );
  30730. }
  30731. if ( t1 === undefined ) {
  30732. i1 = pp.length;
  30733. this._cachedIndex = i1;
  30734. return this.copySampleValue_( i1 - 1 );
  30735. }
  30736. } // seek
  30737. this._cachedIndex = i1;
  30738. this.intervalChanged_( i1, t0, t1 );
  30739. } // validate_interval
  30740. return this.interpolate_( i1, t0, t, t1 );
  30741. }
  30742. /**
  30743. * Returns the interpolation settings.
  30744. *
  30745. * @return {Object} The interpolation settings.
  30746. */
  30747. getSettings_() {
  30748. return this.settings || this.DefaultSettings_;
  30749. }
  30750. /**
  30751. * Copies a sample value to the result buffer.
  30752. *
  30753. * @param {number} index - An index into the sample value buffer.
  30754. * @return {TypedArray} The result buffer.
  30755. */
  30756. copySampleValue_( index ) {
  30757. // copies a sample value to the result buffer
  30758. const result = this.resultBuffer,
  30759. values = this.sampleValues,
  30760. stride = this.valueSize,
  30761. offset = index * stride;
  30762. for ( let i = 0; i !== stride; ++ i ) {
  30763. result[ i ] = values[ offset + i ];
  30764. }
  30765. return result;
  30766. }
  30767. /**
  30768. * Copies a sample value to the result buffer.
  30769. *
  30770. * @abstract
  30771. * @param {number} i1 - An index into the sample value buffer.
  30772. * @param {number} t0 - The previous interpolation factor.
  30773. * @param {number} t - The current interpolation factor.
  30774. * @param {number} t1 - The next interpolation factor.
  30775. * @return {TypedArray} The result buffer.
  30776. */
  30777. interpolate_( /* i1, t0, t, t1 */ ) {
  30778. throw new Error( 'call to abstract method' );
  30779. // implementations shall return this.resultBuffer
  30780. }
  30781. /**
  30782. * Optional method that is executed when the interval has changed.
  30783. *
  30784. * @param {number} i1 - An index into the sample value buffer.
  30785. * @param {number} t0 - The previous interpolation factor.
  30786. * @param {number} t - The current interpolation factor.
  30787. */
  30788. intervalChanged_( /* i1, t0, t1 */ ) {
  30789. // empty
  30790. }
  30791. }
  30792. /**
  30793. * Fast and simple cubic spline interpolant.
  30794. *
  30795. * It was derived from a Hermitian construction setting the first derivative
  30796. * at each sample position to the linear slope between neighboring positions
  30797. * over their parameter interval.
  30798. *
  30799. * @augments Interpolant
  30800. */
  30801. class CubicInterpolant extends Interpolant {
  30802. /**
  30803. * Constructs a new cubic interpolant.
  30804. *
  30805. * @param {TypedArray} parameterPositions - The parameter positions hold the interpolation factors.
  30806. * @param {TypedArray} sampleValues - The sample values.
  30807. * @param {number} sampleSize - The sample size
  30808. * @param {TypedArray} [resultBuffer] - The result buffer.
  30809. */
  30810. constructor( parameterPositions, sampleValues, sampleSize, resultBuffer ) {
  30811. super( parameterPositions, sampleValues, sampleSize, resultBuffer );
  30812. this._weightPrev = -0;
  30813. this._offsetPrev = -0;
  30814. this._weightNext = -0;
  30815. this._offsetNext = -0;
  30816. this.DefaultSettings_ = {
  30817. endingStart: ZeroCurvatureEnding,
  30818. endingEnd: ZeroCurvatureEnding
  30819. };
  30820. }
  30821. intervalChanged_( i1, t0, t1 ) {
  30822. const pp = this.parameterPositions;
  30823. let iPrev = i1 - 2,
  30824. iNext = i1 + 1,
  30825. tPrev = pp[ iPrev ],
  30826. tNext = pp[ iNext ];
  30827. if ( tPrev === undefined ) {
  30828. switch ( this.getSettings_().endingStart ) {
  30829. case ZeroSlopeEnding:
  30830. // f'(t0) = 0
  30831. iPrev = i1;
  30832. tPrev = 2 * t0 - t1;
  30833. break;
  30834. case WrapAroundEnding:
  30835. // use the other end of the curve
  30836. iPrev = pp.length - 2;
  30837. tPrev = t0 + pp[ iPrev ] - pp[ iPrev + 1 ];
  30838. break;
  30839. default: // ZeroCurvatureEnding
  30840. // f''(t0) = 0 a.k.a. Natural Spline
  30841. iPrev = i1;
  30842. tPrev = t1;
  30843. }
  30844. }
  30845. if ( tNext === undefined ) {
  30846. switch ( this.getSettings_().endingEnd ) {
  30847. case ZeroSlopeEnding:
  30848. // f'(tN) = 0
  30849. iNext = i1;
  30850. tNext = 2 * t1 - t0;
  30851. break;
  30852. case WrapAroundEnding:
  30853. // use the other end of the curve
  30854. iNext = 1;
  30855. tNext = t1 + pp[ 1 ] - pp[ 0 ];
  30856. break;
  30857. default: // ZeroCurvatureEnding
  30858. // f''(tN) = 0, a.k.a. Natural Spline
  30859. iNext = i1 - 1;
  30860. tNext = t0;
  30861. }
  30862. }
  30863. const halfDt = ( t1 - t0 ) * 0.5,
  30864. stride = this.valueSize;
  30865. this._weightPrev = halfDt / ( t0 - tPrev );
  30866. this._weightNext = halfDt / ( tNext - t1 );
  30867. this._offsetPrev = iPrev * stride;
  30868. this._offsetNext = iNext * stride;
  30869. }
  30870. interpolate_( i1, t0, t, t1 ) {
  30871. const result = this.resultBuffer,
  30872. values = this.sampleValues,
  30873. stride = this.valueSize,
  30874. o1 = i1 * stride, o0 = o1 - stride,
  30875. oP = this._offsetPrev, oN = this._offsetNext,
  30876. wP = this._weightPrev, wN = this._weightNext,
  30877. p = ( t - t0 ) / ( t1 - t0 ),
  30878. pp = p * p,
  30879. ppp = pp * p;
  30880. // evaluate polynomials
  30881. const sP = - wP * ppp + 2 * wP * pp - wP * p;
  30882. const s0 = ( 1 + wP ) * ppp + ( -1.5 - 2 * wP ) * pp + ( -0.5 + wP ) * p + 1;
  30883. const s1 = ( -1 - wN ) * ppp + ( 1.5 + wN ) * pp + 0.5 * p;
  30884. const sN = wN * ppp - wN * pp;
  30885. // combine data linearly
  30886. for ( let i = 0; i !== stride; ++ i ) {
  30887. result[ i ] =
  30888. sP * values[ oP + i ] +
  30889. s0 * values[ o0 + i ] +
  30890. s1 * values[ o1 + i ] +
  30891. sN * values[ oN + i ];
  30892. }
  30893. return result;
  30894. }
  30895. }
  30896. /**
  30897. * A basic linear interpolant.
  30898. *
  30899. * @augments Interpolant
  30900. */
  30901. class LinearInterpolant extends Interpolant {
  30902. /**
  30903. * Constructs a new linear interpolant.
  30904. *
  30905. * @param {TypedArray} parameterPositions - The parameter positions hold the interpolation factors.
  30906. * @param {TypedArray} sampleValues - The sample values.
  30907. * @param {number} sampleSize - The sample size
  30908. * @param {TypedArray} [resultBuffer] - The result buffer.
  30909. */
  30910. constructor( parameterPositions, sampleValues, sampleSize, resultBuffer ) {
  30911. super( parameterPositions, sampleValues, sampleSize, resultBuffer );
  30912. }
  30913. interpolate_( i1, t0, t, t1 ) {
  30914. const result = this.resultBuffer,
  30915. values = this.sampleValues,
  30916. stride = this.valueSize,
  30917. offset1 = i1 * stride,
  30918. offset0 = offset1 - stride,
  30919. weight1 = ( t - t0 ) / ( t1 - t0 ),
  30920. weight0 = 1 - weight1;
  30921. for ( let i = 0; i !== stride; ++ i ) {
  30922. result[ i ] =
  30923. values[ offset0 + i ] * weight0 +
  30924. values[ offset1 + i ] * weight1;
  30925. }
  30926. return result;
  30927. }
  30928. }
  30929. /**
  30930. * Interpolant that evaluates to the sample value at the position preceding
  30931. * the parameter.
  30932. *
  30933. * @augments Interpolant
  30934. */
  30935. class DiscreteInterpolant extends Interpolant {
  30936. /**
  30937. * Constructs a new discrete interpolant.
  30938. *
  30939. * @param {TypedArray} parameterPositions - The parameter positions hold the interpolation factors.
  30940. * @param {TypedArray} sampleValues - The sample values.
  30941. * @param {number} sampleSize - The sample size
  30942. * @param {TypedArray} [resultBuffer] - The result buffer.
  30943. */
  30944. constructor( parameterPositions, sampleValues, sampleSize, resultBuffer ) {
  30945. super( parameterPositions, sampleValues, sampleSize, resultBuffer );
  30946. }
  30947. interpolate_( i1 /*, t0, t, t1 */ ) {
  30948. return this.copySampleValue_( i1 - 1 );
  30949. }
  30950. }
  30951. /**
  30952. * Represents a timed sequence of keyframes, which are composed of lists of
  30953. * times and related values, and which are used to animate a specific property
  30954. * of an object.
  30955. */
  30956. class KeyframeTrack {
  30957. /**
  30958. * Constructs a new keyframe track.
  30959. *
  30960. * @param {string} name - The keyframe track's name.
  30961. * @param {Array<number>} times - A list of keyframe times.
  30962. * @param {Array<number|string|boolean>} values - A list of keyframe values.
  30963. * @param {(InterpolateLinear|InterpolateDiscrete|InterpolateSmooth)} [interpolation] - The interpolation type.
  30964. */
  30965. constructor( name, times, values, interpolation ) {
  30966. if ( name === undefined ) throw new Error( 'THREE.KeyframeTrack: track name is undefined' );
  30967. if ( times === undefined || times.length === 0 ) throw new Error( 'THREE.KeyframeTrack: no keyframes in track named ' + name );
  30968. /**
  30969. * The track's name can refer to morph targets or bones or
  30970. * possibly other values within an animated object. See {@link PropertyBinding#parseTrackName}
  30971. * for the forms of strings that can be parsed for property binding.
  30972. *
  30973. * @type {string}
  30974. */
  30975. this.name = name;
  30976. /**
  30977. * The keyframe times.
  30978. *
  30979. * @type {Float32Array}
  30980. */
  30981. this.times = convertArray( times, this.TimeBufferType );
  30982. /**
  30983. * The keyframe values.
  30984. *
  30985. * @type {Float32Array}
  30986. */
  30987. this.values = convertArray( values, this.ValueBufferType );
  30988. this.setInterpolation( interpolation || this.DefaultInterpolation );
  30989. }
  30990. /**
  30991. * Converts the keyframe track to JSON.
  30992. *
  30993. * @static
  30994. * @param {KeyframeTrack} track - The keyframe track to serialize.
  30995. * @return {Object} The serialized keyframe track as JSON.
  30996. */
  30997. static toJSON( track ) {
  30998. const trackType = track.constructor;
  30999. let json;
  31000. // derived classes can define a static toJSON method
  31001. if ( trackType.toJSON !== this.toJSON ) {
  31002. json = trackType.toJSON( track );
  31003. } else {
  31004. // by default, we assume the data can be serialized as-is
  31005. json = {
  31006. 'name': track.name,
  31007. 'times': convertArray( track.times, Array ),
  31008. 'values': convertArray( track.values, Array )
  31009. };
  31010. const interpolation = track.getInterpolation();
  31011. if ( interpolation !== track.DefaultInterpolation ) {
  31012. json.interpolation = interpolation;
  31013. }
  31014. }
  31015. json.type = track.ValueTypeName; // mandatory
  31016. return json;
  31017. }
  31018. /**
  31019. * Factory method for creating a new discrete interpolant.
  31020. *
  31021. * @static
  31022. * @param {TypedArray} [result] - The result buffer.
  31023. * @return {DiscreteInterpolant} The new interpolant.
  31024. */
  31025. InterpolantFactoryMethodDiscrete( result ) {
  31026. return new DiscreteInterpolant( this.times, this.values, this.getValueSize(), result );
  31027. }
  31028. /**
  31029. * Factory method for creating a new linear interpolant.
  31030. *
  31031. * @static
  31032. * @param {TypedArray} [result] - The result buffer.
  31033. * @return {LinearInterpolant} The new interpolant.
  31034. */
  31035. InterpolantFactoryMethodLinear( result ) {
  31036. return new LinearInterpolant( this.times, this.values, this.getValueSize(), result );
  31037. }
  31038. /**
  31039. * Factory method for creating a new smooth interpolant.
  31040. *
  31041. * @static
  31042. * @param {TypedArray} [result] - The result buffer.
  31043. * @return {CubicInterpolant} The new interpolant.
  31044. */
  31045. InterpolantFactoryMethodSmooth( result ) {
  31046. return new CubicInterpolant( this.times, this.values, this.getValueSize(), result );
  31047. }
  31048. /**
  31049. * Defines the interpolation factor method for this keyframe track.
  31050. *
  31051. * @param {(InterpolateLinear|InterpolateDiscrete|InterpolateSmooth)} interpolation - The interpolation type.
  31052. * @return {KeyframeTrack} A reference to this keyframe track.
  31053. */
  31054. setInterpolation( interpolation ) {
  31055. let factoryMethod;
  31056. switch ( interpolation ) {
  31057. case InterpolateDiscrete:
  31058. factoryMethod = this.InterpolantFactoryMethodDiscrete;
  31059. break;
  31060. case InterpolateLinear:
  31061. factoryMethod = this.InterpolantFactoryMethodLinear;
  31062. break;
  31063. case InterpolateSmooth:
  31064. factoryMethod = this.InterpolantFactoryMethodSmooth;
  31065. break;
  31066. }
  31067. if ( factoryMethod === undefined ) {
  31068. const message = 'unsupported interpolation for ' +
  31069. this.ValueTypeName + ' keyframe track named ' + this.name;
  31070. if ( this.createInterpolant === undefined ) {
  31071. // fall back to default, unless the default itself is messed up
  31072. if ( interpolation !== this.DefaultInterpolation ) {
  31073. this.setInterpolation( this.DefaultInterpolation );
  31074. } else {
  31075. throw new Error( message ); // fatal, in this case
  31076. }
  31077. }
  31078. warn( 'KeyframeTrack:', message );
  31079. return this;
  31080. }
  31081. this.createInterpolant = factoryMethod;
  31082. return this;
  31083. }
  31084. /**
  31085. * Returns the current interpolation type.
  31086. *
  31087. * @return {(InterpolateLinear|InterpolateDiscrete|InterpolateSmooth)} The interpolation type.
  31088. */
  31089. getInterpolation() {
  31090. switch ( this.createInterpolant ) {
  31091. case this.InterpolantFactoryMethodDiscrete:
  31092. return InterpolateDiscrete;
  31093. case this.InterpolantFactoryMethodLinear:
  31094. return InterpolateLinear;
  31095. case this.InterpolantFactoryMethodSmooth:
  31096. return InterpolateSmooth;
  31097. }
  31098. }
  31099. /**
  31100. * Returns the value size.
  31101. *
  31102. * @return {number} The value size.
  31103. */
  31104. getValueSize() {
  31105. return this.values.length / this.times.length;
  31106. }
  31107. /**
  31108. * Moves all keyframes either forward or backward in time.
  31109. *
  31110. * @param {number} timeOffset - The offset to move the time values.
  31111. * @return {KeyframeTrack} A reference to this keyframe track.
  31112. */
  31113. shift( timeOffset ) {
  31114. if ( timeOffset !== 0.0 ) {
  31115. const times = this.times;
  31116. for ( let i = 0, n = times.length; i !== n; ++ i ) {
  31117. times[ i ] += timeOffset;
  31118. }
  31119. }
  31120. return this;
  31121. }
  31122. /**
  31123. * Scale all keyframe times by a factor (useful for frame - seconds conversions).
  31124. *
  31125. * @param {number} timeScale - The time scale.
  31126. * @return {KeyframeTrack} A reference to this keyframe track.
  31127. */
  31128. scale( timeScale ) {
  31129. if ( timeScale !== 1.0 ) {
  31130. const times = this.times;
  31131. for ( let i = 0, n = times.length; i !== n; ++ i ) {
  31132. times[ i ] *= timeScale;
  31133. }
  31134. }
  31135. return this;
  31136. }
  31137. /**
  31138. * Removes keyframes before and after animation without changing any values within the defined time range.
  31139. *
  31140. * Note: The method does not shift around keys to the start of the track time, because for interpolated
  31141. * keys this will change their values
  31142. *
  31143. * @param {number} startTime - The start time.
  31144. * @param {number} endTime - The end time.
  31145. * @return {KeyframeTrack} A reference to this keyframe track.
  31146. */
  31147. trim( startTime, endTime ) {
  31148. const times = this.times,
  31149. nKeys = times.length;
  31150. let from = 0,
  31151. to = nKeys - 1;
  31152. while ( from !== nKeys && times[ from ] < startTime ) {
  31153. ++ from;
  31154. }
  31155. while ( to !== -1 && times[ to ] > endTime ) {
  31156. -- to;
  31157. }
  31158. ++ to; // inclusive -> exclusive bound
  31159. if ( from !== 0 || to !== nKeys ) {
  31160. // empty tracks are forbidden, so keep at least one keyframe
  31161. if ( from >= to ) {
  31162. to = Math.max( to, 1 );
  31163. from = to - 1;
  31164. }
  31165. const stride = this.getValueSize();
  31166. this.times = times.slice( from, to );
  31167. this.values = this.values.slice( from * stride, to * stride );
  31168. }
  31169. return this;
  31170. }
  31171. /**
  31172. * Performs minimal validation on the keyframe track. Returns `true` if the values
  31173. * are valid.
  31174. *
  31175. * @return {boolean} Whether the keyframes are valid or not.
  31176. */
  31177. validate() {
  31178. let valid = true;
  31179. const valueSize = this.getValueSize();
  31180. if ( valueSize - Math.floor( valueSize ) !== 0 ) {
  31181. error( 'KeyframeTrack: Invalid value size in track.', this );
  31182. valid = false;
  31183. }
  31184. const times = this.times,
  31185. values = this.values,
  31186. nKeys = times.length;
  31187. if ( nKeys === 0 ) {
  31188. error( 'KeyframeTrack: Track is empty.', this );
  31189. valid = false;
  31190. }
  31191. let prevTime = null;
  31192. for ( let i = 0; i !== nKeys; i ++ ) {
  31193. const currTime = times[ i ];
  31194. if ( typeof currTime === 'number' && isNaN( currTime ) ) {
  31195. error( 'KeyframeTrack: Time is not a valid number.', this, i, currTime );
  31196. valid = false;
  31197. break;
  31198. }
  31199. if ( prevTime !== null && prevTime > currTime ) {
  31200. error( 'KeyframeTrack: Out of order keys.', this, i, currTime, prevTime );
  31201. valid = false;
  31202. break;
  31203. }
  31204. prevTime = currTime;
  31205. }
  31206. if ( values !== undefined ) {
  31207. if ( isTypedArray( values ) ) {
  31208. for ( let i = 0, n = values.length; i !== n; ++ i ) {
  31209. const value = values[ i ];
  31210. if ( isNaN( value ) ) {
  31211. error( 'KeyframeTrack: Value is not a valid number.', this, i, value );
  31212. valid = false;
  31213. break;
  31214. }
  31215. }
  31216. }
  31217. }
  31218. return valid;
  31219. }
  31220. /**
  31221. * Optimizes this keyframe track by removing equivalent sequential keys (which are
  31222. * common in morph target sequences).
  31223. *
  31224. * @return {KeyframeTrack} A reference to this keyframe track.
  31225. */
  31226. optimize() {
  31227. // (0,0,0,0,1,1,1,0,0,0,0,0,0,0) --> (0,0,1,1,0,0)
  31228. // times or values may be shared with other tracks, so overwriting is unsafe
  31229. const times = this.times.slice(),
  31230. values = this.values.slice(),
  31231. stride = this.getValueSize(),
  31232. smoothInterpolation = this.getInterpolation() === InterpolateSmooth,
  31233. lastIndex = times.length - 1;
  31234. let writeIndex = 1;
  31235. for ( let i = 1; i < lastIndex; ++ i ) {
  31236. let keep = false;
  31237. const time = times[ i ];
  31238. const timeNext = times[ i + 1 ];
  31239. // remove adjacent keyframes scheduled at the same time
  31240. if ( time !== timeNext && ( i !== 1 || time !== times[ 0 ] ) ) {
  31241. if ( ! smoothInterpolation ) {
  31242. // remove unnecessary keyframes same as their neighbors
  31243. const offset = i * stride,
  31244. offsetP = offset - stride,
  31245. offsetN = offset + stride;
  31246. for ( let j = 0; j !== stride; ++ j ) {
  31247. const value = values[ offset + j ];
  31248. if ( value !== values[ offsetP + j ] ||
  31249. value !== values[ offsetN + j ] ) {
  31250. keep = true;
  31251. break;
  31252. }
  31253. }
  31254. } else {
  31255. keep = true;
  31256. }
  31257. }
  31258. // in-place compaction
  31259. if ( keep ) {
  31260. if ( i !== writeIndex ) {
  31261. times[ writeIndex ] = times[ i ];
  31262. const readOffset = i * stride,
  31263. writeOffset = writeIndex * stride;
  31264. for ( let j = 0; j !== stride; ++ j ) {
  31265. values[ writeOffset + j ] = values[ readOffset + j ];
  31266. }
  31267. }
  31268. ++ writeIndex;
  31269. }
  31270. }
  31271. // flush last keyframe (compaction looks ahead)
  31272. if ( lastIndex > 0 ) {
  31273. times[ writeIndex ] = times[ lastIndex ];
  31274. for ( let readOffset = lastIndex * stride, writeOffset = writeIndex * stride, j = 0; j !== stride; ++ j ) {
  31275. values[ writeOffset + j ] = values[ readOffset + j ];
  31276. }
  31277. ++ writeIndex;
  31278. }
  31279. if ( writeIndex !== times.length ) {
  31280. this.times = times.slice( 0, writeIndex );
  31281. this.values = values.slice( 0, writeIndex * stride );
  31282. } else {
  31283. this.times = times;
  31284. this.values = values;
  31285. }
  31286. return this;
  31287. }
  31288. /**
  31289. * Returns a new keyframe track with copied values from this instance.
  31290. *
  31291. * @return {KeyframeTrack} A clone of this instance.
  31292. */
  31293. clone() {
  31294. const times = this.times.slice();
  31295. const values = this.values.slice();
  31296. const TypedKeyframeTrack = this.constructor;
  31297. const track = new TypedKeyframeTrack( this.name, times, values );
  31298. // Interpolant argument to constructor is not saved, so copy the factory method directly.
  31299. track.createInterpolant = this.createInterpolant;
  31300. return track;
  31301. }
  31302. }
  31303. /**
  31304. * The value type name.
  31305. *
  31306. * @type {string}
  31307. * @default ''
  31308. */
  31309. KeyframeTrack.prototype.ValueTypeName = '';
  31310. /**
  31311. * The time buffer type of this keyframe track.
  31312. *
  31313. * @type {TypedArray|Array}
  31314. * @default Float32Array.constructor
  31315. */
  31316. KeyframeTrack.prototype.TimeBufferType = Float32Array;
  31317. /**
  31318. * The value buffer type of this keyframe track.
  31319. *
  31320. * @type {TypedArray|Array}
  31321. * @default Float32Array.constructor
  31322. */
  31323. KeyframeTrack.prototype.ValueBufferType = Float32Array;
  31324. /**
  31325. * The default interpolation type of this keyframe track.
  31326. *
  31327. * @type {(InterpolateLinear|InterpolateDiscrete|InterpolateSmooth)}
  31328. * @default InterpolateLinear
  31329. */
  31330. KeyframeTrack.prototype.DefaultInterpolation = InterpolateLinear;
  31331. /**
  31332. * A track for boolean keyframe values.
  31333. *
  31334. * @augments KeyframeTrack
  31335. */
  31336. class BooleanKeyframeTrack extends KeyframeTrack {
  31337. /**
  31338. * Constructs a new boolean keyframe track.
  31339. *
  31340. * This keyframe track type has no `interpolation` parameter because the
  31341. * interpolation is always discrete.
  31342. *
  31343. * @param {string} name - The keyframe track's name.
  31344. * @param {Array<number>} times - A list of keyframe times.
  31345. * @param {Array<boolean>} values - A list of keyframe values.
  31346. */
  31347. constructor( name, times, values ) {
  31348. super( name, times, values );
  31349. }
  31350. }
  31351. /**
  31352. * The value type name.
  31353. *
  31354. * @type {string}
  31355. * @default 'bool'
  31356. */
  31357. BooleanKeyframeTrack.prototype.ValueTypeName = 'bool';
  31358. /**
  31359. * The value buffer type of this keyframe track.
  31360. *
  31361. * @type {TypedArray|Array}
  31362. * @default Array.constructor
  31363. */
  31364. BooleanKeyframeTrack.prototype.ValueBufferType = Array;
  31365. /**
  31366. * The default interpolation type of this keyframe track.
  31367. *
  31368. * @type {(InterpolateLinear|InterpolateDiscrete|InterpolateSmooth)}
  31369. * @default InterpolateDiscrete
  31370. */
  31371. BooleanKeyframeTrack.prototype.DefaultInterpolation = InterpolateDiscrete;
  31372. BooleanKeyframeTrack.prototype.InterpolantFactoryMethodLinear = undefined;
  31373. BooleanKeyframeTrack.prototype.InterpolantFactoryMethodSmooth = undefined;
  31374. /**
  31375. * A track for color keyframe values.
  31376. *
  31377. * @augments KeyframeTrack
  31378. */
  31379. class ColorKeyframeTrack extends KeyframeTrack {
  31380. /**
  31381. * Constructs a new color keyframe track.
  31382. *
  31383. * @param {string} name - The keyframe track's name.
  31384. * @param {Array<number>} times - A list of keyframe times.
  31385. * @param {Array<number>} values - A list of keyframe values.
  31386. * @param {(InterpolateLinear|InterpolateDiscrete|InterpolateSmooth)} [interpolation] - The interpolation type.
  31387. */
  31388. constructor( name, times, values, interpolation ) {
  31389. super( name, times, values, interpolation );
  31390. }
  31391. }
  31392. /**
  31393. * The value type name.
  31394. *
  31395. * @type {string}
  31396. * @default 'color'
  31397. */
  31398. ColorKeyframeTrack.prototype.ValueTypeName = 'color';
  31399. /**
  31400. * A track for numeric keyframe values.
  31401. *
  31402. * @augments KeyframeTrack
  31403. */
  31404. class NumberKeyframeTrack extends KeyframeTrack {
  31405. /**
  31406. * Constructs a new number keyframe track.
  31407. *
  31408. * @param {string} name - The keyframe track's name.
  31409. * @param {Array<number>} times - A list of keyframe times.
  31410. * @param {Array<number>} values - A list of keyframe values.
  31411. * @param {(InterpolateLinear|InterpolateDiscrete|InterpolateSmooth)} [interpolation] - The interpolation type.
  31412. */
  31413. constructor( name, times, values, interpolation ) {
  31414. super( name, times, values, interpolation );
  31415. }
  31416. }
  31417. /**
  31418. * The value type name.
  31419. *
  31420. * @type {string}
  31421. * @default 'number'
  31422. */
  31423. NumberKeyframeTrack.prototype.ValueTypeName = 'number';
  31424. /**
  31425. * Spherical linear unit quaternion interpolant.
  31426. *
  31427. * @augments Interpolant
  31428. */
  31429. class QuaternionLinearInterpolant extends Interpolant {
  31430. /**
  31431. * Constructs a new SLERP interpolant.
  31432. *
  31433. * @param {TypedArray} parameterPositions - The parameter positions hold the interpolation factors.
  31434. * @param {TypedArray} sampleValues - The sample values.
  31435. * @param {number} sampleSize - The sample size
  31436. * @param {TypedArray} [resultBuffer] - The result buffer.
  31437. */
  31438. constructor( parameterPositions, sampleValues, sampleSize, resultBuffer ) {
  31439. super( parameterPositions, sampleValues, sampleSize, resultBuffer );
  31440. }
  31441. interpolate_( i1, t0, t, t1 ) {
  31442. const result = this.resultBuffer,
  31443. values = this.sampleValues,
  31444. stride = this.valueSize,
  31445. alpha = ( t - t0 ) / ( t1 - t0 );
  31446. let offset = i1 * stride;
  31447. for ( let end = offset + stride; offset !== end; offset += 4 ) {
  31448. Quaternion.slerpFlat( result, 0, values, offset - stride, values, offset, alpha );
  31449. }
  31450. return result;
  31451. }
  31452. }
  31453. /**
  31454. * A track for Quaternion keyframe values.
  31455. *
  31456. * @augments KeyframeTrack
  31457. */
  31458. class QuaternionKeyframeTrack extends KeyframeTrack {
  31459. /**
  31460. * Constructs a new Quaternion keyframe track.
  31461. *
  31462. * @param {string} name - The keyframe track's name.
  31463. * @param {Array<number>} times - A list of keyframe times.
  31464. * @param {Array<number>} values - A list of keyframe values.
  31465. * @param {(InterpolateLinear|InterpolateDiscrete|InterpolateSmooth)} [interpolation] - The interpolation type.
  31466. */
  31467. constructor( name, times, values, interpolation ) {
  31468. super( name, times, values, interpolation );
  31469. }
  31470. /**
  31471. * Overwritten so the method returns Quaternion based interpolant.
  31472. *
  31473. * @static
  31474. * @param {TypedArray} [result] - The result buffer.
  31475. * @return {QuaternionLinearInterpolant} The new interpolant.
  31476. */
  31477. InterpolantFactoryMethodLinear( result ) {
  31478. return new QuaternionLinearInterpolant( this.times, this.values, this.getValueSize(), result );
  31479. }
  31480. }
  31481. /**
  31482. * The value type name.
  31483. *
  31484. * @type {string}
  31485. * @default 'quaternion'
  31486. */
  31487. QuaternionKeyframeTrack.prototype.ValueTypeName = 'quaternion';
  31488. // ValueBufferType is inherited
  31489. // DefaultInterpolation is inherited;
  31490. QuaternionKeyframeTrack.prototype.InterpolantFactoryMethodSmooth = undefined;
  31491. /**
  31492. * A track for string keyframe values.
  31493. *
  31494. * @augments KeyframeTrack
  31495. */
  31496. class StringKeyframeTrack extends KeyframeTrack {
  31497. /**
  31498. * Constructs a new string keyframe track.
  31499. *
  31500. * This keyframe track type has no `interpolation` parameter because the
  31501. * interpolation is always discrete.
  31502. *
  31503. * @param {string} name - The keyframe track's name.
  31504. * @param {Array<number>} times - A list of keyframe times.
  31505. * @param {Array<string>} values - A list of keyframe values.
  31506. */
  31507. constructor( name, times, values ) {
  31508. super( name, times, values );
  31509. }
  31510. }
  31511. /**
  31512. * The value type name.
  31513. *
  31514. * @type {string}
  31515. * @default 'string'
  31516. */
  31517. StringKeyframeTrack.prototype.ValueTypeName = 'string';
  31518. /**
  31519. * The value buffer type of this keyframe track.
  31520. *
  31521. * @type {TypedArray|Array}
  31522. * @default Array.constructor
  31523. */
  31524. StringKeyframeTrack.prototype.ValueBufferType = Array;
  31525. /**
  31526. * The default interpolation type of this keyframe track.
  31527. *
  31528. * @type {(InterpolateLinear|InterpolateDiscrete|InterpolateSmooth)}
  31529. * @default InterpolateDiscrete
  31530. */
  31531. StringKeyframeTrack.prototype.DefaultInterpolation = InterpolateDiscrete;
  31532. StringKeyframeTrack.prototype.InterpolantFactoryMethodLinear = undefined;
  31533. StringKeyframeTrack.prototype.InterpolantFactoryMethodSmooth = undefined;
  31534. /**
  31535. * A track for vector keyframe values.
  31536. *
  31537. * @augments KeyframeTrack
  31538. */
  31539. class VectorKeyframeTrack extends KeyframeTrack {
  31540. /**
  31541. * Constructs a new vector keyframe track.
  31542. *
  31543. * @param {string} name - The keyframe track's name.
  31544. * @param {Array<number>} times - A list of keyframe times.
  31545. * @param {Array<number>} values - A list of keyframe values.
  31546. * @param {(InterpolateLinear|InterpolateDiscrete|InterpolateSmooth)} [interpolation] - The interpolation type.
  31547. */
  31548. constructor( name, times, values, interpolation ) {
  31549. super( name, times, values, interpolation );
  31550. }
  31551. }
  31552. /**
  31553. * The value type name.
  31554. *
  31555. * @type {string}
  31556. * @default 'vector'
  31557. */
  31558. VectorKeyframeTrack.prototype.ValueTypeName = 'vector';
  31559. /**
  31560. * A reusable set of keyframe tracks which represent an animation.
  31561. */
  31562. class AnimationClip {
  31563. /**
  31564. * Constructs a new animation clip.
  31565. *
  31566. * Note: Instead of instantiating an AnimationClip directly with the constructor, you can
  31567. * use the static interface of this class for creating clips. In most cases though, animation clips
  31568. * will automatically be created by loaders when importing animated 3D assets.
  31569. *
  31570. * @param {string} [name=''] - The clip's name.
  31571. * @param {number} [duration=-1] - The clip's duration in seconds. If a negative value is passed,
  31572. * the duration will be calculated from the passed keyframes.
  31573. * @param {Array<KeyframeTrack>} tracks - An array of keyframe tracks.
  31574. * @param {(NormalAnimationBlendMode|AdditiveAnimationBlendMode)} [blendMode=NormalAnimationBlendMode] - Defines how the animation
  31575. * is blended/combined when two or more animations are simultaneously played.
  31576. */
  31577. constructor( name = '', duration = -1, tracks = [], blendMode = NormalAnimationBlendMode ) {
  31578. /**
  31579. * The clip's name.
  31580. *
  31581. * @type {string}
  31582. */
  31583. this.name = name;
  31584. /**
  31585. * An array of keyframe tracks.
  31586. *
  31587. * @type {Array<KeyframeTrack>}
  31588. */
  31589. this.tracks = tracks;
  31590. /**
  31591. * The clip's duration in seconds.
  31592. *
  31593. * @type {number}
  31594. */
  31595. this.duration = duration;
  31596. /**
  31597. * Defines how the animation is blended/combined when two or more animations
  31598. * are simultaneously played.
  31599. *
  31600. * @type {(NormalAnimationBlendMode|AdditiveAnimationBlendMode)}
  31601. */
  31602. this.blendMode = blendMode;
  31603. /**
  31604. * The UUID of the animation clip.
  31605. *
  31606. * @type {string}
  31607. * @readonly
  31608. */
  31609. this.uuid = generateUUID();
  31610. /**
  31611. * An object that can be used to store custom data about the animation clip.
  31612. * It should not hold references to functions as these will not be cloned.
  31613. *
  31614. * @type {Object}
  31615. */
  31616. this.userData = {};
  31617. // this means it should figure out its duration by scanning the tracks
  31618. if ( this.duration < 0 ) {
  31619. this.resetDuration();
  31620. }
  31621. }
  31622. /**
  31623. * Factory method for creating an animation clip from the given JSON.
  31624. *
  31625. * @static
  31626. * @param {Object} json - The serialized animation clip.
  31627. * @return {AnimationClip} The new animation clip.
  31628. */
  31629. static parse( json ) {
  31630. const tracks = [],
  31631. jsonTracks = json.tracks,
  31632. frameTime = 1.0 / ( json.fps || 1.0 );
  31633. for ( let i = 0, n = jsonTracks.length; i !== n; ++ i ) {
  31634. tracks.push( parseKeyframeTrack( jsonTracks[ i ] ).scale( frameTime ) );
  31635. }
  31636. const clip = new this( json.name, json.duration, tracks, json.blendMode );
  31637. clip.uuid = json.uuid;
  31638. clip.userData = JSON.parse( json.userData || '{}' );
  31639. return clip;
  31640. }
  31641. /**
  31642. * Serializes the given animation clip into JSON.
  31643. *
  31644. * @static
  31645. * @param {AnimationClip} clip - The animation clip to serialize.
  31646. * @return {Object} The JSON object.
  31647. */
  31648. static toJSON( clip ) {
  31649. const tracks = [],
  31650. clipTracks = clip.tracks;
  31651. const json = {
  31652. 'name': clip.name,
  31653. 'duration': clip.duration,
  31654. 'tracks': tracks,
  31655. 'uuid': clip.uuid,
  31656. 'blendMode': clip.blendMode,
  31657. 'userData': JSON.stringify( clip.userData ),
  31658. };
  31659. for ( let i = 0, n = clipTracks.length; i !== n; ++ i ) {
  31660. tracks.push( KeyframeTrack.toJSON( clipTracks[ i ] ) );
  31661. }
  31662. return json;
  31663. }
  31664. /**
  31665. * Returns a new animation clip from the passed morph targets array of a
  31666. * geometry, taking a name and the number of frames per second.
  31667. *
  31668. * Note: The fps parameter is required, but the animation speed can be
  31669. * overridden via {@link AnimationAction#setDuration}.
  31670. *
  31671. * @static
  31672. * @param {string} name - The name of the animation clip.
  31673. * @param {Array<Object>} morphTargetSequence - A sequence of morph targets.
  31674. * @param {number} fps - The Frames-Per-Second value.
  31675. * @param {boolean} noLoop - Whether the clip should be no loop or not.
  31676. * @return {AnimationClip} The new animation clip.
  31677. */
  31678. static CreateFromMorphTargetSequence( name, morphTargetSequence, fps, noLoop ) {
  31679. const numMorphTargets = morphTargetSequence.length;
  31680. const tracks = [];
  31681. for ( let i = 0; i < numMorphTargets; i ++ ) {
  31682. let times = [];
  31683. let values = [];
  31684. times.push(
  31685. ( i + numMorphTargets - 1 ) % numMorphTargets,
  31686. i,
  31687. ( i + 1 ) % numMorphTargets );
  31688. values.push( 0, 1, 0 );
  31689. const order = getKeyframeOrder( times );
  31690. times = sortedArray( times, 1, order );
  31691. values = sortedArray( values, 1, order );
  31692. // if there is a key at the first frame, duplicate it as the
  31693. // last frame as well for perfect loop.
  31694. if ( ! noLoop && times[ 0 ] === 0 ) {
  31695. times.push( numMorphTargets );
  31696. values.push( values[ 0 ] );
  31697. }
  31698. tracks.push(
  31699. new NumberKeyframeTrack(
  31700. '.morphTargetInfluences[' + morphTargetSequence[ i ].name + ']',
  31701. times, values
  31702. ).scale( 1.0 / fps ) );
  31703. }
  31704. return new this( name, -1, tracks );
  31705. }
  31706. /**
  31707. * Searches for an animation clip by name, taking as its first parameter
  31708. * either an array of clips, or a mesh or geometry that contains an
  31709. * array named "animations" property.
  31710. *
  31711. * @static
  31712. * @param {(Array<AnimationClip>|Object3D)} objectOrClipArray - The array or object to search through.
  31713. * @param {string} name - The name to search for.
  31714. * @return {?AnimationClip} The found animation clip. Returns `null` if no clip has been found.
  31715. */
  31716. static findByName( objectOrClipArray, name ) {
  31717. let clipArray = objectOrClipArray;
  31718. if ( ! Array.isArray( objectOrClipArray ) ) {
  31719. const o = objectOrClipArray;
  31720. clipArray = o.geometry && o.geometry.animations || o.animations;
  31721. }
  31722. for ( let i = 0; i < clipArray.length; i ++ ) {
  31723. if ( clipArray[ i ].name === name ) {
  31724. return clipArray[ i ];
  31725. }
  31726. }
  31727. return null;
  31728. }
  31729. /**
  31730. * Returns an array of new AnimationClips created from the morph target
  31731. * sequences of a geometry, trying to sort morph target names into
  31732. * animation-group-based patterns like "Walk_001, Walk_002, Run_001, Run_002...".
  31733. *
  31734. * See {@link MD2Loader#parse} as an example for how the method should be used.
  31735. *
  31736. * @static
  31737. * @param {Array<Object>} morphTargets - A sequence of morph targets.
  31738. * @param {number} fps - The Frames-Per-Second value.
  31739. * @param {boolean} noLoop - Whether the clip should be no loop or not.
  31740. * @return {Array<AnimationClip>} An array of new animation clips.
  31741. */
  31742. static CreateClipsFromMorphTargetSequences( morphTargets, fps, noLoop ) {
  31743. const animationToMorphTargets = {};
  31744. // tested with https://regex101.com/ on trick sequences
  31745. // such flamingo_flyA_003, flamingo_run1_003, crdeath0059
  31746. const pattern = /^([\w-]*?)([\d]+)$/;
  31747. // sort morph target names into animation groups based
  31748. // patterns like Walk_001, Walk_002, Run_001, Run_002
  31749. for ( let i = 0, il = morphTargets.length; i < il; i ++ ) {
  31750. const morphTarget = morphTargets[ i ];
  31751. const parts = morphTarget.name.match( pattern );
  31752. if ( parts && parts.length > 1 ) {
  31753. const name = parts[ 1 ];
  31754. let animationMorphTargets = animationToMorphTargets[ name ];
  31755. if ( ! animationMorphTargets ) {
  31756. animationToMorphTargets[ name ] = animationMorphTargets = [];
  31757. }
  31758. animationMorphTargets.push( morphTarget );
  31759. }
  31760. }
  31761. const clips = [];
  31762. for ( const name in animationToMorphTargets ) {
  31763. clips.push( this.CreateFromMorphTargetSequence( name, animationToMorphTargets[ name ], fps, noLoop ) );
  31764. }
  31765. return clips;
  31766. }
  31767. /**
  31768. * Parses the `animation.hierarchy` format and returns a new animation clip.
  31769. *
  31770. * @static
  31771. * @deprecated since r175.
  31772. * @param {Object} animation - A serialized animation clip as JSON.
  31773. * @param {Array<Bone>} bones - An array of bones.
  31774. * @return {?AnimationClip} The new animation clip.
  31775. */
  31776. static parseAnimation( animation, bones ) {
  31777. warn( 'AnimationClip: parseAnimation() is deprecated and will be removed with r185' );
  31778. if ( ! animation ) {
  31779. error( 'AnimationClip: No animation in JSONLoader data.' );
  31780. return null;
  31781. }
  31782. const addNonemptyTrack = function ( trackType, trackName, animationKeys, propertyName, destTracks ) {
  31783. // only return track if there are actually keys.
  31784. if ( animationKeys.length !== 0 ) {
  31785. const times = [];
  31786. const values = [];
  31787. flattenJSON( animationKeys, times, values, propertyName );
  31788. // empty keys are filtered out, so check again
  31789. if ( times.length !== 0 ) {
  31790. destTracks.push( new trackType( trackName, times, values ) );
  31791. }
  31792. }
  31793. };
  31794. const tracks = [];
  31795. const clipName = animation.name || 'default';
  31796. const fps = animation.fps || 30;
  31797. const blendMode = animation.blendMode;
  31798. // automatic length determination in AnimationClip.
  31799. let duration = animation.length || -1;
  31800. const hierarchyTracks = animation.hierarchy || [];
  31801. for ( let h = 0; h < hierarchyTracks.length; h ++ ) {
  31802. const animationKeys = hierarchyTracks[ h ].keys;
  31803. // skip empty tracks
  31804. if ( ! animationKeys || animationKeys.length === 0 ) continue;
  31805. // process morph targets
  31806. if ( animationKeys[ 0 ].morphTargets ) {
  31807. // figure out all morph targets used in this track
  31808. const morphTargetNames = {};
  31809. let k;
  31810. for ( k = 0; k < animationKeys.length; k ++ ) {
  31811. if ( animationKeys[ k ].morphTargets ) {
  31812. for ( let m = 0; m < animationKeys[ k ].morphTargets.length; m ++ ) {
  31813. morphTargetNames[ animationKeys[ k ].morphTargets[ m ] ] = -1;
  31814. }
  31815. }
  31816. }
  31817. // create a track for each morph target with all zero
  31818. // morphTargetInfluences except for the keys in which
  31819. // the morphTarget is named.
  31820. for ( const morphTargetName in morphTargetNames ) {
  31821. const times = [];
  31822. const values = [];
  31823. for ( let m = 0; m !== animationKeys[ k ].morphTargets.length; ++ m ) {
  31824. const animationKey = animationKeys[ k ];
  31825. times.push( animationKey.time );
  31826. values.push( ( animationKey.morphTarget === morphTargetName ) ? 1 : 0 );
  31827. }
  31828. tracks.push( new NumberKeyframeTrack( '.morphTargetInfluence[' + morphTargetName + ']', times, values ) );
  31829. }
  31830. duration = morphTargetNames.length * fps;
  31831. } else {
  31832. // ...assume skeletal animation
  31833. const boneName = '.bones[' + bones[ h ].name + ']';
  31834. addNonemptyTrack(
  31835. VectorKeyframeTrack, boneName + '.position',
  31836. animationKeys, 'pos', tracks );
  31837. addNonemptyTrack(
  31838. QuaternionKeyframeTrack, boneName + '.quaternion',
  31839. animationKeys, 'rot', tracks );
  31840. addNonemptyTrack(
  31841. VectorKeyframeTrack, boneName + '.scale',
  31842. animationKeys, 'scl', tracks );
  31843. }
  31844. }
  31845. if ( tracks.length === 0 ) {
  31846. return null;
  31847. }
  31848. const clip = new this( clipName, duration, tracks, blendMode );
  31849. return clip;
  31850. }
  31851. /**
  31852. * Sets the duration of this clip to the duration of its longest keyframe track.
  31853. *
  31854. * @return {AnimationClip} A reference to this animation clip.
  31855. */
  31856. resetDuration() {
  31857. const tracks = this.tracks;
  31858. let duration = 0;
  31859. for ( let i = 0, n = tracks.length; i !== n; ++ i ) {
  31860. const track = this.tracks[ i ];
  31861. duration = Math.max( duration, track.times[ track.times.length - 1 ] );
  31862. }
  31863. this.duration = duration;
  31864. return this;
  31865. }
  31866. /**
  31867. * Trims all tracks to the clip's duration.
  31868. *
  31869. * @return {AnimationClip} A reference to this animation clip.
  31870. */
  31871. trim() {
  31872. for ( let i = 0; i < this.tracks.length; i ++ ) {
  31873. this.tracks[ i ].trim( 0, this.duration );
  31874. }
  31875. return this;
  31876. }
  31877. /**
  31878. * Performs minimal validation on each track in the clip. Returns `true` if all
  31879. * tracks are valid.
  31880. *
  31881. * @return {boolean} Whether the clip's keyframes are valid or not.
  31882. */
  31883. validate() {
  31884. let valid = true;
  31885. for ( let i = 0; i < this.tracks.length; i ++ ) {
  31886. valid = valid && this.tracks[ i ].validate();
  31887. }
  31888. return valid;
  31889. }
  31890. /**
  31891. * Optimizes each track by removing equivalent sequential keys (which are
  31892. * common in morph target sequences).
  31893. *
  31894. * @return {AnimationClip} A reference to this animation clip.
  31895. */
  31896. optimize() {
  31897. for ( let i = 0; i < this.tracks.length; i ++ ) {
  31898. this.tracks[ i ].optimize();
  31899. }
  31900. return this;
  31901. }
  31902. /**
  31903. * Returns a new animation clip with copied values from this instance.
  31904. *
  31905. * @return {AnimationClip} A clone of this instance.
  31906. */
  31907. clone() {
  31908. const tracks = [];
  31909. for ( let i = 0; i < this.tracks.length; i ++ ) {
  31910. tracks.push( this.tracks[ i ].clone() );
  31911. }
  31912. const clip = new this.constructor( this.name, this.duration, tracks, this.blendMode );
  31913. clip.userData = JSON.parse( JSON.stringify( this.userData ) );
  31914. return clip;
  31915. }
  31916. /**
  31917. * Serializes this animation clip into JSON.
  31918. *
  31919. * @return {Object} The JSON object.
  31920. */
  31921. toJSON() {
  31922. return this.constructor.toJSON( this );
  31923. }
  31924. }
  31925. function getTrackTypeForValueTypeName( typeName ) {
  31926. switch ( typeName.toLowerCase() ) {
  31927. case 'scalar':
  31928. case 'double':
  31929. case 'float':
  31930. case 'number':
  31931. case 'integer':
  31932. return NumberKeyframeTrack;
  31933. case 'vector':
  31934. case 'vector2':
  31935. case 'vector3':
  31936. case 'vector4':
  31937. return VectorKeyframeTrack;
  31938. case 'color':
  31939. return ColorKeyframeTrack;
  31940. case 'quaternion':
  31941. return QuaternionKeyframeTrack;
  31942. case 'bool':
  31943. case 'boolean':
  31944. return BooleanKeyframeTrack;
  31945. case 'string':
  31946. return StringKeyframeTrack;
  31947. }
  31948. throw new Error( 'THREE.KeyframeTrack: Unsupported typeName: ' + typeName );
  31949. }
  31950. function parseKeyframeTrack( json ) {
  31951. if ( json.type === undefined ) {
  31952. throw new Error( 'THREE.KeyframeTrack: track type undefined, can not parse' );
  31953. }
  31954. const trackType = getTrackTypeForValueTypeName( json.type );
  31955. if ( json.times === undefined ) {
  31956. const times = [], values = [];
  31957. flattenJSON( json.keys, times, values, 'value' );
  31958. json.times = times;
  31959. json.values = values;
  31960. }
  31961. // derived classes can define a static parse method
  31962. if ( trackType.parse !== undefined ) {
  31963. return trackType.parse( json );
  31964. } else {
  31965. // by default, we assume a constructor compatible with the base
  31966. return new trackType( json.name, json.times, json.values, json.interpolation );
  31967. }
  31968. }
  31969. /**
  31970. * @class
  31971. * @classdesc A simple caching system, used internally by {@link FileLoader}.
  31972. * To enable caching across all loaders that use {@link FileLoader}, add `THREE.Cache.enabled = true.` once in your app.
  31973. * @hideconstructor
  31974. */
  31975. const Cache = {
  31976. /**
  31977. * Whether caching is enabled or not.
  31978. *
  31979. * @static
  31980. * @type {boolean}
  31981. * @default false
  31982. */
  31983. enabled: false,
  31984. /**
  31985. * A dictionary that holds cached files.
  31986. *
  31987. * @static
  31988. * @type {Object<string,Object>}
  31989. */
  31990. files: {},
  31991. /**
  31992. * Adds a cache entry with a key to reference the file. If this key already
  31993. * holds a file, it is overwritten.
  31994. *
  31995. * @static
  31996. * @param {string} key - The key to reference the cached file.
  31997. * @param {Object} file - The file to be cached.
  31998. */
  31999. add: function ( key, file ) {
  32000. if ( this.enabled === false ) return;
  32001. // log( 'Cache', 'Adding key:', key );
  32002. this.files[ key ] = file;
  32003. },
  32004. /**
  32005. * Gets the cached value for the given key.
  32006. *
  32007. * @static
  32008. * @param {string} key - The key to reference the cached file.
  32009. * @return {Object|undefined} The cached file. If the key does not exist `undefined` is returned.
  32010. */
  32011. get: function ( key ) {
  32012. if ( this.enabled === false ) return;
  32013. // log( 'Cache', 'Checking key:', key );
  32014. return this.files[ key ];
  32015. },
  32016. /**
  32017. * Removes the cached file associated with the given key.
  32018. *
  32019. * @static
  32020. * @param {string} key - The key to reference the cached file.
  32021. */
  32022. remove: function ( key ) {
  32023. delete this.files[ key ];
  32024. },
  32025. /**
  32026. * Remove all values from the cache.
  32027. *
  32028. * @static
  32029. */
  32030. clear: function () {
  32031. this.files = {};
  32032. }
  32033. };
  32034. /**
  32035. * Handles and keeps track of loaded and pending data. A default global
  32036. * instance of this class is created and used by loaders if not supplied
  32037. * manually.
  32038. *
  32039. * In general that should be sufficient, however there are times when it can
  32040. * be useful to have separate loaders - for example if you want to show
  32041. * separate loading bars for objects and textures.
  32042. *
  32043. * ```js
  32044. * const manager = new THREE.LoadingManager();
  32045. * manager.onLoad = () => console.log( 'Loading complete!' );
  32046. *
  32047. * const loader1 = new OBJLoader( manager );
  32048. * const loader2 = new ColladaLoader( manager );
  32049. * ```
  32050. */
  32051. class LoadingManager {
  32052. /**
  32053. * Constructs a new loading manager.
  32054. *
  32055. * @param {Function} [onLoad] - Executes when all items have been loaded.
  32056. * @param {Function} [onProgress] - Executes when single items have been loaded.
  32057. * @param {Function} [onError] - Executes when an error occurs.
  32058. */
  32059. constructor( onLoad, onProgress, onError ) {
  32060. const scope = this;
  32061. let isLoading = false;
  32062. let itemsLoaded = 0;
  32063. let itemsTotal = 0;
  32064. let urlModifier = undefined;
  32065. const handlers = [];
  32066. // Refer to #5689 for the reason why we don't set .onStart
  32067. // in the constructor
  32068. /**
  32069. * Executes when an item starts loading.
  32070. *
  32071. * @type {Function|undefined}
  32072. * @default undefined
  32073. */
  32074. this.onStart = undefined;
  32075. /**
  32076. * Executes when all items have been loaded.
  32077. *
  32078. * @type {Function|undefined}
  32079. * @default undefined
  32080. */
  32081. this.onLoad = onLoad;
  32082. /**
  32083. * Executes when single items have been loaded.
  32084. *
  32085. * @type {Function|undefined}
  32086. * @default undefined
  32087. */
  32088. this.onProgress = onProgress;
  32089. /**
  32090. * Executes when an error occurs.
  32091. *
  32092. * @type {Function|undefined}
  32093. * @default undefined
  32094. */
  32095. this.onError = onError;
  32096. /**
  32097. * Used for aborting ongoing requests in loaders using this manager.
  32098. *
  32099. * @private
  32100. * @type {AbortController | null}
  32101. */
  32102. this._abortController = null;
  32103. /**
  32104. * This should be called by any loader using the manager when the loader
  32105. * starts loading an item.
  32106. *
  32107. * @param {string} url - The URL to load.
  32108. */
  32109. this.itemStart = function ( url ) {
  32110. itemsTotal ++;
  32111. if ( isLoading === false ) {
  32112. if ( scope.onStart !== undefined ) {
  32113. scope.onStart( url, itemsLoaded, itemsTotal );
  32114. }
  32115. }
  32116. isLoading = true;
  32117. };
  32118. /**
  32119. * This should be called by any loader using the manager when the loader
  32120. * ended loading an item.
  32121. *
  32122. * @param {string} url - The URL of the loaded item.
  32123. */
  32124. this.itemEnd = function ( url ) {
  32125. itemsLoaded ++;
  32126. if ( scope.onProgress !== undefined ) {
  32127. scope.onProgress( url, itemsLoaded, itemsTotal );
  32128. }
  32129. if ( itemsLoaded === itemsTotal ) {
  32130. isLoading = false;
  32131. if ( scope.onLoad !== undefined ) {
  32132. scope.onLoad();
  32133. }
  32134. }
  32135. };
  32136. /**
  32137. * This should be called by any loader using the manager when the loader
  32138. * encounters an error when loading an item.
  32139. *
  32140. * @param {string} url - The URL of the item that produces an error.
  32141. */
  32142. this.itemError = function ( url ) {
  32143. if ( scope.onError !== undefined ) {
  32144. scope.onError( url );
  32145. }
  32146. };
  32147. /**
  32148. * Given a URL, uses the URL modifier callback (if any) and returns a
  32149. * resolved URL. If no URL modifier is set, returns the original URL.
  32150. *
  32151. * @param {string} url - The URL to load.
  32152. * @return {string} The resolved URL.
  32153. */
  32154. this.resolveURL = function ( url ) {
  32155. if ( urlModifier ) {
  32156. return urlModifier( url );
  32157. }
  32158. return url;
  32159. };
  32160. /**
  32161. * If provided, the callback will be passed each resource URL before a
  32162. * request is sent. The callback may return the original URL, or a new URL to
  32163. * override loading behavior. This behavior can be used to load assets from
  32164. * .ZIP files, drag-and-drop APIs, and Data URIs.
  32165. *
  32166. * ```js
  32167. * const blobs = {'fish.gltf': blob1, 'diffuse.png': blob2, 'normal.png': blob3};
  32168. *
  32169. * const manager = new THREE.LoadingManager();
  32170. *
  32171. * // Initialize loading manager with URL callback.
  32172. * const objectURLs = [];
  32173. * manager.setURLModifier( ( url ) => {
  32174. *
  32175. * url = URL.createObjectURL( blobs[ url ] );
  32176. * objectURLs.push( url );
  32177. * return url;
  32178. *
  32179. * } );
  32180. *
  32181. * // Load as usual, then revoke the blob URLs.
  32182. * const loader = new GLTFLoader( manager );
  32183. * loader.load( 'fish.gltf', (gltf) => {
  32184. *
  32185. * scene.add( gltf.scene );
  32186. * objectURLs.forEach( ( url ) => URL.revokeObjectURL( url ) );
  32187. *
  32188. * } );
  32189. * ```
  32190. *
  32191. * @param {function(string):string} transform - URL modifier callback. Called with an URL and must return a resolved URL.
  32192. * @return {LoadingManager} A reference to this loading manager.
  32193. */
  32194. this.setURLModifier = function ( transform ) {
  32195. urlModifier = transform;
  32196. return this;
  32197. };
  32198. /**
  32199. * Registers a loader with the given regular expression. Can be used to
  32200. * define what loader should be used in order to load specific files. A
  32201. * typical use case is to overwrite the default loader for textures.
  32202. *
  32203. * ```js
  32204. * // add handler for TGA textures
  32205. * manager.addHandler( /\.tga$/i, new TGALoader() );
  32206. * ```
  32207. *
  32208. * @param {string} regex - A regular expression.
  32209. * @param {Loader} loader - A loader that should handle matched cases.
  32210. * @return {LoadingManager} A reference to this loading manager.
  32211. */
  32212. this.addHandler = function ( regex, loader ) {
  32213. handlers.push( regex, loader );
  32214. return this;
  32215. };
  32216. /**
  32217. * Removes the loader for the given regular expression.
  32218. *
  32219. * @param {string} regex - A regular expression.
  32220. * @return {LoadingManager} A reference to this loading manager.
  32221. */
  32222. this.removeHandler = function ( regex ) {
  32223. const index = handlers.indexOf( regex );
  32224. if ( index !== -1 ) {
  32225. handlers.splice( index, 2 );
  32226. }
  32227. return this;
  32228. };
  32229. /**
  32230. * Can be used to retrieve the registered loader for the given file path.
  32231. *
  32232. * @param {string} file - The file path.
  32233. * @return {?Loader} The registered loader. Returns `null` if no loader was found.
  32234. */
  32235. this.getHandler = function ( file ) {
  32236. for ( let i = 0, l = handlers.length; i < l; i += 2 ) {
  32237. const regex = handlers[ i ];
  32238. const loader = handlers[ i + 1 ];
  32239. if ( regex.global ) regex.lastIndex = 0; // see #17920
  32240. if ( regex.test( file ) ) {
  32241. return loader;
  32242. }
  32243. }
  32244. return null;
  32245. };
  32246. /**
  32247. * Can be used to abort ongoing loading requests in loaders using this manager.
  32248. * The abort only works if the loaders implement {@link Loader#abort} and `AbortSignal.any()`
  32249. * is supported in the browser.
  32250. *
  32251. * @return {LoadingManager} A reference to this loading manager.
  32252. */
  32253. this.abort = function () {
  32254. this.abortController.abort();
  32255. this._abortController = null;
  32256. return this;
  32257. };
  32258. }
  32259. // TODO: Revert this back to a single member variable once this issue has been fixed
  32260. // https://github.com/cloudflare/workerd/issues/3657
  32261. /**
  32262. * Used for aborting ongoing requests in loaders using this manager.
  32263. *
  32264. * @type {AbortController}
  32265. */
  32266. get abortController() {
  32267. if ( ! this._abortController ) {
  32268. this._abortController = new AbortController();
  32269. }
  32270. return this._abortController;
  32271. }
  32272. }
  32273. /**
  32274. * The global default loading manager.
  32275. *
  32276. * @constant
  32277. * @type {LoadingManager}
  32278. */
  32279. const DefaultLoadingManager = /*@__PURE__*/ new LoadingManager();
  32280. /**
  32281. * Abstract base class for loaders.
  32282. *
  32283. * @abstract
  32284. */
  32285. class Loader {
  32286. /**
  32287. * Constructs a new loader.
  32288. *
  32289. * @param {LoadingManager} [manager] - The loading manager.
  32290. */
  32291. constructor( manager ) {
  32292. /**
  32293. * The loading manager.
  32294. *
  32295. * @type {LoadingManager}
  32296. * @default DefaultLoadingManager
  32297. */
  32298. this.manager = ( manager !== undefined ) ? manager : DefaultLoadingManager;
  32299. /**
  32300. * The crossOrigin string to implement CORS for loading the url from a
  32301. * different domain that allows CORS.
  32302. *
  32303. * @type {string}
  32304. * @default 'anonymous'
  32305. */
  32306. this.crossOrigin = 'anonymous';
  32307. /**
  32308. * Whether the XMLHttpRequest uses credentials.
  32309. *
  32310. * @type {boolean}
  32311. * @default false
  32312. */
  32313. this.withCredentials = false;
  32314. /**
  32315. * The base path from which the asset will be loaded.
  32316. *
  32317. * @type {string}
  32318. */
  32319. this.path = '';
  32320. /**
  32321. * The base path from which additional resources like textures will be loaded.
  32322. *
  32323. * @type {string}
  32324. */
  32325. this.resourcePath = '';
  32326. /**
  32327. * The [request header](https://developer.mozilla.org/en-US/docs/Glossary/Request_header)
  32328. * used in HTTP request.
  32329. *
  32330. * @type {Object<string, any>}
  32331. */
  32332. this.requestHeader = {};
  32333. if ( typeof __THREE_DEVTOOLS__ !== 'undefined' ) {
  32334. __THREE_DEVTOOLS__.dispatchEvent( new CustomEvent( 'observe', { detail: this } ) );
  32335. }
  32336. }
  32337. /**
  32338. * This method needs to be implemented by all concrete loaders. It holds the
  32339. * logic for loading assets from the backend.
  32340. *
  32341. * @abstract
  32342. * @param {string} url - The path/URL of the file to be loaded.
  32343. * @param {Function} onLoad - Executed when the loading process has been finished.
  32344. * @param {onProgressCallback} [onProgress] - Executed while the loading is in progress.
  32345. * @param {onErrorCallback} [onError] - Executed when errors occur.
  32346. */
  32347. load( /* url, onLoad, onProgress, onError */ ) {}
  32348. /**
  32349. * A async version of {@link Loader#load}.
  32350. *
  32351. * @param {string} url - The path/URL of the file to be loaded.
  32352. * @param {onProgressCallback} [onProgress] - Executed while the loading is in progress.
  32353. * @return {Promise} A Promise that resolves when the asset has been loaded.
  32354. */
  32355. loadAsync( url, onProgress ) {
  32356. const scope = this;
  32357. return new Promise( function ( resolve, reject ) {
  32358. scope.load( url, resolve, onProgress, reject );
  32359. } );
  32360. }
  32361. /**
  32362. * This method needs to be implemented by all concrete loaders. It holds the
  32363. * logic for parsing the asset into three.js entities.
  32364. *
  32365. * @abstract
  32366. * @param {any} data - The data to parse.
  32367. */
  32368. parse( /* data */ ) {}
  32369. /**
  32370. * Sets the `crossOrigin` String to implement CORS for loading the URL
  32371. * from a different domain that allows CORS.
  32372. *
  32373. * @param {string} crossOrigin - The `crossOrigin` value.
  32374. * @return {Loader} A reference to this instance.
  32375. */
  32376. setCrossOrigin( crossOrigin ) {
  32377. this.crossOrigin = crossOrigin;
  32378. return this;
  32379. }
  32380. /**
  32381. * Whether the XMLHttpRequest uses credentials such as cookies, authorization
  32382. * headers or TLS client certificates, see [XMLHttpRequest.withCredentials](https://developer.mozilla.org/en-US/docs/Web/API/XMLHttpRequest/withCredentials).
  32383. *
  32384. * Note: This setting has no effect if you are loading files locally or from the same domain.
  32385. *
  32386. * @param {boolean} value - The `withCredentials` value.
  32387. * @return {Loader} A reference to this instance.
  32388. */
  32389. setWithCredentials( value ) {
  32390. this.withCredentials = value;
  32391. return this;
  32392. }
  32393. /**
  32394. * Sets the base path for the asset.
  32395. *
  32396. * @param {string} path - The base path.
  32397. * @return {Loader} A reference to this instance.
  32398. */
  32399. setPath( path ) {
  32400. this.path = path;
  32401. return this;
  32402. }
  32403. /**
  32404. * Sets the base path for dependent resources like textures.
  32405. *
  32406. * @param {string} resourcePath - The resource path.
  32407. * @return {Loader} A reference to this instance.
  32408. */
  32409. setResourcePath( resourcePath ) {
  32410. this.resourcePath = resourcePath;
  32411. return this;
  32412. }
  32413. /**
  32414. * Sets the given request header.
  32415. *
  32416. * @param {Object} requestHeader - A [request header](https://developer.mozilla.org/en-US/docs/Glossary/Request_header)
  32417. * for configuring the HTTP request.
  32418. * @return {Loader} A reference to this instance.
  32419. */
  32420. setRequestHeader( requestHeader ) {
  32421. this.requestHeader = requestHeader;
  32422. return this;
  32423. }
  32424. /**
  32425. * This method can be implemented in loaders for aborting ongoing requests.
  32426. *
  32427. * @abstract
  32428. * @return {Loader} A reference to this instance.
  32429. */
  32430. abort() {
  32431. return this;
  32432. }
  32433. }
  32434. /**
  32435. * Callback for onProgress in loaders.
  32436. *
  32437. * @callback onProgressCallback
  32438. * @param {ProgressEvent} event - An instance of `ProgressEvent` that represents the current loading status.
  32439. */
  32440. /**
  32441. * Callback for onError in loaders.
  32442. *
  32443. * @callback onErrorCallback
  32444. * @param {Error} error - The error which occurred during the loading process.
  32445. */
  32446. /**
  32447. * The default material name that is used by loaders
  32448. * when creating materials for loaded 3D objects.
  32449. *
  32450. * Note: Not all loaders might honor this setting.
  32451. *
  32452. * @static
  32453. * @type {string}
  32454. * @default '__DEFAULT'
  32455. */
  32456. Loader.DEFAULT_MATERIAL_NAME = '__DEFAULT';
  32457. const loading = {};
  32458. class HttpError extends Error {
  32459. constructor( message, response ) {
  32460. super( message );
  32461. this.response = response;
  32462. }
  32463. }
  32464. /**
  32465. * A low level class for loading resources with the Fetch API, used internally by
  32466. * most loaders. It can also be used directly to load any file type that does
  32467. * not have a loader.
  32468. *
  32469. * This loader supports caching. If you want to use it, add `THREE.Cache.enabled = true;`
  32470. * once to your application.
  32471. *
  32472. * ```js
  32473. * const loader = new THREE.FileLoader();
  32474. * const data = await loader.loadAsync( 'example.txt' );
  32475. * ```
  32476. *
  32477. * @augments Loader
  32478. */
  32479. class FileLoader extends Loader {
  32480. /**
  32481. * Constructs a new file loader.
  32482. *
  32483. * @param {LoadingManager} [manager] - The loading manager.
  32484. */
  32485. constructor( manager ) {
  32486. super( manager );
  32487. /**
  32488. * The expected mime type. Valid values can be found
  32489. * [here](hhttps://developer.mozilla.org/en-US/docs/Web/API/DOMParser/parseFromString#mimetype)
  32490. *
  32491. * @type {string}
  32492. */
  32493. this.mimeType = '';
  32494. /**
  32495. * The expected response type.
  32496. *
  32497. * @type {('arraybuffer'|'blob'|'document'|'json'|'')}
  32498. * @default ''
  32499. */
  32500. this.responseType = '';
  32501. /**
  32502. * Used for aborting requests.
  32503. *
  32504. * @private
  32505. * @type {AbortController}
  32506. */
  32507. this._abortController = new AbortController();
  32508. }
  32509. /**
  32510. * Starts loading from the given URL and pass the loaded response to the `onLoad()` callback.
  32511. *
  32512. * @param {string} url - The path/URL of the file to be loaded. This can also be a data URI.
  32513. * @param {function(any)} onLoad - Executed when the loading process has been finished.
  32514. * @param {onProgressCallback} [onProgress] - Executed while the loading is in progress.
  32515. * @param {onErrorCallback} [onError] - Executed when errors occur.
  32516. * @return {any|undefined} The cached resource if available.
  32517. */
  32518. load( url, onLoad, onProgress, onError ) {
  32519. if ( url === undefined ) url = '';
  32520. if ( this.path !== undefined ) url = this.path + url;
  32521. url = this.manager.resolveURL( url );
  32522. const cached = Cache.get( `file:${url}` );
  32523. if ( cached !== undefined ) {
  32524. this.manager.itemStart( url );
  32525. setTimeout( () => {
  32526. if ( onLoad ) onLoad( cached );
  32527. this.manager.itemEnd( url );
  32528. }, 0 );
  32529. return cached;
  32530. }
  32531. // Check if request is duplicate
  32532. if ( loading[ url ] !== undefined ) {
  32533. loading[ url ].push( {
  32534. onLoad: onLoad,
  32535. onProgress: onProgress,
  32536. onError: onError
  32537. } );
  32538. return;
  32539. }
  32540. // Initialise array for duplicate requests
  32541. loading[ url ] = [];
  32542. loading[ url ].push( {
  32543. onLoad: onLoad,
  32544. onProgress: onProgress,
  32545. onError: onError,
  32546. } );
  32547. // create request
  32548. const req = new Request( url, {
  32549. headers: new Headers( this.requestHeader ),
  32550. credentials: this.withCredentials ? 'include' : 'same-origin',
  32551. signal: ( typeof AbortSignal.any === 'function' ) ? AbortSignal.any( [ this._abortController.signal, this.manager.abortController.signal ] ) : this._abortController.signal
  32552. } );
  32553. // record states ( avoid data race )
  32554. const mimeType = this.mimeType;
  32555. const responseType = this.responseType;
  32556. // start the fetch
  32557. fetch( req )
  32558. .then( response => {
  32559. if ( response.status === 200 || response.status === 0 ) {
  32560. // Some browsers return HTTP Status 0 when using non-http protocol
  32561. // e.g. 'file://' or 'data://'. Handle as success.
  32562. if ( response.status === 0 ) {
  32563. warn( 'FileLoader: HTTP Status 0 received.' );
  32564. }
  32565. // Workaround: Checking if response.body === undefined for Alipay browser #23548
  32566. if ( typeof ReadableStream === 'undefined' || response.body === undefined || response.body.getReader === undefined ) {
  32567. return response;
  32568. }
  32569. const callbacks = loading[ url ];
  32570. const reader = response.body.getReader();
  32571. // Nginx needs X-File-Size check
  32572. // https://serverfault.com/questions/482875/why-does-nginx-remove-content-length-header-for-chunked-content
  32573. const contentLength = response.headers.get( 'X-File-Size' ) || response.headers.get( 'Content-Length' );
  32574. const total = contentLength ? parseInt( contentLength ) : 0;
  32575. const lengthComputable = total !== 0;
  32576. let loaded = 0;
  32577. // periodically read data into the new stream tracking while download progress
  32578. const stream = new ReadableStream( {
  32579. start( controller ) {
  32580. readData();
  32581. function readData() {
  32582. reader.read().then( ( { done, value } ) => {
  32583. if ( done ) {
  32584. controller.close();
  32585. } else {
  32586. loaded += value.byteLength;
  32587. const event = new ProgressEvent( 'progress', { lengthComputable, loaded, total } );
  32588. for ( let i = 0, il = callbacks.length; i < il; i ++ ) {
  32589. const callback = callbacks[ i ];
  32590. if ( callback.onProgress ) callback.onProgress( event );
  32591. }
  32592. controller.enqueue( value );
  32593. readData();
  32594. }
  32595. }, ( e ) => {
  32596. controller.error( e );
  32597. } );
  32598. }
  32599. }
  32600. } );
  32601. return new Response( stream );
  32602. } else {
  32603. throw new HttpError( `fetch for "${response.url}" responded with ${response.status}: ${response.statusText}`, response );
  32604. }
  32605. } )
  32606. .then( response => {
  32607. switch ( responseType ) {
  32608. case 'arraybuffer':
  32609. return response.arrayBuffer();
  32610. case 'blob':
  32611. return response.blob();
  32612. case 'document':
  32613. return response.text()
  32614. .then( text => {
  32615. const parser = new DOMParser();
  32616. return parser.parseFromString( text, mimeType );
  32617. } );
  32618. case 'json':
  32619. return response.json();
  32620. default:
  32621. if ( mimeType === '' ) {
  32622. return response.text();
  32623. } else {
  32624. // sniff encoding
  32625. const re = /charset="?([^;"\s]*)"?/i;
  32626. const exec = re.exec( mimeType );
  32627. const label = exec && exec[ 1 ] ? exec[ 1 ].toLowerCase() : undefined;
  32628. const decoder = new TextDecoder( label );
  32629. return response.arrayBuffer().then( ab => decoder.decode( ab ) );
  32630. }
  32631. }
  32632. } )
  32633. .then( data => {
  32634. // Add to cache only on HTTP success, so that we do not cache
  32635. // error response bodies as proper responses to requests.
  32636. Cache.add( `file:${url}`, data );
  32637. const callbacks = loading[ url ];
  32638. delete loading[ url ];
  32639. for ( let i = 0, il = callbacks.length; i < il; i ++ ) {
  32640. const callback = callbacks[ i ];
  32641. if ( callback.onLoad ) callback.onLoad( data );
  32642. }
  32643. } )
  32644. .catch( err => {
  32645. // Abort errors and other errors are handled the same
  32646. const callbacks = loading[ url ];
  32647. if ( callbacks === undefined ) {
  32648. // When onLoad was called and url was deleted in `loading`
  32649. this.manager.itemError( url );
  32650. throw err;
  32651. }
  32652. delete loading[ url ];
  32653. for ( let i = 0, il = callbacks.length; i < il; i ++ ) {
  32654. const callback = callbacks[ i ];
  32655. if ( callback.onError ) callback.onError( err );
  32656. }
  32657. this.manager.itemError( url );
  32658. } )
  32659. .finally( () => {
  32660. this.manager.itemEnd( url );
  32661. } );
  32662. this.manager.itemStart( url );
  32663. }
  32664. /**
  32665. * Sets the expected response type.
  32666. *
  32667. * @param {('arraybuffer'|'blob'|'document'|'json'|'')} value - The response type.
  32668. * @return {FileLoader} A reference to this file loader.
  32669. */
  32670. setResponseType( value ) {
  32671. this.responseType = value;
  32672. return this;
  32673. }
  32674. /**
  32675. * Sets the expected mime type of the loaded file.
  32676. *
  32677. * @param {string} value - The mime type.
  32678. * @return {FileLoader} A reference to this file loader.
  32679. */
  32680. setMimeType( value ) {
  32681. this.mimeType = value;
  32682. return this;
  32683. }
  32684. /**
  32685. * Aborts ongoing fetch requests.
  32686. *
  32687. * @return {FileLoader} A reference to this instance.
  32688. */
  32689. abort() {
  32690. this._abortController.abort();
  32691. this._abortController = new AbortController();
  32692. return this;
  32693. }
  32694. }
  32695. /**
  32696. * Class for loading animation clips in the JSON format. The files are internally
  32697. * loaded via {@link FileLoader}.
  32698. *
  32699. * ```js
  32700. * const loader = new THREE.AnimationLoader();
  32701. * const animations = await loader.loadAsync( 'animations/animation.js' );
  32702. * ```
  32703. *
  32704. * @augments Loader
  32705. */
  32706. class AnimationLoader extends Loader {
  32707. /**
  32708. * Constructs a new animation loader.
  32709. *
  32710. * @param {LoadingManager} [manager] - The loading manager.
  32711. */
  32712. constructor( manager ) {
  32713. super( manager );
  32714. }
  32715. /**
  32716. * Starts loading from the given URL and pass the loaded animations as an array
  32717. * holding instances of {@link AnimationClip} to the `onLoad()` callback.
  32718. *
  32719. * @param {string} url - The path/URL of the file to be loaded. This can also be a data URI.
  32720. * @param {function(Array<AnimationClip>)} onLoad - Executed when the loading process has been finished.
  32721. * @param {onProgressCallback} onProgress - Executed while the loading is in progress.
  32722. * @param {onErrorCallback} onError - Executed when errors occur.
  32723. */
  32724. load( url, onLoad, onProgress, onError ) {
  32725. const scope = this;
  32726. const loader = new FileLoader( this.manager );
  32727. loader.setPath( this.path );
  32728. loader.setRequestHeader( this.requestHeader );
  32729. loader.setWithCredentials( this.withCredentials );
  32730. loader.load( url, function ( text ) {
  32731. try {
  32732. onLoad( scope.parse( JSON.parse( text ) ) );
  32733. } catch ( e ) {
  32734. if ( onError ) {
  32735. onError( e );
  32736. } else {
  32737. error( e );
  32738. }
  32739. scope.manager.itemError( url );
  32740. }
  32741. }, onProgress, onError );
  32742. }
  32743. /**
  32744. * Parses the given JSON object and returns an array of animation clips.
  32745. *
  32746. * @param {Object} json - The serialized animation clips.
  32747. * @return {Array<AnimationClip>} The parsed animation clips.
  32748. */
  32749. parse( json ) {
  32750. const animations = [];
  32751. for ( let i = 0; i < json.length; i ++ ) {
  32752. const clip = AnimationClip.parse( json[ i ] );
  32753. animations.push( clip );
  32754. }
  32755. return animations;
  32756. }
  32757. }
  32758. /**
  32759. * Abstract base class for loading compressed texture formats S3TC, ASTC or ETC.
  32760. * Textures are internally loaded via {@link FileLoader}.
  32761. *
  32762. * Derived classes have to implement the `parse()` method which holds the parsing
  32763. * for the respective format.
  32764. *
  32765. * @abstract
  32766. * @augments Loader
  32767. */
  32768. class CompressedTextureLoader extends Loader {
  32769. /**
  32770. * Constructs a new compressed texture loader.
  32771. *
  32772. * @param {LoadingManager} [manager] - The loading manager.
  32773. */
  32774. constructor( manager ) {
  32775. super( manager );
  32776. }
  32777. /**
  32778. * Starts loading from the given URL and passes the loaded compressed texture
  32779. * to the `onLoad()` callback. The method also returns a new texture object which can
  32780. * directly be used for material creation. If you do it this way, the texture
  32781. * may pop up in your scene once the respective loading process is finished.
  32782. *
  32783. * @param {string} url - The path/URL of the file to be loaded. This can also be a data URI.
  32784. * @param {function(CompressedTexture)} onLoad - Executed when the loading process has been finished.
  32785. * @param {onProgressCallback} onProgress - Executed while the loading is in progress.
  32786. * @param {onErrorCallback} onError - Executed when errors occur.
  32787. * @return {CompressedTexture} The compressed texture.
  32788. */
  32789. load( url, onLoad, onProgress, onError ) {
  32790. const scope = this;
  32791. const images = [];
  32792. const texture = new CompressedTexture();
  32793. const loader = new FileLoader( this.manager );
  32794. loader.setPath( this.path );
  32795. loader.setResponseType( 'arraybuffer' );
  32796. loader.setRequestHeader( this.requestHeader );
  32797. loader.setWithCredentials( scope.withCredentials );
  32798. let loaded = 0;
  32799. function loadTexture( i ) {
  32800. loader.load( url[ i ], function ( buffer ) {
  32801. const texDatas = scope.parse( buffer, true );
  32802. images[ i ] = {
  32803. width: texDatas.width,
  32804. height: texDatas.height,
  32805. format: texDatas.format,
  32806. mipmaps: texDatas.mipmaps
  32807. };
  32808. loaded += 1;
  32809. if ( loaded === 6 ) {
  32810. if ( texDatas.mipmapCount === 1 ) texture.minFilter = LinearFilter;
  32811. texture.image = images;
  32812. texture.format = texDatas.format;
  32813. texture.needsUpdate = true;
  32814. if ( onLoad ) onLoad( texture );
  32815. }
  32816. }, onProgress, onError );
  32817. }
  32818. if ( Array.isArray( url ) ) {
  32819. for ( let i = 0, il = url.length; i < il; ++ i ) {
  32820. loadTexture( i );
  32821. }
  32822. } else {
  32823. // compressed cubemap texture stored in a single DDS file
  32824. loader.load( url, function ( buffer ) {
  32825. const texDatas = scope.parse( buffer, true );
  32826. if ( texDatas.isCubemap ) {
  32827. const faces = texDatas.mipmaps.length / texDatas.mipmapCount;
  32828. for ( let f = 0; f < faces; f ++ ) {
  32829. images[ f ] = { mipmaps: [] };
  32830. for ( let i = 0; i < texDatas.mipmapCount; i ++ ) {
  32831. images[ f ].mipmaps.push( texDatas.mipmaps[ f * texDatas.mipmapCount + i ] );
  32832. images[ f ].format = texDatas.format;
  32833. images[ f ].width = texDatas.width;
  32834. images[ f ].height = texDatas.height;
  32835. }
  32836. }
  32837. texture.image = images;
  32838. } else {
  32839. texture.image.width = texDatas.width;
  32840. texture.image.height = texDatas.height;
  32841. texture.mipmaps = texDatas.mipmaps;
  32842. }
  32843. if ( texDatas.mipmapCount === 1 ) {
  32844. texture.minFilter = LinearFilter;
  32845. }
  32846. texture.format = texDatas.format;
  32847. texture.needsUpdate = true;
  32848. if ( onLoad ) onLoad( texture );
  32849. }, onProgress, onError );
  32850. }
  32851. return texture;
  32852. }
  32853. }
  32854. const _loading = new WeakMap();
  32855. /**
  32856. * A loader for loading images. The class loads images with the HTML `Image` API.
  32857. *
  32858. * ```js
  32859. * const loader = new THREE.ImageLoader();
  32860. * const image = await loader.loadAsync( 'image.png' );
  32861. * ```
  32862. * Please note that `ImageLoader` has dropped support for progress
  32863. * events in `r84`. For an `ImageLoader` that supports progress events, see
  32864. * [this thread](https://github.com/mrdoob/three.js/issues/10439#issuecomment-275785639).
  32865. *
  32866. * @augments Loader
  32867. */
  32868. class ImageLoader extends Loader {
  32869. /**
  32870. * Constructs a new image loader.
  32871. *
  32872. * @param {LoadingManager} [manager] - The loading manager.
  32873. */
  32874. constructor( manager ) {
  32875. super( manager );
  32876. }
  32877. /**
  32878. * Starts loading from the given URL and passes the loaded image
  32879. * to the `onLoad()` callback. The method also returns a new `Image` object which can
  32880. * directly be used for texture creation. If you do it this way, the texture
  32881. * may pop up in your scene once the respective loading process is finished.
  32882. *
  32883. * @param {string} url - The path/URL of the file to be loaded. This can also be a data URI.
  32884. * @param {function(Image)} onLoad - Executed when the loading process has been finished.
  32885. * @param {onProgressCallback} onProgress - Unsupported in this loader.
  32886. * @param {onErrorCallback} onError - Executed when errors occur.
  32887. * @return {Image} The image.
  32888. */
  32889. load( url, onLoad, onProgress, onError ) {
  32890. if ( this.path !== undefined ) url = this.path + url;
  32891. url = this.manager.resolveURL( url );
  32892. const scope = this;
  32893. const cached = Cache.get( `image:${url}` );
  32894. if ( cached !== undefined ) {
  32895. if ( cached.complete === true ) {
  32896. scope.manager.itemStart( url );
  32897. setTimeout( function () {
  32898. if ( onLoad ) onLoad( cached );
  32899. scope.manager.itemEnd( url );
  32900. }, 0 );
  32901. } else {
  32902. let arr = _loading.get( cached );
  32903. if ( arr === undefined ) {
  32904. arr = [];
  32905. _loading.set( cached, arr );
  32906. }
  32907. arr.push( { onLoad, onError } );
  32908. }
  32909. return cached;
  32910. }
  32911. const image = createElementNS( 'img' );
  32912. function onImageLoad() {
  32913. removeEventListeners();
  32914. if ( onLoad ) onLoad( this );
  32915. //
  32916. const callbacks = _loading.get( this ) || [];
  32917. for ( let i = 0; i < callbacks.length; i ++ ) {
  32918. const callback = callbacks[ i ];
  32919. if ( callback.onLoad ) callback.onLoad( this );
  32920. }
  32921. _loading.delete( this );
  32922. scope.manager.itemEnd( url );
  32923. }
  32924. function onImageError( event ) {
  32925. removeEventListeners();
  32926. if ( onError ) onError( event );
  32927. Cache.remove( `image:${url}` );
  32928. //
  32929. const callbacks = _loading.get( this ) || [];
  32930. for ( let i = 0; i < callbacks.length; i ++ ) {
  32931. const callback = callbacks[ i ];
  32932. if ( callback.onError ) callback.onError( event );
  32933. }
  32934. _loading.delete( this );
  32935. scope.manager.itemError( url );
  32936. scope.manager.itemEnd( url );
  32937. }
  32938. function removeEventListeners() {
  32939. image.removeEventListener( 'load', onImageLoad, false );
  32940. image.removeEventListener( 'error', onImageError, false );
  32941. }
  32942. image.addEventListener( 'load', onImageLoad, false );
  32943. image.addEventListener( 'error', onImageError, false );
  32944. if ( url.slice( 0, 5 ) !== 'data:' ) {
  32945. if ( this.crossOrigin !== undefined ) image.crossOrigin = this.crossOrigin;
  32946. }
  32947. Cache.add( `image:${url}`, image );
  32948. scope.manager.itemStart( url );
  32949. image.src = url;
  32950. return image;
  32951. }
  32952. }
  32953. /**
  32954. * Class for loading cube textures. Images are internally loaded via {@link ImageLoader}.
  32955. *
  32956. * The loader returns an instance of {@link CubeTexture} and expects the cube map to
  32957. * be defined as six separate images representing the sides of a cube. Other cube map definitions
  32958. * like vertical and horizontal cross, column and row layouts are not supported.
  32959. *
  32960. * Note that, by convention, cube maps are specified in a coordinate system
  32961. * in which positive-x is to the right when looking up the positive-z axis --
  32962. * in other words, using a left-handed coordinate system. Since three.js uses
  32963. * a right-handed coordinate system, environment maps used in three.js will
  32964. * have pos-x and neg-x swapped.
  32965. *
  32966. * The loaded cube texture is in sRGB color space. Meaning {@link Texture#colorSpace}
  32967. * is set to `SRGBColorSpace` by default.
  32968. *
  32969. * ```js
  32970. * const loader = new THREE.CubeTextureLoader().setPath( 'textures/cubeMaps/' );
  32971. * const cubeTexture = await loader.loadAsync( [
  32972. * 'px.png', 'nx.png', 'py.png', 'ny.png', 'pz.png', 'nz.png'
  32973. * ] );
  32974. * scene.background = cubeTexture;
  32975. * ```
  32976. *
  32977. * @augments Loader
  32978. */
  32979. class CubeTextureLoader extends Loader {
  32980. /**
  32981. * Constructs a new cube texture loader.
  32982. *
  32983. * @param {LoadingManager} [manager] - The loading manager.
  32984. */
  32985. constructor( manager ) {
  32986. super( manager );
  32987. }
  32988. /**
  32989. * Starts loading from the given URL and pass the fully loaded cube texture
  32990. * to the `onLoad()` callback. The method also returns a new cube texture object which can
  32991. * directly be used for material creation. If you do it this way, the cube texture
  32992. * may pop up in your scene once the respective loading process is finished.
  32993. *
  32994. * @param {Array<string>} urls - Array of 6 URLs to images, one for each side of the
  32995. * cube texture. The urls should be specified in the following order: pos-x,
  32996. * neg-x, pos-y, neg-y, pos-z, neg-z. An array of data URIs are allowed as well.
  32997. * @param {function(CubeTexture)} onLoad - Executed when the loading process has been finished.
  32998. * @param {onProgressCallback} onProgress - Unsupported in this loader.
  32999. * @param {onErrorCallback} onError - Executed when errors occur.
  33000. * @return {CubeTexture} The cube texture.
  33001. */
  33002. load( urls, onLoad, onProgress, onError ) {
  33003. const texture = new CubeTexture();
  33004. texture.colorSpace = SRGBColorSpace;
  33005. const loader = new ImageLoader( this.manager );
  33006. loader.setCrossOrigin( this.crossOrigin );
  33007. loader.setPath( this.path );
  33008. let loaded = 0;
  33009. function loadTexture( i ) {
  33010. loader.load( urls[ i ], function ( image ) {
  33011. texture.images[ i ] = image;
  33012. loaded ++;
  33013. if ( loaded === 6 ) {
  33014. texture.needsUpdate = true;
  33015. if ( onLoad ) onLoad( texture );
  33016. }
  33017. }, undefined, onError );
  33018. }
  33019. for ( let i = 0; i < urls.length; ++ i ) {
  33020. loadTexture( i );
  33021. }
  33022. return texture;
  33023. }
  33024. }
  33025. /**
  33026. * Abstract base class for loading binary texture formats RGBE, EXR or TGA.
  33027. * Textures are internally loaded via {@link FileLoader}.
  33028. *
  33029. * Derived classes have to implement the `parse()` method which holds the parsing
  33030. * for the respective format.
  33031. *
  33032. * @abstract
  33033. * @augments Loader
  33034. */
  33035. class DataTextureLoader extends Loader {
  33036. /**
  33037. * Constructs a new data texture loader.
  33038. *
  33039. * @param {LoadingManager} [manager] - The loading manager.
  33040. */
  33041. constructor( manager ) {
  33042. super( manager );
  33043. }
  33044. /**
  33045. * Starts loading from the given URL and passes the loaded data texture
  33046. * to the `onLoad()` callback. The method also returns a new texture object which can
  33047. * directly be used for material creation. If you do it this way, the texture
  33048. * may pop up in your scene once the respective loading process is finished.
  33049. *
  33050. * @param {string} url - The path/URL of the file to be loaded. This can also be a data URI.
  33051. * @param {function(DataTexture)} onLoad - Executed when the loading process has been finished.
  33052. * @param {onProgressCallback} onProgress - Executed while the loading is in progress.
  33053. * @param {onErrorCallback} onError - Executed when errors occur.
  33054. * @return {DataTexture} The data texture.
  33055. */
  33056. load( url, onLoad, onProgress, onError ) {
  33057. const scope = this;
  33058. const texture = new DataTexture();
  33059. const loader = new FileLoader( this.manager );
  33060. loader.setResponseType( 'arraybuffer' );
  33061. loader.setRequestHeader( this.requestHeader );
  33062. loader.setPath( this.path );
  33063. loader.setWithCredentials( scope.withCredentials );
  33064. loader.load( url, function ( buffer ) {
  33065. let texData;
  33066. try {
  33067. texData = scope.parse( buffer );
  33068. } catch ( error ) {
  33069. if ( onError !== undefined ) {
  33070. onError( error );
  33071. } else {
  33072. error( error );
  33073. return;
  33074. }
  33075. }
  33076. if ( texData.image !== undefined ) {
  33077. texture.image = texData.image;
  33078. } else if ( texData.data !== undefined ) {
  33079. texture.image.width = texData.width;
  33080. texture.image.height = texData.height;
  33081. texture.image.data = texData.data;
  33082. }
  33083. texture.wrapS = texData.wrapS !== undefined ? texData.wrapS : ClampToEdgeWrapping;
  33084. texture.wrapT = texData.wrapT !== undefined ? texData.wrapT : ClampToEdgeWrapping;
  33085. texture.magFilter = texData.magFilter !== undefined ? texData.magFilter : LinearFilter;
  33086. texture.minFilter = texData.minFilter !== undefined ? texData.minFilter : LinearFilter;
  33087. texture.anisotropy = texData.anisotropy !== undefined ? texData.anisotropy : 1;
  33088. if ( texData.colorSpace !== undefined ) {
  33089. texture.colorSpace = texData.colorSpace;
  33090. }
  33091. if ( texData.flipY !== undefined ) {
  33092. texture.flipY = texData.flipY;
  33093. }
  33094. if ( texData.format !== undefined ) {
  33095. texture.format = texData.format;
  33096. }
  33097. if ( texData.type !== undefined ) {
  33098. texture.type = texData.type;
  33099. }
  33100. if ( texData.mipmaps !== undefined ) {
  33101. texture.mipmaps = texData.mipmaps;
  33102. texture.minFilter = LinearMipmapLinearFilter; // presumably...
  33103. }
  33104. if ( texData.mipmapCount === 1 ) {
  33105. texture.minFilter = LinearFilter;
  33106. }
  33107. if ( texData.generateMipmaps !== undefined ) {
  33108. texture.generateMipmaps = texData.generateMipmaps;
  33109. }
  33110. texture.needsUpdate = true;
  33111. if ( onLoad ) onLoad( texture, texData );
  33112. }, onProgress, onError );
  33113. return texture;
  33114. }
  33115. }
  33116. /**
  33117. * Class for loading textures. Images are internally
  33118. * loaded via {@link ImageLoader}.
  33119. *
  33120. * ```js
  33121. * const loader = new THREE.TextureLoader();
  33122. * const texture = await loader.loadAsync( 'textures/land_ocean_ice_cloud_2048.jpg' );
  33123. *
  33124. * const material = new THREE.MeshBasicMaterial( { map:texture } );
  33125. * ```
  33126. * Please note that `TextureLoader` has dropped support for progress
  33127. * events in `r84`. For a `TextureLoader` that supports progress events, see
  33128. * [this thread](https://github.com/mrdoob/three.js/issues/10439#issuecomment-293260145).
  33129. *
  33130. * @augments Loader
  33131. */
  33132. class TextureLoader extends Loader {
  33133. /**
  33134. * Constructs a new texture loader.
  33135. *
  33136. * @param {LoadingManager} [manager] - The loading manager.
  33137. */
  33138. constructor( manager ) {
  33139. super( manager );
  33140. }
  33141. /**
  33142. * Starts loading from the given URL and pass the fully loaded texture
  33143. * to the `onLoad()` callback. The method also returns a new texture object which can
  33144. * directly be used for material creation. If you do it this way, the texture
  33145. * may pop up in your scene once the respective loading process is finished.
  33146. *
  33147. * @param {string} url - The path/URL of the file to be loaded. This can also be a data URI.
  33148. * @param {function(Texture)} onLoad - Executed when the loading process has been finished.
  33149. * @param {onProgressCallback} onProgress - Unsupported in this loader.
  33150. * @param {onErrorCallback} onError - Executed when errors occur.
  33151. * @return {Texture} The texture.
  33152. */
  33153. load( url, onLoad, onProgress, onError ) {
  33154. const texture = new Texture();
  33155. const loader = new ImageLoader( this.manager );
  33156. loader.setCrossOrigin( this.crossOrigin );
  33157. loader.setPath( this.path );
  33158. loader.load( url, function ( image ) {
  33159. texture.image = image;
  33160. texture.needsUpdate = true;
  33161. if ( onLoad !== undefined ) {
  33162. onLoad( texture );
  33163. }
  33164. }, onProgress, onError );
  33165. return texture;
  33166. }
  33167. }
  33168. /**
  33169. * Abstract base class for lights - all other light types inherit the
  33170. * properties and methods described here.
  33171. *
  33172. * @abstract
  33173. * @augments Object3D
  33174. */
  33175. class Light extends Object3D {
  33176. /**
  33177. * Constructs a new light.
  33178. *
  33179. * @param {(number|Color|string)} [color=0xffffff] - The light's color.
  33180. * @param {number} [intensity=1] - The light's strength/intensity.
  33181. */
  33182. constructor( color, intensity = 1 ) {
  33183. super();
  33184. /**
  33185. * This flag can be used for type testing.
  33186. *
  33187. * @type {boolean}
  33188. * @readonly
  33189. * @default true
  33190. */
  33191. this.isLight = true;
  33192. this.type = 'Light';
  33193. /**
  33194. * The light's color.
  33195. *
  33196. * @type {Color}
  33197. */
  33198. this.color = new Color( color );
  33199. /**
  33200. * The light's intensity.
  33201. *
  33202. * @type {number}
  33203. * @default 1
  33204. */
  33205. this.intensity = intensity;
  33206. }
  33207. /**
  33208. * Frees the GPU-related resources allocated by this instance. Call this
  33209. * method whenever this instance is no longer used in your app.
  33210. */
  33211. dispose() {
  33212. this.dispatchEvent( { type: 'dispose' } );
  33213. }
  33214. copy( source, recursive ) {
  33215. super.copy( source, recursive );
  33216. this.color.copy( source.color );
  33217. this.intensity = source.intensity;
  33218. return this;
  33219. }
  33220. toJSON( meta ) {
  33221. const data = super.toJSON( meta );
  33222. data.object.color = this.color.getHex();
  33223. data.object.intensity = this.intensity;
  33224. return data;
  33225. }
  33226. }
  33227. /**
  33228. * A light source positioned directly above the scene, with color fading from
  33229. * the sky color to the ground color.
  33230. *
  33231. * This light cannot be used to cast shadows.
  33232. *
  33233. * ```js
  33234. * const light = new THREE.HemisphereLight( 0xffffbb, 0x080820, 1 );
  33235. * scene.add( light );
  33236. * ```
  33237. *
  33238. * @augments Light
  33239. */
  33240. class HemisphereLight extends Light {
  33241. /**
  33242. * Constructs a new hemisphere light.
  33243. *
  33244. * @param {(number|Color|string)} [skyColor=0xffffff] - The light's sky color.
  33245. * @param {(number|Color|string)} [groundColor=0xffffff] - The light's ground color.
  33246. * @param {number} [intensity=1] - The light's strength/intensity.
  33247. */
  33248. constructor( skyColor, groundColor, intensity ) {
  33249. super( skyColor, intensity );
  33250. /**
  33251. * This flag can be used for type testing.
  33252. *
  33253. * @type {boolean}
  33254. * @readonly
  33255. * @default true
  33256. */
  33257. this.isHemisphereLight = true;
  33258. this.type = 'HemisphereLight';
  33259. this.position.copy( Object3D.DEFAULT_UP );
  33260. this.updateMatrix();
  33261. /**
  33262. * The light's ground color.
  33263. *
  33264. * @type {Color}
  33265. */
  33266. this.groundColor = new Color( groundColor );
  33267. }
  33268. copy( source, recursive ) {
  33269. super.copy( source, recursive );
  33270. this.groundColor.copy( source.groundColor );
  33271. return this;
  33272. }
  33273. toJSON( meta ) {
  33274. const data = super.toJSON( meta );
  33275. data.object.groundColor = this.groundColor.getHex();
  33276. return data;
  33277. }
  33278. }
  33279. const _projScreenMatrix = /*@__PURE__*/ new Matrix4();
  33280. const _lightPositionWorld = /*@__PURE__*/ new Vector3();
  33281. const _lookTarget = /*@__PURE__*/ new Vector3();
  33282. /**
  33283. * Abstract base class for light shadow classes. These classes
  33284. * represent the shadow configuration for different light types.
  33285. *
  33286. * @abstract
  33287. */
  33288. class LightShadow {
  33289. /**
  33290. * Constructs a new light shadow.
  33291. *
  33292. * @param {Camera} camera - The light's view of the world.
  33293. */
  33294. constructor( camera ) {
  33295. /**
  33296. * The light's view of the world.
  33297. *
  33298. * @type {Camera}
  33299. */
  33300. this.camera = camera;
  33301. /**
  33302. * The intensity of the shadow. The default is `1`.
  33303. * Valid values are in the range `[0, 1]`.
  33304. *
  33305. * @type {number}
  33306. * @default 1
  33307. */
  33308. this.intensity = 1;
  33309. /**
  33310. * Shadow map bias, how much to add or subtract from the normalized depth
  33311. * when deciding whether a surface is in shadow.
  33312. *
  33313. * The default is `0`. Very tiny adjustments here (in the order of `0.0001`)
  33314. * may help reduce artifacts in shadows.
  33315. *
  33316. * @type {number}
  33317. * @default 0
  33318. */
  33319. this.bias = 0;
  33320. /**
  33321. * Defines how much the position used to query the shadow map is offset along
  33322. * the object normal. The default is `0`. Increasing this value can be used to
  33323. * reduce shadow acne especially in large scenes where light shines onto
  33324. * geometry at a shallow angle. The cost is that shadows may appear distorted.
  33325. *
  33326. * @type {number}
  33327. * @default 0
  33328. */
  33329. this.normalBias = 0;
  33330. /**
  33331. * Setting this to values greater than 1 will blur the edges of the shadow.
  33332. * High values will cause unwanted banding effects in the shadows - a greater
  33333. * map size will allow for a higher value to be used here before these effects
  33334. * become visible.
  33335. *
  33336. * The property has no effect when the shadow map type is `BasicShadowMap`.
  33337. *
  33338. * @type {number}
  33339. * @default 1
  33340. */
  33341. this.radius = 1;
  33342. /**
  33343. * The amount of samples to use when blurring a VSM shadow map.
  33344. *
  33345. * @type {number}
  33346. * @default 8
  33347. */
  33348. this.blurSamples = 8;
  33349. /**
  33350. * Defines the width and height of the shadow map. Higher values give better quality
  33351. * shadows at the cost of computation time. Values must be powers of two.
  33352. *
  33353. * @type {Vector2}
  33354. * @default (512,512)
  33355. */
  33356. this.mapSize = new Vector2( 512, 512 );
  33357. /**
  33358. * The type of shadow texture. The default is `UnsignedByteType`.
  33359. *
  33360. * @type {number}
  33361. * @default UnsignedByteType
  33362. */
  33363. this.mapType = UnsignedByteType;
  33364. /**
  33365. * The depth map generated using the internal camera; a location beyond a
  33366. * pixel's depth is in shadow. Computed internally during rendering.
  33367. *
  33368. * @type {?RenderTarget}
  33369. * @default null
  33370. */
  33371. this.map = null;
  33372. /**
  33373. * The distribution map generated using the internal camera; an occlusion is
  33374. * calculated based on the distribution of depths. Computed internally during
  33375. * rendering.
  33376. *
  33377. * @type {?RenderTarget}
  33378. * @default null
  33379. */
  33380. this.mapPass = null;
  33381. /**
  33382. * Model to shadow camera space, to compute location and depth in shadow map.
  33383. * This is computed internally during rendering.
  33384. *
  33385. * @type {Matrix4}
  33386. */
  33387. this.matrix = new Matrix4();
  33388. /**
  33389. * Enables automatic updates of the light's shadow. If you do not require dynamic
  33390. * lighting / shadows, you may set this to `false`.
  33391. *
  33392. * @type {boolean}
  33393. * @default true
  33394. */
  33395. this.autoUpdate = true;
  33396. /**
  33397. * When set to `true`, shadow maps will be updated in the next `render` call.
  33398. * If you have set {@link LightShadow#autoUpdate} to `false`, you will need to
  33399. * set this property to `true` and then make a render call to update the light's shadow.
  33400. *
  33401. * @type {boolean}
  33402. * @default false
  33403. */
  33404. this.needsUpdate = false;
  33405. this._frustum = new Frustum();
  33406. this._frameExtents = new Vector2( 1, 1 );
  33407. this._viewportCount = 1;
  33408. this._viewports = [
  33409. new Vector4( 0, 0, 1, 1 )
  33410. ];
  33411. }
  33412. /**
  33413. * Used internally by the renderer to get the number of viewports that need
  33414. * to be rendered for this shadow.
  33415. *
  33416. * @return {number} The viewport count.
  33417. */
  33418. getViewportCount() {
  33419. return this._viewportCount;
  33420. }
  33421. /**
  33422. * Gets the shadow cameras frustum. Used internally by the renderer to cull objects.
  33423. *
  33424. * @return {Frustum} The shadow camera frustum.
  33425. */
  33426. getFrustum() {
  33427. return this._frustum;
  33428. }
  33429. /**
  33430. * Update the matrices for the camera and shadow, used internally by the renderer.
  33431. *
  33432. * @param {Light} light - The light for which the shadow is being rendered.
  33433. */
  33434. updateMatrices( light ) {
  33435. const shadowCamera = this.camera;
  33436. const shadowMatrix = this.matrix;
  33437. _lightPositionWorld.setFromMatrixPosition( light.matrixWorld );
  33438. shadowCamera.position.copy( _lightPositionWorld );
  33439. _lookTarget.setFromMatrixPosition( light.target.matrixWorld );
  33440. shadowCamera.lookAt( _lookTarget );
  33441. shadowCamera.updateMatrixWorld();
  33442. _projScreenMatrix.multiplyMatrices( shadowCamera.projectionMatrix, shadowCamera.matrixWorldInverse );
  33443. this._frustum.setFromProjectionMatrix( _projScreenMatrix, shadowCamera.coordinateSystem, shadowCamera.reversedDepth );
  33444. if ( shadowCamera.reversedDepth ) {
  33445. shadowMatrix.set(
  33446. 0.5, 0.0, 0.0, 0.5,
  33447. 0.0, 0.5, 0.0, 0.5,
  33448. 0.0, 0.0, 1.0, 0.0,
  33449. 0.0, 0.0, 0.0, 1.0
  33450. );
  33451. } else {
  33452. shadowMatrix.set(
  33453. 0.5, 0.0, 0.0, 0.5,
  33454. 0.0, 0.5, 0.0, 0.5,
  33455. 0.0, 0.0, 0.5, 0.5,
  33456. 0.0, 0.0, 0.0, 1.0
  33457. );
  33458. }
  33459. shadowMatrix.multiply( _projScreenMatrix );
  33460. }
  33461. /**
  33462. * Returns a viewport definition for the given viewport index.
  33463. *
  33464. * @param {number} viewportIndex - The viewport index.
  33465. * @return {Vector4} The viewport.
  33466. */
  33467. getViewport( viewportIndex ) {
  33468. return this._viewports[ viewportIndex ];
  33469. }
  33470. /**
  33471. * Returns the frame extends.
  33472. *
  33473. * @return {Vector2} The frame extends.
  33474. */
  33475. getFrameExtents() {
  33476. return this._frameExtents;
  33477. }
  33478. /**
  33479. * Frees the GPU-related resources allocated by this instance. Call this
  33480. * method whenever this instance is no longer used in your app.
  33481. */
  33482. dispose() {
  33483. if ( this.map ) {
  33484. this.map.dispose();
  33485. }
  33486. if ( this.mapPass ) {
  33487. this.mapPass.dispose();
  33488. }
  33489. }
  33490. /**
  33491. * Copies the values of the given light shadow instance to this instance.
  33492. *
  33493. * @param {LightShadow} source - The light shadow to copy.
  33494. * @return {LightShadow} A reference to this light shadow instance.
  33495. */
  33496. copy( source ) {
  33497. this.camera = source.camera.clone();
  33498. this.intensity = source.intensity;
  33499. this.bias = source.bias;
  33500. this.radius = source.radius;
  33501. this.autoUpdate = source.autoUpdate;
  33502. this.needsUpdate = source.needsUpdate;
  33503. this.normalBias = source.normalBias;
  33504. this.blurSamples = source.blurSamples;
  33505. this.mapSize.copy( source.mapSize );
  33506. return this;
  33507. }
  33508. /**
  33509. * Returns a new light shadow instance with copied values from this instance.
  33510. *
  33511. * @return {LightShadow} A clone of this instance.
  33512. */
  33513. clone() {
  33514. return new this.constructor().copy( this );
  33515. }
  33516. /**
  33517. * Serializes the light shadow into JSON.
  33518. *
  33519. * @return {Object} A JSON object representing the serialized light shadow.
  33520. * @see {@link ObjectLoader#parse}
  33521. */
  33522. toJSON() {
  33523. const object = {};
  33524. if ( this.intensity !== 1 ) object.intensity = this.intensity;
  33525. if ( this.bias !== 0 ) object.bias = this.bias;
  33526. if ( this.normalBias !== 0 ) object.normalBias = this.normalBias;
  33527. if ( this.radius !== 1 ) object.radius = this.radius;
  33528. if ( this.mapSize.x !== 512 || this.mapSize.y !== 512 ) object.mapSize = this.mapSize.toArray();
  33529. object.camera = this.camera.toJSON( false ).object;
  33530. delete object.camera.matrix;
  33531. return object;
  33532. }
  33533. }
  33534. /**
  33535. * Represents the shadow configuration of directional lights.
  33536. *
  33537. * @augments LightShadow
  33538. */
  33539. class SpotLightShadow extends LightShadow {
  33540. /**
  33541. * Constructs a new spot light shadow.
  33542. */
  33543. constructor() {
  33544. super( new PerspectiveCamera( 50, 1, 0.5, 500 ) );
  33545. /**
  33546. * This flag can be used for type testing.
  33547. *
  33548. * @type {boolean}
  33549. * @readonly
  33550. * @default true
  33551. */
  33552. this.isSpotLightShadow = true;
  33553. /**
  33554. * Used to focus the shadow camera. The camera's field of view is set as a
  33555. * percentage of the spotlight's field-of-view. Range is `[0, 1]`.
  33556. *
  33557. * @type {number}
  33558. * @default 1
  33559. */
  33560. this.focus = 1;
  33561. /**
  33562. * Texture aspect ratio.
  33563. *
  33564. * @type {number}
  33565. * @default 1
  33566. */
  33567. this.aspect = 1;
  33568. }
  33569. updateMatrices( light ) {
  33570. const camera = this.camera;
  33571. const fov = RAD2DEG * 2 * light.angle * this.focus;
  33572. const aspect = ( this.mapSize.width / this.mapSize.height ) * this.aspect;
  33573. const far = light.distance || camera.far;
  33574. if ( fov !== camera.fov || aspect !== camera.aspect || far !== camera.far ) {
  33575. camera.fov = fov;
  33576. camera.aspect = aspect;
  33577. camera.far = far;
  33578. camera.updateProjectionMatrix();
  33579. }
  33580. super.updateMatrices( light );
  33581. }
  33582. copy( source ) {
  33583. super.copy( source );
  33584. this.focus = source.focus;
  33585. return this;
  33586. }
  33587. }
  33588. /**
  33589. * This light gets emitted from a single point in one direction, along a cone
  33590. * that increases in size the further from the light it gets.
  33591. *
  33592. * This light can cast shadows - see the {@link SpotLightShadow} for details.
  33593. *
  33594. * ```js
  33595. * // white spotlight shining from the side, modulated by a texture
  33596. * const spotLight = new THREE.SpotLight( 0xffffff );
  33597. * spotLight.position.set( 100, 1000, 100 );
  33598. * spotLight.map = new THREE.TextureLoader().load( url );
  33599. *
  33600. * spotLight.castShadow = true;
  33601. * spotLight.shadow.mapSize.width = 1024;
  33602. * spotLight.shadow.mapSize.height = 1024;
  33603. * spotLight.shadow.camera.near = 500;
  33604. * spotLight.shadow.camera.far = 4000;
  33605. * spotLight.shadow.camera.fov = 30;s
  33606. * ```
  33607. *
  33608. * @augments Light
  33609. */
  33610. class SpotLight extends Light {
  33611. /**
  33612. * Constructs a new spot light.
  33613. *
  33614. * @param {(number|Color|string)} [color=0xffffff] - The light's color.
  33615. * @param {number} [intensity=1] - The light's strength/intensity measured in candela (cd).
  33616. * @param {number} [distance=0] - Maximum range of the light. `0` means no limit.
  33617. * @param {number} [angle=Math.PI/3] - Maximum angle of light dispersion from its direction whose upper bound is `Math.PI/2`.
  33618. * @param {number} [penumbra=0] - Percent of the spotlight cone that is attenuated due to penumbra. Value range is `[0,1]`.
  33619. * @param {number} [decay=2] - The amount the light dims along the distance of the light.
  33620. */
  33621. constructor( color, intensity, distance = 0, angle = Math.PI / 3, penumbra = 0, decay = 2 ) {
  33622. super( color, intensity );
  33623. /**
  33624. * This flag can be used for type testing.
  33625. *
  33626. * @type {boolean}
  33627. * @readonly
  33628. * @default true
  33629. */
  33630. this.isSpotLight = true;
  33631. this.type = 'SpotLight';
  33632. this.position.copy( Object3D.DEFAULT_UP );
  33633. this.updateMatrix();
  33634. /**
  33635. * The spot light points from its position to the
  33636. * target's position.
  33637. *
  33638. * For the target's position to be changed to anything other
  33639. * than the default, it must be added to the scene.
  33640. *
  33641. * It is also possible to set the target to be another 3D object
  33642. * in the scene. The light will now track the target object.
  33643. *
  33644. * @type {Object3D}
  33645. */
  33646. this.target = new Object3D();
  33647. /**
  33648. * Maximum range of the light. `0` means no limit.
  33649. *
  33650. * @type {number}
  33651. * @default 0
  33652. */
  33653. this.distance = distance;
  33654. /**
  33655. * Maximum angle of light dispersion from its direction whose upper bound is `Math.PI/2`.
  33656. *
  33657. * @type {number}
  33658. * @default Math.PI/3
  33659. */
  33660. this.angle = angle;
  33661. /**
  33662. * Percent of the spotlight cone that is attenuated due to penumbra.
  33663. * Value range is `[0,1]`.
  33664. *
  33665. * @type {number}
  33666. * @default 0
  33667. */
  33668. this.penumbra = penumbra;
  33669. /**
  33670. * The amount the light dims along the distance of the light. In context of
  33671. * physically-correct rendering the default value should not be changed.
  33672. *
  33673. * @type {number}
  33674. * @default 2
  33675. */
  33676. this.decay = decay;
  33677. /**
  33678. * A texture used to modulate the color of the light. The spot light
  33679. * color is mixed with the RGB value of this texture, with a ratio
  33680. * corresponding to its alpha value. The cookie-like masking effect is
  33681. * reproduced using pixel values (0, 0, 0, 1-cookie_value).
  33682. *
  33683. * *Warning*: This property is disabled if {@link Object3D#castShadow} is set to `false`.
  33684. *
  33685. * @type {?Texture}
  33686. * @default null
  33687. */
  33688. this.map = null;
  33689. /**
  33690. * This property holds the light's shadow configuration.
  33691. *
  33692. * @type {SpotLightShadow}
  33693. */
  33694. this.shadow = new SpotLightShadow();
  33695. }
  33696. /**
  33697. * The light's power. Power is the luminous power of the light measured in lumens (lm).
  33698. * Changing the power will also change the light's intensity.
  33699. *
  33700. * @type {number}
  33701. */
  33702. get power() {
  33703. // compute the light's luminous power (in lumens) from its intensity (in candela)
  33704. // by convention for a spotlight, luminous power (lm) = π * luminous intensity (cd)
  33705. return this.intensity * Math.PI;
  33706. }
  33707. set power( power ) {
  33708. // set the light's intensity (in candela) from the desired luminous power (in lumens)
  33709. this.intensity = power / Math.PI;
  33710. }
  33711. dispose() {
  33712. super.dispose();
  33713. this.shadow.dispose();
  33714. }
  33715. copy( source, recursive ) {
  33716. super.copy( source, recursive );
  33717. this.distance = source.distance;
  33718. this.angle = source.angle;
  33719. this.penumbra = source.penumbra;
  33720. this.decay = source.decay;
  33721. this.target = source.target.clone();
  33722. this.map = source.map;
  33723. this.shadow = source.shadow.clone();
  33724. return this;
  33725. }
  33726. toJSON( meta ) {
  33727. const data = super.toJSON( meta );
  33728. data.object.distance = this.distance;
  33729. data.object.angle = this.angle;
  33730. data.object.decay = this.decay;
  33731. data.object.penumbra = this.penumbra;
  33732. data.object.target = this.target.uuid;
  33733. if ( this.map && this.map.isTexture ) data.object.map = this.map.toJSON( meta ).uuid;
  33734. data.object.shadow = this.shadow.toJSON();
  33735. return data;
  33736. }
  33737. }
  33738. /**
  33739. * Represents the shadow configuration of point lights.
  33740. *
  33741. * @augments LightShadow
  33742. */
  33743. class PointLightShadow extends LightShadow {
  33744. /**
  33745. * Constructs a new point light shadow.
  33746. */
  33747. constructor() {
  33748. super( new PerspectiveCamera( 90, 1, 0.5, 500 ) );
  33749. /**
  33750. * This flag can be used for type testing.
  33751. *
  33752. * @type {boolean}
  33753. * @readonly
  33754. * @default true
  33755. */
  33756. this.isPointLightShadow = true;
  33757. }
  33758. }
  33759. /**
  33760. * A light that gets emitted from a single point in all directions. A common
  33761. * use case for this is to replicate the light emitted from a bare
  33762. * lightbulb.
  33763. *
  33764. * This light can cast shadows - see the {@link PointLightShadow} for details.
  33765. *
  33766. * ```js
  33767. * const light = new THREE.PointLight( 0xff0000, 1, 100 );
  33768. * light.position.set( 50, 50, 50 );
  33769. * scene.add( light );
  33770. * ```
  33771. *
  33772. * @augments Light
  33773. */
  33774. class PointLight extends Light {
  33775. /**
  33776. * Constructs a new point light.
  33777. *
  33778. * @param {(number|Color|string)} [color=0xffffff] - The light's color.
  33779. * @param {number} [intensity=1] - The light's strength/intensity measured in candela (cd).
  33780. * @param {number} [distance=0] - Maximum range of the light. `0` means no limit.
  33781. * @param {number} [decay=2] - The amount the light dims along the distance of the light.
  33782. */
  33783. constructor( color, intensity, distance = 0, decay = 2 ) {
  33784. super( color, intensity );
  33785. /**
  33786. * This flag can be used for type testing.
  33787. *
  33788. * @type {boolean}
  33789. * @readonly
  33790. * @default true
  33791. */
  33792. this.isPointLight = true;
  33793. this.type = 'PointLight';
  33794. /**
  33795. * When distance is zero, light will attenuate according to inverse-square
  33796. * law to infinite distance. When distance is non-zero, light will attenuate
  33797. * according to inverse-square law until near the distance cutoff, where it
  33798. * will then attenuate quickly and smoothly to 0. Inherently, cutoffs are not
  33799. * physically correct.
  33800. *
  33801. * @type {number}
  33802. * @default 0
  33803. */
  33804. this.distance = distance;
  33805. /**
  33806. * The amount the light dims along the distance of the light. In context of
  33807. * physically-correct rendering the default value should not be changed.
  33808. *
  33809. * @type {number}
  33810. * @default 2
  33811. */
  33812. this.decay = decay;
  33813. /**
  33814. * This property holds the light's shadow configuration.
  33815. *
  33816. * @type {PointLightShadow}
  33817. */
  33818. this.shadow = new PointLightShadow();
  33819. }
  33820. /**
  33821. * The light's power. Power is the luminous power of the light measured in lumens (lm).
  33822. * Changing the power will also change the light's intensity.
  33823. *
  33824. * @type {number}
  33825. */
  33826. get power() {
  33827. // compute the light's luminous power (in lumens) from its intensity (in candela)
  33828. // for an isotropic light source, luminous power (lm) = 4 π luminous intensity (cd)
  33829. return this.intensity * 4 * Math.PI;
  33830. }
  33831. set power( power ) {
  33832. // set the light's intensity (in candela) from the desired luminous power (in lumens)
  33833. this.intensity = power / ( 4 * Math.PI );
  33834. }
  33835. dispose() {
  33836. super.dispose();
  33837. this.shadow.dispose();
  33838. }
  33839. copy( source, recursive ) {
  33840. super.copy( source, recursive );
  33841. this.distance = source.distance;
  33842. this.decay = source.decay;
  33843. this.shadow = source.shadow.clone();
  33844. return this;
  33845. }
  33846. toJSON( meta ) {
  33847. const data = super.toJSON( meta );
  33848. data.object.distance = this.distance;
  33849. data.object.decay = this.decay;
  33850. data.object.shadow = this.shadow.toJSON();
  33851. return data;
  33852. }
  33853. }
  33854. /**
  33855. * Camera that uses [orthographic projection](https://en.wikipedia.org/wiki/Orthographic_projection).
  33856. *
  33857. * In this projection mode, an object's size in the rendered image stays
  33858. * constant regardless of its distance from the camera. This can be useful
  33859. * for rendering 2D scenes and UI elements, amongst other things.
  33860. *
  33861. * ```js
  33862. * const camera = new THREE.OrthographicCamera( width / - 2, width / 2, height / 2, height / - 2, 1, 1000 );
  33863. * scene.add( camera );
  33864. * ```
  33865. *
  33866. * @augments Camera
  33867. */
  33868. class OrthographicCamera extends Camera {
  33869. /**
  33870. * Constructs a new orthographic camera.
  33871. *
  33872. * @param {number} [left=-1] - The left plane of the camera's frustum.
  33873. * @param {number} [right=1] - The right plane of the camera's frustum.
  33874. * @param {number} [top=1] - The top plane of the camera's frustum.
  33875. * @param {number} [bottom=-1] - The bottom plane of the camera's frustum.
  33876. * @param {number} [near=0.1] - The camera's near plane.
  33877. * @param {number} [far=2000] - The camera's far plane.
  33878. */
  33879. constructor( left = -1, right = 1, top = 1, bottom = -1, near = 0.1, far = 2000 ) {
  33880. super();
  33881. /**
  33882. * This flag can be used for type testing.
  33883. *
  33884. * @type {boolean}
  33885. * @readonly
  33886. * @default true
  33887. */
  33888. this.isOrthographicCamera = true;
  33889. this.type = 'OrthographicCamera';
  33890. /**
  33891. * The zoom factor of the camera.
  33892. *
  33893. * @type {number}
  33894. * @default 1
  33895. */
  33896. this.zoom = 1;
  33897. /**
  33898. * Represents the frustum window specification. This property should not be edited
  33899. * directly but via {@link PerspectiveCamera#setViewOffset} and {@link PerspectiveCamera#clearViewOffset}.
  33900. *
  33901. * @type {?Object}
  33902. * @default null
  33903. */
  33904. this.view = null;
  33905. /**
  33906. * The left plane of the camera's frustum.
  33907. *
  33908. * @type {number}
  33909. * @default -1
  33910. */
  33911. this.left = left;
  33912. /**
  33913. * The right plane of the camera's frustum.
  33914. *
  33915. * @type {number}
  33916. * @default 1
  33917. */
  33918. this.right = right;
  33919. /**
  33920. * The top plane of the camera's frustum.
  33921. *
  33922. * @type {number}
  33923. * @default 1
  33924. */
  33925. this.top = top;
  33926. /**
  33927. * The bottom plane of the camera's frustum.
  33928. *
  33929. * @type {number}
  33930. * @default -1
  33931. */
  33932. this.bottom = bottom;
  33933. /**
  33934. * The camera's near plane. The valid range is greater than `0`
  33935. * and less than the current value of {@link OrthographicCamera#far}.
  33936. *
  33937. * Note that, unlike for the {@link PerspectiveCamera}, `0` is a
  33938. * valid value for an orthographic camera's near plane.
  33939. *
  33940. * @type {number}
  33941. * @default 0.1
  33942. */
  33943. this.near = near;
  33944. /**
  33945. * The camera's far plane. Must be greater than the
  33946. * current value of {@link OrthographicCamera#near}.
  33947. *
  33948. * @type {number}
  33949. * @default 2000
  33950. */
  33951. this.far = far;
  33952. this.updateProjectionMatrix();
  33953. }
  33954. copy( source, recursive ) {
  33955. super.copy( source, recursive );
  33956. this.left = source.left;
  33957. this.right = source.right;
  33958. this.top = source.top;
  33959. this.bottom = source.bottom;
  33960. this.near = source.near;
  33961. this.far = source.far;
  33962. this.zoom = source.zoom;
  33963. this.view = source.view === null ? null : Object.assign( {}, source.view );
  33964. return this;
  33965. }
  33966. /**
  33967. * Sets an offset in a larger frustum. This is useful for multi-window or
  33968. * multi-monitor/multi-machine setups.
  33969. *
  33970. * @param {number} fullWidth - The full width of multiview setup.
  33971. * @param {number} fullHeight - The full height of multiview setup.
  33972. * @param {number} x - The horizontal offset of the subcamera.
  33973. * @param {number} y - The vertical offset of the subcamera.
  33974. * @param {number} width - The width of subcamera.
  33975. * @param {number} height - The height of subcamera.
  33976. * @see {@link PerspectiveCamera#setViewOffset}
  33977. */
  33978. setViewOffset( fullWidth, fullHeight, x, y, width, height ) {
  33979. if ( this.view === null ) {
  33980. this.view = {
  33981. enabled: true,
  33982. fullWidth: 1,
  33983. fullHeight: 1,
  33984. offsetX: 0,
  33985. offsetY: 0,
  33986. width: 1,
  33987. height: 1
  33988. };
  33989. }
  33990. this.view.enabled = true;
  33991. this.view.fullWidth = fullWidth;
  33992. this.view.fullHeight = fullHeight;
  33993. this.view.offsetX = x;
  33994. this.view.offsetY = y;
  33995. this.view.width = width;
  33996. this.view.height = height;
  33997. this.updateProjectionMatrix();
  33998. }
  33999. /**
  34000. * Removes the view offset from the projection matrix.
  34001. */
  34002. clearViewOffset() {
  34003. if ( this.view !== null ) {
  34004. this.view.enabled = false;
  34005. }
  34006. this.updateProjectionMatrix();
  34007. }
  34008. /**
  34009. * Updates the camera's projection matrix. Must be called after any change of
  34010. * camera properties.
  34011. */
  34012. updateProjectionMatrix() {
  34013. const dx = ( this.right - this.left ) / ( 2 * this.zoom );
  34014. const dy = ( this.top - this.bottom ) / ( 2 * this.zoom );
  34015. const cx = ( this.right + this.left ) / 2;
  34016. const cy = ( this.top + this.bottom ) / 2;
  34017. let left = cx - dx;
  34018. let right = cx + dx;
  34019. let top = cy + dy;
  34020. let bottom = cy - dy;
  34021. if ( this.view !== null && this.view.enabled ) {
  34022. const scaleW = ( this.right - this.left ) / this.view.fullWidth / this.zoom;
  34023. const scaleH = ( this.top - this.bottom ) / this.view.fullHeight / this.zoom;
  34024. left += scaleW * this.view.offsetX;
  34025. right = left + scaleW * this.view.width;
  34026. top -= scaleH * this.view.offsetY;
  34027. bottom = top - scaleH * this.view.height;
  34028. }
  34029. this.projectionMatrix.makeOrthographic( left, right, top, bottom, this.near, this.far, this.coordinateSystem, this.reversedDepth );
  34030. this.projectionMatrixInverse.copy( this.projectionMatrix ).invert();
  34031. }
  34032. toJSON( meta ) {
  34033. const data = super.toJSON( meta );
  34034. data.object.zoom = this.zoom;
  34035. data.object.left = this.left;
  34036. data.object.right = this.right;
  34037. data.object.top = this.top;
  34038. data.object.bottom = this.bottom;
  34039. data.object.near = this.near;
  34040. data.object.far = this.far;
  34041. if ( this.view !== null ) data.object.view = Object.assign( {}, this.view );
  34042. return data;
  34043. }
  34044. }
  34045. /**
  34046. * Represents the shadow configuration of directional lights.
  34047. *
  34048. * @augments LightShadow
  34049. */
  34050. class DirectionalLightShadow extends LightShadow {
  34051. /**
  34052. * Constructs a new directional light shadow.
  34053. */
  34054. constructor() {
  34055. super( new OrthographicCamera( -5, 5, 5, -5, 0.5, 500 ) );
  34056. /**
  34057. * This flag can be used for type testing.
  34058. *
  34059. * @type {boolean}
  34060. * @readonly
  34061. * @default true
  34062. */
  34063. this.isDirectionalLightShadow = true;
  34064. }
  34065. }
  34066. /**
  34067. * A light that gets emitted in a specific direction. This light will behave
  34068. * as though it is infinitely far away and the rays produced from it are all
  34069. * parallel. The common use case for this is to simulate daylight; the sun is
  34070. * far enough away that its position can be considered to be infinite, and
  34071. * all light rays coming from it are parallel.
  34072. *
  34073. * A common point of confusion for directional lights is that setting the
  34074. * rotation has no effect. This is because three.js's DirectionalLight is the
  34075. * equivalent to what is often called a 'Target Direct Light' in other
  34076. * applications.
  34077. *
  34078. * This means that its direction is calculated as pointing from the light's
  34079. * {@link Object3D#position} to the {@link DirectionalLight#target} position
  34080. * (as opposed to a 'Free Direct Light' that just has a rotation
  34081. * component).
  34082. *
  34083. * This light can cast shadows - see the {@link DirectionalLightShadow} for details.
  34084. *
  34085. * ```js
  34086. * // White directional light at half intensity shining from the top.
  34087. * const directionalLight = new THREE.DirectionalLight( 0xffffff, 0.5 );
  34088. * scene.add( directionalLight );
  34089. * ```
  34090. *
  34091. * @augments Light
  34092. */
  34093. class DirectionalLight extends Light {
  34094. /**
  34095. * Constructs a new directional light.
  34096. *
  34097. * @param {(number|Color|string)} [color=0xffffff] - The light's color.
  34098. * @param {number} [intensity=1] - The light's strength/intensity.
  34099. */
  34100. constructor( color, intensity ) {
  34101. super( color, intensity );
  34102. /**
  34103. * This flag can be used for type testing.
  34104. *
  34105. * @type {boolean}
  34106. * @readonly
  34107. * @default true
  34108. */
  34109. this.isDirectionalLight = true;
  34110. this.type = 'DirectionalLight';
  34111. this.position.copy( Object3D.DEFAULT_UP );
  34112. this.updateMatrix();
  34113. /**
  34114. * The directional light points from its position to the
  34115. * target's position.
  34116. *
  34117. * For the target's position to be changed to anything other
  34118. * than the default, it must be added to the scene.
  34119. *
  34120. * It is also possible to set the target to be another 3D object
  34121. * in the scene. The light will now track the target object.
  34122. *
  34123. * @type {Object3D}
  34124. */
  34125. this.target = new Object3D();
  34126. /**
  34127. * This property holds the light's shadow configuration.
  34128. *
  34129. * @type {DirectionalLightShadow}
  34130. */
  34131. this.shadow = new DirectionalLightShadow();
  34132. }
  34133. dispose() {
  34134. super.dispose();
  34135. this.shadow.dispose();
  34136. }
  34137. copy( source ) {
  34138. super.copy( source );
  34139. this.target = source.target.clone();
  34140. this.shadow = source.shadow.clone();
  34141. return this;
  34142. }
  34143. toJSON( meta ) {
  34144. const data = super.toJSON( meta );
  34145. data.object.shadow = this.shadow.toJSON();
  34146. data.object.target = this.target.uuid;
  34147. return data;
  34148. }
  34149. }
  34150. /**
  34151. * This light globally illuminates all objects in the scene equally.
  34152. *
  34153. * It cannot be used to cast shadows as it does not have a direction.
  34154. *
  34155. * ```js
  34156. * const light = new THREE.AmbientLight( 0x404040 ); // soft white light
  34157. * scene.add( light );
  34158. * ```
  34159. *
  34160. * @augments Light
  34161. */
  34162. class AmbientLight extends Light {
  34163. /**
  34164. * Constructs a new ambient light.
  34165. *
  34166. * @param {(number|Color|string)} [color=0xffffff] - The light's color.
  34167. * @param {number} [intensity=1] - The light's strength/intensity.
  34168. */
  34169. constructor( color, intensity ) {
  34170. super( color, intensity );
  34171. /**
  34172. * This flag can be used for type testing.
  34173. *
  34174. * @type {boolean}
  34175. * @readonly
  34176. * @default true
  34177. */
  34178. this.isAmbientLight = true;
  34179. this.type = 'AmbientLight';
  34180. }
  34181. }
  34182. /**
  34183. * This class emits light uniformly across the face a rectangular plane.
  34184. * This light type can be used to simulate light sources such as bright
  34185. * windows or strip lighting.
  34186. *
  34187. * Important Notes:
  34188. *
  34189. * - There is no shadow support.
  34190. * - Only PBR materials are supported.
  34191. * - You have to include `RectAreaLightUniformsLib` (`WebGLRenderer`) or `RectAreaLightTexturesLib` (`WebGPURenderer`)
  34192. * into your app and init the uniforms/textures.
  34193. *
  34194. * ```js
  34195. * RectAreaLightUniformsLib.init(); // only relevant for WebGLRenderer
  34196. * THREE.RectAreaLightNode.setLTC( RectAreaLightTexturesLib.init() ); // only relevant for WebGPURenderer
  34197. *
  34198. * const intensity = 1; const width = 10; const height = 10;
  34199. * const rectLight = new THREE.RectAreaLight( 0xffffff, intensity, width, height );
  34200. * rectLight.position.set( 5, 5, 0 );
  34201. * rectLight.lookAt( 0, 0, 0 );
  34202. * scene.add( rectLight )
  34203. * ```
  34204. *
  34205. * @augments Light
  34206. */
  34207. class RectAreaLight extends Light {
  34208. /**
  34209. * Constructs a new area light.
  34210. *
  34211. * @param {(number|Color|string)} [color=0xffffff] - The light's color.
  34212. * @param {number} [intensity=1] - The light's strength/intensity.
  34213. * @param {number} [width=10] - The width of the light.
  34214. * @param {number} [height=10] - The height of the light.
  34215. */
  34216. constructor( color, intensity, width = 10, height = 10 ) {
  34217. super( color, intensity );
  34218. /**
  34219. * This flag can be used for type testing.
  34220. *
  34221. * @type {boolean}
  34222. * @readonly
  34223. * @default true
  34224. */
  34225. this.isRectAreaLight = true;
  34226. this.type = 'RectAreaLight';
  34227. /**
  34228. * The width of the light.
  34229. *
  34230. * @type {number}
  34231. * @default 10
  34232. */
  34233. this.width = width;
  34234. /**
  34235. * The height of the light.
  34236. *
  34237. * @type {number}
  34238. * @default 10
  34239. */
  34240. this.height = height;
  34241. }
  34242. /**
  34243. * The light's power. Power is the luminous power of the light measured in lumens (lm).
  34244. * Changing the power will also change the light's intensity.
  34245. *
  34246. * @type {number}
  34247. */
  34248. get power() {
  34249. // compute the light's luminous power (in lumens) from its intensity (in nits)
  34250. return this.intensity * this.width * this.height * Math.PI;
  34251. }
  34252. set power( power ) {
  34253. // set the light's intensity (in nits) from the desired luminous power (in lumens)
  34254. this.intensity = power / ( this.width * this.height * Math.PI );
  34255. }
  34256. copy( source ) {
  34257. super.copy( source );
  34258. this.width = source.width;
  34259. this.height = source.height;
  34260. return this;
  34261. }
  34262. toJSON( meta ) {
  34263. const data = super.toJSON( meta );
  34264. data.object.width = this.width;
  34265. data.object.height = this.height;
  34266. return data;
  34267. }
  34268. }
  34269. /**
  34270. * Represents a third-order spherical harmonics (SH). Light probes use this class
  34271. * to encode lighting information.
  34272. *
  34273. * - Primary reference: {@link https://graphics.stanford.edu/papers/envmap/envmap.pdf}
  34274. * - Secondary reference: {@link https://www.ppsloan.org/publications/StupidSH36.pdf}
  34275. */
  34276. class SphericalHarmonics3 {
  34277. /**
  34278. * Constructs a new spherical harmonics.
  34279. */
  34280. constructor() {
  34281. /**
  34282. * This flag can be used for type testing.
  34283. *
  34284. * @type {boolean}
  34285. * @readonly
  34286. * @default true
  34287. */
  34288. this.isSphericalHarmonics3 = true;
  34289. /**
  34290. * An array holding the (9) SH coefficients.
  34291. *
  34292. * @type {Array<Vector3>}
  34293. */
  34294. this.coefficients = [];
  34295. for ( let i = 0; i < 9; i ++ ) {
  34296. this.coefficients.push( new Vector3() );
  34297. }
  34298. }
  34299. /**
  34300. * Sets the given SH coefficients to this instance by copying
  34301. * the values.
  34302. *
  34303. * @param {Array<Vector3>} coefficients - The SH coefficients.
  34304. * @return {SphericalHarmonics3} A reference to this spherical harmonics.
  34305. */
  34306. set( coefficients ) {
  34307. for ( let i = 0; i < 9; i ++ ) {
  34308. this.coefficients[ i ].copy( coefficients[ i ] );
  34309. }
  34310. return this;
  34311. }
  34312. /**
  34313. * Sets all SH coefficients to `0`.
  34314. *
  34315. * @return {SphericalHarmonics3} A reference to this spherical harmonics.
  34316. */
  34317. zero() {
  34318. for ( let i = 0; i < 9; i ++ ) {
  34319. this.coefficients[ i ].set( 0, 0, 0 );
  34320. }
  34321. return this;
  34322. }
  34323. /**
  34324. * Returns the radiance in the direction of the given normal.
  34325. *
  34326. * @param {Vector3} normal - The normal vector (assumed to be unit length)
  34327. * @param {Vector3} target - The target vector that is used to store the method's result.
  34328. * @return {Vector3} The radiance.
  34329. */
  34330. getAt( normal, target ) {
  34331. // normal is assumed to be unit length
  34332. const x = normal.x, y = normal.y, z = normal.z;
  34333. const coeff = this.coefficients;
  34334. // band 0
  34335. target.copy( coeff[ 0 ] ).multiplyScalar( 0.282095 );
  34336. // band 1
  34337. target.addScaledVector( coeff[ 1 ], 0.488603 * y );
  34338. target.addScaledVector( coeff[ 2 ], 0.488603 * z );
  34339. target.addScaledVector( coeff[ 3 ], 0.488603 * x );
  34340. // band 2
  34341. target.addScaledVector( coeff[ 4 ], 1.092548 * ( x * y ) );
  34342. target.addScaledVector( coeff[ 5 ], 1.092548 * ( y * z ) );
  34343. target.addScaledVector( coeff[ 6 ], 0.315392 * ( 3.0 * z * z - 1.0 ) );
  34344. target.addScaledVector( coeff[ 7 ], 1.092548 * ( x * z ) );
  34345. target.addScaledVector( coeff[ 8 ], 0.546274 * ( x * x - y * y ) );
  34346. return target;
  34347. }
  34348. /**
  34349. * Returns the irradiance (radiance convolved with cosine lobe) in the
  34350. * direction of the given normal.
  34351. *
  34352. * @param {Vector3} normal - The normal vector (assumed to be unit length)
  34353. * @param {Vector3} target - The target vector that is used to store the method's result.
  34354. * @return {Vector3} The irradiance.
  34355. */
  34356. getIrradianceAt( normal, target ) {
  34357. // normal is assumed to be unit length
  34358. const x = normal.x, y = normal.y, z = normal.z;
  34359. const coeff = this.coefficients;
  34360. // band 0
  34361. target.copy( coeff[ 0 ] ).multiplyScalar( 0.886227 ); // π * 0.282095
  34362. // band 1
  34363. target.addScaledVector( coeff[ 1 ], 2.0 * 0.511664 * y ); // ( 2 * π / 3 ) * 0.488603
  34364. target.addScaledVector( coeff[ 2 ], 2.0 * 0.511664 * z );
  34365. target.addScaledVector( coeff[ 3 ], 2.0 * 0.511664 * x );
  34366. // band 2
  34367. target.addScaledVector( coeff[ 4 ], 2.0 * 0.429043 * x * y ); // ( π / 4 ) * 1.092548
  34368. target.addScaledVector( coeff[ 5 ], 2.0 * 0.429043 * y * z );
  34369. target.addScaledVector( coeff[ 6 ], 0.743125 * z * z - 0.247708 ); // ( π / 4 ) * 0.315392 * 3
  34370. target.addScaledVector( coeff[ 7 ], 2.0 * 0.429043 * x * z );
  34371. target.addScaledVector( coeff[ 8 ], 0.429043 * ( x * x - y * y ) ); // ( π / 4 ) * 0.546274
  34372. return target;
  34373. }
  34374. /**
  34375. * Adds the given SH to this instance.
  34376. *
  34377. * @param {SphericalHarmonics3} sh - The SH to add.
  34378. * @return {SphericalHarmonics3} A reference to this spherical harmonics.
  34379. */
  34380. add( sh ) {
  34381. for ( let i = 0; i < 9; i ++ ) {
  34382. this.coefficients[ i ].add( sh.coefficients[ i ] );
  34383. }
  34384. return this;
  34385. }
  34386. /**
  34387. * A convenience method for performing {@link SphericalHarmonics3#add} and
  34388. * {@link SphericalHarmonics3#scale} at once.
  34389. *
  34390. * @param {SphericalHarmonics3} sh - The SH to add.
  34391. * @param {number} s - The scale factor.
  34392. * @return {SphericalHarmonics3} A reference to this spherical harmonics.
  34393. */
  34394. addScaledSH( sh, s ) {
  34395. for ( let i = 0; i < 9; i ++ ) {
  34396. this.coefficients[ i ].addScaledVector( sh.coefficients[ i ], s );
  34397. }
  34398. return this;
  34399. }
  34400. /**
  34401. * Scales this SH by the given scale factor.
  34402. *
  34403. * @param {number} s - The scale factor.
  34404. * @return {SphericalHarmonics3} A reference to this spherical harmonics.
  34405. */
  34406. scale( s ) {
  34407. for ( let i = 0; i < 9; i ++ ) {
  34408. this.coefficients[ i ].multiplyScalar( s );
  34409. }
  34410. return this;
  34411. }
  34412. /**
  34413. * Linear interpolates between the given SH and this instance by the given
  34414. * alpha factor.
  34415. *
  34416. * @param {SphericalHarmonics3} sh - The SH to interpolate with.
  34417. * @param {number} alpha - The alpha factor.
  34418. * @return {SphericalHarmonics3} A reference to this spherical harmonics.
  34419. */
  34420. lerp( sh, alpha ) {
  34421. for ( let i = 0; i < 9; i ++ ) {
  34422. this.coefficients[ i ].lerp( sh.coefficients[ i ], alpha );
  34423. }
  34424. return this;
  34425. }
  34426. /**
  34427. * Returns `true` if this spherical harmonics is equal with the given one.
  34428. *
  34429. * @param {SphericalHarmonics3} sh - The spherical harmonics to test for equality.
  34430. * @return {boolean} Whether this spherical harmonics is equal with the given one.
  34431. */
  34432. equals( sh ) {
  34433. for ( let i = 0; i < 9; i ++ ) {
  34434. if ( ! this.coefficients[ i ].equals( sh.coefficients[ i ] ) ) {
  34435. return false;
  34436. }
  34437. }
  34438. return true;
  34439. }
  34440. /**
  34441. * Copies the values of the given spherical harmonics to this instance.
  34442. *
  34443. * @param {SphericalHarmonics3} sh - The spherical harmonics to copy.
  34444. * @return {SphericalHarmonics3} A reference to this spherical harmonics.
  34445. */
  34446. copy( sh ) {
  34447. return this.set( sh.coefficients );
  34448. }
  34449. /**
  34450. * Returns a new spherical harmonics with copied values from this instance.
  34451. *
  34452. * @return {SphericalHarmonics3} A clone of this instance.
  34453. */
  34454. clone() {
  34455. return new this.constructor().copy( this );
  34456. }
  34457. /**
  34458. * Sets the SH coefficients of this instance from the given array.
  34459. *
  34460. * @param {Array<number>} array - An array holding the SH coefficients.
  34461. * @param {number} [offset=0] - The array offset where to start copying.
  34462. * @return {SphericalHarmonics3} A clone of this instance.
  34463. */
  34464. fromArray( array, offset = 0 ) {
  34465. const coefficients = this.coefficients;
  34466. for ( let i = 0; i < 9; i ++ ) {
  34467. coefficients[ i ].fromArray( array, offset + ( i * 3 ) );
  34468. }
  34469. return this;
  34470. }
  34471. /**
  34472. * Returns an array with the SH coefficients, or copies them into the provided
  34473. * array. The coefficients are represented as numbers.
  34474. *
  34475. * @param {Array<number>} [array=[]] - The target array.
  34476. * @param {number} [offset=0] - The array offset where to start copying.
  34477. * @return {Array<number>} An array with flat SH coefficients.
  34478. */
  34479. toArray( array = [], offset = 0 ) {
  34480. const coefficients = this.coefficients;
  34481. for ( let i = 0; i < 9; i ++ ) {
  34482. coefficients[ i ].toArray( array, offset + ( i * 3 ) );
  34483. }
  34484. return array;
  34485. }
  34486. /**
  34487. * Computes the SH basis for the given normal vector.
  34488. *
  34489. * @param {Vector3} normal - The normal.
  34490. * @param {Array<number>} shBasis - The target array holding the SH basis.
  34491. */
  34492. static getBasisAt( normal, shBasis ) {
  34493. // normal is assumed to be unit length
  34494. const x = normal.x, y = normal.y, z = normal.z;
  34495. // band 0
  34496. shBasis[ 0 ] = 0.282095;
  34497. // band 1
  34498. shBasis[ 1 ] = 0.488603 * y;
  34499. shBasis[ 2 ] = 0.488603 * z;
  34500. shBasis[ 3 ] = 0.488603 * x;
  34501. // band 2
  34502. shBasis[ 4 ] = 1.092548 * x * y;
  34503. shBasis[ 5 ] = 1.092548 * y * z;
  34504. shBasis[ 6 ] = 0.315392 * ( 3 * z * z - 1 );
  34505. shBasis[ 7 ] = 1.092548 * x * z;
  34506. shBasis[ 8 ] = 0.546274 * ( x * x - y * y );
  34507. }
  34508. }
  34509. /**
  34510. * Light probes are an alternative way of adding light to a 3D scene. Unlike
  34511. * classical light sources (e.g. directional, point or spot lights), light
  34512. * probes do not emit light. Instead they store information about light
  34513. * passing through 3D space. During rendering, the light that hits a 3D
  34514. * object is approximated by using the data from the light probe.
  34515. *
  34516. * Light probes are usually created from (radiance) environment maps. The
  34517. * class {@link LightProbeGenerator} can be used to create light probes from
  34518. * cube textures or render targets. However, light estimation data could also
  34519. * be provided in other forms e.g. by WebXR. This enables the rendering of
  34520. * augmented reality content that reacts to real world lighting.
  34521. *
  34522. * The current probe implementation in three.js supports so-called diffuse
  34523. * light probes. This type of light probe is functionally equivalent to an
  34524. * irradiance environment map.
  34525. *
  34526. * @augments Light
  34527. */
  34528. class LightProbe extends Light {
  34529. /**
  34530. * Constructs a new light probe.
  34531. *
  34532. * @param {SphericalHarmonics3} sh - The spherical harmonics which represents encoded lighting information.
  34533. * @param {number} [intensity=1] - The light's strength/intensity.
  34534. */
  34535. constructor( sh = new SphericalHarmonics3(), intensity = 1 ) {
  34536. super( undefined, intensity );
  34537. /**
  34538. * This flag can be used for type testing.
  34539. *
  34540. * @type {boolean}
  34541. * @readonly
  34542. * @default true
  34543. */
  34544. this.isLightProbe = true;
  34545. /**
  34546. * A light probe uses spherical harmonics to encode lighting information.
  34547. *
  34548. * @type {SphericalHarmonics3}
  34549. */
  34550. this.sh = sh;
  34551. }
  34552. copy( source ) {
  34553. super.copy( source );
  34554. this.sh.copy( source.sh );
  34555. return this;
  34556. }
  34557. toJSON( meta ) {
  34558. const data = super.toJSON( meta );
  34559. data.object.sh = this.sh.toArray();
  34560. return data;
  34561. }
  34562. }
  34563. /**
  34564. * Class for loading materials. The files are internally
  34565. * loaded via {@link FileLoader}.
  34566. *
  34567. * ```js
  34568. * const loader = new THREE.MaterialLoader();
  34569. * const material = await loader.loadAsync( 'material.json' );
  34570. * ```
  34571. * This loader does not support node materials. Use {@link NodeMaterialLoader} instead.
  34572. *
  34573. * @augments Loader
  34574. */
  34575. class MaterialLoader extends Loader {
  34576. /**
  34577. * Constructs a new material loader.
  34578. *
  34579. * @param {LoadingManager} [manager] - The loading manager.
  34580. */
  34581. constructor( manager ) {
  34582. super( manager );
  34583. /**
  34584. * A dictionary holding textures used by the material.
  34585. *
  34586. * @type {Object<string,Texture>}
  34587. */
  34588. this.textures = {};
  34589. }
  34590. /**
  34591. * Starts loading from the given URL and pass the loaded material to the `onLoad()` callback.
  34592. *
  34593. * @param {string} url - The path/URL of the file to be loaded. This can also be a data URI.
  34594. * @param {function(Material)} onLoad - Executed when the loading process has been finished.
  34595. * @param {onProgressCallback} onProgress - Executed while the loading is in progress.
  34596. * @param {onErrorCallback} onError - Executed when errors occur.
  34597. */
  34598. load( url, onLoad, onProgress, onError ) {
  34599. const scope = this;
  34600. const loader = new FileLoader( scope.manager );
  34601. loader.setPath( scope.path );
  34602. loader.setRequestHeader( scope.requestHeader );
  34603. loader.setWithCredentials( scope.withCredentials );
  34604. loader.load( url, function ( text ) {
  34605. try {
  34606. onLoad( scope.parse( JSON.parse( text ) ) );
  34607. } catch ( e ) {
  34608. if ( onError ) {
  34609. onError( e );
  34610. } else {
  34611. error( e );
  34612. }
  34613. scope.manager.itemError( url );
  34614. }
  34615. }, onProgress, onError );
  34616. }
  34617. /**
  34618. * Parses the given JSON object and returns a material.
  34619. *
  34620. * @param {Object} json - The serialized material.
  34621. * @return {Material} The parsed material.
  34622. */
  34623. parse( json ) {
  34624. const textures = this.textures;
  34625. function getTexture( name ) {
  34626. if ( textures[ name ] === undefined ) {
  34627. warn( 'MaterialLoader: Undefined texture', name );
  34628. }
  34629. return textures[ name ];
  34630. }
  34631. const material = this.createMaterialFromType( json.type );
  34632. if ( json.uuid !== undefined ) material.uuid = json.uuid;
  34633. if ( json.name !== undefined ) material.name = json.name;
  34634. if ( json.color !== undefined && material.color !== undefined ) material.color.setHex( json.color );
  34635. if ( json.roughness !== undefined ) material.roughness = json.roughness;
  34636. if ( json.metalness !== undefined ) material.metalness = json.metalness;
  34637. if ( json.sheen !== undefined ) material.sheen = json.sheen;
  34638. if ( json.sheenColor !== undefined ) material.sheenColor = new Color().setHex( json.sheenColor );
  34639. if ( json.sheenRoughness !== undefined ) material.sheenRoughness = json.sheenRoughness;
  34640. if ( json.emissive !== undefined && material.emissive !== undefined ) material.emissive.setHex( json.emissive );
  34641. if ( json.specular !== undefined && material.specular !== undefined ) material.specular.setHex( json.specular );
  34642. if ( json.specularIntensity !== undefined ) material.specularIntensity = json.specularIntensity;
  34643. if ( json.specularColor !== undefined && material.specularColor !== undefined ) material.specularColor.setHex( json.specularColor );
  34644. if ( json.shininess !== undefined ) material.shininess = json.shininess;
  34645. if ( json.clearcoat !== undefined ) material.clearcoat = json.clearcoat;
  34646. if ( json.clearcoatRoughness !== undefined ) material.clearcoatRoughness = json.clearcoatRoughness;
  34647. if ( json.dispersion !== undefined ) material.dispersion = json.dispersion;
  34648. if ( json.iridescence !== undefined ) material.iridescence = json.iridescence;
  34649. if ( json.iridescenceIOR !== undefined ) material.iridescenceIOR = json.iridescenceIOR;
  34650. if ( json.iridescenceThicknessRange !== undefined ) material.iridescenceThicknessRange = json.iridescenceThicknessRange;
  34651. if ( json.transmission !== undefined ) material.transmission = json.transmission;
  34652. if ( json.thickness !== undefined ) material.thickness = json.thickness;
  34653. if ( json.attenuationDistance !== undefined ) material.attenuationDistance = json.attenuationDistance;
  34654. if ( json.attenuationColor !== undefined && material.attenuationColor !== undefined ) material.attenuationColor.setHex( json.attenuationColor );
  34655. if ( json.anisotropy !== undefined ) material.anisotropy = json.anisotropy;
  34656. if ( json.anisotropyRotation !== undefined ) material.anisotropyRotation = json.anisotropyRotation;
  34657. if ( json.fog !== undefined ) material.fog = json.fog;
  34658. if ( json.flatShading !== undefined ) material.flatShading = json.flatShading;
  34659. if ( json.blending !== undefined ) material.blending = json.blending;
  34660. if ( json.combine !== undefined ) material.combine = json.combine;
  34661. if ( json.side !== undefined ) material.side = json.side;
  34662. if ( json.shadowSide !== undefined ) material.shadowSide = json.shadowSide;
  34663. if ( json.opacity !== undefined ) material.opacity = json.opacity;
  34664. if ( json.transparent !== undefined ) material.transparent = json.transparent;
  34665. if ( json.alphaTest !== undefined ) material.alphaTest = json.alphaTest;
  34666. if ( json.alphaHash !== undefined ) material.alphaHash = json.alphaHash;
  34667. if ( json.depthFunc !== undefined ) material.depthFunc = json.depthFunc;
  34668. if ( json.depthTest !== undefined ) material.depthTest = json.depthTest;
  34669. if ( json.depthWrite !== undefined ) material.depthWrite = json.depthWrite;
  34670. if ( json.colorWrite !== undefined ) material.colorWrite = json.colorWrite;
  34671. if ( json.blendSrc !== undefined ) material.blendSrc = json.blendSrc;
  34672. if ( json.blendDst !== undefined ) material.blendDst = json.blendDst;
  34673. if ( json.blendEquation !== undefined ) material.blendEquation = json.blendEquation;
  34674. if ( json.blendSrcAlpha !== undefined ) material.blendSrcAlpha = json.blendSrcAlpha;
  34675. if ( json.blendDstAlpha !== undefined ) material.blendDstAlpha = json.blendDstAlpha;
  34676. if ( json.blendEquationAlpha !== undefined ) material.blendEquationAlpha = json.blendEquationAlpha;
  34677. if ( json.blendColor !== undefined && material.blendColor !== undefined ) material.blendColor.setHex( json.blendColor );
  34678. if ( json.blendAlpha !== undefined ) material.blendAlpha = json.blendAlpha;
  34679. if ( json.stencilWriteMask !== undefined ) material.stencilWriteMask = json.stencilWriteMask;
  34680. if ( json.stencilFunc !== undefined ) material.stencilFunc = json.stencilFunc;
  34681. if ( json.stencilRef !== undefined ) material.stencilRef = json.stencilRef;
  34682. if ( json.stencilFuncMask !== undefined ) material.stencilFuncMask = json.stencilFuncMask;
  34683. if ( json.stencilFail !== undefined ) material.stencilFail = json.stencilFail;
  34684. if ( json.stencilZFail !== undefined ) material.stencilZFail = json.stencilZFail;
  34685. if ( json.stencilZPass !== undefined ) material.stencilZPass = json.stencilZPass;
  34686. if ( json.stencilWrite !== undefined ) material.stencilWrite = json.stencilWrite;
  34687. if ( json.wireframe !== undefined ) material.wireframe = json.wireframe;
  34688. if ( json.wireframeLinewidth !== undefined ) material.wireframeLinewidth = json.wireframeLinewidth;
  34689. if ( json.wireframeLinecap !== undefined ) material.wireframeLinecap = json.wireframeLinecap;
  34690. if ( json.wireframeLinejoin !== undefined ) material.wireframeLinejoin = json.wireframeLinejoin;
  34691. if ( json.rotation !== undefined ) material.rotation = json.rotation;
  34692. if ( json.linewidth !== undefined ) material.linewidth = json.linewidth;
  34693. if ( json.dashSize !== undefined ) material.dashSize = json.dashSize;
  34694. if ( json.gapSize !== undefined ) material.gapSize = json.gapSize;
  34695. if ( json.scale !== undefined ) material.scale = json.scale;
  34696. if ( json.polygonOffset !== undefined ) material.polygonOffset = json.polygonOffset;
  34697. if ( json.polygonOffsetFactor !== undefined ) material.polygonOffsetFactor = json.polygonOffsetFactor;
  34698. if ( json.polygonOffsetUnits !== undefined ) material.polygonOffsetUnits = json.polygonOffsetUnits;
  34699. if ( json.dithering !== undefined ) material.dithering = json.dithering;
  34700. if ( json.alphaToCoverage !== undefined ) material.alphaToCoverage = json.alphaToCoverage;
  34701. if ( json.premultipliedAlpha !== undefined ) material.premultipliedAlpha = json.premultipliedAlpha;
  34702. if ( json.forceSinglePass !== undefined ) material.forceSinglePass = json.forceSinglePass;
  34703. if ( json.allowOverride !== undefined ) material.allowOverride = json.allowOverride;
  34704. if ( json.visible !== undefined ) material.visible = json.visible;
  34705. if ( json.toneMapped !== undefined ) material.toneMapped = json.toneMapped;
  34706. if ( json.userData !== undefined ) material.userData = json.userData;
  34707. if ( json.vertexColors !== undefined ) {
  34708. if ( typeof json.vertexColors === 'number' ) {
  34709. material.vertexColors = ( json.vertexColors > 0 ) ? true : false;
  34710. } else {
  34711. material.vertexColors = json.vertexColors;
  34712. }
  34713. }
  34714. // Shader Material
  34715. if ( json.uniforms !== undefined ) {
  34716. for ( const name in json.uniforms ) {
  34717. const uniform = json.uniforms[ name ];
  34718. material.uniforms[ name ] = {};
  34719. switch ( uniform.type ) {
  34720. case 't':
  34721. material.uniforms[ name ].value = getTexture( uniform.value );
  34722. break;
  34723. case 'c':
  34724. material.uniforms[ name ].value = new Color().setHex( uniform.value );
  34725. break;
  34726. case 'v2':
  34727. material.uniforms[ name ].value = new Vector2().fromArray( uniform.value );
  34728. break;
  34729. case 'v3':
  34730. material.uniforms[ name ].value = new Vector3().fromArray( uniform.value );
  34731. break;
  34732. case 'v4':
  34733. material.uniforms[ name ].value = new Vector4().fromArray( uniform.value );
  34734. break;
  34735. case 'm3':
  34736. material.uniforms[ name ].value = new Matrix3().fromArray( uniform.value );
  34737. break;
  34738. case 'm4':
  34739. material.uniforms[ name ].value = new Matrix4().fromArray( uniform.value );
  34740. break;
  34741. default:
  34742. material.uniforms[ name ].value = uniform.value;
  34743. }
  34744. }
  34745. }
  34746. if ( json.defines !== undefined ) material.defines = json.defines;
  34747. if ( json.vertexShader !== undefined ) material.vertexShader = json.vertexShader;
  34748. if ( json.fragmentShader !== undefined ) material.fragmentShader = json.fragmentShader;
  34749. if ( json.glslVersion !== undefined ) material.glslVersion = json.glslVersion;
  34750. if ( json.extensions !== undefined ) {
  34751. for ( const key in json.extensions ) {
  34752. material.extensions[ key ] = json.extensions[ key ];
  34753. }
  34754. }
  34755. if ( json.lights !== undefined ) material.lights = json.lights;
  34756. if ( json.clipping !== undefined ) material.clipping = json.clipping;
  34757. // for PointsMaterial
  34758. if ( json.size !== undefined ) material.size = json.size;
  34759. if ( json.sizeAttenuation !== undefined ) material.sizeAttenuation = json.sizeAttenuation;
  34760. // maps
  34761. if ( json.map !== undefined ) material.map = getTexture( json.map );
  34762. if ( json.matcap !== undefined ) material.matcap = getTexture( json.matcap );
  34763. if ( json.alphaMap !== undefined ) material.alphaMap = getTexture( json.alphaMap );
  34764. if ( json.bumpMap !== undefined ) material.bumpMap = getTexture( json.bumpMap );
  34765. if ( json.bumpScale !== undefined ) material.bumpScale = json.bumpScale;
  34766. if ( json.normalMap !== undefined ) material.normalMap = getTexture( json.normalMap );
  34767. if ( json.normalMapType !== undefined ) material.normalMapType = json.normalMapType;
  34768. if ( json.normalScale !== undefined ) {
  34769. let normalScale = json.normalScale;
  34770. if ( Array.isArray( normalScale ) === false ) {
  34771. // Blender exporter used to export a scalar. See #7459
  34772. normalScale = [ normalScale, normalScale ];
  34773. }
  34774. material.normalScale = new Vector2().fromArray( normalScale );
  34775. }
  34776. if ( json.displacementMap !== undefined ) material.displacementMap = getTexture( json.displacementMap );
  34777. if ( json.displacementScale !== undefined ) material.displacementScale = json.displacementScale;
  34778. if ( json.displacementBias !== undefined ) material.displacementBias = json.displacementBias;
  34779. if ( json.roughnessMap !== undefined ) material.roughnessMap = getTexture( json.roughnessMap );
  34780. if ( json.metalnessMap !== undefined ) material.metalnessMap = getTexture( json.metalnessMap );
  34781. if ( json.emissiveMap !== undefined ) material.emissiveMap = getTexture( json.emissiveMap );
  34782. if ( json.emissiveIntensity !== undefined ) material.emissiveIntensity = json.emissiveIntensity;
  34783. if ( json.specularMap !== undefined ) material.specularMap = getTexture( json.specularMap );
  34784. if ( json.specularIntensityMap !== undefined ) material.specularIntensityMap = getTexture( json.specularIntensityMap );
  34785. if ( json.specularColorMap !== undefined ) material.specularColorMap = getTexture( json.specularColorMap );
  34786. if ( json.envMap !== undefined ) material.envMap = getTexture( json.envMap );
  34787. if ( json.envMapRotation !== undefined ) material.envMapRotation.fromArray( json.envMapRotation );
  34788. if ( json.envMapIntensity !== undefined ) material.envMapIntensity = json.envMapIntensity;
  34789. if ( json.reflectivity !== undefined ) material.reflectivity = json.reflectivity;
  34790. if ( json.refractionRatio !== undefined ) material.refractionRatio = json.refractionRatio;
  34791. if ( json.lightMap !== undefined ) material.lightMap = getTexture( json.lightMap );
  34792. if ( json.lightMapIntensity !== undefined ) material.lightMapIntensity = json.lightMapIntensity;
  34793. if ( json.aoMap !== undefined ) material.aoMap = getTexture( json.aoMap );
  34794. if ( json.aoMapIntensity !== undefined ) material.aoMapIntensity = json.aoMapIntensity;
  34795. if ( json.gradientMap !== undefined ) material.gradientMap = getTexture( json.gradientMap );
  34796. if ( json.clearcoatMap !== undefined ) material.clearcoatMap = getTexture( json.clearcoatMap );
  34797. if ( json.clearcoatRoughnessMap !== undefined ) material.clearcoatRoughnessMap = getTexture( json.clearcoatRoughnessMap );
  34798. if ( json.clearcoatNormalMap !== undefined ) material.clearcoatNormalMap = getTexture( json.clearcoatNormalMap );
  34799. if ( json.clearcoatNormalScale !== undefined ) material.clearcoatNormalScale = new Vector2().fromArray( json.clearcoatNormalScale );
  34800. if ( json.iridescenceMap !== undefined ) material.iridescenceMap = getTexture( json.iridescenceMap );
  34801. if ( json.iridescenceThicknessMap !== undefined ) material.iridescenceThicknessMap = getTexture( json.iridescenceThicknessMap );
  34802. if ( json.transmissionMap !== undefined ) material.transmissionMap = getTexture( json.transmissionMap );
  34803. if ( json.thicknessMap !== undefined ) material.thicknessMap = getTexture( json.thicknessMap );
  34804. if ( json.anisotropyMap !== undefined ) material.anisotropyMap = getTexture( json.anisotropyMap );
  34805. if ( json.sheenColorMap !== undefined ) material.sheenColorMap = getTexture( json.sheenColorMap );
  34806. if ( json.sheenRoughnessMap !== undefined ) material.sheenRoughnessMap = getTexture( json.sheenRoughnessMap );
  34807. return material;
  34808. }
  34809. /**
  34810. * Textures are not embedded in the material JSON so they have
  34811. * to be injected before the loading process starts.
  34812. *
  34813. * @param {Object} value - A dictionary holding textures for material properties.
  34814. * @return {MaterialLoader} A reference to this material loader.
  34815. */
  34816. setTextures( value ) {
  34817. this.textures = value;
  34818. return this;
  34819. }
  34820. /**
  34821. * Creates a material for the given type.
  34822. *
  34823. * @param {string} type - The material type.
  34824. * @return {Material} The new material.
  34825. */
  34826. createMaterialFromType( type ) {
  34827. return MaterialLoader.createMaterialFromType( type );
  34828. }
  34829. /**
  34830. * Creates a material for the given type.
  34831. *
  34832. * @static
  34833. * @param {string} type - The material type.
  34834. * @return {Material} The new material.
  34835. */
  34836. static createMaterialFromType( type ) {
  34837. const materialLib = {
  34838. ShadowMaterial,
  34839. SpriteMaterial,
  34840. RawShaderMaterial,
  34841. ShaderMaterial,
  34842. PointsMaterial,
  34843. MeshPhysicalMaterial,
  34844. MeshStandardMaterial,
  34845. MeshPhongMaterial,
  34846. MeshToonMaterial,
  34847. MeshNormalMaterial,
  34848. MeshLambertMaterial,
  34849. MeshDepthMaterial,
  34850. MeshDistanceMaterial,
  34851. MeshBasicMaterial,
  34852. MeshMatcapMaterial,
  34853. LineDashedMaterial,
  34854. LineBasicMaterial,
  34855. Material
  34856. };
  34857. return new materialLib[ type ]();
  34858. }
  34859. }
  34860. /**
  34861. * A class with loader utility functions.
  34862. */
  34863. class LoaderUtils {
  34864. /**
  34865. * Extracts the base URL from the given URL.
  34866. *
  34867. * @param {string} url -The URL to extract the base URL from.
  34868. * @return {string} The extracted base URL.
  34869. */
  34870. static extractUrlBase( url ) {
  34871. const index = url.lastIndexOf( '/' );
  34872. if ( index === -1 ) return './';
  34873. return url.slice( 0, index + 1 );
  34874. }
  34875. /**
  34876. * Resolves relative URLs against the given path. Absolute paths, data urls,
  34877. * and blob URLs will be returned as is. Invalid URLs will return an empty
  34878. * string.
  34879. *
  34880. * @param {string} url -The URL to resolve.
  34881. * @param {string} path - The base path for relative URLs to be resolved against.
  34882. * @return {string} The resolved URL.
  34883. */
  34884. static resolveURL( url, path ) {
  34885. // Invalid URL
  34886. if ( typeof url !== 'string' || url === '' ) return '';
  34887. // Host Relative URL
  34888. if ( /^https?:\/\//i.test( path ) && /^\//.test( url ) ) {
  34889. path = path.replace( /(^https?:\/\/[^\/]+).*/i, '$1' );
  34890. }
  34891. // Absolute URL http://,https://,//
  34892. if ( /^(https?:)?\/\//i.test( url ) ) return url;
  34893. // Data URI
  34894. if ( /^data:.*,.*$/i.test( url ) ) return url;
  34895. // Blob URL
  34896. if ( /^blob:.*$/i.test( url ) ) return url;
  34897. // Relative URL
  34898. return path + url;
  34899. }
  34900. }
  34901. /**
  34902. * An instanced version of a geometry.
  34903. */
  34904. class InstancedBufferGeometry extends BufferGeometry {
  34905. /**
  34906. * Constructs a new instanced buffer geometry.
  34907. */
  34908. constructor() {
  34909. super();
  34910. /**
  34911. * This flag can be used for type testing.
  34912. *
  34913. * @type {boolean}
  34914. * @readonly
  34915. * @default true
  34916. */
  34917. this.isInstancedBufferGeometry = true;
  34918. this.type = 'InstancedBufferGeometry';
  34919. /**
  34920. * The instance count.
  34921. *
  34922. * @type {number}
  34923. * @default Infinity
  34924. */
  34925. this.instanceCount = Infinity;
  34926. }
  34927. copy( source ) {
  34928. super.copy( source );
  34929. this.instanceCount = source.instanceCount;
  34930. return this;
  34931. }
  34932. toJSON() {
  34933. const data = super.toJSON();
  34934. data.instanceCount = this.instanceCount;
  34935. data.isInstancedBufferGeometry = true;
  34936. return data;
  34937. }
  34938. }
  34939. /**
  34940. * Class for loading geometries. The files are internally
  34941. * loaded via {@link FileLoader}.
  34942. *
  34943. * ```js
  34944. * const loader = new THREE.BufferGeometryLoader();
  34945. * const geometry = await loader.loadAsync( 'models/json/pressure.json' );
  34946. *
  34947. * const material = new THREE.MeshBasicMaterial( { color: 0xF5F5F5 } );
  34948. * const object = new THREE.Mesh( geometry, material );
  34949. * scene.add( object );
  34950. * ```
  34951. *
  34952. * @augments Loader
  34953. */
  34954. class BufferGeometryLoader extends Loader {
  34955. /**
  34956. * Constructs a new geometry loader.
  34957. *
  34958. * @param {LoadingManager} [manager] - The loading manager.
  34959. */
  34960. constructor( manager ) {
  34961. super( manager );
  34962. }
  34963. /**
  34964. * Starts loading from the given URL and pass the loaded geometry to the `onLoad()` callback.
  34965. *
  34966. * @param {string} url - The path/URL of the file to be loaded. This can also be a data URI.
  34967. * @param {function(BufferGeometry)} onLoad - Executed when the loading process has been finished.
  34968. * @param {onProgressCallback} onProgress - Executed while the loading is in progress.
  34969. * @param {onErrorCallback} onError - Executed when errors occur.
  34970. */
  34971. load( url, onLoad, onProgress, onError ) {
  34972. const scope = this;
  34973. const loader = new FileLoader( scope.manager );
  34974. loader.setPath( scope.path );
  34975. loader.setRequestHeader( scope.requestHeader );
  34976. loader.setWithCredentials( scope.withCredentials );
  34977. loader.load( url, function ( text ) {
  34978. try {
  34979. onLoad( scope.parse( JSON.parse( text ) ) );
  34980. } catch ( e ) {
  34981. if ( onError ) {
  34982. onError( e );
  34983. } else {
  34984. error( e );
  34985. }
  34986. scope.manager.itemError( url );
  34987. }
  34988. }, onProgress, onError );
  34989. }
  34990. /**
  34991. * Parses the given JSON object and returns a geometry.
  34992. *
  34993. * @param {Object} json - The serialized geometry.
  34994. * @return {BufferGeometry} The parsed geometry.
  34995. */
  34996. parse( json ) {
  34997. const interleavedBufferMap = {};
  34998. const arrayBufferMap = {};
  34999. function getInterleavedBuffer( json, uuid ) {
  35000. if ( interleavedBufferMap[ uuid ] !== undefined ) return interleavedBufferMap[ uuid ];
  35001. const interleavedBuffers = json.interleavedBuffers;
  35002. const interleavedBuffer = interleavedBuffers[ uuid ];
  35003. const buffer = getArrayBuffer( json, interleavedBuffer.buffer );
  35004. const array = getTypedArray( interleavedBuffer.type, buffer );
  35005. const ib = new InterleavedBuffer( array, interleavedBuffer.stride );
  35006. ib.uuid = interleavedBuffer.uuid;
  35007. interleavedBufferMap[ uuid ] = ib;
  35008. return ib;
  35009. }
  35010. function getArrayBuffer( json, uuid ) {
  35011. if ( arrayBufferMap[ uuid ] !== undefined ) return arrayBufferMap[ uuid ];
  35012. const arrayBuffers = json.arrayBuffers;
  35013. const arrayBuffer = arrayBuffers[ uuid ];
  35014. const ab = new Uint32Array( arrayBuffer ).buffer;
  35015. arrayBufferMap[ uuid ] = ab;
  35016. return ab;
  35017. }
  35018. const geometry = json.isInstancedBufferGeometry ? new InstancedBufferGeometry() : new BufferGeometry();
  35019. const index = json.data.index;
  35020. if ( index !== undefined ) {
  35021. const typedArray = getTypedArray( index.type, index.array );
  35022. geometry.setIndex( new BufferAttribute( typedArray, 1 ) );
  35023. }
  35024. const attributes = json.data.attributes;
  35025. for ( const key in attributes ) {
  35026. const attribute = attributes[ key ];
  35027. let bufferAttribute;
  35028. if ( attribute.isInterleavedBufferAttribute ) {
  35029. const interleavedBuffer = getInterleavedBuffer( json.data, attribute.data );
  35030. bufferAttribute = new InterleavedBufferAttribute( interleavedBuffer, attribute.itemSize, attribute.offset, attribute.normalized );
  35031. } else {
  35032. const typedArray = getTypedArray( attribute.type, attribute.array );
  35033. const bufferAttributeConstr = attribute.isInstancedBufferAttribute ? InstancedBufferAttribute : BufferAttribute;
  35034. bufferAttribute = new bufferAttributeConstr( typedArray, attribute.itemSize, attribute.normalized );
  35035. }
  35036. if ( attribute.name !== undefined ) bufferAttribute.name = attribute.name;
  35037. if ( attribute.usage !== undefined ) bufferAttribute.setUsage( attribute.usage );
  35038. geometry.setAttribute( key, bufferAttribute );
  35039. }
  35040. const morphAttributes = json.data.morphAttributes;
  35041. if ( morphAttributes ) {
  35042. for ( const key in morphAttributes ) {
  35043. const attributeArray = morphAttributes[ key ];
  35044. const array = [];
  35045. for ( let i = 0, il = attributeArray.length; i < il; i ++ ) {
  35046. const attribute = attributeArray[ i ];
  35047. let bufferAttribute;
  35048. if ( attribute.isInterleavedBufferAttribute ) {
  35049. const interleavedBuffer = getInterleavedBuffer( json.data, attribute.data );
  35050. bufferAttribute = new InterleavedBufferAttribute( interleavedBuffer, attribute.itemSize, attribute.offset, attribute.normalized );
  35051. } else {
  35052. const typedArray = getTypedArray( attribute.type, attribute.array );
  35053. bufferAttribute = new BufferAttribute( typedArray, attribute.itemSize, attribute.normalized );
  35054. }
  35055. if ( attribute.name !== undefined ) bufferAttribute.name = attribute.name;
  35056. array.push( bufferAttribute );
  35057. }
  35058. geometry.morphAttributes[ key ] = array;
  35059. }
  35060. }
  35061. const morphTargetsRelative = json.data.morphTargetsRelative;
  35062. if ( morphTargetsRelative ) {
  35063. geometry.morphTargetsRelative = true;
  35064. }
  35065. const groups = json.data.groups || json.data.drawcalls || json.data.offsets;
  35066. if ( groups !== undefined ) {
  35067. for ( let i = 0, n = groups.length; i !== n; ++ i ) {
  35068. const group = groups[ i ];
  35069. geometry.addGroup( group.start, group.count, group.materialIndex );
  35070. }
  35071. }
  35072. const boundingSphere = json.data.boundingSphere;
  35073. if ( boundingSphere !== undefined ) {
  35074. geometry.boundingSphere = new Sphere().fromJSON( boundingSphere );
  35075. }
  35076. if ( json.name ) geometry.name = json.name;
  35077. if ( json.userData ) geometry.userData = json.userData;
  35078. return geometry;
  35079. }
  35080. }
  35081. /**
  35082. * 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).
  35083. * The files are internally loaded via {@link FileLoader}.
  35084. *
  35085. * ```js
  35086. * const loader = new THREE.ObjectLoader();
  35087. * const obj = await loader.loadAsync( 'models/json/example.json' );
  35088. * scene.add( obj );
  35089. *
  35090. * // Alternatively, to parse a previously loaded JSON structure
  35091. * const object = await loader.parseAsync( a_json_object );
  35092. * scene.add( object );
  35093. * ```
  35094. *
  35095. * @augments Loader
  35096. */
  35097. class ObjectLoader extends Loader {
  35098. /**
  35099. * Constructs a new object loader.
  35100. *
  35101. * @param {LoadingManager} [manager] - The loading manager.
  35102. */
  35103. constructor( manager ) {
  35104. super( manager );
  35105. }
  35106. /**
  35107. * Starts loading from the given URL and pass the loaded 3D object to the `onLoad()` callback.
  35108. *
  35109. * @param {string} url - The path/URL of the file to be loaded. This can also be a data URI.
  35110. * @param {function(Object3D)} onLoad - Executed when the loading process has been finished.
  35111. * @param {onProgressCallback} onProgress - Executed while the loading is in progress.
  35112. * @param {onErrorCallback} onError - Executed when errors occur.
  35113. */
  35114. load( url, onLoad, onProgress, onError ) {
  35115. const scope = this;
  35116. const path = ( this.path === '' ) ? LoaderUtils.extractUrlBase( url ) : this.path;
  35117. this.resourcePath = this.resourcePath || path;
  35118. const loader = new FileLoader( this.manager );
  35119. loader.setPath( this.path );
  35120. loader.setRequestHeader( this.requestHeader );
  35121. loader.setWithCredentials( this.withCredentials );
  35122. loader.load( url, function ( text ) {
  35123. let json = null;
  35124. try {
  35125. json = JSON.parse( text );
  35126. } catch ( error ) {
  35127. if ( onError !== undefined ) onError( error );
  35128. error( 'ObjectLoader: Can\'t parse ' + url + '.', error.message );
  35129. return;
  35130. }
  35131. const metadata = json.metadata;
  35132. if ( metadata === undefined || metadata.type === undefined || metadata.type.toLowerCase() === 'geometry' ) {
  35133. if ( onError !== undefined ) onError( new Error( 'THREE.ObjectLoader: Can\'t load ' + url ) );
  35134. error( 'ObjectLoader: Can\'t load ' + url );
  35135. return;
  35136. }
  35137. scope.parse( json, onLoad );
  35138. }, onProgress, onError );
  35139. }
  35140. /**
  35141. * Async version of {@link ObjectLoader#load}.
  35142. *
  35143. * @async
  35144. * @param {string} url - The path/URL of the file to be loaded. This can also be a data URI.
  35145. * @param {onProgressCallback} onProgress - Executed while the loading is in progress.
  35146. * @return {Promise<Object3D>} A Promise that resolves with the loaded 3D object.
  35147. */
  35148. async loadAsync( url, onProgress ) {
  35149. const scope = this;
  35150. const path = ( this.path === '' ) ? LoaderUtils.extractUrlBase( url ) : this.path;
  35151. this.resourcePath = this.resourcePath || path;
  35152. const loader = new FileLoader( this.manager );
  35153. loader.setPath( this.path );
  35154. loader.setRequestHeader( this.requestHeader );
  35155. loader.setWithCredentials( this.withCredentials );
  35156. const text = await loader.loadAsync( url, onProgress );
  35157. const json = JSON.parse( text );
  35158. const metadata = json.metadata;
  35159. if ( metadata === undefined || metadata.type === undefined || metadata.type.toLowerCase() === 'geometry' ) {
  35160. throw new Error( 'THREE.ObjectLoader: Can\'t load ' + url );
  35161. }
  35162. return await scope.parseAsync( json );
  35163. }
  35164. /**
  35165. * Parses the given JSON. This is used internally by {@link ObjectLoader#load}
  35166. * but can also be used directly to parse a previously loaded JSON structure.
  35167. *
  35168. * @param {Object} json - The serialized 3D object.
  35169. * @param {onLoad} onLoad - Executed when all resources (e.g. textures) have been fully loaded.
  35170. * @return {Object3D} The parsed 3D object.
  35171. */
  35172. parse( json, onLoad ) {
  35173. const animations = this.parseAnimations( json.animations );
  35174. const shapes = this.parseShapes( json.shapes );
  35175. const geometries = this.parseGeometries( json.geometries, shapes );
  35176. const images = this.parseImages( json.images, function () {
  35177. if ( onLoad !== undefined ) onLoad( object );
  35178. } );
  35179. const textures = this.parseTextures( json.textures, images );
  35180. const materials = this.parseMaterials( json.materials, textures );
  35181. const object = this.parseObject( json.object, geometries, materials, textures, animations );
  35182. const skeletons = this.parseSkeletons( json.skeletons, object );
  35183. this.bindSkeletons( object, skeletons );
  35184. this.bindLightTargets( object );
  35185. //
  35186. if ( onLoad !== undefined ) {
  35187. let hasImages = false;
  35188. for ( const uuid in images ) {
  35189. if ( images[ uuid ].data instanceof HTMLImageElement ) {
  35190. hasImages = true;
  35191. break;
  35192. }
  35193. }
  35194. if ( hasImages === false ) onLoad( object );
  35195. }
  35196. return object;
  35197. }
  35198. /**
  35199. * Async version of {@link ObjectLoader#parse}.
  35200. *
  35201. * @param {Object} json - The serialized 3D object.
  35202. * @return {Promise<Object3D>} A Promise that resolves with the parsed 3D object.
  35203. */
  35204. async parseAsync( json ) {
  35205. const animations = this.parseAnimations( json.animations );
  35206. const shapes = this.parseShapes( json.shapes );
  35207. const geometries = this.parseGeometries( json.geometries, shapes );
  35208. const images = await this.parseImagesAsync( json.images );
  35209. const textures = this.parseTextures( json.textures, images );
  35210. const materials = this.parseMaterials( json.materials, textures );
  35211. const object = this.parseObject( json.object, geometries, materials, textures, animations );
  35212. const skeletons = this.parseSkeletons( json.skeletons, object );
  35213. this.bindSkeletons( object, skeletons );
  35214. this.bindLightTargets( object );
  35215. return object;
  35216. }
  35217. // internals
  35218. parseShapes( json ) {
  35219. const shapes = {};
  35220. if ( json !== undefined ) {
  35221. for ( let i = 0, l = json.length; i < l; i ++ ) {
  35222. const shape = new Shape().fromJSON( json[ i ] );
  35223. shapes[ shape.uuid ] = shape;
  35224. }
  35225. }
  35226. return shapes;
  35227. }
  35228. parseSkeletons( json, object ) {
  35229. const skeletons = {};
  35230. const bones = {};
  35231. // generate bone lookup table
  35232. object.traverse( function ( child ) {
  35233. if ( child.isBone ) bones[ child.uuid ] = child;
  35234. } );
  35235. // create skeletons
  35236. if ( json !== undefined ) {
  35237. for ( let i = 0, l = json.length; i < l; i ++ ) {
  35238. const skeleton = new Skeleton().fromJSON( json[ i ], bones );
  35239. skeletons[ skeleton.uuid ] = skeleton;
  35240. }
  35241. }
  35242. return skeletons;
  35243. }
  35244. parseGeometries( json, shapes ) {
  35245. const geometries = {};
  35246. if ( json !== undefined ) {
  35247. const bufferGeometryLoader = new BufferGeometryLoader();
  35248. for ( let i = 0, l = json.length; i < l; i ++ ) {
  35249. let geometry;
  35250. const data = json[ i ];
  35251. switch ( data.type ) {
  35252. case 'BufferGeometry':
  35253. case 'InstancedBufferGeometry':
  35254. geometry = bufferGeometryLoader.parse( data );
  35255. break;
  35256. default:
  35257. if ( data.type in Geometries ) {
  35258. geometry = Geometries[ data.type ].fromJSON( data, shapes );
  35259. } else {
  35260. warn( `ObjectLoader: Unsupported geometry type "${ data.type }"` );
  35261. }
  35262. }
  35263. geometry.uuid = data.uuid;
  35264. if ( data.name !== undefined ) geometry.name = data.name;
  35265. if ( data.userData !== undefined ) geometry.userData = data.userData;
  35266. geometries[ data.uuid ] = geometry;
  35267. }
  35268. }
  35269. return geometries;
  35270. }
  35271. parseMaterials( json, textures ) {
  35272. const cache = {}; // MultiMaterial
  35273. const materials = {};
  35274. if ( json !== undefined ) {
  35275. const loader = new MaterialLoader();
  35276. loader.setTextures( textures );
  35277. for ( let i = 0, l = json.length; i < l; i ++ ) {
  35278. const data = json[ i ];
  35279. if ( cache[ data.uuid ] === undefined ) {
  35280. cache[ data.uuid ] = loader.parse( data );
  35281. }
  35282. materials[ data.uuid ] = cache[ data.uuid ];
  35283. }
  35284. }
  35285. return materials;
  35286. }
  35287. parseAnimations( json ) {
  35288. const animations = {};
  35289. if ( json !== undefined ) {
  35290. for ( let i = 0; i < json.length; i ++ ) {
  35291. const data = json[ i ];
  35292. const clip = AnimationClip.parse( data );
  35293. animations[ clip.uuid ] = clip;
  35294. }
  35295. }
  35296. return animations;
  35297. }
  35298. parseImages( json, onLoad ) {
  35299. const scope = this;
  35300. const images = {};
  35301. let loader;
  35302. function loadImage( url ) {
  35303. scope.manager.itemStart( url );
  35304. return loader.load( url, function () {
  35305. scope.manager.itemEnd( url );
  35306. }, undefined, function () {
  35307. scope.manager.itemError( url );
  35308. scope.manager.itemEnd( url );
  35309. } );
  35310. }
  35311. function deserializeImage( image ) {
  35312. if ( typeof image === 'string' ) {
  35313. const url = image;
  35314. const path = /^(\/\/)|([a-z]+:(\/\/)?)/i.test( url ) ? url : scope.resourcePath + url;
  35315. return loadImage( path );
  35316. } else {
  35317. if ( image.data ) {
  35318. return {
  35319. data: getTypedArray( image.type, image.data ),
  35320. width: image.width,
  35321. height: image.height
  35322. };
  35323. } else {
  35324. return null;
  35325. }
  35326. }
  35327. }
  35328. if ( json !== undefined && json.length > 0 ) {
  35329. const manager = new LoadingManager( onLoad );
  35330. loader = new ImageLoader( manager );
  35331. loader.setCrossOrigin( this.crossOrigin );
  35332. for ( let i = 0, il = json.length; i < il; i ++ ) {
  35333. const image = json[ i ];
  35334. const url = image.url;
  35335. if ( Array.isArray( url ) ) {
  35336. // load array of images e.g CubeTexture
  35337. const imageArray = [];
  35338. for ( let j = 0, jl = url.length; j < jl; j ++ ) {
  35339. const currentUrl = url[ j ];
  35340. const deserializedImage = deserializeImage( currentUrl );
  35341. if ( deserializedImage !== null ) {
  35342. if ( deserializedImage instanceof HTMLImageElement ) {
  35343. imageArray.push( deserializedImage );
  35344. } else {
  35345. // special case: handle array of data textures for cube textures
  35346. imageArray.push( new DataTexture( deserializedImage.data, deserializedImage.width, deserializedImage.height ) );
  35347. }
  35348. }
  35349. }
  35350. images[ image.uuid ] = new Source( imageArray );
  35351. } else {
  35352. // load single image
  35353. const deserializedImage = deserializeImage( image.url );
  35354. images[ image.uuid ] = new Source( deserializedImage );
  35355. }
  35356. }
  35357. }
  35358. return images;
  35359. }
  35360. async parseImagesAsync( json ) {
  35361. const scope = this;
  35362. const images = {};
  35363. let loader;
  35364. async function deserializeImage( image ) {
  35365. if ( typeof image === 'string' ) {
  35366. const url = image;
  35367. const path = /^(\/\/)|([a-z]+:(\/\/)?)/i.test( url ) ? url : scope.resourcePath + url;
  35368. return await loader.loadAsync( path );
  35369. } else {
  35370. if ( image.data ) {
  35371. return {
  35372. data: getTypedArray( image.type, image.data ),
  35373. width: image.width,
  35374. height: image.height
  35375. };
  35376. } else {
  35377. return null;
  35378. }
  35379. }
  35380. }
  35381. if ( json !== undefined && json.length > 0 ) {
  35382. loader = new ImageLoader( this.manager );
  35383. loader.setCrossOrigin( this.crossOrigin );
  35384. for ( let i = 0, il = json.length; i < il; i ++ ) {
  35385. const image = json[ i ];
  35386. const url = image.url;
  35387. if ( Array.isArray( url ) ) {
  35388. // load array of images e.g CubeTexture
  35389. const imageArray = [];
  35390. for ( let j = 0, jl = url.length; j < jl; j ++ ) {
  35391. const currentUrl = url[ j ];
  35392. const deserializedImage = await deserializeImage( currentUrl );
  35393. if ( deserializedImage !== null ) {
  35394. if ( deserializedImage instanceof HTMLImageElement ) {
  35395. imageArray.push( deserializedImage );
  35396. } else {
  35397. // special case: handle array of data textures for cube textures
  35398. imageArray.push( new DataTexture( deserializedImage.data, deserializedImage.width, deserializedImage.height ) );
  35399. }
  35400. }
  35401. }
  35402. images[ image.uuid ] = new Source( imageArray );
  35403. } else {
  35404. // load single image
  35405. const deserializedImage = await deserializeImage( image.url );
  35406. images[ image.uuid ] = new Source( deserializedImage );
  35407. }
  35408. }
  35409. }
  35410. return images;
  35411. }
  35412. parseTextures( json, images ) {
  35413. function parseConstant( value, type ) {
  35414. if ( typeof value === 'number' ) return value;
  35415. warn( 'ObjectLoader.parseTexture: Constant should be in numeric form.', value );
  35416. return type[ value ];
  35417. }
  35418. const textures = {};
  35419. if ( json !== undefined ) {
  35420. for ( let i = 0, l = json.length; i < l; i ++ ) {
  35421. const data = json[ i ];
  35422. if ( data.image === undefined ) {
  35423. warn( 'ObjectLoader: No "image" specified for', data.uuid );
  35424. }
  35425. if ( images[ data.image ] === undefined ) {
  35426. warn( 'ObjectLoader: Undefined image', data.image );
  35427. }
  35428. const source = images[ data.image ];
  35429. const image = source.data;
  35430. let texture;
  35431. if ( Array.isArray( image ) ) {
  35432. texture = new CubeTexture();
  35433. if ( image.length === 6 ) texture.needsUpdate = true;
  35434. } else {
  35435. if ( image && image.data ) {
  35436. texture = new DataTexture();
  35437. } else {
  35438. texture = new Texture();
  35439. }
  35440. if ( image ) texture.needsUpdate = true; // textures can have undefined image data
  35441. }
  35442. texture.source = source;
  35443. texture.uuid = data.uuid;
  35444. if ( data.name !== undefined ) texture.name = data.name;
  35445. if ( data.mapping !== undefined ) texture.mapping = parseConstant( data.mapping, TEXTURE_MAPPING );
  35446. if ( data.channel !== undefined ) texture.channel = data.channel;
  35447. if ( data.offset !== undefined ) texture.offset.fromArray( data.offset );
  35448. if ( data.repeat !== undefined ) texture.repeat.fromArray( data.repeat );
  35449. if ( data.center !== undefined ) texture.center.fromArray( data.center );
  35450. if ( data.rotation !== undefined ) texture.rotation = data.rotation;
  35451. if ( data.wrap !== undefined ) {
  35452. texture.wrapS = parseConstant( data.wrap[ 0 ], TEXTURE_WRAPPING );
  35453. texture.wrapT = parseConstant( data.wrap[ 1 ], TEXTURE_WRAPPING );
  35454. }
  35455. if ( data.format !== undefined ) texture.format = data.format;
  35456. if ( data.internalFormat !== undefined ) texture.internalFormat = data.internalFormat;
  35457. if ( data.type !== undefined ) texture.type = data.type;
  35458. if ( data.colorSpace !== undefined ) texture.colorSpace = data.colorSpace;
  35459. if ( data.minFilter !== undefined ) texture.minFilter = parseConstant( data.minFilter, TEXTURE_FILTER );
  35460. if ( data.magFilter !== undefined ) texture.magFilter = parseConstant( data.magFilter, TEXTURE_FILTER );
  35461. if ( data.anisotropy !== undefined ) texture.anisotropy = data.anisotropy;
  35462. if ( data.flipY !== undefined ) texture.flipY = data.flipY;
  35463. if ( data.generateMipmaps !== undefined ) texture.generateMipmaps = data.generateMipmaps;
  35464. if ( data.premultiplyAlpha !== undefined ) texture.premultiplyAlpha = data.premultiplyAlpha;
  35465. if ( data.unpackAlignment !== undefined ) texture.unpackAlignment = data.unpackAlignment;
  35466. if ( data.compareFunction !== undefined ) texture.compareFunction = data.compareFunction;
  35467. if ( data.userData !== undefined ) texture.userData = data.userData;
  35468. textures[ data.uuid ] = texture;
  35469. }
  35470. }
  35471. return textures;
  35472. }
  35473. parseObject( data, geometries, materials, textures, animations ) {
  35474. let object;
  35475. function getGeometry( name ) {
  35476. if ( geometries[ name ] === undefined ) {
  35477. warn( 'ObjectLoader: Undefined geometry', name );
  35478. }
  35479. return geometries[ name ];
  35480. }
  35481. function getMaterial( name ) {
  35482. if ( name === undefined ) return undefined;
  35483. if ( Array.isArray( name ) ) {
  35484. const array = [];
  35485. for ( let i = 0, l = name.length; i < l; i ++ ) {
  35486. const uuid = name[ i ];
  35487. if ( materials[ uuid ] === undefined ) {
  35488. warn( 'ObjectLoader: Undefined material', uuid );
  35489. }
  35490. array.push( materials[ uuid ] );
  35491. }
  35492. return array;
  35493. }
  35494. if ( materials[ name ] === undefined ) {
  35495. warn( 'ObjectLoader: Undefined material', name );
  35496. }
  35497. return materials[ name ];
  35498. }
  35499. function getTexture( uuid ) {
  35500. if ( textures[ uuid ] === undefined ) {
  35501. warn( 'ObjectLoader: Undefined texture', uuid );
  35502. }
  35503. return textures[ uuid ];
  35504. }
  35505. let geometry, material;
  35506. switch ( data.type ) {
  35507. case 'Scene':
  35508. object = new Scene();
  35509. if ( data.background !== undefined ) {
  35510. if ( Number.isInteger( data.background ) ) {
  35511. object.background = new Color( data.background );
  35512. } else {
  35513. object.background = getTexture( data.background );
  35514. }
  35515. }
  35516. if ( data.environment !== undefined ) {
  35517. object.environment = getTexture( data.environment );
  35518. }
  35519. if ( data.fog !== undefined ) {
  35520. if ( data.fog.type === 'Fog' ) {
  35521. object.fog = new Fog( data.fog.color, data.fog.near, data.fog.far );
  35522. } else if ( data.fog.type === 'FogExp2' ) {
  35523. object.fog = new FogExp2( data.fog.color, data.fog.density );
  35524. }
  35525. if ( data.fog.name !== '' ) {
  35526. object.fog.name = data.fog.name;
  35527. }
  35528. }
  35529. if ( data.backgroundBlurriness !== undefined ) object.backgroundBlurriness = data.backgroundBlurriness;
  35530. if ( data.backgroundIntensity !== undefined ) object.backgroundIntensity = data.backgroundIntensity;
  35531. if ( data.backgroundRotation !== undefined ) object.backgroundRotation.fromArray( data.backgroundRotation );
  35532. if ( data.environmentIntensity !== undefined ) object.environmentIntensity = data.environmentIntensity;
  35533. if ( data.environmentRotation !== undefined ) object.environmentRotation.fromArray( data.environmentRotation );
  35534. break;
  35535. case 'PerspectiveCamera':
  35536. object = new PerspectiveCamera( data.fov, data.aspect, data.near, data.far );
  35537. if ( data.focus !== undefined ) object.focus = data.focus;
  35538. if ( data.zoom !== undefined ) object.zoom = data.zoom;
  35539. if ( data.filmGauge !== undefined ) object.filmGauge = data.filmGauge;
  35540. if ( data.filmOffset !== undefined ) object.filmOffset = data.filmOffset;
  35541. if ( data.view !== undefined ) object.view = Object.assign( {}, data.view );
  35542. break;
  35543. case 'OrthographicCamera':
  35544. object = new OrthographicCamera( data.left, data.right, data.top, data.bottom, data.near, data.far );
  35545. if ( data.zoom !== undefined ) object.zoom = data.zoom;
  35546. if ( data.view !== undefined ) object.view = Object.assign( {}, data.view );
  35547. break;
  35548. case 'AmbientLight':
  35549. object = new AmbientLight( data.color, data.intensity );
  35550. break;
  35551. case 'DirectionalLight':
  35552. object = new DirectionalLight( data.color, data.intensity );
  35553. object.target = data.target || '';
  35554. break;
  35555. case 'PointLight':
  35556. object = new PointLight( data.color, data.intensity, data.distance, data.decay );
  35557. break;
  35558. case 'RectAreaLight':
  35559. object = new RectAreaLight( data.color, data.intensity, data.width, data.height );
  35560. break;
  35561. case 'SpotLight':
  35562. object = new SpotLight( data.color, data.intensity, data.distance, data.angle, data.penumbra, data.decay );
  35563. object.target = data.target || '';
  35564. break;
  35565. case 'HemisphereLight':
  35566. object = new HemisphereLight( data.color, data.groundColor, data.intensity );
  35567. break;
  35568. case 'LightProbe':
  35569. const sh = new SphericalHarmonics3().fromArray( data.sh );
  35570. object = new LightProbe( sh, data.intensity );
  35571. break;
  35572. case 'SkinnedMesh':
  35573. geometry = getGeometry( data.geometry );
  35574. material = getMaterial( data.material );
  35575. object = new SkinnedMesh( geometry, material );
  35576. if ( data.bindMode !== undefined ) object.bindMode = data.bindMode;
  35577. if ( data.bindMatrix !== undefined ) object.bindMatrix.fromArray( data.bindMatrix );
  35578. if ( data.skeleton !== undefined ) object.skeleton = data.skeleton;
  35579. break;
  35580. case 'Mesh':
  35581. geometry = getGeometry( data.geometry );
  35582. material = getMaterial( data.material );
  35583. object = new Mesh( geometry, material );
  35584. break;
  35585. case 'InstancedMesh':
  35586. geometry = getGeometry( data.geometry );
  35587. material = getMaterial( data.material );
  35588. const count = data.count;
  35589. const instanceMatrix = data.instanceMatrix;
  35590. const instanceColor = data.instanceColor;
  35591. object = new InstancedMesh( geometry, material, count );
  35592. object.instanceMatrix = new InstancedBufferAttribute( new Float32Array( instanceMatrix.array ), 16 );
  35593. if ( instanceColor !== undefined ) object.instanceColor = new InstancedBufferAttribute( new Float32Array( instanceColor.array ), instanceColor.itemSize );
  35594. break;
  35595. case 'BatchedMesh':
  35596. geometry = getGeometry( data.geometry );
  35597. material = getMaterial( data.material );
  35598. object = new BatchedMesh( data.maxInstanceCount, data.maxVertexCount, data.maxIndexCount, material );
  35599. object.geometry = geometry;
  35600. object.perObjectFrustumCulled = data.perObjectFrustumCulled;
  35601. object.sortObjects = data.sortObjects;
  35602. object._drawRanges = data.drawRanges;
  35603. object._reservedRanges = data.reservedRanges;
  35604. object._geometryInfo = data.geometryInfo.map( info => {
  35605. let box = null;
  35606. let sphere = null;
  35607. if ( info.boundingBox !== undefined ) {
  35608. box = new Box3().fromJSON( info.boundingBox );
  35609. }
  35610. if ( info.boundingSphere !== undefined ) {
  35611. sphere = new Sphere().fromJSON( info.boundingSphere );
  35612. }
  35613. return {
  35614. ...info,
  35615. boundingBox: box,
  35616. boundingSphere: sphere
  35617. };
  35618. } );
  35619. object._instanceInfo = data.instanceInfo;
  35620. object._availableInstanceIds = data._availableInstanceIds;
  35621. object._availableGeometryIds = data._availableGeometryIds;
  35622. object._nextIndexStart = data.nextIndexStart;
  35623. object._nextVertexStart = data.nextVertexStart;
  35624. object._geometryCount = data.geometryCount;
  35625. object._maxInstanceCount = data.maxInstanceCount;
  35626. object._maxVertexCount = data.maxVertexCount;
  35627. object._maxIndexCount = data.maxIndexCount;
  35628. object._geometryInitialized = data.geometryInitialized;
  35629. object._matricesTexture = getTexture( data.matricesTexture.uuid );
  35630. object._indirectTexture = getTexture( data.indirectTexture.uuid );
  35631. if ( data.colorsTexture !== undefined ) {
  35632. object._colorsTexture = getTexture( data.colorsTexture.uuid );
  35633. }
  35634. if ( data.boundingSphere !== undefined ) {
  35635. object.boundingSphere = new Sphere().fromJSON( data.boundingSphere );
  35636. }
  35637. if ( data.boundingBox !== undefined ) {
  35638. object.boundingBox = new Box3().fromJSON( data.boundingBox );
  35639. }
  35640. break;
  35641. case 'LOD':
  35642. object = new LOD();
  35643. break;
  35644. case 'Line':
  35645. object = new Line( getGeometry( data.geometry ), getMaterial( data.material ) );
  35646. break;
  35647. case 'LineLoop':
  35648. object = new LineLoop( getGeometry( data.geometry ), getMaterial( data.material ) );
  35649. break;
  35650. case 'LineSegments':
  35651. object = new LineSegments( getGeometry( data.geometry ), getMaterial( data.material ) );
  35652. break;
  35653. case 'PointCloud':
  35654. case 'Points':
  35655. object = new Points( getGeometry( data.geometry ), getMaterial( data.material ) );
  35656. break;
  35657. case 'Sprite':
  35658. object = new Sprite( getMaterial( data.material ) );
  35659. break;
  35660. case 'Group':
  35661. object = new Group();
  35662. break;
  35663. case 'Bone':
  35664. object = new Bone();
  35665. break;
  35666. default:
  35667. object = new Object3D();
  35668. }
  35669. object.uuid = data.uuid;
  35670. if ( data.name !== undefined ) object.name = data.name;
  35671. if ( data.matrix !== undefined ) {
  35672. object.matrix.fromArray( data.matrix );
  35673. if ( data.matrixAutoUpdate !== undefined ) object.matrixAutoUpdate = data.matrixAutoUpdate;
  35674. if ( object.matrixAutoUpdate ) object.matrix.decompose( object.position, object.quaternion, object.scale );
  35675. } else {
  35676. if ( data.position !== undefined ) object.position.fromArray( data.position );
  35677. if ( data.rotation !== undefined ) object.rotation.fromArray( data.rotation );
  35678. if ( data.quaternion !== undefined ) object.quaternion.fromArray( data.quaternion );
  35679. if ( data.scale !== undefined ) object.scale.fromArray( data.scale );
  35680. }
  35681. if ( data.up !== undefined ) object.up.fromArray( data.up );
  35682. if ( data.castShadow !== undefined ) object.castShadow = data.castShadow;
  35683. if ( data.receiveShadow !== undefined ) object.receiveShadow = data.receiveShadow;
  35684. if ( data.shadow ) {
  35685. if ( data.shadow.intensity !== undefined ) object.shadow.intensity = data.shadow.intensity;
  35686. if ( data.shadow.bias !== undefined ) object.shadow.bias = data.shadow.bias;
  35687. if ( data.shadow.normalBias !== undefined ) object.shadow.normalBias = data.shadow.normalBias;
  35688. if ( data.shadow.radius !== undefined ) object.shadow.radius = data.shadow.radius;
  35689. if ( data.shadow.mapSize !== undefined ) object.shadow.mapSize.fromArray( data.shadow.mapSize );
  35690. if ( data.shadow.camera !== undefined ) object.shadow.camera = this.parseObject( data.shadow.camera );
  35691. }
  35692. if ( data.visible !== undefined ) object.visible = data.visible;
  35693. if ( data.frustumCulled !== undefined ) object.frustumCulled = data.frustumCulled;
  35694. if ( data.renderOrder !== undefined ) object.renderOrder = data.renderOrder;
  35695. if ( data.userData !== undefined ) object.userData = data.userData;
  35696. if ( data.layers !== undefined ) object.layers.mask = data.layers;
  35697. if ( data.children !== undefined ) {
  35698. const children = data.children;
  35699. for ( let i = 0; i < children.length; i ++ ) {
  35700. object.add( this.parseObject( children[ i ], geometries, materials, textures, animations ) );
  35701. }
  35702. }
  35703. if ( data.animations !== undefined ) {
  35704. const objectAnimations = data.animations;
  35705. for ( let i = 0; i < objectAnimations.length; i ++ ) {
  35706. const uuid = objectAnimations[ i ];
  35707. object.animations.push( animations[ uuid ] );
  35708. }
  35709. }
  35710. if ( data.type === 'LOD' ) {
  35711. if ( data.autoUpdate !== undefined ) object.autoUpdate = data.autoUpdate;
  35712. const levels = data.levels;
  35713. for ( let l = 0; l < levels.length; l ++ ) {
  35714. const level = levels[ l ];
  35715. const child = object.getObjectByProperty( 'uuid', level.object );
  35716. if ( child !== undefined ) {
  35717. object.addLevel( child, level.distance, level.hysteresis );
  35718. }
  35719. }
  35720. }
  35721. return object;
  35722. }
  35723. bindSkeletons( object, skeletons ) {
  35724. if ( Object.keys( skeletons ).length === 0 ) return;
  35725. object.traverse( function ( child ) {
  35726. if ( child.isSkinnedMesh === true && child.skeleton !== undefined ) {
  35727. const skeleton = skeletons[ child.skeleton ];
  35728. if ( skeleton === undefined ) {
  35729. warn( 'ObjectLoader: No skeleton found with UUID:', child.skeleton );
  35730. } else {
  35731. child.bind( skeleton, child.bindMatrix );
  35732. }
  35733. }
  35734. } );
  35735. }
  35736. bindLightTargets( object ) {
  35737. object.traverse( function ( child ) {
  35738. if ( child.isDirectionalLight || child.isSpotLight ) {
  35739. const uuid = child.target;
  35740. const target = object.getObjectByProperty( 'uuid', uuid );
  35741. if ( target !== undefined ) {
  35742. child.target = target;
  35743. } else {
  35744. child.target = new Object3D();
  35745. }
  35746. }
  35747. } );
  35748. }
  35749. }
  35750. const TEXTURE_MAPPING = {
  35751. UVMapping: UVMapping,
  35752. CubeReflectionMapping: CubeReflectionMapping,
  35753. CubeRefractionMapping: CubeRefractionMapping,
  35754. EquirectangularReflectionMapping: EquirectangularReflectionMapping,
  35755. EquirectangularRefractionMapping: EquirectangularRefractionMapping,
  35756. CubeUVReflectionMapping: CubeUVReflectionMapping
  35757. };
  35758. const TEXTURE_WRAPPING = {
  35759. RepeatWrapping: RepeatWrapping,
  35760. ClampToEdgeWrapping: ClampToEdgeWrapping,
  35761. MirroredRepeatWrapping: MirroredRepeatWrapping
  35762. };
  35763. const TEXTURE_FILTER = {
  35764. NearestFilter: NearestFilter,
  35765. NearestMipmapNearestFilter: NearestMipmapNearestFilter,
  35766. NearestMipmapLinearFilter: NearestMipmapLinearFilter,
  35767. LinearFilter: LinearFilter,
  35768. LinearMipmapNearestFilter: LinearMipmapNearestFilter,
  35769. LinearMipmapLinearFilter: LinearMipmapLinearFilter
  35770. };
  35771. const _errorMap = new WeakMap();
  35772. /**
  35773. * A loader for loading images as an [ImageBitmap](https://developer.mozilla.org/en-US/docs/Web/API/ImageBitmap).
  35774. * An `ImageBitmap` provides an asynchronous and resource efficient pathway to prepare
  35775. * textures for rendering.
  35776. *
  35777. * Note that {@link Texture#flipY} and {@link Texture#premultiplyAlpha} are ignored with image bitmaps.
  35778. * These options need to be configured via {@link ImageBitmapLoader#setOptions} prior to loading,
  35779. * unlike regular images which can be configured on the Texture to set these options on GPU upload instead.
  35780. *
  35781. * To match the default behaviour of {@link Texture}, the following options are needed:
  35782. *
  35783. * ```js
  35784. * { imageOrientation: 'flipY', premultiplyAlpha: 'none' }
  35785. * ```
  35786. *
  35787. * Also note that unlike {@link FileLoader}, this loader will only avoid multiple concurrent requests to the same URL if {@link Cache} is enabled.
  35788. *
  35789. * ```js
  35790. * const loader = new THREE.ImageBitmapLoader();
  35791. * loader.setOptions( { imageOrientation: 'flipY' } ); // set options if needed
  35792. * const imageBitmap = await loader.loadAsync( 'image.png' );
  35793. *
  35794. * const texture = new THREE.Texture( imageBitmap );
  35795. * texture.needsUpdate = true;
  35796. * ```
  35797. *
  35798. * @augments Loader
  35799. */
  35800. class ImageBitmapLoader extends Loader {
  35801. /**
  35802. * Constructs a new image bitmap loader.
  35803. *
  35804. * @param {LoadingManager} [manager] - The loading manager.
  35805. */
  35806. constructor( manager ) {
  35807. super( manager );
  35808. /**
  35809. * This flag can be used for type testing.
  35810. *
  35811. * @type {boolean}
  35812. * @readonly
  35813. * @default true
  35814. */
  35815. this.isImageBitmapLoader = true;
  35816. if ( typeof createImageBitmap === 'undefined' ) {
  35817. warn( 'ImageBitmapLoader: createImageBitmap() not supported.' );
  35818. }
  35819. if ( typeof fetch === 'undefined' ) {
  35820. warn( 'ImageBitmapLoader: fetch() not supported.' );
  35821. }
  35822. /**
  35823. * Represents the loader options.
  35824. *
  35825. * @type {Object}
  35826. * @default {premultiplyAlpha:'none'}
  35827. */
  35828. this.options = { premultiplyAlpha: 'none' };
  35829. /**
  35830. * Used for aborting requests.
  35831. *
  35832. * @private
  35833. * @type {AbortController}
  35834. */
  35835. this._abortController = new AbortController();
  35836. }
  35837. /**
  35838. * Sets the given loader options. The structure of the object must match the `options` parameter of
  35839. * [createImageBitmap](https://developer.mozilla.org/en-US/docs/Web/API/Window/createImageBitmap).
  35840. *
  35841. * @param {Object} options - The loader options to set.
  35842. * @return {ImageBitmapLoader} A reference to this image bitmap loader.
  35843. */
  35844. setOptions( options ) {
  35845. this.options = options;
  35846. return this;
  35847. }
  35848. /**
  35849. * Starts loading from the given URL and pass the loaded image bitmap to the `onLoad()` callback.
  35850. *
  35851. * @param {string} url - The path/URL of the file to be loaded. This can also be a data URI.
  35852. * @param {function(ImageBitmap)} onLoad - Executed when the loading process has been finished.
  35853. * @param {onProgressCallback} onProgress - Unsupported in this loader.
  35854. * @param {onErrorCallback} onError - Executed when errors occur.
  35855. * @return {ImageBitmap|undefined} The image bitmap.
  35856. */
  35857. load( url, onLoad, onProgress, onError ) {
  35858. if ( url === undefined ) url = '';
  35859. if ( this.path !== undefined ) url = this.path + url;
  35860. url = this.manager.resolveURL( url );
  35861. const scope = this;
  35862. const cached = Cache.get( `image-bitmap:${url}` );
  35863. if ( cached !== undefined ) {
  35864. scope.manager.itemStart( url );
  35865. // If cached is a promise, wait for it to resolve
  35866. if ( cached.then ) {
  35867. cached.then( imageBitmap => {
  35868. // check if there is an error for the cached promise
  35869. if ( _errorMap.has( cached ) === true ) {
  35870. if ( onError ) onError( _errorMap.get( cached ) );
  35871. scope.manager.itemError( url );
  35872. scope.manager.itemEnd( url );
  35873. } else {
  35874. if ( onLoad ) onLoad( imageBitmap );
  35875. scope.manager.itemEnd( url );
  35876. return imageBitmap;
  35877. }
  35878. } );
  35879. return;
  35880. }
  35881. // If cached is not a promise (i.e., it's already an imageBitmap)
  35882. setTimeout( function () {
  35883. if ( onLoad ) onLoad( cached );
  35884. scope.manager.itemEnd( url );
  35885. }, 0 );
  35886. return cached;
  35887. }
  35888. const fetchOptions = {};
  35889. fetchOptions.credentials = ( this.crossOrigin === 'anonymous' ) ? 'same-origin' : 'include';
  35890. fetchOptions.headers = this.requestHeader;
  35891. fetchOptions.signal = ( typeof AbortSignal.any === 'function' ) ? AbortSignal.any( [ this._abortController.signal, this.manager.abortController.signal ] ) : this._abortController.signal;
  35892. const promise = fetch( url, fetchOptions ).then( function ( res ) {
  35893. return res.blob();
  35894. } ).then( function ( blob ) {
  35895. return createImageBitmap( blob, Object.assign( scope.options, { colorSpaceConversion: 'none' } ) );
  35896. } ).then( function ( imageBitmap ) {
  35897. Cache.add( `image-bitmap:${url}`, imageBitmap );
  35898. if ( onLoad ) onLoad( imageBitmap );
  35899. scope.manager.itemEnd( url );
  35900. return imageBitmap;
  35901. } ).catch( function ( e ) {
  35902. if ( onError ) onError( e );
  35903. _errorMap.set( promise, e );
  35904. Cache.remove( `image-bitmap:${url}` );
  35905. scope.manager.itemError( url );
  35906. scope.manager.itemEnd( url );
  35907. } );
  35908. Cache.add( `image-bitmap:${url}`, promise );
  35909. scope.manager.itemStart( url );
  35910. }
  35911. /**
  35912. * Aborts ongoing fetch requests.
  35913. *
  35914. * @return {ImageBitmapLoader} A reference to this instance.
  35915. */
  35916. abort() {
  35917. this._abortController.abort();
  35918. this._abortController = new AbortController();
  35919. return this;
  35920. }
  35921. }
  35922. let _context;
  35923. /**
  35924. * Manages the global audio context in the engine.
  35925. *
  35926. * @hideconstructor
  35927. */
  35928. class AudioContext {
  35929. /**
  35930. * Returns the global native audio context.
  35931. *
  35932. * @return {AudioContext} The native audio context.
  35933. */
  35934. static getContext() {
  35935. if ( _context === undefined ) {
  35936. _context = new ( window.AudioContext || window.webkitAudioContext )();
  35937. }
  35938. return _context;
  35939. }
  35940. /**
  35941. * Allows to set the global native audio context from outside.
  35942. *
  35943. * @param {AudioContext} value - The native context to set.
  35944. */
  35945. static setContext( value ) {
  35946. _context = value;
  35947. }
  35948. }
  35949. /**
  35950. * Class for loading audio buffers. Audios are internally
  35951. * loaded via {@link FileLoader}.
  35952. *
  35953. * ```js
  35954. * const audioListener = new THREE.AudioListener();
  35955. * const ambientSound = new THREE.Audio( audioListener );
  35956. *
  35957. * const loader = new THREE.AudioLoader();
  35958. * const audioBuffer = await loader.loadAsync( 'audio/ambient_ocean.ogg' );
  35959. *
  35960. * ambientSound.setBuffer( audioBuffer );
  35961. * ambientSound.play();
  35962. * ```
  35963. *
  35964. * @augments Loader
  35965. */
  35966. class AudioLoader extends Loader {
  35967. /**
  35968. * Constructs a new audio loader.
  35969. *
  35970. * @param {LoadingManager} [manager] - The loading manager.
  35971. */
  35972. constructor( manager ) {
  35973. super( manager );
  35974. }
  35975. /**
  35976. * Starts loading from the given URL and passes the loaded audio buffer
  35977. * to the `onLoad()` callback.
  35978. *
  35979. * @param {string} url - The path/URL of the file to be loaded. This can also be a data URI.
  35980. * @param {function(AudioBuffer)} onLoad - Executed when the loading process has been finished.
  35981. * @param {onProgressCallback} onProgress - Executed while the loading is in progress.
  35982. * @param {onErrorCallback} onError - Executed when errors occur.
  35983. */
  35984. load( url, onLoad, onProgress, onError ) {
  35985. const scope = this;
  35986. const loader = new FileLoader( this.manager );
  35987. loader.setResponseType( 'arraybuffer' );
  35988. loader.setPath( this.path );
  35989. loader.setRequestHeader( this.requestHeader );
  35990. loader.setWithCredentials( this.withCredentials );
  35991. loader.load( url, function ( buffer ) {
  35992. try {
  35993. // Create a copy of the buffer. The `decodeAudioData` method
  35994. // detaches the buffer when complete, preventing reuse.
  35995. const bufferCopy = buffer.slice( 0 );
  35996. const context = AudioContext.getContext();
  35997. context.decodeAudioData( bufferCopy, function ( audioBuffer ) {
  35998. onLoad( audioBuffer );
  35999. } ).catch( handleError );
  36000. } catch ( e ) {
  36001. handleError( e );
  36002. }
  36003. }, onProgress, onError );
  36004. function handleError( e ) {
  36005. if ( onError ) {
  36006. onError( e );
  36007. } else {
  36008. error( e );
  36009. }
  36010. scope.manager.itemError( url );
  36011. }
  36012. }
  36013. }
  36014. const _eyeRight = /*@__PURE__*/ new Matrix4();
  36015. const _eyeLeft = /*@__PURE__*/ new Matrix4();
  36016. const _projectionMatrix = /*@__PURE__*/ new Matrix4();
  36017. /**
  36018. * A special type of camera that uses two perspective cameras with
  36019. * stereoscopic projection. Can be used for rendering stereo effects
  36020. * like [3D Anaglyph](https://en.wikipedia.org/wiki/Anaglyph_3D) or
  36021. * [Parallax Barrier](https://en.wikipedia.org/wiki/parallax_barrier).
  36022. */
  36023. class StereoCamera {
  36024. /**
  36025. * Constructs a new stereo camera.
  36026. */
  36027. constructor() {
  36028. /**
  36029. * The type property is used for detecting the object type
  36030. * in context of serialization/deserialization.
  36031. *
  36032. * @type {string}
  36033. * @readonly
  36034. */
  36035. this.type = 'StereoCamera';
  36036. /**
  36037. * The aspect.
  36038. *
  36039. * @type {number}
  36040. * @default 1
  36041. */
  36042. this.aspect = 1;
  36043. /**
  36044. * The eye separation which represents the distance
  36045. * between the left and right camera.
  36046. *
  36047. * @type {number}
  36048. * @default 0.064
  36049. */
  36050. this.eyeSep = 0.064;
  36051. /**
  36052. * The camera representing the left eye. This is added to layer `1` so objects to be
  36053. * rendered by the left camera must also be added to this layer.
  36054. *
  36055. * @type {PerspectiveCamera}
  36056. */
  36057. this.cameraL = new PerspectiveCamera();
  36058. this.cameraL.layers.enable( 1 );
  36059. this.cameraL.matrixAutoUpdate = false;
  36060. /**
  36061. * The camera representing the right eye. This is added to layer `2` so objects to be
  36062. * rendered by the right camera must also be added to this layer.
  36063. *
  36064. * @type {PerspectiveCamera}
  36065. */
  36066. this.cameraR = new PerspectiveCamera();
  36067. this.cameraR.layers.enable( 2 );
  36068. this.cameraR.matrixAutoUpdate = false;
  36069. this._cache = {
  36070. focus: null,
  36071. fov: null,
  36072. aspect: null,
  36073. near: null,
  36074. far: null,
  36075. zoom: null,
  36076. eyeSep: null
  36077. };
  36078. }
  36079. /**
  36080. * Updates the stereo camera based on the given perspective camera.
  36081. *
  36082. * @param {PerspectiveCamera} camera - The perspective camera.
  36083. */
  36084. update( camera ) {
  36085. const cache = this._cache;
  36086. const needsUpdate = cache.focus !== camera.focus || cache.fov !== camera.fov ||
  36087. cache.aspect !== camera.aspect * this.aspect || cache.near !== camera.near ||
  36088. cache.far !== camera.far || cache.zoom !== camera.zoom || cache.eyeSep !== this.eyeSep;
  36089. if ( needsUpdate ) {
  36090. cache.focus = camera.focus;
  36091. cache.fov = camera.fov;
  36092. cache.aspect = camera.aspect * this.aspect;
  36093. cache.near = camera.near;
  36094. cache.far = camera.far;
  36095. cache.zoom = camera.zoom;
  36096. cache.eyeSep = this.eyeSep;
  36097. // Off-axis stereoscopic effect based on
  36098. // http://paulbourke.net/stereographics/stereorender/
  36099. _projectionMatrix.copy( camera.projectionMatrix );
  36100. const eyeSepHalf = cache.eyeSep / 2;
  36101. const eyeSepOnProjection = eyeSepHalf * cache.near / cache.focus;
  36102. const ymax = ( cache.near * Math.tan( DEG2RAD * cache.fov * 0.5 ) ) / cache.zoom;
  36103. let xmin, xmax;
  36104. // translate xOffset
  36105. _eyeLeft.elements[ 12 ] = - eyeSepHalf;
  36106. _eyeRight.elements[ 12 ] = eyeSepHalf;
  36107. // for left eye
  36108. xmin = - ymax * cache.aspect + eyeSepOnProjection;
  36109. xmax = ymax * cache.aspect + eyeSepOnProjection;
  36110. _projectionMatrix.elements[ 0 ] = 2 * cache.near / ( xmax - xmin );
  36111. _projectionMatrix.elements[ 8 ] = ( xmax + xmin ) / ( xmax - xmin );
  36112. this.cameraL.projectionMatrix.copy( _projectionMatrix );
  36113. // for right eye
  36114. xmin = - ymax * cache.aspect - eyeSepOnProjection;
  36115. xmax = ymax * cache.aspect - eyeSepOnProjection;
  36116. _projectionMatrix.elements[ 0 ] = 2 * cache.near / ( xmax - xmin );
  36117. _projectionMatrix.elements[ 8 ] = ( xmax + xmin ) / ( xmax - xmin );
  36118. this.cameraR.projectionMatrix.copy( _projectionMatrix );
  36119. }
  36120. this.cameraL.matrixWorld.copy( camera.matrixWorld ).multiply( _eyeLeft );
  36121. this.cameraR.matrixWorld.copy( camera.matrixWorld ).multiply( _eyeRight );
  36122. }
  36123. }
  36124. /**
  36125. * This type of camera can be used in order to efficiently render a scene with a
  36126. * predefined set of cameras. This is an important performance aspect for
  36127. * rendering VR scenes.
  36128. *
  36129. * An instance of `ArrayCamera` always has an array of sub cameras. It's mandatory
  36130. * to define for each sub camera the `viewport` property which determines the
  36131. * part of the viewport that is rendered with this camera.
  36132. *
  36133. * @augments PerspectiveCamera
  36134. */
  36135. class ArrayCamera extends PerspectiveCamera {
  36136. /**
  36137. * Constructs a new array camera.
  36138. *
  36139. * @param {Array<PerspectiveCamera>} [array=[]] - An array of perspective sub cameras.
  36140. */
  36141. constructor( array = [] ) {
  36142. super();
  36143. /**
  36144. * This flag can be used for type testing.
  36145. *
  36146. * @type {boolean}
  36147. * @readonly
  36148. * @default true
  36149. */
  36150. this.isArrayCamera = true;
  36151. /**
  36152. * Whether this camera is used with multiview rendering or not.
  36153. *
  36154. * @type {boolean}
  36155. * @readonly
  36156. * @default false
  36157. */
  36158. this.isMultiViewCamera = false;
  36159. /**
  36160. * An array of perspective sub cameras.
  36161. *
  36162. * @type {Array<PerspectiveCamera>}
  36163. */
  36164. this.cameras = array;
  36165. }
  36166. }
  36167. /**
  36168. * Class for keeping track of time.
  36169. */
  36170. class Clock {
  36171. /**
  36172. * Constructs a new clock.
  36173. *
  36174. * @param {boolean} [autoStart=true] - Whether to automatically start the clock when
  36175. * `getDelta()` is called for the first time.
  36176. */
  36177. constructor( autoStart = true ) {
  36178. /**
  36179. * If set to `true`, the clock starts automatically when `getDelta()` is called
  36180. * for the first time.
  36181. *
  36182. * @type {boolean}
  36183. * @default true
  36184. */
  36185. this.autoStart = autoStart;
  36186. /**
  36187. * Holds the time at which the clock's `start()` method was last called.
  36188. *
  36189. * @type {number}
  36190. * @default 0
  36191. */
  36192. this.startTime = 0;
  36193. /**
  36194. * Holds the time at which the clock's `start()`, `getElapsedTime()` or
  36195. * `getDelta()` methods were last called.
  36196. *
  36197. * @type {number}
  36198. * @default 0
  36199. */
  36200. this.oldTime = 0;
  36201. /**
  36202. * Keeps track of the total time that the clock has been running.
  36203. *
  36204. * @type {number}
  36205. * @default 0
  36206. */
  36207. this.elapsedTime = 0;
  36208. /**
  36209. * Whether the clock is running or not.
  36210. *
  36211. * @type {boolean}
  36212. * @default true
  36213. */
  36214. this.running = false;
  36215. }
  36216. /**
  36217. * Starts the clock. When `autoStart` is set to `true`, the method is automatically
  36218. * called by the class.
  36219. */
  36220. start() {
  36221. this.startTime = performance.now();
  36222. this.oldTime = this.startTime;
  36223. this.elapsedTime = 0;
  36224. this.running = true;
  36225. }
  36226. /**
  36227. * Stops the clock.
  36228. */
  36229. stop() {
  36230. this.getElapsedTime();
  36231. this.running = false;
  36232. this.autoStart = false;
  36233. }
  36234. /**
  36235. * Returns the elapsed time in seconds.
  36236. *
  36237. * @return {number} The elapsed time.
  36238. */
  36239. getElapsedTime() {
  36240. this.getDelta();
  36241. return this.elapsedTime;
  36242. }
  36243. /**
  36244. * Returns the delta time in seconds.
  36245. *
  36246. * @return {number} The delta time.
  36247. */
  36248. getDelta() {
  36249. let diff = 0;
  36250. if ( this.autoStart && ! this.running ) {
  36251. this.start();
  36252. return 0;
  36253. }
  36254. if ( this.running ) {
  36255. const newTime = performance.now();
  36256. diff = ( newTime - this.oldTime ) / 1000;
  36257. this.oldTime = newTime;
  36258. this.elapsedTime += diff;
  36259. }
  36260. return diff;
  36261. }
  36262. }
  36263. const _position$1 = /*@__PURE__*/ new Vector3();
  36264. const _quaternion$1 = /*@__PURE__*/ new Quaternion();
  36265. const _scale$1 = /*@__PURE__*/ new Vector3();
  36266. const _forward = /*@__PURE__*/ new Vector3();
  36267. const _up = /*@__PURE__*/ new Vector3();
  36268. /**
  36269. * The class represents a virtual listener of the all positional and non-positional audio effects
  36270. * in the scene. A three.js application usually creates a single listener. It is a mandatory
  36271. * constructor parameter for audios entities like {@link Audio} and {@link PositionalAudio}.
  36272. *
  36273. * In most cases, the listener object is a child of the camera. So the 3D transformation of the
  36274. * camera represents the 3D transformation of the listener.
  36275. *
  36276. * @augments Object3D
  36277. */
  36278. class AudioListener extends Object3D {
  36279. /**
  36280. * Constructs a new audio listener.
  36281. */
  36282. constructor() {
  36283. super();
  36284. this.type = 'AudioListener';
  36285. /**
  36286. * The native audio context.
  36287. *
  36288. * @type {AudioContext}
  36289. * @readonly
  36290. */
  36291. this.context = AudioContext.getContext();
  36292. /**
  36293. * The gain node used for volume control.
  36294. *
  36295. * @type {GainNode}
  36296. * @readonly
  36297. */
  36298. this.gain = this.context.createGain();
  36299. this.gain.connect( this.context.destination );
  36300. /**
  36301. * An optional filter.
  36302. *
  36303. * Defined via {@link AudioListener#setFilter}.
  36304. *
  36305. * @type {?AudioNode}
  36306. * @default null
  36307. * @readonly
  36308. */
  36309. this.filter = null;
  36310. /**
  36311. * Time delta values required for `linearRampToValueAtTime()` usage.
  36312. *
  36313. * @type {number}
  36314. * @default 0
  36315. * @readonly
  36316. */
  36317. this.timeDelta = 0;
  36318. // private
  36319. this._clock = new Clock();
  36320. }
  36321. /**
  36322. * Returns the listener's input node.
  36323. *
  36324. * This method is used by other audio nodes to connect to this listener.
  36325. *
  36326. * @return {GainNode} The input node.
  36327. */
  36328. getInput() {
  36329. return this.gain;
  36330. }
  36331. /**
  36332. * Removes the current filter from this listener.
  36333. *
  36334. * @return {AudioListener} A reference to this listener.
  36335. */
  36336. removeFilter() {
  36337. if ( this.filter !== null ) {
  36338. this.gain.disconnect( this.filter );
  36339. this.filter.disconnect( this.context.destination );
  36340. this.gain.connect( this.context.destination );
  36341. this.filter = null;
  36342. }
  36343. return this;
  36344. }
  36345. /**
  36346. * Returns the current set filter.
  36347. *
  36348. * @return {?AudioNode} The filter.
  36349. */
  36350. getFilter() {
  36351. return this.filter;
  36352. }
  36353. /**
  36354. * Sets the given filter to this listener.
  36355. *
  36356. * @param {AudioNode} value - The filter to set.
  36357. * @return {AudioListener} A reference to this listener.
  36358. */
  36359. setFilter( value ) {
  36360. if ( this.filter !== null ) {
  36361. this.gain.disconnect( this.filter );
  36362. this.filter.disconnect( this.context.destination );
  36363. } else {
  36364. this.gain.disconnect( this.context.destination );
  36365. }
  36366. this.filter = value;
  36367. this.gain.connect( this.filter );
  36368. this.filter.connect( this.context.destination );
  36369. return this;
  36370. }
  36371. /**
  36372. * Returns the applications master volume.
  36373. *
  36374. * @return {number} The master volume.
  36375. */
  36376. getMasterVolume() {
  36377. return this.gain.gain.value;
  36378. }
  36379. /**
  36380. * Sets the applications master volume. This volume setting affects
  36381. * all audio nodes in the scene.
  36382. *
  36383. * @param {number} value - The master volume to set.
  36384. * @return {AudioListener} A reference to this listener.
  36385. */
  36386. setMasterVolume( value ) {
  36387. this.gain.gain.setTargetAtTime( value, this.context.currentTime, 0.01 );
  36388. return this;
  36389. }
  36390. updateMatrixWorld( force ) {
  36391. super.updateMatrixWorld( force );
  36392. const listener = this.context.listener;
  36393. this.timeDelta = this._clock.getDelta();
  36394. this.matrixWorld.decompose( _position$1, _quaternion$1, _scale$1 );
  36395. // the initial forward and up directions must be orthogonal
  36396. _forward.set( 0, 0, -1 ).applyQuaternion( _quaternion$1 );
  36397. _up.set( 0, 1, 0 ).applyQuaternion( _quaternion$1 );
  36398. if ( listener.positionX ) {
  36399. // code path for Chrome (see #14393)
  36400. const endTime = this.context.currentTime + this.timeDelta;
  36401. listener.positionX.linearRampToValueAtTime( _position$1.x, endTime );
  36402. listener.positionY.linearRampToValueAtTime( _position$1.y, endTime );
  36403. listener.positionZ.linearRampToValueAtTime( _position$1.z, endTime );
  36404. listener.forwardX.linearRampToValueAtTime( _forward.x, endTime );
  36405. listener.forwardY.linearRampToValueAtTime( _forward.y, endTime );
  36406. listener.forwardZ.linearRampToValueAtTime( _forward.z, endTime );
  36407. listener.upX.linearRampToValueAtTime( _up.x, endTime );
  36408. listener.upY.linearRampToValueAtTime( _up.y, endTime );
  36409. listener.upZ.linearRampToValueAtTime( _up.z, endTime );
  36410. } else {
  36411. listener.setPosition( _position$1.x, _position$1.y, _position$1.z );
  36412. listener.setOrientation( _forward.x, _forward.y, _forward.z, _up.x, _up.y, _up.z );
  36413. }
  36414. }
  36415. }
  36416. /**
  36417. * Represents a non-positional ( global ) audio object.
  36418. *
  36419. * This and related audio modules make use of the [Web Audio API](https://www.w3.org/TR/webaudio-1.1/).
  36420. *
  36421. * ```js
  36422. * // create an AudioListener and add it to the camera
  36423. * const listener = new THREE.AudioListener();
  36424. * camera.add( listener );
  36425. *
  36426. * // create a global audio source
  36427. * const sound = new THREE.Audio( listener );
  36428. *
  36429. * // load a sound and set it as the Audio object's buffer
  36430. * const audioLoader = new THREE.AudioLoader();
  36431. * audioLoader.load( 'sounds/ambient.ogg', function( buffer ) {
  36432. * sound.setBuffer( buffer );
  36433. * sound.setLoop( true );
  36434. * sound.setVolume( 0.5 );
  36435. * sound.play();
  36436. * });
  36437. * ```
  36438. *
  36439. * @augments Object3D
  36440. */
  36441. class Audio extends Object3D {
  36442. /**
  36443. * Constructs a new audio.
  36444. *
  36445. * @param {AudioListener} listener - The global audio listener.
  36446. */
  36447. constructor( listener ) {
  36448. super();
  36449. this.type = 'Audio';
  36450. /**
  36451. * The global audio listener.
  36452. *
  36453. * @type {AudioListener}
  36454. * @readonly
  36455. */
  36456. this.listener = listener;
  36457. /**
  36458. * The audio context.
  36459. *
  36460. * @type {AudioContext}
  36461. * @readonly
  36462. */
  36463. this.context = listener.context;
  36464. /**
  36465. * The gain node used for volume control.
  36466. *
  36467. * @type {GainNode}
  36468. * @readonly
  36469. */
  36470. this.gain = this.context.createGain();
  36471. this.gain.connect( listener.getInput() );
  36472. /**
  36473. * Whether to start playback automatically or not.
  36474. *
  36475. * @type {boolean}
  36476. * @default false
  36477. */
  36478. this.autoplay = false;
  36479. /**
  36480. * A reference to an audio buffer.
  36481. *
  36482. * Defined via {@link Audio#setBuffer}.
  36483. *
  36484. * @type {?AudioBuffer}
  36485. * @default null
  36486. * @readonly
  36487. */
  36488. this.buffer = null;
  36489. /**
  36490. * Modify pitch, measured in cents. +/- 100 is a semitone.
  36491. * +/- 1200 is an octave.
  36492. *
  36493. * Defined via {@link Audio#setDetune}.
  36494. *
  36495. * @type {number}
  36496. * @default 0
  36497. * @readonly
  36498. */
  36499. this.detune = 0;
  36500. /**
  36501. * Whether the audio should loop or not.
  36502. *
  36503. * Defined via {@link Audio#setLoop}.
  36504. *
  36505. * @type {boolean}
  36506. * @default false
  36507. * @readonly
  36508. */
  36509. this.loop = false;
  36510. /**
  36511. * Defines where in the audio buffer the replay should
  36512. * start, in seconds.
  36513. *
  36514. * @type {number}
  36515. * @default 0
  36516. */
  36517. this.loopStart = 0;
  36518. /**
  36519. * Defines where in the audio buffer the replay should
  36520. * stop, in seconds.
  36521. *
  36522. * @type {number}
  36523. * @default 0
  36524. */
  36525. this.loopEnd = 0;
  36526. /**
  36527. * An offset to the time within the audio buffer the playback
  36528. * should begin, in seconds.
  36529. *
  36530. * @type {number}
  36531. * @default 0
  36532. */
  36533. this.offset = 0;
  36534. /**
  36535. * Overrides the default duration of the audio.
  36536. *
  36537. * @type {undefined|number}
  36538. * @default undefined
  36539. */
  36540. this.duration = undefined;
  36541. /**
  36542. * The playback speed.
  36543. *
  36544. * Defined via {@link Audio#setPlaybackRate}.
  36545. *
  36546. * @type {number}
  36547. * @readonly
  36548. * @default 1
  36549. */
  36550. this.playbackRate = 1;
  36551. /**
  36552. * Indicates whether the audio is playing or not.
  36553. *
  36554. * This flag will be automatically set when using {@link Audio#play},
  36555. * {@link Audio#pause}, {@link Audio#stop}.
  36556. *
  36557. * @type {boolean}
  36558. * @readonly
  36559. * @default false
  36560. */
  36561. this.isPlaying = false;
  36562. /**
  36563. * Indicates whether the audio playback can be controlled
  36564. * with method like {@link Audio#play} or {@link Audio#pause}.
  36565. *
  36566. * This flag will be automatically set when audio sources are
  36567. * defined.
  36568. *
  36569. * @type {boolean}
  36570. * @readonly
  36571. * @default true
  36572. */
  36573. this.hasPlaybackControl = true;
  36574. /**
  36575. * Holds a reference to the current audio source.
  36576. *
  36577. * The property is automatically by one of the `set*()` methods.
  36578. *
  36579. * @type {?AudioNode}
  36580. * @readonly
  36581. * @default null
  36582. */
  36583. this.source = null;
  36584. /**
  36585. * Defines the source type.
  36586. *
  36587. * The property is automatically set by one of the `set*()` methods.
  36588. *
  36589. * @type {('empty'|'audioNode'|'mediaNode'|'mediaStreamNode'|'buffer')}
  36590. * @readonly
  36591. * @default 'empty'
  36592. */
  36593. this.sourceType = 'empty';
  36594. this._startedAt = 0;
  36595. this._progress = 0;
  36596. this._connected = false;
  36597. /**
  36598. * Can be used to apply a variety of low-order filters to create
  36599. * more complex sound effects e.g. via `BiquadFilterNode`.
  36600. *
  36601. * The property is automatically set by {@link Audio#setFilters}.
  36602. *
  36603. * @type {Array<AudioNode>}
  36604. * @readonly
  36605. */
  36606. this.filters = [];
  36607. }
  36608. /**
  36609. * Returns the output audio node.
  36610. *
  36611. * @return {GainNode} The output node.
  36612. */
  36613. getOutput() {
  36614. return this.gain;
  36615. }
  36616. /**
  36617. * Sets the given audio node as the source of this instance.
  36618. *
  36619. * {@link Audio#sourceType} is set to `audioNode` and {@link Audio#hasPlaybackControl} to `false`.
  36620. *
  36621. * @param {AudioNode} audioNode - The audio node like an instance of `OscillatorNode`.
  36622. * @return {Audio} A reference to this instance.
  36623. */
  36624. setNodeSource( audioNode ) {
  36625. this.hasPlaybackControl = false;
  36626. this.sourceType = 'audioNode';
  36627. this.source = audioNode;
  36628. this.connect();
  36629. return this;
  36630. }
  36631. /**
  36632. * Sets the given media element as the source of this instance.
  36633. *
  36634. * {@link Audio#sourceType} is set to `mediaNode` and {@link Audio#hasPlaybackControl} to `false`.
  36635. *
  36636. * @param {HTMLMediaElement} mediaElement - The media element.
  36637. * @return {Audio} A reference to this instance.
  36638. */
  36639. setMediaElementSource( mediaElement ) {
  36640. this.hasPlaybackControl = false;
  36641. this.sourceType = 'mediaNode';
  36642. this.source = this.context.createMediaElementSource( mediaElement );
  36643. this.connect();
  36644. return this;
  36645. }
  36646. /**
  36647. * Sets the given media stream as the source of this instance.
  36648. *
  36649. * {@link Audio#sourceType} is set to `mediaStreamNode` and {@link Audio#hasPlaybackControl} to `false`.
  36650. *
  36651. * @param {MediaStream} mediaStream - The media stream.
  36652. * @return {Audio} A reference to this instance.
  36653. */
  36654. setMediaStreamSource( mediaStream ) {
  36655. this.hasPlaybackControl = false;
  36656. this.sourceType = 'mediaStreamNode';
  36657. this.source = this.context.createMediaStreamSource( mediaStream );
  36658. this.connect();
  36659. return this;
  36660. }
  36661. /**
  36662. * Sets the given audio buffer as the source of this instance.
  36663. *
  36664. * {@link Audio#sourceType} is set to `buffer` and {@link Audio#hasPlaybackControl} to `true`.
  36665. *
  36666. * @param {AudioBuffer} audioBuffer - The audio buffer.
  36667. * @return {Audio} A reference to this instance.
  36668. */
  36669. setBuffer( audioBuffer ) {
  36670. this.buffer = audioBuffer;
  36671. this.sourceType = 'buffer';
  36672. if ( this.autoplay ) this.play();
  36673. return this;
  36674. }
  36675. /**
  36676. * Starts the playback of the audio.
  36677. *
  36678. * Can only be used with compatible audio sources that allow playback control.
  36679. *
  36680. * @param {number} [delay=0] - The delay, in seconds, at which the audio should start playing.
  36681. * @return {Audio|undefined} A reference to this instance.
  36682. */
  36683. play( delay = 0 ) {
  36684. if ( this.isPlaying === true ) {
  36685. warn( 'Audio: Audio is already playing.' );
  36686. return;
  36687. }
  36688. if ( this.hasPlaybackControl === false ) {
  36689. warn( 'Audio: this Audio has no playback control.' );
  36690. return;
  36691. }
  36692. this._startedAt = this.context.currentTime + delay;
  36693. const source = this.context.createBufferSource();
  36694. source.buffer = this.buffer;
  36695. source.loop = this.loop;
  36696. source.loopStart = this.loopStart;
  36697. source.loopEnd = this.loopEnd;
  36698. source.onended = this.onEnded.bind( this );
  36699. source.start( this._startedAt, this._progress + this.offset, this.duration );
  36700. this.isPlaying = true;
  36701. this.source = source;
  36702. this.setDetune( this.detune );
  36703. this.setPlaybackRate( this.playbackRate );
  36704. return this.connect();
  36705. }
  36706. /**
  36707. * Pauses the playback of the audio.
  36708. *
  36709. * Can only be used with compatible audio sources that allow playback control.
  36710. *
  36711. * @return {Audio|undefined} A reference to this instance.
  36712. */
  36713. pause() {
  36714. if ( this.hasPlaybackControl === false ) {
  36715. warn( 'Audio: this Audio has no playback control.' );
  36716. return;
  36717. }
  36718. if ( this.isPlaying === true ) {
  36719. // update current progress
  36720. this._progress += Math.max( this.context.currentTime - this._startedAt, 0 ) * this.playbackRate;
  36721. if ( this.loop === true ) {
  36722. // ensure _progress does not exceed duration with looped audios
  36723. this._progress = this._progress % ( this.duration || this.buffer.duration );
  36724. }
  36725. this.source.stop();
  36726. this.source.onended = null;
  36727. this.isPlaying = false;
  36728. }
  36729. return this;
  36730. }
  36731. /**
  36732. * Stops the playback of the audio.
  36733. *
  36734. * Can only be used with compatible audio sources that allow playback control.
  36735. *
  36736. * @param {number} [delay=0] - The delay, in seconds, at which the audio should stop playing.
  36737. * @return {Audio|undefined} A reference to this instance.
  36738. */
  36739. stop( delay = 0 ) {
  36740. if ( this.hasPlaybackControl === false ) {
  36741. warn( 'Audio: this Audio has no playback control.' );
  36742. return;
  36743. }
  36744. this._progress = 0;
  36745. if ( this.source !== null ) {
  36746. this.source.stop( this.context.currentTime + delay );
  36747. this.source.onended = null;
  36748. }
  36749. this.isPlaying = false;
  36750. return this;
  36751. }
  36752. /**
  36753. * Connects to the audio source. This is used internally on
  36754. * initialisation and when setting / removing filters.
  36755. *
  36756. * @return {Audio} A reference to this instance.
  36757. */
  36758. connect() {
  36759. if ( this.filters.length > 0 ) {
  36760. this.source.connect( this.filters[ 0 ] );
  36761. for ( let i = 1, l = this.filters.length; i < l; i ++ ) {
  36762. this.filters[ i - 1 ].connect( this.filters[ i ] );
  36763. }
  36764. this.filters[ this.filters.length - 1 ].connect( this.getOutput() );
  36765. } else {
  36766. this.source.connect( this.getOutput() );
  36767. }
  36768. this._connected = true;
  36769. return this;
  36770. }
  36771. /**
  36772. * Disconnects to the audio source. This is used internally on
  36773. * initialisation and when setting / removing filters.
  36774. *
  36775. * @return {Audio|undefined} A reference to this instance.
  36776. */
  36777. disconnect() {
  36778. if ( this._connected === false ) {
  36779. return;
  36780. }
  36781. if ( this.filters.length > 0 ) {
  36782. this.source.disconnect( this.filters[ 0 ] );
  36783. for ( let i = 1, l = this.filters.length; i < l; i ++ ) {
  36784. this.filters[ i - 1 ].disconnect( this.filters[ i ] );
  36785. }
  36786. this.filters[ this.filters.length - 1 ].disconnect( this.getOutput() );
  36787. } else {
  36788. this.source.disconnect( this.getOutput() );
  36789. }
  36790. this._connected = false;
  36791. return this;
  36792. }
  36793. /**
  36794. * Returns the current set filters.
  36795. *
  36796. * @return {Array<AudioNode>} The list of filters.
  36797. */
  36798. getFilters() {
  36799. return this.filters;
  36800. }
  36801. /**
  36802. * Sets an array of filters and connects them with the audio source.
  36803. *
  36804. * @param {Array<AudioNode>} [value] - A list of filters.
  36805. * @return {Audio} A reference to this instance.
  36806. */
  36807. setFilters( value ) {
  36808. if ( ! value ) value = [];
  36809. if ( this._connected === true ) {
  36810. this.disconnect();
  36811. this.filters = value.slice();
  36812. this.connect();
  36813. } else {
  36814. this.filters = value.slice();
  36815. }
  36816. return this;
  36817. }
  36818. /**
  36819. * Defines the detuning of oscillation in cents.
  36820. *
  36821. * @param {number} value - The detuning of oscillation in cents.
  36822. * @return {Audio} A reference to this instance.
  36823. */
  36824. setDetune( value ) {
  36825. this.detune = value;
  36826. if ( this.isPlaying === true && this.source.detune !== undefined ) {
  36827. this.source.detune.setTargetAtTime( this.detune, this.context.currentTime, 0.01 );
  36828. }
  36829. return this;
  36830. }
  36831. /**
  36832. * Returns the detuning of oscillation in cents.
  36833. *
  36834. * @return {number} The detuning of oscillation in cents.
  36835. */
  36836. getDetune() {
  36837. return this.detune;
  36838. }
  36839. /**
  36840. * Returns the first filter in the list of filters.
  36841. *
  36842. * @return {AudioNode|undefined} The first filter in the list of filters.
  36843. */
  36844. getFilter() {
  36845. return this.getFilters()[ 0 ];
  36846. }
  36847. /**
  36848. * Applies a single filter node to the audio.
  36849. *
  36850. * @param {AudioNode} [filter] - The filter to set.
  36851. * @return {Audio} A reference to this instance.
  36852. */
  36853. setFilter( filter ) {
  36854. return this.setFilters( filter ? [ filter ] : [] );
  36855. }
  36856. /**
  36857. * Sets the playback rate.
  36858. *
  36859. * Can only be used with compatible audio sources that allow playback control.
  36860. *
  36861. * @param {number} [value] - The playback rate to set.
  36862. * @return {Audio|undefined} A reference to this instance.
  36863. */
  36864. setPlaybackRate( value ) {
  36865. if ( this.hasPlaybackControl === false ) {
  36866. warn( 'Audio: this Audio has no playback control.' );
  36867. return;
  36868. }
  36869. this.playbackRate = value;
  36870. if ( this.isPlaying === true ) {
  36871. this.source.playbackRate.setTargetAtTime( this.playbackRate, this.context.currentTime, 0.01 );
  36872. }
  36873. return this;
  36874. }
  36875. /**
  36876. * Returns the current playback rate.
  36877. * @return {number} The playback rate.
  36878. */
  36879. getPlaybackRate() {
  36880. return this.playbackRate;
  36881. }
  36882. /**
  36883. * Automatically called when playback finished.
  36884. */
  36885. onEnded() {
  36886. this.isPlaying = false;
  36887. this._progress = 0;
  36888. }
  36889. /**
  36890. * Returns the loop flag.
  36891. *
  36892. * Can only be used with compatible audio sources that allow playback control.
  36893. *
  36894. * @return {boolean} Whether the audio should loop or not.
  36895. */
  36896. getLoop() {
  36897. if ( this.hasPlaybackControl === false ) {
  36898. warn( 'Audio: this Audio has no playback control.' );
  36899. return false;
  36900. }
  36901. return this.loop;
  36902. }
  36903. /**
  36904. * Sets the loop flag.
  36905. *
  36906. * Can only be used with compatible audio sources that allow playback control.
  36907. *
  36908. * @param {boolean} value - Whether the audio should loop or not.
  36909. * @return {Audio|undefined} A reference to this instance.
  36910. */
  36911. setLoop( value ) {
  36912. if ( this.hasPlaybackControl === false ) {
  36913. warn( 'Audio: this Audio has no playback control.' );
  36914. return;
  36915. }
  36916. this.loop = value;
  36917. if ( this.isPlaying === true ) {
  36918. this.source.loop = this.loop;
  36919. }
  36920. return this;
  36921. }
  36922. /**
  36923. * Sets the loop start value which defines where in the audio buffer the replay should
  36924. * start, in seconds.
  36925. *
  36926. * @param {number} value - The loop start value.
  36927. * @return {Audio} A reference to this instance.
  36928. */
  36929. setLoopStart( value ) {
  36930. this.loopStart = value;
  36931. return this;
  36932. }
  36933. /**
  36934. * Sets the loop end value which defines where in the audio buffer the replay should
  36935. * stop, in seconds.
  36936. *
  36937. * @param {number} value - The loop end value.
  36938. * @return {Audio} A reference to this instance.
  36939. */
  36940. setLoopEnd( value ) {
  36941. this.loopEnd = value;
  36942. return this;
  36943. }
  36944. /**
  36945. * Returns the volume.
  36946. *
  36947. * @return {number} The volume.
  36948. */
  36949. getVolume() {
  36950. return this.gain.gain.value;
  36951. }
  36952. /**
  36953. * Sets the volume.
  36954. *
  36955. * @param {number} value - The volume to set.
  36956. * @return {Audio} A reference to this instance.
  36957. */
  36958. setVolume( value ) {
  36959. this.gain.gain.setTargetAtTime( value, this.context.currentTime, 0.01 );
  36960. return this;
  36961. }
  36962. copy( source, recursive ) {
  36963. super.copy( source, recursive );
  36964. if ( source.sourceType !== 'buffer' ) {
  36965. warn( 'Audio: Audio source type cannot be copied.' );
  36966. return this;
  36967. }
  36968. this.autoplay = source.autoplay;
  36969. this.buffer = source.buffer;
  36970. this.detune = source.detune;
  36971. this.loop = source.loop;
  36972. this.loopStart = source.loopStart;
  36973. this.loopEnd = source.loopEnd;
  36974. this.offset = source.offset;
  36975. this.duration = source.duration;
  36976. this.playbackRate = source.playbackRate;
  36977. this.hasPlaybackControl = source.hasPlaybackControl;
  36978. this.sourceType = source.sourceType;
  36979. this.filters = source.filters.slice();
  36980. return this;
  36981. }
  36982. clone( recursive ) {
  36983. return new this.constructor( this.listener ).copy( this, recursive );
  36984. }
  36985. }
  36986. const _position = /*@__PURE__*/ new Vector3();
  36987. const _quaternion = /*@__PURE__*/ new Quaternion();
  36988. const _scale = /*@__PURE__*/ new Vector3();
  36989. const _orientation = /*@__PURE__*/ new Vector3();
  36990. /**
  36991. * Represents a positional audio object.
  36992. *
  36993. * ```js
  36994. * // create an AudioListener and add it to the camera
  36995. * const listener = new THREE.AudioListener();
  36996. * camera.add( listener );
  36997. *
  36998. * // create the PositionalAudio object (passing in the listener)
  36999. * const sound = new THREE.PositionalAudio( listener );
  37000. *
  37001. * // load a sound and set it as the PositionalAudio object's buffer
  37002. * const audioLoader = new THREE.AudioLoader();
  37003. * audioLoader.load( 'sounds/song.ogg', function( buffer ) {
  37004. * sound.setBuffer( buffer );
  37005. * sound.setRefDistance( 20 );
  37006. * sound.play();
  37007. * });
  37008. *
  37009. * // create an object for the sound to play from
  37010. * const sphere = new THREE.SphereGeometry( 20, 32, 16 );
  37011. * const material = new THREE.MeshPhongMaterial( { color: 0xff2200 } );
  37012. * const mesh = new THREE.Mesh( sphere, material );
  37013. * scene.add( mesh );
  37014. *
  37015. * // finally add the sound to the mesh
  37016. * mesh.add( sound );
  37017. *
  37018. * @augments Audio
  37019. */
  37020. class PositionalAudio extends Audio {
  37021. /**
  37022. * Constructs a positional audio.
  37023. *
  37024. * @param {AudioListener} listener - The global audio listener.
  37025. */
  37026. constructor( listener ) {
  37027. super( listener );
  37028. /**
  37029. * The panner node represents the location, direction, and behavior of an audio
  37030. * source in 3D space.
  37031. *
  37032. * @type {PannerNode}
  37033. * @readonly
  37034. */
  37035. this.panner = this.context.createPanner();
  37036. this.panner.panningModel = 'HRTF';
  37037. this.panner.connect( this.gain );
  37038. }
  37039. connect() {
  37040. super.connect();
  37041. this.panner.connect( this.gain );
  37042. return this;
  37043. }
  37044. disconnect() {
  37045. super.disconnect();
  37046. this.panner.disconnect( this.gain );
  37047. return this;
  37048. }
  37049. getOutput() {
  37050. return this.panner;
  37051. }
  37052. /**
  37053. * Returns the current reference distance.
  37054. *
  37055. * @return {number} The reference distance.
  37056. */
  37057. getRefDistance() {
  37058. return this.panner.refDistance;
  37059. }
  37060. /**
  37061. * Defines the reference distance for reducing volume as the audio source moves
  37062. * further from the listener – i.e. the distance at which the volume reduction
  37063. * starts taking effect.
  37064. *
  37065. * @param {number} value - The reference distance to set.
  37066. * @return {PositionalAudio} A reference to this instance.
  37067. */
  37068. setRefDistance( value ) {
  37069. this.panner.refDistance = value;
  37070. return this;
  37071. }
  37072. /**
  37073. * Returns the current rolloff factor.
  37074. *
  37075. * @return {number} The rolloff factor.
  37076. */
  37077. getRolloffFactor() {
  37078. return this.panner.rolloffFactor;
  37079. }
  37080. /**
  37081. * Defines how quickly the volume is reduced as the source moves away from the listener.
  37082. *
  37083. * @param {number} value - The rolloff factor.
  37084. * @return {PositionalAudio} A reference to this instance.
  37085. */
  37086. setRolloffFactor( value ) {
  37087. this.panner.rolloffFactor = value;
  37088. return this;
  37089. }
  37090. /**
  37091. * Returns the current distance model.
  37092. *
  37093. * @return {('linear'|'inverse'|'exponential')} The distance model.
  37094. */
  37095. getDistanceModel() {
  37096. return this.panner.distanceModel;
  37097. }
  37098. /**
  37099. * Defines which algorithm to use to reduce the volume of the audio source
  37100. * as it moves away from the listener.
  37101. *
  37102. * Read [the spec](https://www.w3.org/TR/webaudio-1.1/#enumdef-distancemodeltype)
  37103. * for more details.
  37104. *
  37105. * @param {('linear'|'inverse'|'exponential')} value - The distance model to set.
  37106. * @return {PositionalAudio} A reference to this instance.
  37107. */
  37108. setDistanceModel( value ) {
  37109. this.panner.distanceModel = value;
  37110. return this;
  37111. }
  37112. /**
  37113. * Returns the current max distance.
  37114. *
  37115. * @return {number} The max distance.
  37116. */
  37117. getMaxDistance() {
  37118. return this.panner.maxDistance;
  37119. }
  37120. /**
  37121. * Defines the maximum distance between the audio source and the listener,
  37122. * after which the volume is not reduced any further.
  37123. *
  37124. * This value is used only by the `linear` distance model.
  37125. *
  37126. * @param {number} value - The max distance.
  37127. * @return {PositionalAudio} A reference to this instance.
  37128. */
  37129. setMaxDistance( value ) {
  37130. this.panner.maxDistance = value;
  37131. return this;
  37132. }
  37133. /**
  37134. * Sets the directional cone in which the audio can be listened.
  37135. *
  37136. * @param {number} coneInnerAngle - An angle, in degrees, of a cone inside of which there will be no volume reduction.
  37137. * @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.
  37138. * @param {number} coneOuterGain - The amount of volume reduction outside the cone defined by the `coneOuterAngle`. When set to `0`, no sound can be heard.
  37139. * @return {PositionalAudio} A reference to this instance.
  37140. */
  37141. setDirectionalCone( coneInnerAngle, coneOuterAngle, coneOuterGain ) {
  37142. this.panner.coneInnerAngle = coneInnerAngle;
  37143. this.panner.coneOuterAngle = coneOuterAngle;
  37144. this.panner.coneOuterGain = coneOuterGain;
  37145. return this;
  37146. }
  37147. updateMatrixWorld( force ) {
  37148. super.updateMatrixWorld( force );
  37149. if ( this.hasPlaybackControl === true && this.isPlaying === false ) return;
  37150. this.matrixWorld.decompose( _position, _quaternion, _scale );
  37151. _orientation.set( 0, 0, 1 ).applyQuaternion( _quaternion );
  37152. const panner = this.panner;
  37153. if ( panner.positionX ) {
  37154. // code path for Chrome and Firefox (see #14393)
  37155. const endTime = this.context.currentTime + this.listener.timeDelta;
  37156. panner.positionX.linearRampToValueAtTime( _position.x, endTime );
  37157. panner.positionY.linearRampToValueAtTime( _position.y, endTime );
  37158. panner.positionZ.linearRampToValueAtTime( _position.z, endTime );
  37159. panner.orientationX.linearRampToValueAtTime( _orientation.x, endTime );
  37160. panner.orientationY.linearRampToValueAtTime( _orientation.y, endTime );
  37161. panner.orientationZ.linearRampToValueAtTime( _orientation.z, endTime );
  37162. } else {
  37163. panner.setPosition( _position.x, _position.y, _position.z );
  37164. panner.setOrientation( _orientation.x, _orientation.y, _orientation.z );
  37165. }
  37166. }
  37167. }
  37168. /**
  37169. * This class can be used to analyse audio data.
  37170. *
  37171. * ```js
  37172. * // create an AudioListener and add it to the camera
  37173. * const listener = new THREE.AudioListener();
  37174. * camera.add( listener );
  37175. *
  37176. * // create an Audio source
  37177. * const sound = new THREE.Audio( listener );
  37178. *
  37179. * // load a sound and set it as the Audio object's buffer
  37180. * const audioLoader = new THREE.AudioLoader();
  37181. * audioLoader.load( 'sounds/ambient.ogg', function( buffer ) {
  37182. * sound.setBuffer( buffer );
  37183. * sound.setLoop(true);
  37184. * sound.setVolume(0.5);
  37185. * sound.play();
  37186. * });
  37187. *
  37188. * // create an AudioAnalyser, passing in the sound and desired fftSize
  37189. * const analyser = new THREE.AudioAnalyser( sound, 32 );
  37190. *
  37191. * // get the average frequency of the sound
  37192. * const data = analyser.getAverageFrequency();
  37193. * ```
  37194. */
  37195. class AudioAnalyser {
  37196. /**
  37197. * Constructs a new audio analyzer.
  37198. *
  37199. * @param {Audio} audio - The audio to analyze.
  37200. * @param {number} [fftSize=2048] - The window size in samples that is used when performing a Fast Fourier Transform (FFT) to get frequency domain data.
  37201. */
  37202. constructor( audio, fftSize = 2048 ) {
  37203. /**
  37204. * The global audio listener.
  37205. *
  37206. * @type {AnalyserNode}
  37207. */
  37208. this.analyser = audio.context.createAnalyser();
  37209. this.analyser.fftSize = fftSize;
  37210. /**
  37211. * Holds the analyzed data.
  37212. *
  37213. * @type {Uint8Array}
  37214. */
  37215. this.data = new Uint8Array( this.analyser.frequencyBinCount );
  37216. audio.getOutput().connect( this.analyser );
  37217. }
  37218. /**
  37219. * Returns an array with frequency data of the audio.
  37220. *
  37221. * Each item in the array represents the decibel value for a specific frequency.
  37222. * The frequencies are spread linearly from 0 to 1/2 of the sample rate.
  37223. * For example, for 48000 sample rate, the last item of the array will represent
  37224. * the decibel value for 24000 Hz.
  37225. *
  37226. * @return {Uint8Array} The frequency data.
  37227. */
  37228. getFrequencyData() {
  37229. this.analyser.getByteFrequencyData( this.data );
  37230. return this.data;
  37231. }
  37232. /**
  37233. * Returns the average of the frequencies returned by {@link AudioAnalyser#getFrequencyData}.
  37234. *
  37235. * @return {number} The average frequency.
  37236. */
  37237. getAverageFrequency() {
  37238. let value = 0;
  37239. const data = this.getFrequencyData();
  37240. for ( let i = 0; i < data.length; i ++ ) {
  37241. value += data[ i ];
  37242. }
  37243. return value / data.length;
  37244. }
  37245. }
  37246. /**
  37247. * Buffered scene graph property that allows weighted accumulation; used internally.
  37248. */
  37249. class PropertyMixer {
  37250. /**
  37251. * Constructs a new property mixer.
  37252. *
  37253. * @param {PropertyBinding} binding - The property binding.
  37254. * @param {string} typeName - The keyframe track type name.
  37255. * @param {number} valueSize - The keyframe track value size.
  37256. */
  37257. constructor( binding, typeName, valueSize ) {
  37258. /**
  37259. * The property binding.
  37260. *
  37261. * @type {PropertyBinding}
  37262. */
  37263. this.binding = binding;
  37264. /**
  37265. * The keyframe track value size.
  37266. *
  37267. * @type {number}
  37268. */
  37269. this.valueSize = valueSize;
  37270. let mixFunction,
  37271. mixFunctionAdditive,
  37272. setIdentity;
  37273. // buffer layout: [ incoming | accu0 | accu1 | orig | addAccu | (optional work) ]
  37274. //
  37275. // interpolators can use .buffer as their .result
  37276. // the data then goes to 'incoming'
  37277. //
  37278. // 'accu0' and 'accu1' are used frame-interleaved for
  37279. // the cumulative result and are compared to detect
  37280. // changes
  37281. //
  37282. // 'orig' stores the original state of the property
  37283. //
  37284. // 'add' is used for additive cumulative results
  37285. //
  37286. // 'work' is optional and is only present for quaternion types. It is used
  37287. // to store intermediate quaternion multiplication results
  37288. switch ( typeName ) {
  37289. case 'quaternion':
  37290. mixFunction = this._slerp;
  37291. mixFunctionAdditive = this._slerpAdditive;
  37292. setIdentity = this._setAdditiveIdentityQuaternion;
  37293. this.buffer = new Float64Array( valueSize * 6 );
  37294. this._workIndex = 5;
  37295. break;
  37296. case 'string':
  37297. case 'bool':
  37298. mixFunction = this._select;
  37299. // Use the regular mix function and for additive on these types,
  37300. // additive is not relevant for non-numeric types
  37301. mixFunctionAdditive = this._select;
  37302. setIdentity = this._setAdditiveIdentityOther;
  37303. this.buffer = new Array( valueSize * 5 );
  37304. break;
  37305. default:
  37306. mixFunction = this._lerp;
  37307. mixFunctionAdditive = this._lerpAdditive;
  37308. setIdentity = this._setAdditiveIdentityNumeric;
  37309. this.buffer = new Float64Array( valueSize * 5 );
  37310. }
  37311. this._mixBufferRegion = mixFunction;
  37312. this._mixBufferRegionAdditive = mixFunctionAdditive;
  37313. this._setIdentity = setIdentity;
  37314. this._origIndex = 3;
  37315. this._addIndex = 4;
  37316. /**
  37317. * TODO
  37318. *
  37319. * @type {number}
  37320. * @default 0
  37321. */
  37322. this.cumulativeWeight = 0;
  37323. /**
  37324. * TODO
  37325. *
  37326. * @type {number}
  37327. * @default 0
  37328. */
  37329. this.cumulativeWeightAdditive = 0;
  37330. /**
  37331. * TODO
  37332. *
  37333. * @type {number}
  37334. * @default 0
  37335. */
  37336. this.useCount = 0;
  37337. /**
  37338. * TODO
  37339. *
  37340. * @type {number}
  37341. * @default 0
  37342. */
  37343. this.referenceCount = 0;
  37344. }
  37345. /**
  37346. * Accumulates data in the `incoming` region into `accu<i>`.
  37347. *
  37348. * @param {number} accuIndex - The accumulation index.
  37349. * @param {number} weight - The weight.
  37350. */
  37351. accumulate( accuIndex, weight ) {
  37352. // note: happily accumulating nothing when weight = 0, the caller knows
  37353. // the weight and shouldn't have made the call in the first place
  37354. const buffer = this.buffer,
  37355. stride = this.valueSize,
  37356. offset = accuIndex * stride + stride;
  37357. let currentWeight = this.cumulativeWeight;
  37358. if ( currentWeight === 0 ) {
  37359. // accuN := incoming * weight
  37360. for ( let i = 0; i !== stride; ++ i ) {
  37361. buffer[ offset + i ] = buffer[ i ];
  37362. }
  37363. currentWeight = weight;
  37364. } else {
  37365. // accuN := accuN + incoming * weight
  37366. currentWeight += weight;
  37367. const mix = weight / currentWeight;
  37368. this._mixBufferRegion( buffer, offset, 0, mix, stride );
  37369. }
  37370. this.cumulativeWeight = currentWeight;
  37371. }
  37372. /**
  37373. * Accumulates data in the `incoming` region into `add`.
  37374. *
  37375. * @param {number} weight - The weight.
  37376. */
  37377. accumulateAdditive( weight ) {
  37378. const buffer = this.buffer,
  37379. stride = this.valueSize,
  37380. offset = stride * this._addIndex;
  37381. if ( this.cumulativeWeightAdditive === 0 ) {
  37382. // add = identity
  37383. this._setIdentity();
  37384. }
  37385. // add := add + incoming * weight
  37386. this._mixBufferRegionAdditive( buffer, offset, 0, weight, stride );
  37387. this.cumulativeWeightAdditive += weight;
  37388. }
  37389. /**
  37390. * Applies the state of `accu<i>` to the binding when accus differ.
  37391. *
  37392. * @param {number} accuIndex - The accumulation index.
  37393. */
  37394. apply( accuIndex ) {
  37395. const stride = this.valueSize,
  37396. buffer = this.buffer,
  37397. offset = accuIndex * stride + stride,
  37398. weight = this.cumulativeWeight,
  37399. weightAdditive = this.cumulativeWeightAdditive,
  37400. binding = this.binding;
  37401. this.cumulativeWeight = 0;
  37402. this.cumulativeWeightAdditive = 0;
  37403. if ( weight < 1 ) {
  37404. // accuN := accuN + original * ( 1 - cumulativeWeight )
  37405. const originalValueOffset = stride * this._origIndex;
  37406. this._mixBufferRegion(
  37407. buffer, offset, originalValueOffset, 1 - weight, stride );
  37408. }
  37409. if ( weightAdditive > 0 ) {
  37410. // accuN := accuN + additive accuN
  37411. this._mixBufferRegionAdditive( buffer, offset, this._addIndex * stride, 1, stride );
  37412. }
  37413. for ( let i = stride, e = stride + stride; i !== e; ++ i ) {
  37414. if ( buffer[ i ] !== buffer[ i + stride ] ) {
  37415. // value has changed -> update scene graph
  37416. binding.setValue( buffer, offset );
  37417. break;
  37418. }
  37419. }
  37420. }
  37421. /**
  37422. * Remembers the state of the bound property and copy it to both accus.
  37423. */
  37424. saveOriginalState() {
  37425. const binding = this.binding;
  37426. const buffer = this.buffer,
  37427. stride = this.valueSize,
  37428. originalValueOffset = stride * this._origIndex;
  37429. binding.getValue( buffer, originalValueOffset );
  37430. // accu[0..1] := orig -- initially detect changes against the original
  37431. for ( let i = stride, e = originalValueOffset; i !== e; ++ i ) {
  37432. buffer[ i ] = buffer[ originalValueOffset + ( i % stride ) ];
  37433. }
  37434. // Add to identity for additive
  37435. this._setIdentity();
  37436. this.cumulativeWeight = 0;
  37437. this.cumulativeWeightAdditive = 0;
  37438. }
  37439. /**
  37440. * Applies the state previously taken via {@link PropertyMixer#saveOriginalState} to the binding.
  37441. */
  37442. restoreOriginalState() {
  37443. const originalValueOffset = this.valueSize * 3;
  37444. this.binding.setValue( this.buffer, originalValueOffset );
  37445. }
  37446. // internals
  37447. _setAdditiveIdentityNumeric() {
  37448. const startIndex = this._addIndex * this.valueSize;
  37449. const endIndex = startIndex + this.valueSize;
  37450. for ( let i = startIndex; i < endIndex; i ++ ) {
  37451. this.buffer[ i ] = 0;
  37452. }
  37453. }
  37454. _setAdditiveIdentityQuaternion() {
  37455. this._setAdditiveIdentityNumeric();
  37456. this.buffer[ this._addIndex * this.valueSize + 3 ] = 1;
  37457. }
  37458. _setAdditiveIdentityOther() {
  37459. const startIndex = this._origIndex * this.valueSize;
  37460. const targetIndex = this._addIndex * this.valueSize;
  37461. for ( let i = 0; i < this.valueSize; i ++ ) {
  37462. this.buffer[ targetIndex + i ] = this.buffer[ startIndex + i ];
  37463. }
  37464. }
  37465. // mix functions
  37466. _select( buffer, dstOffset, srcOffset, t, stride ) {
  37467. if ( t >= 0.5 ) {
  37468. for ( let i = 0; i !== stride; ++ i ) {
  37469. buffer[ dstOffset + i ] = buffer[ srcOffset + i ];
  37470. }
  37471. }
  37472. }
  37473. _slerp( buffer, dstOffset, srcOffset, t ) {
  37474. Quaternion.slerpFlat( buffer, dstOffset, buffer, dstOffset, buffer, srcOffset, t );
  37475. }
  37476. _slerpAdditive( buffer, dstOffset, srcOffset, t, stride ) {
  37477. const workOffset = this._workIndex * stride;
  37478. // Store result in intermediate buffer offset
  37479. Quaternion.multiplyQuaternionsFlat( buffer, workOffset, buffer, dstOffset, buffer, srcOffset );
  37480. // Slerp to the intermediate result
  37481. Quaternion.slerpFlat( buffer, dstOffset, buffer, dstOffset, buffer, workOffset, t );
  37482. }
  37483. _lerp( buffer, dstOffset, srcOffset, t, stride ) {
  37484. const s = 1 - t;
  37485. for ( let i = 0; i !== stride; ++ i ) {
  37486. const j = dstOffset + i;
  37487. buffer[ j ] = buffer[ j ] * s + buffer[ srcOffset + i ] * t;
  37488. }
  37489. }
  37490. _lerpAdditive( buffer, dstOffset, srcOffset, t, stride ) {
  37491. for ( let i = 0; i !== stride; ++ i ) {
  37492. const j = dstOffset + i;
  37493. buffer[ j ] = buffer[ j ] + buffer[ srcOffset + i ] * t;
  37494. }
  37495. }
  37496. }
  37497. // Characters [].:/ are reserved for track binding syntax.
  37498. const _RESERVED_CHARS_RE = '\\[\\]\\.:\\/';
  37499. const _reservedRe = new RegExp( '[' + _RESERVED_CHARS_RE + ']', 'g' );
  37500. // Attempts to allow node names from any language. ES5's `\w` regexp matches
  37501. // only latin characters, and the unicode \p{L} is not yet supported. So
  37502. // instead, we exclude reserved characters and match everything else.
  37503. const _wordChar = '[^' + _RESERVED_CHARS_RE + ']';
  37504. const _wordCharOrDot = '[^' + _RESERVED_CHARS_RE.replace( '\\.', '' ) + ']';
  37505. // Parent directories, delimited by '/' or ':'. Currently unused, but must
  37506. // be matched to parse the rest of the track name.
  37507. const _directoryRe = /*@__PURE__*/ /((?:WC+[\/:])*)/.source.replace( 'WC', _wordChar );
  37508. // Target node. May contain word characters (a-zA-Z0-9_) and '.' or '-'.
  37509. const _nodeRe = /*@__PURE__*/ /(WCOD+)?/.source.replace( 'WCOD', _wordCharOrDot );
  37510. // Object on target node, and accessor. May not contain reserved
  37511. // characters. Accessor may contain any character except closing bracket.
  37512. const _objectRe = /*@__PURE__*/ /(?:\.(WC+)(?:\[(.+)\])?)?/.source.replace( 'WC', _wordChar );
  37513. // Property and accessor. May not contain reserved characters. Accessor may
  37514. // contain any non-bracket characters.
  37515. const _propertyRe = /*@__PURE__*/ /\.(WC+)(?:\[(.+)\])?/.source.replace( 'WC', _wordChar );
  37516. const _trackRe = new RegExp( ''
  37517. + '^'
  37518. + _directoryRe
  37519. + _nodeRe
  37520. + _objectRe
  37521. + _propertyRe
  37522. + '$'
  37523. );
  37524. const _supportedObjectNames = [ 'material', 'materials', 'bones', 'map' ];
  37525. class Composite {
  37526. constructor( targetGroup, path, optionalParsedPath ) {
  37527. const parsedPath = optionalParsedPath || PropertyBinding.parseTrackName( path );
  37528. this._targetGroup = targetGroup;
  37529. this._bindings = targetGroup.subscribe_( path, parsedPath );
  37530. }
  37531. getValue( array, offset ) {
  37532. this.bind(); // bind all binding
  37533. const firstValidIndex = this._targetGroup.nCachedObjects_,
  37534. binding = this._bindings[ firstValidIndex ];
  37535. // and only call .getValue on the first
  37536. if ( binding !== undefined ) binding.getValue( array, offset );
  37537. }
  37538. setValue( array, offset ) {
  37539. const bindings = this._bindings;
  37540. for ( let i = this._targetGroup.nCachedObjects_, n = bindings.length; i !== n; ++ i ) {
  37541. bindings[ i ].setValue( array, offset );
  37542. }
  37543. }
  37544. bind() {
  37545. const bindings = this._bindings;
  37546. for ( let i = this._targetGroup.nCachedObjects_, n = bindings.length; i !== n; ++ i ) {
  37547. bindings[ i ].bind();
  37548. }
  37549. }
  37550. unbind() {
  37551. const bindings = this._bindings;
  37552. for ( let i = this._targetGroup.nCachedObjects_, n = bindings.length; i !== n; ++ i ) {
  37553. bindings[ i ].unbind();
  37554. }
  37555. }
  37556. }
  37557. // Note: This class uses a State pattern on a per-method basis:
  37558. // 'bind' sets 'this.getValue' / 'setValue' and shadows the
  37559. // prototype version of these methods with one that represents
  37560. // the bound state. When the property is not found, the methods
  37561. // become no-ops.
  37562. /**
  37563. * This holds a reference to a real property in the scene graph; used internally.
  37564. */
  37565. class PropertyBinding {
  37566. /**
  37567. * Constructs a new property binding.
  37568. *
  37569. * @param {Object} rootNode - The root node.
  37570. * @param {string} path - The path.
  37571. * @param {?Object} [parsedPath] - The parsed path.
  37572. */
  37573. constructor( rootNode, path, parsedPath ) {
  37574. /**
  37575. * The object path to the animated property.
  37576. *
  37577. * @type {string}
  37578. */
  37579. this.path = path;
  37580. /**
  37581. * An object holding information about the path.
  37582. *
  37583. * @type {Object}
  37584. */
  37585. this.parsedPath = parsedPath || PropertyBinding.parseTrackName( path );
  37586. /**
  37587. * The object owns the animated property.
  37588. *
  37589. * @type {?Object}
  37590. */
  37591. this.node = PropertyBinding.findNode( rootNode, this.parsedPath.nodeName );
  37592. /**
  37593. * The root node.
  37594. *
  37595. * @type {Object3D|Skeleton}
  37596. */
  37597. this.rootNode = rootNode;
  37598. // initial state of these methods that calls 'bind'
  37599. this.getValue = this._getValue_unbound;
  37600. this.setValue = this._setValue_unbound;
  37601. }
  37602. /**
  37603. * Factory method for creating a property binding from the given parameters.
  37604. *
  37605. * @static
  37606. * @param {Object} root - The root node.
  37607. * @param {string} path - The path.
  37608. * @param {?Object} [parsedPath] - The parsed path.
  37609. * @return {PropertyBinding|Composite} The created property binding or composite.
  37610. */
  37611. static create( root, path, parsedPath ) {
  37612. if ( ! ( root && root.isAnimationObjectGroup ) ) {
  37613. return new PropertyBinding( root, path, parsedPath );
  37614. } else {
  37615. return new PropertyBinding.Composite( root, path, parsedPath );
  37616. }
  37617. }
  37618. /**
  37619. * Replaces spaces with underscores and removes unsupported characters from
  37620. * node names, to ensure compatibility with parseTrackName().
  37621. *
  37622. * @param {string} name - Node name to be sanitized.
  37623. * @return {string} The sanitized node name.
  37624. */
  37625. static sanitizeNodeName( name ) {
  37626. return name.replace( /\s/g, '_' ).replace( _reservedRe, '' );
  37627. }
  37628. /**
  37629. * Parses the given track name (an object path to an animated property) and
  37630. * returns an object with information about the path. Matches strings in the following forms:
  37631. *
  37632. * - nodeName.property
  37633. * - nodeName.property[accessor]
  37634. * - nodeName.material.property[accessor]
  37635. * - uuid.property[accessor]
  37636. * - uuid.objectName[objectIndex].propertyName[propertyIndex]
  37637. * - parentName/nodeName.property
  37638. * - parentName/parentName/nodeName.property[index]
  37639. * - .bone[Armature.DEF_cog].position
  37640. * - scene:helium_balloon_model:helium_balloon_model.position
  37641. *
  37642. * @static
  37643. * @param {string} trackName - The track name to parse.
  37644. * @return {Object} The parsed track name as an object.
  37645. */
  37646. static parseTrackName( trackName ) {
  37647. const matches = _trackRe.exec( trackName );
  37648. if ( matches === null ) {
  37649. throw new Error( 'PropertyBinding: Cannot parse trackName: ' + trackName );
  37650. }
  37651. const results = {
  37652. // directoryName: matches[ 1 ], // (tschw) currently unused
  37653. nodeName: matches[ 2 ],
  37654. objectName: matches[ 3 ],
  37655. objectIndex: matches[ 4 ],
  37656. propertyName: matches[ 5 ], // required
  37657. propertyIndex: matches[ 6 ]
  37658. };
  37659. const lastDot = results.nodeName && results.nodeName.lastIndexOf( '.' );
  37660. if ( lastDot !== undefined && lastDot !== -1 ) {
  37661. const objectName = results.nodeName.substring( lastDot + 1 );
  37662. // Object names must be checked against an allowlist. Otherwise, there
  37663. // is no way to parse 'foo.bar.baz': 'baz' must be a property, but
  37664. // 'bar' could be the objectName, or part of a nodeName (which can
  37665. // include '.' characters).
  37666. if ( _supportedObjectNames.indexOf( objectName ) !== -1 ) {
  37667. results.nodeName = results.nodeName.substring( 0, lastDot );
  37668. results.objectName = objectName;
  37669. }
  37670. }
  37671. if ( results.propertyName === null || results.propertyName.length === 0 ) {
  37672. throw new Error( 'PropertyBinding: can not parse propertyName from trackName: ' + trackName );
  37673. }
  37674. return results;
  37675. }
  37676. /**
  37677. * Searches for a node in the hierarchy of the given root object by the given
  37678. * node name.
  37679. *
  37680. * @static
  37681. * @param {Object} root - The root object.
  37682. * @param {string|number} nodeName - The name of the node.
  37683. * @return {?Object} The found node. Returns `null` if no object was found.
  37684. */
  37685. static findNode( root, nodeName ) {
  37686. if ( nodeName === undefined || nodeName === '' || nodeName === '.' || nodeName === -1 || nodeName === root.name || nodeName === root.uuid ) {
  37687. return root;
  37688. }
  37689. // search into skeleton bones.
  37690. if ( root.skeleton ) {
  37691. const bone = root.skeleton.getBoneByName( nodeName );
  37692. if ( bone !== undefined ) {
  37693. return bone;
  37694. }
  37695. }
  37696. // search into node subtree.
  37697. if ( root.children ) {
  37698. const searchNodeSubtree = function ( children ) {
  37699. for ( let i = 0; i < children.length; i ++ ) {
  37700. const childNode = children[ i ];
  37701. if ( childNode.name === nodeName || childNode.uuid === nodeName ) {
  37702. return childNode;
  37703. }
  37704. const result = searchNodeSubtree( childNode.children );
  37705. if ( result ) return result;
  37706. }
  37707. return null;
  37708. };
  37709. const subTreeNode = searchNodeSubtree( root.children );
  37710. if ( subTreeNode ) {
  37711. return subTreeNode;
  37712. }
  37713. }
  37714. return null;
  37715. }
  37716. // these are used to "bind" a nonexistent property
  37717. _getValue_unavailable() {}
  37718. _setValue_unavailable() {}
  37719. // Getters
  37720. _getValue_direct( buffer, offset ) {
  37721. buffer[ offset ] = this.targetObject[ this.propertyName ];
  37722. }
  37723. _getValue_array( buffer, offset ) {
  37724. const source = this.resolvedProperty;
  37725. for ( let i = 0, n = source.length; i !== n; ++ i ) {
  37726. buffer[ offset ++ ] = source[ i ];
  37727. }
  37728. }
  37729. _getValue_arrayElement( buffer, offset ) {
  37730. buffer[ offset ] = this.resolvedProperty[ this.propertyIndex ];
  37731. }
  37732. _getValue_toArray( buffer, offset ) {
  37733. this.resolvedProperty.toArray( buffer, offset );
  37734. }
  37735. // Direct
  37736. _setValue_direct( buffer, offset ) {
  37737. this.targetObject[ this.propertyName ] = buffer[ offset ];
  37738. }
  37739. _setValue_direct_setNeedsUpdate( buffer, offset ) {
  37740. this.targetObject[ this.propertyName ] = buffer[ offset ];
  37741. this.targetObject.needsUpdate = true;
  37742. }
  37743. _setValue_direct_setMatrixWorldNeedsUpdate( buffer, offset ) {
  37744. this.targetObject[ this.propertyName ] = buffer[ offset ];
  37745. this.targetObject.matrixWorldNeedsUpdate = true;
  37746. }
  37747. // EntireArray
  37748. _setValue_array( buffer, offset ) {
  37749. const dest = this.resolvedProperty;
  37750. for ( let i = 0, n = dest.length; i !== n; ++ i ) {
  37751. dest[ i ] = buffer[ offset ++ ];
  37752. }
  37753. }
  37754. _setValue_array_setNeedsUpdate( buffer, offset ) {
  37755. const dest = this.resolvedProperty;
  37756. for ( let i = 0, n = dest.length; i !== n; ++ i ) {
  37757. dest[ i ] = buffer[ offset ++ ];
  37758. }
  37759. this.targetObject.needsUpdate = true;
  37760. }
  37761. _setValue_array_setMatrixWorldNeedsUpdate( buffer, offset ) {
  37762. const dest = this.resolvedProperty;
  37763. for ( let i = 0, n = dest.length; i !== n; ++ i ) {
  37764. dest[ i ] = buffer[ offset ++ ];
  37765. }
  37766. this.targetObject.matrixWorldNeedsUpdate = true;
  37767. }
  37768. // ArrayElement
  37769. _setValue_arrayElement( buffer, offset ) {
  37770. this.resolvedProperty[ this.propertyIndex ] = buffer[ offset ];
  37771. }
  37772. _setValue_arrayElement_setNeedsUpdate( buffer, offset ) {
  37773. this.resolvedProperty[ this.propertyIndex ] = buffer[ offset ];
  37774. this.targetObject.needsUpdate = true;
  37775. }
  37776. _setValue_arrayElement_setMatrixWorldNeedsUpdate( buffer, offset ) {
  37777. this.resolvedProperty[ this.propertyIndex ] = buffer[ offset ];
  37778. this.targetObject.matrixWorldNeedsUpdate = true;
  37779. }
  37780. // HasToFromArray
  37781. _setValue_fromArray( buffer, offset ) {
  37782. this.resolvedProperty.fromArray( buffer, offset );
  37783. }
  37784. _setValue_fromArray_setNeedsUpdate( buffer, offset ) {
  37785. this.resolvedProperty.fromArray( buffer, offset );
  37786. this.targetObject.needsUpdate = true;
  37787. }
  37788. _setValue_fromArray_setMatrixWorldNeedsUpdate( buffer, offset ) {
  37789. this.resolvedProperty.fromArray( buffer, offset );
  37790. this.targetObject.matrixWorldNeedsUpdate = true;
  37791. }
  37792. _getValue_unbound( targetArray, offset ) {
  37793. this.bind();
  37794. this.getValue( targetArray, offset );
  37795. }
  37796. _setValue_unbound( sourceArray, offset ) {
  37797. this.bind();
  37798. this.setValue( sourceArray, offset );
  37799. }
  37800. /**
  37801. * Creates a getter / setter pair for the property tracked by this binding.
  37802. */
  37803. bind() {
  37804. let targetObject = this.node;
  37805. const parsedPath = this.parsedPath;
  37806. const objectName = parsedPath.objectName;
  37807. const propertyName = parsedPath.propertyName;
  37808. let propertyIndex = parsedPath.propertyIndex;
  37809. if ( ! targetObject ) {
  37810. targetObject = PropertyBinding.findNode( this.rootNode, parsedPath.nodeName );
  37811. this.node = targetObject;
  37812. }
  37813. // set fail state so we can just 'return' on error
  37814. this.getValue = this._getValue_unavailable;
  37815. this.setValue = this._setValue_unavailable;
  37816. // ensure there is a value node
  37817. if ( ! targetObject ) {
  37818. warn( 'PropertyBinding: No target node found for track: ' + this.path + '.' );
  37819. return;
  37820. }
  37821. if ( objectName ) {
  37822. let objectIndex = parsedPath.objectIndex;
  37823. // special cases were we need to reach deeper into the hierarchy to get the face materials....
  37824. switch ( objectName ) {
  37825. case 'materials':
  37826. if ( ! targetObject.material ) {
  37827. error( 'PropertyBinding: Can not bind to material as node does not have a material.', this );
  37828. return;
  37829. }
  37830. if ( ! targetObject.material.materials ) {
  37831. error( 'PropertyBinding: Can not bind to material.materials as node.material does not have a materials array.', this );
  37832. return;
  37833. }
  37834. targetObject = targetObject.material.materials;
  37835. break;
  37836. case 'bones':
  37837. if ( ! targetObject.skeleton ) {
  37838. error( 'PropertyBinding: Can not bind to bones as node does not have a skeleton.', this );
  37839. return;
  37840. }
  37841. // potential future optimization: skip this if propertyIndex is already an integer
  37842. // and convert the integer string to a true integer.
  37843. targetObject = targetObject.skeleton.bones;
  37844. // support resolving morphTarget names into indices.
  37845. for ( let i = 0; i < targetObject.length; i ++ ) {
  37846. if ( targetObject[ i ].name === objectIndex ) {
  37847. objectIndex = i;
  37848. break;
  37849. }
  37850. }
  37851. break;
  37852. case 'map':
  37853. if ( 'map' in targetObject ) {
  37854. targetObject = targetObject.map;
  37855. break;
  37856. }
  37857. if ( ! targetObject.material ) {
  37858. error( 'PropertyBinding: Can not bind to material as node does not have a material.', this );
  37859. return;
  37860. }
  37861. if ( ! targetObject.material.map ) {
  37862. error( 'PropertyBinding: Can not bind to material.map as node.material does not have a map.', this );
  37863. return;
  37864. }
  37865. targetObject = targetObject.material.map;
  37866. break;
  37867. default:
  37868. if ( targetObject[ objectName ] === undefined ) {
  37869. error( 'PropertyBinding: Can not bind to objectName of node undefined.', this );
  37870. return;
  37871. }
  37872. targetObject = targetObject[ objectName ];
  37873. }
  37874. if ( objectIndex !== undefined ) {
  37875. if ( targetObject[ objectIndex ] === undefined ) {
  37876. error( 'PropertyBinding: Trying to bind to objectIndex of objectName, but is undefined.', this, targetObject );
  37877. return;
  37878. }
  37879. targetObject = targetObject[ objectIndex ];
  37880. }
  37881. }
  37882. // resolve property
  37883. const nodeProperty = targetObject[ propertyName ];
  37884. if ( nodeProperty === undefined ) {
  37885. const nodeName = parsedPath.nodeName;
  37886. error( 'PropertyBinding: Trying to update property for track: ' + nodeName +
  37887. '.' + propertyName + ' but it wasn\'t found.', targetObject );
  37888. return;
  37889. }
  37890. // determine versioning scheme
  37891. let versioning = this.Versioning.None;
  37892. this.targetObject = targetObject;
  37893. if ( targetObject.isMaterial === true ) {
  37894. versioning = this.Versioning.NeedsUpdate;
  37895. } else if ( targetObject.isObject3D === true ) {
  37896. versioning = this.Versioning.MatrixWorldNeedsUpdate;
  37897. }
  37898. // determine how the property gets bound
  37899. let bindingType = this.BindingType.Direct;
  37900. if ( propertyIndex !== undefined ) {
  37901. // access a sub element of the property array (only primitives are supported right now)
  37902. if ( propertyName === 'morphTargetInfluences' ) {
  37903. // potential optimization, skip this if propertyIndex is already an integer, and convert the integer string to a true integer.
  37904. // support resolving morphTarget names into indices.
  37905. if ( ! targetObject.geometry ) {
  37906. error( 'PropertyBinding: Can not bind to morphTargetInfluences because node does not have a geometry.', this );
  37907. return;
  37908. }
  37909. if ( ! targetObject.geometry.morphAttributes ) {
  37910. error( 'PropertyBinding: Can not bind to morphTargetInfluences because node does not have a geometry.morphAttributes.', this );
  37911. return;
  37912. }
  37913. if ( targetObject.morphTargetDictionary[ propertyIndex ] !== undefined ) {
  37914. propertyIndex = targetObject.morphTargetDictionary[ propertyIndex ];
  37915. }
  37916. }
  37917. bindingType = this.BindingType.ArrayElement;
  37918. this.resolvedProperty = nodeProperty;
  37919. this.propertyIndex = propertyIndex;
  37920. } else if ( nodeProperty.fromArray !== undefined && nodeProperty.toArray !== undefined ) {
  37921. // must use copy for Object3D.Euler/Quaternion
  37922. bindingType = this.BindingType.HasFromToArray;
  37923. this.resolvedProperty = nodeProperty;
  37924. } else if ( Array.isArray( nodeProperty ) ) {
  37925. bindingType = this.BindingType.EntireArray;
  37926. this.resolvedProperty = nodeProperty;
  37927. } else {
  37928. this.propertyName = propertyName;
  37929. }
  37930. // select getter / setter
  37931. this.getValue = this.GetterByBindingType[ bindingType ];
  37932. this.setValue = this.SetterByBindingTypeAndVersioning[ bindingType ][ versioning ];
  37933. }
  37934. /**
  37935. * Unbinds the property.
  37936. */
  37937. unbind() {
  37938. this.node = null;
  37939. // back to the prototype version of getValue / setValue
  37940. // note: avoiding to mutate the shape of 'this' via 'delete'
  37941. this.getValue = this._getValue_unbound;
  37942. this.setValue = this._setValue_unbound;
  37943. }
  37944. }
  37945. PropertyBinding.Composite = Composite;
  37946. PropertyBinding.prototype.BindingType = {
  37947. Direct: 0,
  37948. EntireArray: 1,
  37949. ArrayElement: 2,
  37950. HasFromToArray: 3
  37951. };
  37952. PropertyBinding.prototype.Versioning = {
  37953. None: 0,
  37954. NeedsUpdate: 1,
  37955. MatrixWorldNeedsUpdate: 2
  37956. };
  37957. PropertyBinding.prototype.GetterByBindingType = [
  37958. PropertyBinding.prototype._getValue_direct,
  37959. PropertyBinding.prototype._getValue_array,
  37960. PropertyBinding.prototype._getValue_arrayElement,
  37961. PropertyBinding.prototype._getValue_toArray,
  37962. ];
  37963. PropertyBinding.prototype.SetterByBindingTypeAndVersioning = [
  37964. [
  37965. // Direct
  37966. PropertyBinding.prototype._setValue_direct,
  37967. PropertyBinding.prototype._setValue_direct_setNeedsUpdate,
  37968. PropertyBinding.prototype._setValue_direct_setMatrixWorldNeedsUpdate,
  37969. ], [
  37970. // EntireArray
  37971. PropertyBinding.prototype._setValue_array,
  37972. PropertyBinding.prototype._setValue_array_setNeedsUpdate,
  37973. PropertyBinding.prototype._setValue_array_setMatrixWorldNeedsUpdate,
  37974. ], [
  37975. // ArrayElement
  37976. PropertyBinding.prototype._setValue_arrayElement,
  37977. PropertyBinding.prototype._setValue_arrayElement_setNeedsUpdate,
  37978. PropertyBinding.prototype._setValue_arrayElement_setMatrixWorldNeedsUpdate,
  37979. ], [
  37980. // HasToFromArray
  37981. PropertyBinding.prototype._setValue_fromArray,
  37982. PropertyBinding.prototype._setValue_fromArray_setNeedsUpdate,
  37983. PropertyBinding.prototype._setValue_fromArray_setMatrixWorldNeedsUpdate,
  37984. ]
  37985. ];
  37986. /**
  37987. * A group of objects that receives a shared animation state.
  37988. *
  37989. * Usage:
  37990. *
  37991. * - Add objects you would otherwise pass as 'root' to the
  37992. * constructor or the .clipAction method of AnimationMixer.
  37993. * - Instead pass this object as 'root'.
  37994. * - You can also add and remove objects later when the mixer is running.
  37995. *
  37996. * Note:
  37997. *
  37998. * - Objects of this class appear as one object to the mixer,
  37999. * so cache control of the individual objects must be done on the group.
  38000. *
  38001. * Limitation:
  38002. *
  38003. * - The animated properties must be compatible among the all objects in the group.
  38004. * - A single property can either be controlled through a target group or directly, but not both.
  38005. */
  38006. class AnimationObjectGroup {
  38007. /**
  38008. * Constructs a new animation group.
  38009. *
  38010. * @param {...Object3D} arguments - An arbitrary number of 3D objects that share the same animation state.
  38011. */
  38012. constructor() {
  38013. /**
  38014. * This flag can be used for type testing.
  38015. *
  38016. * @type {boolean}
  38017. * @readonly
  38018. * @default true
  38019. */
  38020. this.isAnimationObjectGroup = true;
  38021. /**
  38022. * The UUID of the 3D object.
  38023. *
  38024. * @type {string}
  38025. * @readonly
  38026. */
  38027. this.uuid = generateUUID();
  38028. // cached objects followed by the active ones
  38029. this._objects = Array.prototype.slice.call( arguments );
  38030. this.nCachedObjects_ = 0; // threshold
  38031. // note: read by PropertyBinding.Composite
  38032. const indices = {};
  38033. this._indicesByUUID = indices; // for bookkeeping
  38034. for ( let i = 0, n = arguments.length; i !== n; ++ i ) {
  38035. indices[ arguments[ i ].uuid ] = i;
  38036. }
  38037. this._paths = []; // inside: string
  38038. this._parsedPaths = []; // inside: { we don't care, here }
  38039. this._bindings = []; // inside: Array< PropertyBinding >
  38040. this._bindingsIndicesByPath = {}; // inside: indices in these arrays
  38041. const scope = this;
  38042. this.stats = {
  38043. objects: {
  38044. get total() {
  38045. return scope._objects.length;
  38046. },
  38047. get inUse() {
  38048. return this.total - scope.nCachedObjects_;
  38049. }
  38050. },
  38051. get bindingsPerObject() {
  38052. return scope._bindings.length;
  38053. }
  38054. };
  38055. }
  38056. /**
  38057. * Adds an arbitrary number of objects to this animation group.
  38058. *
  38059. * @param {...Object3D} arguments - The 3D objects to add.
  38060. */
  38061. add() {
  38062. const objects = this._objects,
  38063. indicesByUUID = this._indicesByUUID,
  38064. paths = this._paths,
  38065. parsedPaths = this._parsedPaths,
  38066. bindings = this._bindings,
  38067. nBindings = bindings.length;
  38068. let knownObject = undefined,
  38069. nObjects = objects.length,
  38070. nCachedObjects = this.nCachedObjects_;
  38071. for ( let i = 0, n = arguments.length; i !== n; ++ i ) {
  38072. const object = arguments[ i ],
  38073. uuid = object.uuid;
  38074. let index = indicesByUUID[ uuid ];
  38075. if ( index === undefined ) {
  38076. // unknown object -> add it to the ACTIVE region
  38077. index = nObjects ++;
  38078. indicesByUUID[ uuid ] = index;
  38079. objects.push( object );
  38080. // accounting is done, now do the same for all bindings
  38081. for ( let j = 0, m = nBindings; j !== m; ++ j ) {
  38082. bindings[ j ].push( new PropertyBinding( object, paths[ j ], parsedPaths[ j ] ) );
  38083. }
  38084. } else if ( index < nCachedObjects ) {
  38085. knownObject = objects[ index ];
  38086. // move existing object to the ACTIVE region
  38087. const firstActiveIndex = -- nCachedObjects,
  38088. lastCachedObject = objects[ firstActiveIndex ];
  38089. indicesByUUID[ lastCachedObject.uuid ] = index;
  38090. objects[ index ] = lastCachedObject;
  38091. indicesByUUID[ uuid ] = firstActiveIndex;
  38092. objects[ firstActiveIndex ] = object;
  38093. // accounting is done, now do the same for all bindings
  38094. for ( let j = 0, m = nBindings; j !== m; ++ j ) {
  38095. const bindingsForPath = bindings[ j ],
  38096. lastCached = bindingsForPath[ firstActiveIndex ];
  38097. let binding = bindingsForPath[ index ];
  38098. bindingsForPath[ index ] = lastCached;
  38099. if ( binding === undefined ) {
  38100. // since we do not bother to create new bindings
  38101. // for objects that are cached, the binding may
  38102. // or may not exist
  38103. binding = new PropertyBinding( object, paths[ j ], parsedPaths[ j ] );
  38104. }
  38105. bindingsForPath[ firstActiveIndex ] = binding;
  38106. }
  38107. } else if ( objects[ index ] !== knownObject ) {
  38108. error( 'AnimationObjectGroup: Different objects with the same UUID ' +
  38109. 'detected. Clean the caches or recreate your infrastructure when reloading scenes.' );
  38110. } // else the object is already where we want it to be
  38111. } // for arguments
  38112. this.nCachedObjects_ = nCachedObjects;
  38113. }
  38114. /**
  38115. * Removes an arbitrary number of objects to this animation group
  38116. *
  38117. * @param {...Object3D} arguments - The 3D objects to remove.
  38118. */
  38119. remove() {
  38120. const objects = this._objects,
  38121. indicesByUUID = this._indicesByUUID,
  38122. bindings = this._bindings,
  38123. nBindings = bindings.length;
  38124. let nCachedObjects = this.nCachedObjects_;
  38125. for ( let i = 0, n = arguments.length; i !== n; ++ i ) {
  38126. const object = arguments[ i ],
  38127. uuid = object.uuid,
  38128. index = indicesByUUID[ uuid ];
  38129. if ( index !== undefined && index >= nCachedObjects ) {
  38130. // move existing object into the CACHED region
  38131. const lastCachedIndex = nCachedObjects ++,
  38132. firstActiveObject = objects[ lastCachedIndex ];
  38133. indicesByUUID[ firstActiveObject.uuid ] = index;
  38134. objects[ index ] = firstActiveObject;
  38135. indicesByUUID[ uuid ] = lastCachedIndex;
  38136. objects[ lastCachedIndex ] = object;
  38137. // accounting is done, now do the same for all bindings
  38138. for ( let j = 0, m = nBindings; j !== m; ++ j ) {
  38139. const bindingsForPath = bindings[ j ],
  38140. firstActive = bindingsForPath[ lastCachedIndex ],
  38141. binding = bindingsForPath[ index ];
  38142. bindingsForPath[ index ] = firstActive;
  38143. bindingsForPath[ lastCachedIndex ] = binding;
  38144. }
  38145. }
  38146. } // for arguments
  38147. this.nCachedObjects_ = nCachedObjects;
  38148. }
  38149. /**
  38150. * Deallocates all memory resources for the passed 3D objects of this animation group.
  38151. *
  38152. * @param {...Object3D} arguments - The 3D objects to uncache.
  38153. */
  38154. uncache() {
  38155. const objects = this._objects,
  38156. indicesByUUID = this._indicesByUUID,
  38157. bindings = this._bindings,
  38158. nBindings = bindings.length;
  38159. let nCachedObjects = this.nCachedObjects_,
  38160. nObjects = objects.length;
  38161. for ( let i = 0, n = arguments.length; i !== n; ++ i ) {
  38162. const object = arguments[ i ],
  38163. uuid = object.uuid,
  38164. index = indicesByUUID[ uuid ];
  38165. if ( index !== undefined ) {
  38166. delete indicesByUUID[ uuid ];
  38167. if ( index < nCachedObjects ) {
  38168. // object is cached, shrink the CACHED region
  38169. const firstActiveIndex = -- nCachedObjects,
  38170. lastCachedObject = objects[ firstActiveIndex ],
  38171. lastIndex = -- nObjects,
  38172. lastObject = objects[ lastIndex ];
  38173. // last cached object takes this object's place
  38174. indicesByUUID[ lastCachedObject.uuid ] = index;
  38175. objects[ index ] = lastCachedObject;
  38176. // last object goes to the activated slot and pop
  38177. indicesByUUID[ lastObject.uuid ] = firstActiveIndex;
  38178. objects[ firstActiveIndex ] = lastObject;
  38179. objects.pop();
  38180. // accounting is done, now do the same for all bindings
  38181. for ( let j = 0, m = nBindings; j !== m; ++ j ) {
  38182. const bindingsForPath = bindings[ j ],
  38183. lastCached = bindingsForPath[ firstActiveIndex ],
  38184. last = bindingsForPath[ lastIndex ];
  38185. bindingsForPath[ index ] = lastCached;
  38186. bindingsForPath[ firstActiveIndex ] = last;
  38187. bindingsForPath.pop();
  38188. }
  38189. } else {
  38190. // object is active, just swap with the last and pop
  38191. const lastIndex = -- nObjects,
  38192. lastObject = objects[ lastIndex ];
  38193. if ( lastIndex > 0 ) {
  38194. indicesByUUID[ lastObject.uuid ] = index;
  38195. }
  38196. objects[ index ] = lastObject;
  38197. objects.pop();
  38198. // accounting is done, now do the same for all bindings
  38199. for ( let j = 0, m = nBindings; j !== m; ++ j ) {
  38200. const bindingsForPath = bindings[ j ];
  38201. bindingsForPath[ index ] = bindingsForPath[ lastIndex ];
  38202. bindingsForPath.pop();
  38203. }
  38204. } // cached or active
  38205. } // if object is known
  38206. } // for arguments
  38207. this.nCachedObjects_ = nCachedObjects;
  38208. }
  38209. // Internal interface used by befriended PropertyBinding.Composite:
  38210. subscribe_( path, parsedPath ) {
  38211. // returns an array of bindings for the given path that is changed
  38212. // according to the contained objects in the group
  38213. const indicesByPath = this._bindingsIndicesByPath;
  38214. let index = indicesByPath[ path ];
  38215. const bindings = this._bindings;
  38216. if ( index !== undefined ) return bindings[ index ];
  38217. const paths = this._paths,
  38218. parsedPaths = this._parsedPaths,
  38219. objects = this._objects,
  38220. nObjects = objects.length,
  38221. nCachedObjects = this.nCachedObjects_,
  38222. bindingsForPath = new Array( nObjects );
  38223. index = bindings.length;
  38224. indicesByPath[ path ] = index;
  38225. paths.push( path );
  38226. parsedPaths.push( parsedPath );
  38227. bindings.push( bindingsForPath );
  38228. for ( let i = nCachedObjects, n = objects.length; i !== n; ++ i ) {
  38229. const object = objects[ i ];
  38230. bindingsForPath[ i ] = new PropertyBinding( object, path, parsedPath );
  38231. }
  38232. return bindingsForPath;
  38233. }
  38234. unsubscribe_( path ) {
  38235. // tells the group to forget about a property path and no longer
  38236. // update the array previously obtained with 'subscribe_'
  38237. const indicesByPath = this._bindingsIndicesByPath,
  38238. index = indicesByPath[ path ];
  38239. if ( index !== undefined ) {
  38240. const paths = this._paths,
  38241. parsedPaths = this._parsedPaths,
  38242. bindings = this._bindings,
  38243. lastBindingsIndex = bindings.length - 1,
  38244. lastBindings = bindings[ lastBindingsIndex ],
  38245. lastBindingsPath = path[ lastBindingsIndex ];
  38246. indicesByPath[ lastBindingsPath ] = index;
  38247. bindings[ index ] = lastBindings;
  38248. bindings.pop();
  38249. parsedPaths[ index ] = parsedPaths[ lastBindingsIndex ];
  38250. parsedPaths.pop();
  38251. paths[ index ] = paths[ lastBindingsIndex ];
  38252. paths.pop();
  38253. }
  38254. }
  38255. }
  38256. /**
  38257. * An instance of `AnimationAction` schedules the playback of an animation which is
  38258. * stored in {@link AnimationClip}.
  38259. */
  38260. class AnimationAction {
  38261. /**
  38262. * Constructs a new animation action.
  38263. *
  38264. * @param {AnimationMixer} mixer - The mixer that is controlled by this action.
  38265. * @param {AnimationClip} clip - The animation clip that holds the actual keyframes.
  38266. * @param {?Object3D} [localRoot=null] - The root object on which this action is performed.
  38267. * @param {(NormalAnimationBlendMode|AdditiveAnimationBlendMode)} [blendMode] - The blend mode.
  38268. */
  38269. constructor( mixer, clip, localRoot = null, blendMode = clip.blendMode ) {
  38270. this._mixer = mixer;
  38271. this._clip = clip;
  38272. this._localRoot = localRoot;
  38273. /**
  38274. * Defines how the animation is blended/combined when two or more animations
  38275. * are simultaneously played.
  38276. *
  38277. * @type {(NormalAnimationBlendMode|AdditiveAnimationBlendMode)}
  38278. */
  38279. this.blendMode = blendMode;
  38280. const tracks = clip.tracks,
  38281. nTracks = tracks.length,
  38282. interpolants = new Array( nTracks );
  38283. const interpolantSettings = {
  38284. endingStart: ZeroCurvatureEnding,
  38285. endingEnd: ZeroCurvatureEnding
  38286. };
  38287. for ( let i = 0; i !== nTracks; ++ i ) {
  38288. const interpolant = tracks[ i ].createInterpolant( null );
  38289. interpolants[ i ] = interpolant;
  38290. interpolant.settings = interpolantSettings;
  38291. }
  38292. this._interpolantSettings = interpolantSettings;
  38293. this._interpolants = interpolants; // bound by the mixer
  38294. // inside: PropertyMixer (managed by the mixer)
  38295. this._propertyBindings = new Array( nTracks );
  38296. this._cacheIndex = null; // for the memory manager
  38297. this._byClipCacheIndex = null; // for the memory manager
  38298. this._timeScaleInterpolant = null;
  38299. this._weightInterpolant = null;
  38300. /**
  38301. * The loop mode, set via {@link AnimationAction#setLoop}.
  38302. *
  38303. * @type {(LoopRepeat|LoopOnce|LoopPingPong)}
  38304. * @default LoopRepeat
  38305. */
  38306. this.loop = LoopRepeat;
  38307. this._loopCount = -1;
  38308. // global mixer time when the action is to be started
  38309. // it's set back to 'null' upon start of the action
  38310. this._startTime = null;
  38311. /**
  38312. * The local time of this action (in seconds, starting with `0`).
  38313. *
  38314. * The value gets clamped or wrapped to `[0,clip.duration]` (according to the
  38315. * loop state).
  38316. *
  38317. * @type {number}
  38318. * @default Infinity
  38319. */
  38320. this.time = 0;
  38321. /**
  38322. * Scaling factor for the {@link AnimationAction#time}. A value of `0` causes the
  38323. * animation to pause. Negative values cause the animation to play backwards.
  38324. *
  38325. * @type {number}
  38326. * @default 1
  38327. */
  38328. this.timeScale = 1;
  38329. this._effectiveTimeScale = 1;
  38330. /**
  38331. * The degree of influence of this action (in the interval `[0, 1]`). Values
  38332. * between `0` (no impact) and `1` (full impact) can be used to blend between
  38333. * several actions.
  38334. *
  38335. * @type {number}
  38336. * @default 1
  38337. */
  38338. this.weight = 1;
  38339. this._effectiveWeight = 1;
  38340. /**
  38341. * The number of repetitions of the performed clip over the course of this action.
  38342. * Can be set via {@link AnimationAction#setLoop}.
  38343. *
  38344. * Setting this number has no effect if {@link AnimationAction#loop} is set to
  38345. * `THREE:LoopOnce`.
  38346. *
  38347. * @type {number}
  38348. * @default Infinity
  38349. */
  38350. this.repetitions = Infinity;
  38351. /**
  38352. * If set to `true`, the playback of the action is paused.
  38353. *
  38354. * @type {boolean}
  38355. * @default false
  38356. */
  38357. this.paused = false;
  38358. /**
  38359. * If set to `false`, the action is disabled so it has no impact.
  38360. *
  38361. * When the action is re-enabled, the animation continues from its current
  38362. * time (setting `enabled` to `false` doesn't reset the action).
  38363. *
  38364. * @type {boolean}
  38365. * @default true
  38366. */
  38367. this.enabled = true;
  38368. /**
  38369. * If set to true the animation will automatically be paused on its last frame.
  38370. *
  38371. * If set to false, {@link AnimationAction#enabled} will automatically be switched
  38372. * to `false` when the last loop of the action has finished, so that this action has
  38373. * no further impact.
  38374. *
  38375. * Note: This member has no impact if the action is interrupted (it
  38376. * has only an effect if its last loop has really finished).
  38377. *
  38378. * @type {boolean}
  38379. * @default false
  38380. */
  38381. this.clampWhenFinished = false;
  38382. /**
  38383. * Enables smooth interpolation without separate clips for start, loop and end.
  38384. *
  38385. * @type {boolean}
  38386. * @default true
  38387. */
  38388. this.zeroSlopeAtStart = true;
  38389. /**
  38390. * Enables smooth interpolation without separate clips for start, loop and end.
  38391. *
  38392. * @type {boolean}
  38393. * @default true
  38394. */
  38395. this.zeroSlopeAtEnd = true;
  38396. }
  38397. /**
  38398. * Starts the playback of the animation.
  38399. *
  38400. * @return {AnimationAction} A reference to this animation action.
  38401. */
  38402. play() {
  38403. this._mixer._activateAction( this );
  38404. return this;
  38405. }
  38406. /**
  38407. * Stops the playback of the animation.
  38408. *
  38409. * @return {AnimationAction} A reference to this animation action.
  38410. */
  38411. stop() {
  38412. this._mixer._deactivateAction( this );
  38413. return this.reset();
  38414. }
  38415. /**
  38416. * Resets the playback of the animation.
  38417. *
  38418. * @return {AnimationAction} A reference to this animation action.
  38419. */
  38420. reset() {
  38421. this.paused = false;
  38422. this.enabled = true;
  38423. this.time = 0; // restart clip
  38424. this._loopCount = -1;// forget previous loops
  38425. this._startTime = null;// forget scheduling
  38426. return this.stopFading().stopWarping();
  38427. }
  38428. /**
  38429. * Returns `true` if the animation is running.
  38430. *
  38431. * @return {boolean} Whether the animation is running or not.
  38432. */
  38433. isRunning() {
  38434. return this.enabled && ! this.paused && this.timeScale !== 0 &&
  38435. this._startTime === null && this._mixer._isActiveAction( this );
  38436. }
  38437. /**
  38438. * Returns `true` when {@link AnimationAction#play} has been called.
  38439. *
  38440. * @return {boolean} Whether the animation is scheduled or not.
  38441. */
  38442. isScheduled() {
  38443. return this._mixer._isActiveAction( this );
  38444. }
  38445. /**
  38446. * Defines the time when the animation should start.
  38447. *
  38448. * @param {number} time - The start time in seconds.
  38449. * @return {AnimationAction} A reference to this animation action.
  38450. */
  38451. startAt( time ) {
  38452. this._startTime = time;
  38453. return this;
  38454. }
  38455. /**
  38456. * Configures the loop settings for this action.
  38457. *
  38458. * @param {(LoopRepeat|LoopOnce|LoopPingPong)} mode - The loop mode.
  38459. * @param {number} repetitions - The number of repetitions.
  38460. * @return {AnimationAction} A reference to this animation action.
  38461. */
  38462. setLoop( mode, repetitions ) {
  38463. this.loop = mode;
  38464. this.repetitions = repetitions;
  38465. return this;
  38466. }
  38467. /**
  38468. * Sets the effective weight of this action.
  38469. *
  38470. * An action has no effect and thus an effective weight of zero when the
  38471. * action is disabled.
  38472. *
  38473. * @param {number} weight - The weight to set.
  38474. * @return {AnimationAction} A reference to this animation action.
  38475. */
  38476. setEffectiveWeight( weight ) {
  38477. this.weight = weight;
  38478. // note: same logic as when updated at runtime
  38479. this._effectiveWeight = this.enabled ? weight : 0;
  38480. return this.stopFading();
  38481. }
  38482. /**
  38483. * Returns the effective weight of this action.
  38484. *
  38485. * @return {number} The effective weight.
  38486. */
  38487. getEffectiveWeight() {
  38488. return this._effectiveWeight;
  38489. }
  38490. /**
  38491. * Fades the animation in by increasing its weight gradually from `0` to `1`,
  38492. * within the passed time interval.
  38493. *
  38494. * @param {number} duration - The duration of the fade.
  38495. * @return {AnimationAction} A reference to this animation action.
  38496. */
  38497. fadeIn( duration ) {
  38498. return this._scheduleFading( duration, 0, 1 );
  38499. }
  38500. /**
  38501. * Fades the animation out by decreasing its weight gradually from `1` to `0`,
  38502. * within the passed time interval.
  38503. *
  38504. * @param {number} duration - The duration of the fade.
  38505. * @return {AnimationAction} A reference to this animation action.
  38506. */
  38507. fadeOut( duration ) {
  38508. return this._scheduleFading( duration, 1, 0 );
  38509. }
  38510. /**
  38511. * Causes this action to fade in and the given action to fade out,
  38512. * within the passed time interval.
  38513. *
  38514. * @param {AnimationAction} fadeOutAction - The animation action to fade out.
  38515. * @param {number} duration - The duration of the fade.
  38516. * @param {boolean} [warp=false] - Whether warping should be used or not.
  38517. * @return {AnimationAction} A reference to this animation action.
  38518. */
  38519. crossFadeFrom( fadeOutAction, duration, warp = false ) {
  38520. fadeOutAction.fadeOut( duration );
  38521. this.fadeIn( duration );
  38522. if ( warp === true ) {
  38523. const fadeInDuration = this._clip.duration,
  38524. fadeOutDuration = fadeOutAction._clip.duration,
  38525. startEndRatio = fadeOutDuration / fadeInDuration,
  38526. endStartRatio = fadeInDuration / fadeOutDuration;
  38527. fadeOutAction.warp( 1.0, startEndRatio, duration );
  38528. this.warp( endStartRatio, 1.0, duration );
  38529. }
  38530. return this;
  38531. }
  38532. /**
  38533. * Causes this action to fade out and the given action to fade in,
  38534. * within the passed time interval.
  38535. *
  38536. * @param {AnimationAction} fadeInAction - The animation action to fade in.
  38537. * @param {number} duration - The duration of the fade.
  38538. * @param {boolean} [warp=false] - Whether warping should be used or not.
  38539. * @return {AnimationAction} A reference to this animation action.
  38540. */
  38541. crossFadeTo( fadeInAction, duration, warp = false ) {
  38542. return fadeInAction.crossFadeFrom( this, duration, warp );
  38543. }
  38544. /**
  38545. * Stops any fading which is applied to this action.
  38546. *
  38547. * @return {AnimationAction} A reference to this animation action.
  38548. */
  38549. stopFading() {
  38550. const weightInterpolant = this._weightInterpolant;
  38551. if ( weightInterpolant !== null ) {
  38552. this._weightInterpolant = null;
  38553. this._mixer._takeBackControlInterpolant( weightInterpolant );
  38554. }
  38555. return this;
  38556. }
  38557. /**
  38558. * Sets the effective time scale of this action.
  38559. *
  38560. * An action has no effect and thus an effective time scale of zero when the
  38561. * action is paused.
  38562. *
  38563. * @param {number} timeScale - The time scale to set.
  38564. * @return {AnimationAction} A reference to this animation action.
  38565. */
  38566. setEffectiveTimeScale( timeScale ) {
  38567. this.timeScale = timeScale;
  38568. this._effectiveTimeScale = this.paused ? 0 : timeScale;
  38569. return this.stopWarping();
  38570. }
  38571. /**
  38572. * Returns the effective time scale of this action.
  38573. *
  38574. * @return {number} The effective time scale.
  38575. */
  38576. getEffectiveTimeScale() {
  38577. return this._effectiveTimeScale;
  38578. }
  38579. /**
  38580. * Sets the duration for a single loop of this action.
  38581. *
  38582. * @param {number} duration - The duration to set.
  38583. * @return {AnimationAction} A reference to this animation action.
  38584. */
  38585. setDuration( duration ) {
  38586. this.timeScale = this._clip.duration / duration;
  38587. return this.stopWarping();
  38588. }
  38589. /**
  38590. * Synchronizes this action with the passed other action.
  38591. *
  38592. * @param {AnimationAction} action - The action to sync with.
  38593. * @return {AnimationAction} A reference to this animation action.
  38594. */
  38595. syncWith( action ) {
  38596. this.time = action.time;
  38597. this.timeScale = action.timeScale;
  38598. return this.stopWarping();
  38599. }
  38600. /**
  38601. * Decelerates this animation's speed to `0` within the passed time interval.
  38602. *
  38603. * @param {number} duration - The duration.
  38604. * @return {AnimationAction} A reference to this animation action.
  38605. */
  38606. halt( duration ) {
  38607. return this.warp( this._effectiveTimeScale, 0, duration );
  38608. }
  38609. /**
  38610. * Changes the playback speed, within the passed time interval, by modifying
  38611. * {@link AnimationAction#timeScale} gradually from `startTimeScale` to
  38612. * `endTimeScale`.
  38613. *
  38614. * @param {number} startTimeScale - The start time scale.
  38615. * @param {number} endTimeScale - The end time scale.
  38616. * @param {number} duration - The duration.
  38617. * @return {AnimationAction} A reference to this animation action.
  38618. */
  38619. warp( startTimeScale, endTimeScale, duration ) {
  38620. const mixer = this._mixer,
  38621. now = mixer.time,
  38622. timeScale = this.timeScale;
  38623. let interpolant = this._timeScaleInterpolant;
  38624. if ( interpolant === null ) {
  38625. interpolant = mixer._lendControlInterpolant();
  38626. this._timeScaleInterpolant = interpolant;
  38627. }
  38628. const times = interpolant.parameterPositions,
  38629. values = interpolant.sampleValues;
  38630. times[ 0 ] = now;
  38631. times[ 1 ] = now + duration;
  38632. values[ 0 ] = startTimeScale / timeScale;
  38633. values[ 1 ] = endTimeScale / timeScale;
  38634. return this;
  38635. }
  38636. /**
  38637. * Stops any scheduled warping which is applied to this action.
  38638. *
  38639. * @return {AnimationAction} A reference to this animation action.
  38640. */
  38641. stopWarping() {
  38642. const timeScaleInterpolant = this._timeScaleInterpolant;
  38643. if ( timeScaleInterpolant !== null ) {
  38644. this._timeScaleInterpolant = null;
  38645. this._mixer._takeBackControlInterpolant( timeScaleInterpolant );
  38646. }
  38647. return this;
  38648. }
  38649. /**
  38650. * Returns the animation mixer of this animation action.
  38651. *
  38652. * @return {AnimationMixer} The animation mixer.
  38653. */
  38654. getMixer() {
  38655. return this._mixer;
  38656. }
  38657. /**
  38658. * Returns the animation clip of this animation action.
  38659. *
  38660. * @return {AnimationClip} The animation clip.
  38661. */
  38662. getClip() {
  38663. return this._clip;
  38664. }
  38665. /**
  38666. * Returns the root object of this animation action.
  38667. *
  38668. * @return {Object3D} The root object.
  38669. */
  38670. getRoot() {
  38671. return this._localRoot || this._mixer._root;
  38672. }
  38673. // Internal
  38674. _update( time, deltaTime, timeDirection, accuIndex ) {
  38675. // called by the mixer
  38676. if ( ! this.enabled ) {
  38677. // call ._updateWeight() to update ._effectiveWeight
  38678. this._updateWeight( time );
  38679. return;
  38680. }
  38681. const startTime = this._startTime;
  38682. if ( startTime !== null ) {
  38683. // check for scheduled start of action
  38684. const timeRunning = ( time - startTime ) * timeDirection;
  38685. if ( timeRunning < 0 || timeDirection === 0 ) {
  38686. deltaTime = 0;
  38687. } else {
  38688. this._startTime = null; // unschedule
  38689. deltaTime = timeDirection * timeRunning;
  38690. }
  38691. }
  38692. // apply time scale and advance time
  38693. deltaTime *= this._updateTimeScale( time );
  38694. const clipTime = this._updateTime( deltaTime );
  38695. // note: _updateTime may disable the action resulting in
  38696. // an effective weight of 0
  38697. const weight = this._updateWeight( time );
  38698. if ( weight > 0 ) {
  38699. const interpolants = this._interpolants;
  38700. const propertyMixers = this._propertyBindings;
  38701. switch ( this.blendMode ) {
  38702. case AdditiveAnimationBlendMode:
  38703. for ( let j = 0, m = interpolants.length; j !== m; ++ j ) {
  38704. interpolants[ j ].evaluate( clipTime );
  38705. propertyMixers[ j ].accumulateAdditive( weight );
  38706. }
  38707. break;
  38708. case NormalAnimationBlendMode:
  38709. default:
  38710. for ( let j = 0, m = interpolants.length; j !== m; ++ j ) {
  38711. interpolants[ j ].evaluate( clipTime );
  38712. propertyMixers[ j ].accumulate( accuIndex, weight );
  38713. }
  38714. }
  38715. }
  38716. }
  38717. _updateWeight( time ) {
  38718. let weight = 0;
  38719. if ( this.enabled ) {
  38720. weight = this.weight;
  38721. const interpolant = this._weightInterpolant;
  38722. if ( interpolant !== null ) {
  38723. const interpolantValue = interpolant.evaluate( time )[ 0 ];
  38724. weight *= interpolantValue;
  38725. if ( time > interpolant.parameterPositions[ 1 ] ) {
  38726. this.stopFading();
  38727. if ( interpolantValue === 0 ) {
  38728. // faded out, disable
  38729. this.enabled = false;
  38730. }
  38731. }
  38732. }
  38733. }
  38734. this._effectiveWeight = weight;
  38735. return weight;
  38736. }
  38737. _updateTimeScale( time ) {
  38738. let timeScale = 0;
  38739. if ( ! this.paused ) {
  38740. timeScale = this.timeScale;
  38741. const interpolant = this._timeScaleInterpolant;
  38742. if ( interpolant !== null ) {
  38743. const interpolantValue = interpolant.evaluate( time )[ 0 ];
  38744. timeScale *= interpolantValue;
  38745. if ( time > interpolant.parameterPositions[ 1 ] ) {
  38746. this.stopWarping();
  38747. if ( timeScale === 0 ) {
  38748. // motion has halted, pause
  38749. this.paused = true;
  38750. } else {
  38751. // warp done - apply final time scale
  38752. this.timeScale = timeScale;
  38753. }
  38754. }
  38755. }
  38756. }
  38757. this._effectiveTimeScale = timeScale;
  38758. return timeScale;
  38759. }
  38760. _updateTime( deltaTime ) {
  38761. const duration = this._clip.duration;
  38762. const loop = this.loop;
  38763. let time = this.time + deltaTime;
  38764. let loopCount = this._loopCount;
  38765. const pingPong = ( loop === LoopPingPong );
  38766. if ( deltaTime === 0 ) {
  38767. if ( loopCount === -1 ) return time;
  38768. return ( pingPong && ( loopCount & 1 ) === 1 ) ? duration - time : time;
  38769. }
  38770. if ( loop === LoopOnce ) {
  38771. if ( loopCount === -1 ) {
  38772. // just started
  38773. this._loopCount = 0;
  38774. this._setEndings( true, true, false );
  38775. }
  38776. handle_stop: {
  38777. if ( time >= duration ) {
  38778. time = duration;
  38779. } else if ( time < 0 ) {
  38780. time = 0;
  38781. } else {
  38782. this.time = time;
  38783. break handle_stop;
  38784. }
  38785. if ( this.clampWhenFinished ) this.paused = true;
  38786. else this.enabled = false;
  38787. this.time = time;
  38788. this._mixer.dispatchEvent( {
  38789. type: 'finished', action: this,
  38790. direction: deltaTime < 0 ? -1 : 1
  38791. } );
  38792. }
  38793. } else { // repetitive Repeat or PingPong
  38794. if ( loopCount === -1 ) {
  38795. // just started
  38796. if ( deltaTime >= 0 ) {
  38797. loopCount = 0;
  38798. this._setEndings( true, this.repetitions === 0, pingPong );
  38799. } else {
  38800. // when looping in reverse direction, the initial
  38801. // transition through zero counts as a repetition,
  38802. // so leave loopCount at -1
  38803. this._setEndings( this.repetitions === 0, true, pingPong );
  38804. }
  38805. }
  38806. if ( time >= duration || time < 0 ) {
  38807. // wrap around
  38808. const loopDelta = Math.floor( time / duration ); // signed
  38809. time -= duration * loopDelta;
  38810. loopCount += Math.abs( loopDelta );
  38811. const pending = this.repetitions - loopCount;
  38812. if ( pending <= 0 ) {
  38813. // have to stop (switch state, clamp time, fire event)
  38814. if ( this.clampWhenFinished ) this.paused = true;
  38815. else this.enabled = false;
  38816. time = deltaTime > 0 ? duration : 0;
  38817. this.time = time;
  38818. this._mixer.dispatchEvent( {
  38819. type: 'finished', action: this,
  38820. direction: deltaTime > 0 ? 1 : -1
  38821. } );
  38822. } else {
  38823. // keep running
  38824. if ( pending === 1 ) {
  38825. // entering the last round
  38826. const atStart = deltaTime < 0;
  38827. this._setEndings( atStart, ! atStart, pingPong );
  38828. } else {
  38829. this._setEndings( false, false, pingPong );
  38830. }
  38831. this._loopCount = loopCount;
  38832. this.time = time;
  38833. this._mixer.dispatchEvent( {
  38834. type: 'loop', action: this, loopDelta: loopDelta
  38835. } );
  38836. }
  38837. } else {
  38838. this.time = time;
  38839. }
  38840. if ( pingPong && ( loopCount & 1 ) === 1 ) {
  38841. // invert time for the "pong round"
  38842. return duration - time;
  38843. }
  38844. }
  38845. return time;
  38846. }
  38847. _setEndings( atStart, atEnd, pingPong ) {
  38848. const settings = this._interpolantSettings;
  38849. if ( pingPong ) {
  38850. settings.endingStart = ZeroSlopeEnding;
  38851. settings.endingEnd = ZeroSlopeEnding;
  38852. } else {
  38853. // assuming for LoopOnce atStart == atEnd == true
  38854. if ( atStart ) {
  38855. settings.endingStart = this.zeroSlopeAtStart ? ZeroSlopeEnding : ZeroCurvatureEnding;
  38856. } else {
  38857. settings.endingStart = WrapAroundEnding;
  38858. }
  38859. if ( atEnd ) {
  38860. settings.endingEnd = this.zeroSlopeAtEnd ? ZeroSlopeEnding : ZeroCurvatureEnding;
  38861. } else {
  38862. settings.endingEnd = WrapAroundEnding;
  38863. }
  38864. }
  38865. }
  38866. _scheduleFading( duration, weightNow, weightThen ) {
  38867. const mixer = this._mixer, now = mixer.time;
  38868. let interpolant = this._weightInterpolant;
  38869. if ( interpolant === null ) {
  38870. interpolant = mixer._lendControlInterpolant();
  38871. this._weightInterpolant = interpolant;
  38872. }
  38873. const times = interpolant.parameterPositions,
  38874. values = interpolant.sampleValues;
  38875. times[ 0 ] = now;
  38876. values[ 0 ] = weightNow;
  38877. times[ 1 ] = now + duration;
  38878. values[ 1 ] = weightThen;
  38879. return this;
  38880. }
  38881. }
  38882. const _controlInterpolantsResultBuffer = new Float32Array( 1 );
  38883. /**
  38884. * `AnimationMixer` is a player for animations on a particular object in
  38885. * the scene. When multiple objects in the scene are animated independently,
  38886. * one `AnimationMixer` may be used for each object.
  38887. */
  38888. class AnimationMixer extends EventDispatcher {
  38889. /**
  38890. * Constructs a new animation mixer.
  38891. *
  38892. * @param {Object3D} root - The object whose animations shall be played by this mixer.
  38893. */
  38894. constructor( root ) {
  38895. super();
  38896. this._root = root;
  38897. this._initMemoryManager();
  38898. this._accuIndex = 0;
  38899. /**
  38900. * The global mixer time (in seconds; starting with `0` on the mixer's creation).
  38901. *
  38902. * @type {number}
  38903. * @default 0
  38904. */
  38905. this.time = 0;
  38906. /**
  38907. * A scaling factor for the global time.
  38908. *
  38909. * Note: Setting this member to `0` and later back to `1` is a
  38910. * possibility to pause/unpause all actions that are controlled by this
  38911. * mixer.
  38912. *
  38913. * @type {number}
  38914. * @default 1
  38915. */
  38916. this.timeScale = 1.0;
  38917. if ( typeof __THREE_DEVTOOLS__ !== 'undefined' ) {
  38918. __THREE_DEVTOOLS__.dispatchEvent( new CustomEvent( 'observe', { detail: this } ) );
  38919. }
  38920. }
  38921. _bindAction( action, prototypeAction ) {
  38922. const root = action._localRoot || this._root,
  38923. tracks = action._clip.tracks,
  38924. nTracks = tracks.length,
  38925. bindings = action._propertyBindings,
  38926. interpolants = action._interpolants,
  38927. rootUuid = root.uuid,
  38928. bindingsByRoot = this._bindingsByRootAndName;
  38929. let bindingsByName = bindingsByRoot[ rootUuid ];
  38930. if ( bindingsByName === undefined ) {
  38931. bindingsByName = {};
  38932. bindingsByRoot[ rootUuid ] = bindingsByName;
  38933. }
  38934. for ( let i = 0; i !== nTracks; ++ i ) {
  38935. const track = tracks[ i ],
  38936. trackName = track.name;
  38937. let binding = bindingsByName[ trackName ];
  38938. if ( binding !== undefined ) {
  38939. ++ binding.referenceCount;
  38940. bindings[ i ] = binding;
  38941. } else {
  38942. binding = bindings[ i ];
  38943. if ( binding !== undefined ) {
  38944. // existing binding, make sure the cache knows
  38945. if ( binding._cacheIndex === null ) {
  38946. ++ binding.referenceCount;
  38947. this._addInactiveBinding( binding, rootUuid, trackName );
  38948. }
  38949. continue;
  38950. }
  38951. const path = prototypeAction && prototypeAction.
  38952. _propertyBindings[ i ].binding.parsedPath;
  38953. binding = new PropertyMixer(
  38954. PropertyBinding.create( root, trackName, path ),
  38955. track.ValueTypeName, track.getValueSize() );
  38956. ++ binding.referenceCount;
  38957. this._addInactiveBinding( binding, rootUuid, trackName );
  38958. bindings[ i ] = binding;
  38959. }
  38960. interpolants[ i ].resultBuffer = binding.buffer;
  38961. }
  38962. }
  38963. _activateAction( action ) {
  38964. if ( ! this._isActiveAction( action ) ) {
  38965. if ( action._cacheIndex === null ) {
  38966. // this action has been forgotten by the cache, but the user
  38967. // appears to be still using it -> rebind
  38968. const rootUuid = ( action._localRoot || this._root ).uuid,
  38969. clipUuid = action._clip.uuid,
  38970. actionsForClip = this._actionsByClip[ clipUuid ];
  38971. this._bindAction( action,
  38972. actionsForClip && actionsForClip.knownActions[ 0 ] );
  38973. this._addInactiveAction( action, clipUuid, rootUuid );
  38974. }
  38975. const bindings = action._propertyBindings;
  38976. // increment reference counts / sort out state
  38977. for ( let i = 0, n = bindings.length; i !== n; ++ i ) {
  38978. const binding = bindings[ i ];
  38979. if ( binding.useCount ++ === 0 ) {
  38980. this._lendBinding( binding );
  38981. binding.saveOriginalState();
  38982. }
  38983. }
  38984. this._lendAction( action );
  38985. }
  38986. }
  38987. _deactivateAction( action ) {
  38988. if ( this._isActiveAction( action ) ) {
  38989. const bindings = action._propertyBindings;
  38990. // decrement reference counts / sort out state
  38991. for ( let i = 0, n = bindings.length; i !== n; ++ i ) {
  38992. const binding = bindings[ i ];
  38993. if ( -- binding.useCount === 0 ) {
  38994. binding.restoreOriginalState();
  38995. this._takeBackBinding( binding );
  38996. }
  38997. }
  38998. this._takeBackAction( action );
  38999. }
  39000. }
  39001. // Memory manager
  39002. _initMemoryManager() {
  39003. this._actions = []; // 'nActiveActions' followed by inactive ones
  39004. this._nActiveActions = 0;
  39005. this._actionsByClip = {};
  39006. // inside:
  39007. // {
  39008. // knownActions: Array< AnimationAction > - used as prototypes
  39009. // actionByRoot: AnimationAction - lookup
  39010. // }
  39011. this._bindings = []; // 'nActiveBindings' followed by inactive ones
  39012. this._nActiveBindings = 0;
  39013. this._bindingsByRootAndName = {}; // inside: Map< name, PropertyMixer >
  39014. this._controlInterpolants = []; // same game as above
  39015. this._nActiveControlInterpolants = 0;
  39016. const scope = this;
  39017. this.stats = {
  39018. actions: {
  39019. get total() {
  39020. return scope._actions.length;
  39021. },
  39022. get inUse() {
  39023. return scope._nActiveActions;
  39024. }
  39025. },
  39026. bindings: {
  39027. get total() {
  39028. return scope._bindings.length;
  39029. },
  39030. get inUse() {
  39031. return scope._nActiveBindings;
  39032. }
  39033. },
  39034. controlInterpolants: {
  39035. get total() {
  39036. return scope._controlInterpolants.length;
  39037. },
  39038. get inUse() {
  39039. return scope._nActiveControlInterpolants;
  39040. }
  39041. }
  39042. };
  39043. }
  39044. // Memory management for AnimationAction objects
  39045. _isActiveAction( action ) {
  39046. const index = action._cacheIndex;
  39047. return index !== null && index < this._nActiveActions;
  39048. }
  39049. _addInactiveAction( action, clipUuid, rootUuid ) {
  39050. const actions = this._actions,
  39051. actionsByClip = this._actionsByClip;
  39052. let actionsForClip = actionsByClip[ clipUuid ];
  39053. if ( actionsForClip === undefined ) {
  39054. actionsForClip = {
  39055. knownActions: [ action ],
  39056. actionByRoot: {}
  39057. };
  39058. action._byClipCacheIndex = 0;
  39059. actionsByClip[ clipUuid ] = actionsForClip;
  39060. } else {
  39061. const knownActions = actionsForClip.knownActions;
  39062. action._byClipCacheIndex = knownActions.length;
  39063. knownActions.push( action );
  39064. }
  39065. action._cacheIndex = actions.length;
  39066. actions.push( action );
  39067. actionsForClip.actionByRoot[ rootUuid ] = action;
  39068. }
  39069. _removeInactiveAction( action ) {
  39070. const actions = this._actions,
  39071. lastInactiveAction = actions[ actions.length - 1 ],
  39072. cacheIndex = action._cacheIndex;
  39073. lastInactiveAction._cacheIndex = cacheIndex;
  39074. actions[ cacheIndex ] = lastInactiveAction;
  39075. actions.pop();
  39076. action._cacheIndex = null;
  39077. const clipUuid = action._clip.uuid,
  39078. actionsByClip = this._actionsByClip,
  39079. actionsForClip = actionsByClip[ clipUuid ],
  39080. knownActionsForClip = actionsForClip.knownActions,
  39081. lastKnownAction =
  39082. knownActionsForClip[ knownActionsForClip.length - 1 ],
  39083. byClipCacheIndex = action._byClipCacheIndex;
  39084. lastKnownAction._byClipCacheIndex = byClipCacheIndex;
  39085. knownActionsForClip[ byClipCacheIndex ] = lastKnownAction;
  39086. knownActionsForClip.pop();
  39087. action._byClipCacheIndex = null;
  39088. const actionByRoot = actionsForClip.actionByRoot,
  39089. rootUuid = ( action._localRoot || this._root ).uuid;
  39090. delete actionByRoot[ rootUuid ];
  39091. if ( knownActionsForClip.length === 0 ) {
  39092. delete actionsByClip[ clipUuid ];
  39093. }
  39094. this._removeInactiveBindingsForAction( action );
  39095. }
  39096. _removeInactiveBindingsForAction( action ) {
  39097. const bindings = action._propertyBindings;
  39098. for ( let i = 0, n = bindings.length; i !== n; ++ i ) {
  39099. const binding = bindings[ i ];
  39100. if ( -- binding.referenceCount === 0 ) {
  39101. this._removeInactiveBinding( binding );
  39102. }
  39103. }
  39104. }
  39105. _lendAction( action ) {
  39106. // [ active actions | inactive actions ]
  39107. // [ active actions >| inactive actions ]
  39108. // s a
  39109. // <-swap->
  39110. // a s
  39111. const actions = this._actions,
  39112. prevIndex = action._cacheIndex,
  39113. lastActiveIndex = this._nActiveActions ++,
  39114. firstInactiveAction = actions[ lastActiveIndex ];
  39115. action._cacheIndex = lastActiveIndex;
  39116. actions[ lastActiveIndex ] = action;
  39117. firstInactiveAction._cacheIndex = prevIndex;
  39118. actions[ prevIndex ] = firstInactiveAction;
  39119. }
  39120. _takeBackAction( action ) {
  39121. // [ active actions | inactive actions ]
  39122. // [ active actions |< inactive actions ]
  39123. // a s
  39124. // <-swap->
  39125. // s a
  39126. const actions = this._actions,
  39127. prevIndex = action._cacheIndex,
  39128. firstInactiveIndex = -- this._nActiveActions,
  39129. lastActiveAction = actions[ firstInactiveIndex ];
  39130. action._cacheIndex = firstInactiveIndex;
  39131. actions[ firstInactiveIndex ] = action;
  39132. lastActiveAction._cacheIndex = prevIndex;
  39133. actions[ prevIndex ] = lastActiveAction;
  39134. }
  39135. // Memory management for PropertyMixer objects
  39136. _addInactiveBinding( binding, rootUuid, trackName ) {
  39137. const bindingsByRoot = this._bindingsByRootAndName,
  39138. bindings = this._bindings;
  39139. let bindingByName = bindingsByRoot[ rootUuid ];
  39140. if ( bindingByName === undefined ) {
  39141. bindingByName = {};
  39142. bindingsByRoot[ rootUuid ] = bindingByName;
  39143. }
  39144. bindingByName[ trackName ] = binding;
  39145. binding._cacheIndex = bindings.length;
  39146. bindings.push( binding );
  39147. }
  39148. _removeInactiveBinding( binding ) {
  39149. const bindings = this._bindings,
  39150. propBinding = binding.binding,
  39151. rootUuid = propBinding.rootNode.uuid,
  39152. trackName = propBinding.path,
  39153. bindingsByRoot = this._bindingsByRootAndName,
  39154. bindingByName = bindingsByRoot[ rootUuid ],
  39155. lastInactiveBinding = bindings[ bindings.length - 1 ],
  39156. cacheIndex = binding._cacheIndex;
  39157. lastInactiveBinding._cacheIndex = cacheIndex;
  39158. bindings[ cacheIndex ] = lastInactiveBinding;
  39159. bindings.pop();
  39160. delete bindingByName[ trackName ];
  39161. if ( Object.keys( bindingByName ).length === 0 ) {
  39162. delete bindingsByRoot[ rootUuid ];
  39163. }
  39164. }
  39165. _lendBinding( binding ) {
  39166. const bindings = this._bindings,
  39167. prevIndex = binding._cacheIndex,
  39168. lastActiveIndex = this._nActiveBindings ++,
  39169. firstInactiveBinding = bindings[ lastActiveIndex ];
  39170. binding._cacheIndex = lastActiveIndex;
  39171. bindings[ lastActiveIndex ] = binding;
  39172. firstInactiveBinding._cacheIndex = prevIndex;
  39173. bindings[ prevIndex ] = firstInactiveBinding;
  39174. }
  39175. _takeBackBinding( binding ) {
  39176. const bindings = this._bindings,
  39177. prevIndex = binding._cacheIndex,
  39178. firstInactiveIndex = -- this._nActiveBindings,
  39179. lastActiveBinding = bindings[ firstInactiveIndex ];
  39180. binding._cacheIndex = firstInactiveIndex;
  39181. bindings[ firstInactiveIndex ] = binding;
  39182. lastActiveBinding._cacheIndex = prevIndex;
  39183. bindings[ prevIndex ] = lastActiveBinding;
  39184. }
  39185. // Memory management of Interpolants for weight and time scale
  39186. _lendControlInterpolant() {
  39187. const interpolants = this._controlInterpolants,
  39188. lastActiveIndex = this._nActiveControlInterpolants ++;
  39189. let interpolant = interpolants[ lastActiveIndex ];
  39190. if ( interpolant === undefined ) {
  39191. interpolant = new LinearInterpolant(
  39192. new Float32Array( 2 ), new Float32Array( 2 ),
  39193. 1, _controlInterpolantsResultBuffer );
  39194. interpolant.__cacheIndex = lastActiveIndex;
  39195. interpolants[ lastActiveIndex ] = interpolant;
  39196. }
  39197. return interpolant;
  39198. }
  39199. _takeBackControlInterpolant( interpolant ) {
  39200. const interpolants = this._controlInterpolants,
  39201. prevIndex = interpolant.__cacheIndex,
  39202. firstInactiveIndex = -- this._nActiveControlInterpolants,
  39203. lastActiveInterpolant = interpolants[ firstInactiveIndex ];
  39204. interpolant.__cacheIndex = firstInactiveIndex;
  39205. interpolants[ firstInactiveIndex ] = interpolant;
  39206. lastActiveInterpolant.__cacheIndex = prevIndex;
  39207. interpolants[ prevIndex ] = lastActiveInterpolant;
  39208. }
  39209. /**
  39210. * Returns an instance of {@link AnimationAction} for the passed clip.
  39211. *
  39212. * If an action fitting the clip and root parameters doesn't yet exist, it
  39213. * will be created by this method. Calling this method several times with the
  39214. * same clip and root parameters always returns the same action.
  39215. *
  39216. * @param {AnimationClip|string} clip - An animation clip or alternatively the name of the animation clip.
  39217. * @param {Object3D} [optionalRoot] - An alternative root object.
  39218. * @param {(NormalAnimationBlendMode|AdditiveAnimationBlendMode)} [blendMode] - The blend mode.
  39219. * @return {?AnimationAction} The animation action.
  39220. */
  39221. clipAction( clip, optionalRoot, blendMode ) {
  39222. const root = optionalRoot || this._root,
  39223. rootUuid = root.uuid;
  39224. let clipObject = typeof clip === 'string' ? AnimationClip.findByName( root, clip ) : clip;
  39225. const clipUuid = clipObject !== null ? clipObject.uuid : clip;
  39226. const actionsForClip = this._actionsByClip[ clipUuid ];
  39227. let prototypeAction = null;
  39228. if ( blendMode === undefined ) {
  39229. if ( clipObject !== null ) {
  39230. blendMode = clipObject.blendMode;
  39231. } else {
  39232. blendMode = NormalAnimationBlendMode;
  39233. }
  39234. }
  39235. if ( actionsForClip !== undefined ) {
  39236. const existingAction = actionsForClip.actionByRoot[ rootUuid ];
  39237. if ( existingAction !== undefined && existingAction.blendMode === blendMode ) {
  39238. return existingAction;
  39239. }
  39240. // we know the clip, so we don't have to parse all
  39241. // the bindings again but can just copy
  39242. prototypeAction = actionsForClip.knownActions[ 0 ];
  39243. // also, take the clip from the prototype action
  39244. if ( clipObject === null )
  39245. clipObject = prototypeAction._clip;
  39246. }
  39247. // clip must be known when specified via string
  39248. if ( clipObject === null ) return null;
  39249. // allocate all resources required to run it
  39250. const newAction = new AnimationAction( this, clipObject, optionalRoot, blendMode );
  39251. this._bindAction( newAction, prototypeAction );
  39252. // and make the action known to the memory manager
  39253. this._addInactiveAction( newAction, clipUuid, rootUuid );
  39254. return newAction;
  39255. }
  39256. /**
  39257. * Returns an existing animation action for the passed clip.
  39258. *
  39259. * @param {AnimationClip|string} clip - An animation clip or alternatively the name of the animation clip.
  39260. * @param {Object3D} [optionalRoot] - An alternative root object.
  39261. * @return {?AnimationAction} The animation action. Returns `null` if no action was found.
  39262. */
  39263. existingAction( clip, optionalRoot ) {
  39264. const root = optionalRoot || this._root,
  39265. rootUuid = root.uuid,
  39266. clipObject = typeof clip === 'string' ?
  39267. AnimationClip.findByName( root, clip ) : clip,
  39268. clipUuid = clipObject ? clipObject.uuid : clip,
  39269. actionsForClip = this._actionsByClip[ clipUuid ];
  39270. if ( actionsForClip !== undefined ) {
  39271. return actionsForClip.actionByRoot[ rootUuid ] || null;
  39272. }
  39273. return null;
  39274. }
  39275. /**
  39276. * Deactivates all previously scheduled actions on this mixer.
  39277. *
  39278. * @return {AnimationMixer} A reference to this animation mixer.
  39279. */
  39280. stopAllAction() {
  39281. const actions = this._actions,
  39282. nActions = this._nActiveActions;
  39283. for ( let i = nActions - 1; i >= 0; -- i ) {
  39284. actions[ i ].stop();
  39285. }
  39286. return this;
  39287. }
  39288. /**
  39289. * Advances the global mixer time and updates the animation.
  39290. *
  39291. * This is usually done in the render loop by passing the delta
  39292. * time from {@link Clock} or {@link Timer}.
  39293. *
  39294. * @param {number} deltaTime - The delta time in seconds.
  39295. * @return {AnimationMixer} A reference to this animation mixer.
  39296. */
  39297. update( deltaTime ) {
  39298. deltaTime *= this.timeScale;
  39299. const actions = this._actions,
  39300. nActions = this._nActiveActions,
  39301. time = this.time += deltaTime,
  39302. timeDirection = Math.sign( deltaTime ),
  39303. accuIndex = this._accuIndex ^= 1;
  39304. // run active actions
  39305. for ( let i = 0; i !== nActions; ++ i ) {
  39306. const action = actions[ i ];
  39307. action._update( time, deltaTime, timeDirection, accuIndex );
  39308. }
  39309. // update scene graph
  39310. const bindings = this._bindings,
  39311. nBindings = this._nActiveBindings;
  39312. for ( let i = 0; i !== nBindings; ++ i ) {
  39313. bindings[ i ].apply( accuIndex );
  39314. }
  39315. return this;
  39316. }
  39317. /**
  39318. * Sets the global mixer to a specific time and updates the animation accordingly.
  39319. *
  39320. * This is useful when you need to jump to an exact time in an animation. The
  39321. * input parameter will be scaled by {@link AnimationMixer#timeScale}
  39322. *
  39323. * @param {number} time - The time to set in seconds.
  39324. * @return {AnimationMixer} A reference to this animation mixer.
  39325. */
  39326. setTime( time ) {
  39327. this.time = 0; // Zero out time attribute for AnimationMixer object;
  39328. for ( let i = 0; i < this._actions.length; i ++ ) {
  39329. this._actions[ i ].time = 0; // Zero out time attribute for all associated AnimationAction objects.
  39330. }
  39331. return this.update( time ); // Update used to set exact time. Returns "this" AnimationMixer object.
  39332. }
  39333. /**
  39334. * Returns this mixer's root object.
  39335. *
  39336. * @return {Object3D} The mixer's root object.
  39337. */
  39338. getRoot() {
  39339. return this._root;
  39340. }
  39341. /**
  39342. * Deallocates all memory resources for a clip. Before using this method make
  39343. * sure to call {@link AnimationAction#stop} for all related actions.
  39344. *
  39345. * @param {AnimationClip} clip - The clip to uncache.
  39346. */
  39347. uncacheClip( clip ) {
  39348. const actions = this._actions,
  39349. clipUuid = clip.uuid,
  39350. actionsByClip = this._actionsByClip,
  39351. actionsForClip = actionsByClip[ clipUuid ];
  39352. if ( actionsForClip !== undefined ) {
  39353. // note: just calling _removeInactiveAction would mess up the
  39354. // iteration state and also require updating the state we can
  39355. // just throw away
  39356. const actionsToRemove = actionsForClip.knownActions;
  39357. for ( let i = 0, n = actionsToRemove.length; i !== n; ++ i ) {
  39358. const action = actionsToRemove[ i ];
  39359. this._deactivateAction( action );
  39360. const cacheIndex = action._cacheIndex,
  39361. lastInactiveAction = actions[ actions.length - 1 ];
  39362. action._cacheIndex = null;
  39363. action._byClipCacheIndex = null;
  39364. lastInactiveAction._cacheIndex = cacheIndex;
  39365. actions[ cacheIndex ] = lastInactiveAction;
  39366. actions.pop();
  39367. this._removeInactiveBindingsForAction( action );
  39368. }
  39369. delete actionsByClip[ clipUuid ];
  39370. }
  39371. }
  39372. /**
  39373. * Deallocates all memory resources for a root object. Before using this
  39374. * method make sure to call {@link AnimationAction#stop} for all related
  39375. * actions or alternatively {@link AnimationMixer#stopAllAction} when the
  39376. * mixer operates on a single root.
  39377. *
  39378. * @param {Object3D} root - The root object to uncache.
  39379. */
  39380. uncacheRoot( root ) {
  39381. const rootUuid = root.uuid,
  39382. actionsByClip = this._actionsByClip;
  39383. for ( const clipUuid in actionsByClip ) {
  39384. const actionByRoot = actionsByClip[ clipUuid ].actionByRoot,
  39385. action = actionByRoot[ rootUuid ];
  39386. if ( action !== undefined ) {
  39387. this._deactivateAction( action );
  39388. this._removeInactiveAction( action );
  39389. }
  39390. }
  39391. const bindingsByRoot = this._bindingsByRootAndName,
  39392. bindingByName = bindingsByRoot[ rootUuid ];
  39393. if ( bindingByName !== undefined ) {
  39394. for ( const trackName in bindingByName ) {
  39395. const binding = bindingByName[ trackName ];
  39396. binding.restoreOriginalState();
  39397. this._removeInactiveBinding( binding );
  39398. }
  39399. }
  39400. }
  39401. /**
  39402. * Deallocates all memory resources for an action. The action is identified by the
  39403. * given clip and an optional root object. Before using this method make
  39404. * sure to call {@link AnimationAction#stop} to deactivate the action.
  39405. *
  39406. * @param {AnimationClip|string} clip - An animation clip or alternatively the name of the animation clip.
  39407. * @param {Object3D} [optionalRoot] - An alternative root object.
  39408. */
  39409. uncacheAction( clip, optionalRoot ) {
  39410. const action = this.existingAction( clip, optionalRoot );
  39411. if ( action !== null ) {
  39412. this._deactivateAction( action );
  39413. this._removeInactiveAction( action );
  39414. }
  39415. }
  39416. }
  39417. /**
  39418. * Represents a 3D render target.
  39419. *
  39420. * @augments RenderTarget
  39421. */
  39422. class RenderTarget3D extends RenderTarget {
  39423. /**
  39424. * Constructs a new 3D render target.
  39425. *
  39426. * @param {number} [width=1] - The width of the render target.
  39427. * @param {number} [height=1] - The height of the render target.
  39428. * @param {number} [depth=1] - The height of the render target.
  39429. * @param {RenderTarget~Options} [options] - The configuration object.
  39430. */
  39431. constructor( width = 1, height = 1, depth = 1, options = {} ) {
  39432. super( width, height, options );
  39433. /**
  39434. * This flag can be used for type testing.
  39435. *
  39436. * @type {boolean}
  39437. * @readonly
  39438. * @default true
  39439. */
  39440. this.isRenderTarget3D = true;
  39441. this.depth = depth;
  39442. /**
  39443. * Overwritten with a different texture type.
  39444. *
  39445. * @type {Data3DTexture}
  39446. */
  39447. this.texture = new Data3DTexture( null, width, height, depth );
  39448. this._setTextureOptions( options );
  39449. this.texture.isRenderTargetTexture = true;
  39450. }
  39451. }
  39452. /**
  39453. * Represents a uniform which is a global shader variable. They are passed to shader programs.
  39454. *
  39455. * When declaring a uniform of a {@link ShaderMaterial}, it is declared by value or by object.
  39456. * ```js
  39457. * uniforms: {
  39458. * time: { value: 1.0 },
  39459. * resolution: new Uniform( new Vector2() )
  39460. * };
  39461. * ```
  39462. * Since this class can only be used in context of {@link ShaderMaterial}, it is only supported
  39463. * in {@link WebGLRenderer}.
  39464. */
  39465. class Uniform {
  39466. /**
  39467. * Constructs a new uniform.
  39468. *
  39469. * @param {any} value - The uniform value.
  39470. */
  39471. constructor( value ) {
  39472. /**
  39473. * The uniform value.
  39474. *
  39475. * @type {any}
  39476. */
  39477. this.value = value;
  39478. }
  39479. /**
  39480. * Returns a new uniform with copied values from this instance.
  39481. * If the value has a `clone()` method, the value is cloned as well.
  39482. *
  39483. * @return {Uniform} A clone of this instance.
  39484. */
  39485. clone() {
  39486. return new Uniform( this.value.clone === undefined ? this.value : this.value.clone() );
  39487. }
  39488. }
  39489. let _id = 0;
  39490. /**
  39491. * A class for managing multiple uniforms in a single group. The renderer will process
  39492. * such a definition as a single UBO.
  39493. *
  39494. * Since this class can only be used in context of {@link ShaderMaterial}, it is only supported
  39495. * in {@link WebGLRenderer}.
  39496. *
  39497. * @augments EventDispatcher
  39498. */
  39499. class UniformsGroup extends EventDispatcher {
  39500. /**
  39501. * Constructs a new uniforms group.
  39502. */
  39503. constructor() {
  39504. super();
  39505. /**
  39506. * This flag can be used for type testing.
  39507. *
  39508. * @type {boolean}
  39509. * @readonly
  39510. * @default true
  39511. */
  39512. this.isUniformsGroup = true;
  39513. /**
  39514. * The ID of the 3D object.
  39515. *
  39516. * @name UniformsGroup#id
  39517. * @type {number}
  39518. * @readonly
  39519. */
  39520. Object.defineProperty( this, 'id', { value: _id ++ } );
  39521. /**
  39522. * The name of the uniforms group.
  39523. *
  39524. * @type {string}
  39525. */
  39526. this.name = '';
  39527. /**
  39528. * The buffer usage.
  39529. *
  39530. * @type {(StaticDrawUsage|DynamicDrawUsage|StreamDrawUsage|StaticReadUsage|DynamicReadUsage|StreamReadUsage|StaticCopyUsage|DynamicCopyUsage|StreamCopyUsage)}
  39531. * @default StaticDrawUsage
  39532. */
  39533. this.usage = StaticDrawUsage;
  39534. /**
  39535. * An array holding the uniforms.
  39536. *
  39537. * @type {Array<Uniform>}
  39538. */
  39539. this.uniforms = [];
  39540. }
  39541. /**
  39542. * Adds the given uniform to this uniforms group.
  39543. *
  39544. * @param {Uniform} uniform - The uniform to add.
  39545. * @return {UniformsGroup} A reference to this uniforms group.
  39546. */
  39547. add( uniform ) {
  39548. this.uniforms.push( uniform );
  39549. return this;
  39550. }
  39551. /**
  39552. * Removes the given uniform from this uniforms group.
  39553. *
  39554. * @param {Uniform} uniform - The uniform to remove.
  39555. * @return {UniformsGroup} A reference to this uniforms group.
  39556. */
  39557. remove( uniform ) {
  39558. const index = this.uniforms.indexOf( uniform );
  39559. if ( index !== -1 ) this.uniforms.splice( index, 1 );
  39560. return this;
  39561. }
  39562. /**
  39563. * Sets the name of this uniforms group.
  39564. *
  39565. * @param {string} name - The name to set.
  39566. * @return {UniformsGroup} A reference to this uniforms group.
  39567. */
  39568. setName( name ) {
  39569. this.name = name;
  39570. return this;
  39571. }
  39572. /**
  39573. * Sets the usage of this uniforms group.
  39574. *
  39575. * @param {(StaticDrawUsage|DynamicDrawUsage|StreamDrawUsage|StaticReadUsage|DynamicReadUsage|StreamReadUsage|StaticCopyUsage|DynamicCopyUsage|StreamCopyUsage)} value - The usage to set.
  39576. * @return {UniformsGroup} A reference to this uniforms group.
  39577. */
  39578. setUsage( value ) {
  39579. this.usage = value;
  39580. return this;
  39581. }
  39582. /**
  39583. * Frees the GPU-related resources allocated by this instance. Call this
  39584. * method whenever this instance is no longer used in your app.
  39585. *
  39586. * @fires Texture#dispose
  39587. */
  39588. dispose() {
  39589. this.dispatchEvent( { type: 'dispose' } );
  39590. }
  39591. /**
  39592. * Copies the values of the given uniforms group to this instance.
  39593. *
  39594. * @param {UniformsGroup} source - The uniforms group to copy.
  39595. * @return {UniformsGroup} A reference to this uniforms group.
  39596. */
  39597. copy( source ) {
  39598. this.name = source.name;
  39599. this.usage = source.usage;
  39600. const uniformsSource = source.uniforms;
  39601. this.uniforms.length = 0;
  39602. for ( let i = 0, l = uniformsSource.length; i < l; i ++ ) {
  39603. const uniforms = Array.isArray( uniformsSource[ i ] ) ? uniformsSource[ i ] : [ uniformsSource[ i ] ];
  39604. for ( let j = 0; j < uniforms.length; j ++ ) {
  39605. this.uniforms.push( uniforms[ j ].clone() );
  39606. }
  39607. }
  39608. return this;
  39609. }
  39610. /**
  39611. * Returns a new uniforms group with copied values from this instance.
  39612. *
  39613. * @return {UniformsGroup} A clone of this instance.
  39614. */
  39615. clone() {
  39616. return new this.constructor().copy( this );
  39617. }
  39618. }
  39619. /**
  39620. * An instanced version of an interleaved buffer.
  39621. *
  39622. * @augments InterleavedBuffer
  39623. */
  39624. class InstancedInterleavedBuffer extends InterleavedBuffer {
  39625. /**
  39626. * Constructs a new instanced interleaved buffer.
  39627. *
  39628. * @param {TypedArray} array - A typed array with a shared buffer storing attribute data.
  39629. * @param {number} stride - The number of typed-array elements per vertex.
  39630. * @param {number} [meshPerAttribute=1] - Defines how often a value of this interleaved buffer should be repeated.
  39631. */
  39632. constructor( array, stride, meshPerAttribute = 1 ) {
  39633. super( array, stride );
  39634. /**
  39635. * This flag can be used for type testing.
  39636. *
  39637. * @type {boolean}
  39638. * @readonly
  39639. * @default true
  39640. */
  39641. this.isInstancedInterleavedBuffer = true;
  39642. /**
  39643. * Defines how often a value of this buffer attribute should be repeated,
  39644. * see {@link InstancedBufferAttribute#meshPerAttribute}.
  39645. *
  39646. * @type {number}
  39647. * @default 1
  39648. */
  39649. this.meshPerAttribute = meshPerAttribute;
  39650. }
  39651. copy( source ) {
  39652. super.copy( source );
  39653. this.meshPerAttribute = source.meshPerAttribute;
  39654. return this;
  39655. }
  39656. clone( data ) {
  39657. const ib = super.clone( data );
  39658. ib.meshPerAttribute = this.meshPerAttribute;
  39659. return ib;
  39660. }
  39661. toJSON( data ) {
  39662. const json = super.toJSON( data );
  39663. json.isInstancedInterleavedBuffer = true;
  39664. json.meshPerAttribute = this.meshPerAttribute;
  39665. return json;
  39666. }
  39667. }
  39668. /**
  39669. * An alternative version of a buffer attribute with more control over the VBO.
  39670. *
  39671. * The renderer does not construct a VBO for this kind of attribute. Instead, it uses
  39672. * whatever VBO is passed in constructor and can later be altered via the `buffer` property.
  39673. *
  39674. * The most common use case for this class is when some kind of GPGPU calculation interferes
  39675. * or even produces the VBOs in question.
  39676. *
  39677. * Notice that this class can only be used with {@link WebGLRenderer}.
  39678. */
  39679. class GLBufferAttribute {
  39680. /**
  39681. * Constructs a new GL buffer attribute.
  39682. *
  39683. * @param {WebGLBuffer} buffer - The native WebGL buffer.
  39684. * @param {number} type - The native data type (e.g. `gl.FLOAT`).
  39685. * @param {number} itemSize - The item size.
  39686. * @param {number} elementSize - The corresponding size (in bytes) for the given `type` parameter.
  39687. * @param {number} count - The expected number of vertices in VBO.
  39688. * @param {boolean} [normalized=false] - Whether the data are normalized or not.
  39689. */
  39690. constructor( buffer, type, itemSize, elementSize, count, normalized = false ) {
  39691. /**
  39692. * This flag can be used for type testing.
  39693. *
  39694. * @type {boolean}
  39695. * @readonly
  39696. * @default true
  39697. */
  39698. this.isGLBufferAttribute = true;
  39699. /**
  39700. * The name of the buffer attribute.
  39701. *
  39702. * @type {string}
  39703. */
  39704. this.name = '';
  39705. /**
  39706. * The native WebGL buffer.
  39707. *
  39708. * @type {WebGLBuffer}
  39709. */
  39710. this.buffer = buffer;
  39711. /**
  39712. * The native data type.
  39713. *
  39714. * @type {number}
  39715. */
  39716. this.type = type;
  39717. /**
  39718. * The item size, see {@link BufferAttribute#itemSize}.
  39719. *
  39720. * @type {number}
  39721. */
  39722. this.itemSize = itemSize;
  39723. /**
  39724. * The corresponding size (in bytes) for the given `type` parameter.
  39725. *
  39726. * @type {number}
  39727. */
  39728. this.elementSize = elementSize;
  39729. /**
  39730. * The expected number of vertices in VBO.
  39731. *
  39732. * @type {number}
  39733. */
  39734. this.count = count;
  39735. /**
  39736. * Applies to integer data only. Indicates how the underlying data in the buffer maps to
  39737. * the values in the GLSL code. For instance, if `buffer` contains data of `gl.UNSIGNED_SHORT`,
  39738. * and `normalized` is `true`, the values `0 - +65535` in the buffer data will be mapped to
  39739. * `0.0f - +1.0f` in the GLSL attribute. If `normalized` is `false`, the values will be converted
  39740. * to floats unmodified, i.e. `65535` becomes `65535.0f`.
  39741. *
  39742. * @type {boolean}
  39743. */
  39744. this.normalized = normalized;
  39745. /**
  39746. * A version number, incremented every time the `needsUpdate` is set to `true`.
  39747. *
  39748. * @type {number}
  39749. */
  39750. this.version = 0;
  39751. }
  39752. /**
  39753. * Flag to indicate that this attribute has changed and should be re-sent to
  39754. * the GPU. Set this to `true` when you modify the value of the array.
  39755. *
  39756. * @type {number}
  39757. * @default false
  39758. * @param {boolean} value
  39759. */
  39760. set needsUpdate( value ) {
  39761. if ( value === true ) this.version ++;
  39762. }
  39763. /**
  39764. * Sets the given native WebGL buffer.
  39765. *
  39766. * @param {WebGLBuffer} buffer - The buffer to set.
  39767. * @return {BufferAttribute} A reference to this instance.
  39768. */
  39769. setBuffer( buffer ) {
  39770. this.buffer = buffer;
  39771. return this;
  39772. }
  39773. /**
  39774. * Sets the given native data type and element size.
  39775. *
  39776. * @param {number} type - The native data type (e.g. `gl.FLOAT`).
  39777. * @param {number} elementSize - The corresponding size (in bytes) for the given `type` parameter.
  39778. * @return {BufferAttribute} A reference to this instance.
  39779. */
  39780. setType( type, elementSize ) {
  39781. this.type = type;
  39782. this.elementSize = elementSize;
  39783. return this;
  39784. }
  39785. /**
  39786. * Sets the item size.
  39787. *
  39788. * @param {number} itemSize - The item size.
  39789. * @return {BufferAttribute} A reference to this instance.
  39790. */
  39791. setItemSize( itemSize ) {
  39792. this.itemSize = itemSize;
  39793. return this;
  39794. }
  39795. /**
  39796. * Sets the count (the expected number of vertices in VBO).
  39797. *
  39798. * @param {number} count - The count.
  39799. * @return {BufferAttribute} A reference to this instance.
  39800. */
  39801. setCount( count ) {
  39802. this.count = count;
  39803. return this;
  39804. }
  39805. }
  39806. const _matrix = /*@__PURE__*/ new Matrix4();
  39807. /**
  39808. * This class is designed to assist with raycasting. Raycasting is used for
  39809. * mouse picking (working out what objects in the 3d space the mouse is over)
  39810. * amongst other things.
  39811. */
  39812. class Raycaster {
  39813. /**
  39814. * Constructs a new raycaster.
  39815. *
  39816. * @param {Vector3} origin - The origin vector where the ray casts from.
  39817. * @param {Vector3} direction - The (normalized) direction vector that gives direction to the ray.
  39818. * @param {number} [near=0] - All results returned are further away than near. Near can't be negative.
  39819. * @param {number} [far=Infinity] - All results returned are closer than far. Far can't be lower than near.
  39820. */
  39821. constructor( origin, direction, near = 0, far = Infinity ) {
  39822. /**
  39823. * The ray used for raycasting.
  39824. *
  39825. * @type {Ray}
  39826. */
  39827. this.ray = new Ray( origin, direction );
  39828. /**
  39829. * All results returned are further away than near. Near can't be negative.
  39830. *
  39831. * @type {number}
  39832. * @default 0
  39833. */
  39834. this.near = near;
  39835. /**
  39836. * All results returned are closer than far. Far can't be lower than near.
  39837. *
  39838. * @type {number}
  39839. * @default Infinity
  39840. */
  39841. this.far = far;
  39842. /**
  39843. * The camera to use when raycasting against view-dependent objects such as
  39844. * billboarded objects like sprites. This field can be set manually or
  39845. * is set when calling `setFromCamera()`.
  39846. *
  39847. * @type {?Camera}
  39848. * @default null
  39849. */
  39850. this.camera = null;
  39851. /**
  39852. * Allows to selectively ignore 3D objects when performing intersection tests.
  39853. * The following code example ensures that only 3D objects on layer `1` will be
  39854. * honored by raycaster.
  39855. * ```js
  39856. * raycaster.layers.set( 1 );
  39857. * object.layers.enable( 1 );
  39858. * ```
  39859. *
  39860. * @type {Layers}
  39861. */
  39862. this.layers = new Layers();
  39863. /**
  39864. * A parameter object that configures the raycasting. It has the structure:
  39865. *
  39866. * ```
  39867. * {
  39868. * Mesh: {},
  39869. * Line: { threshold: 1 },
  39870. * LOD: {},
  39871. * Points: { threshold: 1 },
  39872. * Sprite: {}
  39873. * }
  39874. * ```
  39875. * Where `threshold` is the precision of the raycaster when intersecting objects, in world units.
  39876. *
  39877. * @type {Object}
  39878. */
  39879. this.params = {
  39880. Mesh: {},
  39881. Line: { threshold: 1 },
  39882. LOD: {},
  39883. Points: { threshold: 1 },
  39884. Sprite: {}
  39885. };
  39886. }
  39887. /**
  39888. * Updates the ray with a new origin and direction by copying the values from the arguments.
  39889. *
  39890. * @param {Vector3} origin - The origin vector where the ray casts from.
  39891. * @param {Vector3} direction - The (normalized) direction vector that gives direction to the ray.
  39892. */
  39893. set( origin, direction ) {
  39894. // direction is assumed to be normalized (for accurate distance calculations)
  39895. this.ray.set( origin, direction );
  39896. }
  39897. /**
  39898. * Uses the given coordinates and camera to compute a new origin and direction for the internal ray.
  39899. *
  39900. * @param {Vector2} coords - 2D coordinates of the mouse, in normalized device coordinates (NDC).
  39901. * X and Y components should be between `-1` and `1`.
  39902. * @param {Camera} camera - The camera from which the ray should originate.
  39903. */
  39904. setFromCamera( coords, camera ) {
  39905. if ( camera.isPerspectiveCamera ) {
  39906. this.ray.origin.setFromMatrixPosition( camera.matrixWorld );
  39907. this.ray.direction.set( coords.x, coords.y, 0.5 ).unproject( camera ).sub( this.ray.origin ).normalize();
  39908. this.camera = camera;
  39909. } else if ( camera.isOrthographicCamera ) {
  39910. this.ray.origin.set( coords.x, coords.y, ( camera.near + camera.far ) / ( camera.near - camera.far ) ).unproject( camera ); // set origin in plane of camera
  39911. this.ray.direction.set( 0, 0, -1 ).transformDirection( camera.matrixWorld );
  39912. this.camera = camera;
  39913. } else {
  39914. error( 'Raycaster: Unsupported camera type: ' + camera.type );
  39915. }
  39916. }
  39917. /**
  39918. * Uses the given WebXR controller to compute a new origin and direction for the internal ray.
  39919. *
  39920. * @param {WebXRController} controller - The controller to copy the position and direction from.
  39921. * @return {Raycaster} A reference to this raycaster.
  39922. */
  39923. setFromXRController( controller ) {
  39924. _matrix.identity().extractRotation( controller.matrixWorld );
  39925. this.ray.origin.setFromMatrixPosition( controller.matrixWorld );
  39926. this.ray.direction.set( 0, 0, -1 ).applyMatrix4( _matrix );
  39927. return this;
  39928. }
  39929. /**
  39930. * The intersection point of a raycaster intersection test.
  39931. * @typedef {Object} Raycaster~Intersection
  39932. * @property {number} distance - The distance from the ray's origin to the intersection point.
  39933. * @property {number} distanceToRay - Some 3D objects e.g. {@link Points} provide the distance of the
  39934. * intersection to the nearest point on the ray. For other objects it will be `undefined`.
  39935. * @property {Vector3} point - The intersection point, in world coordinates.
  39936. * @property {Object} face - The face that has been intersected.
  39937. * @property {number} faceIndex - The face index.
  39938. * @property {Object3D} object - The 3D object that has been intersected.
  39939. * @property {Vector2} uv - U,V coordinates at point of intersection.
  39940. * @property {Vector2} uv1 - Second set of U,V coordinates at point of intersection.
  39941. * @property {Vector3} normal - Interpolated normal vector at point of intersection.
  39942. * @property {number} instanceId - The index number of the instance where the ray
  39943. * intersects the {@link InstancedMesh}.
  39944. */
  39945. /**
  39946. * Checks all intersection between the ray and the object with or without the
  39947. * descendants. Intersections are returned sorted by distance, closest first.
  39948. *
  39949. * `Raycaster` delegates to the `raycast()` method of the passed 3D object, when
  39950. * evaluating whether the ray intersects the object or not. This allows meshes to respond
  39951. * differently to ray casting than lines or points.
  39952. *
  39953. * Note that for meshes, faces must be pointed towards the origin of the ray in order
  39954. * to be detected; intersections of the ray passing through the back of a face will not
  39955. * be detected. To raycast against both faces of an object, you'll want to set {@link Material#side}
  39956. * to `THREE.DoubleSide`.
  39957. *
  39958. * @param {Object3D} object - The 3D object to check for intersection with the ray.
  39959. * @param {boolean} [recursive=true] - If set to `true`, it also checks all descendants.
  39960. * Otherwise it only checks intersection with the object.
  39961. * @param {Array<Raycaster~Intersection>} [intersects=[]] The target array that holds the result of the method.
  39962. * @return {Array<Raycaster~Intersection>} An array holding the intersection points.
  39963. */
  39964. intersectObject( object, recursive = true, intersects = [] ) {
  39965. intersect( object, this, intersects, recursive );
  39966. intersects.sort( ascSort );
  39967. return intersects;
  39968. }
  39969. /**
  39970. * Checks all intersection between the ray and the objects with or without
  39971. * the descendants. Intersections are returned sorted by distance, closest first.
  39972. *
  39973. * @param {Array<Object3D>} objects - The 3D objects to check for intersection with the ray.
  39974. * @param {boolean} [recursive=true] - If set to `true`, it also checks all descendants.
  39975. * Otherwise it only checks intersection with the object.
  39976. * @param {Array<Raycaster~Intersection>} [intersects=[]] The target array that holds the result of the method.
  39977. * @return {Array<Raycaster~Intersection>} An array holding the intersection points.
  39978. */
  39979. intersectObjects( objects, recursive = true, intersects = [] ) {
  39980. for ( let i = 0, l = objects.length; i < l; i ++ ) {
  39981. intersect( objects[ i ], this, intersects, recursive );
  39982. }
  39983. intersects.sort( ascSort );
  39984. return intersects;
  39985. }
  39986. }
  39987. function ascSort( a, b ) {
  39988. return a.distance - b.distance;
  39989. }
  39990. function intersect( object, raycaster, intersects, recursive ) {
  39991. let propagate = true;
  39992. if ( object.layers.test( raycaster.layers ) ) {
  39993. const result = object.raycast( raycaster, intersects );
  39994. if ( result === false ) propagate = false;
  39995. }
  39996. if ( propagate === true && recursive === true ) {
  39997. const children = object.children;
  39998. for ( let i = 0, l = children.length; i < l; i ++ ) {
  39999. intersect( children[ i ], raycaster, intersects, true );
  40000. }
  40001. }
  40002. }
  40003. /**
  40004. * This class is an alternative to {@link Clock} with a different API design and behavior.
  40005. * The goal is to avoid the conceptual flaws that became apparent in `Clock` over time.
  40006. *
  40007. * - `Timer` has an `update()` method that updates its internal state. That makes it possible to
  40008. * call `getDelta()` and `getElapsed()` multiple times per simulation step without getting different values.
  40009. * - The class can make use of the Page Visibility API to avoid large time delta values when the app
  40010. * is inactive (e.g. tab switched or browser hidden).
  40011. *
  40012. * ```js
  40013. * const timer = new Timer();
  40014. * timer.connect( document ); // use Page Visibility API
  40015. * ```
  40016. */
  40017. class Timer {
  40018. /**
  40019. * Constructs a new timer.
  40020. */
  40021. constructor() {
  40022. this._previousTime = 0;
  40023. this._currentTime = 0;
  40024. this._startTime = performance.now();
  40025. this._delta = 0;
  40026. this._elapsed = 0;
  40027. this._timescale = 1;
  40028. this._document = null;
  40029. this._pageVisibilityHandler = null;
  40030. }
  40031. /**
  40032. * Connect the timer to the given document.Calling this method is not mandatory to
  40033. * use the timer but enables the usage of the Page Visibility API to avoid large time
  40034. * delta values.
  40035. *
  40036. * @param {Document} document - The document.
  40037. */
  40038. connect( document ) {
  40039. this._document = document;
  40040. // use Page Visibility API to avoid large time delta values
  40041. if ( document.hidden !== undefined ) {
  40042. this._pageVisibilityHandler = handleVisibilityChange.bind( this );
  40043. document.addEventListener( 'visibilitychange', this._pageVisibilityHandler, false );
  40044. }
  40045. }
  40046. /**
  40047. * Disconnects the timer from the DOM and also disables the usage of the Page Visibility API.
  40048. */
  40049. disconnect() {
  40050. if ( this._pageVisibilityHandler !== null ) {
  40051. this._document.removeEventListener( 'visibilitychange', this._pageVisibilityHandler );
  40052. this._pageVisibilityHandler = null;
  40053. }
  40054. this._document = null;
  40055. }
  40056. /**
  40057. * Returns the time delta in seconds.
  40058. *
  40059. * @return {number} The time delta in second.
  40060. */
  40061. getDelta() {
  40062. return this._delta / 1000;
  40063. }
  40064. /**
  40065. * Returns the elapsed time in seconds.
  40066. *
  40067. * @return {number} The elapsed time in second.
  40068. */
  40069. getElapsed() {
  40070. return this._elapsed / 1000;
  40071. }
  40072. /**
  40073. * Returns the timescale.
  40074. *
  40075. * @return {number} The timescale.
  40076. */
  40077. getTimescale() {
  40078. return this._timescale;
  40079. }
  40080. /**
  40081. * Sets the given timescale which scale the time delta computation
  40082. * in `update()`.
  40083. *
  40084. * @param {number} timescale - The timescale to set.
  40085. * @return {Timer} A reference to this timer.
  40086. */
  40087. setTimescale( timescale ) {
  40088. this._timescale = timescale;
  40089. return this;
  40090. }
  40091. /**
  40092. * Resets the time computation for the current simulation step.
  40093. *
  40094. * @return {Timer} A reference to this timer.
  40095. */
  40096. reset() {
  40097. this._currentTime = performance.now() - this._startTime;
  40098. return this;
  40099. }
  40100. /**
  40101. * Can be used to free all internal resources. Usually called when
  40102. * the timer instance isn't required anymore.
  40103. */
  40104. dispose() {
  40105. this.disconnect();
  40106. }
  40107. /**
  40108. * Updates the internal state of the timer. This method should be called
  40109. * once per simulation step and before you perform queries against the timer
  40110. * (e.g. via `getDelta()`).
  40111. *
  40112. * @param {number} timestamp - The current time in milliseconds. Can be obtained
  40113. * from the `requestAnimationFrame` callback argument. If not provided, the current
  40114. * time will be determined with `performance.now`.
  40115. * @return {Timer} A reference to this timer.
  40116. */
  40117. update( timestamp ) {
  40118. if ( this._pageVisibilityHandler !== null && this._document.hidden === true ) {
  40119. this._delta = 0;
  40120. } else {
  40121. this._previousTime = this._currentTime;
  40122. this._currentTime = ( timestamp !== undefined ? timestamp : performance.now() ) - this._startTime;
  40123. this._delta = ( this._currentTime - this._previousTime ) * this._timescale;
  40124. this._elapsed += this._delta; // _elapsed is the accumulation of all previous deltas
  40125. }
  40126. return this;
  40127. }
  40128. }
  40129. function handleVisibilityChange() {
  40130. if ( this._document.hidden === false ) this.reset();
  40131. }
  40132. /**
  40133. * This class can be used to represent points in 3D space as
  40134. * [Spherical coordinates](https://en.wikipedia.org/wiki/Spherical_coordinate_system).
  40135. */
  40136. class Spherical {
  40137. /**
  40138. * Constructs a new spherical.
  40139. *
  40140. * @param {number} [radius=1] - The radius, or the Euclidean distance (straight-line distance) from the point to the origin.
  40141. * @param {number} [phi=0] - The polar angle in radians from the y (up) axis.
  40142. * @param {number} [theta=0] - The equator/azimuthal angle in radians around the y (up) axis.
  40143. */
  40144. constructor( radius = 1, phi = 0, theta = 0 ) {
  40145. /**
  40146. * The radius, or the Euclidean distance (straight-line distance) from the point to the origin.
  40147. *
  40148. * @type {number}
  40149. * @default 1
  40150. */
  40151. this.radius = radius;
  40152. /**
  40153. * The polar angle in radians from the y (up) axis.
  40154. *
  40155. * @type {number}
  40156. * @default 0
  40157. */
  40158. this.phi = phi;
  40159. /**
  40160. * The equator/azimuthal angle in radians around the y (up) axis.
  40161. *
  40162. * @type {number}
  40163. * @default 0
  40164. */
  40165. this.theta = theta;
  40166. }
  40167. /**
  40168. * Sets the spherical components by copying the given values.
  40169. *
  40170. * @param {number} radius - The radius.
  40171. * @param {number} phi - The polar angle.
  40172. * @param {number} theta - The azimuthal angle.
  40173. * @return {Spherical} A reference to this spherical.
  40174. */
  40175. set( radius, phi, theta ) {
  40176. this.radius = radius;
  40177. this.phi = phi;
  40178. this.theta = theta;
  40179. return this;
  40180. }
  40181. /**
  40182. * Copies the values of the given spherical to this instance.
  40183. *
  40184. * @param {Spherical} other - The spherical to copy.
  40185. * @return {Spherical} A reference to this spherical.
  40186. */
  40187. copy( other ) {
  40188. this.radius = other.radius;
  40189. this.phi = other.phi;
  40190. this.theta = other.theta;
  40191. return this;
  40192. }
  40193. /**
  40194. * Restricts the polar angle [page:.phi phi] to be between `0.000001` and pi -
  40195. * `0.000001`.
  40196. *
  40197. * @return {Spherical} A reference to this spherical.
  40198. */
  40199. makeSafe() {
  40200. const EPS = 0.000001;
  40201. this.phi = clamp( this.phi, EPS, Math.PI - EPS );
  40202. return this;
  40203. }
  40204. /**
  40205. * Sets the spherical components from the given vector which is assumed to hold
  40206. * Cartesian coordinates.
  40207. *
  40208. * @param {Vector3} v - The vector to set.
  40209. * @return {Spherical} A reference to this spherical.
  40210. */
  40211. setFromVector3( v ) {
  40212. return this.setFromCartesianCoords( v.x, v.y, v.z );
  40213. }
  40214. /**
  40215. * Sets the spherical components from the given Cartesian coordinates.
  40216. *
  40217. * @param {number} x - The x value.
  40218. * @param {number} y - The y value.
  40219. * @param {number} z - The z value.
  40220. * @return {Spherical} A reference to this spherical.
  40221. */
  40222. setFromCartesianCoords( x, y, z ) {
  40223. this.radius = Math.sqrt( x * x + y * y + z * z );
  40224. if ( this.radius === 0 ) {
  40225. this.theta = 0;
  40226. this.phi = 0;
  40227. } else {
  40228. this.theta = Math.atan2( x, z );
  40229. this.phi = Math.acos( clamp( y / this.radius, -1, 1 ) );
  40230. }
  40231. return this;
  40232. }
  40233. /**
  40234. * Returns a new spherical with copied values from this instance.
  40235. *
  40236. * @return {Spherical} A clone of this instance.
  40237. */
  40238. clone() {
  40239. return new this.constructor().copy( this );
  40240. }
  40241. }
  40242. /**
  40243. * This class can be used to represent points in 3D space as
  40244. * [Cylindrical coordinates](https://en.wikipedia.org/wiki/Cylindrical_coordinate_system).
  40245. */
  40246. class Cylindrical {
  40247. /**
  40248. * Constructs a new cylindrical.
  40249. *
  40250. * @param {number} [radius=1] - The distance from the origin to a point in the x-z plane.
  40251. * @param {number} [theta=0] - A counterclockwise angle in the x-z plane measured in radians from the positive z-axis.
  40252. * @param {number} [y=0] - The height above the x-z plane.
  40253. */
  40254. constructor( radius = 1, theta = 0, y = 0 ) {
  40255. /**
  40256. * The distance from the origin to a point in the x-z plane.
  40257. *
  40258. * @type {number}
  40259. * @default 1
  40260. */
  40261. this.radius = radius;
  40262. /**
  40263. * A counterclockwise angle in the x-z plane measured in radians from the positive z-axis.
  40264. *
  40265. * @type {number}
  40266. * @default 0
  40267. */
  40268. this.theta = theta;
  40269. /**
  40270. * The height above the x-z plane.
  40271. *
  40272. * @type {number}
  40273. * @default 0
  40274. */
  40275. this.y = y;
  40276. }
  40277. /**
  40278. * Sets the cylindrical components by copying the given values.
  40279. *
  40280. * @param {number} radius - The radius.
  40281. * @param {number} theta - The theta angle.
  40282. * @param {number} y - The height value.
  40283. * @return {Cylindrical} A reference to this cylindrical.
  40284. */
  40285. set( radius, theta, y ) {
  40286. this.radius = radius;
  40287. this.theta = theta;
  40288. this.y = y;
  40289. return this;
  40290. }
  40291. /**
  40292. * Copies the values of the given cylindrical to this instance.
  40293. *
  40294. * @param {Cylindrical} other - The cylindrical to copy.
  40295. * @return {Cylindrical} A reference to this cylindrical.
  40296. */
  40297. copy( other ) {
  40298. this.radius = other.radius;
  40299. this.theta = other.theta;
  40300. this.y = other.y;
  40301. return this;
  40302. }
  40303. /**
  40304. * Sets the cylindrical components from the given vector which is assumed to hold
  40305. * Cartesian coordinates.
  40306. *
  40307. * @param {Vector3} v - The vector to set.
  40308. * @return {Cylindrical} A reference to this cylindrical.
  40309. */
  40310. setFromVector3( v ) {
  40311. return this.setFromCartesianCoords( v.x, v.y, v.z );
  40312. }
  40313. /**
  40314. * Sets the cylindrical components from the given Cartesian coordinates.
  40315. *
  40316. * @param {number} x - The x value.
  40317. * @param {number} y - The x value.
  40318. * @param {number} z - The x value.
  40319. * @return {Cylindrical} A reference to this cylindrical.
  40320. */
  40321. setFromCartesianCoords( x, y, z ) {
  40322. this.radius = Math.sqrt( x * x + z * z );
  40323. this.theta = Math.atan2( x, z );
  40324. this.y = y;
  40325. return this;
  40326. }
  40327. /**
  40328. * Returns a new cylindrical with copied values from this instance.
  40329. *
  40330. * @return {Cylindrical} A clone of this instance.
  40331. */
  40332. clone() {
  40333. return new this.constructor().copy( this );
  40334. }
  40335. }
  40336. /**
  40337. * Represents a 2x2 matrix.
  40338. *
  40339. * A Note on Row-Major and Column-Major Ordering:
  40340. *
  40341. * The constructor and {@link Matrix2#set} method take arguments in
  40342. * [row-major](https://en.wikipedia.org/wiki/Row-_and_column-major_order#Column-major_order)
  40343. * order, while internally they are stored in the {@link Matrix2#elements} array in column-major order.
  40344. * This means that calling:
  40345. * ```js
  40346. * const m = new THREE.Matrix2();
  40347. * m.set( 11, 12,
  40348. * 21, 22 );
  40349. * ```
  40350. * will result in the elements array containing:
  40351. * ```js
  40352. * m.elements = [ 11, 21,
  40353. * 12, 22 ];
  40354. * ```
  40355. * and internally all calculations are performed using column-major ordering.
  40356. * However, as the actual ordering makes no difference mathematically and
  40357. * most people are used to thinking about matrices in row-major order, the
  40358. * three.js documentation shows matrices in row-major order. Just bear in
  40359. * mind that if you are reading the source code, you'll have to take the
  40360. * transpose of any matrices outlined here to make sense of the calculations.
  40361. */
  40362. class Matrix2 {
  40363. /**
  40364. * Constructs a new 2x2 matrix. The arguments are supposed to be
  40365. * in row-major order. If no arguments are provided, the constructor
  40366. * initializes the matrix as an identity matrix.
  40367. *
  40368. * @param {number} [n11] - 1-1 matrix element.
  40369. * @param {number} [n12] - 1-2 matrix element.
  40370. * @param {number} [n21] - 2-1 matrix element.
  40371. * @param {number} [n22] - 2-2 matrix element.
  40372. */
  40373. constructor( n11, n12, n21, n22 ) {
  40374. /**
  40375. * This flag can be used for type testing.
  40376. *
  40377. * @type {boolean}
  40378. * @readonly
  40379. * @default true
  40380. */
  40381. Matrix2.prototype.isMatrix2 = true;
  40382. /**
  40383. * A column-major list of matrix values.
  40384. *
  40385. * @type {Array<number>}
  40386. */
  40387. this.elements = [
  40388. 1, 0,
  40389. 0, 1,
  40390. ];
  40391. if ( n11 !== undefined ) {
  40392. this.set( n11, n12, n21, n22 );
  40393. }
  40394. }
  40395. /**
  40396. * Sets this matrix to the 2x2 identity matrix.
  40397. *
  40398. * @return {Matrix2} A reference to this matrix.
  40399. */
  40400. identity() {
  40401. this.set(
  40402. 1, 0,
  40403. 0, 1,
  40404. );
  40405. return this;
  40406. }
  40407. /**
  40408. * Sets the elements of the matrix from the given array.
  40409. *
  40410. * @param {Array<number>} array - The matrix elements in column-major order.
  40411. * @param {number} [offset=0] - Index of the first element in the array.
  40412. * @return {Matrix2} A reference to this matrix.
  40413. */
  40414. fromArray( array, offset = 0 ) {
  40415. for ( let i = 0; i < 4; i ++ ) {
  40416. this.elements[ i ] = array[ i + offset ];
  40417. }
  40418. return this;
  40419. }
  40420. /**
  40421. * Sets the elements of the matrix.The arguments are supposed to be
  40422. * in row-major order.
  40423. *
  40424. * @param {number} n11 - 1-1 matrix element.
  40425. * @param {number} n12 - 1-2 matrix element.
  40426. * @param {number} n21 - 2-1 matrix element.
  40427. * @param {number} n22 - 2-2 matrix element.
  40428. * @return {Matrix2} A reference to this matrix.
  40429. */
  40430. set( n11, n12, n21, n22 ) {
  40431. const te = this.elements;
  40432. te[ 0 ] = n11; te[ 2 ] = n12;
  40433. te[ 1 ] = n21; te[ 3 ] = n22;
  40434. return this;
  40435. }
  40436. }
  40437. const _vector$4 = /*@__PURE__*/ new Vector2();
  40438. /**
  40439. * Represents an axis-aligned bounding box (AABB) in 2D space.
  40440. */
  40441. class Box2 {
  40442. /**
  40443. * Constructs a new bounding box.
  40444. *
  40445. * @param {Vector2} [min=(Infinity,Infinity)] - A vector representing the lower boundary of the box.
  40446. * @param {Vector2} [max=(-Infinity,-Infinity)] - A vector representing the upper boundary of the box.
  40447. */
  40448. constructor( min = new Vector2( + Infinity, + Infinity ), max = new Vector2( - Infinity, - Infinity ) ) {
  40449. /**
  40450. * This flag can be used for type testing.
  40451. *
  40452. * @type {boolean}
  40453. * @readonly
  40454. * @default true
  40455. */
  40456. this.isBox2 = true;
  40457. /**
  40458. * The lower boundary of the box.
  40459. *
  40460. * @type {Vector2}
  40461. */
  40462. this.min = min;
  40463. /**
  40464. * The upper boundary of the box.
  40465. *
  40466. * @type {Vector2}
  40467. */
  40468. this.max = max;
  40469. }
  40470. /**
  40471. * Sets the lower and upper boundaries of this box.
  40472. * Please note that this method only copies the values from the given objects.
  40473. *
  40474. * @param {Vector2} min - The lower boundary of the box.
  40475. * @param {Vector2} max - The upper boundary of the box.
  40476. * @return {Box2} A reference to this bounding box.
  40477. */
  40478. set( min, max ) {
  40479. this.min.copy( min );
  40480. this.max.copy( max );
  40481. return this;
  40482. }
  40483. /**
  40484. * Sets the upper and lower bounds of this box so it encloses the position data
  40485. * in the given array.
  40486. *
  40487. * @param {Array<Vector2>} points - An array holding 2D position data as instances of {@link Vector2}.
  40488. * @return {Box2} A reference to this bounding box.
  40489. */
  40490. setFromPoints( points ) {
  40491. this.makeEmpty();
  40492. for ( let i = 0, il = points.length; i < il; i ++ ) {
  40493. this.expandByPoint( points[ i ] );
  40494. }
  40495. return this;
  40496. }
  40497. /**
  40498. * Centers this box on the given center vector and sets this box's width, height and
  40499. * depth to the given size values.
  40500. *
  40501. * @param {Vector2} center - The center of the box.
  40502. * @param {Vector2} size - The x and y dimensions of the box.
  40503. * @return {Box2} A reference to this bounding box.
  40504. */
  40505. setFromCenterAndSize( center, size ) {
  40506. const halfSize = _vector$4.copy( size ).multiplyScalar( 0.5 );
  40507. this.min.copy( center ).sub( halfSize );
  40508. this.max.copy( center ).add( halfSize );
  40509. return this;
  40510. }
  40511. /**
  40512. * Returns a new box with copied values from this instance.
  40513. *
  40514. * @return {Box2} A clone of this instance.
  40515. */
  40516. clone() {
  40517. return new this.constructor().copy( this );
  40518. }
  40519. /**
  40520. * Copies the values of the given box to this instance.
  40521. *
  40522. * @param {Box2} box - The box to copy.
  40523. * @return {Box2} A reference to this bounding box.
  40524. */
  40525. copy( box ) {
  40526. this.min.copy( box.min );
  40527. this.max.copy( box.max );
  40528. return this;
  40529. }
  40530. /**
  40531. * Makes this box empty which means in encloses a zero space in 2D.
  40532. *
  40533. * @return {Box2} A reference to this bounding box.
  40534. */
  40535. makeEmpty() {
  40536. this.min.x = this.min.y = + Infinity;
  40537. this.max.x = this.max.y = - Infinity;
  40538. return this;
  40539. }
  40540. /**
  40541. * Returns true if this box includes zero points within its bounds.
  40542. * Note that a box with equal lower and upper bounds still includes one
  40543. * point, the one both bounds share.
  40544. *
  40545. * @return {boolean} Whether this box is empty or not.
  40546. */
  40547. isEmpty() {
  40548. // this is a more robust check for empty than ( volume <= 0 ) because volume can get positive with two negative axes
  40549. return ( this.max.x < this.min.x ) || ( this.max.y < this.min.y );
  40550. }
  40551. /**
  40552. * Returns the center point of this box.
  40553. *
  40554. * @param {Vector2} target - The target vector that is used to store the method's result.
  40555. * @return {Vector2} The center point.
  40556. */
  40557. getCenter( target ) {
  40558. return this.isEmpty() ? target.set( 0, 0 ) : target.addVectors( this.min, this.max ).multiplyScalar( 0.5 );
  40559. }
  40560. /**
  40561. * Returns the dimensions of this box.
  40562. *
  40563. * @param {Vector2} target - The target vector that is used to store the method's result.
  40564. * @return {Vector2} The size.
  40565. */
  40566. getSize( target ) {
  40567. return this.isEmpty() ? target.set( 0, 0 ) : target.subVectors( this.max, this.min );
  40568. }
  40569. /**
  40570. * Expands the boundaries of this box to include the given point.
  40571. *
  40572. * @param {Vector2} point - The point that should be included by the bounding box.
  40573. * @return {Box2} A reference to this bounding box.
  40574. */
  40575. expandByPoint( point ) {
  40576. this.min.min( point );
  40577. this.max.max( point );
  40578. return this;
  40579. }
  40580. /**
  40581. * Expands this box equilaterally by the given vector. The width of this
  40582. * box will be expanded by the x component of the vector in both
  40583. * directions. The height of this box will be expanded by the y component of
  40584. * the vector in both directions.
  40585. *
  40586. * @param {Vector2} vector - The vector that should expand the bounding box.
  40587. * @return {Box2} A reference to this bounding box.
  40588. */
  40589. expandByVector( vector ) {
  40590. this.min.sub( vector );
  40591. this.max.add( vector );
  40592. return this;
  40593. }
  40594. /**
  40595. * Expands each dimension of the box by the given scalar. If negative, the
  40596. * dimensions of the box will be contracted.
  40597. *
  40598. * @param {number} scalar - The scalar value that should expand the bounding box.
  40599. * @return {Box2} A reference to this bounding box.
  40600. */
  40601. expandByScalar( scalar ) {
  40602. this.min.addScalar( - scalar );
  40603. this.max.addScalar( scalar );
  40604. return this;
  40605. }
  40606. /**
  40607. * Returns `true` if the given point lies within or on the boundaries of this box.
  40608. *
  40609. * @param {Vector2} point - The point to test.
  40610. * @return {boolean} Whether the bounding box contains the given point or not.
  40611. */
  40612. containsPoint( point ) {
  40613. return point.x >= this.min.x && point.x <= this.max.x &&
  40614. point.y >= this.min.y && point.y <= this.max.y;
  40615. }
  40616. /**
  40617. * Returns `true` if this bounding box includes the entirety of the given bounding box.
  40618. * If this box and the given one are identical, this function also returns `true`.
  40619. *
  40620. * @param {Box2} box - The bounding box to test.
  40621. * @return {boolean} Whether the bounding box contains the given bounding box or not.
  40622. */
  40623. containsBox( box ) {
  40624. return this.min.x <= box.min.x && box.max.x <= this.max.x &&
  40625. this.min.y <= box.min.y && box.max.y <= this.max.y;
  40626. }
  40627. /**
  40628. * Returns a point as a proportion of this box's width and height.
  40629. *
  40630. * @param {Vector2} point - A point in 2D space.
  40631. * @param {Vector2} target - The target vector that is used to store the method's result.
  40632. * @return {Vector2} A point as a proportion of this box's width and height.
  40633. */
  40634. getParameter( point, target ) {
  40635. // This can potentially have a divide by zero if the box
  40636. // has a size dimension of 0.
  40637. return target.set(
  40638. ( point.x - this.min.x ) / ( this.max.x - this.min.x ),
  40639. ( point.y - this.min.y ) / ( this.max.y - this.min.y )
  40640. );
  40641. }
  40642. /**
  40643. * Returns `true` if the given bounding box intersects with this bounding box.
  40644. *
  40645. * @param {Box2} box - The bounding box to test.
  40646. * @return {boolean} Whether the given bounding box intersects with this bounding box.
  40647. */
  40648. intersectsBox( box ) {
  40649. // using 4 splitting planes to rule out intersections
  40650. return box.max.x >= this.min.x && box.min.x <= this.max.x &&
  40651. box.max.y >= this.min.y && box.min.y <= this.max.y;
  40652. }
  40653. /**
  40654. * Clamps the given point within the bounds of this box.
  40655. *
  40656. * @param {Vector2} point - The point to clamp.
  40657. * @param {Vector2} target - The target vector that is used to store the method's result.
  40658. * @return {Vector2} The clamped point.
  40659. */
  40660. clampPoint( point, target ) {
  40661. return target.copy( point ).clamp( this.min, this.max );
  40662. }
  40663. /**
  40664. * Returns the euclidean distance from any edge of this box to the specified point. If
  40665. * the given point lies inside of this box, the distance will be `0`.
  40666. *
  40667. * @param {Vector2} point - The point to compute the distance to.
  40668. * @return {number} The euclidean distance.
  40669. */
  40670. distanceToPoint( point ) {
  40671. return this.clampPoint( point, _vector$4 ).distanceTo( point );
  40672. }
  40673. /**
  40674. * Computes the intersection of this bounding box and the given one, setting the upper
  40675. * bound of this box to the lesser of the two boxes' upper bounds and the
  40676. * lower bound of this box to the greater of the two boxes' lower bounds. If
  40677. * there's no overlap, makes this box empty.
  40678. *
  40679. * @param {Box2} box - The bounding box to intersect with.
  40680. * @return {Box2} A reference to this bounding box.
  40681. */
  40682. intersect( box ) {
  40683. this.min.max( box.min );
  40684. this.max.min( box.max );
  40685. if ( this.isEmpty() ) this.makeEmpty();
  40686. return this;
  40687. }
  40688. /**
  40689. * Computes the union of this box and another and the given one, setting the upper
  40690. * bound of this box to the greater of the two boxes' upper bounds and the
  40691. * lower bound of this box to the lesser of the two boxes' lower bounds.
  40692. *
  40693. * @param {Box2} box - The bounding box that will be unioned with this instance.
  40694. * @return {Box2} A reference to this bounding box.
  40695. */
  40696. union( box ) {
  40697. this.min.min( box.min );
  40698. this.max.max( box.max );
  40699. return this;
  40700. }
  40701. /**
  40702. * Adds the given offset to both the upper and lower bounds of this bounding box,
  40703. * effectively moving it in 2D space.
  40704. *
  40705. * @param {Vector2} offset - The offset that should be used to translate the bounding box.
  40706. * @return {Box2} A reference to this bounding box.
  40707. */
  40708. translate( offset ) {
  40709. this.min.add( offset );
  40710. this.max.add( offset );
  40711. return this;
  40712. }
  40713. /**
  40714. * Returns `true` if this bounding box is equal with the given one.
  40715. *
  40716. * @param {Box2} box - The box to test for equality.
  40717. * @return {boolean} Whether this bounding box is equal with the given one.
  40718. */
  40719. equals( box ) {
  40720. return box.min.equals( this.min ) && box.max.equals( this.max );
  40721. }
  40722. }
  40723. const _startP = /*@__PURE__*/ new Vector3();
  40724. const _startEnd = /*@__PURE__*/ new Vector3();
  40725. const _d1 = /*@__PURE__*/ new Vector3();
  40726. const _d2 = /*@__PURE__*/ new Vector3();
  40727. const _r = /*@__PURE__*/ new Vector3();
  40728. const _c1 = /*@__PURE__*/ new Vector3();
  40729. const _c2 = /*@__PURE__*/ new Vector3();
  40730. /**
  40731. * An analytical line segment in 3D space represented by a start and end point.
  40732. */
  40733. class Line3 {
  40734. /**
  40735. * Constructs a new line segment.
  40736. *
  40737. * @param {Vector3} [start=(0,0,0)] - Start of the line segment.
  40738. * @param {Vector3} [end=(0,0,0)] - End of the line segment.
  40739. */
  40740. constructor( start = new Vector3(), end = new Vector3() ) {
  40741. /**
  40742. * Start of the line segment.
  40743. *
  40744. * @type {Vector3}
  40745. */
  40746. this.start = start;
  40747. /**
  40748. * End of the line segment.
  40749. *
  40750. * @type {Vector3}
  40751. */
  40752. this.end = end;
  40753. }
  40754. /**
  40755. * Sets the start and end values by copying the given vectors.
  40756. *
  40757. * @param {Vector3} start - The start point.
  40758. * @param {Vector3} end - The end point.
  40759. * @return {Line3} A reference to this line segment.
  40760. */
  40761. set( start, end ) {
  40762. this.start.copy( start );
  40763. this.end.copy( end );
  40764. return this;
  40765. }
  40766. /**
  40767. * Copies the values of the given line segment to this instance.
  40768. *
  40769. * @param {Line3} line - The line segment to copy.
  40770. * @return {Line3} A reference to this line segment.
  40771. */
  40772. copy( line ) {
  40773. this.start.copy( line.start );
  40774. this.end.copy( line.end );
  40775. return this;
  40776. }
  40777. /**
  40778. * Returns the center of the line segment.
  40779. *
  40780. * @param {Vector3} target - The target vector that is used to store the method's result.
  40781. * @return {Vector3} The center point.
  40782. */
  40783. getCenter( target ) {
  40784. return target.addVectors( this.start, this.end ).multiplyScalar( 0.5 );
  40785. }
  40786. /**
  40787. * Returns the delta vector of the line segment's start and end point.
  40788. *
  40789. * @param {Vector3} target - The target vector that is used to store the method's result.
  40790. * @return {Vector3} The delta vector.
  40791. */
  40792. delta( target ) {
  40793. return target.subVectors( this.end, this.start );
  40794. }
  40795. /**
  40796. * Returns the squared Euclidean distance between the line' start and end point.
  40797. *
  40798. * @return {number} The squared Euclidean distance.
  40799. */
  40800. distanceSq() {
  40801. return this.start.distanceToSquared( this.end );
  40802. }
  40803. /**
  40804. * Returns the Euclidean distance between the line' start and end point.
  40805. *
  40806. * @return {number} The Euclidean distance.
  40807. */
  40808. distance() {
  40809. return this.start.distanceTo( this.end );
  40810. }
  40811. /**
  40812. * Returns a vector at a certain position along the line segment.
  40813. *
  40814. * @param {number} t - A value between `[0,1]` to represent a position along the line segment.
  40815. * @param {Vector3} target - The target vector that is used to store the method's result.
  40816. * @return {Vector3} The delta vector.
  40817. */
  40818. at( t, target ) {
  40819. return this.delta( target ).multiplyScalar( t ).add( this.start );
  40820. }
  40821. /**
  40822. * Returns a point parameter based on the closest point as projected on the line segment.
  40823. *
  40824. * @param {Vector3} point - The point for which to return a point parameter.
  40825. * @param {boolean} clampToLine - Whether to clamp the result to the range `[0,1]` or not.
  40826. * @return {number} The point parameter.
  40827. */
  40828. closestPointToPointParameter( point, clampToLine ) {
  40829. _startP.subVectors( point, this.start );
  40830. _startEnd.subVectors( this.end, this.start );
  40831. const startEnd2 = _startEnd.dot( _startEnd );
  40832. const startEnd_startP = _startEnd.dot( _startP );
  40833. let t = startEnd_startP / startEnd2;
  40834. if ( clampToLine ) {
  40835. t = clamp( t, 0, 1 );
  40836. }
  40837. return t;
  40838. }
  40839. /**
  40840. * Returns the closest point on the line for a given point.
  40841. *
  40842. * @param {Vector3} point - The point to compute the closest point on the line for.
  40843. * @param {boolean} clampToLine - Whether to clamp the result to the range `[0,1]` or not.
  40844. * @param {Vector3} target - The target vector that is used to store the method's result.
  40845. * @return {Vector3} The closest point on the line.
  40846. */
  40847. closestPointToPoint( point, clampToLine, target ) {
  40848. const t = this.closestPointToPointParameter( point, clampToLine );
  40849. return this.delta( target ).multiplyScalar( t ).add( this.start );
  40850. }
  40851. /**
  40852. * Returns the closest squared distance between this line segment and the given one.
  40853. *
  40854. * @param {Line3} line - The line segment to compute the closest squared distance to.
  40855. * @param {Vector3} [c1] - The closest point on this line segment.
  40856. * @param {Vector3} [c2] - The closest point on the given line segment.
  40857. * @return {number} The squared distance between this line segment and the given one.
  40858. */
  40859. distanceSqToLine3( line, c1 = _c1, c2 = _c2 ) {
  40860. // from Real-Time Collision Detection by Christer Ericson, chapter 5.1.9
  40861. // Computes closest points C1 and C2 of S1(s)=P1+s*(Q1-P1) and
  40862. // S2(t)=P2+t*(Q2-P2), returning s and t. Function result is squared
  40863. // distance between between S1(s) and S2(t)
  40864. const EPSILON = 1e-8 * 1e-8; // must be squared since we compare squared length
  40865. let s, t;
  40866. const p1 = this.start;
  40867. const p2 = line.start;
  40868. const q1 = this.end;
  40869. const q2 = line.end;
  40870. _d1.subVectors( q1, p1 ); // Direction vector of segment S1
  40871. _d2.subVectors( q2, p2 ); // Direction vector of segment S2
  40872. _r.subVectors( p1, p2 );
  40873. const a = _d1.dot( _d1 ); // Squared length of segment S1, always nonnegative
  40874. const e = _d2.dot( _d2 ); // Squared length of segment S2, always nonnegative
  40875. const f = _d2.dot( _r );
  40876. // Check if either or both segments degenerate into points
  40877. if ( a <= EPSILON && e <= EPSILON ) {
  40878. // Both segments degenerate into points
  40879. c1.copy( p1 );
  40880. c2.copy( p2 );
  40881. c1.sub( c2 );
  40882. return c1.dot( c1 );
  40883. }
  40884. if ( a <= EPSILON ) {
  40885. // First segment degenerates into a point
  40886. s = 0;
  40887. t = f / e; // s = 0 => t = (b*s + f) / e = f / e
  40888. t = clamp( t, 0, 1 );
  40889. } else {
  40890. const c = _d1.dot( _r );
  40891. if ( e <= EPSILON ) {
  40892. // Second segment degenerates into a point
  40893. t = 0;
  40894. s = clamp( - c / a, 0, 1 ); // t = 0 => s = (b*t - c) / a = -c / a
  40895. } else {
  40896. // The general nondegenerate case starts here
  40897. const b = _d1.dot( _d2 );
  40898. const denom = a * e - b * b; // Always nonnegative
  40899. // If segments not parallel, compute closest point on L1 to L2 and
  40900. // clamp to segment S1. Else pick arbitrary s (here 0)
  40901. if ( denom !== 0 ) {
  40902. s = clamp( ( b * f - c * e ) / denom, 0, 1 );
  40903. } else {
  40904. s = 0;
  40905. }
  40906. // Compute point on L2 closest to S1(s) using
  40907. // t = Dot((P1 + D1*s) - P2,D2) / Dot(D2,D2) = (b*s + f) / e
  40908. t = ( b * s + f ) / e;
  40909. // If t in [0,1] done. Else clamp t, recompute s for the new value
  40910. // of t using s = Dot((P2 + D2*t) - P1,D1) / Dot(D1,D1)= (t*b - c) / a
  40911. // and clamp s to [0, 1]
  40912. if ( t < 0 ) {
  40913. t = 0.;
  40914. s = clamp( - c / a, 0, 1 );
  40915. } else if ( t > 1 ) {
  40916. t = 1;
  40917. s = clamp( ( b - c ) / a, 0, 1 );
  40918. }
  40919. }
  40920. }
  40921. c1.copy( p1 ).add( _d1.multiplyScalar( s ) );
  40922. c2.copy( p2 ).add( _d2.multiplyScalar( t ) );
  40923. c1.sub( c2 );
  40924. return c1.dot( c1 );
  40925. }
  40926. /**
  40927. * Applies a 4x4 transformation matrix to this line segment.
  40928. *
  40929. * @param {Matrix4} matrix - The transformation matrix.
  40930. * @return {Line3} A reference to this line segment.
  40931. */
  40932. applyMatrix4( matrix ) {
  40933. this.start.applyMatrix4( matrix );
  40934. this.end.applyMatrix4( matrix );
  40935. return this;
  40936. }
  40937. /**
  40938. * Returns `true` if this line segment is equal with the given one.
  40939. *
  40940. * @param {Line3} line - The line segment to test for equality.
  40941. * @return {boolean} Whether this line segment is equal with the given one.
  40942. */
  40943. equals( line ) {
  40944. return line.start.equals( this.start ) && line.end.equals( this.end );
  40945. }
  40946. /**
  40947. * Returns a new line segment with copied values from this instance.
  40948. *
  40949. * @return {Line3} A clone of this instance.
  40950. */
  40951. clone() {
  40952. return new this.constructor().copy( this );
  40953. }
  40954. }
  40955. const _vector$3 = /*@__PURE__*/ new Vector3();
  40956. /**
  40957. * This displays a cone shaped helper object for a {@link SpotLight}.
  40958. *
  40959. * ```js
  40960. * const spotLight = new THREE.SpotLight( 0xffffff );
  40961. * spotLight.position.set( 10, 10, 10 );
  40962. * scene.add( spotLight );
  40963. *
  40964. * const spotLightHelper = new THREE.SpotLightHelper( spotLight );
  40965. * scene.add( spotLightHelper );
  40966. * ```
  40967. *
  40968. * @augments Object3D
  40969. */
  40970. class SpotLightHelper extends Object3D {
  40971. /**
  40972. * Constructs a new spot light helper.
  40973. *
  40974. * @param {HemisphereLight} light - The light to be visualized.
  40975. * @param {number|Color|string} [color] - The helper's color. If not set, the helper will take
  40976. * the color of the light.
  40977. */
  40978. constructor( light, color ) {
  40979. super();
  40980. /**
  40981. * The light being visualized.
  40982. *
  40983. * @type {SpotLight}
  40984. */
  40985. this.light = light;
  40986. this.matrixAutoUpdate = false;
  40987. /**
  40988. * The color parameter passed in the constructor.
  40989. * If not set, the helper will take the color of the light.
  40990. *
  40991. * @type {number|Color|string}
  40992. */
  40993. this.color = color;
  40994. this.type = 'SpotLightHelper';
  40995. const geometry = new BufferGeometry();
  40996. const positions = [
  40997. 0, 0, 0, 0, 0, 1,
  40998. 0, 0, 0, 1, 0, 1,
  40999. 0, 0, 0, -1, 0, 1,
  41000. 0, 0, 0, 0, 1, 1,
  41001. 0, 0, 0, 0, -1, 1
  41002. ];
  41003. for ( let i = 0, j = 1, l = 32; i < l; i ++, j ++ ) {
  41004. const p1 = ( i / l ) * Math.PI * 2;
  41005. const p2 = ( j / l ) * Math.PI * 2;
  41006. positions.push(
  41007. Math.cos( p1 ), Math.sin( p1 ), 1,
  41008. Math.cos( p2 ), Math.sin( p2 ), 1
  41009. );
  41010. }
  41011. geometry.setAttribute( 'position', new Float32BufferAttribute( positions, 3 ) );
  41012. const material = new LineBasicMaterial( { fog: false, toneMapped: false } );
  41013. this.cone = new LineSegments( geometry, material );
  41014. this.add( this.cone );
  41015. this.update();
  41016. }
  41017. /**
  41018. * Frees the GPU-related resources allocated by this instance. Call this
  41019. * method whenever this instance is no longer used in your app.
  41020. */
  41021. dispose() {
  41022. this.cone.geometry.dispose();
  41023. this.cone.material.dispose();
  41024. }
  41025. /**
  41026. * Updates the helper to match the position and direction of the
  41027. * light being visualized.
  41028. */
  41029. update() {
  41030. this.light.updateWorldMatrix( true, false );
  41031. this.light.target.updateWorldMatrix( true, false );
  41032. // update the local matrix based on the parent and light target transforms
  41033. if ( this.parent ) {
  41034. this.parent.updateWorldMatrix( true );
  41035. this.matrix
  41036. .copy( this.parent.matrixWorld )
  41037. .invert()
  41038. .multiply( this.light.matrixWorld );
  41039. } else {
  41040. this.matrix.copy( this.light.matrixWorld );
  41041. }
  41042. this.matrixWorld.copy( this.light.matrixWorld );
  41043. const coneLength = this.light.distance ? this.light.distance : 1000;
  41044. const coneWidth = coneLength * Math.tan( this.light.angle );
  41045. this.cone.scale.set( coneWidth, coneWidth, coneLength );
  41046. _vector$3.setFromMatrixPosition( this.light.target.matrixWorld );
  41047. this.cone.lookAt( _vector$3 );
  41048. if ( this.color !== undefined ) {
  41049. this.cone.material.color.set( this.color );
  41050. } else {
  41051. this.cone.material.color.copy( this.light.color );
  41052. }
  41053. }
  41054. }
  41055. const _vector$2 = /*@__PURE__*/ new Vector3();
  41056. const _boneMatrix = /*@__PURE__*/ new Matrix4();
  41057. const _matrixWorldInv = /*@__PURE__*/ new Matrix4();
  41058. /**
  41059. * A helper object to assist with visualizing a {@link Skeleton}.
  41060. *
  41061. * ```js
  41062. * const helper = new THREE.SkeletonHelper( skinnedMesh );
  41063. * scene.add( helper );
  41064. * ```
  41065. *
  41066. * @augments LineSegments
  41067. */
  41068. class SkeletonHelper extends LineSegments {
  41069. /**
  41070. * Constructs a new skeleton helper.
  41071. *
  41072. * @param {Object3D} object - Usually an instance of {@link SkinnedMesh}. However, any 3D object
  41073. * can be used if it represents a hierarchy of bones (see {@link Bone}).
  41074. */
  41075. constructor( object ) {
  41076. const bones = getBoneList( object );
  41077. const geometry = new BufferGeometry();
  41078. const vertices = [];
  41079. const colors = [];
  41080. for ( let i = 0; i < bones.length; i ++ ) {
  41081. const bone = bones[ i ];
  41082. if ( bone.parent && bone.parent.isBone ) {
  41083. vertices.push( 0, 0, 0 );
  41084. vertices.push( 0, 0, 0 );
  41085. colors.push( 0, 0, 0 );
  41086. colors.push( 0, 0, 0 );
  41087. }
  41088. }
  41089. geometry.setAttribute( 'position', new Float32BufferAttribute( vertices, 3 ) );
  41090. geometry.setAttribute( 'color', new Float32BufferAttribute( colors, 3 ) );
  41091. const material = new LineBasicMaterial( { vertexColors: true, depthTest: false, depthWrite: false, toneMapped: false, transparent: true } );
  41092. super( geometry, material );
  41093. /**
  41094. * This flag can be used for type testing.
  41095. *
  41096. * @type {boolean}
  41097. * @readonly
  41098. * @default true
  41099. */
  41100. this.isSkeletonHelper = true;
  41101. this.type = 'SkeletonHelper';
  41102. /**
  41103. * The object being visualized.
  41104. *
  41105. * @type {Object3D}
  41106. */
  41107. this.root = object;
  41108. /**
  41109. * The list of bones that the helper visualizes.
  41110. *
  41111. * @type {Array<Bone>}
  41112. */
  41113. this.bones = bones;
  41114. this.matrix = object.matrixWorld;
  41115. this.matrixAutoUpdate = false;
  41116. // colors
  41117. const color1 = new Color( 0x0000ff );
  41118. const color2 = new Color( 0x00ff00 );
  41119. this.setColors( color1, color2 );
  41120. }
  41121. updateMatrixWorld( force ) {
  41122. const bones = this.bones;
  41123. const geometry = this.geometry;
  41124. const position = geometry.getAttribute( 'position' );
  41125. _matrixWorldInv.copy( this.root.matrixWorld ).invert();
  41126. for ( let i = 0, j = 0; i < bones.length; i ++ ) {
  41127. const bone = bones[ i ];
  41128. if ( bone.parent && bone.parent.isBone ) {
  41129. _boneMatrix.multiplyMatrices( _matrixWorldInv, bone.matrixWorld );
  41130. _vector$2.setFromMatrixPosition( _boneMatrix );
  41131. position.setXYZ( j, _vector$2.x, _vector$2.y, _vector$2.z );
  41132. _boneMatrix.multiplyMatrices( _matrixWorldInv, bone.parent.matrixWorld );
  41133. _vector$2.setFromMatrixPosition( _boneMatrix );
  41134. position.setXYZ( j + 1, _vector$2.x, _vector$2.y, _vector$2.z );
  41135. j += 2;
  41136. }
  41137. }
  41138. geometry.getAttribute( 'position' ).needsUpdate = true;
  41139. super.updateMatrixWorld( force );
  41140. }
  41141. /**
  41142. * Defines the colors of the helper.
  41143. *
  41144. * @param {Color} color1 - The first line color for each bone.
  41145. * @param {Color} color2 - The second line color for each bone.
  41146. * @return {SkeletonHelper} A reference to this helper.
  41147. */
  41148. setColors( color1, color2 ) {
  41149. const geometry = this.geometry;
  41150. const colorAttribute = geometry.getAttribute( 'color' );
  41151. for ( let i = 0; i < colorAttribute.count; i += 2 ) {
  41152. colorAttribute.setXYZ( i, color1.r, color1.g, color1.b );
  41153. colorAttribute.setXYZ( i + 1, color2.r, color2.g, color2.b );
  41154. }
  41155. colorAttribute.needsUpdate = true;
  41156. return this;
  41157. }
  41158. /**
  41159. * Frees the GPU-related resources allocated by this instance. Call this
  41160. * method whenever this instance is no longer used in your app.
  41161. */
  41162. dispose() {
  41163. this.geometry.dispose();
  41164. this.material.dispose();
  41165. }
  41166. }
  41167. function getBoneList( object ) {
  41168. const boneList = [];
  41169. if ( object.isBone === true ) {
  41170. boneList.push( object );
  41171. }
  41172. for ( let i = 0; i < object.children.length; i ++ ) {
  41173. boneList.push( ...getBoneList( object.children[ i ] ) );
  41174. }
  41175. return boneList;
  41176. }
  41177. /**
  41178. * This displays a helper object consisting of a spherical mesh for
  41179. * visualizing an instance of {@link PointLight}.
  41180. *
  41181. * ```js
  41182. * const pointLight = new THREE.PointLight( 0xff0000, 1, 100 );
  41183. * pointLight.position.set( 10, 10, 10 );
  41184. * scene.add( pointLight );
  41185. *
  41186. * const sphereSize = 1;
  41187. * const pointLightHelper = new THREE.PointLightHelper( pointLight, sphereSize );
  41188. * scene.add( pointLightHelper );
  41189. * ```
  41190. *
  41191. * @augments Mesh
  41192. */
  41193. class PointLightHelper extends Mesh {
  41194. /**
  41195. * Constructs a new point light helper.
  41196. *
  41197. * @param {PointLight} light - The light to be visualized.
  41198. * @param {number} [sphereSize=1] - The size of the sphere helper.
  41199. * @param {number|Color|string} [color] - The helper's color. If not set, the helper will take
  41200. * the color of the light.
  41201. */
  41202. constructor( light, sphereSize, color ) {
  41203. const geometry = new SphereGeometry( sphereSize, 4, 2 );
  41204. const material = new MeshBasicMaterial( { wireframe: true, fog: false, toneMapped: false } );
  41205. super( geometry, material );
  41206. /**
  41207. * The light being visualized.
  41208. *
  41209. * @type {PointLight}
  41210. */
  41211. this.light = light;
  41212. /**
  41213. * The color parameter passed in the constructor.
  41214. * If not set, the helper will take the color of the light.
  41215. *
  41216. * @type {number|Color|string}
  41217. */
  41218. this.color = color;
  41219. this.type = 'PointLightHelper';
  41220. this.matrix = this.light.matrixWorld;
  41221. this.matrixAutoUpdate = false;
  41222. this.update();
  41223. /*
  41224. // TODO: delete this comment?
  41225. const distanceGeometry = new THREE.IcosahedronGeometry( 1, 2 );
  41226. const distanceMaterial = new THREE.MeshBasicMaterial( { color: hexColor, fog: false, wireframe: true, opacity: 0.1, transparent: true } );
  41227. this.lightSphere = new THREE.Mesh( bulbGeometry, bulbMaterial );
  41228. this.lightDistance = new THREE.Mesh( distanceGeometry, distanceMaterial );
  41229. const d = light.distance;
  41230. if ( d === 0.0 ) {
  41231. this.lightDistance.visible = false;
  41232. } else {
  41233. this.lightDistance.scale.set( d, d, d );
  41234. }
  41235. this.add( this.lightDistance );
  41236. */
  41237. }
  41238. /**
  41239. * Frees the GPU-related resources allocated by this instance. Call this
  41240. * method whenever this instance is no longer used in your app.
  41241. */
  41242. dispose() {
  41243. this.geometry.dispose();
  41244. this.material.dispose();
  41245. }
  41246. /**
  41247. * Updates the helper to match the position of the
  41248. * light being visualized.
  41249. */
  41250. update() {
  41251. this.light.updateWorldMatrix( true, false );
  41252. if ( this.color !== undefined ) {
  41253. this.material.color.set( this.color );
  41254. } else {
  41255. this.material.color.copy( this.light.color );
  41256. }
  41257. /*
  41258. const d = this.light.distance;
  41259. if ( d === 0.0 ) {
  41260. this.lightDistance.visible = false;
  41261. } else {
  41262. this.lightDistance.visible = true;
  41263. this.lightDistance.scale.set( d, d, d );
  41264. }
  41265. */
  41266. }
  41267. }
  41268. const _vector$1 = /*@__PURE__*/ new Vector3();
  41269. const _color1 = /*@__PURE__*/ new Color();
  41270. const _color2 = /*@__PURE__*/ new Color();
  41271. /**
  41272. * Creates a visual aid consisting of a spherical mesh for a
  41273. * given {@link HemisphereLight}.
  41274. *
  41275. * ```js
  41276. * const light = new THREE.HemisphereLight( 0xffffbb, 0x080820, 1 );
  41277. * const helper = new THREE.HemisphereLightHelper( light, 5 );
  41278. * scene.add( helper );
  41279. * ```
  41280. *
  41281. * @augments Object3D
  41282. */
  41283. class HemisphereLightHelper extends Object3D {
  41284. /**
  41285. * Constructs a new hemisphere light helper.
  41286. *
  41287. * @param {HemisphereLight} light - The light to be visualized.
  41288. * @param {number} [size=1] - The size of the mesh used to visualize the light.
  41289. * @param {number|Color|string} [color] - The helper's color. If not set, the helper will take
  41290. * the color of the light.
  41291. */
  41292. constructor( light, size, color ) {
  41293. super();
  41294. /**
  41295. * The light being visualized.
  41296. *
  41297. * @type {HemisphereLight}
  41298. */
  41299. this.light = light;
  41300. this.matrix = light.matrixWorld;
  41301. this.matrixAutoUpdate = false;
  41302. /**
  41303. * The color parameter passed in the constructor.
  41304. * If not set, the helper will take the color of the light.
  41305. *
  41306. * @type {number|Color|string}
  41307. */
  41308. this.color = color;
  41309. this.type = 'HemisphereLightHelper';
  41310. const geometry = new OctahedronGeometry( size );
  41311. geometry.rotateY( Math.PI * 0.5 );
  41312. this.material = new MeshBasicMaterial( { wireframe: true, fog: false, toneMapped: false } );
  41313. if ( this.color === undefined ) this.material.vertexColors = true;
  41314. const position = geometry.getAttribute( 'position' );
  41315. const colors = new Float32Array( position.count * 3 );
  41316. geometry.setAttribute( 'color', new BufferAttribute( colors, 3 ) );
  41317. this.add( new Mesh( geometry, this.material ) );
  41318. this.update();
  41319. }
  41320. /**
  41321. * Frees the GPU-related resources allocated by this instance. Call this
  41322. * method whenever this instance is no longer used in your app.
  41323. */
  41324. dispose() {
  41325. this.children[ 0 ].geometry.dispose();
  41326. this.children[ 0 ].material.dispose();
  41327. }
  41328. /**
  41329. * Updates the helper to match the position and direction of the
  41330. * light being visualized.
  41331. */
  41332. update() {
  41333. const mesh = this.children[ 0 ];
  41334. if ( this.color !== undefined ) {
  41335. this.material.color.set( this.color );
  41336. } else {
  41337. const colors = mesh.geometry.getAttribute( 'color' );
  41338. _color1.copy( this.light.color );
  41339. _color2.copy( this.light.groundColor );
  41340. for ( let i = 0, l = colors.count; i < l; i ++ ) {
  41341. const color = ( i < ( l / 2 ) ) ? _color1 : _color2;
  41342. colors.setXYZ( i, color.r, color.g, color.b );
  41343. }
  41344. colors.needsUpdate = true;
  41345. }
  41346. this.light.updateWorldMatrix( true, false );
  41347. mesh.lookAt( _vector$1.setFromMatrixPosition( this.light.matrixWorld ).negate() );
  41348. }
  41349. }
  41350. /**
  41351. * The helper is an object to define grids. Grids are two-dimensional
  41352. * arrays of lines.
  41353. *
  41354. * ```js
  41355. * const size = 10;
  41356. * const divisions = 10;
  41357. *
  41358. * const gridHelper = new THREE.GridHelper( size, divisions );
  41359. * scene.add( gridHelper );
  41360. * ```
  41361. *
  41362. * @augments LineSegments
  41363. */
  41364. class GridHelper extends LineSegments {
  41365. /**
  41366. * Constructs a new grid helper.
  41367. *
  41368. * @param {number} [size=10] - The size of the grid.
  41369. * @param {number} [divisions=10] - The number of divisions across the grid.
  41370. * @param {number|Color|string} [color1=0x444444] - The color of the center line.
  41371. * @param {number|Color|string} [color2=0x888888] - The color of the lines of the grid.
  41372. */
  41373. constructor( size = 10, divisions = 10, color1 = 0x444444, color2 = 0x888888 ) {
  41374. color1 = new Color( color1 );
  41375. color2 = new Color( color2 );
  41376. const center = divisions / 2;
  41377. const step = size / divisions;
  41378. const halfSize = size / 2;
  41379. const vertices = [], colors = [];
  41380. for ( let i = 0, j = 0, k = - halfSize; i <= divisions; i ++, k += step ) {
  41381. vertices.push( - halfSize, 0, k, halfSize, 0, k );
  41382. vertices.push( k, 0, - halfSize, k, 0, halfSize );
  41383. const color = i === center ? color1 : color2;
  41384. color.toArray( colors, j ); j += 3;
  41385. color.toArray( colors, j ); j += 3;
  41386. color.toArray( colors, j ); j += 3;
  41387. color.toArray( colors, j ); j += 3;
  41388. }
  41389. const geometry = new BufferGeometry();
  41390. geometry.setAttribute( 'position', new Float32BufferAttribute( vertices, 3 ) );
  41391. geometry.setAttribute( 'color', new Float32BufferAttribute( colors, 3 ) );
  41392. const material = new LineBasicMaterial( { vertexColors: true, toneMapped: false } );
  41393. super( geometry, material );
  41394. this.type = 'GridHelper';
  41395. }
  41396. /**
  41397. * Frees the GPU-related resources allocated by this instance. Call this
  41398. * method whenever this instance is no longer used in your app.
  41399. */
  41400. dispose() {
  41401. this.geometry.dispose();
  41402. this.material.dispose();
  41403. }
  41404. }
  41405. /**
  41406. * This helper is an object to define polar grids. Grids are
  41407. * two-dimensional arrays of lines.
  41408. *
  41409. * ```js
  41410. * const radius = 10;
  41411. * const sectors = 16;
  41412. * const rings = 8;
  41413. * const divisions = 64;
  41414. *
  41415. * const helper = new THREE.PolarGridHelper( radius, sectors, rings, divisions );
  41416. * scene.add( helper );
  41417. * ```
  41418. *
  41419. * @augments LineSegments
  41420. */
  41421. class PolarGridHelper extends LineSegments {
  41422. /**
  41423. * Constructs a new polar grid helper.
  41424. *
  41425. * @param {number} [radius=10] - The radius of the polar grid. This can be any positive number.
  41426. * @param {number} [sectors=16] - The number of sectors the grid will be divided into. This can be any positive integer.
  41427. * @param {number} [rings=16] - The number of rings. This can be any positive integer.
  41428. * @param {number} [divisions=64] - The number of line segments used for each circle. This can be any positive integer.
  41429. * @param {number|Color|string} [color1=0x444444] - The first color used for grid elements.
  41430. * @param {number|Color|string} [color2=0x888888] - The second color used for grid elements.
  41431. */
  41432. constructor( radius = 10, sectors = 16, rings = 8, divisions = 64, color1 = 0x444444, color2 = 0x888888 ) {
  41433. color1 = new Color( color1 );
  41434. color2 = new Color( color2 );
  41435. const vertices = [];
  41436. const colors = [];
  41437. // create the sectors
  41438. if ( sectors > 1 ) {
  41439. for ( let i = 0; i < sectors; i ++ ) {
  41440. const v = ( i / sectors ) * ( Math.PI * 2 );
  41441. const x = Math.sin( v ) * radius;
  41442. const z = Math.cos( v ) * radius;
  41443. vertices.push( 0, 0, 0 );
  41444. vertices.push( x, 0, z );
  41445. const color = ( i & 1 ) ? color1 : color2;
  41446. colors.push( color.r, color.g, color.b );
  41447. colors.push( color.r, color.g, color.b );
  41448. }
  41449. }
  41450. // create the rings
  41451. for ( let i = 0; i < rings; i ++ ) {
  41452. const color = ( i & 1 ) ? color1 : color2;
  41453. const r = radius - ( radius / rings * i );
  41454. for ( let j = 0; j < divisions; j ++ ) {
  41455. // first vertex
  41456. let v = ( j / divisions ) * ( Math.PI * 2 );
  41457. let x = Math.sin( v ) * r;
  41458. let z = Math.cos( v ) * r;
  41459. vertices.push( x, 0, z );
  41460. colors.push( color.r, color.g, color.b );
  41461. // second vertex
  41462. v = ( ( j + 1 ) / divisions ) * ( Math.PI * 2 );
  41463. x = Math.sin( v ) * r;
  41464. z = Math.cos( v ) * r;
  41465. vertices.push( x, 0, z );
  41466. colors.push( color.r, color.g, color.b );
  41467. }
  41468. }
  41469. const geometry = new BufferGeometry();
  41470. geometry.setAttribute( 'position', new Float32BufferAttribute( vertices, 3 ) );
  41471. geometry.setAttribute( 'color', new Float32BufferAttribute( colors, 3 ) );
  41472. const material = new LineBasicMaterial( { vertexColors: true, toneMapped: false } );
  41473. super( geometry, material );
  41474. this.type = 'PolarGridHelper';
  41475. }
  41476. /**
  41477. * Frees the GPU-related resources allocated by this instance. Call this
  41478. * method whenever this instance is no longer used in your app.
  41479. */
  41480. dispose() {
  41481. this.geometry.dispose();
  41482. this.material.dispose();
  41483. }
  41484. }
  41485. const _v1 = /*@__PURE__*/ new Vector3();
  41486. const _v2 = /*@__PURE__*/ new Vector3();
  41487. const _v3 = /*@__PURE__*/ new Vector3();
  41488. /**
  41489. * Helper object to assist with visualizing a {@link DirectionalLight}'s
  41490. * effect on the scene. This consists of plane and a line representing the
  41491. * light's position and direction.
  41492. *
  41493. * ```js
  41494. * const light = new THREE.DirectionalLight( 0xFFFFFF );
  41495. * scene.add( light );
  41496. *
  41497. * const helper = new THREE.DirectionalLightHelper( light, 5 );
  41498. * scene.add( helper );
  41499. * ```
  41500. *
  41501. * @augments Object3D
  41502. */
  41503. class DirectionalLightHelper extends Object3D {
  41504. /**
  41505. * Constructs a new directional light helper.
  41506. *
  41507. * @param {DirectionalLight} light - The light to be visualized.
  41508. * @param {number} [size=1] - The dimensions of the plane.
  41509. * @param {number|Color|string} [color] - The helper's color. If not set, the helper will take
  41510. * the color of the light.
  41511. */
  41512. constructor( light, size, color ) {
  41513. super();
  41514. /**
  41515. * The light being visualized.
  41516. *
  41517. * @type {DirectionalLight}
  41518. */
  41519. this.light = light;
  41520. this.matrix = light.matrixWorld;
  41521. this.matrixAutoUpdate = false;
  41522. /**
  41523. * The color parameter passed in the constructor.
  41524. * If not set, the helper will take the color of the light.
  41525. *
  41526. * @type {number|Color|string}
  41527. */
  41528. this.color = color;
  41529. this.type = 'DirectionalLightHelper';
  41530. if ( size === undefined ) size = 1;
  41531. let geometry = new BufferGeometry();
  41532. geometry.setAttribute( 'position', new Float32BufferAttribute( [
  41533. - size, size, 0,
  41534. size, size, 0,
  41535. size, - size, 0,
  41536. - size, - size, 0,
  41537. - size, size, 0
  41538. ], 3 ) );
  41539. const material = new LineBasicMaterial( { fog: false, toneMapped: false } );
  41540. /**
  41541. * Contains the line showing the location of the directional light.
  41542. *
  41543. * @type {Line}
  41544. */
  41545. this.lightPlane = new Line( geometry, material );
  41546. this.add( this.lightPlane );
  41547. geometry = new BufferGeometry();
  41548. geometry.setAttribute( 'position', new Float32BufferAttribute( [ 0, 0, 0, 0, 0, 1 ], 3 ) );
  41549. /**
  41550. * Represents the target line of the directional light.
  41551. *
  41552. * @type {Line}
  41553. */
  41554. this.targetLine = new Line( geometry, material );
  41555. this.add( this.targetLine );
  41556. this.update();
  41557. }
  41558. /**
  41559. * Frees the GPU-related resources allocated by this instance. Call this
  41560. * method whenever this instance is no longer used in your app.
  41561. */
  41562. dispose() {
  41563. this.lightPlane.geometry.dispose();
  41564. this.lightPlane.material.dispose();
  41565. this.targetLine.geometry.dispose();
  41566. this.targetLine.material.dispose();
  41567. }
  41568. /**
  41569. * Updates the helper to match the position and direction of the
  41570. * light being visualized.
  41571. */
  41572. update() {
  41573. this.light.updateWorldMatrix( true, false );
  41574. this.light.target.updateWorldMatrix( true, false );
  41575. _v1.setFromMatrixPosition( this.light.matrixWorld );
  41576. _v2.setFromMatrixPosition( this.light.target.matrixWorld );
  41577. _v3.subVectors( _v2, _v1 );
  41578. this.lightPlane.lookAt( _v2 );
  41579. if ( this.color !== undefined ) {
  41580. this.lightPlane.material.color.set( this.color );
  41581. this.targetLine.material.color.set( this.color );
  41582. } else {
  41583. this.lightPlane.material.color.copy( this.light.color );
  41584. this.targetLine.material.color.copy( this.light.color );
  41585. }
  41586. this.targetLine.lookAt( _v2 );
  41587. this.targetLine.scale.z = _v3.length();
  41588. }
  41589. }
  41590. const _vector = /*@__PURE__*/ new Vector3();
  41591. const _camera = /*@__PURE__*/ new Camera();
  41592. /**
  41593. * This helps with visualizing what a camera contains in its frustum. It
  41594. * visualizes the frustum of a camera using a line segments.
  41595. *
  41596. * Based on frustum visualization in [lightgl.js shadowmap example](https://github.com/evanw/lightgl.js/blob/master/tests/shadowmap.html).
  41597. *
  41598. * `CameraHelper` must be a child of the scene.
  41599. *
  41600. * ```js
  41601. * const camera = new THREE.PerspectiveCamera( 75, window.innerWidth / window.innerHeight, 0.1, 1000 );
  41602. * const helper = new THREE.CameraHelper( camera );
  41603. * scene.add( helper );
  41604. * ```
  41605. *
  41606. * @augments LineSegments
  41607. */
  41608. class CameraHelper extends LineSegments {
  41609. /**
  41610. * Constructs a new arrow helper.
  41611. *
  41612. * @param {Camera} camera - The camera to visualize.
  41613. */
  41614. constructor( camera ) {
  41615. const geometry = new BufferGeometry();
  41616. const material = new LineBasicMaterial( { color: 0xffffff, vertexColors: true, toneMapped: false } );
  41617. const vertices = [];
  41618. const colors = [];
  41619. const pointMap = {};
  41620. // near
  41621. addLine( 'n1', 'n2' );
  41622. addLine( 'n2', 'n4' );
  41623. addLine( 'n4', 'n3' );
  41624. addLine( 'n3', 'n1' );
  41625. // far
  41626. addLine( 'f1', 'f2' );
  41627. addLine( 'f2', 'f4' );
  41628. addLine( 'f4', 'f3' );
  41629. addLine( 'f3', 'f1' );
  41630. // sides
  41631. addLine( 'n1', 'f1' );
  41632. addLine( 'n2', 'f2' );
  41633. addLine( 'n3', 'f3' );
  41634. addLine( 'n4', 'f4' );
  41635. // cone
  41636. addLine( 'p', 'n1' );
  41637. addLine( 'p', 'n2' );
  41638. addLine( 'p', 'n3' );
  41639. addLine( 'p', 'n4' );
  41640. // up
  41641. addLine( 'u1', 'u2' );
  41642. addLine( 'u2', 'u3' );
  41643. addLine( 'u3', 'u1' );
  41644. // target
  41645. addLine( 'c', 't' );
  41646. addLine( 'p', 'c' );
  41647. // cross
  41648. addLine( 'cn1', 'cn2' );
  41649. addLine( 'cn3', 'cn4' );
  41650. addLine( 'cf1', 'cf2' );
  41651. addLine( 'cf3', 'cf4' );
  41652. function addLine( a, b ) {
  41653. addPoint( a );
  41654. addPoint( b );
  41655. }
  41656. function addPoint( id ) {
  41657. vertices.push( 0, 0, 0 );
  41658. colors.push( 0, 0, 0 );
  41659. if ( pointMap[ id ] === undefined ) {
  41660. pointMap[ id ] = [];
  41661. }
  41662. pointMap[ id ].push( ( vertices.length / 3 ) - 1 );
  41663. }
  41664. geometry.setAttribute( 'position', new Float32BufferAttribute( vertices, 3 ) );
  41665. geometry.setAttribute( 'color', new Float32BufferAttribute( colors, 3 ) );
  41666. super( geometry, material );
  41667. this.type = 'CameraHelper';
  41668. /**
  41669. * The camera being visualized.
  41670. *
  41671. * @type {Camera}
  41672. */
  41673. this.camera = camera;
  41674. if ( this.camera.updateProjectionMatrix ) this.camera.updateProjectionMatrix();
  41675. this.matrix = camera.matrixWorld;
  41676. this.matrixAutoUpdate = false;
  41677. /**
  41678. * This contains the points used to visualize the camera.
  41679. *
  41680. * @type {Object<string,Array<number>>}
  41681. */
  41682. this.pointMap = pointMap;
  41683. this.update();
  41684. // colors
  41685. const colorFrustum = new Color( 0xffaa00 );
  41686. const colorCone = new Color( 0xff0000 );
  41687. const colorUp = new Color( 0x00aaff );
  41688. const colorTarget = new Color( 0xffffff );
  41689. const colorCross = new Color( 0x333333 );
  41690. this.setColors( colorFrustum, colorCone, colorUp, colorTarget, colorCross );
  41691. }
  41692. /**
  41693. * Defines the colors of the helper.
  41694. *
  41695. * @param {Color} frustum - The frustum line color.
  41696. * @param {Color} cone - The cone line color.
  41697. * @param {Color} up - The up line color.
  41698. * @param {Color} target - The target line color.
  41699. * @param {Color} cross - The cross line color.
  41700. * @return {CameraHelper} A reference to this helper.
  41701. */
  41702. setColors( frustum, cone, up, target, cross ) {
  41703. const geometry = this.geometry;
  41704. const colorAttribute = geometry.getAttribute( 'color' );
  41705. // near
  41706. colorAttribute.setXYZ( 0, frustum.r, frustum.g, frustum.b ); colorAttribute.setXYZ( 1, frustum.r, frustum.g, frustum.b ); // n1, n2
  41707. colorAttribute.setXYZ( 2, frustum.r, frustum.g, frustum.b ); colorAttribute.setXYZ( 3, frustum.r, frustum.g, frustum.b ); // n2, n4
  41708. colorAttribute.setXYZ( 4, frustum.r, frustum.g, frustum.b ); colorAttribute.setXYZ( 5, frustum.r, frustum.g, frustum.b ); // n4, n3
  41709. colorAttribute.setXYZ( 6, frustum.r, frustum.g, frustum.b ); colorAttribute.setXYZ( 7, frustum.r, frustum.g, frustum.b ); // n3, n1
  41710. // far
  41711. colorAttribute.setXYZ( 8, frustum.r, frustum.g, frustum.b ); colorAttribute.setXYZ( 9, frustum.r, frustum.g, frustum.b ); // f1, f2
  41712. colorAttribute.setXYZ( 10, frustum.r, frustum.g, frustum.b ); colorAttribute.setXYZ( 11, frustum.r, frustum.g, frustum.b ); // f2, f4
  41713. colorAttribute.setXYZ( 12, frustum.r, frustum.g, frustum.b ); colorAttribute.setXYZ( 13, frustum.r, frustum.g, frustum.b ); // f4, f3
  41714. colorAttribute.setXYZ( 14, frustum.r, frustum.g, frustum.b ); colorAttribute.setXYZ( 15, frustum.r, frustum.g, frustum.b ); // f3, f1
  41715. // sides
  41716. colorAttribute.setXYZ( 16, frustum.r, frustum.g, frustum.b ); colorAttribute.setXYZ( 17, frustum.r, frustum.g, frustum.b ); // n1, f1
  41717. colorAttribute.setXYZ( 18, frustum.r, frustum.g, frustum.b ); colorAttribute.setXYZ( 19, frustum.r, frustum.g, frustum.b ); // n2, f2
  41718. colorAttribute.setXYZ( 20, frustum.r, frustum.g, frustum.b ); colorAttribute.setXYZ( 21, frustum.r, frustum.g, frustum.b ); // n3, f3
  41719. colorAttribute.setXYZ( 22, frustum.r, frustum.g, frustum.b ); colorAttribute.setXYZ( 23, frustum.r, frustum.g, frustum.b ); // n4, f4
  41720. // cone
  41721. colorAttribute.setXYZ( 24, cone.r, cone.g, cone.b ); colorAttribute.setXYZ( 25, cone.r, cone.g, cone.b ); // p, n1
  41722. colorAttribute.setXYZ( 26, cone.r, cone.g, cone.b ); colorAttribute.setXYZ( 27, cone.r, cone.g, cone.b ); // p, n2
  41723. colorAttribute.setXYZ( 28, cone.r, cone.g, cone.b ); colorAttribute.setXYZ( 29, cone.r, cone.g, cone.b ); // p, n3
  41724. colorAttribute.setXYZ( 30, cone.r, cone.g, cone.b ); colorAttribute.setXYZ( 31, cone.r, cone.g, cone.b ); // p, n4
  41725. // up
  41726. colorAttribute.setXYZ( 32, up.r, up.g, up.b ); colorAttribute.setXYZ( 33, up.r, up.g, up.b ); // u1, u2
  41727. colorAttribute.setXYZ( 34, up.r, up.g, up.b ); colorAttribute.setXYZ( 35, up.r, up.g, up.b ); // u2, u3
  41728. colorAttribute.setXYZ( 36, up.r, up.g, up.b ); colorAttribute.setXYZ( 37, up.r, up.g, up.b ); // u3, u1
  41729. // target
  41730. colorAttribute.setXYZ( 38, target.r, target.g, target.b ); colorAttribute.setXYZ( 39, target.r, target.g, target.b ); // c, t
  41731. colorAttribute.setXYZ( 40, cross.r, cross.g, cross.b ); colorAttribute.setXYZ( 41, cross.r, cross.g, cross.b ); // p, c
  41732. // cross
  41733. colorAttribute.setXYZ( 42, cross.r, cross.g, cross.b ); colorAttribute.setXYZ( 43, cross.r, cross.g, cross.b ); // cn1, cn2
  41734. colorAttribute.setXYZ( 44, cross.r, cross.g, cross.b ); colorAttribute.setXYZ( 45, cross.r, cross.g, cross.b ); // cn3, cn4
  41735. colorAttribute.setXYZ( 46, cross.r, cross.g, cross.b ); colorAttribute.setXYZ( 47, cross.r, cross.g, cross.b ); // cf1, cf2
  41736. colorAttribute.setXYZ( 48, cross.r, cross.g, cross.b ); colorAttribute.setXYZ( 49, cross.r, cross.g, cross.b ); // cf3, cf4
  41737. colorAttribute.needsUpdate = true;
  41738. return this;
  41739. }
  41740. /**
  41741. * Updates the helper based on the projection matrix of the camera.
  41742. */
  41743. update() {
  41744. const geometry = this.geometry;
  41745. const pointMap = this.pointMap;
  41746. const w = 1, h = 1;
  41747. let nearZ, farZ;
  41748. // we need just camera projection matrix inverse
  41749. // world matrix must be identity
  41750. _camera.projectionMatrixInverse.copy( this.camera.projectionMatrixInverse );
  41751. // Adjust z values based on coordinate system
  41752. if ( this.camera.reversedDepth === true ) {
  41753. nearZ = 1;
  41754. farZ = 0;
  41755. } else {
  41756. if ( this.camera.coordinateSystem === WebGLCoordinateSystem ) {
  41757. nearZ = -1;
  41758. farZ = 1;
  41759. } else if ( this.camera.coordinateSystem === WebGPUCoordinateSystem ) {
  41760. nearZ = 0;
  41761. farZ = 1;
  41762. } else {
  41763. throw new Error( 'THREE.CameraHelper.update(): Invalid coordinate system: ' + this.camera.coordinateSystem );
  41764. }
  41765. }
  41766. // center / target
  41767. setPoint( 'c', pointMap, geometry, _camera, 0, 0, nearZ );
  41768. setPoint( 't', pointMap, geometry, _camera, 0, 0, farZ );
  41769. // near
  41770. setPoint( 'n1', pointMap, geometry, _camera, - w, - h, nearZ );
  41771. setPoint( 'n2', pointMap, geometry, _camera, w, - h, nearZ );
  41772. setPoint( 'n3', pointMap, geometry, _camera, - w, h, nearZ );
  41773. setPoint( 'n4', pointMap, geometry, _camera, w, h, nearZ );
  41774. // far
  41775. setPoint( 'f1', pointMap, geometry, _camera, - w, - h, farZ );
  41776. setPoint( 'f2', pointMap, geometry, _camera, w, - h, farZ );
  41777. setPoint( 'f3', pointMap, geometry, _camera, - w, h, farZ );
  41778. setPoint( 'f4', pointMap, geometry, _camera, w, h, farZ );
  41779. // up
  41780. setPoint( 'u1', pointMap, geometry, _camera, w * 0.7, h * 1.1, nearZ );
  41781. setPoint( 'u2', pointMap, geometry, _camera, - w * 0.7, h * 1.1, nearZ );
  41782. setPoint( 'u3', pointMap, geometry, _camera, 0, h * 2, nearZ );
  41783. // cross
  41784. setPoint( 'cf1', pointMap, geometry, _camera, - w, 0, farZ );
  41785. setPoint( 'cf2', pointMap, geometry, _camera, w, 0, farZ );
  41786. setPoint( 'cf3', pointMap, geometry, _camera, 0, - h, farZ );
  41787. setPoint( 'cf4', pointMap, geometry, _camera, 0, h, farZ );
  41788. setPoint( 'cn1', pointMap, geometry, _camera, - w, 0, nearZ );
  41789. setPoint( 'cn2', pointMap, geometry, _camera, w, 0, nearZ );
  41790. setPoint( 'cn3', pointMap, geometry, _camera, 0, - h, nearZ );
  41791. setPoint( 'cn4', pointMap, geometry, _camera, 0, h, nearZ );
  41792. geometry.getAttribute( 'position' ).needsUpdate = true;
  41793. }
  41794. /**
  41795. * Frees the GPU-related resources allocated by this instance. Call this
  41796. * method whenever this instance is no longer used in your app.
  41797. */
  41798. dispose() {
  41799. this.geometry.dispose();
  41800. this.material.dispose();
  41801. }
  41802. }
  41803. function setPoint( point, pointMap, geometry, camera, x, y, z ) {
  41804. _vector.set( x, y, z ).unproject( camera );
  41805. const points = pointMap[ point ];
  41806. if ( points !== undefined ) {
  41807. const position = geometry.getAttribute( 'position' );
  41808. for ( let i = 0, l = points.length; i < l; i ++ ) {
  41809. position.setXYZ( points[ i ], _vector.x, _vector.y, _vector.z );
  41810. }
  41811. }
  41812. }
  41813. const _box = /*@__PURE__*/ new Box3();
  41814. /**
  41815. * Helper object to graphically show the world-axis-aligned bounding box
  41816. * around an object. The actual bounding box is handled with {@link Box3},
  41817. * this is just a visual helper for debugging. It can be automatically
  41818. * resized with {@link BoxHelper#update} when the object it's created from
  41819. * is transformed. Note that the object must have a geometry for this to work,
  41820. * so it won't work with sprites.
  41821. *
  41822. * ```js
  41823. * const sphere = new THREE.SphereGeometry();
  41824. * const object = new THREE.Mesh( sphere, new THREE.MeshBasicMaterial( 0xff0000 ) );
  41825. * const box = new THREE.BoxHelper( object, 0xffff00 );
  41826. * scene.add( box );
  41827. * ```
  41828. *
  41829. * @augments LineSegments
  41830. */
  41831. class BoxHelper extends LineSegments {
  41832. /**
  41833. * Constructs a new box helper.
  41834. *
  41835. * @param {Object3D} [object] - The 3D object to show the world-axis-aligned bounding box.
  41836. * @param {number|Color|string} [color=0xffff00] - The box's color.
  41837. */
  41838. constructor( object, color = 0xffff00 ) {
  41839. 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 ] );
  41840. const positions = new Float32Array( 8 * 3 );
  41841. const geometry = new BufferGeometry();
  41842. geometry.setIndex( new BufferAttribute( indices, 1 ) );
  41843. geometry.setAttribute( 'position', new BufferAttribute( positions, 3 ) );
  41844. super( geometry, new LineBasicMaterial( { color: color, toneMapped: false } ) );
  41845. /**
  41846. * The 3D object being visualized.
  41847. *
  41848. * @type {Object3D}
  41849. */
  41850. this.object = object;
  41851. this.type = 'BoxHelper';
  41852. this.matrixAutoUpdate = false;
  41853. this.update();
  41854. }
  41855. /**
  41856. * Updates the helper's geometry to match the dimensions of the object,
  41857. * including any children.
  41858. */
  41859. update() {
  41860. if ( this.object !== undefined ) {
  41861. _box.setFromObject( this.object );
  41862. }
  41863. if ( _box.isEmpty() ) return;
  41864. const min = _box.min;
  41865. const max = _box.max;
  41866. /*
  41867. 5____4
  41868. 1/___0/|
  41869. | 6__|_7
  41870. 2/___3/
  41871. 0: max.x, max.y, max.z
  41872. 1: min.x, max.y, max.z
  41873. 2: min.x, min.y, max.z
  41874. 3: max.x, min.y, max.z
  41875. 4: max.x, max.y, min.z
  41876. 5: min.x, max.y, min.z
  41877. 6: min.x, min.y, min.z
  41878. 7: max.x, min.y, min.z
  41879. */
  41880. const position = this.geometry.attributes.position;
  41881. const array = position.array;
  41882. array[ 0 ] = max.x; array[ 1 ] = max.y; array[ 2 ] = max.z;
  41883. array[ 3 ] = min.x; array[ 4 ] = max.y; array[ 5 ] = max.z;
  41884. array[ 6 ] = min.x; array[ 7 ] = min.y; array[ 8 ] = max.z;
  41885. array[ 9 ] = max.x; array[ 10 ] = min.y; array[ 11 ] = max.z;
  41886. array[ 12 ] = max.x; array[ 13 ] = max.y; array[ 14 ] = min.z;
  41887. array[ 15 ] = min.x; array[ 16 ] = max.y; array[ 17 ] = min.z;
  41888. array[ 18 ] = min.x; array[ 19 ] = min.y; array[ 20 ] = min.z;
  41889. array[ 21 ] = max.x; array[ 22 ] = min.y; array[ 23 ] = min.z;
  41890. position.needsUpdate = true;
  41891. this.geometry.computeBoundingSphere();
  41892. }
  41893. /**
  41894. * Updates the wireframe box for the passed object.
  41895. *
  41896. * @param {Object3D} object - The 3D object to create the helper for.
  41897. * @return {BoxHelper} A reference to this instance.
  41898. */
  41899. setFromObject( object ) {
  41900. this.object = object;
  41901. this.update();
  41902. return this;
  41903. }
  41904. copy( source, recursive ) {
  41905. super.copy( source, recursive );
  41906. this.object = source.object;
  41907. return this;
  41908. }
  41909. /**
  41910. * Frees the GPU-related resources allocated by this instance. Call this
  41911. * method whenever this instance is no longer used in your app.
  41912. */
  41913. dispose() {
  41914. this.geometry.dispose();
  41915. this.material.dispose();
  41916. }
  41917. }
  41918. /**
  41919. * A helper object to visualize an instance of {@link Box3}.
  41920. *
  41921. * ```js
  41922. * const box = new THREE.Box3();
  41923. * box.setFromCenterAndSize( new THREE.Vector3( 1, 1, 1 ), new THREE.Vector3( 2, 1, 3 ) );
  41924. *
  41925. * const helper = new THREE.Box3Helper( box, 0xffff00 );
  41926. * scene.add( helper )
  41927. * ```
  41928. *
  41929. * @augments LineSegments
  41930. */
  41931. class Box3Helper extends LineSegments {
  41932. /**
  41933. * Constructs a new box3 helper.
  41934. *
  41935. * @param {Box3} box - The box to visualize.
  41936. * @param {number|Color|string} [color=0xffff00] - The box's color.
  41937. */
  41938. constructor( box, color = 0xffff00 ) {
  41939. 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 ] );
  41940. 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 ];
  41941. const geometry = new BufferGeometry();
  41942. geometry.setIndex( new BufferAttribute( indices, 1 ) );
  41943. geometry.setAttribute( 'position', new Float32BufferAttribute( positions, 3 ) );
  41944. super( geometry, new LineBasicMaterial( { color: color, toneMapped: false } ) );
  41945. /**
  41946. * The box being visualized.
  41947. *
  41948. * @type {Box3}
  41949. */
  41950. this.box = box;
  41951. this.type = 'Box3Helper';
  41952. this.geometry.computeBoundingSphere();
  41953. }
  41954. updateMatrixWorld( force ) {
  41955. const box = this.box;
  41956. if ( box.isEmpty() ) return;
  41957. box.getCenter( this.position );
  41958. box.getSize( this.scale );
  41959. this.scale.multiplyScalar( 0.5 );
  41960. super.updateMatrixWorld( force );
  41961. }
  41962. /**
  41963. * Frees the GPU-related resources allocated by this instance. Call this
  41964. * method whenever this instance is no longer used in your app.
  41965. */
  41966. dispose() {
  41967. this.geometry.dispose();
  41968. this.material.dispose();
  41969. }
  41970. }
  41971. /**
  41972. * A helper object to visualize an instance of {@link Plane}.
  41973. *
  41974. * ```js
  41975. * const plane = new THREE.Plane( new THREE.Vector3( 1, 1, 0.2 ), 3 );
  41976. * const helper = new THREE.PlaneHelper( plane, 1, 0xffff00 );
  41977. * scene.add( helper );
  41978. * ```
  41979. *
  41980. * @augments Line
  41981. */
  41982. class PlaneHelper extends Line {
  41983. /**
  41984. * Constructs a new plane helper.
  41985. *
  41986. * @param {Plane} plane - The plane to be visualized.
  41987. * @param {number} [size=1] - The side length of plane helper.
  41988. * @param {number|Color|string} [hex=0xffff00] - The helper's color.
  41989. */
  41990. constructor( plane, size = 1, hex = 0xffff00 ) {
  41991. const color = hex;
  41992. 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 ];
  41993. const geometry = new BufferGeometry();
  41994. geometry.setAttribute( 'position', new Float32BufferAttribute( positions, 3 ) );
  41995. geometry.computeBoundingSphere();
  41996. super( geometry, new LineBasicMaterial( { color: color, toneMapped: false } ) );
  41997. this.type = 'PlaneHelper';
  41998. /**
  41999. * The plane being visualized.
  42000. *
  42001. * @type {Plane}
  42002. */
  42003. this.plane = plane;
  42004. /**
  42005. * The side length of plane helper.
  42006. *
  42007. * @type {number}
  42008. * @default 1
  42009. */
  42010. this.size = size;
  42011. const positions2 = [ 1, 1, 0, -1, 1, 0, -1, -1, 0, 1, 1, 0, -1, -1, 0, 1, -1, 0 ];
  42012. const geometry2 = new BufferGeometry();
  42013. geometry2.setAttribute( 'position', new Float32BufferAttribute( positions2, 3 ) );
  42014. geometry2.computeBoundingSphere();
  42015. this.add( new Mesh( geometry2, new MeshBasicMaterial( { color: color, opacity: 0.2, transparent: true, depthWrite: false, toneMapped: false } ) ) );
  42016. }
  42017. updateMatrixWorld( force ) {
  42018. this.position.set( 0, 0, 0 );
  42019. this.scale.set( 0.5 * this.size, 0.5 * this.size, 1 );
  42020. this.lookAt( this.plane.normal );
  42021. this.translateZ( - this.plane.constant );
  42022. super.updateMatrixWorld( force );
  42023. }
  42024. /**
  42025. * Updates the helper to match the position and direction of the
  42026. * light being visualized.
  42027. */
  42028. dispose() {
  42029. this.geometry.dispose();
  42030. this.material.dispose();
  42031. this.children[ 0 ].geometry.dispose();
  42032. this.children[ 0 ].material.dispose();
  42033. }
  42034. }
  42035. const _axis = /*@__PURE__*/ new Vector3();
  42036. let _lineGeometry, _coneGeometry;
  42037. /**
  42038. * An 3D arrow object for visualizing directions.
  42039. *
  42040. * ```js
  42041. * const dir = new THREE.Vector3( 1, 2, 0 );
  42042. *
  42043. * //normalize the direction vector (convert to vector of length 1)
  42044. * dir.normalize();
  42045. *
  42046. * const origin = new THREE.Vector3( 0, 0, 0 );
  42047. * const length = 1;
  42048. * const hex = 0xffff00;
  42049. *
  42050. * const arrowHelper = new THREE.ArrowHelper( dir, origin, length, hex );
  42051. * scene.add( arrowHelper );
  42052. * ```
  42053. *
  42054. * @augments Object3D
  42055. */
  42056. class ArrowHelper extends Object3D {
  42057. /**
  42058. * Constructs a new arrow helper.
  42059. *
  42060. * @param {Vector3} [dir=(0, 0, 1)] - The (normalized) direction vector.
  42061. * @param {Vector3} [origin=(0, 0, 0)] - Point at which the arrow starts.
  42062. * @param {number} [length=1] - Length of the arrow in world units.
  42063. * @param {(number|Color|string)} [color=0xffff00] - Color of the arrow.
  42064. * @param {number} [headLength=length*0.2] - The length of the head of the arrow.
  42065. * @param {number} [headWidth=headLength*0.2] - The width of the head of the arrow.
  42066. */
  42067. 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 ) {
  42068. super();
  42069. this.type = 'ArrowHelper';
  42070. if ( _lineGeometry === undefined ) {
  42071. _lineGeometry = new BufferGeometry();
  42072. _lineGeometry.setAttribute( 'position', new Float32BufferAttribute( [ 0, 0, 0, 0, 1, 0 ], 3 ) );
  42073. _coneGeometry = new ConeGeometry( 0.5, 1, 5, 1 );
  42074. _coneGeometry.translate( 0, -0.5, 0 );
  42075. }
  42076. this.position.copy( origin );
  42077. /**
  42078. * The line part of the arrow helper.
  42079. *
  42080. * @type {Line}
  42081. */
  42082. this.line = new Line( _lineGeometry, new LineBasicMaterial( { color: color, toneMapped: false } ) );
  42083. this.line.matrixAutoUpdate = false;
  42084. this.add( this.line );
  42085. /**
  42086. * The cone part of the arrow helper.
  42087. *
  42088. * @type {Mesh}
  42089. */
  42090. this.cone = new Mesh( _coneGeometry, new MeshBasicMaterial( { color: color, toneMapped: false } ) );
  42091. this.cone.matrixAutoUpdate = false;
  42092. this.add( this.cone );
  42093. this.setDirection( dir );
  42094. this.setLength( length, headLength, headWidth );
  42095. }
  42096. /**
  42097. * Sets the direction of the helper.
  42098. *
  42099. * @param {Vector3} dir - The normalized direction vector.
  42100. */
  42101. setDirection( dir ) {
  42102. // dir is assumed to be normalized
  42103. if ( dir.y > 0.99999 ) {
  42104. this.quaternion.set( 0, 0, 0, 1 );
  42105. } else if ( dir.y < -0.99999 ) {
  42106. this.quaternion.set( 1, 0, 0, 0 );
  42107. } else {
  42108. _axis.set( dir.z, 0, - dir.x ).normalize();
  42109. const radians = Math.acos( dir.y );
  42110. this.quaternion.setFromAxisAngle( _axis, radians );
  42111. }
  42112. }
  42113. /**
  42114. * Sets the length of the helper.
  42115. *
  42116. * @param {number} length - Length of the arrow in world units.
  42117. * @param {number} [headLength=length*0.2] - The length of the head of the arrow.
  42118. * @param {number} [headWidth=headLength*0.2] - The width of the head of the arrow.
  42119. */
  42120. setLength( length, headLength = length * 0.2, headWidth = headLength * 0.2 ) {
  42121. this.line.scale.set( 1, Math.max( 0.0001, length - headLength ), 1 ); // see #17458
  42122. this.line.updateMatrix();
  42123. this.cone.scale.set( headWidth, headLength, headWidth );
  42124. this.cone.position.y = length;
  42125. this.cone.updateMatrix();
  42126. }
  42127. /**
  42128. * Sets the color of the helper.
  42129. *
  42130. * @param {number|Color|string} color - The color to set.
  42131. */
  42132. setColor( color ) {
  42133. this.line.material.color.set( color );
  42134. this.cone.material.color.set( color );
  42135. }
  42136. copy( source ) {
  42137. super.copy( source, false );
  42138. this.line.copy( source.line );
  42139. this.cone.copy( source.cone );
  42140. return this;
  42141. }
  42142. /**
  42143. * Frees the GPU-related resources allocated by this instance. Call this
  42144. * method whenever this instance is no longer used in your app.
  42145. */
  42146. dispose() {
  42147. this.line.geometry.dispose();
  42148. this.line.material.dispose();
  42149. this.cone.geometry.dispose();
  42150. this.cone.material.dispose();
  42151. }
  42152. }
  42153. /**
  42154. * An axis object to visualize the 3 axes in a simple way.
  42155. * The X axis is red. The Y axis is green. The Z axis is blue.
  42156. *
  42157. * ```js
  42158. * const axesHelper = new THREE.AxesHelper( 5 );
  42159. * scene.add( axesHelper );
  42160. * ```
  42161. *
  42162. * @augments LineSegments
  42163. */
  42164. class AxesHelper extends LineSegments {
  42165. /**
  42166. * Constructs a new axes helper.
  42167. *
  42168. * @param {number} [size=1] - Size of the lines representing the axes.
  42169. */
  42170. constructor( size = 1 ) {
  42171. const vertices = [
  42172. 0, 0, 0, size, 0, 0,
  42173. 0, 0, 0, 0, size, 0,
  42174. 0, 0, 0, 0, 0, size
  42175. ];
  42176. const colors = [
  42177. 1, 0, 0, 1, 0.6, 0,
  42178. 0, 1, 0, 0.6, 1, 0,
  42179. 0, 0, 1, 0, 0.6, 1
  42180. ];
  42181. const geometry = new BufferGeometry();
  42182. geometry.setAttribute( 'position', new Float32BufferAttribute( vertices, 3 ) );
  42183. geometry.setAttribute( 'color', new Float32BufferAttribute( colors, 3 ) );
  42184. const material = new LineBasicMaterial( { vertexColors: true, toneMapped: false } );
  42185. super( geometry, material );
  42186. this.type = 'AxesHelper';
  42187. }
  42188. /**
  42189. * Defines the colors of the axes helper.
  42190. *
  42191. * @param {number|Color|string} xAxisColor - The color for the x axis.
  42192. * @param {number|Color|string} yAxisColor - The color for the y axis.
  42193. * @param {number|Color|string} zAxisColor - The color for the z axis.
  42194. * @return {AxesHelper} A reference to this axes helper.
  42195. */
  42196. setColors( xAxisColor, yAxisColor, zAxisColor ) {
  42197. const color = new Color();
  42198. const array = this.geometry.attributes.color.array;
  42199. color.set( xAxisColor );
  42200. color.toArray( array, 0 );
  42201. color.toArray( array, 3 );
  42202. color.set( yAxisColor );
  42203. color.toArray( array, 6 );
  42204. color.toArray( array, 9 );
  42205. color.set( zAxisColor );
  42206. color.toArray( array, 12 );
  42207. color.toArray( array, 15 );
  42208. this.geometry.attributes.color.needsUpdate = true;
  42209. return this;
  42210. }
  42211. /**
  42212. * Frees the GPU-related resources allocated by this instance. Call this
  42213. * method whenever this instance is no longer used in your app.
  42214. */
  42215. dispose() {
  42216. this.geometry.dispose();
  42217. this.material.dispose();
  42218. }
  42219. }
  42220. /**
  42221. * This class is used to convert a series of paths to an array of
  42222. * shapes. It is specifically used in context of fonts and SVG.
  42223. */
  42224. class ShapePath {
  42225. /**
  42226. * Constructs a new shape path.
  42227. */
  42228. constructor() {
  42229. this.type = 'ShapePath';
  42230. /**
  42231. * The color of the shape.
  42232. *
  42233. * @type {Color}
  42234. */
  42235. this.color = new Color();
  42236. /**
  42237. * The paths that have been generated for this shape.
  42238. *
  42239. * @type {Array<Path>}
  42240. * @default null
  42241. */
  42242. this.subPaths = [];
  42243. /**
  42244. * The current path that is being generated.
  42245. *
  42246. * @type {?Path}
  42247. * @default null
  42248. */
  42249. this.currentPath = null;
  42250. }
  42251. /**
  42252. * Creates a new path and moves it current point to the given one.
  42253. *
  42254. * @param {number} x - The x coordinate.
  42255. * @param {number} y - The y coordinate.
  42256. * @return {ShapePath} A reference to this shape path.
  42257. */
  42258. moveTo( x, y ) {
  42259. this.currentPath = new Path();
  42260. this.subPaths.push( this.currentPath );
  42261. this.currentPath.moveTo( x, y );
  42262. return this;
  42263. }
  42264. /**
  42265. * Adds an instance of {@link LineCurve} to the path by connecting
  42266. * the current point with the given one.
  42267. *
  42268. * @param {number} x - The x coordinate of the end point.
  42269. * @param {number} y - The y coordinate of the end point.
  42270. * @return {ShapePath} A reference to this shape path.
  42271. */
  42272. lineTo( x, y ) {
  42273. this.currentPath.lineTo( x, y );
  42274. return this;
  42275. }
  42276. /**
  42277. * Adds an instance of {@link QuadraticBezierCurve} to the path by connecting
  42278. * the current point with the given one.
  42279. *
  42280. * @param {number} aCPx - The x coordinate of the control point.
  42281. * @param {number} aCPy - The y coordinate of the control point.
  42282. * @param {number} aX - The x coordinate of the end point.
  42283. * @param {number} aY - The y coordinate of the end point.
  42284. * @return {ShapePath} A reference to this shape path.
  42285. */
  42286. quadraticCurveTo( aCPx, aCPy, aX, aY ) {
  42287. this.currentPath.quadraticCurveTo( aCPx, aCPy, aX, aY );
  42288. return this;
  42289. }
  42290. /**
  42291. * Adds an instance of {@link CubicBezierCurve} to the path by connecting
  42292. * the current point with the given one.
  42293. *
  42294. * @param {number} aCP1x - The x coordinate of the first control point.
  42295. * @param {number} aCP1y - The y coordinate of the first control point.
  42296. * @param {number} aCP2x - The x coordinate of the second control point.
  42297. * @param {number} aCP2y - The y coordinate of the second control point.
  42298. * @param {number} aX - The x coordinate of the end point.
  42299. * @param {number} aY - The y coordinate of the end point.
  42300. * @return {ShapePath} A reference to this shape path.
  42301. */
  42302. bezierCurveTo( aCP1x, aCP1y, aCP2x, aCP2y, aX, aY ) {
  42303. this.currentPath.bezierCurveTo( aCP1x, aCP1y, aCP2x, aCP2y, aX, aY );
  42304. return this;
  42305. }
  42306. /**
  42307. * Adds an instance of {@link SplineCurve} to the path by connecting
  42308. * the current point with the given list of points.
  42309. *
  42310. * @param {Array<Vector2>} pts - An array of points in 2D space.
  42311. * @return {ShapePath} A reference to this shape path.
  42312. */
  42313. splineThru( pts ) {
  42314. this.currentPath.splineThru( pts );
  42315. return this;
  42316. }
  42317. /**
  42318. * Converts the paths into an array of shapes.
  42319. *
  42320. * @param {boolean} isCCW - By default solid shapes are defined clockwise (CW) and holes are defined counterclockwise (CCW).
  42321. * If this flag is set to `true`, then those are flipped.
  42322. * @return {Array<Shape>} An array of shapes.
  42323. */
  42324. toShapes( isCCW ) {
  42325. function toShapesNoHoles( inSubpaths ) {
  42326. const shapes = [];
  42327. for ( let i = 0, l = inSubpaths.length; i < l; i ++ ) {
  42328. const tmpPath = inSubpaths[ i ];
  42329. const tmpShape = new Shape();
  42330. tmpShape.curves = tmpPath.curves;
  42331. shapes.push( tmpShape );
  42332. }
  42333. return shapes;
  42334. }
  42335. function isPointInsidePolygon( inPt, inPolygon ) {
  42336. const polyLen = inPolygon.length;
  42337. // inPt on polygon contour => immediate success or
  42338. // toggling of inside/outside at every single! intersection point of an edge
  42339. // with the horizontal line through inPt, left of inPt
  42340. // not counting lowerY endpoints of edges and whole edges on that line
  42341. let inside = false;
  42342. for ( let p = polyLen - 1, q = 0; q < polyLen; p = q ++ ) {
  42343. let edgeLowPt = inPolygon[ p ];
  42344. let edgeHighPt = inPolygon[ q ];
  42345. let edgeDx = edgeHighPt.x - edgeLowPt.x;
  42346. let edgeDy = edgeHighPt.y - edgeLowPt.y;
  42347. if ( Math.abs( edgeDy ) > Number.EPSILON ) {
  42348. // not parallel
  42349. if ( edgeDy < 0 ) {
  42350. edgeLowPt = inPolygon[ q ]; edgeDx = - edgeDx;
  42351. edgeHighPt = inPolygon[ p ]; edgeDy = - edgeDy;
  42352. }
  42353. if ( ( inPt.y < edgeLowPt.y ) || ( inPt.y > edgeHighPt.y ) ) continue;
  42354. if ( inPt.y === edgeLowPt.y ) {
  42355. if ( inPt.x === edgeLowPt.x ) return true; // inPt is on contour ?
  42356. // continue; // no intersection or edgeLowPt => doesn't count !!!
  42357. } else {
  42358. const perpEdge = edgeDy * ( inPt.x - edgeLowPt.x ) - edgeDx * ( inPt.y - edgeLowPt.y );
  42359. if ( perpEdge === 0 ) return true; // inPt is on contour ?
  42360. if ( perpEdge < 0 ) continue;
  42361. inside = ! inside; // true intersection left of inPt
  42362. }
  42363. } else {
  42364. // parallel or collinear
  42365. if ( inPt.y !== edgeLowPt.y ) continue; // parallel
  42366. // edge lies on the same horizontal line as inPt
  42367. if ( ( ( edgeHighPt.x <= inPt.x ) && ( inPt.x <= edgeLowPt.x ) ) ||
  42368. ( ( edgeLowPt.x <= inPt.x ) && ( inPt.x <= edgeHighPt.x ) ) ) return true; // inPt: Point on contour !
  42369. // continue;
  42370. }
  42371. }
  42372. return inside;
  42373. }
  42374. const isClockWise = ShapeUtils.isClockWise;
  42375. const subPaths = this.subPaths;
  42376. if ( subPaths.length === 0 ) return [];
  42377. let solid, tmpPath, tmpShape;
  42378. const shapes = [];
  42379. if ( subPaths.length === 1 ) {
  42380. tmpPath = subPaths[ 0 ];
  42381. tmpShape = new Shape();
  42382. tmpShape.curves = tmpPath.curves;
  42383. shapes.push( tmpShape );
  42384. return shapes;
  42385. }
  42386. let holesFirst = ! isClockWise( subPaths[ 0 ].getPoints() );
  42387. holesFirst = isCCW ? ! holesFirst : holesFirst;
  42388. // log("Holes first", holesFirst);
  42389. const betterShapeHoles = [];
  42390. const newShapes = [];
  42391. let newShapeHoles = [];
  42392. let mainIdx = 0;
  42393. let tmpPoints;
  42394. newShapes[ mainIdx ] = undefined;
  42395. newShapeHoles[ mainIdx ] = [];
  42396. for ( let i = 0, l = subPaths.length; i < l; i ++ ) {
  42397. tmpPath = subPaths[ i ];
  42398. tmpPoints = tmpPath.getPoints();
  42399. solid = isClockWise( tmpPoints );
  42400. solid = isCCW ? ! solid : solid;
  42401. if ( solid ) {
  42402. if ( ( ! holesFirst ) && ( newShapes[ mainIdx ] ) ) mainIdx ++;
  42403. newShapes[ mainIdx ] = { s: new Shape(), p: tmpPoints };
  42404. newShapes[ mainIdx ].s.curves = tmpPath.curves;
  42405. if ( holesFirst ) mainIdx ++;
  42406. newShapeHoles[ mainIdx ] = [];
  42407. //log('cw', i);
  42408. } else {
  42409. newShapeHoles[ mainIdx ].push( { h: tmpPath, p: tmpPoints[ 0 ] } );
  42410. //log('ccw', i);
  42411. }
  42412. }
  42413. // only Holes? -> probably all Shapes with wrong orientation
  42414. if ( ! newShapes[ 0 ] ) return toShapesNoHoles( subPaths );
  42415. if ( newShapes.length > 1 ) {
  42416. let ambiguous = false;
  42417. let toChange = 0;
  42418. for ( let sIdx = 0, sLen = newShapes.length; sIdx < sLen; sIdx ++ ) {
  42419. betterShapeHoles[ sIdx ] = [];
  42420. }
  42421. for ( let sIdx = 0, sLen = newShapes.length; sIdx < sLen; sIdx ++ ) {
  42422. const sho = newShapeHoles[ sIdx ];
  42423. for ( let hIdx = 0; hIdx < sho.length; hIdx ++ ) {
  42424. const ho = sho[ hIdx ];
  42425. let hole_unassigned = true;
  42426. for ( let s2Idx = 0; s2Idx < newShapes.length; s2Idx ++ ) {
  42427. if ( isPointInsidePolygon( ho.p, newShapes[ s2Idx ].p ) ) {
  42428. if ( sIdx !== s2Idx ) toChange ++;
  42429. if ( hole_unassigned ) {
  42430. hole_unassigned = false;
  42431. betterShapeHoles[ s2Idx ].push( ho );
  42432. } else {
  42433. ambiguous = true;
  42434. }
  42435. }
  42436. }
  42437. if ( hole_unassigned ) {
  42438. betterShapeHoles[ sIdx ].push( ho );
  42439. }
  42440. }
  42441. }
  42442. if ( toChange > 0 && ambiguous === false ) {
  42443. newShapeHoles = betterShapeHoles;
  42444. }
  42445. }
  42446. let tmpHoles;
  42447. for ( let i = 0, il = newShapes.length; i < il; i ++ ) {
  42448. tmpShape = newShapes[ i ].s;
  42449. shapes.push( tmpShape );
  42450. tmpHoles = newShapeHoles[ i ];
  42451. for ( let j = 0, jl = tmpHoles.length; j < jl; j ++ ) {
  42452. tmpShape.holes.push( tmpHoles[ j ].h );
  42453. }
  42454. }
  42455. //log("shape", shapes);
  42456. return shapes;
  42457. }
  42458. }
  42459. /**
  42460. * Abstract base class for controls.
  42461. *
  42462. * @abstract
  42463. * @augments EventDispatcher
  42464. */
  42465. class Controls extends EventDispatcher {
  42466. /**
  42467. * Constructs a new controls instance.
  42468. *
  42469. * @param {Object3D} object - The object that is managed by the controls.
  42470. * @param {?HTMLElement} domElement - The HTML element used for event listeners.
  42471. */
  42472. constructor( object, domElement = null ) {
  42473. super();
  42474. /**
  42475. * The object that is managed by the controls.
  42476. *
  42477. * @type {Object3D}
  42478. */
  42479. this.object = object;
  42480. /**
  42481. * The HTML element used for event listeners.
  42482. *
  42483. * @type {?HTMLElement}
  42484. * @default null
  42485. */
  42486. this.domElement = domElement;
  42487. /**
  42488. * Whether the controls responds to user input or not.
  42489. *
  42490. * @type {boolean}
  42491. * @default true
  42492. */
  42493. this.enabled = true;
  42494. /**
  42495. * The internal state of the controls.
  42496. *
  42497. * @type {number}
  42498. * @default -1
  42499. */
  42500. this.state = -1;
  42501. /**
  42502. * This object defines the keyboard input of the controls.
  42503. *
  42504. * @type {Object}
  42505. */
  42506. this.keys = {};
  42507. /**
  42508. * This object defines what type of actions are assigned to the available mouse buttons.
  42509. * It depends on the control implementation what kind of mouse buttons and actions are supported.
  42510. *
  42511. * @type {{LEFT: ?number, MIDDLE: ?number, RIGHT: ?number}}
  42512. */
  42513. this.mouseButtons = { LEFT: null, MIDDLE: null, RIGHT: null };
  42514. /**
  42515. * This object defines what type of actions are assigned to what kind of touch interaction.
  42516. * It depends on the control implementation what kind of touch interaction and actions are supported.
  42517. *
  42518. * @type {{ONE: ?number, TWO: ?number}}
  42519. */
  42520. this.touches = { ONE: null, TWO: null };
  42521. }
  42522. /**
  42523. * Connects the controls to the DOM. This method has so called "side effects" since
  42524. * it adds the module's event listeners to the DOM.
  42525. *
  42526. * @param {HTMLElement} element - The DOM element to connect to.
  42527. */
  42528. connect( element ) {
  42529. if ( element === undefined ) {
  42530. warn( 'Controls: connect() now requires an element.' ); // @deprecated, the warning can be removed with r185
  42531. return;
  42532. }
  42533. if ( this.domElement !== null ) this.disconnect();
  42534. this.domElement = element;
  42535. }
  42536. /**
  42537. * Disconnects the controls from the DOM.
  42538. */
  42539. disconnect() {}
  42540. /**
  42541. * Call this method if you no longer want use to the controls. It frees all internal
  42542. * resources and removes all event listeners.
  42543. */
  42544. dispose() {}
  42545. /**
  42546. * Controls should implement this method if they have to update their internal state
  42547. * per simulation step.
  42548. *
  42549. * @param {number} [delta] - The time delta in seconds.
  42550. */
  42551. update( /* delta */ ) {}
  42552. }
  42553. /**
  42554. * Scales the texture as large as possible within its surface without cropping
  42555. * or stretching the texture. The method preserves the original aspect ratio of
  42556. * the texture. Akin to CSS `object-fit: contain`
  42557. *
  42558. * @param {Texture} texture - The texture.
  42559. * @param {number} aspect - The texture's aspect ratio.
  42560. * @return {Texture} The updated texture.
  42561. */
  42562. function contain( texture, aspect ) {
  42563. const imageAspect = ( texture.image && texture.image.width ) ? texture.image.width / texture.image.height : 1;
  42564. if ( imageAspect > aspect ) {
  42565. texture.repeat.x = 1;
  42566. texture.repeat.y = imageAspect / aspect;
  42567. texture.offset.x = 0;
  42568. texture.offset.y = ( 1 - texture.repeat.y ) / 2;
  42569. } else {
  42570. texture.repeat.x = aspect / imageAspect;
  42571. texture.repeat.y = 1;
  42572. texture.offset.x = ( 1 - texture.repeat.x ) / 2;
  42573. texture.offset.y = 0;
  42574. }
  42575. return texture;
  42576. }
  42577. /**
  42578. * Scales the texture to the smallest possible size to fill the surface, leaving
  42579. * no empty space. The method preserves the original aspect ratio of the texture.
  42580. * Akin to CSS `object-fit: cover`.
  42581. *
  42582. * @param {Texture} texture - The texture.
  42583. * @param {number} aspect - The texture's aspect ratio.
  42584. * @return {Texture} The updated texture.
  42585. */
  42586. function cover( texture, aspect ) {
  42587. const imageAspect = ( texture.image && texture.image.width ) ? texture.image.width / texture.image.height : 1;
  42588. if ( imageAspect > aspect ) {
  42589. texture.repeat.x = aspect / imageAspect;
  42590. texture.repeat.y = 1;
  42591. texture.offset.x = ( 1 - texture.repeat.x ) / 2;
  42592. texture.offset.y = 0;
  42593. } else {
  42594. texture.repeat.x = 1;
  42595. texture.repeat.y = imageAspect / aspect;
  42596. texture.offset.x = 0;
  42597. texture.offset.y = ( 1 - texture.repeat.y ) / 2;
  42598. }
  42599. return texture;
  42600. }
  42601. /**
  42602. * Configures the texture to the default transformation. Akin to CSS `object-fit: fill`.
  42603. *
  42604. * @param {Texture} texture - The texture.
  42605. * @return {Texture} The updated texture.
  42606. */
  42607. function fill( texture ) {
  42608. texture.repeat.x = 1;
  42609. texture.repeat.y = 1;
  42610. texture.offset.x = 0;
  42611. texture.offset.y = 0;
  42612. return texture;
  42613. }
  42614. /**
  42615. * Determines how many bytes must be used to represent the texture.
  42616. *
  42617. * @param {number} width - The width of the texture.
  42618. * @param {number} height - The height of the texture.
  42619. * @param {number} format - The texture's format.
  42620. * @param {number} type - The texture's type.
  42621. * @return {number} The byte length.
  42622. */
  42623. function getByteLength( width, height, format, type ) {
  42624. const typeByteLength = getTextureTypeByteLength( type );
  42625. switch ( format ) {
  42626. // https://registry.khronos.org/OpenGL-Refpages/es3.0/html/glTexImage2D.xhtml
  42627. case AlphaFormat:
  42628. return width * height;
  42629. case RedFormat:
  42630. return ( ( width * height ) / typeByteLength.components ) * typeByteLength.byteLength;
  42631. case RedIntegerFormat:
  42632. return ( ( width * height ) / typeByteLength.components ) * typeByteLength.byteLength;
  42633. case RGFormat:
  42634. return ( ( width * height * 2 ) / typeByteLength.components ) * typeByteLength.byteLength;
  42635. case RGIntegerFormat:
  42636. return ( ( width * height * 2 ) / typeByteLength.components ) * typeByteLength.byteLength;
  42637. case RGBFormat:
  42638. return ( ( width * height * 3 ) / typeByteLength.components ) * typeByteLength.byteLength;
  42639. case RGBAFormat:
  42640. return ( ( width * height * 4 ) / typeByteLength.components ) * typeByteLength.byteLength;
  42641. case RGBAIntegerFormat:
  42642. return ( ( width * height * 4 ) / typeByteLength.components ) * typeByteLength.byteLength;
  42643. // https://registry.khronos.org/webgl/extensions/WEBGL_compressed_texture_s3tc_srgb/
  42644. case RGB_S3TC_DXT1_Format:
  42645. case RGBA_S3TC_DXT1_Format:
  42646. return Math.floor( ( width + 3 ) / 4 ) * Math.floor( ( height + 3 ) / 4 ) * 8;
  42647. case RGBA_S3TC_DXT3_Format:
  42648. case RGBA_S3TC_DXT5_Format:
  42649. return Math.floor( ( width + 3 ) / 4 ) * Math.floor( ( height + 3 ) / 4 ) * 16;
  42650. // https://registry.khronos.org/webgl/extensions/WEBGL_compressed_texture_pvrtc/
  42651. case RGB_PVRTC_2BPPV1_Format:
  42652. case RGBA_PVRTC_2BPPV1_Format:
  42653. return ( Math.max( width, 16 ) * Math.max( height, 8 ) ) / 4;
  42654. case RGB_PVRTC_4BPPV1_Format:
  42655. case RGBA_PVRTC_4BPPV1_Format:
  42656. return ( Math.max( width, 8 ) * Math.max( height, 8 ) ) / 2;
  42657. // https://registry.khronos.org/webgl/extensions/WEBGL_compressed_texture_etc/
  42658. case RGB_ETC1_Format:
  42659. case RGB_ETC2_Format:
  42660. case R11_EAC_Format:
  42661. case SIGNED_R11_EAC_Format:
  42662. return Math.floor( ( width + 3 ) / 4 ) * Math.floor( ( height + 3 ) / 4 ) * 8;
  42663. case RGBA_ETC2_EAC_Format:
  42664. case RG11_EAC_Format:
  42665. case SIGNED_RG11_EAC_Format:
  42666. return Math.floor( ( width + 3 ) / 4 ) * Math.floor( ( height + 3 ) / 4 ) * 16;
  42667. // https://registry.khronos.org/webgl/extensions/WEBGL_compressed_texture_astc/
  42668. case RGBA_ASTC_4x4_Format:
  42669. return Math.floor( ( width + 3 ) / 4 ) * Math.floor( ( height + 3 ) / 4 ) * 16;
  42670. case RGBA_ASTC_5x4_Format:
  42671. return Math.floor( ( width + 4 ) / 5 ) * Math.floor( ( height + 3 ) / 4 ) * 16;
  42672. case RGBA_ASTC_5x5_Format:
  42673. return Math.floor( ( width + 4 ) / 5 ) * Math.floor( ( height + 4 ) / 5 ) * 16;
  42674. case RGBA_ASTC_6x5_Format:
  42675. return Math.floor( ( width + 5 ) / 6 ) * Math.floor( ( height + 4 ) / 5 ) * 16;
  42676. case RGBA_ASTC_6x6_Format:
  42677. return Math.floor( ( width + 5 ) / 6 ) * Math.floor( ( height + 5 ) / 6 ) * 16;
  42678. case RGBA_ASTC_8x5_Format:
  42679. return Math.floor( ( width + 7 ) / 8 ) * Math.floor( ( height + 4 ) / 5 ) * 16;
  42680. case RGBA_ASTC_8x6_Format:
  42681. return Math.floor( ( width + 7 ) / 8 ) * Math.floor( ( height + 5 ) / 6 ) * 16;
  42682. case RGBA_ASTC_8x8_Format:
  42683. return Math.floor( ( width + 7 ) / 8 ) * Math.floor( ( height + 7 ) / 8 ) * 16;
  42684. case RGBA_ASTC_10x5_Format:
  42685. return Math.floor( ( width + 9 ) / 10 ) * Math.floor( ( height + 4 ) / 5 ) * 16;
  42686. case RGBA_ASTC_10x6_Format:
  42687. return Math.floor( ( width + 9 ) / 10 ) * Math.floor( ( height + 5 ) / 6 ) * 16;
  42688. case RGBA_ASTC_10x8_Format:
  42689. return Math.floor( ( width + 9 ) / 10 ) * Math.floor( ( height + 7 ) / 8 ) * 16;
  42690. case RGBA_ASTC_10x10_Format:
  42691. return Math.floor( ( width + 9 ) / 10 ) * Math.floor( ( height + 9 ) / 10 ) * 16;
  42692. case RGBA_ASTC_12x10_Format:
  42693. return Math.floor( ( width + 11 ) / 12 ) * Math.floor( ( height + 9 ) / 10 ) * 16;
  42694. case RGBA_ASTC_12x12_Format:
  42695. return Math.floor( ( width + 11 ) / 12 ) * Math.floor( ( height + 11 ) / 12 ) * 16;
  42696. // https://registry.khronos.org/webgl/extensions/EXT_texture_compression_bptc/
  42697. case RGBA_BPTC_Format:
  42698. case RGB_BPTC_SIGNED_Format:
  42699. case RGB_BPTC_UNSIGNED_Format:
  42700. return Math.ceil( width / 4 ) * Math.ceil( height / 4 ) * 16;
  42701. // https://registry.khronos.org/webgl/extensions/EXT_texture_compression_rgtc/
  42702. case RED_RGTC1_Format:
  42703. case SIGNED_RED_RGTC1_Format:
  42704. return Math.ceil( width / 4 ) * Math.ceil( height / 4 ) * 8;
  42705. case RED_GREEN_RGTC2_Format:
  42706. case SIGNED_RED_GREEN_RGTC2_Format:
  42707. return Math.ceil( width / 4 ) * Math.ceil( height / 4 ) * 16;
  42708. }
  42709. throw new Error(
  42710. `Unable to determine texture byte length for ${format} format.`,
  42711. );
  42712. }
  42713. function getTextureTypeByteLength( type ) {
  42714. switch ( type ) {
  42715. case UnsignedByteType:
  42716. case ByteType:
  42717. return { byteLength: 1, components: 1 };
  42718. case UnsignedShortType:
  42719. case ShortType:
  42720. case HalfFloatType:
  42721. return { byteLength: 2, components: 1 };
  42722. case UnsignedShort4444Type:
  42723. case UnsignedShort5551Type:
  42724. return { byteLength: 2, components: 4 };
  42725. case UnsignedIntType:
  42726. case IntType:
  42727. case FloatType:
  42728. return { byteLength: 4, components: 1 };
  42729. case UnsignedInt5999Type:
  42730. case UnsignedInt101111Type:
  42731. return { byteLength: 4, components: 3 };
  42732. }
  42733. throw new Error( `Unknown texture type ${type}.` );
  42734. }
  42735. /**
  42736. * A class containing utility functions for textures.
  42737. *
  42738. * @hideconstructor
  42739. */
  42740. class TextureUtils {
  42741. /**
  42742. * Scales the texture as large as possible within its surface without cropping
  42743. * or stretching the texture. The method preserves the original aspect ratio of
  42744. * the texture. Akin to CSS `object-fit: contain`
  42745. *
  42746. * @param {Texture} texture - The texture.
  42747. * @param {number} aspect - The texture's aspect ratio.
  42748. * @return {Texture} The updated texture.
  42749. */
  42750. static contain( texture, aspect ) {
  42751. return contain( texture, aspect );
  42752. }
  42753. /**
  42754. * Scales the texture to the smallest possible size to fill the surface, leaving
  42755. * no empty space. The method preserves the original aspect ratio of the texture.
  42756. * Akin to CSS `object-fit: cover`.
  42757. *
  42758. * @param {Texture} texture - The texture.
  42759. * @param {number} aspect - The texture's aspect ratio.
  42760. * @return {Texture} The updated texture.
  42761. */
  42762. static cover( texture, aspect ) {
  42763. return cover( texture, aspect );
  42764. }
  42765. /**
  42766. * Configures the texture to the default transformation. Akin to CSS `object-fit: fill`.
  42767. *
  42768. * @param {Texture} texture - The texture.
  42769. * @return {Texture} The updated texture.
  42770. */
  42771. static fill( texture ) {
  42772. return fill( texture );
  42773. }
  42774. /**
  42775. * Determines how many bytes must be used to represent the texture.
  42776. *
  42777. * @param {number} width - The width of the texture.
  42778. * @param {number} height - The height of the texture.
  42779. * @param {number} format - The texture's format.
  42780. * @param {number} type - The texture's type.
  42781. * @return {number} The byte length.
  42782. */
  42783. static getByteLength( width, height, format, type ) {
  42784. return getByteLength( width, height, format, type );
  42785. }
  42786. }
  42787. if ( typeof __THREE_DEVTOOLS__ !== 'undefined' ) {
  42788. __THREE_DEVTOOLS__.dispatchEvent( new CustomEvent( 'register', { detail: {
  42789. revision: REVISION,
  42790. } } ) );
  42791. }
  42792. if ( typeof window !== 'undefined' ) {
  42793. if ( window.__THREE__ ) {
  42794. warn( 'WARNING: Multiple instances of Three.js being imported.' );
  42795. } else {
  42796. window.__THREE__ = REVISION;
  42797. }
  42798. }
  42799. 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, 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, 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, WebGLCubeRenderTarget, 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号