G4VisCommandSceneNotifyHandlers Class Reference

#include <G4VisCommandsScene.hh>

Inheritance diagram for G4VisCommandSceneNotifyHandlers:

Public Member Functions
	G4VisCommandSceneNotifyHandlers ()
virtual	~G4VisCommandSceneNotifyHandlers ()
G4String	GetCurrentValue (G4UIcommand *command)
void	SetNewValue (G4UIcommand *command, G4String newValue)
Public Member Functions inherited from G4VVisCommandScene
	G4VVisCommandScene ()
virtual	~G4VVisCommandScene ()
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 ()
virtual G4String	GetCurrentValue (G4UIcommand *command)
virtual void	SetNewValue (G4UIcommand *command, G4String newValue)
G4bool	operator== (const G4UImessenger &messenger) const
G4bool	operator!= (const G4UImessenger &messenger) const
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 G4VVisCommandScene
G4String	CurrentSceneName ()
Protected Member Functions inherited from G4VVisCommand
void	SetViewParameters (G4VViewer *viewer, const G4ViewParameters &viewParams)
void	RefreshIfRequired (G4VViewer *viewer)
void	InterpolateViews (G4VViewer *currentViewer, 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	DtoS (G4double a)
G4String	BtoS (G4bool b)
G4int	StoI (const G4String &s)
G4long	StoL (const G4String &s)
G4double	StoD (const G4String &s)
G4bool	StoB (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

Detailed Description

Definition at line 115 of file G4VisCommandsScene.hh.

Constructor & Destructor Documentation

G4VisCommandSceneNotifyHandlers()

G4VisCommandSceneNotifyHandlers::G4VisCommandSceneNotifyHandlers

(

)

Definition at line 588 of file G4VisCommandsScene.cc.

                                                                  {
  G4bool omitable;
  fpCommand = new G4UIcommand ("/vis/scene/notifyHandlers", this);
  fpCommand -> SetGuidance
    ("Notifies scene handlers and forces re-rendering.");
  fpCommand -> SetGuidance
    ("Notifies the handler(s) of the specified scene and forces a"
     "\nreconstruction of any graphical databases."
     "\nClears and refreshes all viewers of current scene."
     "\n  The default action \"refresh\" does not issue \"update\" (see"
     "\n    /vis/viewer/update)."
     "\nIf \"flush\" is specified, it issues an \"update\" as well as"
     "\n  \"refresh\" - \"update\" and initiates post-processing"
     "\n  for graphics systems which need it.");
  fpCommand -> SetGuidance 
    ("The default for <scene-name> is the current scene name.");
  fpCommand -> SetGuidance
    ("This command does not change current scene, scene handler or viewer.");
  G4UIparameter* parameter;
  parameter = new G4UIparameter ("scene-name", 's',
                 omitable = true);
  parameter -> SetCurrentAsDefault(true);
  fpCommand -> SetParameter (parameter);
  parameter = new G4UIparameter ("refresh-flush", 's',
                 omitable = true);
  parameter -> SetDefaultValue("refresh");
  parameter -> SetParameterCandidates("r refresh f flush");
  fpCommand -> SetParameter (parameter);
}

~G4VisCommandSceneNotifyHandlers()

G4VisCommandSceneNotifyHandlers::~G4VisCommandSceneNotifyHandlers ( )

virtual

Definition at line 618 of file G4VisCommandsScene.cc.

                                                                   {
  delete fpCommand;
}

Member Function Documentation

GetCurrentValue()

G4String G4VisCommandSceneNotifyHandlers::GetCurrentValue ( G4UIcommand *  command )

virtual

Reimplemented from G4UImessenger.

Definition at line 622 of file G4VisCommandsScene.cc.

                                                                      {
  return CurrentSceneName ();
}

SetNewValue()

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

virtual

Reimplemented from G4UImessenger.

Definition at line 626 of file G4VisCommandsScene.cc.

                                              {
 
  G4VisManager::Verbosity verbosity = fpVisManager->GetVerbosity();
 
  G4String sceneName, refresh_flush;
  std::istringstream is (newValue);
  is >> sceneName >> refresh_flush;
  G4bool flush = false;
  if (refresh_flush[0] == 'f') flush = true;
 
  const G4SceneList& sceneList = fpVisManager -> GetSceneList ();
  G4SceneHandlerList& sceneHandlerList =
    fpVisManager -> SetAvailableSceneHandlers ();
 
  // Check scene name.
  const std::size_t nScenes = sceneList.size ();
  std::size_t iScene;
  for (iScene = 0; iScene < nScenes; ++iScene) {
    G4Scene* scene = sceneList [iScene];
    if (sceneName == scene -> GetName ()) break;
  }
  if (iScene >= nScenes ) {
    if (verbosity >= G4VisManager::warnings) {
      G4warn << "WARNING: Scene \"" << sceneName << "\" not found."
    "\n  /vis/scene/list to see scenes."
         << G4endl;
    }
    return;
  }
 
  // Store current context...
  G4VSceneHandler* pCurrentSceneHandler =
    fpVisManager -> GetCurrentSceneHandler();
  if (!pCurrentSceneHandler) {
    if (verbosity >= G4VisManager::warnings) {
      G4warn << "WARNING: No current scene handler."
         << G4endl;
    }
    return;
  }
  G4VViewer* pCurrentViewer = fpVisManager -> GetCurrentViewer();
  if (!pCurrentViewer) {
    if (verbosity >= G4VisManager::warnings) {
      G4warn << "WARNING: No current viewer."
         << G4endl;
    }
    return;
  }
  G4Scene* pCurrentScene = fpVisManager -> GetCurrentScene();
  if (!pCurrentScene) {
    if (verbosity >= G4VisManager::warnings) {
      G4warn << "WARNING: No current scene."
         << G4endl;
    }
    return;
  }
 
  G4VisManager::Verbosity currentVerbosity = fpVisManager -> GetVerbosity();
 
  // Suppress messages during this process (only print errors)...
  //fpVisManager -> SetVerboseLevel(G4VisManager::errors);
 
  // For each scene handler, if it contains the scene, clear and
  // rebuild the graphical database, then for each viewer set (make
  // current), clear, (re)draw, and show.
  const std::size_t nSceneHandlers = sceneHandlerList.size ();
  for (std::size_t iSH = 0; iSH < nSceneHandlers; ++iSH) {
    G4VSceneHandler* aSceneHandler = sceneHandlerList [iSH];
    G4Scene* aScene = aSceneHandler -> GetScene ();
    if (aScene) {
      const G4String& aSceneName = aScene -> GetName ();
      if (sceneName == aSceneName) {
    aScene->CalculateExtent();  // Check and recalculate extent
    G4ViewerList& viewerList = aSceneHandler -> SetViewerList ();
    const std::size_t nViewers = viewerList.size ();
    for (std::size_t iV = 0; iV < nViewers; ++iV) {
      G4VViewer* aViewer = viewerList [iV];
      // Force rebuild of graphical database, if any.
      aViewer -> NeedKernelVisit();
      if (aViewer->GetViewParameters().IsAutoRefresh()) {
        aSceneHandler -> SetCurrentViewer (aViewer);
        // Ensure consistency of vis manager...
        fpVisManager -> SetCurrentViewer(aViewer);
        fpVisManager -> SetCurrentSceneHandler(aSceneHandler);
        fpVisManager -> SetCurrentScene(aScene);
        aViewer -> SetView ();
        aViewer -> ClearView ();
        aViewer -> DrawView ();
        if (flush) aViewer -> ShowView ();
        if (verbosity >= G4VisManager::confirmations) {
          G4cout << "Viewer \"" << aViewer -> GetName ()
             << "\" of scene handler \"" << aSceneHandler -> GetName ()
             << "\"\n  ";
          if (flush) G4cout << "flushed";
          else G4cout << "refreshed";
          G4cout << " at request of scene \"" << sceneName
             << "\"." << G4endl;
        }
      } else {
        if (verbosity >= G4VisManager::confirmations) {
          G4cout << "NOTE: The scene, \""
             << sceneName
             << "\", of viewer \""
             << aViewer -> GetName ()
             << "\"\n  of scene handler \""
             << aSceneHandler -> GetName ()
             << "\"  has changed.  To see effect,"
             << "\n  \"/vis/viewer/select "
             << aViewer -> GetShortName ()
             << "\" and \"/vis/viewer/rebuild\"."
             << G4endl;
        }
      }
    }
      }
    }
    else {
      if (verbosity >= G4VisManager::warnings) {
    G4warn << "WARNING: G4VisCommandSceneNotifyHandlers: scene handler \""
           << aSceneHandler->GetName()
           << "\" has a null scene."
           << G4endl;
      }
    }
  }
 
  // Reclaim original context - but set viewer first, then scene
  // handler, because the latter might have been created very recently
  // and, not yet having a viewer, the current viewer will,
  // temporarily, refer to another scene handler.  SetCurrentViewer
  // actually resets the scene handler, which is what we don't want,
  // so we set it again on the next line...
  fpVisManager -> SetCurrentViewer(pCurrentViewer);
  fpVisManager -> SetCurrentSceneHandler(pCurrentSceneHandler);
  fpVisManager -> SetCurrentScene(pCurrentScene);
  fpVisManager -> SetVerboseLevel(currentVerbosity);
  // Take care of special case of scene handler with no viewer yet.  
  if (pCurrentSceneHandler) {
    G4ViewerList& viewerList = pCurrentSceneHandler -> SetViewerList ();
    const std::size_t nViewers = viewerList.size ();
    if (nViewers) {
      pCurrentSceneHandler -> SetCurrentViewer (pCurrentViewer);
      // JA: I don't think we need this. SetView will be called when needed.
      // if (pCurrentViewer && pCurrentSceneHandler->GetScene()) {
      //   pCurrentViewer -> SetView ();
      // }
    }
  }
}

---

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

• G4VisCommandsScene.hh
• G4VisCommandsScene.cc