G4VtkMessenger Class Reference

#include <G4VtkMessenger.hh>

Inheritance diagram for G4VtkMessenger:

Public Member Functions
	~G4VtkMessenger () override
G4String	GetCurrentValue (G4UIcommand *command) override
void	SetNewValue (G4UIcommand *command, G4String newValue) override
Public Member Functions inherited from G4UImessenger
	G4UImessenger ()=default
	G4UImessenger (const G4String &path, const G4String &dsc, G4bool commandsToBeBroadcasted=true)
virtual	~G4UImessenger ()
G4bool	CommandsShouldBeInMaster () const

Static Public Member Functions
static G4VtkMessenger *	GetInstance ()

Additional Inherited Members
Protected Member Functions inherited from G4UImessenger
G4String	ItoS (G4int i)
G4String	LtoS (G4long l)
G4String	DtoS (G4double a)
G4String	BtoS (G4bool b)
G4int	StoI (const G4String &s)
G4long	StoL (const G4String &s)
G4double	StoD (const G4String &s)
G4bool	StoB (const G4String &s)
void	AddUIcommand (G4UIcommand *newCommand)
void	CreateDirectory (const G4String &path, const G4String &dsc, G4bool commandsToBeBroadcasted=true)
template<typename T>
T *	CreateCommand (const G4String &cname, const G4String &dsc)
Protected Attributes inherited from G4UImessenger
G4UIdirectory *	baseDir = nullptr
G4String	baseDirName = ""
G4bool	commandsShouldBeInMaster = false

Detailed Description

Definition at line 39 of file G4VtkMessenger.hh.

Constructor & Destructor Documentation

~G4VtkMessenger()

G4VtkMessenger::~G4VtkMessenger ( )

override

Definition at line 274 of file G4VtkMessenger.cc.

{
  delete fpDirectory;
  delete fpDirectorySet;
  delete fpDirectoryAdd;
  delete fpCommandExport;
  delete fpCommandExportCutter;
  delete fpCommandWarnings;
  delete fpCommandDebugPrint;
  delete fpCommandPolyhedronPipeline;
  delete fpCommandImageOverlay;
  delete fpCommandGeometryOverlay;
}

Member Function Documentation

GetCurrentValue()

G4String G4VtkMessenger::GetCurrentValue ( G4UIcommand * command )

overridevirtual

Reimplemented from G4UImessenger.

Definition at line 288 of file G4VtkMessenger.cc.

{
  return G4String();
}

GetInstance()

G4VtkMessenger * G4VtkMessenger::GetInstance ( )

static

Definition at line 42 of file G4VtkMessenger.cc.

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

Referenced by G4Vtk::G4Vtk(), and G4VtkOffscreen::G4VtkOffscreen().

SetNewValue()

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

overridevirtual

Reimplemented from G4UImessenger.

Definition at line 293 of file G4VtkMessenger.cc.

{
  G4VisManager* pVisManager = G4VisManager::GetInstance();
 
  G4VViewer* pViewer = pVisManager->GetCurrentViewer();
  if (pViewer == nullptr) {
    G4cout << "G4VtkMessenger::SetNewValue: No current viewer.\n"
           << "\"/vis/open\", or similar, to get one." << G4endl;
    return;
  }
 
  auto* pVtkViewer = dynamic_cast<G4VtkViewer*>(pViewer);
  if (pVtkViewer == nullptr) {
    G4cout << "G4VtkMessenger::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 == fpCommandClearNonG4) {
    auto sceneHandler = dynamic_cast<G4VtkSceneHandler*>(pViewer->GetSceneHandler());
    auto transientStore = sceneHandler->GetTransientStore();
 
    transientStore.ClearNonG4();
  }
  else 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 if (format == "gltf")
      pVtkViewer->ExportGLTFScene(name);
    else if (format == "x3d")
      pVtkViewer->ExportX3DScene(name);
    else
      G4cout << "Unknown /vis/vtk/export file format" << G4endl;
  }
  else if (command == fpCommandExportCutter) {
    std::istringstream iss(newValue);
 
    G4String fileName;
    iss >> fileName;
    pVtkViewer->ExportVTPCutter(fileName);
  }
  else if (command == fpCommandWarnings) {
    if (G4UIcommand::ConvertToBool(newValue)) {
      vtkObject::GlobalWarningDisplayOn();
    }
    else {
      vtkObject::GlobalWarningDisplayOff();
    }
  }
  else if (command == fpCommandHUD) {
    if (G4UIcommand::ConvertToBool(newValue)) {
      pVtkViewer->EnableHUD();
    }
    else {
      pVtkViewer->DisableHUD();
    }
  }
  else if (command == fpCameraOrientation) {
    G4cout << newValue << G4endl;
    if (G4UIcommand::ConvertToBool(newValue)) {
      pVtkViewer->EnableCameraOrientationWidget();
    }
    else {
      pVtkViewer->DisableCameraOrientationWidget();
    }
  }
  else if (command == fpCommandDebugPrint) {
    pVtkViewer->Print();
  }
  else if (command == fpCommandPolyhedronPipeline) {
    G4String temp;
 
    std::istringstream iss(newValue);
 
    G4String pipelineType;
    iss >> pipelineType;
 
    pVtkViewer->SetPolyhedronPipeline(pipelineType);
  }
  else if (command == fpCommandImageOverlay) {
    G4String temp;
 
    G4String fileName;
    G4double imageBottomLeft[2] = {0, 0};
    G4double imageTopRight[2] = {1, 1};
    G4double worldBottomLeft[2] = {0, 0};
    G4double worldTopRight[2] = {1, 1};
    G4double rotation[3] = {0, 0, 0};
    G4double translation[3] = {0, 0, 0};
    G4double alpha = 0.5;
 
    std::istringstream iss(newValue);
 
    iss >> fileName >> imageBottomLeft[0] >> imageBottomLeft[1] >> imageTopRight[0]
      >> imageTopRight[1] >> worldBottomLeft[0] >> worldBottomLeft[1] >> worldTopRight[0]
      >> worldTopRight[1] >> rotation[0] >> rotation[1] >> rotation[2] >> translation[0]
      >> translation[1] >> translation[2] >> alpha;
 
    pVtkViewer->AddImageOverlay(fileName, alpha, imageBottomLeft, worldBottomLeft, imageTopRight,
                                worldTopRight, rotation, translation);
  }
  else if (command == fpCommandGeometryOverlay) {
    G4String temp;
 
    G4String fileName;
    G4double scale[3] = {1, 1, 1};
    G4double rotation[3] = {0,0,0};
    G4double translation[3] = {0,0,0};
    G4double colour[3] = {0.5, 0.5, 0.5};
    G4double alpha = 1.0;
    G4String representation = "w";
 
    std::istringstream iss(newValue);
 
    iss >> fileName
        >> scale[0] >> scale[1] >> scale[2]
        >> rotation[0] >> rotation[1] >> rotation[2]
        >> translation[0] >> translation[1] >> translation[2]
        >> alpha >> representation;
 
    G4cout << fileName << G4endl;
    pVtkViewer->AddGeometryOverlay(fileName, colour, alpha, representation,
                                   scale, rotation, translation);
  }
 
 
  else if (command == fpCommandClipper) {
    pVtkViewer->EnableClipper(G4Plane3D(), true);
  }
  else if (command == fpCommandCutter) {
    pVtkViewer->EnableCutter(G4Plane3D(), true);
  }
  else if (command == fpCommandShadow) {
    pVtkViewer->EnableShadows();
  }
  else if (command == fpCommandInteractorStart) {
    pVtkViewer->StartInteractor();
  }
}

---

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

• G4VtkMessenger.hh
• G4VtkMessenger.cc