rescuecore2.misc.geometry

Class Vector2D

java.lang.Object

rescuecore2.misc.geometry.Vector2D

public class Vector2D
extends java.lang.Object

A vector in 2D space. Points are immutable.

Constructor Summary

Constructors

Constructor and Description
Vector2D(double dx, double dy) Create a new Vector2D.

Method Summary

Modifier and Type	Method and Description
Vector2D	add(Vector2D v) Create a new Vector2D by adding a vector to this one.
double	dot(Vector2D v) Calculate the dot product of this vector and another vector.
double	getLength() Get the length of this vector.
Vector2D	getNormal() Get a Vector2D that is normal to this one.
double	getX() Get the X component of this vector.
double	getY() Get the Y component of this vector.
Vector2D	normalised() Create a normalised version of this vector.
Vector2D	scale(double amount) Create a scaled version of this vector.
java.lang.String	toString()

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

Vector2D

public Vector2D(double dx,
                double dy)

Create a new Vector2D.

Parameters:

dx - The x component.

dy - The y component.

Method Detail

getLength

public double getLength()

Get the length of this vector.

Returns:

The length of the vector.

dot

public double dot(Vector2D v)

Calculate the dot product of this vector and another vector.

Parameters:

v - The other vector.

Returns:

The dot product of this vector and the other vector.

getX

public double getX()

Get the X component of this vector.

Returns:

The X component.

getY

public double getY()

Get the Y component of this vector.

Returns:

The Y component.

add

public Vector2D add(Vector2D v)

Create a new Vector2D by adding a vector to this one.

Parameters:

v - The vector to add.

Returns:

A new Vector2D.

scale

public Vector2D scale(double amount)

Create a scaled version of this vector.

Parameters:

amount - The scale factor.

Returns:

A new Vector2D.

normalised

public Vector2D normalised()

Create a normalised version of this vector.

Returns:

A new Vector2D with length 1.

getNormal

public Vector2D getNormal()

Get a Vector2D that is normal to this one.

Returns:

A new Vector2D that is normal to this one. This will be the "left-hand" normal.

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object