G4VisCommandSceneAddMagneticField Class Reference

#include <G4VisCommandsSceneAdd.hh>

Inheritance diagram for G4VisCommandSceneAddMagneticField:

Public Member Functions
	G4VisCommandSceneAddMagneticField ()
virtual	~G4VisCommandSceneAddMagneticField ()
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 ()
	G4UImessenger (const G4String &path, const G4String &dsc, G4bool commandsToBeBroadcasted=true)
virtual	~G4UImessenger ()
G4bool	operator== (const G4UImessenger &messenger) const

Additional Inherited Members
Static Public Member Functions inherited from G4VVisCommand
static void	SetVisManager (G4VisManager *)
Protected Member Functions inherited from G4VVisCommandScene
G4String	CurrentSceneName ()
Protected Member Functions inherited from G4VVisCommand
void	UpdateVisManagerScene (const G4String &sceneName="")
Protected Member Functions inherited from G4UImessenger
G4String	ItoS (G4int i)
G4String	DtoS (G4double a)
G4String	BtoS (G4bool b)
G4int	StoI (G4String s)
G4double	StoD (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 void	ConvertToDoublePair (const G4String &paramString, G4double &xval, G4double &yval)
Protected Attributes inherited from G4UImessenger
G4UIdirectory *	baseDir
G4String	baseDirName
Static Protected Attributes inherited from G4VVisCommand
static G4VisManager *	fpVisManager = 0
static G4Colour	fCurrentColour = G4Colour::White()
static G4Colour	fCurrentTextColour = G4Colour::Blue()
static G4Text::Layout	fCurrentTextLayout = G4Text::left
static G4double	fCurrentLineWidth = 1.
static G4ModelingParameters::PVNameCopyNoPath	fCurrentTouchablePath

Detailed Description

Definition at line 300 of file G4VisCommandsSceneAdd.hh.

Constructor & Destructor Documentation

G4VisCommandSceneAddMagneticField::G4VisCommandSceneAddMagneticField

(

)

Definition at line 1529 of file G4VisCommandsSceneAdd.cc.

References G4UIcmdWithAnInteger::SetDefaultValue(), and G4UIcmdWithAnInteger::SetParameterName().

                                                                      {
  G4bool ommitable;
  fpCommand = new G4UIcmdWithAnInteger ("/vis/scene/add/magneticField", this);
  fpCommand->SetParameterName("nDataPointsPerHalfScene",ommitable=true);
  fpCommand->SetDefaultValue(10);
  fpCommand -> SetGuidance
  ("Adds magnetic field representation to current scene.");
  fpCommand -> SetGuidance
  ("The parameter is no. of data points per half scene.  So, possibly, at"
   "\nmaximum, the number of data points sampled is (2*n+1)^3, which can grow"
   "\nlarge--be warned!"
   "\nYou might find that your scene is cluttered by thousands of arrows for"
   "\nthe default number of data points, so try reducing to 2 or 3, e.g:"
   "\n  /vis/scene/add/magneticField 3"
   "\nor, if only a small part of the scene has a field:"
   "\n  /vis/scene/add/magneticField 50 # or more");
  fpCommand -> SetGuidance
  ("In the arrow representation, the length of the arrow is proporational"
   "\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 blue->green->red.");
}

G4VisCommandSceneAddMagneticField::~G4VisCommandSceneAddMagneticField ( )

virtual

Definition at line 1551 of file G4VisCommandsSceneAdd.cc.

                                                                       {
  delete fpCommand;
}

Member Function Documentation

G4String G4VisCommandSceneAddMagneticField::GetCurrentValue ( G4UIcommand *  command )

virtual

Reimplemented from G4UImessenger.

Definition at line 1555 of file G4VisCommandsSceneAdd.cc.

                                                                         {
  return "";
}

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

virtual

Reimplemented from G4UImessenger.

Definition at line 1560 of file G4VisCommandsSceneAdd.cc.

References G4VisManager::confirmations, G4VisManager::errors, G4cout, G4endl, and G4VisManager::warnings.

                                  {

  G4VisManager::Verbosity verbosity = fpVisManager->GetVerbosity();
  G4bool warn(verbosity >= G4VisManager::warnings);

  G4Scene* pScene = fpVisManager->GetCurrentScene();
  if (!pScene) {
    if (verbosity >= G4VisManager::errors) {
      G4cout << "ERROR: No current scene.  Please create one." << G4endl;
    }
    return;
  }

  G4int nDataPointsPerHalfScene = fpCommand->GetNewIntValue(newValue);
  
  G4MagneticFieldModel* model =
  new G4MagneticFieldModel(nDataPointsPerHalfScene);
  const G4String& currentSceneName = pScene -> GetName ();
  G4bool successful = pScene -> AddRunDurationModel (model, warn);
  if (successful) {
    if (verbosity >= G4VisManager::confirmations) {
      G4cout << "Magnetic field, if any, will be drawn in scene \""
      << currentSceneName
      << "\"\n  with "
      << nDataPointsPerHalfScene << " data points per half scene."
      << G4endl;
    }
  }
  else G4VisCommandsSceneAddUnsuccessful(verbosity);
  UpdateVisManagerScene (currentSceneName);
}

---

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

• G4VisCommandsSceneAdd.hh
• G4VisCommandsSceneAdd.cc