module-quat2.html 76 KB

1234567891011121314151617181920212223242526272829303132333435363738394041424344454647484950515253545556575859606162636465666768697071727374757677787980818283848586878889909192939495969798991001011021031041051061071081091101111121131141151161171181191201211221231241251261271281291301311321331341351361371381391401411421431441451461471481491501511521531541551561571581591601611621631641651661671681691701711721731741751761771781791801811821831841851861871881891901911921931941951961971981992002012022032042052062072082092102112122132142152162172182192202212222232242252262272282292302312322332342352362372382392402412422432442452462472482492502512522532542552562572582592602612622632642652662672682692702712722732742752762772782792802812822832842852862872882892902912922932942952962972982993003013023033043053063073083093103113123133143153163173183193203213223233243253263273283293303313323333343353363373383393403413423433443453463473483493503513523533543553563573583593603613623633643653663673683693703713723733743753763773783793803813823833843853863873883893903913923933943953963973983994004014024034044054064074084094104114124134144154164174184194204214224234244254264274284294304314324334344354364374384394404414424434444454464474484494504514524534544554564574584594604614624634644654664674684694704714724734744754764774784794804814824834844854864874884894904914924934944954964974984995005015025035045055065075085095105115125135145155165175185195205215225235245255265275285295305315325335345355365375385395405415425435445455465475485495505515525535545555565575585595605615625635645655665675685695705715725735745755765775785795805815825835845855865875885895905915925935945955965975985996006016026036046056066076086096106116126136146156166176186196206216226236246256266276286296306316326336346356366376386396406416426436446456466476486496506516526536546556566576586596606616626636646656666676686696706716726736746756766776786796806816826836846856866876886896906916926936946956966976986997007017027037047057067077087097107117127137147157167177187197207217227237247257267277287297307317327337347357367377387397407417427437447457467477487497507517527537547557567577587597607617627637647657667677687697707717727737747757767777787797807817827837847857867877887897907917927937947957967977987998008018028038048058068078088098108118128138148158168178188198208218228238248258268278288298308318328338348358368378388398408418428438448458468478488498508518528538548558568578588598608618628638648658668678688698708718728738748758768778788798808818828838848858868878888898908918928938948958968978988999009019029039049059069079089099109119129139149159169179189199209219229239249259269279289299309319329339349359369379389399409419429439449459469479489499509519529539549559569579589599609619629639649659669679689699709719729739749759769779789799809819829839849859869879889899909919929939949959969979989991000100110021003100410051006100710081009101010111012101310141015101610171018101910201021102210231024102510261027102810291030103110321033103410351036103710381039104010411042104310441045104610471048104910501051105210531054105510561057105810591060106110621063106410651066106710681069107010711072107310741075107610771078107910801081108210831084108510861087108810891090109110921093109410951096109710981099110011011102110311041105110611071108110911101111111211131114111511161117111811191120112111221123112411251126112711281129113011311132113311341135113611371138113911401141114211431144114511461147114811491150115111521153115411551156115711581159116011611162116311641165116611671168116911701171117211731174117511761177117811791180118111821183118411851186118711881189119011911192119311941195119611971198119912001201120212031204120512061207120812091210121112121213121412151216121712181219122012211222122312241225122612271228122912301231123212331234123512361237123812391240124112421243124412451246124712481249125012511252125312541255125612571258125912601261126212631264126512661267126812691270127112721273127412751276127712781279128012811282128312841285128612871288128912901291129212931294129512961297129812991300130113021303130413051306130713081309131013111312131313141315131613171318131913201321132213231324132513261327132813291330133113321333133413351336133713381339134013411342134313441345134613471348134913501351135213531354135513561357135813591360136113621363136413651366136713681369137013711372137313741375137613771378137913801381138213831384138513861387138813891390139113921393139413951396139713981399140014011402140314041405140614071408140914101411141214131414141514161417141814191420142114221423142414251426142714281429143014311432143314341435143614371438143914401441144214431444144514461447144814491450145114521453145414551456145714581459146014611462146314641465146614671468146914701471147214731474147514761477147814791480148114821483148414851486148714881489149014911492149314941495149614971498149915001501150215031504150515061507150815091510151115121513151415151516151715181519152015211522152315241525152615271528152915301531153215331534153515361537153815391540154115421543154415451546154715481549155015511552155315541555155615571558155915601561156215631564156515661567156815691570157115721573157415751576157715781579158015811582158315841585158615871588158915901591159215931594159515961597159815991600160116021603160416051606160716081609161016111612161316141615161616171618161916201621162216231624162516261627162816291630163116321633163416351636163716381639164016411642164316441645164616471648164916501651165216531654165516561657165816591660166116621663166416651666166716681669167016711672167316741675167616771678167916801681168216831684168516861687168816891690169116921693169416951696169716981699170017011702170317041705170617071708170917101711171217131714171517161717171817191720172117221723172417251726172717281729173017311732173317341735173617371738173917401741174217431744174517461747174817491750175117521753175417551756175717581759176017611762176317641765176617671768176917701771177217731774177517761777177817791780178117821783178417851786178717881789179017911792179317941795179617971798179918001801180218031804180518061807180818091810181118121813181418151816181718181819182018211822182318241825182618271828182918301831183218331834183518361837183818391840184118421843184418451846184718481849185018511852185318541855185618571858185918601861186218631864186518661867186818691870187118721873187418751876187718781879188018811882188318841885188618871888188918901891189218931894189518961897189818991900190119021903190419051906190719081909191019111912191319141915191619171918191919201921192219231924192519261927192819291930193119321933193419351936193719381939194019411942194319441945194619471948194919501951195219531954195519561957195819591960196119621963196419651966196719681969197019711972197319741975197619771978197919801981198219831984198519861987198819891990199119921993199419951996199719981999200020012002200320042005200620072008200920102011201220132014201520162017201820192020202120222023202420252026202720282029203020312032203320342035203620372038203920402041204220432044204520462047204820492050205120522053205420552056205720582059206020612062206320642065206620672068206920702071207220732074207520762077207820792080208120822083208420852086208720882089209020912092209320942095209620972098209921002101210221032104210521062107210821092110211121122113211421152116211721182119212021212122212321242125212621272128212921302131213221332134213521362137213821392140214121422143214421452146214721482149215021512152215321542155215621572158215921602161216221632164216521662167216821692170217121722173217421752176217721782179218021812182218321842185218621872188218921902191219221932194219521962197219821992200220122022203220422052206220722082209221022112212221322142215221622172218221922202221222222232224222522262227222822292230223122322233223422352236223722382239224022412242224322442245224622472248224922502251225222532254225522562257225822592260226122622263226422652266226722682269227022712272227322742275227622772278227922802281228222832284228522862287228822892290229122922293229422952296229722982299230023012302230323042305230623072308230923102311231223132314231523162317231823192320232123222323232423252326232723282329233023312332233323342335233623372338233923402341234223432344234523462347234823492350235123522353235423552356235723582359236023612362236323642365236623672368236923702371237223732374237523762377237823792380238123822383238423852386238723882389239023912392239323942395239623972398239924002401240224032404240524062407240824092410241124122413241424152416241724182419242024212422242324242425242624272428242924302431243224332434243524362437243824392440244124422443244424452446244724482449245024512452245324542455245624572458245924602461246224632464246524662467246824692470247124722473247424752476247724782479248024812482248324842485248624872488248924902491249224932494249524962497249824992500250125022503250425052506250725082509251025112512251325142515251625172518251925202521252225232524252525262527252825292530253125322533253425352536253725382539254025412542254325442545254625472548254925502551255225532554255525562557255825592560256125622563256425652566256725682569257025712572257325742575257625772578257925802581258225832584258525862587258825892590259125922593259425952596259725982599260026012602260326042605260626072608260926102611261226132614261526162617261826192620262126222623262426252626262726282629263026312632263326342635263626372638263926402641264226432644264526462647264826492650265126522653265426552656265726582659266026612662266326642665266626672668266926702671267226732674267526762677267826792680268126822683268426852686268726882689269026912692269326942695269626972698269927002701270227032704270527062707270827092710271127122713271427152716271727182719272027212722272327242725272627272728272927302731273227332734273527362737273827392740274127422743274427452746274727482749275027512752275327542755275627572758275927602761276227632764276527662767276827692770277127722773277427752776277727782779278027812782278327842785278627872788278927902791279227932794279527962797279827992800280128022803280428052806280728082809281028112812281328142815281628172818281928202821282228232824282528262827282828292830283128322833283428352836283728382839284028412842284328442845284628472848284928502851285228532854285528562857285828592860286128622863286428652866286728682869287028712872287328742875287628772878287928802881288228832884288528862887288828892890289128922893289428952896289728982899290029012902290329042905290629072908290929102911291229132914291529162917291829192920292129222923292429252926292729282929293029312932293329342935293629372938293929402941294229432944294529462947294829492950295129522953295429552956295729582959296029612962296329642965296629672968296929702971297229732974297529762977297829792980298129822983298429852986298729882989299029912992299329942995299629972998299930003001300230033004300530063007300830093010301130123013301430153016301730183019302030213022302330243025302630273028302930303031303230333034303530363037303830393040304130423043304430453046304730483049305030513052305330543055305630573058305930603061306230633064306530663067306830693070307130723073307430753076307730783079308030813082308330843085308630873088308930903091309230933094309530963097309830993100310131023103310431053106310731083109311031113112311331143115311631173118311931203121312231233124312531263127312831293130313131323133313431353136313731383139314031413142314331443145314631473148314931503151315231533154315531563157315831593160316131623163316431653166316731683169317031713172317331743175317631773178317931803181318231833184318531863187318831893190319131923193319431953196319731983199320032013202320332043205320632073208320932103211321232133214321532163217321832193220322132223223322432253226322732283229323032313232323332343235323632373238323932403241324232433244324532463247324832493250325132523253325432553256325732583259326032613262326332643265326632673268326932703271327232733274327532763277327832793280328132823283328432853286328732883289329032913292329332943295329632973298329933003301330233033304330533063307330833093310331133123313331433153316331733183319332033213322332333243325332633273328332933303331333233333334333533363337333833393340334133423343334433453346334733483349335033513352335333543355335633573358335933603361336233633364336533663367336833693370337133723373337433753376337733783379338033813382338333843385338633873388338933903391339233933394339533963397339833993400340134023403340434053406340734083409341034113412341334143415341634173418341934203421342234233424342534263427342834293430343134323433343434353436343734383439344034413442344334443445344634473448344934503451345234533454345534563457345834593460346134623463346434653466346734683469347034713472347334743475347634773478347934803481348234833484348534863487348834893490349134923493349434953496349734983499350035013502350335043505350635073508350935103511351235133514351535163517351835193520352135223523352435253526352735283529353035313532353335343535353635373538353935403541354235433544354535463547354835493550355135523553355435553556355735583559356035613562356335643565356635673568356935703571357235733574357535763577357835793580358135823583358435853586358735883589359035913592359335943595359635973598359936003601360236033604360536063607360836093610361136123613361436153616361736183619362036213622362336243625362636273628362936303631363236333634363536363637363836393640364136423643364436453646364736483649365036513652365336543655365636573658365936603661366236633664366536663667366836693670367136723673367436753676367736783679368036813682368336843685368636873688368936903691369236933694369536963697369836993700370137023703370437053706370737083709371037113712371337143715371637173718371937203721372237233724372537263727372837293730373137323733373437353736373737383739374037413742374337443745374637473748374937503751375237533754375537563757375837593760376137623763376437653766376737683769377037713772377337743775377637773778377937803781378237833784378537863787378837893790379137923793379437953796379737983799380038013802380338043805380638073808380938103811381238133814381538163817381838193820382138223823382438253826382738283829383038313832383338343835383638373838383938403841384238433844384538463847384838493850385138523853385438553856385738583859386038613862386338643865386638673868386938703871387238733874387538763877387838793880388138823883388438853886388738883889389038913892389338943895389638973898389939003901390239033904390539063907390839093910391139123913391439153916391739183919392039213922392339243925392639273928392939303931393239333934393539363937393839393940394139423943394439453946394739483949395039513952395339543955395639573958395939603961396239633964396539663967396839693970397139723973397439753976397739783979398039813982398339843985398639873988398939903991399239933994399539963997399839994000400140024003400440054006400740084009401040114012401340144015401640174018401940204021402240234024402540264027402840294030403140324033403440354036403740384039404040414042404340444045404640474048404940504051405240534054405540564057405840594060406140624063406440654066406740684069407040714072407340744075407640774078407940804081408240834084408540864087408840894090409140924093409440954096409740984099410041014102410341044105410641074108410941104111411241134114411541164117411841194120412141224123412441254126412741284129413041314132413341344135413641374138413941404141414241434144414541464147414841494150415141524153415441554156415741584159416041614162416341644165416641674168416941704171417241734174417541764177417841794180418141824183418441854186418741884189419041914192419341944195419641974198419942004201420242034204420542064207420842094210421142124213421442154216421742184219422042214222422342244225422642274228422942304231423242334234423542364237423842394240424142424243424442454246424742484249425042514252425342544255425642574258425942604261426242634264426542664267426842694270427142724273427442754276427742784279428042814282428342844285428642874288428942904291429242934294429542964297429842994300430143024303430443054306430743084309431043114312431343144315431643174318431943204321432243234324432543264327432843294330433143324333433443354336433743384339434043414342434343444345434643474348434943504351435243534354435543564357435843594360436143624363436443654366436743684369437043714372437343744375437643774378437943804381438243834384438543864387438843894390439143924393439443954396439743984399440044014402440344044405440644074408440944104411441244134414441544164417441844194420442144224423442444254426442744284429443044314432443344344435443644374438443944404441444244434444444544464447444844494450445144524453445444554456445744584459446044614462446344644465446644674468446944704471447244734474447544764477447844794480448144824483448444854486448744884489449044914492449344944495449644974498449945004501450245034504450545064507450845094510451145124513451445154516451745184519452045214522452345244525452645274528452945304531453245334534453545364537453845394540454145424543454445454546454745484549455045514552455345544555455645574558455945604561456245634564456545664567456845694570457145724573457445754576457745784579458045814582458345844585458645874588458945904591459245934594459545964597459845994600460146024603460446054606460746084609461046114612461346144615461646174618461946204621462246234624462546264627462846294630463146324633463446354636463746384639464046414642464346444645464646474648464946504651465246534654465546564657465846594660466146624663466446654666466746684669467046714672467346744675467646774678467946804681468246834684468546864687468846894690469146924693469446954696469746984699470047014702470347044705470647074708470947104711471247134714471547164717471847194720472147224723472447254726472747284729473047314732473347344735473647374738473947404741474247434744474547464747474847494750475147524753475447554756475747584759476047614762476347644765476647674768476947704771477247734774477547764777477847794780478147824783478447854786478747884789479047914792479347944795479647974798479948004801480248034804480548064807480848094810481148124813481448154816481748184819482048214822482348244825482648274828482948304831483248334834483548364837483848394840484148424843484448454846484748484849485048514852485348544855485648574858485948604861486248634864486548664867486848694870487148724873487448754876487748784879488048814882488348844885488648874888488948904891489248934894489548964897489848994900490149024903490449054906490749084909491049114912491349144915491649174918491949204921492249234924492549264927492849294930493149324933493449354936493749384939494049414942494349444945494649474948494949504951495249534954495549564957495849594960496149624963496449654966496749684969497049714972497349744975497649774978497949804981498249834984498549864987498849894990499149924993499449954996499749984999500050015002500350045005500650075008500950105011501250135014501550165017501850195020502150225023502450255026502750285029503050315032503350345035503650375038503950405041504250435044504550465047504850495050505150525053505450555056505750585059506050615062506350645065506650675068506950705071507250735074507550765077507850795080508150825083508450855086508750885089509050915092509350945095509650975098509951005101510251035104510551065107510851095110511151125113511451155116511751185119512051215122512351245125512651275128512951305131513251335134513551365137513851395140514151425143514451455146514751485149515051515152515351545155515651575158515951605161516251635164516551665167516851695170517151725173517451755176517751785179518051815182518351845185518651875188518951905191519251935194519551965197519851995200520152025203520452055206520752085209521052115212521352145215521652175218521952205221522252235224522552265227522852295230523152325233523452355236523752385239524052415242524352445245524652475248524952505251525252535254525552565257525852595260526152625263526452655266526752685269527052715272527352745275527652775278527952805281528252835284528552865287528852895290529152925293529452955296529752985299530053015302530353045305530653075308530953105311531253135314531553165317531853195320532153225323532453255326532753285329533053315332533353345335533653375338533953405341534253435344534553465347534853495350535153525353535453555356535753585359536053615362536353645365536653675368536953705371537253735374537553765377537853795380538153825383538453855386538753885389539053915392539353945395539653975398539954005401540254035404540554065407540854095410541154125413541454155416541754185419542054215422542354245425542654275428542954305431543254335434543554365437543854395440544154425443544454455446544754485449545054515452545354545455545654575458545954605461546254635464546554665467546854695470547154725473547454755476547754785479548054815482548354845485548654875488548954905491549254935494549554965497549854995500550155025503550455055506550755085509551055115512551355145515551655175518551955205521552255235524552555265527552855295530553155325533553455355536553755385539554055415542554355445545554655475548554955505551555255535554555555565557555855595560556155625563556455655566556755685569557055715572557355745575557655775578557955805581558255835584558555865587558855895590559155925593559455955596559755985599560056015602560356045605560656075608560956105611561256135614561556165617561856195620562156225623562456255626562756285629563056315632563356345635563656375638563956405641564256435644564556465647564856495650565156525653565456555656565756585659566056615662566356645665566656675668566956705671567256735674567556765677567856795680568156825683568456855686568756885689569056915692569356945695569656975698569957005701570257035704570557065707570857095710571157125713571457155716571757185719572057215722572357245725572657275728572957305731573257335734573557365737573857395740574157425743574457455746574757485749575057515752575357545755575657575758575957605761576257635764576557665767576857695770577157725773577457755776577757785779578057815782578357845785578657875788578957905791579257935794579557965797579857995800580158025803580458055806580758085809581058115812581358145815581658175818581958205821582258235824582558265827582858295830583158325833583458355836583758385839584058415842584358445845584658475848584958505851585258535854585558565857585858595860586158625863586458655866586758685869587058715872587358745875587658775878587958805881588258835884588558865887588858895890589158925893589458955896589758985899590059015902590359045905590659075908590959105911591259135914591559165917591859195920592159225923592459255926592759285929593059315932593359345935593659375938593959405941594259435944594559465947594859495950595159525953595459555956595759585959596059615962596359645965596659675968596959705971597259735974597559765977597859795980598159825983598459855986598759885989599059915992599359945995599659975998599960006001600260036004600560066007600860096010601160126013601460156016601760186019602060216022602360246025602660276028602960306031603260336034603560366037603860396040604160426043604460456046604760486049605060516052605360546055605660576058605960606061606260636064606560666067606860696070607160726073607460756076607760786079608060816082608360846085608660876088608960906091609260936094609560966097609860996100610161026103610461056106610761086109611061116112611361146115611661176118611961206121612261236124612561266127612861296130613161326133613461356136613761386139614061416142614361446145614661476148614961506151615261536154615561566157615861596160616161626163616461656166616761686169617061716172617361746175617661776178617961806181618261836184618561866187618861896190619161926193619461956196619761986199620062016202620362046205620662076208620962106211621262136214621562166217621862196220622162226223622462256226622762286229623062316232623362346235623662376238623962406241624262436244624562466247624862496250625162526253625462556256625762586259626062616262626362646265626662676268626962706271627262736274627562766277627862796280628162826283628462856286628762886289629062916292629362946295629662976298629963006301630263036304630563066307630863096310631163126313631463156316631763186319632063216322632363246325632663276328632963306331633263336334633563366337633863396340634163426343634463456346634763486349635063516352635363546355635663576358635963606361636263636364636563666367636863696370637163726373637463756376637763786379638063816382638363846385638663876388638963906391639263936394639563966397639863996400640164026403640464056406640764086409641064116412641364146415641664176418641964206421642264236424642564266427642864296430643164326433643464356436643764386439644064416442644364446445644664476448644964506451645264536454645564566457645864596460646164626463646464656466646764686469647064716472647364746475647664776478647964806481648264836484648564866487648864896490649164926493649464956496649764986499650065016502650365046505650665076508650965106511651265136514651565166517651865196520652165226523652465256526652765286529653065316532653365346535653665376538653965406541654265436544654565466547654865496550655165526553655465556556655765586559656065616562656365646565656665676568656965706571657265736574657565766577657865796580658165826583658465856586658765886589659065916592659365946595659665976598659966006601660266036604660566066607660866096610661166126613661466156616661766186619662066216622662366246625662666276628662966306631663266336634663566366637663866396640664166426643664466456646664766486649665066516652665366546655665666576658665966606661666266636664666566666667666866696670667166726673667466756676667766786679668066816682668366846685668666876688668966906691669266936694669566966697669866996700670167026703670467056706670767086709671067116712671367146715671667176718671967206721672267236724672567266727672867296730673167326733673467356736673767386739674067416742674367446745674667476748674967506751675267536754675567566757675867596760676167626763676467656766676767686769677067716772677367746775677667776778677967806781678267836784678567866787678867896790679167926793679467956796679767986799680068016802680368046805680668076808680968106811681268136814681568166817681868196820682168226823682468256826682768286829683068316832683368346835683668376838683968406841684268436844684568466847684868496850685168526853685468556856685768586859686068616862686368646865686668676868686968706871687268736874687568766877687868796880688168826883688468856886688768886889689068916892689368946895689668976898689969006901690269036904690569066907690869096910691169126913691469156916691769186919692069216922692369246925692669276928692969306931693269336934693569366937693869396940694169426943694469456946694769486949695069516952695369546955695669576958695969606961696269636964696569666967696869696970697169726973697469756976697769786979698069816982698369846985698669876988698969906991699269936994699569966997699869997000700170027003700470057006700770087009701070117012701370147015701670177018701970207021702270237024702570267027702870297030703170327033703470357036703770387039704070417042704370447045704670477048704970507051705270537054705570567057705870597060706170627063706470657066706770687069707070717072707370747075707670777078707970807081708270837084708570867087708870897090709170927093709470957096709770987099710071017102710371047105710671077108710971107111711271137114711571167117711871197120712171227123712471257126712771287129713071317132713371347135713671377138713971407141714271437144714571467147714871497150715171527153715471557156715771587159716071617162716371647165716671677168716971707171717271737174717571767177717871797180718171827183718471857186718771887189719071917192719371947195719671977198719972007201720272037204720572067207720872097210721172127213721472157216721772187219722072217222722372247225722672277228722972307231723272337234723572367237723872397240724172427243724472457246724772487249725072517252725372547255725672577258725972607261726272637264726572667267726872697270727172727273727472757276727772787279728072817282728372847285728672877288728972907291729272937294729572967297729872997300730173027303730473057306730773087309731073117312731373147315731673177318731973207321732273237324732573267327732873297330733173327333733473357336733773387339734073417342734373447345
  1. <!DOCTYPE html>
  2. <html lang="en">
  3. <head>
  4. <meta charset="utf-8">
  5. <title>JSDoc: Module: quat2</title>
  6. <script src="scripts/prettify/prettify.js"> </script>
  7. <script src="scripts/prettify/lang-css.js"> </script>
  8. <!--[if lt IE 9]>
  9. <script src="//html5shiv.googlecode.com/svn/trunk/html5.js"></script>
  10. <![endif]-->
  11. <link type="text/css" rel="stylesheet" href="styles/prettify-tomorrow.css">
  12. <link type="text/css" rel="stylesheet" href="styles/jsdoc-default.css">
  13. </head>
  14. <body>
  15. <div id="main">
  16. <h1 class="page-title">Module: quat2</h1>
  17. <section>
  18. <header>
  19. </header>
  20. <article>
  21. <div class="container-overview">
  22. <div class="description">Dual Quaternion<br>
  23. Format: [real, dual]<br>
  24. Quaternion format: XYZW<br>
  25. Make sure to have normalized dual quaternions, otherwise the functions may not work as intended.<br></div>
  26. <dl class="details">
  27. <dt class="tag-source">Source:</dt>
  28. <dd class="tag-source"><ul class="dummy"><li>
  29. <a href="quat2.js.html">quat2.js</a>, <a href="quat2.js.html#line5">line 5</a>
  30. </li></ul></dd>
  31. </dl>
  32. </div>
  33. <h3 class="subsection-title">Members</h3>
  34. <h4 class="name" id=".getReal"><span class="type-signature">(static, constant) </span>getReal<span class="type-signature"></span></h4>
  35. <div class="description">
  36. Gets the real part of a dual quat
  37. </div>
  38. <dl class="details">
  39. <dt class="tag-source">Source:</dt>
  40. <dd class="tag-source"><ul class="dummy"><li>
  41. <a href="quat2.js.html">quat2.js</a>, <a href="quat2.js.html#line268">line 268</a>
  42. </li></ul></dd>
  43. </dl>
  44. <h3 class="subsection-title">Methods</h3>
  45. <h4 class="name" id=".add"><span class="type-signature">(static) </span>add<span class="signature">(out, a, b)</span><span class="type-signature"> &rarr; {quat2}</span></h4>
  46. <div class="description">
  47. Adds two dual quat's
  48. </div>
  49. <h5>Parameters:</h5>
  50. <table class="params">
  51. <thead>
  52. <tr>
  53. <th>Name</th>
  54. <th>Type</th>
  55. <th class="last">Description</th>
  56. </tr>
  57. </thead>
  58. <tbody>
  59. <tr>
  60. <td class="name"><code>out</code></td>
  61. <td class="type">
  62. <span class="param-type">quat2</span>
  63. </td>
  64. <td class="description last">the receiving dual quaternion</td>
  65. </tr>
  66. <tr>
  67. <td class="name"><code>a</code></td>
  68. <td class="type">
  69. <span class="param-type">quat2</span>
  70. </td>
  71. <td class="description last">the first operand</td>
  72. </tr>
  73. <tr>
  74. <td class="name"><code>b</code></td>
  75. <td class="type">
  76. <span class="param-type">quat2</span>
  77. </td>
  78. <td class="description last">the second operand</td>
  79. </tr>
  80. </tbody>
  81. </table>
  82. <dl class="details">
  83. <dt class="tag-source">Source:</dt>
  84. <dd class="tag-source"><ul class="dummy"><li>
  85. <a href="quat2.js.html">quat2.js</a>, <a href="quat2.js.html#line580">line 580</a>
  86. </li></ul></dd>
  87. </dl>
  88. <h5>Returns:</h5>
  89. <div class="param-desc">
  90. out
  91. </div>
  92. <dl>
  93. <dt>
  94. Type
  95. </dt>
  96. <dd>
  97. <span class="param-type">quat2</span>
  98. </dd>
  99. </dl>
  100. <h4 class="name" id=".clone"><span class="type-signature">(static) </span>clone<span class="signature">(a)</span><span class="type-signature"> &rarr; {quat2}</span></h4>
  101. <div class="description">
  102. Creates a new quat initialized with values from an existing quaternion
  103. </div>
  104. <h5>Parameters:</h5>
  105. <table class="params">
  106. <thead>
  107. <tr>
  108. <th>Name</th>
  109. <th>Type</th>
  110. <th class="last">Description</th>
  111. </tr>
  112. </thead>
  113. <tbody>
  114. <tr>
  115. <td class="name"><code>a</code></td>
  116. <td class="type">
  117. <span class="param-type">quat2</span>
  118. </td>
  119. <td class="description last">dual quaternion to clone</td>
  120. </tr>
  121. </tbody>
  122. </table>
  123. <dl class="details">
  124. <dt class="tag-source">Source:</dt>
  125. <dd class="tag-source"><ul class="dummy"><li>
  126. <a href="quat2.js.html">quat2.js</a>, <a href="quat2.js.html#line41">line 41</a>
  127. </li></ul></dd>
  128. </dl>
  129. <h5>Returns:</h5>
  130. <div class="param-desc">
  131. new dual quaternion
  132. </div>
  133. <dl>
  134. <dt>
  135. Type
  136. </dt>
  137. <dd>
  138. <span class="param-type">quat2</span>
  139. </dd>
  140. </dl>
  141. <h4 class="name" id=".conjugate"><span class="type-signature">(static) </span>conjugate<span class="signature">(out, a)</span><span class="type-signature"> &rarr; {quat2}</span></h4>
  142. <div class="description">
  143. Calculates the conjugate of a dual quat
  144. If the dual quaternion is normalized, this function is faster than quat2.inverse and produces the same result.
  145. </div>
  146. <h5>Parameters:</h5>
  147. <table class="params">
  148. <thead>
  149. <tr>
  150. <th>Name</th>
  151. <th>Type</th>
  152. <th class="last">Description</th>
  153. </tr>
  154. </thead>
  155. <tbody>
  156. <tr>
  157. <td class="name"><code>out</code></td>
  158. <td class="type">
  159. <span class="param-type">quat2</span>
  160. </td>
  161. <td class="description last">the receiving quaternion</td>
  162. </tr>
  163. <tr>
  164. <td class="name"><code>a</code></td>
  165. <td class="type">
  166. <span class="param-type">quat2</span>
  167. </td>
  168. <td class="description last">quat to calculate conjugate of</td>
  169. </tr>
  170. </tbody>
  171. </table>
  172. <dl class="details">
  173. <dt class="tag-source">Source:</dt>
  174. <dd class="tag-source"><ul class="dummy"><li>
  175. <a href="quat2.js.html">quat2.js</a>, <a href="quat2.js.html#line719">line 719</a>
  176. </li></ul></dd>
  177. </dl>
  178. <h5>Returns:</h5>
  179. <div class="param-desc">
  180. out
  181. </div>
  182. <dl>
  183. <dt>
  184. Type
  185. </dt>
  186. <dd>
  187. <span class="param-type">quat2</span>
  188. </dd>
  189. </dl>
  190. <h4 class="name" id=".copy"><span class="type-signature">(static) </span>copy<span class="signature">(out, a)</span><span class="type-signature"> &rarr; {quat2}</span></h4>
  191. <div class="description">
  192. Copy the values from one dual quat to another
  193. </div>
  194. <h5>Parameters:</h5>
  195. <table class="params">
  196. <thead>
  197. <tr>
  198. <th>Name</th>
  199. <th>Type</th>
  200. <th class="last">Description</th>
  201. </tr>
  202. </thead>
  203. <tbody>
  204. <tr>
  205. <td class="name"><code>out</code></td>
  206. <td class="type">
  207. <span class="param-type">quat2</span>
  208. </td>
  209. <td class="description last">the receiving dual quaternion</td>
  210. </tr>
  211. <tr>
  212. <td class="name"><code>a</code></td>
  213. <td class="type">
  214. <span class="param-type">quat2</span>
  215. </td>
  216. <td class="description last">the source dual quaternion</td>
  217. </tr>
  218. </tbody>
  219. </table>
  220. <dl class="details">
  221. <dt class="tag-source">Source:</dt>
  222. <dd class="tag-source"><ul class="dummy"><li>
  223. <a href="quat2.js.html">quat2.js</a>, <a href="quat2.js.html#line204">line 204</a>
  224. </li></ul></dd>
  225. </dl>
  226. <h5>Returns:</h5>
  227. <div class="param-desc">
  228. out
  229. </div>
  230. <dl>
  231. <dt>
  232. Type
  233. </dt>
  234. <dd>
  235. <span class="param-type">quat2</span>
  236. </dd>
  237. </dl>
  238. <h4 class="name" id=".create"><span class="type-signature">(static) </span>create<span class="signature">()</span><span class="type-signature"> &rarr; {quat2}</span></h4>
  239. <div class="description">
  240. Creates a new identity dual quat
  241. </div>
  242. <dl class="details">
  243. <dt class="tag-source">Source:</dt>
  244. <dd class="tag-source"><ul class="dummy"><li>
  245. <a href="quat2.js.html">quat2.js</a>, <a href="quat2.js.html#line19">line 19</a>
  246. </li></ul></dd>
  247. </dl>
  248. <h5>Returns:</h5>
  249. <div class="param-desc">
  250. a new dual quaternion [real -> rotation, dual -> translation]
  251. </div>
  252. <dl>
  253. <dt>
  254. Type
  255. </dt>
  256. <dd>
  257. <span class="param-type">quat2</span>
  258. </dd>
  259. </dl>
  260. <h4 class="name" id=".dot"><span class="type-signature">(static) </span>dot<span class="signature">(a, b)</span><span class="type-signature"> &rarr; {Number}</span></h4>
  261. <div class="description">
  262. Calculates the dot product of two dual quat's (The dot product of the real parts)
  263. </div>
  264. <h5>Parameters:</h5>
  265. <table class="params">
  266. <thead>
  267. <tr>
  268. <th>Name</th>
  269. <th>Type</th>
  270. <th class="last">Description</th>
  271. </tr>
  272. </thead>
  273. <tbody>
  274. <tr>
  275. <td class="name"><code>a</code></td>
  276. <td class="type">
  277. <span class="param-type">quat2</span>
  278. </td>
  279. <td class="description last">the first operand</td>
  280. </tr>
  281. <tr>
  282. <td class="name"><code>b</code></td>
  283. <td class="type">
  284. <span class="param-type">quat2</span>
  285. </td>
  286. <td class="description last">the second operand</td>
  287. </tr>
  288. </tbody>
  289. </table>
  290. <dl class="details">
  291. <dt class="tag-source">Source:</dt>
  292. <dd class="tag-source"><ul class="dummy"><li>
  293. <a href="quat2.js.html">quat2.js</a>, <a href="quat2.js.html#line663">line 663</a>
  294. </li></ul></dd>
  295. </dl>
  296. <h5>Returns:</h5>
  297. <div class="param-desc">
  298. dot product of a and b
  299. </div>
  300. <dl>
  301. <dt>
  302. Type
  303. </dt>
  304. <dd>
  305. <span class="param-type">Number</span>
  306. </dd>
  307. </dl>
  308. <h4 class="name" id=".equals"><span class="type-signature">(static) </span>equals<span class="signature">(a, b)</span><span class="type-signature"> &rarr; {Boolean}</span></h4>
  309. <div class="description">
  310. Returns whether or not the dual quaternions have approximately the same elements in the same position.
  311. </div>
  312. <h5>Parameters:</h5>
  313. <table class="params">
  314. <thead>
  315. <tr>
  316. <th>Name</th>
  317. <th>Type</th>
  318. <th class="last">Description</th>
  319. </tr>
  320. </thead>
  321. <tbody>
  322. <tr>
  323. <td class="name"><code>a</code></td>
  324. <td class="type">
  325. <span class="param-type">quat2</span>
  326. </td>
  327. <td class="description last">the first dual quat.</td>
  328. </tr>
  329. <tr>
  330. <td class="name"><code>b</code></td>
  331. <td class="type">
  332. <span class="param-type">quat2</span>
  333. </td>
  334. <td class="description last">the second dual quat.</td>
  335. </tr>
  336. </tbody>
  337. </table>
  338. <dl class="details">
  339. <dt class="tag-source">Source:</dt>
  340. <dd class="tag-source"><ul class="dummy"><li>
  341. <a href="quat2.js.html">quat2.js</a>, <a href="quat2.js.html#line829">line 829</a>
  342. </li></ul></dd>
  343. </dl>
  344. <h5>Returns:</h5>
  345. <div class="param-desc">
  346. true if the dual quats are equal, false otherwise.
  347. </div>
  348. <dl>
  349. <dt>
  350. Type
  351. </dt>
  352. <dd>
  353. <span class="param-type">Boolean</span>
  354. </dd>
  355. </dl>
  356. <h4 class="name" id=".exactEquals"><span class="type-signature">(static) </span>exactEquals<span class="signature">(a, b)</span><span class="type-signature"> &rarr; {Boolean}</span></h4>
  357. <div class="description">
  358. Returns whether or not the dual quaternions have exactly the same elements in the same position (when compared with ===)
  359. </div>
  360. <h5>Parameters:</h5>
  361. <table class="params">
  362. <thead>
  363. <tr>
  364. <th>Name</th>
  365. <th>Type</th>
  366. <th class="last">Description</th>
  367. </tr>
  368. </thead>
  369. <tbody>
  370. <tr>
  371. <td class="name"><code>a</code></td>
  372. <td class="type">
  373. <span class="param-type">quat2</span>
  374. </td>
  375. <td class="description last">the first dual quaternion.</td>
  376. </tr>
  377. <tr>
  378. <td class="name"><code>b</code></td>
  379. <td class="type">
  380. <span class="param-type">quat2</span>
  381. </td>
  382. <td class="description last">the second dual quaternion.</td>
  383. </tr>
  384. </tbody>
  385. </table>
  386. <dl class="details">
  387. <dt class="tag-source">Source:</dt>
  388. <dd class="tag-source"><ul class="dummy"><li>
  389. <a href="quat2.js.html">quat2.js</a>, <a href="quat2.js.html#line817">line 817</a>
  390. </li></ul></dd>
  391. </dl>
  392. <h5>Returns:</h5>
  393. <div class="param-desc">
  394. true if the dual quaternions are equal, false otherwise.
  395. </div>
  396. <dl>
  397. <dt>
  398. Type
  399. </dt>
  400. <dd>
  401. <span class="param-type">Boolean</span>
  402. </dd>
  403. </dl>
  404. <h4 class="name" id=".fromMat4"><span class="type-signature">(static) </span>fromMat4<span class="signature">(out, a)</span><span class="type-signature"> &rarr; {quat2}</span></h4>
  405. <div class="description">
  406. Creates a new dual quat from a matrix (4x4)
  407. </div>
  408. <h5>Parameters:</h5>
  409. <table class="params">
  410. <thead>
  411. <tr>
  412. <th>Name</th>
  413. <th>Type</th>
  414. <th class="last">Description</th>
  415. </tr>
  416. </thead>
  417. <tbody>
  418. <tr>
  419. <td class="name"><code>out</code></td>
  420. <td class="type">
  421. <span class="param-type">quat2</span>
  422. </td>
  423. <td class="description last">the dual quaternion</td>
  424. </tr>
  425. <tr>
  426. <td class="name"><code>a</code></td>
  427. <td class="type">
  428. <span class="param-type">mat4</span>
  429. </td>
  430. <td class="description last">the matrix</td>
  431. </tr>
  432. </tbody>
  433. </table>
  434. <dl class="details">
  435. <dt class="tag-source">Source:</dt>
  436. <dd class="tag-source"><ul class="dummy"><li>
  437. <a href="quat2.js.html">quat2.js</a>, <a href="quat2.js.html#line186">line 186</a>
  438. </li></ul></dd>
  439. </dl>
  440. <h5>Returns:</h5>
  441. <div class="param-desc">
  442. dual quat receiving operation result
  443. </div>
  444. <dl>
  445. <dt>
  446. Type
  447. </dt>
  448. <dd>
  449. <span class="param-type">quat2</span>
  450. </dd>
  451. </dl>
  452. <h4 class="name" id=".fromRotation"><span class="type-signature">(static) </span>fromRotation<span class="signature">(dual, q)</span><span class="type-signature"> &rarr; {quat2}</span></h4>
  453. <div class="description">
  454. Creates a dual quat from a quaternion
  455. </div>
  456. <h5>Parameters:</h5>
  457. <table class="params">
  458. <thead>
  459. <tr>
  460. <th>Name</th>
  461. <th>Type</th>
  462. <th class="last">Description</th>
  463. </tr>
  464. </thead>
  465. <tbody>
  466. <tr>
  467. <td class="name"><code>dual</code></td>
  468. <td class="type">
  469. <span class="param-type">quat2</span>
  470. </td>
  471. <td class="description last">quaternion receiving operation result</td>
  472. </tr>
  473. <tr>
  474. <td class="name"><code>q</code></td>
  475. <td class="type">
  476. <span class="param-type">quat</span>
  477. </td>
  478. <td class="description last">the quaternion</td>
  479. </tr>
  480. </tbody>
  481. </table>
  482. <dl class="details">
  483. <dt class="tag-source">Source:</dt>
  484. <dd class="tag-source"><ul class="dummy"><li>
  485. <a href="quat2.js.html">quat2.js</a>, <a href="quat2.js.html#line166">line 166</a>
  486. </li></ul></dd>
  487. </dl>
  488. <h5>Returns:</h5>
  489. <div class="param-desc">
  490. dual quaternion receiving operation result
  491. </div>
  492. <dl>
  493. <dt>
  494. Type
  495. </dt>
  496. <dd>
  497. <span class="param-type">quat2</span>
  498. </dd>
  499. </dl>
  500. <h4 class="name" id=".fromRotationTranslation"><span class="type-signature">(static) </span>fromRotationTranslation<span class="signature">(dual, q, t)</span><span class="type-signature"> &rarr; {quat2}</span></h4>
  501. <div class="description">
  502. Creates a dual quat from a quaternion and a translation
  503. </div>
  504. <h5>Parameters:</h5>
  505. <table class="params">
  506. <thead>
  507. <tr>
  508. <th>Name</th>
  509. <th>Type</th>
  510. <th class="last">Description</th>
  511. </tr>
  512. </thead>
  513. <tbody>
  514. <tr>
  515. <td class="name"><code>dual</code></td>
  516. <td class="type">
  517. <span class="param-type">quat2</span>
  518. </td>
  519. <td class="description last">quaternion receiving operation result</td>
  520. </tr>
  521. <tr>
  522. <td class="name"><code>q</code></td>
  523. <td class="type">
  524. <span class="param-type">quat</span>
  525. </td>
  526. <td class="description last">quaternion</td>
  527. </tr>
  528. <tr>
  529. <td class="name"><code>t</code></td>
  530. <td class="type">
  531. <span class="param-type">vec3</span>
  532. </td>
  533. <td class="description last">tranlation vector</td>
  534. </tr>
  535. </tbody>
  536. </table>
  537. <dl class="details">
  538. <dt class="tag-source">Source:</dt>
  539. <dd class="tag-source"><ul class="dummy"><li>
  540. <a href="quat2.js.html">quat2.js</a>, <a href="quat2.js.html#line119">line 119</a>
  541. </li></ul></dd>
  542. </dl>
  543. <h5>Returns:</h5>
  544. <div class="param-desc">
  545. dual quaternion receiving operation result
  546. </div>
  547. <dl>
  548. <dt>
  549. Type
  550. </dt>
  551. <dd>
  552. <span class="param-type">quat2</span>
  553. </dd>
  554. </dl>
  555. <h4 class="name" id=".fromRotationTranslationValues"><span class="type-signature">(static) </span>fromRotationTranslationValues<span class="signature">(x1, y1, z1, w1, x2, y2, z2)</span><span class="type-signature"> &rarr; {quat2}</span></h4>
  556. <div class="description">
  557. Creates a new dual quat from the given values (quat and translation)
  558. </div>
  559. <h5>Parameters:</h5>
  560. <table class="params">
  561. <thead>
  562. <tr>
  563. <th>Name</th>
  564. <th>Type</th>
  565. <th class="last">Description</th>
  566. </tr>
  567. </thead>
  568. <tbody>
  569. <tr>
  570. <td class="name"><code>x1</code></td>
  571. <td class="type">
  572. <span class="param-type">Number</span>
  573. </td>
  574. <td class="description last">X component</td>
  575. </tr>
  576. <tr>
  577. <td class="name"><code>y1</code></td>
  578. <td class="type">
  579. <span class="param-type">Number</span>
  580. </td>
  581. <td class="description last">Y component</td>
  582. </tr>
  583. <tr>
  584. <td class="name"><code>z1</code></td>
  585. <td class="type">
  586. <span class="param-type">Number</span>
  587. </td>
  588. <td class="description last">Z component</td>
  589. </tr>
  590. <tr>
  591. <td class="name"><code>w1</code></td>
  592. <td class="type">
  593. <span class="param-type">Number</span>
  594. </td>
  595. <td class="description last">W component</td>
  596. </tr>
  597. <tr>
  598. <td class="name"><code>x2</code></td>
  599. <td class="type">
  600. <span class="param-type">Number</span>
  601. </td>
  602. <td class="description last">X component (translation)</td>
  603. </tr>
  604. <tr>
  605. <td class="name"><code>y2</code></td>
  606. <td class="type">
  607. <span class="param-type">Number</span>
  608. </td>
  609. <td class="description last">Y component (translation)</td>
  610. </tr>
  611. <tr>
  612. <td class="name"><code>z2</code></td>
  613. <td class="type">
  614. <span class="param-type">Number</span>
  615. </td>
  616. <td class="description last">Z component (translation)</td>
  617. </tr>
  618. </tbody>
  619. </table>
  620. <dl class="details">
  621. <dt class="tag-source">Source:</dt>
  622. <dd class="tag-source"><ul class="dummy"><li>
  623. <a href="quat2.js.html">quat2.js</a>, <a href="quat2.js.html#line94">line 94</a>
  624. </li></ul></dd>
  625. </dl>
  626. <h5>Returns:</h5>
  627. <div class="param-desc">
  628. new dual quaternion
  629. </div>
  630. <dl>
  631. <dt>
  632. Type
  633. </dt>
  634. <dd>
  635. <span class="param-type">quat2</span>
  636. </dd>
  637. </dl>
  638. <h4 class="name" id=".fromTranslation"><span class="type-signature">(static) </span>fromTranslation<span class="signature">(dual, t)</span><span class="type-signature"> &rarr; {quat2}</span></h4>
  639. <div class="description">
  640. Creates a dual quat from a translation
  641. </div>
  642. <h5>Parameters:</h5>
  643. <table class="params">
  644. <thead>
  645. <tr>
  646. <th>Name</th>
  647. <th>Type</th>
  648. <th class="last">Description</th>
  649. </tr>
  650. </thead>
  651. <tbody>
  652. <tr>
  653. <td class="name"><code>dual</code></td>
  654. <td class="type">
  655. <span class="param-type">quat2</span>
  656. </td>
  657. <td class="description last">quaternion receiving operation result</td>
  658. </tr>
  659. <tr>
  660. <td class="name"><code>t</code></td>
  661. <td class="type">
  662. <span class="param-type">vec3</span>
  663. </td>
  664. <td class="description last">translation vector</td>
  665. </tr>
  666. </tbody>
  667. </table>
  668. <dl class="details">
  669. <dt class="tag-source">Source:</dt>
  670. <dd class="tag-source"><ul class="dummy"><li>
  671. <a href="quat2.js.html">quat2.js</a>, <a href="quat2.js.html#line146">line 146</a>
  672. </li></ul></dd>
  673. </dl>
  674. <h5>Returns:</h5>
  675. <div class="param-desc">
  676. dual quaternion receiving operation result
  677. </div>
  678. <dl>
  679. <dt>
  680. Type
  681. </dt>
  682. <dd>
  683. <span class="param-type">quat2</span>
  684. </dd>
  685. </dl>
  686. <h4 class="name" id=".fromValues"><span class="type-signature">(static) </span>fromValues<span class="signature">(x1, y1, z1, w1, x2, y2, z2, w2)</span><span class="type-signature"> &rarr; {quat2}</span></h4>
  687. <div class="description">
  688. Creates a new dual quat initialized with the given values
  689. </div>
  690. <h5>Parameters:</h5>
  691. <table class="params">
  692. <thead>
  693. <tr>
  694. <th>Name</th>
  695. <th>Type</th>
  696. <th class="last">Description</th>
  697. </tr>
  698. </thead>
  699. <tbody>
  700. <tr>
  701. <td class="name"><code>x1</code></td>
  702. <td class="type">
  703. <span class="param-type">Number</span>
  704. </td>
  705. <td class="description last">X component</td>
  706. </tr>
  707. <tr>
  708. <td class="name"><code>y1</code></td>
  709. <td class="type">
  710. <span class="param-type">Number</span>
  711. </td>
  712. <td class="description last">Y component</td>
  713. </tr>
  714. <tr>
  715. <td class="name"><code>z1</code></td>
  716. <td class="type">
  717. <span class="param-type">Number</span>
  718. </td>
  719. <td class="description last">Z component</td>
  720. </tr>
  721. <tr>
  722. <td class="name"><code>w1</code></td>
  723. <td class="type">
  724. <span class="param-type">Number</span>
  725. </td>
  726. <td class="description last">W component</td>
  727. </tr>
  728. <tr>
  729. <td class="name"><code>x2</code></td>
  730. <td class="type">
  731. <span class="param-type">Number</span>
  732. </td>
  733. <td class="description last">X component</td>
  734. </tr>
  735. <tr>
  736. <td class="name"><code>y2</code></td>
  737. <td class="type">
  738. <span class="param-type">Number</span>
  739. </td>
  740. <td class="description last">Y component</td>
  741. </tr>
  742. <tr>
  743. <td class="name"><code>z2</code></td>
  744. <td class="type">
  745. <span class="param-type">Number</span>
  746. </td>
  747. <td class="description last">Z component</td>
  748. </tr>
  749. <tr>
  750. <td class="name"><code>w2</code></td>
  751. <td class="type">
  752. <span class="param-type">Number</span>
  753. </td>
  754. <td class="description last">W component</td>
  755. </tr>
  756. </tbody>
  757. </table>
  758. <dl class="details">
  759. <dt class="tag-source">Source:</dt>
  760. <dd class="tag-source"><ul class="dummy"><li>
  761. <a href="quat2.js.html">quat2.js</a>, <a href="quat2.js.html#line68">line 68</a>
  762. </li></ul></dd>
  763. </dl>
  764. <h5>Returns:</h5>
  765. <div class="param-desc">
  766. new dual quaternion
  767. </div>
  768. <dl>
  769. <dt>
  770. Type
  771. </dt>
  772. <dd>
  773. <span class="param-type">quat2</span>
  774. </dd>
  775. </dl>
  776. <h4 class="name" id=".getDual"><span class="type-signature">(static) </span>getDual<span class="signature">(out, a)</span><span class="type-signature"> &rarr; {quat}</span></h4>
  777. <div class="description">
  778. Gets the dual part of a dual quat
  779. </div>
  780. <h5>Parameters:</h5>
  781. <table class="params">
  782. <thead>
  783. <tr>
  784. <th>Name</th>
  785. <th>Type</th>
  786. <th class="last">Description</th>
  787. </tr>
  788. </thead>
  789. <tbody>
  790. <tr>
  791. <td class="name"><code>out</code></td>
  792. <td class="type">
  793. <span class="param-type">quat</span>
  794. </td>
  795. <td class="description last">dual part</td>
  796. </tr>
  797. <tr>
  798. <td class="name"><code>a</code></td>
  799. <td class="type">
  800. <span class="param-type">quat2</span>
  801. </td>
  802. <td class="description last">Dual Quaternion</td>
  803. </tr>
  804. </tbody>
  805. </table>
  806. <dl class="details">
  807. <dt class="tag-source">Source:</dt>
  808. <dd class="tag-source"><ul class="dummy"><li>
  809. <a href="quat2.js.html">quat2.js</a>, <a href="quat2.js.html#line276">line 276</a>
  810. </li></ul></dd>
  811. </dl>
  812. <h5>Returns:</h5>
  813. <div class="param-desc">
  814. dual part
  815. </div>
  816. <dl>
  817. <dt>
  818. Type
  819. </dt>
  820. <dd>
  821. <span class="param-type">quat</span>
  822. </dd>
  823. </dl>
  824. <h4 class="name" id=".getTranslation"><span class="type-signature">(static) </span>getTranslation<span class="signature">(out, a)</span><span class="type-signature"> &rarr; {vec3}</span></h4>
  825. <div class="description">
  826. Gets the translation of a normalized dual quat
  827. </div>
  828. <h5>Parameters:</h5>
  829. <table class="params">
  830. <thead>
  831. <tr>
  832. <th>Name</th>
  833. <th>Type</th>
  834. <th class="last">Description</th>
  835. </tr>
  836. </thead>
  837. <tbody>
  838. <tr>
  839. <td class="name"><code>out</code></td>
  840. <td class="type">
  841. <span class="param-type">vec3</span>
  842. </td>
  843. <td class="description last">translation</td>
  844. </tr>
  845. <tr>
  846. <td class="name"><code>a</code></td>
  847. <td class="type">
  848. <span class="param-type">quat2</span>
  849. </td>
  850. <td class="description last">Dual Quaternion to be decomposed</td>
  851. </tr>
  852. </tbody>
  853. </table>
  854. <dl class="details">
  855. <dt class="tag-source">Source:</dt>
  856. <dd class="tag-source"><ul class="dummy"><li>
  857. <a href="quat2.js.html">quat2.js</a>, <a href="quat2.js.html#line316">line 316</a>
  858. </li></ul></dd>
  859. </dl>
  860. <h5>Returns:</h5>
  861. <div class="param-desc">
  862. translation
  863. </div>
  864. <dl>
  865. <dt>
  866. Type
  867. </dt>
  868. <dd>
  869. <span class="param-type">vec3</span>
  870. </dd>
  871. </dl>
  872. <h4 class="name" id=".identity"><span class="type-signature">(static) </span>identity<span class="signature">(out)</span><span class="type-signature"> &rarr; {quat2}</span></h4>
  873. <div class="description">
  874. Set a dual quat to the identity dual quaternion
  875. </div>
  876. <h5>Parameters:</h5>
  877. <table class="params">
  878. <thead>
  879. <tr>
  880. <th>Name</th>
  881. <th>Type</th>
  882. <th class="last">Description</th>
  883. </tr>
  884. </thead>
  885. <tbody>
  886. <tr>
  887. <td class="name"><code>out</code></td>
  888. <td class="type">
  889. <span class="param-type">quat2</span>
  890. </td>
  891. <td class="description last">the receiving quaternion</td>
  892. </tr>
  893. </tbody>
  894. </table>
  895. <dl class="details">
  896. <dt class="tag-source">Source:</dt>
  897. <dd class="tag-source"><ul class="dummy"><li>
  898. <a href="quat2.js.html">quat2.js</a>, <a href="quat2.js.html#line222">line 222</a>
  899. </li></ul></dd>
  900. </dl>
  901. <h5>Returns:</h5>
  902. <div class="param-desc">
  903. out
  904. </div>
  905. <dl>
  906. <dt>
  907. Type
  908. </dt>
  909. <dd>
  910. <span class="param-type">quat2</span>
  911. </dd>
  912. </dl>
  913. <h4 class="name" id=".invert"><span class="type-signature">(static) </span>invert<span class="signature">(out, a)</span><span class="type-signature"> &rarr; {quat2}</span></h4>
  914. <div class="description">
  915. Calculates the inverse of a dual quat. If they are normalized, conjugate is cheaper
  916. </div>
  917. <h5>Parameters:</h5>
  918. <table class="params">
  919. <thead>
  920. <tr>
  921. <th>Name</th>
  922. <th>Type</th>
  923. <th class="last">Description</th>
  924. </tr>
  925. </thead>
  926. <tbody>
  927. <tr>
  928. <td class="name"><code>out</code></td>
  929. <td class="type">
  930. <span class="param-type">quat2</span>
  931. </td>
  932. <td class="description last">the receiving dual quaternion</td>
  933. </tr>
  934. <tr>
  935. <td class="name"><code>a</code></td>
  936. <td class="type">
  937. <span class="param-type">quat2</span>
  938. </td>
  939. <td class="description last">dual quat to calculate inverse of</td>
  940. </tr>
  941. </tbody>
  942. </table>
  943. <dl class="details">
  944. <dt class="tag-source">Source:</dt>
  945. <dd class="tag-source"><ul class="dummy"><li>
  946. <a href="quat2.js.html">quat2.js</a>, <a href="quat2.js.html#line698">line 698</a>
  947. </li></ul></dd>
  948. </dl>
  949. <h5>Returns:</h5>
  950. <div class="param-desc">
  951. out
  952. </div>
  953. <dl>
  954. <dt>
  955. Type
  956. </dt>
  957. <dd>
  958. <span class="param-type">quat2</span>
  959. </dd>
  960. </dl>
  961. <h4 class="name" id=".len"><span class="type-signature">(static) </span>len<span class="signature">()</span><span class="type-signature"></span></h4>
  962. <div class="description">
  963. Alias for quat2.length
  964. </div>
  965. <dl class="details">
  966. <dt class="tag-source">Source:</dt>
  967. <dd class="tag-source"><ul class="dummy"><li>
  968. <a href="quat2.js.html">quat2.js</a>, <a href="quat2.js.html#line744">line 744</a>
  969. </li></ul></dd>
  970. </dl>
  971. <h4 class="name" id=".length"><span class="type-signature">(static) </span>length<span class="signature">(a)</span><span class="type-signature"> &rarr; {Number}</span></h4>
  972. <div class="description">
  973. Calculates the length of a dual quat
  974. </div>
  975. <h5>Parameters:</h5>
  976. <table class="params">
  977. <thead>
  978. <tr>
  979. <th>Name</th>
  980. <th>Type</th>
  981. <th class="last">Description</th>
  982. </tr>
  983. </thead>
  984. <tbody>
  985. <tr>
  986. <td class="name"><code>a</code></td>
  987. <td class="type">
  988. <span class="param-type">quat2</span>
  989. </td>
  990. <td class="description last">dual quat to calculate length of</td>
  991. </tr>
  992. </tbody>
  993. </table>
  994. <dl class="details">
  995. <dt class="tag-source">Source:</dt>
  996. <dd class="tag-source"><ul class="dummy"><li>
  997. <a href="quat2.js.html">quat2.js</a>, <a href="quat2.js.html#line738">line 738</a>
  998. </li></ul></dd>
  999. </dl>
  1000. <h5>Returns:</h5>
  1001. <div class="param-desc">
  1002. length of a
  1003. </div>
  1004. <dl>
  1005. <dt>
  1006. Type
  1007. </dt>
  1008. <dd>
  1009. <span class="param-type">Number</span>
  1010. </dd>
  1011. </dl>
  1012. <h4 class="name" id=".lerp"><span class="type-signature">(static) </span>lerp<span class="signature">(out, a, b, t)</span><span class="type-signature"> &rarr; {quat2}</span></h4>
  1013. <div class="description">
  1014. Performs a linear interpolation between two dual quats's
  1015. NOTE: The resulting dual quaternions won't always be normalized (The error is most noticeable when t = 0.5)
  1016. </div>
  1017. <h5>Parameters:</h5>
  1018. <table class="params">
  1019. <thead>
  1020. <tr>
  1021. <th>Name</th>
  1022. <th>Type</th>
  1023. <th class="last">Description</th>
  1024. </tr>
  1025. </thead>
  1026. <tbody>
  1027. <tr>
  1028. <td class="name"><code>out</code></td>
  1029. <td class="type">
  1030. <span class="param-type">quat2</span>
  1031. </td>
  1032. <td class="description last">the receiving dual quat</td>
  1033. </tr>
  1034. <tr>
  1035. <td class="name"><code>a</code></td>
  1036. <td class="type">
  1037. <span class="param-type">quat2</span>
  1038. </td>
  1039. <td class="description last">the first operand</td>
  1040. </tr>
  1041. <tr>
  1042. <td class="name"><code>b</code></td>
  1043. <td class="type">
  1044. <span class="param-type">quat2</span>
  1045. </td>
  1046. <td class="description last">the second operand</td>
  1047. </tr>
  1048. <tr>
  1049. <td class="name"><code>t</code></td>
  1050. <td class="type">
  1051. <span class="param-type">Number</span>
  1052. </td>
  1053. <td class="description last">interpolation amount, in the range [0-1], between the two inputs</td>
  1054. </tr>
  1055. </tbody>
  1056. </table>
  1057. <dl class="details">
  1058. <dt class="tag-source">Source:</dt>
  1059. <dd class="tag-source"><ul class="dummy"><li>
  1060. <a href="quat2.js.html">quat2.js</a>, <a href="quat2.js.html#line675">line 675</a>
  1061. </li></ul></dd>
  1062. </dl>
  1063. <h5>Returns:</h5>
  1064. <div class="param-desc">
  1065. out
  1066. </div>
  1067. <dl>
  1068. <dt>
  1069. Type
  1070. </dt>
  1071. <dd>
  1072. <span class="param-type">quat2</span>
  1073. </dd>
  1074. </dl>
  1075. <h4 class="name" id=".mul"><span class="type-signature">(static) </span>mul<span class="signature">()</span><span class="type-signature"></span></h4>
  1076. <div class="description">
  1077. Alias for quat2.multiply
  1078. </div>
  1079. <dl class="details">
  1080. <dt class="tag-source">Source:</dt>
  1081. <dd class="tag-source"><ul class="dummy"><li>
  1082. <a href="quat2.js.html">quat2.js</a>, <a href="quat2.js.html#line632">line 632</a>
  1083. </li></ul></dd>
  1084. </dl>
  1085. <h4 class="name" id=".multiply"><span class="type-signature">(static) </span>multiply<span class="signature">(out, a, b)</span><span class="type-signature"> &rarr; {quat2}</span></h4>
  1086. <div class="description">
  1087. Multiplies two dual quat's
  1088. </div>
  1089. <h5>Parameters:</h5>
  1090. <table class="params">
  1091. <thead>
  1092. <tr>
  1093. <th>Name</th>
  1094. <th>Type</th>
  1095. <th class="last">Description</th>
  1096. </tr>
  1097. </thead>
  1098. <tbody>
  1099. <tr>
  1100. <td class="name"><code>out</code></td>
  1101. <td class="type">
  1102. <span class="param-type">quat2</span>
  1103. </td>
  1104. <td class="description last">the receiving dual quaternion</td>
  1105. </tr>
  1106. <tr>
  1107. <td class="name"><code>a</code></td>
  1108. <td class="type">
  1109. <span class="param-type">quat2</span>
  1110. </td>
  1111. <td class="description last">the first operand</td>
  1112. </tr>
  1113. <tr>
  1114. <td class="name"><code>b</code></td>
  1115. <td class="type">
  1116. <span class="param-type">quat2</span>
  1117. </td>
  1118. <td class="description last">the second operand</td>
  1119. </tr>
  1120. </tbody>
  1121. </table>
  1122. <dl class="details">
  1123. <dt class="tag-source">Source:</dt>
  1124. <dd class="tag-source"><ul class="dummy"><li>
  1125. <a href="quat2.js.html">quat2.js</a>, <a href="quat2.js.html#line600">line 600</a>
  1126. </li></ul></dd>
  1127. </dl>
  1128. <h5>Returns:</h5>
  1129. <div class="param-desc">
  1130. out
  1131. </div>
  1132. <dl>
  1133. <dt>
  1134. Type
  1135. </dt>
  1136. <dd>
  1137. <span class="param-type">quat2</span>
  1138. </dd>
  1139. </dl>
  1140. <h4 class="name" id=".normalize"><span class="type-signature">(static) </span>normalize<span class="signature">(out, a)</span><span class="type-signature"> &rarr; {quat2}</span></h4>
  1141. <div class="description">
  1142. Normalize a dual quat
  1143. </div>
  1144. <h5>Parameters:</h5>
  1145. <table class="params">
  1146. <thead>
  1147. <tr>
  1148. <th>Name</th>
  1149. <th>Type</th>
  1150. <th class="last">Description</th>
  1151. </tr>
  1152. </thead>
  1153. <tbody>
  1154. <tr>
  1155. <td class="name"><code>out</code></td>
  1156. <td class="type">
  1157. <span class="param-type">quat2</span>
  1158. </td>
  1159. <td class="description last">the receiving dual quaternion</td>
  1160. </tr>
  1161. <tr>
  1162. <td class="name"><code>a</code></td>
  1163. <td class="type">
  1164. <span class="param-type">quat2</span>
  1165. </td>
  1166. <td class="description last">dual quaternion to normalize</td>
  1167. </tr>
  1168. </tbody>
  1169. </table>
  1170. <dl class="details">
  1171. <dt class="tag-source">Source:</dt>
  1172. <dd class="tag-source"><ul class="dummy"><li>
  1173. <a href="quat2.js.html">quat2.js</a>, <a href="quat2.js.html#line769">line 769</a>
  1174. </li></ul></dd>
  1175. </dl>
  1176. <h5>Returns:</h5>
  1177. <div class="param-desc">
  1178. out
  1179. </div>
  1180. <dl>
  1181. <dt>
  1182. Type
  1183. </dt>
  1184. <dd>
  1185. <span class="param-type">quat2</span>
  1186. </dd>
  1187. </dl>
  1188. <h4 class="name" id=".rotateAroundAxis"><span class="type-signature">(static) </span>rotateAroundAxis<span class="signature">(out, a, axis, rad)</span><span class="type-signature"> &rarr; {quat2}</span></h4>
  1189. <div class="description">
  1190. Rotates a dual quat around a given axis. Does the normalisation automatically
  1191. </div>
  1192. <h5>Parameters:</h5>
  1193. <table class="params">
  1194. <thead>
  1195. <tr>
  1196. <th>Name</th>
  1197. <th>Type</th>
  1198. <th class="last">Description</th>
  1199. </tr>
  1200. </thead>
  1201. <tbody>
  1202. <tr>
  1203. <td class="name"><code>out</code></td>
  1204. <td class="type">
  1205. <span class="param-type">quat2</span>
  1206. </td>
  1207. <td class="description last">the receiving dual quaternion</td>
  1208. </tr>
  1209. <tr>
  1210. <td class="name"><code>a</code></td>
  1211. <td class="type">
  1212. <span class="param-type">quat2</span>
  1213. </td>
  1214. <td class="description last">the dual quaternion to rotate</td>
  1215. </tr>
  1216. <tr>
  1217. <td class="name"><code>axis</code></td>
  1218. <td class="type">
  1219. <span class="param-type">vec3</span>
  1220. </td>
  1221. <td class="description last">the axis to rotate around</td>
  1222. </tr>
  1223. <tr>
  1224. <td class="name"><code>rad</code></td>
  1225. <td class="type">
  1226. <span class="param-type">Number</span>
  1227. </td>
  1228. <td class="description last">how far the rotation should be</td>
  1229. </tr>
  1230. </tbody>
  1231. </table>
  1232. <dl class="details">
  1233. <dt class="tag-source">Source:</dt>
  1234. <dd class="tag-source"><ul class="dummy"><li>
  1235. <a href="quat2.js.html">quat2.js</a>, <a href="quat2.js.html#line536">line 536</a>
  1236. </li></ul></dd>
  1237. </dl>
  1238. <h5>Returns:</h5>
  1239. <div class="param-desc">
  1240. out
  1241. </div>
  1242. <dl>
  1243. <dt>
  1244. Type
  1245. </dt>
  1246. <dd>
  1247. <span class="param-type">quat2</span>
  1248. </dd>
  1249. </dl>
  1250. <h4 class="name" id=".rotateByQuatAppend"><span class="type-signature">(static) </span>rotateByQuatAppend<span class="signature">(out, a, q)</span><span class="type-signature"> &rarr; {quat2}</span></h4>
  1251. <div class="description">
  1252. Rotates a dual quat by a given quaternion (a * q)
  1253. </div>
  1254. <h5>Parameters:</h5>
  1255. <table class="params">
  1256. <thead>
  1257. <tr>
  1258. <th>Name</th>
  1259. <th>Type</th>
  1260. <th class="last">Description</th>
  1261. </tr>
  1262. </thead>
  1263. <tbody>
  1264. <tr>
  1265. <td class="name"><code>out</code></td>
  1266. <td class="type">
  1267. <span class="param-type">quat2</span>
  1268. </td>
  1269. <td class="description last">the receiving dual quaternion</td>
  1270. </tr>
  1271. <tr>
  1272. <td class="name"><code>a</code></td>
  1273. <td class="type">
  1274. <span class="param-type">quat2</span>
  1275. </td>
  1276. <td class="description last">the dual quaternion to rotate</td>
  1277. </tr>
  1278. <tr>
  1279. <td class="name"><code>q</code></td>
  1280. <td class="type">
  1281. <span class="param-type">quat</span>
  1282. </td>
  1283. <td class="description last">quaternion to rotate by</td>
  1284. </tr>
  1285. </tbody>
  1286. </table>
  1287. <dl class="details">
  1288. <dt class="tag-source">Source:</dt>
  1289. <dd class="tag-source"><ul class="dummy"><li>
  1290. <a href="quat2.js.html">quat2.js</a>, <a href="quat2.js.html#line469">line 469</a>
  1291. </li></ul></dd>
  1292. </dl>
  1293. <h5>Returns:</h5>
  1294. <div class="param-desc">
  1295. out
  1296. </div>
  1297. <dl>
  1298. <dt>
  1299. Type
  1300. </dt>
  1301. <dd>
  1302. <span class="param-type">quat2</span>
  1303. </dd>
  1304. </dl>
  1305. <h4 class="name" id=".rotateByQuatPrepend"><span class="type-signature">(static) </span>rotateByQuatPrepend<span class="signature">(out, q, a)</span><span class="type-signature"> &rarr; {quat2}</span></h4>
  1306. <div class="description">
  1307. Rotates a dual quat by a given quaternion (q * a)
  1308. </div>
  1309. <h5>Parameters:</h5>
  1310. <table class="params">
  1311. <thead>
  1312. <tr>
  1313. <th>Name</th>
  1314. <th>Type</th>
  1315. <th class="last">Description</th>
  1316. </tr>
  1317. </thead>
  1318. <tbody>
  1319. <tr>
  1320. <td class="name"><code>out</code></td>
  1321. <td class="type">
  1322. <span class="param-type">quat2</span>
  1323. </td>
  1324. <td class="description last">the receiving dual quaternion</td>
  1325. </tr>
  1326. <tr>
  1327. <td class="name"><code>q</code></td>
  1328. <td class="type">
  1329. <span class="param-type">quat</span>
  1330. </td>
  1331. <td class="description last">quaternion to rotate by</td>
  1332. </tr>
  1333. <tr>
  1334. <td class="name"><code>a</code></td>
  1335. <td class="type">
  1336. <span class="param-type">quat2</span>
  1337. </td>
  1338. <td class="description last">the dual quaternion to rotate</td>
  1339. </tr>
  1340. </tbody>
  1341. </table>
  1342. <dl class="details">
  1343. <dt class="tag-source">Source:</dt>
  1344. <dd class="tag-source"><ul class="dummy"><li>
  1345. <a href="quat2.js.html">quat2.js</a>, <a href="quat2.js.html#line502">line 502</a>
  1346. </li></ul></dd>
  1347. </dl>
  1348. <h5>Returns:</h5>
  1349. <div class="param-desc">
  1350. out
  1351. </div>
  1352. <dl>
  1353. <dt>
  1354. Type
  1355. </dt>
  1356. <dd>
  1357. <span class="param-type">quat2</span>
  1358. </dd>
  1359. </dl>
  1360. <h4 class="name" id=".rotateX"><span class="type-signature">(static) </span>rotateX<span class="signature">(out, a, rad)</span><span class="type-signature"> &rarr; {quat2}</span></h4>
  1361. <div class="description">
  1362. Rotates a dual quat around the X axis
  1363. </div>
  1364. <h5>Parameters:</h5>
  1365. <table class="params">
  1366. <thead>
  1367. <tr>
  1368. <th>Name</th>
  1369. <th>Type</th>
  1370. <th class="last">Description</th>
  1371. </tr>
  1372. </thead>
  1373. <tbody>
  1374. <tr>
  1375. <td class="name"><code>out</code></td>
  1376. <td class="type">
  1377. <span class="param-type">quat2</span>
  1378. </td>
  1379. <td class="description last">the receiving dual quaternion</td>
  1380. </tr>
  1381. <tr>
  1382. <td class="name"><code>a</code></td>
  1383. <td class="type">
  1384. <span class="param-type">quat2</span>
  1385. </td>
  1386. <td class="description last">the dual quaternion to rotate</td>
  1387. </tr>
  1388. <tr>
  1389. <td class="name"><code>rad</code></td>
  1390. <td class="type">
  1391. <span class="param-type">number</span>
  1392. </td>
  1393. <td class="description last">how far should the rotation be</td>
  1394. </tr>
  1395. </tbody>
  1396. </table>
  1397. <dl class="details">
  1398. <dt class="tag-source">Source:</dt>
  1399. <dd class="tag-source"><ul class="dummy"><li>
  1400. <a href="quat2.js.html">quat2.js</a>, <a href="quat2.js.html#line370">line 370</a>
  1401. </li></ul></dd>
  1402. </dl>
  1403. <h5>Returns:</h5>
  1404. <div class="param-desc">
  1405. out
  1406. </div>
  1407. <dl>
  1408. <dt>
  1409. Type
  1410. </dt>
  1411. <dd>
  1412. <span class="param-type">quat2</span>
  1413. </dd>
  1414. </dl>
  1415. <h4 class="name" id=".rotateY"><span class="type-signature">(static) </span>rotateY<span class="signature">(out, a, rad)</span><span class="type-signature"> &rarr; {quat2}</span></h4>
  1416. <div class="description">
  1417. Rotates a dual quat around the Y axis
  1418. </div>
  1419. <h5>Parameters:</h5>
  1420. <table class="params">
  1421. <thead>
  1422. <tr>
  1423. <th>Name</th>
  1424. <th>Type</th>
  1425. <th class="last">Description</th>
  1426. </tr>
  1427. </thead>
  1428. <tbody>
  1429. <tr>
  1430. <td class="name"><code>out</code></td>
  1431. <td class="type">
  1432. <span class="param-type">quat2</span>
  1433. </td>
  1434. <td class="description last">the receiving dual quaternion</td>
  1435. </tr>
  1436. <tr>
  1437. <td class="name"><code>a</code></td>
  1438. <td class="type">
  1439. <span class="param-type">quat2</span>
  1440. </td>
  1441. <td class="description last">the dual quaternion to rotate</td>
  1442. </tr>
  1443. <tr>
  1444. <td class="name"><code>rad</code></td>
  1445. <td class="type">
  1446. <span class="param-type">number</span>
  1447. </td>
  1448. <td class="description last">how far should the rotation be</td>
  1449. </tr>
  1450. </tbody>
  1451. </table>
  1452. <dl class="details">
  1453. <dt class="tag-source">Source:</dt>
  1454. <dd class="tag-source"><ul class="dummy"><li>
  1455. <a href="quat2.js.html">quat2.js</a>, <a href="quat2.js.html#line403">line 403</a>
  1456. </li></ul></dd>
  1457. </dl>
  1458. <h5>Returns:</h5>
  1459. <div class="param-desc">
  1460. out
  1461. </div>
  1462. <dl>
  1463. <dt>
  1464. Type
  1465. </dt>
  1466. <dd>
  1467. <span class="param-type">quat2</span>
  1468. </dd>
  1469. </dl>
  1470. <h4 class="name" id=".rotateZ"><span class="type-signature">(static) </span>rotateZ<span class="signature">(out, a, rad)</span><span class="type-signature"> &rarr; {quat2}</span></h4>
  1471. <div class="description">
  1472. Rotates a dual quat around the Z axis
  1473. </div>
  1474. <h5>Parameters:</h5>
  1475. <table class="params">
  1476. <thead>
  1477. <tr>
  1478. <th>Name</th>
  1479. <th>Type</th>
  1480. <th class="last">Description</th>
  1481. </tr>
  1482. </thead>
  1483. <tbody>
  1484. <tr>
  1485. <td class="name"><code>out</code></td>
  1486. <td class="type">
  1487. <span class="param-type">quat2</span>
  1488. </td>
  1489. <td class="description last">the receiving dual quaternion</td>
  1490. </tr>
  1491. <tr>
  1492. <td class="name"><code>a</code></td>
  1493. <td class="type">
  1494. <span class="param-type">quat2</span>
  1495. </td>
  1496. <td class="description last">the dual quaternion to rotate</td>
  1497. </tr>
  1498. <tr>
  1499. <td class="name"><code>rad</code></td>
  1500. <td class="type">
  1501. <span class="param-type">number</span>
  1502. </td>
  1503. <td class="description last">how far should the rotation be</td>
  1504. </tr>
  1505. </tbody>
  1506. </table>
  1507. <dl class="details">
  1508. <dt class="tag-source">Source:</dt>
  1509. <dd class="tag-source"><ul class="dummy"><li>
  1510. <a href="quat2.js.html">quat2.js</a>, <a href="quat2.js.html#line436">line 436</a>
  1511. </li></ul></dd>
  1512. </dl>
  1513. <h5>Returns:</h5>
  1514. <div class="param-desc">
  1515. out
  1516. </div>
  1517. <dl>
  1518. <dt>
  1519. Type
  1520. </dt>
  1521. <dd>
  1522. <span class="param-type">quat2</span>
  1523. </dd>
  1524. </dl>
  1525. <h4 class="name" id=".scale"><span class="type-signature">(static) </span>scale<span class="signature">(out, a, b)</span><span class="type-signature"> &rarr; {quat2}</span></h4>
  1526. <div class="description">
  1527. Scales a dual quat by a scalar number
  1528. </div>
  1529. <h5>Parameters:</h5>
  1530. <table class="params">
  1531. <thead>
  1532. <tr>
  1533. <th>Name</th>
  1534. <th>Type</th>
  1535. <th class="last">Description</th>
  1536. </tr>
  1537. </thead>
  1538. <tbody>
  1539. <tr>
  1540. <td class="name"><code>out</code></td>
  1541. <td class="type">
  1542. <span class="param-type">quat2</span>
  1543. </td>
  1544. <td class="description last">the receiving dual quat</td>
  1545. </tr>
  1546. <tr>
  1547. <td class="name"><code>a</code></td>
  1548. <td class="type">
  1549. <span class="param-type">quat2</span>
  1550. </td>
  1551. <td class="description last">the dual quat to scale</td>
  1552. </tr>
  1553. <tr>
  1554. <td class="name"><code>b</code></td>
  1555. <td class="type">
  1556. <span class="param-type">Number</span>
  1557. </td>
  1558. <td class="description last">amount to scale the dual quat by</td>
  1559. </tr>
  1560. </tbody>
  1561. </table>
  1562. <dl class="details">
  1563. <dt class="tag-source">Source:</dt>
  1564. <dd class="tag-source"><ul class="dummy"><li>
  1565. <a href="quat2.js.html">quat2.js</a>, <a href="quat2.js.html#line643">line 643</a>
  1566. </li></ul></dd>
  1567. </dl>
  1568. <h5>Returns:</h5>
  1569. <div class="param-desc">
  1570. out
  1571. </div>
  1572. <dl>
  1573. <dt>
  1574. Type
  1575. </dt>
  1576. <dd>
  1577. <span class="param-type">quat2</span>
  1578. </dd>
  1579. </dl>
  1580. <h4 class="name" id=".set"><span class="type-signature">(static) </span>set<span class="signature">(out, x1, y1, z1, w1, x2, y2, z2, w2)</span><span class="type-signature"> &rarr; {quat2}</span></h4>
  1581. <div class="description">
  1582. Set the components of a dual quat to the given values
  1583. </div>
  1584. <h5>Parameters:</h5>
  1585. <table class="params">
  1586. <thead>
  1587. <tr>
  1588. <th>Name</th>
  1589. <th>Type</th>
  1590. <th class="last">Description</th>
  1591. </tr>
  1592. </thead>
  1593. <tbody>
  1594. <tr>
  1595. <td class="name"><code>out</code></td>
  1596. <td class="type">
  1597. <span class="param-type">quat2</span>
  1598. </td>
  1599. <td class="description last">the receiving quaternion</td>
  1600. </tr>
  1601. <tr>
  1602. <td class="name"><code>x1</code></td>
  1603. <td class="type">
  1604. <span class="param-type">Number</span>
  1605. </td>
  1606. <td class="description last">X component</td>
  1607. </tr>
  1608. <tr>
  1609. <td class="name"><code>y1</code></td>
  1610. <td class="type">
  1611. <span class="param-type">Number</span>
  1612. </td>
  1613. <td class="description last">Y component</td>
  1614. </tr>
  1615. <tr>
  1616. <td class="name"><code>z1</code></td>
  1617. <td class="type">
  1618. <span class="param-type">Number</span>
  1619. </td>
  1620. <td class="description last">Z component</td>
  1621. </tr>
  1622. <tr>
  1623. <td class="name"><code>w1</code></td>
  1624. <td class="type">
  1625. <span class="param-type">Number</span>
  1626. </td>
  1627. <td class="description last">W component</td>
  1628. </tr>
  1629. <tr>
  1630. <td class="name"><code>x2</code></td>
  1631. <td class="type">
  1632. <span class="param-type">Number</span>
  1633. </td>
  1634. <td class="description last">X component</td>
  1635. </tr>
  1636. <tr>
  1637. <td class="name"><code>y2</code></td>
  1638. <td class="type">
  1639. <span class="param-type">Number</span>
  1640. </td>
  1641. <td class="description last">Y component</td>
  1642. </tr>
  1643. <tr>
  1644. <td class="name"><code>z2</code></td>
  1645. <td class="type">
  1646. <span class="param-type">Number</span>
  1647. </td>
  1648. <td class="description last">Z component</td>
  1649. </tr>
  1650. <tr>
  1651. <td class="name"><code>w2</code></td>
  1652. <td class="type">
  1653. <span class="param-type">Number</span>
  1654. </td>
  1655. <td class="description last">W component</td>
  1656. </tr>
  1657. </tbody>
  1658. </table>
  1659. <dl class="details">
  1660. <dt class="tag-source">Source:</dt>
  1661. <dd class="tag-source"><ul class="dummy"><li>
  1662. <a href="quat2.js.html">quat2.js</a>, <a href="quat2.js.html#line249">line 249</a>
  1663. </li></ul></dd>
  1664. </dl>
  1665. <h5>Returns:</h5>
  1666. <div class="param-desc">
  1667. out
  1668. </div>
  1669. <dl>
  1670. <dt>
  1671. Type
  1672. </dt>
  1673. <dd>
  1674. <span class="param-type">quat2</span>
  1675. </dd>
  1676. </dl>
  1677. <h4 class="name" id=".setDual"><span class="type-signature">(static) </span>setDual<span class="signature">(out, q)</span><span class="type-signature"> &rarr; {quat2}</span></h4>
  1678. <div class="description">
  1679. Set the dual component of a dual quat to the given quaternion
  1680. </div>
  1681. <h5>Parameters:</h5>
  1682. <table class="params">
  1683. <thead>
  1684. <tr>
  1685. <th>Name</th>
  1686. <th>Type</th>
  1687. <th class="last">Description</th>
  1688. </tr>
  1689. </thead>
  1690. <tbody>
  1691. <tr>
  1692. <td class="name"><code>out</code></td>
  1693. <td class="type">
  1694. <span class="param-type">quat2</span>
  1695. </td>
  1696. <td class="description last">the receiving quaternion</td>
  1697. </tr>
  1698. <tr>
  1699. <td class="name"><code>q</code></td>
  1700. <td class="type">
  1701. <span class="param-type">quat</span>
  1702. </td>
  1703. <td class="description last">a quaternion representing the dual part</td>
  1704. </tr>
  1705. </tbody>
  1706. </table>
  1707. <dl class="details">
  1708. <dt class="tag-source">Source:</dt>
  1709. <dd class="tag-source"><ul class="dummy"><li>
  1710. <a href="quat2.js.html">quat2.js</a>, <a href="quat2.js.html#line302">line 302</a>
  1711. </li></ul></dd>
  1712. </dl>
  1713. <h5>Returns:</h5>
  1714. <div class="param-desc">
  1715. out
  1716. </div>
  1717. <dl>
  1718. <dt>
  1719. Type
  1720. </dt>
  1721. <dd>
  1722. <span class="param-type">quat2</span>
  1723. </dd>
  1724. </dl>
  1725. <h4 class="name" id=".setReal"><span class="type-signature">(static) </span>setReal<span class="signature">(out, q)</span><span class="type-signature"> &rarr; {quat2}</span></h4>
  1726. <div class="description">
  1727. Set the real component of a dual quat to the given quaternion
  1728. </div>
  1729. <h5>Parameters:</h5>
  1730. <table class="params">
  1731. <thead>
  1732. <tr>
  1733. <th>Name</th>
  1734. <th>Type</th>
  1735. <th class="last">Description</th>
  1736. </tr>
  1737. </thead>
  1738. <tbody>
  1739. <tr>
  1740. <td class="name"><code>out</code></td>
  1741. <td class="type">
  1742. <span class="param-type">quat2</span>
  1743. </td>
  1744. <td class="description last">the receiving quaternion</td>
  1745. </tr>
  1746. <tr>
  1747. <td class="name"><code>q</code></td>
  1748. <td class="type">
  1749. <span class="param-type">quat</span>
  1750. </td>
  1751. <td class="description last">a quaternion representing the real part</td>
  1752. </tr>
  1753. </tbody>
  1754. </table>
  1755. <dl class="details">
  1756. <dt class="tag-source">Source:</dt>
  1757. <dd class="tag-source"><ul class="dummy"><li>
  1758. <a href="quat2.js.html">quat2.js</a>, <a href="quat2.js.html#line292">line 292</a>
  1759. </li></ul></dd>
  1760. </dl>
  1761. <h5>Returns:</h5>
  1762. <div class="param-desc">
  1763. out
  1764. </div>
  1765. <dl>
  1766. <dt>
  1767. Type
  1768. </dt>
  1769. <dd>
  1770. <span class="param-type">quat2</span>
  1771. </dd>
  1772. </dl>
  1773. <h4 class="name" id=".sqrLen"><span class="type-signature">(static) </span>sqrLen<span class="signature">()</span><span class="type-signature"></span></h4>
  1774. <div class="description">
  1775. Alias for quat2.squaredLength
  1776. </div>
  1777. <dl class="details">
  1778. <dt class="tag-source">Source:</dt>
  1779. <dd class="tag-source"><ul class="dummy"><li>
  1780. <a href="quat2.js.html">quat2.js</a>, <a href="quat2.js.html#line759">line 759</a>
  1781. </li></ul></dd>
  1782. </dl>
  1783. <h4 class="name" id=".squaredLength"><span class="type-signature">(static) </span>squaredLength<span class="signature">(a)</span><span class="type-signature"> &rarr; {Number}</span></h4>
  1784. <div class="description">
  1785. Calculates the squared length of a dual quat
  1786. </div>
  1787. <h5>Parameters:</h5>
  1788. <table class="params">
  1789. <thead>
  1790. <tr>
  1791. <th>Name</th>
  1792. <th>Type</th>
  1793. <th class="last">Description</th>
  1794. </tr>
  1795. </thead>
  1796. <tbody>
  1797. <tr>
  1798. <td class="name"><code>a</code></td>
  1799. <td class="type">
  1800. <span class="param-type">quat2</span>
  1801. </td>
  1802. <td class="description last">dual quat to calculate squared length of</td>
  1803. </tr>
  1804. </tbody>
  1805. </table>
  1806. <dl class="details">
  1807. <dt class="tag-source">Source:</dt>
  1808. <dd class="tag-source"><ul class="dummy"><li>
  1809. <a href="quat2.js.html">quat2.js</a>, <a href="quat2.js.html#line753">line 753</a>
  1810. </li></ul></dd>
  1811. </dl>
  1812. <h5>Returns:</h5>
  1813. <div class="param-desc">
  1814. squared length of a
  1815. </div>
  1816. <dl>
  1817. <dt>
  1818. Type
  1819. </dt>
  1820. <dd>
  1821. <span class="param-type">Number</span>
  1822. </dd>
  1823. </dl>
  1824. <h4 class="name" id=".str"><span class="type-signature">(static) </span>str<span class="signature">(a)</span><span class="type-signature"> &rarr; {String}</span></h4>
  1825. <div class="description">
  1826. Returns a string representation of a dual quatenion
  1827. </div>
  1828. <h5>Parameters:</h5>
  1829. <table class="params">
  1830. <thead>
  1831. <tr>
  1832. <th>Name</th>
  1833. <th>Type</th>
  1834. <th class="last">Description</th>
  1835. </tr>
  1836. </thead>
  1837. <tbody>
  1838. <tr>
  1839. <td class="name"><code>a</code></td>
  1840. <td class="type">
  1841. <span class="param-type">quat2</span>
  1842. </td>
  1843. <td class="description last">dual quaternion to represent as a string</td>
  1844. </tr>
  1845. </tbody>
  1846. </table>
  1847. <dl class="details">
  1848. <dt class="tag-source">Source:</dt>
  1849. <dd class="tag-source"><ul class="dummy"><li>
  1850. <a href="quat2.js.html">quat2.js</a>, <a href="quat2.js.html#line805">line 805</a>
  1851. </li></ul></dd>
  1852. </dl>
  1853. <h5>Returns:</h5>
  1854. <div class="param-desc">
  1855. string representation of the dual quat
  1856. </div>
  1857. <dl>
  1858. <dt>
  1859. Type
  1860. </dt>
  1861. <dd>
  1862. <span class="param-type">String</span>
  1863. </dd>
  1864. </dl>
  1865. <h4 class="name" id=".translate"><span class="type-signature">(static) </span>translate<span class="signature">(out, a, v)</span><span class="type-signature"> &rarr; {quat2}</span></h4>
  1866. <div class="description">
  1867. Translates a dual quat by the given vector
  1868. </div>
  1869. <h5>Parameters:</h5>
  1870. <table class="params">
  1871. <thead>
  1872. <tr>
  1873. <th>Name</th>
  1874. <th>Type</th>
  1875. <th class="last">Description</th>
  1876. </tr>
  1877. </thead>
  1878. <tbody>
  1879. <tr>
  1880. <td class="name"><code>out</code></td>
  1881. <td class="type">
  1882. <span class="param-type">quat2</span>
  1883. </td>
  1884. <td class="description last">the receiving dual quaternion</td>
  1885. </tr>
  1886. <tr>
  1887. <td class="name"><code>a</code></td>
  1888. <td class="type">
  1889. <span class="param-type">quat2</span>
  1890. </td>
  1891. <td class="description last">the dual quaternion to translate</td>
  1892. </tr>
  1893. <tr>
  1894. <td class="name"><code>v</code></td>
  1895. <td class="type">
  1896. <span class="param-type">vec3</span>
  1897. </td>
  1898. <td class="description last">vector to translate by</td>
  1899. </tr>
  1900. </tbody>
  1901. </table>
  1902. <dl class="details">
  1903. <dt class="tag-source">Source:</dt>
  1904. <dd class="tag-source"><ul class="dummy"><li>
  1905. <a href="quat2.js.html">quat2.js</a>, <a href="quat2.js.html#line339">line 339</a>
  1906. </li></ul></dd>
  1907. </dl>
  1908. <h5>Returns:</h5>
  1909. <div class="param-desc">
  1910. out
  1911. </div>
  1912. <dl>
  1913. <dt>
  1914. Type
  1915. </dt>
  1916. <dd>
  1917. <span class="param-type">quat2</span>
  1918. </dd>
  1919. </dl>
  1920. </article>
  1921. </section>
  1922. </div>
  1923. <nav>
  1924. <h2><a href="index.html">Home</a></h2><h3>Modules</h3><ul><li><a href="module-glMatrix.html">glMatrix</a></li><li><a href="module-mat2.html">mat2</a></li><li><a href="module-mat2d.html">mat2d</a></li><li><a href="module-mat3.html">mat3</a></li><li><a href="module-mat4.html">mat4</a></li><li><a href="module-quat.html">quat</a></li><li><a href="module-quat2.html">quat2</a></li><li><a href="module-vec2.html">vec2</a></li><li><a href="module-vec3.html">vec3</a></li><li><a href="module-vec4.html">vec4</a></li></ul>
  1925. </nav>
  1926. <br class="clear">
  1927. <footer>
  1928. Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.5.5</a> on Fri Jul 13 2018 11:51:34 GMT+0200 (W. Europe Daylight Time)
  1929. </footer>
  1930. <script> prettyPrint(); </script>
  1931. <script src="scripts/linenumber.js"> </script>
  1932. </body>
  1933. </html>