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

///////////////////////////////////////////////////////////////////
// LArVolumeBuilder.h, (c) ATLAS Detector software
///////////////////////////////////////////////////////////////////

#ifndef LARTRACKINGGEOMETRY_LARVOLUMEBUILDER_H
#define LARTRACKINGGEOMETRY_LARVOLUMEBUILDER_H

// Gaudi
#include "AthenaBaseComps/AthAlgTool.h"
#include "GaudiKernel/ToolHandle.h"
// Trk
#include "TrkDetDescrInterfaces/ITrackingVolumeBuilder.h"
#include "CaloTrackingGeometry/ICaloSurfaceBuilder.h"
// STL
#include <vector>

class LArDetectorManager;
class CaloDepthTool;
class GeoPVConstLink;

namespace Trk {
  class ILayerArrayCreator;
  class ITrackingVolumeHelper;
  class ITrackingVolumeCreator;
  class TrackingVolume;
  class Material;
  class Volume;
  class Layer;
}

namespace LAr {

  /** @class LArVolumeBuilder
       
      The LArVolumeBuilder builds the TrackingVolumes for 
         - LAr Barrel
         - LAr Inner Endcap
         - LAr Outer Endcap

      The HEC and Forward Calorimeter have to be added later when knowing the dimensions
      of the Tile Calorimter.

      @author Andreas.Salzburger@cern.ch
    */
  class LArVolumeBuilder : public AthAlgTool,
                             virtual public Trk::ITrackingVolumeBuilder {
    
    
    
                            
    public:
      /** AlgTool style constructor */
      LArVolumeBuilder(const std::string&,const std::string&,const IInterface*);
      /** Destructor */
      virtual ~LArVolumeBuilder();
      
      /** AlgTool initialize method */
      StatusCode initialize();
      /** AlgTool finalize method */
      StatusCode finalize();

      /** TrackingVolumeBuilder interface method - returns vector of Volumes */
      const std::vector<const Trk::TrackingVolume*>* trackingVolumes() const;
          
    private:
      // ------------- private methods -----------------------------------------
      void printCheckResult(MsgStream& log, const Trk::TrackingVolume* vol) const;

      void printInfo(GeoPVConstLink pv, int gen=-1) const;
      void printChildren(GeoPVConstLink pv, int gen, int igen, Amg::Transform3D tr) const;

      void throwIntoGarbage(const Trk::Material* mat) const;

      /** create the sensitive volumes to associate to the layers **/
      Trk::Volume* cylAssociatedVolume(const CaloCell_ID::CaloSample sample,
                                       const double hlenz, 
                                       double& radius) const;

      Trk::Volume* discAssociatedVolume(const CaloCell_ID::CaloSample sample, 
                                        const int side, 
                                        const double radmin, 
                                        const double radmax, 
                                        double& z, 
                                        double& depth) const;
      /** associates volumes to layers,
          defines a sensitive volume around a layer **/
      void associateVolumeToPositiveLayer(const std::vector<const Trk::Layer*>, 
                                          const std::vector<const Trk::Volume*>) const;
      /** associates volumes to layers,
          defines a sensitive volume around a layer **/
      void associateVolumeToNegativeLayer(const std::vector<const Trk::Layer*>, 
                                          const std::vector<const Trk::Volume*>) const;
      /** associates cylindrical volumes to layers 
          defines a sensitive volume around a layer **/
      void associateCylVolumeToLayer(const std::vector<const Trk::Layer*> matLayers, 
                                     const std::vector<const Trk::Volume*> sensitiveVolumes) const;

      // ------------- private members -----------------------------------------
                                     
      const LArDetectorManager*                         m_lArMgr;                     //!< Calo DetDescrMgr
      std::string                                       m_lArMgrLocation;             //!< Location of the CaloDetDescrMgr
                                                                                      
      ToolHandle<Trk::ITrackingVolumeHelper>            m_lArTrackingVolumeHelper;     //!< Helper Tool to create TrackingVolumes
      ToolHandle<Trk::ITrackingVolumeCreator>           m_trackingVolumeCreator;       //!< helper for volume creation
                              
      double                           m_lArBarrelEnvelope;            //!< envelope Cover of the Barrel
      double                           m_lArEndcapEnvelope;            //!< envelope Cover of the Endcap

      bool                             m_useCaloSurfBuilder;           //!< if true use DetDescr based layering, if false use biequidistant layering
      unsigned int                     m_lArLayersPerRegion;           //!< if m_useCaloSurfBuilder == true, number of layers per dead material region or sampling
      bool                             m_useCaloTrackingGeometryBounds;//!< if true use DetDescr based layering, if false use biequidistant layering

      ToolHandle<ICaloSurfaceBuilder>  m_calosurf;                      //!< tool required for DetDescr-based layering
      mutable std::map<const Trk::Material*, bool> m_materialGarbage;
  };
  
} // end of namespace

inline void LAr::LArVolumeBuilder::throwIntoGarbage(const Trk::Material* mat) const
{ if (mat) m_materialGarbage[mat] = true; }


#endif // CALOTRACKINGGEOMETRY_LARVOLUMEBUILDER_H