Detector/interface/IRootVolumeFinderBuilder.hpp

0001 // This file is part of the Acts project.
0002 //
0003 // Copyright (C) 2023 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 http://mozilla.org/MPL/2.0/.
0008
0009 #pragma once
0010
0011 #include "Acts/Geometry/GeometryContext.hpp"
0012 #include "Acts/Navigation/PortalNavigation.hpp"
0013
0014 #include <memory>
0015 #include <vector>
0016
0017 namespace Acts::Experimental {
0018
0019 class DetectorVolume;
0020
0021 /// @brief This is the interface for builders that create root volume finder
0022 /// delegates
0023 class IRootVolumeFinderBuilder {
0024  public:
0025   virtual ~IRootVolumeFinderBuilder() = default;
0026
0027   /// The virtual interface definition for root volume finder builders
0028   ///
0029   /// @param gctx the geometry context at the creation of the internal structure
0030   /// @param rootVolumes the root volumes to be used for the search
0031   ///
0032   /// @return a shared detector object
0033   virtual ExternalNavigationDelegate construct(
0034       const GeometryContext& gctx,
0035       const std::vector<std::shared_ptr<DetectorVolume>>& rootVolumes)
0036       const = 0;
0037 };
0038
0039 }  // namespace Acts::Experimental