com.bonzaiengine.math

Class Vec3i

java.lang.Object

com.bonzaiengine.math.Vec3i

All Implemented Interfaces:

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

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

Field Summary

Fields

Modifier and Type	Field and Description
static Vec3i	one Don't modify the value of this vector.
int	x
int	y
int	z
static Vec3i	zero Don't modify the value of this vector.

Constructor Summary

Constructors

Constructor and Description
Vec3i() Constructor of the (0, 0, 0) point
Vec3i(int x, int y, int z) Constructor of a (x, y, z) point

Method Summary

Modifier and Type	Method and Description
Vec3i	add(Vec3i v)
Vec3i	add(Vec3i vec1, Vec3i vec2)
Vec3i	addScale(Vec3i vec1, Vec3i vec2, int scale)
Vec3i	addScale(Vec3i vec1, Vec3i vec2, Vec3i scale)
Vec3i	clone()
float	distance(Vec3i vec)
Vec3i	divide(float f)
Vec3i	divide(Vec3i v)
Vec3i	divide(Vec3i vec, float f)
Vec3i	divide(Vec3i vec1, Vec3i vec2)
int	dot(Vec3i vec)
boolean	equals(java.lang.Object obj)
int[]	get()
int	getX()
int	getY()
int	getZ()
int	hashCode()
Vec3i	interpolate(Vec3i current, Vec3i next, float t) Interpolate current and next and store result in this.
boolean	isUnitVector()
boolean	isZeroVector()
float	magnitude()
float	magnitudeSqr()
Vec3i	multiply(float f)
Vec3i	multiply(Vec3i vec)
Vec3i	multiply(Vec3i vec, int f)
Vec3i	multiply(Vec3i vec1, Vec3i vec2)
Vec3i	set(int x, int y, int z)
Vec3i	set(Vec3i src) Copy src in this vector.
Vec3i	setUnit()
Vec3i	setX(int x)
Vec3i	setY(int y)
Vec3i	setZ(int z)
Vec3i	setZero()
Vec3i	subtract(Vec3i v)
Vec3i	subtract(Vec3i vec1, Vec3i vec2)
java.lang.String	toString()
Vec3	toVec3()

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Field Detail

zero

public static final Vec3i zero

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

one

public static final Vec3i one

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

x

public int x

y

public int y

z

public int z

Constructor Detail

Vec3i

public Vec3i()

Constructor of the (0, 0, 0) point

Vec3i

public Vec3i(int x,
             int y,
             int z)

Constructor of a (x, y, z) point

Method Detail

clone

public final Vec3i clone()

Specified by:

clone in interface IData<Vec3i>

Specified by:

clone in interface IValueCopy<Vec3i>

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

isUnitVector

public final boolean isUnitVector()

setUnit

public final Vec3i setUnit()

get

public final int[] get()

set

public final Vec3i set(int x,
                       int y,
                       int z)

getX

public final int getX()

setX

public final Vec3i setX(int x)

getY

public final int getY()

setY

public final Vec3i setY(int y)

getZ

public final int getZ()

setZ

public final Vec3i setZ(int z)

add

public final Vec3i add(Vec3i v)

Parameters:

vec -

Returns:

this += vec

add

public final Vec3i add(Vec3i vec1,
                       Vec3i vec2)

Parameters:

vec1 -

vec2 -

Returns:

this = vec1 + vec2

addScale

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

Parameters:

vec1 -

vec2 -

scale -

Returns:

this = vec1 + (vec2 * scale)

addScale

public final Vec3i addScale(Vec3i vec1,
                            Vec3i vec2,
                            int scale)

Parameters:

vec1 -

vec2 -

scale -

Returns:

this = vec1 + (vec2 * scale)

subtract

public final Vec3i subtract(Vec3i v)

Parameters:

vec -

Returns:

this -= vec

subtract

public final Vec3i subtract(Vec3i vec1,
                            Vec3i vec2)

Parameters:

vec1 -

vec2 -

Returns:

this = vec1 - vec2

multiply

public final Vec3i multiply(Vec3i vec)

Parameters:

vec -

Returns:

this *= vec

multiply

public final Vec3i multiply(Vec3i vec1,
                            Vec3i vec2)

Parameters:

vec1 -

vec2 -

Returns:

this = vec1 * vec2

multiply

public final Vec3i multiply(float f)

Parameters:

vec -

f -

Returns:

this *= f

multiply

public final Vec3i multiply(Vec3i vec,
                            int f)

Parameters:

vec -

f -

Returns:

this = vec * f

divide

public final Vec3i divide(Vec3i v)

Parameters:

vec -

Returns:

this /= vec

divide

public final Vec3i divide(Vec3i vec1,
                          Vec3i vec2)

Parameters:

vec1 -

vec2 -

Returns:

this = vec1 / vec2

divide

public final Vec3i divide(float f)

Parameters:

f -

Returns:

this /= f

divide

public final Vec3i divide(Vec3i vec,
                          float f)

Parameters:

vec -

f -

Returns:

this = vec / f

magnitude

public final float magnitude()

Returns:

the magnitude of this vector

magnitudeSqr

public final float magnitudeSqr()

Returns:

the magnitude squared of this vector

distance

public final float distance(Vec3i vec)

Parameters:

vec - a vector

Returns:

the distance between this and vector

dot

public final int dot(Vec3i vec)

Parameters:

vec - a vector

Returns:

the dot product between this vector and vec

interpolate

public Vec3i interpolate(Vec3i current,
                         Vec3i next,
                         float t)

Description copied from interface: IInterpolable

Interpolate current and next and store result in this.

Specified by:

interpolate in interface IInterpolable<Vec3i>

Specified by:

interpolate in interface IData<Vec3i>

Parameters:

next -

t - range is [0, 1]

current - current value

Returns:

the (new) interpolated vector

set

public final Vec3i set(Vec3i src)

Copy src in this vector.

Specified by:

set in interface IValueCopy<Vec3i>

Parameters:

src - source vector

toVec3

public Vec3 toVec3()