G4VisAttributes Class Reference

#include <G4VisAttributes.hh>

Collaboration diagram for G4VisAttributes:

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

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 G4int	GetMinLineSegmentsPerCircle ()

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

Private Attributes
G4bool	fVisible
G4bool	fDaughtersInvisible
G4Colour	fColour
LineStyle	fLineStyle
G4double	fLineWidth
G4bool	fForceDrawingStyle
ForcedDrawingStyle	fForcedStyle
G4bool	fForceAuxEdgeVisible
G4int	fForcedLineSegmentsPerCircle
G4double	fStartTime
G4double	fEndTime
const std::vector< G4AttValue > *	fAttValues
const std::map< G4String, G4AttDef > *	fAttDefs

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

Detailed Description

Definition at line 65 of file G4VisAttributes.hh.

Member Enumeration Documentation

anonymous enum

anonymous enum

Enumerator
fMinLineSegmentsPerCircle

Definition at line 73 of file G4VisAttributes.hh.

{fMinLineSegmentsPerCircle = 3};   // number of sides per circle

ForcedDrawingStyle

enum G4VisAttributes::ForcedDrawingStyle

Enumerator
wireframe
solid

Definition at line 72 of file G4VisAttributes.hh.

{wireframe, solid};

LineStyle

enum G4VisAttributes::LineStyle

Enumerator
unbroken
dashed
dotted

Definition at line 71 of file G4VisAttributes.hh.

{unbroken, dashed, dotted};

Constructor & Destructor Documentation

G4VisAttributes() [1/5]

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)
{}

Here is the caller graph for this function:

G4VisAttributes() [2/5]

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() [3/5]

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() [4/5]

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() [5/5]

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::~G4VisAttributes

(

)

Definition at line 123 of file G4VisAttributes.cc.

{
}

Member Function Documentation

CreateAttValues()

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

(

)

const

Definition at line 159 of file G4VisAttributes.cc.

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

Here is the caller graph for this function:

GetAttDefs()

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

(

)

const

Here is the caller graph for this function:

GetColor()

const G4Color& G4VisAttributes::GetColor

(

)

const

Here is the caller graph for this function:

GetColour()

const G4Colour& G4VisAttributes::GetColour

(

)

const

Here is the caller graph for this function:

GetEndTime()

G4double G4VisAttributes::GetEndTime

(

)

const

GetForcedDrawingStyle()

ForcedDrawingStyle G4VisAttributes::GetForcedDrawingStyle

(

)

const

Here is the caller graph for this function:

GetForcedLineSegmentsPerCircle()

G4int G4VisAttributes::GetForcedLineSegmentsPerCircle

(

)

const

Here is the caller graph for this function:

GetInvisible()

const G4VisAttributes & G4VisAttributes::GetInvisible ( )

static

Definition at line 154 of file G4VisAttributes.cc.

                                                     {
  static const G4VisAttributes invisible = G4VisAttributes(false);
  return invisible;
}

Here is the call graph for this function:

Here is the caller graph for this function:

GetLineStyle()

LineStyle G4VisAttributes::GetLineStyle

(

)

const

Here is the caller graph for this function:

GetLineWidth()

G4double G4VisAttributes::GetLineWidth

(

)

const

Here is the caller graph for this function:

GetMinLineSegmentsPerCircle()

static G4int G4VisAttributes::GetMinLineSegmentsPerCircle ( )

inlinestatic

Definition at line 131 of file G4VisAttributes.hh.

                                                    {
    return fMinLineSegmentsPerCircle;
  };

Here is the call graph for this function:

Here is the caller graph for this function:

GetStartTime()

G4double G4VisAttributes::GetStartTime

(

)

const

IsDaughtersInvisible()

G4bool G4VisAttributes::IsDaughtersInvisible

(

)

const

Here is the caller graph for this function:

IsForceAuxEdgeVisible()

G4bool G4VisAttributes::IsForceAuxEdgeVisible

(

)

const

Here is the caller graph for this function:

IsForceDrawingStyle()

G4bool G4VisAttributes::IsForceDrawingStyle

(

)

const

Here is the caller graph for this function:

IsForceLineSegmentsPerCircle()

G4bool G4VisAttributes::IsForceLineSegmentsPerCircle

(

)

const

Here is the caller graph for this function:

IsVisible()

G4bool G4VisAttributes::IsVisible

(

)

const

Here is the caller graph for this function:

operator!=()

G4bool G4VisAttributes::operator!=

(

const G4VisAttributes &

a

)

const

Definition at line 233 of file G4VisAttributes.cc.

                                                                   {

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

Here is the caller graph for this function:

operator=()

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

Here is the call graph for this function:

operator==()

G4bool G4VisAttributes::operator==

(

const G4VisAttributes &

a

)

const

Definition at line 258 of file G4VisAttributes.cc.

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

Here is the call graph for this function:

SetAttDefs()

void G4VisAttributes::SetAttDefs

(

const std::map< G4String, G4AttDef > *

)

Here is the caller graph for this function:

SetAttValues()

void G4VisAttributes::SetAttValues

(

const std::vector< G4AttValue > *

)

Here is the caller graph for this function:

SetColor() [1/2]

void G4VisAttributes::SetColor

(

const G4Color &

)

Here is the caller graph for this function:

SetColor() [2/2]

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

SetColour() [1/2]

void G4VisAttributes::SetColour

(

const G4Colour &

)

Here is the caller graph for this function:

SetColour() [2/2]

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

SetDaughtersInvisible()

void G4VisAttributes::SetDaughtersInvisible

(

G4bool

)

Here is the caller graph for this function:

SetEndTime()

void G4VisAttributes::SetEndTime

(

G4double

)

Here is the caller graph for this function:

SetForceAuxEdgeVisible()

void G4VisAttributes::SetForceAuxEdgeVisible

(

G4bool

)

Here is the caller graph for this function:

SetForceLineSegmentsPerCircle()

void G4VisAttributes::SetForceLineSegmentsPerCircle

(

G4int

nSegments

)

Definition at line 164 of file G4VisAttributes.cc.

                                                                    {
  const G4int nSegmentsMin = fMinLineSegmentsPerCircle;
  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;
}

Here is the caller graph for this function:

SetForceSolid()

void G4VisAttributes::SetForceSolid

(

G4bool

)

SetForceWireframe()

void G4VisAttributes::SetForceWireframe

(

G4bool

)

Here is the caller graph for this function:

SetLineStyle()

void G4VisAttributes::SetLineStyle

(

LineStyle

)

Here is the caller graph for this function:

SetLineWidth()

void G4VisAttributes::SetLineWidth

(

G4double

)

Here is the caller graph for this function:

SetStartTime()

void G4VisAttributes::SetStartTime

(

G4double

)

Here is the caller graph for this function:

SetVisibility()

void G4VisAttributes::SetVisibility

(

G4bool

)

Friends And Related Function Documentation

operator<<

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

friend

Definition at line 176 of file G4VisAttributes.cc.

{
  os << "G4VisAttributes: ";
  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 << ", min line segments per circle: " << a.GetMinLineSegmentsPerCircle();
  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";
  return os;
}

Member Data Documentation

fAttDefs

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

private

Definition at line 154 of file G4VisAttributes.hh.

fAttValues

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

private

Definition at line 153 of file G4VisAttributes.hh.

fColour

G4Colour G4VisAttributes::fColour

private

Definition at line 143 of file G4VisAttributes.hh.

fDaughtersInvisible

G4bool G4VisAttributes::fDaughtersInvisible

private

Definition at line 142 of file G4VisAttributes.hh.

fEndTime

G4double G4VisAttributes::fEndTime

private

Definition at line 152 of file G4VisAttributes.hh.

fForceAuxEdgeVisible

G4bool G4VisAttributes::fForceAuxEdgeVisible

private

Definition at line 149 of file G4VisAttributes.hh.

fForcedLineSegmentsPerCircle

G4int G4VisAttributes::fForcedLineSegmentsPerCircle

private

Definition at line 150 of file G4VisAttributes.hh.

fForceDrawingStyle

G4bool G4VisAttributes::fForceDrawingStyle

private

Definition at line 147 of file G4VisAttributes.hh.

fForcedStyle

ForcedDrawingStyle G4VisAttributes::fForcedStyle

private

Definition at line 148 of file G4VisAttributes.hh.

fLineStyle

LineStyle G4VisAttributes::fLineStyle

private

Definition at line 144 of file G4VisAttributes.hh.

fLineWidth

G4double G4VisAttributes::fLineWidth

private

Definition at line 145 of file G4VisAttributes.hh.

fStartTime

G4double G4VisAttributes::fStartTime

private

Definition at line 152 of file G4VisAttributes.hh.

fVisible

G4bool G4VisAttributes::fVisible

private

Definition at line 141 of file G4VisAttributes.hh.

Invisible

const G4VisAttributes G4VisAttributes::Invisible = G4VisAttributes (false)

static

Definition at line 88 of file G4VisAttributes.hh.

---

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

• G4VisAttributes.hh
• G4VisAttributes.cc