crystalspace.jbind.impl.csgeom.vector2
Class csVector2

java.lang.Object
  crystalspace.jbind.impl.csNativeObject
      crystalspace.jbind.impl.csgeom.vector2.csVector2

All Implemented Interfaces:

iPointer

public class csVector2

extends csNativeObject

Author:

Quentin Anciaux

Field Summary

Fields inherited from class crystalspace.jbind.impl.csNativeObject

ImplFactory, nPointer

Constructor Summary

csVector2()
Make a new vector.

csVector2(float x, float y)
Make a new vector and initialize with the given values.

csVector2(iPointer nPointer)
Create a java csVector2 object which points to the native csVector2 nPointer.

Method Summary

csVector2	add() Unary + operator.
csVector2	add(csVector2 v) Add another vector to this vector.
static csVector2	add(csVector2 v1, csVector2 v2) Add two vectors.
static csVector2	div(csVector2 v, float f) Divide a vector by a scalar.
csVector2	div(float f) Divide this vector by a scalar.
static boolean	equals(csVector2 v1, csVector2 v2) Check if two vectors are equal.
boolean	equals(java.lang.Object obj) Check if two vectors are equal.
static boolean	greater(float f, csVector2 v) Test if each component of a vector is greater than a small epsilon value.
protected boolean	isNativePointerValidSafe(long nPointer)
static boolean	less(csVector2 v, float f) Test if each component of a vector is less than a small epsilon value.
csVector2	minus() Unary - operator.
csVector2	minus(csVector2 v) Subtract another vector from this vector.
static csVector2	minus(csVector2 v1, csVector2 v2) Subtract two vectors.
static float	mul(csVector2 v1, csVector2 v2) Take the dot product of two vectors.
static csVector2	mul(csVector2 v, float f) Multiply a vector and a scalar.
csVector2	mul(float f) Multiply this vector by a scalar.
static csVector2	mul(float f, csVector2 v) Multiply a vector and a scalar.
protected void	nDelete(long pointer)
static boolean	NEquals(csVector2 v1, csVector2 v2) Check if two vectors are not equal.
float	norm() Return the norm (magnitude) of this vector.
static float	norm(csVector2 v) Return the norm (magnitude) of a 2D vector.
void	rotate(float angle) Rotate vector around the origin by a given angle in radians.
void	set(csVector2 v) Set vector to given values.
void	set(float ix, float iy) Set vector to given values.
float	squaredNorm() Return the squared norm (magnitude) of this vector.

Methods inherited from class crystalspace.jbind.impl.csNativeObject

changePointer, finalize, getPointer, getPointer, getPointerArray, hashCode, isMemoryOwner, isNativePointerValid, newNativeObject, setMemoryOwner, toString

Methods inherited from class java.lang.Object

clone, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

csVector2

public csVector2(iPointer nPointer)

Create a java csVector2 object which points to the native csVector2 nPointer.

Parameters:

nPointer -

csVector2

public csVector2()

Make a new vector. No initialization is done.

csVector2

public csVector2(float x,
                 float y)

Make a new vector and initialize with the given values.

Parameters:

x -

y -

Method Detail

nDelete

protected void nDelete(long pointer)

Specified by:

nDelete in class csNativeObject

See Also:

csNativeObject.nDelete(long)

isNativePointerValidSafe

protected boolean isNativePointerValidSafe(long nPointer)

Specified by:

isNativePointerValidSafe in class csNativeObject

See Also:

crystalspace.jbind.impl.csNativeObject#isNativePointerValidSafe()

set

public final void set(float ix,
                      float iy)

Set vector to given values.

Parameters:

ix -

iy -

set

public final void set(csVector2 v)

Set vector to given values.

Parameters:

v -

norm

public final float norm()

Return the norm (magnitude) of this vector.

Returns:

squaredNorm

public final float squaredNorm()

Return the squared norm (magnitude) of this vector.

Returns:

rotate

public final void rotate(float angle)

Rotate vector around the origin by a given angle in radians.

Parameters:

angle -

add

public final csVector2 add(csVector2 v)

Add another vector to this vector.

Parameters:

v -

Returns:

minus

public final csVector2 minus(csVector2 v)

Subtract another vector from this vector.

Parameters:

v -

Returns:

mul

public final csVector2 mul(float f)

Multiply this vector by a scalar.

Parameters:

f -

Returns:

div

public final csVector2 div(float f)

Divide this vector by a scalar.

Parameters:

f -

Returns:

add

public final csVector2 add()

Unary + operator.

Returns:

minus

public final csVector2 minus()

Unary - operator.

Returns:

norm

public static final float norm(csVector2 v)

Return the norm (magnitude) of a 2D vector.

Parameters:

v -

Returns:

add

public static final csVector2 add(csVector2 v1,
                                  csVector2 v2)

Add two vectors.

Parameters:

v1 -

v2 -

Returns:

minus

public static final csVector2 minus(csVector2 v1,
                                    csVector2 v2)

Subtract two vectors.

Parameters:

v1 -

v2 -

Returns:

mul

public static final float mul(csVector2 v1,
                              csVector2 v2)

Take the dot product of two vectors.

Parameters:

v1 -

v2 -

Returns:

mul

public static final csVector2 mul(csVector2 v,
                                  float f)

Multiply a vector and a scalar.

Parameters:

v -

f -

Returns:

mul

public static final csVector2 mul(float f,
                                  csVector2 v)

Multiply a vector and a scalar.

Parameters:

f -

v -

Returns:

div

public static final csVector2 div(csVector2 v,
                                  float f)

Divide a vector by a scalar.

Parameters:

v -

f -

Returns:

equals

public static final boolean equals(csVector2 v1,
                                   csVector2 v2)

Check if two vectors are equal.

Parameters:

v1 -

v2 -

Returns:

NEquals

public static final boolean NEquals(csVector2 v1,
                                    csVector2 v2)

Check if two vectors are not equal.

Parameters:

v1 -

v2 -

Returns:

less

public static final boolean less(csVector2 v,
                                 float f)

Test if each component of a vector is less than a small epsilon value.

Parameters:

v -

f -

Returns:

greater

public static final boolean greater(float f,
                                    csVector2 v)

Test if each component of a vector is greater than a small epsilon value.

Parameters:

f -

v -

Returns:

equals

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

Check if two vectors are equal.

Overrides:

equals in class csNativeObject

See Also:

Object.equals(java.lang.Object)