Public Member Functions | Friends | List of all members
line< Point, PointRef > Class Template Reference

A line primitive. More...

Public Member Functions

 line (const Point &start, const Point &end)
 Construct from two points. More...
 
 line (const UList< Point > &, const FixedList< label, 2 > &indices)
 Construct from two points in the list of points. More...
 
 line (Istream &)
 Construct from Istream. More...
 
PointRef start () const
 Return first vertex. More...
 
PointRef end () const
 Return second vertex. More...
 
Point centre () const
 Return centre (centroid) More...
 
scalar mag () const
 Return scalar magnitude. More...
 
Point vec () const
 Return start-end vector. More...
 
PointHit< Point > nearestDist (const Point &p) const
 Return nearest distance to line from a given point. More...
 
scalar nearestDist (const line< Point, const Point & > &edge, Point &thisPoint, Point &edgePoint) const
 Return nearest distance from line to line. Returns distance. More...
 
scalar nearestDist (const line< point2D, const point2D & > &e, point2D &thisPt, point2D &edgePt) const
 
scalar nearestDist (const line< point2D, const point2D & > &edge, point2D &thisPoint, point2D &edgePoint) const
 2D specialisation More...
 

Friends

Istream & operator>> (Istream &, line &)
 
Ostream & operator (Ostream &, const line &)
 

Detailed Description

template<class Point, class PointRef>
class Foam::line< Point, PointRef >

A line primitive.

Source files

Definition at line 70 of file line.H.

Constructor & Destructor Documentation

◆ line() [1/3]

line ( const Point &  start,
const Point &  end 
)
inline

Construct from two points.

Definition at line 31 of file lineI.H.

◆ line() [2/3]

line ( const UList< Point > &  points,
const FixedList< label, 2 > &  indices 
)
inline

Construct from two points in the list of points.

The indices could be from edge etc.

Definition at line 39 of file lineI.H.

◆ line() [3/3]

line ( Istream &  is)
inline

Construct from Istream.

Definition at line 51 of file lineI.H.

Member Function Documentation

◆ start()

PointRef start
inline

Return first vertex.

Definition at line 60 of file lineI.H.

Referenced by plane::lineIntersect().

Here is the caller graph for this function:

◆ end()

PointRef end
inline

Return second vertex.

Definition at line 66 of file lineI.H.

◆ centre()

Point centre
inline

Return centre (centroid)

Definition at line 73 of file lineI.H.

Referenced by surfaceFeatures::nearestSurfEdge().

Here is the caller graph for this function:

◆ mag()

Foam::scalar mag
inline

Return scalar magnitude.

Definition at line 80 of file lineI.H.

References Foam::mag().

Here is the call graph for this function:

◆ vec()

Point vec
inline

Return start-end vector.

Definition at line 87 of file lineI.H.

Referenced by plane::lineIntersect().

Here is the caller graph for this function:

◆ nearestDist() [1/4]

Foam::PointHit< Point > nearestDist ( const Point &  p) const

Return nearest distance to line from a given point.

If the nearest point is on the line, return a hit

Definition at line 94 of file lineI.H.

References b, Foam::constant::physicoChemical::c1, Foam::constant::physicoChemical::c2, Foam::mag(), and p.

Referenced by treeDataFace::getVolumeType().

Here is the call graph for this function:
Here is the caller graph for this function:

◆ nearestDist() [2/4]

Foam::scalar nearestDist ( const line< Point, const Point & > &  edge,
Point &  thisPoint,
Point &  edgePoint 
) const

Return nearest distance from line to line. Returns distance.

and sets both points (one on *this, one on the provided linePointRef.

Definition at line 126 of file lineI.H.

References b, Foam::constant::universal::c, PointHit< Point >::distance(), edge::end(), Foam::mag(), Foam::magSqr(), Foam::max(), Foam::min(), PointHit< Point >::rawPoint(), s(), and edge::start().

Here is the call graph for this function:

◆ nearestDist() [3/4]

scalar nearestDist ( const line< point2D, const point2D & > &  e,
point2D &  thisPt,
point2D &  edgePt 
) const

Definition at line 36 of file line.C.

References Foam::e, Foam::mag(), Foam::max(), Foam::min(), Vector2D< Cmpt >::perp(), and s().

Here is the call graph for this function:

◆ nearestDist() [4/4]

scalar nearestDist ( const line< point2D, const point2D & > &  edge,
point2D &  thisPoint,
point2D &  edgePoint 
) const

2D specialisation

Friends And Related Function Documentation

◆ operator>>

Istream& operator>> ( Istream &  ,
line< Point, PointRef > &   
)
friend

◆ operator

Ostream& operator ( Ostream &  ,
const line< Point, PointRef > &   
)
friend
The documentation for this class was generated from the following files: