Package gaiasky.util.math
Interface Vectord<T extends Vectord<T>>
public interface Vectord<T extends Vectord<T>>

Method Summary
Modifier and TypeMethodDescriptionAdds the given vector to this vectorclamp(double min, double max)
Clamps this vector's length to given min and max valuescpy()
double
double
double
This method is faster thandst(Vectord)
because it avoids calculating a square root.boolean
epsilonEquals(T other, double epsilon)
Compares this vector with the other vector, using the supplied epsilon for fuzzy equality testing.boolean
hasOppositeDirection(T other)
boolean
hasSameDirection(T other)
interpolate(T target, 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(T other)
boolean
isCollinear(T other, double epsilon)
boolean
isCollinearOpposite(T other)
boolean
isCollinearOpposite(T other, double epsilon)
boolean
boolean
boolean
isPerpendicular(T other)
boolean
isPerpendicular(T other, double epsilon)
boolean
isUnit()
boolean
isUnit(double margin)
boolean
isZero()
boolean
isZero(double margin)
double
len()
double
len2()
This method is faster thanlen()
because it avoids calculating a square root.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.First scale a supplied vector, then add it to this vector.First scale a supplied vector, then add it to this vector.nor()
Normalizes this vector.scl(double scalar)
Scales this vector by a scalarScales this vector by another vectorSets this vector from the given vectorsetLength(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 directionsetZero()
Sets the components of this vector to 0Subtracts the given vector from this vector.

Method Details

cpy
T cpy() Returns:
 a copy of this vector

len
double len() Returns:
 The euclidean length

len2
double len2()This method is faster thanlen()
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. Returns:
 The squared euclidean length

limit
Limits the length of this vector, based on the desired maximum length. Parameters:
limit
 desired maximum length for this vector Returns:
 this vector for chaining

limit2
Limits the length of this vector, based on the desired maximum length squared.This method is slightly faster than limit().
 Parameters:
limit2
 squared desired maximum length for this vector Returns:
 this vector for chaining
 See Also:
len2()

setLength
Sets the length of this vector. Does nothing is this vector is zero. Parameters:
len
 desired length for this vector Returns:
 this vector for chaining

setLength2
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().
 Parameters:
len2
 desired square of the length for this vector Returns:
 this vector for chaining
 See Also:
len2()

clamp
Clamps this vector's length to given min and max values Parameters:
min
 Min lengthmax
 Max length Returns:
 This vector for chaining

set
Sets this vector from the given vector Parameters:
v
 The vector Returns:
 This vector for chaining

sub
Subtracts the given vector from this vector. Parameters:
v
 The vector Returns:
 This vector for chaining

nor
T nor()Normalizes this vector. Does nothing if it is zero. Returns:
 This vector for chaining

add
Adds the given vector to this vector Parameters:
v
 The vector Returns:
 This vector for chaining

dot
 Parameters:
v
 The other vector Returns:
 The dot product between this and the other vector

scl
Scales this vector by a scalar Parameters:
scalar
 The scalar Returns:
 This vector for chaining

scl
Scales this vector by another vector Returns:
 This vector for chaining

dst
 Parameters:
v
 The other vector Returns:
 the distance between this and the other vector

dst2
This method is faster thandst(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. Parameters:
v
 The other vector Returns:
 the squared distance between this and the other vector

lerp
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. Parameters:
target
 The target vectoralpha
 The interpolation coefficient Returns:
 This vector for chaining.

interpolate
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. Parameters:
target
 The target vectoralpha
 The interpolation coefficientinterpolator
 An Interpolation object describing the used interpolation method Returns:
 This vector for chaining.

setToRandomDirection
T setToRandomDirection()Sets this vector to the unit vector with a random direction Returns:
 This vector for chaining

isUnit
boolean isUnit() Returns:
 Whether this vector is a unit length vector

isUnit
boolean isUnit(double margin) Returns:
 Whether this vector is a unit length vector within the given margin.

isZero
boolean isZero() Returns:
 Whether this vector is a zero vector

isZero
boolean isZero(double margin) Returns:
 Whether the length of this vector is smaller than the given margin

isOnLine
 Returns:
 true if this vector is in line with the other vector (either in the same or the opposite direction)

isOnLine
 Returns:
 true if this vector is in line with the other vector (either in the same or the opposite direction)

isCollinear
 Returns:
 true if this vector is collinear with the other vector (
isOnLine(Vectord, double)
&&hasSameDirection(Vectord)
).

isCollinear
 Returns:
 true if this vector is collinear with the other vector (
isOnLine(Vectord)
&&hasSameDirection(Vectord)
).

isCollinearOpposite
 Returns:
 true if this vector is opposite collinear with the other vector (
isOnLine(Vectord, double)
&&hasOppositeDirection(Vectord)
).

isCollinearOpposite
 Returns:
 true if this vector is opposite collinear with the other vector (
isOnLine(Vectord)
&&hasOppositeDirection(Vectord)
).

isPerpendicular
 Returns:
 Whether this vector is perpendicular with the other vector. True if the dot product is 0.

isPerpendicular
 Parameters:
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
 Returns:
 Whether this vector has similar direction compared to the other vector. True if the normalized dot product is > 0.

hasOppositeDirection
 Returns:
 Whether this vector has opposite direction compared to the other vector. True if the normalized dot product is < 0.

epsilonEquals
Compares this vector with the other vector, using the supplied epsilon for fuzzy equality testing. Parameters:
other
epsilon
 Returns:
 whether the vectors have fuzzy equality.

mulAdd
First scale a supplied vector, then add it to this vector. Parameters:
v
 addition vectorscalar
 for scaling the addition vector

mulAdd
First scale a supplied vector, then add it to this vector. Parameters:
v
 addition vectormulVec
 vector by whose values the addition vector will be scaled

setZero
T setZero()Sets the components of this vector to 0 Returns:
 This vector for chaining
