axom::slam::util::Point3< DataType > Struct Template Reference

A simple 3D point class similar to primal's point class, with some basic Point/Vector functionalities. More...

#include </home/docs/checkouts/readthedocs.org/user_builds/axom/checkouts/main/src/axom/slam/Utilities.hpp>

Public Member Functions
	Point3 (const DataType &x, const DataType &y, const DataType &z)
	Point3 (const DataType *d)
	Point3 ()
DataType	radius () const
	Distance from origin. More...
Point3 &	operator+= (const Point3 &pt)
Point3 &	operator-= (const Point3 &pt)
Point3 &	operator*= (const DataType &sc)
template<typename T >
Point3 &	operator/= (const T &sc)
DataType	operator[] (unsigned int i) const
	access the xyz values More...
bool	operator== (const Point3 &pt) const

Public Attributes
DataType	m_x
DataType	m_y
DataType	m_z

Friends
std::ostream &	operator<< (std::ostream &os, const Point3 &pt)

Detailed Description

template<typename DataType = double>
struct axom::slam::util::Point3< DataType >

A simple 3D point class similar to primal's point class, with some basic Point/Vector functionalities.

Note

This is needed for internal testing in slam (which does not depend on primal)

Constructor & Destructor Documentation

Point3() [1/3]

template<typename DataType = double>

axom::slam::util::Point3< DataType >::Point3 ( const DataType &  x, const DataType &  y, const DataType &  z  )

inline

Point3() [2/3]

template<typename DataType = double>

axom::slam::util::Point3< DataType >::Point3 ( const DataType *  d )

inline

Point3() [3/3]

template<typename DataType = double>

axom::slam::util::Point3< DataType >::Point3 ( )

inline

Member Function Documentation

radius()

template<typename DataType = double>

DataType axom::slam::util::Point3< DataType >::radius ( ) const

inline

Distance from origin.

References axom::slam::util::Point3< DataType >::m_x, axom::slam::util::Point3< DataType >::m_y, and axom::slam::util::Point3< DataType >::m_z.

operator+=()

template<typename DataType = double>

Point3& axom::slam::util::Point3< DataType >::operator+= ( const Point3< DataType > &  pt )

inline

References axom::slam::util::Point3< DataType >::m_x, axom::slam::util::Point3< DataType >::m_y, and axom::slam::util::Point3< DataType >::m_z.

operator-=()

template<typename DataType = double>

Point3& axom::slam::util::Point3< DataType >::operator-= ( const Point3< DataType > &  pt )

inline

References axom::slam::util::Point3< DataType >::m_x, axom::slam::util::Point3< DataType >::m_y, and axom::slam::util::Point3< DataType >::m_z.

operator*=()

template<typename DataType = double>

Point3& axom::slam::util::Point3< DataType >::operator*= ( const DataType &  sc )

inline

References axom::slam::util::Point3< DataType >::m_x, axom::slam::util::Point3< DataType >::m_y, and axom::slam::util::Point3< DataType >::m_z.

operator/=()

template<typename DataType = double>

template<typename T >

Point3& axom::slam::util::Point3< DataType >::operator/= ( const T &  sc )

inline

References axom::slam::util::Point3< DataType >::operator*=().

operator[]()

template<typename DataType = double>

DataType axom::slam::util::Point3< DataType >::operator[] ( unsigned int  i ) const

inline

access the xyz values

References axom::slam::util::Point3< DataType >::m_x, axom::slam::util::Point3< DataType >::m_y, and axom::slam::util::Point3< DataType >::m_z.

operator==()

template<typename DataType = double>

bool axom::slam::util::Point3< DataType >::operator== ( const Point3< DataType > &  pt ) const

inline

References axom::slam::util::Point3< DataType >::m_x, axom::slam::util::Point3< DataType >::m_y, and axom::slam::util::Point3< DataType >::m_z.

Friends And Related Function Documentation

operator<<

template<typename DataType = double>

std::ostream& operator<< ( std::ostream &  os, const Point3< DataType > &  pt  )

friend

Member Data Documentation

m_x

template<typename DataType = double>

DataType axom::slam::util::Point3< DataType >::m_x

m_y

template<typename DataType = double>

DataType axom::slam::util::Point3< DataType >::m_y

m_z

template<typename DataType = double>

DataType axom::slam::util::Point3< DataType >::m_z

---

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

• /home/docs/checkouts/readthedocs.org/user_builds/axom/checkouts/main/src/axom/slam/Utilities.hpp