#include <G4VtkMessenger.hh>

Inheritance diagram for G4VtkMessenger:

Public Member Functions
G4bool	CommandsShouldBeInMaster () const

virtual G4String	GetCurrentValue (G4UIcommand *command)

G4bool	operator!= (const G4UImessenger &messenger) const

G4bool	operator== (const G4UImessenger &messenger) const

virtual void	SetNewValue (G4UIcommand *command, G4String newValue)

virtual	~G4VtkMessenger ()

Static Public Member Functions
static G4VtkMessenger *	GetInstance ()

Protected Member Functions
void	AddUIcommand (G4UIcommand *newCommand)

G4String	BtoS (G4bool b)

template<typename T >
T *	CreateCommand (const G4String &cname, const G4String &dsc)

void	CreateDirectory (const G4String &path, const G4String &dsc, G4bool commandsToBeBroadcasted=true)

G4String	DtoS (G4double a)

G4String	ItoS (G4int i)

G4bool	StoB (G4String s)

G4double	StoD (G4String s)

G4int	StoI (G4String s)

G4long	StoL (G4String s)

Protected Attributes
G4UIdirectory *	baseDir = nullptr

G4String	baseDirName = ""

G4bool	commandsShouldBeInMaster = false

Private Member Functions
	G4VtkMessenger ()

Private Attributes
G4UIcommand *	fpCommandExport

G4UIcmdWithABool *	fpCommandWarnings

G4UIdirectory *	fpDirectory

Static Private Attributes
static G4VtkMessenger *	fpInstance = nullptr

Detailed Description

Definition at line 38 of file G4VtkMessenger.hh.

Constructor & Destructor Documentation

◆ ~G4VtkMessenger()

G4VtkMessenger::~G4VtkMessenger ( )

virtual

Definition at line 73 of file G4VtkMessenger.cc.

{
  delete fpDirectory;
  delete fpCommandExport;
  delete fpCommandWarnings;
}

References fpCommandExport, fpCommandWarnings, and fpDirectory.

◆ G4VtkMessenger()

G4VtkMessenger::G4VtkMessenger ( )

private

Definition at line 48 of file G4VtkMessenger.cc.

                               {
  G4bool omitable;
 
  fpDirectory = new G4UIdirectory("/vis/vtk/");
  fpDirectory->SetGuidance("G4VtkViewer commands.");
 
  // Export command
  fpCommandExport = new G4UIcommand("/vis/vtk/export", this);
  fpCommandExport->SetGuidance ("Export a screenshot or OBJ file of current Vtk viewer");
 
  // File type for export
  auto parameterExport = new G4UIparameter ("name", 's', omitable = true);
  fpCommandExport->SetGuidance ("File type (jpg,tiff,eps,ps,obj,vrml)");
  fpCommandExport->SetParameter(parameterExport);
 
  // File name for export
  parameterExport = new G4UIparameter ("name", 's', omitable = true);
  fpCommandExport->SetGuidance ("File name");
  fpCommandExport->SetParameter(parameterExport);
 
  // Vtk warnings output
  fpCommandWarnings = new G4UIcmdWithABool("/vis/vtk/warnings", this);
  fpCommandExport->SetGuidance ("Enable (True) or disable (False) VTK warnings");
}

References fpCommandExport, fpCommandWarnings, fpDirectory, G4UIcommand::SetGuidance(), and G4UIcommand::SetParameter().

Referenced by GetInstance().

Member Function Documentation

◆ AddUIcommand()

void G4UImessenger::AddUIcommand ( G4UIcommand * newCommand )

protectedinherited

Definition at line 149 of file G4UImessenger.cc.

{
  G4cerr << "Warning : Old style definition of G4UIcommand <"
         << newCommand->GetCommandPath() << ">." << G4endl;
}

References G4cerr, G4endl, and G4UIcommand::GetCommandPath().

◆ BtoS()

G4String G4UImessenger::BtoS ( G4bool b )

protectedinherited

Definition at line 98 of file G4UImessenger.cc.

{
  G4String vl = "0";
  if(b)
    vl = "true";
  return vl;
}

◆ CommandsShouldBeInMaster()

G4bool G4UImessenger::CommandsShouldBeInMaster ( ) const

inlineinherited

Definition at line 77 of file G4UImessenger.hh.

    {
      return commandsShouldBeInMaster;
    }

References G4UImessenger::commandsShouldBeInMaster.

Referenced by G4UIcommand::G4UIcommandCommonConstructorCode().

◆ CreateCommand()

template<typename T >

T * G4UImessenger::CreateCommand	(	const G4String &	cname,
		const G4String &	dsc
	)

protectedinherited

Definition at line 110 of file G4UImessenger.hh.

{
  G4String path;
  if(cname[0] != '/')
  {
    path = baseDirName + cname;
    if(path[0] != '/')
      path = "/" + path;
  }
 
  T* command = new T(path.c_str(), this);
  command->SetGuidance(dsc.c_str());
 
  return command;
}

References G4UImessenger::baseDirName.

◆ CreateDirectory()

void G4UImessenger::CreateDirectory	(	const G4String &	path,
		const G4String &	dsc,
		G4bool	commandsToBeBroadcasted = `true`
	)

protectedinherited

Definition at line 156 of file G4UImessenger.cc.

{
  G4UImanager* ui = G4UImanager::GetUIpointer();
 
  G4String fullpath = path;
  if(fullpath.back() != '/')
    fullpath.append("/");
 
  G4UIcommandTree* tree = ui->GetTree()->FindCommandTree(fullpath.c_str());
  if(tree != nullptr)
  {
    baseDirName = tree->GetPathName();
  }
  else
  {
    baseDir     = new G4UIdirectory(fullpath.c_str(), commandsToBeBroadcasted);
    baseDirName = fullpath;
    baseDir->SetGuidance(dsc.c_str());
  }
}

References G4UImessenger::baseDir, G4UImessenger::baseDirName, G4UIcommandTree::FindCommandTree(), G4UIcommandTree::GetPathName(), G4UImanager::GetTree(), G4UImanager::GetUIpointer(), and G4UIcommand::SetGuidance().

Referenced by G4MoleculeShootMessenger::G4MoleculeShootMessenger(), and G4UImessenger::G4UImessenger().

◆ DtoS()

G4String G4UImessenger::DtoS ( G4double a )

protectedinherited

Definition at line 90 of file G4UImessenger.cc.

{
  std::ostringstream os;
  os << a;
  return G4String(os.str());
}

Referenced by G4ScoreQuantityMessenger::FilterCommands(), and G4UIcontrolMessenger::SetNewValue().

◆ GetCurrentValue()

G4String G4VtkMessenger::GetCurrentValue ( G4UIcommand * command )

virtual

Reimplemented from G4UImessenger.

Definition at line 79 of file G4VtkMessenger.cc.

                                                        {
  return G4String();
}

◆ GetInstance()

G4VtkMessenger * G4VtkMessenger::GetInstance ( )

static

Definition at line 42 of file G4VtkMessenger.cc.

{
  if (!fpInstance) fpInstance = new G4VtkMessenger;
  return fpInstance;
}

References fpInstance, and G4VtkMessenger().

Referenced by G4Vtk::G4Vtk().

◆ ItoS()

G4String G4UImessenger::ItoS ( G4int i )

protectedinherited

Definition at line 82 of file G4UImessenger.cc.

{
  std::ostringstream os;
  os << i;
  return G4String(os.str());
}

Referenced by G4GenericMessenger::DeclareMethod(), and G4ParticleGunMessenger::GetCurrentValue().

◆ operator!=()

G4bool G4UImessenger::operator!= ( const G4UImessenger & messenger ) const

inherited

Definition at line 76 of file G4UImessenger.cc.

{
  return this != &messenger;
}

◆ operator==()

G4bool G4UImessenger::operator== ( const G4UImessenger & messenger ) const

inherited

Definition at line 70 of file G4UImessenger.cc.

{
  return this == &messenger;
}

◆ SetNewValue()

void G4VtkMessenger::SetNewValue	(	G4UIcommand *	command,
		G4String	newValue
	)

virtual

Reimplemented from G4UImessenger.

Definition at line 83 of file G4VtkMessenger.cc.

{
 
  G4VisManager* pVisManager = G4VisManager::GetInstance();
 
  G4VViewer* pViewer = pVisManager->GetCurrentViewer();
  if (!pViewer) {
    G4cout << "G4VtkMessenger::SetNewValue: No current viewer.\n"
           << "\"/vis/open\", or similar, to get one."
           << G4endl;
    return;
  }
 
  auto* pVtkViewer = dynamic_cast<G4VtkViewer*>(pViewer);
  if (!pVtkViewer) {
    G4cout << "G4OpenGLViewerMessenger::SetNewValue: Current viewer is not of type VTK. \n"
           << "(It is \""
           << pViewer->GetName()
           << "\".)\n"
           << "Use \"/vis/viewer/select\" or \"/vis/open\"."
           << G4endl;
    return;
  }
 
  if (command == fpCommandExport)
  {
    G4String format, name;
 
    std::istringstream iss(newValue);
    iss >> format >> name;
 
    if(format == "jpg" || format == "tiff" ||
       format == "png" || format == "bmp" ||
       format == "pnm" || format == "ps")
      pVtkViewer->ExportScreenShot(name, format);
    else if(format == "obj")
      pVtkViewer->ExportOBJScene(name);
    else if(format == "vrml")
      pVtkViewer->ExportVRMLScene(name);
    else if(format == "vtp")
      pVtkViewer->ExportVTPScene(name);
    else
      G4cout << "Unknown /vis/vtk/export file format" << G4endl;
  }
  else if (command == fpCommandWarnings)
  {
    vtkObject::GlobalWarningDisplayOff();
  }
}

References fpCommandExport, fpCommandWarnings, G4cout, G4endl, G4VisManager::GetCurrentViewer(), G4VisManager::GetInstance(), G4VViewer::GetName(), and G4InuclParticleNames::name().

◆ StoB()

G4bool G4UImessenger::StoB ( G4String s )

protectedinherited

Definition at line 137 of file G4UImessenger.cc.

{
  G4String v = G4StrUtil::to_upper_copy(str);
  G4bool vl = false;
  if(v == "Y" || v == "YES" || v == "1" || v == "T" || v == "TRUE")
  {
    vl = true;
  }
  return vl;
}

References G4StrUtil::to_upper_copy().

Referenced by G4LocalThreadCoutMessenger::SetNewValue(), G4CascadeParamMessenger::SetNewValue(), G4ScoreQuantityMessenger::SetNewValue(), and G4ScoringMessenger::SetNewValue().

◆ StoD()

G4double G4UImessenger::StoD ( G4String s )

protectedinherited

Definition at line 127 of file G4UImessenger.cc.

{
  G4double vl;
  const char* t = str;
  std::istringstream is(t);
  is >> vl;
  return vl;
}

Referenced by G4ScoreQuantityMessenger::FParticleWithEnergyCommand(), G4ParticleGunMessenger::IonCommand(), G4GeneralParticleSourceMessenger::IonCommand(), G4UIcontrolMessenger::SetNewValue(), G4MatScanMessenger::SetNewValue(), G4VisCommandSceneAddText::SetNewValue(), G4VisCommandSceneAddText2D::SetNewValue(), G4ScoreQuantityMessenger::SetNewValue(), G4ScoringMessenger::SetNewValue(), and G4PolarizationMessenger::SetNewValue().

◆ StoI()

G4int G4UImessenger::StoI ( G4String s )

protectedinherited

Definition at line 107 of file G4UImessenger.cc.

{
  G4int vl;
  const char* t = str;
  std::istringstream is(t);
  is >> vl;
  return vl;
}

Referenced by G4ScoringMessenger::Fill1D(), G4ParticleGunMessenger::IonCommand(), G4GeneralParticleSourceMessenger::IonCommand(), G4ParticleGunMessenger::IonLevelCommand(), G4GeneralParticleSourceMessenger::IonLvlCommand(), G4ScoringMessenger::MeshBinCommand(), G4LocalThreadCoutMessenger::SetNewValue(), G4UIcontrolMessenger::SetNewValue(), G4MatScanMessenger::SetNewValue(), G4GMocrenMessenger::SetNewValue(), G4ScoreQuantityMessenger::SetNewValue(), and G4ScoringMessenger::SetNewValue().

◆ StoL()

G4long G4UImessenger::StoL ( G4String s )

protectedinherited

Definition at line 117 of file G4UImessenger.cc.

{
  G4long vl;
  const char* t = str;
  std::istringstream is(t);
  is >> vl;
  return vl;
}

Referenced by G4RunMessenger::SetNewValue().

Field Documentation

◆ baseDir

G4UIdirectory* G4UImessenger::baseDir = nullptr

protectedinherited

Definition at line 102 of file G4UImessenger.hh.

Referenced by G4UImessenger::CreateDirectory(), and G4UImessenger::~G4UImessenger().

◆ baseDirName

G4String G4UImessenger::baseDirName = ""

protectedinherited

Definition at line 103 of file G4UImessenger.hh.

Referenced by G4UImessenger::CreateCommand(), and G4UImessenger::CreateDirectory().

◆ commandsShouldBeInMaster

G4bool G4UImessenger::commandsShouldBeInMaster = false

protectedinherited

Definition at line 104 of file G4UImessenger.hh.

Referenced by G4UImessenger::CommandsShouldBeInMaster(), and G4GeneralParticleSourceMessenger::G4GeneralParticleSourceMessenger().

◆ fpCommandExport

G4UIcommand* G4VtkMessenger::fpCommandExport

private

Definition at line 52 of file G4VtkMessenger.hh.

Referenced by G4VtkMessenger(), SetNewValue(), and ~G4VtkMessenger().

◆ fpCommandWarnings

G4UIcmdWithABool* G4VtkMessenger::fpCommandWarnings

private

Definition at line 53 of file G4VtkMessenger.hh.

Referenced by G4VtkMessenger(), SetNewValue(), and ~G4VtkMessenger().

◆ fpDirectory

G4UIdirectory* G4VtkMessenger::fpDirectory

private

Definition at line 51 of file G4VtkMessenger.hh.

Referenced by G4VtkMessenger(), and ~G4VtkMessenger().

◆ fpInstance

G4VtkMessenger * G4VtkMessenger::fpInstance = nullptr

staticprivate

Definition at line 49 of file G4VtkMessenger.hh.

Referenced by GetInstance().

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

source/visualization/Vtk/include/G4VtkMessenger.hh
source/visualization/Vtk/src/G4VtkMessenger.cc

Public Member Functions

Static Public Member Functions

Protected Member Functions

Protected Attributes

Private Member Functions

Private Attributes

Static Private Attributes

Detailed Description

Constructor & Destructor Documentation

◆ ~G4VtkMessenger()

◆ G4VtkMessenger()

Member Function Documentation

◆ AddUIcommand()

◆ BtoS()

◆ CommandsShouldBeInMaster()

◆ CreateCommand()

◆ CreateDirectory()

◆ DtoS()

◆ GetCurrentValue()

◆ GetInstance()

◆ ItoS()

◆ operator!=()

◆ operator==()

◆ SetNewValue()

◆ StoB()

◆ StoD()

◆ StoI()

◆ StoL()

Field Documentation

◆ baseDir

◆ baseDirName

◆ commandsShouldBeInMaster

◆ fpCommandExport

◆ fpCommandWarnings

◆ fpDirectory

◆ fpInstance