geoalgo::Cone Class Reference

Representation of a 3D semi-infinite line. Defines a 3D cone with the following properties:
Start point (or vertex), Direction, Length (or Length), Radius, opening angle
When 2 of Length, Radius, opening angle are defined the third is automatically set. More...

#include "GeoCone.h"

Inheritance diagram for geoalgo::Cone:

Public Member Functions
	Cone ()
	Default constructor. More...
virtual	~Cone ()
	Default destructor. More...
	Cone (const double x, const double y, const double z, const double dirx, const double diry, const double dirz, const double length, const double radius)
	Alternative ctor (1) More...
	Cone (const Point_t &start, const Vector_t &dir, const double length, const double radius)
	Alternative ctor (2) More...
double	Length () const
	Length getter. More...
double	Radius () const
	Length getter. More...
double	Angle () const
	Angle getter. More...
void	Length (const double l)
	Length setter. More...
void	Radius (const double r)
	Radius setter. More...
template<class T , class U >
	Cone (const T &start, const U &dir)
	Alternative ctor using template (3) More...
const Point_t &	Start () const
	Start getter. More...
void	Start (const double x, const double y, const double z)
	Start setter. More...
void	Start (const TVector3 &pt)
	Start setter. More...
template<class T >
void	Start (const T &pos)
	Start setter template. More...
const Vector_t &	Dir () const
	Direction getter. More...
void	Dir (const double x, const double y, const double z)
	Dir setter. More...
void	Dir (const TVector3 &dir)
	Dir setter. More...
template<class T >
void	Dir (const T &dir)
	Dir setter template. More...

Protected Member Functions
void	Normalize ()
	Normalize direction. More...

Protected Attributes
double	_length
	Helight (length) of the cone. More...
double	_radius
	Radius of the cone at the base. More...
double	_angle
	Opening Angle. More...
Point_t	_start
	Beginning of the half line. More...
Vector_t	_dir
	Direction of the half line from _start. More...

Detailed Description

Representation of a 3D semi-infinite line. Defines a 3D cone with the following properties:
Start point (or vertex), Direction, Length (or Length), Radius, opening angle
When 2 of Length, Radius, opening angle are defined the third is automatically set.

Definition at line 27 of file GeoCone.h.

Constructor & Destructor Documentation

geoalgo::Cone::Cone

(

)

Default constructor.

Definition at line 9 of file GeoCone.cxx.

References _angle, _length, and _radius.

Referenced by ~Cone().

             : HalfLine()
  {
    _length = 1;
    _radius = 1;
    _angle = atan(_radius / _length);
  }

virtual geoalgo::Cone::~Cone ( )

inlinevirtual

Default destructor.

Definition at line 34 of file GeoCone.h.

References Angle(), Cone(), dir, Length(), r, radius, Radius(), x, y, and z.

{};

geoalgo::Cone::Cone	(	const double	x,
		const double	y,
		const double	z,
		const double	dirx,
		const double	diry,
		const double	dirz,
		const double	length,
		const double	radius
	)

Alternative ctor (1)

Definition at line 16 of file GeoCone.cxx.

References _angle, _length, _radius, and radius.

    : HalfLine(x, y, z, dirx, diry, dirz)
  {
    if (length == 0) {
      std::ostringstream msg;
      msg << "<<" << __FUNCTION__ << ">>"
          << " Cone Length cannot be 0." << std::endl;
      throw GeoAlgoException(msg.str());
    }
    _length = length;
    _radius = radius;
    _angle = atan(_radius / _length);
  }

geoalgo::Cone::Cone	(	const Point_t &	start,
		const Vector_t &	dir,
		const double	length,
		const double	radius
	)

Alternative ctor (2)

Definition at line 37 of file GeoCone.cxx.

References _angle, _length, _radius, and radius.

    : HalfLine(start, dir)
  {
    if (length == 0) {
      std::ostringstream msg;
      msg << "<<" << __FUNCTION__ << ">>"
          << " Cone Length cannot be 0." << std::endl;
      throw GeoAlgoException(msg.str());
    }
    _length = length;
    _radius = radius;
    _angle = atan(_radius / _length);
  }

template<class T , class U >

geoalgo::Cone::Cone ( const T &  start, const U &  dir  )

inline

Alternative ctor using template (3)

Definition at line 73 of file GeoCone.h.

                                       : Cone(Point_t(start), Vector_t(dir))
    {}

Member Function Documentation

double geoalgo::Cone::Angle

(

)

const

Angle getter.

Definition at line 61 of file GeoCone.cxx.

References _angle.

Referenced by ~Cone().

  {
    return _angle;
  }

const Vector_t & geoalgo::HalfLine::Dir ( ) const

inherited

Direction getter.

Definition at line 33 of file GeoHalfLine.cxx.

References geoalgo::HalfLine::_dir.

Referenced by geoalgo::GeoAlgo::_ClosestPt_(), geoalgo::GeoAlgo::_commonOrigin_(), geoalgo::GeoAlgo::_SqDist_(), geoalgo::GeoObjCollection::Add(), geoalgo::GeoAlgo::Intersection(), and geoalgo::HalfLine::~HalfLine().

  {
    return _dir;
  }

void geoalgo::HalfLine::Dir ( const double  x, const double  y, const double  z  )

inherited

Dir setter.

Definition at line 45 of file GeoHalfLine.cxx.

References geoalgo::HalfLine::_dir, geoalgo::HalfLine::Normalize(), x, y, and z.

  {
    _dir[0] = x;
    _dir[1] = y;
    _dir[2] = z;
    Normalize();
  }

void geoalgo::HalfLine::Dir ( const TVector3 &  dir )

inherited

Dir setter.

Definition at line 60 of file GeoHalfLine.cxx.

References geoalgo::HalfLine::_dir, and geoalgo::HalfLine::Normalize().

  {
    _dir[0] = dir[0];
    _dir[1] = dir[1];
    _dir[2] = dir[2];
    Normalize();
  }

template<class T >

void geoalgo::HalfLine::Dir ( const T &  dir )

inlineinherited

Dir setter template.

Definition at line 85 of file GeoHalfLine.h.

References geoalgo::HalfLine::Normalize().

    {
      _dir = Vector_t(dir);
      if (_dir.size() != 3)
        throw GeoAlgoException("<<Start>> Only 3 dimensional start point allowed!");
      Normalize();
    }

double geoalgo::Cone::Length

(

)

const

Length getter.

Definition at line 51 of file GeoCone.cxx.

References _length.

Referenced by geoalgo::GeoObjCollection::Add(), and ~Cone().

  {
    return _length;
  }

void geoalgo::Cone::Length

(

const double

l

)

Length setter.

Definition at line 66 of file GeoCone.cxx.

References _angle, _length, and _radius.

  {
    if (l == 0) {
      std::ostringstream msg;
      msg << "<<" << __FUNCTION__ << ">>"
          << " Cone Length cannot be 0." << std::endl;
      throw GeoAlgoException(msg.str());
    }
    _length = l;
    _angle = atan(_radius / _length);
  }

void geoalgo::HalfLine::Normalize ( )

protectedinherited

Normalize direction.

Definition at line 68 of file GeoHalfLine.cxx.

References geoalgo::HalfLine::_dir, and geoalgo::Vector::Length().

Referenced by geoalgo::HalfLine::Dir(), geoalgo::HalfLine::HalfLine(), and geoalgo::HalfLine::~HalfLine().

  {
    auto l = _dir.Length();
    if (!l) throw GeoAlgoException("<<Normalize>> cannot normalize 0-length direction vector!");

    // inf check commented out till compatible solution found... --kazu
    //if(isnan(l))
    //throw GeoAlgoException("<<Normalize>> cannot normalize inf-length direction vector!");
    _dir /= l;
  }

double geoalgo::Cone::Radius

(

)

const

Length getter.

Definition at line 56 of file GeoCone.cxx.

References _radius.

Referenced by ~Cone().

  {
    return _radius;
  }

void geoalgo::Cone::Radius

(

const double

r

)

Radius setter.

Definition at line 78 of file GeoCone.cxx.

References _angle, _length, _radius, and r.

  {
    _radius = r;
    _angle = atan(_radius / _length);
  }

const Point_t & geoalgo::HalfLine::Start ( ) const

inherited

Start getter.

Definition at line 28 of file GeoHalfLine.cxx.

References geoalgo::HalfLine::_start.

Referenced by geoalgo::GeoAlgo::_ClosestPt_(), geoalgo::GeoAlgo::_commonOrigin_(), geoalgo::GeoAlgo::_SqDist_(), geoalgo::GeoObjCollection::Add(), geoalgo::GeoAlgo::BoxOverlap(), geoalgo::GeoAlgo::ClosestPt(), geoalgo::GeoAlgo::commonOrigin(), geoalgo::GeoAlgo::Intersection(), geoalgo::GeoAlgo::SqDist(), and geoalgo::HalfLine::~HalfLine().

  {
    return _start;
  }

void geoalgo::HalfLine::Start ( const double  x, const double  y, const double  z  )

inherited

Start setter.

Definition at line 38 of file GeoHalfLine.cxx.

References geoalgo::HalfLine::_start, x, y, and z.

  {
    _start[0] = x;
    _start[1] = y;
    _start[2] = z;
  }

void geoalgo::HalfLine::Start ( const TVector3 &  pt )

inherited

Start setter.

Definition at line 53 of file GeoHalfLine.cxx.

References geoalgo::HalfLine::_start.

  {
    _start[0] = pt[0];
    _start[1] = pt[1];
    _start[2] = pt[2];
  }

template<class T >

void geoalgo::HalfLine::Start ( const T &  pos )

inlineinherited

Start setter template.

Definition at line 76 of file GeoHalfLine.h.

    {
      _start = Point_t(pos);
      if (_start.size() != 3)
        throw GeoAlgoException("<<Start>> Only 3 dimensional start point allowed!");
    }

Member Data Documentation

double geoalgo::Cone::_angle

protected

Opening Angle.

Definition at line 65 of file GeoCone.h.

Referenced by Angle(), Cone(), Length(), and Radius().

Vector_t geoalgo::HalfLine::_dir

protectedinherited

Direction of the half line from _start.

Definition at line 62 of file GeoHalfLine.h.

Referenced by geoalgo::HalfLine::Dir(), and geoalgo::HalfLine::Normalize().

double geoalgo::Cone::_length

protected

Helight (length) of the cone.

Definition at line 63 of file GeoCone.h.

Referenced by Cone(), Length(), and Radius().

double geoalgo::Cone::_radius

protected

Radius of the cone at the base.

Definition at line 64 of file GeoCone.h.

Referenced by Cone(), Length(), and Radius().

Point_t geoalgo::HalfLine::_start

protectedinherited

Beginning of the half line.

Definition at line 61 of file GeoHalfLine.h.

Referenced by geoalgo::HalfLine::Start().

---

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

• larcorealg/v09_13_01/source/larcorealg/GeoAlgo/GeoCone.h
• larcorealg/v09_13_01/source/larcorealg/GeoAlgo/GeoCone.cxx