org.joml

Class Vector2f

java.lang.Object

org.joml.Vector2f

All Implemented Interfaces:

Externalizable, Serializable

public class Vector2f
extends Object
implements Externalizable

Represents a 2D vector with single-precision.

Author:

RGreenlees, Kai Burjack

See Also:

Serialized Form

Field Summary

Fields

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

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method and Description
Vector2f	add(Vector2f v) Add v to this vector.
static void	add(Vector2f a, Vector2f b, Vector2f dest) Add a to b and store the result in dest.
float	angle(Vector2f v) Return the angle between this vector and the supplied vector.
float	distance(Vector2f v) Return the distance between this and v.
float	dot(Vector2f v) Return the dot product of this vector and v.
boolean	equals(Object obj)
Vector2f	fma(float a, Vector2f b) Add the component-wise multiplication of a * b to this vector.
Vector2f	fma(float a, Vector2f b, Vector2f dest) Add the component-wise multiplication of a * b to this vector and store the result in dest.
Vector2f	fma(Vector2f a, Vector2f b) Add the component-wise multiplication of a * b to this vector.
Vector2f	fma(Vector2f a, Vector2f b, Vector2f 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.
FloatBuffer	get(FloatBuffer buffer) Store this vector into the supplied FloatBuffer 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.
FloatBuffer	get(int index, FloatBuffer buffer) Store this vector into the supplied FloatBuffer starting at the specified absolute buffer position/index.
int	hashCode()
float	length() Return the length of this vector.
float	lengthSquared() Return the length squared of this vector.
Vector2f	lerp(Vector2f other, float t) Linearly interpolate this and other using the given interpolation factor t and store the result in this.
Vector2f	lerp(Vector2f other, float t, Vector2f dest) Linearly interpolate this and other using the given interpolation factor t and store the result in dest.
Vector2f	mul(float scalar) Multiply the components of this vector by the given scalar.
Vector2f	mul(float scalar, Vector2f dest) Multiply the components of this vector by the given scalar and store the result in dest.
Vector2f	mul(Matrix3f m) Multiply this vector by the given matrix.
Vector2f	mul(Matrix3f m, Vector2f dest) Multiply this vector by the given matrix and store the result in dest.
Vector2f	negate() Negate this vector.
Vector2f	negate(Vector2f dest) Negate this vector and store the result in dest.
Vector2f	normalize() Normalize this vector.
Vector2f	normalize(Vector2f dest) Normalize this vector and store the result in dest.
Vector2f	perpendicular() Set this vector to be one of its perpendicular vectors.
static void	perpendicular(Vector2f v, Vector2f dest) Store one perpendicular vector of v in dest.
void	readExternal(ObjectInput in)
Vector2f	set(ByteBuffer buffer) Read this vector from the supplied ByteBuffer at the current buffer position.
Vector2f	set(float d) Set the x and y components to the supplied value.
Vector2f	set(FloatBuffer buffer) Read this vector from the supplied FloatBuffer at the current buffer position.
Vector2f	set(float x, float y) Set the x and y components to the supplied values.
Vector2f	set(int index, ByteBuffer buffer) Read this vector from the supplied ByteBuffer starting at the specified absolute buffer position/index.
Vector2f	set(int index, FloatBuffer buffer) Read this vector from the supplied FloatBuffer starting at the specified absolute buffer position/index.
Vector2f	set(Vector2f v) Set this Vector2f to the values of v.
Vector2f	sub(float x, float y) Subtract (x, y) from this vector.
Vector2f	sub(Vector2f v) Subtract v from this vector.
static void	sub(Vector2f a, Vector2f b, Vector2f 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)
Vector2f	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 float x

The x component of the vector.

y

public float y

The y component of the vector.

Constructor Detail

Vector2f

public Vector2f()

Create a new Vector2f and initialize its components to zero.

Vector2f

public Vector2f(float d)

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

Parameters:

d - the value of both components

Vector2f

public Vector2f(float x,
                float y)

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

Parameters:

x - the x component

y - the y component

Vector2f

public Vector2f(Vector2f v)

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

Parameters:

v - the Vector2f to copy the values from

Vector2f

public Vector2f(ByteBuffer buffer)

Create a new Vector2f 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 Vector2f(int, ByteBuffer), taking the absolute position as parameter.

Parameters:

buffer - values will be read in x, y order

See Also:

Vector2f(int, ByteBuffer)

Vector2f

public Vector2f(int index,
                ByteBuffer buffer)

Create a new Vector2f 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

Vector2f

public Vector2f(FloatBuffer buffer)

Create a new Vector2f and read this vector from the supplied FloatBuffer at the current buffer position.

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

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

Parameters:

buffer - values will be read in x, y order

See Also:

Vector2f(int, FloatBuffer)

Vector2f

public Vector2f(int index,
                FloatBuffer buffer)

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

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

Parameters:

index - the absolute position into the FloatBuffer

buffer - values will be read in x, y order

Method Detail

set

public Vector2f set(float d)

Set the x and y components to the supplied value.

Parameters:

d - the value of both components

Returns:

this

set

public Vector2f set(float x,
                    float y)

Set the x and y components to the supplied values.

Parameters:

x - the x component

y - the y component

Returns:

this

set

public Vector2f set(Vector2f v)

Set this Vector2f to the values of v.

Parameters:

v - the vector to copy from

Returns:

this

set

public Vector2f 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 Vector2f 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 Vector2f set(FloatBuffer buffer)

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

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

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

Parameters:

buffer - values will be read in x, y order

Returns:

this

See Also:

set(int, FloatBuffer)

set

public Vector2f set(int index,
                    FloatBuffer buffer)

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

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

Parameters:

index - the absolute position into the FloatBuffer

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 FloatBuffer get(FloatBuffer buffer)

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

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

In order to specify the offset into the FloatBuffer at which the vector is stored, use get(int, FloatBuffer), 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, FloatBuffer)

get

public FloatBuffer get(int index,
                       FloatBuffer buffer)

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

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

Parameters:

index - the absolute position into the FloatBuffer

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

Returns:

the passed in buffer

perpendicular

public static void perpendicular(Vector2f v,
                                 Vector2f 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 Vector2f perpendicular()

Set this vector to be one of its perpendicular vectors.

Returns:

this

sub

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

Subtract b from a and store the result in dest.

Parameters:

a - the first operand

b - the second operand

dest - will hold the result of a - b

sub

public Vector2f sub(Vector2f v)

Subtract v from this vector.

Parameters:

v - the vector to subtract from this

Returns:

this

sub

public Vector2f sub(float x,
                    float y)

Subtract (x, y) from this vector.

Parameters:

x - the x component to subtract

y - the y component to subtract

Returns:

this

dot

public float dot(Vector2f v)

Return the dot product of this vector and v.

Parameters:

v - the other vector

Returns:

the dot product

angle

public float angle(Vector2f v)

Return the angle between this vector and the supplied vector.

Parameters:

v - the other vector

Returns:

the angle, in radians

length

public float length()

Return the length of this vector.

Returns:

the length

lengthSquared

public float lengthSquared()

Return the length squared of this vector.

Returns:

the length squared

distance

public float distance(Vector2f v)

Return the distance between this and v.

Parameters:

v - the other vector

Returns:

the distance

normalize

public Vector2f normalize()

Normalize this vector.

Returns:

this

normalize

public Vector2f normalize(Vector2f dest)

Normalize this vector and store the result in dest.

Parameters:

dest - will hold the result

Returns:

dest

add

public Vector2f add(Vector2f v)

Add v to this vector.

Parameters:

v - the vector to add

Returns:

this

add

public static void add(Vector2f a,
                       Vector2f b,
                       Vector2f 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 Vector2f 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 Vector2f negate()

Negate this vector.

Returns:

this

negate

public Vector2f negate(Vector2f dest)

Negate this vector and store the result in dest.

Parameters:

dest - will hold the result

Returns:

dest

mul

public Vector2f mul(float scalar)

Multiply the components of this vector by the given scalar.

Parameters:

scalar - the value to multiply this vector's components by

Returns:

this

mul

public Vector2f mul(float scalar,
                    Vector2f dest)

Multiply the components of this vector by the given scalar and store the result in dest.

Parameters:

scalar - the value to multiply this vector's components by

dest - will hold the result

Returns:

dest

mul

public Vector2f mul(Matrix3f m)

Multiply this vector by the given matrix.

Parameters:

m - the matrix to multiply this vector by

Returns:

this

mul

public Vector2f mul(Matrix3f m,
                    Vector2f dest)

Multiply this vector by the given matrix and store the result in dest.

Parameters:

m - the matrix to multiply this vector by

dest - will hold the result

Returns:

dest

lerp

public Vector2f lerp(Vector2f other,
                     float 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 Vector2f lerp(Vector2f other,
                     float t,
                     Vector2f 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 Vector2f fma(Vector2f a,
                    Vector2f 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 Vector2f fma(float a,
                    Vector2f 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 Vector2f fma(Vector2f a,
                    Vector2f b,
                    Vector2f 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 Vector2f fma(float a,
                    Vector2f b,
                    Vector2f 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