Acts/Navigation/NavigationDelegate.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/BoundaryTolerance.hpp"
0014 #include "Acts/Utilities/Delegate.hpp"
0015
0016 namespace Acts {
0017
0018 class NavigationStream;
0019 class AppendOnlyNavigationStream;
0020 class NavigationPolicyState;
0021 class Logger;
0022
0023 /// Struct that serves as the argument to the navigation delegate.
0024 /// It is not supposed to be used as an lvalue.
0025 struct NavigationArguments {
0026   /// Current position in 3D space for navigation
0027   Vector3 position{};
0028   /// Direction vector for navigation propagation
0029   Vector3 direction{};
0030
0031   /// Boundary tolerance for surface intersection calculations
0032   BoundaryTolerance tolerance = BoundaryTolerance::None();
0033 };
0034
0035 /// Central alias for the navigation delegate. This type is owning to support
0036 /// (type-erased) navigation delegate chains (i.e. multiple policies).
0037 using NavigationDelegate = Delegate<void(
0038     const GeometryContext&, const NavigationArguments&, NavigationPolicyState&,
0039     AppendOnlyNavigationStream&, const Logger&)>;
0040
0041 }  // namespace Acts