Acts/Geometry/ApproachDescriptor.hpp

0001 // This file is part of the Acts project.
0002 //
0003 // Copyright (C) 2016-2020 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/Definitions/Algebra.hpp"
0012 #include "Acts/Geometry/GeometryContext.hpp"
0013 #include "Acts/Surfaces/Surface.hpp"
0014 #include "Acts/Utilities/Intersection.hpp"
0015
0016 #include <vector>
0017
0018 namespace Acts {
0019
0020 class Surface;
0021 class Layer;
0022 class BoundaryCheck;
0023
0024 /// @class ApproachDescriptor
0025 ///
0026 /// Virtual base class to decide and return which approaching surface to be
0027 /// taken, the surfaces are std::shared_ptr, as they can be the boundary
0028 /// surfaces of the representingVolume of the Layer
0029 class ApproachDescriptor {
0030  public:
0031   ApproachDescriptor() = default;
0032   virtual ~ApproachDescriptor() = default;
0033
0034   /// @brief Register Layer
0035   /// Links the layer to the approach surfaces
0036   ///
0037   /// @param lay is the layer to be assigned
0038   virtual void registerLayer(const Layer& lay) = 0;
0039
0040   /// @brief Get the surface on approach
0041   ///
0042   /// @param gctx The current geometry context object, e.g. alignment
0043   /// @param position is the position from start of the search
0044   /// @param direction is the direction at the start of the search
0045   /// @param bcheck is the boundary check directive
0046   /// @param nearLimit The minimum distance for an intersection to be considered
0047   /// @param farLimit The maximum distance for an intersection to be considered
0048   ///
0049   /// @return is a surface intersection
0050   virtual SurfaceIntersection approachSurface(const GeometryContext& gctx,
0051                                               const Vector3& position,
0052                                               const Vector3& direction,
0053                                               const BoundaryCheck& bcheck,
0054                                               double nearLimit,
0055                                               double farLimit) const = 0;
0056
0057   /// Get all the contained surfaces
0058   /// @return all contained surfaces of this approach descriptor
0059   virtual const std::vector<const Surface*>& containedSurfaces() const = 0;
0060
0061   /// Non-const version
0062   virtual std::vector<const Surface*>& containedSurfaces() = 0;
0063 };
0064
0065 }  // namespace Acts