G4VisAttributes Class Reference

#include <G4VisAttributes.hh>

Public Types
enum	LineStyle { unbroken, dashed, dotted }
enum	ForcedDrawingStyle { wireframe, solid }

Public Member Functions
	G4VisAttributes ()
	G4VisAttributes (const G4VisAttributes &)
	G4VisAttributes (G4bool visibility)
	G4VisAttributes (const G4Colour &colour)
	G4VisAttributes (G4bool visibility, const G4Colour &colour)
	~G4VisAttributes ()
G4VisAttributes &	operator= (const G4VisAttributes &)
G4bool	operator!= (const G4VisAttributes &a) const
G4bool	operator== (const G4VisAttributes &a) const
void	SetVisibility (G4bool)
void	SetDaughtersInvisible (G4bool)
void	SetColour (const G4Colour &)
void	SetColor (const G4Color &)
void	SetColour (G4double red, G4double green, G4double blue, G4double alpha=1.)
void	SetColor (G4double red, G4double green, G4double blue, G4double alpha=1.)
void	SetLineStyle (LineStyle)
void	SetLineWidth (G4double)
void	SetForceWireframe (G4bool)
void	SetForceSolid (G4bool)
void	SetForceAuxEdgeVisible (G4bool)
void	SetForceLineSegmentsPerCircle (G4int nSegments)
void	SetStartTime (G4double)
void	SetEndTime (G4double)
void	SetAttValues (const std::vector< G4AttValue > *)
void	SetAttDefs (const std::map< G4String, G4AttDef > *)
G4bool	IsVisible () const
G4bool	IsDaughtersInvisible () const
const G4Colour &	GetColour () const
const G4Color &	GetColor () const
LineStyle	GetLineStyle () const
G4double	GetLineWidth () const
G4bool	IsForceDrawingStyle () const
ForcedDrawingStyle	GetForcedDrawingStyle () const
G4bool	IsForceAuxEdgeVisible () const
G4bool	IsForceLineSegmentsPerCircle () const
G4int	GetForcedLineSegmentsPerCircle () const
G4double	GetStartTime () const
G4double	GetEndTime () const
const std::vector< G4AttValue > *	CreateAttValues () const
const std::map< G4String, G4AttDef > *	GetAttDefs () const

Static Public Member Functions
static const G4VisAttributes &	GetInvisible ()

Static Public Attributes
static const G4VisAttributes	Invisible = G4VisAttributes (false)

Friends
std::ostream &	operator<< (std::ostream &os, const G4VisAttributes &a)

Detailed Description

Definition at line 65 of file G4VisAttributes.hh.

Member Enumeration Documentation

enum G4VisAttributes::ForcedDrawingStyle

Enumerator
wireframe
solid

Definition at line 72 of file G4VisAttributes.hh.

{wireframe, solid};

enum G4VisAttributes::LineStyle

Enumerator
unbroken
dashed
dotted

Definition at line 71 of file G4VisAttributes.hh.

{unbroken, dashed, dotted};

Constructor & Destructor Documentation

G4VisAttributes::G4VisAttributes

(

)

Definition at line 58 of file G4VisAttributes.cc.

                                 :
fVisible             (true),
fDaughtersInvisible  (false),
fColour              (G4Colour ()),
fLineStyle           (unbroken),
fLineWidth           (1.),
fForceDrawingStyle   (false),
fForcedStyle         (wireframe),
fForceAuxEdgeVisible (false),
fForcedLineSegmentsPerCircle (0),  // <=0 means not forced.
fStartTime           (-DBL_MAX),
fEndTime             (DBL_MAX),
fAttValues           (0),
fAttDefs             (0)
{}

G4VisAttributes::G4VisAttributes

(

const G4VisAttributes &

va

)

Definition at line 37 of file G4VisAttributes.cc.

                                                          :
fVisible             (va.fVisible),
fDaughtersInvisible  (va.fDaughtersInvisible),
fColour              (va.fColour),
fLineStyle           (va.fLineStyle),
fLineWidth           (va.fLineWidth),
fForceDrawingStyle   (va.fForceDrawingStyle),
fForcedStyle         (va.fForcedStyle),
fForceAuxEdgeVisible (va.fForceAuxEdgeVisible),
fForcedLineSegmentsPerCircle (va.fForcedLineSegmentsPerCircle),
fStartTime           (va.fStartTime),
fEndTime             (va.fEndTime),
// AttValues are created afresh for each object (using the
// CreateAttValues message), but deletion is the responsibility of
// the creator.  So just copy pointer.
fAttValues           (va.fAttValues),
// AttDefs, if any, belong to the object from which they were obtained
// (with a GetAttDefs message), so just copy pointer.
fAttDefs             (va.fAttDefs)
{}

G4VisAttributes::G4VisAttributes

(

G4bool

visibility

)

Definition at line 74 of file G4VisAttributes.cc.

                                                  :
fVisible             (visibility),
fDaughtersInvisible  (false),
fColour              (G4Colour ()),
fLineStyle           (unbroken),
fLineWidth           (1.),
fForceDrawingStyle   (false),
fForcedStyle         (wireframe),
fForceAuxEdgeVisible (false),
fForcedLineSegmentsPerCircle (0),  // <=0 means not forced.
fStartTime           (-DBL_MAX),
fEndTime             (DBL_MAX),
fAttValues           (0),
fAttDefs             (0)
{}

G4VisAttributes::G4VisAttributes

(

const G4Colour &

colour

)

Definition at line 90 of file G4VisAttributes.cc.

                                                       :
fVisible             (true),
fDaughtersInvisible  (false),
fColour              (colour),
fLineStyle           (unbroken),
fLineWidth           (1.),
fForceDrawingStyle   (false),
fForcedStyle         (wireframe),
fForceAuxEdgeVisible (false),
fForcedLineSegmentsPerCircle (0),  // <=0 means not forced.
fStartTime           (-DBL_MAX),
fEndTime             (DBL_MAX),
fAttValues           (0),
fAttDefs             (0)
{}

G4VisAttributes::G4VisAttributes	(	G4bool	visibility,
		const G4Colour &	colour
	)

Definition at line 106 of file G4VisAttributes.cc.

                                         :
fVisible             (visibility),
fDaughtersInvisible  (false),
fColour              (colour),
fLineStyle           (unbroken),
fLineWidth           (1.),
fForceDrawingStyle   (false),
fForcedStyle         (wireframe),
fForceAuxEdgeVisible (false),
fForcedLineSegmentsPerCircle (0),  // <=0 means not forced.
fStartTime           (-DBL_MAX),
fEndTime             (DBL_MAX),
fAttValues           (0),
fAttDefs             (0)
{}

G4VisAttributes::~G4VisAttributes

(

)

Definition at line 123 of file G4VisAttributes.cc.

{
}

Member Function Documentation

const std::vector< G4AttValue > * G4VisAttributes::CreateAttValues

(

)

const

Definition at line 153 of file G4VisAttributes.cc.

Referenced by G4VSceneHandler::LoadAtts(), and G4XXXStoredSceneHandler::PreAddSolid().

                                                                     {
  // Create an expendable copy on the heap...
  return new std::vector<G4AttValue>(*fAttValues);
}

const std::map<G4String,G4AttDef>* G4VisAttributes::GetAttDefs

(

)

const

Referenced by G4VSceneHandler::LoadAtts(), and G4XXXStoredSceneHandler::PreAddSolid().

const G4Color& G4VisAttributes::GetColor

(

)

const

Referenced by G4GMocrenFileSceneHandler::AddPrimitive(), G03ColorWriter::ColorWrite(), and export_G4VisAttributes().

const G4Colour& G4VisAttributes::GetColour

(

)

const

Referenced by G4TheRayTracer::Attenuate(), G4XXXSGViewer::CompareForKernelVisit(), G4XXXStoredViewer::CompareForKernelVisit(), G4PhysicalVolumeModel::DescribeAndDescend(), export_G4VisAttributes(), G4TheRayTracer::GetSurfaceColour(), operator<<(), G4VisCommandsViewerSet::SetNewValue(), G4ViewParameters::TouchableCommands(), and G4RTSteppingAction::UserSteppingAction().

G4double G4VisAttributes::GetEndTime

(

)

const

ForcedDrawingStyle G4VisAttributes::GetForcedDrawingStyle

(

)

const

Referenced by G4PhysicalVolumeModel::DescribeAndDescend(), export_G4VisAttributes(), operator<<(), G4ViewParameters::TouchableCommands(), G4RTSteppingAction::UserSteppingAction(), and G4TheRayTracer::ValidColour().

G4int G4VisAttributes::GetForcedLineSegmentsPerCircle

(

)

const

Referenced by G4PhysicalVolumeModel::DescribeAndDescend(), G4PhysicalVolumeModel::DescribeSolid(), G4VSceneHandler::GetNoOfSides(), operator<<(), and G4ViewParameters::TouchableCommands().

static const G4VisAttributes& G4VisAttributes::GetInvisible ( )

static

Referenced by RE05DetectorConstruction::Construct(), and export_G4VisAttributes().

LineStyle G4VisAttributes::GetLineStyle

(

)

const

Referenced by G4PhysicalVolumeModel::DescribeAndDescend(), export_G4VisAttributes(), operator<<(), and G4ViewParameters::TouchableCommands().

G4double G4VisAttributes::GetLineWidth

(

)

const

Referenced by G4PhysicalVolumeModel::DescribeAndDescend(), export_G4VisAttributes(), G4VSceneHandler::GetLineWidth(), operator<<(), and G4ViewParameters::TouchableCommands().

G4double G4VisAttributes::GetStartTime

(

)

const

G4bool G4VisAttributes::IsDaughtersInvisible

(

)

const

Referenced by G4PhysicalVolumeModel::DescribeAndDescend(), export_G4VisAttributes(), operator<<(), and G4ViewParameters::TouchableCommands().

G4bool G4VisAttributes::IsForceAuxEdgeVisible

(

)

const

Referenced by G4PhysicalVolumeModel::DescribeAndDescend(), export_G4VisAttributes(), operator<<(), and G4ViewParameters::TouchableCommands().

G4bool G4VisAttributes::IsForceDrawingStyle

(

)

const

Referenced by G4PhysicalVolumeModel::DescribeAndDescend(), export_G4VisAttributes(), operator<<(), G4ViewParameters::TouchableCommands(), G4RTSteppingAction::UserSteppingAction(), and G4TheRayTracer::ValidColour().

G4bool G4VisAttributes::IsForceLineSegmentsPerCircle

(

)

const

Referenced by G4PhysicalVolumeModel::DescribeSolid(), and G4VSceneHandler::GetNoOfSides().

G4bool G4VisAttributes::IsVisible

(

)

const

Referenced by G4HepRepFileSceneHandler::AddPrimitive(), G4HepRepFileSceneHandler::AddSolid(), G4PhysicalVolumeModel::DescribeAndDescend(), export_G4VisAttributes(), operator<<(), G4ViewParameters::TouchableCommands(), G4RTSteppingAction::UserSteppingAction(), and G4TheRayTracer::ValidColour().

G4bool G4VisAttributes::operator!=

(

const G4VisAttributes &

a

)

const

Definition at line 229 of file G4VisAttributes.cc.

Referenced by operator==().

                                                                   {

  if (
      (fVisible            != a.fVisible)            ||
      (fDaughtersInvisible != a.fDaughtersInvisible) ||
      (fColour             != a.fColour)             ||
      (fLineStyle          != a.fLineStyle)          ||
      (fLineWidth          != a.fLineWidth)          ||
      (fForceDrawingStyle  != a.fForceDrawingStyle)  ||
      (fForceAuxEdgeVisible!= a.fForceAuxEdgeVisible)||
      (fForcedLineSegmentsPerCircle != a.fForcedLineSegmentsPerCircle) ||
      (fStartTime          != a.fStartTime)          ||
      (fEndTime            != a.fEndTime)            ||
      (fAttValues          != a.fAttValues)          ||
      (fAttDefs            != a.fAttDefs)
      )
    return true;

  if (fForceDrawingStyle) {
    if (fForcedStyle != a.fForcedStyle) return true;
  }

  return false;
}

G4VisAttributes & G4VisAttributes::operator=

(

const G4VisAttributes &

rhs

)

Definition at line 127 of file G4VisAttributes.cc.

{
  if (&rhs == this) return *this;
  fVisible             = rhs.fVisible;
  fDaughtersInvisible  = rhs.fDaughtersInvisible;
  fColour              = rhs.fColour;
  fLineStyle           = rhs.fLineStyle;
  fLineWidth           = rhs.fLineWidth;
  fForceDrawingStyle   = rhs.fForceDrawingStyle;
  fForcedStyle         = rhs.fForcedStyle;
  fForceAuxEdgeVisible = rhs.fForceAuxEdgeVisible;
  fForcedLineSegmentsPerCircle = rhs.fForcedLineSegmentsPerCircle;
  fStartTime           = rhs.fStartTime;
  fEndTime             = rhs.fEndTime;
  // AttValues are created afresh for each object (using the
  // CreateAttValues message), but deletion is the responsibility of
  // the creator.  So just copy pointer.
  fAttValues           = rhs.fAttValues;
  // AttDefs, if any, belong to the object from which they were obtained
  // (with a GetAttDefs message), so just copy pointer.
  fAttDefs             = rhs.fAttDefs;
  return *this;
}

G4bool G4VisAttributes::operator==

(

const G4VisAttributes &

a

)

const

Definition at line 254 of file G4VisAttributes.cc.

References operator!=().

                                                                   {
  return !(G4VisAttributes::operator != (a));
}

void G4VisAttributes::SetAttDefs

(

const std::map< G4String, G4AttDef > *

)

Referenced by export_G4VisAttributes().

void G4VisAttributes::SetAttValues

(

const std::vector< G4AttValue > *

)

Referenced by export_G4VisAttributes().

void G4VisAttributes::SetColor

(

const G4Color &

)

Referenced by eRositaDetectorConstruction::Construct().

void G4VisAttributes::SetColor	(	G4double	red,
		G4double	green,
		G4double	blue,
		G4double	alpha = 1.
	)

void G4VisAttributes::SetColour

(

const G4Colour &

)

Referenced by CellParameterisation::CellParameterisation(), G4tgbVolume::ConstructG4LogVol(), G4PhysicalVolumeModel::DescribeAndDescend(), G4PhysicalVolumeModel::DescribeSolid(), G4ScoringCylinder::Draw(), G4ScoringBox::Draw(), ExN04CalorimeterHit::Draw(), RE01CalorimeterHit::Draw(), RE05CalorimeterHit::Draw(), ExGflashHit::Draw(), Par01CalorimeterHit::Draw(), G4ScoringCylinder::DrawColumn(), G4ScoringBox::DrawColumn(), G4ArrowModel::G4ArrowModel(), G4DrawVoxels::G4DrawVoxels(), G4VisCommandsTouchableSet::SetNewValue(), and G4VisCommandsViewerSet::SetNewValue().

void G4VisAttributes::SetColour	(	G4double	red,
		G4double	green,
		G4double	blue,
		G4double	alpha = 1.
	)

void G4VisAttributes::SetDaughtersInvisible

(

G4bool

)

Referenced by G4PhysicalVolumeModel::DescribeAndDescend(), export_G4VisAttributes(), F04ElementField::GetVisAttribute(), and G4VisCommandsTouchableSet::SetNewValue().

void G4VisAttributes::SetEndTime

(

G4double

)

Referenced by XAluminumElectrodeHit::Draw().

void G4VisAttributes::SetForceAuxEdgeVisible

(

G4bool

)

Referenced by G4PhysicalVolumeModel::DescribeAndDescend(), G4ScoringCylinder::Draw(), G4ScoringBox::Draw(), G4ScoringCylinder::DrawColumn(), G4ScoringBox::DrawColumn(), export_G4VisAttributes(), and G4VisCommandsTouchableSet::SetNewValue().

void G4VisAttributes::SetForceLineSegmentsPerCircle

(

G4int

nSegments

)

Definition at line 158 of file G4VisAttributes.cc.

References G4cout, and G4endl.

Referenced by G4PhysicalVolumeModel::DescribeAndDescend(), and G4VisCommandsTouchableSet::SetNewValue().

                                                                    {
  const G4int nSegmentsMin = 12;
  if (nSegments > 0 && nSegments < nSegmentsMin) {
    nSegments = nSegmentsMin;
    G4cout <<
      "G4VisAttributes::SetForcedLineSegmentsPerCircle: attempt to set the"
      "\nnumber of line segements per circle < " << nSegmentsMin
         << "; forced to " << nSegments << G4endl;
  }
  fForcedLineSegmentsPerCircle = nSegments;
}

void G4VisAttributes::SetForceSolid

(

G4bool

)

Referenced by G4MIRDLiver::Construct(), B03DetectorConstruction::Construct(), G4MIRDLeftLeg::Construct(), G4MIRDLeftLegBone::Construct(), G4MIRDRightClavicle::Construct(), G4MIRDRightKidney::Construct(), G4MIRDRightLeg::Construct(), G4MIRDRightLegBone::Construct(), G4MIRDLeftOvary::Construct(), G4MIRDRightScapula::Construct(), G4MIRDLeftAdrenal::Construct(), G4MIRDLeftTeste::Construct(), G4MIRDSkull::Construct(), G4MIRDSmallIntestine::Construct(), G4MIRDLeftScapula::Construct(), G4MIRDThyroid::Construct(), G4MIRDLowerLargeIntestine::Construct(), G4MIRDUpperLargeIntestine::Construct(), G4MIRDLeftClavicle::Construct(), G4MIRDMaleGenitalia::Construct(), G4MIRDPelvis::Construct(), G4MIRDLeftKidney::Construct(), G4MIRDRightAdrenal::Construct(), G4MIRDRightLung::Construct(), G4MIRDRightOvary::Construct(), G4MIRDLeftLung::Construct(), G4MIRDRightTeste::Construct(), G4MIRDBrain::Construct(), G4MIRDSpleen::Construct(), G4MIRDStomach::Construct(), G4MIRDThymus::Construct(), G4MIRDHeart::Construct(), G4MIRDTrunk::Construct(), G4MIRDRightBreast::Construct(), G4MIRDMiddleLowerSpine::Construct(), G4MIRDUpperSpine::Construct(), G4MIRDUterus::Construct(), G4MIRDPancreas::Construct(), G4MIRDRibCage::Construct(), G4MIRDLeftBreast::Construct(), B02DetectorConstruction::Construct(), G4MIRDHead::Construct(), G4MIRDRightArmBone::Construct(), G4MIRDUrinaryBladder::Construct(), G4MIRDLeftArmBone::Construct(), B01DetectorConstruction::Construct(), DMXDetectorConstruction::Construct(), CML2PhaseSpaces::createPlane(), G4PhysicalVolumeModel::DescribeAndDescend(), G4ScoringCylinder::Draw(), G4ScoringBox::Draw(), ExN04CalorimeterHit::Draw(), RE01CalorimeterHit::Draw(), RE05CalorimeterHit::Draw(), ExGflashHit::Draw(), Par01CalorimeterHit::Draw(), LXePMTHit::Draw(), G4ScoringCylinder::DrawColumn(), G4ScoringBox::DrawColumn(), export_G4VisAttributes(), G4ArrowModel::G4ArrowModel(), G4VisCommandsTouchableSet::SetNewValue(), and G4VisCommandSceneAddLogo::SetNewValue().

void G4VisAttributes::SetForceWireframe

(

G4bool

)

Referenced by Par01DetectorConstruction::Construct(), ExN04DetectorConstruction::Construct(), RE01DetectorConstruction::Construct(), RE05DetectorConstruction::Construct(), UltraDetectorConstruction::Construct(), G4PhysicalVolumeModel::DescribeAndDescend(), G4LogicalVolumeModel::DescribeSolid(), ExN04CalorimeterHit::Draw(), RE01CalorimeterHit::Draw(), Par01CalorimeterHit::Draw(), ExGflashHit::Draw(), export_G4VisAttributes(), G4VisCommandsTouchableSet::SetNewValue(), and CCalG4Able::setVisType().

void G4VisAttributes::SetLineStyle

(

LineStyle

)

Referenced by G4PhysicalVolumeModel::DescribeAndDescend(), export_G4VisAttributes(), and G4VisCommandsTouchableSet::SetNewValue().

void G4VisAttributes::SetLineWidth

(

G4double

)

Referenced by G4MIRDSkull::Construct(), G4MIRDBrain::Construct(), CML2Ph_BoxInBox::Construct(), G4PhysicalVolumeModel::DescribeAndDescend(), export_G4VisAttributes(), and G4VisCommandsTouchableSet::SetNewValue().

void G4VisAttributes::SetStartTime

(

G4double

)

Referenced by XAluminumElectrodeHit::Draw().

void G4VisAttributes::SetVisibility

(

G4bool

)

Referenced by eRositaDetectorConstruction::Construct(), B5DetectorConstruction::Construct(), CML2PhantomConstruction::Construct(), CML2AcceleratorConstruction::Construct(), CML2Ph_FullWater::Construct(), DMXDetectorConstruction::Construct(), UltraDetectorConstruction::Construct(), CML2Ph_BoxInBox::Construct(), G4tgbVolume::ConstructG4LogVol(), CML2WorldConstruction::create(), CML2PhaseSpaces::createPlane(), G4PhysicalVolumeModel::DescribeAndDescend(), export_G4VisAttributes(), G4VisCommandsTouchableSet::SetNewValue(), and CCalG4Able::setVisType().

Friends And Related Function Documentation

std::ostream& operator<< ( std::ostream &  os, const G4VisAttributes &  a  )

friend

Definition at line 170 of file G4VisAttributes.cc.

                                                                   {
  
  os << "G4VisAttributes: ";
  if (&a){
    if (!a.fVisible) os << "in";
    os << "visible, daughters ";
    if (a.fDaughtersInvisible) os << "in";
    os << "visible, colour: " << a.fColour;
    os << "\n  linestyle: ";
    switch (a.fLineStyle) {
    case G4VisAttributes::unbroken:
      os << "solid"; break;
    case G4VisAttributes::dashed:
      os << "dashed"; break;
    case G4VisAttributes::dotted: os << "dotted"; break;
    default: os << "unrecognised"; break;
    }
    os << ", line width: " << a.fLineWidth;
    os << "\n  drawing style: ";
    if (a.fForceDrawingStyle) {
      os << "forced to: ";
      switch (a.fForcedStyle) {
      case G4VisAttributes::wireframe:
    os << "wireframe"; break;
      case G4VisAttributes::solid:
    os << "solid"; break;
      default: os << "unrecognised"; break;
      }
    }
    else {
      os << "not forced";
    }
    os << ", auxiliary edge visibility: ";
    if (!a.fForceAuxEdgeVisible) {
      os << "not ";
    }
    os << "forced";
    os << "\n  line segments per circle: ";
    if (a.fForcedLineSegmentsPerCircle > 0) {
      os << "forced to " << a.fForcedLineSegmentsPerCircle;
    } else {
      os << "not forced.";
    }
    os << "\n  time range: (" << a.fStartTime << ',' << a.fEndTime << ')';
    os << "\n  G4AttValue pointer is ";
    if (a.fAttValues) {
      os << "non-";
    }
    os << "zero";      
    os << ", G4AttDef pointer is ";
    if (a.fAttDefs) {
      os << "non-";
    }
    os << "zero";      
  } 
  else os << " zero G4VisAttributes pointer";
  return os;
}

Field Documentation

const G4VisAttributes G4VisAttributes::Invisible = G4VisAttributes (false)

static

Definition at line 82 of file G4VisAttributes.hh.

Referenced by HadrontherapyModulator::BuildModulator(), Par01DetectorConstruction::Construct(), exGPSGeometryConstruction::Construct(), G4MIRDRibCage::Construct(), B3DetectorConstruction::Construct(), ExGflashDetectorConstruction::Construct(), FCALCryostatVolumes::Construct(), FCALEMModule::Construct(), exrdmDetectorConstruction::Construct(), FCALTestbeamSetup::Construct(), XrayTelDetectorConstruction::Construct(), UltraDetectorConstruction::Construct(), DMXDetectorConstruction::Construct(), RE02DetectorConstruction::Construct(), BrachyDetectorConstruction::ConstructPhantom(), export_G4VisAttributes(), G4BuildGeom(), F04ElementField::GetVisAttribute(), and G4GDMLReadStructure::GetWorldVolume().

---

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

• G4VisAttributes.hh
• G4VisAttributes.cc