Acts/Navigation/NavigationDelegates.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 #include "Acts/Utilities/Delegate.hpp"
0013
0014 namespace Acts {
0015
0016 class Surface;
0017
0018 namespace Experimental {
0019
0020 struct NavigationState;
0021
0022 /// Base class for navigation delegates that handle internal
0023 /// volume navigation updates
0024 class IInternalNavigation {
0025  public:
0026   virtual ~IInternalNavigation() = default;
0027 };
0028
0029 /// Declare an updator for the local navigation, i.e. the
0030 /// navigation inside a detector volume. This can be called
0031 /// either directly after a volume switch or in order to update
0032 /// within a volume after some progression
0033 ///
0034 /// This delegate dispatches the local navigation action
0035 /// to a dedicated struct or function that is optimised for
0036 /// the given environment.
0037 ///
0038 /// @param gctx is the current geometry context
0039 /// @param nState [in,out] is the navigation state to be updated
0040 ///
0041 /// @note it relies on the detector volume to be set to the state
0042 /// Memory  managed navigation state updator
0043 using InternalNavigationDelegate =
0044     OwningDelegate<void(const GeometryContext& gctx, NavigationState& nState),
0045                    IInternalNavigation>;
0046
0047 /// Base class for external navigation delegates that handle external
0048 /// volume navigation updates
0049 class IExternalNavigation {
0050  public:
0051   virtual ~IExternalNavigation() = default;
0052 };
0053
0054 /// Declare a Detctor Volume finding or switching delegate
0055 ///
0056 /// @param gctx is the current geometry context
0057 /// @param nState [in, out] is the navigation state to be updated
0058 ///
0059 /// @return the new DetectorVolume into which one changes at this switch
0060 using ExternalNavigationDelegate =
0061     OwningDelegate<void(const GeometryContext& gctx, NavigationState& nState),
0062                    IExternalNavigation>;
0063
0064 }  // namespace Experimental
0065 }  // namespace Acts