ObjComponent.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/DllConfig.h"
#include "MantidGeometry/IObjComponent.h"
#include "MantidGeometry/Instrument/Component.h"
 
#ifdef _WIN32
#pragma warning(disable : 4250)
#endif
 
namespace Mantid {
namespace Geometry {
class Objects;
//----------------------------------------------------------------------
// Forward Declaration
//----------------------------------------------------------------------
 
class MANTID_GEOMETRY_DLL ObjComponent : public virtual IObjComponent, public Component {
public:
  std::string type() const override { return "PhysicalComponent"; }
 
  ObjComponent(const IComponent *base, const ParameterMap *map);
  // Looking to get rid of the first of these constructors in due course (and
  // probably add others)
  explicit ObjComponent(const std::string &name, IComponent *parent = nullptr);
  explicit ObjComponent(const std::string &name, std::shared_ptr<const IObject> shape, IComponent *parent = nullptr);
 
  IComponent *clone() const override { return new ObjComponent(*this); }
 
  bool isValid(const Kernel::V3D &point) const override;
  bool isOnSide(const Kernel::V3D &point) const override;
  int interceptSurface(Track &track) const override;
  double solidAngle(const Geometry::SolidAngleParams &params) const override;
  void boundingBox(double &xmax, double &ymax, double &zmax, double &xmin, double &ymin, double &zmin) const;
  void getBoundingBox(BoundingBox &absoluteBB) const override;
  virtual double getHeight() const;
  virtual double getWidth() const;
  virtual double getDepth() const;
 
  int getPointInObject(Kernel::V3D &point) const override;
  // Rendering member functions
  void draw() const override;
  void drawObject() const override;
  void initDraw() const override;
 
  const std::shared_ptr<const IObject> shape() const override;
  void setShape(std::shared_ptr<const IObject> newShape);
  const Kernel::Material material() const override;
 
  virtual size_t registerContents(class ComponentVisitor &componentVisitor) const override;
 
protected:
  // Made a pointer to a const object. Since this is a shared object we
  // shouldn't be
  // exposing non-const methods of Object through this class.
  std::shared_ptr<const IObject> m_shape;
 
  const Kernel::V3D factorOutComponentPosition(const Kernel::V3D &point) const;
  const Kernel::V3D takeOutRotation(Kernel::V3D point) const;
 
private:
  void getRelativeBoundingBox(BoundingBox &RelativeBB) const;
};
 
} // namespace Geometry
} // namespace Mantid