API Documentation
•All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Properties Friends Macros
Public Member Functions | Static Public Member Functions | Public Attributes | List of all members
Plane< t_dims, t_type > Class Template Reference

Logic for a given plane or N-dimensions. Planes are coordinate systems of one less dimension than the dimension they occupy. More...

#include <Plane.hpp>

Public Member Functions

template<uint01 t_new_dims, class t_new_type >
Plane< t_new_dims, t_new_type > as () const
 
Vertex< t_dims, t_type > calculateIntersection (const LineSegment< t_dims, t_type > &line, t_type epsilon) const
 
t_type calculateIntersectionPos (const LineSegment< t_dims, t_type > &line, t_type epsilon) const
 
bool contains (const Vector< 3, t_type > &point, t_type epsilon) const
 
t_type distanceTo (const Vector< t_dims, t_type > &pos) const
 
bool isAbovePlane (const Vector< t_dims, t_type > &pos) const
 
bool isBelowPlane (const Vector< t_dims, t_type > &pos) const
 
bool isSamePlane (const Plane &plane, t_type epsilon) const
 
bool liesOnPlane (const Vector< t_dims, t_type > &pos) const
 
Vertex< t_dims, t_type > nearestPosition (const Vector< 3, fltp08 > &pos) const
 
constexpr void negate ()
 
bool operator!= (const Plane &plane) const
 
bool operator== (const Plane &plane) const
 
 Plane ()
 
constexpr Plane (const Ray< t_dims, t_type > &_normal, const Vertex< t_dims, t_type > &_p)
 
constexpr Plane (const Ray< t_dims, t_type > &_normal, t_type _d)
 
constexpr Plane (const Vertex< t_dims, t_type > &a, const Vertex< t_dims, t_type > &b, const Vertex< t_dims, t_type > &c)
 
PlanePosition planePosition (const Vector< t_dims, t_type > &pos) const
 
Matrix< t_type > projectionMatrix (const Vector< 3, t_type > &up) const
 

Static Public Member Functions

template<class t_buffer_type >
static Plane CreateBestFitPlane (const t_buffer_type &points, const Vector< t_dims, t_type > &direction_reference=Vector< t_dims, t_type >(0, 0, 1))
 

Public Attributes

t_type d
 
Ray< t_dims, t_type > normal
 

Detailed Description

template<uint01 t_dims, class t_type>
class NDEVR::Plane< t_dims, t_type >

Logic for a given plane or N-dimensions. Planes are coordinate systems of one less dimension than the dimension they occupy.

Constructor & Destructor Documentation

◆ Plane() [1/4]

template<uint01 t_dims, class t_type >
Plane ( )
inline

◆ Plane() [2/4]

template<uint01 t_dims, class t_type >
Plane ( const Ray< t_dims, t_type > & _normal,
const Vertex< t_dims, t_type > & _p )
inlineconstexpr

◆ Plane() [3/4]

template<uint01 t_dims, class t_type >
Plane ( const Vertex< t_dims, t_type > & a,
const Vertex< t_dims, t_type > & b,
const Vertex< t_dims, t_type > & c )
inlineconstexpr

◆ Plane() [4/4]

template<uint01 t_dims, class t_type >
Plane ( const Ray< t_dims, t_type > & _normal,
t_type _d )
inlineconstexpr

Member Function Documentation

◆ as()

template<uint01 t_dims, class t_type >
template<uint01 t_new_dims, class t_new_type >
Plane< t_new_dims, t_new_type > as ( ) const
inlinenodiscard

◆ calculateIntersection()

template<uint01 t_dims, class t_type >
Vertex< t_dims, t_type > calculateIntersection ( const LineSegment< t_dims, t_type > & line,
t_type epsilon ) const
inlinenodiscard

◆ calculateIntersectionPos()

template<uint01 t_dims, class t_type >
t_type calculateIntersectionPos ( const LineSegment< t_dims, t_type > & line,
t_type epsilon ) const
inlinenodiscard

◆ contains()

template<uint01 t_dims, class t_type >
bool contains ( const Vector< 3, t_type > & point,
t_type epsilon ) const
inline

◆ CreateBestFitPlane()

template<uint01 t_dims, class t_type >
template<class t_buffer_type >
static Plane CreateBestFitPlane ( const t_buffer_type & points,
const Vector< t_dims, t_type > & direction_reference = Vector<t_dims, t_type>(0,0,1) )
inlinestatic

◆ distanceTo()

template<uint01 t_dims, class t_type >
t_type distanceTo ( const Vector< t_dims, t_type > & pos) const
inlinenodiscard

◆ isAbovePlane()

template<uint01 t_dims, class t_type >
bool isAbovePlane ( const Vector< t_dims, t_type > & pos) const
inlinenodiscard

◆ isBelowPlane()

template<uint01 t_dims, class t_type >
bool isBelowPlane ( const Vector< t_dims, t_type > & pos) const
inlinenodiscard

◆ isSamePlane()

template<uint01 t_dims, class t_type >
bool isSamePlane ( const Plane< t_dims, t_type > & plane,
t_type epsilon ) const
inline

◆ liesOnPlane()

template<uint01 t_dims, class t_type >
bool liesOnPlane ( const Vector< t_dims, t_type > & pos) const
inlinenodiscard

◆ nearestPosition()

template<uint01 t_dims, class t_type >
Vertex< t_dims, t_type > nearestPosition ( const Vector< 3, fltp08 > & pos) const
inlinenodiscard

◆ negate()

template<uint01 t_dims, class t_type >
void negate ( )
inlineconstexpr

◆ operator!=()

template<uint01 t_dims, class t_type >
bool operator!= ( const Plane< t_dims, t_type > & plane) const
inline

◆ operator==()

template<uint01 t_dims, class t_type >
bool operator== ( const Plane< t_dims, t_type > & plane) const
inline

◆ planePosition()

template<uint01 t_dims, class t_type >
PlanePosition planePosition ( const Vector< t_dims, t_type > & pos) const
inlinenodiscard

◆ projectionMatrix()

template<uint01 t_dims, class t_type >
Matrix< t_type > projectionMatrix ( const Vector< 3, t_type > & up) const
inlinenodiscard

Member Data Documentation

◆ d

template<uint01 t_dims, class t_type >
t_type d

◆ normal

template<uint01 t_dims, class t_type >
Ray<t_dims, t_type> normal
The documentation for this class was generated from the following files: