<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
<!-- NewPage -->
<html lang="en">
<head>
<!-- Generated by javadoc (version 1.7.0_17) on Sun Nov 03 15:35:42 CET 2013 -->
<title>Vector (libgdx API)
</title>
<meta name="date" content="2013-11-03">
<link rel="stylesheet" type="text/css" href="../../../../stylesheet.css" title="Style">
</head>
<body>
<script type="text/javascript"><!--
if (location.href.indexOf('is-external=true') == -1) {
parent.document.title="Vector (libgdx API)";
}
//-->
</script>
<noscript>
<div>JavaScript is disabled on your browser.
</div>
</noscript>
<!-- ========= START OF TOP NAVBAR ======= -->
<div class="topNav"><a name="navbar_top">
<!-- -->
</a><a href="#skip-navbar_top" title="Skip navigation links"></a><a name="navbar_top_firstrow">
<!-- -->
</a>
<ul class="navList" title="Navigation">
<li><a href="../../../../overview-summary.html">Overview
</a></li>
<li><a href="package-summary.html">Package
</a></li>
<li class="navBarCell1Rev">Class
</li>
<li><a href="class-use/Vector.html">Use
</a></li>
<li><a href="package-tree.html">Tree
</a></li>
<li><a href="../../../../deprecated-list.html">Deprecated
</a></li>
<li><a href="../../../../index-all.html">Index
</a></li>
<li><a href="../../../../help-doc.html">Help
</a></li>
</ul>
<div class="aboutLanguage"><em>
libgdx API
<style>
body, td, th { font-family:Helvetica, Tahoma, Arial, sans-serif; font-size:10pt }
pre, code, tt { font-size:9pt; font-family:Lucida Console, Courier New, sans-serif }
h1, h2, h3, .FrameTitleFont, .FrameHeadingFont, .TableHeadingColor font { font-size:105%; font-weight:bold }
.TableHeadingColor { background:#EEEEFF; }
a { text-decoration:none }
a:hover { text-decoration:underline }
a:link, a:visited { color:blue }
table { border:0px }
.TableRowColor td:first-child { border-left:1px solid black }
.TableRowColor td { border:0px; border-bottom:1px solid black; border-right:1px solid black }
hr { border:0px; border-bottom:1px solid #333366; }
</style>
</em></div>
</div>
<div class="subNav">
<ul class="navList">
<li><a href="../../../../com/badlogic/gdx/math/Rectangle.html" title="class in com.badlogic.gdx.math"><span class="strong">Prev Class
</span></a></li>
<li><a href="../../../../com/badlogic/gdx/math/Vector2.html" title="class in com.badlogic.gdx.math"><span class="strong">Next Class
</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../../index.html?com/badlogic/gdx/math/Vector.html" target="_top">Frames
</a></li>
<li><a href="Vector.html" target="_top">No Frames
</a></li>
</ul>
<ul class="navList" id="allclasses_navbar_top">
<li><a href="../../../../allclasses-noframe.html">All Classes
</a></li>
</ul>
<div>
<script type="text/javascript"><!--
allClassesLink = document.getElementById("allclasses_navbar_top");
if(window==top) {
allClassesLink.style.display = "block";
}
else {
allClassesLink.style.display = "none";
}
//-->
</script>
</div>
<div>
<ul class="subNavList">
<li>Summary:
</li>
<li>Nested
|
</li>
<li>Field
|
</li>
<li>Constr
|
</li>
<li><a href="#method_summary">Method
</a></li>
</ul>
<ul class="subNavList">
<li>Detail:
</li>
<li>Field
|
</li>
<li>Constr
|
</li>
<li><a href="#method_detail">Method
</a></li>
</ul>
</div>
<a name="skip-navbar_top">
<!-- -->
</a></div>
<!-- ========= END OF TOP NAVBAR ========= -->
<!-- ======== START OF CLASS DATA ======== -->
<div class="header">
<div class="subTitle">com.badlogic.gdx.math
</div>
<h2 title="Interface Vector" class="title">Interface Vector
<T extends Vector
<T
>></h2>
</div>
<div class="contentContainer">
<div class="description">
<ul class="blockList">
<li class="blockList">
<dl>
<dt>All Known Implementing Classes:
</dt>
<dd><a href="../../../../com/badlogic/gdx/math/Vector2.html" title="class in com.badlogic.gdx.math">Vector2
</a>,
<a href="../../../../com/badlogic/gdx/math/Vector3.html" title="class in com.badlogic.gdx.math">Vector3
</a></dd>
</dl>
<hr>
<br>
<pre>public interface
<span class="strong">Vector
<T extends Vector
<T
>></span></pre>
<div class="block">Encapsulates a general vector. Allows chaining operations by returning a reference to itself in all modification methods. See
<a href="../../../../com/badlogic/gdx/math/Vector2.html" title="class in com.badlogic.gdx.math"><code>Vector2
</code></a> and
<a href="../../../../com/badlogic/gdx/math/Vector3.html" title="class in com.badlogic.gdx.math"><code>Vector3
</code></a> for specific implementations.
</div>
<dl><dt><span class="strong">Author:
</span></dt>
<dd>Xoppa
</dd></dl>
</li>
</ul>
</div>
<div class="summary">
<ul class="blockList">
<li class="blockList">
<!-- ========== METHOD SUMMARY =========== -->
<ul class="blockList">
<li class="blockList"><a name="method_summary">
<!-- -->
</a>
<h3>Method Summary
</h3>
<table class="overviewSummary" border="0" cellpadding="3" cellspacing="0" summary="Method Summary table, listing methods, and an explanation">
<caption><span>Methods
</span><span class="tabEnd"> </span></caption>
<tr>
<th class="colFirst" scope="col">Modifier and Type
</th>
<th class="colLast" scope="col">Method and Description
</th>
</tr>
<tr class="altColor">
<td class="colFirst"><code><a href="../../../../com/badlogic/gdx/math/Vector.html" title="type parameter in Vector">T
</a></code></td>
<td class="colLast"><code><strong><a href="../../../../com/badlogic/gdx/math/Vector.html#add(T)">add
</a></strong>(
<a href="../../../../com/badlogic/gdx/math/Vector.html" title="type parameter in Vector">T
</a> v)
</code>
<div class="block">Adds the given vector to this vector
</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code><a href="../../../../com/badlogic/gdx/math/Vector.html" title="type parameter in Vector">T
</a></code></td>
<td class="colLast"><code><strong><a href="../../../../com/badlogic/gdx/math/Vector.html#clamp(float, float)">clamp
</a></strong>(float
min,
float
max)
</code>
<div class="block">Clamps this vector's length to given value
</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code><a href="../../../../com/badlogic/gdx/math/Vector.html" title="type parameter in Vector">T
</a></code></td>
<td class="colLast"><code><strong><a href="../../../../com/badlogic/gdx/math/Vector.html#cpy()">cpy
</a></strong>()
</code> </td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>float
</code></td>
<td class="colLast"><code><strong><a href="../../../../com/badlogic/gdx/math/Vector.html#dot(T)">dot
</a></strong>(
<a href="../../../../com/badlogic/gdx/math/Vector.html" title="type parameter in Vector">T
</a> v)
</code> </td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>float
</code></td>
<td class="colLast"><code><strong><a href="../../../../com/badlogic/gdx/math/Vector.html#dst(T)">dst
</a></strong>(
<a href="../../../../com/badlogic/gdx/math/Vector.html" title="type parameter in Vector">T
</a> v)
</code> </td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>float
</code></td>
<td class="colLast"><code><strong><a href="../../../../com/badlogic/gdx/math/Vector.html#dst2(T)">dst2
</a></strong>(
<a href="../../../../com/badlogic/gdx/math/Vector.html" title="type parameter in Vector">T
</a> v)
</code>
<div class="block">This is much faster to calculate than
<a href="../../../../com/badlogic/gdx/math/Vector.html#dst(T)"><code>dst(Vector)
</code></a>
It avoids a calculating square root, so it is mostly useful for comparisons
</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>float
</code></td>
<td class="colLast"><code><strong><a href="../../../../com/badlogic/gdx/math/Vector.html#len()">len
</a></strong>()
</code> </td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>float
</code></td>
<td class="colLast"><code><strong><a href="../../../../com/badlogic/gdx/math/Vector.html#len2()">len2
</a></strong>()
</code> </td>
</tr>
<tr class="altColor">
<td class="colFirst"><code><a href="../../../../com/badlogic/gdx/math/Vector.html" title="type parameter in Vector">T
</a></code></td>
<td class="colLast"><code><strong><a href="../../../../com/badlogic/gdx/math/Vector.html#lerp(T, float)">lerp
</a></strong>(
<a href="../../../../com/badlogic/gdx/math/Vector.html" title="type parameter in Vector">T
</a> target,
float
alpha)
</code>
<div class="block">Linearly interpolates between this vector and the target vector by alpha which is in the range [0,1].
</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code><a href="../../../../com/badlogic/gdx/math/Vector.html" title="type parameter in Vector">T
</a></code></td>
<td class="colLast"><code><strong><a href="../../../../com/badlogic/gdx/math/Vector.html#limit(float)">limit
</a></strong>(float
limit)
</code>
<div class="block">Limits this vector's length to given value
</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code><a href="../../../../com/badlogic/gdx/math/Vector.html" title="type parameter in Vector">T
</a></code></td>
<td class="colLast"><code><strong><a href="../../../../com/badlogic/gdx/math/Vector.html#nor()">nor
</a></strong>()
</code>
<div class="block">Normalizes this vector.
</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code><a href="../../../../com/badlogic/gdx/math/Vector.html" title="type parameter in Vector">T
</a></code></td>
<td class="colLast"><code><strong><a href="../../../../com/badlogic/gdx/math/Vector.html#scl(float)">scl
</a></strong>(float
scalar)
</code>
<div class="block">Scales this vector by a scalar
</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code><a href="../../../../com/badlogic/gdx/math/Vector.html" title="type parameter in Vector">T
</a></code></td>
<td class="colLast"><code><strong><a href="../../../../com/badlogic/gdx/math/Vector.html#scl(T)">scl
</a></strong>(
<a href="../../../../com/badlogic/gdx/math/Vector.html" title="type parameter in Vector">T
</a> v)
</code>
<div class="block">Scales this vector by another vector
</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code><a href="../../../../com/badlogic/gdx/math/Vector.html" title="type parameter in Vector">T
</a></code></td>
<td class="colLast"><code><strong><a href="../../../../com/badlogic/gdx/math/Vector.html#set(T)">set
</a></strong>(
<a href="../../../../com/badlogic/gdx/math/Vector.html" title="type parameter in Vector">T
</a> v)
</code>
<div class="block">Sets this vector from the given vector
</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code><a href="../../../../com/badlogic/gdx/math/Vector.html" title="type parameter in Vector">T
</a></code></td>
<td class="colLast"><code><strong><a href="../../../../com/badlogic/gdx/math/Vector.html#sub(T)">sub
</a></strong>(
<a href="../../../../com/badlogic/gdx/math/Vector.html" title="type parameter in Vector">T
</a> v)
</code>
<div class="block">Substracts the given vector from this vector.
</div>
</td>
</tr>
</table>
</li>
</ul>
</li>
</ul>
</div>
<div class="details">
<ul class="blockList">
<li class="blockList">
<!-- ============ METHOD DETAIL ========== -->
<ul class="blockList">
<li class="blockList"><a name="method_detail">
<!-- -->
</a>
<h3>Method Detail
</h3>
<a name="cpy()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>cpy
</h4>
<pre><a href="../../../../com/badlogic/gdx/math/Vector.html" title="type parameter in Vector">T
</a> cpy()
</pre>
<dl><dt><span class="strong">Returns:
</span></dt><dd>a copy of this vector
</dd></dl>
</li>
</ul>
<a name="len()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>len
</h4>
<pre>float
len()
</pre>
<dl><dt><span class="strong">Returns:
</span></dt><dd>The euclidian length
</dd></dl>
</li>
</ul>
<a name="len2()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>len2
</h4>
<pre>float
len2()
</pre>
<dl><dt><span class="strong">Returns:
</span></dt><dd>The squared euclidian length
</dd></dl>
</li>
</ul>
<a name="limit(float)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>limit
</h4>
<pre><a href="../../../../com/badlogic/gdx/math/Vector.html" title="type parameter in Vector">T
</a> limit(float
limit)
</pre>
<div class="block">Limits this vector's length to given value
</div>
<dl><dt><span class="strong">Returns:
</span></dt><dd>This vector for chaining
</dd></dl>
</li>
</ul>
<a name="clamp(float, float)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>clamp
</h4>
<pre><a href="../../../../com/badlogic/gdx/math/Vector.html" title="type parameter in Vector">T
</a> clamp(float
min,
float
max)
</pre>
<div class="block">Clamps this vector's length to given value
</div>
<dl><dt><span class="strong">Parameters:
</span></dt><dd><code>min
</code> - Min length
</dd><dd><code>max
</code> - Max length
</dd>
<dt><span class="strong">Returns:
</span></dt><dd>This vector for chaining
</dd></dl>
</li>
</ul>
<a name="set(com.badlogic.gdx.math.Vector)">
<!-- -->
</a><a name="set(T)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>set
</h4>
<pre><a href="../../../../com/badlogic/gdx/math/Vector.html" title="type parameter in Vector">T
</a> set(
<a href="../../../../com/badlogic/gdx/math/Vector.html" title="type parameter in Vector">T
</a> v)
</pre>
<div class="block">Sets this vector from the given vector
</div>
<dl><dt><span class="strong">Parameters:
</span></dt><dd><code>v
</code> - The vector
</dd>
<dt><span class="strong">Returns:
</span></dt><dd>This vector for chaining
</dd></dl>
</li>
</ul>
<a name="sub(com.badlogic.gdx.math.Vector)">
<!-- -->
</a><a name="sub(T)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>sub
</h4>
<pre><a href="../../../../com/badlogic/gdx/math/Vector.html" title="type parameter in Vector">T
</a> sub(
<a href="../../../../com/badlogic/gdx/math/Vector.html" title="type parameter in Vector">T
</a> v)
</pre>
<div class="block">Substracts the given vector from this vector.
</div>
<dl><dt><span class="strong">Parameters:
</span></dt><dd><code>v
</code> - The vector
</dd>
<dt><span class="strong">Returns:
</span></dt><dd>This vector for chaining
</dd></dl>
</li>
</ul>
<a name="nor()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>nor
</h4>
<pre><a href="../../../../com/badlogic/gdx/math/Vector.html" title="type parameter in Vector">T
</a> nor()
</pre>
<div class="block">Normalizes this vector. Does nothing if it is zero.
</div>
<dl><dt><span class="strong">Returns:
</span></dt><dd>This vector for chaining
</dd></dl>
</li>
</ul>
<a name="add(com.badlogic.gdx.math.Vector)">
<!-- -->
</a><a name="add(T)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>add
</h4>
<pre><a href="../../../../com/badlogic/gdx/math/Vector.html" title="type parameter in Vector">T
</a> add(
<a href="../../../../com/badlogic/gdx/math/Vector.html" title="type parameter in Vector">T
</a> v)
</pre>
<div class="block">Adds the given vector to this vector
</div>
<dl><dt><span class="strong">Parameters:
</span></dt><dd><code>v
</code> - The vector
</dd>
<dt><span class="strong">Returns:
</span></dt><dd>This vector for chaining
</dd></dl>
</li>
</ul>
<a name="dot(com.badlogic.gdx.math.Vector)">
<!-- -->
</a><a name="dot(T)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>dot
</h4>
<pre>float
dot(
<a href="../../../../com/badlogic/gdx/math/Vector.html" title="type parameter in Vector">T
</a> v)
</pre>
<dl><dt><span class="strong">Parameters:
</span></dt><dd><code>v
</code> - The other vector
</dd>
<dt><span class="strong">Returns:
</span></dt><dd>The dot product between this and the other vector
</dd></dl>
</li>
</ul>
<a name="scl(float)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>scl
</h4>
<pre><a href="../../../../com/badlogic/gdx/math/Vector.html" title="type parameter in Vector">T
</a> scl(float
scalar)
</pre>
<div class="block">Scales this vector by a scalar
</div>
<dl><dt><span class="strong">Parameters:
</span></dt><dd><code>scalar
</code> - The scalar
</dd>
<dt><span class="strong">Returns:
</span></dt><dd>This vector for chaining
</dd></dl>
</li>
</ul>
<a name="scl(com.badlogic.gdx.math.Vector)">
<!-- -->
</a><a name="scl(T)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>scl
</h4>
<pre><a href="../../../../com/badlogic/gdx/math/Vector.html" title="type parameter in Vector">T
</a> scl(
<a href="../../../../com/badlogic/gdx/math/Vector.html" title="type parameter in Vector">T
</a> v)
</pre>
<div class="block">Scales this vector by another vector
</div>
<dl><dt><span class="strong">Returns:
</span></dt><dd>This vector for chaining
</dd></dl>
</li>
</ul>
<a name="dst(com.badlogic.gdx.math.Vector)">
<!-- -->
</a><a name="dst(T)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>dst
</h4>
<pre>float
dst(
<a href="../../../../com/badlogic/gdx/math/Vector.html" title="type parameter in Vector">T
</a> v)
</pre>
<dl><dt><span class="strong">Parameters:
</span></dt><dd><code>v
</code> - The other vector
</dd>
<dt><span class="strong">Returns:
</span></dt><dd>the distance between this and the other vector
</dd></dl>
</li>
</ul>
<a name="dst2(com.badlogic.gdx.math.Vector)">
<!-- -->
</a><a name="dst2(T)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>dst2
</h4>
<pre>float
dst2(
<a href="../../../../com/badlogic/gdx/math/Vector.html" title="type parameter in Vector">T
</a> v)
</pre>
<div class="block">This is much faster to calculate than
<a href="../../../../com/badlogic/gdx/math/Vector.html#dst(T)"><code>dst(Vector)
</code></a>
It avoids a calculating square root, so it is mostly useful for comparisons
</div>
<dl><dt><span class="strong">Parameters:
</span></dt><dd><code>v
</code> - The other vector
</dd>
<dt><span class="strong">Returns:
</span></dt><dd>the squared distance between this and the other vector
</dd></dl>
</li>
</ul>
<a name="lerp(com.badlogic.gdx.math.Vector,float)">
<!-- -->
</a><a name="lerp(T, float)">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>lerp
</h4>
<pre><a href="../../../../com/badlogic/gdx/math/Vector.html" title="type parameter in Vector">T
</a> lerp(
<a href="../../../../com/badlogic/gdx/math/Vector.html" title="type parameter in Vector">T
</a> target,
float
alpha)
</pre>
<div class="block">Linearly interpolates between this vector and the target vector by alpha which is in the range [0,1]. The result is stored
in this vector.
</div>
<dl><dt><span class="strong">Parameters:
</span></dt><dd><code>target
</code> - The target vector
</dd><dd><code>alpha
</code> - The interpolation coefficient
</dd>
<dt><span class="strong">Returns:
</span></dt><dd>This vector for chaining.
</dd></dl>
</li>
</ul>
</li>
</ul>
</li>
</ul>
</div>
</div>
<!-- ========= END OF CLASS DATA ========= -->
<!-- ======= START OF BOTTOM NAVBAR ====== -->
<div class="bottomNav"><a name="navbar_bottom">
<!-- -->
</a><a href="#skip-navbar_bottom" title="Skip navigation links"></a><a name="navbar_bottom_firstrow">
<!-- -->
</a>
<ul class="navList" title="Navigation">
<li><a href="../../../../overview-summary.html">Overview
</a></li>
<li><a href="package-summary.html">Package
</a></li>
<li class="navBarCell1Rev">Class
</li>
<li><a href="class-use/Vector.html">Use
</a></li>
<li><a href="package-tree.html">Tree
</a></li>
<li><a href="../../../../deprecated-list.html">Deprecated
</a></li>
<li><a href="../../../../index-all.html">Index
</a></li>
<li><a href="../../../../help-doc.html">Help
</a></li>
</ul>
<div class="aboutLanguage"><em>libgdx API
</em></div>
</div>
<div class="subNav">
<ul class="navList">
<li><a href="../../../../com/badlogic/gdx/math/Rectangle.html" title="class in com.badlogic.gdx.math"><span class="strong">Prev Class
</span></a></li>
<li><a href="../../../../com/badlogic/gdx/math/Vector2.html" title="class in com.badlogic.gdx.math"><span class="strong">Next Class
</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../../index.html?com/badlogic/gdx/math/Vector.html" target="_top">Frames
</a></li>
<li><a href="Vector.html" target="_top">No Frames
</a></li>
</ul>
<ul class="navList" id="allclasses_navbar_bottom">
<li><a href="../../../../allclasses-noframe.html">All Classes
</a></li>
</ul>
<div>
<script type="text/javascript"><!--
allClassesLink = document.getElementById("allclasses_navbar_bottom");
if(window==top) {
allClassesLink.style.display = "block";
}
else {
allClassesLink.style.display = "none";
}
//-->
</script>
</div>
<div>
<ul class="subNavList">
<li>Summary:
</li>
<li>Nested
|
</li>
<li>Field
|
</li>
<li>Constr
|
</li>
<li><a href="#method_summary">Method
</a></li>
</ul>
<ul class="subNavList">
<li>Detail:
</li>
<li>Field
|
</li>
<li>Constr
|
</li>
<li><a href="#method_detail">Method
</a></li>
</ul>
</div>
<a name="skip-navbar_bottom">
<!-- -->
</a></div>
<!-- ======== END OF BOTTOM NAVBAR ======= -->
<p class="legalCopy"><small>
<div style="font-size:9pt"><i>
Copyright
© 2010-2013 Mario Zechner (contact@badlogicgames.com), Nathan Sweet (admin@esotericsoftware.com)
</i></div>
</small></p>
</body>
</html>