nomlib
Loading...
Searching...
No Matches
nom::Point3< T > Struct Template Reference

3D Point class More...

#include <Point3.hpp>

Public Member Functions

 Point3 ()
 Default constructor; initialize values to Point3<T>::null.
 ~Point3 ()
 Destructor.
 Point3 (T x, T y, T z)
 Constructor variant for initializing x, y, z at construction.
template<typename U>
 Point3 (const Point3< U > &copy)
 Copy constructor.
const Point3< T > & get () const
 Obtain a reference of the object.

Public Attributes

x
y
z

Static Public Attributes

static const Point3 null
 Null value.
static const Point3 zero
 Zero value constant.

Detailed Description

template<typename T>
struct nom::Point3< T >

3D Point class

Definition at line 41 of file Point3.hpp.

Constructor & Destructor Documentation

◆ Point3() [1/3]

template<typename T>
nom::Point3< T >::Point3 ( )
inline

Default constructor; initialize values to Point3<T>::null.

Definition at line 44 of file Point3.hpp.

◆ ~Point3()

template<typename T>
nom::Point3< T >::~Point3 ( )
inline

Destructor.

Definition at line 53 of file Point3.hpp.

◆ Point3() [2/3]

template<typename T>
nom::Point3< T >::Point3 ( T x,
T y,
T z )
inline

Constructor variant for initializing x, y, z at construction.

Definition at line 59 of file Point3.hpp.

◆ Point3() [3/3]

template<typename T>
template<typename U>
nom::Point3< T >::Point3 ( const Point3< U > & copy)
inlineexplicit

Copy constructor.

Remarks
The explicit keyword here will result in compile-time errors in any instance that it finds incompatible casting occurring, such as if you try to down-cast a Point3<int> to a Point3<float>.

Definition at line 59 of file Point3.hpp.

Member Function Documentation

◆ get()

template<typename T>
const Point3< T > & nom::Point3< T >::get ( ) const
inline

Obtain a reference of the object.

Definition at line 82 of file Point3.hpp.

Member Data Documentation

◆ null

template<typename T>
const Point3 nom::Point3< T >::null
static

Null value.

Remarks
Null value implementation depends on signed (negative) numbers.

Definition at line 90 of file Point3.hpp.

◆ x

template<typename T>
T nom::Point3< T >::x

Definition at line 95 of file Point3.hpp.

◆ y

template<typename T>
T nom::Point3< T >::y

Definition at line 96 of file Point3.hpp.

◆ z

template<typename T>
T nom::Point3< T >::z

Definition at line 97 of file Point3.hpp.

◆ zero

template<typename T>
const Point3 nom::Point3< T >::zero
static

Zero value constant.

Definition at line 93 of file Point3.hpp.


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