Move Vectormath main
C++20 game and graphics mathematics
Loading...
Searching...
No Matches
Classes | Public Types | Public Member Functions | Static Public Member Functions | List of all members
mv::math::Plane3< T > Class Template Reference

#include <mv/math/geometry/Plane3.hpp>

Public Types

using Component = T
 

Public Member Functions

 Plane3 () noexcept=default
 
Normal3< T > Normal () const noexcept
 
T Offset () const noexcept
 
T SignedDistance (const Point3< T > &point) const noexcept
 
PlaneSide Classify (const Point3< T > &point, T boundaryTolerance=T(0)) const noexcept
 
Point3< T > ClosestPoint (const Point3< T > &point) const noexcept
 
Plane3 Flipped () const noexcept
 

Static Public Member Functions

static std::optional< Plane3 > TryFromNormalAndOffset (const Normal3< T > &normal, T offset) noexcept
 
static std::optional< Plane3 > TryFromPointNormal (const Point3< T > &point, const Normal3< T > &normal) noexcept
 
static std::optional< Plane3 > TryFromPoints (const Point3< T > &first, const Point3< T > &second, const Point3< T > &third) noexcept
 

Detailed Description

template<typename T>
requires std::is_floating_point_v<T>
class mv::math::Plane3< T >

Definition at line 23 of file Plane3.hpp.

Member Typedef Documentation

◆ Component

template<typename T >
using mv::math::Plane3< T >::Component = T

Definition at line 26 of file Plane3.hpp.

Constructor & Destructor Documentation

◆ Plane3()

template<typename T >
mv::math::Plane3< T >::Plane3 ( )
defaultnoexcept

Member Function Documentation

◆ Classify()

template<typename T >
PlaneSide mv::math::Plane3< T >::Classify ( const Point3< T > &  point,
T  boundaryTolerance = T(0) 
) const
inlinenoexcept

Definition at line 78 of file Plane3.hpp.

◆ ClosestPoint()

template<typename T >
Point3< T > mv::math::Plane3< T >::ClosestPoint ( const Point3< T > &  point) const
inlinenoexcept

Definition at line 94 of file Plane3.hpp.

◆ Flipped()

template<typename T >
Plane3 mv::math::Plane3< T >::Flipped ( ) const
inlinenoexcept

Definition at line 100 of file Plane3.hpp.

◆ Normal()

template<typename T >
Normal3< T > mv::math::Plane3< T >::Normal ( ) const
inlinenoexcept

Definition at line 61 of file Plane3.hpp.

◆ Offset()

template<typename T >
T mv::math::Plane3< T >::Offset ( ) const
inlinenoexcept

Definition at line 68 of file Plane3.hpp.

◆ SignedDistance()

template<typename T >
T mv::math::Plane3< T >::SignedDistance ( const Point3< T > &  point) const
inlinenoexcept

Definition at line 73 of file Plane3.hpp.

◆ TryFromNormalAndOffset()

template<typename T >
static std::optional< Plane3 > mv::math::Plane3< T >::TryFromNormalAndOffset ( const Normal3< T > &  normal,
T  offset 
)
inlinestaticnoexcept

Definition at line 30 of file Plane3.hpp.

◆ TryFromPointNormal()

template<typename T >
static std::optional< Plane3 > mv::math::Plane3< T >::TryFromPointNormal ( const Point3< T > &  point,
const Normal3< T > &  normal 
)
inlinestaticnoexcept

Definition at line 40 of file Plane3.hpp.

◆ TryFromPoints()

template<typename T >
static std::optional< Plane3 > mv::math::Plane3< T >::TryFromPoints ( const Point3< T > &  first,
const Point3< T > &  second,
const Point3< T > &  third 
)
inlinestaticnoexcept

Definition at line 47 of file Plane3.hpp.

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