Geant4_10
G4TheMTRayTracer.hh
Go to the documentation of this file.
1 //
2 // ********************************************************************
3 // * License and Disclaimer *
4 // * *
5 // * The Geant4 software is copyright of the Copyright Holders of *
6 // * the Geant4 Collaboration. It is provided under the terms and *
7 // * conditions of the Geant4 Software License, included in the file *
8 // * LICENSE and available at http://cern.ch/geant4/license . These *
9 // * include a list of copyright holders. *
10 // * *
11 // * Neither the authors of this software system, nor their employing *
12 // * institutes,nor the agencies providing financial support for this *
13 // * work make any representation or warranty, express or implied, *
14 // * regarding this software system or assume any liability for its *
15 // * use. Please see the license in the file LICENSE and URL above *
16 // * for the full disclaimer and the limitation of liability. *
17 // * *
18 // * This code implementation is the result of the scientific and *
19 // * technical work of the GEANT4 collaboration. *
20 // * By using, copying, modifying or distributing the software (or *
21 // * any work based on the software) you agree to acknowledge its *
22 // * use in resulting scientific publications, and indicate your *
23 // * acceptance of all terms of the Geant4 Software license. *
24 // ********************************************************************
25 //
26 //
27 // $Id: G4TheMTRayTracer.hh 66264 2012-12-14 10:17:44Z allison $
28 //
29 //
30 
31 
32 #ifndef G4TheMTRayTracer_H
33 #define G4TheMTRayTracer_H 1
34 
35 // class description:
36 //
37 // G4TheMTRayTracer
38 // This is a graphics driver of Geant4 which generates a figure file by
39 // ray tracing technique. The format of output figure file can be selected
40 // by assigning a pointer of G4VFigureFileMaker concrete class object.
41 // The main entry of ray tracing is Trace() method, which is available
42 // only at Idle state. G4TheMTRayTracer shoots rays and controls its own event
43 // loop. It generates G4Event objects used for its own purpose. When ray
44 // tracing is working, all sensitive detectors are inactivated and all
45 // user action classes are swapped out. Still, verbosities set to Geant4
46 // manager classes are concerned. Thus, it is recommended to set verbosities
47 // to minimum (usually zero).
48 // G4TheMTRayTracer can visualise absolutely all kinds of geometrical shapes
49 // which G4Navigator can deal with. Instead, it can NOT visualise hits
50 // nor trajectories generated by usual simulation.
51 
52 #include "globals.hh"
53 #include "G4ThreeVector.hh"
54 #include "G4Colour.hh"
55 
56 class G4RTMessenger;
57 class G4RayShooter;
58 class G4VFigureFileMaker;
59 class G4VisAttributes;
60 class G4VRTScanner;
63 class G4UserRunAction;
64 class G4RTRunAction;
66 class G4RTRun;
67 class G4RayTracerViewer;
68 
69 #include "G4TheRayTracer.hh"
70 
72 {
74  friend class G4RTRun;
75  friend class G4RayTracerViewer;
76 
77  private:
78  static G4TheMTRayTracer* theInstance;
79 
80  public: // with description
82  G4VRTScanner* scanner = 0);
83  // Constructor. The argument is the pointer to G4VFigureFileMaker
84  // concrete class object. If it is not set and
85  // SetFigureFileMaker() method is not invoked before Trace()
86  // command is invoked, then G4RTJpegMaker will be used and JPEG
87  // file will be generated. The second argument is a scanner that
88  // produces a sequence of window coordinates. If it is not set
89  // here or if SetScanner is not invoked before Trace(), a default
90  // G4RTSimpleScanner will be used.
91 
92  public:
93  virtual ~G4TheMTRayTracer();
94 
95  public: // with description
96  virtual void Trace(const G4String& fileName);
97  // The main entry point which triggers ray tracing. "fileName" is output
98  // file name, and it must contain extention (e.g. myFigure.jpg). This
99  // method is available only if Geant4 is at Idle state.
100 
101  protected:
102  virtual G4bool CreateBitMap();
103  // Event loop
104 
105  protected:
106  virtual void StoreUserActions();
107  virtual void RestoreUserActions();
108 
109  protected:
114 
115 };
116 
117 #endif
virtual ~G4TheMTRayTracer()
G4TheMTRayTracer(G4VFigureFileMaker *figMaker=0, G4VRTScanner *scanner=0)
virtual void Trace(const G4String &fileName)
G4RTRunAction * theRTRunAction
bool G4bool
Definition: G4Types.hh:79
virtual void StoreUserActions()
const G4UserWorkerInitialization * theUserWorkerInitialization
const G4UserRunAction * theUserRunAction
G4RTWorkerInitialization * theRTWorkerInitialization
virtual G4bool CreateBitMap()
virtual void RestoreUserActions()