Vector3f (jMonkeyEngine3)

java.lang.Object
- com.jme3.math.Vector3f

All Implemented Interfaces:

Savable, java.io.Serializable, java.lang.Cloneable
```
public final class Vector3f
extends java.lang.Object
implements Savable, java.lang.Cloneable, java.io.Serializable
```
Vector3f defines a Vector for a three float value tuple. Vector3f can represent any three dimensional value, such as a vertex, a normal, etc. Utility methods are also included to aid in mathematical calculations.

See Also:

Serialized Form

Field Summary

Fields
Modifier and Type	Field and Description
`static Vector3f`	`NAN` shared instance of the all-NaN vector (NaN,NaN,NaN) - Do not modify!
`static Vector3f`	`NEGATIVE_INFINITY` shared instance of the all-negative-infinity vector (-Inf,-Inf,-Inf) - Do not modify!
`static Vector3f`	`POSITIVE_INFINITY` shared instance of the all-plus-infinity vector (+Inf,+Inf,+Inf) - Do not modify!
`static Vector3f`	`UNIT_X` shared instance of the +X direction (1,0,0) - Do not modify!
`static Vector3f`	`UNIT_XYZ` shared instance of the all-ones vector (1,1,1) - Do not modify!
`static Vector3f`	`UNIT_Y` shared instance of the +Y direction (0,1,0) - Do not modify!
`static Vector3f`	`UNIT_Z` shared instance of the +Z direction (0,0,1) - Do not modify!
`float`	`x` the x value of the vector.
`float`	`y` the y value of the vector.
`float`	`z` the z value of the vector.
`static Vector3f`	`ZERO` shared instance of the all-zero vector (0,0,0) - Do not modify!

Constructor Summary

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

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`Vector3f`	`add(float addX, float addY, float addZ)` `add` adds the provided values to this vector, creating a new vector that is then returned.
`Vector3f`	`add(Vector3f vec)` `add` adds a provided vector to this vector creating a resultant vector which is returned.
`Vector3f`	`add(Vector3f vec, Vector3f result)` `add` adds the values of a provided vector storing the values in the supplied vector.
`Vector3f`	`addLocal(float addX, float addY, float addZ)` `addLocal` adds the provided values to this vector internally, and returns a handle to this vector for easy chaining of calls.
`Vector3f`	`addLocal(Vector3f vec)` `addLocal` adds a provided vector to this vector internally, and returns a handle to this vector for easy chaining of calls.
`float`	`angleBetween(Vector3f otherVector)` `angleBetween` returns (in radians) the angle between two vectors.
`Vector3f`	`clone()` Create a copy of this vector.
`Vector3f`	`cross(float otherX, float otherY, float otherZ, Vector3f result)` `cross` calculates the cross product of this vector with a parameter vector v.
`Vector3f`	`cross(Vector3f v)` `cross` calculates the cross product of this vector with a parameter vector v.
`Vector3f`	`cross(Vector3f v, Vector3f result)` `cross` calculates the cross product of this vector with a parameter vector v.
`Vector3f`	`crossLocal(float otherX, float otherY, float otherZ)` `crossLocal` calculates the cross product of this vector with a parameter vector v.
`Vector3f`	`crossLocal(Vector3f v)` `crossLocal` calculates the cross product of this vector with a parameter vector v.
`float`	`distance(Vector3f v)` `distance` calculates the distance between this vector and vector v.
`float`	`distanceSquared(Vector3f v)` `distanceSquared` calculates the distance squared between this vector and vector v.
`Vector3f`	`divide(float scalar)` `divide` divides the values of this vector by a scalar and returns the result.
`Vector3f`	`divide(Vector3f scalar)` `divide` divides the values of this vector by a scalar and returns the result.
`Vector3f`	`divideLocal(float scalar)` `divideLocal` divides this vector by a scalar internally, and returns a handle to this vector for easy chaining of calls.
`Vector3f`	`divideLocal(Vector3f scalar)` `divideLocal` divides this vector by a scalar internally, and returns a handle to this vector for easy chaining of calls.
`float`	`dot(Vector3f 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.
`static void`	`generateComplementBasis(Vector3f u, Vector3f v, Vector3f w)`
`static void`	`generateOrthonormalBasis(Vector3f u, Vector3f v, Vector3f w)`
`float`	`get(int index)`
`float`	`getX()` Determine the X component of this vector.
`float`	`getY()` Determine the Y component of this vector.
`float`	`getZ()` Determine the Z component of this vector.
`int`	`hashCode()` `hashCode` returns a unique code for this vector object based on its values.
`Vector3f`	`interpolateLocal(Vector3f finalVec, float changeAmnt)` Sets this vector to the interpolation by changeAmnt from this to the finalVec this=(1-changeAmnt)this + changeAmnt finalVec
`Vector3f`	`interpolateLocal(Vector3f beginVec, Vector3f finalVec, float changeAmnt)` Sets this vector to the interpolation by changeAmnt from beginVec to finalVec this=(1-changeAmnt)beginVec + changeAmnt finalVec
`boolean`	`isSimilar(Vector3f other, float epsilon)` Returns true if this vector is similar to the specified vector within some value of epsilon.
`boolean`	`isUnitVector()` Returns true if this vector is a unit vector (length() ~= 1), returns false otherwise.
`static boolean`	`isValidVector(Vector3f vector)` Check a vector...
`float`	`length()` `length` calculates the magnitude of this vector.
`float`	`lengthSquared()` `lengthSquared` calculates the squared value of the magnitude of the vector.
`Vector3f`	`maxLocal(Vector3f other)` `maxLocal` computes the maximum value for each component in this and `other` vector.
`Vector3f`	`minLocal(Vector3f other)` `minLocal` computes the minimum value for each component in this and `other` vector.
`Vector3f`	`mult(float scalar)` `mult` multiplies this vector by a scalar.
`Vector3f`	`mult(float scalar, Vector3f product)` `mult` multiplies this vector by a scalar.
`Vector3f`	`mult(Vector3f vec)` `multLocal` multiplies a provided vector to this vector internally, and returns a handle to this vector for easy chaining of calls.
`Vector3f`	`mult(Vector3f vec, Vector3f store)` `multLocal` multiplies a provided vector to this vector internally, and returns a handle to this vector for easy chaining of calls.
`Vector3f`	`multLocal(float scalar)` `multLocal` multiplies this vector by a scalar internally, and returns a handle to this vector for easy chaining of calls.
`Vector3f`	`multLocal(float x, float y, float z)` `multLocal` multiplies this vector by 3 scalars internally, and returns a handle to this vector for easy chaining of calls.
`Vector3f`	`multLocal(Vector3f vec)` `multLocal` multiplies a provided vector to this vector internally, and returns a handle to this vector for easy chaining of calls.
`Vector3f`	`negate()` `negate` returns the negative of this vector.
`Vector3f`	`negateLocal()` `negateLocal` negates the internal values of this vector.
`Vector3f`	`normalize()` `normalize` returns the unit vector of this vector.
`Vector3f`	`normalizeLocal()` `normalizeLocal` makes this vector into a unit vector of itself.
`Vector3f`	`project(Vector3f other)` Projects this vector onto another vector
`Vector3f`	`projectLocal(Vector3f other)` Projects this vector onto another vector, stores the result in this vector
`void`	`read(JmeImporter e)` De-serialize this vector from the specified importer, for example when loading from a J3O file.
`Vector3f`	`scaleAdd(float scalar, Vector3f add)` `scaleAdd` multiplies this vector by a scalar then adds the given Vector3f.
`Vector3f`	`scaleAdd(float scalar, Vector3f mult, Vector3f add)` `scaleAdd` multiplies the given vector by a scalar then adds the given vector.
`Vector3f`	`set(float x, float y, float z)` `set` sets the x,y,z values of the vector based on passed parameters.
`void`	`set(int index, float value)`
`Vector3f`	`set(Vector3f vect)` `set` sets the x,y,z values of the vector by copying the supplied vector.
`Vector3f`	`setX(float x)` Alter the X component of this vector.
`Vector3f`	`setY(float y)` Alter the Y component of this vector.
`Vector3f`	`setZ(float z)` Alter the Z component of this vector.
`Vector3f`	`subtract(float subtractX, float subtractY, float subtractZ)` `subtract` subtracts the provided values from this vector, creating a new vector that is then returned.
`Vector3f`	`subtract(Vector3f vec)` `subtract` subtracts the values of a given vector from those of this vector creating a new vector object.
`Vector3f`	`subtract(Vector3f vec, Vector3f result)` `subtract`
`Vector3f`	`subtractLocal(float subtractX, float subtractY, float subtractZ)` `subtractLocal` subtracts the provided values from this vector internally, and returns a handle to this vector for easy chaining of calls.
`Vector3f`	`subtractLocal(Vector3f vec)` `subtractLocal` subtracts a provided vector to this vector internally, and returns a handle to this vector for easy chaining of calls.
`float[]`	`toArray(float[] floats)` Saves this Vector3f into the given float[] object.
`java.lang.String`	`toString()` `toString` returns a string representation of this vector.
`void`	`write(JmeExporter e)` Serialize this vector to the specified exporter, for example when saving to a J3O file.
`Vector3f`	`zero()` `zero` resets this vector's data to zero internally.

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

- Field Detail
  - ZERO
```
public static final Vector3f ZERO
```
    shared instance of the all-zero vector (0,0,0) - Do not modify!
  - NAN
```
public static final Vector3f NAN
```
    shared instance of the all-NaN vector (NaN,NaN,NaN) - Do not modify!
  - UNIT_X
```
public static final Vector3f UNIT_X
```
    shared instance of the +X direction (1,0,0) - Do not modify!
  - UNIT_Y
```
public static final Vector3f UNIT_Y
```
    shared instance of the +Y direction (0,1,0) - Do not modify!
  - UNIT_Z
```
public static final Vector3f UNIT_Z
```
    shared instance of the +Z direction (0,0,1) - Do not modify!
  - UNIT_XYZ
```
public static final Vector3f UNIT_XYZ
```
    shared instance of the all-ones vector (1,1,1) - Do not modify!
  - POSITIVE_INFINITY
```
public static final Vector3f POSITIVE_INFINITY
```
    shared instance of the all-plus-infinity vector (+Inf,+Inf,+Inf) - Do not modify!
  - NEGATIVE_INFINITY
```
public static final Vector3f NEGATIVE_INFINITY
```
    shared instance of the all-negative-infinity vector (-Inf,-Inf,-Inf) - Do not modify!
  - x
```
public float x
```
    the x value of the vector.
  - y
```
public float y
```
    the y value of the vector.
  - z
```
public float z
```
    the z value of the vector.
- Constructor Detail
  - Vector3f
```
public Vector3f()
```
    Constructor instantiates a new Vector3f with default values of (0,0,0).
  - Vector3f
```
public Vector3f(float x,
                float y,
                float z)
```
    Constructor instantiates a new Vector3f 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.
  - Vector3f
```
public Vector3f(Vector3f copy)
```
    Constructor instantiates a new Vector3f that is a copy of the provided vector
    
    Parameters:
    
    copy - The Vector3f to copy
- Method Detail
  - set
```
public Vector3f set(float x,
                    float y,
                    float 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 Vector3f set(Vector3f 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 Vector3f add(Vector3f 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 Vector3f add(Vector3f vec,
                    Vector3f 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 Vector3f addLocal(Vector3f 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 Vector3f add(float addX,
                    float addY,
                    float 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 Vector3f addLocal(float addX,
                         float addY,
                         float 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 Vector3f scaleAdd(float scalar,
                         Vector3f add)
```
    scaleAdd multiplies this vector by a scalar then adds the given Vector3f.
    
    Parameters:
    
    scalar - the value to multiply this vector by.
    
    add - the value to add
    
    Returns:
    
    this
  - scaleAdd
```
public Vector3f scaleAdd(float scalar,
                         Vector3f mult,
                         Vector3f 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
    
    Returns:
    
    this
  - dot
```
public float dot(Vector3f 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 Vector3f cross(Vector3f 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 Vector3f cross(Vector3f v,
                      Vector3f 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 receiving the cross product vector.
  - cross
```
public Vector3f cross(float otherX,
                      float otherY,
                      float otherZ,
                      Vector3f 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 receiving the cross product vector.
  - crossLocal
```
public Vector3f crossLocal(Vector3f 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 Vector3f crossLocal(float otherX,
                           float otherY,
                           float 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.
  - project
```
public Vector3f project(Vector3f other)
```
    Projects this vector onto another vector
    
    Parameters:
    
    other - The vector to project this vector onto
    
    Returns:
    
    A new vector with the projection result
  - projectLocal
```
public Vector3f projectLocal(Vector3f other)
```
    Projects this vector onto another vector, stores the result in this vector
    
    Parameters:
    
    other - The vector to project this vector onto
    
    Returns:
    
    This Vector3f, set to the projection result
  - isUnitVector
```
public boolean isUnitVector()
```
    Returns true if this vector is a unit vector (length() ~= 1), returns false otherwise.
    
    Returns:
    
    true if this vector is a unit vector (length() ~= 1), or false otherwise.
  - length
```
public float length()
```
    length calculates the magnitude of this vector.
    
    Returns:
    
    the length or magnitude of the vector.
  - lengthSquared
```
public float lengthSquared()
```
    lengthSquared calculates the squared value of the magnitude of the vector.
    
    Returns:
    
    the magnitude squared of the vector.
  - distanceSquared
```
public float distanceSquared(Vector3f 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 float distance(Vector3f 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 Vector3f mult(float 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 Vector3f mult(float scalar,
                     Vector3f 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 Vector3f multLocal(float 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 Vector3f multLocal(Vector3f 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 Vector3f multLocal(float x,
                          float y,
                          float z)
```
    multLocal multiplies this vector by 3 scalars internally, and returns a handle to this vector for easy chaining of calls.
    
    Parameters:
    
    x - the scale factor for the X component
    
    y - the scale factor for the Y component
    
    z - the scale factor for the Z component
    
    Returns:
    
    this
  - mult
```
public Vector3f mult(Vector3f 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 Vector3f mult(Vector3f vec,
                     Vector3f 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 Vector3f divide(float 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 Vector3f divideLocal(float 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 Vector3f divide(Vector3f 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 Vector3f divideLocal(Vector3f 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 Vector3f negate()
```
    negate returns the negative of this vector. All values are negated and set to a new vector.
    
    Returns:
    
    the negated vector.
  - negateLocal
```
public Vector3f negateLocal()
```
    negateLocal negates the internal values of this vector.
    
    Returns:
    
    this.
  - subtract
```
public Vector3f subtract(Vector3f 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 Vector3f subtractLocal(Vector3f 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 Vector3f subtract(Vector3f vec,
                         Vector3f result)
```
    subtract
    
    Parameters:
    
    vec - the vector to subtract from this
    
    result - the vector to store the result in
    
    Returns:
    
    result
  - subtract
```
public Vector3f subtract(float subtractX,
                         float subtractY,
                         float 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 Vector3f subtractLocal(float subtractX,
                              float subtractY,
                              float 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 Vector3f normalize()
```
    normalize returns the unit vector of this vector.
    
    Returns:
    
    unit vector of this vector.
  - normalizeLocal
```
public Vector3f normalizeLocal()
```
    normalizeLocal makes this vector into a unit vector of itself.
    
    Returns:
    
    this.
  - maxLocal
```
public Vector3f maxLocal(Vector3f other)
```
    maxLocal computes the maximum value for each component in this and other vector. The result is stored in this vector.
    
    Parameters:
    
    other - the vector to compare with (not null, unaffected)
    
    Returns:
    
    this
  - minLocal
```
public Vector3f minLocal(Vector3f other)
```
    minLocal computes the minimum value for each component in this and other vector. The result is stored in this vector.
    
    Parameters:
    
    other - the vector to compare with (not null, unaffected)
    
    Returns:
    
    this
  - zero
```
public Vector3f zero()
```
    zero resets this vector's data to zero internally.
    
    Returns:
    
    this
  - angleBetween
```
public float angleBetween(Vector3f 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.
  - interpolateLocal
```
public Vector3f interpolateLocal(Vector3f finalVec,
                                 float changeAmnt)
```
    Sets this vector to the interpolation by changeAmnt from this to the finalVec this=(1-changeAmnt)*this + changeAmnt * finalVec
    
    Parameters:
    
    finalVec - The final vector to interpolate towards
    
    changeAmnt - An amount between 0.0 - 1.0 representing a percentage change from this towards finalVec
    
    Returns:
    
    this
  - interpolateLocal
```
public Vector3f interpolateLocal(Vector3f beginVec,
                                 Vector3f finalVec,
                                 float changeAmnt)
```
    Sets this vector to the interpolation by changeAmnt from beginVec to finalVec this=(1-changeAmnt)*beginVec + changeAmnt * finalVec
    
    Parameters:
    
    beginVec - the beginning vector (changeAmnt=0)
    
    finalVec - The final vector to interpolate towards
    
    changeAmnt - An amount between 0.0 - 1.0 representing a percentage change from beginVec towards finalVec
    
    Returns:
    
    this
  - isValidVector
```
public static boolean isValidVector(Vector3f vector)
```
    Check a vector... if it is null or its floats are NaN or infinite, return false. Else return true.
    
    Parameters:
    
    vector - the vector to check
    
    Returns:
    
    true or false as stated above.
  - generateOrthonormalBasis
```
public static void generateOrthonormalBasis(Vector3f u,
                                            Vector3f v,
                                            Vector3f w)
```
  - generateComplementBasis
```
public static void generateComplementBasis(Vector3f u,
                                           Vector3f v,
                                           Vector3f w)
```
  - clone
```
public Vector3f clone()
```
    Create a copy of this vector.
    
    Overrides:
    
    clone in class java.lang.Object
    
    Returns:
    
    a new instance, equivalent to this one
  - toArray
```
public float[] toArray(float[] floats)
```
    Saves this Vector3f into the given float[] object.
    
    Parameters:
    
    floats - The float[] to take this Vector3f. If null, a new float[3] is created.
    
    Returns:
    
    The array, with X, Y, Z float values in that order
  - 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
  - isSimilar
```
public boolean isSimilar(Vector3f other,
                         float epsilon)
```
    Returns true if this vector is similar to the specified vector within some value of epsilon.
    
    Parameters:
    
    other - the vector to compare with (not null, unaffected)
    
    epsilon - the desired error tolerance for each component
    
    Returns:
    
    true if all 3 components are within tolerance, otherwise false
  - hashCode
```
public int hashCode()
```
    hashCode returns a unique code for this vector object based on its 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 a string representation of this vector. The format is: (XX.XXXX, YY.YYYY, ZZ.ZZZZ)
    
    Overrides:
    
    toString in class java.lang.Object
    
    Returns:
    
    the string representation of this vector.
  - write
```
public void write(JmeExporter e)
           throws java.io.IOException
```
    Serialize this vector to the specified exporter, for example when saving to a J3O file.
    
    Specified by:
    
    write in interface Savable
    
    Parameters:
    
    e - (not null)
    
    Throws:
    
    java.io.IOException - from the exporter
  - read
```
public void read(JmeImporter e)
          throws java.io.IOException
```
    De-serialize this vector from the specified importer, for example when loading from a J3O file.
    
    Specified by:
    
    read in interface Savable
    
    Parameters:
    
    e - (not null)
    
    Throws:
    
    java.io.IOException - from the importer
  - getX
```
public float getX()
```
    Determine the X component of this vector.
    
    Returns:
    
    x
  - setX
```
public Vector3f setX(float x)
```
    Alter the X component of this vector.
    
    Parameters:
    
    x - the desired value
    
    Returns:
    
    this vector, modified
  - getY
```
public float getY()
```
    Determine the Y component of this vector.
    
    Returns:
    
    y
  - setY
```
public Vector3f setY(float y)
```
    Alter the Y component of this vector.
    
    Parameters:
    
    y - the desired value
    
    Returns:
    
    this vector, modified
  - getZ
```
public float getZ()
```
    Determine the Z component of this vector.
    
    Returns:
    
    z
  - setZ
```
public Vector3f setZ(float z)
```
    Alter the Z component of this vector.
    
    Parameters:
    
    z - the desired value
    
    Returns:
    
    this vector, modified
  - get
```
public float get(int index)
```
    Parameters:
    
    index - 0, 1, or 2
    
    Returns:
    
    x value if index == 0, y value if index == 1 or z value if index == 2
    
    Throws:
    
    java.lang.IllegalArgumentException - if index is not one of 0, 1, 2.
  - set
```
public void set(int index,
                float value)
```
    Parameters:
    
    index - which field index in this vector to set.
    
    value - to set to one of x, y or z.
    
    Throws:
    
    java.lang.IllegalArgumentException - if index is not one of 0, 1, 2.

Class Vector3f

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

ZERO

NAN

UNIT_X

UNIT_Y

UNIT_Z

UNIT_XYZ

POSITIVE_INFINITY

NEGATIVE_INFINITY

x

y

z

Constructor Detail

Vector3f

Vector3f

Vector3f

Method Detail

set

set

add

add

addLocal

add

addLocal

scaleAdd

scaleAdd

dot

cross

cross

cross

crossLocal

crossLocal

project

projectLocal

isUnitVector

length

lengthSquared

distanceSquared

distance

mult

mult

multLocal

multLocal

multLocal

mult

mult

divide

divideLocal

divide

divideLocal

negate

negateLocal

subtract

subtractLocal

subtract

subtract

subtractLocal

normalize

normalizeLocal

maxLocal

minLocal

zero

angleBetween

interpolateLocal

interpolateLocal

isValidVector

generateOrthonormalBasis

generateComplementBasis

clone

toArray

equals

isSimilar

hashCode

toString

write