PointIndexHit< Point > Class Template Reference

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

#include <meshTools/PointIndexHit_.H>

---

Detailed Description

template<class Point>
class Foam::PointIndexHit< Point >

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

like pointHit but carries face (or cell, edge etc.) index

Source files

• src/meshTools/octree/PointIndexHit_.H

Definition at line 54 of file PointIndexHit_.H.

Inheritance diagram for PointIndexHit< Point >:

List of all members.

Public Member Functions
	PointIndexHit (const bool success, const Point &p, const label index)
	Construct from components.
	PointIndexHit (const Point &p)
	Construct from point. Hit and distance set later.
	PointIndexHit ()
	Construct null.
	PointIndexHit (Istream &is)
	Construct from Istream.
bool	hit () const
	Is there a hit.
label	index () const
	Return index.
const Point &	hitPoint () const
	Return hit point.
const Point &	missPoint () const
	Return miss point.
const Point &	rawPoint () const
	Return point with no checking.
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
Ostream &	operator<< (Ostream &os, const PointIndexHit &pHit)
Istream &	operator>> (Istream &is, PointIndexHit &pHit)

---

Constructor & Destructor Documentation

PointIndexHit	(	const bool	success,
		const Point &	p,
		const label	index
	)		[inline]

Construct from components.

Definition at line 73 of file PointIndexHit_.H.

PointIndexHit

(

const Point &

p  )

[inline]

Construct from point. Hit and distance set later.

Definition at line 81 of file PointIndexHit_.H.

PointIndexHit

(

)

[inline]

Construct null.

Definition at line 89 of file PointIndexHit_.H.

PointIndexHit

(

Istream &

is  )

[inline]

Construct from Istream.

Definition at line 97 of file PointIndexHit_.H.

---

Member Function Documentation

bool hit

(

)

const [inline]

Is there a hit.

Definition at line 106 of file PointIndexHit_.H.

Referenced by triSurfaceSearch::calcNearest(), triSurfaceSearch::calcNearestTri(), searchableSurfacesQueries::facesIntersection(), meshSearch::findCell(), patchProbes::findElements(), searchableSphere::findLine(), searchableCylinder::findLine(), octree< Type >::findLine(), triSurfaceMesh::findLineAll(), searchableSphere::findLineAll(), searchableCylinder::findLineAll(), searchableBox::findLineAll(), searchableSphere::findLineAny(), searchableCylinder::findLineAny(), octree< Type >::findLineAny(), meshSearch::findNearestBoundaryFace(), treeDataTriSurface::getVolumeType(), meshSearch::intersection(), meshSearch::intersections(), PointIndexHit< Point >::operator==(), triSurfaceTools::track(), triSurfaceTools::trackToEdge(), sampledTriSurfaceMesh::update(), and PointIndexHit< Point >::write().

label index

(

)

const [inline]

Return index.

Definition at line 112 of file PointIndexHit_.H.

Referenced by triSurfaceSearch::calcNearestTri(), meshSearch::findCell(), patchProbes::findElements(), searchableBox::findLine(), searchableBox::findLineAll(), meshSearch::findNearestBoundaryFace(), treeDataTriSurface::getVolumeType(), treeDataFace::getVolumeType(), meshSearch::intersection(), meshSearch::intersections(), surfaceFeatures::nearestSurfEdge(), surfaceLocation::normal(), PointIndexHit< Point >::operator==(), PointIndexHit< Point >::setIndex(), surfaceIntersection::surfaceIntersection(), triSurfaceTools::trackToEdge(), sampledTriSurfaceMesh::update(), and PointIndexHit< Point >::write().

const Point& hitPoint

(

)

const [inline]

Return hit point.

Definition at line 118 of file PointIndexHit_.H.

References Foam::abort(), Foam::FatalError, and FatalErrorIn.

Referenced by triSurfaceSearch::calcNearest(), searchableSurfacesQueries::facesIntersection(), meshSearch::findCell(), searchableBox::findLineAll(), treeDataTriSurface::getVolumeType(), meshSearch::intersections(), surfaceIntersection::surfaceIntersection(), sampledTriSurfaceMesh::update(), and PointIndexHit< Point >::write().

const Point& missPoint

(

)

const [inline]

Return miss point.

Definition at line 131 of file PointIndexHit_.H.

References Foam::abort(), Foam::FatalError, and FatalErrorIn.

Referenced by PointIndexHit< Point >::write().

const Point& rawPoint

(

)

const [inline]

Return point with no checking.

Definition at line 144 of file PointIndexHit_.H.

Referenced by searchableBox::findLine(), searchableBox::findNearestOnEdge(), surfaceFeatures::nearestSurfEdge(), PointIndexHit< Point >::operator==(), and triSurfaceTools::trackToEdge().

Point& rawPoint

(

)

[inline]

Definition at line 149 of file PointIndexHit_.H.

void setHit

(

)

[inline]

Definition at line 154 of file PointIndexHit_.H.

Referenced by triSurfaceTools::classify(), searchableBox::findLine(), octree< Type >::findLine(), and octree< Type >::findLineAny().

void setMiss

(

)

[inline]

Definition at line 159 of file PointIndexHit_.H.

Referenced by triSurfaceTools::classify(), searchableBox::findNearestOnEdge(), and triSurfaceTools::trackToEdge().

void setPoint

(

const Point &

p  )

[inline]

Definition at line 164 of file PointIndexHit_.H.

References p.

Referenced by triSurfaceTools::classify(), octree< Type >::findLine(), and octree< Type >::findLineAny().

void setIndex

(

const label

index  )

[inline]

Definition at line 169 of file PointIndexHit_.H.

References PointIndexHit< Point >::index().

Referenced by triSurfaceTools::classify(), searchableBox::findLine(), octree< Type >::findLine(), octree< Type >::findLineAny(), searchableBox::findNearestOnEdge(), and meshSearch::intersection().

bool operator==

(

const PointIndexHit< Point > &

rhs  )

const [inline]

Definition at line 174 of file PointIndexHit_.H.

References PointIndexHit< Point >::hit(), PointIndexHit< Point >::index(), and PointIndexHit< Point >::rawPoint().

Referenced by PointIndexHit< Point >::operator!=().

bool operator!=

(

const PointIndexHit< Point > &

rhs  )

const [inline]

Definition at line 182 of file PointIndexHit_.H.

References PointIndexHit< Point >::operator==().

void write

(

Ostream &

os  )

[inline]

Definition at line 187 of file PointIndexHit_.H.

References PointIndexHit< Point >::hit(), PointIndexHit< Point >::hitPoint(), PointIndexHit< Point >::index(), and PointIndexHit< Point >::missPoint().

Referenced by meshSearch::findCell().

---

Friends And Related Function Documentation

Ostream& operator<<	(	Ostream &	os,
		const PointIndexHit< Point > &	pHit
	)		[friend]

Definition at line 199 of file PointIndexHit_.H.

Istream& operator>>	(	Istream &	is,
		PointIndexHit< Point > &	pHit
	)		[friend]

Definition at line 221 of file PointIndexHit_.H.

---

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

• src/meshTools/octree/PointIndexHit_.H