walberla::math::Plane Class Reference

#include <Plane.h>

Public Types

using Vec3Real = Vector3< real_t >
 

Public Member Functions

 Plane ()
 
 Plane (const Vec3Real &origin, const Vec3Real &_normal)
 
 Plane (const Vec3Real &_normal, const real_t _d)
 
bool operator== (const Plane &other) const
 
bool operator!= (const Plane &other) const
 
void assign (const Vec3Real &origin, const Vec3Real &_normal)
 
void assign (const Vec3Real &_normal, const real_t _d)
 
real_t signedDistance (const Vec3Real &point) const
 
real_t distance (const Vec3Real &point) const
 
bool isInHalfSpace (const Vec3Real &point) const
 
void invert ()
 
void shift (const real_t distance)
 
void scale (const real_t factor)
 
real_t d () const
 
const Vec3Realnormal () const
 

Private Attributes

Vec3Real normal_
 
real_t d_
 

Friends

std::ostream & operator<< (std::ostream &os, const Plane &p)
 
std::istream & operator>> (std::istream &is, Plane &plane)
 

Member Typedef Documentation

◆ Vec3Real

Constructor & Destructor Documentation

◆ Plane() [1/3]

walberla::math::Plane::Plane ( )
inline

◆ Plane() [2/3]

walberla::math::Plane::Plane ( const Vec3Real origin,
const Vec3Real _normal 
)
inline

◆ Plane() [3/3]

walberla::math::Plane::Plane ( const Vec3Real _normal,
const real_t  _d 
)
inline

Member Function Documentation

◆ assign() [1/2]

void walberla::math::Plane::assign ( const Vec3Real _normal,
const real_t  _d 
)
inline

◆ assign() [2/2]

void walberla::math::Plane::assign ( const Vec3Real origin,
const Vec3Real _normal 
)
inline

◆ d()

real_t walberla::math::Plane::d ( ) const
inline

◆ distance()

real_t walberla::math::Plane::distance ( const Vec3Real point) const
inline

◆ invert()

void walberla::math::Plane::invert ( )
inline

◆ isInHalfSpace()

bool walberla::math::Plane::isInHalfSpace ( const Vec3Real point) const
inline

◆ normal()

const Vec3Real& walberla::math::Plane::normal ( ) const
inline

◆ operator!=()

bool walberla::math::Plane::operator!= ( const Plane other) const
inline

◆ operator==()

bool walberla::math::Plane::operator== ( const Plane other) const
inline

◆ scale()

void walberla::math::Plane::scale ( const real_t  factor)
inline

◆ shift()

void walberla::math::Plane::shift ( const real_t  distance)
inline

◆ signedDistance()

real_t walberla::math::Plane::signedDistance ( const Vec3Real point) const
inline

Friends And Related Function Documentation

◆ operator<<

std::ostream& operator<< ( std::ostream &  os,
const Plane p 
)
friend

◆ operator>>

std::istream& operator>> ( std::istream &  is,
Plane plane 
)
friend

Member Data Documentation

◆ d_

real_t walberla::math::Plane::d_
private

◆ normal_

Vec3Real walberla::math::Plane::normal_
private

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