Vector2 Class Reference

Vector with 2 floating point components: (x, y). More...

Public Member Functions
	Vector2 (long cPtr, boolean cMemoryOwn)
	Vector2 ()
	Default constructor. More...
	Vector2 (float x, float y)
	Constructor. More...
	Vector2 (float v)
	Constructor. More...
Vector2	add (float scalar)
	Adds a scalar to each vector element. More...
Vector2	add (Vector2 v)
	Modifies this vector by adding another vector. More...
synchronized void	delete ()
Vector2	divide (float scalar)
	Divides each vector element with a scalar. More...
boolean	equals (Object obj)
float	get (long index)
	Returns the vector element value at index. More...
float	getX ()
	Returns the x element of the vector. More...
float	getY ()
	Returns the y element of the vector. More...
int	hashCode ()
boolean	hasNan ()
	Returns true if and only if at least one of the vector values is NaN.
float	length ()
	Calculates the length a vectors. More...
Vector2	multiply (float scalar)
	Multiplies each vector element with a scalar. More...
Vector2	normalized ()
	Normalizes the vector and returns the resulting vector. More...
void	set (long index, float value)
	Sets the vector element at index to value. More...
void	setX (float value)
	Sets the x element of the vector. More...
void	setY (float value)
	Sets the y element of the vector. More...
float	squaredLength ()
	Calculates the squared length a vectors. More...
Vector2	subtract (Vector2 v)
	Modifies this vector by subtracting another vector from this vector. More...

Static Public Member Functions
static Vector2	add (float scalar, Vector2 v)
	Adds a scalar and a vector and returns the sum. More...
static Vector2	add (Vector2 v, float scalar)
	Adds a vector and a scalar and returns the sum. More...
static Vector2	add (Vector2 v1, Vector2 v2)
	Adds two vectors and returns the sum. More...
static Vector2	componentAbs (Vector2 v)
	Calculates component-wise absolute value for all elements and returns resulting vector. More...
static Vector2	componentAdd (Vector2 v, float scalar)
	Adds a value to all elements of a vector and returns the result. More...
static boolean	componentAllGreaterThan (Vector2 a, Vector2 b)
	Returns whether each component of the first vector is greater than the corresponding component of the second vector. More...
static boolean	componentAllGreaterThanOrEqual (Vector2 a, Vector2 b)
	Returns whether each component of the first vector is greater than or equal to the corresponding component of the second vector. More...
static boolean	componentAllLessThan (Vector2 a, Vector2 b)
	Returns whether each component of the first vector is less than the corresponding component of the second vector. More...
static boolean	componentAllLessThanOrEqual (Vector2 a, Vector2 b)
	Returns whether each component of the first vector is less than or equal to the corresponding component of the second vector. More...
static Vector2	componentCeil (Vector2 v)
	Calculates component-wise ceil value for all elements and returns resulting vector. More...
static Vector2	componentFloor (Vector2 v)
	Calculates component-wise floor value for all elements and returns resulting vector. More...
static Vector2	componentRound (Vector2 v)
	Calculates component-wise rounded value for all elements and returns resulting vector. More...
static Vector2	componentSqrt (Vector2 v)
	Calculates component-wise square root all elements and returns resulting vector. More...
static Vector2	componentSubtract (Vector2 v, float scalar)
	Subtracts a value from all elements of a vector and returns the result. More...
static Vector2	componentWiseDivide (Vector2 v1, Vector2 v2)
	Divides all vector elements component-wise and returns the resulting vector. More...
static Vector2	componentWiseMax (Vector2 v1, Vector2 v2)
	Calculates the component-wise maximum for all vector elements and returns the resulting vector. More...
static Vector2	componentWiseMin (Vector2 v1, Vector2 v2)
	Calculates the component-wise minimum for all vector elements and returns the resulting vector. More...
static Vector2	componentWiseMultiply (Vector2 v1, Vector2 v2)
	Multiplies all vector elements component-wise and returns the resulting vector. More...
static Vector2	componentWiseRemainder (Vector2 v1, Vector2 v2)
	Calculates component-wise the remainder for all vector elements and returns the resulting vector. More...
static Vector2	createFromVector3 (Vector3 v)
	Creates a Vector2 from Vector3 by dropping the z-coordinate. More...
static Vector2	divide (Vector2 v, float scalar)
	Divides all vector elements with a scalar and returns the resulting vector. More...
static float	dotProduct (Vector2 v1, Vector2 v2)
	Calculates the dot product of two vectors. More...
static long	getCPtr (Vector2 obj)
static Vector2	highestValue ()
	Returns the vector with each element having the most positive float value. More...
static boolean	isfinite (Vector2 v)
	Overloading of std::isfinite for kanzi::Vector2. More...
static Vector2	lowestValue ()
	Returns the vector with each element having the most negative float value. More...
static Vector2	multiply (float scalar, Vector2 v)
	Multiplies all vector elements with a scalar and returns the resulting vector. More...
static Vector2	multiply (Vector2 v, float scalar)
	Multiplies all vector elements with a scalar and returns the resulting vector. More...
static Vector2	nan ()
	Returns the vector with each element being NaN. More...
static Vector2	negate (Vector2 v)
	Negates all vector elements and returns the resulting vector. More...
static Vector2	negativeInfinity ()
	Returns the vector with each element being the negative infinity. More...
static Vector2	one ()
	Returns the vector with each element being one. More...
static Vector2	positiveInfinity ()
	Returns the vector with each element being the positive infinity. More...
static float	pseudoCrossProduct (Vector2 left, Vector2 right)
	Calculates pseudo-cross product of two 2D vectors. More...
static Vector2	subtract (Vector2 v1, Vector2 v2)
	Subtracts two vectors and returns the difference. More...
static Vector2	zero ()
	Returns the vector with each element being zero. More...

Protected Member Functions
void	finalize ()

Protected Attributes
transient boolean	swigCMemOwn

Detailed Description

Vector with 2 floating point components: (x, y).

Constructor & Destructor Documentation

Vector2() [1/3]

Vector2

(

)

Default constructor.

Initializes a vector to (0.0, 0.0).

Vector2() [2/3]

Vector2	(	float	x,
		float	y
	)

Constructor.

Initializes a vector to (x, y).

Parameters

x	x coefficient of a vector.
y	y coefficient of a vector.

Vector2() [3/3]

Vector2

(

float

v

)

Constructor.

Initializes a vector to (v, v).

Parameters

v	x and y coefficients of a vector.

Member Function Documentation

add() [1/5]

Vector2 add

(

float

scalar

)

Adds a scalar to each vector element.

Parameters

scalar

Addition to each vector element.

Returns

This vector.

add() [2/5]

Vector2 add

(

Vector2

v

)

Modifies this vector by adding another vector.

Parameters

v	Another vector.

Returns

This vector.

add() [3/5]

static Vector2 add ( float  scalar, Vector2  v  )

static

Adds a scalar and a vector and returns the sum.

Parameters

scalar	Left hand side scalar.
v	Right hand side vector.

Returns

The result vector.

add() [4/5]

static Vector2 add ( Vector2  v, float  scalar  )

static

Adds a vector and a scalar and returns the sum.

Parameters

v	Left hand side vector.
scalar	Right hand side scalar.

Returns

The result vector.

add() [5/5]

static Vector2 add ( Vector2  v1, Vector2  v2  )

static

Adds two vectors and returns the sum.

Parameters

v1	Left hand side vector.
v2	Right hand side vector.

Returns

The result vector.

componentAbs()

static Vector2 componentAbs ( Vector2  v )

static

Calculates component-wise absolute value for all elements and returns resulting vector.

Parameters

v	Vector input.

Returns

The result vector.

componentAdd()

static Vector2 componentAdd ( Vector2  v, float  scalar  )

static

Adds a value to all elements of a vector and returns the result.

Parameters

v	A vector.
scalar	A scalar.

Returns

The result vector.

componentAllGreaterThan()

static boolean componentAllGreaterThan ( Vector2  a, Vector2  b  )

static

Returns whether each component of the first vector is greater than the corresponding component of the second vector.

Parameters

a	First vector.
b	Second vector.

Returns

If each component of the first vector is greater than the corresponding component of the second vector, true, othwerise false.

componentAllGreaterThanOrEqual()

static boolean componentAllGreaterThanOrEqual ( Vector2  a, Vector2  b  )

static

Returns whether each component of the first vector is greater than or equal to the corresponding component of the second vector.

Parameters

a	First vector.
b	Second vector.

Returns

If each component of the first vector is greater than or equal to the corresponding component of the second vector, true, otherwise false.

componentAllLessThan()

static boolean componentAllLessThan ( Vector2  a, Vector2  b  )

static

Returns whether each component of the first vector is less than the corresponding component of the second vector.

Parameters

a	First vector.
b	Second vector.

Returns

If each component of the first vector is less than the corresponding component of the second vector, true, otherwise false.

componentAllLessThanOrEqual()

static boolean componentAllLessThanOrEqual ( Vector2  a, Vector2  b  )

static

Returns whether each component of the first vector is less than or equal to the corresponding component of the second vector.

Parameters

a	First vector.
b	Second vector.

Returns

If each component of the first vector is less than or equal to the corresponding component of the second vector, true, otherwise false.

componentCeil()

static Vector2 componentCeil ( Vector2  v )

static

Calculates component-wise ceil value for all elements and returns resulting vector.

Parameters

v	Vector input.

Returns

The result vector.

componentFloor()

static Vector2 componentFloor ( Vector2  v )

static

Calculates component-wise floor value for all elements and returns resulting vector.

Parameters

v	Vector input.

Returns

The result vector.

componentRound()

static Vector2 componentRound ( Vector2  v )

static

Calculates component-wise rounded value for all elements and returns resulting vector.

Parameters

v	Vector input.

Returns

The result vector.

componentSqrt()

static Vector2 componentSqrt ( Vector2  v )

static

Calculates component-wise square root all elements and returns resulting vector.

Parameters

v	Vector input.

Returns

The result vector.

componentSubtract()

static Vector2 componentSubtract ( Vector2  v, float  scalar  )

static

Subtracts a value from all elements of a vector and returns the result.

Parameters

v	A vector.
scalar	A scalar.

Returns

The result vector.

componentWiseDivide()

static Vector2 componentWiseDivide ( Vector2  v1, Vector2  v2  )

static

Divides all vector elements component-wise and returns the resulting vector.

Parameters

v1	The first vector.
v2	The second vector.

Returns

The result vector.

componentWiseMax()

static Vector2 componentWiseMax ( Vector2  v1, Vector2  v2  )

static

Calculates the component-wise maximum for all vector elements and returns the resulting vector.

Parameters

v1	The first vector.
v2	The second vector.

Returns

The result vector.

componentWiseMin()

static Vector2 componentWiseMin ( Vector2  v1, Vector2  v2  )

static

Calculates the component-wise minimum for all vector elements and returns the resulting vector.

Parameters

v1	The first vector.
v2	The second vector.

Returns

The result vector.

componentWiseMultiply()

static Vector2 componentWiseMultiply ( Vector2  v1, Vector2  v2  )

static

Multiplies all vector elements component-wise and returns the resulting vector.

Parameters

v1	The first vector.
v2	The second vector.

Returns

The result vector.

componentWiseRemainder()

static Vector2 componentWiseRemainder ( Vector2  v1, Vector2  v2  )

static

Calculates component-wise the remainder for all vector elements and returns the resulting vector.

Parameters

v1	The first vector.
v2	The second vector.

Returns

The result vector.

createFromVector3()

static Vector2 createFromVector3 ( Vector3  v )

static

Creates a Vector2 from Vector3 by dropping the z-coordinate.

Parameters

v	Input vector.

Returns

The input vector without z-coordinate.

divide() [1/2]

Vector2 divide

(

float

scalar

)

Divides each vector element with a scalar.

Parameters

scalar

Divider for each vector element.

Returns

This vector.

divide() [2/2]

static Vector2 divide ( Vector2  v, float  scalar  )

static

Divides all vector elements with a scalar and returns the resulting vector.

Parameters

v	A vector.
scalar	A scalar.

Returns

The result vector.

dotProduct()

static float dotProduct ( Vector2  v1, Vector2  v2  )

static

Calculates the dot product of two vectors.

Parameters

v1	The first vector.
v2	The second vector.

Returns

The dot product of the vectors.

get()

float get

(

long

index

)

Returns the vector element value at index.

Returns

The vector element value at index.

getX()

float getX

(

)

Returns the x element of the vector.

Returns

The x element.

getY()

float getY

(

)

Returns the y element of the vector.

Returns

The y element.

highestValue()

static Vector2 highestValue ( )

static

Returns the vector with each element having the most positive float value.

Returns

Vector with the highest possible value.

isfinite()

static boolean isfinite ( Vector2  v )

static

Overloading of std::isfinite for kanzi::Vector2.

Returns

If both elements of the Vector2 have finite value, true, otherwise false.

length()

float length

(

)

Calculates the length a vectors.

Returns

sqrt(x*x + y*y)

lowestValue()

static Vector2 lowestValue ( )

static

Returns the vector with each element having the most negative float value.

Returns

Vector with the lowest possible value.

multiply() [1/3]

Vector2 multiply

(

float

scalar

)

Multiplies each vector element with a scalar.

Parameters

scalar

Multiplier for each vector element.

Returns

This vector.

multiply() [2/3]

static Vector2 multiply ( float  scalar, Vector2  v  )

static

Multiplies all vector elements with a scalar and returns the resulting vector.

Parameters

scalar	A scalar.
v	A vector.

Returns

The result vector.

multiply() [3/3]

static Vector2 multiply ( Vector2  v, float  scalar  )

static

Multiplies all vector elements with a scalar and returns the resulting vector.

Parameters

v	A vector.
scalar	A scalar.

Returns

The result vector.

nan()

static Vector2 nan ( )

static

Returns the vector with each element being NaN.

Returns

Vector with NaN elements.

negate()

static Vector2 negate ( Vector2  v )

static

Negates all vector elements and returns the resulting vector.

Parameters

v

A vector.

Returns

The result vector.

negativeInfinity()

static Vector2 negativeInfinity ( )

static

Returns the vector with each element being the negative infinity.

Returns

Vector with negative infinity elements.

normalized()

Vector2 normalized

(

)

Normalizes the vector and returns the resulting vector.

Returns

The normalized vector.

one()

static Vector2 one ( )

static

Returns the vector with each element being one.

Returns

Vector with unit element values.

positiveInfinity()

static Vector2 positiveInfinity ( )

static

Returns the vector with each element being the positive infinity.

Returns

Vector with positive infinity elements.

pseudoCrossProduct()

static float pseudoCrossProduct ( Vector2  left, Vector2  right  )

static

Calculates pseudo-cross product of two 2D vectors.

U x V = Uy * Vx - Ux * Vy.

Parameters

left	The first vector.
right	The second vector.

Returns

The pseudo-cross product of the vectors.

set()

void set	(	long	index,
		float	value
	)

Sets the vector element at index to value.

Parameters

index	Vector element index to set.
value	Value to set.

setX()

void setX

(

float

value

)

Sets the x element of the vector.

Parameters

value

The new value of the x element.

setY()

void setY

(

float

value

)

Sets the y element of the vector.

Parameters

value

The new value of the y element.

squaredLength()

float squaredLength

(

)

Calculates the squared length a vectors.

Returns

x*x + y*y

subtract() [1/2]

Vector2 subtract

(

Vector2

v

)

Modifies this vector by subtracting another vector from this vector.

Parameters

v	Another vector.

Returns

This vector.

subtract() [2/2]

static Vector2 subtract ( Vector2  v1, Vector2  v2  )

static

Subtracts two vectors and returns the difference.

Parameters

v1	Left hand side vector.
v2	Right hand side vector.

Returns

The result vector.

zero()

static Vector2 zero ( )

static

Returns the vector with each element being zero.

Returns

Vector with zeroed elements.