Vec2< T, STRIDE, SPACE > Struct Template Reference

#include <vec2.h>

Detailed Description

template<typename T, Int STRIDE = 1, typename SPACE = void>
struct maxon::Vec2< T, STRIDE, SPACE >

A vector consisting of two components X and Y.

Public Types
template<typename U >
using	Rebind = Vec2< U, STRIDE, SPACE >
using	VectorStrideType = std::integral_constant< Int, STRIDE >
using	ValueType = T
using	ValueTypeParam = typename ByValueParam< T >::type
using	Unstrided = Vec2< T, 1, SPACE >
using	BoolType = decltype(T()==T())

Public Member Functions
constexpr	Vec2 ()
constexpr	Vec2 (ValueTypeParam in)
constexpr	Vec2 (ValueTypeParam ix, ValueTypeParam iy)
template<typename T2 , Int S2>
constexpr	Vec2 (const Vec2< T2, S2, SPACE > &v)
template<Int S2>
constexpr	Vec2 (const Vec2< T, S2, SPACE > &v)
template<typename T2 , Int S2>
constexpr	Vec2 (const Vec3< T2, S2 > &v)
constexpr	Vec2 (ENUM_DONT_INITIALIZE v)
constexpr MAXON_IMPLICIT	Vec2 (const typename std::conditional< STRIDE==1, DummyParamType, Vec2 >::type &src)
Vec2 &	operator= (const typename std::conditional< STRIDE==1, DummyParamType, Vec2 >::type &src)
T &	operator[] (Int l)
ValueTypeParam	operator[] (Int l) const
template<typename T2 , Int S2>
Vec2 &	operator+= (const Vec2< T2, S2, SPACE > &v)
Vec2 &	operator+= (const Vec2 &v)
template<typename T2 , Int S2>
Vec2 &	operator-= (const Vec2< T2, S2, SPACE > &v)
Vec2 &	operator-= (const Vec2 &v)
template<typename T2 , Int S2>
Vec2 &	operator*= (const Vec2< T2, S2, SPACE > &v)
Vec2 &	operator*= (const Vec2 &v)
Vec2 &	operator*= (ValueTypeParam s)
Vec2 &	operator/= (ValueTypeParam s)
constexpr Unstrided	operator* (ValueTypeParam s) const
template<typename S >
constexpr Vec2< typename MultiplicativePromotion< T, S, STD_IS_REPLACEMENT(scalar, S)>::type, 1, SPACE >	operator* (S s) const
constexpr Unstrided	operator/ (ValueTypeParam s) const
constexpr Unstrided	operator* (const Vec2 &v) const
constexpr Unstrided	operator+ (const Vec2 &v) const
constexpr Unstrided	operator- (const Vec2 &v) const
constexpr Unstrided	operator- () const
template<typename T2 , Int S2>
constexpr BoolType	operator== (const Vec2< T2, S2, SPACE > &v) const
constexpr BoolType	operator== (const Vec2 &v) const
template<typename T2 , Int S2>
constexpr BoolType	operator!= (const Vec2< T2, S2, SPACE > &v) const
constexpr BoolType	operator!= (const Vec2 &v) const
constexpr BoolType	operator<= (const Vec2 &v) const
constexpr BoolType	operator>= (const Vec2 &v) const
constexpr BoolType	operator< (const Vec2 &v) const
constexpr BoolType	operator> (const Vec2 &v) const
constexpr HashInt	GetHashCode () const
UniqueHash	GetUniqueHashCode () const
BoolType	IsEqual (const Vec2 &other, ValueTypeParam epsilon) const
constexpr BoolType	IsZero () const
void	SetZero ()
constexpr T	GetAverage () const
constexpr T	GetSum () const
void	ClampMin (const Vec2 &other=Vec2())
void	ClampMax (const Vec2 &other)
constexpr Unstrided	Clamp01 () const
T	GetLength () const
constexpr T	GetSquaredLength () const
Unstrided	GetNormalized () const
Unstrided	operator! () const
void	Normalize ()
String	ToString (const FormatStatement *formatStatement=nullptr) const
constexpr T	GetMin () const
constexpr T	GetMax () const
constexpr Unstrided	GetRightRotated (Int rots) const
template<typename T2 >
Vec2 &	operator*= (const Mat2< T2 > &m)

Static Public Member Functions
static MAXON_ATTRIBUTE_FORCE_INLINE const Vec2 &	NullValue ()

Public Attributes
union {
T   x
T   _xpadding [STRIDE]
};
union {
T   y
T   _ypadding [STRIDE]
};

Friends
constexpr friend Unstrided	operator* (ValueTypeParam s, const Vec2 &v)
constexpr friend T	Dot (const Vec2 &v1, const Vec2 &v2)
Unstrided	Abs (const Vec2 &v1)
template<typename T2 , Int S2>
constexpr friend MultiplicativePromotion< T, T2 >::type	Dot (const Vec2 &v1, const Vec2< T2, S2, SPACE > &v2)
constexpr friend Unstrided	Min (const Vec2 &a, const Vec2 &other)
constexpr friend Unstrided	Max (const Vec2 &a, const Vec2 &other)
void	SetMin (Vec2 &a, const Vec2 &other)
void	SetMax (Vec2 &a, const Vec2 &other)
T	GetAngle (const Vec2 &v1, const Vec2 &v2)
constexpr friend Unstrided	Cross (const Vec2 &v1)

Member Typedef Documentation

Rebind

using Rebind = Vec2<U, STRIDE, SPACE>

VectorStrideType

using VectorStrideType = std::integral_constant<Int, STRIDE>

ValueType

using ValueType = T

ValueTypeParam

using ValueTypeParam = typename ByValueParam<T>::type

Unstrided

using Unstrided = Vec2<T, 1, SPACE>

BoolType

using BoolType = decltype(T() == T())

The type returned by comparisons. If the template argument for T is a SIMD type, this will be a SIMD type, too, which contains the per-element results.

Constructor & Destructor Documentation

Vec2() [1/8]

constexpr Vec2 ( )

constexpr

Initializes all vector components with 0.0.

Vec2() [2/8]

constexpr Vec2 ( ValueTypeParam  in )

explicitconstexpr

Initializes all vector components with a scalar.

Vec2() [3/8]

constexpr Vec2 ( ValueTypeParam  ix, ValueTypeParam  iy  )

explicitconstexpr

Initializes all vector components individually.

Vec2() [4/8]

constexpr Vec2 ( const Vec2< T2, S2, SPACE > &  v )

explicitconstexpr

Initializes components from another 2d vector.

Vec2() [5/8]

constexpr Vec2 ( const Vec2< T, S2, SPACE > &  v )

constexpr

Initializes components from another 2d vector.

Vec2() [6/8]

constexpr Vec2 ( const Vec3< T2, S2 > &  v )

explicitconstexpr

Initializes components from a 3d vector. The z-component of v is ignored.

Vec2() [7/8]

constexpr Vec2 ( ENUM_DONT_INITIALIZE  v )

explicitconstexpr

Skips initialization of vector (for better speed)

Vec2() [8/8]

constexpr MAXON_IMPLICIT Vec2 ( const typename std::conditional< STRIDE==1, DummyParamType, Vec2< T, STRIDE, SPACE > >::type &  src )

constexpr

When STRIDE is not 1, we have to provide copy constructor and operator because the default ones would also copy the padding. When STRIDE is 1, we want to avoid to declare them (because then the type wouldn't be trivially copyable any longer), so we use DummyParamType for the parameter in that case.

Member Function Documentation

operator=()

Vec2& operator=

(

const typename std::conditional< STRIDE==1, DummyParamType, Vec2< T, STRIDE, SPACE > >::type &

src

)

Copies the source vector.

Parameters

[in]

src

Source vector.

Returns

*this.

operator[]() [1/2]

T& operator[]

(

Int

l

)

Accesses vector component: index 0 is 'x', index 1 is 'y'. All other values must not be used and will crash.

operator[]() [2/2]

ValueTypeParam operator[]

(

Int

l

)

const

Accesses vector component: index 0 is 'x', index 1 is 'y'. All other values must not be used and will crash.

operator+=() [1/2]

Vec2& operator+=

(

const Vec2< T2, S2, SPACE > &

v

)

Adds two vectors.

operator+=() [2/2]

Vec2& operator+=

(

const Vec2< T, STRIDE, SPACE > &

v

)

Adds a vector. We repeat the function template as non-template function, this allows the usage in contexts where the parameter is not a vector itself, but something with a conversion operator to a vector.

Parameters

[in]

v

Vector to be added.

Returns

*this.

operator-=() [1/2]

Vec2& operator-=

(

const Vec2< T2, S2, SPACE > &

v

)

Subtracts two vectors.

operator-=() [2/2]

Vec2& operator-=

(

const Vec2< T, STRIDE, SPACE > &

v

)

Subtracts a vector. We repeat the function template as non-template function, this allows the usage in contexts where the parameter is not a vector itself, but something with a conversion operator to a vector.

Parameters

[in]

v

Vector to be substracted from this.

Returns

*this.

operator*=() [1/4]

Vec2& operator*=

(

const Vec2< T2, S2, SPACE > &

v

)

Multiplies two vectors component-wise.

operator*=() [2/4]

Vec2& operator*=

(

const Vec2< T, STRIDE, SPACE > &

v

)

Multiplies with vector component-wise. We repeat the function template as non-template function, this allows the usage in contexts where the parameter is not a vector itself, but something with a conversion operator to a vector.

Parameters

[in]

v

Vector to be multiplied with.

Returns

*this.

operator*=() [3/4]

Vec2& operator*=

(

ValueTypeParam

s

)

Multiplies each vector component by a scalar.

operator/=()

Vec2& operator/=

(

ValueTypeParam

s

)

Divides each vector component by a scalar. The passed argument is checked for 0.0.

operator*() [1/3]

constexpr Unstrided operator* ( ValueTypeParam  s ) const

constexpr

Multiplies each vector component by a scalar.

operator*() [2/3]

constexpr Vec2<typename MultiplicativePromotion<T, S, STD_IS_REPLACEMENT(scalar, S)>::type, 1, SPACE> operator* ( S  s ) const

constexpr

Multiplies each vector component by a scalar.

operator/()

constexpr Unstrided operator/ ( ValueTypeParam  s ) const

constexpr

Divides each vector component by a scalar. The scalar value is tested for 0.0.

operator*() [3/3]

constexpr Unstrided operator* ( const Vec2< T, STRIDE, SPACE > &  v ) const

constexpr

Multiplies two vectors component-wise.

operator+()

constexpr Unstrided operator+ ( const Vec2< T, STRIDE, SPACE > &  v ) const

constexpr

Adds two vectors.

operator-() [1/2]

constexpr Unstrided operator- ( const Vec2< T, STRIDE, SPACE > &  v ) const

constexpr

Subtracts vector v2 from v1.

operator-() [2/2]

constexpr Unstrided operator- ( ) const

constexpr

Negates vector v.

operator==() [1/2]

constexpr BoolType operator== ( const Vec2< T2, S2, SPACE > &  v ) const

constexpr

Equality operator. We repeat the function template as non-template function, this allows the usage in contexts where the parameter is not a vector itself, but something with a conversion operator to a vector

Parameters

[in]

v

Comparison vector.

Returns

True if this and v are equal, otherwise false.

operator==() [2/2]

constexpr BoolType operator== ( const Vec2< T, STRIDE, SPACE > &  v ) const

constexpr

Equality operator. We repeat the function template as non-template function, this allows the usage in contexts where the parameter is not a vector itself, but something with a conversion operator to a vector

Parameters

[in]

v

Comparison vector.

Returns

True if this and v are equal, otherwise false.

operator!=() [1/2]

constexpr BoolType operator!= ( const Vec2< T2, S2, SPACE > &  v ) const

constexpr

Inequality operator.

Parameters

[in]

v

Comparison vector.

Returns

False if this and v are equal, otherwise true.

operator!=() [2/2]

constexpr BoolType operator!= ( const Vec2< T, STRIDE, SPACE > &  v ) const

constexpr

Inequality operator. We repeat the function template as non-template function, this allows the usage in contexts where the parameter is not a vector itself, but something with a conversion operator to a vector

Parameters

[in]

v

Comparison vector.

Returns

False if this and v are equal, otherwise true.

operator<=()

constexpr BoolType operator<= ( const Vec2< T, STRIDE, SPACE > &  v ) const

constexpr

Compares this vector with v. Note that this doesn't define a total order but just a partial order, so for a pair of vectors it can happen that neither {v <= w} nor {v >= w}.

Parameters

[in]

v

Comparison vector.

Returns

True if this.c <= v.c for all components c of the vectors, false otherwise.

operator>=()

constexpr BoolType operator>= ( const Vec2< T, STRIDE, SPACE > &  v ) const

constexpr

Compares this vector with v. Note that this doesn't define a total order but just a partial order, so for a pair of vectors it can happen that neither {v <= w} nor {v >= w}.

Parameters

[in]

v

Comparison vector.

Returns

True if this.c >= v.c for all components c of the vectors, false otherwise.

operator<()

constexpr BoolType operator< ( const Vec2< T, STRIDE, SPACE > &  v ) const

constexpr

Compares this vector with v. Note that this doesn't define a total order but just a partial order, so for a pair of vectors it can happen that neither {v < w} nor {v > w} nor {v == w}. Also note that {v < w} is not the same as {v <= w && v != w}.

Parameters

[in]

v

Comparison vector.

Returns

True if this.c < v.c for all components c of the vectors, false otherwise.

operator>()

constexpr BoolType operator> ( const Vec2< T, STRIDE, SPACE > &  v ) const

constexpr

Compares this vector with v. Note that this doesn't define a total order but just a partial order, so for a pair of vectors it can happen that neither {v < w} nor {v > w} nor {v == w}. Also note that {v > w} is not the same as {v >= w && v != w}.

Parameters

[in]

v

Comparison vector.

Returns

True if this.c > v.c for all components c of the vectors, false otherwise.

GetHashCode()

constexpr HashInt GetHashCode ( ) const

constexpr

Returns the hash code of the vector (used for hash maps and comparisons).

Returns

The vector's hash code.

GetUniqueHashCode()

UniqueHash GetUniqueHashCode

(

)

const

IsEqual()

BoolType IsEqual	(	const Vec2< T, STRIDE, SPACE > &	other,
		ValueTypeParam	epsilon
	)		const

Tests component-wise if the difference is no bigger than 'epsilon'.

IsZero()

constexpr BoolType IsZero ( ) const

constexpr

Checks if each component is zero.

SetZero()

void SetZero

(

)

Sets all components to zero.

GetAverage()

constexpr T GetAverage ( ) const

constexpr

Calculates the average value of 'x', 'y' and 'z'.

GetSum()

constexpr T GetSum ( ) const

constexpr

Calculates the sum of 'x', 'y' and 'z'.

ClampMin()

void ClampMin

(

const Vec2< T, STRIDE, SPACE > &

other = Vec2< T, STRIDE, SPACE >()

)

Set the minimum of each component.

ClampMax()

void ClampMax

(

const Vec2< T, STRIDE, SPACE > &

other

)

Set the maximum of each component.

Clamp01()

constexpr Unstrided Clamp01 ( ) const

constexpr

Returns a vector that is clamped to the range [0.0 .. 1.0].

GetLength()

T GetLength

(

)

const

Returns the length of the vector.

GetSquaredLength()

constexpr T GetSquaredLength ( ) const

constexpr

Returns the squared length of the vector.

GetNormalized()

Unstrided GetNormalized

(

)

const

Returns a normalized vector, so that GetLength(vector)==1.0.

operator!()

Unstrided operator!

(

)

const

Returns a normalized vector, so that GetLength(vector)==1.0.

Normalize()

void Normalize

(

)

Normalizes this vector, so that GetLength()==1.0.

ToString()

String ToString

(

const FormatStatement *

formatStatement = nullptr

)

const

Returns a readable string of the content.

Parameters

[in]

formatStatement

Nullptr or additional formatting instruction. See also Formatting Floating point values.

Returns

The converted result.

GetMin()

constexpr T GetMin ( ) const

constexpr

Returns the minimum of 'x' and 'y'.

GetMax()

constexpr T GetMax ( ) const

constexpr

Returns the maximum of 'x' and 'y'.

GetRightRotated()

constexpr Unstrided GetRightRotated ( Int  rots ) const

constexpr

Returns a vector where the components have been rotated to the right (in the usual (x, y)-representation). E.g., with a value of 1 for rots, the result will be (y, x).

Parameters

[in]

rots

Number of rotations, may be negative. The result depends only on the number modulo 2.

Returns

Vector with rotated components.

operator*=() [4/4]

Vec2& operator*=

(

const Mat2< T2 > &

m

)

Transforms point by a matrix.

NullValue()

static MAXON_ATTRIBUTE_FORCE_INLINE const Vec2& NullValue ( )

static

Returns a null value of the vector (see nullvalue.h for more details).

Returns

A null value of the vector.

Friends And Related Function Documentation

operator*

constexpr friend Unstrided operator* ( ValueTypeParam  s, const Vec2< T, STRIDE, SPACE > &  v  )

friend

Multiplies each vector component by a scalar.

Dot [1/2]

constexpr friend T Dot ( const Vec2< T, STRIDE, SPACE > &  v1, const Vec2< T, STRIDE, SPACE > &  v2  )

friend

Calculates dot product of v1 and v2.

Abs

Unstrided Abs ( const Vec2< T, STRIDE, SPACE > &  v1 )

friend

returns the vector with absolute value for each entry

Parameters

[in]

v1

input vector to work on

Returns

component wise absolute value vector of input vector

Dot [2/2]

constexpr friend MultiplicativePromotion<T, T2>::type Dot ( const Vec2< T, STRIDE, SPACE > &  v1, const Vec2< T2, S2, SPACE > &  v2  )

friend

Calculates dot product of v1 and v2.

Min

constexpr friend Unstrided Min ( const Vec2< T, STRIDE, SPACE > &  a, const Vec2< T, STRIDE, SPACE > &  other  )

friend

Calculates the minimum of each component.

Max

constexpr friend Unstrided Max ( const Vec2< T, STRIDE, SPACE > &  a, const Vec2< T, STRIDE, SPACE > &  other  )

friend

Calculates the maximum of each component.

SetMin

void SetMin ( Vec2< T, STRIDE, SPACE > &  a, const Vec2< T, STRIDE, SPACE > &  other  )

friend

Set the minimum of each component.

SetMax

void SetMax ( Vec2< T, STRIDE, SPACE > &  a, const Vec2< T, STRIDE, SPACE > &  other  )

friend

Set the maximum of each component.

GetAngle

T GetAngle ( const Vec2< T, STRIDE, SPACE > &  v1, const Vec2< T, STRIDE, SPACE > &  v2  )

friend

Calculates angle (in radians) between v1 and v2.

Cross

constexpr friend Unstrided Cross ( const Vec2< T, STRIDE, SPACE > &  v1 )

friend

Calculates the cross product of a 2d vector. This is the vector (Y, -X), i.e., the clockwise rotation by 90 degrees.

Member Data Documentation

x

T x

_xpadding

T _xpadding[STRIDE]

union { ... }

y

T y

_ypadding

T _ypadding[STRIDE]

union { ... }