ActsPlugins/GeoModel/IGeoShapeConverter.hpp

0001 // This file is part of the ACTS project.
0002 //
0003 // Copyright (C) 2016 CERN for the benefit of the ACTS project
0004 //
0005 // This Source Code Form is subject to the terms of the Mozilla Public
0006 // License, v. 2.0. If a copy of the MPL was not distributed with this
0007 // file, You can obtain one at https://mozilla.org/MPL/2.0/.
0008
0009 #pragma once
0010
0011 #include "Acts/Definitions/Algebra.hpp"
0012 #include "Acts/Utilities/BoundFactory.hpp"
0013 #include "Acts/Utilities/Result.hpp"
0014 #include "ActsPlugins/GeoModel/GeoModelDetectorElement.hpp"
0015
0016 #include <memory>
0017 #include <tuple>
0018
0019 class GeoFullPhysVol;
0020
0021 namespace Acts {
0022 class Surface;
0023 }
0024
0025 namespace ActsPlugins {
0026
0027 /// @addtogroup geomodel_plugin
0028 /// @{
0029
0030 /// @class IGeoShapeConverter
0031 ///
0032 /// Interface for the conversion of GeoShapes to Acts surfaces
0033 class IGeoShapeConverter {
0034  public:
0035   /// @brief Virtual destructor
0036   virtual ~IGeoShapeConverter() = default;
0037
0038   /// @brief Convert a GeoShape into a sensitive surface with associated
0039   ///        GeoModelDetectorElement
0040   /// @param geoPV The physical volume to convert
0041   /// @param transform: Placement of the constructed detector element
0042   /// @param boundFactory: Reference to the bound factory to share equivalent bounds
0043   ///                      across multiple surfaces
0044   /// @return The detector element and surface
0045   virtual Acts::Result<GeoModelSensitiveSurface> toSensitiveSurface(
0046       PVConstLink geoPV, const Acts::Transform3& transform,
0047       Acts::SurfaceBoundFactory& boundFactory) const = 0;
0048
0049   /// @brief Convert a GeoShape into a passive surface
0050   /// @param geoPV The physical volume to convert
0051   /// @param transform: Placement of the constructed detector element
0052   /// @param boundFactory: Reference to the bound factory to share equivalent bounds
0053   ///                      across multiple surfaces
0054   /// @return The detector element and surface
0055   virtual Acts::Result<std::shared_ptr<Acts::Surface>> toPassiveSurface(
0056       PVConstLink geoPV, const Acts::Transform3& transform,
0057       Acts::SurfaceBoundFactory& boundFactory) const = 0;
0058 };
0059
0060 /// @}
0061
0062 }  // namespace ActsPlugins