Vector2.html 44 KB

12345678910111213141516171819202122232425262728293031323334353637383940414243444546474849505152535455565758596061626364656667686970717273747576777879808182838485868788899091929394959697989910010110210310410510610710810911011111211311411511611711811912012112212312412512612712812913013113213313413513613713813914014114214314414514614714814915015115215315415515615715815916016116216316416516616716816917017117217317417517617717817918018118218318418518618718818919019119219319419519619719819920020120220320420520620720820921021121221321421521621721821922022122222322422522622722822923023123223323423523623723823924024124224324424524624724824925025125225325425525625725825926026126226326426526626726826927027127227327427527627727827928028128228328428528628728828929029129229329429529629729829930030130230330430530630730830931031131231331431531631731831932032132232332432532632732832933033133233333433533633733833934034134234334434534634734834935035135235335435535635735835936036136236336436536636736836937037137237337437537637737837938038138238338438538638738838939039139239339439539639739839940040140240340440540640740840941041141241341441541641741841942042142242342442542642742842943043143243343443543643743843944044144244344444544644744844945045145245345445545645745845946046146246346446546646746846947047147247347447547647747847948048148248348448548648748848949049149249349449549649749849950050150250350450550650750850951051151251351451551651751851952052152252352452552652752852953053153253353453553653753853954054154254354454554654754854955055155255355455555655755855956056156256356456556656756856957057157257357457557657757857958058158258358458558658758858959059159259359459559659759859960060160260360460560660760860961061161261361461561661761861962062162262362462562662762862963063163263363463563663763863964064164264364464564664764864965065165265365465565665765865966066166266366466566666766866967067167267367467567667767867968068168268368468568668768868969069169269369469569669769869970070170270370470570670770870971071171271371471571671771871972072172272372472572672772872973073173273373473573673773873974074174274374474574674774874975075175275375475575675775875976076176276376476576676776876977077177277377477577677777877978078178278378478578678778878979079179279379479579679779879980080180280380480580680780880981081181281381481581681781881982082182282382482582682782882983083183283383483583683783883984084184284384484584684784884985085185285385485585685785885986086186286386486586686786886987087187287387487587687787887988088188288388488588688788888989089189289389489589689789889990090190290390490590690790890991091191291391491591691791891992092192292392492592692792892993093193293393493593693793893994094194294394494594694794894995095195295395495595695795895996096196296396496596696796896997097197297397497597697797897998098198298398498598698798898999099199299399499599699799899910001001100210031004100510061007100810091010101110121013101410151016101710181019102010211022102310241025102610271028102910301031103210331034103510361037103810391040104110421043104410451046104710481049105010511052105310541055105610571058105910601061106210631064106510661067106810691070107110721073107410751076107710781079108010811082108310841085108610871088108910901091109210931094109510961097109810991100110111021103110411051106110711081109111011111112111311141115111611171118111911201121112211231124112511261127112811291130113111321133113411351136113711381139114011411142114311441145114611471148114911501151115211531154115511561157115811591160116111621163116411651166116711681169117011711172117311741175117611771178117911801181118211831184118511861187118811891190119111921193119411951196119711981199120012011202120312041205120612071208120912101211121212131214121512161217121812191220122112221223122412251226122712281229123012311232123312341235123612371238123912401241124212431244124512461247124812491250125112521253125412551256125712581259126012611262126312641265126612671268126912701271127212731274127512761277127812791280128112821283128412851286128712881289129012911292129312941295129612971298129913001301130213031304130513061307130813091310131113121313131413151316131713181319132013211322132313241325132613271328132913301331133213331334133513361337133813391340134113421343134413451346134713481349135013511352135313541355135613571358135913601361136213631364136513661367136813691370137113721373137413751376137713781379138013811382138313841385138613871388138913901391139213931394139513961397139813991400140114021403140414051406140714081409141014111412141314141415141614171418141914201421142214231424142514261427142814291430143114321433143414351436143714381439144014411442144314441445144614471448144914501451145214531454145514561457145814591460146114621463146414651466146714681469147014711472147314741475147614771478147914801481148214831484148514861487148814891490149114921493149414951496149714981499150015011502150315041505150615071508150915101511151215131514151515161517151815191520152115221523152415251526152715281529153015311532153315341535153615371538153915401541154215431544154515461547154815491550155115521553155415551556155715581559156015611562156315641565156615671568156915701571157215731574157515761577157815791580158115821583158415851586158715881589159015911592159315941595159615971598159916001601160216031604160516061607160816091610161116121613161416151616161716181619162016211622162316241625162616271628162916301631163216331634163516361637163816391640164116421643164416451646164716481649165016511652165316541655165616571658165916601661166216631664166516661667166816691670167116721673167416751676167716781679168016811682168316841685168616871688168916901691169216931694169516961697169816991700170117021703170417051706170717081709171017111712171317141715171617171718171917201721172217231724172517261727172817291730173117321733173417351736173717381739174017411742174317441745174617471748174917501751175217531754175517561757175817591760176117621763176417651766176717681769177017711772177317741775177617771778177917801781178217831784178517861787178817891790179117921793179417951796179717981799180018011802180318041805180618071808180918101811181218131814181518161817181818191820182118221823182418251826182718281829183018311832183318341835183618371838183918401841184218431844184518461847184818491850185118521853185418551856185718581859186018611862186318641865186618671868186918701871187218731874187518761877187818791880188118821883188418851886188718881889189018911892189318941895189618971898189919001901190219031904190519061907190819091910191119121913191419151916191719181919192019211922192319241925192619271928192919301931193219331934193519361937193819391940194119421943194419451946194719481949195019511952195319541955195619571958195919601961196219631964196519661967196819691970197119721973197419751976197719781979198019811982198319841985198619871988198919901991199219931994199519961997199819992000200120022003200420052006200720082009201020112012201320142015201620172018201920202021202220232024202520262027202820292030203120322033203420352036203720382039204020412042204320442045204620472048204920502051205220532054205520562057205820592060206120622063206420652066206720682069207020712072207320742075207620772078207920802081208220832084208520862087208820892090209120922093209420952096209720982099210021012102210321042105210621072108210921102111211221132114211521162117211821192120212121222123212421252126212721282129213021312132213321342135213621372138213921402141214221432144214521462147214821492150215121522153215421552156215721582159216021612162216321642165216621672168216921702171217221732174217521762177217821792180218121822183218421852186218721882189219021912192219321942195219621972198219922002201220222032204220522062207220822092210221122122213221422152216221722182219222022212222222322242225222622272228222922302231223222332234223522362237223822392240224122422243224422452246224722482249225022512252225322542255225622572258225922602261226222632264226522662267226822692270227122722273227422752276227722782279228022812282228322842285228622872288228922902291229222932294229522962297229822992300230123022303230423052306230723082309231023112312231323142315231623172318231923202321232223232324232523262327232823292330233123322333233423352336233723382339234023412342234323442345234623472348234923502351235223532354235523562357235823592360236123622363236423652366236723682369237023712372237323742375237623772378237923802381238223832384238523862387238823892390239123922393239423952396239723982399240024012402240324042405240624072408240924102411241224132414241524162417241824192420242124222423242424252426242724282429243024312432243324342435243624372438243924402441244224432444244524462447244824492450245124522453245424552456245724582459246024612462246324642465246624672468246924702471247224732474247524762477247824792480248124822483248424852486248724882489249024912492249324942495249624972498249925002501250225032504250525062507250825092510251125122513251425152516251725182519252025212522252325242525252625272528252925302531253225332534253525362537253825392540254125422543254425452546254725482549255025512552255325542555255625572558255925602561256225632564256525662567256825692570257125722573257425752576257725782579258025812582258325842585258625872588258925902591259225932594259525962597259825992600260126022603260426052606260726082609261026112612261326142615261626172618261926202621262226232624262526262627262826292630263126322633263426352636263726382639264026412642264326442645264626472648264926502651265226532654265526562657265826592660266126622663266426652666266726682669267026712672267326742675267626772678267926802681268226832684268526862687268826892690269126922693269426952696269726982699270027012702270327042705270627072708270927102711271227132714271527162717271827192720272127222723272427252726272727282729273027312732273327342735273627372738273927402741274227432744274527462747274827492750275127522753275427552756275727582759276027612762276327642765276627672768276927702771277227732774277527762777277827792780278127822783278427852786278727882789279027912792279327942795279627972798279928002801280228032804280528062807280828092810281128122813281428152816281728182819282028212822282328242825282628272828282928302831283228332834283528362837283828392840284128422843284428452846284728482849285028512852285328542855285628572858285928602861286228632864286528662867286828692870287128722873287428752876287728782879288028812882288328842885288628872888288928902891289228932894289528962897289828992900290129022903290429052906290729082909291029112912291329142915291629172918291929202921292229232924292529262927292829292930293129322933293429352936293729382939294029412942294329442945294629472948294929502951295229532954295529562957295829592960296129622963296429652966296729682969297029712972297329742975297629772978297929802981298229832984298529862987298829892990299129922993299429952996299729982999300030013002300330043005300630073008300930103011301230133014301530163017301830193020302130223023302430253026302730283029303030313032303330343035303630373038303930403041304230433044304530463047304830493050305130523053305430553056305730583059306030613062306330643065306630673068306930703071307230733074307530763077307830793080308130823083308430853086308730883089309030913092309330943095309630973098309931003101310231033104310531063107310831093110311131123113311431153116311731183119312031213122312331243125312631273128312931303131313231333134313531363137313831393140314131423143314431453146314731483149315031513152315331543155315631573158315931603161316231633164316531663167316831693170317131723173317431753176317731783179318031813182318331843185318631873188318931903191319231933194319531963197319831993200320132023203320432053206320732083209321032113212321332143215321632173218321932203221322232233224322532263227322832293230323132323233323432353236323732383239324032413242324332443245324632473248324932503251325232533254325532563257325832593260326132623263326432653266326732683269327032713272327332743275327632773278327932803281328232833284328532863287328832893290329132923293329432953296329732983299330033013302330333043305330633073308330933103311331233133314331533163317331833193320332133223323332433253326332733283329333033313332333333343335333633373338333933403341334233433344334533463347334833493350335133523353335433553356335733583359336033613362336333643365336633673368336933703371337233733374337533763377337833793380338133823383338433853386338733883389339033913392339333943395339633973398339934003401340234033404340534063407340834093410341134123413341434153416341734183419342034213422342334243425342634273428342934303431343234333434343534363437343834393440344134423443344434453446344734483449345034513452345334543455345634573458345934603461346234633464346534663467346834693470347134723473347434753476347734783479348034813482348334843485348634873488348934903491349234933494349534963497349834993500350135023503350435053506350735083509351035113512351335143515351635173518351935203521352235233524352535263527352835293530353135323533353435353536353735383539354035413542354335443545354635473548354935503551355235533554355535563557355835593560356135623563356435653566356735683569357035713572357335743575357635773578357935803581358235833584358535863587358835893590359135923593359435953596359735983599360036013602360336043605360636073608360936103611361236133614361536163617361836193620362136223623362436253626362736283629363036313632363336343635363636373638363936403641364236433644364536463647364836493650365136523653365436553656365736583659366036613662366336643665366636673668366936703671367236733674367536763677367836793680368136823683368436853686368736883689369036913692369336943695369636973698369937003701370237033704370537063707370837093710371137123713371437153716371737183719372037213722372337243725372637273728372937303731373237333734373537363737373837393740374137423743374437453746374737483749375037513752375337543755375637573758375937603761376237633764376537663767376837693770377137723773377437753776377737783779378037813782378337843785378637873788378937903791379237933794379537963797379837993800380138023803380438053806380738083809381038113812381338143815381638173818381938203821382238233824382538263827382838293830383138323833383438353836383738383839384038413842384338443845384638473848384938503851385238533854385538563857385838593860386138623863386438653866386738683869387038713872387338743875387638773878387938803881388238833884388538863887388838893890389138923893389438953896389738983899390039013902390339043905390639073908390939103911391239133914391539163917391839193920392139223923392439253926392739283929393039313932393339343935393639373938393939403941394239433944394539463947394839493950395139523953395439553956395739583959396039613962396339643965396639673968396939703971397239733974397539763977397839793980398139823983398439853986398739883989399039913992399339943995399639973998399940004001400240034004400540064007400840094010401140124013401440154016401740184019402040214022402340244025402640274028402940304031403240334034403540364037403840394040404140424043404440454046404740484049405040514052405340544055405640574058405940604061406240634064406540664067406840694070407140724073407440754076407740784079408040814082408340844085408640874088408940904091409240934094409540964097409840994100410141024103410441054106410741084109411041114112411341144115411641174118411941204121412241234124412541264127412841294130413141324133413441354136413741384139414041414142414341444145414641474148414941504151415241534154415541564157415841594160416141624163416441654166416741684169417041714172417341744175417641774178417941804181418241834184418541864187418841894190419141924193419441954196419741984199420042014202420342044205420642074208420942104211421242134214421542164217421842194220422142224223422442254226422742284229423042314232423342344235423642374238423942404241424242434244424542464247424842494250425142524253425442554256425742584259426042614262426342644265426642674268426942704271427242734274427542764277427842794280428142824283428442854286428742884289429042914292429342944295429642974298429943004301430243034304430543064307430843094310431143124313431443154316431743184319432043214322432343244325432643274328432943304331433243334334433543364337433843394340434143424343434443454346434743484349435043514352435343544355435643574358435943604361436243634364436543664367436843694370437143724373437443754376437743784379438043814382438343844385438643874388438943904391439243934394439543964397439843994400440144024403440444054406440744084409441044114412441344144415441644174418441944204421442244234424442544264427442844294430443144324433443444354436443744384439444044414442444344444445444644474448444944504451445244534454445544564457445844594460446144624463446444654466446744684469447044714472447344744475447644774478447944804481448244834484448544864487448844894490449144924493449444954496449744984499450045014502450345044505450645074508450945104511451245134514451545164517451845194520452145224523452445254526452745284529453045314532453345344535453645374538453945404541454245434544454545464547454845494550455145524553455445554556455745584559456045614562456345644565456645674568456945704571457245734574457545764577457845794580458145824583458445854586458745884589459045914592459345944595459645974598459946004601460246034604460546064607460846094610461146124613461446154616461746184619462046214622462346244625462646274628462946304631463246334634463546364637463846394640464146424643464446454646464746484649465046514652465346544655465646574658465946604661466246634664466546664667466846694670467146724673467446754676467746784679468046814682468346844685468646874688
  1. <!DOCTYPE html>
  2. <html lang="en">
  3. <head>
  4. <meta charset="utf-8">
  5. <title>JSDoc: Class: Vector2</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">Class: Vector2</h1>
  17. <section>
  18. <header>
  19. <h2><span class="attribs"><span class="type-signature"></span></span>Vector2<span class="signature">(x, y)</span><span class="type-signature"></span></h2>
  20. </header>
  21. <article>
  22. <div class="container-overview">
  23. <h4 class="name" id="Vector2"><span class="type-signature"></span>new Vector2<span class="signature">(x, y)</span><span class="type-signature"></span></h4>
  24. <div class="description">
  25. Class representing a 2D vector. A 2D vector is an ordered pair of numbers (labeled x and y), which can be used to represent points in space, directions, etc.
  26. </div>
  27. <h5>Parameters:</h5>
  28. <table class="params">
  29. <thead>
  30. <tr>
  31. <th>Name</th>
  32. <th>Type</th>
  33. <th class="last">Description</th>
  34. </tr>
  35. </thead>
  36. <tbody>
  37. <tr>
  38. <td class="name"><code>x</code></td>
  39. <td class="type">
  40. <span class="param-type">number</span>
  41. </td>
  42. <td class="description last"></td>
  43. </tr>
  44. <tr>
  45. <td class="name"><code>y</code></td>
  46. <td class="type">
  47. <span class="param-type">number</span>
  48. </td>
  49. <td class="description last"></td>
  50. </tr>
  51. </tbody>
  52. </table>
  53. <dl class="details">
  54. <dt class="tag-source">Source:</dt>
  55. <dd class="tag-source"><ul class="dummy"><li>
  56. <a href="math_Vector2.js.html">math/Vector2.js</a>, <a href="math_Vector2.js.html#line11">line 11</a>
  57. </li></ul></dd>
  58. </dl>
  59. </div>
  60. <h3 class="subsection-title">Methods</h3>
  61. <h4 class="name" id="add"><span class="type-signature"></span>add<span class="signature">(v)</span><span class="type-signature"></span></h4>
  62. <div class="description">
  63. Add the content of another vector to this one.
  64. </div>
  65. <h5>Parameters:</h5>
  66. <table class="params">
  67. <thead>
  68. <tr>
  69. <th>Name</th>
  70. <th>Type</th>
  71. <th class="last">Description</th>
  72. </tr>
  73. </thead>
  74. <tbody>
  75. <tr>
  76. <td class="name"><code>v</code></td>
  77. <td class="type">
  78. <span class="param-type"><a href="Vector2.html">Vector2</a></span>
  79. </td>
  80. <td class="description last"></td>
  81. </tr>
  82. </tbody>
  83. </table>
  84. <dl class="details">
  85. <dt class="tag-source">Source:</dt>
  86. <dd class="tag-source"><ul class="dummy"><li>
  87. <a href="math_Vector2.js.html">math/Vector2.js</a>, <a href="math_Vector2.js.html#line62">line 62</a>
  88. </li></ul></dd>
  89. </dl>
  90. <h4 class="name" id="addScalar"><span class="type-signature"></span>addScalar<span class="signature">(s)</span><span class="type-signature"></span></h4>
  91. <div class="description">
  92. Add a scalar value to booth vector components.
  93. </div>
  94. <h5>Parameters:</h5>
  95. <table class="params">
  96. <thead>
  97. <tr>
  98. <th>Name</th>
  99. <th>Type</th>
  100. <th class="last">Description</th>
  101. </tr>
  102. </thead>
  103. <tbody>
  104. <tr>
  105. <td class="name"><code>s</code></td>
  106. <td class="type">
  107. <span class="param-type">number</span>
  108. </td>
  109. <td class="description last"></td>
  110. </tr>
  111. </tbody>
  112. </table>
  113. <dl class="details">
  114. <dt class="tag-source">Source:</dt>
  115. <dd class="tag-source"><ul class="dummy"><li>
  116. <a href="math_Vector2.js.html">math/Vector2.js</a>, <a href="math_Vector2.js.html#line73">line 73</a>
  117. </li></ul></dd>
  118. </dl>
  119. <h4 class="name" id="addScaledVector"><span class="type-signature"></span>addScaledVector<span class="signature">(v, s)</span><span class="type-signature"></span></h4>
  120. <div class="description">
  121. Scale a vector components and add the result to this vector.
  122. </div>
  123. <h5>Parameters:</h5>
  124. <table class="params">
  125. <thead>
  126. <tr>
  127. <th>Name</th>
  128. <th>Type</th>
  129. <th class="last">Description</th>
  130. </tr>
  131. </thead>
  132. <tbody>
  133. <tr>
  134. <td class="name"><code>v</code></td>
  135. <td class="type">
  136. <span class="param-type"><a href="Vector2.html">Vector2</a></span>
  137. </td>
  138. <td class="description last"></td>
  139. </tr>
  140. <tr>
  141. <td class="name"><code>s</code></td>
  142. <td class="type">
  143. <span class="param-type">number</span>
  144. </td>
  145. <td class="description last"></td>
  146. </tr>
  147. </tbody>
  148. </table>
  149. <dl class="details">
  150. <dt class="tag-source">Source:</dt>
  151. <dd class="tag-source"><ul class="dummy"><li>
  152. <a href="math_Vector2.js.html">math/Vector2.js</a>, <a href="math_Vector2.js.html#line97">line 97</a>
  153. </li></ul></dd>
  154. </dl>
  155. <h4 class="name" id="addVectors"><span class="type-signature"></span>addVectors<span class="signature">(a, b)</span><span class="type-signature"></span></h4>
  156. <div class="description">
  157. Add two vectors and store the result in this vector.
  158. </div>
  159. <h5>Parameters:</h5>
  160. <table class="params">
  161. <thead>
  162. <tr>
  163. <th>Name</th>
  164. <th>Type</th>
  165. <th class="last">Description</th>
  166. </tr>
  167. </thead>
  168. <tbody>
  169. <tr>
  170. <td class="name"><code>a</code></td>
  171. <td class="type">
  172. <span class="param-type"><a href="Vector2.html">Vector2</a></span>
  173. </td>
  174. <td class="description last"></td>
  175. </tr>
  176. <tr>
  177. <td class="name"><code>b</code></td>
  178. <td class="type">
  179. <span class="param-type"><a href="Vector2.html">Vector2</a></span>
  180. </td>
  181. <td class="description last"></td>
  182. </tr>
  183. </tbody>
  184. </table>
  185. <dl class="details">
  186. <dt class="tag-source">Source:</dt>
  187. <dd class="tag-source"><ul class="dummy"><li>
  188. <a href="math_Vector2.js.html">math/Vector2.js</a>, <a href="math_Vector2.js.html#line85">line 85</a>
  189. </li></ul></dd>
  190. </dl>
  191. <h4 class="name" id="angle"><span class="type-signature"></span>angle<span class="signature">()</span><span class="type-signature"></span></h4>
  192. <div class="description">
  193. Computes the angle in radians with respect to the positive x-axis
  194. </div>
  195. <dl class="details">
  196. <dt class="tag-source">Source:</dt>
  197. <dd class="tag-source"><ul class="dummy"><li>
  198. <a href="math_Vector2.js.html">math/Vector2.js</a>, <a href="math_Vector2.js.html#line324">line 324</a>
  199. </li></ul></dd>
  200. </dl>
  201. <h4 class="name" id="ceil"><span class="type-signature"></span>ceil<span class="signature">()</span><span class="type-signature"></span></h4>
  202. <div class="description">
  203. Round the vector coordinates to integer by ceiling to the bigger integer.
  204. </div>
  205. <dl class="details">
  206. <dt class="tag-source">Source:</dt>
  207. <dd class="tag-source"><ul class="dummy"><li>
  208. <a href="math_Vector2.js.html">math/Vector2.js</a>, <a href="math_Vector2.js.html#line239">line 239</a>
  209. </li></ul></dd>
  210. </dl>
  211. <h4 class="name" id="clone"><span class="type-signature"></span>clone<span class="signature">()</span><span class="type-signature"></span></h4>
  212. <div class="description">
  213. Create a clone of this vector object.
  214. </div>
  215. <dl class="details">
  216. <dt class="tag-source">Source:</dt>
  217. <dd class="tag-source"><ul class="dummy"><li>
  218. <a href="math_Vector2.js.html">math/Vector2.js</a>, <a href="math_Vector2.js.html#line41">line 41</a>
  219. </li></ul></dd>
  220. </dl>
  221. <h4 class="name" id="copy"><span class="type-signature"></span>copy<span class="signature">(v)</span><span class="type-signature"></span></h4>
  222. <div class="description">
  223. Copy the content of another vector into this one.
  224. </div>
  225. <h5>Parameters:</h5>
  226. <table class="params">
  227. <thead>
  228. <tr>
  229. <th>Name</th>
  230. <th>Type</th>
  231. <th class="last">Description</th>
  232. </tr>
  233. </thead>
  234. <tbody>
  235. <tr>
  236. <td class="name"><code>v</code></td>
  237. <td class="type">
  238. <span class="param-type"><a href="Vector2.html">Vector2</a></span>
  239. </td>
  240. <td class="description last"></td>
  241. </tr>
  242. </tbody>
  243. </table>
  244. <dl class="details">
  245. <dt class="tag-source">Source:</dt>
  246. <dd class="tag-source"><ul class="dummy"><li>
  247. <a href="math_Vector2.js.html">math/Vector2.js</a>, <a href="math_Vector2.js.html#line51">line 51</a>
  248. </li></ul></dd>
  249. </dl>
  250. <h4 class="name" id="cross"><span class="type-signature"></span>cross<span class="signature">(vector)</span><span class="type-signature"> &rarr; {number}</span></h4>
  251. <div class="description">
  252. Cross multiplication between this vector and another vector.
  253. </div>
  254. <h5>Parameters:</h5>
  255. <table class="params">
  256. <thead>
  257. <tr>
  258. <th>Name</th>
  259. <th>Type</th>
  260. <th class="last">Description</th>
  261. </tr>
  262. </thead>
  263. <tbody>
  264. <tr>
  265. <td class="name"><code>vector</code></td>
  266. <td class="type">
  267. <span class="param-type"><a href="Vector2.html">Vector2</a></span>
  268. </td>
  269. <td class="description last"></td>
  270. </tr>
  271. </tbody>
  272. </table>
  273. <dl class="details">
  274. <dt class="tag-source">Source:</dt>
  275. <dd class="tag-source"><ul class="dummy"><li>
  276. <a href="math_Vector2.js.html">math/Vector2.js</a>, <a href="math_Vector2.js.html#line282">line 282</a>
  277. </li></ul></dd>
  278. </dl>
  279. <h5>Returns:</h5>
  280. <div class="param-desc">
  281. Result of the cross multiplication.
  282. </div>
  283. <dl>
  284. <dt>
  285. Type
  286. </dt>
  287. <dd>
  288. <span class="param-type">number</span>
  289. </dd>
  290. </dl>
  291. <h4 class="name" id="distanceTo"><span class="type-signature"></span>distanceTo<span class="signature">()</span><span class="type-signature"></span></h4>
  292. <div class="description">
  293. Distance between two vector positions.
  294. </div>
  295. <dl class="details">
  296. <dt class="tag-source">Source:</dt>
  297. <dd class="tag-source"><ul class="dummy"><li>
  298. <a href="math_Vector2.js.html">math/Vector2.js</a>, <a href="math_Vector2.js.html#line339">line 339</a>
  299. </li></ul></dd>
  300. </dl>
  301. <h4 class="name" id="distanceToSquared"><span class="type-signature"></span>distanceToSquared<span class="signature">()</span><span class="type-signature"></span></h4>
  302. <div class="description">
  303. Distance between two vector positions squared. Faster for comparisons.
  304. </div>
  305. <dl class="details">
  306. <dt class="tag-source">Source:</dt>
  307. <dd class="tag-source"><ul class="dummy"><li>
  308. <a href="math_Vector2.js.html">math/Vector2.js</a>, <a href="math_Vector2.js.html#line349">line 349</a>
  309. </li></ul></dd>
  310. </dl>
  311. <h4 class="name" id="divide"><span class="type-signature"></span>divide<span class="signature">(v)</span><span class="type-signature"></span></h4>
  312. <div class="description">
  313. Divide the content of another vector from this one.
  314. </div>
  315. <h5>Parameters:</h5>
  316. <table class="params">
  317. <thead>
  318. <tr>
  319. <th>Name</th>
  320. <th>Type</th>
  321. <th class="last">Description</th>
  322. </tr>
  323. </thead>
  324. <tbody>
  325. <tr>
  326. <td class="name"><code>v</code></td>
  327. <td class="type">
  328. <span class="param-type"><a href="Vector2.html">Vector2</a></span>
  329. </td>
  330. <td class="description last"></td>
  331. </tr>
  332. </tbody>
  333. </table>
  334. <dl class="details">
  335. <dt class="tag-source">Source:</dt>
  336. <dd class="tag-source"><ul class="dummy"><li>
  337. <a href="math_Vector2.js.html">math/Vector2.js</a>, <a href="math_Vector2.js.html#line165">line 165</a>
  338. </li></ul></dd>
  339. </dl>
  340. <h4 class="name" id="divideScalar"><span class="type-signature"></span>divideScalar<span class="signature">(s)</span><span class="type-signature"></span></h4>
  341. <div class="description">
  342. Divide a scalar value by booth vector components.
  343. </div>
  344. <h5>Parameters:</h5>
  345. <table class="params">
  346. <thead>
  347. <tr>
  348. <th>Name</th>
  349. <th>Type</th>
  350. <th class="last">Description</th>
  351. </tr>
  352. </thead>
  353. <tbody>
  354. <tr>
  355. <td class="name"><code>s</code></td>
  356. <td class="type">
  357. <span class="param-type">number</span>
  358. </td>
  359. <td class="description last"></td>
  360. </tr>
  361. </tbody>
  362. </table>
  363. <dl class="details">
  364. <dt class="tag-source">Source:</dt>
  365. <dd class="tag-source"><ul class="dummy"><li>
  366. <a href="math_Vector2.js.html">math/Vector2.js</a>, <a href="math_Vector2.js.html#line176">line 176</a>
  367. </li></ul></dd>
  368. </dl>
  369. <h4 class="name" id="dot"><span class="type-signature"></span>dot<span class="signature">(vector)</span><span class="type-signature"> &rarr; {number}</span></h4>
  370. <div class="description">
  371. Dot multiplication between this vector and another vector.
  372. </div>
  373. <h5>Parameters:</h5>
  374. <table class="params">
  375. <thead>
  376. <tr>
  377. <th>Name</th>
  378. <th>Type</th>
  379. <th class="last">Description</th>
  380. </tr>
  381. </thead>
  382. <tbody>
  383. <tr>
  384. <td class="name"><code>vector</code></td>
  385. <td class="type">
  386. <span class="param-type"><a href="Vector2.html">Vector2</a></span>
  387. </td>
  388. <td class="description last"></td>
  389. </tr>
  390. </tbody>
  391. </table>
  392. <dl class="details">
  393. <dt class="tag-source">Source:</dt>
  394. <dd class="tag-source"><ul class="dummy"><li>
  395. <a href="math_Vector2.js.html">math/Vector2.js</a>, <a href="math_Vector2.js.html#line271">line 271</a>
  396. </li></ul></dd>
  397. </dl>
  398. <h5>Returns:</h5>
  399. <div class="param-desc">
  400. Result of the dot multiplication.
  401. </div>
  402. <dl>
  403. <dt>
  404. Type
  405. </dt>
  406. <dd>
  407. <span class="param-type">number</span>
  408. </dd>
  409. </dl>
  410. <h4 class="name" id="equals"><span class="type-signature"></span>equals<span class="signature">(v)</span><span class="type-signature"></span></h4>
  411. <div class="description">
  412. Check if two vectors are equal.
  413. </div>
  414. <h5>Parameters:</h5>
  415. <table class="params">
  416. <thead>
  417. <tr>
  418. <th>Name</th>
  419. <th>Type</th>
  420. <th class="last">Description</th>
  421. </tr>
  422. </thead>
  423. <tbody>
  424. <tr>
  425. <td class="name"><code>v</code></td>
  426. <td class="type">
  427. <span class="param-type"><a href="Vector2.html">Vector2</a></span>
  428. </td>
  429. <td class="description last"></td>
  430. </tr>
  431. </tbody>
  432. </table>
  433. <dl class="details">
  434. <dt class="tag-source">Source:</dt>
  435. <dd class="tag-source"><ul class="dummy"><li>
  436. <a href="math_Vector2.js.html">math/Vector2.js</a>, <a href="math_Vector2.js.html#line389">line 389</a>
  437. </li></ul></dd>
  438. </dl>
  439. <h4 class="name" id="floor"><span class="type-signature"></span>floor<span class="signature">()</span><span class="type-signature"></span></h4>
  440. <div class="description">
  441. Round the vector coordinates to integer by flooring to the smaller integer.
  442. </div>
  443. <dl class="details">
  444. <dt class="tag-source">Source:</dt>
  445. <dd class="tag-source"><ul class="dummy"><li>
  446. <a href="math_Vector2.js.html">math/Vector2.js</a>, <a href="math_Vector2.js.html#line230">line 230</a>
  447. </li></ul></dd>
  448. </dl>
  449. <h4 class="name" id="fromArray"><span class="type-signature"></span>fromArray<span class="signature">(array, offset<span class="signature-attributes">opt</span>)</span><span class="type-signature"></span></h4>
  450. <div class="description">
  451. Set vector value from array with a offset.
  452. </div>
  453. <h5>Parameters:</h5>
  454. <table class="params">
  455. <thead>
  456. <tr>
  457. <th>Name</th>
  458. <th>Type</th>
  459. <th>Attributes</th>
  460. <th class="last">Description</th>
  461. </tr>
  462. </thead>
  463. <tbody>
  464. <tr>
  465. <td class="name"><code>array</code></td>
  466. <td class="type">
  467. <span class="param-type">array</span>
  468. </td>
  469. <td class="attributes">
  470. </td>
  471. <td class="description last"></td>
  472. </tr>
  473. <tr>
  474. <td class="name"><code>offset</code></td>
  475. <td class="type">
  476. <span class="param-type">number</span>
  477. </td>
  478. <td class="attributes">
  479. &lt;optional><br>
  480. </td>
  481. <td class="description last"></td>
  482. </tr>
  483. </tbody>
  484. </table>
  485. <dl class="details">
  486. <dt class="tag-source">Source:</dt>
  487. <dd class="tag-source"><ul class="dummy"><li>
  488. <a href="math_Vector2.js.html">math/Vector2.js</a>, <a href="math_Vector2.js.html#line400">line 400</a>
  489. </li></ul></dd>
  490. </dl>
  491. <h4 class="name" id="length"><span class="type-signature"></span>length<span class="signature">()</span><span class="type-signature"></span></h4>
  492. <div class="description">
  493. Length of the vector.
  494. </div>
  495. <dl class="details">
  496. <dt class="tag-source">Source:</dt>
  497. <dd class="tag-source"><ul class="dummy"><li>
  498. <a href="math_Vector2.js.html">math/Vector2.js</a>, <a href="math_Vector2.js.html#line300">line 300</a>
  499. </li></ul></dd>
  500. </dl>
  501. <h4 class="name" id="lengthSq"><span class="type-signature"></span>lengthSq<span class="signature">()</span><span class="type-signature"></span></h4>
  502. <div class="description">
  503. Squared length of the vector. Faster for comparions.
  504. </div>
  505. <dl class="details">
  506. <dt class="tag-source">Source:</dt>
  507. <dd class="tag-source"><ul class="dummy"><li>
  508. <a href="math_Vector2.js.html">math/Vector2.js</a>, <a href="math_Vector2.js.html#line292">line 292</a>
  509. </li></ul></dd>
  510. </dl>
  511. <h4 class="name" id="manhattanDistanceTo"><span class="type-signature"></span>manhattanDistanceTo<span class="signature">()</span><span class="type-signature"></span></h4>
  512. <div class="description">
  513. Manhattan distance between two vector positions.
  514. </div>
  515. <dl class="details">
  516. <dt class="tag-source">Source:</dt>
  517. <dd class="tag-source"><ul class="dummy"><li>
  518. <a href="math_Vector2.js.html">math/Vector2.js</a>, <a href="math_Vector2.js.html#line360">line 360</a>
  519. </li></ul></dd>
  520. </dl>
  521. <h4 class="name" id="manhattanLength"><span class="type-signature"></span>manhattanLength<span class="signature">()</span><span class="type-signature"></span></h4>
  522. <div class="description">
  523. Manhattan length of the vector.
  524. </div>
  525. <dl class="details">
  526. <dt class="tag-source">Source:</dt>
  527. <dd class="tag-source"><ul class="dummy"><li>
  528. <a href="math_Vector2.js.html">math/Vector2.js</a>, <a href="math_Vector2.js.html#line308">line 308</a>
  529. </li></ul></dd>
  530. </dl>
  531. <h4 class="name" id="max"><span class="type-signature"></span>max<span class="signature">(v)</span><span class="type-signature"></span></h4>
  532. <div class="description">
  533. Set the maximum of x and y coordinates between two vectors. X is set as the max between this vector and the other vector.
  534. </div>
  535. <h5>Parameters:</h5>
  536. <table class="params">
  537. <thead>
  538. <tr>
  539. <th>Name</th>
  540. <th>Type</th>
  541. <th class="last">Description</th>
  542. </tr>
  543. </thead>
  544. <tbody>
  545. <tr>
  546. <td class="name"><code>v</code></td>
  547. <td class="type">
  548. <span class="param-type"><a href="Vector2.html">Vector2</a></span>
  549. </td>
  550. <td class="description last"></td>
  551. </tr>
  552. </tbody>
  553. </table>
  554. <dl class="details">
  555. <dt class="tag-source">Source:</dt>
  556. <dd class="tag-source"><ul class="dummy"><li>
  557. <a href="math_Vector2.js.html">math/Vector2.js</a>, <a href="math_Vector2.js.html#line201">line 201</a>
  558. </li></ul></dd>
  559. </dl>
  560. <h4 class="name" id="min"><span class="type-signature"></span>min<span class="signature">(v)</span><span class="type-signature"></span></h4>
  561. <div class="description">
  562. Set the minimum of x and y coordinates between two vectors. X is set as the min between this vector and the other vector.
  563. </div>
  564. <h5>Parameters:</h5>
  565. <table class="params">
  566. <thead>
  567. <tr>
  568. <th>Name</th>
  569. <th>Type</th>
  570. <th class="last">Description</th>
  571. </tr>
  572. </thead>
  573. <tbody>
  574. <tr>
  575. <td class="name"><code>v</code></td>
  576. <td class="type">
  577. <span class="param-type"><a href="Vector2.html">Vector2</a></span>
  578. </td>
  579. <td class="description last"></td>
  580. </tr>
  581. </tbody>
  582. </table>
  583. <dl class="details">
  584. <dt class="tag-source">Source:</dt>
  585. <dd class="tag-source"><ul class="dummy"><li>
  586. <a href="math_Vector2.js.html">math/Vector2.js</a>, <a href="math_Vector2.js.html#line188">line 188</a>
  587. </li></ul></dd>
  588. </dl>
  589. <h4 class="name" id="multiply"><span class="type-signature"></span>multiply<span class="signature">(v)</span><span class="type-signature"></span></h4>
  590. <div class="description">
  591. Multiply the content of another vector to this one.
  592. </div>
  593. <h5>Parameters:</h5>
  594. <table class="params">
  595. <thead>
  596. <tr>
  597. <th>Name</th>
  598. <th>Type</th>
  599. <th class="last">Description</th>
  600. </tr>
  601. </thead>
  602. <tbody>
  603. <tr>
  604. <td class="name"><code>v</code></td>
  605. <td class="type">
  606. <span class="param-type"><a href="Vector2.html">Vector2</a></span>
  607. </td>
  608. <td class="description last"></td>
  609. </tr>
  610. </tbody>
  611. </table>
  612. <dl class="details">
  613. <dt class="tag-source">Source:</dt>
  614. <dd class="tag-source"><ul class="dummy"><li>
  615. <a href="math_Vector2.js.html">math/Vector2.js</a>, <a href="math_Vector2.js.html#line142">line 142</a>
  616. </li></ul></dd>
  617. </dl>
  618. <h4 class="name" id="multiplyScalar"><span class="type-signature"></span>multiplyScalar<span class="signature">(s)</span><span class="type-signature"></span></h4>
  619. <div class="description">
  620. Multiply a scalar value by booth vector components.
  621. </div>
  622. <h5>Parameters:</h5>
  623. <table class="params">
  624. <thead>
  625. <tr>
  626. <th>Name</th>
  627. <th>Type</th>
  628. <th class="last">Description</th>
  629. </tr>
  630. </thead>
  631. <tbody>
  632. <tr>
  633. <td class="name"><code>s</code></td>
  634. <td class="type">
  635. <span class="param-type">number</span>
  636. </td>
  637. <td class="description last"></td>
  638. </tr>
  639. </tbody>
  640. </table>
  641. <dl class="details">
  642. <dt class="tag-source">Source:</dt>
  643. <dd class="tag-source"><ul class="dummy"><li>
  644. <a href="math_Vector2.js.html">math/Vector2.js</a>, <a href="math_Vector2.js.html#line153">line 153</a>
  645. </li></ul></dd>
  646. </dl>
  647. <h4 class="name" id="negate"><span class="type-signature"></span>negate<span class="signature">()</span><span class="type-signature"></span></h4>
  648. <div class="description">
  649. Negate the coordinates of this vector.
  650. </div>
  651. <dl class="details">
  652. <dt class="tag-source">Source:</dt>
  653. <dd class="tag-source"><ul class="dummy"><li>
  654. <a href="math_Vector2.js.html">math/Vector2.js</a>, <a href="math_Vector2.js.html#line257">line 257</a>
  655. </li></ul></dd>
  656. </dl>
  657. <h4 class="name" id="normalize"><span class="type-signature"></span>normalize<span class="signature">()</span><span class="type-signature"></span></h4>
  658. <div class="description">
  659. Normalize the vector (make it length one).
  660. </div>
  661. <dl class="details">
  662. <dt class="tag-source">Source:</dt>
  663. <dd class="tag-source"><ul class="dummy"><li>
  664. <a href="math_Vector2.js.html">math/Vector2.js</a>, <a href="math_Vector2.js.html#line316">line 316</a>
  665. </li></ul></dd>
  666. </dl>
  667. <h4 class="name" id="rotateAround"><span class="type-signature"></span>rotateAround<span class="signature">(center, angle)</span><span class="type-signature"></span></h4>
  668. <div class="description">
  669. Rotate the vector around a central point.
  670. </div>
  671. <h5>Parameters:</h5>
  672. <table class="params">
  673. <thead>
  674. <tr>
  675. <th>Name</th>
  676. <th>Type</th>
  677. <th class="last">Description</th>
  678. </tr>
  679. </thead>
  680. <tbody>
  681. <tr>
  682. <td class="name"><code>center</code></td>
  683. <td class="type">
  684. <span class="param-type"><a href="Vector2.html">Vector2</a></span>
  685. </td>
  686. <td class="description last"></td>
  687. </tr>
  688. <tr>
  689. <td class="name"><code>angle</code></td>
  690. <td class="type">
  691. <span class="param-type">number</span>
  692. </td>
  693. <td class="description last"></td>
  694. </tr>
  695. </tbody>
  696. </table>
  697. <dl class="details">
  698. <dt class="tag-source">Source:</dt>
  699. <dd class="tag-source"><ul class="dummy"><li>
  700. <a href="math_Vector2.js.html">math/Vector2.js</a>, <a href="math_Vector2.js.html#line431">line 431</a>
  701. </li></ul></dd>
  702. </dl>
  703. <h4 class="name" id="round"><span class="type-signature"></span>round<span class="signature">()</span><span class="type-signature"></span></h4>
  704. <div class="description">
  705. Round the vector coordinates to their closest integer.
  706. </div>
  707. <dl class="details">
  708. <dt class="tag-source">Source:</dt>
  709. <dd class="tag-source"><ul class="dummy"><li>
  710. <a href="math_Vector2.js.html">math/Vector2.js</a>, <a href="math_Vector2.js.html#line248">line 248</a>
  711. </li></ul></dd>
  712. </dl>
  713. <h4 class="name" id="set"><span class="type-signature"></span>set<span class="signature">(x, y)</span><span class="type-signature"></span></h4>
  714. <div class="description">
  715. Set vector x and y values.
  716. </div>
  717. <h5>Parameters:</h5>
  718. <table class="params">
  719. <thead>
  720. <tr>
  721. <th>Name</th>
  722. <th>Type</th>
  723. <th class="last">Description</th>
  724. </tr>
  725. </thead>
  726. <tbody>
  727. <tr>
  728. <td class="name"><code>x</code></td>
  729. <td class="type">
  730. <span class="param-type">number</span>
  731. </td>
  732. <td class="description last"></td>
  733. </tr>
  734. <tr>
  735. <td class="name"><code>y</code></td>
  736. <td class="type">
  737. <span class="param-type">number</span>
  738. </td>
  739. <td class="description last"></td>
  740. </tr>
  741. </tbody>
  742. </table>
  743. <dl class="details">
  744. <dt class="tag-source">Source:</dt>
  745. <dd class="tag-source"><ul class="dummy"><li>
  746. <a href="math_Vector2.js.html">math/Vector2.js</a>, <a href="math_Vector2.js.html#line23">line 23</a>
  747. </li></ul></dd>
  748. </dl>
  749. <h4 class="name" id="setLength"><span class="type-signature"></span>setLength<span class="signature">()</span><span class="type-signature"></span></h4>
  750. <div class="description">
  751. Scale the vector to have a defined length value.
  752. </div>
  753. <dl class="details">
  754. <dt class="tag-source">Source:</dt>
  755. <dd class="tag-source"><ul class="dummy"><li>
  756. <a href="math_Vector2.js.html">math/Vector2.js</a>, <a href="math_Vector2.js.html#line368">line 368</a>
  757. </li></ul></dd>
  758. </dl>
  759. <h4 class="name" id="setScalar"><span class="type-signature"></span>setScalar<span class="signature">()</span><span class="type-signature"></span></h4>
  760. <div class="description">
  761. Set a scalar value into the x and y values.
  762. </div>
  763. <dl class="details">
  764. <dt class="tag-source">Source:</dt>
  765. <dd class="tag-source"><ul class="dummy"><li>
  766. <a href="math_Vector2.js.html">math/Vector2.js</a>, <a href="math_Vector2.js.html#line32">line 32</a>
  767. </li></ul></dd>
  768. </dl>
  769. <h4 class="name" id="sub"><span class="type-signature"></span>sub<span class="signature">(v)</span><span class="type-signature"></span></h4>
  770. <div class="description">
  771. Subtract the content of another vector to this one.
  772. </div>
  773. <h5>Parameters:</h5>
  774. <table class="params">
  775. <thead>
  776. <tr>
  777. <th>Name</th>
  778. <th>Type</th>
  779. <th class="last">Description</th>
  780. </tr>
  781. </thead>
  782. <tbody>
  783. <tr>
  784. <td class="name"><code>v</code></td>
  785. <td class="type">
  786. <span class="param-type"><a href="Vector2.html">Vector2</a></span>
  787. </td>
  788. <td class="description last"></td>
  789. </tr>
  790. </tbody>
  791. </table>
  792. <dl class="details">
  793. <dt class="tag-source">Source:</dt>
  794. <dd class="tag-source"><ul class="dummy"><li>
  795. <a href="math_Vector2.js.html">math/Vector2.js</a>, <a href="math_Vector2.js.html#line108">line 108</a>
  796. </li></ul></dd>
  797. </dl>
  798. <h4 class="name" id="subScalar"><span class="type-signature"></span>subScalar<span class="signature">(s)</span><span class="type-signature"></span></h4>
  799. <div class="description">
  800. Subtract a scalar value to booth vector components.
  801. </div>
  802. <h5>Parameters:</h5>
  803. <table class="params">
  804. <thead>
  805. <tr>
  806. <th>Name</th>
  807. <th>Type</th>
  808. <th class="last">Description</th>
  809. </tr>
  810. </thead>
  811. <tbody>
  812. <tr>
  813. <td class="name"><code>s</code></td>
  814. <td class="type">
  815. <span class="param-type">number</span>
  816. </td>
  817. <td class="description last"></td>
  818. </tr>
  819. </tbody>
  820. </table>
  821. <dl class="details">
  822. <dt class="tag-source">Source:</dt>
  823. <dd class="tag-source"><ul class="dummy"><li>
  824. <a href="math_Vector2.js.html">math/Vector2.js</a>, <a href="math_Vector2.js.html#line119">line 119</a>
  825. </li></ul></dd>
  826. </dl>
  827. <h4 class="name" id="subVectors"><span class="type-signature"></span>subVectors<span class="signature">(a, b)</span><span class="type-signature"></span></h4>
  828. <div class="description">
  829. Subtract two vectors and store the result in this vector.
  830. </div>
  831. <h5>Parameters:</h5>
  832. <table class="params">
  833. <thead>
  834. <tr>
  835. <th>Name</th>
  836. <th>Type</th>
  837. <th class="last">Description</th>
  838. </tr>
  839. </thead>
  840. <tbody>
  841. <tr>
  842. <td class="name"><code>a</code></td>
  843. <td class="type">
  844. <span class="param-type"><a href="Vector2.html">Vector2</a></span>
  845. </td>
  846. <td class="description last"></td>
  847. </tr>
  848. <tr>
  849. <td class="name"><code>b</code></td>
  850. <td class="type">
  851. <span class="param-type"><a href="Vector2.html">Vector2</a></span>
  852. </td>
  853. <td class="description last"></td>
  854. </tr>
  855. </tbody>
  856. </table>
  857. <dl class="details">
  858. <dt class="tag-source">Source:</dt>
  859. <dd class="tag-source"><ul class="dummy"><li>
  860. <a href="math_Vector2.js.html">math/Vector2.js</a>, <a href="math_Vector2.js.html#line131">line 131</a>
  861. </li></ul></dd>
  862. </dl>
  863. <h4 class="name" id="toArray"><span class="type-signature"></span>toArray<span class="signature">(array, offset<span class="signature-attributes">opt</span>)</span><span class="type-signature"></span></h4>
  864. <div class="description">
  865. Convert this vector to an array.
  866. </div>
  867. <h5>Parameters:</h5>
  868. <table class="params">
  869. <thead>
  870. <tr>
  871. <th>Name</th>
  872. <th>Type</th>
  873. <th>Attributes</th>
  874. <th class="last">Description</th>
  875. </tr>
  876. </thead>
  877. <tbody>
  878. <tr>
  879. <td class="name"><code>array</code></td>
  880. <td class="type">
  881. <span class="param-type">array</span>
  882. </td>
  883. <td class="attributes">
  884. </td>
  885. <td class="description last"></td>
  886. </tr>
  887. <tr>
  888. <td class="name"><code>offset</code></td>
  889. <td class="type">
  890. <span class="param-type">number</span>
  891. </td>
  892. <td class="attributes">
  893. &lt;optional><br>
  894. </td>
  895. <td class="description last"></td>
  896. </tr>
  897. </tbody>
  898. </table>
  899. <dl class="details">
  900. <dt class="tag-source">Source:</dt>
  901. <dd class="tag-source"><ul class="dummy"><li>
  902. <a href="math_Vector2.js.html">math/Vector2.js</a>, <a href="math_Vector2.js.html#line414">line 414</a>
  903. </li></ul></dd>
  904. </dl>
  905. </article>
  906. </section>
  907. </div>
  908. <nav>
  909. <h2><a href="index.html">Home</a></h2><h3>Classes</h3><ul><li><a href="BezierCurve.html">BezierCurve</a></li><li><a href="Box.html">Box</a></li><li><a href="Box2.html">Box2</a></li><li><a href="BoxMask.html">BoxMask</a></li><li><a href="Circle.html">Circle</a></li><li><a href="DOM.html">DOM</a></li><li><a href="EventManager.html">EventManager</a></li><li><a href="Graph.html">Graph</a></li><li><a href="Helpers.html">Helpers</a></li><li><a href="Image.html">Image</a></li><li><a href="Key.html">Key</a></li><li><a href="Line.html">Line</a></li><li><a href="Mask.html">Mask</a></li><li><a href="Matrix.html">Matrix</a></li><li><a href="Object2D.html">Object2D</a></li><li><a href="Pattern.html">Pattern</a></li><li><a href="Pointer.html">Pointer</a></li><li><a href="Renderer.html">Renderer</a></li><li><a href="Text.html">Text</a></li><li><a href="UUID.html">UUID</a></li><li><a href="Vector2.html">Vector2</a></li><li><a href="Viewport.html">Viewport</a></li><li><a href="ViewportControls.html">ViewportControls</a></li></ul>
  910. </nav>
  911. <br class="clear">
  912. <footer>
  913. Documentation generated by <a href="https://github.com/jsdoc/jsdoc">JSDoc 3.6.2</a> on Thu Jun 13 2019 09:46:07 GMT+0100 (Western European Summer Time)
  914. </footer>
  915. <script> prettyPrint(); </script>
  916. <script src="scripts/linenumber.js"> </script>
  917. </body>
  918. </html>