Plane.h

Go to the documentation of this file.

/*
 * Plane.h
 *
 *  Created on: 31 May 2019
 *      Author: Lorenzo Pacini
 */
 
#ifndef HERD_PLANE_H_
#define HERD_PLANE_H_
 
// HerdSoftware headers
#include "herd/analysis/common/RefFrame.h"
#include "herd/analysis/common/Vec3D.h"
#include "herd/analysis/dataobjects/Line.h"
#include "herd/analysis/dataobjects/Point.h"
#include <optional>
 
#ifdef HS_USE_ROOT
#include "Rtypes.h"
#endif
 
namespace Herd {
 
class Plane {
public:
  Plane(Point point, const float polar, const float azimuth);
 
  Plane(Point point, Vec3D normal) : _point{std::move(point)}, _normal{std::move(normal)} { _normal /= _normal.Mag(); }
 
  Plane(std::array<Point, 3> points);
 
  Plane();
 
  virtual ~Plane() = default;
 
  [[nodiscard]] inline float Polar() const { return _normal.PolarAngle(); };
 
  [[nodiscard]] inline float Azimuth() const { return _normal.AzimuthAngle(); };
 
  [[nodiscard]] Vec3D Normal() const { return _normal; };
 
  [[nodiscard]] Point Origin() const { return _point; };
 
  [[nodiscard]] std::optional<Point> Intersection(Line line) const;
 
  [[nodiscard]] double DistanceToPoint(const Point p) const;
 
  bool operator==(const Plane &rhs) const { return _point == rhs._point && _normal == rhs._normal; }
 
private:
  Point _point;
  Vec3D _normal;
 
#ifdef HS_USE_ROOT
  ClassDef(Plane, 2)
#endif
};
 
namespace {
template <> const Plane defaultValue<Plane> = Plane();
}
 
} // namespace Herd
 
#endif /* HERD_PLANE_H_ */