public class VectorM2I extends Object implements VectorReadable2IType, VectorWritable2IType
A two-dimensional mutable vector type with integer elements.
Values of this type cannot be accessed safely from multiple threads without explicit synchronization.
| Constructor and Description |
|---|
VectorM2I()
Default constructor, initializing the vector with values
[0, 0, 0]. |
VectorM2I(int in_x,
int in_y)
Construct a vector initialized with the given values.
|
VectorM2I(VectorReadable2IType in_v)
Construct a vector initialized with the values given in the vector
in_v. |
| Modifier and Type | Method and Description |
|---|---|
static VectorM2I |
absolute(VectorReadable2IType v,
VectorM2I out)
Calculate the absolute values of the elements in vector
v,
saving the result to out. |
static VectorM2I |
absoluteInPlace(VectorM2I v)
Calculate the absolute values of the elements in vector
v,
saving the result to v. |
static VectorM2I |
add(VectorReadable2IType v0,
VectorReadable2IType v1,
VectorM2I out)
Calculate the element-wise sum of the vectors
v0 and
v1, saving the result to out. |
static VectorM2I |
addInPlace(VectorM2I v0,
VectorReadable2IType v1)
Calculate the element-wise sum of the vectors
v0 and
v1, saving the result to v0. |
static VectorM2I |
addScaled(VectorReadable2IType v0,
VectorReadable2IType v1,
double r,
VectorM2I 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 VectorM2I |
addScaledInPlace(VectorM2I v0,
VectorReadable2IType 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 double |
angle(VectorReadable2IType v0,
VectorReadable2IType v1)
Calculate the angle between vectors
v0 and v1,
in radians. |
static VectorM2I |
clamp(VectorReadable2IType v,
int minimum,
int maximum,
VectorM2I out)
Clamp the elements of the vector
v to the range
[minimum .. |
static VectorM2I |
clampByVector(VectorReadable2IType v,
VectorReadable2IType minimum,
VectorReadable2IType maximum,
VectorM2I 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 VectorM2I |
clampByVectorInPlace(VectorM2I v,
VectorReadable2IType minimum,
VectorReadable2IType 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 VectorM2I |
clampInPlace(VectorM2I v,
int minimum,
int maximum)
Clamp the elements of the vector
v to the range
[minimum .. |
static VectorM2I |
clampMaximum(VectorReadable2IType v,
int maximum,
VectorM2I out)
Clamp the elements of the vector
v to the range
[-Infinity .. |
static VectorM2I |
clampMaximumByVector(VectorReadable2IType v,
VectorReadable2IType maximum,
VectorM2I 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 VectorM2I |
clampMaximumByVectorInPlace(VectorM2I v,
VectorReadable2IType 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 VectorM2I |
clampMaximumInPlace(VectorM2I v,
int maximum)
Clamp the elements of the vector
v to the range
[-Infinity .. |
static VectorM2I |
clampMinimum(VectorReadable2IType v,
int minimum,
VectorM2I out)
Clamp the elements of the vector
v to the range
[minimum .. |
static VectorM2I |
clampMinimumByVector(VectorReadable2IType v,
VectorReadable2IType minimum,
VectorM2I 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 VectorM2I |
clampMinimumByVectorInPlace(VectorM2I v,
VectorReadable2IType 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 VectorM2I |
clampMinimumInPlace(VectorM2I v,
int minimum)
Clamp the elements of the vector
v to the range
[minimum .. |
static <T extends VectorWritable2IType> |
copy(VectorReadable2IType input,
T output)
Copy all elements of the vector
input to the vector
output. |
void |
copyFrom2I(VectorReadable2IType in_v)
Set the current vector to the contents of the input vector.
|
static int |
distance(VectorReadable2IType v0,
VectorReadable2IType v1)
Calculate the distance between the two vectors
v0 and
v1. |
static int |
dotProduct(VectorReadable2IType v0,
VectorReadable2IType v1)
Calculate the scalar product of the vectors
v0 and
v1. |
boolean |
equals(Object obj) |
int |
getXI() |
int |
getYI() |
int |
hashCode() |
static VectorM2I |
interpolateLinear(VectorReadable2IType v0,
VectorReadable2IType v1,
double alpha,
VectorM2I r)
Linearly interpolate between
v0 and v1 by the
amount alpha, saving the result to r. |
static int |
magnitude(VectorReadable2IType v)
Calculate the magnitude of the vector
v. |
static int |
magnitudeSquared(VectorReadable2IType v)
Calculate the squared magnitude of the vector
v. |
static VectorM2I |
projection(VectorReadable2IType p,
VectorReadable2IType q,
VectorM2I r)
Calculate the projection of the vector
p onto the vector
q, saving the result in r. |
static VectorM2I |
scale(VectorReadable2IType v,
double r,
VectorM2I out)
Scale the vector
v by the scalar r, saving the
result to out. |
static VectorM2I |
scaleInPlace(VectorM2I v,
int r)
Scale the vector
v by the scalar r, saving the
result to v. |
void |
set2I(int in_x,
int in_y)
Set the current
x and y values of the current
vector. |
void |
setXI(int in_x)
Set the current
x value of the current vector. |
void |
setYI(int in_y)
Set the current
y value of the current vector. |
static VectorM2I |
subtract(VectorReadable2IType v0,
VectorReadable2IType v1,
VectorM2I out)
Subtract the vector
v1 from the vector v0,
saving the result to out. |
static VectorM2I |
subtractInPlace(VectorM2I v0,
VectorReadable2IType v1)
Subtract the vector
v1 from the vector v0,
saving the result to v0. |
String |
toString() |
public VectorM2I()
[0, 0, 0].public VectorM2I(int in_x,
int in_y)
in_x - The x valuein_y - The y valuepublic VectorM2I(VectorReadable2IType in_v)
in_v.in_v - The source vectorpublic static final VectorM2I absolute(VectorReadable2IType v, VectorM2I out) throws ArithmeticException
v,
saving the result to out.v - The input vectorout - The output vector(abs v.x, abs v.y, abs v.z)ArithmeticException - Iff an internal arithmetic operation causes an integer overflowpublic static final VectorM2I absoluteInPlace(VectorM2I v) throws ArithmeticException
v,
saving the result to v.v - The input vector(abs v.x, abs v.y, abs v.z)ArithmeticException - Iff an internal arithmetic operation causes an integer overflowpublic static final VectorM2I add(VectorReadable2IType v0, VectorReadable2IType v1, VectorM2I out) throws ArithmeticException
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)ArithmeticException - Iff an internal arithmetic operation causes an integer overflowpublic static final VectorM2I addInPlace(VectorM2I v0, VectorReadable2IType v1) throws ArithmeticException
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)ArithmeticException - Iff an internal arithmetic operation causes an integer overflowpublic static final VectorM2I addScaled(VectorReadable2IType v0, VectorReadable2IType v1, double r, VectorM2I out) throws ArithmeticException
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))ArithmeticException - Iff an internal arithmetic operation causes an integer overflowpublic static final VectorM2I addScaledInPlace(VectorM2I v0, VectorReadable2IType v1, double r) throws ArithmeticException
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))ArithmeticException - Iff an internal arithmetic operation causes an integer overflowpublic static final double angle(VectorReadable2IType v0, VectorReadable2IType v1)
v0 and v1,
in radians.v0 - The left input vectorv1 - The right input vectorpublic static final VectorM2I clamp(VectorReadable2IType v, int minimum, int maximum, VectorM2I 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 VectorM2I clampByVector(VectorReadable2IType v, VectorReadable2IType minimum, VectorReadable2IType maximum, VectorM2I 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 VectorM2I clampByVectorInPlace(VectorM2I v, VectorReadable2IType minimum, VectorReadable2IType 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 VectorM2I clampInPlace(VectorM2I v, int minimum, int 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 VectorM2I clampMaximum(VectorReadable2IType v, int maximum, VectorM2I 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 VectorM2I clampMaximumByVector(VectorReadable2IType v, VectorReadable2IType maximum, VectorM2I 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 VectorM2I clampMaximumByVectorInPlace(VectorM2I v, VectorReadable2IType 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 VectorM2I clampMaximumInPlace(VectorM2I v, int 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 VectorM2I clampMinimum(VectorReadable2IType v, int minimum, VectorM2I 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 VectorM2I clampMinimumByVector(VectorReadable2IType v, VectorReadable2IType minimum, VectorM2I 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 VectorM2I clampMinimumByVectorInPlace(VectorM2I v, VectorReadable2IType 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 VectorM2I clampMinimumInPlace(VectorM2I v, int 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 <T extends VectorWritable2IType> T copy(VectorReadable2IType input, T output)
input to the vector
output.T - The specific type of vectorinput - The input vectoroutput - The output vectorpublic static final int distance(VectorReadable2IType v0, VectorReadable2IType v1) throws ArithmeticException
v0 and
v1.v0 - The left input vectorv1 - The right input vectorArithmeticException - Iff an internal arithmetic operation causes an integer overflowpublic static final int dotProduct(VectorReadable2IType v0, VectorReadable2IType v1) throws ArithmeticException
v0 and
v1.v0 - The left input vectorv1 - The right input vectorArithmeticException - Iff an internal arithmetic operation causes an integer overflowpublic static final VectorM2I interpolateLinear(VectorReadable2IType v0, VectorReadable2IType v1, double alpha, VectorM2I r) throws ArithmeticException
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.rArithmeticException - Iff an internal arithmetic operation causes an integer
overflow.public static final int magnitude(VectorReadable2IType v) throws ArithmeticException
v.
Correspondingly, magnitude(normalize(v)) == 1.0.v - The input vectorArithmeticException - Iff an internal arithmetic operation causes an integer overflowpublic static final int magnitudeSquared(VectorReadable2IType v) throws ArithmeticException
v.v - The input vectorArithmeticException - Iff an internal arithmetic operation causes an integer overflowpublic static final VectorM2I projection(VectorReadable2IType p, VectorReadable2IType q, VectorM2I r) throws ArithmeticException
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) * qArithmeticException - Iff an internal arithmetic operation causes an integer overflowpublic static final VectorM2I scale(VectorReadable2IType v, double r, VectorM2I out) throws ArithmeticException
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)ArithmeticException - Iff an internal arithmetic operation causes an integer overflowpublic static final VectorM2I scaleInPlace(VectorM2I v, int r) throws ArithmeticException
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)ArithmeticException - Iff an internal arithmetic operation causes an integer overflowpublic static final VectorM2I subtract(VectorReadable2IType v0, VectorReadable2IType v1, VectorM2I out) throws ArithmeticException
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)ArithmeticException - Iff an internal arithmetic operation causes an integer overflowpublic static final VectorM2I subtractInPlace(VectorM2I v0, VectorReadable2IType v1) throws ArithmeticException
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)ArithmeticException - Iff an internal arithmetic operation causes an integer overflowpublic final void copyFrom2I(VectorReadable2IType in_v)
VectorWritable2ITypecopyFrom2I in interface VectorWritable2ITypein_v - The input vectorpublic final int getXI()
getXI in interface VectorReadable2ITypepublic final int getYI()
getYI in interface VectorReadable2ITypepublic final void set2I(int in_x,
int in_y)
VectorWritable2ITypex and y values of the current
vector.set2I in interface VectorWritable2ITypein_x - The new x value.in_y - The new y value.public final void setXI(int in_x)
VectorWritable2ITypex value of the current vector.setXI in interface VectorWritable2ITypein_x - The new x value.public final void setYI(int in_y)
VectorWritable2ITypey value of the current vector.setYI in interface VectorWritable2ITypein_y - The new y value.Copyright © 2015 <code@io7m.com> http://io7m.com