Vector3f (AchternEngine 0.4 API)

java.lang.Object
- org.achtern.AchternEngine.core.math.Vector3f

All Implemented Interfaces:

Cloneable
```
public class Vector3f
extends Object
implements Cloneable
```
A Vector3f is a implementation of the mathematical Vector in R3. It is made up of 3 float variables and has the common vector manipulation methods. All methods return a new instance rather then modifying the object it self. If the modification is desired, the ...Local() method perform the modification. Careful!

Field Summary

Fields
Modifier and Type	Field and Description
`protected boolean`	`locked`
`static Vector3f`	`ONE` Unit Vector (1/1/1)
`static Vector3f`	`UNIT_X` Unit Vector of X (1/0/0)
`static Vector3f`	`UNIT_Y` Unit Vector of Y (0/1/0)
`static Vector3f`	`UNIT_Z` Unit Vector of Z (0/0/1)
`static Vector3f`	`ZERO` Zero Vector (0/0/0)

Constructor Summary

Constructors
Constructor and Description
`Vector3f(float v)` Construct a new Vector, where all components are the same
`Vector3f(float x, float y, float z)` Construct a new Vector
`Vector3f(Vector3f v)` Copy constructor

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`Vector3f`	`abs()` Returns the absolute version of this Vector
`Vector3f`	`add(float v)` Add constant to Vector
`Vector3f`	`add(Vector3f v)` Add two Vectors
`Vector3f`	`addLocal(float v)` Add constant to THIS Vector
`Vector3f`	`addLocal(Vector3f v)` Add Vector to THIS Vector
`Vector3f`	`clamp(float c)` Returns clamped version of this vector
`Vector3f`	`clampLocal(float c)` Clamp all components to the constant c.
`Vector3f`	`clone()`
`Vector3f`	`cross(Vector3f v)` Cross Product
`static float`	`distance(Vector3f p, Vector3f q)` Calculates the euclidean distance.
`Vector3f`	`div(float v)`
`Vector3f`	`div(Vector3f v)`
`float`	`dot(Vector3f v)` Dot Product
`boolean`	`equals(Object obj)`
`boolean`	`equals(Vector3f v)`
`float`	`euclidean(Vector3f v)` Calculates the euclidean distance.
`Vector3f`	`get()` Copy components into new Vector object
`float`	`getX()`
`Vector2f`	`getXY()`
`Vector2f`	`getXZ()`
`float`	`getY()`
`Vector2f`	`getYX()`
`Vector2f`	`getYZ()`
`float`	`getZ()`
`Vector2f`	`getZX()`
`Vector2f`	`getZY()`
`boolean`	`isLocked()`
`boolean`	`isNullVector()` Returns true when all 3 components are 0
`float`	`length()` Calculates length a.k.a. magnitude
`Vector3f`	`lerp(Vector3f dest, float factor)` Linearly interpolates between two Vectors.
`static Vector3f`	`lerp(Vector3f p, Vector3f q, float factor)` Linearly interpolates between two Vectors.
`Vector3f`	`lock()`
`float`	`max()` Returns the largest component of this Vector
`Vector3f`	`mul(float v)`
`Vector3f`	`mul(Vector3f v)`
`Vector3f`	`multLocal(float v)`
`Vector3f`	`multLocal(Vector3f v)`
`void`	`normalize()` Normalizes this object
`Vector3f`	`normalized()` Returns normalized version of this Vector.
`Vector3f`	`rotate(Quaternion q)` Returns Vector of this rotated by using thw Quaternion
`Vector3f`	`rotate(Vector3f axis, float angle)` Returns Vector of this rotated around the given axis by angle amount.
`Vector3f`	`set(float x, float y, float z)`
`Vector3f`	`set(Vector3f v)`
`void`	`setX(float x)`
`void`	`setY(float y)`
`void`	`setZ(float z)`
`Vector3f`	`sub(float v)` Subtract constant from Vector
`Vector3f`	`sub(Vector3f v)` Subtract two Vectors
`Vector3f`	`subLocal(float v)` Subtract constant from THIS Vector
`Vector3f`	`subLocal(Vector3f v)` Subtract Vector from THIS Vector
`String`	`toString()`
`Vector3f`	`unlock()`

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

- Field Detail
  - ZERO
```
public static final Vector3f ZERO
```
    Zero Vector (0/0/0)
  - UNIT_X
```
public static final Vector3f UNIT_X
```
    Unit Vector of X (1/0/0)
  - UNIT_Y
```
public static final Vector3f UNIT_Y
```
    Unit Vector of Y (0/1/0)
  - UNIT_Z
```
public static final Vector3f UNIT_Z
```
    Unit Vector of Z (0/0/1)
  - ONE
```
public static final Vector3f ONE
```
    Unit Vector (1/1/1)
  - locked
```
protected boolean locked
```
- Constructor Detail
  - Vector3f
```
public Vector3f(float x,
                float y,
                float z)
```
    Construct a new Vector
    
    Parameters:
    
    x - X-Component
    
    y - Y-Component
    
    z - Z-Component
  - Vector3f
```
public Vector3f(float v)
```
    Construct a new Vector, where all components are the same
    
    Parameters:
    
    v - X, Y, Z - Component
  - Vector3f
```
public Vector3f(Vector3f v)
```
    Copy constructor
    
    Parameters:
    
    v - copy
- Method Detail
  - distance
```
public static float distance(Vector3f p,
                             Vector3f q)
```
    Calculates the euclidean distance. Calls to this static method are equivalent to p.euclidean(q);
    
    Parameters:
    
    p - First Vector
    
    q - Second Vector
    
    Returns:
    
    Euclidean distance
  - lerp
```
public static Vector3f lerp(Vector3f p,
                            Vector3f q,
                            float factor)
```
    Linearly interpolates between two Vectors. Calls to this static method are equivalent to p.lerp(q, factor);
    
    Parameters:
    
    p - First Vector
    
    q - Second Vector
    
    factor - Interpolation factor
    
    Returns:
    
    interpolated Vector
  - lock
```
public Vector3f lock()
```
  - unlock
```
public Vector3f unlock()
```
  - isLocked
```
public boolean isLocked()
```
  - euclidean
```
public float euclidean(Vector3f v)
```
    Calculates the euclidean distance.
    
    Parameters:
    
    v - destination
    
    Returns:
    
    distance
  - length
```
public float length()
```
    Calculates length a.k.a. magnitude
    
    Returns:
    
    length
  - dot
```
public float dot(Vector3f v)
```
    Dot Product
    
    Parameters:
    
    v - other
    
    Returns:
    
    dot
  - cross
```
public Vector3f cross(Vector3f v)
```
    Cross Product
    
    Parameters:
    
    v - other
    
    Returns:
    
    cross
  - normalize
```
public void normalize()
```
    Normalizes this object
  - normalized
```
public Vector3f normalized()
```
    Returns normalized version of this Vector. DOES NOT modify this object. Use normalize() for this!
    
    Returns:
    
    normalized Vector
  - lerp
```
public Vector3f lerp(Vector3f dest,
                     float factor)
```
    Linearly interpolates between two Vectors.
    
    Parameters:
    
    dest - Destination Vector
    
    factor - Interpolation factor
    
    Returns:
    
    interpolated Vector
  - rotate
```
public Vector3f rotate(Vector3f axis,
                       float angle)
```
    Returns Vector of this rotated around the given axis by angle amount.
    
    Parameters:
    
    axis - Rotation Axis
    
    angle - angle in radians!
    
    Returns:
    
    new instance!!
  - rotate
```
public Vector3f rotate(Quaternion q)
```
    Returns Vector of this rotated by using thw Quaternion
    
    Parameters:
    
    q - Quaternion to rotate.
    
    Returns:
    
    new instance!!
  - max
```
public float max()
```
    Returns the largest component of this Vector
    
    Returns:
    
    largest component
  - add
```
public Vector3f add(Vector3f v)
```
    Add two Vectors
    
    Parameters:
    
    v - other
    
    Returns:
    
    Added Vectors (new instance!!)
  - add
```
public Vector3f add(float v)
```
    Add constant to Vector
    
    Parameters:
    
    v - constant
    
    Returns:
    
    new instance!!
  - addLocal
```
public Vector3f addLocal(Vector3f v)
```
    Add Vector to THIS Vector
    
    Parameters:
    
    v - other
    
    Returns:
    
    this
  - addLocal
```
public Vector3f addLocal(float v)
```
    Add constant to THIS Vector
    
    Parameters:
    
    v - constant
    
    Returns:
    
    this
  - sub
```
public Vector3f sub(Vector3f v)
```
    Subtract two Vectors
    
    Parameters:
    
    v - other
    
    Returns:
    
    Subtracted Vectors (new instance!!)
  - sub
```
public Vector3f sub(float v)
```
    Subtract constant from Vector
    
    Parameters:
    
    v - constant
    
    Returns:
    
    new instance!!
  - subLocal
```
public Vector3f subLocal(Vector3f v)
```
    Subtract Vector from THIS Vector
    
    Parameters:
    
    v - other
    
    Returns:
    
    this
  - subLocal
```
public Vector3f subLocal(float v)
```
    Subtract constant from THIS Vector
    
    Parameters:
    
    v - constant
    
    Returns:
    
    this
  - mul
```
public Vector3f mul(Vector3f v)
```
  - mul
```
public Vector3f mul(float v)
```
  - multLocal
```
public Vector3f multLocal(Vector3f v)
```
  - multLocal
```
public Vector3f multLocal(float v)
```
  - div
```
public Vector3f div(Vector3f v)
```
  - div
```
public Vector3f div(float v)
```
  - abs
```
public Vector3f abs()
```
    Returns the absolute version of this Vector
    
    Returns:
    
    new instance!!
  - clamp
```
public Vector3f clamp(float c)
```
    Returns clamped version of this vector
    
    Parameters:
    
    c - constant
    
    Returns:
    
    clamped version (new instance!!)
    
    See Also:
    
    clampLocal(float)
  - clampLocal
```
public Vector3f clampLocal(float c)
```
    Clamp all components to the constant c. Just checks:
```
 
 COMPONENT > c
 
 
```
    -4 will stay the same if clamped to 3!
    Parameters:
    
    c - constant
    
    Returns:
    
    this
  - getXY
```
public Vector2f getXY()
```
  - getYZ
```
public Vector2f getYZ()
```
  - getXZ
```
public Vector2f getXZ()
```
  - getYX
```
public Vector2f getYX()
```
  - getZY
```
public Vector2f getZY()
```
  - getZX
```
public Vector2f getZX()
```
  - set
```
public Vector3f set(float x,
                    float y,
                    float z)
```
  - set
```
public Vector3f set(Vector3f v)
```
  - setX
```
public void setX(float x)
```
  - setY
```
public void setY(float y)
```
  - setZ
```
public void setZ(float z)
```
  - equals
```
public boolean equals(Vector3f v)
```
  - isNullVector
```
public boolean isNullVector()
```
    Returns true when all 3 components are 0
    
    Returns:
    
    nullVector
  - equals
```
public boolean equals(Object obj)
```
    Overrides:
    
    equals in class Object
  - toString
```
public String toString()
```
    Overrides:
    
    toString in class Object
  - get
```
public Vector3f get()
```
    Copy components into new Vector object
    
    Returns:
    
    new instance
  - clone
```
public Vector3f clone()
               throws CloneNotSupportedException
```
    Overrides:
    
    clone in class Object
    
    Throws:
    
    CloneNotSupportedException
  - getX
```
@Generated(value="lombok")
public float getX()
```
  - getY
```
@Generated(value="lombok")
public float getY()
```
  - getZ
```
@Generated(value="lombok")
public float getZ()
```

Class Vector3f

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

ZERO

UNIT_X

UNIT_Y

UNIT_Z

ONE

locked

Constructor Detail

Vector3f

Vector3f

Vector3f

Method Detail

distance

lerp

lock

unlock

isLocked

euclidean

length

dot

cross

normalize

normalized

lerp

rotate

rotate

max

add

add

addLocal

addLocal

sub

sub

subLocal

subLocal

mul

mul

multLocal

multLocal

div

div

abs

clamp

clampLocal

getXY

getYZ

getXZ

getYX

getZY

getZX

set

set

setX

setY

setZ

equals

isNullVector

equals

toString

get

clone

getX

getY

getZ