G4Colour Class Reference

#include <G4Colour.hh>

Collaboration diagram for G4Colour:

Public Member Functions
	G4Colour (G4double r=1., G4double g=1., G4double b=1., G4double a=1.)
	G4Colour (G4ThreeVector)
	operator G4ThreeVector ()
G4bool	operator!= (const G4Colour &c) const
G4bool	operator== (const G4Colour &c) const
G4Colour &	operator+= (const G4Colour &)
G4double	GetRed () const
G4double	GetGreen () const
G4double	GetBlue () const
G4double	GetAlpha () const

Static Public Member Functions
static G4Colour	White ()
static G4Colour	Gray ()
static G4Colour	Grey ()
static G4Colour	Black ()
static G4Colour	Brown ()
static G4Colour	Red ()
static G4Colour	Green ()
static G4Colour	Blue ()
static G4Colour	Cyan ()
static G4Colour	Magenta ()
static G4Colour	Yellow ()
static void	AddToMap (const G4String &key, const G4Colour &colour)
static G4bool	GetColour (const G4String &key, G4Colour &result)
static const std::map< G4String, G4Colour > &	GetMap ()

Static Private Member Functions
static void	InitialiseColourMap ()

Private Attributes
G4double	red
G4double	green
G4double	blue
G4double	alpha

Static Private Attributes
static G4ThreadLocal std::map< G4String, G4Colour > *	fColourMap = 0
static G4ThreadLocal G4bool	fInitColourMap = false

Friends
std::ostream &	operator<< (std::ostream &, const G4Colour &)

Detailed Description

Definition at line 83 of file G4Colour.hh.

Constructor & Destructor Documentation

G4Colour() [1/2]

G4Colour::G4Colour	(	G4double	r = 1.,
		G4double	g = 1.,
		G4double	b = 1.,
		G4double	a = 1.
	)

Definition at line 34 of file G4Colour.cc.

                                                                  :
red (r), green (gr), blue (b), alpha (a)
{
  if( red   > 1.0 ){red   = 1.0;} if( red   < 0.0 ){red   = 0.0;}
  if( green > 1.0 ){green = 1.0;} if( green < 0.0 ){green = 0.0;}
  if( blue  > 1.0 ){blue  = 1.0;} if( blue  < 0.0 ){blue  = 0.0;}
  if( alpha > 1.0 ){alpha = 1.0;} if( alpha < 0.0 ){alpha = 0.0;}
}

Here is the caller graph for this function:

G4Colour() [2/2]

G4Colour::G4Colour

(

G4ThreeVector

v

)

Definition at line 43 of file G4Colour.cc.

                                  :
red (v.x()), green (v.y()), blue (v.z()), alpha (1.)
{
  if( red   > 1.0 ){red   = 1.0;} if( red   < 0.0 ){red   = 0.0;}
  if( green > 1.0 ){green = 1.0;} if( green < 0.0 ){green = 0.0;}
  if( blue  > 1.0 ){blue  = 1.0;} if( blue  < 0.0 ){blue  = 0.0;}
}

Member Function Documentation

AddToMap()

void G4Colour::AddToMap ( const G4String &  key, const G4Colour &  colour  )

static

Definition at line 86 of file G4Colour.cc.

{
  if (!fColourMap)
    fColourMap = new std::map<G4String, G4Colour>;

  // Convert to lower case since colour map is case insensitive
  G4String myKey(key);
  myKey.toLower();

  std::map<G4String, G4Colour>::iterator iter = fColourMap->find(myKey);
  
  if (iter == fColourMap->end()) (*fColourMap)[myKey] = colour;  
  else {
    G4ExceptionDescription ed; 
    ed << "G4Colour with key "<<myKey<<" already exists."<<G4endl;
    G4Exception
      ("G4Colour::AddToMap(const G4String& key, const G4Colour& colour)",
       "greps0001", JustWarning, ed,
       "Colour key exists");
  }
}

Here is the call graph for this function:

Here is the caller graph for this function:

Black()

G4Colour G4Colour::Black ( )

inlinestatic

Definition at line 146 of file G4Colour.hh.

{return G4Colour(0.0, 0.0, 0.0);}

Here is the call graph for this function:

Here is the caller graph for this function:

Blue()

G4Colour G4Colour::Blue ( )

inlinestatic

Definition at line 150 of file G4Colour.hh.

{return G4Colour(0.0, 0.0, 1.0);} 

Here is the call graph for this function:

Here is the caller graph for this function:

Brown()

G4Colour G4Colour::Brown ( )

inlinestatic

Definition at line 147 of file G4Colour.hh.

{return G4Colour(0.45,0.25,0.0);}

Here is the call graph for this function:

Here is the caller graph for this function:

Cyan()

G4Colour G4Colour::Cyan ( )

inlinestatic

Definition at line 151 of file G4Colour.hh.

{return G4Colour(0.0, 1.0, 1.0);}

Here is the call graph for this function:

Here is the caller graph for this function:

GetAlpha()

G4double G4Colour::GetAlpha ( ) const

inline

Definition at line 142 of file G4Colour.hh.

{return alpha;}

Here is the caller graph for this function:

GetBlue()

G4double G4Colour::GetBlue ( ) const

inline

Definition at line 141 of file G4Colour.hh.

{return blue;}

Here is the caller graph for this function:

GetColour()

bool G4Colour::GetColour ( const G4String &  key, G4Colour &  result  )

static

Definition at line 126 of file G4Colour.cc.

{
  if (false == fInitColourMap) {
    fInitColourMap = true;
    // Add standard colours to map
    InitialiseColourMap();
  }
 
  G4String myKey(key);
  myKey.toLower();
 
  std::map<G4String, G4Colour>::iterator iter = fColourMap->find(myKey);

  // Don't modify "result" if colour was not found in map
  if (iter == fColourMap->end()) return false;
  
  result = iter->second;

  return true;
}

Here is the call graph for this function:

Here is the caller graph for this function:

GetGreen()

G4double G4Colour::GetGreen ( ) const

inline

Definition at line 140 of file G4Colour.hh.

{return green;}

Here is the caller graph for this function:

GetMap()

const std::map< G4String, G4Colour > & G4Colour::GetMap ( )

static

Definition at line 147 of file G4Colour.cc.

{
  if (false == fInitColourMap) {
    fInitColourMap = true;
    // Add standard colours to map
    InitialiseColourMap();
  }
 
  return *fColourMap;
}

Here is the call graph for this function:

Here is the caller graph for this function:

GetRed()

G4double G4Colour::GetRed ( ) const

inline

Definition at line 139 of file G4Colour.hh.

{return red;}

Here is the caller graph for this function:

Gray()

G4Colour G4Colour::Gray ( )

inlinestatic

Definition at line 144 of file G4Colour.hh.

{return G4Colour(0.5, 0.5, 0.5);}

Here is the call graph for this function:

Here is the caller graph for this function:

Green()

G4Colour G4Colour::Green ( )

inlinestatic

Definition at line 149 of file G4Colour.hh.

{return G4Colour(0.0, 1.0, 0.0);}

Here is the call graph for this function:

Here is the caller graph for this function:

Grey()

G4Colour G4Colour::Grey ( )

inlinestatic

Definition at line 145 of file G4Colour.hh.

{return G4Colour(0.5, 0.5, 0.5);}

Here is the call graph for this function:

Here is the caller graph for this function:

InitialiseColourMap()

void G4Colour::InitialiseColourMap ( )

staticprivate

Definition at line 109 of file G4Colour.cc.

{
  // Standard colours
  AddToMap("white",   G4Colour::White());
  AddToMap("grey",    G4Colour::Grey());
  AddToMap("gray",    G4Colour::Gray());
  AddToMap("black",   G4Colour::Black());
  AddToMap("brown",   G4Colour::Brown());
  AddToMap("red",     G4Colour::Red());
  AddToMap("green",   G4Colour::Green());
  AddToMap("blue",    G4Colour::Blue());
  AddToMap("cyan",    G4Colour::Cyan());
  AddToMap("magenta", G4Colour::Magenta());
  AddToMap("yellow",  G4Colour::Yellow());
}

Here is the call graph for this function:

Here is the caller graph for this function:

Magenta()

G4Colour G4Colour::Magenta ( )

inlinestatic

Definition at line 152 of file G4Colour.hh.

{return G4Colour(1.0, 0.0, 1.0);}

Here is the call graph for this function:

Here is the caller graph for this function:

operator G4ThreeVector()

G4Colour::operator G4ThreeVector

(

)

Definition at line 51 of file G4Colour.cc.

                                 {
  return G4ThreeVector(red,green,blue);
}

operator!=()

G4bool G4Colour::operator!=

(

const G4Colour &

c

)

const

Definition at line 71 of file G4Colour.cc.

                                                     {
  if (
      (red   != c.red)   ||
      (green != c.green) ||
      (blue  != c.blue)  ||
      (alpha != c.alpha)
      )
    return true;
  return false;
}

Here is the caller graph for this function:

operator+=()

G4Colour& G4Colour::operator+= ( const G4Colour &  )

inline

Definition at line 101 of file G4Colour.hh.

{return *this;}  // Dummy

Here is the call graph for this function:

operator==()

G4bool G4Colour::operator== ( const G4Colour &  c ) const

inline

Definition at line 100 of file G4Colour.hh.

{return !(operator != (c));}

Here is the call graph for this function:

Red()

G4Colour G4Colour::Red ( )

inlinestatic

Definition at line 148 of file G4Colour.hh.

{return G4Colour(1.0, 0.0, 0.0);}

Here is the call graph for this function:

Here is the caller graph for this function:

White()

G4Colour G4Colour::White ( )

inlinestatic

Definition at line 143 of file G4Colour.hh.

{return G4Colour(1.0, 1.0, 1.0);}

Here is the call graph for this function:

Here is the caller graph for this function:

Yellow()

G4Colour G4Colour::Yellow ( )

inlinestatic

Definition at line 153 of file G4Colour.hh.

{return G4Colour(1.0, 1.0, 0.0);}

Here is the call graph for this function:

Here is the caller graph for this function:

Friends And Related Function Documentation

operator<<

std::ostream& operator<< ( std::ostream &  os, const G4Colour &  c  )

friend

Definition at line 55 of file G4Colour.cc.

                                                            {
  os << '(' << c.red << ',' << c.green << ',' << c.blue
            << ',' << c.alpha << ')';
  const std::map<G4String, G4Colour>& colourMap = G4Colour::GetMap();
  // Reverse iterator to pick up English spelling of grey!!  :)
  std::map<G4String, G4Colour>::const_reverse_iterator ri;
  for (ri = colourMap.rbegin(); ri != colourMap.rend(); ++ri) {
    if (c == ri->second) {
      os << " (" << ri->first << ')';
      break;
    }
  }
  
  return os;
}

Member Data Documentation

alpha

G4double G4Colour::alpha

private

Definition at line 131 of file G4Colour.hh.

blue

G4double G4Colour::blue

private

Definition at line 131 of file G4Colour.hh.

fColourMap

G4ThreadLocal std::map< G4String, G4Colour > * G4Colour::fColourMap = 0

staticprivate

Definition at line 133 of file G4Colour.hh.

fInitColourMap

G4ThreadLocal bool G4Colour::fInitColourMap = false

staticprivate

Definition at line 134 of file G4Colour.hh.

green

G4double G4Colour::green

private

Definition at line 131 of file G4Colour.hh.

red

G4double G4Colour::red

private

Definition at line 131 of file G4Colour.hh.

---

The documentation for this class was generated from the following files:

• G4Colour.hh
• G4Colour.cc