java.lang.Object

org.web3d.util.spatial.Vec3DDouble

All Implemented Interfaces:: Comparable<ReadonlyVec3DDouble>, ReadonlyVec3DDouble

public class Vec3DDouble extends Object implements Comparable<ReadonlyVec3DDouble>, ReadonlyVec3DDouble

Comprehensive 3D vector class with additional basic intersection and collision detection features.

Nested Class Summary

Nested Classes

Modifier and Type

Class

Description

static enum

Vec3DDouble.Axis
Field Summary

Fields

Modifier and Type

Field

Description

static final ReadonlyVec3DDouble

MAX_VALUE

Defines vector with all coords set to Double.MAX_VALUE.

static final ReadonlyVec3DDouble

MIN_VALUE

Defines vector with all coords set to Double.MIN_VALUE.

double

x

X coordinate.

static final ReadonlyVec3DDouble

X_AXIS

Defines positive X axis.

double

y

Y coordinate.

static final ReadonlyVec3DDouble

Y_AXIS

Defines positive Y axis.

double

z

Z coordinate.

static final ReadonlyVec3DDouble

Z_AXIS

Defines positive Z axis.

static final ReadonlyVec3DDouble

ZERO

Defines the zero vector.
Constructor Summary

Constructors

Constructor

Description

Vec3DDouble()

Creates a new zero vector.

Vec3DDouble(double[] v)

Vec3DDouble(double x, double y, double z)

Creates a new vector with the given coordinates.

Vec3DDouble(ReadonlyVec3DDouble v)

Creates a new vector with the coordinates of the given vector.
Method Summary

Modifier and Type

Method

Description

final Vec3DDouble

abs()

Abs.

final Vec3DDouble

add(double a, double b, double c)

Adds vector {a,b,c} and returns result as new vector.

Vec3DDouble

add(ReadonlyVec3DDouble v)

final Vec3DDouble

add(Vec3DDouble v)

Add vector v and returns result as new vector.

final Vec3DDouble

addSelf(double a, double b, double c)

Adds vector {a,b,c} and overrides coordinates with result.

final Vec3DDouble

addSelf(ReadonlyVec3DDouble v)

final Vec3DDouble

addSelf(Vec3DDouble v)

Adds vector v and overrides coordinates with result.

final double

angleBetween(ReadonlyVec3DDouble v)

Computes the angle between this vector and vector V.

final double

angleBetween(ReadonlyVec3DDouble v, boolean forceNormalize)

Computes the angle between this vector and vector V.

final ReadonlyVec3DDouble

clear()

Sets all vector components to 0.

int

compareTo(ReadonlyVec3DDouble v)

Compares the length of the vector with another one.

final Vec3DDouble

constrain(toxi.geom.AABB box)

Forcefully fits the vector in the given AABB.

final Vec3DDouble

constrain(toxi.geom.Vec3D min, toxi.geom.Vec3D max)

Forcefully fits the vector in the given AABB specified by the 2 given points.

Vec3DDouble

copy()

Copy.

final Vec3DDouble

cross(ReadonlyVec3DDouble v)

Calculates cross-product with vector v.

final Vec3DDouble

cross(Vec3DDouble v)

final Vec3DDouble

crossInto(ReadonlyVec3DDouble v, Vec3DDouble result)

Calculates cross-product with vector v.

final Vec3DDouble

crossSelf(Vec3DDouble v)

Calculates cross-product with vector v.

final double

distanceTo(ReadonlyVec3DDouble v)

Calculates distance to another vector.

final double

distanceToSquared(ReadonlyVec3DDouble v)

Calculates the squared distance to another vector.

final double

dot(ReadonlyVec3DDouble v)

Computes the scalar product (dot product) with the given vector.

final double

dot(Vec3DDouble v)

boolean

equals(Object v)

Returns true if the Object v is of type ReadonlyVec3DDouble and all of the data members of v are equal to the corresponding data members in this vector.

boolean

equals(ReadonlyVec3DDouble v)

Returns true if the Object v is of type ReadonlyVec3DDouble and all of the data members of v are equal to the corresponding data members in this vector.

boolean

equalsWithTolerance(ReadonlyVec3DDouble v, double tolerance)

Compares this vector with the one given.

final Vec3DDouble

floor()

Replaces the vector components with integer values of their current values.

final Vec3DDouble

frac()

Replaces the vector components with the fractional part of their current values.

static Vec3DDouble

fromXYTheta(double theta)

Creates a new vector from the given angle in the XY plane.

static Vec3DDouble

fromXZTheta(double theta)

Creates a new vector from the given angle in the XZ plane.

static Vec3DDouble

fromYZTheta(double theta)

Creates a new vector from the given angle in the YZ plane.

final Vec3DDouble

getAbs()

Gets the abs.

Vec3DDouble

getCartesian()

Converts the spherical vector back into cartesian coordinates.

final double

getComponent(int id)

final double

getComponent(Vec3DDouble.Axis id)

final Vec3DDouble

getConstrained(toxi.geom.AABB box)

Creates a copy of the vector which forcefully fits in the given AABB.

final Vec3DDouble

getFloored()

Creates a new vector whose components are the integer value of their current values.

final Vec3DDouble

getFrac()

Creates a new vector whose components are the fractional part of their current values.

final Vec3DDouble

getInverted()

Scales vector uniformly by factor -1 ( v = -v ).

final Vec3DDouble

getLimited(double lim)

Creates a copy of the vector with its magnitude limited to the length given.

Vec3DDouble

getMapped(toxi.math.ScaleMap map)

Produces a new vector with its coordinates passed through the given ScaleMap.

final Vec3DDouble

getNormalized()

Produces the normalized version as a new vector.

final Vec3DDouble

getNormalizedTo(double len)

Produces a new vector normalized to the given length.

final Vec3DDouble

getReciprocal()

Returns a multiplicative inverse copy of the vector.

final Vec3DDouble

getReflected(ReadonlyVec3DDouble normal)

final Vec3DDouble

getRotatedAroundAxis(ReadonlyVec3DDouble axis, double theta)

Gets the rotated around axis.

final Vec3DDouble

getRotatedX(double theta)

Creates a new vector rotated by the given angle around the X axis.

final Vec3DDouble

getRotatedY(double theta)

Creates a new vector rotated by the given angle around the Y axis.

final Vec3DDouble

getRotatedZ(double theta)

Creates a new vector rotated by the given angle around the Z axis.

final Vec3DDouble

getSignum()

Creates a new vector in which all components are replaced with the signum of their original values.

Vec3DDouble

getSpherical()

Converts the vector into spherical coordinates.

int

hashCode()

Returns a hash code value based on the data values in this object.

final double

headingXY()

Computes the vector's direction in the XY plane (for example for 2D points).

final double

headingXZ()

Computes the vector's direction in the XZ plane.

final double

headingYZ()

Computes the vector's direction in the YZ plane.

ReadonlyVec3DDouble

immutable()

final Vec3DDouble

interpolateTo(ReadonlyVec3DDouble v, double f)

Interpolates the vector towards the given target vector, using linear interpolation.

final Vec3DDouble

interpolateTo(ReadonlyVec3DDouble v, double f, toxi.math.InterpolateStrategy s)

Interpolates the vector towards the given target vector, using the given InterpolateStrategy.

final Vec3DDouble

interpolateTo(Vec3DDouble v, double f)

final Vec3DDouble

interpolateTo(Vec3DDouble v, double f, toxi.math.InterpolateStrategy s)

final Vec3DDouble

interpolateToSelf(ReadonlyVec3DDouble v, double f)

Interpolates the vector towards the given target vector, using linear interpolation.

final Vec3DDouble

interpolateToSelf(ReadonlyVec3DDouble v, double f, toxi.math.InterpolateStrategy s)

Interpolates the vector towards the given target vector, using the given InterpolateStrategy.

final Vec3DDouble

invert()

Scales vector uniformly by factor -1 ( v = -v ), overrides coordinates with result.

boolean

isInAABB(Vec3DDouble boxOrigin, Vec3DDouble boxExtent)

Checks if the point is inside the given axis-aligned bounding box.

boolean

isInAABB(toxi.geom.AABB box)

Checks if the point is inside the given AABB.

final boolean

isMajorAxis(double tol)

Checks if the vector is parallel with either the X or Y axis (any direction).

final boolean

isZeroVector()

Checks if vector has a magnitude equals or close to zero (tolerance used is MathUtils.EPS).

final Vec3DDouble

jitter(double j)

Add random jitter to the vector in the range -j ...

final Vec3DDouble

jitter(double jx, double jy, double jz)

Adds random jitter to the vector in the range -j ...

final Vec3DDouble

jitter(Random rnd, double j)

final Vec3DDouble

jitter(Random rnd, double jx, double jy, double jz)

final Vec3DDouble

jitter(Random rnd, Vec3DDouble jitterVec)

final Vec3DDouble

jitter(Vec3DDouble jitterVec)

Adds random jitter to the vector in the range defined by the given vector components and using the default Random generator of MathUtils.

final Vec3DDouble

limit(double lim)

Limits the vector's magnitude to the length given.

final double

magnitude()

Calculates the magnitude/eucledian length of the vector.

final double

magSquared()

Calculates only the squared magnitude/length of the vector.

static Vec3DDouble

max(ReadonlyVec3DDouble a, ReadonlyVec3DDouble b)

Constructs a new vector consisting of the largest components of both vectors.

final Vec3DDouble

maxSelf(ReadonlyVec3DDouble b)

Max self.

static Vec3DDouble

min(ReadonlyVec3DDouble a, ReadonlyVec3DDouble b)

Constructs a new vector consisting of the smallest components of both vectors.

final Vec3DDouble

minSelf(ReadonlyVec3DDouble b)

Min self.

final Vec3DDouble

modSelf(double base)

Applies a uniform modulo operation to the vector, using the same base for all components.

final Vec3DDouble

modSelf(double bx, double by, double bz)

Calculates modulo operation for each vector component separately.

final Vec3DDouble

normalize()

Normalizes the vector so that its magnitude = 1.

final Vec3DDouble

normalizeTo(double len)

Normalizes the vector to the given length.

static Vec3DDouble

randomVector()

Static factory method.

static Vec3DDouble

randomVector(Random rnd)

Static factory method.

final Vec3DDouble

reciprocal()

Replaces the vector components with their multiplicative inverse.

final Vec3DDouble

reflect(ReadonlyVec3DDouble normal)

final Vec3DDouble

rotateAroundAxis(ReadonlyVec3DDouble axis, double theta)

Rotates the vector around the giving axis.

final Vec3DDouble

rotateX(double theta)

Rotates the vector by the given angle around the X axis.

final Vec3DDouble

rotateY(double theta)

Rotates the vector by the given angle around the Y axis.

final Vec3DDouble

rotateZ(double theta)

Rotates the vector by the given angle around the Z axis.

Vec3DDouble

scale(double s)

Scales vector uniformly and returns result as new vector.

Vec3DDouble

scale(double a, double b, double c)

Scales vector non-uniformly and returns result as new vector.

Vec3DDouble

scale(ReadonlyVec3DDouble s)

Scales vector non-uniformly by vector v and returns result as new vector.

Vec3DDouble

scale(Vec3DDouble s)

Vec3DDouble

scaleSelf(double s)

Scales vector uniformly and overrides coordinates with result.

Vec3DDouble

scaleSelf(double a, double b, double c)

Scales vector non-uniformly by vector {a,b,c} and overrides coordinates with result.

Vec3DDouble

scaleSelf(ReadonlyVec3DDouble s)

Vec3DDouble

scaleSelf(Vec3DDouble s)

Scales vector non-uniformly by vector v and overrides coordinates with result.

Vec3DDouble

set(double x, double y, double z)

Overrides coordinates with the given values.

Vec3DDouble

set(ReadonlyVec3DDouble v)

Vec3DDouble

set(Vec3DDouble v)

Overrides coordinates with the ones of the given vector.

final Vec3DDouble

setComponent(int id, double val)

final Vec3DDouble

setComponent(Vec3DDouble.Axis id, double val)

Vec3DDouble

setX(double x)

Vec3DDouble

setXY(toxi.geom.Vec2D v)

Overrides XY coordinates with the ones of the given 2D vector.

Vec3DDouble

setY(double y)

Vec3DDouble

setZ(double z)

Vec3DDouble

shuffle(int iterations)

Vec3DDouble

signum()

Replaces all vector components with the signum of their original values.

final Vec3DDouble

snapToAxis()

Rounds the vector to the closest major axis.

final Vec3DDouble

sub(double a, double b, double c)

Subtracts vector {a,b,c} and returns result as new vector.

final Vec3DDouble

sub(ReadonlyVec3DDouble v)

Subtracts vector v and returns result as new vector.

final Vec3DDouble

sub(Vec3DDouble v)

final Vec3DDouble

subSelf(double a, double b, double c)

Subtracts vector {a,b,c} and overrides coordinates with result.

final Vec3DDouble

subSelf(ReadonlyVec3DDouble v)

final Vec3DDouble

subSelf(Vec3DDouble v)

Subtracts vector v and overrides coordinates with result.

final toxi.geom.Vec2D

to2DXY()

Creates a new 2D vector of the XY components.

final toxi.geom.Vec2D

to2DXZ()

Creates a new 2D vector of the XZ components.

final toxi.geom.Vec2D

to2DYZ()

Creates a new 2D vector of the YZ components.

double[]

toArray()

double[]

toArray4(double w)

final Vec3DDouble

toCartesian()

final Vec3DDouble

toSpherical()

String

toString()

final double

x()

final double

y()

final double

z()

Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Field Details
- X_AXIS
  
  public static final ReadonlyVec3DDouble X_AXIS
  
  Defines positive X axis.
- Y_AXIS
  
  public static final ReadonlyVec3DDouble Y_AXIS
  
  Defines positive Y axis.
- Z_AXIS
  
  public static final ReadonlyVec3DDouble Z_AXIS
  
  Defines positive Z axis.
- ZERO
  
  public static final ReadonlyVec3DDouble ZERO
  
  Defines the zero vector.
- MIN_VALUE
  
  public static final ReadonlyVec3DDouble MIN_VALUE
  
  Defines vector with all coords set to Double.MIN_VALUE. Useful for bounding box operations.
- MAX_VALUE
  
  public static final ReadonlyVec3DDouble MAX_VALUE
  
  Defines vector with all coords set to Double.MAX_VALUE. Useful for bounding box operations.
- x
  
  public double x
  
  X coordinate.
- y
  
  public double y
  
  Y coordinate.
- z
  
  public double z
  
  Z coordinate.
Constructor Details
- Vec3DDouble
  
  public Vec3DDouble()
  
  Creates a new zero vector.
- Vec3DDouble
  
  public Vec3DDouble(double x, double y, double z)
  
  Creates a new vector with the given coordinates.
  
  Parameters:
  
  x - the x
  
  y - the y
  
  z - the z
- Vec3DDouble
  
  public Vec3DDouble(double[] v)
- Vec3DDouble
  
  public Vec3DDouble(ReadonlyVec3DDouble v)
  
  Creates a new vector with the coordinates of the given vector.
  
  Parameters:
  
  v - vector to be copied
Method Details
- fromXYTheta
  
  public static Vec3DDouble fromXYTheta(double theta)
  
  Creates a new vector from the given angle in the XY plane. The Z component of the vector will be zero. The resulting vector for theta=0 is equal to the positive X axis.
  
  Parameters:
  
  theta - the theta
  
  Returns:
  
  new vector in the XY plane
- fromXZTheta
  
  public static Vec3DDouble fromXZTheta(double theta)
  
  Creates a new vector from the given angle in the XZ plane. The Y component of the vector will be zero. The resulting vector for theta=0 is equal to the positive X axis.
  
  Parameters:
  
  theta - the theta
  
  Returns:
  
  new vector in the XZ plane
- fromYZTheta
  
  public static Vec3DDouble fromYZTheta(double theta)
  
  Creates a new vector from the given angle in the YZ plane. The X component of the vector will be zero. The resulting vector for theta=0 is equal to the positive Y axis.
  
  Parameters:
  
  theta - the theta
  
  Returns:
  
  new vector in the YZ plane
- max
  
  public static Vec3DDouble max(ReadonlyVec3DDouble a, ReadonlyVec3DDouble b)
  
  Constructs a new vector consisting of the largest components of both vectors.
  
  Parameters:
  
  a - the a
  
  b - the b
  
  Returns:
  
  result as new vector
- min
  
  public static Vec3DDouble min(ReadonlyVec3DDouble a, ReadonlyVec3DDouble b)
  
  Constructs a new vector consisting of the smallest components of both vectors.
  
  Parameters:
  
  a - the a
  
  b - comparing vector
  
  Returns:
  
  result as new vector
- randomVector
  
  public static Vec3DDouble randomVector()
  
  Static factory method. Creates a new random unit vector using the Random implementation set as default for the MathUtils class.
  
  Returns:
  
  a new random normalized unit vector.
- randomVector
  
  public static Vec3DDouble randomVector(Random rnd)
  
  Static factory method. Creates a new random unit vector using the given Random generator instance. I recommend to have a look at the https://uncommons-maths.dev.java.net library for a good choice of reliable and high quality random number generators.
  
  Parameters:
  
  rnd - the rnd
  
  Returns:
  
  a new random normalized unit vector.
- abs
  
  public final Vec3DDouble abs()
  
  Abs.
  
  Returns:
  
  the vec3 d
- add
  
  public final Vec3DDouble add(double a, double b, double c)
  
  Description copied from interface: ReadonlyVec3DDouble
  
  Adds vector {a,b,c} and returns result as new vector.
  
  Specified by:
  
  add in interface ReadonlyVec3DDouble
  
  Parameters:
  
  a - X coordinate
  
  b - Y coordinate
  
  c - Z coordinate
  
  Returns:
  
  result as new vector
- add
  
  public Vec3DDouble add(ReadonlyVec3DDouble v)
  
  Specified by:
  
  add in interface ReadonlyVec3DDouble
- add
  
  public final Vec3DDouble add(Vec3DDouble v)
  
  Description copied from interface: ReadonlyVec3DDouble
  
  Add vector v and returns result as new vector.
  
  Specified by:
  
  add in interface ReadonlyVec3DDouble
  
  Parameters:
  
  v - vector to add
  
  Returns:
  
  result as new vector
- addSelf
  
  public final Vec3DDouble addSelf(double a, double b, double c)
  
  Adds vector {a,b,c} and overrides coordinates with result.
  
  Parameters:
  
  a - X coordinate
  
  b - Y coordinate
  
  c - Z coordinate
  
  Returns:
  
  itself
- addSelf
  
  public final Vec3DDouble addSelf(ReadonlyVec3DDouble v)
- addSelf
  
  public final Vec3DDouble addSelf(Vec3DDouble v)
  
  Adds vector v and overrides coordinates with result.
  
  Parameters:
  
  v - vector to add
  
  Returns:
  
  itself
- angleBetween
  
  public final double angleBetween(ReadonlyVec3DDouble v)
  
  Description copied from interface: ReadonlyVec3DDouble
  
  Computes the angle between this vector and vector V. This function assumes both vectors are normalized, if this can't be guaranteed, use the alternative implementation ReadonlyVec3DDouble.angleBetween(ReadonlyVec3DDouble, boolean)
  
  Specified by:
  
  angleBetween in interface ReadonlyVec3DDouble
  
  Parameters:
  
  v - vector
  
  Returns:
  
  angle in radians, or NaN if vectors are parallel
- angleBetween
  
  public final double angleBetween(ReadonlyVec3DDouble v, boolean forceNormalize)
  
  Description copied from interface: ReadonlyVec3DDouble
  
  Computes the angle between this vector and vector V.
  
  Specified by:
  
  angleBetween in interface ReadonlyVec3DDouble
  
  Parameters:
  
  v - vector
  
  forceNormalize - true, if normalized versions of the vectors are to be used (Note: only copies will be used, original vectors will not be altered by this method)
  
  Returns:
  
  angle in radians, or NaN if vectors are parallel
- clear
  
  public final ReadonlyVec3DDouble clear()
  
  Sets all vector components to 0.
  
  Returns:
  
  itself
- compareTo
  
  public int compareTo(ReadonlyVec3DDouble v)
  
  Description copied from interface: ReadonlyVec3DDouble
  
  Compares the length of the vector with another one.
  
  Specified by:
  
  compareTo in interface Comparable<ReadonlyVec3DDouble>
  
  Specified by:
  
  compareTo in interface ReadonlyVec3DDouble
  
  Parameters:
  
  v - vector to compare with
  
  Returns:
  
  -1 if other vector is longer, 0 if both are equal or else +1
- constrain
  
  public final Vec3DDouble constrain(toxi.geom.AABB box)
  
  Forcefully fits the vector in the given AABB.
  
  Parameters:
  
  box - the box
  
  Returns:
  
  itself
- constrain
  
  public final Vec3DDouble constrain(toxi.geom.Vec3D min, toxi.geom.Vec3D max)
  
  Forcefully fits the vector in the given AABB specified by the 2 given points.
  
  Parameters:
  
  min -
  
  max -
  
  Returns:
  
  itself
- copy
  
  public Vec3DDouble copy()
  
  Description copied from interface: ReadonlyVec3DDouble
  
  Copy.
  
  Specified by:
  
  copy in interface ReadonlyVec3DDouble
  
  Returns:
  
  a new independent instance/copy of a given vector
- cross
  
  public final Vec3DDouble cross(ReadonlyVec3DDouble v)
  
  Description copied from interface: ReadonlyVec3DDouble
  
  Calculates cross-product with vector v. The resulting vector is perpendicular to both the current and supplied vector.
  
  Specified by:
  
  cross in interface ReadonlyVec3DDouble
  
  Parameters:
  
  v - vector to cross
  
  Returns:
  
  cross-product as new vector
- cross
  
  public final Vec3DDouble cross(Vec3DDouble v)
- crossInto
  
  public final Vec3DDouble crossInto(ReadonlyVec3DDouble v, Vec3DDouble result)
  
  Description copied from interface: ReadonlyVec3DDouble
  
  Calculates cross-product with vector v. The resulting vector is perpendicular to both the current and supplied vector and stored in the supplied result vector.
  
  Specified by:
  
  crossInto in interface ReadonlyVec3DDouble
  
  Parameters:
  
  v - vector to cross
  
  result - result vector
  
  Returns:
  
  result vector
- crossSelf
  
  public final Vec3DDouble crossSelf(Vec3DDouble v)
  
  Calculates cross-product with vector v. The resulting vector is perpendicular to both the current and supplied vector and overrides the current.
  
  Parameters:
  
  v - the v
  
  Returns:
  
  itself
- distanceTo
  
  public final double distanceTo(ReadonlyVec3DDouble v)
  
  Description copied from interface: ReadonlyVec3DDouble
  
  Calculates distance to another vector.
  
  Specified by:
  
  distanceTo in interface ReadonlyVec3DDouble
  
  Parameters:
  
  v - non-null vector
  
  Returns:
  
  distance or Float.NaN if v=null
- distanceToSquared
  public final double distanceToSquared(ReadonlyVec3DDouble v)
  
  Description copied from interface: ReadonlyVec3DDouble
  
  Calculates the squared distance to another vector.
  
  Specified by:
  
  distanceToSquared in interface ReadonlyVec3DDouble
  
  Parameters:
  
  v - non-null vector
  
  Returns:
  
  distance or NaN if v=null
  
  See Also:
  
  ReadonlyVec3DDouble.magSquared()
- dot
  public final double dot(ReadonlyVec3DDouble v)
  
  Description copied from interface: ReadonlyVec3DDouble
  
  Computes the scalar product (dot product) with the given vector.
  
  Specified by:
  
  dot in interface ReadonlyVec3DDouble
  
  Parameters:
  
  v - the v
  
  Returns:
  
  dot product
  
  See Also:
  
  Wikipedia entry
- dot
  
  public final double dot(Vec3DDouble v)
- equals
  
  public boolean equals(Object v)
  
  Returns true if the Object v is of type ReadonlyVec3DDouble and all of the data members of v are equal to the corresponding data members in this vector.
  
  Specified by:
  
  equals in interface ReadonlyVec3DDouble
  
  Overrides:
  
  equals in class Object
  
  Parameters:
  
  v - the Object with which the comparison is made
  
  Returns:
  
  true or false
- equals
  
  public boolean equals(ReadonlyVec3DDouble v)
  
  Returns true if the Object v is of type ReadonlyVec3DDouble and all of the data members of v are equal to the corresponding data members in this vector.
  
  Parameters:
  
  v - the vector with which the comparison is made
  
  Returns:
  
  true or false
- equalsWithTolerance
  
  public boolean equalsWithTolerance(ReadonlyVec3DDouble v, double tolerance)
  
  Description copied from interface: ReadonlyVec3DDouble
  
  Compares this vector with the one given. The vectors are deemed equal if the individual differences of all component values are within the given tolerance.
  
  Specified by:
  
  equalsWithTolerance in interface ReadonlyVec3DDouble
  
  Parameters:
  
  v - the v
  
  tolerance - the tolerance
  
  Returns:
  
  true, if equal
- floor
  
  public final Vec3DDouble floor()
  
  Replaces the vector components with integer values of their current values.
  
  Returns:
  
  itself
- frac
  
  public final Vec3DDouble frac()
  
  Replaces the vector components with the fractional part of their current values.
  
  Returns:
  
  itself
- getAbs
  
  public final Vec3DDouble getAbs()
  
  Description copied from interface: ReadonlyVec3DDouble
  
  Gets the abs.
  
  Specified by:
  
  getAbs in interface ReadonlyVec3DDouble
  
  Returns:
  
  the abs
- getCartesian
  
  public Vec3DDouble getCartesian()
  
  Description copied from interface: ReadonlyVec3DDouble
  
  Converts the spherical vector back into cartesian coordinates.
  
  Specified by:
  
  getCartesian in interface ReadonlyVec3DDouble
  
  Returns:
  
  new vector
- getComponent
  
  public final double getComponent(Vec3DDouble.Axis id)
  
  Specified by:
  
  getComponent in interface ReadonlyVec3DDouble
- getComponent
  
  public final double getComponent(int id)
  
  Specified by:
  
  getComponent in interface ReadonlyVec3DDouble
- getConstrained
  
  public final Vec3DDouble getConstrained(toxi.geom.AABB box)
  
  Description copied from interface: ReadonlyVec3DDouble
  
  Creates a copy of the vector which forcefully fits in the given AABB.
  
  Specified by:
  
  getConstrained in interface ReadonlyVec3DDouble
  
  Parameters:
  
  box - the box
  
  Returns:
  
  fitted vector
- getFloored
  
  public final Vec3DDouble getFloored()
  
  Description copied from interface: ReadonlyVec3DDouble
  
  Creates a new vector whose components are the integer value of their current values.
  
  Specified by:
  
  getFloored in interface ReadonlyVec3DDouble
  
  Returns:
  
  result as new vector
- getFrac
  
  public final Vec3DDouble getFrac()
  
  Description copied from interface: ReadonlyVec3DDouble
  
  Creates a new vector whose components are the fractional part of their current values.
  
  Specified by:
  
  getFrac in interface ReadonlyVec3DDouble
  
  Returns:
  
  result as new vector
- getInverted
  
  public final Vec3DDouble getInverted()
  
  Description copied from interface: ReadonlyVec3DDouble
  
  Scales vector uniformly by factor -1 ( v = -v ).
  
  Specified by:
  
  getInverted in interface ReadonlyVec3DDouble
  
  Returns:
  
  result as new vector
- getLimited
  
  public final Vec3DDouble getLimited(double lim)
  
  Description copied from interface: ReadonlyVec3DDouble
  
  Creates a copy of the vector with its magnitude limited to the length given.
  
  Specified by:
  
  getLimited in interface ReadonlyVec3DDouble
  
  Parameters:
  
  lim - new maximum magnitude
  
  Returns:
  
  result as new vector
- getMapped
  
  public Vec3DDouble getMapped(toxi.math.ScaleMap map)
  
  Description copied from interface: ReadonlyVec3DDouble
  
  Produces a new vector with its coordinates passed through the given ScaleMap.
  
  Specified by:
  
  getMapped in interface ReadonlyVec3DDouble
  
  Parameters:
  
  map -
  
  Returns:
  
  mapped vector
- getNormalized
  
  public final Vec3DDouble getNormalized()
  
  Description copied from interface: ReadonlyVec3DDouble
  
  Produces the normalized version as a new vector.
  
  Specified by:
  
  getNormalized in interface ReadonlyVec3DDouble
  
  Returns:
  
  new vector
- getNormalizedTo
  
  public final Vec3DDouble getNormalizedTo(double len)
  
  Description copied from interface: ReadonlyVec3DDouble
  
  Produces a new vector normalized to the given length.
  
  Specified by:
  
  getNormalizedTo in interface ReadonlyVec3DDouble
  
  Parameters:
  
  len - new desired length
  
  Returns:
  
  new vector
- getReciprocal
  
  public final Vec3DDouble getReciprocal()
  
  Description copied from interface: ReadonlyVec3DDouble
  
  Returns a multiplicative inverse copy of the vector.
  
  Specified by:
  
  getReciprocal in interface ReadonlyVec3DDouble
  
  Returns:
  
  new vector
- getReflected
  
  public final Vec3DDouble getReflected(ReadonlyVec3DDouble normal)
  
  Specified by:
  
  getReflected in interface ReadonlyVec3DDouble
- getRotatedAroundAxis
  
  public final Vec3DDouble getRotatedAroundAxis(ReadonlyVec3DDouble axis, double theta)
  
  Description copied from interface: ReadonlyVec3DDouble
  
  Gets the rotated around axis.
  
  Specified by:
  
  getRotatedAroundAxis in interface ReadonlyVec3DDouble
  
  Parameters:
  
  axis - the axis
  
  theta - the theta
  
  Returns:
  
  new result vector
- getRotatedX
  
  public final Vec3DDouble getRotatedX(double theta)
  
  Description copied from interface: ReadonlyVec3DDouble
  
  Creates a new vector rotated by the given angle around the X axis.
  
  Specified by:
  
  getRotatedX in interface ReadonlyVec3DDouble
  
  Parameters:
  
  theta - the theta
  
  Returns:
  
  rotated vector
- getRotatedY
  
  public final Vec3DDouble getRotatedY(double theta)
  
  Description copied from interface: ReadonlyVec3DDouble
  
  Creates a new vector rotated by the given angle around the Y axis.
  
  Specified by:
  
  getRotatedY in interface ReadonlyVec3DDouble
  
  Parameters:
  
  theta - the theta
  
  Returns:
  
  rotated vector
- getRotatedZ
  
  public final Vec3DDouble getRotatedZ(double theta)
  
  Description copied from interface: ReadonlyVec3DDouble
  
  Creates a new vector rotated by the given angle around the Z axis.
  
  Specified by:
  
  getRotatedZ in interface ReadonlyVec3DDouble
  
  Parameters:
  
  theta - the theta
  
  Returns:
  
  rotated vector
- getSignum
  
  public final Vec3DDouble getSignum()
  
  Description copied from interface: ReadonlyVec3DDouble
  
  Creates a new vector in which all components are replaced with the signum of their original values. In other words if a components value was negative its new value will be -1, if zero => 0, if positive => +1
  
  Specified by:
  
  getSignum in interface ReadonlyVec3DDouble
  
  Returns:
  
  result vector
- getSpherical
  public Vec3DDouble getSpherical()
  
  Description copied from interface: ReadonlyVec3DDouble
  
  Converts the vector into spherical coordinates. After the conversion the vector components are to be interpreted as:
  
  x = radius
  
  y = azimuth
  
  z = theta
  
  Specified by:
  
  getSpherical in interface ReadonlyVec3DDouble
  
  Returns:
  
  new vector
- hashCode
  
  public int hashCode()
  
  Returns a hash code value based on the data values in this object. Two different Vec3DDouble objects with identical data values (i.e., Vec3DDouble.equals returns true) will return the same hash code value. Two objects with different data members may return the same hash value, although this is not likely.
  
  Overrides:
  
  hashCode in class Object
  
  Returns:
  
  the integer hash code value
- headingXY
  
  public final double headingXY()
  
  Description copied from interface: ReadonlyVec3DDouble
  
  Computes the vector's direction in the XY plane (for example for 2D points). The positive X axis equals 0 degrees.
  
  Specified by:
  
  headingXY in interface ReadonlyVec3DDouble
  
  Returns:
  
  rotation angle
- headingXZ
  
  public final double headingXZ()
  
  Description copied from interface: ReadonlyVec3DDouble
  
  Computes the vector's direction in the XZ plane. The positive X axis equals 0 degrees.
  
  Specified by:
  
  headingXZ in interface ReadonlyVec3DDouble
  
  Returns:
  
  rotation angle
- headingYZ
  
  public final double headingYZ()
  
  Description copied from interface: ReadonlyVec3DDouble
  
  Computes the vector's direction in the YZ plane. The positive Z axis equals 0 degrees.
  
  Specified by:
  
  headingYZ in interface ReadonlyVec3DDouble
  
  Returns:
  
  rotation angle
- immutable
  
  public ReadonlyVec3DDouble immutable()
- interpolateTo
  
  public final Vec3DDouble interpolateTo(ReadonlyVec3DDouble v, double f)
  
  Description copied from interface: ReadonlyVec3DDouble
  
  Interpolates the vector towards the given target vector, using linear interpolation.
  
  Specified by:
  
  interpolateTo in interface ReadonlyVec3DDouble
  
  Parameters:
  
  v - target vector
  
  f - interpolation factor (should be in the range 0..1)
  
  Returns:
  
  result as new vector
- interpolateTo
  
  public final Vec3DDouble interpolateTo(ReadonlyVec3DDouble v, double f, toxi.math.InterpolateStrategy s)
  
  Description copied from interface: ReadonlyVec3DDouble
  
  Interpolates the vector towards the given target vector, using the given InterpolateStrategy.
  
  Specified by:
  
  interpolateTo in interface ReadonlyVec3DDouble
  
  Parameters:
  
  v - target vector
  
  f - interpolation factor (should be in the range 0..1)
  
  s - InterpolateStrategy instance
  
  Returns:
  
  result as new vector
- interpolateTo
  
  public final Vec3DDouble interpolateTo(Vec3DDouble v, double f)
- interpolateTo
  
  public final Vec3DDouble interpolateTo(Vec3DDouble v, double f, toxi.math.InterpolateStrategy s)
- interpolateToSelf
  
  public final Vec3DDouble interpolateToSelf(ReadonlyVec3DDouble v, double f)
  
  Interpolates the vector towards the given target vector, using linear interpolation.
  
  Parameters:
  
  v - target vector
  
  f - interpolation factor (should be in the range 0..1)
  
  Returns:
  
  itself, result overrides current vector
- interpolateToSelf
  
  public final Vec3DDouble interpolateToSelf(ReadonlyVec3DDouble v, double f, toxi.math.InterpolateStrategy s)
  
  Interpolates the vector towards the given target vector, using the given InterpolateStrategy.
  
  Parameters:
  
  v - target vector
  
  f - interpolation factor (should be in the range 0..1)
  
  s - InterpolateStrategy instance
  
  Returns:
  
  itself, result overrides current vector
- invert
  
  public final Vec3DDouble invert()
  
  Scales vector uniformly by factor -1 ( v = -v ), overrides coordinates with result.
  
  Returns:
  
  itself
- isInAABB
  
  public boolean isInAABB(toxi.geom.AABB box)
  
  Description copied from interface: ReadonlyVec3DDouble
  
  Checks if the point is inside the given AABB.
  
  Specified by:
  
  isInAABB in interface ReadonlyVec3DDouble
  
  Parameters:
  
  box - bounding box to check
  
  Returns:
  
  true, if point is inside
- isInAABB
  
  public boolean isInAABB(Vec3DDouble boxOrigin, Vec3DDouble boxExtent)
  
  Description copied from interface: ReadonlyVec3DDouble
  
  Checks if the point is inside the given axis-aligned bounding box.
  
  Specified by:
  
  isInAABB in interface ReadonlyVec3DDouble
  
  Parameters:
  
  boxOrigin - bounding box origin/center
  
  boxExtent - bounding box extends (half measure)
  
  Returns:
  
  true, if point is inside the box
- isMajorAxis
  
  public final boolean isMajorAxis(double tol)
  
  Description copied from interface: ReadonlyVec3DDouble
  
  Checks if the vector is parallel with either the X or Y axis (any direction).
  
  Specified by:
  
  isMajorAxis in interface ReadonlyVec3DDouble
  
  Parameters:
  
  tol -
  
  Returns:
  
  true, if parallel within the given tolerance
- isZeroVector
  
  public final boolean isZeroVector()
  
  Description copied from interface: ReadonlyVec3DDouble
  
  Checks if vector has a magnitude equals or close to zero (tolerance used is MathUtils.EPS).
  
  Specified by:
  
  isZeroVector in interface ReadonlyVec3DDouble
  
  Returns:
  
  true, if zero vector
- jitter
  
  public final Vec3DDouble jitter(double j)
  
  Add random jitter to the vector in the range -j ... +j using the default Random generator of MathUtils.
  
  Parameters:
  
  j - the j
  
  Returns:
  
  the vec3 d
- jitter
  
  public final Vec3DDouble jitter(double jx, double jy, double jz)
  
  Adds random jitter to the vector in the range -j ... +j using the default Random generator of MathUtils.
  
  Parameters:
  
  jx - maximum x jitter
  
  jy - maximum y jitter
  
  jz - maximum z jitter
  
  Returns:
  
  itself
- jitter
  
  public final Vec3DDouble jitter(Random rnd, double j)
- jitter
  
  public final Vec3DDouble jitter(Random rnd, double jx, double jy, double jz)
- jitter
  
  public final Vec3DDouble jitter(Random rnd, Vec3DDouble jitterVec)
- jitter
  
  public final Vec3DDouble jitter(Vec3DDouble jitterVec)
  
  Adds random jitter to the vector in the range defined by the given vector components and using the default Random generator of MathUtils.
  
  Parameters:
  
  jitterVec - the jitter vec
  
  Returns:
  
  itself
- limit
  
  public final Vec3DDouble limit(double lim)
  
  Limits the vector's magnitude to the length given.
  
  Parameters:
  
  lim - new maximum magnitude
  
  Returns:
  
  itself
- magnitude
  
  public final double magnitude()
  
  Description copied from interface: ReadonlyVec3DDouble
  
  Calculates the magnitude/eucledian length of the vector.
  
  Specified by:
  
  magnitude in interface ReadonlyVec3DDouble
  
  Returns:
  
  vector length
- magSquared
  
  public final double magSquared()
  
  Description copied from interface: ReadonlyVec3DDouble
  
  Calculates only the squared magnitude/length of the vector. Useful for inverse square law applications and/or for speed reasons or if the real eucledian distance is not required (e.g. sorting).
  
  Specified by:
  
  magSquared in interface ReadonlyVec3DDouble
  
  Returns:
  
  squared magnitude (x^2 + y^2 + z^2)
- maxSelf
  
  public final Vec3DDouble maxSelf(ReadonlyVec3DDouble b)
  
  Max self.
  
  Parameters:
  
  b - the b
  
  Returns:
  
  the vec3 d
- minSelf
  
  public final Vec3DDouble minSelf(ReadonlyVec3DDouble b)
  
  Min self.
  
  Parameters:
  
  b - the b
  
  Returns:
  
  the vec3 d
- modSelf
  
  public final Vec3DDouble modSelf(double base)
  
  Applies a uniform modulo operation to the vector, using the same base for all components.
  
  Parameters:
  
  base - the base
  
  Returns:
  
  itself
- modSelf
  
  public final Vec3DDouble modSelf(double bx, double by, double bz)
  
  Calculates modulo operation for each vector component separately.
  
  Parameters:
  
  bx - the bx
  
  by - the by
  
  bz - the bz
  
  Returns:
  
  itself
- normalize
  
  public final Vec3DDouble normalize()
  
  Normalizes the vector so that its magnitude = 1.
  
  Returns:
  
  itself
- normalizeTo
  
  public final Vec3DDouble normalizeTo(double len)
  
  Normalizes the vector to the given length.
  
  Parameters:
  
  len - desired length
  
  Returns:
  
  itself
- reciprocal
  
  public final Vec3DDouble reciprocal()
  
  Replaces the vector components with their multiplicative inverse.
  
  Returns:
  
  itself
- reflect
  
  public final Vec3DDouble reflect(ReadonlyVec3DDouble normal)
- rotateAroundAxis
  
  public final Vec3DDouble rotateAroundAxis(ReadonlyVec3DDouble axis, double theta)
  
  Rotates the vector around the giving axis.
  
  Parameters:
  
  axis - rotation axis vector
  
  theta - rotation angle (in radians)
  
  Returns:
  
  itself
- rotateX
  
  public final Vec3DDouble rotateX(double theta)
  
  Rotates the vector by the given angle around the X axis.
  
  Parameters:
  
  theta - the theta
  
  Returns:
  
  itself
- rotateY
  
  public final Vec3DDouble rotateY(double theta)
  
  Rotates the vector by the given angle around the Y axis.
  
  Parameters:
  
  theta - the theta
  
  Returns:
  
  itself
- rotateZ
  
  public final Vec3DDouble rotateZ(double theta)
  
  Rotates the vector by the given angle around the Z axis.
  
  Parameters:
  
  theta - the theta
  
  Returns:
  
  itself
- scale
  
  public Vec3DDouble scale(double s)
  
  Description copied from interface: ReadonlyVec3DDouble
  
  Scales vector uniformly and returns result as new vector.
  
  Specified by:
  
  scale in interface ReadonlyVec3DDouble
  
  Parameters:
  
  s - scale factor
  
  Returns:
  
  new vector
- scale
  
  public Vec3DDouble scale(double a, double b, double c)
  
  Description copied from interface: ReadonlyVec3DDouble
  
  Scales vector non-uniformly and returns result as new vector.
  
  Specified by:
  
  scale in interface ReadonlyVec3DDouble
  
  Parameters:
  
  a - scale factor for X coordinate
  
  b - scale factor for Y coordinate
  
  c - scale factor for Z coordinate
  
  Returns:
  
  new vector
- scale
  
  public Vec3DDouble scale(ReadonlyVec3DDouble s)
  
  Description copied from interface: ReadonlyVec3DDouble
  
  Scales vector non-uniformly by vector v and returns result as new vector.
  
  Specified by:
  
  scale in interface ReadonlyVec3DDouble
  
  Parameters:
  
  s - scale vector
  
  Returns:
  
  new vector
- scale
  
  public Vec3DDouble scale(Vec3DDouble s)
- scaleSelf
  
  public Vec3DDouble scaleSelf(double s)
  
  Scales vector uniformly and overrides coordinates with result.
  
  Parameters:
  
  s - scale factor
  
  Returns:
  
  itself
- scaleSelf
  
  public Vec3DDouble scaleSelf(double a, double b, double c)
  
  Scales vector non-uniformly by vector {a,b,c} and overrides coordinates with result.
  
  Parameters:
  
  a - scale factor for X coordinate
  
  b - scale factor for Y coordinate
  
  c - scale factor for Z coordinate
  
  Returns:
  
  itself
- scaleSelf
  
  public Vec3DDouble scaleSelf(ReadonlyVec3DDouble s)
- scaleSelf
  
  public Vec3DDouble scaleSelf(Vec3DDouble s)
  
  Scales vector non-uniformly by vector v and overrides coordinates with result.
  
  Parameters:
  
  s - scale vector
  
  Returns:
  
  itself
- set
  
  public Vec3DDouble set(double x, double y, double z)
  
  Overrides coordinates with the given values.
  
  Parameters:
  
  x - the x
  
  y - the y
  
  z - the z
  
  Returns:
  
  itself
- set
  
  public Vec3DDouble set(ReadonlyVec3DDouble v)
- set
  
  public Vec3DDouble set(Vec3DDouble v)
  
  Overrides coordinates with the ones of the given vector.
  
  Parameters:
  
  v - vector to be copied
  
  Returns:
  
  itself
- setComponent
  
  public final Vec3DDouble setComponent(Vec3DDouble.Axis id, double val)
- setComponent
  
  public final Vec3DDouble setComponent(int id, double val)
- setX
  
  public Vec3DDouble setX(double x)
- setXY
  
  public Vec3DDouble setXY(toxi.geom.Vec2D v)
  
  Overrides XY coordinates with the ones of the given 2D vector.
  
  Parameters:
  
  v - 2D vector
  
  Returns:
  
  itself
- setY
  
  public Vec3DDouble setY(double y)
- setZ
  
  public Vec3DDouble setZ(double z)
- shuffle
  
  public Vec3DDouble shuffle(int iterations)
- signum
  
  public Vec3DDouble signum()
  
  Replaces all vector components with the signum of their original values. In other words if a components value was negative its new value will be -1, if zero => 0, if positive => +1
  
  Returns:
  
  itself
- snapToAxis
  
  public final Vec3DDouble snapToAxis()
  
  Rounds the vector to the closest major axis. Assumes the vector is normalized.
  
  Returns:
  
  itself
- sub
  
  public final Vec3DDouble sub(double a, double b, double c)
  
  Description copied from interface: ReadonlyVec3DDouble
  
  Subtracts vector {a,b,c} and returns result as new vector.
  
  Specified by:
  
  sub in interface ReadonlyVec3DDouble
  
  Parameters:
  
  a - X coordinate
  
  b - Y coordinate
  
  c - Z coordinate
  
  Returns:
  
  result as new vector
- sub
  
  public final Vec3DDouble sub(ReadonlyVec3DDouble v)
  
  Description copied from interface: ReadonlyVec3DDouble
  
  Subtracts vector v and returns result as new vector.
  
  Specified by:
  
  sub in interface ReadonlyVec3DDouble
  
  Parameters:
  
  v - vector to be subtracted
  
  Returns:
  
  result as new vector
- sub
  
  public final Vec3DDouble sub(Vec3DDouble v)
- subSelf
  
  public final Vec3DDouble subSelf(double a, double b, double c)
  
  Subtracts vector {a,b,c} and overrides coordinates with result.
  
  Parameters:
  
  a - X coordinate
  
  b - Y coordinate
  
  c - Z coordinate
  
  Returns:
  
  itself
- subSelf
  
  public final Vec3DDouble subSelf(ReadonlyVec3DDouble v)
- subSelf
  
  public final Vec3DDouble subSelf(Vec3DDouble v)
  
  Subtracts vector v and overrides coordinates with result.
  
  Parameters:
  
  v - vector to be subtracted
  
  Returns:
  
  itself
- to2DXY
  
  public final toxi.geom.Vec2D to2DXY()
  
  Description copied from interface: ReadonlyVec3DDouble
  
  Creates a new 2D vector of the XY components.
  
  Specified by:
  
  to2DXY in interface ReadonlyVec3DDouble
  
  Returns:
  
  new vector
- to2DXZ
  
  public final toxi.geom.Vec2D to2DXZ()
  
  Description copied from interface: ReadonlyVec3DDouble
  
  Creates a new 2D vector of the XZ components.
  
  Specified by:
  
  to2DXZ in interface ReadonlyVec3DDouble
  
  Returns:
  
  new vector
- to2DYZ
  
  public final toxi.geom.Vec2D to2DYZ()
  
  Description copied from interface: ReadonlyVec3DDouble
  
  Creates a new 2D vector of the YZ components.
  
  Specified by:
  
  to2DYZ in interface ReadonlyVec3DDouble
  
  Returns:
  
  new vector
- toArray
  
  public double[] toArray()
  
  Specified by:
  
  toArray in interface ReadonlyVec3DDouble
- toArray4
  
  public double[] toArray4(double w)
  
  Specified by:
  
  toArray4 in interface ReadonlyVec3DDouble
- toCartesian
  
  public final Vec3DDouble toCartesian()
- toSpherical
  
  public final Vec3DDouble toSpherical()
- toString
  
  public String toString()
  
  Overrides:
  
  toString in class Object
- x
  
  public final double x()
  
  Specified by:
  
  x in interface ReadonlyVec3DDouble
- y
  
  public final double y()
  
  Specified by:
  
  y in interface ReadonlyVec3DDouble
- z
  
  public final double z()
  
  Specified by:
  
  z in interface ReadonlyVec3DDouble

Class Vec3DDouble

Nested Class Summary

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Details

X_AXIS

Y_AXIS

Z_AXIS

ZERO

MIN_VALUE

MAX_VALUE

x

y

z

Constructor Details

Vec3DDouble

Vec3DDouble

Vec3DDouble

Vec3DDouble

Method Details

fromXYTheta

fromXZTheta

fromYZTheta

max

min

randomVector

randomVector

abs

add

add

add

addSelf

addSelf

addSelf

angleBetween

angleBetween

clear

compareTo

constrain

constrain

copy

cross

cross

crossInto

crossSelf

distanceTo

distanceToSquared

dot

dot

equals

equals

equalsWithTolerance

floor

frac

getAbs

getCartesian

getComponent

getComponent

getConstrained

getFloored

getFrac

getInverted

getLimited

getMapped

getNormalized

getNormalizedTo

getReciprocal

getReflected

getRotatedAroundAxis

getRotatedX

getRotatedY

getRotatedZ

getSignum

getSpherical

hashCode

headingXY

headingXZ

headingYZ