model.environment.position

Class Vector

java.lang.Object

model.environment.position.Position

model.environment.position.Vector

All Implemented Interfaces:

java.lang.Cloneable

public class Vector
extends Position

A 2D vector.

Author:

S.A.M. Janssen

Field Summary

Fields inherited from class model.environment.position.Position

NO_POSITION, x, y

Constructor Summary

Constructors

Constructor and Description
Vector(double x, double y) Creates a vector.
Vector(float x, float y) Creates a vector.

Method Summary

Modifier and Type	Method and Description
Vector	addVector(Vector other) Add another vector.
Vector	clone()
Vector	elementWiseMultiply(Vector other) Element wise multiplication of this vector and another.
boolean	isAproximateRotation(float degrees, Vector other) Checks if this vector is an approximate counterclockwise rotation of another vector.
float	length() The length of the vector.
float	multiply(Vector other) Multiplies (dot product) this vector with another.
Vector	normalize() Normalizes this vector.
Vector	reverse() Reverse the vector.
Vector	scalarMultiply(double scalar) Scalar multiplies this vector.
Vector	scalarMultiply(float scalar) Scalar multiplies this vector.
Vector	subtractVector(Vector other) Subtracts another vector from this vector.
java.lang.String	toString()

Methods inherited from class model.environment.position.Position

distanceTo, equals, hashCode

Methods inherited from class java.lang.Object

finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

Vector

public Vector(double x,
              double y)

Creates a vector.

Parameters:

x - The x direction.

y - The y direction.

Vector

public Vector(float x,
              float y)

Creates a vector.

Parameters:

x - The x direction.

y - The y direction.

Method Detail

addVector

public Vector addVector(Vector other)

Add another vector.

Parameters:

other - The other vector.

Returns:

The sum of the two vectors.

clone

public Vector clone()

Overrides:

clone in class Position

elementWiseMultiply

public Vector elementWiseMultiply(Vector other)

Element wise multiplication of this vector and another.

Parameters:

other - The other vector.

Returns:

The element wise multiplication of the two vectors.

isAproximateRotation

public boolean isAproximateRotation(float degrees,
                                    Vector other)

Checks if this vector is an approximate counterclockwise rotation of another vector.

Parameters:

degrees - The degrees rotation.

other - The other vector.

Returns:

True if it is an approximate rotation, false otherwise.

length

public float length()

The length of the vector.

Returns:

The length.

multiply

public float multiply(Vector other)

Multiplies (dot product) this vector with another.

Parameters:

other - The other vector.

Returns:

The multiplication.

normalize

public Vector normalize()

Normalizes this vector.

Returns:

The normalized vector.

reverse

public Vector reverse()

Reverse the vector.

Returns:

The reverse.

scalarMultiply

public Vector scalarMultiply(double scalar)

Scalar multiplies this vector.

Parameters:

scalar - The scalar.

Returns:

The scalar multiplied vector.

scalarMultiply

public Vector scalarMultiply(float scalar)

Scalar multiplies this vector.

Parameters:

scalar - The scalar.

Returns:

The scalar multiplied vector.

subtractVector

public Vector subtractVector(Vector other)

Subtracts another vector from this vector.

Parameters:

other - The other vector.

Returns:

The subtracted vector.

toString

public java.lang.String toString()

Overrides:

toString in class Position