INavigator.h

Go to the documentation of this file.

/*
  Copyright (C) 2002-2021 CERN for the benefit of the ATLAS collaboration
*/

// INavigator.h, (c) ATLAS Detector software
 
#ifndef TRKDETDESCRINTERFACES_INAVIGATOR_H
#define TRKDETDESCRINTERFACES_INAVIGATOR_H
 
// Gaudi
#include "GaudiKernel/IAlgTool.h"
#include "GaudiKernel/EventContext.h"
// GeoPrimitives
#include "GeoPrimitives/GeoPrimitives.h"
// Trk
#include "TrkEventPrimitives/ParticleHypothesis.h"
#include "TrkParameters/TrackParameters.h"
#include "TrkVolumes/BoundarySurface.h"
#include "TrkVolumes/BoundarySurfaceFace.h"
// STL
#include <utility>
 
namespace Trk {
 
class IPropagator;
class Surface;
class Track;
// class TrackParameters;
class TrackingVolume;
class TrackingGeometry;
class DetachedTrackingVolume;

struct NavigationCell
{
  //Not Ownig ptr to volume from geometry
  const TrackingVolume* nextVolume;
  //Owning ptr for parameters
  std::unique_ptr<TrackParameters> parametersOnBoundary;
  BoundarySurfaceFace exitFace;
  NavigationCell(const TrackingVolume* nVol,
                 std::unique_ptr<TrackParameters> lPar,
                 BoundarySurfaceFace face = undefinedFace)
    : nextVolume(nVol)
    , parametersOnBoundary(std::move(lPar))
    , exitFace(face)
  {}
};
 
typedef std::pair<int, const NavigationCell*> IdNavigationCell;

static const InterfaceID IID_INavigator("INavigator", 1, 0);

class INavigator : virtual public IAlgTool
{
public:
  virtual ~INavigator() {}

  static const InterfaceID& interfaceID() { return IID_INavigator; }

  virtual const TrackingGeometry* trackingGeometry(
    const EventContext& ctx) const = 0;

  virtual const TrackingVolume* volume(const EventContext& ctx,
                                       const Amg::Vector3D& gp) const = 0;

  virtual const TrackingVolume* highestVolume(
    const EventContext& ctx) const = 0;

  virtual const TrackParameters* closestParameters(
    const Track& trk,
    const Surface& sf) const = 0;

  virtual bool atVolumeBoundary(const Trk::TrackParameters* parms,
                                const Trk::TrackingVolume* vol,
                                Trk::PropDirection dir,
                                const Trk::TrackingVolume*& nextVol,
                                double tol) const = 0;

  virtual const BoundarySurface<TrackingVolume>* nextBoundarySurface(
    const EventContext& ctx,
    const IPropagator& prop,
    const TrackParameters& parms,
    PropDirection dir) const = 0;

  virtual const BoundarySurface<TrackingVolume>* nextBoundarySurface(
    const EventContext& ctx,
    const IPropagator& prop,
    const TrackParameters& parms,
    PropDirection dir,
    const TrackingVolume& vol) const = 0;

  virtual NavigationCell nextTrackingVolume(
    const EventContext& ctx,
    const IPropagator& prop,
    const TrackParameters& parms,
    PropDirection dir,
    const TrackingVolume& vol) const = 0;
 
 
};
} // end of namespace
 
#endif // TRKDETDESCRINTERFACES_INAVIGATOR_H