G4Colour Class Reference

#include <G4Colour.hh>

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
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 ()

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;}
}

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.

{
  // 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");
  }
}

Black()

G4Colour G4Colour::Black ( )

inlinestatic

Definition at line 145 of file G4Colour.hh.

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

Blue()

G4Colour G4Colour::Blue ( )

inlinestatic

Definition at line 149 of file G4Colour.hh.

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

Referenced by G4AxesModel::G4AxesModel(), and G4TrajectoryDrawByCharge::G4TrajectoryDrawByCharge().

Brown()

G4Colour G4Colour::Brown ( )

inlinestatic

Definition at line 146 of file G4Colour.hh.

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

Cyan()

G4Colour G4Colour::Cyan ( )

inlinestatic

Definition at line 150 of file G4Colour.hh.

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

GetAlpha()

G4double G4Colour::GetAlpha ( ) const

inline

Definition at line 141 of file G4Colour.hh.

{return alpha;}

Referenced by G4TheRayTracer::Attenuate(), G4ViewParameters::CameraAndLightingCommands(), G4PhysicalVolumeModel::DescribeAndDescend(), G4TheRayTracer::GenerateColour(), G4TheRayTracer::GetMixedColour(), G4TheRayTracer::GetSurfaceColour(), and G4ViewParameters::TouchableCommands().

GetBlue()

G4double G4Colour::GetBlue ( ) const

inline

Definition at line 140 of file G4Colour.hh.

{return blue;}

Referenced by G4HepRepFileSceneHandler::AddCompound(), G4GMocrenFileSceneHandler::AddPrimitive(), G4HepRepFileSceneHandler::AddPrimitive(), G4TheRayTracer::Attenuate(), G4ViewParameters::CameraAndLightingCommands(), G4TheRayTracer::CreateBitMap(), G4TheRayTracer::GetMixedColour(), G4TheRayTracer::GetSurfaceColour(), G4VisCommandGeometrySetColour::SetNewValue(), G4VisCommandSetColour::SetNewValue(), G4VisCommandSetTextColour::SetNewValue(), G4VisCommandsTouchableSet::SetNewValue(), G4VisCommandsViewerSet::SetNewValue(), and G4ViewParameters::TouchableCommands().

GetColour()

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

static

Definition at line 123 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;
}

Referenced by G4AxesModel::G4AxesModel(), G4ModelColourMap< T >::Set(), G4TrajectoryDrawByOriginVolume::SetDefault(), G4TrajectoryDrawByParticleID::SetDefault(), G4VisCommandGeometrySetColour::SetNewValue(), G4VisCommandSetColour::SetNewValue(), G4VisCommandSetTextColour::SetNewValue(), G4VisCommandsTouchableSet::SetNewValue(), G4VisCommandsViewerSet::SetNewValue(), G4ModelCmdApplyStringColour< M >::SetNewValue(), and G4ModelCmdApplyColour< M >::SetNewValue().

GetGreen()

G4double G4Colour::GetGreen ( ) const

inline

Definition at line 139 of file G4Colour.hh.

{return green;}

Referenced by G4HepRepFileSceneHandler::AddCompound(), G4GMocrenFileSceneHandler::AddPrimitive(), G4HepRepFileSceneHandler::AddPrimitive(), G4TheRayTracer::Attenuate(), G4ViewParameters::CameraAndLightingCommands(), G4TheRayTracer::CreateBitMap(), G4TheRayTracer::GetMixedColour(), G4TheRayTracer::GetSurfaceColour(), G4VisCommandGeometrySetColour::SetNewValue(), G4VisCommandSetColour::SetNewValue(), G4VisCommandSetTextColour::SetNewValue(), G4VisCommandsTouchableSet::SetNewValue(), G4VisCommandsViewerSet::SetNewValue(), and G4ViewParameters::TouchableCommands().

GetMap()

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

static

Definition at line 144 of file G4Colour.cc.

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

GetRed()

G4double G4Colour::GetRed ( ) const

inline

Definition at line 138 of file G4Colour.hh.

{return red;}

Referenced by G4HepRepFileSceneHandler::AddCompound(), G4GMocrenFileSceneHandler::AddPrimitive(), G4HepRepFileSceneHandler::AddPrimitive(), G4TheRayTracer::Attenuate(), G4ViewParameters::CameraAndLightingCommands(), G4TheRayTracer::CreateBitMap(), G4TheRayTracer::GetMixedColour(), G4TheRayTracer::GetSurfaceColour(), G4VisCommandGeometrySetColour::SetNewValue(), G4VisCommandSetColour::SetNewValue(), G4VisCommandSetTextColour::SetNewValue(), G4VisCommandsTouchableSet::SetNewValue(), G4VisCommandsViewerSet::SetNewValue(), and G4ViewParameters::TouchableCommands().

Gray()

G4Colour G4Colour::Gray ( )

inlinestatic

Definition at line 143 of file G4Colour.hh.

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

Green()

G4Colour G4Colour::Green ( )

inlinestatic

Definition at line 148 of file G4Colour.hh.

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

Referenced by G4AxesModel::G4AxesModel(), and G4TrajectoryDrawByCharge::G4TrajectoryDrawByCharge().

Grey()

G4Colour G4Colour::Grey ( )

inlinestatic

Definition at line 144 of file G4Colour.hh.

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

Magenta()

G4Colour G4Colour::Magenta ( )

inlinestatic

Definition at line 151 of file G4Colour.hh.

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

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;
}

Referenced by operator==().

operator==()

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

inline

Definition at line 100 of file G4Colour.hh.

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

Red()

G4Colour G4Colour::Red ( )

inlinestatic

Definition at line 147 of file G4Colour.hh.

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

Referenced by G4PhysicalVolumeModel::DescribeSolid(), G4AxesModel::G4AxesModel(), and G4TrajectoryDrawByCharge::G4TrajectoryDrawByCharge().

White()

G4Colour G4Colour::White ( )

inlinestatic

Definition at line 142 of file G4Colour.hh.

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

Referenced by G4TrajectoryDrawByParticleID::SetDefault().

Yellow()

G4Colour G4Colour::Yellow ( )

inlinestatic

Definition at line 152 of file G4Colour.hh.

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

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;
}

---

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

• G4Colour.hh
• G4Colour.cc