com.jonathan.survivor.math

Class Vector2

java.lang.Object

com.jonathan.survivor.math.Vector2

public class Vector2
extends java.lang.Object

Field Summary

Fields

Modifier and Type	Field and Description
static float	TO_DEGREES
static float	TO_RADIANS
float	x
float	y

Constructor Summary

Constructors

Constructor and Description
Vector2() Contructs a 2d vector with an x and y component of zero.
Vector2(float x, float y) Contructs a 2d vector with given x and y components.
Vector2(Vector2 other) Constructs a vector using another vector's x and y components.

Method Summary

Methods

Modifier and Type	Method and Description
Vector2	add(float amount) Adds the given amount to the x and y components of this Vector.
Vector2	add(float x, float y) Adds the x and y arguments to the x and y components of this Vector.
Vector2	add(Vector2 other) Adds a vector to this vector.
float	angle() Returns the angle formed by the vector, counterclockwise from the +x axis.
float	distance(float x, float y) Returns the distance between this vector and the given x and y components, which form another vector.
float	distance(Vector2 other) Returns the distance between this vector and another vector.
float	distSquared(float x, float y) Returns the distance squared between this vector and another vector with position (x,y).
float	distSquared(Vector2 other) Returns the distance squared between this vector and another vector.
float	magnitude() Returns the magnitude of this vector.
Vector2	mul(float scalar) Multiplies this vector by a scalar.
Vector2	normalize() Normalizes the vector.
Vector2	set(float x, float y) Sets the x and y components of the vector.
Vector2	set(Vector2 other) Copies the x and y components of another vector into this vector.
Vector2	sub(float amount) Subtracts the given amount from the x and y components of this Vector.
Vector2	sub(float x, float y) Subtracts the x and y arguments from the x and y components of this Vector.
Vector2	sub(Vector2 other) Adds a vector form this vector.
java.lang.String	toString()

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Detail

TO_RADIANS

public static float TO_RADIANS

TO_DEGREES

public static float TO_DEGREES

x

public float x

y

public float y

Constructor Detail

Vector2

public Vector2()

Contructs a 2d vector with an x and y component of zero.

Vector2

public Vector2(float x,
       float y)

Contructs a 2d vector with given x and y components.

Vector2

public Vector2(Vector2 other)

Constructs a vector using another vector's x and y components.

Method Detail

set

public Vector2 set(float x,
          float y)

Sets the x and y components of the vector. Returns the instance of this vector for easy chaining.

set

public Vector2 set(Vector2 other)

Copies the x and y components of another vector into this vector. Returns the instance of this vector for chained operations.

add

public Vector2 add(float amount)

Adds the given amount to the x and y components of this Vector. Returns a reference of this vector to use in method chaining for multiple operations.

add

public Vector2 add(float x,
          float y)

Adds the x and y arguments to the x and y components of this Vector. Returns a reference of this vector to use in method chaining for multiple operations.

add

public Vector2 add(Vector2 other)

Adds a vector to this vector. Done by adding the x and y components of the other vector to this vector. Returns the instance of this vector for use in operation chaining.

sub

public Vector2 sub(float amount)

Subtracts the given amount from the x and y components of this Vector. Returns a reference of this vector to use in method chaining for multiple operations.

sub

public Vector2 sub(float x,
          float y)

Subtracts the x and y arguments from the x and y components of this Vector. Returns a reference of this vector to use in method chaining for multiple operations.

sub

public Vector2 sub(Vector2 other)

Adds a vector form this vector. Done by subtracting the x and y components of the other vector from this vector's x and y components. Returns the instance of this vector for use in operation chaining.

mul

public Vector2 mul(float scalar)

Multiplies this vector by a scalar. Done by multiplying the x and y components of this vector by the given argument. Returns the instance of this vector for use in operation chaining.

magnitude

public float magnitude()

Returns the magnitude of this vector.

normalize

public Vector2 normalize()

Normalizes the vector. This means that we convert this vector into a unit vector with magnitude one. We return a reference to the normalized vector for use in chaining operations via chained method calls.

angle

public float angle()

Returns the angle formed by the vector, counterclockwise from the +x axis. Angle is in degrees, ranging from 0 to 360.

distance

public float distance(Vector2 other)

Returns the distance between this vector and another vector. Note that the value returned is a scalar quantity.

distance

public float distance(float x,
             float y)

Returns the distance between this vector and the given x and y components, which form another vector. Note that the value returned is a scalar distance quantity.

distSquared

public float distSquared(Vector2 other)

Returns the distance squared between this vector and another vector. Note that this avoids using a square root, making it more cost-efficient. Should be used instead of the Vector2.dist() method, as it prevents the costly square-root function.

distSquared

public float distSquared(float x,
                float y)

Returns the distance squared between this vector and another vector with position (x,y). Note that this avoids using a square root, making it more cost-efficient. Should be used instead of the Vector2.dist() method, as it prevents the costly square-root function.

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object