surfaceLocation Class Reference

Contains information about location on a triSurface. More...

Inheritance diagram for surfaceLocation:
Collaboration diagram for surfaceLocation:

Public Member Functions

 surfaceLocation ()
 Construct null. More...
 
 surfaceLocation (const pointIndexHit &pih, const triPointRef::proxType elementType, const label triangle)
 Construct from components. More...
 
 surfaceLocation (Istream &is)
 Construct from Istream. More...
 
triPointRef::proxTypeelementType ()
 
triPointRef::proxType elementType () const
 
labeltriangle ()
 
label triangle () const
 
vector normal (const triSurface &s) const
 Normal. Approximate for points. More...
 
InfoProxy< surfaceLocationinfo () const
 Return info proxy. More...
 
void write (Ostream &os, const triSurface &s) const
 Write info to os. More...
 
- Public Member Functions inherited from PointIndexHit< Point >
 PointIndexHit (const bool success, const Point &p, const label index)
 Construct from components. More...
 
 PointIndexHit (const Point &p)
 Construct from point. Hit and distance set later. More...
 
 PointIndexHit ()
 Construct null. More...
 
 PointIndexHit (Istream &is)
 Construct from Istream. More...
 
bool hit () const
 Is there a hit. More...
 
label index () const
 Return index. More...
 
const Point & hitPoint () const
 Return hit point. More...
 
const Point & missPoint () const
 Return miss point. More...
 
const Point & rawPoint () const
 Return point with no checking. More...
 
Point & rawPoint ()
 
void setHit ()
 
void setMiss ()
 
void setPoint (const Point &p)
 
void setIndex (const label index)
 
bool operator== (const PointIndexHit &rhs) const
 
bool operator!= (const PointIndexHit &rhs) const
 
void write (Ostream &os)
 

Friends

Istreamoperator>> (Istream &is, surfaceLocation &sl)
 
Ostreamoperator<< (Ostream &os, const surfaceLocation &sl)
 
Ostreamoperator<< (Ostream &, const InfoProxy< surfaceLocation > &)
 

Detailed Description

Contains information about location on a triSurface.

Access to data:

Source files

Definition at line 73 of file surfaceLocation.H.

Constructor & Destructor Documentation

◆ surfaceLocation() [1/3]

surfaceLocation ( )
inline

Construct null.

Definition at line 89 of file surfaceLocation.H.

◆ surfaceLocation() [2/3]

surfaceLocation ( const pointIndexHit pih,
const triPointRef::proxType  elementType,
const label  triangle 
)
inline

Construct from components.

Definition at line 98 of file surfaceLocation.H.

◆ surfaceLocation() [3/3]

surfaceLocation ( Istream is)
inline

Construct from Istream.

Definition at line 110 of file surfaceLocation.H.

Member Function Documentation

◆ elementType() [1/2]

triPointRef::proxType& elementType ( )
inline

Definition at line 120 of file surfaceLocation.H.

Referenced by triSurfaceTools::classify(), Foam::operator<<(), triSurfaceTools::trackToEdge(), and surfaceLocation::write().

Here is the caller graph for this function:

◆ elementType() [2/2]

triPointRef::proxType elementType ( ) const
inline

Definition at line 125 of file surfaceLocation.H.

◆ triangle() [1/2]

label& triangle ( )
inline

Definition at line 130 of file surfaceLocation.H.

Referenced by Foam::operator<<(), triSurfaceTools::track(), and triSurfaceTools::trackToEdge().

Here is the caller graph for this function:

◆ triangle() [2/2]

label triangle ( ) const
inline

Definition at line 135 of file surfaceLocation.H.

References surfaceLocation::info(), surfaceLocation::normal(), surfaceLocation::operator<<, surfaceLocation::operator>>, s(), and surfaceLocation::write().

Here is the call graph for this function:

◆ normal()

◆ info()

InfoProxy<surfaceLocation> info ( ) const
inline

Return info proxy.

Used to print token information to a stream

Definition at line 145 of file surfaceLocation.H.

Referenced by surfaceLocation::triangle().

Here is the caller graph for this function:

◆ write()

Friends And Related Function Documentation

◆ operator>>

Istream& operator>> ( Istream is,
surfaceLocation sl 
)
friend

◆ operator<< [1/2]

Ostream& operator<< ( Ostream os,
const surfaceLocation sl 
)
friend

◆ operator<< [2/2]

Ostream& operator<< ( Ostream ,
const InfoProxy< surfaceLocation > &   
)
friend

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