| 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: G4Text.hh 66376 2012-12-18 09:42:59Z gcosmo $
27 // 28 //
28 // 29 //
29 // John Allison 17/11/96. 30 // John Allison 17/11/96.
30 31
31 // Class Description: 32 // Class Description:
32 // Text, i.e., a character string, is used to 33 // Text, i.e., a character string, is used to visualize various kinds of
33 // description, particle name, energy, coordin 34 // description, particle name, energy, coordinate names etc. Text is
34 // described by the class G4Text. The followin 35 // described by the class G4Text. The following constructors are supported:
35 // 36 //
36 // //----- Constructors of G4Text 37 // //----- Constructors of G4Text
37 // G4Text (const G4String& text); 38 // G4Text (const G4String& text);
38 // G4Text (const G4String& text, const G4 39 // G4Text (const G4String& text, const G4Point3D& pos);
39 // 40 //
40 // where the argument text is the text (string 41 // where the argument text is the text (string) to be visualized, and pos
41 // is the 3D position at which the text is vis 42 // is the 3D position at which the text is visualized. Note that class
42 // G4Text inherits G4VMarker. Size of text is 43 // G4Text inherits G4VMarker. Size of text is recognized as "font size",
43 // i.e., height of the text. All the access fu 44 // i.e., height of the text. All the access functions defined for class
44 // G4VMarker are available. In addition, the f 45 // G4VMarker are available. In addition, the following access functions
45 // are available, too: 46 // are available, too:
46 // 47 //
47 // //----- Set functions of G4Text 48 // //----- Set functions of G4Text
48 // void G4Text::SetText ( const G4String& 49 // void G4Text::SetText ( const G4String& text ) ;
49 // void G4Text::SetOffset ( double dx, do 50 // void G4Text::SetOffset ( double dx, double dy ) ;
50 // 51 //
51 // //----- Get functions of G4Text 52 // //----- Get functions of G4Text
52 // G4String G4Text::GetText () const; 53 // G4String G4Text::GetText () const;
53 // G4double G4Text::GetXOffset () const; 54 // G4double G4Text::GetXOffset () const;
54 // G4double G4Text::GetYOffset () const; 55 // G4double G4Text::GetYOffset () const;
55 // 56 //
56 // Method SetText() defines text to be visuali 57 // Method SetText() defines text to be visualized, and GetText() returns
57 // the defined text. Method SetOffset() define 58 // the defined text. Method SetOffset() defines x (horizontal) and
58 // y (vertical) offsets in the screen coordina 59 // y (vertical) offsets in the screen coordinates. By default, both offsets
59 // are zero, and the text starts from the 3D p 60 // are zero, and the text starts from the 3D position given to the
60 // constructor or to the method G4VMarker:SetP 61 // constructor or to the method G4VMarker:SetPosition(). Offsets should be
61 // given with the same units as the one adopte 62 // given with the same units as the one adopted for the size, i.e.,
62 // world-size or screen-size units. 63 // world-size or screen-size units.
63 // Class Description - End: 64 // Class Description - End:
64 65
65 66
66 #ifndef G4TEXT_HH 67 #ifndef G4TEXT_HH
67 #define G4TEXT_HH 68 #define G4TEXT_HH
68 69
69 #include "G4VMarker.hh" 70 #include "G4VMarker.hh"
70 #include "globals.hh" 71 #include "globals.hh"
71 72
72 class G4Text: public G4VMarker { 73 class G4Text: public G4VMarker {
73 74
74 public: // With description 75 public: // With description
75 76
76 enum Layout {left, centre, right}; 77 enum Layout {left, centre, right};
77 G4Text (const G4String& text = "none"); << 78 G4Text (const G4String& text);
78 G4Text (const G4String& text, const G4Point3 79 G4Text (const G4String& text, const G4Point3D& position);
79 G4Text (const G4VMarker&); 80 G4Text (const G4VMarker&);
80 G4Text (const G4Text&) = default; << 81 G4Text (const G4Text&);
81 G4Text (G4Text&&) = default; << 82 virtual ~G4Text ();
82 ~G4Text () override; << 83 G4Text& operator= (const G4Text&);
83 G4Text& operator= (const G4Text&) = default; <<
84 G4Text& operator= (G4Text&&) = default; <<
85 84
86 G4String GetText () const; 85 G4String GetText () const;
87 Layout GetLayout () const; 86 Layout GetLayout () const;
88 87
89 G4double GetXOffset () const ; 88 G4double GetXOffset () const ;
90 G4double GetYOffset () const ; 89 G4double GetYOffset () const ;
91 90
92 void SetText (const G4String& text); 91 void SetText (const G4String& text);
93 void SetLayout (Layout); 92 void SetLayout (Layout);
94 93
95 void SetOffset (double dx, double dy) ; 94 void SetOffset (double dx, double dy) ;
96 95
97 private: 96 private:
98 G4String fText; 97 G4String fText;
99 Layout fLayout; 98 Layout fLayout;
100 G4double fXOffset, fYOffset; 99 G4double fXOffset, fYOffset;
101 }; 100 };
102 101
103 #include "G4Text.icc" 102 #include "G4Text.icc"
104 103
105 std::ostream& operator<< (std::ostream& os, co 104 std::ostream& operator<< (std::ostream& os, const G4Text&);
106 std::ostream& operator<< (std::ostream& os, G4 105 std::ostream& operator<< (std::ostream& os, G4Text::Layout);
107 106
108 #endif 107 #endif
109 108