G4VisCommandSceneAddElectricField Class Reference

#include <G4VisCommandsSceneAdd.hh>

Inheritance diagram for G4VisCommandSceneAddElectricField:

Public Member Functions
	G4VisCommandSceneAddElectricField ()
virtual	~G4VisCommandSceneAddElectricField ()
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 175 of file G4VisCommandsSceneAdd.hh.

Constructor & Destructor Documentation

G4VisCommandSceneAddElectricField()

G4VisCommandSceneAddElectricField::G4VisCommandSceneAddElectricField

(

)

Definition at line 533 of file G4VisCommandsSceneAdd.cc.

                                                                      {
  G4bool omitable;
  fpCommand = new G4UIcommand ("/vis/scene/add/electricField", this);
  fpCommand -> SetGuidance
  ("Adds electric field representation to current scene.");
  fpCommand -> SetGuidance
  ("The first parameter is no. of data points per half extent.  So, possibly, at"
   "\nmaximum, the number of data points sampled is (2*n+1)^3, which can grow"
   "\nlarge--be warned!"
   "\nThe default value is 10, i.e., a 21x21x21 array, i.e., 9,261 sampling points."
   "\nThat may swamp your view, but usually, a field is limited to a small part of"
   "\nthe extent, so it's not a problem. But if it is, here are some of the things"
   "\nyou can do:"
   "\n- reduce the number of data points per half extent (first parameter);"
   "\n- specify \"lightArrow\" (second parameter);"
   "\n- restrict the region sampled with \"/vis/set/extentForField\";"
   "\n- restrict the drawing to a specific volume with"
   "\n    \"/vis/set/volumeForField\" or \"/vis/touchable/volumeForField\"."
   "\nNote: you might have to deactivate existing field models with"
   "\n  \"/vis/scene/activateModel Field false\" and re-issue"
   "\n  \"/vis/scene/add/...Field\" command again.");
  fpCommand -> SetGuidance
  ("In the arrow representation, the length of the arrow is proportional"
   "\nto the magnitude of the field and the colour is mapped onto the range"
   "\nas a fraction of the maximum magnitude: 0->0.5->1 is red->green->blue.");
  G4UIparameter* parameter;
  parameter = new G4UIparameter ("nDataPointsPerHalfExtent", 'i', omitable = true);
  parameter -> SetDefaultValue (10);
  fpCommand -> SetParameter (parameter);
  parameter = new G4UIparameter ("representation", 's', omitable = true);
  parameter -> SetParameterCandidates("fullArrow lightArrow");
  parameter -> SetDefaultValue ("fullArrow");
  fpCommand -> SetParameter (parameter);
}

~G4VisCommandSceneAddElectricField()

G4VisCommandSceneAddElectricField::~G4VisCommandSceneAddElectricField ( )

virtual

Definition at line 568 of file G4VisCommandsSceneAdd.cc.

                                                                       {
  delete fpCommand;
}

Member Function Documentation

GetCurrentValue()

G4String G4VisCommandSceneAddElectricField::GetCurrentValue ( G4UIcommand *  command )

virtual

Reimplemented from G4UImessenger.

Definition at line 572 of file G4VisCommandsSceneAdd.cc.

                                                                         {
  return "";
}

SetNewValue()

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

virtual

Reimplemented from G4UImessenger.

Definition at line 576 of file G4VisCommandsSceneAdd.cc.

                                  {
 
  G4VisManager::Verbosity verbosity = fpVisManager->GetVerbosity();
  G4bool warn(verbosity >= G4VisManager::warnings);
 
  G4Scene* pScene = fpVisManager->GetCurrentScene();
  if (!pScene) {
    if (verbosity >= G4VisManager::errors) {
      G4warn <<  "ERROR: No current scene.  Please create one." << G4endl;
    }
    return;
  }
 
  G4int nDataPointsPerHalfExtent;
  G4String representation;
  std::istringstream iss(newValue);
  iss >> nDataPointsPerHalfExtent >> representation;
  G4ElectricFieldModel::Representation
  modelRepresentation = G4ElectricFieldModel::fullArrow;
  if (representation == "lightArrow") {
    modelRepresentation = G4ElectricFieldModel::lightArrow;
  }
  G4VModel* model;
  model = new G4ElectricFieldModel
  (nDataPointsPerHalfExtent,modelRepresentation,
   fCurrentArrow3DLineSegmentsPerCircle,
   fCurrentExtentForField,
   fCurrrentPVFindingsForField);
  const G4String& currentSceneName = pScene -> GetName ();
  G4bool successful = pScene -> AddRunDurationModel (model, warn);
  if (successful) {
    if (verbosity >= G4VisManager::confirmations) {
      G4cout
      << "Electric field, if any, will be drawn in scene \""
      << currentSceneName
      << "\"\n  with "
      << nDataPointsPerHalfExtent
      << " data points per half extent and with representation \""
      << representation
      << '\"'
      << G4endl;
    }
  }
  else G4VisCommandsSceneAddUnsuccessful(verbosity);
 
  CheckSceneAndNotifyHandlers (pScene);
}

---

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

• G4VisCommandsSceneAdd.hh
• G4VisCommandsSceneAdd.cc