Vector2f (JOML 2D 1.5.0 API)

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-coordinate of the vector.

float y
The y-coordinate of the vector.

Fields
Modifier and Type	Field and Description
`float`	`x` The x-coordinate of the vector.
`float`	`y` The y-coordinate of the vector.

Constructor Summary

Constructors
Constructor and Description
`Vector2f()` Create a new `Vector2f` and initialize its components to zero.
`Vector2f(float x, float y)` Create a new `Vector2f` and initialize its components to the given values.
`Vector2f(Vector2f v)` Create a new `Vector2f` and initialize its components to the one of the given vector.

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
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)`
`int`	`hashCode()`
`float`	`length()` Return the length of this vector.
`float`	`lengthSquared()` Return the length squared of this vector.
`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(float x, float y)` Set the x and y attributes to the supplied values.
`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-coordinate of the vector.
  - y
```
public float y
```
    The y-coordinate of the vector.
- Constructor Detail
  - Vector2f
```
public Vector2f()
```
    Create a new Vector2f and initialize its components to zero.
  - Vector2f
```
public Vector2f(float x,
                float y)
```
    Create a new Vector2f and initialize its components to the given values.
    
    Parameters:
    
    x - the x value
    
    y - the y value
  - 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
- Method Detail
  - set
```
public Vector2f set(float x,
                    float y)
```
    Set the x and y attributes to the supplied values.
    
    Parameters:
    
    x - the x value to set
    
    y - the y value to set
    
    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
  - 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-coordinate to subtract
    
    y - the y-coordinate 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
  - 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

Class Vector2f

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

x

y

Constructor Detail

Vector2f

Vector2f

Vector2f

Method Detail

set

set

perpendicular

perpendicular

sub

sub

sub

dot

angle

length

lengthSquared

distance

normalize

normalize

add

add

zero

writeExternal

readExternal

negate

negate

mul

mul

mul

mul

hashCode

equals

toString

toString