Class Vector3f
- java.lang.Object
-
- org.joml.Vector3f
-
- All Implemented Interfaces:
java.io.Externalizable
,java.io.Serializable
,java.lang.Cloneable
,Vector3fc
public class Vector3f extends java.lang.Object implements java.io.Externalizable, java.lang.Cloneable, Vector3fc
Contains the definition of a Vector comprising 3 floats and associated transformations.- Author:
- Richard Greenlees, Kai Burjack, F. Neurath
- See Also:
- Serialized Form
-
-
Constructor Summary
Constructors Constructor Description Vector3f()
Create a newVector3f
of(0, 0, 0)
.Vector3f(float d)
Create a newVector3f
and initialize all three components with the given value.Vector3f(float[] xyz)
Create a newVector3f
and initialize its three components from the first three elements of the given array.Vector3f(float x, float y, float z)
Create a newVector3f
with the given component values.Vector3f(int index, java.nio.ByteBuffer buffer)
Create a newVector3f
and read this vector from the suppliedByteBuffer
starting at the specified absolute buffer position/index.Vector3f(int index, java.nio.FloatBuffer buffer)
Create a newVector3f
and read this vector from the suppliedFloatBuffer
starting at the specified absolute buffer position/index.Vector3f(java.nio.ByteBuffer buffer)
Create a newVector3f
and read this vector from the suppliedByteBuffer
at the current bufferposition
.Vector3f(java.nio.FloatBuffer buffer)
Create a newVector3f
and read this vector from the suppliedFloatBuffer
at the current bufferposition
.Vector3f(Vector2fc v, float z)
Vector3f(Vector2ic v, float z)
Vector3f(Vector3fc v)
Create a newVector3f
with the same values asv
.Vector3f(Vector3ic v)
Create a newVector3f
with the same values asv
.
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description Vector3f
absolute()
Setthis
vector's components to their respective absolute values.Vector3f
absolute(Vector3f dest)
Compute the absolute values of the individual components ofthis
and store the result indest
.Vector3f
add(float x, float y, float z)
Increment the components of this vector by the given values.Vector3f
add(float x, float y, float z, Vector3f dest)
Increment the components of this vector by the given values and store the result indest
.Vector3f
add(Vector3fc v)
Add the supplied vector to this one.Vector3f
add(Vector3fc v, Vector3f dest)
Add the supplied vector to this one and store the result indest
.float
angle(Vector3fc v)
Return the angle between this vector and the supplied vector.float
angleCos(Vector3fc v)
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
angleSigned(Vector3fc v, Vector3fc n)
Return the signed angle between this vector and the supplied vector with respect to the plane with the given normal vectorn
.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.Vector3f
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 indest
.java.lang.Object
clone()
Vector3f
cross(float x, float y, float z)
Set this vector to be the cross product of itself and(x, y, z)
.Vector3f
cross(float x, float y, float z, Vector3f dest)
Compute the cross product of this vector and(x, y, z)
and store the result indest
.Vector3f
cross(Vector3fc v)
Set this vector to be the cross product of itself andv
.Vector3f
cross(Vector3fc v, Vector3f dest)
Compute the cross product of this vector andv
and store the result indest
.float
distance(float x, float y, float z)
Return the distance betweenthis
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
distance(Vector3fc v)
Return the distance between this Vector andv
.float
distanceSquared(float x, float y, float z)
Return the square of the distance betweenthis
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
distanceSquared(Vector3fc v)
Return the square of the distance between this vector andv
.Vector3f
div(float scalar)
Divide all components of thisVector3f
by the given scalar value.Vector3f
div(float x, float y, float z)
Divide the components of this Vector3f by the given scalar values and store the result inthis
.Vector3f
div(float x, float y, float z, Vector3f dest)
Divide the components of this Vector3f by the given scalar values and store the result indest
.Vector3f
div(float scalar, Vector3f dest)
Divide all components of thisVector3f
by the given scalar value and store the result indest
.Vector3f
div(Vector3fc v)
Divide this Vector3f component-wise by another Vector3fc.Vector3f
div(Vector3fc v, Vector3f dest)
Divide this Vector3f component-wise by another Vector3f and store the result indest
.float
dot(float x, float y, float z)
Return the dot product of this vector and the vector(x, y, z)
.float
dot(Vector3fc v)
Return the dot product of this vector and the supplied vector.boolean
equals(float x, float y, float z)
Compare the vector components ofthis
vector with the given(x, y, z)
and return whether all of them are equal.boolean
equals(java.lang.Object obj)
boolean
equals(Vector3fc v, float delta)
Compare the vector components ofthis
vector with the given vector using the givendelta
and return whether all of them are equal within a maximum difference ofdelta
.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.Vector3f
floor(Vector3f dest)
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 indest
.Vector3f
fma(float a, Vector3fc b)
Add the component-wise multiplication ofa * b
to this vector.Vector3f
fma(float a, Vector3fc b, Vector3f dest)
Add the component-wise multiplication ofa * b
to this vector and store the result indest
.Vector3f
fma(Vector3fc a, Vector3fc b)
Add the component-wise multiplication ofa * b
to this vector.Vector3f
fma(Vector3fc a, Vector3fc b, Vector3f dest)
Add the component-wise multiplication ofa * b
to this vector and store the result indest
.float
get(int component)
Get the value of the specified component of this vector.java.nio.ByteBuffer
get(int index, java.nio.ByteBuffer buffer)
Store this vector into the suppliedByteBuffer
starting at the specified absolute buffer position/index.java.nio.FloatBuffer
get(int index, java.nio.FloatBuffer buffer)
Store this vector into the suppliedFloatBuffer
starting at the specified absolute buffer position/index.Vector3i
get(int mode, Vector3i dest)
java.nio.ByteBuffer
get(java.nio.ByteBuffer buffer)
Store this vector into the suppliedByteBuffer
at the current bufferposition
.java.nio.FloatBuffer
get(java.nio.FloatBuffer buffer)
Store this vector into the suppliedFloatBuffer
at the current bufferposition
.Vector3d
get(Vector3d dest)
Set the components of the given vectordest
to those ofthis
vector.Vector3f
get(Vector3f dest)
Set the components of the given vectordest
to those ofthis
vector.Vector3fc
getToAddress(long address)
Store this vector at the given off-heap memory address.Vector3f
half(float x, float y, float z)
Compute the half vector between this and the vector(x, y, z)
.Vector3f
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 indest
.Vector3f
half(Vector3fc other)
Compute the half vector between this and the other vector.Vector3f
half(Vector3fc other, Vector3f dest)
Compute the half vector between this and the other vector and store the result indest
.int
hashCode()
Vector3f
hermite(Vector3fc t0, Vector3fc v1, Vector3fc t1, float t, Vector3f dest)
Compute a hermite interpolation betweenthis
vector with its associated tangentt0
and the given vectorv
with its tangentt1
and store the result indest
.boolean
isFinite()
Determine whether all components are finite floating-point values, that is, they are notNaN
and notinfinity
.float
length()
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
lengthSquared()
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.Vector3f
lerp(Vector3fc other, float t)
Linearly interpolatethis
andother
using the given interpolation factort
and store the result inthis
.Vector3f
lerp(Vector3fc other, float t, Vector3f dest)
Linearly interpolatethis
andother
using the given interpolation factort
and store the result indest
.Vector3f
max(Vector3fc v)
Set the components of this vector to be the component-wise maximum of this and the other vector.Vector3f
max(Vector3fc v, Vector3f dest)
Set the components ofdest
to be the component-wise maximum of this and the other vector.int
maxComponent()
Determine the component with the biggest absolute value.Vector3f
min(Vector3fc v)
Set the components of this vector to be the component-wise minimum of this and the other vector.Vector3f
min(Vector3fc v, Vector3f dest)
Set the components ofdest
to be the component-wise minimum of this and the other vector.int
minComponent()
Determine the component with the smallest (towards zero) absolute value.Vector3f
mul(float scalar)
Multiply all components of thisVector3f
by the given scalar value.Vector3f
mul(float x, float y, float z)
Multiply the components of this Vector3f by the given scalar values and store the result inthis
.Vector3f
mul(float x, float y, float z, Vector3f dest)
Multiply the components of this Vector3f by the given scalar values and store the result indest
.Vector3f
mul(float scalar, Vector3f dest)
Multiply all components of thisVector3f
by the given scalar value and store the result indest
.Vector3f
mul(Matrix3dc mat)
Multiply the given matrix with this Vector3f and store the result inthis
.Vector3f
mul(Matrix3dc mat, Vector3f dest)
Multiply the given matrix with this Vector3f and store the result indest
.Vector3f
mul(Matrix3fc mat)
Multiply the given matrix with this Vector3f and store the result inthis
.Vector3f
mul(Matrix3fc mat, Vector3f dest)
Multiply the given matrix with this Vector3f and store the result indest
.Vector3f
mul(Matrix3x2fc mat)
Multiply the given matrix with this Vector3f and store the result inthis
.Vector3f
mul(Matrix3x2fc mat, Vector3f dest)
Multiply the given matrixmat
withthis
by assuming a third row in the matrix of(0, 0, 1)
and store the result indest
.Vector3f
mul(Vector3fc v)
Multiply this Vector3f component-wise by another Vector3fc.Vector3f
mul(Vector3fc v, Vector3f dest)
Multiply this Vector3f component-wise by another Vector3f and store the result indest
.Vector3f
mulAdd(float a, Vector3fc b)
Add the component-wise multiplication ofthis * a
tob
and store the result inthis
.Vector3f
mulAdd(float a, Vector3fc b, Vector3f dest)
Add the component-wise multiplication ofthis * a
tob
and store the result indest
.Vector3f
mulAdd(Vector3fc a, Vector3fc b)
Add the component-wise multiplication ofthis * a
tob
and store the result inthis
.Vector3f
mulAdd(Vector3fc a, Vector3fc b, Vector3f dest)
Add the component-wise multiplication ofthis * a
tob
and store the result indest
.Vector3f
mulDirection(Matrix4dc mat)
Multiply the given 4x4 matrixmat
withthis
.Vector3f
mulDirection(Matrix4dc mat, Vector3f dest)
Multiply the given 4x4 matrixmat
withthis
and store the result indest
.Vector3f
mulDirection(Matrix4fc mat)
Multiply the given 4x4 matrixmat
withthis
.Vector3f
mulDirection(Matrix4fc mat, Vector3f dest)
Multiply the given 4x4 matrixmat
withthis
and store the result indest
.Vector3f
mulDirection(Matrix4x3fc mat)
Multiply the given 4x3 matrixmat
withthis
.Vector3f
mulDirection(Matrix4x3fc mat, Vector3f dest)
Multiply the given 4x3 matrixmat
withthis
and store the result indest
.Vector3f
mulPosition(Matrix4fc mat)
Multiply the given 4x4 matrixmat
withthis
.Vector3f
mulPosition(Matrix4fc mat, Vector3f dest)
Multiply the given 4x4 matrixmat
withthis
and store the result indest
.Vector3f
mulPosition(Matrix4x3fc mat)
Multiply the given 4x3 matrixmat
withthis
.Vector3f
mulPosition(Matrix4x3fc mat, Vector3f dest)
Multiply the given 4x3 matrixmat
withthis
and store the result indest
.float
mulPositionW(Matrix4fc mat)
Multiply the given 4x4 matrixmat
withthis
and return the w component of the resulting 4D vector.float
mulPositionW(Matrix4fc mat, Vector3f dest)
Multiply the given 4x4 matrixmat
withthis
, store the result indest
and return the w component of the resulting 4D vector.Vector3f
mulProject(Matrix4fc mat)
Multiply the given matrixmat
with this Vector3f, perform perspective division.Vector3f
mulProject(Matrix4fc mat, float w, Vector3f dest)
Multiply the given matrixmat
with this Vector3f, perform perspective division and store the result indest
.Vector3f
mulProject(Matrix4fc mat, Vector3f dest)
Multiply the given matrixmat
with this Vector3f, perform perspective division and store the result indest
.Vector3f
mulTranspose(Matrix3fc mat)
Multiply the transpose of the given matrix with this Vector3f store the result inthis
.Vector3f
mulTranspose(Matrix3fc mat, Vector3f dest)
Multiply the transpose of the given matrix with this Vector3f and store the result indest
.Vector3f
mulTransposeDirection(Matrix4fc mat)
Multiply the transpose of the given 4x4 matrixmat
withthis
.Vector3f
mulTransposeDirection(Matrix4fc mat, Vector3f dest)
Multiply the transpose of the given 4x4 matrixmat
withthis
and store the result indest
.Vector3f
mulTransposePosition(Matrix4fc mat)
Multiply the transpose of the given 4x4 matrixmat
withthis
.Vector3f
mulTransposePosition(Matrix4fc mat, Vector3f dest)
Multiply the transpose of the given 4x4 matrixmat
withthis
and store the result indest
.Vector3f
negate()
Negate this vector.Vector3f
negate(Vector3f dest)
Negate this vector and store the result indest
.Vector3f
normalize()
Normalize this vector.Vector3f
normalize(float length)
Scale this vector to have the given length.Vector3f
normalize(float length, Vector3f dest)
Scale this vector to have the given length and store the result indest
.Vector3f
normalize(Vector3f dest)
Normalize this vector and store the result indest
.Vector3f
orthogonalize(Vector3fc v)
Transformthis
vector so that it is orthogonal to the given vectorv
and normalize the result.Vector3f
orthogonalize(Vector3fc v, Vector3f dest)
Transformthis
vector so that it is orthogonal to the given vectorv
, normalize the result and store it intodest
.Vector3f
orthogonalizeUnit(Vector3fc v)
Transformthis
vector so that it is orthogonal to the given unit vectorv
and normalize the result.Vector3f
orthogonalizeUnit(Vector3fc v, Vector3f dest)
Transformthis
vector so that it is orthogonal to the given unit vectorv
, normalize the result and store it intodest
.void
readExternal(java.io.ObjectInput in)
Vector3f
reflect(float x, float y, float z)
Reflect this vector about the given normal vector.Vector3f
reflect(float x, float y, float z, Vector3f dest)
Reflect this vector about the given normal vector and store the result indest
.Vector3f
reflect(Vector3fc normal)
Reflect this vector about the givennormal
vector.Vector3f
reflect(Vector3fc normal, Vector3f dest)
Reflect this vector about the givennormal
vector and store the result indest
.Vector3f
rotate(Quaternionfc quat)
Rotate this vector by the given quaternionquat
and store the result inthis
.Vector3f
rotate(Quaternionfc quat, Vector3f dest)
Rotate this vector by the given quaternionquat
and store the result indest
.Vector3f
rotateAxis(float angle, float x, float y, float z)
Rotate this vector the specified radians around the given rotation axis.Vector3f
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 intodest
.Vector3f
rotateX(float angle)
Rotate this vector the specified radians around the X axis.Vector3f
rotateX(float angle, Vector3f dest)
Rotate this vector the specified radians around the X axis and store the result intodest
.Vector3f
rotateY(float angle)
Rotate this vector the specified radians around the Y axis.Vector3f
rotateY(float angle, Vector3f dest)
Rotate this vector the specified radians around the Y axis and store the result intodest
.Vector3f
rotateZ(float angle)
Rotate this vector the specified radians around the Z axis.Vector3f
rotateZ(float angle, Vector3f dest)
Rotate this vector the specified radians around the Z axis and store the result intodest
.Quaternionf
rotationTo(float toDirX, float toDirY, float toDirZ, Quaternionf dest)
Compute the quaternion representing a rotation ofthis
vector to point along(toDirX, toDirY, toDirZ)
and store the result indest
.Quaternionf
rotationTo(Vector3fc toDir, Quaternionf dest)
Compute the quaternion representing a rotation ofthis
vector to point alongtoDir
and store the result indest
.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.Vector3f
round(Vector3f dest)
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 indest
.Vector3f
set(double d)
Set the x, y, and z components to the supplied value.Vector3f
set(double x, double y, double z)
Set the x, y and z components to the supplied values.Vector3f
set(float d)
Set the x, y, and z components to the supplied value.Vector3f
set(float[] xyz)
Set the three components of this vector to the first three elements of the given array.Vector3f
set(float x, float y, float z)
Set the x, y and z components to the supplied values.Vector3f
set(int index, java.nio.ByteBuffer buffer)
Read this vector from the suppliedByteBuffer
starting at the specified absolute buffer position/index.Vector3f
set(int index, java.nio.FloatBuffer buffer)
Read this vector from the suppliedFloatBuffer
starting at the specified absolute buffer position/index.Vector3f
set(java.nio.ByteBuffer buffer)
Read this vector from the suppliedByteBuffer
at the current bufferposition
.Vector3f
set(java.nio.FloatBuffer buffer)
Read this vector from the suppliedFloatBuffer
at the current bufferposition
.Vector3f
set(Vector2dc v, float z)
Set the first two components from the givenv
and the z component from the givenz
Vector3f
set(Vector2fc v, float z)
Set the first two components from the givenv
and the z component from the givenz
Vector3f
set(Vector2ic v, float z)
Set the first two components from the givenv
and the z component from the givenz
Vector3f
set(Vector3dc v)
Set the x, y and z components to match the supplied vector.Vector3f
set(Vector3fc v)
Set the x, y and z components to match the supplied vector.Vector3f
set(Vector3ic v)
Set the x, y and z components to match the supplied vector.Vector3f
setComponent(int component, float value)
Set the value of the specified component of this vector.Vector3f
setFromAddress(long address)
Set the values of this vector by reading 3 float values from off-heap memory, starting at the given address.Vector3f
smoothStep(Vector3fc v, float t, Vector3f dest)
Compute a smooth-step (i.e.Vector3f
sub(float x, float y, float z)
Decrement the components of this vector by the given values.Vector3f
sub(float x, float y, float z, Vector3f dest)
Decrement the components of this vector by the given values and store the result indest
.Vector3f
sub(Vector3fc v)
Subtract the supplied vector from this one and store the result inthis
.Vector3f
sub(Vector3fc v, Vector3f dest)
Subtract the supplied vector from this one and store the result indest
.java.lang.String
toString()
Return a string representation of this vector.java.lang.String
toString(java.text.NumberFormat formatter)
Return a string representation of this vector by formatting the vector components with the givenNumberFormat
.void
writeExternal(java.io.ObjectOutput out)
float
x()
float
y()
float
z()
Vector3f
zero()
Set all components to zero.
-
-
-
Constructor Detail
-
Vector3f
public Vector3f()
Create a newVector3f
of(0, 0, 0)
.
-
Vector3f
public Vector3f(float d)
Create a newVector3f
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 newVector3f
with the given component values.- Parameters:
x
- the value of xy
- the value of yz
- the value of z
-
Vector3f
public Vector3f(Vector3fc v)
Create a newVector3f
with the same values asv
.- Parameters:
v
- theVector3fc
to copy the values from
-
Vector3f
public Vector3f(Vector3ic v)
Create a newVector3f
with the same values asv
.- Parameters:
v
- theVector3ic
to copy the values from
-
Vector3f
public Vector3f(Vector2fc v, float z)
- Parameters:
v
- theVector2fc
to copy the values fromz
- the z component
-
Vector3f
public Vector3f(Vector2ic v, float z)
- Parameters:
v
- theVector2ic
to copy the values fromz
- the z component
-
Vector3f
public Vector3f(float[] xyz)
Create a newVector3f
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(java.nio.ByteBuffer buffer)
Create a newVector3f
and read this vector from the suppliedByteBuffer
at the current bufferposition
.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 inx, y, z
order- See Also:
Vector3f(int, ByteBuffer)
-
Vector3f
public Vector3f(int index, java.nio.ByteBuffer buffer)
Create a newVector3f
and read this vector from the suppliedByteBuffer
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 ByteBufferbuffer
- values will be read inx, y, z
order
-
Vector3f
public Vector3f(java.nio.FloatBuffer buffer)
Create a newVector3f
and read this vector from the suppliedFloatBuffer
at the current bufferposition
.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 inx, y, z
order- See Also:
Vector3f(int, FloatBuffer)
-
Vector3f
public Vector3f(int index, java.nio.FloatBuffer buffer)
Create a newVector3f
and read this vector from the suppliedFloatBuffer
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 FloatBufferbuffer
- values will be read inx, y, z
order
-
-
Method Detail
-
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 givenv
and the z component from the givenz
- Parameters:
v
- theVector2fc
to copy the values fromz
- the z component- Returns:
- this
-
set
public Vector3f set(Vector2dc v, float z)
Set the first two components from the givenv
and the z component from the givenz
- Parameters:
v
- theVector2dc
to copy the values fromz
- the z component- Returns:
- this
-
set
public Vector3f set(Vector2ic v, float z)
Set the first two components from the givenv
and the z component from the givenz
- Parameters:
v
- theVector2ic
to copy the values fromz
- 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 componenty
- the y componentz
- 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 componenty
- the y componentz
- 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(java.nio.ByteBuffer buffer)
Read this vector from the suppliedByteBuffer
at the current bufferposition
.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 inx, y, z
order- Returns:
- this
- See Also:
set(int, ByteBuffer)
-
set
public Vector3f set(int index, java.nio.ByteBuffer buffer)
Read this vector from the suppliedByteBuffer
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 ByteBufferbuffer
- values will be read inx, y, z
order- Returns:
- this
-
set
public Vector3f set(java.nio.FloatBuffer buffer)
Read this vector from the suppliedFloatBuffer
at the current bufferposition
.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 inx, y, z
order- Returns:
- this
- See Also:
set(int, FloatBuffer)
-
set
public Vector3f set(int index, java.nio.FloatBuffer buffer)
Read this vector from the suppliedFloatBuffer
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 FloatBufferbuffer
- values will be read inx, 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 java.lang.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:
java.lang.IllegalArgumentException
- ifcomponent
is not within[0..2]
-
get
public java.nio.FloatBuffer get(java.nio.FloatBuffer buffer)
Description copied from interface:Vector3fc
Store this vector into the suppliedFloatBuffer
at the current bufferposition
.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 interfaceVector3fc
- Parameters:
buffer
- will receive the values of this vector inx, y, z
order- Returns:
- the passed in buffer
- See Also:
Vector3fc.get(int, FloatBuffer)
,Vector3fc.get(int, FloatBuffer)
-
get
public java.nio.FloatBuffer get(int index, java.nio.FloatBuffer buffer)
Description copied from interface:Vector3fc
Store this vector into the suppliedFloatBuffer
starting at the specified absolute buffer position/index.This method will not increment the position of the given FloatBuffer.
-
get
public java.nio.ByteBuffer get(java.nio.ByteBuffer buffer)
Description copied from interface:Vector3fc
Store this vector into the suppliedByteBuffer
at the current bufferposition
.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 interfaceVector3fc
- Parameters:
buffer
- will receive the values of this vector inx, y, z
order- Returns:
- the passed in buffer
- See Also:
Vector3fc.get(int, ByteBuffer)
,Vector3fc.get(int, ByteBuffer)
-
get
public java.nio.ByteBuffer get(int index, java.nio.ByteBuffer buffer)
Description copied from interface:Vector3fc
Store this vector into the suppliedByteBuffer
starting at the specified absolute buffer position/index.This method will not increment the position of the given ByteBuffer.
-
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 interfaceVector3fc
- 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 inthis
.- 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 indest
.
-
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 subtracty
- the y component to subtractz
- 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 indest
.
-
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 indest
.
-
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 addy
- the y component to addz
- 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 indest
.
-
fma
public Vector3f fma(Vector3fc a, Vector3fc b)
Add the component-wise multiplication ofa * b
to this vector.- Parameters:
a
- the first multiplicandb
- the second multiplicand- Returns:
- this
-
fma
public Vector3f fma(float a, Vector3fc b)
Add the component-wise multiplication ofa * b
to this vector.- Parameters:
a
- the first multiplicandb
- 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 ofa * b
to this vector and store the result indest
.
-
fma
public Vector3f fma(float a, Vector3fc b, Vector3f dest)
Description copied from interface:Vector3fc
Add the component-wise multiplication ofa * b
to this vector and store the result indest
.
-
mulAdd
public Vector3f mulAdd(Vector3fc a, Vector3fc b)
Add the component-wise multiplication ofthis * a
tob
and store the result inthis
.- Parameters:
a
- the multiplicandb
- the addend- Returns:
- this
-
mulAdd
public Vector3f mulAdd(float a, Vector3fc b)
Add the component-wise multiplication ofthis * a
tob
and store the result inthis
.- Parameters:
a
- the multiplicandb
- the addend- Returns:
- this
-
mulAdd
public Vector3f mulAdd(Vector3fc a, Vector3fc b, Vector3f dest)
Description copied from interface:Vector3fc
Add the component-wise multiplication ofthis * a
tob
and store the result indest
.
-
mulAdd
public Vector3f mulAdd(float a, Vector3fc b, Vector3f dest)
Description copied from interface:Vector3fc
Add the component-wise multiplication ofthis * a
tob
and store the result indest
.
-
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 indest
.
-
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 indest
.
-
mulProject
public Vector3f mulProject(Matrix4fc mat, Vector3f dest)
Description copied from interface:Vector3fc
Multiply the given matrixmat
with this Vector3f, perform perspective division and store the result indest
.This method uses
w=1.0
as the fourth vector component.- Specified by:
mulProject
in interfaceVector3fc
- Parameters:
mat
- the matrix to multiply this vector bydest
- will hold the result- Returns:
- dest
-
mulProject
public Vector3f mulProject(Matrix4fc mat, float w, Vector3f dest)
Description copied from interface:Vector3fc
Multiply the given matrixmat
with this Vector3f, perform perspective division and store the result indest
.This method uses the given
w
as the fourth vector component.- Specified by:
mulProject
in interfaceVector3fc
- Parameters:
mat
- the matrix to multiply this vector byw
- the w component to usedest
- will hold the result- Returns:
- dest
-
mulProject
public Vector3f mulProject(Matrix4fc mat)
Multiply the given matrixmat
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 inthis
.- 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 indest
.
-
mul
public Vector3f mul(Matrix3dc mat)
Multiply the given matrix with this Vector3f and store the result inthis
.- 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 indest
.
-
mul
public Vector3f mul(Matrix3x2fc mat)
Multiply the given matrix with this Vector3f and store the result inthis
.- Parameters:
mat
- the matrix- Returns:
- this
-
mul
public Vector3f mul(Matrix3x2fc mat, Vector3f dest)
Description copied from interface:Vector3fc
Multiply the given matrixmat
withthis
by assuming a third row in the matrix of(0, 0, 1)
and store the result indest
.
-
mulTranspose
public Vector3f mulTranspose(Matrix3fc mat)
Multiply the transpose of the given matrix with this Vector3f store the result inthis
.- 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 indest
.- Specified by:
mulTranspose
in interfaceVector3fc
- Parameters:
mat
- the matrixdest
- will hold the result- Returns:
- dest
-
mulPosition
public Vector3f mulPosition(Matrix4fc mat)
Multiply the given 4x4 matrixmat
withthis
.This method assumes the
w
component ofthis
to be1.0
.- Parameters:
mat
- the matrix to multiply this vector by- Returns:
- this
-
mulPosition
public Vector3f mulPosition(Matrix4x3fc mat)
Multiply the given 4x3 matrixmat
withthis
.This method assumes the
w
component ofthis
to be1.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 matrixmat
withthis
and store the result indest
.This method assumes the
w
component ofthis
to be1.0
.- Specified by:
mulPosition
in interfaceVector3fc
- Parameters:
mat
- the matrix to multiply this vector bydest
- will hold the result- Returns:
- dest
-
mulPosition
public Vector3f mulPosition(Matrix4x3fc mat, Vector3f dest)
Description copied from interface:Vector3fc
Multiply the given 4x3 matrixmat
withthis
and store the result indest
.This method assumes the
w
component ofthis
to be1.0
.- Specified by:
mulPosition
in interfaceVector3fc
- Parameters:
mat
- the matrix to multiply this vector bydest
- will hold the result- Returns:
- dest
-
mulTransposePosition
public Vector3f mulTransposePosition(Matrix4fc mat)
Multiply the transpose of the given 4x4 matrixmat
withthis
.This method assumes the
w
component ofthis
to be1.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 matrixmat
withthis
and store the result indest
.This method assumes the
w
component ofthis
to be1.0
.- Specified by:
mulTransposePosition
in interfaceVector3fc
- Parameters:
mat
- the matrix whose transpose to multiply this vector bydest
- will hold the result- Returns:
- dest
-
mulPositionW
public float mulPositionW(Matrix4fc mat)
Multiply the given 4x4 matrixmat
withthis
and return the w component of the resulting 4D vector.This method assumes the
w
component ofthis
to be1.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 matrixmat
withthis
, store the result indest
and return the w component of the resulting 4D vector.This method assumes the
w
component ofthis
to be1.0
.- Specified by:
mulPositionW
in interfaceVector3fc
- Parameters:
mat
- the matrix to multiply this vector bydest
- 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 matrixmat
withthis
.This method assumes the
w
component ofthis
to be0.0
.- Parameters:
mat
- the matrix to multiply this vector by- Returns:
- this
-
mulDirection
public Vector3f mulDirection(Matrix4fc mat)
Multiply the given 4x4 matrixmat
withthis
.This method assumes the
w
component ofthis
to be0.0
.- Parameters:
mat
- the matrix to multiply this vector by- Returns:
- this
-
mulDirection
public Vector3f mulDirection(Matrix4x3fc mat)
Multiply the given 4x3 matrixmat
withthis
.This method assumes the
w
component ofthis
to be0.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 matrixmat
withthis
and store the result indest
.This method assumes the
w
component ofthis
to be0.0
.- Specified by:
mulDirection
in interfaceVector3fc
- Parameters:
mat
- the matrix to multiply this vector bydest
- will hold the result- Returns:
- dest
-
mulDirection
public Vector3f mulDirection(Matrix4fc mat, Vector3f dest)
Description copied from interface:Vector3fc
Multiply the given 4x4 matrixmat
withthis
and store the result indest
.This method assumes the
w
component ofthis
to be0.0
.- Specified by:
mulDirection
in interfaceVector3fc
- Parameters:
mat
- the matrix to multiply this vector bydest
- will hold the result- Returns:
- dest
-
mulDirection
public Vector3f mulDirection(Matrix4x3fc mat, Vector3f dest)
Description copied from interface:Vector3fc
Multiply the given 4x3 matrixmat
withthis
and store the result indest
.This method assumes the
w
component ofthis
to be0.0
.- Specified by:
mulDirection
in interfaceVector3fc
- Parameters:
mat
- the matrix to multiply this vector bydest
- will hold the result- Returns:
- dest
-
mulTransposeDirection
public Vector3f mulTransposeDirection(Matrix4fc mat)
Multiply the transpose of the given 4x4 matrixmat
withthis
.This method assumes the
w
component ofthis
to be0.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 matrixmat
withthis
and store the result indest
.This method assumes the
w
component ofthis
to be0.0
.- Specified by:
mulTransposeDirection
in interfaceVector3fc
- Parameters:
mat
- the matrix whose transpose to multiply this vector bydest
- will hold the result- Returns:
- dest
-
mul
public Vector3f mul(float scalar)
Multiply all components of thisVector3f
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 thisVector3f
by the given scalar value and store the result indest
.
-
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 inthis
.- Parameters:
x
- the x component to multiply this vector byy
- the y component to multiply this vector byz
- 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 indest
.
-
div
public Vector3f div(float scalar)
Divide all components of thisVector3f
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 thisVector3f
by the given scalar value and store the result indest
.
-
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 inthis
.- Parameters:
x
- the x component to divide this vector byy
- the y component to divide this vector byz
- 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 indest
.
-
rotate
public Vector3f rotate(Quaternionfc quat)
Rotate this vector by the given quaternionquat
and store the result inthis
.- Parameters:
quat
- the quaternion to rotate this vector- Returns:
- this
- See Also:
Quaternionfc.transform(Vector3f)
-
rotate
public Vector3f rotate(Quaternionfc quat, Vector3f dest)
Description copied from interface:Vector3fc
Rotate this vector by the given quaternionquat
and store the result indest
.- Specified by:
rotate
in interfaceVector3fc
- Parameters:
quat
- the quaternion to rotate this vectordest
- will hold the result- Returns:
- dest
- See Also:
Quaternionfc.transform(Vector3f)
-
rotationTo
public Quaternionf rotationTo(Vector3fc toDir, Quaternionf dest)
Description copied from interface:Vector3fc
Compute the quaternion representing a rotation ofthis
vector to point alongtoDir
and store the result indest
.Because there can be multiple possible rotations, this method chooses the one with the shortest arc.
- Specified by:
rotationTo
in interfaceVector3fc
- Parameters:
toDir
- the destination directiondest
- will hold the result- Returns:
- dest
- See Also:
Quaternionf.rotationTo(Vector3fc, Vector3fc)
-
rotationTo
public Quaternionf rotationTo(float toDirX, float toDirY, float toDirZ, Quaternionf dest)
Description copied from interface:Vector3fc
Compute the quaternion representing a rotation ofthis
vector to point along(toDirX, toDirY, toDirZ)
and store the result indest
.Because there can be multiple possible rotations, this method chooses the one with the shortest arc.
- Specified by:
rotationTo
in interfaceVector3fc
- Parameters:
toDirX
- the x coordinate of the destination directiontoDirY
- the y coordinate of the destination directiontoDirZ
- the z coordinate of the destination directiondest
- will hold the result- Returns:
- dest
- See Also:
Quaternionf.rotationTo(float, float, float, float, float, float)
-
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 radiansx
- the x component of the rotation axisy
- the y component of the rotation axisz
- 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 intodest
.- Specified by:
rotateAxis
in interfaceVector3fc
- Parameters:
angle
- the angle in radiansaX
- the x component of the rotation axisaY
- the y component of the rotation axisaZ
- the z component of the rotation axisdest
- 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 intodest
.
-
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 intodest
.
-
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 intodest
.
-
lengthSquared
public float lengthSquared()
Description copied from interface:Vector3fc
Return the length squared of this vector.- Specified by:
lengthSquared
in interfaceVector3fc
- 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 componenty
- The vector's y componentz
- 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.
-
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 componenty
- The vector's y componentz
- 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 indest
.
-
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 indest
.
-
cross
public Vector3f cross(Vector3fc v)
Set this vector to be the cross product of itself andv
.- 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 vectory
- the y component of the other vectorz
- 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 andv
and store the result indest
.
-
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 indest
.
-
distance
public float distance(Vector3fc v)
Description copied from interface:Vector3fc
Return the distance between this Vector andv
.
-
distance
public float distance(float x, float y, float z)
Description copied from interface:Vector3fc
Return the distance betweenthis
vector and(x, y, z)
.
-
distanceSquared
public float distanceSquared(Vector3fc v)
Description copied from interface:Vector3fc
Return the square of the distance between this vector andv
.- Specified by:
distanceSquared
in interfaceVector3fc
- 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 betweenthis
vector and(x, y, z)
.- Specified by:
distanceSquared
in interfaceVector3fc
- Parameters:
x
- the x component of the other vectory
- the y component of the other vectorz
- 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 vectory1
- the y component of the first vectorz1
- the z component of the first vectorx2
- the x component of the second vectory2
- the y component of the second vectorz2
- 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 vectory1
- the y component of the first vectorz1
- the z component of the first vectorx2
- the x component of the second vectory2
- the y component of the second vectorz2
- 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.
-
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)
.
-
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 interfaceVector3fc
- Parameters:
v
- the other vector- Returns:
- the cosine of the angle
- See Also:
Vector3fc.angle(Vector3fc)
-
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 interfaceVector3fc
- Parameters:
v
- the other vector- Returns:
- the angle, in radians
- See Also:
Vector3fc.angleCos(Vector3fc)
-
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 vectorn
.- Specified by:
angleSigned
in interfaceVector3fc
- Parameters:
v
- the other vectorn
- the plane's normal vector- Returns:
- the angle, in radians
- See Also:
Vector3fc.angleCos(Vector3fc)
-
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 interfaceVector3fc
- Parameters:
x
- the x coordinate of the other vectory
- the y coordinate of the other vectorz
- the z coordinate of the other vectornx
- the x coordinate of the plane's normal vectorny
- the y coordinate of the plane's normal vectornz
- 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 ofdest
to be the component-wise minimum of this and the other vector.
-
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 ofdest
to be the component-wise maximum of this and the other vector.
-
zero
public Vector3f zero()
Set all components to zero.- Returns:
- this
-
toString
public java.lang.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 classjava.lang.Object
- Returns:
- the string representation
-
toString
public java.lang.String toString(java.text.NumberFormat formatter)
Return a string representation of this vector by formatting the vector components with the givenNumberFormat
.- Parameters:
formatter
- theNumberFormat
used to format the vector components with- Returns:
- the string representation
-
writeExternal
public void writeExternal(java.io.ObjectOutput out) throws java.io.IOException
- Specified by:
writeExternal
in interfacejava.io.Externalizable
- Throws:
java.io.IOException
-
readExternal
public void readExternal(java.io.ObjectInput in) throws java.io.IOException, java.lang.ClassNotFoundException
- Specified by:
readExternal
in interfacejava.io.Externalizable
- Throws:
java.io.IOException
java.lang.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 indest
.
-
absolute
public Vector3f absolute()
Setthis
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 ofthis
and store the result indest
.
-
hashCode
public int hashCode()
- Overrides:
hashCode
in classjava.lang.Object
-
equals
public boolean equals(java.lang.Object obj)
- Overrides:
equals
in classjava.lang.Object
-
equals
public boolean equals(Vector3fc v, float delta)
Description copied from interface:Vector3fc
Compare the vector components ofthis
vector with the given vector using the givendelta
and return whether all of them are equal within a maximum difference ofdelta
.Please note that this method is not used by any data structure such as
ArrayList
HashSet
orHashMap
and their operations, such asArrayList.contains(Object)
orHashSet.remove(Object)
, since those data structures only use theObject.equals(Object)
andObject.hashCode()
methods.
-
equals
public boolean equals(float x, float y, float z)
Description copied from interface:Vector3fc
Compare the vector components ofthis
vector with the given(x, y, z)
and return whether all of them are equal.
-
reflect
public Vector3f reflect(Vector3fc normal)
Reflect this vector about the givennormal
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 normaly
- the y component of the normalz
- 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 givennormal
vector and store the result indest
.
-
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 indest
.
-
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 vectory
- the y component of the other vectorz
- 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 indest
.
-
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 indest
.
-
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 betweenthis
vector and the given vectorv
and store the result indest
.- Specified by:
smoothStep
in interfaceVector3fc
- Parameters:
v
- the other vectort
- 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 betweenthis
vector with its associated tangentt0
and the given vectorv
with its tangentt1
and store the result indest
.
-
lerp
public Vector3f lerp(Vector3fc other, float t)
Linearly interpolatethis
andother
using the given interpolation factort
and store the result inthis
.If
t
is0.0
then the result isthis
. If the interpolation factor is1.0
then the result isother
.- Parameters:
other
- the other vectort
- 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 interpolatethis
andother
using the given interpolation factort
and store the result indest
.If
t
is0.0
then the result isthis
. If the interpolation factor is1.0
then the result isother
.
-
get
public float get(int component) throws java.lang.IllegalArgumentException
Description copied from interface:Vector3fc
Get the value of the specified component of this vector.
-
get
public Vector3i get(int mode, Vector3i dest)
Description copied from interface:Vector3fc
- Specified by:
get
in interfaceVector3fc
- Parameters:
mode
- theRoundingMode
to usedest
- will hold the result- Returns:
- dest
-
get
public Vector3f get(Vector3f dest)
Description copied from interface:Vector3fc
Set the components of the given vectordest
to those ofthis
vector.
-
get
public Vector3d get(Vector3d dest)
Description copied from interface:Vector3fc
Set the components of the given vectordest
to those ofthis
vector.
-
maxComponent
public int maxComponent()
Description copied from interface:Vector3fc
Determine the component with the biggest absolute value.- Specified by:
maxComponent
in interfaceVector3fc
- 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 interfaceVector3fc
- Returns:
- the component index, within
[0..2]
-
orthogonalize
public Vector3f orthogonalize(Vector3fc v, Vector3f dest)
Description copied from interface:Vector3fc
Transformthis
vector so that it is orthogonal to the given vectorv
, normalize the result and store it intodest
.Reference: Gram–Schmidt process
- Specified by:
orthogonalize
in interfaceVector3fc
- Parameters:
v
- the reference vector which the result should be orthogonal todest
- will hold the result- Returns:
- dest
-
orthogonalize
public Vector3f orthogonalize(Vector3fc v)
Transformthis
vector so that it is orthogonal to the given vectorv
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
Transformthis
vector so that it is orthogonal to the given unit vectorv
, normalize the result and store it intodest
.The vector
v
is assumed to be aunit
vector.Reference: Gram–Schmidt process
- Specified by:
orthogonalizeUnit
in interfaceVector3fc
- Parameters:
v
- the reference unit vector which the result should be orthogonal todest
- will hold the result- Returns:
- dest
-
orthogonalizeUnit
public Vector3f orthogonalizeUnit(Vector3fc v)
Transformthis
vector so that it is orthogonal to the given unit vectorv
and normalize the result.The vector
v
is assumed to be aunit
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 indest
.
-
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 indest
.
-
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 indest
.
-
isFinite
public boolean isFinite()
Description copied from interface:Vector3fc
Determine whether all components are finite floating-point values, that is, they are notNaN
and notinfinity
.
-
clone
public java.lang.Object clone() throws java.lang.CloneNotSupportedException
- Overrides:
clone
in classjava.lang.Object
- Throws:
java.lang.CloneNotSupportedException
-
-