G4ModelingParameters Class Reference

#include <G4ModelingParameters.hh>

Classes
class	PVNameCopyNo
class	VisAttributesModifier

Public Types
enum	DrawingStyle { wf, hlr, hsr, hlhsr }
enum	VisAttributesSignifier {   VASVisibility, VASDaughtersInvisible, VASColour, VASLineStyle,   VASLineWidth, VASForceWireframe, VASForceSolid, VASForceAuxEdgeVisible,   VASForceLineSegmentsPerCircle }
typedef std::vector< PVNameCopyNo >	PVNameCopyNoPath
typedef PVNameCopyNoPath::const_iterator	PVNameCopyNoPathConstIterator

Public Member Functions
	G4ModelingParameters ()
	G4ModelingParameters (const G4VisAttributes *pDefaultVisAttributes, DrawingStyle drawingStyle, G4bool isCulling, G4bool isCullingInvisible, G4bool isDensityCulling, G4double visibleDensity, G4bool isCullingCovered, G4int noOfSides)
	~G4ModelingParameters ()
G4bool	operator!= (const G4ModelingParameters &) const
G4bool	IsWarning () const
const G4VisAttributes *	GetDefaultVisAttributes () const
DrawingStyle	GetDrawingStyle () const
G4bool	IsCulling () const
G4bool	IsCullingInvisible () const
G4bool	IsDensityCulling () const
G4double	GetVisibleDensity () const
G4bool	IsCullingCovered () const
G4bool	IsExplode () const
G4double	GetExplodeFactor () const
const G4Point3D &	GetExplodeCentre () const
G4int	GetNoOfSides () const
G4VSolid *	GetSectionSolid () const
G4VSolid *	GetCutawaySolid () const
const G4Event *	GetEvent () const
const std::vector < VisAttributesModifier > &	GetVisAttributesModifiers () const
void	SetWarning (G4bool)
void	SetDefaultVisAttributes (const G4VisAttributes *pDefaultVisAttributes)
void	SetDrawingStyle (DrawingStyle)
void	SetCulling (G4bool)
void	SetCullingInvisible (G4bool)
void	SetDensityCulling (G4bool)
void	SetVisibleDensity (G4double)
void	SetCullingCovered (G4bool)
void	SetExplodeFactor (G4double explodeFactor)
void	SetExplodeCentre (const G4Point3D &explodeCentre)
G4int	SetNoOfSides (G4int)
void	SetSectionSolid (G4VSolid *pSectionSolid)
void	SetCutawaySolid (G4VSolid *pCutawaySolid)
void	SetEvent (const G4Event *pEvent)
void	SetVisAttributesModifiers (const std::vector< VisAttributesModifier > &)

Friends
std::ostream &	operator<< (std::ostream &os, const G4ModelingParameters &)
std::ostream &	operator<< (std::ostream &os, const PVNameCopyNoPath &)
std::ostream &	operator<< (std::ostream &os, const std::vector< VisAttributesModifier > &)

Detailed Description

Definition at line 52 of file G4ModelingParameters.hh.

Member Typedef Documentation

typedef std::vector<PVNameCopyNo> G4ModelingParameters::PVNameCopyNoPath

Definition at line 91 of file G4ModelingParameters.hh.

typedef PVNameCopyNoPath::const_iterator G4ModelingParameters::PVNameCopyNoPathConstIterator

Definition at line 92 of file G4ModelingParameters.hh.

Member Enumeration Documentation

enum G4ModelingParameters::DrawingStyle

Enumerator
wf
hlr
hsr
hlhsr

Definition at line 57 of file G4ModelingParameters.hh.

                    {
    wf,         // Draw edges    - no hidden line removal (wireframe).
    hlr,        // Draw edges    - hidden lines removed.
    hsr,        // Draw surfaces - hidden surfaces removed.
    hlhsr       // Draw surfaces and edges - hidden removed.
  };

enum G4ModelingParameters::VisAttributesSignifier

Enumerator
VASVisibility
VASDaughtersInvisible
VASColour
VASLineStyle
VASLineWidth
VASForceWireframe
VASForceSolid
VASForceAuxEdgeVisible
VASForceLineSegmentsPerCircle

Definition at line 66 of file G4ModelingParameters.hh.

                              {
    VASVisibility,
    VASDaughtersInvisible,
    VASColour,
    VASLineStyle,
    VASLineWidth,
    VASForceWireframe,
    VASForceSolid,
    VASForceAuxEdgeVisible,
    VASForceLineSegmentsPerCircle
  };

Constructor & Destructor Documentation

G4ModelingParameters::G4ModelingParameters

(

)

Definition at line 43 of file G4ModelingParameters.cc.

                                           :
  fWarning               (true),
  fpDefaultVisAttributes (0),
  fDrawingStyle          (wf),
  fCulling               (false),
  fCullInvisible         (false),
  fDensityCulling        (false),
  fVisibleDensity        (0.01 * g / cm3),
  fCullCovered           (false),
  fExplodeFactor         (1.),
  fNoOfSides             (72),
  fpSectionSolid         (0),
  fpCutawaySolid         (0),
  fpEvent                (0)
{}

G4ModelingParameters::G4ModelingParameters	(	const G4VisAttributes *	pDefaultVisAttributes,
		G4ModelingParameters::DrawingStyle	drawingStyle,
		G4bool	isCulling,
		G4bool	isCullingInvisible,
		G4bool	isDensityCulling,
		G4double	visibleDensity,
		G4bool	isCullingCovered,
		G4int	noOfSides
	)

Definition at line 60 of file G4ModelingParameters.cc.

  :
  fWarning        (true),
  fpDefaultVisAttributes (pDefaultVisAttributes),
  fDrawingStyle   (drawingStyle),
  fCulling        (isCulling),
  fCullInvisible  (isCullingInvisible),
  fDensityCulling (isDensityCulling),
  fVisibleDensity (visibleDensity),
  fCullCovered    (isCullingCovered),
  fExplodeFactor  (1.),
  fNoOfSides      (noOfSides),
  fpSectionSolid  (0),
  fpCutawaySolid  (0),
  fpEvent         (0)
{}

G4ModelingParameters::~G4ModelingParameters

(

)

Definition at line 84 of file G4ModelingParameters.cc.

{
  delete fpSectionSolid;
  delete fpCutawaySolid;
}

Member Function Documentation

G4VSolid* G4ModelingParameters::GetCutawaySolid

(

)

const

const G4VisAttributes* G4ModelingParameters::GetDefaultVisAttributes

(

)

const

Here is the caller graph for this function:

DrawingStyle G4ModelingParameters::GetDrawingStyle

(

)

const

const G4Event* G4ModelingParameters::GetEvent

(

)

const

Here is the caller graph for this function:

const G4Point3D& G4ModelingParameters::GetExplodeCentre

(

)

const

G4double G4ModelingParameters::GetExplodeFactor

(

)

const

G4int G4ModelingParameters::GetNoOfSides

(

)

const

G4VSolid* G4ModelingParameters::GetSectionSolid

(

)

const

const std::vector<VisAttributesModifier>& G4ModelingParameters::GetVisAttributesModifiers

(

)

const

G4double G4ModelingParameters::GetVisibleDensity

(

)

const

G4bool G4ModelingParameters::IsCulling

(

)

const

G4bool G4ModelingParameters::IsCullingCovered

(

)

const

G4bool G4ModelingParameters::IsCullingInvisible

(

)

const

G4bool G4ModelingParameters::IsDensityCulling

(

)

const

G4bool G4ModelingParameters::IsExplode

(

)

const

G4bool G4ModelingParameters::IsWarning

(

)

const

G4bool G4ModelingParameters::operator!=

(

const G4ModelingParameters &

mp

)

const

Definition at line 225 of file G4ModelingParameters.cc.

                                       {

  if (
      (fWarning                != mp.fWarning)                ||
      (*fpDefaultVisAttributes != *mp.fpDefaultVisAttributes) ||
      (fCulling                != mp.fCulling)                ||
      (fCullInvisible          != mp.fCullInvisible)          ||
      (fDensityCulling         != mp.fDensityCulling)         ||
      (fCullCovered            != mp.fCullCovered)            ||
      (fExplodeFactor          != mp.fExplodeFactor)          ||
      (fExplodeCentre          != mp.fExplodeCentre)          ||
      (fNoOfSides              != mp.fNoOfSides)              ||
      (fpSectionSolid          != mp.fpSectionSolid)          ||
      (fpCutawaySolid          != mp.fpCutawaySolid)          ||
      (fpEvent                 != mp.fpEvent)
      )
    return true;

  if (fDensityCulling &&
      (fVisibleDensity != mp.fVisibleDensity)) return true;

  if (fVisAttributesModifiers != mp.fVisAttributesModifiers)
    return true;

  return false;
}

void G4ModelingParameters::SetCulling

(

G4bool

)

Here is the caller graph for this function:

void G4ModelingParameters::SetCullingCovered

(

G4bool

)

void G4ModelingParameters::SetCullingInvisible

(

G4bool

)

void G4ModelingParameters::SetCutawaySolid

(

G4VSolid *

pCutawaySolid

)

Definition at line 147 of file G4ModelingParameters.cc.

                          {
  delete fpCutawaySolid;
  fpCutawaySolid = pCutawaySolid;
}

Here is the caller graph for this function:

void G4ModelingParameters::SetDefaultVisAttributes

(

const G4VisAttributes *

pDefaultVisAttributes

)

Here is the caller graph for this function:

void G4ModelingParameters::SetDensityCulling

(

G4bool

)

void G4ModelingParameters::SetDrawingStyle

(

DrawingStyle

)

void G4ModelingParameters::SetEvent

(

const G4Event *

pEvent

)

Here is the caller graph for this function:

void G4ModelingParameters::SetExplodeCentre

(

const G4Point3D &

explodeCentre

)

Here is the caller graph for this function:

void G4ModelingParameters::SetExplodeFactor

(

G4double

explodeFactor

)

Here is the caller graph for this function:

G4int G4ModelingParameters::SetNoOfSides

(

G4int

nSides

)

Definition at line 127 of file G4ModelingParameters.cc.

                                                      {
  const G4int  nSidesMin = fpDefaultVisAttributes->GetMinLineSegmentsPerCircle();
  if (nSides < nSidesMin) {
    nSides = nSidesMin;
    if (fWarning)
      G4cout << "G4ModelingParameters::SetNoOfSides: attempt to set the"
    "\nnumber of sides per circle < " << nSidesMin
         << "; forced to" << nSides << G4endl;
  }
  fNoOfSides = nSides;
  return fNoOfSides;
}

Here is the call graph for this function:

void G4ModelingParameters::SetSectionSolid

(

G4VSolid *

pSectionSolid

)

Definition at line 141 of file G4ModelingParameters.cc.

                          {
  delete fpSectionSolid;
  fpSectionSolid = pSectionSolid;
}

Here is the caller graph for this function:

void G4ModelingParameters::SetVisAttributesModifiers

(

const std::vector< VisAttributesModifier > &

)

Here is the caller graph for this function:

void G4ModelingParameters::SetVisibleDensity

(

G4double

visibleDensity

)

Definition at line 110 of file G4ModelingParameters.cc.

                                                                     {
  const G4double reasonableMaximum = 10.0 * g / cm3;
  if (visibleDensity < 0 && fWarning) {
    G4cout << "G4ModelingParameters::SetVisibleDensity: attempt to set negative "
      "density - ignored." << G4endl;
  }
  else {
    if (fVisibleDensity > reasonableMaximum && fWarning) {
      G4cout << "G4ModelingParameters::SetVisibleDensity: density > "
       << reasonableMaximum
       << " g / cm3 - did you mean this?"
       << G4endl;
    }
    fVisibleDensity = visibleDensity;
  }
}

void G4ModelingParameters::SetWarning

(

G4bool

)

Here is the caller graph for this function:

Friends And Related Function Documentation

std::ostream& operator<< ( std::ostream &  os, const G4ModelingParameters &  mp  )

friend

Definition at line 152 of file G4ModelingParameters.cc.

{
  os << "Modeling parameters (warning ";
  if (mp.fWarning) os << "true";
  else os << "false";
  os << "):";

  const G4VisAttributes* va = mp.fpDefaultVisAttributes;
  os << "\n  Default vis. attributes: ";
  if (va) os << *va;
  else os << "none";

  os << "\n  Current requested drawing style: ";
  switch (mp.fDrawingStyle) {
  case G4ModelingParameters::wf:
    os << "wireframe"; break;
  case G4ModelingParameters::hlr:
    os << "hidden line removal (hlr)"; break;
  case G4ModelingParameters::hsr:
    os << "surface (hsr)"; break;
  case G4ModelingParameters::hlhsr:
    os << "surface and edges (hlhsr)"; break;
  default: os << "unrecognised"; break;
  }

  os << "\n  Culling: ";
  if (mp.fCulling) os << "on";
  else            os << "off";

  os << "\n  Culling invisible objects: ";
  if (mp.fCullInvisible) os << "on";
  else                  os << "off";

  os << "\n  Density culling: ";
  if (mp.fDensityCulling) {
    os << "on - invisible if density less than "
       << mp.fVisibleDensity / (1. * g / cm3) << " g cm^-3";
  }
  else os << "off";

  os << "\n  Culling daughters covered by opaque mothers: ";
  if (mp.fCullCovered) os << "on";
  else                os << "off";

  os << "\n  Explode factor: " << mp.fExplodeFactor
     << " about centre: " << mp.fExplodeCentre;

  os << "\n  No. of sides used in circle polygon approximation: "
     << mp.fNoOfSides;

  os << "\n  Section (DCUT) shape (G4VSolid) pointer: ";
  if (!mp.fpSectionSolid) os << "non-";
  os << "null";

  os << "\n  Cutaway (DCUT) shape (G4VSolid) pointer: ";
  if (!mp.fpCutawaySolid) os << "non-";
  os << "null";

  os << "\n  Event pointer: " << mp.fpEvent;

  os << "\n  Vis attributes modifiers: ";
  const std::vector<G4ModelingParameters::VisAttributesModifier>& vams =
  mp.fVisAttributesModifiers;
  if (vams.empty()) {
    os << "None";
  } else {
    os << vams;
  }

  return os;
}

std::ostream& operator<< ( std::ostream &  os, const PVNameCopyNoPath &  path  )

friend

Definition at line 314 of file G4ModelingParameters.cc.

{
  os << "Touchable path: physical-volume-name:copy-number pairs:\n  ";
  G4ModelingParameters::PVNameCopyNoPathConstIterator i;
  for (i = path.begin(); i != path.end(); ++i) {
    if (i != path.begin()) {
      os << ',';
    }
    os << i->GetName() << ':' << i->GetCopyNo();
  }
  return os;
}

std::ostream& operator<< ( std::ostream &  os, const std::vector< VisAttributesModifier > &  vams  )

friend

Definition at line 328 of file G4ModelingParameters.cc.

{
  std::vector<G4ModelingParameters::VisAttributesModifier>::const_iterator
  iModifier;
  for (iModifier = vams.begin();
       iModifier != vams.end();
       ++iModifier) {
    const G4ModelingParameters::PVNameCopyNoPath& vamPath =
    iModifier->GetPVNameCopyNoPath();
    os << '\n' << vamPath;
    const G4VisAttributes& vamVisAtts = iModifier->GetVisAttributes();
    const G4Colour& c = vamVisAtts.GetColour();
    switch (iModifier->GetVisAttributesSignifier()) {
      case G4ModelingParameters::VASVisibility:
        os << " visibility ";
        if (vamVisAtts.IsVisible()) {
          os << "true";
        } else {
          os << "false";
        }
        break;
      case G4ModelingParameters::VASDaughtersInvisible:
        os << " daughtersInvisible ";
        if (vamVisAtts.IsDaughtersInvisible()) {
          os << "true";
        } else {
          os << "false";
        }
        break;
      case G4ModelingParameters::VASColour:
        os << " colour " << c;
        break;
      case G4ModelingParameters::VASLineStyle:
        os << " lineStyle ";
        switch (vamVisAtts.GetLineStyle()) {
          case G4VisAttributes::unbroken:
            os << "unbroken";
            break;
          case G4VisAttributes::dashed:
            os << "dashed";
            break;
          case G4VisAttributes::dotted:
            os << "dotted";
        }
        break;
      case G4ModelingParameters::VASLineWidth:
        os << " lineWidth "
        << vamVisAtts.GetLineWidth();
        break;
      case G4ModelingParameters::VASForceWireframe:
        if (vamVisAtts.GetForcedDrawingStyle() == G4VisAttributes::wireframe) {
          os << " forceWireframe ";
          if (vamVisAtts.IsForceDrawingStyle()) {
            os << "true";
          } else {
            os << "false";
          }
        }
        break;
      case G4ModelingParameters::VASForceSolid:
        if (vamVisAtts.GetForcedDrawingStyle() == G4VisAttributes::solid) {
          os << " forceSolid ";
          if (vamVisAtts.IsForceDrawingStyle()) {
            os << "true";
          } else {
            os << "false";
          }
        }
        break;
      case G4ModelingParameters::VASForceAuxEdgeVisible:
        os << " forceAuxEdgeVisible: ";
        if (!vamVisAtts.IsForceDrawingStyle()) {
          os << "not ";
        }
        os << " forced";
        if (vamVisAtts.IsForceAuxEdgeVisible()) {
          os << ": ";
          if (vamVisAtts.IsForcedAuxEdgeVisible()) {
            os << "true";
          } else {
            os << "false";
          }
        }
        break;
      case G4ModelingParameters::VASForceLineSegmentsPerCircle:
        os << " lineSegmentsPerCircle "
        << vamVisAtts.GetForcedLineSegmentsPerCircle();
        break;
    }
  }

  return os;
}

---

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

• geant4.10.03.p01/source/visualization/modeling/include/G4ModelingParameters.hh
• geant4.10.03.p01/source/visualization/modeling/src/G4ModelingParameters.cc