Interface Vector3fc
 All Known Implementing Classes:
Vector3f
 Author:
 Kai Burjack

Method Summary
Modifier and TypeMethodDescriptionCompute the absolute values of the individual components ofthis
and store the result indest
.Increment the components of this vector by the given values and store the result indest
.Add the supplied vector to this one and store the result indest
.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
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
.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
.Compute the cross product of this vector and(x, y, z)
and store the result indest
.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)
.float
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)
.float
Return the square of the distance between this vector andv
.Divide the components of this Vector3f by the given scalar values and store the result indest
.Divide all components of thisVector3f
by the given scalar value and store the result indest
.Divide this Vector3f componentwise 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
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
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
.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
.Add the componentwise multiplication ofa * b
to this vector and store the result indest
.Add the componentwise 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.get(int index, ByteBuffer buffer)
Store this vector into the suppliedByteBuffer
starting at the specified absolute buffer position/index.get(int index, FloatBuffer buffer)
Store this vector into the suppliedFloatBuffer
starting at the specified absolute buffer position/index.get(ByteBuffer buffer)
Store this vector into the suppliedByteBuffer
at the current bufferposition
.get(FloatBuffer buffer)
Store this vector into the suppliedFloatBuffer
at the current bufferposition
.Set the components of the given vectordest
to those ofthis
vector.Set the components of the given vectordest
to those ofthis
vector.getToAddress(long address)
Store this vector at the given offheap memory address.Compute the half vector between this and the vector(x, y, z)
and store the result indest
.Compute the half vector between this and the other vector and store the result indest
.Compute a hermite interpolation betweenthis
vector with its associated tangentt0
and the given vectorv
with its tangentt1
and store the result indest
.boolean
isFinite()
float
length()
Return the length of this vector.float
Return the length squared of this vector.Linearly interpolatethis
andother
using the given interpolation factort
and store the result indest
.Set the components ofdest
to be the componentwise maximum of this and the other vector.int
Determine the component with the biggest absolute value.Set the components ofdest
to be the componentwise minimum of this and the other vector.int
Determine the component with the smallest (towards zero) absolute value.Multiply the components of this Vector3f by the given scalar values and store the result indest
.Multiply all components of thisVector3f
by the given scalar value and store the result indest
.Multiply the given matrix with this Vector3f and store the result indest
.Multiply the given matrix with this Vector3f and store the result indest
.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
.Multiply this Vector3f componentwise by another Vector3f and store the result indest
.Add the componentwise multiplication ofthis * a
tob
and store the result indest
.Add the componentwise multiplication ofthis * a
tob
and store the result indest
.mulDirection(Matrix4dc mat, Vector3f dest)
Multiply the given 4x4 matrixmat
withthis
and store the result indest
.mulDirection(Matrix4fc mat, Vector3f dest)
Multiply the given 4x4 matrixmat
withthis
and store the result indest
.mulDirection(Matrix4x3fc mat, Vector3f dest)
Multiply the given 4x3 matrixmat
withthis
and store the result indest
.mulPosition(Matrix4fc mat, Vector3f dest)
Multiply the given 4x4 matrixmat
withthis
and store the result indest
.mulPosition(Matrix4x3fc mat, Vector3f dest)
Multiply the given 4x3 matrixmat
withthis
and store the result indest
.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.mulProject(Matrix4fc mat, float w, Vector3f dest)
Multiply the given matrixmat
with this Vector3f, perform perspective division and store the result indest
.mulProject(Matrix4fc mat, Vector3f dest)
Multiply the given matrixmat
with this Vector3f, perform perspective division and store the result indest
.mulTranspose(Matrix3fc mat, Vector3f dest)
Multiply the transpose of the given matrix with this Vector3f and store the result indest
.mulTransposeDirection(Matrix4fc mat, Vector3f dest)
Multiply the transpose of the given 4x4 matrixmat
withthis
and store the result indest
.mulTransposePosition(Matrix4fc mat, Vector3f dest)
Multiply the transpose of the given 4x4 matrixmat
withthis
and store the result indest
.Negate this vector and store the result indest
.Scale this vector to have the given length and store the result indest
.Normalize this vector and store the result indest
.orthogonalize(Vector3fc v, Vector3f dest)
Transformthis
vector so that it is orthogonal to the given vectorv
, normalize the result and store it intodest
.orthogonalizeUnit(Vector3fc v, Vector3f dest)
Transformthis
vector so that it is orthogonal to the given unit vectorv
, normalize the result and store it intodest
.Reflect this vector about the given normal vector and store the result indest
.Reflect this vector about the givennormal
vector and store the result indest
.rotate(Quaternionfc quat, Vector3f dest)
Rotate this vector by the given quaternionquat
and store the result indest
.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
.Rotate this vector the specified radians around the X axis and store the result intodest
.Rotate this vector the specified radians around the Y axis and store the result intodest
.Rotate this vector the specified radians around the Z axis and store the result intodest
.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
.rotationTo(Vector3fc toDir, Quaternionf dest)
Compute the quaternion representing a rotation ofthis
vector to point alongtoDir
and store the result indest
.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
.smoothStep(Vector3fc v, float t, Vector3f dest)
Compute a smoothstep (i.e. hermite with zero tangents) interpolation betweenthis
vector and the given vectorv
and store the result indest
.Decrement the components of this vector by the given values and store the result indest
.Subtract the supplied vector from this one and store the result indest
.float
x()
float
y()
float
z()

Method Details

x
float x() Returns:
 the value of the x component

y
float y() Returns:
 the value of the y component

z
float z() Returns:
 the value of the z component

get
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
get(int, FloatBuffer)
, taking the absolute position as parameter. Parameters:
buffer
 will receive the values of this vector inx, y, z
order Returns:
 the passed in buffer
 See Also:
get(int, FloatBuffer)
,get(int, FloatBuffer)

get
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.
 Parameters:
index
 the absolute position into the FloatBufferbuffer
 will receive the values of this vector inx, y, z
order Returns:
 the passed in buffer

get
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
get(int, ByteBuffer)
, taking the absolute position as parameter. Parameters:
buffer
 will receive the values of this vector inx, y, z
order Returns:
 the passed in buffer
 See Also:
get(int, ByteBuffer)
,get(int, ByteBuffer)

get
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.
 Parameters:
index
 the absolute position into the ByteBufferbuffer
 will receive the values of this vector inx, y, z
order Returns:
 the passed in buffer

getToAddress
Store this vector at the given offheap 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.
 Parameters:
address
 the offheap address where to store this vector Returns:
 this

sub
Subtract the supplied vector from this one and store the result indest
. Parameters:
v
 the vector to subtractdest
 will hold the result Returns:
 dest

sub
Decrement the components of this vector by the given values and store the result indest
. Parameters:
x
 the x component to subtracty
 the y component to subtractz
 the z component to subtractdest
 will hold the result Returns:
 dest

add
Add the supplied vector to this one and store the result indest
. Parameters:
v
 the vector to adddest
 will hold the result Returns:
 dest

add
Increment the components of this vector by the given values and store the result indest
. Parameters:
x
 the x component to addy
 the y component to addz
 the z component to adddest
 will hold the result Returns:
 dest

fma
Add the componentwise multiplication ofa * b
to this vector and store the result indest
. Parameters:
a
 the first multiplicandb
 the second multiplicanddest
 will hold the result Returns:
 dest

fma
Add the componentwise multiplication ofa * b
to this vector and store the result indest
. Parameters:
a
 the first multiplicandb
 the second multiplicanddest
 will hold the result Returns:
 dest

mulAdd
Add the componentwise multiplication ofthis * a
tob
and store the result indest
. Parameters:
a
 the multiplicandb
 the addenddest
 will hold the result Returns:
 dest

mulAdd
Add the componentwise multiplication ofthis * a
tob
and store the result indest
. Parameters:
a
 the multiplicandb
 the addenddest
 will hold the result Returns:
 dest

mul
Multiply this Vector3f componentwise by another Vector3f and store the result indest
. Parameters:
v
 the vector to multiply bydest
 will hold the result Returns:
 dest

div
Divide this Vector3f componentwise by another Vector3f and store the result indest
. Parameters:
v
 the vector to divide bydest
 will hold the result Returns:
 dest

mulProject
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. Parameters:
mat
 the matrix to multiply this vector bydest
 will hold the result Returns:
 dest

mulProject
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. Parameters:
mat
 the matrix to multiply this vector byw
 the w component to usedest
 will hold the result Returns:
 dest

mul
Multiply the given matrix with this Vector3f and store the result indest
. Parameters:
mat
 the matrixdest
 will hold the result Returns:
 dest

mul
Multiply the given matrix with this Vector3f and store the result indest
. Parameters:
mat
 the matrixdest
 will hold the result Returns:
 dest

mul
Multiply the given matrixmat
withthis
by assuming a third row in the matrix of(0, 0, 1)
and store the result indest
. Parameters:
mat
 the matrix to multiply this vector bydest
 will hold the result Returns:
 dest

mulTranspose
Multiply the transpose of the given matrix with this Vector3f and store the result indest
. Parameters:
mat
 the matrixdest
 will hold the result Returns:
 dest

mulPosition
Multiply the given 4x4 matrixmat
withthis
and store the result indest
.This method assumes the
w
component ofthis
to be1.0
. Parameters:
mat
 the matrix to multiply this vector bydest
 will hold the result Returns:
 dest

mulPosition
Multiply the given 4x3 matrixmat
withthis
and store the result indest
.This method assumes the
w
component ofthis
to be1.0
. Parameters:
mat
 the matrix to multiply this vector bydest
 will hold the result Returns:
 dest

mulTransposePosition
Multiply the transpose of the given 4x4 matrixmat
withthis
and store the result indest
.This method assumes the
w
component ofthis
to be1.0
. Parameters:
mat
 the matrix whose transpose to multiply this vector bydest
 will hold the result Returns:
 dest

mulPositionW
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
. 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
Multiply the given 4x4 matrixmat
withthis
and store the result indest
.This method assumes the
w
component ofthis
to be0.0
. Parameters:
mat
 the matrix to multiply this vector bydest
 will hold the result Returns:
 dest

mulDirection
Multiply the given 4x4 matrixmat
withthis
and store the result indest
.This method assumes the
w
component ofthis
to be0.0
. Parameters:
mat
 the matrix to multiply this vector bydest
 will hold the result Returns:
 dest

mulDirection
Multiply the given 4x3 matrixmat
withthis
and store the result indest
.This method assumes the
w
component ofthis
to be0.0
. Parameters:
mat
 the matrix to multiply this vector bydest
 will hold the result Returns:
 dest

mulTransposeDirection
Multiply the transpose of the given 4x4 matrixmat
withthis
and store the result indest
.This method assumes the
w
component ofthis
to be0.0
. Parameters:
mat
 the matrix whose transpose to multiply this vector bydest
 will hold the result Returns:
 dest

mul
Multiply all components of thisVector3f
by the given scalar value and store the result indest
. Parameters:
scalar
 the scalar to multiply this vector bydest
 will hold the result Returns:
 dest

mul
Multiply the components of this Vector3f by the given scalar values and store the result indest
. 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 bydest
 will hold the result Returns:
 dest

div
Divide all components of thisVector3f
by the given scalar value and store the result indest
. Parameters:
scalar
 the scalar to divide bydest
 will hold the result Returns:
 dest

div
Divide the components of this Vector3f by the given scalar values and store the result indest
. 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 bydest
 will hold the result Returns:
 dest

rotate
Rotate this vector by the given quaternionquat
and store the result indest
. Parameters:
quat
 the quaternion to rotate this vectordest
 will hold the result Returns:
 dest
 See Also:
Quaternionfc.transform(Vector3f)

rotationTo
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.
 Parameters:
toDir
 the destination directiondest
 will hold the result Returns:
 dest
 See Also:
Quaternionf.rotationTo(Vector3fc, Vector3fc)

rotationTo
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.
 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
Rotate this vector the specified radians around the given rotation axis and store the result intodest
. 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
Rotate this vector the specified radians around the X axis and store the result intodest
. Parameters:
angle
 the angle in radiansdest
 will hold the result Returns:
 dest

rotateY
Rotate this vector the specified radians around the Y axis and store the result intodest
. Parameters:
angle
 the angle in radiansdest
 will hold the result Returns:
 dest

rotateZ
Rotate this vector the specified radians around the Z axis and store the result intodest
. Parameters:
angle
 the angle in radiansdest
 will hold the result Returns:
 dest

lengthSquared
float lengthSquared()Return the length squared of this vector. Returns:
 the length squared

length
float length()Return the length of this vector. Returns:
 the length

normalize
Normalize this vector and store the result indest
. Parameters:
dest
 will hold the result Returns:
 dest

normalize
Scale this vector to have the given length and store the result indest
. Parameters:
length
 the desired lengthdest
 will hold the result Returns:
 dest

cross
Compute the cross product of this vector andv
and store the result indest
. Parameters:
v
 the other vectordest
 will hold the result Returns:
 dest

cross
Compute the cross product of this vector and(x, y, z)
and store the result indest
. Parameters:
x
 the x component of the other vectory
 the y component of the other vectorz
 the z component of the other vectordest
 will hold the result Returns:
 dest

distance
Return the distance between this Vector andv
. Parameters:
v
 the other vector Returns:
 the distance

distance
float distance(float x, float y, float z)Return the distance betweenthis
vector 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:
 the euclidean distance

distanceSquared
Return the square of the distance between this vector andv
. Parameters:
v
 the other vector Returns:
 the squared of the distance

distanceSquared
float distanceSquared(float x, float y, float z)Return the square of the distance betweenthis
vector 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:
 the square of the distance

dot
Return the dot product of this vector and the supplied vector. Parameters:
v
 the other vector Returns:
 the dot product

dot
float dot(float x, float y, float z)Return the dot product of this vector 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:
 the dot product

angleCos
Return the cosine of the angle between this vector and the supplied vector. Use this instead of Math.cos(this.angle(v)). Parameters:
v
 the other vector Returns:
 the cosine of the angle
 See Also:
angle(Vector3fc)

angle
Return the angle between this vector and the supplied vector. Parameters:
v
 the other vector Returns:
 the angle, in radians
 See Also:
angleCos(Vector3fc)

angleSigned
Return the signed angle between this vector and the supplied vector with respect to the plane with the given normal vectorn
. Parameters:
v
 the other vectorn
 the plane's normal vector Returns:
 the angle, in radians
 See Also:
angleCos(Vector3fc)

angleSigned
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)
. 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
Set the components ofdest
to be the componentwise minimum of this and the other vector. Parameters:
v
 the other vectordest
 will hold the result Returns:
 dest

max
Set the components ofdest
to be the componentwise maximum of this and the other vector. Parameters:
v
 the other vectordest
 will hold the result Returns:
 dest

negate
Negate this vector and store the result indest
. Parameters:
dest
 will hold the result Returns:
 dest

absolute
Compute the absolute values of the individual components ofthis
and store the result indest
. Parameters:
dest
 will hold the result Returns:
 dest

reflect
Reflect this vector about the givennormal
vector and store the result indest
. Parameters:
normal
 the vector to reflect aboutdest
 will hold the result Returns:
 dest

reflect
Reflect this vector about the given normal vector and store the result indest
. Parameters:
x
 the x component of the normaly
 the y component of the normalz
 the z component of the normaldest
 will hold the result Returns:
 dest

half
Compute the half vector between this and the other vector and store the result indest
. Parameters:
other
 the other vectordest
 will hold the result Returns:
 dest

half
Compute the half vector between this and the vector(x, y, z)
and store the result indest
. Parameters:
x
 the x component of the other vectory
 the y component of the other vectorz
 the z component of the other vectordest
 will hold the result Returns:
 dest

smoothStep
Compute a smoothstep (i.e. hermite with zero tangents) interpolation betweenthis
vector and the given vectorv
and store the result indest
. Parameters:
v
 the other vectort
 the interpolation factor, within[0..1]
dest
 will hold the result Returns:
 dest

hermite
Compute a hermite interpolation betweenthis
vector with its associated tangentt0
and the given vectorv
with its tangentt1
and store the result indest
. Parameters:
t0
 the tangent ofthis
vectorv1
 the other vectort1
 the tangent of the other vectort
 the interpolation factor, within[0..1]
dest
 will hold the result Returns:
 dest

lerp
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
. Parameters:
other
 the other vectort
 the interpolation factor between 0.0 and 1.0dest
 will hold the result Returns:
 dest

get
Get the value of the specified component of this vector. Parameters:
component
 the component, within[0..2]
 Returns:
 the value
 Throws:
IllegalArgumentException
 ifcomponent
is not within[0..2]

get
 Parameters:
mode
 theRoundingMode
to usedest
 will hold the result Returns:
 dest

get
Set the components of the given vectordest
to those ofthis
vector. Parameters:
dest
 will hold the result Returns:
 dest

get
Set the components of the given vectordest
to those ofthis
vector. Parameters:
dest
 will hold the result Returns:
 dest

maxComponent
int maxComponent()Determine the component with the biggest absolute value. Returns:
 the component index, within
[0..2]

minComponent
int minComponent()Determine the component with the smallest (towards zero) absolute value. Returns:
 the component index, within
[0..2]

orthogonalize
Transformthis
vector so that it is orthogonal to the given vectorv
, normalize the result and store it intodest
.Reference: Gramâ€“Schmidt process
 Parameters:
v
 the reference vector which the result should be orthogonal todest
 will hold the result Returns:
 dest

orthogonalizeUnit
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
 Parameters:
v
 the reference unit vector which the result should be orthogonal todest
 will hold the result Returns:
 dest

floor
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
. Parameters:
dest
 will hold the result Returns:
 dest

ceil
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
. Parameters:
dest
 will hold the result Returns:
 dest

round
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
. Parameters:
dest
 will hold the result Returns:
 dest

isFinite
boolean isFinite()Determine whether all components are finite floatingpoint values, that is, they are notNaN
and notinfinity
. Returns:
true
if all components are finite floatingpoint values;false
otherwise

equals
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. Parameters:
v
 the other vectordelta
 the allowed maximum difference Returns:
true
whether all of the vector components are equal;false
otherwise

equals
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. Parameters:
x
 the x component to compare toy
 the y component to compare toz
 the z component to compare to Returns:
true
if all the vector components are equal
