ReferenceFrame.h

Go to the documentation of this file.

// Mantid Repository : https://github.com/mantidproject/mantid
//
// Copyright © 2012 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/DllConfig.h"
#include "MantidKernel/V3D.h"
#include <string>
 
namespace Mantid {
namespace Geometry {
enum PointingAlong { X = 0, Y = 1, Z = 2 };
enum Handedness { Left, Right };
 
class MANTID_GEOMETRY_DLL ReferenceFrame {
public:
  ReferenceFrame();
  ReferenceFrame(PointingAlong up, PointingAlong alongBeam, Handedness handedness, std::string origin);
  ReferenceFrame(PointingAlong up, PointingAlong alongBeam, PointingAlong thetaSign, Handedness handedness,
                 std::string origin);
  PointingAlong pointingUp() const;
  PointingAlong pointingAlongBeam() const;
  PointingAlong pointingHorizontal() const;
  Handedness getHandedness() const;
  std::string origin() const;
  virtual ~ReferenceFrame() = default;
  Mantid::Kernel::V3D vecPointingUp() const;
  Mantid::Kernel::V3D vecPointingAlongBeam() const;
  Mantid::Kernel::V3D vecPointingHorizontal() const;
  Mantid::Kernel::V3D vecThetaSign() const;
  std::string pointingUpAxis() const;
  std::string pointingAlongBeamAxis() const;
  std::string pointingHorizontalAxis() const;
  bool isVectorPointingAlongBeam(const Mantid::Kernel::V3D &v) const;
 
private:
  ReferenceFrame &operator=(const ReferenceFrame &);
  PointingAlong m_up;
  PointingAlong m_alongBeam;
  PointingAlong m_thetaSign;
  Handedness m_handedness;
  std::string m_origin;
  Mantid::Kernel::V3D m_vecPointingAlongBeam;
  Mantid::Kernel::V3D m_vecPointingUp;
  Mantid::Kernel::V3D m_vecThetaSign;
};
 
} // namespace Geometry
} // namespace Mantid