com.bonzaiengine.math

Class Vec4

java.lang.Object

com.bonzaiengine.math.Vec4

All Implemented Interfaces:

IInterpolable<Vec4>, IData<Vec4>, IValueCopy<Vec4>, java.lang.Cloneable

public class Vec4
extends java.lang.Object
implements IData<Vec4>

Field Summary

Fields

Modifier and Type	Field and Description
float	w
float	x
float	y
float	z

Constructor Summary

Constructors

Constructor and Description
Vec4() Constructor of the (0, 0, 0, 0) Point
Vec4(float x, float y, float z, float w) Constructor of the (x, y, z, w) Point
Vec4(Vec3 vector, float w) Constructor of the (x, y, z) Point

Method Summary

Modifier and Type	Method and Description
Vec4	add(float x, float y, float z, float w)
Vec4	add(Vec4 vec1, Vec4 vec2)
Vec4	addScale(Vec4 vec1, Vec4 vec2, float scale)
Vec4	addScale(Vec4 vec1, Vec4 vec2, Vec4 scale)
Vec4	clone()
float	distance(Vec4 vector)
float	distanceSqr(Vec4 vector)
Vec4	divide(Vec4 src, float f)
Vec4	divide(Vec4 vec1, Vec4 vec2)
float	dot(Vec4 vec)
boolean	equals(java.lang.Object obj)
void	get(float[] dst)
float	getW()
float	getX()
float	getY()
float	getZ()
int	hashCode()
Vec4	interpolate(Vec4 current, Vec4 next, float t) Interpolate current and next and store result in this.
void	interpolateNoCheck(Vec4 next, float t, float[] dest, int destIndex)
Vec4	interpolateNoCheck(Vec4 current, Vec4 next, float t)
Vec4	invert(Vec4 vec)
boolean	isUnitVector()
boolean	isZeroVector()
float	magnitude()
Vec4	magnitude(float length)
float	magnitudeSqr()
Vec4	max(Vec4 vec1, Vec4 vec2)
Vec4	min(Vec4 vec1, Vec4 vec2)
Vec4	multiply(Vec4 vec, float f)
Vec4	multiply(Vec4 vec1, Vec4 vec2)
float	normalize() Normalize this Vec4
float	normalize(Vec4 src)
Vec4	set(float[] src)
Vec4	set(float x, float y, float z, float w)
Vec4	set(Vec3 src, float srcW) Copy src in this vector.
Vec4	set(Vec4 src) Copy src in this vector.
Vec4	setUnit()
Vec4	setW(float w)
Vec4	setX(float x)
Vec4	setY(float y)
Vec4	setZ(float z)
Vec4	setZero()
Vec4	subtract(Vec4 vec1, Vec4 vec2)
java.lang.String	toString()

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Field Detail

x

public float x

y

public float y

z

public float z

w

public float w

Constructor Detail

Vec4

public Vec4()

Constructor of the (0, 0, 0, 0) Point

Vec4

public Vec4(float x,
            float y,
            float z,
            float w)

Constructor of the (x, y, z, w) Point

Vec4

public Vec4(Vec3 vector,
            float w)

Constructor of the (x, y, z) Point

Method Detail

clone

public final Vec4 clone()

Specified by:

clone in interface IData<Vec4>

Specified by:

clone in interface IValueCopy<Vec4>

Overrides:

clone in class java.lang.Object

equals

public final boolean equals(java.lang.Object obj)

Overrides:

equals in class java.lang.Object

toString

public final java.lang.String toString()

Overrides:

toString in class java.lang.Object

hashCode

public final int hashCode()

Overrides:

hashCode in class java.lang.Object

isZeroVector

public final boolean isZeroVector()

setZero

public final Vec4 setZero()

isUnitVector

public final boolean isUnitVector()

setUnit

public final Vec4 setUnit()

get

public final void get(float[] dst)

set

public final Vec4 set(float x,
                      float y,
                      float z,
                      float w)

getX

public final float getX()

setX

public final Vec4 setX(float x)

getY

public final float getY()

setY

public final Vec4 setY(float y)

getZ

public final float getZ()

setZ

public final Vec4 setZ(float z)

getW

public final float getW()

setW

public final Vec4 setW(float w)

add

public Vec4 add(float x,
                float y,
                float z,
                float w)

add

public final Vec4 add(Vec4 vec1,
                      Vec4 vec2)

Parameters:

vec1 -

vec2 -

Returns:

this = vec1 + vec2

addScale

public final Vec4 addScale(Vec4 vec1,
                           Vec4 vec2,
                           Vec4 scale)

Parameters:

vec1 -

vec2 -

scale -

Returns:

this = vec1 + (vec2 * scale)

addScale

public final Vec4 addScale(Vec4 vec1,
                           Vec4 vec2,
                           float scale)

Parameters:

vec1 -

vec2 -

scale -

Returns:

this = vec1 + (vec2 * scale)

subtract

public final Vec4 subtract(Vec4 vec1,
                           Vec4 vec2)

Parameters:

vec1 -

vec2 -

Returns:

this = vec1 - vec2

multiply

public final Vec4 multiply(Vec4 vec1,
                           Vec4 vec2)

Parameters:

vec1 -

vec2 -

Returns:

this = vec1 * vec2

multiply

public final Vec4 multiply(Vec4 vec,
                           float f)

Parameters:

vec -

f -

Returns:

this = vec * f

divide

public final Vec4 divide(Vec4 src,
                         float f)

Parameters:

vec -

f -

Returns:

this = vec / f

divide

public final Vec4 divide(Vec4 vec1,
                         Vec4 vec2)

Parameters:

vec1 -

vec2 -

Returns:

this = vec1 / vec2

invert

public final Vec4 invert(Vec4 vec)

Returns:

this = 1 / vec

magnitude

public final float magnitude()

Returns:

the magnitude of this Vec4

magnitudeSqr

public final float magnitudeSqr()

Returns:

the magnitude squared of this Vec4

magnitude

public final Vec4 magnitude(float length)

Parameters:

length - new magnitude (length) for this Vec4

normalize

public final float normalize()

Normalize this Vec4

Returns:

magnitude before normalization

normalize

public final float normalize(Vec4 src)

Parameters:

src - normalize src into this Vec4

distance

public final float distance(Vec4 vector)

Parameters:

vector - a vector

Returns:

the distance between this and vector

distanceSqr

public final float distanceSqr(Vec4 vector)

dot

public final float dot(Vec4 vec)

Parameters:

vec - a vector

Returns:

the dot product between this vector and vec

min

public final Vec4 min(Vec4 vec1,
                      Vec4 vec2)

max

public final Vec4 max(Vec4 vec1,
                      Vec4 vec2)

interpolate

public final Vec4 interpolate(Vec4 current,
                              Vec4 next,
                              float t)

Description copied from interface: IInterpolable

Interpolate current and next and store result in this.

Specified by:

interpolate in interface IInterpolable<Vec4>

Specified by:

interpolate in interface IData<Vec4>

Parameters:

next -

t - range is [0, 1]

current - current value

Returns:

the (new) interpolated vector

interpolateNoCheck

public final Vec4 interpolateNoCheck(Vec4 current,
                                     Vec4 next,
                                     float t)

interpolateNoCheck

public final void interpolateNoCheck(Vec4 next,
                                     float t,
                                     float[] dest,
                                     int destIndex)

set

public final Vec4 set(Vec4 src)

Copy src in this vector.

Specified by:

set in interface IValueCopy<Vec4>

Parameters:

src - source vector

set

public final Vec4 set(float[] src)

set

public final Vec4 set(Vec3 src,
                      float srcW)

Copy src in this vector.

Parameters:

src - source vector