Import Geant4 1.0.0 source tree

source/graphics_reps/include/G4Colour.hh

@@ -1,16 +1,58 @@
 // 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: G4Colour.hh,v 1.2 1999/05/25 09:10:07 johna Exp $
-// GEANT4 tag $Name: geant4-00-01 $
+// $Id: G4Colour.hh,v 1.3.2.1 1999/12/07 20:48:48 gunter Exp $
+// GEANT4 tag $Name: geant4-01-00 $
 //
 // 
 // John Allison 20th October 1996
 
+// Class Description:
+// Class G4Colour has 4 fields, which represent the RGBA (red, green, blue, 
+// and alpha) components of colour. Each component takes a value between 
+// 0 and 1. If an irrelevant value, i.e., a value less than 0 or greater 
+// than 1, is given as an argument of the constructor, such a value is 
+// automatically clipped to 0 or 1. Alpha is opacity, which is not used 
+// at present. You can use its default value 1, which means "opaque" 
+// in instantiation of G4Colour. 
+// 
+// A G4Colour object is instantiated by giving red, green, and blue 
+// components to its constructor, i.e., 
+// 
+//      G4Colour::G4Colour ( G4double r = 1.0, 
+//                           G4double g = 1.0, 
+//                           G4double b = 1.0, 
+//                           G4double a = 1.0);
+//                                   // 0<=red, green, blue <= 1.0 
+// 
+// The default value of each component is 1.0. That is to say, the default 
+// colour is "white".  For example, colours which are often used can be 
+// instantiated as follows: 
+// 
+//      G4Colour  white   ()              ;  // white
+//      G4Colour  white   (1.0, 1.0, 1.0) ;  // white
+//      G4Colour  gray    (0.5, 0.5, 0.5) ;  // gray
+//      G4Colour  black   (0.0, 0.0, 0.0) ;  // black
+//      G4Colour  red     (1.0, 0.0, 0.0) ;  // red
+//      G4Colour  green   (0.0, 1.0, 0.0) ;  // green
+//      G4Colour  blue    (0.0, 0.0, 1.0) ;  // blue
+//      G4Colour  cyan    (0.0, 1.0, 1.0) ;  // cyan
+//      G4Colour  magenta (1.0, 0.0, 1.0) ;  // magenta 
+//      G4Colour  yellow  (1.0, 1.0, 0.0) ;  // yellow
+// 
+// After instantiation of a G4Colour object, you can access to its components 
+// with the following access functions: 
+// 
+//      G4double G4Colour::GetRed   () const ; // Get the red   component. 
+//      G4double G4Colour::GetGreen () const ; // Get the green component.
+//      G4double G4Colour::GetBlue  () const ; // Get the blue  component.
+//
+// Class Description - End:
+
 #ifndef G4COLOUR_HH
 #define G4COLOUR_HH
 
@@ -19,7 +61,9 @@ class ostream;
 
 class G4Colour {
   friend ostream& operator << (ostream& os, const G4Colour& c);
-public:
+
+public: // With description
+
   G4Colour (G4double r = 1., G4double g = 1., G4double b = 1.,
 	    G4double a = 1.);
   G4bool operator != (const G4Colour& c) const;