Acts/Geometry/ApproachDescriptor.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/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
0023 /// @class ApproachDescriptor
0024 ///
0025 /// Virtual base class to decide and return which approaching surface to be
0026 /// taken, the surfaces are std::shared_ptr, as they can be the boundary
0027 /// surfaces of the representingVolume of the Layer
0028 class ApproachDescriptor {
0029  public:
0030   ApproachDescriptor() = default;
0031   virtual ~ApproachDescriptor() = default;
0032
0033   /// @brief Register Layer
0034   /// Links the layer to the approach surfaces
0035   ///
0036   /// @param lay is the layer to be assigned
0037   virtual void registerLayer(const Layer& lay) = 0;
0038
0039   /// @brief Get the surface on approach
0040   ///
0041   /// @param gctx The current geometry context object, e.g. alignment
0042   /// @param position is the position from start of the search
0043   /// @param direction is the direction at the start of the search
0044   /// @param boundaryTolerance is the boundary check directive
0045   /// @param nearLimit The minimum distance for an intersection to be considered
0046   /// @param farLimit The maximum distance for an intersection to be considered
0047   ///
0048   /// @return is a surface intersection
0049   virtual SurfaceIntersection approachSurface(
0050       const GeometryContext& gctx, const Vector3& position,
0051       const Vector3& direction, const BoundaryTolerance& boundaryTolerance,
0052       double nearLimit, double farLimit) const = 0;
0053
0054   /// Get all the contained surfaces
0055   /// @return all contained surfaces of this approach descriptor
0056   virtual const std::vector<const Surface*>& containedSurfaces() const = 0;
0057
0058   /// Non-const version
0059   virtual std::vector<const Surface*>& containedSurfaces() = 0;
0060 };
0061
0062 }  // namespace Acts