stator
A math, geometry, and utility library
Public Member Functions | Protected Attributes | List of all members
stator::geometry::Plane< Scalar, D > Class Template Reference

An infinite flat surface of fixed thickness. More...

#include <plane.hpp>

Public Member Functions

 Plane (const Vector< Scalar, D > &center, const Vector< Scalar, D > &normal, const Scalar thickness=Scalar(0))
 
const Vector< Scalar, D > & center () const
 
const Vector< Scalar, D > & normal () const
 
const Vector< Scalar, D > & thickness () const
 

Protected Attributes

Vector< Scalar, D > center_
 
Vector< Scalar, D > normal_
 
Scalar thickness_
 

Detailed Description

template<typename Scalar, size_t D>
class stator::geometry::Plane< Scalar, D >

Template Parameters
ScalarThe scalar type used for computation of properties of the object.
DThe dimensionality of the Plane.

Definition at line 63 of file plane.hpp.

Constructor & Destructor Documentation

◆ Plane()

template<typename Scalar , size_t D>
stator::geometry::Plane< Scalar, D >::Plane ( const Vector< Scalar, D > &  center,
const Vector< Scalar, D > &  normal,
const Scalar  thickness = Scalar(0) 
)
inline

Definition at line 65 of file plane.hpp.

Member Function Documentation

◆ center()

template<typename Scalar , size_t D>
const Vector<Scalar, D>& stator::geometry::Plane< Scalar, D >::center ( ) const
inline

Definition at line 69 of file plane.hpp.

◆ normal()

template<typename Scalar , size_t D>
const Vector<Scalar, D>& stator::geometry::Plane< Scalar, D >::normal ( ) const
inline

Definition at line 70 of file plane.hpp.

◆ thickness()

template<typename Scalar , size_t D>
const Vector<Scalar, D>& stator::geometry::Plane< Scalar, D >::thickness ( ) const
inline

Definition at line 71 of file plane.hpp.

Member Data Documentation

◆ center_

template<typename Scalar , size_t D>
Vector<Scalar, D> stator::geometry::Plane< Scalar, D >::center_
protected

Definition at line 74 of file plane.hpp.

◆ normal_

template<typename Scalar , size_t D>
Vector<Scalar, D> stator::geometry::Plane< Scalar, D >::normal_
protected

Definition at line 75 of file plane.hpp.

◆ thickness_

template<typename Scalar , size_t D>
Scalar stator::geometry::Plane< Scalar, D >::thickness_
protected

Definition at line 76 of file plane.hpp.


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