com.bonzaiengine.math

Class Vec2

java.lang.Object

com.bonzaiengine.math.Vec2

All Implemented Interfaces:

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

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

Field Summary

Fields

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

Constructor Summary

Constructors

Constructor and Description
Vec2() Constructor of the (0, 0) point
Vec2(float x, float y) Constructor of a (x, y) point

Method Summary

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

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Field Detail

zero

public static final Vec2 zero

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

one

public static final Vec2 one

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

x

public float x

y

public float y

Constructor Detail

Vec2

public Vec2()

Constructor of the (0, 0) point

Vec2

public Vec2(float x,
            float y)

Constructor of a (x, y) point

Method Detail

clone

public final Vec2 clone()

Specified by:

clone in interface IData<Vec2>

Specified by:

clone in interface IValueCopy<Vec2>

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

isUnitVector

public final boolean isUnitVector()

setUnit

public final Vec2 setUnit()

get

public final float[] get()

set

public final Vec2 set(float x,
                      float y)

getX

public final float getX()

setX

public final Vec2 setX(float x)

getY

public final float getY()

setY

public final Vec2 setY(float y)

add

public Vec2 add(float x,
                float y)

add

public final Vec2 add(Vec2 vec)

Parameters:

vec -

Returns:

this += vec

add

public final Vec2 add(Vec2 vec1,
                      Vec2 vec2)

Parameters:

vec1 -

vec2 -

Returns:

this = vec1 + vec2

addScale

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

Parameters:

vec1 -

vec2 -

scale -

Returns:

this = vec1 + (vec2 * scale)

addScale

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

Parameters:

vec1 -

vec2 -

scale -

Returns:

this = vec1 + (vec2 * scale)

subtract

public final Vec2 subtract(Vec2 vec)

Parameters:

vec -

Returns:

this -= vec

subtract

public final Vec2 subtract(Vec2 vec1,
                           Vec2 vec2)

Parameters:

vec1 -

vec2 -

Returns:

this = vec1 - vec2

multiply

public final Vec2 multiply(Vec2 vec)

Parameters:

vec -

Returns:

this *= vec

multiply

public final Vec2 multiply(Vec2 vec1,
                           Vec2 vec2)

Parameters:

vec1 -

vec2 -

Returns:

this = vec1 * vec2

multiply

public final Vec2 multiply(float f)

Parameters:

vec -

f -

Returns:

this *= f

multiply

public final Vec2 multiply(Vec2 vec,
                           float f)

Parameters:

vec -

f -

Returns:

this = vec * f

divide

public final Vec2 divide(Vec2 vec,
                         float f)

Parameters:

vec -

f -

Returns:

this = vec / f

divide

public final Vec2 divide(Vec2 vec1,
                         Vec2 vec2)

Parameters:

vec1 -

vec2 -

Returns:

this = vec1 / vec2

invert

public final Vec2 invert(Vec2 vec)

Returns:

this = 1 / vec

magnitude

public final float magnitude()

Returns:

the magnitude of this Vec2

magnitudeSqr

public final float magnitudeSqr()

Returns:

the magnitude squared of this Vec2

magnitude

public final Vec2 magnitude(float length)

Parameters:

length - new magnitude (length) for this Vec2

normalize

public final float normalize()

Normalize this Vec2

Returns:

magnitude before normalization

distance

public final float distance(Vec2 vec)

Parameters:

vec - a vector

Returns:

the distance between this and vector

distanceSqr

public final float distanceSqr(Vec2 vec)

Parameters:

vec - a vector

Returns:

the distance squared between this and vector

dot

public final float dot(Vec2 vec)

Parameters:

vec - a vector

Returns:

the dot product between this vector and vec

min

public final Vec2 min(Vec2 vec1,
                      Vec2 vec2)

max

public final Vec2 max(Vec2 vec1,
                      Vec2 vec2)

interpolate

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

Description copied from interface: IInterpolable

Interpolate current and next and store result in this.

Specified by:

interpolate in interface IInterpolable<Vec2>

Specified by:

interpolate in interface IData<Vec2>

Parameters:

next -

t - range is [0, 1]

current - current value

Returns:

the (new) interpolated vector

interpolateNoCheck

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

interpolateNoCheck

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

interpolateScaleAddNoCheck

public final void interpolateScaleAddNoCheck(Vec2 next,
                                             float t,
                                             float scaleX,
                                             float scaleY,
                                             float addX,
                                             float addY,
                                             float[] dest,
                                             int destIndex)

set

public final Vec2 set(Vec2 src)

Copy src in this vector.

Specified by:

set in interface IValueCopy<Vec2>

Parameters:

src - source vector