Package org.joml

Class Vector3f

java.lang.Object
org.joml.Vector3f
All Implemented Interfaces:
Externalizable, Serializable, Cloneable, Vector3fc

public class Vector3f extends Object implements Externalizable, Cloneable, Vector3fc
Contains the definition of a Vector comprising 3 floats and associated transformations.
Author:
Richard Greenlees, Kai Burjack, F. Neurath
See Also:
  • Field Summary

    Fields
    Modifier and Type
    Field
    Description
    float
    The x component of the vector.
    float
    The y component of the vector.
    float
    The z component of the vector.
  • Constructor Summary

    Constructors
    Constructor
    Description
    Create a new Vector3f of (0, 0, 0).
    Vector3f(float d)
    Create a new Vector3f and initialize all three components with the given value.
    Vector3f(float[] xyz)
    Create a new Vector3f and initialize its three components from the first three elements of the given array.
    Vector3f(float x, float y, float z)
    Create a new Vector3f with the given component values.
    Vector3f(int index, ByteBuffer buffer)
    Create a new Vector3f and read this vector from the supplied ByteBuffer starting at the specified absolute buffer position/index.
    Vector3f(int index, FloatBuffer buffer)
    Create a new Vector3f and read this vector from the supplied FloatBuffer starting at the specified absolute buffer position/index.
    Create a new Vector3f and read this vector from the supplied ByteBuffer at the current buffer position.
    Create a new Vector3f and read this vector from the supplied FloatBuffer at the current buffer position.
    Vector3f(Vector2fc v, float z)
    Create a new Vector3f with the first two components from the given v and the given z
    Vector3f(Vector2ic v, float z)
    Create a new Vector3f with the first two components from the given v and the given z
    Create a new Vector3f with the same values as v.
    Create a new Vector3f with the same values as v.
  • Method Summary

    Modifier and Type
    Method
    Description
    Set this vector's components to their respective absolute values.
    Compute the absolute values of the individual components of this and store the result in dest.
    add(float x, float y, float z)
    Increment the components of this vector by the given values.
    add(float x, float y, float z, Vector3f dest)
    Increment the components of this vector by the given values and store the result in dest.
    Add the supplied vector to this one.
    Add the supplied vector to this one and store the result in dest.
    float
    Return the angle between this vector and the supplied vector.
    float
    Return the cosine of the angle between this vector and the supplied vector.
    float
    angleSigned(float x, float y, float z, float nx, float ny, float nz)
    Return the signed angle between this vector and the supplied vector with respect to the plane with the given normal vector (nx, ny, nz).
    float
    Return the signed angle between this vector and the supplied vector with respect to the plane with the given normal vector n.
    Set each component of this vector to the smallest (closest to negative infinity) float value that is greater than or equal to that component and is equal to a mathematical integer.
    ceil(Vector3f dest)
    Compute for each component of this vector the smallest (closest to negative infinity) float value that is greater than or equal to that component and is equal to a mathematical integer and store the result in dest.
     
    cross(float x, float y, float z)
    Set this vector to be the cross product of itself and (x, y, z).
    cross(float x, float y, float z, Vector3f dest)
    Compute the cross product of this vector and (x, y, z) and store the result in dest.
    Set this vector to be the cross product of itself and v.
    Compute the cross product of this vector and v and store the result in dest.
    float
    distance(float x, float y, float z)
    Return the distance between this vector and (x, y, z).
    static float
    distance(float x1, float y1, float z1, float x2, float y2, float z2)
    Return the distance between (x1, y1, z1) and (x2, y2, z2).
    float
    Return the distance between this Vector and v.
    float
    distanceSquared(float x, float y, float z)
    Return the square of the distance between this vector and (x, y, z).
    static float
    distanceSquared(float x1, float y1, float z1, float x2, float y2, float z2)
    Return the squared distance between (x1, y1, z1) and (x2, y2, z2).
    float
    Return the square of the distance between this vector and v.
    div(float scalar)
    Divide all components of this Vector3f by the given scalar value.
    div(float x, float y, float z)
    Divide the components of this Vector3f by the given scalar values and store the result in this.
    div(float x, float y, float z, Vector3f dest)
    Divide the components of this Vector3f by the given scalar values and store the result in dest.
    div(float scalar, Vector3f dest)
    Divide all components of this Vector3f by the given scalar value and store the result in dest.
    Divide this Vector3f component-wise by another Vector3fc.
    Divide this Vector3f component-wise by another Vector3f and store the result in dest.
    float
    dot(float x, float y, float z)
    Return the dot product of this vector and the vector (x, y, z).
    float
    Return the dot product of this vector and the supplied vector.
    boolean
    equals(float x, float y, float z)
    Compare the vector components of this vector with the given (x, y, z) and return whether all of them are equal.
    boolean
     
    boolean
    equals(Vector3fc v, float delta)
    Compare the vector components of this vector with the given vector using the given delta and return whether all of them are equal within a maximum difference of delta.
    Set each component of this vector to the largest (closest to positive infinity) float value that is less than or equal to that component and is equal to a mathematical integer.
    Compute for each component of this vector the largest (closest to positive infinity) float value that is less than or equal to that component and is equal to a mathematical integer and store the result in dest.
    fma(float a, Vector3fc b)
    Add the component-wise multiplication of a * b to this vector.
    fma(float a, Vector3fc b, Vector3f dest)
    Add the component-wise multiplication of a * b to this vector and store the result in dest.
    Add the component-wise multiplication of a * b to this vector.
    Add the component-wise multiplication of a * b to this vector and store the result in dest.
    float
    get(int component)
    Get the value of the specified component of this vector.
    get(int index, ByteBuffer buffer)
    Store this vector into the supplied ByteBuffer starting at the specified absolute buffer position/index.
    get(int index, FloatBuffer buffer)
    Store this vector into the supplied FloatBuffer starting at the specified absolute buffer position/index.
    get(int mode, Vector3i dest)
    Set the components of the given vector dest to those of this vector using the given RoundingMode.
    get(ByteBuffer buffer)
    Store this vector into the supplied ByteBuffer at the current buffer position.
    get(FloatBuffer buffer)
    Store this vector into the supplied FloatBuffer at the current buffer position.
    get(Vector3d dest)
    Set the components of the given vector dest to those of this vector.
    get(Vector3f dest)
    Set the components of the given vector dest to those of this vector.
    getToAddress(long address)
    Store this vector at the given off-heap memory address.
    half(float x, float y, float z)
    Compute the half vector between this and the vector (x, y, z).
    half(float x, float y, float z, Vector3f dest)
    Compute the half vector between this and the vector (x, y, z) and store the result in dest.
    half(Vector3fc other)
    Compute the half vector between this and the other vector.
    half(Vector3fc other, Vector3f dest)
    Compute the half vector between this and the other vector and store the result in dest.
    int
     
    hermite(Vector3fc t0, Vector3fc v1, Vector3fc t1, float t, Vector3f dest)
    Compute a hermite interpolation between this vector with its associated tangent t0 and the given vector v with its tangent t1 and store the result in dest.
    boolean
    Determine whether all components are finite floating-point values, that is, they are not NaN and not infinity.
    float
    Return the length of this vector.
    static float
    length(float x, float y, float z)
    Get the length of a 3-dimensional single-precision vector.
    float
    Return the length squared of this vector.
    static float
    lengthSquared(float x, float y, float z)
    Get the length squared of a 3-dimensional single-precision vector.
    lerp(Vector3fc other, float t)
    Linearly interpolate this and other using the given interpolation factor t and store the result in this.
    lerp(Vector3fc other, float t, Vector3f dest)
    Linearly interpolate this and other using the given interpolation factor t and store the result in dest.
    Set the components of this vector to be the component-wise maximum of this and the other vector.
    Set the components of dest to be the component-wise maximum of this and the other vector.
    int
    Determine the component with the biggest absolute value.
    Set the components of this vector to be the component-wise minimum of this and the other vector.
    Set the components of dest to be the component-wise minimum of this and the other vector.
    int
    Determine the component with the smallest (towards zero) absolute value.
    mul(float scalar)
    Multiply all components of this Vector3f by the given scalar value.
    mul(float x, float y, float z)
    Multiply the components of this Vector3f by the given scalar values and store the result in this.
    mul(float x, float y, float z, Vector3f dest)
    Multiply the components of this Vector3f by the given scalar values and store the result in dest.
    mul(float scalar, Vector3f dest)
    Multiply all components of this Vector3f by the given scalar value and store the result in dest.
    Multiply the given matrix with this Vector3f and store the result in this.
    mul(Matrix3dc mat, Vector3f dest)
    Multiply the given matrix with this Vector3f and store the result in dest.
    Multiply the given matrix with this Vector3f and store the result in this.
    mul(Matrix3fc mat, Vector3f dest)
    Multiply the given matrix with this Vector3f and store the result in dest.
    Multiply the given matrix with this Vector3f and store the result in this.
    mul(Matrix3x2fc mat, Vector3f dest)
    Multiply the given matrix mat with this by assuming a third row in the matrix of (0, 0, 1) and store the result in dest.
    Multiply this Vector3f component-wise by another Vector3fc.
    Multiply this Vector3f component-wise by another Vector3f and store the result in dest.
    mulAdd(float a, Vector3fc b)
    Add the component-wise multiplication of this * a to b and store the result in this.
    mulAdd(float a, Vector3fc b, Vector3f dest)
    Add the component-wise multiplication of this * a to b and store the result in dest.
    Add the component-wise multiplication of this * a to b and store the result in this.
    Add the component-wise multiplication of this * a to b and store the result in dest.
    Multiply the given 4x4 matrix mat with this.
    Multiply the given 4x4 matrix mat with this and store the result in dest.
    Multiply the given 4x4 matrix mat with this.
    Multiply the given 4x4 matrix mat with this and store the result in dest.
    Multiply the given 4x3 matrix mat with this.
    Multiply the given 4x3 matrix mat with this and store the result in dest.
    Multiply the given 4x4 matrix mat with this.
    Multiply the given 4x4 matrix mat with this and store the result in dest.
    Multiply the given 4x3 matrix mat with this.
    Multiply the given 4x3 matrix mat with this and store the result in dest.
    float
    Multiply the given 4x4 matrix mat with this and return the w component of the resulting 4D vector.
    float
    Multiply the given 4x4 matrix mat with this, store the result in dest and return the w component of the resulting 4D vector.
    Multiply the given matrix mat with this Vector3f, perform perspective division.
    mulProject(Matrix4fc mat, float w, Vector3f dest)
    Multiply the given matrix mat with this Vector3f, perform perspective division and store the result in dest.
    Multiply the given matrix mat with this Vector3f, perform perspective division and store the result in dest.
    Multiply the transpose of the given matrix with this Vector3f store the result in this.
    Multiply the transpose of the given matrix with this Vector3f and store the result in dest.
    Multiply the transpose of the given 4x4 matrix mat with this.
    Multiply the transpose of the given 4x4 matrix mat with this and store the result in dest.
    Multiply the transpose of the given 4x4 matrix mat with this.
    Multiply the transpose of the given 4x4 matrix mat with this and store the result in dest.
    Negate this vector.
    Negate this vector and store the result in dest.
    Normalize this vector.
    normalize(float length)
    Scale this vector to have the given length.
    normalize(float length, Vector3f dest)
    Scale this vector to have the given length and store the result in dest.
    Normalize this vector and store the result in dest.
    Transform this vector so that it is orthogonal to the given vector v and normalize the result.
    Transform this vector so that it is orthogonal to the given vector v, normalize the result and store it into dest.
    Transform this vector so that it is orthogonal to the given unit vector v and normalize the result.
    Transform this vector so that it is orthogonal to the given unit vector v, normalize the result and store it into dest.
    void
     
    reflect(float x, float y, float z)
    Reflect this vector about the given normal vector.
    reflect(float x, float y, float z, Vector3f dest)
    Reflect this vector about the given normal vector and store the result in dest.
    Reflect this vector about the given normal vector.
    reflect(Vector3fc normal, Vector3f dest)
    Reflect this vector about the given normal vector and store the result in dest.
    Rotate this vector by the given quaternion quat and store the result in this.
    Rotate this vector by the given quaternion quat and store the result in dest.
    rotateAxis(float angle, float x, float y, float z)
    Rotate this vector the specified radians around the given rotation axis.
    rotateAxis(float angle, float aX, float aY, float aZ, Vector3f dest)
    Rotate this vector the specified radians around the given rotation axis and store the result into dest.
    rotateX(float angle)
    Rotate this vector the specified radians around the X axis.
    rotateX(float angle, Vector3f dest)
    Rotate this vector the specified radians around the X axis and store the result into dest.
    rotateY(float angle)
    Rotate this vector the specified radians around the Y axis.
    rotateY(float angle, Vector3f dest)
    Rotate this vector the specified radians around the Y axis and store the result into dest.
    rotateZ(float angle)
    Rotate this vector the specified radians around the Z axis.
    rotateZ(float angle, Vector3f dest)
    Rotate this vector the specified radians around the Z axis and store the result into dest.
    rotationTo(float toDirX, float toDirY, float toDirZ, Quaternionf dest)
    Compute the quaternion representing a rotation of this vector to point along (toDirX, toDirY, toDirZ) and store the result in dest.
    Compute the quaternion representing a rotation of this vector to point along toDir and store the result in dest.
    Set each component of this vector to the closest float that is equal to a mathematical integer, with ties rounding to positive infinity.
    Compute for each component of this vector the closest float that is equal to a mathematical integer, with ties rounding to positive infinity and store the result in dest.
    set(double d)
    Set the x, y, and z components to the supplied value.
    set(double x, double y, double z)
    Set the x, y and z components to the supplied values.
    set(float d)
    Set the x, y, and z components to the supplied value.
    set(float[] xyz)
    Set the three components of this vector to the first three elements of the given array.
    set(float x, float y, float z)
    Set the x, y and z components to the supplied values.
    set(int index, ByteBuffer buffer)
    Read this vector from the supplied ByteBuffer starting at the specified absolute buffer position/index.
    set(int index, FloatBuffer buffer)
    Read this vector from the supplied FloatBuffer starting at the specified absolute buffer position/index.
    set(ByteBuffer buffer)
    Read this vector from the supplied ByteBuffer at the current buffer position.
    set(FloatBuffer buffer)
    Read this vector from the supplied FloatBuffer at the current buffer position.
    set(Vector2dc v, float z)
    Set the first two components from the given v and the z component from the given z
    set(Vector2fc v, float z)
    Set the first two components from the given v and the z component from the given z
    set(Vector2ic v, float z)
    Set the first two components from the given v and the z component from the given z
    Set the x, y and z components to match the supplied vector.
    Set the x, y and z components to match the supplied vector.
    Set the x, y and z components to match the supplied vector.
    setComponent(int component, float value)
    Set the value of the specified component of this vector.
    setFromAddress(long address)
    Set the values of this vector by reading 3 float values from off-heap memory, starting at the given address.
    smoothStep(Vector3fc v, float t, Vector3f dest)
    Compute a smooth-step (i.e. hermite with zero tangents) interpolation between this vector and the given vector v and store the result in dest.
    sub(float x, float y, float z)
    Decrement the components of this vector by the given values.
    sub(float x, float y, float z, Vector3f dest)
    Decrement the components of this vector by the given values and store the result in dest.
    Subtract the supplied vector from this one and store the result in this.
    Subtract the supplied vector from this one and store the result in dest.
    Return a string representation of this vector.
    Return a string representation of this vector by formatting the vector components with the given NumberFormat.
    void
     
    float
    x()
     
    float
    y()
     
    float
    z()
     
    Set all components to zero.

    Methods inherited from class java.lang.Object

    finalize, getClass, notify, notifyAll, wait, wait, wait
  • Field Details

    • x

      public float x
      The x component of the vector.
    • y

      public float y
      The y component of the vector.
    • z

      public float z
      The z component of the vector.
  • Constructor Details

    • Vector3f

      public Vector3f()
      Create a new Vector3f of (0, 0, 0).
    • Vector3f

      public Vector3f(float d)
      Create a new Vector3f and initialize all three components with the given value.
      Parameters:
      d - the value of all three components
    • Vector3f

      public Vector3f(float x, float y, float z)
      Create a new Vector3f with the given component values.
      Parameters:
      x - the value of x
      y - the value of y
      z - the value of z
    • Vector3f

      public Vector3f(Vector3fc v)
      Create a new Vector3f with the same values as v.
      Parameters:
      v - the Vector3fc to copy the values from
    • Vector3f

      public Vector3f(Vector3ic v)
      Create a new Vector3f with the same values as v.
      Parameters:
      v - the Vector3ic to copy the values from
    • Vector3f

      public Vector3f(Vector2fc v, float z)
      Create a new Vector3f with the first two components from the given v and the given z
      Parameters:
      v - the Vector2fc to copy the values from
      z - the z component
    • Vector3f

      public Vector3f(Vector2ic v, float z)
      Create a new Vector3f with the first two components from the given v and the given z
      Parameters:
      v - the Vector2ic to copy the values from
      z - the z component
    • Vector3f

      public Vector3f(float[] xyz)
      Create a new Vector3f and initialize its three components from the first three elements of the given array.
      Parameters:
      xyz - the array containing at least three elements
    • Vector3f

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

      Parameters:
      buffer - values will be read in x, y, z order
      See Also:
    • Vector3f

      public Vector3f(int index, ByteBuffer buffer)
      Create a new Vector3f 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, z order
    • Vector3f

      public Vector3f(FloatBuffer buffer)
      Create a new Vector3f 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 Vector3f(int, FloatBuffer), taking the absolute position as parameter.

      Parameters:
      buffer - values will be read in x, y, z order
      See Also:
    • Vector3f

      public Vector3f(int index, FloatBuffer buffer)
      Create a new Vector3f 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, z order
  • Method Details

    • x

      public float x()
      Specified by:
      x in interface Vector3fc
      Returns:
      the value of the x component
    • y

      public float y()
      Specified by:
      y in interface Vector3fc
      Returns:
      the value of the y component
    • z

      public float z()
      Specified by:
      z in interface Vector3fc
      Returns:
      the value of the z component
    • set

      public Vector3f set(Vector3fc v)
      Set the x, y and z components to match the supplied vector.
      Parameters:
      v - contains the values of x, y and z to set
      Returns:
      this
    • set

      public Vector3f set(Vector3dc v)
      Set the x, y and z components to match the supplied vector.

      Note that due to the given vector v storing the components in double-precision, there is the possibility to lose precision.

      Parameters:
      v - contains the values of x, y and z to set
      Returns:
      this
    • set

      public Vector3f set(Vector3ic v)
      Set the x, y and z components to match the supplied vector.
      Parameters:
      v - contains the values of x, y and z to set
      Returns:
      this
    • set

      public Vector3f set(Vector2fc v, float z)
      Set the first two components from the given v and the z component from the given z
      Parameters:
      v - the Vector2fc to copy the values from
      z - the z component
      Returns:
      this
    • set

      public Vector3f set(Vector2dc v, float z)
      Set the first two components from the given v and the z component from the given z
      Parameters:
      v - the Vector2dc to copy the values from
      z - the z component
      Returns:
      this
    • set

      public Vector3f set(Vector2ic v, float z)
      Set the first two components from the given v and the z component from the given z
      Parameters:
      v - the Vector2ic to copy the values from
      z - the z component
      Returns:
      this
    • set

      public Vector3f set(float d)
      Set the x, y, and z components to the supplied value.
      Parameters:
      d - the value of all three components
      Returns:
      this
    • set

      public Vector3f set(float x, float y, float z)
      Set the x, y and z components to the supplied values.
      Parameters:
      x - the x component
      y - the y component
      z - the z component
      Returns:
      this
    • set

      public Vector3f set(double d)
      Set the x, y, and z components to the supplied value.
      Parameters:
      d - the value of all three components
      Returns:
      this
    • set

      public Vector3f set(double x, double y, double z)
      Set the x, y and z components to the supplied values.
      Parameters:
      x - the x component
      y - the y component
      z - the z component
      Returns:
      this
    • set

      public Vector3f set(float[] xyz)
      Set the three components of this vector to the first three elements of the given array.
      Parameters:
      xyz - the array containing at least three elements
      Returns:
      this
    • set

      public Vector3f 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, z order
      Returns:
      this
      See Also:
    • set

      public Vector3f 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, z order
      Returns:
      this
    • set

      public Vector3f 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, z order
      Returns:
      this
      See Also:
    • set

      public Vector3f 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, z order
      Returns:
      this
    • setFromAddress

      public Vector3f setFromAddress(long address)
      Set the values of this vector by reading 3 float values from off-heap memory, starting at the given address.

      This method will throw an UnsupportedOperationException when JOML is used with `-Djoml.nounsafe`.

      This method is unsafe as it can result in a crash of the JVM process when the specified address range does not belong to this process.

      Parameters:
      address - the off-heap memory address to read the vector values from
      Returns:
      this
    • setComponent

      public Vector3f setComponent(int component, float value) throws IllegalArgumentException
      Set the value of the specified component of this vector.
      Parameters:
      component - the component whose value to set, within [0..2]
      value - the value to set
      Returns:
      this
      Throws:
      IllegalArgumentException - if component is not within [0..2]
    • get

      public FloatBuffer get(FloatBuffer buffer)
      Description copied from interface: Vector3fc
      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 Vector3fc.get(int, FloatBuffer), taking the absolute position as parameter.

      Specified by:
      get in interface Vector3fc
      Parameters:
      buffer - will receive the values of this vector in x, y, z order
      Returns:
      the passed in buffer
      See Also:
    • get

      public FloatBuffer get(int index, FloatBuffer buffer)
      Description copied from interface: Vector3fc
      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.

      Specified by:
      get in interface Vector3fc
      Parameters:
      index - the absolute position into the FloatBuffer
      buffer - will receive the values of this vector in x, y, z order
      Returns:
      the passed in buffer
    • get

      public ByteBuffer get(ByteBuffer buffer)
      Description copied from interface: Vector3fc
      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 Vector3fc.get(int, ByteBuffer), taking the absolute position as parameter.

      Specified by:
      get in interface Vector3fc
      Parameters:
      buffer - will receive the values of this vector in x, y, z order
      Returns:
      the passed in buffer
      See Also:
    • get

      public ByteBuffer get(int index, ByteBuffer buffer)
      Description copied from interface: Vector3fc
      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.

      Specified by:
      get in interface Vector3fc
      Parameters:
      index - the absolute position into the ByteBuffer
      buffer - will receive the values of this vector in x, y, z order
      Returns:
      the passed in buffer
    • getToAddress

      public Vector3fc getToAddress(long address)
      Description copied from interface: Vector3fc
      Store this vector at the given off-heap memory address.

      This method will throw an UnsupportedOperationException when JOML is used with `-Djoml.nounsafe`.

      This method is unsafe as it can result in a crash of the JVM process when the specified address range does not belong to this process.

      Specified by:
      getToAddress in interface Vector3fc
      Parameters:
      address - the off-heap address where to store this vector
      Returns:
      this
    • sub

      public Vector3f sub(Vector3fc v)
      Subtract the supplied vector from this one and store the result in this.
      Parameters:
      v - the vector to subtract
      Returns:
      this
    • sub

      public Vector3f sub(Vector3fc v, Vector3f dest)
      Description copied from interface: Vector3fc
      Subtract the supplied vector from this one and store the result in dest.
      Specified by:
      sub in interface Vector3fc
      Parameters:
      v - the vector to subtract
      dest - will hold the result
      Returns:
      dest
    • sub

      public Vector3f sub(float x, float y, float z)
      Decrement the components of this vector by the given values.
      Parameters:
      x - the x component to subtract
      y - the y component to subtract
      z - the z component to subtract
      Returns:
      this
    • sub

      public Vector3f sub(float x, float y, float z, Vector3f dest)
      Description copied from interface: Vector3fc
      Decrement the components of this vector by the given values and store the result in dest.
      Specified by:
      sub in interface Vector3fc
      Parameters:
      x - the x component to subtract
      y - the y component to subtract
      z - the z component to subtract
      dest - will hold the result
      Returns:
      dest
    • add

      public Vector3f add(Vector3fc v)
      Add the supplied vector to this one.
      Parameters:
      v - the vector to add
      Returns:
      this
    • add

      public Vector3f add(Vector3fc v, Vector3f dest)
      Description copied from interface: Vector3fc
      Add the supplied vector to this one and store the result in dest.
      Specified by:
      add in interface Vector3fc
      Parameters:
      v - the vector to add
      dest - will hold the result
      Returns:
      dest
    • add

      public Vector3f add(float x, float y, float z)
      Increment the components of this vector by the given values.
      Parameters:
      x - the x component to add
      y - the y component to add
      z - the z component to add
      Returns:
      this
    • add

      public Vector3f add(float x, float y, float z, Vector3f dest)
      Description copied from interface: Vector3fc
      Increment the components of this vector by the given values and store the result in dest.
      Specified by:
      add in interface Vector3fc
      Parameters:
      x - the x component to add
      y - the y component to add
      z - the z component to add
      dest - will hold the result
      Returns:
      dest
    • fma

      public Vector3f fma(Vector3fc a, Vector3fc 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 Vector3f fma(float a, Vector3fc 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 Vector3f fma(Vector3fc a, Vector3fc b, Vector3f dest)
      Description copied from interface: Vector3fc
      Add the component-wise multiplication of a * b to this vector and store the result in dest.
      Specified by:
      fma in interface Vector3fc
      Parameters:
      a - the first multiplicand
      b - the second multiplicand
      dest - will hold the result
      Returns:
      dest
    • fma

      public Vector3f fma(float a, Vector3fc b, Vector3f dest)
      Description copied from interface: Vector3fc
      Add the component-wise multiplication of a * b to this vector and store the result in dest.
      Specified by:
      fma in interface Vector3fc
      Parameters:
      a - the first multiplicand
      b - the second multiplicand
      dest - will hold the result
      Returns:
      dest
    • mulAdd

      public Vector3f mulAdd(Vector3fc a, Vector3fc b)
      Add the component-wise multiplication of this * a to b and store the result in this.
      Parameters:
      a - the multiplicand
      b - the addend
      Returns:
      this
    • mulAdd

      public Vector3f mulAdd(float a, Vector3fc b)
      Add the component-wise multiplication of this * a to b and store the result in this.
      Parameters:
      a - the multiplicand
      b - the addend
      Returns:
      this
    • mulAdd

      public Vector3f mulAdd(Vector3fc a, Vector3fc b, Vector3f dest)
      Description copied from interface: Vector3fc
      Add the component-wise multiplication of this * a to b and store the result in dest.
      Specified by:
      mulAdd in interface Vector3fc
      Parameters:
      a - the multiplicand
      b - the addend
      dest - will hold the result
      Returns:
      dest
    • mulAdd

      public Vector3f mulAdd(float a, Vector3fc b, Vector3f dest)
      Description copied from interface: Vector3fc
      Add the component-wise multiplication of this * a to b and store the result in dest.
      Specified by:
      mulAdd in interface Vector3fc
      Parameters:
      a - the multiplicand
      b - the addend
      dest - will hold the result
      Returns:
      dest
    • mul

      public Vector3f mul(Vector3fc v)
      Multiply this Vector3f component-wise by another Vector3fc.
      Parameters:
      v - the vector to multiply by
      Returns:
      this
    • mul

      public Vector3f mul(Vector3fc v, Vector3f dest)
      Description copied from interface: Vector3fc
      Multiply this Vector3f component-wise by another Vector3f and store the result in dest.
      Specified by:
      mul in interface Vector3fc
      Parameters:
      v - the vector to multiply by
      dest - will hold the result
      Returns:
      dest
    • div

      public Vector3f div(Vector3fc v)
      Divide this Vector3f component-wise by another Vector3fc.
      Parameters:
      v - the vector to divide by
      Returns:
      this
    • div

      public Vector3f div(Vector3fc v, Vector3f dest)
      Description copied from interface: Vector3fc
      Divide this Vector3f component-wise by another Vector3f and store the result in dest.
      Specified by:
      div in interface Vector3fc
      Parameters:
      v - the vector to divide by
      dest - will hold the result
      Returns:
      dest
    • mulProject

      public Vector3f mulProject(Matrix4fc mat, Vector3f dest)
      Description copied from interface: Vector3fc
      Multiply the given matrix mat with this Vector3f, perform perspective division and store the result in dest.

      This method uses w=1.0 as the fourth vector component.

      Specified by:
      mulProject in interface Vector3fc
      Parameters:
      mat - the matrix to multiply this vector by
      dest - will hold the result
      Returns:
      dest
    • mulProject

      public Vector3f mulProject(Matrix4fc mat, float w, Vector3f dest)
      Description copied from interface: Vector3fc
      Multiply the given matrix mat with this Vector3f, perform perspective division and store the result in dest.

      This method uses the given w as the fourth vector component.

      Specified by:
      mulProject in interface Vector3fc
      Parameters:
      mat - the matrix to multiply this vector by
      w - the w component to use
      dest - will hold the result
      Returns:
      dest
    • mulProject

      public Vector3f mulProject(Matrix4fc mat)
      Multiply the given matrix mat with this Vector3f, perform perspective division.

      This method uses w=1.0 as the fourth vector component.

      Parameters:
      mat - the matrix to multiply this vector by
      Returns:
      this
    • mul

      public Vector3f mul(Matrix3fc mat)
      Multiply the given matrix with this Vector3f and store the result in this.
      Parameters:
      mat - the matrix
      Returns:
      this
    • mul

      public Vector3f mul(Matrix3fc mat, Vector3f dest)
      Description copied from interface: Vector3fc
      Multiply the given matrix with this Vector3f and store the result in dest.
      Specified by:
      mul in interface Vector3fc
      Parameters:
      mat - the matrix
      dest - will hold the result
      Returns:
      dest
    • mul

      public Vector3f mul(Matrix3dc mat)
      Multiply the given matrix with this Vector3f and store the result in this.
      Parameters:
      mat - the matrix
      Returns:
      this
    • mul

      public Vector3f mul(Matrix3dc mat, Vector3f dest)
      Description copied from interface: Vector3fc
      Multiply the given matrix with this Vector3f and store the result in dest.
      Specified by:
      mul in interface Vector3fc
      Parameters:
      mat - the matrix
      dest - will hold the result
      Returns:
      dest
    • mul

      public Vector3f mul(Matrix3x2fc mat)
      Multiply the given matrix with this Vector3f and store the result in this.
      Parameters:
      mat - the matrix
      Returns:
      this
    • mul

      public Vector3f mul(Matrix3x2fc mat, Vector3f dest)
      Description copied from interface: Vector3fc
      Multiply the given matrix mat with this by assuming a third row in the matrix of (0, 0, 1) and store the result in dest.
      Specified by:
      mul in interface Vector3fc
      Parameters:
      mat - the matrix to multiply this vector by
      dest - will hold the result
      Returns:
      dest
    • mulTranspose

      public Vector3f mulTranspose(Matrix3fc mat)
      Multiply the transpose of the given matrix with this Vector3f store the result in this.
      Parameters:
      mat - the matrix
      Returns:
      this
    • mulTranspose

      public Vector3f mulTranspose(Matrix3fc mat, Vector3f dest)
      Description copied from interface: Vector3fc
      Multiply the transpose of the given matrix with this Vector3f and store the result in dest.
      Specified by:
      mulTranspose in interface Vector3fc
      Parameters:
      mat - the matrix
      dest - will hold the result
      Returns:
      dest
    • mulPosition

      public Vector3f mulPosition(Matrix4fc mat)
      Multiply the given 4x4 matrix mat with this.

      This method assumes the w component of this to be 1.0.

      Parameters:
      mat - the matrix to multiply this vector by
      Returns:
      this
    • mulPosition

      public Vector3f mulPosition(Matrix4x3fc mat)
      Multiply the given 4x3 matrix mat with this.

      This method assumes the w component of this to be 1.0.

      Parameters:
      mat - the matrix to multiply this vector by
      Returns:
      this
    • mulPosition

      public Vector3f mulPosition(Matrix4fc mat, Vector3f dest)
      Description copied from interface: Vector3fc
      Multiply the given 4x4 matrix mat with this and store the result in dest.

      This method assumes the w component of this to be 1.0.

      Specified by:
      mulPosition in interface Vector3fc
      Parameters:
      mat - the matrix to multiply this vector by
      dest - will hold the result
      Returns:
      dest
    • mulPosition

      public Vector3f mulPosition(Matrix4x3fc mat, Vector3f dest)
      Description copied from interface: Vector3fc
      Multiply the given 4x3 matrix mat with this and store the result in dest.

      This method assumes the w component of this to be 1.0.

      Specified by:
      mulPosition in interface Vector3fc
      Parameters:
      mat - the matrix to multiply this vector by
      dest - will hold the result
      Returns:
      dest
    • mulTransposePosition

      public Vector3f mulTransposePosition(Matrix4fc mat)
      Multiply the transpose of the given 4x4 matrix mat with this.

      This method assumes the w component of this to be 1.0.

      Parameters:
      mat - the matrix whose transpose to multiply this vector by
      Returns:
      this
    • mulTransposePosition

      public Vector3f mulTransposePosition(Matrix4fc mat, Vector3f dest)
      Description copied from interface: Vector3fc
      Multiply the transpose of the given 4x4 matrix mat with this and store the result in dest.

      This method assumes the w component of this to be 1.0.

      Specified by:
      mulTransposePosition in interface Vector3fc
      Parameters:
      mat - the matrix whose transpose to multiply this vector by
      dest - will hold the result
      Returns:
      dest
    • mulPositionW

      public float mulPositionW(Matrix4fc mat)
      Multiply the given 4x4 matrix mat with this and return the w component of the resulting 4D vector.

      This method assumes the w component of this to be 1.0.

      Parameters:
      mat - the matrix to multiply this vector by
      Returns:
      the w component of the resulting 4D vector after multiplication
    • mulPositionW

      public float mulPositionW(Matrix4fc mat, Vector3f dest)
      Description copied from interface: Vector3fc
      Multiply the given 4x4 matrix mat with this, store the result in dest and return the w component of the resulting 4D vector.

      This method assumes the w component of this to be 1.0.

      Specified by:
      mulPositionW in interface Vector3fc
      Parameters:
      mat - the matrix to multiply this vector by
      dest - will hold the (x, y, z) components of the resulting vector
      Returns:
      the w component of the resulting 4D vector after multiplication
    • mulDirection

      public Vector3f mulDirection(Matrix4dc mat)
      Multiply the given 4x4 matrix mat with this.

      This method assumes the w component of this to be 0.0.

      Parameters:
      mat - the matrix to multiply this vector by
      Returns:
      this
    • mulDirection

      public Vector3f mulDirection(Matrix4fc mat)
      Multiply the given 4x4 matrix mat with this.

      This method assumes the w component of this to be 0.0.

      Parameters:
      mat - the matrix to multiply this vector by
      Returns:
      this
    • mulDirection

      public Vector3f mulDirection(Matrix4x3fc mat)
      Multiply the given 4x3 matrix mat with this.

      This method assumes the w component of this to be 0.0.

      Parameters:
      mat - the matrix to multiply this vector by
      Returns:
      this
    • mulDirection

      public Vector3f mulDirection(Matrix4dc mat, Vector3f dest)
      Description copied from interface: Vector3fc
      Multiply the given 4x4 matrix mat with this and store the result in dest.

      This method assumes the w component of this to be 0.0.

      Specified by:
      mulDirection in interface Vector3fc
      Parameters:
      mat - the matrix to multiply this vector by
      dest - will hold the result
      Returns:
      dest
    • mulDirection

      public Vector3f mulDirection(Matrix4fc mat, Vector3f dest)
      Description copied from interface: Vector3fc
      Multiply the given 4x4 matrix mat with this and store the result in dest.

      This method assumes the w component of this to be 0.0.

      Specified by:
      mulDirection in interface Vector3fc
      Parameters:
      mat - the matrix to multiply this vector by
      dest - will hold the result
      Returns:
      dest
    • mulDirection

      public Vector3f mulDirection(Matrix4x3fc mat, Vector3f dest)
      Description copied from interface: Vector3fc
      Multiply the given 4x3 matrix mat with this and store the result in dest.

      This method assumes the w component of this to be 0.0.

      Specified by:
      mulDirection in interface Vector3fc
      Parameters:
      mat - the matrix to multiply this vector by
      dest - will hold the result
      Returns:
      dest
    • mulTransposeDirection

      public Vector3f mulTransposeDirection(Matrix4fc mat)
      Multiply the transpose of the given 4x4 matrix mat with this.

      This method assumes the w component of this to be 0.0.

      Parameters:
      mat - the matrix whose transpose to multiply this vector by
      Returns:
      this
    • mulTransposeDirection

      public Vector3f mulTransposeDirection(Matrix4fc mat, Vector3f dest)
      Description copied from interface: Vector3fc
      Multiply the transpose of the given 4x4 matrix mat with this and store the result in dest.

      This method assumes the w component of this to be 0.0.

      Specified by:
      mulTransposeDirection in interface Vector3fc
      Parameters:
      mat - the matrix whose transpose to multiply this vector by
      dest - will hold the result
      Returns:
      dest
    • mul

      public Vector3f mul(float scalar)
      Multiply all components of this Vector3f by the given scalar value.
      Parameters:
      scalar - the scalar to multiply this vector by
      Returns:
      this
    • mul

      public Vector3f mul(float scalar, Vector3f dest)
      Description copied from interface: Vector3fc
      Multiply all components of this Vector3f by the given scalar value and store the result in dest.
      Specified by:
      mul in interface Vector3fc
      Parameters:
      scalar - the scalar to multiply this vector by
      dest - will hold the result
      Returns:
      dest
    • mul

      public Vector3f mul(float x, float y, float z)
      Multiply the components of this Vector3f by the given scalar values and store the result in this.
      Parameters:
      x - the x component to multiply this vector by
      y - the y component to multiply this vector by
      z - the z component to multiply this vector by
      Returns:
      this
    • mul

      public Vector3f mul(float x, float y, float z, Vector3f dest)
      Description copied from interface: Vector3fc
      Multiply the components of this Vector3f by the given scalar values and store the result in dest.
      Specified by:
      mul in interface Vector3fc
      Parameters:
      x - the x component to multiply this vector by
      y - the y component to multiply this vector by
      z - the z component to multiply this vector by
      dest - will hold the result
      Returns:
      dest
    • div

      public Vector3f div(float scalar)
      Divide all components of this Vector3f by the given scalar value.
      Parameters:
      scalar - the scalar to divide by
      Returns:
      this
    • div

      public Vector3f div(float scalar, Vector3f dest)
      Description copied from interface: Vector3fc
      Divide all components of this Vector3f by the given scalar value and store the result in dest.
      Specified by:
      div in interface Vector3fc
      Parameters:
      scalar - the scalar to divide by
      dest - will hold the result
      Returns:
      dest
    • div

      public Vector3f div(float x, float y, float z)
      Divide the components of this Vector3f by the given scalar values and store the result in this.
      Parameters:
      x - the x component to divide this vector by
      y - the y component to divide this vector by
      z - the z component to divide this vector by
      Returns:
      this
    • div

      public Vector3f div(float x, float y, float z, Vector3f dest)
      Description copied from interface: Vector3fc
      Divide the components of this Vector3f by the given scalar values and store the result in dest.
      Specified by:
      div in interface Vector3fc
      Parameters:
      x - the x component to divide this vector by
      y - the y component to divide this vector by
      z - the z component to divide this vector by
      dest - will hold the result
      Returns:
      dest
    • rotate

      public Vector3f rotate(Quaternionfc quat)
      Rotate this vector by the given quaternion quat and store the result in this.
      Parameters:
      quat - the quaternion to rotate this vector
      Returns:
      this
      See Also:
    • rotate

      public Vector3f rotate(Quaternionfc quat, Vector3f dest)
      Description copied from interface: Vector3fc
      Rotate this vector by the given quaternion quat and store the result in dest.
      Specified by:
      rotate in interface Vector3fc
      Parameters:
      quat - the quaternion to rotate this vector
      dest - will hold the result
      Returns:
      dest
      See Also:
    • rotationTo

      public Quaternionf rotationTo(Vector3fc toDir, Quaternionf dest)
      Description copied from interface: Vector3fc
      Compute the quaternion representing a rotation of this vector to point along toDir and store the result in dest.

      Because there can be multiple possible rotations, this method chooses the one with the shortest arc.

      Specified by:
      rotationTo in interface Vector3fc
      Parameters:
      toDir - the destination direction
      dest - will hold the result
      Returns:
      dest
      See Also:
    • rotationTo

      public Quaternionf rotationTo(float toDirX, float toDirY, float toDirZ, Quaternionf dest)
      Description copied from interface: Vector3fc
      Compute the quaternion representing a rotation of this vector to point along (toDirX, toDirY, toDirZ) and store the result in dest.

      Because there can be multiple possible rotations, this method chooses the one with the shortest arc.

      Specified by:
      rotationTo in interface Vector3fc
      Parameters:
      toDirX - the x coordinate of the destination direction
      toDirY - the y coordinate of the destination direction
      toDirZ - the z coordinate of the destination direction
      dest - will hold the result
      Returns:
      dest
      See Also:
    • rotateAxis

      public Vector3f rotateAxis(float angle, float x, float y, float z)
      Rotate this vector the specified radians around the given rotation axis.
      Parameters:
      angle - the angle in radians
      x - the x component of the rotation axis
      y - the y component of the rotation axis
      z - the z component of the rotation axis
      Returns:
      this
    • rotateAxis

      public Vector3f rotateAxis(float angle, float aX, float aY, float aZ, Vector3f dest)
      Description copied from interface: Vector3fc
      Rotate this vector the specified radians around the given rotation axis and store the result into dest.
      Specified by:
      rotateAxis in interface Vector3fc
      Parameters:
      angle - the angle in radians
      aX - the x component of the rotation axis
      aY - the y component of the rotation axis
      aZ - the z component of the rotation axis
      dest - will hold the result
      Returns:
      dest
    • rotateX

      public Vector3f rotateX(float angle)
      Rotate this vector the specified radians around the X axis.
      Parameters:
      angle - the angle in radians
      Returns:
      this
    • rotateX

      public Vector3f rotateX(float angle, Vector3f dest)
      Description copied from interface: Vector3fc
      Rotate this vector the specified radians around the X axis and store the result into dest.
      Specified by:
      rotateX in interface Vector3fc
      Parameters:
      angle - the angle in radians
      dest - will hold the result
      Returns:
      dest
    • rotateY

      public Vector3f rotateY(float angle)
      Rotate this vector the specified radians around the Y axis.
      Parameters:
      angle - the angle in radians
      Returns:
      this
    • rotateY

      public Vector3f rotateY(float angle, Vector3f dest)
      Description copied from interface: Vector3fc
      Rotate this vector the specified radians around the Y axis and store the result into dest.
      Specified by:
      rotateY in interface Vector3fc
      Parameters:
      angle - the angle in radians
      dest - will hold the result
      Returns:
      dest
    • rotateZ

      public Vector3f rotateZ(float angle)
      Rotate this vector the specified radians around the Z axis.
      Parameters:
      angle - the angle in radians
      Returns:
      this
    • rotateZ

      public Vector3f rotateZ(float angle, Vector3f dest)
      Description copied from interface: Vector3fc
      Rotate this vector the specified radians around the Z axis and store the result into dest.
      Specified by:
      rotateZ in interface Vector3fc
      Parameters:
      angle - the angle in radians
      dest - will hold the result
      Returns:
      dest
    • lengthSquared

      public float lengthSquared()
      Description copied from interface: Vector3fc
      Return the length squared of this vector.
      Specified by:
      lengthSquared in interface Vector3fc
      Returns:
      the length squared
    • lengthSquared

      public static float lengthSquared(float x, float y, float z)
      Get the length squared of a 3-dimensional single-precision vector.
      Parameters:
      x - The vector's x component
      y - The vector's y component
      z - The vector's z component
      Returns:
      the length squared of the given vector
    • length

      public float length()
      Description copied from interface: Vector3fc
      Return the length of this vector.
      Specified by:
      length in interface Vector3fc
      Returns:
      the length
    • length

      public static float length(float x, float y, float z)
      Get the length of a 3-dimensional single-precision vector.
      Parameters:
      x - The vector's x component
      y - The vector's y component
      z - The vector's z component
      Returns:
      the length of the given vector
    • normalize

      public Vector3f normalize()
      Normalize this vector.
      Returns:
      this
    • normalize

      public Vector3f normalize(Vector3f dest)
      Description copied from interface: Vector3fc
      Normalize this vector and store the result in dest.
      Specified by:
      normalize in interface Vector3fc
      Parameters:
      dest - will hold the result
      Returns:
      dest
    • normalize

      public Vector3f normalize(float length)
      Scale this vector to have the given length.
      Parameters:
      length - the desired length
      Returns:
      this
    • normalize

      public Vector3f normalize(float length, Vector3f dest)
      Description copied from interface: Vector3fc
      Scale this vector to have the given length and store the result in dest.
      Specified by:
      normalize in interface Vector3fc
      Parameters:
      length - the desired length
      dest - will hold the result
      Returns:
      dest
    • cross

      public Vector3f cross(Vector3fc v)
      Set this vector to be the cross product of itself and v.
      Parameters:
      v - the other vector
      Returns:
      this
    • cross

      public Vector3f cross(float x, float y, float z)
      Set this vector to be the cross product of itself and (x, y, z).
      Parameters:
      x - the x component of the other vector
      y - the y component of the other vector
      z - the z component of the other vector
      Returns:
      this
    • cross

      public Vector3f cross(Vector3fc v, Vector3f dest)
      Description copied from interface: Vector3fc
      Compute the cross product of this vector and v and store the result in dest.
      Specified by:
      cross in interface Vector3fc
      Parameters:
      v - the other vector
      dest - will hold the result
      Returns:
      dest
    • cross

      public Vector3f cross(float x, float y, float z, Vector3f dest)
      Description copied from interface: Vector3fc
      Compute the cross product of this vector and (x, y, z) and store the result in dest.
      Specified by:
      cross in interface Vector3fc
      Parameters:
      x - the x component of the other vector
      y - the y component of the other vector
      z - the z component of the other vector
      dest - will hold the result
      Returns:
      dest
    • distance

      public float distance(Vector3fc v)
      Description copied from interface: Vector3fc
      Return the distance between this Vector and v.
      Specified by:
      distance in interface Vector3fc
      Parameters:
      v - the other vector
      Returns:
      the distance
    • distance

      public float distance(float x, float y, float z)
      Description copied from interface: Vector3fc
      Return the distance between this vector and (x, y, z).
      Specified by:
      distance in interface Vector3fc
      Parameters:
      x - the x component of the other vector
      y - the y component of the other vector
      z - the z component of the other vector
      Returns:
      the euclidean distance
    • distanceSquared

      public float distanceSquared(Vector3fc v)
      Description copied from interface: Vector3fc
      Return the square of the distance between this vector and v.
      Specified by:
      distanceSquared in interface Vector3fc
      Parameters:
      v - the other vector
      Returns:
      the squared of the distance
    • distanceSquared

      public float distanceSquared(float x, float y, float z)
      Description copied from interface: Vector3fc
      Return the square of the distance between this vector and (x, y, z).
      Specified by:
      distanceSquared in interface Vector3fc
      Parameters:
      x - the x component of the other vector
      y - the y component of the other vector
      z - the z component of the other vector
      Returns:
      the square of the distance
    • distance

      public static float distance(float x1, float y1, float z1, float x2, float y2, float z2)
      Return the distance between (x1, y1, z1) and (x2, y2, z2).
      Parameters:
      x1 - the x component of the first vector
      y1 - the y component of the first vector
      z1 - the z component of the first vector
      x2 - the x component of the second vector
      y2 - the y component of the second vector
      z2 - the z component of the second vector
      Returns:
      the euclidean distance
    • distanceSquared

      public static float distanceSquared(float x1, float y1, float z1, float x2, float y2, float z2)
      Return the squared distance between (x1, y1, z1) and (x2, y2, z2).
      Parameters:
      x1 - the x component of the first vector
      y1 - the y component of the first vector
      z1 - the z component of the first vector
      x2 - the x component of the second vector
      y2 - the y component of the second vector
      z2 - the z component of the second vector
      Returns:
      the euclidean distance squared
    • dot

      public float dot(Vector3fc v)
      Description copied from interface: Vector3fc
      Return the dot product of this vector and the supplied vector.
      Specified by:
      dot in interface Vector3fc
      Parameters:
      v - the other vector
      Returns:
      the dot product
    • dot

      public float dot(float x, float y, float z)
      Description copied from interface: Vector3fc
      Return the dot product of this vector and the vector (x, y, z).
      Specified by:
      dot in interface Vector3fc
      Parameters:
      x - the x component of the other vector
      y - the y component of the other vector
      z - the z component of the other vector
      Returns:
      the dot product
    • angleCos

      public float angleCos(Vector3fc v)
      Description copied from interface: Vector3fc
      Return the cosine of the angle between this vector and the supplied vector. Use this instead of Math.cos(this.angle(v)).
      Specified by:
      angleCos in interface Vector3fc
      Parameters:
      v - the other vector
      Returns:
      the cosine of the angle
      See Also:
    • angle

      public float angle(Vector3fc v)
      Description copied from interface: Vector3fc
      Return the angle between this vector and the supplied vector.
      Specified by:
      angle in interface Vector3fc
      Parameters:
      v - the other vector
      Returns:
      the angle, in radians
      See Also:
    • angleSigned

      public float angleSigned(Vector3fc v, Vector3fc n)
      Description copied from interface: Vector3fc
      Return the signed angle between this vector and the supplied vector with respect to the plane with the given normal vector n.
      Specified by:
      angleSigned in interface Vector3fc
      Parameters:
      v - the other vector
      n - the plane's normal vector
      Returns:
      the angle, in radians
      See Also:
    • angleSigned

      public float angleSigned(float x, float y, float z, float nx, float ny, float nz)
      Description copied from interface: Vector3fc
      Return the signed angle between this vector and the supplied vector with respect to the plane with the given normal vector (nx, ny, nz).
      Specified by:
      angleSigned in interface Vector3fc
      Parameters:
      x - the x coordinate of the other vector
      y - the y coordinate of the other vector
      z - the z coordinate of the other vector
      nx - the x coordinate of the plane's normal vector
      ny - the y coordinate of the plane's normal vector
      nz - the z coordinate of the plane's normal vector
      Returns:
      the angle, in radians
    • min

      public Vector3f min(Vector3fc v)
      Set the components of this vector to be the component-wise minimum of this and the other vector.
      Parameters:
      v - the other vector
      Returns:
      this
    • min

      public Vector3f min(Vector3fc v, Vector3f dest)
      Description copied from interface: Vector3fc
      Set the components of dest to be the component-wise minimum of this and the other vector.
      Specified by:
      min in interface Vector3fc
      Parameters:
      v - the other vector
      dest - will hold the result
      Returns:
      dest
    • max

      public Vector3f max(Vector3fc v)
      Set the components of this vector to be the component-wise maximum of this and the other vector.
      Parameters:
      v - the other vector
      Returns:
      this
    • max

      public Vector3f max(Vector3fc v, Vector3f dest)
      Description copied from interface: Vector3fc
      Set the components of dest to be the component-wise maximum of this and the other vector.
      Specified by:
      max in interface Vector3fc
      Parameters:
      v - the other vector
      dest - will hold the result
      Returns:
      dest
    • zero

      public Vector3f zero()
      Set all components to zero.
      Returns:
      this
    • 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
    • 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 Vector3f negate()
      Negate this vector.
      Returns:
      this
    • negate

      public Vector3f negate(Vector3f dest)
      Description copied from interface: Vector3fc
      Negate this vector and store the result in dest.
      Specified by:
      negate in interface Vector3fc
      Parameters:
      dest - will hold the result
      Returns:
      dest
    • absolute

      public Vector3f absolute()
      Set this vector's components to their respective absolute values.
      Returns:
      this
    • absolute

      public Vector3f absolute(Vector3f dest)
      Description copied from interface: Vector3fc
      Compute the absolute values of the individual components of this and store the result in dest.
      Specified by:
      absolute in interface Vector3fc
      Parameters:
      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
    • equals

      public boolean equals(Vector3fc v, float delta)
      Description copied from interface: Vector3fc
      Compare the vector components of this vector with the given vector using the given delta and return whether all of them are equal within a maximum difference of delta.

      Please note that this method is not used by any data structure such as ArrayList HashSet or HashMap and their operations, such as ArrayList.contains(Object) or HashSet.remove(Object), since those data structures only use the Object.equals(Object) and Object.hashCode() methods.

      Specified by:
      equals in interface Vector3fc
      Parameters:
      v - the other vector
      delta - the allowed maximum difference
      Returns:
      true whether all of the vector components are equal; false otherwise
    • equals

      public boolean equals(float x, float y, float z)
      Description copied from interface: Vector3fc
      Compare the vector components of this vector with the given (x, y, z) and return whether all of them are equal.
      Specified by:
      equals in interface Vector3fc
      Parameters:
      x - the x component to compare to
      y - the y component to compare to
      z - the z component to compare to
      Returns:
      true if all the vector components are equal
    • reflect

      public Vector3f reflect(Vector3fc normal)
      Reflect this vector about the given normal vector.
      Parameters:
      normal - the vector to reflect about
      Returns:
      this
    • reflect

      public Vector3f reflect(float x, float y, float z)
      Reflect this vector about the given normal vector.
      Parameters:
      x - the x component of the normal
      y - the y component of the normal
      z - the z component of the normal
      Returns:
      this
    • reflect

      public Vector3f reflect(Vector3fc normal, Vector3f dest)
      Description copied from interface: Vector3fc
      Reflect this vector about the given normal vector and store the result in dest.
      Specified by:
      reflect in interface Vector3fc
      Parameters:
      normal - the vector to reflect about
      dest - will hold the result
      Returns:
      dest
    • reflect

      public Vector3f reflect(float x, float y, float z, Vector3f dest)
      Description copied from interface: Vector3fc
      Reflect this vector about the given normal vector and store the result in dest.
      Specified by:
      reflect in interface Vector3fc
      Parameters:
      x - the x component of the normal
      y - the y component of the normal
      z - the z component of the normal
      dest - will hold the result
      Returns:
      dest
    • half

      public Vector3f half(Vector3fc other)
      Compute the half vector between this and the other vector.
      Parameters:
      other - the other vector
      Returns:
      this
    • half

      public Vector3f half(float x, float y, float z)
      Compute the half vector between this and the vector (x, y, z).
      Parameters:
      x - the x component of the other vector
      y - the y component of the other vector
      z - the z component of the other vector
      Returns:
      this
    • half

      public Vector3f half(Vector3fc other, Vector3f dest)
      Description copied from interface: Vector3fc
      Compute the half vector between this and the other vector and store the result in dest.
      Specified by:
      half in interface Vector3fc
      Parameters:
      other - the other vector
      dest - will hold the result
      Returns:
      dest
    • half

      public Vector3f half(float x, float y, float z, Vector3f dest)
      Description copied from interface: Vector3fc
      Compute the half vector between this and the vector (x, y, z) and store the result in dest.
      Specified by:
      half in interface Vector3fc
      Parameters:
      x - the x component of the other vector
      y - the y component of the other vector
      z - the z component of the other vector
      dest - will hold the result
      Returns:
      dest
    • smoothStep

      public Vector3f smoothStep(Vector3fc v, float t, Vector3f dest)
      Description copied from interface: Vector3fc
      Compute a smooth-step (i.e. hermite with zero tangents) interpolation between this vector and the given vector v and store the result in dest.
      Specified by:
      smoothStep in interface Vector3fc
      Parameters:
      v - the other vector
      t - the interpolation factor, within [0..1]
      dest - will hold the result
      Returns:
      dest
    • hermite

      public Vector3f hermite(Vector3fc t0, Vector3fc v1, Vector3fc t1, float t, Vector3f dest)
      Description copied from interface: Vector3fc
      Compute a hermite interpolation between this vector with its associated tangent t0 and the given vector v with its tangent t1 and store the result in dest.
      Specified by:
      hermite in interface Vector3fc
      Parameters:
      t0 - the tangent of this vector
      v1 - the other vector
      t1 - the tangent of the other vector
      t - the interpolation factor, within [0..1]
      dest - will hold the result
      Returns:
      dest
    • lerp

      public Vector3f lerp(Vector3fc 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 Vector3f lerp(Vector3fc other, float t, Vector3f dest)
      Description copied from interface: Vector3fc
      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.

      Specified by:
      lerp in interface Vector3fc
      Parameters:
      other - the other vector
      t - the interpolation factor between 0.0 and 1.0
      dest - will hold the result
      Returns:
      dest
    • get

      public float get(int component) throws IllegalArgumentException
      Description copied from interface: Vector3fc
      Get the value of the specified component of this vector.
      Specified by:
      get in interface Vector3fc
      Parameters:
      component - the component, within [0..2]
      Returns:
      the value
      Throws:
      IllegalArgumentException - if component is not within [0..2]
    • get

      public Vector3i get(int mode, Vector3i dest)
      Description copied from interface: Vector3fc
      Set the components of the given vector dest to those of this vector using the given RoundingMode.
      Specified by:
      get in interface Vector3fc
      Parameters:
      mode - the RoundingMode to use
      dest - will hold the result
      Returns:
      dest
    • get

      public Vector3f get(Vector3f dest)
      Description copied from interface: Vector3fc
      Set the components of the given vector dest to those of this vector.
      Specified by:
      get in interface Vector3fc
      Parameters:
      dest - will hold the result
      Returns:
      dest
    • get

      public Vector3d get(Vector3d dest)
      Description copied from interface: Vector3fc
      Set the components of the given vector dest to those of this vector.
      Specified by:
      get in interface Vector3fc
      Parameters:
      dest - will hold the result
      Returns:
      dest
    • maxComponent

      public int maxComponent()
      Description copied from interface: Vector3fc
      Determine the component with the biggest absolute value.
      Specified by:
      maxComponent in interface Vector3fc
      Returns:
      the component index, within [0..2]
    • minComponent

      public int minComponent()
      Description copied from interface: Vector3fc
      Determine the component with the smallest (towards zero) absolute value.
      Specified by:
      minComponent in interface Vector3fc
      Returns:
      the component index, within [0..2]
    • orthogonalize

      public Vector3f orthogonalize(Vector3fc v, Vector3f dest)
      Description copied from interface: Vector3fc
      Transform this vector so that it is orthogonal to the given vector v, normalize the result and store it into dest.

      Reference: Gram–Schmidt process

      Specified by:
      orthogonalize in interface Vector3fc
      Parameters:
      v - the reference vector which the result should be orthogonal to
      dest - will hold the result
      Returns:
      dest
    • orthogonalize

      public Vector3f orthogonalize(Vector3fc v)
      Transform this vector so that it is orthogonal to the given vector v and normalize the result.

      Reference: Gram–Schmidt process

      Parameters:
      v - the reference vector which the result should be orthogonal to
      Returns:
      this
    • orthogonalizeUnit

      public Vector3f orthogonalizeUnit(Vector3fc v, Vector3f dest)
      Description copied from interface: Vector3fc
      Transform this vector so that it is orthogonal to the given unit vector v, normalize the result and store it into dest.

      The vector v is assumed to be a unit vector.

      Reference: Gram–Schmidt process

      Specified by:
      orthogonalizeUnit in interface Vector3fc
      Parameters:
      v - the reference unit vector which the result should be orthogonal to
      dest - will hold the result
      Returns:
      dest
    • orthogonalizeUnit

      public Vector3f orthogonalizeUnit(Vector3fc v)
      Transform this vector so that it is orthogonal to the given unit vector v and normalize the result.

      The vector v is assumed to be a unit vector.

      Reference: Gram–Schmidt process

      Parameters:
      v - the reference unit vector which the result should be orthogonal to
      Returns:
      this
    • floor

      public Vector3f floor()
      Set each component of this vector to the largest (closest to positive infinity) float value that is less than or equal to that component and is equal to a mathematical integer.
      Returns:
      this
    • floor

      public Vector3f floor(Vector3f dest)
      Description copied from interface: Vector3fc
      Compute for each component of this vector the largest (closest to positive infinity) float value that is less than or equal to that component and is equal to a mathematical integer and store the result in dest.
      Specified by:
      floor in interface Vector3fc
      Parameters:
      dest - will hold the result
      Returns:
      dest
    • ceil

      public Vector3f ceil()
      Set each component of this vector to the smallest (closest to negative infinity) float value that is greater than or equal to that component and is equal to a mathematical integer.
      Returns:
      this
    • ceil

      public Vector3f ceil(Vector3f dest)
      Description copied from interface: Vector3fc
      Compute for each component of this vector the smallest (closest to negative infinity) float value that is greater than or equal to that component and is equal to a mathematical integer and store the result in dest.
      Specified by:
      ceil in interface Vector3fc
      Parameters:
      dest - will hold the result
      Returns:
      dest
    • round

      public Vector3f round()
      Set each component of this vector to the closest float that is equal to a mathematical integer, with ties rounding to positive infinity.
      Returns:
      this
    • round

      public Vector3f round(Vector3f dest)
      Description copied from interface: Vector3fc
      Compute for each component of this vector the closest float that is equal to a mathematical integer, with ties rounding to positive infinity and store the result in dest.
      Specified by:
      round in interface Vector3fc
      Parameters:
      dest - will hold the result
      Returns:
      dest
    • isFinite

      public boolean isFinite()
      Description copied from interface: Vector3fc
      Determine whether all components are finite floating-point values, that is, they are not NaN and not infinity.
      Specified by:
      isFinite in interface Vector3fc
      Returns:
      true if all components are finite floating-point values; false otherwise
    • clone

      public Object clone() throws CloneNotSupportedException
      Overrides:
      clone in class Object
      Throws:
      CloneNotSupportedException