PHG4DisplayAction.h

Go to the documentation of this file. Or view the newest version in sPHENIX GitHub for file PHG4DisplayAction.h

// Tell emacs that this is a C++ source
//  -*- C++ -*-.
#ifndef G4MAIN_PHG4DISPLAYACTION_H
#define G4MAIN_PHG4DISPLAYACTION_H

#include <string>

class G4VPhysicalVolume;

class PHG4DisplayAction
{
 public:
  // delete default ctor, nobody should use it
  PHG4DisplayAction() = delete;
  // this is the ctor we use
  PHG4DisplayAction(const std::string &name)
    : m_Detector(name)
  {
  }

  virtual ~PHG4DisplayAction() {}


  virtual void ApplyDisplayAction(G4VPhysicalVolume *physvol) = 0;

  virtual void SetName(const std::string &name) { m_Detector = name; }

  virtual std::string GetName() const { return m_Detector; }

  virtual void Print(const std::string &/*what*/="ALL") {}

  enum CheckReturnCodes
  {
    ABORT = -1,
    FAILED = 0,
    ACCEPT = 1
  };

 protected:
  /*
 * @param[in] starting volume
 */
  int FindVolumes(G4VPhysicalVolume *physvol);

  /*
 * @param[in] physical volume to be checked
 */
  virtual int CheckVolume(G4VPhysicalVolume */*physvol*/) { return 0; }


  virtual void ApplyVisAttributes(G4VPhysicalVolume */*physvol*/) { return; }

 private:
  std::string m_Detector;
};

#endif  // G4MAIN_PHG4DISPLAYACTION_H