BDSGeometryFactoryGDML.hh

/* 
Beam Delivery Simulation (BDSIM) Copyright (C) Royal Holloway, 
University of London 2001 - 2024.
 
This file is part of BDSIM.
 
BDSIM is free software: you can redistribute it and/or modify 
it under the terms of the GNU General Public License as published 
by the Free Software Foundation version 3 of the License.
 
BDSIM is distributed in the hope that it will be useful, but 
WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
GNU General Public License for more details.
 
You should have received a copy of the GNU General Public License
along with BDSIM.  If not, see <http://www.gnu.org/licenses/>.
*/
#ifdef USE_GDML
 
#ifndef BDSGEOMETRYFACTORYGDML_H
#define BDSGEOMETRYFACTORYGDML_H
 
#include "BDSGeometryFactoryBase.hh"
 
#include "globals.hh"
#include "G4String.hh"
#include "G4VisAttributes.hh"
 
#include <array>
#include <map>
#include <set>
#include <vector>
 
class BDSGeometryExternal;
class G4Colour;
class G4GDMLParser;
class G4LogicalVolume;
class G4UserLimits;
class G4VPhysicalVolume;
 
class BDSGeometryFactoryGDML: public BDSGeometryFactoryBase
{
public:
  BDSGeometryFactoryGDML();
  virtual ~BDSGeometryFactoryGDML(){;}
 
  virtual BDSGeometryExternal* Build(G4String componentName,
                                     G4String fileName,
                                     std::map<G4String, G4Colour*>* colourMapping    = nullptr,
                                     G4bool                 autoColour               = true,
                                     G4double               suggestedLength          = 0,
                                     G4double               suggestedHorizontalWidth = 0,
                                     std::vector<G4String>* namedVacuumVolumes       = nullptr,
                                     G4bool                 makeSensitive            = true,
                                     BDSSDType              sensitivityType          = BDSSDType::energydep,
                                     BDSSDType              vacuumSensitivityType    = BDSSDType::energydepvacuum,
                                     G4UserLimits*          userLimitsToAttachToAllLVs = nullptr);
 
  static std::array<G4double, 4> VRGBAStringAndUnitToColourAndStyle(const G4String& value,
                                                                    G4bool& visible);
 
protected:
  virtual G4String PreprocessedName(const G4String& objectName,
                                    const G4String& acceleratorComponentName) const;
  
private:
  std::map<G4String, G4Colour*> BuildColourMap(const std::set<G4LogicalVolume*>& lvsGDML,
                                               G4GDMLParser* parser,
                                               const G4String& componentName);
 
  void ReplaceStringInFile(const G4String& filename,
                           const G4String& outputFileName,
                           const G4String& key,
                           const G4String& replacement);
 
  void GetAllLogicalPhysicalAndMaterials(const G4VPhysicalVolume*         volume,
                                         std::set<G4VPhysicalVolume*>&    pvs,
                                         std::set<G4LogicalVolume*>&      lvs,
                                         std::map<G4String, G4Material*>& materialsGDML);
};
 
#endif
 
#endif