Io/Obj/ObjTrackingGeometryWriter.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 "ActsExamples/Framework/AlgorithmContext.hpp"
0012 #include "ActsExamples/Framework/ProcessCode.hpp"
0013 #include <Acts/Utilities/Logger.hpp>
0014 #include <Acts/Visualization/ViewConfig.hpp>
0015
0016 #include <cstddef>
0017 #include <fstream>
0018 #include <iostream>
0019 #include <memory>
0020 #include <mutex>
0021 #include <string>
0022
0023 namespace Acts {
0024 class TrackingVolume;
0025 class TrackingGeometry;
0026 }  // namespace Acts
0027
0028 namespace ActsExamples {
0029 struct AlgorithmContext;
0030
0031 /// @class ObjTrackingGeometryWriter
0032 ///
0033 /// An Obj writer for the geometry: TrackingGeometry master
0034 /// It delegates the writing of surfaces to the surface writers
0035 class ObjTrackingGeometryWriter {
0036  public:
0037   // @class Config
0038   //
0039   // The nested config class
0040   class Config {
0041    public:
0042     double outputScalor = 1.0;        ///< scale output values
0043     std::size_t outputPrecision = 6;  ///< floating point precision
0044     std::filesystem::path outputDir = ".";
0045
0046     Acts::ViewConfig containerView = {.color = {220, 220, 220}};
0047     Acts::ViewConfig volumeView = {.color = {220, 220, 0}};
0048     Acts::ViewConfig sensitiveView = {.color = {0, 180, 240}};
0049     Acts::ViewConfig passiveView = {.color = {240, 280, 0}};
0050     Acts::ViewConfig gridView = {.color = {220, 0, 0}};
0051
0052     Acts::ViewConfig portalView = passiveView;
0053   };
0054
0055   /// Constructor
0056   /// @param config is the configuration class
0057   /// @param level the log level
0058   ObjTrackingGeometryWriter(const Config& config, Acts::Logging::Level level);
0059
0060   /// Framework name() method
0061   /// @return the name of the tool
0062   std::string name() const;
0063
0064   /// The write interface
0065   /// @param context the Algorithm/Event context of this call
0066   /// @param tGeometry is the geometry to be written out
0067   /// @return ProcessCode to indicate success/failure
0068   ActsExamples::ProcessCode write(const AlgorithmContext& context,
0069                                   const Acts::TrackingGeometry& tGeometry);
0070
0071  private:
0072   std::unique_ptr<const Acts::Logger> m_logger;  ///< the logger instance
0073
0074   Config m_cfg;  ///< the config class
0075
0076   /// process this volume
0077   /// @param context the Algorithm/Event context for this call
0078   /// @param tVolume the volume to be processed
0079   void write(const AlgorithmContext& context,
0080              const Acts::TrackingVolume& tVolume, bool gen3 = false);
0081
0082   /// Private access to the logging instance
0083   const Acts::Logger& logger() const { return *m_logger; }
0084 };
0085
0086 }  // namespace ActsExamples