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: G4Colour.hh,v 1.14 2007/01/05 14:06:28 allison Exp $ |
---|
28 | // GEANT4 tag $Name: geant4-09-03 $ |
---|
29 | // |
---|
30 | // |
---|
31 | // John Allison 20th October 1996 |
---|
32 | |
---|
33 | // Class Description: |
---|
34 | // Class G4Colour has 4 fields, which represent the RGBA (red, green, blue, |
---|
35 | // and alpha) components of colour. Each component takes a value between |
---|
36 | // 0 and 1. If an irrelevant value, i.e., a value less than 0 or greater |
---|
37 | // than 1, is given as an argument of the constructor, such a value is |
---|
38 | // automatically clipped to 0 or 1. Alpha is opacity (1 = opaque). |
---|
39 | // |
---|
40 | // A G4Colour object is instantiated by giving red, green, and blue |
---|
41 | // components to its constructor, i.e., |
---|
42 | // |
---|
43 | // G4Colour::G4Colour ( G4double r = 1.0, |
---|
44 | // G4double g = 1.0, |
---|
45 | // G4double b = 1.0, |
---|
46 | // G4double a = 1.0); |
---|
47 | // // 0<=red, green, blue <= 1.0 |
---|
48 | // |
---|
49 | // The default value of each component is 1.0. That is to say, the default |
---|
50 | // colour is "white". For example, colours which are often used can be |
---|
51 | // instantiated as follows: |
---|
52 | // |
---|
53 | // G4Colour white () ; // white |
---|
54 | // G4Colour white (1.0, 1.0, 1.0) ; // white |
---|
55 | // G4Colour gray (0.5, 0.5, 0.5) ; // gray |
---|
56 | // G4Colour black (0.0, 0.0, 0.0) ; // black |
---|
57 | // G4Colour red (1.0, 0.0, 0.0) ; // red |
---|
58 | // G4Colour green (0.0, 1.0, 0.0) ; // green |
---|
59 | // G4Colour blue (0.0, 0.0, 1.0) ; // blue |
---|
60 | // G4Colour cyan (0.0, 1.0, 1.0) ; // cyan |
---|
61 | // G4Colour magenta (1.0, 0.0, 1.0) ; // magenta |
---|
62 | // G4Colour yellow (1.0, 1.0, 0.0) ; // yellow |
---|
63 | // |
---|
64 | // For convenience, static member functions are also defined for the above colours. |
---|
65 | // |
---|
66 | // After instantiation of a G4Colour object, you can access to its components |
---|
67 | // with the following access functions: |
---|
68 | // |
---|
69 | // G4double G4Colour::GetRed () const ; // Get the red component. |
---|
70 | // G4double G4Colour::GetGreen () const ; // Get the green component. |
---|
71 | // G4double G4Colour::GetBlue () const ; // Get the blue component. |
---|
72 | // |
---|
73 | // Class Description - End: |
---|
74 | |
---|
75 | #ifndef G4COLOUR_HH |
---|
76 | #define G4COLOUR_HH |
---|
77 | |
---|
78 | #include "globals.hh" |
---|
79 | #include "G4ThreeVector.hh" |
---|
80 | #include <iostream> |
---|
81 | #include <map> |
---|
82 | |
---|
83 | using std::map; |
---|
84 | |
---|
85 | class G4Colour { |
---|
86 | friend std::ostream& operator << (std::ostream& os, const G4Colour& c); |
---|
87 | |
---|
88 | public: // With description |
---|
89 | |
---|
90 | G4Colour (G4double r = 1., G4double g = 1., G4double b = 1., |
---|
91 | G4double a = 1.); |
---|
92 | G4Colour (G4ThreeVector); |
---|
93 | // Converts the components of the 3-vector into red, green, blue. |
---|
94 | // The opacity, alpha = 1. |
---|
95 | operator G4ThreeVector(); |
---|
96 | // Converts red, green, blue into the components of a 3-vector. |
---|
97 | G4bool operator != (const G4Colour& c) const; |
---|
98 | G4double GetRed () const; |
---|
99 | G4double GetGreen () const; |
---|
100 | G4double GetBlue () const; |
---|
101 | G4double GetAlpha () const; // alpha = opacity = 1. - transparency. |
---|
102 | |
---|
103 | static G4Colour White(); |
---|
104 | static G4Colour Gray(); |
---|
105 | static G4Colour Grey(); |
---|
106 | static G4Colour Black(); |
---|
107 | static G4Colour Red(); |
---|
108 | static G4Colour Green(); |
---|
109 | static G4Colour Blue(); |
---|
110 | static G4Colour Cyan(); |
---|
111 | static G4Colour Magenta(); |
---|
112 | static G4Colour Yellow(); |
---|
113 | |
---|
114 | static void AddToMap(const G4String& key, const G4Colour& colour); |
---|
115 | // Add user defined colour to colour map with given key. Standard |
---|
116 | // colours are added to map by default. |
---|
117 | |
---|
118 | static bool GetColour(const G4String& key, G4Colour& result); |
---|
119 | // Get colour for given key. Returns false if key doesn't exist |
---|
120 | // in colour map, leaving result unchanged. Colour map |
---|
121 | // is not sensitive to key case. |
---|
122 | |
---|
123 | private: |
---|
124 | G4double red, green, blue, alpha; |
---|
125 | |
---|
126 | static map<G4String, G4Colour> fColourMap; |
---|
127 | static bool fInitColourMap; |
---|
128 | |
---|
129 | static void InitialiseColourMap(); |
---|
130 | |
---|
131 | }; |
---|
132 | |
---|
133 | inline G4double G4Colour::GetRed () const {return red;} |
---|
134 | inline G4double G4Colour::GetGreen () const {return green;} |
---|
135 | inline G4double G4Colour::GetBlue () const {return blue;} |
---|
136 | inline G4double G4Colour::GetAlpha () const {return alpha;} |
---|
137 | inline G4Colour G4Colour::White() {return G4Colour(1.0, 1.0, 1.0);} |
---|
138 | inline G4Colour G4Colour::Gray() {return G4Colour(0.5, 0.5, 0.5);} |
---|
139 | inline G4Colour G4Colour::Grey() {return G4Colour(0.5, 0.5, 0.5);} |
---|
140 | inline G4Colour G4Colour::Black() {return G4Colour(0.0, 0.0, 0.0);} |
---|
141 | inline G4Colour G4Colour::Red() {return G4Colour(1.0, 0.0, 0.0);} |
---|
142 | inline G4Colour G4Colour::Green() {return G4Colour(0.0, 1.0, 0.0);} |
---|
143 | inline G4Colour G4Colour::Blue() {return G4Colour(0.0, 0.0, 1.0);} |
---|
144 | inline G4Colour G4Colour::Cyan() {return G4Colour(0.0, 1.0, 1.0);} |
---|
145 | inline G4Colour G4Colour::Magenta() {return G4Colour(1.0, 0.0, 1.0);} |
---|
146 | inline G4Colour G4Colour::Yellow() {return G4Colour(1.0, 1.0, 0.0);} |
---|
147 | |
---|
148 | #endif |
---|