#include <G4Colour.hh>

Public Member Functions
	G4Colour (G4double r=1., G4double gr=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 &rhs)
G4double	GetRed () const
G4double	GetGreen () const
G4double	GetBlue () const
G4double	GetAlpha () const
void	SetRed (G4double)
void	SetGreen (G4double)
void	SetBlue (G4double)
void	SetAlpha (G4double)
G4bool	operator< (const G4Colour &rhs) 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 G4bool	GetColour (const G4String &key, G4Colour &result)
static G4bool	GetColor (const G4String &key, G4Colour &result)
static void	AddToMap (const G4String &key, const G4Colour &colour)
static void	InitialiseColourMap ()
static const std::map< G4String, G4Colour > &	GetMap ()

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

Detailed Description

Definition at line 88 of file G4Colour.hh.

Constructor & Destructor Documentation

◆ G4Colour() [1/2]

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

Definition at line 42 of file G4Colour.cc.

                                                                  :
red(clamp(r)), green(clamp(gr)), blue(clamp(b)), alpha(clamp(a))
{}

Referenced by AddToMap(), Black(), Blue(), Brown(), Cyan(), GetColor(), GetColour(), Gray(), Green(), Grey(), Magenta(), operator!=(), operator+=(), operator<(), operator<<, operator==(), Red(), White(), and Yellow().

◆ G4Colour() [2/2]

G4Colour::G4Colour ( G4ThreeVector v )

Definition at line 46 of file G4Colour.cc.

                                  :
red(clamp(v.x())), green(clamp(v.y())), blue(clamp(v.z())), alpha (1.)
{}

Member Function Documentation

◆ AddToMap()

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

static

Definition at line 86 of file G4Colour.cc.

{
  // Allow only master thread to populate the map
  if (!G4Threading::IsMasterThread()) {
    static G4bool first = true;
    if (first) {
      first = false;
      G4Exception
      ("G4Colour::AddToMap(const G4String& key, const G4Colour& colour)",
       "greps0002", JustWarning,
       "Attempt to add to colour map from non-master thread.");
    }
    return;
  }
 
  // Add standard colours to map
  InitialiseColourMap();  // Initialises if not already initialised
 
  // Convert to lower case since colour map is case insensitive
  G4String myKey = G4StrUtil::to_lower_copy(key);
  
  if (fColourMap.find(myKey) == 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");
  }
}

Referenced by InitialiseColourMap().

◆ Black()

G4Colour G4Colour::Black ( )

inlinestatic

Definition at line 178 of file G4Colour.hh.

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

G4Colour::G4Colour

G4Colour(G4double r=1., G4double gr=1., G4double b=1., G4double a=1.)

Definition G4Colour.cc:42

Referenced by InitialiseColourMap(), and G4VVisCommand::Twinkle().

◆ Blue()

G4Colour G4Colour::Blue ( )

inlinestatic

Definition at line 182 of file G4Colour.hh.

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

Referenced by G4AxesModel::Construct(), G4TrajectoryDrawByCharge::G4TrajectoryDrawByCharge(), InitialiseColourMap(), and G4VisCommandSceneAddScale::SetNewValue().

◆ Brown()

G4Colour G4Colour::Brown ( )

inlinestatic

Definition at line 179 of file G4Colour.hh.

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

Referenced by InitialiseColourMap().

◆ Cyan()

G4Colour G4Colour::Cyan ( )

inlinestatic

Definition at line 183 of file G4Colour.hh.

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

Referenced by InitialiseColourMap().

◆ GetAlpha()

G4double G4Colour::GetAlpha ( ) const

inline

Definition at line 173 of file G4Colour.hh.

173{return alpha;}

Referenced by G4OpenInventorSceneHandler::AddPrimitive(), G4VtkStore::AddPrimitiveSeparate(), G4VtkStore::AddPrimitiveTensorGlyph(), G4VtkStore::AddPrimitiveTransformBake(), G4TheRayTracer::Attenuate(), G4ViewParameters::CameraAndLightingCommands(), G4PhysicalVolumeModel::DescribeAndDescend(), G4OpenGLStoredViewer::DrawDisplayLists(), G4OpenGLQtViewer::DrawText(), G4OpenGLXViewer::DrawText(), G4ToolsSGViewer< tools::offscreen::session, tools::offscreen::sg_viewer >::Export(), G4VtkPolydataPolygonPipeline::G4VtkPolydataPolygonPipeline(), G4VtkPolydataPolyline2DPipeline::G4VtkPolydataPolyline2DPipeline(), G4VtkPolydataPolylinePipeline::G4VtkPolydataPolylinePipeline(), G4VtkPolydataSpherePipeline::G4VtkPolydataSpherePipeline(), G4VtkText2DPipeline::G4VtkText2DPipeline(), G4VtkTextPipeline::G4VtkTextPipeline(), G4TheRayTracer::GenerateColour(), G4TheRayTracer::GetMixedColour(), G4TheRayTracer::GetSurfaceColour(), G4VtkSceneHandler::MakeDefaultVisContext(), G4VtkPolydataInstanceAppendPipeline::MakeHash(), G4VtkPolydataInstanceBakePipeline::MakeHash(), MakeHash(), std::hash< G4VisAttributes >::operator()(), G4RTRun::RecordEvent(), and G4ViewParameters::TouchableCommands().

◆ GetBlue()

G4double G4Colour::GetBlue ( ) const

inline

Definition at line 172 of file G4Colour.hh.

172{return blue;}

Referenced by G4GMocrenFileSceneHandler::AddPrimitive(), G4OpenInventorSceneHandler::AddPrimitive(), G4VtkStore::AddPrimitiveSeparate(), G4VtkStore::AddPrimitiveTensorGlyph(), G4VtkStore::AddPrimitiveTransformBake(), G4VtkViewer::AddViewHUD(), G4TheRayTracer::Attenuate(), G4ViewParameters::CameraAndLightingCommands(), G4TheMTRayTracer::CreateBitMap(), G4OpenGLStoredViewer::DrawDisplayLists(), G4OpenGLQtViewer::DrawText(), G4OpenGLXViewer::DrawText(), G4ToolsSGViewer< tools::offscreen::session, tools::offscreen::sg_viewer >::Export(), G4VtkPolydataPolygonPipeline::G4VtkPolydataPolygonPipeline(), G4VtkPolydataPolyline2DPipeline::G4VtkPolydataPolyline2DPipeline(), G4VtkPolydataPolylinePipeline::G4VtkPolydataPolylinePipeline(), G4VtkPolydataSpherePipeline::G4VtkPolydataSpherePipeline(), G4VtkText2DPipeline::G4VtkText2DPipeline(), G4VtkTextPipeline::G4VtkTextPipeline(), G4TheRayTracer::GetMixedColour(), G4TheRayTracer::GetSurfaceColour(), G4VtkSceneHandler::MakeDefaultVisContext(), G4VtkPolydataInstanceAppendPipeline::MakeHash(), MakeHash(), std::hash< G4VisAttributes >::operator()(), G4OpenInventorQtViewer::SetView(), G4OpenInventorWinViewer::SetView(), G4OpenInventorXtExtendedViewer::SetView(), G4OpenInventorXtViewer::SetView(), G4ToolsSGViewer< tools::offscreen::session, tools::offscreen::sg_viewer >::SetView(), G4VtkViewer::SetView(), G4VtkViewer::ShowView(), and G4ViewParameters::TouchableCommands().

◆ GetColor()

G4bool G4Colour::GetColor	(	const G4String &	key,
		G4Colour &	result )

inlinestatic

Definition at line 188 of file G4Colour.hh.

189{return G4Colour::GetColour(key, result);}

G4Colour::GetColour

static G4bool GetColour(const G4String &key, G4Colour &result)

Definition G4Colour.cc:140

◆ GetColour()

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

static

Definition at line 140 of file G4Colour.cc.

{
  // Add standard colours to map
  InitialiseColourMap();  // Initialises if not already initialised
 
  G4String myKey = G4StrUtil::to_lower_copy(key);
 
  // NOLINTNEXTLINE(modernize-use-auto): Explicitly want a const_iterator
  std::map<G4String, G4Colour>::const_iterator iter = fColourMap.find(myKey); 
 
  // Don't modify "result" if colour was not found in map
  if (iter == fColourMap.cend()) {
    G4ExceptionDescription ed;
    ed << "Colour \"" << key << "\" not found. No action taken.";
    G4Exception("G4Colour::GetColour", "greps0003", JustWarning, ed);
    return false;
  }
 
  result = iter->second;
 
  return true;
}

Referenced by G4ViewParameters::CameraAndLightingCommands(), G4AxesModel::Construct(), G4VVisCommand::ConvertToColour(), GetColor(), G4ModelColourMap< T >::Set(), G4TrajectoryDrawByEncounteredVolume::SetDefault(), G4TrajectoryDrawByOriginVolume::SetDefault(), G4TrajectoryDrawByParticleID::SetDefault(), G4ModelCmdApplyColour< M >::SetNewValue(), and G4ModelCmdApplyStringColour< M >::SetNewValue().

◆ GetGreen()

G4double G4Colour::GetGreen ( ) const

inline

Definition at line 171 of file G4Colour.hh.

171{return green;}

Referenced by G4GMocrenFileSceneHandler::AddPrimitive(), G4OpenInventorSceneHandler::AddPrimitive(), G4VtkStore::AddPrimitiveSeparate(), G4VtkStore::AddPrimitiveTensorGlyph(), G4VtkStore::AddPrimitiveTransformBake(), G4VtkViewer::AddViewHUD(), G4TheRayTracer::Attenuate(), G4ViewParameters::CameraAndLightingCommands(), G4TheMTRayTracer::CreateBitMap(), G4OpenGLStoredViewer::DrawDisplayLists(), G4OpenGLQtViewer::DrawText(), G4OpenGLXViewer::DrawText(), G4ToolsSGViewer< tools::offscreen::session, tools::offscreen::sg_viewer >::Export(), G4VtkPolydataPolygonPipeline::G4VtkPolydataPolygonPipeline(), G4VtkPolydataPolyline2DPipeline::G4VtkPolydataPolyline2DPipeline(), G4VtkPolydataPolylinePipeline::G4VtkPolydataPolylinePipeline(), G4VtkPolydataSpherePipeline::G4VtkPolydataSpherePipeline(), G4VtkText2DPipeline::G4VtkText2DPipeline(), G4VtkTextPipeline::G4VtkTextPipeline(), G4TheRayTracer::GetMixedColour(), G4TheRayTracer::GetSurfaceColour(), G4VtkSceneHandler::MakeDefaultVisContext(), G4VtkPolydataInstanceAppendPipeline::MakeHash(), MakeHash(), std::hash< G4VisAttributes >::operator()(), G4OpenInventorQtViewer::SetView(), G4OpenInventorWinViewer::SetView(), G4OpenInventorXtExtendedViewer::SetView(), G4OpenInventorXtViewer::SetView(), G4ToolsSGViewer< tools::offscreen::session, tools::offscreen::sg_viewer >::SetView(), G4VtkViewer::SetView(), G4VtkViewer::ShowView(), and G4ViewParameters::TouchableCommands().

◆ GetMap()

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

static

Definition at line 167 of file G4Colour.cc.

{
  // Add standard colours to map
  InitialiseColourMap();  // Initialises if not already initialised
 
  return fColourMap;
}

Referenced by operator<<.

◆ GetRed()

G4double G4Colour::GetRed ( ) const

inline

Definition at line 170 of file G4Colour.hh.

170{return red;}

Referenced by G4GMocrenFileSceneHandler::AddPrimitive(), G4OpenInventorSceneHandler::AddPrimitive(), G4VtkStore::AddPrimitiveSeparate(), G4VtkStore::AddPrimitiveTensorGlyph(), G4VtkStore::AddPrimitiveTransformBake(), G4VtkViewer::AddViewHUD(), G4TheRayTracer::Attenuate(), G4ViewParameters::CameraAndLightingCommands(), G4TheMTRayTracer::CreateBitMap(), G4OpenGLStoredViewer::DrawDisplayLists(), G4OpenGLQtViewer::DrawText(), G4OpenGLXViewer::DrawText(), G4ToolsSGViewer< tools::offscreen::session, tools::offscreen::sg_viewer >::Export(), G4VtkPolydataPolygonPipeline::G4VtkPolydataPolygonPipeline(), G4VtkPolydataPolyline2DPipeline::G4VtkPolydataPolyline2DPipeline(), G4VtkPolydataPolylinePipeline::G4VtkPolydataPolylinePipeline(), G4VtkPolydataSpherePipeline::G4VtkPolydataSpherePipeline(), G4VtkText2DPipeline::G4VtkText2DPipeline(), G4VtkTextPipeline::G4VtkTextPipeline(), G4TheRayTracer::GetMixedColour(), G4TheRayTracer::GetSurfaceColour(), G4VtkSceneHandler::MakeDefaultVisContext(), G4VtkPolydataInstanceAppendPipeline::MakeHash(), MakeHash(), std::hash< G4VisAttributes >::operator()(), G4OpenInventorQtViewer::SetView(), G4OpenInventorWinViewer::SetView(), G4OpenInventorXtExtendedViewer::SetView(), G4OpenInventorXtViewer::SetView(), G4ToolsSGViewer< tools::offscreen::session, tools::offscreen::sg_viewer >::SetView(), G4VtkViewer::SetView(), G4VtkViewer::ShowView(), and G4ViewParameters::TouchableCommands().

◆ Gray()

G4Colour G4Colour::Gray ( )

inlinestatic

Definition at line 176 of file G4Colour.hh.

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

Referenced by InitialiseColourMap().

◆ Green()

G4Colour G4Colour::Green ( )

inlinestatic

Definition at line 181 of file G4Colour.hh.

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

Referenced by G4AxesModel::Construct(), G4TrajectoryDrawByCharge::G4TrajectoryDrawByCharge(), InitialiseColourMap(), and G4VisCommandSceneAddScale::SetNewValue().

◆ Grey()

G4Colour G4Colour::Grey ( )

inlinestatic

Definition at line 177 of file G4Colour.hh.

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

Referenced by InitialiseColourMap().

◆ InitialiseColourMap()

void G4Colour::InitialiseColourMap ( )

static

Definition at line 118 of file G4Colour.cc.

{
  if (fInitColourMap) return;
 
  fInitColourMap = true;
 
  // clang-format off
  // 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());
  // clang-format off
}

Referenced by AddToMap(), GetColour(), and GetMap().

◆ Magenta()

G4Colour G4Colour::Magenta ( )

inlinestatic

Definition at line 184 of file G4Colour.hh.

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

Referenced by InitialiseColourMap().

◆ operator G4ThreeVector()

G4Colour::operator G4ThreeVector ( )

Definition at line 56 of file G4Colour.cc.

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

◆ operator!=()

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

Definition at line 76 of file G4Colour.cc.

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

Referenced by operator==().

◆ operator+=()

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

inline

Definition at line 106 of file G4Colour.hh.

106{*this = rhs; return *this;}

◆ operator<()

G4bool G4Colour::operator< ( const G4Colour & rhs ) const

Definition at line 175 of file G4Colour.cc.

{
  if (red < rhs.red) return true;
  if (red == rhs.red) {
    if (green < rhs.green) return true;
    if (green == rhs.green) {
      if (blue < rhs.blue) return true;
      if (blue == rhs.blue) {
          if (alpha < rhs.alpha) return true;
      }
    }
  }
  return false;
}

◆ operator==()

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

inline

Definition at line 104 of file G4Colour.hh.

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

G4Colour::operator!=

G4bool operator!=(const G4Colour &c) const

Definition G4Colour.cc:76

◆ Red()

G4Colour G4Colour::Red ( )

inlinestatic

Definition at line 180 of file G4Colour.hh.

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

Referenced by G4AxesModel::Construct(), G4VVisCommand::DrawExtent(), G4TrajectoryDrawByCharge::G4TrajectoryDrawByCharge(), InitialiseColourMap(), and G4VisCommandSceneAddScale::SetNewValue().

◆ SetAlpha()

void G4Colour::SetAlpha ( G4double a )

Definition at line 53 of file G4Colour.cc.

53{alpha = clamp(a);}

Referenced by G4VVisCommand::ConvertToColour(), and G4PhysicalVolumeModel::DescribeAndDescend().

◆ SetBlue()

void G4Colour::SetBlue ( G4double b )

Definition at line 52 of file G4Colour.cc.

52{blue = clamp(b);}

◆ SetGreen()

void G4Colour::SetGreen ( G4double gr )

Definition at line 51 of file G4Colour.cc.

51{green = clamp(gr);}

◆ SetRed()

void G4Colour::SetRed ( G4double r )

Definition at line 50 of file G4Colour.cc.

50{red = clamp(r);}

◆ White()

G4Colour G4Colour::White ( )

inlinestatic

Definition at line 175 of file G4Colour.hh.

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

Referenced by InitialiseColourMap(), G4TrajectoryDrawByParticleID::SetDefault(), and G4VVisCommand::Twinkle().

◆ Yellow()

G4Colour G4Colour::Yellow ( )

inlinestatic

Definition at line 185 of file G4Colour.hh.

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

Referenced by InitialiseColourMap().

◆ operator<<

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

friend

Definition at line 60 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:

Public Member Functions

Static Public Member Functions

Friends

Detailed Description

Constructor & Destructor Documentation

◆ G4Colour() [1/2]

◆ G4Colour() [2/2]

Member Function Documentation

◆ AddToMap()

◆ Black()

◆ Blue()

◆ Brown()

◆ Cyan()

◆ GetAlpha()

◆ GetBlue()

◆ GetColor()

◆ GetColour()

◆ GetGreen()

◆ GetMap()

◆ GetRed()

◆ Gray()

◆ Green()

◆ Grey()

◆ InitialiseColourMap()

◆ Magenta()

◆ operator G4ThreeVector()

◆ operator!=()

◆ operator+=()

◆ operator<()

◆ operator==()

◆ Red()

◆ SetAlpha()

◆ SetBlue()

◆ SetGreen()

◆ SetRed()

◆ White()

◆ Yellow()

Friends And Related Symbol Documentation

◆ operator<<