Vector3d (jMonkeyEngine 3.1 jme3-blender Javadoc)

java.lang.Object
- com.jme3.scene.plugins.blender.math.Vector3d

All Implemented Interfaces:

com.jme3.export.Savable, java.io.Serializable, java.lang.Cloneable
```
public final class Vector3d
extends java.lang.Object
implements com.jme3.export.Savable, java.lang.Cloneable, java.io.Serializable
```
Vector3d defines a Vector for a three float value tuple. Vector3d can represent any three dimensional value, such as a vertex, a normal, etc. Utility methods are also included to aid in mathematical calculations. This class's only purpose is to give better accuracy in floating point operations during computations. This is made by copying the original Vector3f class from jme3 core and leaving only required methods and basic computation methods, so that the class is smaller and easier to maintain. Should any other methods be needed, they will be added.

Author:

Mark Powell, Joshua Slack, Marcin Roguski (Kaelthas)

See Also:
Serialized Form

Field Summary

Fields
Modifier and Type	Field and Description
`static Vector3d`	`UNIT_X`
`static Vector3d`	`UNIT_XYZ`
`static Vector3d`	`UNIT_Y`
`static Vector3d`	`UNIT_Z`
`double`	`x` the x value of the vector.
`double`	`y` the y value of the vector.
`double`	`z` the z value of the vector.
`static Vector3d`	`ZERO`

Constructor Summary

Constructors
Constructor and Description
`Vector3d()` Constructor instantiates a new `Vector3d` with default values of (0,0,0).
`Vector3d(double x, double y, double z)` Constructor instantiates a new `Vector3d` with provides values.
`Vector3d(com.jme3.math.Vector3f vector3f)` Constructor instantiates a new `Vector3d` that is a copy of the provided vector

Method Summary

Methods
Modifier and Type	Method and Description
`Vector3d`	`add(double addX, double addY, double addZ)` `add` adds the provided values to this vector, creating a new vector that is then returned.
`Vector3d`	`add(Vector3d vec)` `add` adds a provided vector to this vector creating a resultant vector which is returned.
`Vector3d`	`add(Vector3d vec, Vector3d result)` `add` adds the values of a provided vector storing the values in the supplied vector.
`Vector3d`	`addLocal(double addX, double addY, double addZ)` `addLocal` adds the provided values to this vector internally, and returns a handle to this vector for easy chaining of calls.
`Vector3d`	`addLocal(Vector3d vec)` `addLocal` adds a provided vector to this vector internally, and returns a handle to this vector for easy chaining of calls.
`double`	`angleBetween(Vector3d otherVector)` `angleBetween` returns (in radians) the angle between two vectors.
`Vector3d`	`clone()`
`Vector3d`	`cross(double otherX, double otherY, double otherZ, Vector3d result)` `cross` calculates the cross product of this vector with a parameter vector v.
`Vector3d`	`cross(Vector3d v)` `cross` calculates the cross product of this vector with a parameter vector v.
`Vector3d`	`cross(Vector3d v, Vector3d result)` `cross` calculates the cross product of this vector with a parameter vector v.
`Vector3d`	`crossLocal(double otherX, double otherY, double otherZ)` `crossLocal` calculates the cross product of this vector with a parameter vector v.
`Vector3d`	`crossLocal(Vector3d v)` `crossLocal` calculates the cross product of this vector with a parameter vector v.
`double`	`distance(Vector3d v)` `distance` calculates the distance between this vector and vector v.
`double`	`distanceSquared(Vector3d v)` `distanceSquared` calculates the distance squared between this vector and vector v.
`Vector3d`	`divide(double scalar)` `divide` divides the values of this vector by a scalar and returns the result.
`Vector3d`	`divide(Vector3d scalar)` `divide` divides the values of this vector by a scalar and returns the result.
`Vector3d`	`divideLocal(double scalar)` `divideLocal` divides this vector by a scalar internally, and returns a handle to this vector for easy chaining of calls.
`Vector3d`	`divideLocal(Vector3d scalar)` `divideLocal` divides this vector by a scalar internally, and returns a handle to this vector for easy chaining of calls.
`double`	`dot(Vector3d vec)` `dot` calculates the dot product of this vector with a provided vector.
`boolean`	`equals(java.lang.Object o)` are these two vectors the same? they are is they both have the same x,y, and z values.
`int`	`hashCode()` `hashCode` returns a unique code for this vector object based on it's values.
`double`	`length()` `length` calculates the magnitude of this vector.
`double`	`lengthSquared()` `lengthSquared` calculates the squared value of the magnitude of the vector.
`Vector3d`	`mult(double scalar)` `mult` multiplies this vector by a scalar.
`Vector3d`	`mult(double scalar, Vector3d product)` `mult` multiplies this vector by a scalar.
`Vector3d`	`mult(Vector3d vec)` `multLocal` multiplies a provided vector to this vector internally, and returns a handle to this vector for easy chaining of calls.
`Vector3d`	`mult(Vector3d vec, Vector3d store)` `multLocal` multiplies a provided vector to this vector internally, and returns a handle to this vector for easy chaining of calls.
`Vector3d`	`multLocal(double scalar)` `multLocal` multiplies this vector by a scalar internally, and returns a handle to this vector for easy chaining of calls.
`Vector3d`	`multLocal(double x, double y, double z)` `multLocal` multiplies this vector by 3 scalars internally, and returns a handle to this vector for easy chaining of calls.
`Vector3d`	`multLocal(Vector3d vec)` `multLocal` multiplies a provided vector to this vector internally, and returns a handle to this vector for easy chaining of calls.
`Vector3d`	`negate()` `negate` returns the negative of this vector.
`Vector3d`	`negateLocal()` `negateLocal` negates the internal values of this vector.
`Vector3d`	`normalize()` `normalize` returns the unit vector of this vector.
`Vector3d`	`normalizeLocal()` `normalizeLocal` makes this vector into a unit vector of itself.
`void`	`read(com.jme3.export.JmeImporter e)`
`Vector3d`	`scaleAdd(double scalar, Vector3d add)` `scaleAdd` multiplies this vector by a scalar then adds the given Vector3d.
`Vector3d`	`scaleAdd(double scalar, Vector3d mult, Vector3d add)` `scaleAdd` multiplies the given vector by a scalar then adds the given vector.
`Vector3d`	`set(double x, double y, double z)` `set` sets the x,y,z values of the vector based on passed parameters.
`Vector3d`	`set(Vector3d vect)` `set` sets the x,y,z values of the vector by copying the supplied vector.
`Vector3d`	`subtract(double subtractX, double subtractY, double subtractZ)` `subtract` subtracts the provided values from this vector, creating a new vector that is then returned.
`Vector3d`	`subtract(Vector3d vec)` `subtract` subtracts the values of a given vector from those of this vector creating a new vector object.
`Vector3d`	`subtract(Vector3d vec, Vector3d result)` `subtract`
`Vector3d`	`subtractLocal(double subtractX, double subtractY, double subtractZ)` `subtractLocal` subtracts the provided values from this vector internally, and returns a handle to this vector for easy chaining of calls.
`Vector3d`	`subtractLocal(Vector3d vec)` `subtractLocal` subtracts a provided vector to this vector internally, and returns a handle to this vector for easy chaining of calls.
`java.lang.String`	`toString()` `toString` returns the string representation of this vector.
`com.jme3.math.Vector3f`	`toVector3f()`
`void`	`write(com.jme3.export.JmeExporter e)`

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

- Field Detail
  - ZERO
```
public static final Vector3d ZERO
```
  - UNIT_XYZ
```
public static final Vector3d UNIT_XYZ
```
  - UNIT_X
```
public static final Vector3d UNIT_X
```
  - UNIT_Y
```
public static final Vector3d UNIT_Y
```
  - UNIT_Z
```
public static final Vector3d UNIT_Z
```
  - x
```
public double x
```
    the x value of the vector.
  - y
```
public double y
```
    the y value of the vector.
  - z
```
public double z
```
    the z value of the vector.
- Constructor Detail
  - Vector3d
```
public Vector3d()
```
    Constructor instantiates a new Vector3d with default values of (0,0,0).
  - Vector3d
```
public Vector3d(double x,
        double y,
        double z)
```
    Constructor instantiates a new Vector3d with provides values.
    
    Parameters:
    x - the x value of the vector.
    y - the y value of the vector.
    z - the z value of the vector.
  - Vector3d
```
public Vector3d(com.jme3.math.Vector3f vector3f)
```
    Constructor instantiates a new Vector3d that is a copy of the provided vector
    
    Parameters:
    copy - The Vector3d to copy
- Method Detail
  - toVector3f
```
public com.jme3.math.Vector3f toVector3f()
```
  - set
```
public Vector3d set(double x,
           double y,
           double z)
```
    set sets the x,y,z values of the vector based on passed parameters.
    
    Parameters:
    x - the x value of the vector.
    y - the y value of the vector.
    z - the z value of the vector.
    
    Returns:
    this vector
  - set
```
public Vector3d set(Vector3d vect)
```
    set sets the x,y,z values of the vector by copying the supplied vector.
    
    Parameters:
    vect - the vector to copy.
    
    Returns:
    this vector
  - add
```
public Vector3d add(Vector3d vec)
```
    add adds a provided vector to this vector creating a resultant vector which is returned. If the provided vector is null, null is returned.
    
    Parameters:
    vec - the vector to add to this.
    
    Returns:
    the resultant vector.
  - add
```
public Vector3d add(Vector3d vec,
           Vector3d result)
```
    add adds the values of a provided vector storing the values in the supplied vector.
    
    Parameters:
    vec - the vector to add to this
    result - the vector to store the result in
    
    Returns:
    result returns the supplied result vector.
  - addLocal
```
public Vector3d addLocal(Vector3d vec)
```
    addLocal adds a provided vector to this vector internally, and returns a handle to this vector for easy chaining of calls. If the provided vector is null, null is returned.
    
    Parameters:
    vec - the vector to add to this vector.
    
    Returns:
    this
  - add
```
public Vector3d add(double addX,
           double addY,
           double addZ)
```
    add adds the provided values to this vector, creating a new vector that is then returned.
    
    Parameters:
    addX - the x value to add.
    addY - the y value to add.
    addZ - the z value to add.
    
    Returns:
    the result vector.
  - addLocal
```
public Vector3d addLocal(double addX,
                double addY,
                double addZ)
```
    addLocal adds the provided values to this vector internally, and returns a handle to this vector for easy chaining of calls.
    
    Parameters:
    addX - value to add to x
    addY - value to add to y
    addZ - value to add to z
    
    Returns:
    this
  - scaleAdd
```
public Vector3d scaleAdd(double scalar,
                Vector3d add)
```
    scaleAdd multiplies this vector by a scalar then adds the given Vector3d.
    
    Parameters:
    scalar - the value to multiply this vector by.
    add - the value to add
  - scaleAdd
```
public Vector3d scaleAdd(double scalar,
                Vector3d mult,
                Vector3d add)
```
    scaleAdd multiplies the given vector by a scalar then adds the given vector.
    
    Parameters:
    scalar - the value to multiply this vector by.
    mult - the value to multiply the scalar by
    add - the value to add
  - dot
```
public double dot(Vector3d vec)
```
    dot calculates the dot product of this vector with a provided vector. If the provided vector is null, 0 is returned.
    
    Parameters:
    vec - the vector to dot with this vector.
    
    Returns:
    the resultant dot product of this vector and a given vector.
  - cross
```
public Vector3d cross(Vector3d v)
```
    cross calculates the cross product of this vector with a parameter vector v.
    
    Parameters:
    v - the vector to take the cross product of with this.
    
    Returns:
    the cross product vector.
  - cross
```
public Vector3d cross(Vector3d v,
             Vector3d result)
```
    cross calculates the cross product of this vector with a parameter vector v. The result is stored in result
    
    Parameters:
    v - the vector to take the cross product of with this.
    result - the vector to store the cross product result.
    
    Returns:
    result, after recieving the cross product vector.
  - cross
```
public Vector3d cross(double otherX,
             double otherY,
             double otherZ,
             Vector3d result)
```
    cross calculates the cross product of this vector with a parameter vector v. The result is stored in result
    
    Parameters:
    otherX - x component of the vector to take the cross product of with this.
    otherY - y component of the vector to take the cross product of with this.
    otherZ - z component of the vector to take the cross product of with this.
    result - the vector to store the cross product result.
    
    Returns:
    result, after recieving the cross product vector.
  - crossLocal
```
public Vector3d crossLocal(Vector3d v)
```
    crossLocal calculates the cross product of this vector with a parameter vector v.
    
    Parameters:
    v - the vector to take the cross product of with this.
    
    Returns:
    this.
  - crossLocal
```
public Vector3d crossLocal(double otherX,
                  double otherY,
                  double otherZ)
```
    crossLocal calculates the cross product of this vector with a parameter vector v.
    
    Parameters:
    otherX - x component of the vector to take the cross product of with this.
    otherY - y component of the vector to take the cross product of with this.
    otherZ - z component of the vector to take the cross product of with this.
    
    Returns:
    this.
  - length
```
public double length()
```
    length calculates the magnitude of this vector.
    
    Returns:
    the length or magnitude of the vector.
  - lengthSquared
```
public double lengthSquared()
```
    lengthSquared calculates the squared value of the magnitude of the vector.
    
    Returns:
    the magnitude squared of the vector.
  - distanceSquared
```
public double distanceSquared(Vector3d v)
```
    distanceSquared calculates the distance squared between this vector and vector v.
    
    Parameters:
    v - the second vector to determine the distance squared.
    
    Returns:
    the distance squared between the two vectors.
  - distance
```
public double distance(Vector3d v)
```
    distance calculates the distance between this vector and vector v.
    
    Parameters:
    v - the second vector to determine the distance.
    
    Returns:
    the distance between the two vectors.
  - mult
```
public Vector3d mult(double scalar)
```
    mult multiplies this vector by a scalar. The resultant vector is returned.
    
    Parameters:
    scalar - the value to multiply this vector by.
    
    Returns:
    the new vector.
  - mult
```
public Vector3d mult(double scalar,
            Vector3d product)
```
    mult multiplies this vector by a scalar. The resultant vector is supplied as the second parameter and returned.
    
    Parameters:
    scalar - the scalar to multiply this vector by.
    product - the product to store the result in.
    
    Returns:
    product
  - multLocal
```
public Vector3d multLocal(double scalar)
```
    multLocal multiplies this vector by a scalar internally, and returns a handle to this vector for easy chaining of calls.
    
    Parameters:
    scalar - the value to multiply this vector by.
    
    Returns:
    this
  - multLocal
```
public Vector3d multLocal(Vector3d vec)
```
    multLocal multiplies a provided vector to this vector internally, and returns a handle to this vector for easy chaining of calls. If the provided vector is null, null is returned.
    
    Parameters:
    vec - the vector to mult to this vector.
    
    Returns:
    this
  - multLocal
```
public Vector3d multLocal(double x,
                 double y,
                 double z)
```
    multLocal multiplies this vector by 3 scalars internally, and returns a handle to this vector for easy chaining of calls.
    
    Parameters:
    x -
    y -
    z -
    
    Returns:
    this
  - mult
```
public Vector3d mult(Vector3d vec)
```
    multLocal multiplies a provided vector to this vector internally, and returns a handle to this vector for easy chaining of calls. If the provided vector is null, null is returned.
    
    Parameters:
    vec - the vector to mult to this vector.
    
    Returns:
    this
  - mult
```
public Vector3d mult(Vector3d vec,
            Vector3d store)
```
    multLocal multiplies a provided vector to this vector internally, and returns a handle to this vector for easy chaining of calls. If the provided vector is null, null is returned.
    
    Parameters:
    vec - the vector to mult to this vector.
    store - result vector (null to create a new vector)
    
    Returns:
    this
  - divide
```
public Vector3d divide(double scalar)
```
    divide divides the values of this vector by a scalar and returns the result. The values of this vector remain untouched.
    
    Parameters:
    scalar - the value to divide this vectors attributes by.
    
    Returns:
    the result Vector.
  - divideLocal
```
public Vector3d divideLocal(double scalar)
```
    divideLocal divides this vector by a scalar internally, and returns a handle to this vector for easy chaining of calls. Dividing by zero will result in an exception.
    
    Parameters:
    scalar - the value to divides this vector by.
    
    Returns:
    this
  - divide
```
public Vector3d divide(Vector3d scalar)
```
    divide divides the values of this vector by a scalar and returns the result. The values of this vector remain untouched.
    
    Parameters:
    scalar - the value to divide this vectors attributes by.
    
    Returns:
    the result Vector.
  - divideLocal
```
public Vector3d divideLocal(Vector3d scalar)
```
    divideLocal divides this vector by a scalar internally, and returns a handle to this vector for easy chaining of calls. Dividing by zero will result in an exception.
    
    Parameters:
    scalar - the value to divides this vector by.
    
    Returns:
    this
  - negate
```
public Vector3d negate()
```
    negate returns the negative of this vector. All values are negated and set to a new vector.
    
    Returns:
    the negated vector.
  - negateLocal
```
public Vector3d negateLocal()
```
    negateLocal negates the internal values of this vector.
    
    Returns:
    this.
  - subtract
```
public Vector3d subtract(Vector3d vec)
```
    subtract subtracts the values of a given vector from those of this vector creating a new vector object. If the provided vector is null, null is returned.
    
    Parameters:
    vec - the vector to subtract from this vector.
    
    Returns:
    the result vector.
  - subtractLocal
```
public Vector3d subtractLocal(Vector3d vec)
```
    subtractLocal subtracts a provided vector to this vector internally, and returns a handle to this vector for easy chaining of calls. If the provided vector is null, null is returned.
    
    Parameters:
    vec - the vector to subtract
    
    Returns:
    this
  - subtract
```
public Vector3d subtract(Vector3d vec,
                Vector3d result)
```
    subtract
    
    Parameters:
    vec - the vector to subtract from this
    result - the vector to store the result in
    
    Returns:
    result
  - subtract
```
public Vector3d subtract(double subtractX,
                double subtractY,
                double subtractZ)
```
    subtract subtracts the provided values from this vector, creating a new vector that is then returned.
    
    Parameters:
    subtractX - the x value to subtract.
    subtractY - the y value to subtract.
    subtractZ - the z value to subtract.
    
    Returns:
    the result vector.
  - subtractLocal
```
public Vector3d subtractLocal(double subtractX,
                     double subtractY,
                     double subtractZ)
```
    subtractLocal subtracts the provided values from this vector internally, and returns a handle to this vector for easy chaining of calls.
    
    Parameters:
    subtractX - the x value to subtract.
    subtractY - the y value to subtract.
    subtractZ - the z value to subtract.
    
    Returns:
    this
  - normalize
```
public Vector3d normalize()
```
    normalize returns the unit vector of this vector.
    
    Returns:
    unit vector of this vector.
  - normalizeLocal
```
public Vector3d normalizeLocal()
```
    normalizeLocal makes this vector into a unit vector of itself.
    
    Returns:
    this.
  - angleBetween
```
public double angleBetween(Vector3d otherVector)
```
    angleBetween returns (in radians) the angle between two vectors. It is assumed that both this vector and the given vector are unit vectors (iow, normalized).
    
    Parameters:
    otherVector - a unit vector to find the angle against
    
    Returns:
    the angle in radians.
  - clone
```
public Vector3d clone()
```
    Overrides:
    
    clone in class java.lang.Object
  - equals
```
public boolean equals(java.lang.Object o)
```
    are these two vectors the same? they are is they both have the same x,y, and z values.
    
    Overrides:
    
    equals in class java.lang.Object
    
    Parameters:
    o - the object to compare for equality
    
    Returns:
    true if they are equal
  - hashCode
```
public int hashCode()
```
    hashCode returns a unique code for this vector object based on it's values. If two vectors are logically equivalent, they will return the same hash code value.
    
    Overrides:
    
    hashCode in class java.lang.Object
    
    Returns:
    the hash code value of this vector.
  - toString
```
public java.lang.String toString()
```
    toString returns the string representation of this vector. The format is: org.jme.math.Vector3d [X=XX.XXXX, Y=YY.YYYY, Z=ZZ.ZZZZ]
    
    Overrides:
    
    toString in class java.lang.Object
    
    Returns:
    the string representation of this vector.
  - write
```
public void write(com.jme3.export.JmeExporter e)
           throws java.io.IOException
```
    Specified by:
    
    write in interface com.jme3.export.Savable
    
    Throws:
    
    java.io.IOException
  - read
```
public void read(com.jme3.export.JmeImporter e)
          throws java.io.IOException
```
    Specified by:
    
    read in interface com.jme3.export.Savable
    
    Throws:
    
    java.io.IOException

Class Vector3d

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

ZERO

UNIT_XYZ

UNIT_X

UNIT_Y

UNIT_Z

x

y

z

Constructor Detail

Vector3d

Vector3d

Vector3d

Method Detail

toVector3f

set

set

add

add

addLocal

add

addLocal

scaleAdd

scaleAdd

dot

cross

cross

cross

crossLocal

crossLocal

length

lengthSquared

distanceSquared

distance

mult

mult

multLocal

multLocal

multLocal

mult

mult

divide

divideLocal

divide

divideLocal

negate

negateLocal

subtract

subtractLocal

subtract

subtract

subtractLocal

normalize

normalizeLocal

angleBetween

clone

equals

hashCode

toString

write

read