Unigine::Math::dvec2 Struct

Header:

#include <UnigineMathLib.h>

This class represents a vector of 2 double components.

Methods:

Name	Description View: Sort by:
dvec2	Constructor.
set	Sets the vector by components.
get	Gets the vector: val[0]=x, val[1]=y.
length	Returns the length of the vector.
length2	Returns the squared length of the vector.
normalize	Returns normalized vector.
operator __m128d	Performs type conversion to __m128d.
operator const double *	Performs type conversion to const double *.
operator const void *	Performs type conversion to const void *.
operator double *	Performs type conversion to double *.
operator void *	Performs type conversion to void *.
*operator =**	Performs scalar multiplication.
operator +=	Performs vector addition.
operator -	Performs vector negation.
operator -=	Performs vector subtraction.
operator /=	Performs componentwise division of the vector by the scalar.
operator =	Sets the vector using a given 128-bit variable as a source.
operator []	Performs array access to the vector item reference by using given item index.
sse	Sets the vector using a given 128-bit variable as a source.

Variables:

Name	Description
EPS	Vector, filled with epsilon constant (1e-6f).
INF	Vector, filled with infinity constant (1e+9f).
ONE	Vector, filled with ones (1).
ZERO	Vector, filled with zeros (0).

dvec2 Class

Members

dvec2 ( const __m128d & v ) #

Constructor. Initializes the vector using a given 128-bit variable as a source.

NoticeWe do not recommend to use this method unless you have a clear understanding of SSE2.

Arguments

const __m128d & v - 128-bit variable.

dvec2 ( const hvec2 & v ) #

Constructor. Initializes the vector using a given hvec2 source vector.

Arguments

const hvec2 & v - Source vector.

dvec2 ( ) #

Default constructor. Produces a zero vector.

dvec2 ( const dvec2 & v ) #

Constructor. Initializes the vector by copying a given source vector.

Arguments

const dvec2 & v - Source vector.

dvec2 ( double x, double y ) #

Constructor. Initializes the vector using given double values.

Arguments

double x - X component of the vector.
double y - Y component of the vector.

Examples

Source code (UnigineScript)

dvec2(2.0, 3.0);
/*
Creates a vector (2.0, 3.0)
*/

explicit dvec2 ( double v ) #

Constructor. Initializes the vector using a given scalar value: x=v, y=v.

Arguments

double v - Scalar value.

Examples

Source code (UnigineScript)

dvec2(1.0);
/*
Creates a vector (1.0, 1.0)
*/

explicit dvec2 ( const dvec3 & v ) #

Constructor. Initializes the vector using a given three-component vec3 vector: x=v.x, y=v.y.

Arguments

const dvec3 & v - Three-component source vector.

explicit dvec2 ( const dvec4 & v ) #

Constructor. Initializes the vector using a given four-component vec4 source vector: x=v.x, y=v.y.

Arguments

const dvec4 & v - Four-component source vector.

explicit dvec2 ( const vec2 & v ) #

Constructor. Initializes the vector using a given vec2 source vector.

Arguments

const vec2 & v - Source vector.

explicit dvec2 ( const ivec2 & v ) #

Constructor. Initializes the vector using a given ivec2 source vector.

Arguments

const ivec2 & v - Source vector.

explicit dvec2 ( const double * v ) #

Constructor. Initializes the vector using a given pointer to the array of double elements: x=v[0], y=v[1].

Arguments

const double * v - Pointer to the array of double elements.

void set ( double x_, double y_ ) #

Sets the vector by components.

Arguments

double x_ - X component of the vector.
double y_ - Y component of the vector.

void set ( const double * val ) #

Sets the vector using the array of double elements: x=val[0], y=val[1].

Arguments

const double * val - Pointer to the array of double elements.

void set ( double val ) #

Sets the vector components equal to specified scalar value: x=val, y=val.

Arguments

double val - Scalar value.

void set ( const dvec2 & val ) #

Sets the vector equal to the specified source vector.

Arguments

const dvec2 & val - Source vector.

void get ( const double * val ) const#

Gets the vector: val[0]=x, val[1]=y.

Arguments

const double * val - Pointer to the array of double elements.

const double * get ( ) #

Returns the pointer to the vector.

Return value

Pointer to the vector.

const double * get ( ) const#

Returns the constant pointer to the vector.

Return value

Pointer to the vector.

double length ( ) #

Returns the length of the vector.

Return value

Vector length.

double length2 ( ) #

Returns the squared length of the vector.

Return value

Squared length of the vector.

const dvec2 & normalize ( ) #

Returns normalized vector.

Return value

Normalized vector.

m128d operator m128d ( ) #

Performs type conversion to __m128d.

NoticeWe do not recommend to use this method unless you have a clear understanding of SSE2.

const double * operator const double * ( ) #

Performs type conversion to const double *.

const void * operator const void * ( ) #

Performs type conversion to const void *.

double * operator double * ( ) #

Performs type conversion to double *.

void * operator void * ( ) #

Performs type conversion to void *.

const dvec2 & operator*= ( double val ) #

Performs scalar multiplication.

Arguments

double val - Scalar value.

Return value

Resulting vector.

const dvec2 & operator*= ( const dvec2 & val ) #

Performs vector multiplication.

Arguments

const dvec2 & val - Vector.

Return value

Resulting vector.

const dvec2 & operator+= ( const dvec2 & val ) #

Performs vector addition.

Arguments

const dvec2 & val - Vector.

Return value

Resulting vector.

dvec2 operator- ( ) const#

Performs vector negation.

Return value

Resulting vector.

const dvec2 & operator-= ( const dvec2 & val ) #

Performs vector subtraction.

Arguments

const dvec2 & val - Vector.

Return value

Resulting vector.

dvec2 & operator/= ( double val ) #

Performs componentwise division of the vector by the scalar. Implemented using the calculation of inverse scalar value with subsequent by-component multiplication.

Arguments

double val - Scalar value.

Return value

Resulting vector.

Examples

Source code (UnigineScript)

dvec2 a = dvec2(6.0, 10.0);
a /= 2.0;
/*
Initial value of vector a:
	a (6.0, 10.0)

	a /= 2.0;
Vector a after operation:	
	a (3.0, 5.0)	
*/

const dvec2 & operator/= ( const dvec2 & val ) #

Performs componentwise division of vectors.

Arguments

const dvec2 & val - Vector.

Return value

Resulting vector.

Examples

Source code (UnigineScript)

dvec2 a, b;
a = dvec2(6.0, 10.0);
b = dvec2(2.0, 5.0);
a /= b;
/*
Initial values of vectors a and b:
	a (6.0, 10.0)
	b (2.0, 5.0)

	a /= b;
Vector a after operation:	
	a (3.0, 2.0)	
*/

dvec2 & operator= ( const __m128d & val ) #

Sets the vector using a given 128-bit variable as a source.

NoticeWe do not recommend to use this method unless you have a clear understanding of SSE2.

Arguments

const __m128d & val - 128-bit variable.

Return value

Vector.

dvec2 & operator= ( const dvec2 & val ) #

Performs vector assignment. Destination vector = Source vector.

Arguments

const dvec2 & val - Source vector.

Return value

Result.

double & operator[] ( int i ) #

Performs array access to the vector item reference by using given item index.

Arguments

int i - Vector item index.

Return value

Vector item reference.

double operator[] ( int i ) const#

Performs array access to the vector item by using given item index.

Arguments

int i - Vector item index.

Return value

Vector item.

void sse ( const __m128d & val ) #

Sets the vector using a given 128-bit variable as a source.

NoticeWe do not recommend to use this method unless you have a clear understanding of SSE2.

Arguments

const __m128d & val - 128-bit variable.

__m128d sse ( ) #

Returns vector components as a 128-bit variable.

NoticeWe do not recommend to use this method unless you have a clear understanding of SSE2.

Return value

128-bit variable.

Last update: 2020-07-31

Help improve this article

Was this article helpful?

Report a problem related to this article

(or select a word/phrase and press Ctrl+Enter)

Unigine::Math::dvec2 Struct

Methods:

Variables:

dvec2 Class

Members

dvec2 ( const __m128d & v ) #

Arguments

dvec2 ( const hvec2 & v ) #

Arguments

dvec2 ( ) #

dvec2 ( const dvec2 & v ) #

Arguments

dvec2 ( double x, double y ) #

Arguments

Examples

explicit dvec2 ( double v ) #

Arguments

Examples

explicit dvec2 ( const dvec3 & v ) #

Arguments

explicit dvec2 ( const dvec4 & v ) #

Arguments

explicit dvec2 ( const vec2 & v ) #

Arguments

explicit dvec2 ( const ivec2 & v ) #

Arguments

explicit dvec2 ( const double * v ) #

Arguments

void set ( double x_, double y_ ) #

Arguments

void set ( const double * val ) #

Arguments

void set ( double val ) #

Arguments

void set ( const dvec2 & val ) #

Arguments

void get ( const double * val ) const#

Arguments

const double * get ( ) #

Return value

const double * get ( ) const#

Return value

double length ( ) #

Return value

double length2 ( ) #

Return value

const dvec2 & normalize ( ) #

Return value

__m128d operator __m128d ( ) #

const double * operator const double * ( ) #

const void * operator const void * ( ) #

double * operator double * ( ) #

void * operator void * ( ) #

const dvec2 & operator*= ( double val ) #

Arguments

Return value

const dvec2 & operator*= ( const dvec2 & val ) #

Arguments

Return value

const dvec2 & operator+= ( const dvec2 & val ) #

Arguments

Return value

dvec2 operator- ( ) const#

Return value

const dvec2 & operator-= ( const dvec2 & val ) #

Arguments

Return value

dvec2 & operator/= ( double val ) #

Arguments

Return value

Examples

const dvec2 & operator/= ( const dvec2 & val ) #

Arguments

Return value

Examples

dvec2 & operator= ( const __m128d & val ) #

Arguments

Return value

dvec2 & operator= ( const dvec2 & val ) #

Arguments

m128d operator m128d ( ) #