Acts/Geometry/ITrackingVolumeBuilder.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/Geometry/GeometryContext.hpp"
0012
0013 #include <memory>
0014 #include <vector>
0015
0016 namespace Acts {
0017
0018 class VolumeBounds;
0019 class TrackingVolume;
0020 class Layer;
0021 class Volume;
0022 using TrackingVolumePtr = std::shared_ptr<const TrackingVolume>;
0023 using MutableTrackingVolumePtr = std::shared_ptr<TrackingVolume>;
0024 using LayerPtr = std::shared_ptr<const Layer>;
0025 using LayerVector = std::vector<LayerPtr>;
0026
0027 ///  @class ITrackingVolumeBuilder
0028 ///
0029 /// Interface class ITrackingVolumeBuilders
0030 ///
0031 /// this returns the sub-detector tracking volume that is wrapped by the next
0032 /// outer one
0033 /// in the TrackingGeometry building process
0034 ///
0035 /// If an innerVolume is given, this is wrapped
0036 /// If a VolumeBounds object is given this defines the maximum extent.
0037 ///
0038 class ITrackingVolumeBuilder {
0039  public:
0040   /// Virtual destructor
0041   virtual ~ITrackingVolumeBuilder() = default;
0042
0043   /// ITrackingVolumeBuilder interface method
0044   ///
0045   /// @param gctx is the geometry context for witch the volume is built
0046   /// @param oppositeVolume is an (optional) volume to be wrapped
0047   /// @param outsideBounds is an (optional) outside confinement
0048   ///
0049   /// @return shared pointer to a newly created TrackingVolume
0050   virtual MutableTrackingVolumePtr trackingVolume(
0051       const GeometryContext& gctx, TrackingVolumePtr oppositeVolume = nullptr,
0052       std::shared_ptr<const VolumeBounds> outsideBounds = nullptr) const = 0;
0053 };
0054
0055 }  // namespace Acts