ch.aplu.ev3

Class Vector3D

java.lang.Object

ch.aplu.ev3.Vector3D

public class Vector3D
extends java.lang.Object

Class representing a three-dimensional vector with double coordinates (x, y, z).

Field Summary

Fields

Modifier and Type	Field and Description
double	x The public x-coordinate.
double	y The public y-coordinate.
double	z The public z-coordinate.

Constructor Summary

Constructors

Constructor and Description
Vector3D() Constructs a zero vector (with coordinates (0, 0, 0)).
Vector3D(double x, double y, double z) Constructs a vector from given double x-y-coordinates.
Vector3D(float x, float y, float z) Constructs a vector from given float x-y-coordinates.
Vector3D(int x, int y, int z) Constructs a vector from given integer x-y-coordinates.

Method Summary

Methods

Modifier and Type	Method and Description
Vector3D	add(Vector3D v) Returns a new vector that is the vector sum of the current vector and the given vector.
Vector3D	clone() Returns a new vector with the same coordinates as the current vector.
double	distanceTo(Vector3D v) Returns the distance between the current vector and the given vector.
double	dot(Vector3D v) Returns the scalar product (dot product) of the current vector with the given vector.
Vector3D	getNormalized() Returns a new vector with magnitude 1 in the direction of the given vector.
double	getPhi() Returns the phi direction of the vector (range 0..2*pi).
double	getTheta() Returns the phi direction of the vector (range 0..2*pi).
Vector3D	invert() Returns a new vector with inverted coordinates.
boolean	isEqual(Vector3D v) Returns true, if the current vector is identical to the given vector.
double	magnitude() Returns the magnitude (length) of the vector.
double	magnitude2() Returns the square of the magnitude, without squareroot calculation.
Vector3D	mult(double b) Returns a new vector that is the product by a scalar of the current vector and the given double.
Vector3D	mult(float b) Returns a new vector that is the product by a scalar of the current vector and the given float.
Vector3D	mult(int b) Returns a new vector that is the product by a scalar of the current vector and the given integer.
void	normalize() Modifies the vector to unit magnitude.
Vector3D	sub(Vector3D v) Returns a new vector that is the vector difference of the current vector and the given vector.
java.lang.String	toString() Returns a string with the x-y-coordinates in the format (x,y,z).

Methods inherited from class java.lang.Object

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

Field Detail

x

public double x

The public x-coordinate.

y

public double y

The public y-coordinate.

z

public double z

The public z-coordinate.

Constructor Detail

Vector3D

public Vector3D()

Constructs a zero vector (with coordinates (0, 0, 0)).

Vector3D

public Vector3D(int x,
        int y,
        int z)

Constructs a vector from given integer x-y-coordinates.

Parameters:

x - the x-coordinate of the vector

y - the y-coordinate of the vector

z - the z-coordinate of the vector

Vector3D

public Vector3D(float x,
        float y,
        float z)

Constructs a vector from given float x-y-coordinates.

Parameters:

x - the x-coordinate of the vector

y - the y-coordinate of the vector

z - the z-coordinate of the vector

Vector3D

public Vector3D(double x,
        double y,
        double z)

Constructs a vector from given double x-y-coordinates.

Parameters:

x - the x-coordinate of the vector

y - the y-coordinate of the vector

z - the z-coordinate of the vector

Method Detail

magnitude

public double magnitude()

Returns the magnitude (length) of the vector.

Returns:

the magnitude

magnitude2

public double magnitude2()

Returns the square of the magnitude, without squareroot calculation. This is useful when performance is an issue.

Returns:

the square of the magnitude

normalize

public void normalize()

Modifies the vector to unit magnitude.

getNormalized

public Vector3D getNormalized()

Returns a new vector with magnitude 1 in the direction of the given vector.

Returns:

a unit vector with same direction

getPhi

public double getPhi()

Returns the phi direction of the vector (range 0..2*pi). (Euler angle of projection in x-y-plane).

Returns:

the direction of the vector (in radian, zero to x-axis, clockwise)

getTheta

public double getTheta()

Returns the phi direction of the vector (range 0..2*pi). (Euler angle elevation with respect to x-y-plane).

Returns:

the elevation of the vector (in radian, positive in z-direction)

dot

public double dot(Vector3D v)

Returns the scalar product (dot product) of the current vector with the given vector.

Parameters:

v - the vector to take for the dot product

Returns:

the dot product

distanceTo

public double distanceTo(Vector3D v)

Returns the distance between the current vector and the given vector.

Parameters:

v - the vector to take for the distance measurement

Returns:

the distance (magnitude of the vector difference)

add

public Vector3D add(Vector3D v)

Returns a new vector that is the vector sum of the current vector and the given vector. Be aware that the current vector is not modified.

Parameters:

v - the vector to be added to the current vector

Returns:

the sum of the two vectors

invert

public Vector3D invert()

Returns a new vector with inverted coordinates. Be aware that the current vector is not modified.

Returns:

the inverted vector

sub

public Vector3D sub(Vector3D v)

Returns a new vector that is the vector difference of the current vector and the given vector. Be aware that the current vector is not modified.

Parameters:

v - the vector to be substracted from the current vector

Returns:

the difference of the two vectors

mult

public Vector3D mult(int b)

Returns a new vector that is the product by a scalar of the current vector and the given integer. Be aware that the current vector is not modified.

Parameters:

b - the integer scale factor

Returns:

the vector that is scaled with the given integer

mult

public Vector3D mult(float b)

Returns a new vector that is the product by a scalar of the current vector and the given float. Be aware that the current vector is not modified.

Parameters:

b - the float scale factor

Returns:

the vector that is scaled with the given float

mult

public Vector3D mult(double b)

Returns a new vector that is the product by a scalar of the current vector and the given double. Be aware that the current vector is not modified.

Parameters:

b - the double scale factor

Returns:

the vector that is scaled with the given double

clone

public Vector3D clone()

Returns a new vector with the same coordinates as the current vector.

Overrides:

clone in class java.lang.Object

Returns:

a clone of the current vector

toString

public java.lang.String toString()

Returns a string with the x-y-coordinates in the format (x,y,z).

Overrides:

toString in class java.lang.Object

Returns:

a string representation of the vector

isEqual

public boolean isEqual(Vector3D v)

Returns true, if the current vector is identical to the given vector.

Parameters:

v - the vector to compare

Returns:

true, if both vectors are identical