G4VisCommandViewerCreate Class Reference

#include <G4VisCommandsViewer.hh>

Inheritance diagram for G4VisCommandViewerCreate:

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

Additional Inherited Members
Static Public Member Functions inherited from G4VVisCommand
static G4VisManager *	GetVisManager ()
static void	SetVisManager (G4VisManager *pVisManager)
static const G4Colour &	GetCurrentTextColour ()
Protected Member Functions inherited from G4VVisCommand
void	SetViewParameters (G4VViewer *viewer, const G4ViewParameters &viewParams)
void	RefreshIfRequired (G4VViewer *viewer)
void	InterpolateViews (G4VViewer *currentViewer, const std::vector< G4ViewParameters > &viewVector, const G4int nInterpolationPoints=50, const G4int waitTimePerPointmilliseconds=20, const G4String &exportString="")
void	InterpolateToNewView (G4VViewer *currentViewer, const G4ViewParameters &oldVP, const G4ViewParameters &newVP, const G4int nInterpolationPoints=50, const G4int waitTimePerPointmilliseconds=20, const G4String &exportString="")
void	Twinkle (G4VViewer *currentViewer, const G4ViewParameters &baseVP, const std::vector< std::vector< G4PhysicalVolumeModel::G4PhysicalVolumeNodeID > > &paths)
const G4String &	ConvertToColourGuidance ()
void	ConvertToColour (G4Colour &colour, const G4String &redOrString, G4double green, G4double blue, G4double opacity)
G4bool	ProvideValueOfUnit (const G4String &where, const G4String &unit, const G4String &category, G4double &value)
void	CopyCameraParameters (G4ViewParameters &target, const G4ViewParameters &from)
void	CheckSceneAndNotifyHandlers (G4Scene *=nullptr)
G4bool	CheckView ()
void	G4VisCommandsSceneAddUnsuccessful (G4VisManager::Verbosity verbosity)
void	CopyGuidanceFrom (const G4UIcommand *fromCmd, G4UIcommand *toCmd, G4int startLine=0)
void	CopyParametersFrom (const G4UIcommand *fromCmd, G4UIcommand *toCmd)
void	DrawExtent (const G4VisExtent &)
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)
Static Protected Member Functions inherited from G4VVisCommand
static G4String	ConvertToString (G4double x, G4double y, const char *unitName)
static G4bool	ConvertToDoublePair (const G4String &paramString, G4double &xval, G4double &yval)
Protected Attributes inherited from G4UImessenger
G4UIdirectory *	baseDir = nullptr
G4String	baseDirName = ""
G4bool	commandsShouldBeInMaster = false
Static Protected Attributes inherited from G4VVisCommand
static G4VisManager *	fpVisManager = nullptr
static G4int	fCurrentArrow3DLineSegmentsPerCircle = 6
static G4Colour	fCurrentColour = G4Colour::White()
static G4double	fCurrentLineWidth = 1.
static G4Colour	fCurrentTextColour = G4Colour::Blue()
static G4Text::Layout	fCurrentTextLayout = G4Text::left
static G4double	fCurrentTextSize = 12.
static G4PhysicalVolumeModel::TouchableProperties	fCurrentTouchableProperties
static G4VisExtent	fCurrentExtentForField
static std::vector< G4PhysicalVolumesSearchScene::Findings >	fCurrrentPVFindingsForField
static G4bool	fThereWasAViewer = false
static G4ViewParameters	fExistingVP
static G4SceneTreeItem	fExistingSceneTree

Detailed Description

Definition at line 168 of file G4VisCommandsViewer.hh.

Constructor & Destructor Documentation

G4VisCommandViewerCreate()

G4VisCommandViewerCreate::G4VisCommandViewerCreate

(

)

Definition at line 903 of file G4VisCommandsViewer.cc.

                                                   : fId (0) {
  G4bool omitable;
  fpCommand = new G4UIcommand ("/vis/viewer/create", this);
  fpCommand -> SetGuidance
    ("Creates a viewer. If the scene handler name is specified, then a"
     "\nviewer of that scene handler is created. Otherwise, a viewer"
     "\nof the current scene handler is created.");
  fpCommand -> SetGuidance
    ("If the viewer name is not specified a name is generated from the name"
     "\nof the scene handler and a serial number.");
  fpCommand -> SetGuidance("The scene handler and viewer become current.");
  fpCommand -> SetGuidance
    ("(Note: the system adds the graphics system name to the viewer name"
     "\nfor identification, but for selecting, copying, etc., only characters"
     "\nup to the first blank are used. For example, if the viewer name is"
     "\n\"viewer-0 (G4OpenGLStoredQt)\", it may be referenced by \"viewer-0\","
     "\nfor example in \"/vis/viewer/select viewer-0\".)");
  fpCommand -> SetGuidance
  ("Window size and placement hints, e.g. 600x600-100+100 (in pixels):");
  fpCommand -> SetGuidance
  ("- single number, e.g., \"600\": square window;");
  fpCommand -> SetGuidance
  ("- two numbers, e.g., \"800x600\": rectangluar window;");
  fpCommand -> SetGuidance
  ("- two numbers plus placement hint, e.g., \"600x600-100+100\" places window of size"
   "\n  600x600 100 pixels left and 100 pixels down from top right corner.");
  fpCommand -> SetGuidance
  ("- If not specified, the default is \"600\", i.e., 600 pixels square, placed"
   "\n  at the window manager's discretion...or picked up from the previous viewer.");
  fpCommand -> SetGuidance
  ("- This is an X-Windows-type geometry string, see:"
   "\n  https://en.wikibooks.org/wiki/Guide_to_X11/Starting_Programs,"
   "\n  \"Specifying window geometry\".");
  G4UIparameter* parameter;
  parameter = new G4UIparameter ("scene-handler", 's', omitable = true);
  parameter -> SetCurrentAsDefault (true);
  fpCommand -> SetParameter (parameter);
  parameter = new G4UIparameter ("viewer-name", 's', omitable = true);
  parameter -> SetCurrentAsDefault (true);
  fpCommand -> SetParameter (parameter);
  parameter = new G4UIparameter ("window-size-hint", 's', omitable = true);
  parameter -> SetCurrentAsDefault (true);
  fpCommand -> SetParameter (parameter);
}

~G4VisCommandViewerCreate()

G4VisCommandViewerCreate::~G4VisCommandViewerCreate ( )

virtual

Definition at line 948 of file G4VisCommandsViewer.cc.

                                                     {
  delete fpCommand;
}

Member Function Documentation

GetCurrentValue()

G4String G4VisCommandViewerCreate::GetCurrentValue ( G4UIcommand * command )

virtual

Reimplemented from G4UImessenger.

Definition at line 966 of file G4VisCommandsViewer.cc.

{
  G4String sceneHandlerName;
  auto currentSceneHandler = fpVisManager->GetCurrentSceneHandler();
  if (currentSceneHandler) {  // Get name of last scene handler
    sceneHandlerName = currentSceneHandler->GetName();
  }
  else {  // No scene handler - ensure a warning message
    sceneHandlerName = "none";
  }
 
  // Default name
  const auto& viewerName = NextName();
 
  // Size hint
  G4String windowSizeHint;
  auto currentViewer = fpVisManager->GetCurrentViewer();
  if (currentViewer) {  // Get hint from last viewer
    windowSizeHint = currentViewer->GetViewParameters().GetXGeometryString();
  }
  else {  // No viewer - must be first time
    windowSizeHint = fpVisManager->GetDefaultXGeometryString();
  }
 
  // Add quotes around viewer name
  return sceneHandlerName + " \"" + viewerName + "\" " + windowSizeHint;
}

SetNewValue()

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

virtual

Reimplemented from G4UImessenger.

Definition at line 994 of file G4VisCommandsViewer.cc.

                                                                                   {
 
  G4VisManager::Verbosity verbosity = fpVisManager->GetVerbosity();
 
  G4String sceneHandlerName, newName;
  G4String windowSizeHintString;
  std::istringstream is (newValue);
  is >> sceneHandlerName;
 
  // Now need to handle the possibility that the second string
  // contains embedded blanks within quotation marks...
  char c = ' ';
  while (is.get(c) && c == ' '){}
  if (c == '"') {
    while (is.get(c) && c != '"') {newName += c;}
  }
  else {
    newName += c;
    while (is.get(c) && c != ' ') {newName += c;}
  }
  G4StrUtil::strip(newName, ' ');
  G4StrUtil::strip(newName, '"');
 
  // Now get window size hint...
  is >> windowSizeHintString;
 
  const G4SceneHandlerList& sceneHandlerList =
    fpVisManager -> GetAvailableSceneHandlers ();
  std::size_t nHandlers = sceneHandlerList.size ();
  if (nHandlers == 0) {
    G4ExceptionDescription ed;
    ed <<
    "ERROR: G4VisCommandViewerCreate::SetNewValue: no scene handlers."
    "\n  Create a scene handler with \"/vis/sceneHandler/create\"";
    command->CommandFailed(ed);
    return;
  }
 
  std::size_t iHandler;
  for (iHandler = 0; iHandler < nHandlers; ++iHandler) {
    if (sceneHandlerList [iHandler] -> GetName () == sceneHandlerName) break;
  }
 
  if (iHandler >= nHandlers) {
    // Invalid command line argument or none.
    // This shouldn't happen!!!!!!
    G4ExceptionDescription ed;
    ed <<
    "G4VisCommandViewerCreate::SetNewValue: invalid scene handler specified.";
    command->CommandFailed(ed);
    return;
  }
 
  // Valid index.  Set current scene handler and graphics system in
  // preparation for creating viewer.
  G4VSceneHandler* sceneHandler = sceneHandlerList [iHandler];
  if (sceneHandler != fpVisManager -> GetCurrentSceneHandler ()) {
    fpVisManager -> SetCurrentSceneHandler (sceneHandler);
  }
 
  // Now deal with name of viewer.
  G4String nextName = NextName ();
  if (newName == "") {
    newName = nextName;
  }
  if (newName == nextName) fId++;
  G4String newShortName = fpVisManager -> ViewerShortName (newName);
 
  for (std::size_t ih = 0; ih < nHandlers; ++ih) {
    G4VSceneHandler* sh = sceneHandlerList [ih];
    const G4ViewerList& viewerList = sh -> GetViewerList ();
    for (std::size_t iViewer = 0; iViewer < viewerList.size (); iViewer++) {
      if (viewerList [iViewer] -> GetShortName () == newShortName ) {
    G4ExceptionDescription ed;
    ed <<
    "ERROR: Viewer \"" << newShortName << "\" already exists.";
    command->CommandFailed(ed);
    return;
      }
    }
  }
 
  if (fThereWasAViewer && windowSizeHintString == "none") {
    // The user did not specify a window size hint - get from existing VPs
    windowSizeHintString = fExistingVP.GetXGeometryString();
  }
 
  fpVisManager -> CreateViewer (newName,windowSizeHintString);
 
  // Now we have a new viewer
  G4VViewer* newViewer = fpVisManager -> GetCurrentViewer ();
 
  if (newViewer && newViewer -> GetName () == newName) {
    if (fThereWasAViewer) {
      G4ViewParameters vp = newViewer->GetViewParameters();
      // Copy view parameters from existing viewer, except for...
      fExistingVP.SetAutoRefresh(vp.IsAutoRefresh());
      fExistingVP.SetBackgroundColour(vp.GetBackgroundColour());
      fExistingVP.SetGlobalMarkerScale(vp.GetGlobalMarkerScale());
      // ...including window hint paramaters that have been set already above...
      fExistingVP.SetXGeometryString(vp.GetXGeometryString());
      vp = fExistingVP;
      newViewer->SetViewParameters(vp);
      newViewer->AccessSceneTree() = fExistingSceneTree;
    }
    if (verbosity >= G4VisManager::confirmations) {
      G4cout << "New viewer \"" << newName << "\" created." << G4endl;
    }
    // Keep for next time...
    fThereWasAViewer = true;
    auto viewer = fpVisManager->GetCurrentViewer();
    fExistingVP = viewer->GetViewParameters();
    fExistingSceneTree = viewer->GetSceneTree();
  } else {
    G4ExceptionDescription ed;
    if (newViewer) {
      ed << "ERROR: New viewer doesn\'t match!!!  Curious!!";
    } else {
      ed << "WARNING: No viewer created.";
    }
    command->CommandFailed(ed);
    return;
  }
  // Refresh if appropriate...
  if (newViewer) {
    if (newViewer->GetViewParameters().IsAutoRefresh()) {
      G4UImanager::GetUIpointer()->ApplyCommand("/vis/viewer/refresh");
    }
    else {
      if (verbosity >= G4VisManager::warnings) {
    G4warn << "Issue /vis/viewer/refresh or flush to see effect."
           << G4endl;
      }
    }
  }
}

---

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

• G4VisCommandsViewer.hh
• G4VisCommandsViewer.cc