public class VectorM3D extends Object implements VectorReadable3DType, VectorWritable3DType
A three-dimensional mutable vector type with double precision elements.
Values of this type cannot be accessed safely from multiple threads without explicit synchronization.
| Constructor and Description |
|---|
VectorM3D()
Default constructor, initializing the vector with values
[0.0, 0.0, 0.0]. |
VectorM3D(double in_x,
double in_y,
double in_z)
Construct a vector initialized with the given values.
|
VectorM3D(VectorReadable3DType in_v)
Construct a vector initialized with the values given in the vector
v. |
| Modifier and Type | Method and Description |
|---|---|
static VectorM3D |
absolute(VectorReadable3DType v,
VectorM3D out)
Calculate the absolute values of the elements in vector
v,
saving the result to out. |
static VectorM3D |
absoluteInPlace(VectorM3D v)
Calculate the absolute values of the elements in vector
v,
modifying the vector in-place. |
static VectorM3D |
add(VectorReadable3DType v0,
VectorReadable3DType v1,
VectorM3D out)
Calculate the element-wise sum of the vectors
v0 and
v1, saving the result to out. |
static VectorM3D |
addInPlace(VectorM3D v0,
VectorReadable3DType v1)
Calculate the element-wise sum of the vectors
v0 and
v1, saving the result to v0. |
static VectorM3D |
addScaled(VectorReadable3DType v0,
VectorReadable3DType v1,
double r,
VectorM3D out)
Calculate the element-wise sum of the vectors
v0 and the
element-wise product of v1 and r, saving the
result to out. |
static VectorM3D |
addScaledInPlace(VectorM3D v0,
VectorReadable3DType v1,
double r)
Calculate the element-wise sum of the vectors
v0 and the
element-wise product of v1 and r, saving the
result to v0. |
static boolean |
almostEqual(com.io7m.jequality.AlmostEqualDouble.ContextRelative context,
VectorReadable3DType qa,
VectorReadable3DType qb)
Determine whether or not the vectors
qa and qb
are equal to within the degree of error given in context. |
static VectorM3D |
clamp(VectorReadable3DType v,
double minimum,
double maximum,
VectorM3D out)
Clamp the elements of the vector
v to the range
[minimum .. |
static VectorM3D |
clampByVector(VectorReadable3DType v,
VectorReadable3DType minimum,
VectorReadable3DType maximum,
VectorM3D out)
Clamp the elements of the vector
v to the inclusive range
given by the corresponding elements in minimum and
maximum, saving the result to out. |
static VectorM3D |
clampByVectorInPlace(VectorM3D v,
VectorReadable3DType minimum,
VectorReadable3DType maximum)
Clamp the elements of the vector
v to the inclusive range
given by the corresponding elements in minimum and
maximum, saving the result to v. |
static VectorM3D |
clampInPlace(VectorM3D v,
double minimum,
double maximum)
Clamp the elements of the vector
v to the range
[minimum .. |
static VectorM3D |
clampMaximum(VectorReadable3DType v,
double maximum,
VectorM3D out)
Clamp the elements of the vector
v to the range
[-Infinity .. |
static VectorM3D |
clampMaximumByVector(VectorReadable3DType v,
VectorReadable3DType maximum,
VectorM3D out)
Clamp the elements of the vector
v to the inclusive range
given by the corresponding elements in maximum, saving the
result to out. |
static VectorM3D |
clampMaximumByVectorInPlace(VectorM3D v,
VectorReadable3DType maximum)
Clamp the elements of the vector
v to the inclusive range
given by the corresponding elements in maximum, saving the
result to v. |
static VectorM3D |
clampMaximumInPlace(VectorM3D v,
double maximum)
Clamp the elements of the vector
v to the range
[-Infinity .. |
static VectorM3D |
clampMinimum(VectorReadable3DType v,
double minimum,
VectorM3D out)
Clamp the elements of the vector
v to the range
[minimum .. |
static VectorM3D |
clampMinimumByVector(VectorReadable3DType v,
VectorReadable3DType minimum,
VectorM3D out)
Clamp the elements of the vector
v to the inclusive range
given by the corresponding elements in minimum, saving the
result to out. |
static VectorM3D |
clampMinimumByVectorInPlace(VectorM3D v,
VectorReadable3DType minimum)
Clamp the elements of the vector
v to the inclusive range
given by the corresponding elements in minimum, saving the
result to v. |
static VectorM3D |
clampMinimumInPlace(VectorM3D v,
double minimum)
Clamp the elements of the vector
v to the range
[minimum .. |
static VectorWritable3DType |
copy(VectorReadable3DType input,
VectorWritable3DType output)
Copy all elements of the vector
input to the vector
output. |
void |
copyFrom2D(VectorReadable2DType in_v)
Set the current vector to the contents of the input vector.
|
void |
copyFrom3D(VectorReadable3DType in_v)
Set the current vector to the contents of the input vector.
|
static VectorM3D |
crossProduct(VectorReadable3DType v0,
VectorReadable3DType v1,
VectorM3D out)
Return a vector perpendicular to both
v0 and v1
, saving the result in out. |
static double |
distance(VectorReadable3DType v0,
VectorReadable3DType v1)
Calculate the distance between the two vectors
v0 and
v1. |
static double |
dotProduct(VectorReadable3DType v0,
VectorReadable3DType v1)
Calculate the scalar product of the vectors
v0 and
v1. |
boolean |
equals(Object obj) |
double |
getXD() |
double |
getYD() |
double |
getZD() |
int |
hashCode() |
static VectorM3D |
interpolateLinear(VectorReadable3DType v0,
VectorReadable3DType v1,
double alpha,
VectorM3D r)
Linearly interpolate between
v0 and v1 by the
amount alpha, saving the result to r. |
static double |
magnitude(VectorReadable3DType v)
Calculate the magnitude of the vector
v. |
static double |
magnitudeSquared(VectorReadable3DType v)
Calculate the squared magnitude of the vector
v. |
static VectorM3D |
normalize(VectorReadable3DType v,
VectorM3D out)
Returns a vector with the same orientation as
v but with
magnitude equal to 1.0 in out. |
static VectorM3D |
normalizeInPlace(VectorM3D v)
Returns a vector with the same orientation as
v but with
magnitude equal to 1.0 in v. |
static com.io7m.jfunctional.Pair<VectorM3D,VectorM3D> |
orthoNormalize(VectorReadable3DType v0,
VectorReadable3DType v1)
Orthonormalize and return the vectors
v0 and v1
. |
static void |
orthoNormalizeInPlace(VectorM3D v0,
VectorM3D v1)
Orthonormalize and the vectors
v0 and v1. |
static VectorM3D |
projection(VectorReadable3DType p,
VectorReadable3DType q,
VectorM3D r)
Calculate the projection of the vector
p onto the vector
q, saving the result in r. |
static VectorM3D |
scale(VectorReadable3DType v,
double r,
VectorM3D out)
Scale the vector
v by the scalar r, saving the
result to out. |
static VectorM3D |
scaleInPlace(VectorM3D v,
double r)
Scale the vector
v by the scalar r, saving the
result to v. |
void |
set2D(double in_x,
double in_y)
Set the current
x and y values of the current
vector. |
void |
set3D(double in_x,
double in_y,
double in_z)
Set the current
x, y and z values
of the current vector. |
void |
setXD(double in_x)
Set the current
x value of the current vector. |
void |
setYD(double in_y)
Set the current
y value of the current vector. |
void |
setZD(double in_z)
Set the current
z value of the current vector. |
static VectorM3D |
subtract(VectorReadable3DType v0,
VectorReadable3DType v1,
VectorM3D out)
Subtract the vector
v1 from the vector v0,
saving the result to out. |
static VectorM3D |
subtractInPlace(VectorM3D v0,
VectorReadable3DType v1)
Subtract the vector
v1 from the vector v0,
saving the result to v0. |
String |
toString() |
public VectorM3D()
[0.0, 0.0, 0.0].public VectorM3D(double in_x,
double in_y,
double in_z)
in_x - The x valuein_y - The y valuein_z - The z valuepublic VectorM3D(VectorReadable3DType in_v)
v.in_v - The source vectorpublic static final VectorM3D absolute(VectorReadable3DType v, VectorM3D out)
v,
saving the result to out.v - The input vectorout - The output vector(abs v.x, abs v.y, abs v.z)public static final VectorM3D absoluteInPlace(VectorM3D v)
v,
modifying the vector in-place.v - The input vector(abs v.x, abs v.y, abs v.z)public static final VectorM3D add(VectorReadable3DType v0, VectorReadable3DType v1, VectorM3D out)
v0 and
v1, saving the result to out.v0 - The left input vectorv1 - The right input vectorout - The output vector(v0.x + v1.x, v0.y + v1.y, v0.z + v1.z)public static final VectorM3D addInPlace(VectorM3D v0, VectorReadable3DType v1)
v0 and
v1, saving the result to v0.v0 - The left input vectorv1 - The right input vector(v0.x + v1.x, v0.y + v1.y, v0.z + v1.z)public static final VectorM3D addScaled(VectorReadable3DType v0, VectorReadable3DType v1, double r, VectorM3D out)
v0 and the
element-wise product of v1 and r, saving the
result to out.v0 - The left input vectorv1 - The right input vectorout - The output vectorr - The scaling value(v0.x + (v1.x * r), v0.y + (v1.y * r), v0.z + (v1.z * r))public static final VectorM3D addScaledInPlace(VectorM3D v0, VectorReadable3DType v1, double r)
v0 and the
element-wise product of v1 and r, saving the
result to v0.v0 - The left input vectorv1 - The right input vectorr - The scaling value(v0.x + (v1.x * r), v0.y + (v1.y * r), v0.z + (v1.z * r))public static final boolean almostEqual(com.io7m.jequality.AlmostEqualDouble.ContextRelative context,
VectorReadable3DType qa,
VectorReadable3DType qb)
qa and qb
are equal to within the degree of error given in context.context - The equality contextqa - The left input vectorqb - The right input vectortrue if the vectors are almost equalAlmostEqualDouble.almostEqual(ContextRelative, double, double)public static final VectorM3D clamp(VectorReadable3DType v, double minimum, double maximum, VectorM3D out)
v to the range
[minimum .. maximum] inclusive, saving the result to
out.v - The input vectorminimum - The minimum allowed valuemaximum - The maximum allowed valueout - The output vectormaximum
and at least minimumpublic static final VectorM3D clampByVector(VectorReadable3DType v, VectorReadable3DType minimum, VectorReadable3DType maximum, VectorM3D out)
v to the inclusive range
given by the corresponding elements in minimum and
maximum, saving the result to out.v - The input vectorminimum - The vector containing the minimum acceptable valuesmaximum - The vector containing the maximum acceptable valuesout - The output vector(min(max(v.x, minimum.x), maximum.x), min(max(v.y, minimum.y), maximum.y), min(max(v.z, minimum.z), maximum.z))public static final VectorM3D clampByVectorInPlace(VectorM3D v, VectorReadable3DType minimum, VectorReadable3DType maximum)
v to the inclusive range
given by the corresponding elements in minimum and
maximum, saving the result to v.v - The input vectorminimum - The vector containing the minimum acceptable valuesmaximum - The vector containing the maximum acceptable values(min(max(v.x, minimum.x), maximum.x), min(max(v.y, minimum.y), maximum.y), min(max(v.z, minimum.z), maximum.z))public static final VectorM3D clampInPlace(VectorM3D v, double minimum, double maximum)
v to the range
[minimum .. maximum] inclusive, saving the result to
v.v - The input vectorminimum - The minimum allowed valuemaximum - The maximum allowed valuemaximum
and at least minimum, in vpublic static final VectorM3D clampMaximum(VectorReadable3DType v, double maximum, VectorM3D out)
v to the range
[-Infinity .. maximum] inclusive, saving the result to
out.v - The input vectorout - The output vectormaximum - The maximum allowed valuemaximumpublic static final VectorM3D clampMaximumByVector(VectorReadable3DType v, VectorReadable3DType maximum, VectorM3D out)
v to the inclusive range
given by the corresponding elements in maximum, saving the
result to out.v - The input vectormaximum - The vector containing the maximum acceptable valuesout - The output vector(min(v.x, maximum.x), min(v.y, maximum.y), min(v.z, maximum.z))public static final VectorM3D clampMaximumByVectorInPlace(VectorM3D v, VectorReadable3DType maximum)
v to the inclusive range
given by the corresponding elements in maximum, saving the
result to v.v - The input vectormaximum - The vector containing the maximum acceptable values(min(v.x, maximum.x), min(v.y, maximum.y), min(v.z, maximum.z))public static final VectorM3D clampMaximumInPlace(VectorM3D v, double maximum)
v to the range
[-Infinity .. maximum] inclusive, saving the result to
v.v - The input vectormaximum - The maximum allowed valuemaximum
, in vpublic static final VectorM3D clampMinimum(VectorReadable3DType v, double minimum, VectorM3D out)
v to the range
[minimum .. Infinity] inclusive, saving the result to
out.v - The input vectorout - The output vectorminimum - The minimum allowed valueminimumpublic static final VectorM3D clampMinimumByVector(VectorReadable3DType v, VectorReadable3DType minimum, VectorM3D out)
v to the inclusive range
given by the corresponding elements in minimum, saving the
result to out.v - The input vectorout - The output vectorminimum - The vector containing the minimum acceptable values(max(v.x, minimum.x), max(v.y, minimum.y), max(v.z, minimum.z))public static final VectorM3D clampMinimumByVectorInPlace(VectorM3D v, VectorReadable3DType minimum)
v to the inclusive range
given by the corresponding elements in minimum, saving the
result to v.v - The input vectorminimum - The vector containing the minimum acceptable values(max(v.x, minimum.x), max(v.y, minimum.y), max(v.z, minimum.z))
, in vpublic static final VectorM3D clampMinimumInPlace(VectorM3D v, double minimum)
v to the range
[minimum .. Infinity] inclusive, saving the result to
v.v - The input vectorminimum - The minimum allowed valueminimum, in v.public static final VectorWritable3DType copy(VectorReadable3DType input, VectorWritable3DType output)
input to the vector
output.input - The input vectoroutput - The output vectorpublic static final VectorM3D crossProduct(VectorReadable3DType v0, VectorReadable3DType v1, VectorM3D out)
v0 and v1
, saving the result in out.v0 - The left input vector.v1 - The right input vector.out - The output vector.public static final double distance(VectorReadable3DType v0, VectorReadable3DType v1)
v0 and
v1.v0 - The left input vectorv1 - The right input vectorpublic static final double dotProduct(VectorReadable3DType v0, VectorReadable3DType v1)
v0 and
v1.v0 - The left input vectorv1 - The right input vectorpublic static final VectorM3D interpolateLinear(VectorReadable3DType v0, VectorReadable3DType v1, double alpha, VectorM3D r)
v0 and v1 by the
amount alpha, saving the result to r.
The alpha parameter controls the degree of interpolation,
such that:
interpolateLinear(v0, v1, 0.0, r) -> r = v0interpolateLinear(v0, v1, 1.0, r) -> r = v1v0 - The left input vector.v1 - The right input vector.alpha - The interpolation value, between 0.0 and
1.0.r - The result vector.rpublic static final double magnitude(VectorReadable3DType v)
v.
Correspondingly, magnitude(normalize(v)) == 1.0.v - The input vectorpublic static final double magnitudeSquared(VectorReadable3DType v)
v.v - The input vectorpublic static final VectorM3D normalize(VectorReadable3DType v, VectorM3D out)
v but with
magnitude equal to 1.0 in out. The function
returns the zero vector iff the input is the zero vector.v - The input vectorout - The output vectorpublic static final VectorM3D normalizeInPlace(VectorM3D v)
v but with
magnitude equal to 1.0 in v. The function
returns the zero vector iff the input is the zero vector.v - The input vectorpublic static final com.io7m.jfunctional.Pair<VectorM3D,VectorM3D> orthoNormalize(VectorReadable3DType v0, VectorReadable3DType v1)
Orthonormalize and return the vectors v0 and v1
.
See GSP
v0 - The left vectorv1 - The right vector(v0, v1), orthonormalized.public static final void orthoNormalizeInPlace(VectorM3D v0, VectorM3D v1)
Orthonormalize and the vectors v0 and v1.
See GSP
v0 - The left vectorv1 - The right vectorpublic static final VectorM3D projection(VectorReadable3DType p, VectorReadable3DType q, VectorM3D r)
p onto the vector
q, saving the result in r.p - The left vectorq - The right vectorr - The output vector((dotProduct p q) / magnitudeSquared q) * qpublic static final VectorM3D scale(VectorReadable3DType v, double r, VectorM3D out)
v by the scalar r, saving the
result to out.v - The input vectorr - The scaling valueout - The output vector(v.x * r, v.y * r, v.z * r)public static final VectorM3D scaleInPlace(VectorM3D v, double r)
v by the scalar r, saving the
result to v.v - The input vectorr - The scaling value(v.x * r, v.y * r, v.z * r)public static final VectorM3D subtract(VectorReadable3DType v0, VectorReadable3DType v1, VectorM3D out)
v1 from the vector v0,
saving the result to out.v0 - The left input vectorv1 - The right input vectorout - The output vector(v0.x - v1.x, v0.y - v1.y, v0.z - v1.z)public static final VectorM3D subtractInPlace(VectorM3D v0, VectorReadable3DType v1)
v1 from the vector v0,
saving the result to v0.v0 - The left input vectorv1 - The right input vector(v0.x - v1.x, v0.y - v1.y, v0.z - v1.z)public final void copyFrom2D(VectorReadable2DType in_v)
VectorWritable2DTypecopyFrom2D in interface VectorWritable2DTypein_v - The input vectorpublic final void copyFrom3D(VectorReadable3DType in_v)
VectorWritable3DTypecopyFrom3D in interface VectorWritable3DTypein_v - The input vectorpublic final double getXD()
getXD in interface VectorReadable2DTypepublic final double getYD()
getYD in interface VectorReadable2DTypepublic final double getZD()
getZD in interface VectorReadable3DTypepublic final void set2D(double in_x,
double in_y)
VectorWritable2DTypex and y values of the current
vector.set2D in interface VectorWritable2DTypein_x - The new x value.in_y - The new y value.public final void set3D(double in_x,
double in_y,
double in_z)
VectorWritable3DTypex, y and z values
of the current vector.set3D in interface VectorWritable3DTypein_x - The new x value.in_y - The new y value.in_z - The new z value.public final void setXD(double in_x)
VectorWritable2DTypex value of the current vector.setXD in interface VectorWritable2DTypein_x - The new x value.public final void setYD(double in_y)
VectorWritable2DTypey value of the current vector.setYD in interface VectorWritable2DTypein_y - The new y value.public final void setZD(double in_z)
VectorWritable3DTypez value of the current vector.setZD in interface VectorWritable3DTypein_z - The new z value.Copyright © 2015 <code@io7m.com> http://io7m.com