Public Member Functions | Friends | List of all members
PointHit< Point > Class Template Reference

This class describes the interaction of a face and a point. It carries the info of a successful hit and (if successful), returns the interaction point. More...

Inheritance diagram for PointHit< Point >:
Inheritance graph
[legend]

Public Member Functions

 PointHit ()
 Construct null. More...
 
 PointHit (const bool hit, const Point &p, const scalar dist, const bool eligibleMiss)
 Construct from components. More...
 
 PointHit (const Point &p)
 Construct from point. Hit and distance set later. More...
 
bool hit () const
 Is there a hit. More...
 
const Point & hitPoint () const
 Return hit point. More...
 
scalar distance () const
 Return distance to hit. More...
 
const Point & missPoint () const
 Return miss point. More...
 
const Point & rawPoint () const
 Return point with no checking. More...
 
bool eligibleMiss () const
 Is this an eligible miss. More...
 
void setHit ()
 
void setMiss (const bool eligible)
 
void setPoint (const Point &p)
 
void setDistance (const scalar d)
 

Friends

Ostreamoperator (Ostream &os, const PointHit< Point > &b)
 

Detailed Description

template<class Point>
class Foam::PointHit< Point >

This class describes the interaction of a face and a point. It carries the info of a successful hit and (if successful), returns the interaction point.

Definition at line 51 of file PointHit.H.

Constructor & Destructor Documentation

◆ PointHit() [1/3]

PointHit ( )
inline

Construct null.

Definition at line 84 of file PointHit.H.

Referenced by PointHit< point >::PointHit().

Here is the caller graph for this function:

◆ PointHit() [2/3]

PointHit ( const bool  hit,
const Point &  p,
const scalar  dist,
const bool  eligibleMiss 
)
inline

Construct from components.

Definition at line 94 of file PointHit.H.

◆ PointHit() [3/3]

PointHit ( const Point &  p)
inline

Construct from point. Hit and distance set later.

Definition at line 108 of file PointHit.H.

Member Function Documentation

◆ hit()

bool hit ( ) const
inline

◆ hitPoint()

const Point& hitPoint ( ) const
inline

◆ distance()

scalar distance ( ) const
inline

◆ missPoint()

const Point& missPoint ( ) const
inline

◆ rawPoint()

const Point& rawPoint ( ) const
inline

◆ eligibleMiss()

bool eligibleMiss ( ) const
inline

◆ setHit()

void setHit ( )
inline

◆ setMiss()

void setMiss ( const bool  eligible)
inline

◆ setPoint()

void setPoint ( const Point &  p)
inline

◆ setDistance()

void setDistance ( const scalar  d)
inline

Friends And Related Function Documentation

◆ operator

Ostream& operator ( Ostream os,
const PointHit< Point > &  b 
)
friend

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