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