Package gaiasky.util.math
Class Vector3d
java.lang.Object
gaiasky.util.math.Vector3d
- All Implemented Interfaces:
Vectord<Vector3d>
,Serializable
Counterpart to libgdx's Vector3 class, but using double-precision floating point numbers.
- See Also:
-
Field Summary
-
Constructor Summary
-
Method Summary
Modifier and TypeMethodDescriptionadd
(double values) Adds the given value to all three components of the vector.add
(double... vals) Adds the given vector to this componentadd
(double x, double y, double z) Adds the given vector to this componentadd
(com.badlogic.gdx.math.Vector3 vec) Adds the given vector to this vectordouble
Gets the angle in degrees between the two vectorsdouble
Gets the angle in degrees between the two vectorsdouble
Gets the angle in degrees between the two vectorsclamp
(double min, double max) Clamps this vector's length to given min and max valuescpy()
crs
(double x, double y, double z) Sets this vector to the cross product between it and the other vector.Sets this vector to the cross product between it and the other vector.static Vector3d
Calculates the outer product of two given vectorsv
andw
and returns the result as a newGVector3d
.double
dot
(double x, double y, double z) Returns the dot product between this and the given vector.static double
dot
(double x1, double y1, double z1, double x2, double y2, double z2) double
double
double
dst
(double x, double y, double z) static double
dst
(double x1, double y1, double z1, double x2, double y2, double z2) double
double
double
dst2
(double x, double y, double z) Returns the squared distance between this point and the given pointstatic double
dst2
(double x1, double y1, double z1, double x2, double y2, double z2) double
This method is faster thanVectord.dst(Vectord)
because it avoids calculating a square root.boolean
epsilonEquals
(float x, float y, float z) Compares this vector with the other vector using MathUtils.FLOAT_ROUNDING_ERROR for fuzzy equality testingboolean
epsilonEquals
(float x, float y, float z, float epsilon) Compares this vector with the other vector, using the supplied epsilon for fuzzy equality testing.boolean
epsilonEquals
(Vector3d vec) Compares this vector with the other vector using MathUtils.FLOAT_ROUNDING_ERROR for fuzzy equality testingboolean
epsilonEquals
(Vector3d vec, double epsilon) Compares this vector with the other vector, using the supplied epsilon for fuzzy equality testing.boolean
com.badlogic.gdx.math.Matrix4
getMatrix
(com.badlogic.gdx.math.Matrix4 aux) Sets the matrix aux to a translation matrix using this vectorSets the given matrix to a translation matrix using this vectorstatic Vector3d
getUnitX()
static Vector3d
getUnitY()
static Vector3d
getUnitZ()
int
hashCode()
boolean
hasNaN()
boolean
boolean
hasSameDirection
(Vector3d vec) boolean
interpolate
(Vector3d vec, double alpha, Interpolationd interpolator) Interpolates between this vector and the given target vector by alpha (within range [0,1]) using the given Interpolation method.boolean
isCollinear
(Vector3d vec) boolean
isCollinear
(Vector3d vec, double epsilon) boolean
boolean
isCollinearOpposite
(Vector3d vec, double epsilon) boolean
boolean
boolean
isPerpendicular
(Vector3d vec) boolean
isPerpendicular
(Vector3d vec, double epsilon) boolean
isUnit()
boolean
isUnit
(double margin) boolean
isZero()
boolean
isZero
(double margin) double
len()
static double
len
(double x, double y, double z) double
len2()
This method is faster thanVectord.len()
because it avoids calculating a square root.static double
len2
(double x, double y, double z) Linearly interpolates between this vector and the target vector by alpha which is in the range [0,1].limit
(double limit) Limits the length of this vector, based on the desired maximum length.limit2
(double limit2) Limits the length of this vector, based on the desired maximum length squared.Left-multiplies the vector by the given matrix, assuming the fourth (w) component of the vector is 1.mul
(Quaterniond quat) Multiplies the vector by the givenQuaternion
.mul4x3
(double[] matrix) Left-multiplies the vector by the given 4x3 column major matrix.First scale a supplied vector, then add it to this vector.First scale a supplied vector, then add it to this vector.mulLeft
(com.badlogic.gdx.math.Matrix3 matrix) mulRight
(com.badlogic.gdx.math.Matrix3 matrix) nor()
Normalizes this vector.Multiplies this vector by the given matrix dividing by w, assuming the fourth (w) component of the vector is 1.com.badlogic.gdx.math.Vector3
put
(com.badlogic.gdx.math.Vector3 vec) Multiplies this vector by the first three columns of the matrix, essentially only applying rotation and scaling.rotate
(double degrees, double axisX, double axisY, double axisZ) Rotates this vector by the given angle in degrees around the given axis.Rotates this vector by the given angle in degrees around the given axis.rotateRad
(double radians, double axisX, double axisY, double axisZ) Rotates this vector by the given angle in radians around the given axis.Rotates this vector by the given angle in radians around the given axis.Rotates this vector by a quaternion, using "vector rotation" according to (60) in LL-072.Scales a given vector with a scalar and add the result to this one, i.e.scl
(double scalar) Scales this vector by a scalarscl
(double vx, double vy, double vz) Scales this vector by the given valuesScales this vector by another vectorset
(double[] values) Sets the components from the array.set
(double x, double y, double z) Sets the vector to the given componentsset
(float[] values) Sets the components from the array.set
(com.badlogic.gdx.math.Vector3 vec) Sets this vector from the given vectorsetFromSpherical
(double azimuthalAngle, double polarAngle) Sets the components from the given spherical coordinatesetLength
(double len) Sets the length of this vector.setLength2
(double len2) Sets the length of this vector, based on the square of the desired length.Sets this vector to the unit vector with a random directioncom.badlogic.gdx.math.Vector3
setVector3
(com.badlogic.gdx.math.Vector3 v) Returns set v to this vector by casting doubles to floats.setZero()
Sets the components of this vector to 0Spherically interpolates between this vector and the target vector by alpha which is in the range [0,1].sub
(double value) Subtracts the given value from all components of this vectorsub
(double x, double y, double z) Subtracts the other vector from this vector.sub
(com.badlogic.gdx.math.Vector3 vec) Subtracts the given vector from this vector.toString()
com.badlogic.gdx.math.Vector3
Returns a vector3 representation of this vector by casting the doubles to floats.Multiplies the vector by the transpose of the given matrix, assuming the fourth (w) component of the vector is 1.Multiplies this vector by the transpose of the first three columns of the matrix.untransform
(Matrix4d matrix) Translates this vector in the direction opposite to the translation of the matrix and the multiplies this vector by the transpose of the first three columns of the matrix.double[]
values()
float[]
valuesf()
float[]
valuesf
(float[] vec) double
x()
double
y()
double
z()
-
Field Details
-
X
-
Y
-
Z
-
Zero
-
x
public double xthe x-component of this vector -
y
public double ythe y-component of this vector -
z
public double zthe z-component of this vector
-
-
Constructor Details
-
Vector3d
public Vector3d()Constructs a vector at (0,0,0) -
Vector3d
public Vector3d(double x, double y, double z) Creates a vector with the given components- Parameters:
x
- The x-componenty
- The y-componentz
- The z-component
-
Vector3d
Creates a vector from the given vector- Parameters:
vec
- The vector
-
Vector3d
public Vector3d(double[] values) Creates a vector from the given array. The array must have at least 3 elements.- Parameters:
values
- The array
-
-
Method Details
-
getUnitX
-
getUnitY
-
getUnitZ
-
len
public static double len(double x, double y, double z) - Returns:
- The euclidean length
-
len2
public static double len2(double x, double y, double z) - Returns:
- The squared euclidian length
-
dst
public static double dst(double x1, double y1, double z1, double x2, double y2, double z2) - Returns:
- The euclidian distance between the two specified vectors
-
dst2
public static double dst2(double x1, double y1, double z1, double x2, double y2, double z2) - Returns:
- the squared distance between the given points
-
dot
public static double dot(double x1, double y1, double z1, double x2, double y2, double z2) - Returns:
- The dot product between the two vectors
-
crs
Calculates the outer product of two given vectorsv
andw
and returns the result as a newGVector3d
.- Parameters:
v
- left operandw
- right operand- Returns:
- outer product of
v
andw
-
x
public double x() -
y
public double y() -
z
public double z() -
set
Sets the vector to the given components- Parameters:
x
- The x-componenty
- The y-componentz
- The z-component- Returns:
- this vector for chaining
-
set
Description copied from interface:Vectord
Sets this vector from the given vector -
set
-
set
-
put
public com.badlogic.gdx.math.Vector3 put(com.badlogic.gdx.math.Vector3 vec) -
put
-
set
Sets the components from the array. The array must have at least 3 elements- Parameters:
values
- The array- Returns:
- this vector for chaining
-
set
Sets the components from the array. The array must have at least 3 elements- Parameters:
values
- The array- Returns:
- this vector for chaining
-
setFromSpherical
Sets the components from the given spherical coordinate- Parameters:
azimuthalAngle
- The angle between x-axis in radians [0, 2pi]polarAngle
- The angle between z-axis in radians [0, pi]- Returns:
- This vector for chaining
-
setToRandomDirection
Description copied from interface:Vectord
Sets this vector to the unit vector with a random direction- Specified by:
setToRandomDirection
in interfaceVectord<Vector3d>
- Returns:
- This vector for chaining
-
cpy
-
add
Description copied from interface:Vectord
Adds the given vector to this vector -
add
-
add
-
add
Adds the given vector to this component- 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 vector for chaining.
-
add
Adds the given vector to this component- Parameters:
vals
- The 3-value double vector.- Returns:
- This vector for chaining.
-
add
Adds the given value to all three components of the vector.- Parameters:
values
- The value- Returns:
- This vector for chaining
-
sub
Description copied from interface:Vectord
Subtracts the given vector from this vector. -
sub
-
sub
-
sub
Subtracts the other vector from this vector.- 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 vector for chaining
-
sub
Subtracts the given value from all components of this vector- Parameters:
value
- The value- Returns:
- This vector for chaining
-
scl
Description copied from interface:Vectord
Scales this vector by a scalar -
scl
Description copied from interface:Vectord
Scales this vector by another vector -
scl
Scales this vector by the given values- Parameters:
vx
- X valuevy
- Y valuevz
- Z value- Returns:
- This vector for chaining
-
mulAdd
Description copied from interface:Vectord
First scale a supplied vector, then add it to this vector. -
mulAdd
Description copied from interface:Vectord
First scale a supplied vector, then add it to this vector. -
mul
-
div
-
len
public double len() -
len2
public double len2()Description copied from interface:Vectord
This method is faster thanVectord.len()
because it avoids calculating a square root. It is useful for comparisons, but not for getting exact lengths, as the return value is the square of the actual length. -
idt
- Parameters:
vec
- The other vector- Returns:
- Wether this and the other vector are equal
-
dst
-
dst
-
dst
public double dst(double x, double y, double z) - Returns:
- the distance between this point and the given point
-
dst2
Description copied from interface:Vectord
This method is faster thanVectord.dst(Vectord)
because it avoids calculating a square root. It is useful for comparisons, but not for getting accurate distances, as the return value is the square of the actual distance. -
dst2
public double dst2(double x, double y, double z) Returns the squared distance between this point and the given point- Parameters:
x
- The x-component of the other pointy
- The y-component of the other pointz
- The z-component of the other point- Returns:
- The squared distance
-
nor
Description copied from interface:Vectord
Normalizes this vector. Does nothing if it is zero. -
dot
-
dot
-
dot
public double dot(double x, double y, double z) Returns the dot product between this and the given vector.- 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
-
crs
Sets this vector to the cross product between it and the other vector.- Parameters:
vec
- The other vector- Returns:
- This vector for chaining
-
crs
Sets this vector to the cross product between it and the other vector.- 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 vector for chaining
-
mul4x3
Left-multiplies the vector by the given 4x3 column major matrix. The matrix should be composed by a 3x3 matrix representing rotation and scale plus a 1x3 matrix representing the translation.- Parameters:
matrix
- The matrix- Returns:
- This vector for chaining
-
mul
Left-multiplies the vector by the given matrix, assuming the fourth (w) component of the vector is 1.- Parameters:
matrix
- The matrix- Returns:
- This vector for chaining
-
mulLeft
-
mulRight
-
traMul
Multiplies the vector by the transpose of the given matrix, assuming the fourth (w) component of the vector is 1.- Parameters:
matrix
- The matrix- Returns:
- This vector for chaining
-
mul
Multiplies the vector by the givenQuaternion
.- Returns:
- This vector for chaining
-
prj
Multiplies this vector by the given matrix dividing by w, assuming the fourth (w) component of the vector is 1. This is mostly used to project/unproject vectors via a perspective projection matrix.- Parameters:
matrix
- The matrix.- Returns:
- This vector for chaining
-
rot
Multiplies this vector by the first three columns of the matrix, essentially only applying rotation and scaling.- Parameters:
matrix
- The matrix- Returns:
- This vector for chaining
-
unrotate
Multiplies this vector by the transpose of the first three columns of the matrix. Note: only works for translation and rotation, does not work for scaling. For those, userot(Matrix4d)
withMatrix4d.inv()
.- Parameters:
matrix
- The transformation matrix- Returns:
- The vector for chaining
-
untransform
Translates this vector in the direction opposite to the translation of the matrix and the multiplies this vector by the transpose of the first three columns of the matrix. Note: only works for translation and rotation, does not work for scaling. For those, usemul(Matrix4d)
withMatrix4d.inv()
.- Parameters:
matrix
- The transformation matrix- Returns:
- The vector for chaining
-
rotate
Rotates this vector by the given angle in degrees around the given axis.- Parameters:
degrees
- the angle in degreesaxisX
- the x-component of the axisaxisY
- the y-component of the axisaxisZ
- the z-component of the axis- Returns:
- This vector for chaining
-
rotateRad
Rotates this vector by the given angle in radians around the given axis.- Parameters:
radians
- the angle in radiansaxisX
- the x-component of the axisaxisY
- the y-component of the axisaxisZ
- the z-component of the axis- Returns:
- This vector for chaining
-
rotate
Rotates this vector by the given angle in degrees around the given axis.- Parameters:
axis
- the axisdegrees
- the angle in degrees- Returns:
- This vector for chaining
-
rotateRad
Rotates this vector by the given angle in radians around the given axis.- Parameters:
axis
- the axisradians
- the angle in radians- Returns:
- This vector for chaining
-
getMatrix
public com.badlogic.gdx.math.Matrix4 getMatrix(com.badlogic.gdx.math.Matrix4 aux) Sets the matrix aux to a translation matrix using this vector- Parameters:
aux
- The matrix.- Returns:
- The matrix aux.
-
getMatrix
Sets the given matrix to a translation matrix using this vector- Parameters:
aux
- The out matrix- Returns:
- The matrix with the transform
-
isUnit
public boolean isUnit() -
isUnit
public boolean isUnit(double margin) -
isZero
public boolean isZero() -
isZero
public boolean isZero(double margin) -
isOnLine
-
isOnLine
-
isCollinear
- Specified by:
isCollinear
in interfaceVectord<Vector3d>
- Returns:
- true if this vector is collinear with the other vector (
Vectord.isOnLine(Vectord, double)
&&Vectord.hasSameDirection(Vectord)
).
-
isCollinear
- Specified by:
isCollinear
in interfaceVectord<Vector3d>
- Returns:
- true if this vector is collinear with the other vector (
Vectord.isOnLine(Vectord)
&&Vectord.hasSameDirection(Vectord)
).
-
isCollinearOpposite
- Specified by:
isCollinearOpposite
in interfaceVectord<Vector3d>
- Returns:
- true if this vector is opposite collinear with the other vector (
Vectord.isOnLine(Vectord, double)
&&Vectord.hasOppositeDirection(Vectord)
).
-
isCollinearOpposite
- Specified by:
isCollinearOpposite
in interfaceVectord<Vector3d>
- Returns:
- true if this vector is opposite collinear with the other vector (
Vectord.isOnLine(Vectord)
&&Vectord.hasOppositeDirection(Vectord)
).
-
isPerpendicular
- Specified by:
isPerpendicular
in interfaceVectord<Vector3d>
- Returns:
- Whether this vector is perpendicular with the other vector. True if the dot product is 0.
-
isPerpendicular
- Specified by:
isPerpendicular
in interfaceVectord<Vector3d>
epsilon
- a positive small number close to zero- Returns:
- Whether this vector is perpendicular with the other vector. True if the dot product is 0.
-
hasSameDirection
- Specified by:
hasSameDirection
in interfaceVectord<Vector3d>
- Returns:
- Whether this vector has similar direction compared to the other vector. True if the normalized dot product is > 0.
-
hasOppositeDirection
- Specified by:
hasOppositeDirection
in interfaceVectord<Vector3d>
- Returns:
- Whether this vector has opposite direction compared to the other vector. True if the normalized dot product is < 0.
-
lerp
Description copied from interface:Vectord
Linearly interpolates between this vector and the target vector by alpha which is in the range [0,1]. The result is stored in this vector. -
interpolate
Description copied from interface:Vectord
Interpolates between this vector and the given target vector by alpha (within range [0,1]) using the given Interpolation method. the result is stored in this vector.- Specified by:
interpolate
in interfaceVectord<Vector3d>
- Parameters:
vec
- The target vectoralpha
- The interpolation coefficientinterpolator
- An Interpolation object describing the used interpolation method- Returns:
- This vector for chaining.
-
slerp
Spherically interpolates between this vector and the target vector by alpha which is in the range [0,1]. The result is stored in this vector.- Parameters:
vec
- The target vectoralpha
- The interpolation coefficient- Returns:
- This vector for chaining.
-
toString
-
limit
Description copied from interface:Vectord
Limits the length of this vector, based on the desired maximum length. -
limit2
Description copied from interface:Vectord
Limits the length of this vector, based on the desired maximum length squared. This method is slightly faster than limit(). -
setLength
Description copied from interface:Vectord
Sets the length of this vector. Does nothing is this vector is zero. -
setLength2
Description copied from interface:Vectord
Sets the length of this vector, based on the square of the desired length. Does nothing is this vector is zero. This method is slightly faster than setLength().- Specified by:
setLength2
in interfaceVectord<Vector3d>
- Parameters:
len2
- desired square of the length for this vector- Returns:
- this vector for chaining
- See Also:
-
clamp
Description copied from interface:Vectord
Clamps this vector's length to given min and max values -
values
public double[] values() -
valuesf
public float[] valuesf() -
valuesf
public float[] valuesf(float[] vec) -
scaleAdd
Scales a given vector with a scalar and add the result to this one, i.e.this = this + s*v
.- Parameters:
s
- scalar scaling factorvec
- vector to scale- Returns:
- vector modified in place
-
toVector3
public com.badlogic.gdx.math.Vector3 toVector3()Returns a vector3 representation of this vector by casting the doubles to floats. This creates a new object- Returns:
- The vector3 representation of this vector3d
-
setVector3
public com.badlogic.gdx.math.Vector3 setVector3(com.badlogic.gdx.math.Vector3 v) Returns set v to this vector by casting doubles to floats.- Returns:
- The float vector v.
-
rotateVectorByQuaternion
Rotates this vector by a quaternion, using "vector rotation" according to (60) in LL-072. Both the original and the returned vectors are expressed in the same reference frame as the quaternion.- Parameters:
q
- Quaternion defining the vector rotation.- Returns:
- the rotated vector.
-
angle
Gets the angle in degrees between the two vectors -
angle
Gets the angle in degrees between the two vectors -
anglePrecise
Gets the angle in degrees between the two vectors -
hasNaN
public boolean hasNaN() -
hashCode
public int hashCode() -
equals
-
epsilonEquals
Description copied from interface:Vectord
Compares this vector with the other vector, using the supplied epsilon for fuzzy equality testing.- Specified by:
epsilonEquals
in interfaceVectord<Vector3d>
- Returns:
- whether the vectors have fuzzy equality.
-
epsilonEquals
public boolean epsilonEquals(float x, float y, float z, float epsilon) Compares this vector with the other vector, using the supplied epsilon for fuzzy equality testing.- Returns:
- whether the vectors are the same.
-
epsilonEquals
Compares this vector with the other vector using MathUtils.FLOAT_ROUNDING_ERROR for fuzzy equality testing- Parameters:
vec
- other vector to compare- Returns:
- true if vector are equal, otherwise false
-
epsilonEquals
public boolean epsilonEquals(float x, float y, float z) Compares this vector with the other vector using MathUtils.FLOAT_ROUNDING_ERROR for fuzzy equality testing- Parameters:
x
- x component of the other vector to comparey
- y component of the other vector to comparez
- z component of the other vector to compare- Returns:
- true if vector are equal, otherwise false
-
setZero
Description copied from interface:Vectord
Sets the components of this vector to 0
-