CCalVisualisable Class Reference

#include <CCalVisualisable.hh>

Collaboration diagram for CCalVisualisable:

Classes
class	visParameters

Public Types
enum	visType {   Sensitive =0, Electronics =1, Support =2, Cable =3,   Absorber =4, OtherServices =5, PseudoVolumes =6, TotalVisTypes =7,   Undefined =-1 }

Public Member Functions
	CCalVisualisable (G4String file)
virtual	~CCalVisualisable ()
bool	readFile (G4String file)
void	setDefault ()
bool	isVisible (visType v) const
void	setVisible (visType v, bool flag=true)
double	colorRed (visType v) const
double	colorGreen (visType v) const
double	colorBlue (visType v) const
void	setColorRed (visType v, double r)
void	setColorGreen (visType v, double g)
void	setColorBlue (visType v, double b)
void	setColor (visType v, double r, double g, double b)
bool	isWireFrame (visType v) const
void	setWireFrame (visType v, bool wf=true)

Protected Member Functions
bool	readFile ()

Static Protected Member Functions
static void	setPath ()

Private Member Functions
double	checkColorRange (double color, char type) const

Private Attributes
G4String	visFile
visParameters	theParameters [TotalVisTypes]

Static Private Attributes
static const char *	pathName =0

Detailed Description

Definition at line 39 of file CCalVisualisable.hh.

Member Enumeration Documentation

visType

enum CCalVisualisable::visType

Enumerator
Sensitive
Electronics
Support
Cable
Absorber
OtherServices
PseudoVolumes
TotalVisTypes
Undefined

Definition at line 43 of file CCalVisualisable.hh.

               {Sensitive=0,
        Electronics=1,
        Support=2,
        Cable=3, 
        Absorber=4,
        OtherServices=5,
        PseudoVolumes=6,
        TotalVisTypes=7,
        Undefined=-1};

Constructor & Destructor Documentation

CCalVisualisable()

CCalVisualisable::CCalVisualisable

(

G4String

file

)

Definition at line 41 of file CCalVisualisable.cc.

                                               :visFile(file) {
  if (!pathName)
    setPath();
  setDefault();
  readFile();
}

Here is the call graph for this function:

~CCalVisualisable()

virtual CCalVisualisable::~CCalVisualisable ( )

inlinevirtual

Definition at line 71 of file CCalVisualisable.hh.

{}

Here is the call graph for this function:

Member Function Documentation

checkColorRange()

double CCalVisualisable::checkColorRange ( double  color, char  type  ) const

private

Definition at line 159 of file CCalVisualisable.cc.

                                                                        {
  if (cvalue>1) {
    G4cerr << "ERROR: In " << visFile << ". Color " << ctype << "=" 
     << cvalue << " > 1" << G4endl;
    G4cerr << "       It will be reset to 1." << G4endl;
    return 1.;
  }
  if (cvalue<0) {
    G4cerr << "ERROR: In " << visFile << ". Color " << ctype << "=" 
     << cvalue << " < 0" << G4endl;
    G4cerr << "       It will be reset to 0." << G4endl;
    return 0.;
  }
  return cvalue;
}

Here is the caller graph for this function:

colorBlue()

double CCalVisualisable::colorBlue ( visType  v ) const

inline

Definition at line 85 of file CCalVisualisable.hh.

{return theParameters[v].bColor;}

Here is the caller graph for this function:

colorGreen()

double CCalVisualisable::colorGreen ( visType  v ) const

inline

Definition at line 84 of file CCalVisualisable.hh.

{return theParameters[v].gColor;}

Here is the caller graph for this function:

colorRed()

double CCalVisualisable::colorRed ( visType  v ) const

inline

Definition at line 83 of file CCalVisualisable.hh.

{return theParameters[v].rColor;}

Here is the caller graph for this function:

isVisible()

bool CCalVisualisable::isVisible ( visType  v ) const

inline

Definition at line 80 of file CCalVisualisable.hh.

{return theParameters[v].visibility;}

Here is the caller graph for this function:

isWireFrame()

bool CCalVisualisable::isWireFrame ( visType  v ) const

inline

Definition at line 91 of file CCalVisualisable.hh.

{return theParameters[v].wireframe;}

Here is the caller graph for this function:

readFile() [1/2]

bool CCalVisualisable::readFile

(

G4String

file

)

Definition at line 48 of file CCalVisualisable.cc.

                                             { 
  visFile=file;
  return readFile();
}

Here is the call graph for this function:

readFile() [2/2]

bool CCalVisualisable::readFile ( )

protected

Definition at line 80 of file CCalVisualisable.cc.

                                {
  if (visFile=="") {
    G4cerr << "ERROR: No file was specified from which to read Visualisation parameters" 
     << G4endl;
    return false;
  }

  //Let's open the file
  G4cout << " ==> Opening file " << visFile 
       << " to read visualisation parameters..."
       << G4endl;

  G4String pathname(pathName);
  std::ifstream is;
#ifdef debug
  G4cout << "Viualisable : Path " << pathname << " FIle " << visFile << G4endl;
#endif
  bool ok = openGeomFile(is, pathname, visFile);
  if (!ok) {
    G4cout << "WARNING: Could not read " << visFile << G4endl;
    G4cout << "         Default visualization parameters will be used." << G4endl;
    return false;
  }
  
  while (is) {
    G4String viewvol;
    readName(is,viewvol);

    visType vt = Undefined;
    if (viewvol=="Sensitive")
      vt=Sensitive;
    else if (viewvol=="Electronics")
      vt=Electronics;
    else if (viewvol=="Support")
      vt=Support;
    else if (viewvol=="Absorber")
      vt=Absorber;
    else if (viewvol=="Cable")
      vt=Cable;
    else if (viewvol=="OtherServices")
      vt=OtherServices;
    else if (viewvol=="PseudoVolumes")
      vt=PseudoVolumes;
    else {
      vt=Undefined;
      G4cerr << "WARNING: Unknown type of visualisable object \"" << viewvol
       << "\"." << G4endl;
    }


    int isvisible, wireframe;
    double r, g, b;
    
    is >> isvisible >> r >> g >> b >> wireframe >> jump;

    r=checkColorRange(r,'R');
    g=checkColorRange(g,'G');
    b=checkColorRange(b,'B');

    if (vt!=Undefined) {
#ifdef debug
      G4cout << tab << viewvol << tab << isvisible << tab 
       << r << " " << g << " "<< b << tab
       << wireframe << G4endl;
#endif
      theParameters[vt]=visParameters(isvisible, r, g, b, wireframe);
    }

  }

  // Close the file
  G4cout << " ==> Closing file " << visFile << G4endl;
  is.close();

  return true;
}

Here is the call graph for this function:

Here is the caller graph for this function:

setColor()

void CCalVisualisable::setColor	(	visType	v,
		double	r,
		double	g,
		double	b
	)

Definition at line 62 of file CCalVisualisable.cc.

                                                                      {
  theParameters[v].rColor=r;
  theParameters[v].gColor=g;
  theParameters[v].bColor=b;
}

Here is the call graph for this function:

Here is the caller graph for this function:

setColorBlue()

void CCalVisualisable::setColorBlue ( visType  v, double  b  )

inline

Definition at line 88 of file CCalVisualisable.hh.

{theParameters[v].bColor=b;}

Here is the call graph for this function:

setColorGreen()

void CCalVisualisable::setColorGreen ( visType  v, double  g  )

inline

Definition at line 87 of file CCalVisualisable.hh.

{theParameters[v].gColor=g;}

Here is the call graph for this function:

setColorRed()

void CCalVisualisable::setColorRed ( visType  v, double  r  )

inline

Definition at line 86 of file CCalVisualisable.hh.

{theParameters[v].rColor=r;}

setDefault()

void CCalVisualisable::setDefault

(

)

Definition at line 53 of file CCalVisualisable.cc.

                                 {
  theParameters[Sensitive] = visParameters(true);
  theParameters[Electronics] = visParameters(false);
  theParameters[Support] = visParameters(false);
  theParameters[Cable] = visParameters(false);
  theParameters[OtherServices] = visParameters(false);
  theParameters[PseudoVolumes] = visParameters(false);
}

Here is the caller graph for this function:

setPath()

void CCalVisualisable::setPath ( )

staticprotected

Definition at line 68 of file CCalVisualisable.cc.

                               {
  pathName = getenv(visEnvName);
  if (!pathName) {
     G4ExceptionDescription ed;
     ed << "ERROR: " << visEnvName << " environmental variable not set!" 
    << G4endl;
     ed << "       Set it and restart." << G4endl;
     G4Exception("CCalVisualisable::setPath()","ccal007",
         FatalException,ed);
  }
}

Here is the call graph for this function:

Here is the caller graph for this function:

setVisible()

void CCalVisualisable::setVisible ( visType  v, bool  flag = true  )

inline

Definition at line 81 of file CCalVisualisable.hh.

{theParameters[v].visibility=flag;}

setWireFrame()

void CCalVisualisable::setWireFrame ( visType  v, bool  wf = true  )

inline

Definition at line 92 of file CCalVisualisable.hh.

{theParameters[v].wireframe=wf;}

Here is the call graph for this function:

Member Data Documentation

pathName

const char * CCalVisualisable::pathName =0

staticprivate

Definition at line 102 of file CCalVisualisable.hh.

theParameters

visParameters CCalVisualisable::theParameters[TotalVisTypes]

private

Definition at line 104 of file CCalVisualisable.hh.

visFile

G4String CCalVisualisable::visFile

private

Definition at line 103 of file CCalVisualisable.hh.

---

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

• CCalVisualisable.hh
• CCalVisualisable.cc