This class describes the interaction of an object (often a face) and a point. It carries the info of a successful hit and (if successful), returns the interaction point. More...
Public Types | |
typedef PointType | point_type |
The point type. More... | |
Public Member Functions | |
PointIndexHit () | |
Default construct. A zero point, with no hit and index = -1. More... | |
PointIndexHit (const point_type &p) | |
Construct from a point, with no hit and index = -1. More... | |
PointIndexHit (const PointHit< point_type > &p, label index=-1) | |
Construct from hitPoint with index = -1 or specified. More... | |
PointIndexHit (const PointIndexHit< point_type > &p, label index) | |
Copy construct with different index. More... | |
PointIndexHit (bool success, const point_type &p, label index) | |
Construct from components. More... | |
PointIndexHit (Istream &is) | |
Construct from Istream. More... | |
bool | hit () const noexcept |
Is there a hit? More... | |
label | index () const noexcept |
Return the hit index. More... | |
const point_type & | point () const noexcept |
Return point, no checks. More... | |
point_type & | point () noexcept |
Access the point, no checks. More... | |
const point_type & | hitPoint () const |
Return hit point. Fatal if not hit. More... | |
const point_type & | missPoint () const |
Return miss point. Fatal if hit. More... | |
const point_type & | rawPoint () const noexcept |
The point, no checks. Same as point() More... | |
point_type & | rawPoint () noexcept |
The point, no checks. Same as point() More... | |
void | setHit () noexcept |
Set the hit status on. More... | |
void | setMiss () noexcept |
Set the hit status off. More... | |
void | setPoint (const point_type &p) |
Set the point. More... | |
void | setIndex (const label index) noexcept |
Set the index. More... | |
void | hitPoint (const point_type &p) |
Set the point as hit without changing the hit-index. More... | |
void | hitPoint (const point_type &p, const label index) |
Set the point as hit and set the hit-index. More... | |
void | write (Ostream &os) |
Report hit/miss status, point and index. More... | |
bool | operator== (const PointIndexHit &rhs) const |
Test for equality of all components. More... | |
bool | operator!= (const PointIndexHit &rhs) const |
Test for inequality of components. More... | |
Friends | |
Ostream & | operator<< (Ostream &os, const PointIndexHit &pHit) |
Istream & | operator>> (Istream &is, PointIndexHit &pHit) |
This class describes the interaction of an object (often a face) and a point. It carries the info of a successful hit and (if successful), returns the interaction point.
Like pointHit but carries object (eg, face, cell, edge etc.) index
Definition at line 44 of file pointIndexHit.H.
typedef PointType point_type |
The point type.
Definition at line 93 of file pointIndexHit.H.
|
inline |
Default construct. A zero point, with no hit and index = -1.
Definition at line 101 of file pointIndexHit.H.
|
inlineexplicit |
Construct from a point, with no hit and index = -1.
Definition at line 111 of file pointIndexHit.H.
|
inlineexplicit |
Construct from hitPoint with index = -1 or specified.
Definition at line 121 of file pointIndexHit.H.
|
inline |
Copy construct with different index.
Definition at line 131 of file pointIndexHit.H.
|
inline |
Construct from components.
Definition at line 141 of file pointIndexHit.H.
|
inlineexplicit |
Construct from Istream.
Definition at line 151 of file pointIndexHit.H.
|
inlinenoexcept |
Is there a hit?
Definition at line 164 of file pointIndexHit.H.
Referenced by nearWallFields::calcAddressing(), Foam::calcProximityOfFeatureEdges(), Foam::calcProximityOfFeaturePoints(), nearestFaceAMI::calculate(), patchProbes::findElements(), mapNearestMethod::findInitialSeeds(), searchableCone::findLine(), indexedOctree< Foam::treeDataPrimitivePatch< PatchType > >::findLine(), triSurfaceSearch::findLineAll(), searchableDisk::findLineAll(), searchableCylinder::findLineAll(), searchableRotatedBox::findLineAll(), searchableBox::findLineAll(), searchableCone::findLineAll(), searchableSphere::findLineAll(), triSurfaceRegionSearch::findNearest(), distributedTriSurfaceMesh::findNearest(), meshSearch::findNearestBoundaryFace(), refinementFeatures::findNearestEdge(), refinementFeatures::findNearestPoint(), refinementFeatures::findNearestRegionEdge(), advancingFrontAMI::findTargetFace(), boundaryMesh::getNearest(), meshSearch::intersection(), meshSearch::intersections(), surfaceFeatures::nearestFeatEdge(), surfaceFeatures::nearestSamples(), surfaceFeatures::nearestSurfEdge(), powerLawLopesdaCostaZone::powerLawLopesdaCostaZone(), triSurfaceTools::track(), and triSurfaceTools::trackToEdge().
|
inlinenoexcept |
Return the hit index.
Definition at line 172 of file pointIndexHit.H.
Referenced by nearWallFields::calcAddressing(), Foam::calcProximityOfFeatureEdges(), nearestFaceAMI::calculate(), patchProbes::findElements(), mapNearestMethod::findInitialSeeds(), searchableBox::findLine(), triSurfaceSearch::findLineAll(), searchableRotatedBox::findLineAll(), searchableBox::findLineAll(), distributedTriSurfaceMesh::findNearest(), meshSearch::findNearestBoundaryFace(), refinementFeatures::findNearestEdge(), refinementFeatures::findNearestPoint(), refinementFeatures::findNearestRegionEdge(), searchableExtrudedCircle::findParametricNearest(), advancingFrontAMI::findTargetFace(), boundaryMesh::getNearest(), searchableExtrudedCircle::getNormal(), treeDataPrimitivePatch< PatchType >::getVolumeType(), treeDataFace::getVolumeType(), PointIndexHit< PointType >::hitPoint(), meshSearch::intersection(), meshSearch::intersections(), edgeIntersections::merge(), surfaceFeatures::nearestFeatEdge(), surfaceFeatures::nearestSamples(), surfaceFeatures::nearestSurfEdge(), surfaceLocation::normal(), PointIndexHit< PointType >::setIndex(), surfaceIntersection::surfaceIntersection(), and triSurfaceTools::trackToEdge().
|
inlinenoexcept |
Return point, no checks.
Definition at line 180 of file pointIndexHit.H.
Referenced by nearWallFields::calcAddressing(), Foam::calcProximityOfFeatureEdges(), Foam::calcProximityOfFeaturePoints(), patchProbes::findElements(), searchableRotatedBox::findLine(), searchableBox::findLine(), indexedOctree< Foam::treeDataPrimitivePatch< PatchType > >::findLine(), searchableRotatedBox::findLineAll(), triSurfaceRegionSearch::findNearest(), searchableRotatedBox::findNearest(), distributedTriSurfaceMesh::findNearest(), refinementFeatures::findNearestEdge(), searchableBox::findNearestOnEdge(), refinementFeatures::findNearestPoint(), refinementFeatures::findNearestRegionEdge(), advancingFrontAMI::findTargetFace(), boundaryMesh::getNearest(), surfaceFeatures::nearestSurfEdge(), Foam::normalDistance_nonzero(), Foam::normalDistance_zero(), powerLawLopesdaCostaZone::powerLawLopesdaCostaZone(), and triSurfaceTools::trackToEdge().
|
inlinenoexcept |
Access the point, no checks.
Definition at line 188 of file pointIndexHit.H.
|
inline |
Return hit point. Fatal if not hit.
Definition at line 196 of file pointIndexHit.H.
References Foam::abort(), Foam::FatalError, and FatalErrorInFunction.
Referenced by searchableBox::findLineAll(), searchableExtrudedCircle::findParametricNearest(), searchableExtrudedCircle::getNormal(), and surfaceIntersection::surfaceIntersection().
|
inline |
Return miss point. Fatal if hit.
Definition at line 210 of file pointIndexHit.H.
References Foam::abort(), Foam::FatalError, and FatalErrorInFunction.
|
inlinenoexcept |
The point, no checks. Same as point()
Definition at line 226 of file pointIndexHit.H.
|
inlinenoexcept |
The point, no checks. Same as point()
Definition at line 233 of file pointIndexHit.H.
|
inlinenoexcept |
Set the hit status on.
Definition at line 241 of file pointIndexHit.H.
Referenced by triSurfaceTools::classify(), and searchableBox::findLine().
|
inlinenoexcept |
Set the hit status off.
Definition at line 249 of file pointIndexHit.H.
Referenced by triSurfaceTools::classify(), searchableBox::findNearestOnEdge(), and triSurfaceTools::trackToEdge().
|
inline |
Set the point.
Definition at line 257 of file pointIndexHit.H.
References p.
Referenced by triSurfaceTools::classify().
|
inlinenoexcept |
Set the index.
Definition at line 265 of file pointIndexHit.H.
References PointIndexHit< PointType >::index().
Referenced by triSurfaceTools::classify(), searchableBox::findLine(), searchableBox::findNearestOnEdge(), meshSearch::intersection(), and meshSearch::intersections().
|
inline |
Set the point as hit without changing the hit-index.
Definition at line 273 of file pointIndexHit.H.
References p.
|
inline |
Set the point as hit and set the hit-index.
Definition at line 282 of file pointIndexHit.H.
References PointIndexHit< PointType >::index(), and p.
|
inline |
Report hit/miss status, point and index.
Definition at line 295 of file pointIndexHit.H.
References os().
|
inline |
Test for equality of all components.
Definition at line 307 of file pointIndexHit.H.
|
inline |
Test for inequality of components.
Definition at line 320 of file pointIndexHit.H.
|
friend |
Definition at line 328 of file pointIndexHit.H.
|
friend |
Definition at line 350 of file pointIndexHit.H.