Kanzi  3.9.9
Kanzi Engine Java API
Vector3 Class Reference

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

Public Member Functions

 Vector3 ()
 Default constructor, initializes the vector to (0.0, 0.0, 0.0).
 
 Vector3 (float x, float y, float z)
 Constructor, initializes the vector to (x, y, z). More...
 
 Vector3 (float v)
 Constructor, initializes the vector to (v, v, v). More...
 
Vector3 add (float scalar)
 Adds a scalar to each vector element. More...
 
Vector3 add (Vector3 v)
 Modifies this vector by adding another vector. More...
 
synchronized void delete ()
 
Vector3 divide (float scalar)
 Divides each vector element with a scalar. More...
 
boolean equals (Object obj)
 Indicates whether some other object is "equal to" this one. More...
 
float get (int 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...
 
float getZ ()
 Returns the z element of the vector. More...
 
int hashCode ()
 Returns a hash code value for the object. More...
 
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...
 
Vector3 maximumAxis ()
 Returns axis based on the largest component of Vector3. More...
 
Vector3 minimumAxis ()
 Returns axis based on the minimum component of Vector3. More...
 
Vector3 multiply (float scalar)
 Multiplies each vector element with a scalar. More...
 
Vector3 normalized ()
 Normalizes the vector and returns the resulting vector. More...
 
void set (int 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...
 
void setZ (float value)
 Sets the z element of the vector. More...
 
float squaredLength ()
 Calculates the squared length a vectors. More...
 
Vector3 subtract (Vector3 v)
 Modifies this vector by subtracting another vector from this vector. More...
 

Static Public Member Functions

static Vector3 add (float scalar, Vector3 v)
 Adds a scalar and a vector and returns the sum. More...
 
static Vector3 add (Vector3 v, float scalar)
 Adds a vector and a scalar and returns the sum. More...
 
static Vector3 add (Vector3 v1, Vector3 v2)
 Adds two vectors and returns the sum. More...
 
static Vector3 componentAbs (Vector3 v)
 Calculates component-wise absolute value for all elements and returns resulting vector. More...
 
static Vector3 componentAdd (Vector3 v, float scalar)
 Adds a value to all elements of a vector and returns the result. More...
 
static boolean componentAllGreaterThan (Vector3 a, Vector3 b)
 Returns whether each component of the first vector is greater than the corresponding component of the second vector. More...
 
static boolean componentAllGreaterThanOrEqual (Vector3 a, Vector3 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 (Vector3 a, Vector3 b)
 Returns whether each component of the first vector is less than the corresponding component of the second vector. More...
 
static boolean componentAllLessThanOrEqual (Vector3 a, Vector3 b)
 Returns whether each component of the first vector is less than or equal to the corresponding component of the second vector. More...
 
static Vector3 componentCeil (Vector3 v)
 Calculates component-wise ceil value for all elements and returns resulting vector. More...
 
static Vector3 componentFloor (Vector3 v)
 Calculates component-wise floor value for all elements and returns resulting vector. More...
 
static Vector3 componentRound (Vector3 v)
 Calculates component-wise rounded value for all elements and returns resulting vector. More...
 
static Vector3 componentSqrt (Vector3 v)
 Calculates component-wise square root all elements and returns resulting vector. More...
 
static Vector3 componentSubtract (Vector3 v, float scalar)
 Subtracts a value from all elements of a vector and returns the result. More...
 
static Vector3 componentWiseDivide (Vector3 v1, Vector3 v2)
 Divides component-wise all vector elements and returns the resulting vector. More...
 
static Vector3 componentWiseMax (Vector3 v1, Vector3 v2)
 Calculates the component-wise maximum for all vector elements and returns the resulting vector. More...
 
static Vector3 componentWiseMin (Vector3 v1, Vector3 v2)
 Calculates the component-wise minimum for all vector elements and returns the resulting vector. More...
 
static Vector3 componentWiseMultiply (Vector3 v1, Vector3 v2)
 Multiplies component-wise all vector elements and returns the resulting vector. More...
 
static Vector3 componentWiseRemainder (Vector3 v1, Vector3 v2)
 Calculates component-wise the remainder for all vector elements and returns the resulting vector. More...
 
static Vector3 crossProduct (Vector3 v1, Vector3 v2)
 Calculates the cross product of two vectors. More...
 
static Vector3 divide (Vector3 v, float scalar)
 Divides all vector elements with a scalar and returns the resulting vector. More...
 
static float dotProduct (Vector3 v1, Vector3 v2)
 Calculates the dot product of two vectors. More...
 
static Vector3 getOrthogonalVector (Vector3 v)
 Finds a vector that is orthogonal to the given vector. More...
 
static Vector3 highestValue ()
 Returns the vector with each element having the most positive float value. More...
 
static Vector3 linearTosRGB (Vector3 vec)
 Converts to whole Vector3 from linear to sRGB. More...
 
static Vector3 lowestValue ()
 Returns the vector with each element having the most negative float value. More...
 
static Vector3 multiply (float scalar, Vector3 v)
 Multiplies all vector elements with a scalar and returns the resulting vector. More...
 
static Vector3 multiply (Vector3 v, float scalar)
 Multiplies all vector elements with a scalar and returns the resulting vector. More...
 
static Vector3 nan ()
 Returns the vector with each element being NaN. More...
 
static Vector3 negate (Vector3 v)
 Negates all vector elements and returns the resulting vector. More...
 
static Vector3 negativeInfinity ()
 Returns the vector with each element being the negative infinity. More...
 
static Vector3 negativeX ()
 Returns the unit vector pointing left. More...
 
static Vector3 negativeY ()
 Returns the unit vector pointing down. More...
 
static Vector3 negativeZ ()
 Returns the unit vector pointing forward. More...
 
static Vector3 one ()
 Returns the vector with each element being one. More...
 
static Vector3 positiveInfinity ()
 Returns the vector with each element being the positive infinity. More...
 
static Vector3 positiveX ()
 Returns the unit vector pointing right. More...
 
static Vector3 positiveY ()
 Returns the unit vector pointing up. More...
 
static Vector3 positiveZ ()
 Returns the unit vector pointing backward. More...
 
static Vector3 sRGBToLinear (Vector3 vec)
 Converts to whole Vector3 from sRGB to linear. More...
 
static Vector3 subtract (Vector3 v1, Vector3 v2)
 Subtracts two vectors and returns the difference. More...
 
static Vector3 zero ()
 Returns the vector with each element being zero. More...
 

Protected Member Functions

void finalize ()
 Called by the garbage collector on an object when garbage collection determines that there are no more references to the object. More...
 

Protected Attributes

transient boolean swigCMemOwn
 Does this object own its native object. More...
 

Detailed Description

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

Constructor & Destructor Documentation

Vector3 ( float  x,
float  y,
float  z 
)

Constructor, initializes the vector to (x, y, z).


Parameters
xx component of the vector.
yy component of the vector.
zz component of the vector.
Vector3 ( float  v)

Constructor, initializes the vector to (v, v, v).


Parameters
vx, y and z components of the vector.

Member Function Documentation

Vector3 add ( float  scalar)

Adds a scalar to each vector element.


Parameters
scalarAddition to each vector element.
Returns
This vector.
Vector3 add ( Vector3  v)

Modifies this vector by adding another vector.


Parameters
vAnother vector.
Returns
This vector.
static Vector3 add ( float  scalar,
Vector3  v 
)
static

Adds a scalar and a vector and returns the sum.

Parameters
scalarLeft hand side scalar.
vRight hand side vector.
Returns
The result vector.
static Vector3 add ( Vector3  v,
float  scalar 
)
static

Adds a vector and a scalar and returns the sum.

Parameters
vLeft hand side vector.
scalarRight hand side scalar.
Returns
The result vector.
static Vector3 add ( Vector3  v1,
Vector3  v2 
)
static

Adds two vectors and returns the sum.

Parameters
v1Left hand side vector.
v2Right hand side vector.
Returns
The result vector.
static Vector3 componentAbs ( Vector3  v)
static

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


Parameters
vVector input.
Returns
The result vector.
static Vector3 componentAdd ( Vector3  v,
float  scalar 
)
static

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


Parameters
vA vector.
scalarA scalar.
Returns
The result vector.
static boolean componentAllGreaterThan ( Vector3  a,
Vector3  b 
)
static

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


Parameters
aFirst vector.
bSecond vector.
Returns
If each component of the first vector is greater than the corresponding component of the second vector, true, otherwise false.
static boolean componentAllGreaterThanOrEqual ( Vector3  a,
Vector3  b 
)
static

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


Parameters
aFirst vector.
bSecond 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.
static boolean componentAllLessThan ( Vector3  a,
Vector3  b 
)
static

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


Parameters
aFirst vector.
bSecond vector.
Returns
If each component of the first vector is less than the corresponding component of the second vector, true, otherwise false.
static boolean componentAllLessThanOrEqual ( Vector3  a,
Vector3  b 
)
static

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


Parameters
aFirst vector.
bSecond 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.
static Vector3 componentCeil ( Vector3  v)
static

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


Parameters
vVector input.
Returns
The result vector.
static Vector3 componentFloor ( Vector3  v)
static

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


Parameters
vVector input.
Returns
The result vector.
static Vector3 componentRound ( Vector3  v)
static

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


Parameters
vVector input.
Returns
The result vector.
static Vector3 componentSqrt ( Vector3  v)
static

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


Parameters
vVector input.
Returns
The result vector.
static Vector3 componentSubtract ( Vector3  v,
float  scalar 
)
static

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


Parameters
vA vector.
scalarA scalar.
Returns
The result vector.
static Vector3 componentWiseDivide ( Vector3  v1,
Vector3  v2 
)
static

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


Parameters
v1The first vector.
v2The second vector.
Returns
The result vector.
static Vector3 componentWiseMax ( Vector3  v1,
Vector3  v2 
)
static

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


Parameters
v1The first vector.
v2The second vector.
Returns
The result vector.
static Vector3 componentWiseMin ( Vector3  v1,
Vector3  v2 
)
static

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


Parameters
v1The first vector.
v2The second vector.
Returns
The result vector.
static Vector3 componentWiseMultiply ( Vector3  v1,
Vector3  v2 
)
static

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


Parameters
v1The first vector.
v2The second vector.
Returns
The result vector.
static Vector3 componentWiseRemainder ( Vector3  v1,
Vector3  v2 
)
static

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


Parameters
v1The first vector.
v2The second vector.
Returns
The result vector.
static Vector3 crossProduct ( Vector3  v1,
Vector3  v2 
)
static

Calculates the cross product of two vectors.


Parameters
v1The first vector.
v2The second vector.
Returns
The cross product of the vectors.
Vector3 divide ( float  scalar)

Divides each vector element with a scalar.


Parameters
scalarDivider for each vector element.
Returns
This vector.
static Vector3 divide ( Vector3  v,
float  scalar 
)
static

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

Parameters
vA vector.
scalarA scalar.
Returns
The result vector.
static float dotProduct ( Vector3  v1,
Vector3  v2 
)
static

Calculates the dot product of two vectors.


Parameters
v1The first vector.
v2The second vector.
Returns
The dot product of the vectors.
boolean equals ( Object  obj)

Indicates whether some other object is "equal to" this one.

Parameters
objThe reference object with which to compare.
Returns
True if this object is the same as the obj argument, otherwise false.
void finalize ( )
protected

Called by the garbage collector on an object when garbage collection determines that there are no more references to the object.

Finalization is deprecated and subject to removal in future.

float get ( int  index)

Returns the vector element value at index.


Returns
The vector element value at index.
static Vector3 getOrthogonalVector ( Vector3  v)
static

Finds a vector that is orthogonal to the given vector.


Parameters
vSource vector. Length must be 1.
Returns
Vector orthogonal to the source vector. Not necessarily of unit length.
float getX ( )

Returns the x element of the vector.


Returns
The x element.
float getY ( )

Returns the y element of the vector.


Returns
The y element.
float getZ ( )

Returns the z element of the vector.


Returns
The z element.
int hashCode ( )

Returns a hash code value for the object.

Returns
A hash code value for this object.
static Vector3 highestValue ( )
static

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


Returns
Vector with the highest possible value.
float length ( )

Calculates the length a vectors.


Returns
sqrt(x*x + y*y + z*z)
static Vector3 linearTosRGB ( Vector3  vec)
static

Converts to whole Vector3 from linear to sRGB.


Since linear-to-sRGB conversion does not take alpha into account, it is possible to interpret Vector3 as just the RGB components.

Parameters
vecVector3 representing color in linear format.
Returns
Vector3 representing color in sRGB format.
static Vector3 lowestValue ( )
static

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


Returns
Vector with the lowest possible value.
Vector3 maximumAxis ( )

Returns axis based on the largest component of Vector3.


Returns
If X component is largest, (1, 0, 0), else if Y component is largest, (0, 1, 0), else (0, 0, 1).
Vector3 minimumAxis ( )

Returns axis based on the minimum component of Vector3.


Returns
If X component is smallest, (1, 0, 0), else if Y component is smallest, (0, 1, 0), else (0, 0, 1).
Vector3 multiply ( float  scalar)

Multiplies each vector element with a scalar.


Parameters
scalarMultiplier for each vector element.
Returns
This vector.
static Vector3 multiply ( float  scalar,
Vector3  v 
)
static

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

Parameters
scalarA scalar.
vA vector.
Returns
The result vector.
static Vector3 multiply ( Vector3  v,
float  scalar 
)
static

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

Parameters
vA vector.
scalarA scalar.
Returns
The result vector.
static Vector3 nan ( )
static

Returns the vector with each element being NaN.


Returns
Vector with NaN elements.
static Vector3 negate ( Vector3  v)
static

Negates all vector elements and returns the resulting vector.

Parameters
vA vector.
Returns
The result vector.
static Vector3 negativeInfinity ( )
static

Returns the vector with each element being the negative infinity.


Returns
Vector with negative infinity elements.
static Vector3 negativeX ( )
static

Returns the unit vector pointing left.


Returns
Vector3(-1.0f, 0.0f, 0.0f).
static Vector3 negativeY ( )
static

Returns the unit vector pointing down.


Returns
Vector3(0.0f, -1.0f, 0.0f).
static Vector3 negativeZ ( )
static

Returns the unit vector pointing forward.


Returns
Vector3(0.0f, 0.0f, -1.0f).
Vector3 normalized ( )

Normalizes the vector and returns the resulting vector.


Returns
The normalized vector.
static Vector3 one ( )
static

Returns the vector with each element being one.


Returns
Vector with unit element values.
static Vector3 positiveInfinity ( )
static

Returns the vector with each element being the positive infinity.


Returns
Vector with positive infinity elements.
static Vector3 positiveX ( )
static

Returns the unit vector pointing right.


Returns
Vector3(1.0f, 0.0f, 0.0f).
static Vector3 positiveY ( )
static

Returns the unit vector pointing up.


Returns
Vector3(0.0f, 1.0f, 0.0f).
static Vector3 positiveZ ( )
static

Returns the unit vector pointing backward.


Returns
Vector3(0.0f, 0.0f, 1.0f).
void set ( int  index,
float  value 
)

Sets the vector element at index to value.


Parameters
indexVector element index to set.
valueValue to set.
void setX ( float  value)

Sets the x element of the vector.


Parameters
valueThe new value of the x element.
void setY ( float  value)

Sets the y element of the vector.


Parameters
valueThe new value of the y element.
void setZ ( float  value)

Sets the z element of the vector.


Parameters
valueThe new value of the z element.
float squaredLength ( )

Calculates the squared length a vectors.


Returns
x*x + y*y + z*z
static Vector3 sRGBToLinear ( Vector3  vec)
static

Converts to whole Vector3 from sRGB to linear.


Since sRGB-to-linear conversion does not take alpha into account, it is possible to interpret Vector3 as just the RGB components.

Parameters
vecVector3 representing color in sRGB format.
Returns
Vector3 representing color in linear format.
Vector3 subtract ( Vector3  v)

Modifies this vector by subtracting another vector from this vector.


Parameters
vAnother vector.
Returns
This vector.
static Vector3 subtract ( Vector3  v1,
Vector3  v2 
)
static

Subtracts two vectors and returns the difference.

Parameters
v1Left hand side vector.
v2Right hand side vector.
Returns
The result vector.
static Vector3 zero ( )
static

Returns the vector with each element being zero.


Returns
Vector with zeroed elements.

Member Data Documentation

transient boolean swigCMemOwn
protected

Does this object own its native object.