| Geant4 Cross Reference |
1 // 1 //
2 // ******************************************* 2 // ********************************************************************
3 // * License and Disclaimer 3 // * License and Disclaimer *
4 // * 4 // * *
5 // * The Geant4 software is copyright of th 5 // * The Geant4 software is copyright of the Copyright Holders of *
6 // * the Geant4 Collaboration. It is provided 6 // * the Geant4 Collaboration. It is provided under the terms and *
7 // * conditions of the Geant4 Software License 7 // * conditions of the Geant4 Software License, included in the file *
8 // * LICENSE and available at http://cern.ch/ 8 // * LICENSE and available at http://cern.ch/geant4/license . These *
9 // * include a list of copyright holders. 9 // * include a list of copyright holders. *
10 // * 10 // * *
11 // * Neither the authors of this software syst 11 // * Neither the authors of this software system, nor their employing *
12 // * institutes,nor the agencies providing fin 12 // * institutes,nor the agencies providing financial support for this *
13 // * work make any representation or warran 13 // * work make any representation or warranty, express or implied, *
14 // * regarding this software system or assum 14 // * regarding this software system or assume any liability for its *
15 // * use. Please see the license in the file 15 // * use. Please see the license in the file LICENSE and URL above *
16 // * for the full disclaimer and the limitatio 16 // * for the full disclaimer and the limitation of liability. *
17 // * 17 // * *
18 // * This code implementation is the result 18 // * This code implementation is the result of the scientific and *
19 // * technical work of the GEANT4 collaboratio 19 // * technical work of the GEANT4 collaboration. *
20 // * By using, copying, modifying or distri 20 // * By using, copying, modifying or distributing the software (or *
21 // * any work based on the software) you ag 21 // * any work based on the software) you agree to acknowledge its *
22 // * use in resulting scientific publicati 22 // * use in resulting scientific publications, and indicate your *
23 // * acceptance of all terms of the Geant4 Sof 23 // * acceptance of all terms of the Geant4 Software license. *
24 // ******************************************* 24 // ********************************************************************
25 // 25 //
26 // 26 //
>> 27 // $Id: G4VisExecutive.hh,v 1.10 2010-05-28 16:48:03 allison Exp $
>> 28 // GEANT4 tag $Name: not supported by cvs2svn $
27 // 29 //
28 // 30 //
29 // John Allison 2nd February 2005 (based on My 31 // John Allison 2nd February 2005 (based on MyVisManager, 24th January 1998).
30 // 32 //
31 // Class description 33 // Class description
32 // 34 //
33 // Concrete Visualization Manager that impleme 35 // Concrete Visualization Manager that implements the virtual
34 // functions RegisterGraphicsSystems and Regis 36 // functions RegisterGraphicsSystems and RegisterModelFactories. This
35 // is executed when you Initialise() or Initia 37 // is executed when you Initialise() or Initialize() the vis manager.
36 // It exploits C-pre-processor variables G4VIS 38 // It exploits C-pre-processor variables G4VIS_USE_DAWN, etc., which
37 // are set by the GNUmakefiles if environment 39 // are set by the GNUmakefiles if environment variables of the same
38 // name are set. 40 // name are set.
39 // 41 //
40 // Include this file and write code to instant 42 // Include this file and write code to instantiate G4VisExecutive just
41 // once at beginning of operations. Before yo 43 // once at beginning of operations. Before you compile, set
42 // appropriate environment variables (usually 44 // appropriate environment variables (usually using "./Configure").
43 // If you change your environment you must for 45 // If you change your environment you must force recompilation (the
44 // make files will not detect the need to do t 46 // make files will not detect the need to do this).
45 // 47 //
46 // Typically, your main program file will cont 48 // Typically, your main program file will contain:
47 // 49 //
48 // #ifdef G4VIS_USE 50 // #ifdef G4VIS_USE
49 // #include "G4VisExecutive.hh" 51 // #include "G4VisExecutive.hh"
50 // #endif 52 // #endif
51 // ... 53 // ...
52 // int main() { 54 // int main() {
53 // ... 55 // ...
54 // #ifdef G4VIS_USE 56 // #ifdef G4VIS_USE
55 // // Instantiate and initialise Visualizati 57 // // Instantiate and initialise Visualization Manager.
56 // G4VisManager* visManager = new G4VisExecu 58 // G4VisManager* visManager = new G4VisExecutive; // See Note (a).
57 // visManager -> SetVerboseLevel (verbosityS 59 // visManager -> SetVerboseLevel (verbosityString); // See Note (b).
58 // visManager -> RegisterGraphicsSystem (new 60 // visManager -> RegisterGraphicsSystem (new myGS); // See Note (c).
59 // visManager -> Initialize (); 61 // visManager -> Initialize (); // See Note (d).
60 // #endif 62 // #endif
61 // ... 63 // ...
62 // #ifdef G4VIS_USE 64 // #ifdef G4VIS_USE
63 // G4cout << "Deleting vis manager..." << G4 65 // G4cout << "Deleting vis manager..." << G4endl;
64 // delete visManager; 66 // delete visManager;
65 // G4cout << "Vis manager deleted." << G4end 67 // G4cout << "Vis manager deleted." << G4endl;
66 // #endif 68 // #endif
67 // 69 //
68 // Notes: 70 // Notes:
69 // (a) After instantiation, all references to 71 // (a) After instantiation, all references to this object should be as
70 // a G4VisManager. The functions Register 72 // a G4VisManager. The functions RegisterGraphicsSystems and
71 // RegisterModelFactories defined in G4Vis 73 // RegisterModelFactories defined in G4VisExecutive.icc are
72 // virtual functions of G4VisManager. The 74 // virtual functions of G4VisManager. They are invoked by
73 // G4VisManager::Initialise. If you need 75 // G4VisManager::Initialise. If you need to initialise in a
74 // separate file, see advice below. 76 // separate file, see advice below.
75 // (b) The verbosityString ("quiet", "errors", 77 // (b) The verbosityString ("quiet", "errors", "warnings",
76 // "confirmations", etc. - "help /vis/verb 78 // "confirmations", etc. - "help /vis/verbose" to see options) can be
77 // set here or with /vis/verbose. Alterna 79 // set here or with /vis/verbose. Alternatively, you can instantiate
78 // with a verbosity string. e.g: 80 // with a verbosity string. e.g:
79 // G4VisManager* visManager = new G4VisE 81 // G4VisManager* visManager = new G4VisExecutive("quiet");
80 // (c) You can register your own graphics syst 82 // (c) You can register your own graphics system like this.
81 // (d) Your can intialise like this with C++ c 83 // (d) Your can intialise like this with C++ code or use /vis/initialize.
82 // 84 //
83 // If you need to perform the instantiation an 85 // If you need to perform the instantiation and the initialisation in
84 // separate files, e.g., to establish the verb 86 // separate files, e.g., to establish the verbosity before
85 // initialisation, then the code that initiali 87 // initialisation, then the code that initialises must have access, of
86 // course, to the G4VisExecutive object, but t 88 // course, to the G4VisExecutive object, but this should be as a
87 // G4VisManager object, i.e., #include "G4VisM 89 // G4VisManager object, i.e., #include "G4VisManager.hh".
88 // RegisterGraphicsSystems and RegisterModelFa 90 // RegisterGraphicsSystems and RegisterModelFactories are (pure)
89 // virtual methods of G4VisManager called from 91 // virtual methods of G4VisManager called from G4VisManager::Initialize.
90 // First file: 92 // First file:
91 // #include "G4VisExecutive.hh" 93 // #include "G4VisExecutive.hh"
92 // ... 94 // ...
93 // fpVisManager = new G4VisExecutive; 95 // fpVisManager = new G4VisExecutive;
94 // where fpVisManager is a G4VisManager*. 96 // where fpVisManager is a G4VisManager*.
95 // Second file: 97 // Second file:
96 // #include "G4VisManager.hh" 98 // #include "G4VisManager.hh"
97 // ... 99 // ...
98 // fpVisManager -> Initialize (); 100 // fpVisManager -> Initialize ();
99 // where there is some mechanism for getting a 101 // where there is some mechanism for getting access to the pointer
100 // fpVisManager. 102 // fpVisManager.
101 // 103 //
102 // The implementation is included as an .icc f 104 // The implementation is included as an .icc file because - for those
103 // graphics systems that need external librari 105 // graphics systems that need external libraries - only those systems
104 // that have been selected by the flags may be 106 // that have been selected by the flags may be instantiated without
105 // causing unresolved references (only the use 107 // causing unresolved references (only the user knows which libraries
106 // are available on his/her computer). It als 108 // are available on his/her computer). It also ensures that libraries
107 // can be linked in the right order, without c 109 // can be linked in the right order, without circular dependencies.
108 // (Note that some graphics systems, notable t 110 // (Note that some graphics systems, notable those that write files
109 // for off-line viewing, do not suffer these r 111 // for off-line viewing, do not suffer these restrictions and are
110 // always registered.) 112 // always registered.)
111 // 113 //
112 // See class description of G4VisManager for m 114 // See class description of G4VisManager for more details.
113 115
114 #ifndef G4VISEXECUTIVE_HH 116 #ifndef G4VISEXECUTIVE_HH
115 #define G4VISEXECUTIVE_HH 117 #define G4VISEXECUTIVE_HH
116 118
117 #include "G4VisManager.hh" 119 #include "G4VisManager.hh"
118 120
119 class G4VisExecutive: public G4VisManager { 121 class G4VisExecutive: public G4VisManager {
120 122
121 public: // With description 123 public: // With description
122 124
123 G4VisExecutive(const G4String& verbosityStri << 125 G4VisExecutive (const G4String& verbosityString = "warnings");
124 G4VisExecutive(int argc, char** argv, const <<
125 const G4String& verbosityStri <<
126 126
127 private: 127 private:
128 128
129 const G4String& GetDefaultGraphicsSystemName << 129 void RegisterGraphicsSystems();
130 void SetDefaultsByArgument(const G4String& s << 130 void RegisterModelFactories();
131 void SetDefaultsByEnvironment(); <<
132 void SetDefaultsByFile(int argc, char** argv <<
133 void SetDefaultsByBatch(); <<
134 void SetDefaultsByBuildFlags(); <<
135 int fUserArgc; <<
136 char** fUserArgv; <<
137 G4String fUserSpecifiedSystem; <<
138 G4bool fSelected; <<
139 <<
140 void RegisterGraphicsSystems() override; <<
141 void RegisterModelFactories() override; <<
142 131
143 }; 132 };
144 133
145 #include "G4VisExecutive.icc" 134 #include "G4VisExecutive.icc"
146 135
147 #endif 136 #endif
148 137