SampleShapeHelpers.h

Go to the documentation of this file.

// Mantid Repository : https://github.com/mantidproject/mantid
//
// Copyright © 2018 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
 
//--------------------------------------
// Includes
//--------------------------------------
#include <QGroupBox>
#include <QLineEdit>
#include <QWidget>
 
//--------------------------------------
// Qt forward declarations
//--------------------------------------
class QComboBox;
class QRadioButton;
class QLabel;
 
namespace MantidQt {
namespace CustomDialogs {
 
// Forward declartion
class ShapeDetails;
 
class PointGroupBox : public QGroupBox {
  Q_OBJECT
 
public:
  // Default constructor
  PointGroupBox(QWidget *parent = nullptr);
 
  QString write3DElement(const QString &elem_name) const;
 
private slots:
  // Switch to cartesian coordinates
  void changeToCartesian();
  // Switch to spherical coordinates
  void changeToSpherical();
 
private:
  // Labels for fields
  QLabel *m_xlabel, *m_ylabel, *m_zlabel;
  // Edit fields (also used for r,theta,phi) if in spherical mode
  QLineEdit *m_midx, *m_midy, *m_midz;
  // Unit choice boxes (x is used for r in spherical mode)
  QComboBox *m_xunits, *m_yunits, *m_zunits;
  // Radio button selection for coordinates
  QRadioButton *m_cartesian, *m_spherical;
  // The current coordinate system (0 = cartesian, 1 = spherical)
  int m_icoord;
};
 
struct Operation {
  Operation(int op = 0) : binaryop(op) {}
 
  QString toString(const QString &left, const QString &right) const;
 
  int binaryop;
};
 
struct BaseInstantiator {
  BaseInstantiator() {}
  virtual ~BaseInstantiator() = default;
  virtual ShapeDetails *createInstance() const = 0;
 
private:
  BaseInstantiator(const BaseInstantiator &);
  BaseInstantiator &operator=(const BaseInstantiator &);
};
 
template <class T> struct ShapeDetailsInstantiator : public BaseInstantiator {
  ShapeDetailsInstantiator() {}
  ShapeDetails *createInstance() const override { return static_cast<ShapeDetails *>(new T); }
 
private:
  ShapeDetailsInstantiator(const ShapeDetailsInstantiator &);
  ShapeDetailsInstantiator &operator=(const ShapeDetailsInstantiator &);
};
 
class ShapeDetails : public QWidget {
  Q_OBJECT
 
public:
  ShapeDetails(QWidget *parent = nullptr) : QWidget(parent), m_idvalue(""), m_isComplement(false) {}
  ~ShapeDetails() override = default;
 
  virtual QString writeXML() const = 0;
 
  QString getShapeID() const { return m_idvalue; }
 
  static QComboBox *createLengthUnitsCombo();
  // Units enum
  enum Unit { millimetre = 0, centimetre = 1, metre = 2 };
  // Convert a string value from the given unit to metres
  static QString convertToMetres(const QString &value, Unit start_unit);
 
  void setComplementFlag(bool flag);
  bool getComplementFlag() const;
 
protected:
  QString m_idvalue;
 
private:
  bool m_isComplement;
};
 
class SphereDetails : public ShapeDetails {
  Q_OBJECT
 
private:
  static int g_nspheres;
 
public:
  SphereDetails(QWidget *parent = nullptr);
 
  ~SphereDetails() override { --g_nspheres; }
 
  // Write the XML definition of a sphere
  QString writeXML() const override;
 
private:
  QLineEdit *m_radius_box;
  QComboBox *m_runits;
  PointGroupBox *m_centre;
};
 
class CylinderDetails : public ShapeDetails {
  Q_OBJECT
 
private:
  static int g_ncylinders;
 
public:
  CylinderDetails(QWidget *parent = nullptr);
 
  ~CylinderDetails() override { --g_ncylinders; }
 
  // Write the XML definition of a sphere
  QString writeXML() const override;
 
private:
  QLineEdit *m_radius_box, *m_height_box;
  // Unit choice boxes
  QComboBox *m_runits, *m_hunits;
  PointGroupBox *m_lower_centre, *m_axis;
};
 
class InfiniteCylinderDetails : public ShapeDetails {
  Q_OBJECT
 
private:
  static int g_ninfcyls;
 
public:
  InfiniteCylinderDetails(QWidget *parent = nullptr);
 
  ~InfiniteCylinderDetails() override { --g_ninfcyls; }
 
  // Write the XML definition of a sphere
  QString writeXML() const override;
 
private:
  QLineEdit *m_radius_box;
  // Unit choice boxes
  QComboBox *m_runits;
  PointGroupBox *m_centre, *m_axis;
};
 
class SliceOfCylinderRingDetails : public ShapeDetails {
  Q_OBJECT
 
private:
  static int g_ncylrings;
 
public:
  SliceOfCylinderRingDetails(QWidget *parent = nullptr);
 
  ~SliceOfCylinderRingDetails() override { --g_ncylrings; }
 
  QString writeXML() const override;
 
private:
  QLineEdit *m_rinner_box, *m_router_box, *m_depth_box, *m_arc_box;
  // Unit choice boxes
  QComboBox *m_iunits, *m_ounits, *m_dunits;
};
 
class ConeDetails : public ShapeDetails {
  Q_OBJECT
 
private:
  static int g_ncones;
 
public:
  ConeDetails(QWidget *parent = nullptr);
 
  ~ConeDetails() override { --g_ncones; }
 
  QString writeXML() const override;
 
private:
  QLineEdit *m_height_box, *m_angle_box;
  // Unit choice boxes
  QComboBox *m_hunits;
  PointGroupBox *m_tippoint, *m_axis;
};
 
class InfiniteConeDetails : public ShapeDetails {
  Q_OBJECT
 
private:
  static int g_ninfcones;
 
public:
  InfiniteConeDetails(QWidget *parent = nullptr);
 
  ~InfiniteConeDetails() override { --g_ninfcones; }
 
  QString writeXML() const override;
 
private:
  QLineEdit *m_angle_box;
  PointGroupBox *m_tippoint, *m_axis;
};
 
class InfinitePlaneDetails : public ShapeDetails {
  Q_OBJECT
 
private:
  static int g_ninfplanes;
 
public:
  InfinitePlaneDetails(QWidget *parent = nullptr);
 
  ~InfinitePlaneDetails() override { --g_ninfplanes; }
 
  QString writeXML() const override;
 
private:
  PointGroupBox *m_plane, *m_normal;
};
 
class CuboidDetails : public ShapeDetails {
  Q_OBJECT
 
private:
  static int g_ncuboids;
 
public:
  CuboidDetails(QWidget *parent = nullptr);
 
  ~CuboidDetails() override { --g_ncuboids; }
 
  QString writeXML() const override;
 
private:
  PointGroupBox *m_left_frt_bot, *m_left_frt_top, *m_left_bck_bot, *m_right_frt_bot;
};
 
class HexahedronDetails : public ShapeDetails {
  Q_OBJECT
 
private:
  static int g_nhexahedrons;
 
public:
  HexahedronDetails(QWidget *parent = nullptr);
 
  ~HexahedronDetails() override { --g_nhexahedrons; }
 
  QString writeXML() const override;
 
private:
  PointGroupBox *m_left_bck_bot, *m_left_frt_bot, *m_right_frt_bot, *m_right_bck_bot, *m_left_bck_top, *m_left_frt_top,
      *m_right_frt_top, *m_right_bck_top;
};
 
// /**
//  * A widget to define a torus
//  */
// class TorusDetails : public ShapeDetails
// {
//   Q_OBJECT
 
// private:
//   /// The number of objects that currently exist
//   static int g_ntori;
 
// public:
//   ///Default constructor
//   TorusDetails(QWidget *parent = 0);
 
//   ///Default destructor
//   ~TorusDetails() { --g_ntori; }
 
//   /// Write the XML definition of a sphere
//   QString writeXML() const;
 
// private:
//   /// Radius values
//   QLineEdit *m_tube_rad, *m_inner_rad;
//   //Unit choice boxes
//   QComboBox *m_tunits, *m_iunits;
//   /// Corner points
//   PointGroupBox *m_centre, *m_axis;
// };
} // namespace CustomDialogs
} // namespace MantidQt