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