Plane.h

Go to the documentation of this file.

// Mantid Repository : https://github.com/mantidproject/mantid
//
// Copyright © 2007 ISIS Rutherford Appleton Laboratory UKRI,
//   NScD Oak Ridge National Laboratory, European Spallation Source,
//   Institut Laue - Langevin & CSNS, Institute of High Energy Physics, CAS
// SPDX - License - Identifier: GPL - 3.0 +
#pragma once
 
#include "MantidGeometry/Surfaces/Quadratic.h"
#include "MantidKernel/V3D.h"
#include <string>
 
namespace Mantid {
 
namespace Kernel {
template <typename T> class Matrix;
}
 
namespace Geometry {
//---------------------------------------------
// Forward declaration
//---------------------------------------------
class BaseVisit;
 
class MANTID_GEOMETRY_DLL Plane : public Quadratic {
private:
  Kernel::V3D m_normVec; 
  double m_distance;     
 
  std::size_t planeType() const; 
  Plane *doClone() const override;
 
protected:
  Plane(const Plane &) = default;
  Plane &operator=(const Plane &) = delete;
 
public:
  std::string className() const override { return "Plane"; }
 
  Plane();
  std::unique_ptr<Plane> clone() const;
 
  void acceptVisitor(BaseVisit &A) const override { A.Accept(*this); }
 
  int setPlane(const Kernel::V3D &, const Kernel::V3D &);
  //  int setPlane(const std::string&);
  int side(const Kernel::V3D &) const override;
  bool onSurface(const Kernel::V3D &) const override;
  // stuff for finding intersections etc.
  double dotProd(const Plane &) const;                 
  Kernel::V3D crossProd(const Plane &) const;          
  double distance(const Kernel::V3D &) const override; 
 
  double getDistance() const { return m_distance; }          
  const Kernel::V3D &getNormal() const { return m_normVec; } 
 
  void rotate(const Kernel::Matrix<double> &) override;
  void displace(const Kernel::V3D &) override;
 
  int setSurface(const std::string &) override;
  void print() const override;
  void write(std::ostream &) const override; 
 
  void setBaseEqn() override; 
 
  int LineIntersectionWithPlane(Kernel::V3D startpt, Kernel::V3D endpt, Kernel::V3D &output);
  void getBoundingBox(double &xmax, double &ymax, double &zmax, double &xmin, double &ymin, double &zmin) override;
#ifdef ENABLE_OPENCASCADE
  TopoDS_Shape createShape() override;
#endif
};
 
} // NAMESPACE Geometry
 
} // NAMESPACE Mantid