Class Vector3i
- All Implemented Interfaces:
Externalizable
,Serializable
,Cloneable
,Vector3ic
- Author:
- Richard Greenlees, Kai Burjack, Hans Uhlig
- See Also:
-
Field Summary
-
Constructor Summary
ConstructorDescriptionVector3i()
Create a newVector3i
of(0, 0, 0)
.Vector3i
(double x, double y, double z, int mode) Create a newVector3i
with the given component values and round using the givenRoundingMode
.Vector3i
(float x, float y, float z, int mode) Create a newVector3i
with the given component values and round using the givenRoundingMode
.Vector3i
(int d) Create a newVector3i
and initialize all three components with the given value.Vector3i
(int[] xyz) Create a newVector3i
and initialize its three components from the first three elements of the given array.Vector3i
(int x, int y, int z) Create a newVector3i
with the given component values.Vector3i
(int index, ByteBuffer buffer) Create a newVector3i
and read this vector from the suppliedByteBuffer
starting at the specified absolute buffer position/index.Vector3i
(ByteBuffer buffer) Create a newVector3i
and read this vector from the suppliedByteBuffer
at the current bufferposition
.Create a newVector3i
with the first two components from the givenv
and the givenz
and round using the givenRoundingMode
.Create a newVector3i
with the first two components from the givenv
and the givenz
and round using the givenRoundingMode
.Create a newVector3i
and initialize its components to the rounded value of the given vector.Create a newVector3i
and initialize its components to the rounded value of the given vector.Create a newVector3i
with the same values asv
. -
Method Summary
Modifier and TypeMethodDescriptionabsolute()
Setthis
vector's components to their respective absolute values.Compute the absolute of each of this vector's components and store the result intodest
.add
(int x, int y, int z) Increment the components of this vector by the given values.Increment the components of this vector by the given values and store the result indest
.Add the supplied vector to this one.Add the supplied vector to this one and store the result indest
.clone()
double
distance
(int x, int y, int z) Return the distance betweenthis
vector and(x, y, z)
.static double
distance
(int x1, int y1, int z1, int x2, int y2, int z2) Return the distance between(x1, y1, z1)
and(x2, y2, z2)
.double
Return the distance between this Vector andv
.long
distanceSquared
(int x, int y, int z) Return the square of the distance betweenthis
vector and(x, y, z)
.static long
distanceSquared
(int x1, int y1, int z1, int x2, int y2, int z2) Return the squared distance between(x1, y1, z1)
and(x2, y2, z2)
.long
Return the square of the distance between this vector andv
.div
(float scalar) Divide all components of thisVector3i
by the given scalar value.Divide all components of thisVector3i
by the given scalar value and store the result indest
.div
(int scalar) Divide all components of thisVector3i
by the given scalar value.Divide all components of thisVector3i
by the given scalar value and store the result indest
.boolean
equals
(int x, int y, int z) Compare the vector components ofthis
vector with the given(x, y, z)
and return whether all of them are equal.boolean
int
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.Store this vector into the suppliedIntBuffer
starting at the specified absolute buffer position/index.get
(ByteBuffer buffer) Store this vector into the suppliedByteBuffer
at the current bufferposition
.getToAddress
(long address) Store this vector at the given off-heap memory address.long
gridDistance
(int x, int y, int z) Return the grid distance in between (aka 1-Norm, Minkowski or Manhattan distance)(x, y)
.long
Return the grid distance in between (aka 1-Norm, Minkowski or Manhattan distance)(x, y)
.int
hashCode()
double
length()
Return the length of this vector.static double
length
(int x, int y, int z) Get the length of a 3-dimensional single-precision vector.long
Return the length squared of this vector.static long
lengthSquared
(int x, int y, int z) Get the length squared of a 3-dimensional single-precision vector.Set the components of this vector to be the component-wise maximum of this and the other vector.Set the components ofdest
to be the component-wise maximum of this and the other vector.int
Determine the component with the biggest absolute value.Set the components of this vector to be the component-wise minimum of this and the other vector.Set the components ofdest
to be the component-wise minimum of this and the other vector.int
Determine the component with the smallest (towards zero) absolute value.mul
(int scalar) Multiply all components of thisVector3i
by the given scalar value.mul
(int x, int y, int z) Multiply the components of this vector by the given values.Multiply the components of this vector by the given values and store the result indest
.Multiply the components of this vector by the given scalar and store the result indest
.Multiply all components of thisVector3i
by the given vector.Multiply the supplied vector by this one and store the result indest
.negate()
Negate this vector.Negate this vector and store the result indest
.void
set
(int d) Set the x, y, and z components to the supplied value.set
(int[] xyz) Set the three components of this vector to the first three elements of the given array.set
(int x, int y, int z) Set the x, y and z components to the supplied values.set
(int index, ByteBuffer buffer) Read this vector from the suppliedByteBuffer
starting at the specified absolute buffer position/index.Read this vector from the suppliedIntBuffer
starting at the specified absolute buffer position/index.set
(ByteBuffer buffer) Read this vector from the suppliedByteBuffer
at the current bufferposition
.Set the first two components from the givenv
and the z component from the givenz
Set thisVector3i
to the values of v usingRoundingMode.TRUNCATE
rounding.Set thisVector3i
to the values of v using the givenRoundingMode
.Set thisVector3i
to the values of v using the givenRoundingMode
.Set the x, y and z components to match the supplied vector.setComponent
(int component, int value) Set the value of the specified component of this vector.setFromAddress
(long address) Set the values of this vector by reading 3 integer values from off-heap memory, starting at the given address.sub
(int x, int y, int z) Decrement the components of this vector by the given values.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 inthis
.Subtract the supplied vector from this one and store the result indest
.toString()
Return a string representation of this vector.toString
(NumberFormat formatter) Return a string representation of this vector by formatting the vector components with the givenNumberFormat
.void
int
x()
int
y()
int
z()
zero()
Set all components to zero.
-
Field Details
-
x
public int xThe x component of the vector. -
y
public int yThe y component of the vector. -
z
public int zThe z component of the vector.
-
-
Constructor Details
-
Vector3i
public Vector3i()Create a newVector3i
of(0, 0, 0)
. -
Vector3i
public Vector3i(int d) Create a newVector3i
and initialize all three components with the given value.- Parameters:
d
- the value of all three components
-
Vector3i
public Vector3i(int x, int y, int z) Create a newVector3i
with the given component values.- Parameters:
x
- the value of xy
- the value of yz
- the value of z
-
Vector3i
Create a newVector3i
with the same values asv
.- Parameters:
v
- theVector3ic
to copy the values from
-
Vector3i
- Parameters:
v
- theVector2ic
to copy the values fromz
- the z component
-
Vector3i
public Vector3i(float x, float y, float z, int mode) Create a newVector3i
with the given component values and round using the givenRoundingMode
.- Parameters:
x
- the value of xy
- the value of yz
- the value of zmode
- theRoundingMode
to use
-
Vector3i
public Vector3i(double x, double y, double z, int mode) Create a newVector3i
with the given component values and round using the givenRoundingMode
.- Parameters:
x
- the value of xy
- the value of yz
- the value of zmode
- theRoundingMode
to use
-
Vector3i
Create a newVector3i
with the first two components from the givenv
and the givenz
and round using the givenRoundingMode
.- Parameters:
v
- theVector2fc
to copy the values fromz
- the z componentmode
- theRoundingMode
to use
-
Vector3i
Create a newVector3i
and initialize its components to the rounded value of the given vector.- Parameters:
v
- theVector3fc
to round and copy the values frommode
- theRoundingMode
to use
-
Vector3i
Create a newVector3i
with the first two components from the givenv
and the givenz
and round using the givenRoundingMode
.- Parameters:
v
- theVector2dc
to copy the values fromz
- the z componentmode
- theRoundingMode
to use
-
Vector3i
Create a newVector3i
and initialize its components to the rounded value of the given vector.- Parameters:
v
- theVector3dc
to round and copy the values frommode
- theRoundingMode
to use
-
Vector3i
public Vector3i(int[] xyz) Create a newVector3i
and initialize its three components from the first three elements of the given array.- Parameters:
xyz
- the array containing at least three elements
-
Vector3i
Create a newVector3i
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
Vector3i(int, ByteBuffer)
, taking the absolute position as parameter.- Parameters:
buffer
- values will be read inx, y, z
order- See Also:
-
Vector3i
Create a newVector3i
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
-
Vector3i
Create a newVector3i
and read this vector from the suppliedIntBuffer
at the current bufferposition
.This method will not increment the position of the given IntBuffer.
In order to specify the offset into the IntBuffer at which the vector is read, use
Vector3i(int, IntBuffer)
, taking the absolute position as parameter.- Parameters:
buffer
- values will be read inx, y, z
order- See Also:
-
Vector3i
Create a newVector3i
and read this vector from the suppliedIntBuffer
starting at the specified absolute buffer position/index.This method will not increment the position of the given IntBuffer.
- Parameters:
index
- the absolute position into the IntBufferbuffer
- values will be read inx, y, z
order
-
-
Method Details
-
x
public int x() -
y
public int y() -
z
public int z() -
set
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
Set thisVector3i
to the values of v usingRoundingMode.TRUNCATE
rounding.Note that due to the given vector
v
storing the components in double-precision, there is the possibility to lose precision.- Parameters:
v
- the vector to copy from- Returns:
- this
-
set
Set thisVector3i
to the values of v using the givenRoundingMode
.Note that due to the given vector
v
storing the components in double-precision, there is the possibility to lose precision.- Parameters:
v
- the vector to copy frommode
- theRoundingMode
to use- Returns:
- this
-
set
Set thisVector3i
to the values of v using the givenRoundingMode
.Note that due to the given vector
v
storing the components in double-precision, there is the possibility to lose precision.- Parameters:
v
- the vector to copy frommode
- theRoundingMode
to use- Returns:
- this
-
set
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
Set the x, y, and z components to the supplied value.- Parameters:
d
- the value of all three components- Returns:
- this
-
set
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
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
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
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
Read this vector from the suppliedIntBuffer
at the current bufferposition
.This method will not increment the position of the given IntBuffer.
In order to specify the offset into the IntBuffer at which the vector is read, use
set(int, IntBuffer)
, taking the absolute position as parameter.- Parameters:
buffer
- values will be read inx, y, z
order- Returns:
- this
- See Also:
-
set
Read this vector from the suppliedIntBuffer
starting at the specified absolute buffer position/index.This method will not increment the position of the given IntBuffer.
- Parameters:
index
- the absolute position into the IntBufferbuffer
- values will be read inx, y, z
order- Returns:
- this
-
setFromAddress
Set the values of this vector by reading 3 integer 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
-
get
Description copied from interface:Vector3ic
Get the value of the specified component of this vector.- Specified by:
get
in interfaceVector3ic
- Parameters:
component
- the component, within[0..2]
- Returns:
- the value
- Throws:
IllegalArgumentException
- ifcomponent
is not within[0..2]
-
setComponent
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:
IllegalArgumentException
- ifcomponent
is not within[0..2]
-
get
Description copied from interface:Vector3ic
Store this vector into the suppliedIntBuffer
at the current bufferposition
.This method will not increment the position of the given IntBuffer.
In order to specify the offset into the IntBuffer at which the vector is stored, use
Vector3ic.get(int, IntBuffer)
, taking the absolute position as parameter. -
get
Description copied from interface:Vector3ic
Store this vector into the suppliedIntBuffer
starting at the specified absolute buffer position/index.This method will not increment the position of the given IntBuffer.
-
get
Description copied from interface:Vector3ic
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
Vector3ic.get(int, ByteBuffer)
, taking the absolute position as parameter. -
get
Description copied from interface:Vector3ic
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
Description copied from interface:Vector3ic
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 interfaceVector3ic
- Parameters:
address
- the off-heap address where to store this vector- Returns:
- this
-
sub
Subtract the supplied vector from this one and store the result inthis
.- Parameters:
v
- the vector to subtract- Returns:
- this
-
sub
Description copied from interface:Vector3ic
Subtract the supplied vector from this one and store the result indest
. -
sub
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
Description copied from interface:Vector3ic
Decrement the components of this vector by the given values and store the result indest
. -
add
Add the supplied vector to this one.- Parameters:
v
- the vector to add- Returns:
- this
-
add
Description copied from interface:Vector3ic
Add the supplied vector to this one and store the result indest
. -
add
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
Description copied from interface:Vector3ic
Increment the components of this vector by the given values and store the result indest
. -
mul
Multiply all components of thisVector3i
by the given scalar value.- Parameters:
scalar
- the scalar to multiply this vector by- Returns:
- this
-
mul
Description copied from interface:Vector3ic
Multiply the components of this vector by the given scalar and store the result indest
. -
mul
Multiply all components of thisVector3i
by the given vector.- Parameters:
v
- the vector to multiply- Returns:
- this
-
mul
Description copied from interface:Vector3ic
Multiply the supplied vector by this one and store the result indest
. -
mul
Multiply the components of this vector by the given values.- Parameters:
x
- the x component to multiplyy
- the y component to multiplyz
- the z component to multiply- Returns:
- this
-
mul
Description copied from interface:Vector3ic
Multiply the components of this vector by the given values and store the result indest
. -
div
Divide all components of thisVector3i
by the given scalar value.- Parameters:
scalar
- the scalar to divide by- Returns:
- this
-
div
Description copied from interface:Vector3ic
Divide all components of thisVector3i
by the given scalar value and store the result indest
. -
div
Divide all components of thisVector3i
by the given scalar value.- Parameters:
scalar
- the scalar to divide by- Returns:
- this
-
div
Description copied from interface:Vector3ic
Divide all components of thisVector3i
by the given scalar value and store the result indest
. -
lengthSquared
public long lengthSquared()Description copied from interface:Vector3ic
Return the length squared of this vector.- Specified by:
lengthSquared
in interfaceVector3ic
- Returns:
- the length squared
-
lengthSquared
public static long lengthSquared(int x, int y, int 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 double length()Description copied from interface:Vector3ic
Return the length of this vector. -
length
public static double length(int x, int y, int 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 squared of the given vector
-
distance
Description copied from interface:Vector3ic
Return the distance between this Vector andv
. -
distance
public double distance(int x, int y, int z) Description copied from interface:Vector3ic
Return the distance betweenthis
vector and(x, y, z)
. -
gridDistance
Description copied from interface:Vector3ic
Return the grid distance in between (aka 1-Norm, Minkowski or Manhattan distance)(x, y)
.- Specified by:
gridDistance
in interfaceVector3ic
- Parameters:
v
- the other vector- Returns:
- the grid distance
-
gridDistance
public long gridDistance(int x, int y, int z) Description copied from interface:Vector3ic
Return the grid distance in between (aka 1-Norm, Minkowski or Manhattan distance)(x, y)
.- Specified by:
gridDistance
in interfaceVector3ic
- Parameters:
x
- the x component of the other vectory
- the y component of the other vectorz
- the y component of the other vector- Returns:
- the grid distance
-
distanceSquared
Description copied from interface:Vector3ic
Return the square of the distance between this vector andv
.- Specified by:
distanceSquared
in interfaceVector3ic
- Parameters:
v
- the other vector- Returns:
- the squared of the distance
-
distanceSquared
public long distanceSquared(int x, int y, int z) Description copied from interface:Vector3ic
Return the square of the distance betweenthis
vector and(x, y, z)
.- Specified by:
distanceSquared
in interfaceVector3ic
- 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 double distance(int x1, int y1, int z1, int x2, int y2, int 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 long distanceSquared(int x1, int y1, int z1, int x2, int y2, int 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
-
zero
Set all components to zero.- Returns:
- this
-
toString
Return a string representation of this vector.This method creates a new
DecimalFormat
on every invocation with the format string "0.000E0;-
". -
toString
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
- Specified by:
writeExternal
in interfaceExternalizable
- Throws:
IOException
-
readExternal
- Specified by:
readExternal
in interfaceExternalizable
- Throws:
IOException
ClassNotFoundException
-
negate
Negate this vector.- Returns:
- this
-
negate
Description copied from interface:Vector3ic
Negate this vector and store the result indest
. -
min
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
Description copied from interface:Vector3ic
Set the components ofdest
to be the component-wise minimum of this and the other vector. -
max
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
Description copied from interface:Vector3ic
Set the components ofdest
to be the component-wise maximum of this and the other vector. -
maxComponent
public int maxComponent()Description copied from interface:Vector3ic
Determine the component with the biggest absolute value.- Specified by:
maxComponent
in interfaceVector3ic
- Returns:
- the component index, within
[0..2]
-
minComponent
public int minComponent()Description copied from interface:Vector3ic
Determine the component with the smallest (towards zero) absolute value.- Specified by:
minComponent
in interfaceVector3ic
- Returns:
- the component index, within
[0..2]
-
absolute
Setthis
vector's components to their respective absolute values.- Returns:
- this
-
absolute
Description copied from interface:Vector3ic
Compute the absolute of each of this vector's components and store the result intodest
. -
hashCode
public int hashCode() -
equals
-
equals
public boolean equals(int x, int y, int z) Description copied from interface:Vector3ic
Compare the vector components ofthis
vector with the given(x, y, z)
and return whether all of them are equal. -
clone
- Overrides:
clone
in classObject
- Throws:
CloneNotSupportedException
-