Import Geant4 1.0.0 source tree

source/graphics_reps/include/G4Text.hh

@@ -1,16 +1,51 @@
 // This code implementation is the intellectual property of
-// the RD44 GEANT4 collaboration.
+// the GEANT4 collaboration.
 //
 // By copying, distributing or modifying the Program (or any work
 // based on the Program) you indicate your acceptance of this statement,
 // and all its terms.
 //
-// $Id: G4Text.hh,v 1.3 1999/05/25 09:10:12 johna Exp $
-// GEANT4 tag $Name: geant4-00-01 $
+// $Id: G4Text.hh,v 1.4.2.1 1999/12/07 20:48:50 gunter Exp $
+// GEANT4 tag $Name: geant4-01-00 $
 //
 // 
 // John Allison  17/11/96.
 
+// Class Description:
+// Text, i.e., a character string, is used to visualize various kinds of 
+// description, particle name, energy, coordinate names etc. Text is 
+// described by the class G4Text. The following constructors are supported: 
+// 
+//      //----- Constructors of G4Text
+//      G4Text (const G4String& text);
+//      G4Text (const G4String& text, const G4Point3D& pos);
+// 
+// where the argument text is the text (string) to be visualized, and pos 
+// is the 3D position at which the text is visualized.  Note that class 
+// G4Text inherits G4VMarker.  Size of text is recognized as "font size", 
+// i.e., height of the text. All the access functions defined for class 
+// G4VMarker are available. In addition, the following access functions 
+// are available, too: 
+// 
+//      //----- Set functions of G4Text
+//      void G4Text::SetText ( const G4String& text ) ;
+//      void G4Text::SetOffset ( double dx, double dy ) ;
+// 
+//      //----- Get functions of G4Text
+//      G4String G4Text::GetText () const;
+//      G4double G4Text::GetXOffset () const;
+//      G4double G4Text::GetYOffset () const;
+// 
+// Method SetText() defines text to be visualized, and GetText() returns 
+// the defined text. Method SetOffset() defines x (horizontal) and 
+// y (vertical) offsets in the screen coordinates. By default, both offsets 
+// are zero, and the text starts from the 3D position given to the 
+// constructor or to the method G4VMarker:SetPosition(). Offsets should be 
+// given with the same units as the one adopted for the size, i.e., 
+// world-size or screen-size units. 
+// Class Description - End:
+
+
 #ifndef G4TEXT_HH
 #define G4TEXT_HH
 
@@ -18,7 +53,9 @@
 #include "globals.hh"
 
 class G4Text: public G4VMarker {
-public:
+
+public: // With description
+
   enum Layout {left, centre, right};
   G4Text (const G4String& text);
   G4Text (const G4String& text, const G4Point3D& pos);