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

#include <surfaceLocation.H>

Inheritance diagram for surfaceLocation:

Collaboration diagram for surfaceLocation:

Public Member Functions
	surfaceLocation ()
	Default construct.
	surfaceLocation (const pointIndexHit &pHit, const triPointRef::proxType elementType, const label triangle)
	Construct from components.
	surfaceLocation (Istream &is)
	Construct from Istream.
triPointRef::proxType &	elementType () noexcept
triPointRef::proxType	elementType () const noexcept
label &	triangle () noexcept
label	triangle () const noexcept
vector	normal (const triSurface &s) const
	Normal. Approximate for points.
InfoProxy< surfaceLocation >	info () const noexcept
	Return info proxy, to print information to a stream.
void	write (Ostream &os, const triSurface &s) const
	Write info about selected face index to a stream.
Public Member Functions inherited from PointIndexHit< point >
	PointIndexHit ()
	Default construct. A zero point, with no hit and index = -1.
	PointIndexHit (const point_type &p)
	Construct from a point, with no hit and index = -1.
	PointIndexHit (const PointHit< point_type > &p, label index=-1)
	Construct from hitPoint with index = -1 or specified.
	PointIndexHit (const PointIndexHit< point_type > &p, label index)
	Copy construct with different index.
	PointIndexHit (bool success, const point_type &p, label index)
	Construct from components.
	PointIndexHit (Istream &is)
	Construct from Istream.
bool	hit () const noexcept
	Is there a hit?
label	index () const noexcept
	Return the hit index.
const point_type &	point () const noexcept
	Return point, no checks.
point_type &	point () noexcept
	Access the point, no checks.
const point_type &	hitPoint () const
	Return hit point. Fatal if not hit.
const point_type &	missPoint () const
	Return miss point. Fatal if hit.
const point_type &	rawPoint () const noexcept
	The point, no checks. Same as point().
point_type &	rawPoint () noexcept
	The point, no checks. Same as point().
void	setHit () noexcept
	Set the hit status on.
void	setMiss () noexcept
	Set the hit status off.
void	setPoint (const point_type &p)
	Set the point.
void	setIndex (const label index) noexcept
	Set the index.
void	hitPoint (const point_type &p)
	Set the point as hit without changing the hit-index.
void	hitPoint (const point_type &p, const label index)
	Set the point as hit and set the hit-index.
void	write (Ostream &os)
	Report hit/miss status, point and index.
bool	operator== (const PointIndexHit &rhs) const
	Test for equality of all components.
bool	operator!= (const PointIndexHit &rhs) const
	Test for inequality of components.

Friends
Istream &	operator>> (Istream &is, surfaceLocation &sl)
Ostream &	operator<< (Ostream &os, const surfaceLocation &sl)

Additional Inherited Members
Public Types inherited from PointIndexHit< point >
typedef point	point_type
	The point type.

Detailed Description

Contains information about location on a triSurface.

Access to data:

pointIndexHit provides
- location
- bool: hit/miss
- index (of triangle/point/edge)
elementType() provides
- what index above relates to. In triangle::proxType
triangle() provides
- last known triangle