MeshLib C++ Docs
Loading...
Searching...
No Matches
Public Types | Public Member Functions | Static Public Member Functions | Public Attributes | Static Public Attributes | Friends | List of all members
MR::Vector3< T > Struct Template Reference
Math group » Vector

#include <MRVector3.h>

Public Types

using ValueType = T
 
using MatrixType = Matrix3<T>
 
using SymMatrixType = SymMatrix3<T>
 

Public Member Functions

constexpr Vector3 () noexcept
 
 Vector3 (NoInit) noexcept
 
constexpr Vector3 (T x, T y, T z) noexcept
 
constexpr Vector3 (const Vector2< T > &v) noexcept
 
template<typename U >
constexpr Vector3 (const Vector3< U > &v) noexcept
 
constexpr const T & operator[] (int e) const noexcept
 
constexpr T & operator[] (int e) noexcept
 
T lengthSq () const
 
auto length () const
 
Vector3 normalized () const
 
Vector3 furthestBasisVector () const
 returns one of 3 basis unit vector that makes the biggest angle with the direction specified by this
 
std::pair< Vector3, Vector3 > perpendicular () const
 
template<MR_SAME_TYPE_TEMPLATE_PARAM(T, TT) >
Vector3 transformed (const AffineXf3< TT > *xf) const
 returns this vector transformed by xf if it is
 
void unsignZeroValues ()
 get rid of signed zero values to be sure that equal vectors have identical binary representation
 
bool isFinite () const
 

Static Public Member Functions

static constexpr Vector3 diagonal (T a) noexcept
 
static constexpr Vector3 plusX () noexcept
 
static constexpr Vector3 plusY () noexcept
 
static constexpr Vector3 plusZ () noexcept
 
static constexpr Vector3 minusX () noexcept
 
static constexpr Vector3 minusY () noexcept
 
static constexpr Vector3 minusZ () noexcept
 

Public Attributes

T x
 
T y
 
T z
 

Static Public Attributes

static constexpr int elements = 3
 

Friends

constexpr bool operator== (const Vector3< T > &a, const Vector3< T > &b)
 
constexpr bool operator!= (const Vector3< T > &a, const Vector3< T > &b)
 
constexpr const Vector3< T > & operator+ (const Vector3< T > &a)
 
constexpr auto operator- (const Vector3< T > &a) -> Vector3< decltype(-std::declval< T >())>
 
constexpr auto operator+ (const Vector3< T > &a, const Vector3< T > &b) -> Vector3< decltype(std::declval< T >()+std::declval< T >())>
 
constexpr auto operator- (const Vector3< T > &a, const Vector3< T > &b) -> Vector3< decltype(std::declval< T >() - std::declval< T >())>
 
constexpr auto operator* (T a, const Vector3< T > &b) -> Vector3< decltype(std::declval< T >() *std::declval< T >())>
 
constexpr auto operator* (const Vector3< T > &b, T a) -> Vector3< decltype(std::declval< T >() *std::declval< T >())>
 
constexpr auto operator/ (Vector3< T > b, T a) -> Vector3< decltype(std::declval< T >()/std::declval< T >())>
 
constexpr Vector3< T > & operator+= (Vector3< T > &a, const Vector3< T > &b)
 
constexpr Vector3< T > & operator-= (Vector3< T > &a, const Vector3< T > &b)
 
constexpr Vector3< T > & operator*= (Vector3< T > &a, T b)
 
constexpr Vector3< T > & operator/= (Vector3< T > &a, T b)
 

Related Symbols

(Note that these are not member symbols.)

template<typename T >
T distanceSq (const Vector3< T > &a, const Vector3< T > &b)
 squared distance between two points, which is faster to compute than just distance
 
template<typename T >
T distance (const Vector3< T > &a, const Vector3< T > &b)
 distance between two points, better use distanceSq for higher performance
 
template<typename T >
Vector3< T > cross (const Vector3< T > &a, const Vector3< T > &b)
 cross product
 
template<typename T >
auto dot (const Vector3< T > &a, const Vector3< T > &b) -> decltype(a.x *b.x)
 dot product
 
template<typename T >
T sqr (const Vector3< T > &a)
 squared length
 
template<typename T >
T mixed (const Vector3< T > &a, const Vector3< T > &b, const Vector3< T > &c)
 mixed product
 
template<typename T >
Vector3< T > mult (const Vector3< T > &a, const Vector3< T > &b)
 per component multiplication
 
template<typename T >
Vector3< T > div (const Vector3< T > &a, const Vector3< T > &b)
 per component division
 
template<typename T >
T angle (const Vector3< T > &a, const Vector3< T > &b)
 
template<typename T >
Vector3< T > unitVector3 (T azimuth, T altitude)
 returns a point on unit sphere given two angles
 

Detailed Description

template<typename T>
struct MR::Vector3< T >

three-dimensional vector

Member Typedef Documentation

◆ MatrixType

template<typename T >
using MR::Vector3< T >::MatrixType = Matrix3<T>

◆ SymMatrixType

template<typename T >
using MR::Vector3< T >::SymMatrixType = SymMatrix3<T>

◆ ValueType

template<typename T >
using MR::Vector3< T >::ValueType = T

Constructor & Destructor Documentation

◆ Vector3() [1/5]

template<typename T >
MR::Vector3< T >::Vector3 ( )
inlineconstexprnoexcept

◆ Vector3() [2/5]

template<typename T >
MR::Vector3< T >::Vector3 ( NoInit )
inlineexplicitnoexcept

◆ Vector3() [3/5]

template<typename T >
MR::Vector3< T >::Vector3 ( T x,
T y,
T z )
inlineconstexprnoexcept

◆ Vector3() [4/5]

template<typename T >
MR::Vector3< T >::Vector3 ( const Vector2< T > & v)
inlineexplicitconstexprnoexcept

◆ Vector3() [5/5]

template<typename T >
template<typename U >
MR::Vector3< T >::Vector3 ( const Vector3< U > & v)
inlineexplicitconstexprnoexcept

Member Function Documentation

◆ diagonal()

template<typename T >
static constexpr Vector3 MR::Vector3< T >::diagonal ( T a)
inlinestaticconstexprnoexcept

◆ furthestBasisVector()

template<typename T >
Vector3 MR::Vector3< T >::furthestBasisVector ( ) const

returns one of 3 basis unit vector that makes the biggest angle with the direction specified by this

◆ isFinite()

template<typename T >
bool MR::Vector3< T >::isFinite ( ) const
inlinenodiscard

◆ length()

template<typename T >
auto MR::Vector3< T >::length ( ) const
inline

◆ lengthSq()

template<typename T >
T MR::Vector3< T >::lengthSq ( ) const
inline

◆ minusX()

template<typename T >
static constexpr Vector3 MR::Vector3< T >::minusX ( )
inlinestaticconstexprnoexcept

◆ minusY()

template<typename T >
static constexpr Vector3 MR::Vector3< T >::minusY ( )
inlinestaticconstexprnoexcept

◆ minusZ()

template<typename T >
static constexpr Vector3 MR::Vector3< T >::minusZ ( )
inlinestaticconstexprnoexcept

◆ normalized()

template<typename T >
Vector3 MR::Vector3< T >::normalized ( ) const
inlinenodiscard

◆ operator[]() [1/2]

template<typename T >
const T & MR::Vector3< T >::operator[] ( int e) const
inlineconstexprnoexcept

◆ operator[]() [2/2]

template<typename T >
T & MR::Vector3< T >::operator[] ( int e)
inlineconstexprnoexcept

◆ perpendicular()

template<typename T >
std::pair< Vector3, Vector3 > MR::Vector3< T >::perpendicular ( ) const

returns 2 unit vector, which together with this vector make an orthogonal basis Currently not implemented for integral vectors.

◆ plusX()

template<typename T >
static constexpr Vector3 MR::Vector3< T >::plusX ( )
inlinestaticconstexprnoexcept

◆ plusY()

template<typename T >
static constexpr Vector3 MR::Vector3< T >::plusY ( )
inlinestaticconstexprnoexcept

◆ plusZ()

template<typename T >
static constexpr Vector3 MR::Vector3< T >::plusZ ( )
inlinestaticconstexprnoexcept

◆ transformed()

template<typename T >
template<MR_SAME_TYPE_TEMPLATE_PARAM(T, TT) >
Vector3 MR::Vector3< T >::transformed ( const AffineXf3< TT > * xf) const
inline

returns this vector transformed by xf if it is

◆ unsignZeroValues()

template<typename T >
void MR::Vector3< T >::unsignZeroValues ( )
inline

get rid of signed zero values to be sure that equal vectors have identical binary representation

Friends And Related Symbol Documentation

◆ angle()

template<typename T >
T angle ( const Vector3< T > & a,
const Vector3< T > & b )
related

computes minimal angle in [0,pi] between two vectors; the function is symmetric: angle( a, b ) == angle( b, a )

◆ cross()

template<typename T >
Vector3< T > cross ( const Vector3< T > & a,
const Vector3< T > & b )
related

cross product

◆ distance()

template<typename T >
T distance ( const Vector3< T > & a,
const Vector3< T > & b )
related

distance between two points, better use distanceSq for higher performance

◆ distanceSq()

template<typename T >
T distanceSq ( const Vector3< T > & a,
const Vector3< T > & b )
related

squared distance between two points, which is faster to compute than just distance

◆ div()

template<typename T >
Vector3< T > div ( const Vector3< T > & a,
const Vector3< T > & b )
related

per component division

◆ dot()

template<typename T >
auto dot ( const Vector3< T > & a,
const Vector3< T > & b ) -> decltype( a.x * b.x )
related

dot product

◆ mixed()

template<typename T >
T mixed ( const Vector3< T > & a,
const Vector3< T > & b,
const Vector3< T > & c )
related

mixed product

◆ mult()

template<typename T >
Vector3< T > mult ( const Vector3< T > & a,
const Vector3< T > & b )
related

per component multiplication

◆ operator!=

template<typename T >
bool operator!= ( const Vector3< T > & a,
const Vector3< T > & b )
friend

◆ operator* [1/2]

template<typename T >
auto operator* ( const Vector3< T > & b,
T a ) -> Vector3<decltype( std::declval<T>() * std::declval<T>() )>
friend

◆ operator* [2/2]

template<typename T >
auto operator* ( T a,
const Vector3< T > & b ) -> Vector3<decltype( std::declval<T>() * std::declval<T>() )>
friend

◆ operator*=

template<typename T >
Vector3< T > & operator*= ( Vector3< T > & a,
T b )
friend

◆ operator+ [1/2]

template<typename T >
const Vector3< T > & operator+ ( const Vector3< T > & a)
friend

◆ operator+ [2/2]

template<typename T >
auto operator+ ( const Vector3< T > & a,
const Vector3< T > & b ) -> Vector3<decltype( std::declval<T>() + std::declval<T>() )>
friend

◆ operator+=

template<typename T >
Vector3< T > & operator+= ( Vector3< T > & a,
const Vector3< T > & b )
friend

◆ operator- [1/2]

template<typename T >
auto operator- ( const Vector3< T > & a) -> Vector3<decltype( -std::declval<T>() )>
friend

◆ operator- [2/2]

template<typename T >
auto operator- ( const Vector3< T > & a,
const Vector3< T > & b ) -> Vector3<decltype( std::declval<T>() - std::declval<T>() )>
friend

◆ operator-=

template<typename T >
Vector3< T > & operator-= ( Vector3< T > & a,
const Vector3< T > & b )
friend

◆ operator/

template<typename T >
auto operator/ ( Vector3< T > b,
T a ) -> Vector3<decltype( std::declval<T>() / std::declval<T>() )>
friend

◆ operator/=

template<typename T >
Vector3< T > & operator/= ( Vector3< T > & a,
T b )
friend

◆ operator==

template<typename T >
bool operator== ( const Vector3< T > & a,
const Vector3< T > & b )
friend

◆ sqr()

template<typename T >
T sqr ( const Vector3< T > & a)
related

squared length

◆ unitVector3()

template<typename T >
Vector3< T > unitVector3 ( T azimuth,
T altitude )
related

returns a point on unit sphere given two angles

Member Data Documentation

◆ elements

template<typename T >
int MR::Vector3< T >::elements = 3
staticconstexpr

◆ x

template<typename T >
T MR::Vector3< T >::x

◆ y

template<typename T >
T MR::Vector3< T >::y

◆ z

template<typename T >
T MR::Vector3< T >::z
The documentation for this struct was generated from the following file: