Add Vector interface

diff --git a/gdx/src/com/badlogic/gdx/math/Vector.java b/gdx/src/com/badlogic/gdx/math/Vector.java
new file mode 100644 (file)
index 0000000..766092b
--- /dev/null
+++ b/gdx/src/com/badlogic/gdx/math/Vector.java
@@ -0,0 +1,77 @@
+/*******************************************************************************
+ * Copyright 2011 See AUTHORS file.
+ * 
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ * 
+ *   http://www.apache.org/licenses/LICENSE-2.0
+ * 
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ ******************************************************************************/
+
+package com.badlogic.gdx.math;
+
+/** Encapsulates a general vector. Allows chaining operations by returning a reference to itself in all modification methods.
+ * See {@link Vector2} and {@link Vector3} for specific implementations.
+ * @author Xoppa */
+public interface Vector<T extends Vector> {
+       /** @return a copy of this vector */
+       T cpy();
+       /** @return The euclidian length */
+       float len();
+       /** @return The squared euclidian length */
+       float len2();
+       /** Sets this vector from the given vector
+        * @param v The vector
+        * @return This vector for chaining */
+       T set(T v);
+       /** Substracts the given vector from this vector.
+        * @param v The vector
+        * @return This vector for chaining */
+       T sub(T v);
+       /** Normalizes this vector
+        * @return This vector for chaining */
+       T nor();
+       /** Adds the given vector to this vector
+        * @param v The vector
+        * @return This vector for chaining */
+       T add(T v);
+       /** @param v The other vector
+        * @return The dot product between this and the other vector */
+       float dot(T v);
+       /** Multiplies this vector by a scalar
+        * @param scalar The scalar
+        * @return This vector for chaining */
+       T mul(float scalar);
+       /** Multiplies this vector by another vector
+        * @return This vector for chaining */
+       T mul(T v);
+       T div(float scalar);
+       T div(T v);
+       /** @param v The other vector
+        * @return the distance between this and the other vector */
+       float dst(T v);
+       /** @param v The other vector
+        * @return the squared distance between this and the other vector */
+       float dst2(T v);
+       /** NEVER EVER SAVE THIS REFERENCE! Do not use this unless you are aware of the side-effects, e.g. other methods might call this
+        * as well.
+        * 
+        * @return a temporary copy of this vector. Use with care as this is backed by a single static Vector instance. v1.tmp().add(
+        *         v2.tmp() ) will not work! */
+       T tmp();
+       /** 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.
+        * 
+        * @param target The target vector
+        * @param alpha The interpolation coefficient
+        * @return This vector for chaining. */
+       T lerp(T target, float alpha);
+       
+       // TODO: T crs(T v);
+}

diff --git a/gdx/src/com/badlogic/gdx/math/Vector2.java b/gdx/src/com/badlogic/gdx/math/Vector2.java
index 32a2a40..c781e00 100644 (file)
--- a/gdx/src/com/badlogic/gdx/math/Vector2.java
+++ b/gdx/src/com/badlogic/gdx/math/Vector2.java
@@ -22,7 +22,7 @@ import com.badlogic.gdx.utils.NumberUtils;
 \r
 /** Encapsulates a 2D vector. Allows chaining methods by returning a reference to itself\r
  * @author badlogicgames@gmail.com */\r
-public class Vector2 implements Serializable {\r
+public class Vector2 implements Serializable, Vector<Vector2> {\r
        private static final long serialVersionUID = 913902788239530931L;\r
 \r
        /** Static temporary vector. Use with care! Use only when sure other code will not also use this.\r
@@ -151,6 +151,14 @@ public class Vector2 implements Serializable {
                this.y *= y;\r
                return this;\r
        }\r
+       \r
+       /** Multiplies this vector by a scalar\r
+        * @return This vector for chaining */\r
+       public Vector2 mul (Vector2 v) {\r
+               this.x *= v.x;\r
+               this.y *= v.y;\r
+               return this;\r
+       }\r
 \r
        public Vector2 div (float value) {\r
                return this.mul(1/value);\r

diff --git a/gdx/src/com/badlogic/gdx/math/Vector3.java b/gdx/src/com/badlogic/gdx/math/Vector3.java
index 8d25d8d..93ed80e 100644 (file)
--- a/gdx/src/com/badlogic/gdx/math/Vector3.java
+++ b/gdx/src/com/badlogic/gdx/math/Vector3.java
@@ -22,7 +22,7 @@ import com.badlogic.gdx.utils.NumberUtils;
 \r
 /** Encapsulates a 3D vector. Allows chaining operations by returning a reference to itself in all modification methods.\r
  * @author badlogicgames@gmail.com */\r
-public class Vector3 implements Serializable {\r
+public class Vector3 implements Serializable, Vector<Vector3> {\r
        private static final long serialVersionUID = 3840054589595372522L;\r
 \r
        /** the x-component of this vector **/\r