com.bonzaiengine.math

Class Vec3

java.lang.Object

com.bonzaiengine.math.Vec3

All Implemented Interfaces:

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

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

Field Summary

Fields

Modifier and Type	Field and Description
static Vec3	AXIS_NEG_X Don't modify the value.
static Vec3	AXIS_NEG_Y Don't modify the value.
static Vec3	AXIS_NEG_Z Don't modify the value.
static Vec3	AXIS_X Don't modify the value.
static Vec3	AXIS_Y Don't modify the value.
static Vec3	AXIS_Z Don't modify the value.
static Vec3	MAX_VALUE Don't modify the value.
static Vec3	MIN_VALUE Don't modify the value.
static Vec3	MINUS_ONE Don't modify the value.
static Vec3	ONE Don't modify the value.
static Vec3	PLANE_XY Don't modify the value.
static Vec3	PLANE_XZ Don't modify the value.
static Vec3	PLANE_YZ Don't modify the value.
float	x
float	y
float	z
static Vec3	ZERO Don't modify the value.

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method and Description
Vec3	add(float x, float y, float z)
Vec3	add(Vec3 vec)
Vec3	add(Vec3 vec1, Vec3 vec2)
Vec3	addScale(Vec3 vec1, Vec3 vec2, float scale)
Vec3	addScale(Vec3 vec1, Vec3 vec2, Vec3 scale)
float	angle(Vec3 vec)
float	angleOriented(Vec3 vec, Vec3 referenceAxis)
Vec3	clone()
Vec3	cross(Vec3 vec1, Vec3 vec2) The cross product of two vectors: (y1*z2-z1*y2, z1*x2-x1*z2, x1*y2-y1*x2)
float	distance(Vec3 vec)
float	distanceSqr(Vec3 vec)
Vec3	divide(Vec3 vec, float f)
Vec3	divide(Vec3 vec1, Vec3 vec2)
float	dot(Vec3 vec)
boolean	equals(java.lang.Object obj)
float[]	get(float[] dst)
float	get(int i)
float	getX()
float	getY()
float	getZ()
int	hashCode()
Vec3	interpolate(Vec3 current, Vec3 next, float t) Interpolate current and next and store result in this.
void	interpolateNoCheck(Vec3 next, float t, float[] dest, int destIndex)
Vec3	interpolateNoCheck(Vec3 current, Vec3 next, float t)
Vec3	invert(Vec3 vec)
boolean	isUnitVector()
boolean	isZeroVector()
float	magnitude()
Vec3	magnitude(float length)
float	magnitudeSqr()
Vec3	max(Vec3 vec1, Vec3 vec2)
Vec3	min(Vec3 vec1, Vec3 vec2)
Vec3	multiply(float f)
Vec3	multiply(Vec3 vec)
Vec3	multiply(Vec3 vec, float f)
Vec3	multiply(Vec3 vec1, Vec3 vec2)
Vec3	normal(Vec3 dir1, Vec3 dir2)
float	normalize() Normalize this Vec3
float	normalize(Vec3 src)
Vec3	project(Vec3 axis, Vec3 vector) Project the specified vector on the direction and store the result in this
Vec3	set(float xyz)
Vec3	set(float[] src)
Vec3	set(float x, float y, float z)
void	set(int i, float v)
Vec3	set(Vec3 src) Copy src in this vector.
Vec3	set(Vec4 src) Copy src in this vector.
Vec3	setUnit()
Vec3	setX(float x)
Vec3	setY(float y)
Vec3	setZ(float z)
Vec3	setZero()
Vec3	subtract(Vec3 vec)
Vec3	subtract(Vec3 vec1, Vec3 vec2)
java.lang.String	toString()
Vec3	triangleNormal(Vec3 v0, Vec3 v1, Vec3 v2)

Methods inherited from class java.lang.Object

finalize, getClass, notify, notifyAll, wait, wait, wait

Field Detail

ZERO

public static final Vec3 ZERO

Don't modify the value. Value should remains (0,0,0)

ONE

public static final Vec3 ONE

Don't modify the value. Value should remains (1,1,1)

MINUS_ONE

public static final Vec3 MINUS_ONE

Don't modify the value. Value should remains (-1,-1,-1)

AXIS_X

public static final Vec3 AXIS_X

Don't modify the value. Value should remains (1,0,0)

AXIS_Y

public static final Vec3 AXIS_Y

Don't modify the value. Value should remains (0,1,0)

AXIS_Z

public static final Vec3 AXIS_Z

Don't modify the value. Value should remains (0,0,1)

AXIS_NEG_X

public static final Vec3 AXIS_NEG_X

Don't modify the value. Value should remains (-1,0,0)

AXIS_NEG_Y

public static final Vec3 AXIS_NEG_Y

Don't modify the value. Value should remains (0,-1,0)

AXIS_NEG_Z

public static final Vec3 AXIS_NEG_Z

Don't modify the value. Value should remains (0,0,-1)

MAX_VALUE

public static final Vec3 MAX_VALUE

Don't modify the value.

MIN_VALUE

public static final Vec3 MIN_VALUE

Don't modify the value.

PLANE_XY

public static final Vec3 PLANE_XY

Don't modify the value. Value should remains (1,1,0)

PLANE_XZ

public static final Vec3 PLANE_XZ

Don't modify the value. Value should remains (1,0,1)

PLANE_YZ

public static final Vec3 PLANE_YZ

Don't modify the value. Value should remains (0,1,1)

x

public float x

y

public float y

z

public float z

Constructor Detail

Vec3

public Vec3()

Constructor of the (0, 0, 0) Point

Vec3

public Vec3(float x,
            float y,
            float z)

Constructor of the (x, y, z) Point

Method Detail

clone

public final Vec3 clone()

Specified by:

clone in interface IData<Vec3>

Specified by:

clone in interface IValueCopy<Vec3>

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 Vec3 setZero()

isUnitVector

public final boolean isUnitVector()

setUnit

public final Vec3 setUnit()

get

public final float get(int i)

get

public final float[] get(float[] dst)

set

public final void set(int i,
                      float v)

set

public Vec3 set(float x,
                float y,
                float z)

set

public Vec3 set(float xyz)

getX

public final float getX()

setX

public final Vec3 setX(float x)

getY

public final float getY()

setY

public final Vec3 setY(float y)

getZ

public final float getZ()

setZ

public final Vec3 setZ(float z)

add

public Vec3 add(float x,
                float y,
                float z)

add

public final Vec3 add(Vec3 vec)

Parameters:

vec -

Returns:

this += vec

add

public final Vec3 add(Vec3 vec1,
                      Vec3 vec2)

Parameters:

vec1 -

vec2 -

Returns:

this = vec1 + vec2

addScale

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

Parameters:

vec1 -

vec2 -

scale -

Returns:

this = vec1 + (vec2 * scale)

addScale

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

Parameters:

vec1 -

vec2 -

scale -

Returns:

this = vec1 + (vec2 * scale)

subtract

public final Vec3 subtract(Vec3 vec)

Parameters:

vec -

Returns:

this -= vec

subtract

public final Vec3 subtract(Vec3 vec1,
                           Vec3 vec2)

Parameters:

vec1 -

vec2 -

Returns:

this = vec1 - vec2

multiply

public final Vec3 multiply(Vec3 vec)

Parameters:

vec -

Returns:

this *= vec

multiply

public final Vec3 multiply(Vec3 vec1,
                           Vec3 vec2)

Parameters:

vec1 -

vec2 -

Returns:

this = vec1 * vec2

multiply

public final Vec3 multiply(float f)

Parameters:

f -

Returns:

this *= f

multiply

public final Vec3 multiply(Vec3 vec,
                           float f)

Parameters:

vec -

f -

Returns:

this = vec * f

divide

public final Vec3 divide(Vec3 vec,
                         float f)

Parameters:

vec -

f -

Returns:

this = vec / f

divide

public final Vec3 divide(Vec3 vec1,
                         Vec3 vec2)

Parameters:

vec1 -

vec2 -

Returns:

this = vec1 / vec2

invert

public final Vec3 invert(Vec3 vec)

Returns:

this = 1 / vec

magnitude

public final float magnitude()

Returns:

the magnitude of this Vec3

magnitudeSqr

public final float magnitudeSqr()

Returns:

the magnitude squared of this Vec3

magnitude

public final Vec3 magnitude(float length)

Parameters:

length - new magnitude (length) for this Vec3

normalize

public final float normalize()

Normalize this Vec3

Returns:

magnitude before normalization

normalize

public final float normalize(Vec3 src)

Parameters:

src - normalize src into this Vec3

distance

public final float distance(Vec3 vec)

Parameters:

vec - a vector

Returns:

the distance between this and vector

distanceSqr

public final float distanceSqr(Vec3 vec)

Parameters:

vec - a vector

Returns:

the distance squared between this and vector

dot

public final float dot(Vec3 vec)

Parameters:

vec - a vector

Returns:

the dot product between this vector and vec

project

public Vec3 project(Vec3 axis,
                    Vec3 vector)

Project the specified vector on the direction and store the result in this

Parameters:

axis - must not be this Vec3

vector - must not be this Vec3

Returns:

this

cross

public final Vec3 cross(Vec3 vec1,
                        Vec3 vec2)

The cross product of two vectors: (y1*z2-z1*y2, z1*x2-x1*z2, x1*y2-y1*x2)

Parameters:

vec1 - first vector

vec2 - second vector

Returns:

this, containing the cross product result

triangleNormal

public final Vec3 triangleNormal(Vec3 v0,
                                 Vec3 v1,
                                 Vec3 v2)

Parameters:

v0 - first point

v1 - second point

v2 - third point

Returns:

the normal vector of the triangle formed by the 3 points

normal

public final Vec3 normal(Vec3 dir1,
                         Vec3 dir2)

Parameters:

dir1 - first direction

dir2 - second direction

Returns:

the normal vector to the 2 direction vectors

angle

public final float angle(Vec3 vec)

Returns:

angle in radians

angleOriented

public final float angleOriented(Vec3 vec,
                                 Vec3 referenceAxis)

Returns:

angle in radians

min

public final Vec3 min(Vec3 vec1,
                      Vec3 vec2)

max

public final Vec3 max(Vec3 vec1,
                      Vec3 vec2)

interpolate

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

Description copied from interface: IInterpolable

Interpolate current and next and store result in this.

Specified by:

interpolate in interface IInterpolable<Vec3>

Specified by:

interpolate in interface IData<Vec3>

Parameters:

next -

t - range is [0, 1]

current - current value

Returns:

the (new) interpolated vector

interpolateNoCheck

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

interpolateNoCheck

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

set

public final Vec3 set(Vec3 src)

Copy src in this vector.

Specified by:

set in interface IValueCopy<Vec3>

Parameters:

src - source vector

set

public final Vec3 set(Vec4 src)

Copy src in this vector.

Parameters:

src - source vector

set

public final Vec3 set(float[] src)