Multi-purpose 3D vector class. More...

#include <cvb/point_3d.hpp>

Public Member Functions
	Point3D () noexcept=default
	Creates a default point at (0, 0).

	Point3D (T x, T y, T z) noexcept
	Create a point from the x, y and z component.

template<std::size_t N>
	Point3D (const T(&list)[N]) noexcept
	Construct a point with an initializer list.

T	X () const noexcept
	Get the x component of the point.

void	SetX (T x) noexcept
	Set the x component of the point.

T	Y () const noexcept
	Get the y component of the point.

void	SetY (T y)
	Set the y component of the point.

T	Z () const noexcept
	Get the z component of the point.

void	SetZ (T z)
	Set the z component of the point.

T	Length () const noexcept
	Gets the length of this point.

bool	operator== (const Point3D< T > &other) const noexcept
	Compares to an other point.

bool	operator!= (const Point3D< T > &other) const noexcept
	Compares to an other point.

template<class C>
	operator Point3D< C > () const noexcept
	Enable casting.

Point3D< T > &	operator+= (const Point3D< T > &point) noexcept
	Adds and assigns to this point.

Point3D< T > &	operator-= (const Point3D< T > &point) noexcept
	Subtracts and assigns to this point.

Point3D< T > &	operator*= (const T &value) noexcept
	Multiplies by a scalar and assigns to this point.

Point3D< T > &	operator/= (const T &value) noexcept
	Divide by a scalar and assigns to this point.

const T &	operator[] (int index) const noexcept
	Index based element access.

T &	operator[] (int index) noexcept
	Index based element access.

Related Symbols
(Note that these are not member symbols.)
template<size_t I, class T, std::enable_if_t< less< I, 3 >::value, int > = 0>
auto	get (const Point3D< T > &point) noexcept -> decltype(point[I])
	Get's the I-th element of the Point3D<T>.

template<size_t I, class T, std::enable_if_t< less< I, 3 >::value, int > = 0>
void	set (Point3D< T > &point, const T &val) noexcept
	Set's the value of the I-th element in the Point3D<T> point.

template<class T>
Point3D< T >	operator+ (const Point3D< T > &lhs, const Point3D< T > &rhs)
	Add two points.

template<class T>
Point3D< T >	operator- (const Point3D< T > &lhs, const Point3D< T > &rhs)
	Subtracts two points.

template<class T>
T	operator* (const Point3D< T > &lhs, const Point3D< T > &rhs)
	Inner product of two point vectors.

template<class T>
Point3D< T >	operator* (const Point3D< T > &lhs, const T &rhs)
	Multiply point with scalar.

template<class T>
Point3D< T >	operator* (const T &lhs, const Point3D< T > &rhs)
	Multiply scalar with point.

template<class T>
Point3D< T >	operator/ (const Point3D< T > &lhs, const T &rhs)
	Divide point by scalar.

template<class T>
Point3DC< T >	operator* (const T &lhs, const Point3DC< T > &rhs)
	Multiply scalar with point.

template<class T>
Point3DH< T >	operator* (const T &lhs, const Point3DH< T > &rhs)
	Multiply scalar with point.

Detailed Description

template<class T, class ENABLE = void>
class Cvb::Point3D< T, ENABLE >

Multi-purpose 3D vector class.

Constructor & Destructor Documentation

◆ Point3D() [1/3]

template<class T, class ENABLE = void>

Point3D ( )

defaultnoexcept

Creates a default point at (0, 0).

Exceptions

Does	not throw any exception.

◆ Point3D() [2/3]

template<class T, class ENABLE = void>

Point3D	(	T	x,
		T	y,
		T	z )

inlinenoexcept

Create a point from the x, y and z component.

Parameters

[in]	x	Data to initialize with
[in]	y	Data to initialize with
[in]	z	Data to initialize with

Exceptions

Does	not throw any exception.

◆ Point3D() [3/3]

template<class T, class ENABLE = void>

template<std::size_t N>

Point3D ( const T(&) list[N] )

inlinenoexcept

Construct a point with an initializer list.

Parameters

[in] list Containing exactly 3 elements.

Exceptions

Does	not throw any exception.

Member Function Documentation

◆ Length()

template<class T, class ENABLE = void>

T Length ( ) const

inlinenoexcept

Gets the length of this point.

Returns: length of this point.

Exceptions

Does	not throw any exception.

◆ operator!=()

template<class T, class ENABLE = void>

bool operator!= ( const Point3D< T > & other ) const

inlinenoexcept

Compares to an other point.

Parameters

[in] other Other point.

Returns: True if not equal, otherwise false.

Exceptions

Does	not throw any exception.

◆ operator*=()

template<class T, class ENABLE = void>

Point3D< T > & operator*= ( const T & value )

inlinenoexcept

Multiplies by a scalar and assigns to this point.

Parameters

[in] value The scalar.

Returns: This point.

Exceptions

Does	not throw any exception.

◆ operator+=()

template<class T, class ENABLE = void>

Point3D< T > & operator+= ( const Point3D< T > & point )

inlinenoexcept

Adds and assigns to this point.

Parameters

[in] point Other point.

Returns: This point.

Exceptions

Does	not throw any exception.

◆ operator-=()

template<class T, class ENABLE = void>

Point3D< T > & operator-= ( const Point3D< T > & point )

inlinenoexcept

Subtracts and assigns to this point.

Parameters

[in] point Other point.

Returns: This point.

Exceptions

Does	not throw any exception.

◆ operator/=()

template<class T, class ENABLE = void>

Point3D< T > & operator/= ( const T & value )

inlinenoexcept

Divide by a scalar and assigns to this point.

Parameters

[in] value The scalar.

Returns: This point.

Exceptions

Does	not throw any exception.

◆ operator==()

template<class T, class ENABLE = void>

bool operator== ( const Point3D< T > & other ) const

inlinenoexcept

Compares to an other point.

Parameters

[in] other Other point.

Returns: True if equal, otherwise false.

Exceptions

Does	not throw any exception.

◆ operator[]() [1/2]

template<class T, class ENABLE = void>

const T & operator[] ( int index ) const

inlinenoexcept

Index based element access.

Parameters

[in] index Index of the element.

Returns: A const reference to the element.

Exceptions

Does	not throw any exception.

◆ operator[]() [2/2]

template<class T, class ENABLE = void>

T & operator[] ( int index )

inlinenoexcept

Index based element access.

Parameters

[in] index Index of the element.

Returns: A reference to the element.

Exceptions

Does	not throw any exception.

◆ SetX()

template<class T, class ENABLE = void>

void SetX ( T x )

inlinenoexcept

Set the x component of the point.

Parameters

[in] x X component.

Exceptions

Does	not throw any exception.

◆ SetY()

template<class T, class ENABLE = void>

void SetY ( T y )

inline

Set the y component of the point.

Parameters

[in] y Y component.

Exceptions

Does	not throw any exception.

◆ SetZ()

template<class T, class ENABLE = void>

void SetZ ( T z )

inline

Set the z component of the point.

Parameters

[in] z Z component.

Exceptions

Does	not throw any exception.

◆ X()

template<class T, class ENABLE = void>

T X ( ) const

inlinenoexcept

Get the x component of the point.

Returns: X component.

Exceptions

Does	not throw any exception.

◆ Y()

template<class T, class ENABLE = void>

T Y ( ) const

inlinenoexcept

Get the y component of the point.

Returns: Y component.

Exceptions

Does	not throw any exception.

◆ Z()

template<class T, class ENABLE = void>

T Z ( ) const

inlinenoexcept

Get the z component of the point.

Returns: Z component.

Exceptions

Does	not throw any exception.

Friends And Related Symbol Documentation

◆ get()

template<size_t I, class T, std::enable_if_t< less< I, 3 >::value, int > = 0>

auto get ( const Point3D< T > & point ) -> decltype(point[I])

Get's the I-th element of the Point3D<T>.

See also: Block, Visit

Precondition: I < 3

Template Parameters

I	The index of the element.

Parameters

point The Point3D<T> to retrieve the I-th element from.

Returns: The I-th element of point.

◆ operator*() [1/5]

template<class T>

T operator*	(	const Point3D< T > &	lhs,
		const Point3D< T > &	rhs )

Inner product of two point vectors.

Parameters

[in]	lhs	Right hand side point.
[in]	rhs	Left hand side value.

Returns: The computation result.

Exceptions

Does	not throw any exception.

◆ operator*() [2/5]

template<class T>

Point3D< T > operator*	(	const Point3D< T > &	lhs,
		const T &	rhs )

Multiply point with scalar.

Parameters

[in]	lhs	Right hand side point.
[in]	rhs	Left hand side value.

Returns: The computation result.

Exceptions

Does	not throw any exception.

◆ operator*() [3/5]

template<class T>

Point3D< T > operator*	(	const T &	lhs,
		const Point3D< T > &	rhs )

Multiply scalar with point.

Parameters

[in]	lhs	Right hand side value.
[in]	rhs	Left hand side point.

Returns: The computation result.

Exceptions

Does	not throw any exception.

◆ operator*() [4/5]

template<class T>

Point3DC< T > operator*	(	const T &	lhs,
		const Point3DC< T > &	rhs )

Multiply scalar with point.

Parameters

[in]	lhs	Right hand side value.
[in]	rhs	Left hand side point.

Returns: The computation result.

Exceptions

Does	not throw any exception.

◆ operator*() [5/5]

template<class T>

Point3DH< T > operator*	(	const T &	lhs,
		const Point3DH< T > &	rhs )

Multiply scalar with point.

Parameters

[in]	lhs	Right hand side value.
[in]	rhs	Left hand side point.

Returns: The computation result.

Exceptions

Does	not throw any exception.

◆ operator+()

template<class T>

Point3D< T > operator+	(	const Point3D< T > &	lhs,
		const Point3D< T > &	rhs )

Add two points.

Parameters

[in]	lhs	Right hand side point.
[in]	rhs	Left hand side point.

Returns: The computation result.

Exceptions

Does	not throw any exception.

◆ operator-()

template<class T>

Point3D< T > operator-	(	const Point3D< T > &	lhs,
		const Point3D< T > &	rhs )

Subtracts two points.

Parameters

[in]	lhs	Right hand side point.
[in]	rhs	Left hand side point.

Returns: The computation result.

Exceptions

Does	not throw any exception.

◆ operator/()

template<class T>

Point3D< T > operator/	(	const Point3D< T > &	lhs,
		const T &	rhs )

Divide point by scalar.

Parameters

[in]	lhs	Right hand side matrix.
[in]	rhs	Left hand side value.

Returns: The computation result.

Exceptions

Does	not throw any exception.

◆ set()

template<size_t I, class T, std::enable_if_t< less< I, 3 >::value, int > = 0>

void set	(	Point3D< T > &	point,
		const T &	val )

Set's the value of the I-th element in the Point3D<T> point.

See also: Block, Visit

Precondition: I < 3

Template Parameters

I	The index of the element.

Parameters

point	The Point3D<T,K> to set the I-th value in.
val	The value to be written to the I-th element of point.

Public Member Functions

Related Symbols

Detailed Description

Constructor & Destructor Documentation

◆ Point3D() [1/3]

◆ Point3D() [2/3]

◆ Point3D() [3/3]

Member Function Documentation

◆ Length()

◆ operator!=()

◆ operator*=()

◆ operator+=()

◆ operator-=()

◆ operator/=()

◆ operator==()

◆ operator[]() [1/2]

◆ operator[]() [2/2]

◆ SetX()

◆ SetY()

◆ SetZ()

◆ X()

◆ Y()

◆ Z()

Friends And Related Symbol Documentation

◆ get()

◆ operator*() [1/5]

◆ operator*() [2/5]

◆ operator*() [3/5]

◆ operator*() [4/5]

◆ operator*() [5/5]

◆ operator+()

◆ operator-()

◆ operator/()

◆ set()