geoalgo::Line Class Reference

Representation of a 3D infinite line. Defines an infinite 3D line by having 2 points which completely determine the line along which the line extends. It hides the point attributes from users for
protecting the dimensionality. More...

#include "GeoLine.h"

Inheritance diagram for geoalgo::Line:

Public Member Functions
	Line ()
	Default constructor. More...
virtual	~Line ()
	Default destructor. More...
	Line (const double x1, const double y1, const double z1, const double x2, const double y2, const double z2)
	Alternative ctor (1) More...
	Line (const Point_t &pt1, const Point_t &pt2)
	Altenartive ctor (2) More...
const Point_t &	Pt1 () const
	Start getter. More...
const Point_t &	Pt2 () const
	Direction getter. More...
void	Pt1 (const double x, const double y, const double z)
	Pt1 setter. More...
void	Pt2 (const double x, const double y, const double z)
	Pt2 setter. More...
template<class T , class U >
	Line (const T &pt1, const U &pt2)
	Alternative ctor using template (3) More...
template<class T >
void	Pt1 (const T &pt1)
	Pt1 setter template. More...
template<class T >
void	Pt2 (const T &pt2)
	Pt2 setter template. More...

Protected Member Functions
void	check_and_raise (const Point_t &p1, const Point_t &p2) const
	Compatibility check. More...

Protected Attributes
Point_t	_pt1
	First point denoting infinite line. More...
Vector_t	_pt2
	Second point denoting infinite line. More...

Detailed Description

Representation of a 3D infinite line. Defines an infinite 3D line by having 2 points which completely determine the line along which the line extends. It hides the point attributes from users for
protecting the dimensionality.

Definition at line 27 of file GeoLine.h.

Constructor & Destructor Documentation

geoalgo::Line::Line

(

)

Default constructor.

Definition at line 8 of file GeoLine.cxx.

Referenced by ~Line().

    : _pt1(3)
    , _pt2(3)
  {}

virtual geoalgo::Line::~Line ( )

inlinevirtual

Default destructor.

Definition at line 35 of file GeoLine.h.

References check_and_raise(), Line(), Pt1(), Pt2(), x, x1, x2, y, y1, y2, and z.

{}

geoalgo::Line::Line	(	const double	x1,
		const double	y1,
		const double	z1,
		const double	x2,
		const double	y2,
		const double	z2
	)

Alternative ctor (1)

Definition at line 13 of file GeoLine.cxx.

References _pt1, _pt2, and check_and_raise().

    : _pt1 (x1, y1, z1)
    , _pt2 (x2, y2, z2)
  { check_and_raise(_pt1,_pt2); }

geoalgo::Line::Line	(	const Point_t &	pt1,
		const Point_t &	pt2
	)

Altenartive ctor (2)

Definition at line 19 of file GeoLine.cxx.

References check_and_raise().

    : _pt1 ( pt1 )
    , _pt2 ( pt2 )
  { check_and_raise(pt1,pt2); }

template<class T , class U >

geoalgo::Line::Line ( const T &  pt1, const U &  pt2  )

inline

Alternative ctor using template (3)

Definition at line 69 of file GeoLine.h.

      : Line(Point_t(pt1), Point_t(pt2))
    {}

Member Function Documentation

void geoalgo::Line::check_and_raise ( const Point_t &  p1, const Point_t &  p2  ) const

protected

Compatibility check.

Definition at line 43 of file GeoLine.cxx.

Referenced by geoalgo::DirectedLine::DirectedLine(), Line(), Pt1(), Pt2(), and ~Line().

  { 
    if(p1.size()!=3) throw GeoAlgoException("<<check_and_raise>> Pt1 is not 3 dimensional point!");
    if(p2.size()!=3) throw GeoAlgoException("<<check_and_raise>> Pt2 is not 3 dimensional point!");
    if(p1 == p2) throw GeoAlgoException("<<check_and_raise>> Two identical points not allowed for Line ctor!"); 
  }

const Point_t & geoalgo::Line::Pt1

(

)

const

Start getter.

Definition at line 24 of file GeoLine.cxx.

References _pt1.

Referenced by geoalgo::GeoAlgo::_ClosestPt_(), geoalgo::GeoAlgo::_commonOrigin_(), geoalgo::GeoAlgo::_SqDist_(), geoalgo::GeoAlgo::ClosestPt(), geoalgo::GeoAlgo::commonOrigin(), geoalgo::GeoAlgo::SqDist(), and ~Line().

{ return _pt1; }

void geoalgo::Line::Pt1	(	const double	x,
		const double	y,
		const double	z
	)

Pt1 setter.

Definition at line 27 of file GeoLine.cxx.

References _pt1, _pt2, check_and_raise(), x, y, and z.

  { 
    _pt1[0] = x; 
    _pt1[1] = y; 
    _pt1[2] = z; 
    check_and_raise(_pt1,_pt2);
  }

template<class T >

void geoalgo::Line::Pt1 ( const T &  pt1 )

inline

Pt1 setter template.

Definition at line 75 of file GeoLine.h.

References check_and_raise().

    { 
      _pt1 = Point_t(pt1); 
      check_and_raise(_pt1,_pt2);
    }

const Point_t & geoalgo::Line::Pt2

(

)

const

Direction getter.

Definition at line 25 of file GeoLine.cxx.

References _pt2.

Referenced by geoalgo::GeoAlgo::_ClosestPt_(), geoalgo::GeoAlgo::_commonOrigin_(), geoalgo::GeoAlgo::_SqDist_(), and ~Line().

{ return _pt2; }

void geoalgo::Line::Pt2	(	const double	x,
		const double	y,
		const double	z
	)

Pt2 setter.

Definition at line 35 of file GeoLine.cxx.

References _pt1, _pt2, check_and_raise(), x, y, and z.

  { 
    _pt2[0] = x; 
    _pt2[1] = y; 
    _pt2[2] = z; 
    check_and_raise(_pt1,_pt2);
  }

template<class T >

void geoalgo::Line::Pt2 ( const T &  pt2 )

inline

Pt2 setter template.

Definition at line 83 of file GeoLine.h.

References check_and_raise().

    { 
      _pt2 = Vector_t(pt2);
      check_and_raise(_pt1,_pt2);
    }

Member Data Documentation

Point_t geoalgo::Line::_pt1

protected

First point denoting infinite line.

Definition at line 61 of file GeoLine.h.

Referenced by geoalgo::Cylinder::Contain(), geoalgo::DirectedLine::Dir(), geoalgo::DirectedLine::DirectedLine(), Line(), Pt1(), and Pt2().

Vector_t geoalgo::Line::_pt2

protected

Second point denoting infinite line.

Definition at line 62 of file GeoLine.h.

Referenced by geoalgo::Cylinder::Contain(), geoalgo::DirectedLine::Dir(), geoalgo::DirectedLine::DirectedLine(), Line(), Pt1(), and Pt2().

---

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

• larcorealg/v1_24_01/source/larcorealg/GeoAlgo/GeoLine.h
• larcorealg/v1_24_01/source/larcorealg/GeoAlgo/GeoLine.cxx