org.joml

Class Vector2d

java.lang.Object

org.joml.Vector2d

All Implemented Interfaces:

Externalizable, Serializable

public class Vector2d
extends Object
implements Externalizable

Represents a 2D vector with double-precision.

Author:

RGreenlees, Kai Burjack

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
double	x The x component of the vector.
double	y The y component of the vector.

Constructor Summary

Constructors

Constructor and Description
Vector2d() Create a new Vector2d and initialize its components to zero.
Vector2d(ByteBuffer buffer) Create a new Vector2d and read this vector from the supplied ByteBuffer at the current buffer position.
Vector2d(double d) Create a new Vector2d and initialize both of its components with the given value.
Vector2d(DoubleBuffer buffer) Create a new Vector2d and read this vector from the supplied DoubleBuffer at the current buffer position.
Vector2d(double x, double y) Create a new Vector2d and initialize its components to the given values.
Vector2d(int index, ByteBuffer buffer) Create a new Vector2d and read this vector from the supplied ByteBuffer starting at the specified absolute buffer position/index.
Vector2d(int index, DoubleBuffer buffer) Create a new Vector2d and read this vector from the supplied DoubleBuffer starting at the specified absolute buffer position/index.
Vector2d(Vector2d v) Create a new Vector2d and initialize its components to the one of the given vector.
Vector2d(Vector2f v) Create a new Vector2d and initialize its components to the one of the given vector.

Method Summary

Modifier and Type	Method and Description
Vector2d	add(double x, double y) Add (x, y) to this vector.
Vector2d	add(double x, double y, Vector2d dest) Add (x, y) to this vector and store the result in dest.
Vector2d	add(Vector2d v) Add v to this vector.
Vector2d	add(Vector2d v, Vector2d dest) Add v to this vector and store the result in dest.
Vector2d	add(Vector2f v) Add v to this vector.
Vector2d	add(Vector2f v, Vector2d dest) Add v to this vector and store the result in dest.
static void	add(Vector2f a, Vector2d b, Vector2d dest) Add a to b and store the result in dest.
double	angle(Vector2d v) Return the angle between this vector and the supplied vector.
double	distance(Vector2d v) Return the distance between this and v.
double	distance(Vector2f v) Return the distance between this and v.
double	dot(Vector2d v) Return the dot product of this vector and v.
boolean	equals(Object obj)
Vector2d	fma(double a, Vector2d b) Add the component-wise multiplication of a * b to this vector.
Vector2d	fma(double a, Vector2d b, Vector2d dest) Add the component-wise multiplication of a * b to this vector and store the result in dest.
Vector2d	fma(Vector2d a, Vector2d b) Add the component-wise multiplication of a * b to this vector.
Vector2d	fma(Vector2d a, Vector2d b, Vector2d dest) Add the component-wise multiplication of a * b to this vector and store the result in dest.
ByteBuffer	get(ByteBuffer buffer) Store this vector into the supplied ByteBuffer at the current buffer position.
DoubleBuffer	get(DoubleBuffer buffer) Store this vector into the supplied DoubleBuffer at the current buffer position.
ByteBuffer	get(int index, ByteBuffer buffer) Store this vector into the supplied ByteBuffer starting at the specified absolute buffer position/index.
DoubleBuffer	get(int index, DoubleBuffer buffer) Store this vector into the supplied DoubleBuffer starting at the specified absolute buffer position/index.
int	hashCode()
double	length() Return the length of this vector.
Vector2d	lerp(Vector2d other, double t) Linearly interpolate this and other using the given interpolation factor t and store the result in this.
Vector2d	lerp(Vector2d other, double t, Vector2d dest) Linearly interpolate this and other using the given interpolation factor t and store the result in dest.
Vector2d	negate() Negate this vector.
Vector2d	negate(Vector2d dest) Negate this vector and store the result in dest.
Vector2d	normalize() Normalize this vector.
Vector2d	normalize(Vector2d dest) Normalize this vector and store the result in dest.
Vector2d	perpendicular() Set this vector to be one of its perpendicular vectors.
static void	perpendicular(Vector2d v, Vector2d dest) Store one perpendicular vector of v in dest.
void	readExternal(ObjectInput in)
Vector2d	set(ByteBuffer buffer) Read this vector from the supplied ByteBuffer at the current buffer position.
Vector2d	set(double d) Set the x and y components to the supplied value.
Vector2d	set(DoubleBuffer buffer) Read this vector from the supplied DoubleBuffer at the current buffer position.
Vector2d	set(double x, double y) Set the x and y components to the supplied values.
Vector2d	set(int index, ByteBuffer buffer) Read this vector from the supplied ByteBuffer starting at the specified absolute buffer position/index.
Vector2d	set(int index, DoubleBuffer buffer) Read this vector from the supplied DoubleBuffer starting at the specified absolute buffer position/index.
Vector2d	set(Vector2d v) Set this Vector2d to the values of v.
Vector2d	set(Vector2f v) Set this Vector2d to be a clone of v.
Vector2d	sub(double x, double y) Subtract (x, y) from this vector.
Vector2d	sub(double x, double y, Vector2d dest) Subtract (x, y) from this vector and store the result in dest.
Vector2d	sub(Vector2d v) Subtract v from this vector.
Vector2d	sub(Vector2d v, Vector2d dest) Subtract v from this vector and store the result in dest.
Vector2d	sub(Vector2f v) Subtract v from this vector.
Vector2d	sub(Vector2f v, Vector2d dest) Subtract v from this vector and store the result in dest.
static void	sub(Vector2f a, Vector2d b, Vector2d dest) Subtract b from a and store the result in dest.
String	toString() Return a string representation of this vector.
String	toString(NumberFormat formatter) Return a string representation of this vector by formatting the vector components with the given NumberFormat.
void	writeExternal(ObjectOutput out)
Vector2d	zero() Set all components to zero.

Methods inherited from class java.lang.Object

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

Field Detail

x

public double x

The x component of the vector.

y

public double y

The y component of the vector.

Constructor Detail

Vector2d

public Vector2d()

Create a new Vector2d and initialize its components to zero.

Vector2d

public Vector2d(double d)

Create a new Vector2d and initialize both of its components with the given value.

Parameters:

d - the value of both components

Vector2d

public Vector2d(double x,
                double y)

Create a new Vector2d and initialize its components to the given values.

Parameters:

x - the x value

y - the y value

Vector2d

public Vector2d(Vector2d v)

Create a new Vector2d and initialize its components to the one of the given vector.

Parameters:

v - the Vector2d to copy the values from

Vector2d

public Vector2d(Vector2f v)

Create a new Vector2d and initialize its components to the one of the given vector.

Parameters:

v - the Vector2f to copy the values from

Vector2d

public Vector2d(ByteBuffer buffer)

Create a new Vector2d and read this vector from the supplied ByteBuffer at the current buffer position.

This method will not increment the position of the given ByteBuffer.

In order to specify the offset into the ByteBuffer at which the vector is read, use Vector2d(int, ByteBuffer), taking the absolute position as parameter.

Parameters:

buffer - values will be read in x, y order

See Also:

Vector2d(int, ByteBuffer)

Vector2d

public Vector2d(int index,
                ByteBuffer buffer)

Create a new Vector2d and read this vector from the supplied ByteBuffer starting at the specified absolute buffer position/index.

This method will not increment the position of the given ByteBuffer.

Parameters:

index - the absolute position into the ByteBuffer

buffer - values will be read in x, y order

Vector2d

public Vector2d(DoubleBuffer buffer)

Create a new Vector2d and read this vector from the supplied DoubleBuffer at the current buffer position.

This method will not increment the position of the given DoubleBuffer.

In order to specify the offset into the DoubleBuffer at which the vector is read, use Vector2d(int, DoubleBuffer), taking the absolute position as parameter.

Parameters:

buffer - values will be read in x, y order

See Also:

Vector2d(int, DoubleBuffer)

Vector2d

public Vector2d(int index,
                DoubleBuffer buffer)

Create a new Vector2d and read this vector from the supplied DoubleBuffer starting at the specified absolute buffer position/index.

This method will not increment the position of the given DoubleBuffer.

Parameters:

index - the absolute position into the DoubleBuffer

buffer - values will be read in x, y order

Method Detail

set

public Vector2d set(double d)

Set the x and y components to the supplied value.

Parameters:

d - the value of both components

Returns:

this

set

public Vector2d set(double x,
                    double y)

Set the x and y components to the supplied values.

Parameters:

x - the x value

y - the y value

Returns:

this

set

public Vector2d set(Vector2d v)

Set this Vector2d to the values of v.

Parameters:

v - the vector to copy from

Returns:

this

set

public Vector2d set(Vector2f v)

Set this Vector2d to be a clone of v.

Parameters:

v - the vector to copy from

Returns:

this

set

public Vector2d set(ByteBuffer buffer)

Read this vector from the supplied ByteBuffer at the current buffer position.

This method will not increment the position of the given ByteBuffer.

In order to specify the offset into the ByteBuffer at which the vector is read, use set(int, ByteBuffer), taking the absolute position as parameter.

Parameters:

buffer - values will be read in x, y order

Returns:

this

See Also:

set(int, ByteBuffer)

set

public Vector2d set(int index,
                    ByteBuffer buffer)

Read this vector from the supplied ByteBuffer starting at the specified absolute buffer position/index.

This method will not increment the position of the given ByteBuffer.

Parameters:

index - the absolute position into the ByteBuffer

buffer - values will be read in x, y order

Returns:

this

set

public Vector2d set(DoubleBuffer buffer)

Read this vector from the supplied DoubleBuffer at the current buffer position.

This method will not increment the position of the given DoubleBuffer.

In order to specify the offset into the DoubleBuffer at which the vector is read, use set(int, DoubleBuffer), taking the absolute position as parameter.

Parameters:

buffer - values will be read in x, y order

Returns:

this

See Also:

set(int, DoubleBuffer)

set

public Vector2d set(int index,
                    DoubleBuffer buffer)

Read this vector from the supplied DoubleBuffer starting at the specified absolute buffer position/index.

This method will not increment the position of the given DoubleBuffer.

Parameters:

index - the absolute position into the DoubleBuffer

buffer - values will be read in x, y order

Returns:

this

get

public ByteBuffer get(ByteBuffer buffer)

Store this vector into the supplied ByteBuffer at the current buffer position.

This method will not increment the position of the given ByteBuffer.

In order to specify the offset into the ByteBuffer at which the vector is stored, use get(int, ByteBuffer), taking the absolute position as parameter.

Parameters:

buffer - will receive the values of this vector in x, y order

Returns:

the passed in buffer

See Also:

get(int, ByteBuffer)

get

public ByteBuffer get(int index,
                      ByteBuffer buffer)

Store this vector into the supplied ByteBuffer starting at the specified absolute buffer position/index.

This method will not increment the position of the given ByteBuffer.

Parameters:

index - the absolute position into the ByteBuffer

buffer - will receive the values of this vector in x, y order

Returns:

the passed in buffer

get

public DoubleBuffer get(DoubleBuffer buffer)

Store this vector into the supplied DoubleBuffer at the current buffer position.

This method will not increment the position of the given DoubleBuffer.

In order to specify the offset into the DoubleBuffer at which the vector is stored, use get(int, DoubleBuffer), taking the absolute position as parameter.

Parameters:

buffer - will receive the values of this vector in x, y order

Returns:

the passed in buffer

See Also:

get(int, DoubleBuffer)

get

public DoubleBuffer get(int index,
                        DoubleBuffer buffer)

Store this vector into the supplied DoubleBuffer starting at the specified absolute buffer position/index.

This method will not increment the position of the given DoubleBuffer.

Parameters:

index - the absolute position into the DoubleBuffer

buffer - will receive the values of this vector in x, y order

Returns:

the passed in buffer

perpendicular

public static void perpendicular(Vector2d v,
                                 Vector2d dest)

Store one perpendicular vector of v in dest.

Parameters:

v - the vector to build one perpendicular vector of

dest - will hold the result

perpendicular

public Vector2d perpendicular()

Set this vector to be one of its perpendicular vectors.

Returns:

this

sub

public Vector2d sub(Vector2d v)

Subtract v from this vector.

Parameters:

v - the vector to subtract

Returns:

this

sub

public Vector2d sub(double x,
                    double y)

Subtract (x, y) from this vector.

Parameters:

x - the x component to subtract

y - the y component to subtract

Returns:

this

sub

public Vector2d sub(double x,
                    double y,
                    Vector2d dest)

Subtract (x, y) from this vector and store the result in dest.

Parameters:

x - the x component to subtract

y - the y component to subtract

dest - will hold the result

Returns:

dest

sub

public Vector2d sub(Vector2f v)

Subtract v from this vector.

Parameters:

v - the vector to subtract

Returns:

this

sub

public Vector2d sub(Vector2d v,
                    Vector2d dest)

Subtract v from this vector and store the result in dest.

Parameters:

v - the vector to subtract

dest - will hold the result

Returns:

dest

sub

public Vector2d sub(Vector2f v,
                    Vector2d dest)

Subtract v from this vector and store the result in dest.

Parameters:

v - the vector to subtract

dest - will hold the result

Returns:

dest

sub

public static void sub(Vector2f a,
                       Vector2d b,
                       Vector2d dest)

Subtract b from a and store the result in dest.

Parameters:

a - the vector to subtract from

b - the vector to subtract

dest - will hold the result

dot

public double dot(Vector2d v)

Return the dot product of this vector and v.

Parameters:

v - the other vector

Returns:

the dot product

angle

public double angle(Vector2d v)

Return the angle between this vector and the supplied vector.

Parameters:

v - the other vector

Returns:

the angle, in radians

length

public double length()

Return the length of this vector.

Returns:

the length

distance

public double distance(Vector2d v)

Return the distance between this and v.

Parameters:

v - the other vector

Returns:

the euclidean distance

distance

public double distance(Vector2f v)

Return the distance between this and v.

Parameters:

v - the other vector

Returns:

the euclidean distance

normalize

public Vector2d normalize()

Normalize this vector.

Returns:

this

normalize

public Vector2d normalize(Vector2d dest)

Normalize this vector and store the result in dest.

Parameters:

dest - will hold the result

Returns:

dest

add

public Vector2d add(Vector2d v)

Add v to this vector.

Parameters:

v - the vector to add

Returns:

this

add

public Vector2d add(double x,
                    double y)

Add (x, y) to this vector.

Parameters:

x - the x component to add

y - the y component to add

Returns:

this

add

public Vector2d add(double x,
                    double y,
                    Vector2d dest)

Add (x, y) to this vector and store the result in dest.

Parameters:

x - the x component to add

y - the y component to add

dest - will hold the result

Returns:

dest

add

public Vector2d add(Vector2f v)

Add v to this vector.

Parameters:

v - the vector to add

Returns:

this

add

public Vector2d add(Vector2d v,
                    Vector2d dest)

Add v to this vector and store the result in dest.

Parameters:

v - the vector to add

dest - will hold the result

Returns:

dest

add

public Vector2d add(Vector2f v,
                    Vector2d dest)

Add v to this vector and store the result in dest.

Parameters:

v - the vector to add

dest - will hold the result

Returns:

dest

add

public static void add(Vector2f a,
                       Vector2d b,
                       Vector2d dest)

Add a to b and store the result in dest.

Parameters:

a - the first addend

b - the second addend

dest - will hold the result

zero

public Vector2d zero()

Set all components to zero.

Returns:

this

writeExternal

public void writeExternal(ObjectOutput out)
                   throws IOException

Specified by:

writeExternal in interface Externalizable

Throws:

IOException

readExternal

public void readExternal(ObjectInput in)
                  throws IOException,
                         ClassNotFoundException

Specified by:

readExternal in interface Externalizable

Throws:

IOException

ClassNotFoundException

negate

public Vector2d negate()

Negate this vector.

Returns:

this

negate

public Vector2d negate(Vector2d dest)

Negate this vector and store the result in dest.

Parameters:

dest - will hold the result

Returns:

dest

lerp

public Vector2d lerp(Vector2d other,
                     double t)

Linearly interpolate this and other using the given interpolation factor t and store the result in this.

If t is 0.0 then the result is this. If the interpolation factor is 1.0 then the result is other.

Parameters:

other - the other vector

t - the interpolation factor between 0.0 and 1.0

Returns:

this

lerp

public Vector2d lerp(Vector2d other,
                     double t,
                     Vector2d dest)

Linearly interpolate this and other using the given interpolation factor t and store the result in dest.

If t is 0.0 then the result is this. If the interpolation factor is 1.0 then the result is other.

Parameters:

other - the other vector

t - the interpolation factor between 0.0 and 1.0

dest - will hold the result

Returns:

dest

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

toString

public String toString()

Return a string representation of this vector.

This method creates a new DecimalFormat on every invocation with the format string " 0.000E0;-".

Overrides:

toString in class Object

Returns:

the string representation

toString

public String toString(NumberFormat formatter)

Return a string representation of this vector by formatting the vector components with the given NumberFormat.

Parameters:

formatter - the NumberFormat used to format the vector components with

Returns:

the string representation

fma

public Vector2d fma(Vector2d a,
                    Vector2d b)

Add the component-wise multiplication of a * b to this vector.

Parameters:

a - the first multiplicand

b - the second multiplicand

Returns:

this

fma

public Vector2d fma(double a,
                    Vector2d b)

Add the component-wise multiplication of a * b to this vector.

Parameters:

a - the first multiplicand

b - the second multiplicand

Returns:

this

fma

public Vector2d fma(Vector2d a,
                    Vector2d b,
                    Vector2d dest)

Add the component-wise multiplication of a * b to this vector and store the result in dest.

Parameters:

a - the first multiplicand

b - the second multiplicand

dest - will hold the result

Returns:

dest

fma

public Vector2d fma(double a,
                    Vector2d b,
                    Vector2d dest)

Add the component-wise multiplication of a * b to this vector and store the result in dest.

Parameters:

a - the first multiplicand

b - the second multiplicand

dest - will hold the result

Returns:

dest