geoalgo::DirectedLine Class Reference

Representation of a 3D infinite line. Defines an infinite 3D line with a point and a direction. Line points are constructed like this: (pt, dir) -> (pt, pt+dir) It hides the point attributes from users for protecting the dimensionality. More...

#include "GeoDirectedLine.h"

Inheritance diagram for geoalgo::DirectedLine:

Public Member Functions
	DirectedLine ()
	Default ctor. More...
	DirectedLine (const double x, const double y, const double z, const double dirx, const double diry, const double dirz)
	Alternative ctor (1) More...
	DirectedLine (const Point_t &pt, const Vector_t &dir)
	Altenartive ctor (2) More...
	DirectedLine (const HalfLine &l)
	Alternative ctor (3) More...
template<class T , class U >
	DirectedLine (const T &pt, const U &dir)
	Alternative ctor using template (3) More...
Vector_t	Dir () const
const Point_t &	Pt1 () const
	Start getter. More...
void	Pt1 (const double x, const double y, const double z)
	Pt1 setter. More...
template<class T >
void	Pt1 (const T &pt1)
	Pt1 setter template. More...
const Point_t &	Pt2 () const
	Direction getter. More...
void	Pt2 (const double x, const double y, const double z)
	Pt2 setter. 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 with a point and a direction. Line points are constructed like this: (pt, dir) -> (pt, pt+dir) It hides the point attributes from users for protecting the dimensionality.

Definition at line 28 of file GeoDirectedLine.h.

Constructor & Destructor Documentation

geoalgo::DirectedLine::DirectedLine

(

)

Default ctor.

Definition at line 8 of file GeoDirectedLine.cxx.

                             : Line()
  {}

geoalgo::DirectedLine::DirectedLine	(	const double	x,
		const double	y,
		const double	z,
		const double	dirx,
		const double	diry,
		const double	dirz
	)

Alternative ctor (1)

Definition at line 11 of file GeoDirectedLine.cxx.

References geoalgo::Line::_pt1, geoalgo::Line::_pt2, and geoalgo::Line::check_and_raise().

    : Line( x, y, z, x+dirx, y+diry, z+dirz)
  { check_and_raise(_pt1,_pt2); }

geoalgo::DirectedLine::DirectedLine	(	const Point_t &	pt,
		const Vector_t &	dir
	)

Altenartive ctor (2)

Definition at line 16 of file GeoDirectedLine.cxx.

References geoalgo::Line::_pt1, geoalgo::Line::_pt2, and geoalgo::Line::check_and_raise().

    : Line( pt, pt+dir)
  { check_and_raise(_pt1,_pt2); }

geoalgo::DirectedLine::DirectedLine

(

const HalfLine &

l

)

Alternative ctor (3)

Definition at line 20 of file GeoDirectedLine.cxx.

References geoalgo::Line::_pt1, geoalgo::Line::_pt2, and geoalgo::Line::check_and_raise().

    : Line( l.Start(), l.Start()+l.Dir() )
  { check_and_raise(_pt1,_pt2); }

template<class T , class U >

geoalgo::DirectedLine::DirectedLine ( const T &  pt, const U &  dir  )

inline

Alternative ctor using template (3)

Definition at line 46 of file GeoDirectedLine.h.

References Dir().

      : Line(Point_t(pt), Point_t(pt+dir))
    {}

Member Function Documentation

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

protectedinherited

Compatibility check.

Definition at line 43 of file GeoLine.cxx.

Referenced by DirectedLine(), geoalgo::Line::Line(), geoalgo::Line::Pt1(), geoalgo::Line::Pt2(), and geoalgo::Line::~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!"); 
  }

Vector_t geoalgo::DirectedLine::Dir

(

)

const

Definition at line 24 of file GeoDirectedLine.cxx.

References geoalgo::Line::_pt1, and geoalgo::Line::_pt2.

Referenced by DirectedLine().

  { return _pt2 - _pt1; }

const Point_t & geoalgo::Line::Pt1 ( ) const

inherited

Start getter.

Definition at line 24 of file GeoLine.cxx.

References geoalgo::Line::_pt1.

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

{ return _pt1; }

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

inherited

Pt1 setter.

Definition at line 27 of file GeoLine.cxx.

References geoalgo::Line::_pt1, geoalgo::Line::_pt2, geoalgo::Line::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 )

inlineinherited

Pt1 setter template.

Definition at line 75 of file GeoLine.h.

References geoalgo::Line::check_and_raise().

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

const Point_t & geoalgo::Line::Pt2 ( ) const

inherited

Direction getter.

Definition at line 25 of file GeoLine.cxx.

References geoalgo::Line::_pt2.

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

{ return _pt2; }

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

inherited

Pt2 setter.

Definition at line 35 of file GeoLine.cxx.

References geoalgo::Line::_pt1, geoalgo::Line::_pt2, geoalgo::Line::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 )

inlineinherited

Pt2 setter template.

Definition at line 83 of file GeoLine.h.

References geoalgo::Line::check_and_raise().

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

Member Data Documentation

Point_t geoalgo::Line::_pt1

protectedinherited

First point denoting infinite line.

Definition at line 61 of file GeoLine.h.

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

Vector_t geoalgo::Line::_pt2

protectedinherited

Second point denoting infinite line.

Definition at line 62 of file GeoLine.h.

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

---

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

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