Interface Vector2ic
- All Known Implementing Classes:
Vector2i
- Author:
- Kai Burjack
-
Method Summary
Modifier and TypeMethodDescriptionCompute the absolute of each of this vector's components and store the result intodest
.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
.double
distance
(int x, int y) Return the distance betweenthis
vector and(x, y)
.double
Return the distance between this Vector andv
.long
distanceSquared
(int x, int y) Return the square of the distance betweenthis
vector and(x, y)
.long
Return the square of the distance between this vector andv
.Divide all components of thisVector2i
by the given scalar value and store the result indest
.Divide all components of thisVector2i
by the given scalar value and store the result indest
.boolean
equals
(int x, int y) Compare the vector components ofthis
vector with the given(x, y)
and return whether all of them are equal.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) 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)
.double
length()
Return the length of this vector.long
Return the length squared of this 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 ofdest
to be the component-wise minimum of this and the other vector.int
Determine the component with the smallest (towards zero) absolute value.Multiply the components of this vector by the given values and store the result indest
.Multiply all components of thisVector2ic
by the given scalar value and store the result indest
.Multiply the supplied vector by this one and store the result indest
.Negate this vector 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
.int
x()
int
y()
-
Method Details
-
x
int x()- Returns:
- the value of the x component
-
y
int y()- Returns:
- the value of the y component
-
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
order- Returns:
- the passed in buffer
- See Also:
-
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
order- Returns:
- the passed in buffer
-
get
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
get(int, IntBuffer)
, taking the absolute position as parameter.- Parameters:
buffer
- will receive the values of this vector inx, y
order- Returns:
- the passed in buffer
- See Also:
-
get
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.
- Parameters:
index
- the absolute position into the IntBufferbuffer
- will receive the values of this vector inx, y
order- Returns:
- the passed in buffer
-
getToAddress
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.
- 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 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 subtractdest
- will hold the result- Returns:
- dest
-
lengthSquared
long lengthSquared()Return the length squared of this vector.- Returns:
- the length squared
-
length
double length()Return the length of this vector.- Returns:
- the length
-
distance
Return the distance between this Vector andv
.- Parameters:
v
- the other vector- Returns:
- the distance
-
distance
double distance(int x, int y) Return the distance betweenthis
vector and(x, y)
.- Parameters:
x
- the x component of the other vectory
- the y 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
long distanceSquared(int x, int y) Return the square of the distance betweenthis
vector and(x, y)
.- Parameters:
x
- the x component of the other vectory
- the y component of the other vector- Returns:
- the square of the distance
-
gridDistance
Return the grid distance in between (aka 1-Norm, Minkowski or Manhattan distance)(x, y)
.- Parameters:
v
- the other vector- Returns:
- the grid distance
-
gridDistance
long gridDistance(int x, int y) Return the grid distance in between (aka 1-Norm, Minkowski or Manhattan distance)(x, y)
.- Parameters:
x
- the x component of the other vectory
- the y component of the other vector- Returns:
- the grid distance
-
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 adddest
- will hold the result- Returns:
- dest
-
mul
Multiply all components of thisVector2ic
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 supplied vector by this one and store the result indest
.- Parameters:
v
- the vector to multiplydest
- will hold the result- Returns:
- dest
-
mul
Multiply the components of this vector by the given values and store the result indest
.- Parameters:
x
- the x component to multiplyy
- the y component to multiplydest
- will hold the result- Returns:
- dest
-
div
Divide all components of thisVector2i
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 all components of thisVector2i
by the given scalar value and store the result indest
.- Parameters:
scalar
- the scalar to divide bydest
- will hold the result- Returns:
- dest
-
negate
Negate this vector and store the result indest
.- Parameters:
dest
- will hold the result- Returns:
- dest
-
min
Set the components ofdest
to be the component-wise 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 component-wise maximum of this and the other vector.- Parameters:
v
- the other vectordest
- will hold the result- Returns:
- dest
-
maxComponent
int maxComponent()Determine the component with the biggest absolute value.- Returns:
- the component index, within
[0..1]
-
minComponent
int minComponent()Determine the component with the smallest (towards zero) absolute value.- Returns:
- the component index, within
[0..1]
-
absolute
Compute the absolute of each of this vector's components and store the result intodest
.- Parameters:
dest
- will hold the result- Returns:
- dest
-
get
Get the value of the specified component of this vector.- Parameters:
component
- the component, within[0..1]
- Returns:
- the value
- Throws:
IllegalArgumentException
- ifcomponent
is not within[0..1]
-
equals
boolean equals(int x, int y) Compare the vector components ofthis
vector with the given(x, y)
and return whether all of them are equal.- Parameters:
x
- the x component to compare toy
- the y component to compare to- Returns:
true
if all the vector components are equal
-