Line.h

Go to the documentation of this file.

/*
 * Line.h
 *
 *  Created on: 19 Oct 2018
 *      Author: Nicola Mori
 */
 
#ifndef HERD_LINE_H_
#define HERD_LINE_H_
 
#ifdef HS_USE_ROOT
#include "Rtypes.h"
#endif
 
// HerdSoftware headers
#include <utility>
 
#include "herd/analysis/common/DefaultValues.h"
#include "herd/analysis/common/Exception.h"
#include "herd/analysis/common/RefFrame.h"
#include "herd/analysis/common/Vec3D.h"
#include "herd/analysis/dataobjects/Line2D.h"
#include "herd/analysis/dataobjects/Point.h"
 
// c++ headers
#include <optional>
 
namespace Herd {
 
class Plane;
 
class Line {
public:
  Line() : DEFAULT_INIT(_point), DEFAULT_INIT(_direction){};
 
  Line(const Line &other) = default;
 
  Line(Line &&other) = default;
 
  Line &operator=(const Line &other) = default;
 
  Line &operator=(Line &&other) = default;
 
  Line(Point point, Vec3D direction) : _point{std::move(point)}, _direction{std::move(direction)} {
    _direction /= _direction.Mag();
  };
 
  Line(const Point &point, float polar, float azimuth);
 
  Line(const Line2D &proj1, RefFrame::View view1, const Line2D &proj2, RefFrame::View view2);
 
  virtual ~Line() = default;
 
  [[nodiscard]] inline float Polar() const { return _direction.PolarAngle(); };
 
  [[nodiscard]] float Azimuth() const { return _direction.AzimuthAngle(); };
 
  [[nodiscard]] Point Origin() const { return _point; };
 
  [[nodiscard]] Vec3D Direction() const { return _direction; };
 
  class Degenerate : public Exception {
  public:
    using Exception::Exception;
  };
 
  [[nodiscard]] std::optional<Point> Intersection(RefFrame::Axis axis, float coo) const;
 
  [[nodiscard]] std::optional<Point> Intersection(const Line &line) const;
 
  [[nodiscard]] Line Projection(const Plane &plane) const;
 
  [[nodiscard]] Line Projection(const Point p, RefFrame::View view) const;
 
  [[nodiscard]] Line2D Projection2D(RefFrame::View view) const;
 
  [[nodiscard]] double DistanceToPoint(const Point p) const;
 
  [[nodiscard]] double MinimumDistanceToLine(const Line line) const;
 
  bool operator==(const Line &rhs) const { return (_point == rhs._point) && (_direction == rhs._direction); }
  bool operator!=(const Line &rhs) const { return !(*this == rhs); }
 
private:
  Point _point;
  Vec3D _direction;
 
#ifdef HS_USE_ROOT
  ClassDef(Line, 2)
#endif
};
 
} // namespace Herd
 
#endif /* HERD_LINE_H_ */