sbg::SbgVector3< T > Class Template Reference

#include <sbg_vector3.h>

Public Member Functions
const T *	data (void) const
bool	operator!= (const SbgVector3< T > &ref_vector)
const T	operator() (size_t index) const
bool	operator== (const SbgVector3< T > &ref_vector)
	SbgVector3 (void)
	SbgVector3 (T x_value, T y_value, T z_value)
	SbgVector3 (const T *p_raw_data, size_t array_size)

Private Attributes
std::array< T, 3 >	m_data

Detailed Description

template<class T>
class sbg::SbgVector3< T >

Class to define a Vector3.

Definition at line 68 of file sbg_vector3.h.

Constructor & Destructor Documentation

template<class T>

sbg::SbgVector3< T >::SbgVector3 ( void  )

inline

Empty constructor.

Definition at line 87 of file sbg_vector3.h.

template<class T>

sbg::SbgVector3< T >::SbgVector3 ( T  x_value, T  y_value, T  z_value  )

inline

Constructor.

Parameters

[in]	x_value	Vector X value.
[in]	y_value	Vector Y value.
[in]	z_value	Vector Z value.

Definition at line 101 of file sbg_vector3.h.

template<class T>

sbg::SbgVector3< T >::SbgVector3 ( const T *  p_raw_data, size_t  array_size  )

inline

Constructor.

Parameters

[in]	p_raw_data	Pointer to data array.
[in]	array_size	Array size (Should be defined as 3).

Definition at line 114 of file sbg_vector3.h.

Member Function Documentation

template<class T>

const T* sbg::SbgVector3< T >::data ( void  ) const

inline

Get the raw data of the sbgVector.

Returns

Raw vector data.

Definition at line 172 of file sbg_vector3.h.

template<class T>

bool sbg::SbgVector3< T >::operator!= ( const SbgVector3< T > &  ref_vector )

inline

Comparison not equal operator.

Parameters

[in]

ref_vector

Vector to compare.

Returns

True if the vector are equals.

Definition at line 150 of file sbg_vector3.h.

template<class T>

const T sbg::SbgVector3< T >::operator() ( size_t  index ) const

inline

Getter parenthesis operator

Parameters

[in]

index

Index of value to retrieve.

Returns

Value at index.

Definition at line 160 of file sbg_vector3.h.

template<class T>

bool sbg::SbgVector3< T >::operator== ( const SbgVector3< T > &  ref_vector )

inline

Comparison equal operator.

Parameters

[in]

ref_vector

Vector to compare.

Returns

True if the vector are equals.

Definition at line 137 of file sbg_vector3.h.

Member Data Documentation

template<class T>

std::array<T, 3> sbg::SbgVector3< T >::m_data

private

Definition at line 76 of file sbg_vector3.h.

---

The documentation for this class was generated from the following file:

• sbg_vector3.h