G4RTMessenger Class Reference

#include <G4RTMessenger.hh>

Inheritance diagram for G4RTMessenger:

Collaboration diagram for G4RTMessenger:

Public Member Functions
virtual	~G4RTMessenger ()
virtual G4String	GetCurrentValue (G4UIcommand *command)
virtual void	SetNewValue (G4UIcommand *command, G4String newValue)
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
G4bool	CommandsShouldBeInMaster () const

Static Public Member Functions
static G4RTMessenger *	GetInstance (G4TheRayTracer *p1)

Private Member Functions
	G4RTMessenger (G4TheRayTracer *p1)

Private Attributes
G4TheRayTracer *	theDefaultTracer
G4TheRayTracer *	theTracer
G4UIdirectory *	rayDirectory
G4UIcmdWithAnInteger *	columnCmd
G4UIcmdWithAnInteger *	rowCmd
G4UIcmdWith3VectorAndUnit *	targetCmd
G4UIcmdWith3VectorAndUnit *	eyePosCmd
G4UIcmdWith3Vector *	lightCmd
G4UIcmdWithADoubleAndUnit *	spanXCmd
G4UIcmdWithADoubleAndUnit *	headCmd
G4UIcmdWithADoubleAndUnit *	attCmd
G4UIcmdWithABool *	distCmd
G4UIcmdWithABool *	transCmd
G4UIcmdWithAString *	fileCmd
G4UIcmdWith3Vector *	bkgColCmd

Static Private Attributes
static G4RTMessenger *	fpInstance = 0

Additional Inherited Members
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)
Protected Attributes inherited from G4UImessenger
G4UIdirectory *	baseDir
G4String	baseDirName
G4bool	commandsShouldBeInMaster

Detailed Description

Definition at line 51 of file G4RTMessenger.hh.

Constructor & Destructor Documentation

~G4RTMessenger()

G4RTMessenger::~G4RTMessenger ( )

virtual

Definition at line 140 of file G4RTMessenger.cc.

{
  delete columnCmd;
  delete rowCmd;
  delete targetCmd;
  delete eyePosCmd;
  delete lightCmd;
  delete spanXCmd;
  delete headCmd;
  delete attCmd;
  delete distCmd;
  delete transCmd;
  delete fileCmd;
  delete bkgColCmd;
  delete rayDirectory;
}

G4RTMessenger()

G4RTMessenger::G4RTMessenger ( G4TheRayTracer *  p1 )

private

Definition at line 57 of file G4RTMessenger.cc.

{
  theDefaultTracer = p1;
  theTracer = theDefaultTracer;

  rayDirectory = new G4UIdirectory("/vis/rayTracer/");
  rayDirectory->SetGuidance("RayTracer commands.");

  fileCmd = new G4UIcmdWithAString("/vis/rayTracer/trace",this);
  fileCmd->SetGuidance("Start the ray tracing.");
  fileCmd->SetGuidance("Define the name of output JPEG file.");
  fileCmd->SetParameterName("fileName",true);
  fileCmd->SetDefaultValue("g4RayTracer.jpeg");
  fileCmd->AvailableForStates(G4State_Idle);

  columnCmd = new G4UIcmdWithAnInteger("/vis/rayTracer/column",this);
  columnCmd->SetGuidance("Define the number of horizontal pixels.");
  columnCmd->SetParameterName("nPixel",false);
  columnCmd->SetRange("nPixel > 0");

  rowCmd = new G4UIcmdWithAnInteger("/vis/rayTracer/row",this);
  rowCmd->SetGuidance("Define the number of virtical pixels.");
  rowCmd->SetParameterName("nPixel",false);
  rowCmd->SetRange("nPixel > 0");

  targetCmd = new G4UIcmdWith3VectorAndUnit("/vis/rayTracer/target",this);
  targetCmd->SetGuidance("Define the center position of the target.");
  targetCmd->SetParameterName("X","Y","Z",true);
  targetCmd->SetDefaultValue(G4ThreeVector(0.,0.,0.));
  targetCmd->SetDefaultUnit("m");

  eyePosCmd = new G4UIcmdWith3VectorAndUnit("/vis/rayTracer/eyePosition",this);
  eyePosCmd->SetGuidance("Define the eye position.");
  eyePosCmd->SetGuidance("Eye direction is calsurated from (target - eyePosition).");
  eyePosCmd->SetParameterName("X","Y","Z",true);
  eyePosCmd->SetDefaultValue(G4ThreeVector(0.,0.,0.));
  eyePosCmd->SetDefaultUnit("m");

  lightCmd = new G4UIcmdWith3Vector("/vis/rayTracer/lightDirection",this);
  lightCmd->SetGuidance("Define the direction of illumination light.");
  lightCmd->SetGuidance("The vector needs not to be a unit vector, but it must not be a zero vector.");
  lightCmd->SetParameterName("Px","Py","Pz",true);
  lightCmd->SetDefaultValue(G4ThreeVector(0.1,0.2,0.3));
  lightCmd->SetRange("Px != 0 || Py != 0 || Pz != 0");

  spanXCmd = new G4UIcmdWithADoubleAndUnit("/vis/rayTracer/span",this);
  spanXCmd->SetGuidance("Define the angle per 100 pixels.");
  spanXCmd->SetParameterName("span",true);
  spanXCmd->SetDefaultValue(50.);
  spanXCmd->SetDefaultUnit("deg");
  spanXCmd->SetRange("span>0.");

  headCmd = new G4UIcmdWithADoubleAndUnit("/vis/rayTracer/headAngle",this);
  headCmd->SetGuidance("Define the head direction.");
  headCmd->SetParameterName("headAngle",true);
  headCmd->SetDefaultValue(270.);
  headCmd->SetDefaultUnit("deg");
  headCmd->SetRange("headAngle>=0. && headAngle<360.");

  attCmd = new G4UIcmdWithADoubleAndUnit("/vis/rayTracer/attenuation",this);
  attCmd->SetGuidance("Define the attenuation length for transparent material.");
  attCmd->SetGuidance("Note that this value is independent to the attenuation length for the optical photon processes.");
  attCmd->SetParameterName("Length",true);
  attCmd->SetDefaultValue(1.0);
  attCmd->SetDefaultUnit("m");
  attCmd->SetRange("Length > 0.");

  distCmd = new G4UIcmdWithABool("/vis/rayTracer/distortion",this);
  distCmd->SetGuidance("Distortion effect of the fish eye lens.");
  distCmd->SetParameterName("flag",true);
  distCmd->SetDefaultValue(false);

  transCmd = new G4UIcmdWithABool("/vis/rayTracer/ignoreTransparency",this);
  transCmd->SetGuidance("Ignore transparency even if the alpha of G4Colour < 1.");
  transCmd->SetParameterName("flag",true);
  transCmd->SetDefaultValue(false);

  bkgColCmd = new G4UIcmdWith3Vector("/vis/rayTracer/backgroundColour",this);
  bkgColCmd->SetGuidance("Command has been deprecated.  Use /vis/viewer/set/background instead.");
  bkgColCmd->SetParameterName("red","green","blue",true);
  bkgColCmd->SetDefaultValue(G4ThreeVector(1.,1.,1.));
}

Here is the call graph for this function:

Member Function Documentation

GetCurrentValue()

G4String G4RTMessenger::GetCurrentValue ( G4UIcommand *  command )

virtual

Reimplemented from G4UImessenger.

Definition at line 157 of file G4RTMessenger.cc.

{
  G4String currentValue;
  if(command==columnCmd)
  { currentValue = columnCmd->ConvertToString(theTracer->GetNColumn()); }
  else if(command==rowCmd)
  { currentValue = rowCmd->ConvertToString(theTracer->GetNRow()); }
  else if(command==targetCmd)
  { currentValue = targetCmd->ConvertToString(theTracer->GetTargetPosition(),"m"); }
  else if(command==eyePosCmd)
  { currentValue = eyePosCmd->ConvertToString(theTracer->GetEyePosition(),"m"); }
  else if(command==lightCmd)
  { currentValue = lightCmd->ConvertToString(theTracer->GetLightDirection()); }
  else if(command==spanXCmd)
  { currentValue = spanXCmd->ConvertToString(theTracer->GetViewSpan(),"deg"); }
  else if(command==headCmd)
  { currentValue = headCmd->ConvertToString(theTracer->GetHeadAngle(),"deg"); }
  else if(command==attCmd)
  { currentValue = attCmd->ConvertToString(theTracer->GetAttenuationLength(),"m");}
  else if(command==distCmd)
  { currentValue = distCmd->ConvertToString(theTracer->GetDistortion()); }
  else if(command==transCmd)
  { currentValue = transCmd->ConvertToString(G4RTSteppingAction::GetIgnoreTransparency()); }
  else if(command==bkgColCmd)
  { currentValue = bkgColCmd->ConvertToString(theTracer->GetBackgroundColour()); }
  return currentValue;
}

Here is the call graph for this function:

GetInstance()

G4RTMessenger * G4RTMessenger::GetInstance ( G4TheRayTracer *  p1 )

static

Definition at line 51 of file G4RTMessenger.cc.

{
  if (!fpInstance) fpInstance = new G4RTMessenger(p1);
  return fpInstance;
}

Here is the caller graph for this function:

SetNewValue()

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

virtual

Reimplemented from G4UImessenger.

Definition at line 185 of file G4RTMessenger.cc.

{
  G4VisManager* pVisManager = G4VisManager::GetInstance();

  theTracer = theDefaultTracer;

  G4VViewer* pVViewer = pVisManager->GetCurrentViewer();
  if (pVViewer) {
    G4RayTracerViewer* pViewer = dynamic_cast<G4RayTracerViewer*>(pVViewer);
    if (pViewer) {
      theTracer = pViewer->GetTracer();
    } else {
      G4cout <<
    "G4RTMessenger::SetNewValue: Current viewer is not of type RayTracer."
    "\n  Use \"/vis/viewer/select\" or \"/vis/open\"."
         << G4endl;
    }
  }

  if (theTracer == theDefaultTracer) {
    G4cout <<
"G4RTMessenger::SetNewValue: No valid current viewer. Using default RayTracer."
       << G4endl;
  }

  if(command==columnCmd)
  { theTracer->SetNColumn(columnCmd->GetNewIntValue(newValue)); }
  else if(command==rowCmd)
  { theTracer->SetNRow(rowCmd->GetNewIntValue(newValue)); }
  else if(command==targetCmd)
  { theTracer->SetTargetPosition(targetCmd->GetNew3VectorValue(newValue)); }
  else if(command==eyePosCmd)
  { theTracer->SetEyePosition(eyePosCmd->GetNew3VectorValue(newValue)); }
  else if(command==lightCmd)
  { theTracer->SetLightDirection(lightCmd->GetNew3VectorValue(newValue)); }
  else if(command==spanXCmd)
  { theTracer->SetViewSpan(spanXCmd->GetNewDoubleValue(newValue)); }
  else if(command==headCmd)
  { theTracer->SetHeadAngle(headCmd->GetNewDoubleValue(newValue)); }
  else if(command==attCmd)
  { theTracer->SetAttenuationLength(attCmd->GetNewDoubleValue(newValue)); }
  else if(command==distCmd)
  { theTracer->SetDistortion(distCmd->GetNewBoolValue(newValue)); }
  else if(command==bkgColCmd)
  {
    G4cout << "WARNING: /vis/rayTracer/backgroundColour has been deprecated."
    "\n  Use \"/vis/viewer/set/background\" instead."
        << G4endl;
  }
  else if(command==transCmd)
  { G4RTSteppingAction::SetIgnoreTransparency(transCmd->GetNewBoolValue(newValue)); }
  else if(command==fileCmd)
  { theTracer->Trace(newValue); }
}

Here is the call graph for this function:

Member Data Documentation

attCmd

G4UIcmdWithADoubleAndUnit* G4RTMessenger::attCmd

private

Definition at line 75 of file G4RTMessenger.hh.

bkgColCmd

G4UIcmdWith3Vector* G4RTMessenger::bkgColCmd

private

Definition at line 79 of file G4RTMessenger.hh.

columnCmd

G4UIcmdWithAnInteger* G4RTMessenger::columnCmd

private

Definition at line 68 of file G4RTMessenger.hh.

distCmd

G4UIcmdWithABool* G4RTMessenger::distCmd

private

Definition at line 76 of file G4RTMessenger.hh.

eyePosCmd

G4UIcmdWith3VectorAndUnit* G4RTMessenger::eyePosCmd

private

Definition at line 71 of file G4RTMessenger.hh.

fileCmd

G4UIcmdWithAString* G4RTMessenger::fileCmd

private

Definition at line 78 of file G4RTMessenger.hh.

fpInstance

G4RTMessenger * G4RTMessenger::fpInstance = 0

staticprivate

Definition at line 62 of file G4RTMessenger.hh.

headCmd

G4UIcmdWithADoubleAndUnit* G4RTMessenger::headCmd

private

Definition at line 74 of file G4RTMessenger.hh.

lightCmd

G4UIcmdWith3Vector* G4RTMessenger::lightCmd

private

Definition at line 72 of file G4RTMessenger.hh.

rayDirectory

G4UIdirectory* G4RTMessenger::rayDirectory

private

Definition at line 67 of file G4RTMessenger.hh.

rowCmd

G4UIcmdWithAnInteger* G4RTMessenger::rowCmd

private

Definition at line 69 of file G4RTMessenger.hh.

spanXCmd

G4UIcmdWithADoubleAndUnit* G4RTMessenger::spanXCmd

private

Definition at line 73 of file G4RTMessenger.hh.

targetCmd

G4UIcmdWith3VectorAndUnit* G4RTMessenger::targetCmd

private

Definition at line 70 of file G4RTMessenger.hh.

theDefaultTracer

G4TheRayTracer* G4RTMessenger::theDefaultTracer

private

Definition at line 63 of file G4RTMessenger.hh.

theTracer

G4TheRayTracer* G4RTMessenger::theTracer

private

Definition at line 65 of file G4RTMessenger.hh.

transCmd

G4UIcmdWithABool* G4RTMessenger::transCmd

private

Definition at line 77 of file G4RTMessenger.hh.

---

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

• G4RTMessenger.hh
• G4RTMessenger.cc