#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

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

Referenced by Black(), Blue(), Brown(), Cyan(), Gray(), Green(), Grey(), Magenta(), Red(), White(), and Yellow().

◆ G4Colour() [2/2]

G4Colour::G4Colour ( G4ThreeVector v )

Definition at line 44 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 106 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;
  }
 
  // 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 159 of file G4Colour.hh.

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

G4Colour::G4Colour

G4Colour(G4double r_=1., G4double g_=1., G4double b_=1., G4double a_=1.)

Definition G4Colour.cc:35

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

◆ Blue()

G4Colour G4Colour::Blue ( )

inlinestatic

Definition at line 163 of file G4Colour.hh.

163{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 160 of file G4Colour.hh.

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

Referenced by InitialiseColourMap().

◆ Cyan()

G4Colour G4Colour::Cyan ( )

inlinestatic

Definition at line 164 of file G4Colour.hh.

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

Referenced by InitialiseColourMap().

◆ GetAlpha()

G4double G4Colour::GetAlpha ( ) const

inline

Definition at line 155 of file G4Colour.hh.

155{return alpha;}

Referenced by G4OpenInventorSceneHandler::AddPrimitive(), G4VtkStore::AddPrimitiveSeparate(), G4VtkStore::AddPrimitiveTensorGlyph(), G4VtkStore::AddPrimitiveTransformBake(), G4TheRayTracer::Attenuate(), G4ViewParameters::CameraAndLightingCommands(), G4Qt3DUtils::ConvertToQColor(), G4PhysicalVolumeModel::DescribeAndDescend(), G4OpenGLStoredViewer::DrawDisplayLists(), G4OpenGLQtViewer::DrawText(), G4OpenGLXViewer::DrawText(), G4ToolsSGViewer< SG_SESSION, 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(), G4ViewParameters::TouchableCommands(), and G4OpenGLQtViewer::updateViewerPropertiesTableWidget().

◆ GetBlue()

G4double G4Colour::GetBlue ( ) const

inline

Definition at line 154 of file G4Colour.hh.

154{return blue;}

Referenced by G4HepRepFileSceneHandler::AddCompound(), G4GMocrenFileSceneHandler::AddPrimitive(), G4HepRepFileSceneHandler::AddPrimitive(), G4OpenInventorSceneHandler::AddPrimitive(), G4VtkStore::AddPrimitiveSeparate(), G4VtkStore::AddPrimitiveTensorGlyph(), G4VtkStore::AddPrimitiveTransformBake(), G4VtkViewer::AddViewHUD(), G4TheRayTracer::Attenuate(), G4ViewParameters::CameraAndLightingCommands(), G4OpenGLViewer::ClearViewWithoutFlush(), G4Qt3DUtils::ConvertToQColor(), G4TheMTRayTracer::CreateBitMap(), G4TheRayTracer::CreateBitMap(), G4OpenGLXmViewer::CreateMainWindow(), G4OpenGLStoredViewer::DrawDisplayLists(), G4OpenGLQtViewer::DrawText(), G4OpenGLXViewer::DrawText(), G4ToolsSGViewer< SG_SESSION, 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< SG_SESSION, SG_VIEWER >::SetView(), G4VtkViewer::SetView(), G4VtkViewer::ShowView(), G4ViewParameters::TouchableCommands(), G4TheMTRayTracer::Trace(), and G4OpenGLQtViewer::updateViewerPropertiesTableWidget().

◆ GetColour()

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

static

Definition at line 155 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()) return false;
  
  result = iter->second;
 
  return true;
}

Referenced by G4AxesModel::Construct(), G4VVisCommand::ConvertToColour(), 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 153 of file G4Colour.hh.

153{return green;}

Referenced by G4HepRepFileSceneHandler::AddCompound(), G4GMocrenFileSceneHandler::AddPrimitive(), G4HepRepFileSceneHandler::AddPrimitive(), G4OpenInventorSceneHandler::AddPrimitive(), G4VtkStore::AddPrimitiveSeparate(), G4VtkStore::AddPrimitiveTensorGlyph(), G4VtkStore::AddPrimitiveTransformBake(), G4VtkViewer::AddViewHUD(), G4TheRayTracer::Attenuate(), G4ViewParameters::CameraAndLightingCommands(), G4OpenGLViewer::ClearViewWithoutFlush(), G4Qt3DUtils::ConvertToQColor(), G4TheMTRayTracer::CreateBitMap(), G4TheRayTracer::CreateBitMap(), G4OpenGLXmViewer::CreateMainWindow(), G4OpenGLStoredViewer::DrawDisplayLists(), G4OpenGLQtViewer::DrawText(), G4OpenGLXViewer::DrawText(), G4ToolsSGViewer< SG_SESSION, 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< SG_SESSION, SG_VIEWER >::SetView(), G4VtkViewer::SetView(), G4VtkViewer::ShowView(), G4ViewParameters::TouchableCommands(), G4TheMTRayTracer::Trace(), and G4OpenGLQtViewer::updateViewerPropertiesTableWidget().

◆ GetMap()

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

static

Definition at line 173 of file G4Colour.cc.

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

◆ GetRed()

G4double G4Colour::GetRed ( ) const

inline

Definition at line 152 of file G4Colour.hh.

152{return red;}

Referenced by G4HepRepFileSceneHandler::AddCompound(), G4GMocrenFileSceneHandler::AddPrimitive(), G4HepRepFileSceneHandler::AddPrimitive(), G4OpenInventorSceneHandler::AddPrimitive(), G4VtkStore::AddPrimitiveSeparate(), G4VtkStore::AddPrimitiveTensorGlyph(), G4VtkStore::AddPrimitiveTransformBake(), G4VtkViewer::AddViewHUD(), G4TheRayTracer::Attenuate(), G4ViewParameters::CameraAndLightingCommands(), G4OpenGLViewer::ClearViewWithoutFlush(), G4Qt3DUtils::ConvertToQColor(), G4TheMTRayTracer::CreateBitMap(), G4TheRayTracer::CreateBitMap(), G4OpenGLXmViewer::CreateMainWindow(), G4OpenGLStoredViewer::DrawDisplayLists(), G4OpenGLQtViewer::DrawText(), G4OpenGLXViewer::DrawText(), G4ToolsSGViewer< SG_SESSION, 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< SG_SESSION, SG_VIEWER >::SetView(), G4VtkViewer::SetView(), G4VtkViewer::ShowView(), G4ViewParameters::TouchableCommands(), G4TheMTRayTracer::Trace(), and G4OpenGLQtViewer::updateViewerPropertiesTableWidget().

◆ Gray()

G4Colour G4Colour::Gray ( )

inlinestatic

Definition at line 157 of file G4Colour.hh.

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

Referenced by InitialiseColourMap().

◆ Green()

G4Colour G4Colour::Green ( )

inlinestatic

Definition at line 162 of file G4Colour.hh.

162{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 158 of file G4Colour.hh.

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

Referenced by InitialiseColourMap().

◆ InitialiseColourMap()

void G4Colour::InitialiseColourMap ( )

static

Definition at line 135 of file G4Colour.cc.

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

Referenced by GetColour(), and GetMap().

◆ Magenta()

G4Colour G4Colour::Magenta ( )

inlinestatic

Definition at line 165 of file G4Colour.hh.

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

Referenced by InitialiseColourMap().

◆ operator G4ThreeVector()

G4Colour::operator G4ThreeVector ( )

Definition at line 76 of file G4Colour.cc.

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

◆ operator!=()

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

Definition at line 96 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 101 of file G4Colour.hh.

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

◆ operator<()

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

Definition at line 181 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 99 of file G4Colour.hh.

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

G4Colour::operator!=

G4bool operator!=(const G4Colour &c) const

Definition G4Colour.cc:96

◆ Red()

G4Colour G4Colour::Red ( )

inlinestatic

Definition at line 161 of file G4Colour.hh.

161{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 70 of file G4Colour.cc.

{
  alpha = a;
  if( alpha > 1.0 ){alpha = 1.0;} if( alpha < 0.0 ){alpha = 0.0;}
}

Referenced by G4VVisCommand::ConvertToColour().

◆ SetBlue()

void G4Colour::SetBlue ( G4double b )

Definition at line 64 of file G4Colour.cc.

{
  blue = b;
  if( blue  > 1.0 ){blue  = 1.0;} if( blue  < 0.0 ){blue  = 0.0;}
}

◆ SetGreen()

void G4Colour::SetGreen ( G4double gr )

Definition at line 58 of file G4Colour.cc.

{
  green = gr;
  if( green > 1.0 ){green = 1.0;} if( green < 0.0 ){green = 0.0;}
}

◆ SetRed()

void G4Colour::SetRed ( G4double r )

Definition at line 52 of file G4Colour.cc.

{
  red = r;
  if( red   > 1.0 ){red   = 1.0;} if( red   < 0.0 ){red   = 0.0;}
}

◆ White()

G4Colour G4Colour::White ( )

inlinestatic

Definition at line 156 of file G4Colour.hh.

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

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

◆ Yellow()

G4Colour G4Colour::Yellow ( )

inlinestatic

Definition at line 166 of file G4Colour.hh.

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

Referenced by InitialiseColourMap().

Friends And Related Symbol Documentation

◆ operator<<

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

friend

Definition at line 80 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()

◆ 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<<