G4SceneTreeItem Class Reference

#include <G4SceneTreeItem.hh>

Public Types
enum	Type {   unidentified , root , model , pvmodel ,   ghost , touchable }

Public Member Functions
	G4SceneTreeItem (Type type=unidentified)
	~G4SceneTreeItem ()=default
	G4SceneTreeItem (const G4SceneTreeItem &)=default
G4SceneTreeItem &	operator= (const G4SceneTreeItem &)=default
Type	GetType () const
const G4String &	GetTypeString () const
void	SetType (Type type)
const G4String &	GetPVPath () const
void	SetPVPath (const G4String &PVPath)
const G4String &	GetDescription () const
void	SetDescription (const G4String &description)
const G4String &	GetModelType () const
void	SetModelType (const G4String &modelType)
const G4String &	GetModelDescription () const
void	SetModelDescription (const G4String &modelDescription)
const std::map< G4String, G4AttDef > *	GetAttDefs () const
void	SetAttDefs (const std::map< G4String, G4AttDef > *pAttDefs)
std::vector< G4AttValue > *	GetAttValues () const
void	SetAttValues (std::vector< G4AttValue > *pAttValues)
const G4VisAttributes &	GetVisAttributes () const
G4VisAttributes &	AccessVisAttributes ()
void	SetVisAttributes (const G4VisAttributes &visAtts)
const std::list< G4SceneTreeItem > &	GetChildren () const
std::list< G4SceneTreeItem >::iterator	InsertChild (std::list< G4SceneTreeItem >::iterator pos, const G4SceneTreeItem &item)
std::list< G4SceneTreeItem > &	AccessChildren ()
G4bool	IsExpanded () const
void	SetExpanded (G4bool expanded)
void	ResetVisibility ()
G4bool	FindTouchableFromRoot (const G4String &fullPathString, std::list< G4SceneTreeItem >::iterator &foundIter)
void	DumpSingleItem (std::ostream &, G4int verbosity=0) const
void	DumpTree (std::ostream &, G4int verbosity=0) const

Detailed Description

Definition at line 40 of file G4SceneTreeItem.hh.

Member Enumeration Documentation

Type

enum G4SceneTreeItem::Type

Enumerator
unidentified
root
model
pvmodel
ghost
touchable

Definition at line 44 of file G4SceneTreeItem.hh.

    {
      unidentified,
      root,
      model,
      pvmodel,  // Physical Volume model - special case 
      ghost,
      touchable
    };

Constructor & Destructor Documentation

G4SceneTreeItem() [1/2]

G4SceneTreeItem::G4SceneTreeItem ( Type type = unidentified )

inlineexplicit

Definition at line 54 of file G4SceneTreeItem.hh.

{ fType = type; }

~G4SceneTreeItem()

G4SceneTreeItem::~G4SceneTreeItem ( )

default

G4SceneTreeItem() [2/2]

G4SceneTreeItem::G4SceneTreeItem ( const G4SceneTreeItem & )

default

Member Function Documentation

AccessChildren()

std::list< G4SceneTreeItem > & G4SceneTreeItem::AccessChildren ( )

inline

Definition at line 101 of file G4SceneTreeItem.hh.

{ return fChildren; }

AccessVisAttributes()

G4VisAttributes & G4SceneTreeItem::AccessVisAttributes ( )

inline

Definition at line 91 of file G4SceneTreeItem.hh.

{ return fVisAttributes; }

DumpSingleItem()

void G4SceneTreeItem::DumpSingleItem	(	std::ostream &	os,
		G4int	verbosity = 0 ) const

Definition at line 96 of file G4SceneTreeItem.cc.

{
  static G4bool first = true;
  if (first) {
    first = false;
    os << "  Verbosity actions:"
       << "\n  >=0 one line"
       << "\n  >=1 a few lines"
       << "\n  >=2 check G4Atts"
       << "\n  >=3 print G4Atts"
       << "\n  >=4 print some attValues"
       << '\n';
  }
 
  os << GetTypeString() << " (";
  G4String status;
  switch (fType) {
    case unidentified:
      status = "error";
      break;
    case root:
      status = "active";
      break;
    case model:
      [[fallthrough]];
    case pvmodel:
      status = (fVisAttributes.IsVisible() ? "active" : "inactive");
      break;
    case ghost:
      [[fallthrough]];
    case touchable:
      status = (fVisAttributes.IsVisible() ? "visible" : "invisible");
      break;
  }
  if (fExpanded) {
    status += ",expanded";
  } else {
    status += ",collapsed";
  }
  os << status << ')';
 
  G4String description;
  switch (fType) {
    case unidentified:
      break;
    case root:
      break;
    case model:
      [[fallthrough]];
    case pvmodel:
      description = " \"" + fModelDescription + '"';
      break;
    case ghost:
      [[fallthrough]];
    case touchable:
      description = " (" + fPVPath.substr(1, fPVPath.length() - 1) + ')';
      break;
  }
  os << description;
 
  if (fType == touchable) {
    os << ' ' << fVisAttributes.GetColour();
  }
 
  // clang-format off
  if (verbosity >= 1) {
    os << "\n  Description: " << GetDescription()
    << "\n  Model type: " << GetModelType()
    << "\n  Model description: " << GetModelDescription()
    << "\n  " << fChildren.size() << (fChildren.size()==1?" child":" children");
  }
  // clang-format on
 
  if (verbosity >= 2) {
    const auto& attDefs = GetAttDefs();
    const auto& attValues = GetAttValues();
    if (attDefs == nullptr || attValues == nullptr) {
      os << "\n  No G4Atts";  // Legitimate
    }
    else {
      G4AttCheck attCheck(attValues, attDefs);
      if (attCheck.Check("G4SceneTreeItem::Dump")) {
        G4ExceptionDescription ed;
        ed << "Item: " << attCheck;
        G4Exception("G4SceneTreeItem::Dump", "greps0010", JustWarning, ed,
                    "G4Atts don't check out");
        return;
      }
 
      if (verbosity >= 3) {
        os << "\n  G4Atts:\n" << attCheck;
        static G4bool first1 = true;
        if (first1) {
          first1 = false;
          os << "\n  Available G4Atts for touchable:";
          // clang-format off
          for (const auto& att: *GetAttDefs()) {
            os << "\n  " << att.first
            << ',' << att.second.GetName()
            << ',' << att.second.GetDesc()
            << ',' << att.second.GetCategory()
            << ',' << att.second.GetExtra()
            << ',' << att.second.GetValueType()
            << ',' << att.second.GetTypeKey();
          }
          // clang-format on
          os << '\n';
        }
      }
 
      if (verbosity >= 4) {
        for (G4String name : {"PVPath", "GlobalExtent"}) {
          G4String result;
          const auto& iterAttDef = attDefs->find(name);
          if (iterAttDef != attDefs->end()) {
            result = result + "\n  " + iterAttDef->second.GetName();
            result = result + ", " + iterAttDef->second.GetDesc();
          }
          const G4AttValue* pAttValue = nullptr;
          for (const auto& attValue : *attValues) {
            // Why are the attValues not in a map like the attDefs???
            if (attValue.GetName() == name) {
              pAttValue = &attValue;  // Avoid copy
              break;
            }
          }
          if (pAttValue) {
            result = result + ", " + pAttValue->GetValue();
          }
 
          os << result;
        }
      }
    }
  }
 
  os << std::endl;
}

Referenced by DumpTree(), and FindTouchableFromRoot().

DumpTree()

void G4SceneTreeItem::DumpTree	(	std::ostream &	os,
		G4int	verbosity = 0 ) const

Definition at line 236 of file G4SceneTreeItem.cc.

{
  static G4int depth = 0;
  for (G4int i = 0; i < depth; i++) os << "  ";
  DumpSingleItem(os, verbosity);
  for (auto& child : GetChildren()) {
    depth++;
    child.DumpTree(os, verbosity);
    depth--;
  }
}

FindTouchableFromRoot()

G4bool G4SceneTreeItem::FindTouchableFromRoot	(	const G4String &	fullPathString,
		std::list< G4SceneTreeItem >::iterator &	foundIter )

Definition at line 54 of file G4SceneTreeItem.cc.

{
  if (fType != root) {
    G4ExceptionDescription ed;
    ed << "Not a root item:\n";
    DumpSingleItem(ed);
    G4Exception("G4SceneTreeItem::FindTouchableFromRoot", "greps0011", JustWarning, ed);
    return false;
  }
 
  for (auto& aModel : fChildren) {
    if (aModel.fModelType == "G4PhysicalVolumeModel") {  // Top item, i.e., root of touchables
      // Work down the path - "name id", then "name id name id", etc.
      G4String partialPathString;
      auto iter = aModel.fChildren.begin();
      auto iterEnd = aModel.fChildren.end();
      std::istringstream iss(fullPathString);
      G4String name, copyNo;
      while (iss >> name >> copyNo) {
        partialPathString += ' ' + name + ' ' + copyNo;
        for (; iter != iterEnd; ++iter) {
          if (iter->fPVPath == partialPathString) {
            if (partialPathString != fullPathString) {
              // Go to next level
              iter = iter->fChildren.begin();
              iterEnd = iter->fChildren.end();
            }
            break;
          }
        }
        if (iter != iterEnd) {  // Found
          foundIter = iter;
          return true;
        }
      }
    }
  }
  return false;
}

Referenced by G4VViewer::TouchableSetColour(), and G4VViewer::TouchableSetVisibility().

GetAttDefs()

const std::map< G4String, G4AttDef > * G4SceneTreeItem::GetAttDefs ( ) const

inline

Definition at line 84 of file G4SceneTreeItem.hh.

{ return fpAttDefs; }

Referenced by DumpSingleItem().

GetAttValues()

std::vector< G4AttValue > * G4SceneTreeItem::GetAttValues ( ) const

inline

Definition at line 87 of file G4SceneTreeItem.hh.

{ return fpAttValues; }

Referenced by DumpSingleItem().

GetChildren()

const std::list< G4SceneTreeItem > & G4SceneTreeItem::GetChildren ( ) const

inline

Definition at line 94 of file G4SceneTreeItem.hh.

{ return fChildren; }

Referenced by DumpTree(), and G4UIQt::UpdateSceneTree().

GetDescription()

const G4String & G4SceneTreeItem::GetDescription ( ) const

inline

Definition at line 72 of file G4SceneTreeItem.hh.

{ return fDescription; }

Referenced by DumpSingleItem(), and G4UIQt::UpdateSceneTree().

GetModelDescription()

const G4String & G4SceneTreeItem::GetModelDescription ( ) const

inline

Definition at line 78 of file G4SceneTreeItem.hh.

{ return fModelDescription; }

Referenced by DumpSingleItem().

GetModelType()

const G4String & G4SceneTreeItem::GetModelType ( ) const

inline

Definition at line 75 of file G4SceneTreeItem.hh.

{ return fModelType; }

Referenced by DumpSingleItem().

GetPVPath()

const G4String & G4SceneTreeItem::GetPVPath ( ) const

inline

Definition at line 69 of file G4SceneTreeItem.hh.

{ return fPVPath; }

GetType()

Type G4SceneTreeItem::GetType ( ) const

inline

Definition at line 65 of file G4SceneTreeItem.hh.

{ return fType; }

GetTypeString()

const G4String & G4SceneTreeItem::GetTypeString ( ) const

inline

Definition at line 66 of file G4SceneTreeItem.hh.

{ return fTypeMap[fType]; }

Referenced by DumpSingleItem().

GetVisAttributes()

const G4VisAttributes & G4SceneTreeItem::GetVisAttributes ( ) const

inline

Definition at line 90 of file G4SceneTreeItem.hh.

{ return fVisAttributes; }

InsertChild()

std::list< G4SceneTreeItem >::iterator G4SceneTreeItem::InsertChild ( std::list< G4SceneTreeItem >::iterator pos, const G4SceneTreeItem & item )

inline

Definition at line 96 of file G4SceneTreeItem.hh.

    {
      return fChildren.insert(pos, item);
    }

IsExpanded()

G4bool G4SceneTreeItem::IsExpanded ( ) const

inline

Definition at line 103 of file G4SceneTreeItem.hh.

{ return fExpanded; }

operator=()

G4SceneTreeItem & G4SceneTreeItem::operator= ( const G4SceneTreeItem & )

default

ResetVisibility()

void G4SceneTreeItem::ResetVisibility

(

)

Definition at line 44 of file G4SceneTreeItem.cc.

{
  // Reset all but the root item, which is always visible (i.e., active)
  // Other items will be set visible if and when presented to the scene
  if (fType != root) fVisAttributes.SetVisibility(false);
  for (auto& child : fChildren)
    child.ResetVisibility();
}

Referenced by G4VSceneHandler::ProcessScene().

SetAttDefs()

void G4SceneTreeItem::SetAttDefs ( const std::map< G4String, G4AttDef > * pAttDefs )

inline

Definition at line 85 of file G4SceneTreeItem.hh.

{ fpAttDefs = pAttDefs; };

SetAttValues()

void G4SceneTreeItem::SetAttValues ( std::vector< G4AttValue > * pAttValues )

inline

Definition at line 88 of file G4SceneTreeItem.hh.

{ fpAttValues = pAttValues; }

SetDescription()

void G4SceneTreeItem::SetDescription ( const G4String & description )

inline

Definition at line 73 of file G4SceneTreeItem.hh.

{ fDescription = description; }

SetExpanded()

void G4SceneTreeItem::SetExpanded ( G4bool expanded )

inline

Definition at line 104 of file G4SceneTreeItem.hh.

{ fExpanded = expanded; }

SetModelDescription()

void G4SceneTreeItem::SetModelDescription ( const G4String & modelDescription )

inline

Definition at line 79 of file G4SceneTreeItem.hh.

    {
      fModelDescription = modelDescription;
    }

SetModelType()

void G4SceneTreeItem::SetModelType ( const G4String & modelType )

inline

Definition at line 76 of file G4SceneTreeItem.hh.

{ fModelType = modelType; }

SetPVPath()

void G4SceneTreeItem::SetPVPath ( const G4String & PVPath )

inline

Definition at line 70 of file G4SceneTreeItem.hh.

{ fPVPath = PVPath; }

SetType()

void G4SceneTreeItem::SetType ( Type type )

inline

Definition at line 67 of file G4SceneTreeItem.hh.

{ fType = type; }

Referenced by G4VViewer::G4VViewer().

SetVisAttributes()

void G4SceneTreeItem::SetVisAttributes ( const G4VisAttributes & visAtts )

inline

Definition at line 92 of file G4SceneTreeItem.hh.

{ fVisAttributes = visAtts; }

---

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

• G4SceneTreeItem.hh
• G4SceneTreeItem.cc