The FBX-writer module. More...

#include <FBXWriterModule.h>

Inheritance diagram for FBXWriterModule:

Public Types
enum	EModulePropFlags { c_Input = 1 , c_Output = 2 , c_ParallelProcessingCertified = 4 , c_HistogramManager = 8 , c_InternalSerializer = 16 , c_TerminateInAllProcesses = 32 , c_DontCollectStatistics = 64 }
	Each module can be tagged with property flags, which indicate certain features of the module. More...

typedef ModuleCondition::EAfterConditionPath	EAfterConditionPath
	Forward the EAfterConditionPath definition from the ModuleCondition.

Public Member Functions
	FBXWriterModule ()
	Constructor of the module.

void	initialize () override
	Initialize at the start of a job.

void	event () override
	Called for each event: this runs the FBX writer only for the first event.

virtual std::vector< std::string >	getFileNames (bool outputFiles)
	Return a list of output filenames for this modules.

virtual void	beginRun ()
	Called when entering a new run.

virtual void	endRun ()
	This method is called if the current run ends.

virtual void	terminate ()
	This method is called at the end of the event processing.

const std::string &	getName () const
	Returns the name of the module.

const std::string &	getType () const
	Returns the type of the module (i.e.

const std::string &	getPackage () const
	Returns the package this module is in.

const std::string &	getDescription () const
	Returns the description of the module.

void	setName (const std::string &name)
	Set the name of the module.

void	setPropertyFlags (unsigned int propertyFlags)
	Sets the flags for the module properties.

LogConfig &	getLogConfig ()
	Returns the log system configuration.

void	setLogConfig (const LogConfig &logConfig)
	Set the log system configuration.

void	setLogLevel (int logLevel)
	Configure the log level.

void	setDebugLevel (int debugLevel)
	Configure the debug messaging level.

void	setAbortLevel (int abortLevel)
	Configure the abort log level.

void	setLogInfo (int logLevel, unsigned int logInfo)
	Configure the printed log information for the given level.

void	if_value (const std::string &expression, const std::shared_ptr< Path > &path, EAfterConditionPath afterConditionPath=EAfterConditionPath::c_End)
	Add a condition to the module.

void	if_false (const std::shared_ptr< Path > &path, EAfterConditionPath afterConditionPath=EAfterConditionPath::c_End)
	A simplified version to add a condition to the module.

void	if_true (const std::shared_ptr< Path > &path, EAfterConditionPath afterConditionPath=EAfterConditionPath::c_End)
	A simplified version to set the condition of the module.

bool	hasCondition () const
	Returns true if at least one condition was set for the module.

const ModuleCondition *	getCondition () const
	Return a pointer to the first condition (or nullptr, if none was set)

const std::vector< ModuleCondition > &	getAllConditions () const
	Return all set conditions for this module.

bool	evalCondition () const
	If at least one condition was set, it is evaluated and true returned if at least one condition returns true.

std::shared_ptr< Path >	getConditionPath () const
	Returns the path of the last true condition (if there is at least one, else reaturn a null pointer).

Module::EAfterConditionPath	getAfterConditionPath () const
	What to do after the conditional path is finished.

std::vector< std::shared_ptr< Path > >	getAllConditionPaths () const
	Return all condition paths currently set (no matter if the condition is true or not).

bool	hasProperties (unsigned int propertyFlags) const
	Returns true if all specified property flags are available in this module.

bool	hasUnsetForcedParams () const
	Returns true and prints error message if the module has unset parameters which the user has to set in the steering file.

const ModuleParamList &	getParamList () const
	Return module param list.

template<typename T >
ModuleParam< T > &	getParam (const std::string &name) const
	Returns a reference to a parameter.

bool	hasReturnValue () const
	Return true if this module has a valid return value set.

int	getReturnValue () const
	Return the return value set by this module.

std::shared_ptr< PathElement >	clone () const override
	Create an independent copy of this module.

std::shared_ptr< boost::python::list >	getParamInfoListPython () const
	Returns a python list of all parameters.

Static Public Member Functions
static void	exposePythonAPI ()
	Exposes methods of the Module class to Python.

Protected Member Functions
virtual void	def_initialize ()
	Wrappers to make the methods without "def_" prefix callable from Python.

virtual void	def_beginRun ()
	Wrapper method for the virtual function beginRun() that has the implementation to be used in a call from Python.

virtual void	def_event ()
	Wrapper method for the virtual function event() that has the implementation to be used in a call from Python.

virtual void	def_endRun ()
	This method can receive that the current run ends as a call from the Python side.

virtual void	def_terminate ()
	Wrapper method for the virtual function terminate() that has the implementation to be used in a call from Python.

void	setDescription (const std::string &description)
	Sets the description of the module.

void	setType (const std::string &type)
	Set the module type.

template<typename T >
void	addParam (const std::string &name, T &paramVariable, const std::string &description, const T &defaultValue)
	Adds a new parameter to the module.

template<typename T >
void	addParam (const std::string &name, T &paramVariable, const std::string &description)
	Adds a new enforced parameter to the module.

void	setReturnValue (int value)
	Sets the return value for this module as integer.

void	setReturnValue (bool value)
	Sets the return value for this module as bool.

void	setParamList (const ModuleParamList &params)
	Replace existing parameter list.

Private Member Functions
void	assignName (std::vector< std::string > *, unsigned int, const G4String &, int)
	Create unique and legal name for each solid, logical volume, physical volume.

void	writeGeometryNode (G4VSolid *, const std::string &, unsigned long long)
	Write FBX definition for each solid's polyhedron.

void	writeMaterialNode (int, const std::string &)
	Write FBX definition for each logical volume's color information.

void	writeLVModelNode (G4LogicalVolume *, const std::string &, unsigned long long)
	Write FBX definition for each logical volume.

void	writePVModelNode (G4VPhysicalVolume *, const std::string &, unsigned long long)
	Write FBX definition for each physical volume.

void	countEntities (G4VPhysicalVolume *)
	Count the physical volumes, logical volumes, materials and solids (recursive)

void	addModels (G4VPhysicalVolume *, int)
	Process one physical volume for FBX-node writing (recursive)

void	addConnections (G4VPhysicalVolume *, int)
	Write FBX connections among all of the nodes in the tree (recursive)

void	writePreamble (int, int, int)
	Write FBX at the start of the file.

void	writePolyhedron (G4VSolid , G4Polyhedron , const std::string &, unsigned long long)
	Write FBX definition for the solid's polyhedron.

void	writeSolidToLV (const std::string &, const std::string &, bool, unsigned long long, unsigned long long, unsigned long long)
	Write FBX connection for each logical volume's solid and color info.

void	writeSolidToPV (const std::string &, const std::string &, bool, unsigned long long, unsigned long long, unsigned long long)
	Write FBX connection for each physical volume's solid and color info (bypass singleton logical volume)

void	writeLVToPV (const std::string &, const std::string &, unsigned long long, unsigned long long)
	Write FBX connection for the (unique) logical volume of a physical volume.

void	writePVToParentLV (const std::string &, const std::string &, unsigned long long, unsigned long long)
	Write FBX connection for each physical-volume daughter of a parent logical volume.

void	writePVToParentPV (const std::string &, const std::string &, unsigned long long, unsigned long long)
	Write FBX connection for each physical-volume daughter of a parent physical volume (bypass singleton logical volume)

HepPolyhedron *	getBooleanSolidPolyhedron (G4VSolid *)
	Create polyhedron for a boolean solid (recursive)

std::list< ModulePtr >	getModules () const override
	no submodules, return empty list

std::string	getPathString () const override
	return the module name.

void	setParamPython (const std::string &name, const boost::python::object &pyObj)
	Implements a method for setting boost::python objects.

void	setParamPythonDict (const boost::python::dict &dictionary)
	Implements a method for reading the parameter values from a boost::python dictionary.

Private Attributes
bool	m_First {true}
	Once-only flag to write FBX only on the first event.

bool	m_UsePrototypes {false}
	User-specified flag to select whether to write and re-use logical- and physical-volume prototypes once (true) or to write duplicates of each such volume (false).

std::string	m_Filename {"belle2.fbx"}
	User-specified output filename.

std::ofstream	m_File
	Output file.

std::vector< std::string > *	m_PVName {nullptr}
	Modified (legal-character and unique) physical-volume name.

std::vector< std::string > *	m_LVName {nullptr}
	Modified (legal-character and unique) logical-volume name.

std::vector< std::string > *	m_SolidName {nullptr}
	Modified (legal-character and unique) solid name.

std::vector< unsigned long long > *	m_PVID {nullptr}
	Unique identifiers for physical volumes (Model nodes with transformation information)

std::vector< unsigned long long > *	m_LVID {nullptr}
	Unique identifiers for logical volumes (Model nodes with links to Geometry and Material)

std::vector< unsigned long long > *	m_MatID {nullptr}
	Unique identifiers for logical volumes' color information (Material nodes)

std::vector< unsigned long long > *	m_SolidID {nullptr}
	Unique identifiers for solids (Geometry nodes)

std::vector< bool > *	m_Visible {nullptr}
	Flag to indicate that the logical volume is visible.

std::vector< unsigned int > *	m_PVCount {nullptr}
	Count of number of instances of each physical volume.

std::vector< unsigned int > *	m_LVCount {nullptr}
	Count of number of instances of each logical volume.

std::vector< unsigned int > *	m_SolidCount {nullptr}
	Count of number of instances of each solid (typically 1)

std::vector< unsigned int > *	m_PVReplicas {nullptr}
	Count of number of replicas of each replicated physical volume.

std::vector< unsigned int > *	m_LVReplicas {nullptr}
	Count of number of replicas of each logical volume associated with a replicated physical volume.

std::vector< unsigned int > *	m_SolidReplicas {nullptr}
	Count of number of replicas of each solid (extras for replicas with modified solids)

std::vector< bool > *	m_LVUnique {nullptr}
	Flag to indicate that a logical volume is referenced at most once (eligible for bypass)

std::string	m_name
	The name of the module, saved as a string (user-modifiable)

std::string	m_type
	The type of the module, saved as a string.

std::string	m_package
	Package this module is found in (may be empty).

std::string	m_description
	The description of the module.

unsigned int	m_propertyFlags
	The properties of the module as bitwise or (with \|) of EModulePropFlags.

LogConfig	m_logConfig
	The log system configuration of the module.

ModuleParamList	m_moduleParamList
	List storing and managing all parameter of the module.

bool	m_hasReturnValue
	True, if the return value is set.

int	m_returnValue
	The return value.

std::vector< ModuleCondition >	m_conditions
	Module condition, only non-null if set.

Detailed Description

The FBX-writer module.

This module goes through all volumes of the Belle II detector geometry and write an Autodesk FBX file.

This module requires a valid geometry. Therefore, a geometry-building module should have been executed before this module is called.

Definition at line 37 of file FBXWriterModule.h.

Member Typedef Documentation

◆ EAfterConditionPath

typedef ModuleCondition::EAfterConditionPath EAfterConditionPath

inherited

Forward the EAfterConditionPath definition from the ModuleCondition.

Definition at line 88 of file Module.h.

Member Enumeration Documentation

◆ EModulePropFlags

enum EModulePropFlags

inherited

Each module can be tagged with property flags, which indicate certain features of the module.

Enumerator
c_Input	This module is an input module (reads data).
c_Output	This module is an output module (writes data).
c_ParallelProcessingCertified	This module can be run in parallel processing mode safely (All I/O must be done through the data store, in particular, the module must not write any files.)
c_HistogramManager	This module is used to manage histograms accumulated by other modules.
c_InternalSerializer	This module is an internal serializer/deserializer for parallel processing.
c_TerminateInAllProcesses	When using parallel processing, call this module's terminate() function in all processes(). This will also ensure that there is exactly one process (single-core if no parallel modules found) or at least one input, one main and one output process.
c_DontCollectStatistics	No statistics is collected for this module.

Definition at line 77 of file Module.h.

                          {
      c_Input                       = 1,  
      c_Output                      = 2,  
      c_ParallelProcessingCertified = 4,  
      c_HistogramManager            = 8, 
      c_InternalSerializer          = 16,  
      c_TerminateInAllProcesses     = 32,  
      c_DontCollectStatistics       = 64,  
    };

Constructor & Destructor Documentation

◆ FBXWriterModule()

FBXWriterModule ( )

Constructor of the module.

Definition at line 34 of file FBXWriterModule.cc.

{
  //Set module properties and the description
  setDescription("Write the detector geometry in a (semi-)hierarchical FBX format.");
 
  //Parameter definition
  addParam("usePrototypes", m_UsePrototypes, "Use LogVol and PhysVol prototypes", false);
 
  //Parameter definition
  addParam("outputFile", m_Filename, "Output filename", std::string("belle2.fbx"));
}

Member Function Documentation

◆ addConnections()

void addConnections	(	G4VPhysicalVolume *	physVol,
		int	replica
	)

private

Write FBX connections among all of the nodes in the tree (recursive)

Definition at line 481 of file FBXWriterModule.cc.

{
  // Write the PhysVolModel-parentLogVolModel connections as we descend the recursive tree.
  // If the parentLogVol is referenced at most once, use its referencing PhysVol instead.
  G4PhysicalVolumeStore* pvStore = G4PhysicalVolumeStore::GetInstance();
  G4LogicalVolumeStore* lvStore = G4LogicalVolumeStore::GetInstance();
  G4SolidStore* solidStore = G4SolidStore::GetInstance();
  G4LogicalVolume* logVol = physVol->GetLogicalVolume();
  int pvIndex = std::find(pvStore->begin(), pvStore->end(), physVol) - pvStore->begin();
  unsigned long long pvID = (*m_PVID)[pvIndex];
  unsigned int pvCount = (*m_PVCount)[pvIndex];
  std::string pvName = (*m_PVName)[pvIndex];
  int lvIndex = std::find(lvStore->begin(), lvStore->end(), logVol) - lvStore->begin();
  unsigned long long lvID = (*m_LVID)[lvIndex];
  unsigned int lvCount = (*m_LVCount)[lvIndex];
  std::string lvName = (*m_LVName)[lvIndex];
  for (size_t daughter = 0; daughter < logVol->GetNoDaughters(); ++daughter) {
    G4VPhysicalVolume* physVolDaughter = logVol->GetDaughter(daughter);
    int pvIndexDaughter = std::find(pvStore->begin(), pvStore->end(), physVolDaughter) - pvStore->begin();
    unsigned long long pvIDDaughter = (*m_PVID)[pvIndexDaughter];
    unsigned int pvCountDaughter = (*m_PVCount)[pvIndexDaughter];
    for (int j = 0; j < physVolDaughter->GetMultiplicity(); ++j) {
      if (m_UsePrototypes) {
        if ((replica == 0) && (j == 0) && (lvCount == 0) && (pvCountDaughter == 0)) {
          if ((*m_LVUnique)[lvIndex]) {
            writePVToParentPV((*m_PVName)[pvIndexDaughter], pvName, pvIDDaughter, pvID);
          } else {
            writePVToParentLV((*m_PVName)[pvIndexDaughter], lvName, pvIDDaughter, lvID);
          }
        }
      } else {
        //writePVToParentLV((*m_PVName)[pvIndexDaughter], lvName, pvIDDaughter+0x00010000*j+pvCountDaughter, lvID+0x00010000*replica+lvCount);
        writePVToParentPV((*m_PVName)[pvIndexDaughter], pvName, pvIDDaughter + 0x00010000 * j + pvCountDaughter,
                          pvID + 0x00010000 * replica + pvCount);
      }
      addConnections(physVolDaughter, j);
    }
  }
 
  // Write the Geometry-LogVolModel, Material-LogVolModel and PhysVolModel-LogVolModel
  // connections as we ascend the recursive tree
  G4VSolid* solid = logVol->GetSolid();
  int solidIndex = std::find(solidStore->begin(), solidStore->end(), solid) - solidStore->begin();
  unsigned long long solidID = (*m_SolidID)[solidIndex];
  unsigned long long matID = (*m_MatID)[lvIndex];
  std::string solidName = (*m_SolidName)[solidIndex];
  if (physVol->IsReplicated()) {
    pvName.append("_R");
    pvName.append(std::to_string(replica));
    EAxis axis;
    G4int nReplicas;
    G4double width;
    G4double offset;
    G4bool consuming;
    physVol->GetReplicationData(axis, nReplicas, width, offset, consuming);
    physVol->SetCopyNo(replica);
    G4VPVParameterisation* physParameterisation = physVol->GetParameterisation();
    if (physParameterisation) { // parameterised volume
      G4VSolid* solidReplica = physParameterisation->ComputeSolid(replica, physVol);
      physParameterisation->ComputeTransformation(replica, physVol);
      solidReplica->ComputeDimensions(physParameterisation, replica, physVol);
      if (!(*solidReplica == *solid)) {
        solidName.append("_R");
        solidName.append(std::to_string(replica));
        solidID += 0x00010000 * replica;
      }
      if (m_UsePrototypes && (*solidReplica == *solid)) {
        if ((replica == 0) && (lvCount == 0)) {
          if ((*m_LVUnique)[lvIndex]) { // bypass the singleton logical volume
            writeSolidToPV(pvName, solidName, (*m_Visible)[lvIndex], matID, pvID, solidID);
          } else {
            writeSolidToLV(lvName, solidName, (*m_Visible)[lvIndex], matID, lvID, solidID);
          }
        }
      } else {
        lvName.append("_R");
        lvName.append(std::to_string(replica));
        if ((*m_LVUnique)[lvIndex]) { // bypass the singleton logical volume
          writeSolidToPV(pvName, solidName, (*m_Visible)[lvIndex], matID, pvID + 0x00010000 * replica + pvCount, solidID);
        } else {
          writeSolidToLV(lvName, solidName, (*m_Visible)[lvIndex], matID, lvID + 0x00010000 * replica + lvCount, solidID);
        }
      }
      if (!(*m_LVUnique)[lvIndex]) {
        writeLVToPV(pvName, lvName, pvID + 0x00010000 * replica + pvCount, lvID + 0x00010000 * replica + lvCount);
      }
    } else { // plain replicated volume
      if ((axis == kRho) && (solid->GetEntityType() == "G4Tubs")) {
        solidName.append("_R");
        solidName.append(std::to_string(replica));
        solidID += 0x00010000 * replica;
      }
      if (m_UsePrototypes && !((axis == kRho) && (solid->GetEntityType() == "G4Tubs"))) {
        if ((replica == 0) && (lvCount == 0)) {
          if ((*m_LVUnique)[lvIndex]) { // bypass the singleton logical volume
            writeSolidToPV(pvName, solidName, (*m_Visible)[lvIndex], matID, pvID, solidID);
          } else {
            writeSolidToLV(lvName, solidName, (*m_Visible)[lvIndex], matID, lvID, solidID);
          }
        }
      } else {
        lvName.append("_R");
        lvName.append(std::to_string(replica));
        if ((*m_LVUnique)[lvIndex]) { // bypass the singleton logical volume
          writeSolidToPV(pvName, solidName, (*m_Visible)[lvIndex], matID, pvID + 0x00010000 * replica + pvCount, solidID);
        } else {
          writeSolidToLV(lvName, solidName, (*m_Visible)[lvIndex], matID, lvID + 0x00010000 * replica + lvCount, solidID);
        }
      }
      if (!(*m_LVUnique)[lvIndex]) {
        writeLVToPV(pvName, lvName, pvID + 0x00010000 * replica + pvCount, lvID + 0x00010000 * replica + lvCount);
      }
    }
  } else {
    if (m_UsePrototypes) {
      if (lvCount == 0) {
        if ((*m_LVUnique)[lvIndex]) { // bypass the singleton logical volume
          writeSolidToPV(pvName, solidName, (*m_Visible)[lvIndex], matID, pvID, solidID);
        } else {
          writeSolidToLV(lvName, solidName, (*m_Visible)[lvIndex], matID, lvID, solidID);
        }
      }
      if (pvCount == 0) {
        if (!(*m_LVUnique)[lvIndex]) writeLVToPV(pvName, lvName, pvID, lvID);
      }
    } else {
      //writeSolidToLV(lvName, solidName, (*m_Visible)[lvIndex], matID, lvID+lvCount, solidID);
      //writeLVToPV(pvName, lvName, pvID+pvCount, lvID+lvCount);
      writeSolidToPV(pvName, solidName, (*m_Visible)[lvIndex], matID, pvID + pvCount, solidID);
    }
    (*m_LVCount)[lvIndex]++;
    (*m_PVCount)[pvIndex]++;
  }
}

◆ addModels()

void addModels	(	G4VPhysicalVolume *	physVol,
		int	replica
	)

private

Process one physical volume for FBX-node writing (recursive)

Definition at line 295 of file FBXWriterModule.cc.

{
  // Descend to the leaves of the tree
  G4LogicalVolume* logVol = physVol->GetLogicalVolume();
  for (size_t daughter = 0; daughter < logVol->GetNoDaughters(); ++daughter) {
    G4VPhysicalVolume* physVolDaughter = logVol->GetDaughter(daughter);
    for (int j = 0; j < physVolDaughter->GetMultiplicity(); ++j) {
      addModels(physVolDaughter, j);
    }
  }
 
  // Write the physical- and logical-volume models as we ascend the recursive tree
  G4PhysicalVolumeStore* pvStore = G4PhysicalVolumeStore::GetInstance();
  G4LogicalVolumeStore* lvStore = G4LogicalVolumeStore::GetInstance();
  int pvIndex = std::find(pvStore->begin(), pvStore->end(), physVol) - pvStore->begin();
  unsigned long long pvID = (*m_PVID)[pvIndex];
  unsigned int pvCount = (*m_PVCount)[pvIndex];
  std::string pvName = (*m_PVName)[pvIndex];
  int lvIndex = std::find(lvStore->begin(), lvStore->end(), logVol) - lvStore->begin();
  unsigned long long lvID = (*m_LVID)[lvIndex];
  unsigned int lvCount = (*m_LVCount)[lvIndex];
  std::string lvName = (*m_LVName)[lvIndex];
  if ((*m_LVUnique)[lvIndex]) writeMaterialNode(lvIndex, (*m_PVName)[pvIndex]);
  if (physVol->IsReplicated()) {
    G4VSolid* solid = logVol->GetSolid();
    G4SolidStore* solidStore = G4SolidStore::GetInstance();
    int solidIndex = std::find(solidStore->begin(), solidStore->end(), solid) - solidStore->begin();
    unsigned long long solidID = (*m_SolidID)[solidIndex];
    EAxis axis;
    G4int nReplicas;
    G4double width;
    G4double offset;
    G4bool consuming;
    physVol->GetReplicationData(axis, nReplicas, width, offset, consuming);
    physVol->SetCopyNo(replica);
    G4VPVParameterisation* physParameterisation = physVol->GetParameterisation();
    if (physParameterisation) { // parameterised volume
      G4VSolid* solidReplica = physParameterisation->ComputeSolid(replica, physVol);
      physParameterisation->ComputeTransformation(replica, physVol);
      solidReplica->ComputeDimensions(physParameterisation, replica, physVol);
      if (!(*solidReplica == *solid)) {
        std::string solidName = (*m_SolidName)[solidIndex];
        solidName.append("_R");
        solidName.append(std::to_string(replica));
        writeGeometryNode(solidReplica, solidName, solidID + 0x00010000 * replica);
      }
      if (m_UsePrototypes && (*solidReplica == *solid)) {
        if ((replica == 0) && (lvCount == 0)) {
          if (!(*m_LVUnique)[lvIndex]) writeLVModelNode((*lvStore)[lvIndex], lvName, lvID);
        }
      } else {
        // DIVOT lvName.append("_R");
        // DIVOT lvName.append(std::to_string(replica));
        // DIVOT writeLVModelNode((*lvStore)[lvIndex], lvName, lvID+0x00010000*replica+lvCount);
      }
      pvName.append("_R");
      pvName.append(std::to_string(replica));
      writePVModelNode(physVol, pvName, pvID + 0x00010000 * replica + pvCount);
    } else { // plain replicated volume
      G4RotationMatrix* originalRotation = physVol->GetRotation();
      G4ThreeVector translation; // No translation
      G4RotationMatrix rotation; // No rotation
      switch (axis) {
        default:
        case kXAxis:
          translation.setX(width * (replica - 0.5 * (nReplicas - 1)));
          physVol->SetTranslation(translation);
          break;
        case kYAxis:
          translation.setY(width * (replica - 0.5 * (nReplicas - 1)));
          physVol->SetTranslation(translation);
          break;
        case kZAxis:
          translation.setZ(width * (replica - 0.5 * (nReplicas - 1)));
          physVol->SetTranslation(translation);
          break;
        case kRho:
          if (solid->GetEntityType() == "G4Tubs") {
            double originalRMin = ((G4Tubs*)solid)->GetInnerRadius();
            double originalRMax = ((G4Tubs*)solid)->GetOuterRadius();
            ((G4Tubs*)solid)->SetInnerRadius(offset + width * replica);
            ((G4Tubs*)solid)->SetOuterRadius(offset + width * (replica + 1));
            std::string solidName = (*m_SolidName)[solidIndex];
            solidName.append("_R");
            solidName.append(std::to_string(replica));
            writeGeometryNode(solid, solidName, (*m_SolidID)[solidIndex] + 0x00010000 * replica);
            ((G4Tubs*)solid)->SetInnerRadius(originalRMin);
            ((G4Tubs*)solid)->SetOuterRadius(originalRMax);
          } else if (replica == 0) {
            B2WARNING("Built-in volumes replicated along radius for " << solid->GetEntityType() <<
                      " (solid " << solid->GetName() << ") are not visualisable.");
          }
          break;
        case kPhi:
          physVol->SetRotation(&(rotation.rotateZ(-(offset + (replica + 0.5) * width))));
          break;
      }
      if (m_UsePrototypes && !((axis == kRho) && (solid->GetEntityType() == "G4Tubs"))) {
        if ((replica == 0) && (lvCount == 0)) {
          if (!(*m_LVUnique)[lvIndex]) writeLVModelNode((*lvStore)[lvIndex], lvName, lvID);
        }
      } else {
        // DIVOT lvName.append("_R");
        // DIVOT lvName.append(std::to_string(replica));
        // DIVOT writeLVModelNode((*lvStore)[lvIndex], lvName, lvID+0x00010000*replica+lvCount);
      }
      pvName.append("_R");
      pvName.append(std::to_string(replica));
      writePVModelNode(physVol, pvName, pvID + 0x00010000 * replica + pvCount);
      if (axis == kPhi) physVol->SetRotation(originalRotation);
    }
  } else {
    if (m_UsePrototypes) {
      if (lvCount == 0) {
        if (!(*m_LVUnique)[lvIndex]) writeLVModelNode((*lvStore)[lvIndex], lvName, lvID);
      }
      if (pvCount == 0) writePVModelNode(physVol, pvName, pvID);
    } else {
      // DIVOT writeLVModelNode((*lvStore)[lvIndex], lvName, lvID+lvCount);
      writePVModelNode(physVol, pvName, pvID + pvCount);
    }
    (*m_LVCount)[lvIndex]++;
    (*m_PVCount)[pvIndex]++;
  }
}

◆ assignName()

void assignName	(	std::vector< std::string > *	names,
		unsigned int	index,
		const G4String &	originalName,
		int	select
	)

private

Create unique and legal name for each solid, logical volume, physical volume.

Definition at line 186 of file FBXWriterModule.cc.

{
  G4PhysicalVolumeStore* pvStore = G4PhysicalVolumeStore::GetInstance();
  G4LogicalVolumeStore* lvStore = G4LogicalVolumeStore::GetInstance();
  G4SolidStore* solidStore = G4SolidStore::GetInstance();
 
  G4String name = originalName;
  if (name.length() == 0) { name = "anonymous"; }
  // Replace problematic characters with underscore
  for (char c : " .,:;?'\"*+-=|^!/@#$\\%{}[]()<>") std::replace(name.begin(), name.end(), c, '_');
  // Avoid duplicate names for entities that will be written to FBX file
  for (int j = (int)index - 1; j >= 0; --j) {
    if ((*names)[j].length() == 0) continue;
    int match = 0;
    switch (select) {
      case 0:
        match = (*pvStore)[j]->GetName().compare((*pvStore)[index]->GetName()); break;
      case 1:
        match = (*lvStore)[j]->GetName().compare((*lvStore)[index]->GetName()); break;
      case 2:
        match = (*solidStore)[j]->GetName().compare((*solidStore)[index]->GetName()); break;
    }
    if (match == 0) {
      if (name.length() == (*names)[j].length()) {
        (*names)[j].append("_1");
      }
      int n = std::stoi((*names)[j].substr(name.length() + 1), nullptr);
      name.append("_");
      name.append(std::to_string(n + 1));
      break;
    }
  }
  (*names)[index] = name;
}

◆ beginRun()

virtual void beginRun ( void )

inlinevirtualinherited

Called when entering a new run.

Called at the beginning of each run, the method gives you the chance to change run dependent constants like alignment parameters, etc.

This method can be implemented by subclasses.

Definition at line 147 of file Module.h.

147{};

◆ clone()

std::shared_ptr< PathElement > clone ( ) const

overridevirtualinherited

Create an independent copy of this module.

Note that parameters are shared, so changing them on a cloned module will also affect the original module.

Implements PathElement.

Definition at line 179 of file Module.cc.

{
  ModulePtr newModule = ModuleManager::Instance().registerModule(getType());
  newModule->m_moduleParamList.setParameters(getParamList());
  newModule->setName(getName());
  newModule->m_package = m_package;
  newModule->m_propertyFlags = m_propertyFlags;
  newModule->m_logConfig = m_logConfig;
  newModule->m_conditions = m_conditions;
 
  return newModule;
}

◆ countEntities()

void countEntities ( G4VPhysicalVolume * physVol )

private

Count the physical volumes, logical volumes, materials and solids (recursive)

Definition at line 421 of file FBXWriterModule.cc.

{
  // Descend to the leaves of the tree
  G4LogicalVolume* logVol = physVol->GetLogicalVolume();
  for (size_t daughter = 0; daughter < logVol->GetNoDaughters(); ++daughter) {
    G4VPhysicalVolume* physVolDaughter = logVol->GetDaughter(daughter);
    for (int j = 0; j < physVolDaughter->GetMultiplicity(); ++j) {
      countEntities(physVolDaughter);
    }
  }
  // Count replicas and duplicates of each physical and logical volume as well as the unique
  // versions of replicated solids as we ascend the recursive tree
  G4PhysicalVolumeStore* pvStore = G4PhysicalVolumeStore::GetInstance();
  G4LogicalVolumeStore* lvStore = G4LogicalVolumeStore::GetInstance();
  G4SolidStore* solidStore = G4SolidStore::GetInstance();
  G4VSolid* solid = logVol->GetSolid();
  int pvIndex = std::find(pvStore->begin(), pvStore->end(), physVol) - pvStore->begin();
  int lvIndex = std::find(lvStore->begin(), lvStore->end(), logVol) - lvStore->begin();
  int solidIndex = std::find(solidStore->begin(), solidStore->end(), solid) - solidStore->begin();
  if (physVol->IsReplicated()) {
    EAxis axis;
    G4int nReplicas;
    G4double width;
    G4double offset;
    G4bool consuming;
    physVol->GetReplicationData(axis, nReplicas, width, offset, consuming);
    G4VPVParameterisation* physParameterisation = physVol->GetParameterisation();
    if (physParameterisation) { // parameterised volume
      G4VSolid* solidReplica = physParameterisation->ComputeSolid(0, physVol);
      physParameterisation->ComputeTransformation(0, physVol);
      solidReplica->ComputeDimensions(physParameterisation, 0, physVol);
      if (!(*solidReplica == *solid))(*m_SolidReplicas)[solidIndex]++;
      if (m_UsePrototypes && (*solidReplica == *solid)) {
        if ((*m_LVReplicas)[lvIndex] > 0)(*m_LVUnique)[lvIndex] = false;
        (*m_LVReplicas)[lvIndex] = 1;
      } else {
        (*m_LVReplicas)[lvIndex]++;
      }
      (*m_PVReplicas)[pvIndex]++;
    } else { // plain replicated volume
      if ((axis == kRho) && (solid->GetEntityType() == "G4Tubs"))(*m_SolidReplicas)[solidIndex]++;
      if (m_UsePrototypes && !((axis == kRho) && (solid->GetEntityType() == "G4Tubs"))) {
        (*m_LVReplicas)[lvIndex] = 1;
      } else {
        (*m_LVReplicas)[lvIndex]++;
      }
      (*m_PVReplicas)[pvIndex]++;
    }
  } else {
    if ((*m_LVCount)[lvIndex] > 0)(*m_LVUnique)[lvIndex] = false;
    if (m_UsePrototypes) {
      (*m_PVCount)[pvIndex] = 1;
      (*m_LVCount)[lvIndex] = 1;
    } else {
      (*m_PVCount)[pvIndex]++;
      (*m_LVCount)[lvIndex]++;
    }
  }
}

◆ def_beginRun()

virtual void def_beginRun ( )

inlineprotectedvirtualinherited

Wrapper method for the virtual function beginRun() that has the implementation to be used in a call from Python.

Reimplemented in PyModule.

Definition at line 426 of file Module.h.

426{ beginRun(); }

Belle2::Module::beginRun

virtual void beginRun()

Called when entering a new run.

Definition: Module.h:147

◆ def_endRun()

virtual void def_endRun ( )

inlineprotectedvirtualinherited

This method can receive that the current run ends as a call from the Python side.

For regular C++-Modules that forwards the call to the regular endRun() method.

Reimplemented in PyModule.

Definition at line 439 of file Module.h.

439{ endRun(); }

Belle2::Module::endRun

virtual void endRun()

This method is called if the current run ends.

Definition: Module.h:166

◆ def_event()

virtual void def_event ( )

inlineprotectedvirtualinherited

Wrapper method for the virtual function event() that has the implementation to be used in a call from Python.

Reimplemented in PyModule.

Definition at line 432 of file Module.h.

432{ event(); }

Belle2::Module::event

virtual void event()

This method is the core of the module.

Definition: Module.h:157

◆ def_initialize()

virtual void def_initialize ( )

inlineprotectedvirtualinherited

Wrappers to make the methods without "def_" prefix callable from Python.

Overridden in PyModule. Wrapper method for the virtual function initialize() that has the implementation to be used in a call from Python.

Reimplemented in PyModule.

Definition at line 420 of file Module.h.

420{ initialize(); }

Belle2::Module::initialize

virtual void initialize()

Initialize the Module.

Definition: Module.h:109

◆ def_terminate()

virtual void def_terminate ( )

inlineprotectedvirtualinherited

Wrapper method for the virtual function terminate() that has the implementation to be used in a call from Python.

Reimplemented in PyModule.

Definition at line 445 of file Module.h.

445{ terminate(); }

Belle2::Module::terminate

virtual void terminate()

This method is called at the end of the event processing.

Definition: Module.h:176

◆ endRun()

virtual void endRun ( void )

inlinevirtualinherited

This method is called if the current run ends.

Use this method to store information, which should be aggregated over one run.

This method can be implemented by subclasses.

Definition at line 166 of file Module.h.

166{};

◆ evalCondition()

bool evalCondition ( ) const

inherited

If at least one condition was set, it is evaluated and true returned if at least one condition returns true.

If no condition or result value was defined, the method returns false. Otherwise, the condition is evaluated and true returned, if at least one condition returns true. To speed up the evaluation, the condition strings were already parsed in the method if_value().

Returns: True if at least one condition and return value exists and at least one condition expression was evaluated to true.

Definition at line 96 of file Module.cc.

{
  if (m_conditions.empty()) return false;
 
  //okay, a condition was set for this Module...
  if (!m_hasReturnValue) {
    B2FATAL("A condition was set for '" << getName() << "', but the module did not set a return value!");
  }
 
  for (const auto& condition : m_conditions) {
    if (condition.evaluate(m_returnValue)) {
      return true;
    }
  }
  return false;
}

◆ event()

void event ( void )

overridevirtual

Called for each event: this runs the FBX writer only for the first event.

Reimplemented from Module.

Definition at line 51 of file FBXWriterModule.cc.

{
  if (!m_First) return;
  m_First = false;
  G4VPhysicalVolume* topVol = geometry::GeometryManager::getInstance().getTopVolume();
  if (!topVol) {
    B2ERROR("No geometry found: add the Geometry module to the path before the FBXWriter module.");
    return;
  }
 
  G4PhysicalVolumeStore* pvStore = G4PhysicalVolumeStore::GetInstance();
  G4LogicalVolumeStore* lvStore = G4LogicalVolumeStore::GetInstance();
  G4SolidStore* solidStore = G4SolidStore::GetInstance();
 
  // Assign legal and unique names to each used physical volume, logical volume and solid
  m_PVName = new std::vector<std::string>(pvStore->size(), "");
  m_LVName = new std::vector<std::string>(lvStore->size(), "");
  m_SolidName = new std::vector<std::string>(solidStore->size(), "");
  for (G4VPhysicalVolume* physVol : *pvStore) {
    int pvIndex = std::find(pvStore->begin(), pvStore->end(), physVol) - pvStore->begin();
    if ((*m_PVName)[pvIndex].length() == 0) {
      assignName(m_PVName, pvIndex, physVol->GetName(), 0);
      G4LogicalVolume* logVol = physVol->GetLogicalVolume();
      int lvIndex = std::find(lvStore->begin(), lvStore->end(), logVol) - lvStore->begin();
      if ((*m_LVName)[lvIndex].length() == 0) {
        assignName(m_LVName, lvIndex, logVol->GetName(), 1);
        G4VSolid* solid = logVol->GetSolid();
        int solidIndex = std::find(solidStore->begin(), solidStore->end(), solid) - solidStore->begin();
        if ((*m_SolidName)[solidIndex].length() == 0) {
          assignName(m_SolidName, solidIndex, solid->GetName(), 2);
        }
      }
    }
  }
 
  // Count the number of references to each physical volume and logical volume and solid
  // so that these values can be placed in the FBX file's Definitions{} section.
  m_PVCount = new std::vector<unsigned int>(pvStore->size(), 0);
  m_LVCount = new std::vector<unsigned int>(lvStore->size(), 0);
  m_SolidCount = new std::vector<unsigned int>(solidStore->size(), 0);
  m_PVReplicas = new std::vector<unsigned int>(pvStore->size(), 0);
  m_LVReplicas = new std::vector<unsigned int>(lvStore->size(), 0);
  m_SolidReplicas = new std::vector<unsigned int>(solidStore->size(), 0);
  m_LVUnique = new std::vector<bool>(lvStore->size(), true);
  countEntities(topVol);
  unsigned int geometryCount = 0;
  unsigned int materialCount = 0;
  unsigned int modelCount = 0;
  for (unsigned int pvIndex = 0; pvIndex < pvStore->size(); ++pvIndex) {
    if ((*m_PVName)[pvIndex].length() > 0) {
      modelCount += (*m_PVCount)[pvIndex] + (*m_PVReplicas)[pvIndex];
    }
  }
  for (unsigned int lvIndex = 0; lvIndex < lvStore->size(); ++lvIndex) {
    if ((*m_LVName)[lvIndex].length() > 0) {
      if (!(*m_LVUnique)[lvIndex]) {
        modelCount += (*m_LVCount)[lvIndex] + (*m_LVReplicas)[lvIndex];
      }
      materialCount++;
    }
  }
  for (unsigned int solidIndex = 0; solidIndex < solidStore->size(); ++solidIndex) {
    if ((*m_SolidName)[solidIndex].length() > 0) {
      geometryCount += (*m_SolidCount)[solidIndex] + (*m_SolidReplicas)[solidIndex] + 1;
    }
  }
 
  m_File.open(m_Filename, std::ios_base::trunc);
  writePreamble(modelCount, materialCount, geometryCount);
 
  // Write all solids as Geometry nodes (replicas are written later).
  // Write all logical volumes as Material nodes (color information).
  // Write all physical and logical volumes as Model nodes (with replica-solids treated here).
  m_PVID = new std::vector<unsigned long long>(pvStore->size(), 0x0000010000000000LL);
  m_LVID = new std::vector<unsigned long long>(lvStore->size(), 0x000000C000000000LL);
  m_SolidID = new std::vector<unsigned long long>(solidStore->size(), 0x0000008000000000LL);
  m_MatID = new std::vector<unsigned long long>(lvStore->size(), 0x0000004000000000LL);
  m_Visible = new std::vector<bool>(lvStore->size(), false);
  m_File << "Objects:  {" << std::endl;
  for (unsigned int solidIndex = 0; solidIndex < solidStore->size(); ++solidIndex) {
    (*m_SolidID)[solidIndex] += 0x0000000001000000LL * solidIndex;
    if ((*m_SolidName)[solidIndex].length() > 0) {
      for (unsigned int solidCount = 0; solidCount <= (*m_SolidCount)[solidIndex]; ++solidCount) { // note lower and upper limits!
        writeGeometryNode((*solidStore)[solidIndex], (*m_SolidName)[solidIndex], (*m_SolidID)[solidIndex] + solidCount);
      }
    }
  }
  for (unsigned int lvIndex = 0; lvIndex < lvStore->size(); ++lvIndex) {
    (*m_MatID)[lvIndex] += 0x0000000001000000LL * lvIndex;
    (*m_LVID)[lvIndex] += 0x0000000001000000LL * lvIndex;
    if ((*m_LVName)[lvIndex].length() > 0) {
      if (!(*m_LVUnique)[lvIndex]) writeMaterialNode(lvIndex, (*m_LVName)[lvIndex]);
    }
  }
  for (unsigned int pvIndex = 0; pvIndex < pvStore->size(); ++pvIndex) {
    (*m_PVID)[pvIndex] += 0x0000000001000000LL * pvIndex;
  }
  m_PVCount->assign(pvStore->size(), 0);
  m_LVCount->assign(lvStore->size(), 0);
  m_SolidCount->assign(solidStore->size(), 0);
  addModels(topVol, 0);
  m_File << "}" << std::endl << std::endl;
 
  // Recursively write the connections among the solid and logical/physical volume elements
  m_PVCount->assign(pvStore->size(), 0);
  m_LVCount->assign(lvStore->size(), 0);
  m_SolidCount->assign(solidStore->size(), 0);
  m_File << "Connections:  {" << std::endl;
  addConnections(topVol, 0);
  int pvIndex = std::find(pvStore->begin(), pvStore->end(), topVol) - pvStore->begin();
  m_File << "\t; Physical volume Model::" << (*m_PVName)[pvIndex] << " to Model::RootNode" << std::endl <<
         "\tC: \"OO\"," << (*m_PVID)[pvIndex] << ",0" << std::endl << std::endl <<
         "}" << std::endl << std::endl;
 
  m_File << "Takes:  {" << std::endl <<
         "\tCurrent: \"\"" << std::endl <<
         "}" << std::endl;
 
  m_File.close();
  B2INFO("FBX written to " << m_Filename);
 
  delete m_PVName;
  delete m_LVName;
  delete m_SolidName;
  delete m_PVID;
  delete m_LVID;
  delete m_MatID;
  delete m_SolidID;
  delete m_PVCount;
  delete m_LVCount;
  delete m_SolidCount;
  delete m_Visible;
 
}

◆ exposePythonAPI()

void exposePythonAPI ( )

staticinherited

Exposes methods of the Module class to Python.

Definition at line 325 of file Module.cc.

{
  // to avoid confusion between std::arg and boost::python::arg we want a shorthand namespace as well
  namespace bp = boost::python;
 
  docstring_options options(true, true, false); //userdef, py sigs, c++ sigs
 
  void (Module::*setReturnValueInt)(int) = &Module::setReturnValue;
 
  enum_<Module::EAfterConditionPath>("AfterConditionPath",
                                     R"(Determines execution behaviour after a conditional path has been executed:
 
.. attribute:: END
 
  End processing of this path after the conditional path. (this is the default for if_value() etc.)
 
.. attribute:: CONTINUE
 
  After the conditional path, resume execution after this module.)")
  .value("END", Module::EAfterConditionPath::c_End)
  .value("CONTINUE", Module::EAfterConditionPath::c_Continue)
  ;
 
  /* Do not change the names of >, <, ... we use them to serialize conditional pathes */
  enum_<Belle2::ModuleCondition::EConditionOperators>("ConditionOperator")
  .value(">", Belle2::ModuleCondition::EConditionOperators::c_GT)
  .value("<", Belle2::ModuleCondition::EConditionOperators::c_ST)
  .value(">=", Belle2::ModuleCondition::EConditionOperators::c_GE)
  .value("<=", Belle2::ModuleCondition::EConditionOperators::c_SE)
  .value("==", Belle2::ModuleCondition::EConditionOperators::c_EQ)
  .value("!=", Belle2::ModuleCondition::EConditionOperators::c_NE)
  ;
 
  enum_<Module::EModulePropFlags>("ModulePropFlags",
                                  R"(Flags to indicate certain low-level features of modules, see :func:`Module.set_property_flags()`, :func:`Module.has_properties()`. Most useful flags are:
 
.. attribute:: PARALLELPROCESSINGCERTIFIED
 
    This module can be run in parallel processing mode safely (All I/O must be done through the data store, in particular, the module must not write any files.)
 
.. attribute:: HISTOGRAMMANAGER
 
  This module is used to manage histograms accumulated by other modules
 
.. attribute:: TERMINATEINALLPROCESSES
 
  When using parallel processing, call this module's terminate() function in all processes. This will also ensure that there is exactly one process (single-core if no parallel modules found) or at least one input, one main and one output process.
)")
  .value("INPUT", Module::EModulePropFlags::c_Input)
  .value("OUTPUT", Module::EModulePropFlags::c_Output)
  .value("PARALLELPROCESSINGCERTIFIED", Module::EModulePropFlags::c_ParallelProcessingCertified)
  .value("HISTOGRAMMANAGER", Module::EModulePropFlags::c_HistogramManager)
  .value("INTERNALSERIALIZER", Module::EModulePropFlags::c_InternalSerializer)
  .value("TERMINATEINALLPROCESSES", Module::EModulePropFlags::c_TerminateInAllProcesses)
  ;
 
  //Python class definition
  class_<Module, PyModule> module("Module", R"(
Base class for Modules.
 
A module is the smallest building block of the framework.
A typical event processing chain consists of a Path containing
modules. By inheriting from this base class, various types of
modules can be created. To use a module, please refer to
:func:`Path.add_module()`.  A list of modules is available by running
``basf2 -m`` or ``basf2 -m package``, detailed information on parameters is
given by e.g. ``basf2 -m RootInput``.
 
The 'Module Development' section in the manual provides detailed information
on how to create modules, setting parameters, or using return values/conditions:
https://xwiki.desy.de/xwiki/rest/p/f4fa4/#HModuleDevelopment
 
)");
  module
  .def("__str__", &Module::getPathString)
  .def("name", &Module::getName, return_value_policy<copy_const_reference>(),
       "Returns the name of the module. Can be changed via :func:`set_name() <Module.set_name()>`, use :func:`type() <Module.type()>` for identifying a particular module class.")
  .def("type", &Module::getType, return_value_policy<copy_const_reference>(),
       "Returns the type of the module (i.e. class name minus 'Module')")
  .def("set_name", &Module::setName, args("name"), R"(
Set custom name, e.g. to distinguish multiple modules of the same type.
 
>>> path.add_module('EventInfoSetter')
>>> ro = path.add_module('RootOutput', branchNames=['EventMetaData'])
>>> ro.set_name('RootOutput_metadata_only')
>>> print(path)
[EventInfoSetter -> RootOutput_metadata_only]
 
)")
  .def("description", &Module::getDescription, return_value_policy<copy_const_reference>(),
       "Returns the description of this module.")
  .def("package", &Module::getPackage, return_value_policy<copy_const_reference>(),
       "Returns the package this module belongs to.")
  .def("available_params", &_getParamInfoListPython,
       "Return list of all module parameters as `ModuleParamInfo` instances")
  .def("has_properties", &Module::hasProperties, (bp::arg("properties")),
       R"DOCSTRING(Allows to check if the module has the given properties out of `ModulePropFlags` set.
 
>>> if module.has_properties(ModulePropFlags.PARALLELPROCESSINGCERTIFIED):
>>>     ...
 
Parameters:
  properties (int): bitmask of `ModulePropFlags` to check for.
)DOCSTRING")
  .def("set_property_flags", &Module::setPropertyFlags, args("property_mask"),
       "Set module properties in the form of an OR combination of `ModulePropFlags`.");
  {
    // python signature is too crowded, make ourselves
    docstring_options subOptions(true, false, false); //userdef, py sigs, c++ sigs
    module
    .def("if_value", &Module::if_value,
         (bp::arg("expression"), bp::arg("condition_path"), bp::arg("after_condition_path")= Module::EAfterConditionPath::c_End),
         R"DOCSTRING(if_value(expression, condition_path, after_condition_path=AfterConditionPath.END)
 
Sets a conditional sub path which will be executed after this
module if the return value set in the module passes the given ``expression``.
 
Modules can define a return value (int or bool) using ``setReturnValue()``,
which can be used in the steering file to split the Path based on this value, for example
 
>>> module_with_condition.if_value("<1", another_path)
 
In case the return value of the ``module_with_condition`` for a given event is
less than 1, the execution will be diverted into ``another_path`` for this event.
 
You could for example set a special return value if an error occurs, and divert
the execution into a path containing :b2:mod:`RootOutput` if it is found;
saving only the data producing/produced by the error.
 
After a conditional path has executed, basf2 will by default stop processing
the path for this event. This behaviour can be changed by setting the
``after_condition_path`` argument.
 
Parameters:
  expression (str): Expression to determine if the conditional path should be executed.
      This should be one of the comparison operators ``<``, ``>``, ``<=``,
      ``>=``, ``==``, or ``!=`` followed by a numerical value for the return value
  condition_path (Path): path to execute in case the expression is fulfilled
  after_condition_path (AfterConditionPath): What to do once the ``condition_path`` has been executed.
)DOCSTRING")
    .def("if_false", &Module::if_false,
         (bp::arg("condition_path"), bp::arg("after_condition_path")= Module::EAfterConditionPath::c_End),
         R"DOC(if_false(condition_path, after_condition_path=AfterConditionPath.END)
 
Sets a conditional sub path which will be executed after this module if
the return value of the module evaluates to False. This is equivalent to
calling `if_value` with ``expression=\"<1\"``)DOC")
    .def("if_true", &Module::if_true,
         (bp::arg("condition_path"), bp::arg("after_condition_path")= Module::EAfterConditionPath::c_End),
         R"DOC(if_true(condition_path, after_condition_path=AfterConditionPath.END)
 
Sets a conditional sub path which will be executed after this module if
the return value of the module evaluates to True. It is equivalent to
calling `if_value` with ``expression=\">=1\"``)DOC");
  }
  module
  .def("has_condition", &Module::hasCondition,
       "Return true if a conditional path has been set for this module "
       "using `if_value`, `if_true` or `if_false`")
  .def("get_all_condition_paths", &_getAllConditionPathsPython,
       "Return a list of all conditional paths set for this module using "
       "`if_value`, `if_true` or `if_false`")
  .def("get_all_conditions", &_getAllConditionsPython,
       "Return a list of all conditional path expressions set for this module using "
       "`if_value`, `if_true` or `if_false`")
  .add_property("logging", make_function(&Module::getLogConfig, return_value_policy<reference_existing_object>()),
                &Module::setLogConfig)

◆ getAfterConditionPath()

Module::EAfterConditionPath getAfterConditionPath ( ) const

inherited

What to do after the conditional path is finished.

(defaults to c_End if no condition is set)

Definition at line 133 of file Module.cc.

{
  if (m_conditions.empty()) return EAfterConditionPath::c_End;
 
  //okay, a condition was set for this Module...
  if (!m_hasReturnValue) {
    B2FATAL("A condition was set for '" << getName() << "', but the module did not set a return value!");
  }
 
  for (const auto& condition : m_conditions) {
    if (condition.evaluate(m_returnValue)) {
      return condition.getAfterConditionPath();
    }
  }
 
  return EAfterConditionPath::c_End;
}

◆ getAllConditionPaths()

std::vector< std::shared_ptr< Path > > getAllConditionPaths ( ) const

inherited

Return all condition paths currently set (no matter if the condition is true or not).

Definition at line 150 of file Module.cc.

{
  std::vector<std::shared_ptr<Path>> allConditionPaths;
  for (const auto& condition : m_conditions) {
    allConditionPaths.push_back(condition.getPath());
  }
 
  return allConditionPaths;
}

◆ getAllConditions()

const std::vector< ModuleCondition > & getAllConditions ( ) const

inlineinherited

Return all set conditions for this module.

Definition at line 324 of file Module.h.

    {
      return m_conditions;
    }

◆ getBooleanSolidPolyhedron()

HepPolyhedron * getBooleanSolidPolyhedron ( G4VSolid * solid )

private

Create polyhedron for a boolean solid (recursive)

Definition at line 1006 of file FBXWriterModule.cc.

{
  G4VSolid* solidA = solid->GetConstituentSolid(0);
  G4VSolid* solidB = solid->GetConstituentSolid(1);
  HepPolyhedron* polyhedronA = nullptr;
  if ((solidA->GetEntityType() == "G4IntersectionSolid") ||
      (solidA->GetEntityType() == "G4UnionSolid") ||
      (solidA->GetEntityType() == "G4SubtractionSolid") ||
      (solidA->GetEntityType() == "G4BooleanSolid")) {
    polyhedronA = getBooleanSolidPolyhedron(solidA);
  } else {
    polyhedronA = new HepPolyhedron(*(solidA->GetPolyhedron()));
  }
  HepPolyhedron* polyhedronB = nullptr;
  G4VSolid* solidB2 = solidB;
  if (solidB->GetEntityType() == "G4DisplacedSolid") {
    solidB2 = ((G4DisplacedSolid*)solidB)->GetConstituentMovedSolid();
  }
  if ((solidB2->GetEntityType() == "G4IntersectionSolid") ||
      (solidB2->GetEntityType() == "G4UnionSolid") ||
      (solidB2->GetEntityType() == "G4SubtractionSolid") ||
      (solidB2->GetEntityType() == "G4BooleanSolid")) {
    polyhedronB = getBooleanSolidPolyhedron(solidB2);
    if (solidB != solidB2) { // was solidB a G4DisplacedSolid?
      polyhedronB->Transform(G4Transform3D(
                               ((G4DisplacedSolid*)solidB)->GetObjectRotation(),
                               ((G4DisplacedSolid*)solidB)->GetObjectTranslation()));
    }
  } else {
    polyhedronB = new HepPolyhedron(*(solidB->GetPolyhedron()));
  }
  auto* result = new HepPolyhedron();
  if (solid->GetEntityType() == "G4UnionSolid") {
    *result = polyhedronA->add(*polyhedronB);
  } else if (solid->GetEntityType() == "G4SubtractionSolid") {
    *result = polyhedronA->subtract(*polyhedronB);
  } else if (solid->GetEntityType() == "G4IntersectionSolid") {
    *result = polyhedronA->intersect(*polyhedronB);
  } else {
    B2WARNING("getBooleanSolidPolyhedron(): Unrecognized boolean solid " << solid->GetName() <<
              " of type " << solid->GetEntityType());
  }
  delete polyhedronA;
  delete polyhedronB;
  return result;
}

◆ getCondition()

const ModuleCondition * getCondition ( ) const

inlineinherited

Return a pointer to the first condition (or nullptr, if none was set)

Definition at line 314 of file Module.h.

    {
      if (m_conditions.empty()) {
        return nullptr;
      } else {
        return &m_conditions.front();
      }
    }

◆ getConditionPath()

std::shared_ptr< Path > getConditionPath ( ) const

inherited

Returns the path of the last true condition (if there is at least one, else reaturn a null pointer).

Definition at line 113 of file Module.cc.

{
  PathPtr p;
  if (m_conditions.empty()) return p;
 
  //okay, a condition was set for this Module...
  if (!m_hasReturnValue) {
    B2FATAL("A condition was set for '" << getName() << "', but the module did not set a return value!");
  }
 
  for (const auto& condition : m_conditions) {
    if (condition.evaluate(m_returnValue)) {
      return condition.getPath();
    }
  }
 
  // if none of the conditions were true, return a null pointer.
  return p;
}

◆ getDescription()

const std::string & getDescription ( ) const

inlineinherited

Returns the description of the module.

Definition at line 202 of file Module.h.

202{return m_description;}

Belle2::Module::m_description

std::string m_description

The description of the module.

Definition: Module.h:511

◆ getFileNames()

virtual std::vector< std::string > getFileNames ( bool outputFiles )

inlinevirtualinherited

Return a list of output filenames for this modules.

This will be called when basf2 is run with "--dry-run" if the module has set either the c_Input or c_Output properties.

If the parameter outputFiles is false (for modules with c_Input) the list of input filenames should be returned (if any). If outputFiles is true (for modules with c_Output) the list of output files should be returned (if any).

If a module has sat both properties this member is called twice, once for each property.

The module should return the actual list of requested input or produced output filenames (including handling of input/output overrides) so that the grid system can handle input/output files correctly.

This function should return the same value when called multiple times. This is especially important when taking the input/output overrides from Environment as they get consumed when obtained so the finalized list of output files should be stored for subsequent calls.

Reimplemented in RootInputModule, StorageRootOutputModule, and RootOutputModule.

Definition at line 134 of file Module.h.

    {
      return std::vector<std::string>();
    }

◆ getLogConfig()

LogConfig & getLogConfig ( )

inlineinherited

Returns the log system configuration.

Definition at line 225 of file Module.h.

225{return m_logConfig;}

◆ getModules()

std::list< ModulePtr > getModules ( ) const

inlineoverrideprivatevirtualinherited

no submodules, return empty list

Implements PathElement.

Definition at line 506 of file Module.h.

506{ return std::list<ModulePtr>(); }

◆ getName()

const std::string & getName ( ) const

inlineinherited

Returns the name of the module.

This can be changed via e.g. set_name() in the steering file to give more useful names if there is more than one module of the same type.

For identifying the type of a module, using getType() (or type() in Python) is recommended.

Definition at line 187 of file Module.h.

187{return m_name;}

Belle2::Module::m_name

std::string m_name

The name of the module, saved as a string (user-modifiable)

Definition: Module.h:508

◆ getPackage()

const std::string & getPackage ( ) const

inlineinherited

Returns the package this module is in.

Definition at line 197 of file Module.h.

197{return m_package;}

◆ getParamInfoListPython()

std::shared_ptr< boost::python::list > getParamInfoListPython ( ) const

inherited

Returns a python list of all parameters.

Each item in the list consists of the name of the parameter, a string describing its type, a python list of all default values and the description of the parameter.

Returns: A python list containing the parameters of this parameter list.

Definition at line 279 of file Module.cc.

{
  return m_moduleParamList.getParamInfoListPython();
}

◆ getParamList()

const ModuleParamList & getParamList ( ) const

inlineinherited

Return module param list.

Definition at line 363 of file Module.h.

363{ return m_moduleParamList; }

◆ getPathString()

std::string getPathString ( ) const

overrideprivatevirtualinherited

return the module name.

Implements PathElement.

Definition at line 192 of file Module.cc.

{
 
  std::string output = getName();
 
  for (const auto& condition : m_conditions) {
    output += condition.getString();
  }
 
  return output;
}

◆ getReturnValue()

int getReturnValue ( ) const

inlineinherited

Return the return value set by this module.

This value is only meaningful if hasReturnValue() is true

Definition at line 381 of file Module.h.

381{ return m_returnValue; }

◆ getType()

const std::string & getType ( ) const

inherited

Returns the type of the module (i.e.

class name minus 'Module')

Definition at line 41 of file Module.cc.

{
  if (m_type.empty())
    B2FATAL("Module type not set for " << getName());
  return m_type;
}

◆ hasCondition()

bool hasCondition ( ) const

inlineinherited

Returns true if at least one condition was set for the module.

Definition at line 311 of file Module.h.

311{ return not m_conditions.empty(); };

◆ hasProperties()

bool hasProperties ( unsigned int propertyFlags ) const

inherited

Returns true if all specified property flags are available in this module.

Parameters

propertyFlags Ored EModulePropFlags which should be compared with the module flags.

Definition at line 160 of file Module.cc.

{
  return (propertyFlags & m_propertyFlags) == propertyFlags;
}

◆ hasReturnValue()

bool hasReturnValue ( ) const

inlineinherited

Return true if this module has a valid return value set.

Definition at line 378 of file Module.h.

378{ return m_hasReturnValue; }

◆ hasUnsetForcedParams()

bool hasUnsetForcedParams ( ) const

inherited

Returns true and prints error message if the module has unset parameters which the user has to set in the steering file.

Definition at line 166 of file Module.cc.

{
  auto missing = m_moduleParamList.getUnsetForcedParams();
  std::string allMissing = "";
  for (const auto& s : missing)
    allMissing += s + " ";
  if (!missing.empty())
    B2ERROR("The following required parameters of Module '" << getName() << "' were not specified: " << allMissing <<
            "\nPlease add them to your steering file.");
  return !missing.empty();
}

◆ if_false()

void if_false	(	const std::shared_ptr< Path > &	path,
		EAfterConditionPath	afterConditionPath = `EAfterConditionPath::c_End`
	)

inherited

A simplified version to add a condition to the module.

Please note that successive calls of this function will add more than one condition to the module. If more than one condition results in true, only the last of them will be used.

Please be careful: Avoid creating cyclic paths, e.g. by linking a condition to a path which is processed before the path where this module is located in.

It is equivalent to the if_value() method, using the expression "<1". This method is meant to be used together with the setReturnValue(bool value) method.

Parameters

path	Shared pointer to the Path which will be executed if the return value is false.
afterConditionPath	What to do after executing 'path'.

Definition at line 85 of file Module.cc.

{
  if_value("<1", path, afterConditionPath);
}

◆ if_true()

void if_true	(	const std::shared_ptr< Path > &	path,
		EAfterConditionPath	afterConditionPath = `EAfterConditionPath::c_End`
	)

inherited

A simplified version to set the condition of the module.

Please note that successive calls of this function will add more than one condition to the module. If more than one condition results in true, only the last of them will be used.

Please be careful: Avoid creating cyclic paths, e.g. by linking a condition to a path which is processed before the path where this module is located in.

It is equivalent to the if_value() method, using the expression ">=1". This method is meant to be used together with the setReturnValue(bool value) method.

Parameters

path	Shared pointer to the Path which will be executed if the return value is true.
afterConditionPath	What to do after executing 'path'.

Definition at line 90 of file Module.cc.

{
  if_value(">=1", path, afterConditionPath);
}

◆ if_value()

void if_value	(	const std::string &	expression,
		const std::shared_ptr< Path > &	path,
		EAfterConditionPath	afterConditionPath = `EAfterConditionPath::c_End`
	)

inherited

Add a condition to the module.

Please note that successive calls of this function will add more than one condition to the module. If more than one condition results in true, only the last of them will be used.

See https://xwiki.desy.de/xwiki/rest/p/a94f2 or ModuleCondition for a description of the syntax.

Please be careful: Avoid creating cyclic paths, e.g. by linking a condition to a path which is processed before the path where this module is located in.

Parameters

expression	The expression of the condition.
path	Shared pointer to the Path which will be executed if the condition is evaluated to true.
afterConditionPath	What to do after executing 'path'.

Definition at line 79 of file Module.cc.

{
  m_conditions.emplace_back(expression, path, afterConditionPath);
}

◆ initialize()

void initialize ( void )

overridevirtual

Initialize at the start of a job.

Reimplemented from Module.

Definition at line 46 of file FBXWriterModule.cc.

{
  m_First = true;
}

◆ setAbortLevel()

void setAbortLevel ( int abortLevel )

inherited

Configure the abort log level.

Definition at line 67 of file Module.cc.

{
  m_logConfig.setAbortLevel(static_cast<LogConfig::ELogLevel>(abortLevel));
}

◆ setDebugLevel()

void setDebugLevel ( int debugLevel )

inherited

Configure the debug messaging level.

Definition at line 61 of file Module.cc.

{
  m_logConfig.setDebugLevel(debugLevel);
}

◆ setDescription()

void setDescription ( const std::string & description )

protectedinherited

Sets the description of the module.

Parameters

description A description of the module.

Definition at line 214 of file Module.cc.

{
  m_description = description;
}

◆ setLogConfig()

void setLogConfig ( const LogConfig & logConfig )

inlineinherited

Set the log system configuration.

Definition at line 230 of file Module.h.

230{m_logConfig = logConfig;}

◆ setLogInfo()

void setLogInfo	(	int	logLevel,
		unsigned int	logInfo
	)

inherited

Configure the printed log information for the given level.

Parameters

logLevel	The log level (one of LogConfig::ELogLevel)
logInfo	What kind of info should be printed? ORed combination of LogConfig::ELogInfo flags.

Definition at line 73 of file Module.cc.

{
  m_logConfig.setLogInfo(static_cast<LogConfig::ELogLevel>(logLevel), logInfo);
}

◆ setLogLevel()

void setLogLevel ( int logLevel )

inherited

Configure the log level.

Definition at line 55 of file Module.cc.

{
  m_logConfig.setLogLevel(static_cast<LogConfig::ELogLevel>(logLevel));
}

◆ setName()

void setName ( const std::string & name )

inlineinherited

Set the name of the module.

Note: The module name is set when using the REG_MODULE macro, but the module can be renamed before calling process() using the set_name() function in your steering file.

Parameters

name	The name of the module

Definition at line 214 of file Module.h.

214{ m_name = name; };

◆ setParamList()

void setParamList ( const ModuleParamList & params )

inlineprotectedinherited

Replace existing parameter list.

Definition at line 501 of file Module.h.

501{ m_moduleParamList = params; }

◆ setParamPython()

void setParamPython	(	const std::string &	name,
		const boost::python::object &	pyObj
	)

privateinherited

Implements a method for setting boost::python objects.

The method supports the following types: list, dict, int, double, string, bool The conversion of the python object to the C++ type and the final storage of the parameter value is done in the ModuleParam class.

Parameters

name	The unique name of the parameter.
pyObj	The object which should be converted and stored as the parameter value.

Definition at line 234 of file Module.cc.

{
  LogSystem& logSystem = LogSystem::Instance();
  logSystem.updateModule(&(getLogConfig()), getName());
  try {
    m_moduleParamList.setParamPython(name, pyObj);
  } catch (std::runtime_error& e) {
    throw std::runtime_error("Cannot set parameter '" + name + "' for module '"
                             + m_name + "': " + e.what());
  }
 
  logSystem.updateModule(nullptr);
}

◆ setParamPythonDict()

void setParamPythonDict ( const boost::python::dict & dictionary )

privateinherited

Implements a method for reading the parameter values from a boost::python dictionary.

The key of the dictionary has to be the name of the parameter and the value has to be of one of the supported parameter types.

Parameters

dictionary The python dictionary from which the parameter values are read.

Definition at line 249 of file Module.cc.

{
 
  LogSystem& logSystem = LogSystem::Instance();
  logSystem.updateModule(&(getLogConfig()), getName());
 
  boost::python::list dictKeys = dictionary.keys();
  int nKey = boost::python::len(dictKeys);
 
  //Loop over all keys in the dictionary
  for (int iKey = 0; iKey < nKey; ++iKey) {
    boost::python::object currKey = dictKeys[iKey];
    boost::python::extract<std::string> keyProxy(currKey);
 
    if (keyProxy.check()) {
      const boost::python::object& currValue = dictionary[currKey];
      setParamPython(keyProxy, currValue);
    } else {
      B2ERROR("Setting the module parameters from a python dictionary: invalid key in dictionary!");
    }
  }
 
  logSystem.updateModule(nullptr);
}

◆ setPropertyFlags()

void setPropertyFlags ( unsigned int propertyFlags )

inherited

Sets the flags for the module properties.

Parameters

propertyFlags bitwise OR of EModulePropFlags

Definition at line 208 of file Module.cc.

{
  m_propertyFlags = propertyFlags;
}

◆ setReturnValue() [1/2]

void setReturnValue ( bool value )

protectedinherited

Sets the return value for this module as bool.

The bool value is saved as an integer with the convention 1 meaning true and 0 meaning false. The value can be used in the steering file to divide the analysis chain into several paths.

Parameters

value The value of the return value.

Definition at line 227 of file Module.cc.

{
  m_hasReturnValue = true;
  m_returnValue = value;
}

◆ setReturnValue() [2/2]

void setReturnValue ( int value )

protectedinherited

Sets the return value for this module as integer.

The value can be used in the steering file to divide the analysis chain into several paths.

Parameters

value The value of the return value.

Definition at line 220 of file Module.cc.

{
  m_hasReturnValue = true;
  m_returnValue = value;
}

◆ setType()

void setType ( const std::string & type )

protectedinherited

Set the module type.

Only for use by internal modules (which don't use the normal REG_MODULE mechanism).

Definition at line 48 of file Module.cc.

{
  if (!m_type.empty())
    B2FATAL("Trying to change module type from " << m_type << " is not allowed, the value is assumed to be fixed.");
  m_type = type;
}

◆ terminate()

virtual void terminate ( void )

inlinevirtualinherited

This method is called at the end of the event processing.

This method is called only once after the event processing finished. Use this method for cleaning up, closing files, etc.

This method can be implemented by subclasses.

Definition at line 176 of file Module.h.

176{};

◆ writeGeometryNode()

void writeGeometryNode	(	G4VSolid *	solid,
		const std::string &	solidName,
		unsigned long long	solidID
	)

private

Write FBX definition for each solid's polyhedron.

Definition at line 221 of file FBXWriterModule.cc.

{
  if ((solid->GetEntityType() == "G4IntersectionSolid") ||
      (solid->GetEntityType() == "G4UnionSolid") ||
      (solid->GetEntityType() == "G4SubtractionSolid") ||
      (solid->GetEntityType() == "G4BooleanSolid")) {
    HepPolyhedron* polyhedron = getBooleanSolidPolyhedron(solid);
    auto* g4polyhedron = new G4Polyhedron(*polyhedron);
    writePolyhedron(solid, g4polyhedron, solidName, solidID);
    delete polyhedron;
    delete g4polyhedron;
  } else {
    writePolyhedron(solid, solid->GetPolyhedron(), solidName, solidID);
  }
}

◆ writeLVModelNode()

void writeLVModelNode	(	G4LogicalVolume *	logVol,
		const std::string &	lvName,
		unsigned long long	lvID
	)

private

Write FBX definition for each logical volume.

Definition at line 283 of file FBXWriterModule.cc.

{
  m_File << "\t; LogVol " << logVol->GetName() << " with solid " << logVol->GetSolid()->GetName() << std::endl <<
         "\tModel: " << lvID << ", \"Model::lv_" << lvName << R"(", "Null" {)" << std::endl <<
         "\t\tVersion: 232" << std::endl <<
         "\t\tProperties70:  {" << std::endl <<
         "\t\t}" << std::endl <<
         "\t\tShading: T" << std::endl <<
         "\t\tCulling: \"CullingOff\"" << std::endl <<
         "\t}" << std::endl;
}

◆ writeLVToPV()

void writeLVToPV	(	const std::string &	pvName,
		const std::string &	lvName,
		unsigned long long	pvID,
		unsigned long long	lvID
	)

private

Write FBX connection for the (unique) logical volume of a physical volume.

Definition at line 983 of file FBXWriterModule.cc.

{
  m_File << "\t; LogVol Model::lv_" << lvName << ", PhysVol Model::" << pvName << std::endl <<
         "\tC: \"OO\"," << lvID << "," << pvID << std::endl << std::endl;
}

◆ writeMaterialNode()

void writeMaterialNode	(	int	lvIndex,
		const std::string &	matName
	)

private

Write FBX definition for each logical volume's color information.

Definition at line 237 of file FBXWriterModule.cc.

{
  G4LogicalVolumeStore* lvStore = G4LogicalVolumeStore::GetInstance();
  G4LogicalVolume* logVol = (*lvStore)[lvIndex];
  unsigned long long matID = (*m_MatID)[lvIndex];
  G4Color color(0.0, 1.0, 0.0, 0.5); // default is semi-transparent green
  if ((matName.compare(0, 23, "eclBarrelCrystalLogical") == 0) ||
      (matName.compare(0, 20, "eclFwdCrystalLogical") == 0) ||
      (matName.compare(0, 20, "eclBwdCrystalLogical") == 0) ||
      (matName.compare(0, 24, "eclBarrelCrystalPhysical") == 0) ||
      (matName.compare(0, 21, "eclFwdCrystalPhysical") == 0) ||
      (matName.compare(0, 21, "eclBwdCrystalPhysical") == 0)) {
    color = G4Color(1.0, 0.25, 0.0, 0.7); // orange since ECL crystals have no G4VisAttribute :(
  }
  bool visible = true;
  G4String materialName = logVol->GetMaterial()->GetName();
  // Hide containers that have vacuum, air or gas
  if (materialName == "Vacuum") visible = false;
  if (materialName == "G4_AIR") visible = false;
  if (materialName == "CDCGas") visible = false;
  if (materialName == "ColdAir") visible = false;
  if (materialName == "STR-DryAir") visible = false;
  if (materialName == "TOPAir") visible = false;
  if (materialName == "TOPVacuum") visible = false;
  const G4VisAttributes* visAttr = logVol->GetVisAttributes();
  if (visAttr) {
    color = const_cast<G4Color&>(logVol->GetVisAttributes()->GetColor());
    if (!(visAttr->IsVisible())) visible = false;
  } else {
    visible = false;
  }
  if (logVol->GetSensitiveDetector() != nullptr) visible = "";
  (*m_Visible)[lvIndex] = visible;
  m_File << "\t; Color for LogVol " << logVol->GetName() << std::endl <<
         "\tMaterial: " << matID << ", \"Material::" << matName << R"(", "" {)" << std::endl <<
         "\t\tVersion: 102" << std::endl <<
         "\t\tProperties70:  {" << std::endl <<
         "\t\t\tP: \"ShadingModel\", \"KString\", \"\", \"\", \"phong\"" << std::endl <<
         "\t\t\tP: \"DiffuseColor\", \"RGBColor\", \"Color\", \"A\"," <<
         color.GetRed() << "," << color.GetGreen() << "," << color.GetBlue() << std::endl <<
         "\t\t\tP: \"TransparentColor\", \"RGBColor\", \"Color\", \"A\",1,1,1" << std::endl <<
         "\t\t\tP: \"TransparencyFactor\", \"double\", \"Number\", \"\"," << (visible ? 1.0 - color.GetAlpha() : 1) << std::endl <<
         "\t\t}" << std::endl <<
         "\t}" << std::endl;
}

◆ writePolyhedron()

void writePolyhedron	(	G4VSolid *	solid,
		G4Polyhedron *	polyhedron,
		const std::string &	name,
		unsigned long long	solidID
	)

private

Write FBX definition for the solid's polyhedron.

Definition at line 845 of file FBXWriterModule.cc.

{
  if (polyhedron) {
    polyhedron->SetNumberOfRotationSteps(120);
    m_File << "\t; Solid " << solid->GetName() << " of type " << solid->GetEntityType() << std::endl <<
           "\tGeometry: " << solidID << ", \"Geometry::" << name << R"(", "Mesh" {)" << std::endl <<
           "\t\tVertices: *" << polyhedron->GetNoVertices() * 3 << " {" << std::endl << "\t\t\ta: ";
    std::streampos startOfLine = m_File.tellp();
    for (int j = 1; j <= polyhedron->GetNoVertices(); ++j) {
      m_File << (j == 1 ? "" : ",") <<
             polyhedron->GetVertex(j).x() << "," <<
             polyhedron->GetVertex(j).y() << "," <<
             polyhedron->GetVertex(j).z();
      if (m_File.tellp() - startOfLine > 100) {
        startOfLine = m_File.tellp();
        m_File << std::endl << "\t\t\t\t";
      }
    }
    m_File << std::endl << "\t\t}" << std::endl;
 
    std::vector<int> vertices;
    for (int k = 1; k <= polyhedron->GetNoFacets(); ++k) {
      G4bool notLastEdge = true;
      G4int ndx = -1, edgeFlag = 1;
      do {
        notLastEdge = polyhedron->GetNextVertexIndex(ndx, edgeFlag);
        if (notLastEdge) {
          vertices.push_back(ndx - 1);
        } else {
          vertices.push_back(-ndx);
        }
      } while (notLastEdge);
    }
    m_File << "\t\tPolygonVertexIndex: *" << vertices.size() << " {" << std::endl << "\t\t\ta: ";
    startOfLine = m_File.tellp();
    for (unsigned int j = 0; j < vertices.size(); ++j) {
      m_File << (j == 0 ? "" : ",") << vertices[j];
      if (m_File.tellp() - startOfLine > 100) {
        startOfLine = m_File.tellp();
        m_File << std::endl << "\t\t\t\t";
      }
    }
    m_File << std::endl << "\t\t}" << std::endl;
 
    m_File << "\t\tGeometryVersion: 124" << std::endl <<
           "\t\tLayerElementNormal: 0 {" << std::endl <<
           "\t\t\tVersion: 101" << std::endl <<
           // "\t\t\tName: \"\"" << std::endl <<
           "\t\t\tMappingInformationType: \"ByPolygonVertex\"" << std::endl <<
           "\t\t\tReferenceInformationType: \"Direct\"" << std::endl <<
           "\t\t\tNormals: *" << vertices.size() * 3 << " {" << std::endl << "\t\t\t\ta: ";
    startOfLine = m_File.tellp();
    unsigned int j = 0;
    for (int k = 1; k <= polyhedron->GetNoFacets(); ++k) {
      G4Normal3D normal = polyhedron->GetUnitNormal(k);
      do {
        m_File << (j == 0 ? "" : ",") << normal.x() << "," << normal.y() << "," << normal.z();
        if (m_File.tellp() - startOfLine > 100) {
          startOfLine = m_File.tellp();
          m_File << std::endl << "\t\t\t\t";
        }
      } while (vertices[j++] >= 0);
    }
    m_File << std::endl << "\t\t\t}" << std::endl << "\t\t}" << std::endl <<
           "\t\tLayerElementMaterial: 0 {" << std::endl <<
           "\t\t\tVersion: 101" << std::endl <<
           // "\t\t\tName: \"\"" << std::endl <<
           "\t\t\tMappingInformationType: \"AllSame\"" << std::endl <<
           "\t\t\tReferenceInformationType: \"IndexToDirect\"" << std::endl <<
           "\t\t\tMaterials: *1 {" << std::endl <<
           "\t\t\t\ta: 0" << std::endl <<
           "\t\t\t}" << std::endl <<
           "\t\t}" << std::endl <<
           "\t\tLayer: 0 {" << std::endl <<
           "\t\t\tVersion: 100" << std::endl <<
           "\t\t\tLayerElement:  {" << std::endl <<
           "\t\t\t\tType: \"LayerElementNormal\"" << std::endl <<
           "\t\t\t\tTypedIndex: 0" << std::endl <<
           "\t\t\t}" << std::endl <<
           "\t\t\tLayerElement:  {" << std::endl <<
           "\t\t\t\tType: \"LayerElementMaterial\"" << std::endl <<
           "\t\t\t\tTypedIndex: 0" << std::endl <<
           "\t\t\t}" << std::endl <<
           "\t\t}" << std::endl <<
           "\t}" << std::endl;
  } else {
    B2INFO("Polyhedron representation of solid " << name << " cannot be created");
  }
}

◆ writePreamble()

void writePreamble	(	int	modelCount,
		int	materialCount,
		int	geometryCount
	)

private

Write FBX at the start of the file.

Definition at line 616 of file FBXWriterModule.cc.

{
  std::time_t t = std::time(nullptr);
  struct tm* now = std::localtime(&t);
  m_File << "; FBX 7.3.0 project file" << std::endl <<
         "; Copyright (C) 1997-2010 Autodesk Inc. and/or its licensors." << std::endl <<
         "; All rights reserved." << std::endl << std::endl <<
         "FBXHeaderExtension:  {" << std::endl <<
         "\tFBXHeaderVersion: 1003" << std::endl <<
         "\tFBXVersion: 7300" << std::endl <<
         "\tCreationTime: \"" << std::put_time(now, "%F %T") << ":000\"" << std::endl <<
         //"\tCreationTimeStamp:  {" << std::endl <<
         //"\t\tVersion: 1000" << std::endl <<
         //"\t\tYear: " << now->tm_year + 1900 << std::endl <<
         //"\t\tMonth: " << now->tm_mon + 1 << std::endl <<
         //"\t\tDay: " << now->tm_mday << std::endl <<
         //"\t\tHour: " << now->tm_hour << std::endl <<
         //"\t\tMinute: " << now->tm_min << std::endl <<
         //"\t\tSecond: " << now->tm_sec << std::endl <<
         //"\t\tMillisecond: 0" << std::endl <<
         //"\t}" << std::endl <<
         "\tCreator: \"FBX SDK/FBX Plugins version 2013.3\"" << std::endl <<
         "\tSceneInfo: \"SceneInfo::GlobalInfo\", \"UserData\" {" << std::endl <<
         "\t\tType: \"UserData\"" << std::endl <<
         "\t\tVersion: 100" << std::endl <<
         "\t\tMetaData:  {" << std::endl <<
         "\t\t\tVersion: 100" << std::endl <<
         "\t\t\tTitle: \"Belle II Detector\"" << std::endl <<
         "\t\t\tSubject: \"Detector Geometry Model\"" << std::endl <<
         "\t\t\tAuthor: \"Belle II Collaboration\"" << std::endl <<
         "\t\t\tKeywords: \"\"" << std::endl <<
         "\t\t\tRevision: \"\"" << std::endl <<
         "\t\t\tComment: \"\"" << std::endl <<
         "\t\t}" << std::endl <<
         "\t}" << std::endl <<
         "}" << std::endl << std::endl;
 
  m_File << "GlobalSettings:  {" << std::endl <<
         "\tVersion: 1000" << std::endl <<
         "\tProperties70:  {" << std::endl <<
         "\t\tP: \"UpAxis\", \"int\", \"Integer\", \"\",1" << std::endl <<
         "\t\tP: \"UpAxisSign\", \"int\", \"Integer\", \"\",1" << std::endl <<
         "\t\tP: \"FrontAxis\", \"int\", \"Integer\", \"\",2" << std::endl <<
         "\t\tP: \"FrontAxisSign\", \"int\", \"Integer\", \"\",1" << std::endl <<
         "\t\tP: \"CoordAxis\", \"int\", \"Integer\", \"\",0" << std::endl <<
         "\t\tP: \"CoordAxisSign\", \"int\", \"Integer\", \"\",1" << std::endl <<
         "\t\tP: \"OriginalUpAxis\", \"int\", \"Integer\", \"\",1" << std::endl <<
         "\t\tP: \"OriginalUpAxisSign\", \"int\", \"Integer\", \"\",1" << std::endl <<
         "\t\tP: \"UnitScaleFactor\", \"double\", \"Number\", \"\",1" << std::endl <<
         "\t\tP: \"OriginalUnitScaleFactor\", \"double\", \"Number\", \"\",1" << std::endl <<
         "\t\tP: \"AmbientColor\", \"ColorRGB\", \"Color\", \"\",1,1,1" << std::endl <<
         "\t\tP: \"DefaultCamera\", \"KString\", \"\", \"\", \"Producer Perspective\"" << std::endl <<
         "\t\tP: \"TimeMode\", \"enum\", \"\", \"\",0" << std::endl <<
         "\t\tP: \"TimeSpanStart\", \"KTime\", \"Time\", \"\",0" << std::endl <<
         "\t\tP: \"TimeSpanStop\", \"KTime\", \"Time\", \"\",10" << std::endl <<
         "\t\tP: \"CustomFrameRate\", \"double\", \"Number\", \"\",-1" << std::endl <<
         "\t}" << std::endl <<
         "}" << std::endl << std::endl;
 
  m_File << "Documents:  {" << std::endl <<
         "\tCount: 1" << std::endl <<
         "\tDocument: 4000000000, \"\", \"Scene\" {" << std::endl <<
         "\t\tProperties70:  {" << std::endl <<
         "\t\t\tP: \"SourceObject\", \"object\", \"\", \"\"" << std::endl <<
         "\t\t\tP: \"ActiveAnimStackName\", \"KString\", \"\", \"\", \"\"" << std::endl <<
         "\t\t}" << std::endl <<
         "\t\tRootNode: 0" << std::endl <<
         "\t}" << std::endl <<
         "}" << std::endl << std::endl;
 
  m_File << "References:  {" << std::endl <<
         "}" << std::endl << std::endl;
 
  m_File << "Definitions:  {" << std::endl <<
         "\tVersion: 100" << std::endl <<
         "\tCount: 4" << std::endl <<
         "\tObjectType: \"GlobalSettings\" {" << std::endl <<
         "\t\tCount: 1" << std::endl <<
         "\t}" << std::endl;
  m_File << "\tObjectType: \"Model\" {" << std::endl <<
         "\t\tCount: " << modelCount << std::endl <<
         "\t\tPropertyTemplate: \"FbxNode\" {" << std::endl <<
         "\t\t\tProperties70:  {" << std::endl <<
         "\t\t\t\tP: \"QuaternionInterpolate\", \"enum\", \"\", \"\",0" << std::endl <<
         "\t\t\t\tP: \"RotationOffset\", \"Vector3D\", \"Vector\", \"\",0,0,0" << std::endl <<
         "\t\t\t\tP: \"RotationPivot\", \"Vector3D\", \"Vector\", \"\",0,0,0" << std::endl <<
         "\t\t\t\tP: \"ScalingOffset\", \"Vector3D\", \"Vector\", \"\",0,0,0" << std::endl <<
         "\t\t\t\tP: \"ScalingPivot\", \"Vector3D\", \"Vector\", \"\",0,0,0" << std::endl <<
         "\t\t\t\tP: \"TranslationActive\", \"bool\", \"\", \"\",0" << std::endl <<
         "\t\t\t\tP: \"TranslationMin\", \"Vector3D\", \"Vector\", \"\",0,0,0" << std::endl <<
         "\t\t\t\tP: \"TranslationMax\", \"Vector3D\", \"Vector\", \"\",0,0,0" << std::endl <<
         "\t\t\t\tP: \"TranslationMinX\", \"bool\", \"\", \"\",0" << std::endl <<
         "\t\t\t\tP: \"TranslationMinY\", \"bool\", \"\", \"\",0" << std::endl <<
         "\t\t\t\tP: \"TranslationMinZ\", \"bool\", \"\", \"\",0" << std::endl <<
         "\t\t\t\tP: \"TranslationMaxX\", \"bool\", \"\", \"\",0" << std::endl <<
         "\t\t\t\tP: \"TranslationMaxY\", \"bool\", \"\", \"\",0" << std::endl <<
         "\t\t\t\tP: \"TranslationMaxZ\", \"bool\", \"\", \"\",0" << std::endl <<
         "\t\t\t\tP: \"RotationOrder\", \"enum\", \"\", \"\",0" << std::endl <<
         "\t\t\t\tP: \"RotationSpaceForLimitOnly\", \"bool\", \"\", \"\",0" << std::endl <<
         "\t\t\t\tP: \"RotationStiffnessX\", \"double\", \"Number\", \"\",0" << std::endl <<
         "\t\t\t\tP: \"RotationStiffnessY\", \"double\", \"Number\", \"\",0" << std::endl <<
         "\t\t\t\tP: \"RotationStiffnessZ\", \"double\", \"Number\", \"\",0" << std::endl <<
         "\t\t\t\tP: \"AxisLen\", \"double\", \"Number\", \"\",10" << std::endl <<
         "\t\t\t\tP: \"PreRotation\", \"Vector3D\", \"Vector\", \"\",0,0,0" << std::endl <<
         "\t\t\t\tP: \"PostRotation\", \"Vector3D\", \"Vector\", \"\",0,0,0" << std::endl <<
         "\t\t\t\tP: \"RotationActive\", \"bool\", \"\", \"\",0" << std::endl <<
         "\t\t\t\tP: \"RotationMin\", \"Vector3D\", \"Vector\", \"\",0,0,0" << std::endl <<
         "\t\t\t\tP: \"RotationMax\", \"Vector3D\", \"Vector\", \"\",0,0,0" << std::endl <<
         "\t\t\t\tP: \"RotationMinX\", \"bool\", \"\", \"\",0" << std::endl <<
         "\t\t\t\tP: \"RotationMinY\", \"bool\", \"\", \"\",0" << std::endl <<
         "\t\t\t\tP: \"RotationMinZ\", \"bool\", \"\", \"\",0" << std::endl <<
         "\t\t\t\tP: \"RotationMaxX\", \"bool\", \"\", \"\",0" << std::endl <<
         "\t\t\t\tP: \"RotationMaxY\", \"bool\", \"\", \"\",0" << std::endl <<
         "\t\t\t\tP: \"RotationMaxZ\", \"bool\", \"\", \"\",0" << std::endl <<
         "\t\t\t\tP: \"InheritType\", \"enum\", \"\", \"\",0" << std::endl <<
         "\t\t\t\tP: \"ScalingActive\", \"bool\", \"\", \"\",0" << std::endl <<
         "\t\t\t\tP: \"ScalingMin\", \"Vector3D\", \"Vector\", \"\",0,0,0" << std::endl <<
         "\t\t\t\tP: \"ScalingMax\", \"Vector3D\", \"Vector\", \"\",0,0,0" << std::endl <<
         "\t\t\t\tP: \"ScalingMinX\", \"bool\", \"\", \"\",0" << std::endl <<
         "\t\t\t\tP: \"ScalingMinY\", \"bool\", \"\", \"\",0" << std::endl <<
         "\t\t\t\tP: \"ScalingMinZ\", \"bool\", \"\", \"\",0" << std::endl <<
         "\t\t\t\tP: \"ScalingMaxX\", \"bool\", \"\", \"\",0" << std::endl <<
         "\t\t\t\tP: \"ScalingMaxY\", \"bool\", \"\", \"\",0" << std::endl <<
         "\t\t\t\tP: \"ScalingMaxZ\", \"bool\", \"\", \"\",0" << std::endl <<
         "\t\t\t\tP: \"GeometricTranslation\", \"Vector3D\", \"Vector\", \"\",0,0,0" << std::endl <<
         "\t\t\t\tP: \"GeometricRotation\", \"Vector3D\", \"Vector\", \"\",0,0,0" << std::endl <<
         "\t\t\t\tP: \"GeometricScaling\", \"Vector3D\", \"Vector\", \"\",1,1,1" << std::endl <<
         "\t\t\t\tP: \"MinDampRangeX\", \"double\", \"Number\", \"\",0" << std::endl <<
         "\t\t\t\tP: \"MinDampRangeY\", \"double\", \"Number\", \"\",0" << std::endl <<
         "\t\t\t\tP: \"MinDampRangeZ\", \"double\", \"Number\", \"\",0" << std::endl <<
         "\t\t\t\tP: \"MaxDampRangeX\", \"double\", \"Number\", \"\",0" << std::endl <<
         "\t\t\t\tP: \"MaxDampRangeY\", \"double\", \"Number\", \"\",0" << std::endl <<
         "\t\t\t\tP: \"MaxDampRangeZ\", \"double\", \"Number\", \"\",0" << std::endl <<
         "\t\t\t\tP: \"MinDampStrengthX\", \"double\", \"Number\", \"\",0" << std::endl <<
         "\t\t\t\tP: \"MinDampStrengthY\", \"double\", \"Number\", \"\",0" << std::endl <<
         "\t\t\t\tP: \"MinDampStrengthZ\", \"double\", \"Number\", \"\",0" << std::endl <<
         "\t\t\t\tP: \"MaxDampStrengthX\", \"double\", \"Number\", \"\",0" << std::endl <<
         "\t\t\t\tP: \"MaxDampStrengthY\", \"double\", \"Number\", \"\",0" << std::endl <<
         "\t\t\t\tP: \"MaxDampStrengthZ\", \"double\", \"Number\", \"\",0" << std::endl <<
         "\t\t\t\tP: \"PreferedAngleX\", \"double\", \"Number\", \"\",0" << std::endl <<
         "\t\t\t\tP: \"PreferedAngleY\", \"double\", \"Number\", \"\",0" << std::endl <<
         "\t\t\t\tP: \"PreferedAngleZ\", \"double\", \"Number\", \"\",0" << std::endl <<
         "\t\t\t\tP: \"LookAtProperty\", \"object\", \"\", \"\"" << std::endl <<
         "\t\t\t\tP: \"UpVectorProperty\", \"object\", \"\", \"\"" << std::endl <<
         "\t\t\t\tP: \"Show\", \"bool\", \"\", \"\",1" << std::endl <<
         "\t\t\t\tP: \"NegativePercentShapeSupport\", \"bool\", \"\", \"\",1" << std::endl <<
         "\t\t\t\tP: \"DefaultAttributeIndex\", \"int\", \"Integer\", \"\",0" << std::endl <<
         "\t\t\t\tP: \"Freeze\", \"bool\", \"\", \"\",0" << std::endl <<
         "\t\t\t\tP: \"LODBox\", \"bool\", \"\", \"\",0" << std::endl <<
         "\t\t\t\tP: \"Lcl Translation\", \"Lcl Translation\", \"\", \"A\",0,0,0" << std::endl <<
         "\t\t\t\tP: \"Lcl Rotation\", \"Lcl Rotation\", \"\", \"A\",0,0,0" << std::endl <<
         "\t\t\t\tP: \"Lcl Scaling\", \"Lcl Scaling\", \"\", \"A\",1,1,1" << std::endl <<
         "\t\t\t\tP: \"Visibility\", \"Visibility\", \"\", \"A\",1" << std::endl <<
         "\t\t\t\tP: \"Visibility Inheritance\", \"Visibility Inheritance\", \"\", \"\",1" << std::endl <<
         "\t\t\t}" << std::endl <<
         "\t\t}" << std::endl <<
         "\t}" << std::endl;
  m_File << "\tObjectType: \"Material\" {" << std::endl <<
         "\t\tCount: " << materialCount << std::endl <<
         "\t\tPropertyTemplate: \"FbxSurfacePhong\" {" << std::endl <<
         "\t\t\tProperties70:  {" << std::endl <<
         "\t\t\t\tP: \"ShadingModel\", \"KString\", \"\", \"\", \"Phong\"" << std::endl <<
         "\t\t\t\tP: \"MultiLayer\", \"bool\", \"\", \"\",0" << std::endl <<
         "\t\t\t\tP: \"EmissiveColor\", \"ColorRGB\", \"Color\", \"A\",0,0,0" << std::endl <<
         "\t\t\t\tP: \"EmissiveFactor\", \"double\", \"Number\", \"A\",0" << std::endl <<
         "\t\t\t\tP: \"AmbientColor\", \"ColorRGB\", \"Color\", \"A\",0,0,0" << std::endl <<
         "\t\t\t\tP: \"AmbientFactor\", \"double\", \"Number\", \"A\",0" << std::endl <<
         "\t\t\t\tP: \"DiffuseColor\", \"ColorRGB\", \"Color\", \"A\",0,0,0" << std::endl <<
         "\t\t\t\tP: \"DiffuseFactor\", \"double\", \"Number\", \"A\",1" << std::endl <<
         "\t\t\t\tP: \"Bump\", \"Vector3D\", \"Vector\", \"\",0,0,0" << std::endl <<
         "\t\t\t\tP: \"NormalMap\", \"Vector3D\", \"Vector\", \"\",0,0,0" << std::endl <<
         "\t\t\t\tP: \"BumpFactor\", \"double\", \"Number\", \"\",1" << std::endl <<
         "\t\t\t\tP: \"TransparentColor\", \"ColorRGB\", \"Color\", \"A\",0,0,0" << std::endl <<
         "\t\t\t\tP: \"TransparencyFactor\", \"double\", \"Number\", \"A\",0" << std::endl <<
         "\t\t\t\tP: \"DisplacementColor\", \"ColorRGB\", \"Color\", \"\",0,0,0" << std::endl <<
         "\t\t\t\tP: \"DisplacementFactor\", \"double\", \"Number\", \"\",1" << std::endl <<
         "\t\t\t\tP: \"VectorDisplacementColor\", \"ColorRGB\", \"Color\", \"\",0,0,0" << std::endl <<
         "\t\t\t\tP: \"VectorDisplacementFactor\", \"double\", \"Number\", \"\",1" << std::endl <<
         "\t\t\t\tP: \"SpecularColor\", \"ColorRGB\", \"Color\", \"A\",0,0,0" << std::endl <<
         "\t\t\t\tP: \"SpecularFactor\", \"double\", \"Number\", \"A\",0" << std::endl <<
         "\t\t\t\tP: \"ShininessExponent\", \"double\", \"Number\", \"A\",20" << std::endl <<
         "\t\t\t\tP: \"ReflectionColor\", \"ColorRGB\", \"Color\", \"A\",0,0,0" << std::endl <<
         "\t\t\t\tP: \"ReflectionFactor\", \"double\", \"Number\", \"A\",0" << std::endl <<
         "\t\t\t}" << std::endl <<
         "\t\t}" << std::endl <<
         "\t}" << std::endl;
  /*
  m_File << "\tObjectType: \"Material\" {" << std::endl <<
            "\t\tCount: " << materialCount << std::endl <<
            "\t\tPropertyTemplate: \"FbxSurfaceLambert\" {" << std::endl <<
            "\t\t\tProperties70:  {" << std::endl <<
            "\t\t\t\tP: \"ShadingModel\", \"KString\", \"\", \"\", \"Lambet\"" << std::endl <<
            "\t\t\t\tP: \"MultiLayer\", \"bool\", \"\", \"\",0" << std::endl <<
            "\t\t\t\tP: \"EmissiveColor\", \"ColorRGB\", \"Color\", \"A\",0,0,0" << std::endl <<
            "\t\t\t\tP: \"EmissiveFactor\", \"double\", \"Number\", \"A\",0" << std::endl <<
            "\t\t\t\tP: \"AmbientColor\", \"ColorRGB\", \"Color\", \"A\",0,0,0" << std::endl <<
            "\t\t\t\tP: \"AmbientFactor\", \"double\", \"Number\", \"A\",0" << std::endl <<
            "\t\t\t\tP: \"DiffuseColor\", \"ColorRGB\", \"Color\", \"A\",0,0,0" << std::endl <<
            "\t\t\t\tP: \"DiffuseFactor\", \"double\", \"Number\", \"A\",1" << std::endl <<
            "\t\t\t\tP: \"Bump\", \"Vector3D\", \"Vector\", \"\",0,0,0" << std::endl <<
            "\t\t\t\tP: \"NormalMap\", \"Vector3D\", \"Vector\", \"\",0,0,0" << std::endl <<
            "\t\t\t\tP: \"BumpFactor\", \"double\", \"Number\", \"\",1" << std::endl <<
            "\t\t\t\tP: \"TransparentColor\", \"ColorRGB\", \"Color\", \"A\",0,0,0" << std::endl <<
            "\t\t\t\tP: \"TransparencyFactor\", \"double\", \"Number\", \"A\",0" << std::endl <<
            "\t\t\t\tP: \"DisplacementColor\", \"ColorRGB\", \"Color\", \"\",0,0,0" << std::endl <<
            "\t\t\t\tP: \"DisplacementFactor\", \"double\", \"Number\", \"\",1" << std::endl <<
            "\t\t\t\tP: \"VectorDisplacementColor\", \"ColorRGB\", \"Color\", \"\",0,0,0" << std::endl <<
            "\t\t\t\tP: \"VectorDisplacementFactor\", \"double\", \"Number\", \"\",1" << std::endl <<
            "\t\t\t}" << std::endl <<
            "\t\t}" << std::endl <<
            "\t}" << std::endl;
  */
  m_File << "\tObjectType: \"Geometry\" {" << std::endl <<
         "\t\tCount: " << geometryCount << std::endl <<
         "\t\tPropertyTemplate: \"FbxMesh\" {" << std::endl <<
         "\t\t\tProperties70:  {" << std::endl <<
         "\t\t\t\tP: \"Color\", \"ColorRGB\", \"Color\", \"\",1,1,1" << std::endl <<
         "\t\t\t\tP: \"BBoxMin\", \"Vector3D\", \"Vector\", \"\",0,0,0" << std::endl <<
         "\t\t\t\tP: \"BBoxMax\", \"Vector3D\", \"Vector\", \"\",0,0,0" << std::endl <<
         "\t\t\t\tP: \"Primary Visibility\", \"bool\", \"\", \"\",1" << std::endl <<
         "\t\t\t\tP: \"Casts Shadows\", \"bool\", \"\", \"\",0" << std::endl <<
         "\t\t\t\tP: \"Receive Shadows\", \"bool\", \"\", \"\",0" << std::endl <<
         "\t\t\t}" << std::endl <<
         "\t\t}" << std::endl <<
         "\t}" << std::endl <<
         "}" << std::endl << std::endl;
 
}

◆ writePVModelNode()

void writePVModelNode	(	G4VPhysicalVolume *	physVol,
		const std::string &	pvName,
		unsigned long long	pvID
	)

private

Write FBX definition for each physical volume.

Definition at line 936 of file FBXWriterModule.cc.

{
  G4RotationMatrix* rot = physVol->GetObjectRotation();
  G4ThreeVector move = physVol->GetObjectTranslation();
  // FBX uses the Tait-Bryan version of the Euler angles (X then Y then Z rotation)
  double yaw = std::atan2(rot->yx(), rot->xx()) * 180.0 / M_PI;
  if (fabs(yaw) < 1.0E-12) yaw = 0.0;
  double pitch = -std::asin(rot->zx()) * 180.0 / M_PI;
  if (fabs(pitch) < 1.0E-12) pitch = 0.0;
  double roll = std::atan2(rot->zy(), rot->zz()) * 180.0 / M_PI;
  if (fabs(roll) < 1.0E-12) roll = 0.0;
  m_File << "\t; PhysVol " << physVol->GetName();
  if (physVol->IsReplicated()) {
    m_File << " (replicated: copy " << physVol->GetCopyNo() << ")";
  }
  m_File << ", placing LogVol " << physVol->GetLogicalVolume()->GetName() << std::endl <<
         "\tModel: " << pvID << ", \"Model::" << pvName << R"(", "Null" {)" << std::endl <<
         "\t\tVersion: 232" << std::endl <<
         "\t\tProperties70:  {" << std::endl <<
         "\t\t\tP: \"Lcl Translation\", \"Lcl Translation\", \"\", \"A\"," <<
         move.x() << "," << move.y() << "," << move.z() << std::endl <<
         "\t\t\tP: \"Lcl Rotation\", \"Lcl Rotation\", \"\", \"A\"," <<
         roll << "," << pitch << "," << yaw << std::endl <<
         "\t\t}" << std::endl <<
         "\t\tShading: T" << std::endl <<
         "\t\tCulling: \"CullingOff\"" << std::endl <<
         "\t}" << std::endl;
}

◆ writePVToParentLV()

void writePVToParentLV	(	const std::string &	pvNameDaughter,
		const std::string &	lvName,
		unsigned long long	pvIDDaughter,
		unsigned long long	lvID
	)

private

Write FBX connection for each physical-volume daughter of a parent logical volume.

Definition at line 990 of file FBXWriterModule.cc.

{
  m_File << "\t; PhysVol Model::" << pvNameDaughter << ", parent LogVol Model::lv_" << lvName << std::endl <<
         "\tC: \"OO\"," << pvIDDaughter << "," << lvID << std::endl << std::endl;
}

◆ writePVToParentPV()

void writePVToParentPV	(	const std::string &	pvNameDaughter,
		const std::string &	pvName,
		unsigned long long	pvIDDaughter,
		unsigned long long	pvID
	)

private

Write FBX connection for each physical-volume daughter of a parent physical volume (bypass singleton logical volume)

Definition at line 997 of file FBXWriterModule.cc.

{
  m_File << "\t; PhysVol Model::" << pvNameDaughter << ", parent PhysVol Model::" << pvName << std::endl <<
         "\tC: \"OO\"," << pvIDDaughter << "," << pvID << std::endl << std::endl;
}

◆ writeSolidToLV()

void writeSolidToLV	(	const std::string &	lvName,
		const std::string &	solidName,
		bool	visible,
		unsigned long long	matID,
		unsigned long long	lvID,
		unsigned long long	solidID
	)

private

Write FBX connection for each logical volume's solid and color info.

Definition at line 965 of file FBXWriterModule.cc.

{
  m_File << "\t; Solid Geometry::" << solidName << ", LogVol Model::lv_" << lvName << std::endl <<
         "\t" << (visible ? "" : "; ") << "C: \"OO\"," << solidID << "," << lvID << std::endl << std::endl <<
         "\t; Color Material::" << lvName << ", LogVol Model::lv_" << lvName << std::endl <<
         "\t" << (visible ? "" : "; ") << "C: \"OO\"," << matID << "," << lvID << std::endl << std::endl;
}

◆ writeSolidToPV()

void writeSolidToPV	(	const std::string &	pvName,
		const std::string &	solidName,
		bool	visible,
		unsigned long long	matID,
		unsigned long long	pvID,
		unsigned long long	solidID
	)

private

Write FBX connection for each physical volume's solid and color info (bypass singleton logical volume)

Definition at line 974 of file FBXWriterModule.cc.

{
  m_File << "\t; Solid Geometry::" << solidName << ", PhysVol Model::" << pvName << std::endl <<
         "\t" << (visible ? "" : "; ") << "C: \"OO\"," << solidID << "," << pvID << std::endl << std::endl <<
         "\t; Color Material::" << pvName << ", PhysVol Model::" << pvName << std::endl <<
         "\t" << (visible ? "" : "; ") << "C: \"OO\"," << matID << "," << pvID << std::endl << std::endl;
}

Member Data Documentation

◆ m_conditions

std::vector<ModuleCondition> m_conditions

privateinherited

Module condition, only non-null if set.

Definition at line 521 of file Module.h.

◆ m_description

std::string m_description

privateinherited

The description of the module.

Definition at line 511 of file Module.h.

◆ m_File

std::ofstream m_File

private

Output file.

Definition at line 111 of file FBXWriterModule.h.

◆ m_Filename

std::string m_Filename {"belle2.fbx"}

private

User-specified output filename.

Definition at line 108 of file FBXWriterModule.h.

◆ m_First

bool m_First {true}

private

Once-only flag to write FBX only on the first event.

Definition at line 101 of file FBXWriterModule.h.

◆ m_hasReturnValue

bool m_hasReturnValue

privateinherited

True, if the return value is set.

Definition at line 518 of file Module.h.

◆ m_logConfig

LogConfig m_logConfig

privateinherited

The log system configuration of the module.

Definition at line 514 of file Module.h.

◆ m_LVCount

std::vector<unsigned int>* m_LVCount {nullptr}

private

Count of number of instances of each logical volume.

Definition at line 141 of file FBXWriterModule.h.

◆ m_LVID

std::vector<unsigned long long>* m_LVID {nullptr}

private

Unique identifiers for logical volumes (Model nodes with links to Geometry and Material)

Definition at line 126 of file FBXWriterModule.h.

◆ m_LVName

std::vector<std::string>* m_LVName {nullptr}

private

Modified (legal-character and unique) logical-volume name.

Definition at line 117 of file FBXWriterModule.h.

◆ m_LVReplicas

std::vector<unsigned int>* m_LVReplicas {nullptr}

private

Count of number of replicas of each logical volume associated with a replicated physical volume.

Definition at line 150 of file FBXWriterModule.h.

◆ m_LVUnique

std::vector<bool>* m_LVUnique {nullptr}

private

Flag to indicate that a logical volume is referenced at most once (eligible for bypass)

Definition at line 156 of file FBXWriterModule.h.

◆ m_MatID

std::vector<unsigned long long>* m_MatID {nullptr}

private

Unique identifiers for logical volumes' color information (Material nodes)

Definition at line 129 of file FBXWriterModule.h.

◆ m_moduleParamList

ModuleParamList m_moduleParamList

privateinherited

List storing and managing all parameter of the module.

Definition at line 516 of file Module.h.

◆ m_name

std::string m_name

privateinherited

The name of the module, saved as a string (user-modifiable)

Definition at line 508 of file Module.h.

◆ m_package

std::string m_package

privateinherited

Package this module is found in (may be empty).

Definition at line 510 of file Module.h.

◆ m_propertyFlags

unsigned int m_propertyFlags

privateinherited

The properties of the module as bitwise or (with |) of EModulePropFlags.

Definition at line 512 of file Module.h.

◆ m_PVCount

std::vector<unsigned int>* m_PVCount {nullptr}

private

Count of number of instances of each physical volume.

Definition at line 138 of file FBXWriterModule.h.

◆ m_PVID

std::vector<unsigned long long>* m_PVID {nullptr}

private

Unique identifiers for physical volumes (Model nodes with transformation information)

Definition at line 123 of file FBXWriterModule.h.

◆ m_PVName

std::vector<std::string>* m_PVName {nullptr}

private

Modified (legal-character and unique) physical-volume name.

Definition at line 114 of file FBXWriterModule.h.

◆ m_PVReplicas

std::vector<unsigned int>* m_PVReplicas {nullptr}

private

Count of number of replicas of each replicated physical volume.

Definition at line 147 of file FBXWriterModule.h.

◆ m_returnValue

int m_returnValue

privateinherited

The return value.

Definition at line 519 of file Module.h.

◆ m_SolidCount

std::vector<unsigned int>* m_SolidCount {nullptr}

private

Count of number of instances of each solid (typically 1)

Definition at line 144 of file FBXWriterModule.h.

◆ m_SolidID

std::vector<unsigned long long>* m_SolidID {nullptr}

private

Unique identifiers for solids (Geometry nodes)

Definition at line 132 of file FBXWriterModule.h.

◆ m_SolidName

std::vector<std::string>* m_SolidName {nullptr}

private

Modified (legal-character and unique) solid name.

Definition at line 120 of file FBXWriterModule.h.

◆ m_SolidReplicas

std::vector<unsigned int>* m_SolidReplicas {nullptr}

private

Count of number of replicas of each solid (extras for replicas with modified solids)

Definition at line 153 of file FBXWriterModule.h.

◆ m_type

std::string m_type

privateinherited

The type of the module, saved as a string.

Definition at line 509 of file Module.h.

◆ m_UsePrototypes

bool m_UsePrototypes {false}

private

User-specified flag to select whether to write and re-use logical- and physical-volume prototypes once (true) or to write duplicates of each such volume (false).

Definition at line 105 of file FBXWriterModule.h.

◆ m_Visible

std::vector<bool>* m_Visible {nullptr}

private

Flag to indicate that the logical volume is visible.

Definition at line 135 of file FBXWriterModule.h.

The documentation for this class was generated from the following files:

geometry/modules/fbxWriter/include/FBXWriterModule.h
geometry/modules/fbxWriter/src/FBXWriterModule.cc

Public Types

Public Member Functions

Static Public Member Functions

Protected Member Functions

Private Member Functions

Private Attributes

Detailed Description

Member Typedef Documentation

◆ EAfterConditionPath

Member Enumeration Documentation

◆ EModulePropFlags

Constructor & Destructor Documentation

◆ FBXWriterModule()

Member Function Documentation

◆ addConnections()

◆ addModels()

◆ assignName()

◆ beginRun()

◆ clone()

◆ countEntities()

◆ def_beginRun()

◆ def_endRun()

◆ def_event()

◆ def_initialize()

◆ def_terminate()

◆ endRun()

◆ evalCondition()

◆ event()

◆ exposePythonAPI()

◆ getAfterConditionPath()

◆ getAllConditionPaths()

◆ getAllConditions()

◆ getBooleanSolidPolyhedron()

◆ getCondition()

◆ getConditionPath()

◆ getDescription()

◆ getFileNames()

◆ getLogConfig()

◆ getModules()

◆ getName()

◆ getPackage()

◆ getParamInfoListPython()

◆ getParamList()

◆ getPathString()

◆ getReturnValue()

◆ getType()

◆ hasCondition()

◆ hasProperties()

◆ hasReturnValue()

◆ hasUnsetForcedParams()

◆ if_false()

◆ if_true()

◆ if_value()

◆ initialize()

◆ setAbortLevel()

◆ setDebugLevel()

◆ setDescription()

◆ setLogConfig()

◆ setLogInfo()

◆ setLogLevel()

◆ setName()

◆ setParamList()

◆ setParamPython()

◆ setParamPythonDict()

◆ setPropertyFlags()

◆ setReturnValue() [1/2]

◆ setReturnValue() [2/2]

◆ setType()

◆ terminate()

◆ writeGeometryNode()

◆ writeLVModelNode()

◆ writeLVToPV()

◆ writeMaterialNode()

◆ writePolyhedron()

◆ writePreamble()

◆ writePVModelNode()

◆ writePVToParentLV()

◆ writePVToParentPV()

◆ writeSolidToLV()

◆ writeSolidToPV()