VertexHandle Class Reference

#include <VertexHandle.h>

Inheritance diagram for VertexHandle:

Collaboration diagram for VertexHandle:

Classes
class	Imp

Public Member Functions
	VertexHandle (VertexCollHandle *, const xAOD::Vertex *vertex)
virtual	~VertexHandle ()
virtual bool	has3DObjects ()
	Returns true if the 3D objects have been created.
virtual SoNode *	nodes ()
	Returns the 3Dobjects.
SoMaterial *	determineMaterial ()
	Should be implemented by children, in order to change the material depending on the interface etc.
void	updateMaterial ()
	Called after some configuration related to material changes.
virtual void	clear3DObjects ()
	Delete objects.
QStringList	baseInfo () const
virtual QStringList	clicked () const
	Called when user selects the node (stringlist is displayed in messagebox).
virtual QString	shortInfo () const
	returns position & type information about vertex
virtual QString	type () const
	return very short word with type (maybe link with collection type?)
QString	vertexType () const
double	getPositionX () const
double	getPositionY () const
double	getPositionZ () const
const AODSysCommonData *	common () const
void	setVisible (bool)
	use by the collection handle.
bool	visible () const
const AODCollHandleBase *	collHandle () const
virtual void	update3DObjects ()
	Called after some configuration changes, or when the object is first created. Must be overloaded by children.
virtual void	rebuild3DObjects ()
virtual void	attach3DObjects ()
	Connect to the scene graph.
virtual void	detach3DObjects ()
	Remove from the scene graph.
SoMaterial *	currentMaterial () const
	Returns the current material of the handle.
virtual void	fillObjectBrowser (QList< QTreeWidgetItem * > &list)
	Create and fill the object browser QTreeWidgetItem.
void	updateObjectBrowser ()
	Update object browser QTreeWidgetItem.
QTreeWidgetItem *	browserTreeItem () const
	Return the QTreeWidgetItem;.
virtual void	dumpToJSON (std::ofstream &) const

Static Public Member Functions
static int	numberOfInstances ()
static double	unknown ()

Protected Member Functions
virtual void	visibleStateChanged ()
	Dummy implementation does nothing.
virtual void	currentMaterialChanged ()

Private Member Functions
	VertexHandle (const VertexHandle &)
VertexHandle &	operator= (const VertexHandle &)

Private Attributes
Imp *	m_d
bool	m_visible
AODCollHandleBase *	m_collhandle
SoMaterial *	m_currentmaterial

Friends
class	AssocObjAttachmentHandle

Detailed Description

Definition at line 39 of file VertexHandle.h.

Constructor & Destructor Documentation

VertexHandle() [1/2]

VertexHandle::VertexHandle	(	VertexCollHandle *	ch,
		const xAOD::Vertex *	vertex )

Definition at line 69 of file VertexHandle.cxx.

  : AODHandleBase(ch), m_d(new Imp(this,vertex))
{
  m_d->collHandle=ch;
  ++Imp::nvtxhandles;
}

~VertexHandle()

VertexHandle::~VertexHandle ( )

virtual

Definition at line 77 of file VertexHandle.cxx.

{
  delete m_d;
  --Imp::nvtxhandles;
}

VertexHandle() [2/2]

VertexHandle::VertexHandle ( const VertexHandle & )

private

Member Function Documentation

attach3DObjects()

void AODHandleBase::attach3DObjects ( )

virtualinherited

Connect to the scene graph.

Definition at line 157 of file AODHandleBase.cxx.

{
  VP1Msg::messageVerbose("AODHandleBase::attach3DObjects");
 
  if (!m_currentmaterial) {
    m_currentmaterial = determineMaterial();
    m_currentmaterial->ref();
    currentMaterialChanged();
  }
  if (has3DObjects() && m_collhandle->sepHelper()) {
    VP1Msg::messageVerbose("Adding nodes to sep helper...");
  
    m_collhandle->common()->registerHandle(this);
 
    // debug
    // std::cout<<"m_collhandle->sepHelper() = " << m_collhandle->sepHelper()<<std::endl;
    SoNode* tmp = nodes();
    // std::cout << "tmp nodes = "<< tmp << std::endl;
 
    //      m_collhandle->sepHelper()->addNodeUnderMaterial( nodes(), m_currentmaterial );
    m_collhandle->sepHelper()->addNodeUnderMaterial( tmp, m_currentmaterial );
 
  } else {
    if (!has3DObjects()) {
      VP1Msg::message("AODHandleBase::attach3DObjects() - No 3D objects to attach!");
    }
    if (!m_collhandle->sepHelper()) VP1Msg::message("AODHandleBase::attach3DObjects() - No sep helper!");
  }
  // if (label_sep && theclass->common()->textSep() && theclass->common()->controller()->doTrackLabels())
  //   theclass->common()->textSep()->addChild(label_sep);
  //
}

baseInfo()

QStringList VertexHandle::baseInfo ( ) const

virtual

Reimplemented from AODHandleBase.

Definition at line 155 of file VertexHandle.cxx.

{
  QStringList l;
  l << shortInfo() ;
  // vertex position
  l << "Vx: " << VP1Msg::str(m_d->vertex->x()) << "Vy: " << VP1Msg::str(m_d->vertex->y()) << "Vz: " << VP1Msg::str(m_d->vertex->z());
  return l;
}

browserTreeItem()

QTreeWidgetItem * AODHandleBase::browserTreeItem ( ) const

inherited

Return the QTreeWidgetItem;.

Definition at line 311 of file AODHandleBase.cxx.

                                                      {
  return m_d->m_objBrowseTree;
}

clear3DObjects()

void VertexHandle::clear3DObjects ( )

virtual

Delete objects.

Implements AODHandleBase.

Definition at line 97 of file VertexHandle.cxx.

                                 {
  //    VP1Msg::messageVerbose("VertexHandle::clear3DObjects()");
 
  if (m_d->sphere) {
    m_d->sphere->unref();
    m_d->sphere = 0;
  }
  if (m_d->sep) {
    m_d->sep->unref();
    m_d->sep = 0;
  }
 
}

clicked()

QStringList VertexHandle::clicked ( ) const

virtual

Called when user selects the node (stringlist is displayed in messagebox).

Reimplementations should add info momInfo() to get momentum, eta, phi, pid,charge, mass printed.

Implements AODHandleBase.

Definition at line 209 of file VertexHandle.cxx.

{
  QStringList l;
  l << "--Vertex:";
  l << VertexHandle::baseInfo();
  #ifndef BUILDVP1LIGHT
    try {
      l<< "Has "<<VP1Msg::str(m_d->vertex->vxTrackAtVertex ().size()) <<" associated tracks.";
    } catch ( SG::ExcBadAuxVar& ) {
      l<<"Vertex is missing links to tracks!";
    }
  #endif
  return l;
}

collHandle()

const AODCollHandleBase * AODHandleBase::collHandle ( ) const

inlineinherited

Definition at line 55 of file AODHandleBase.h.

{ return m_collhandle; }

common()

const AODSysCommonData * AODHandleBase::common ( ) const

inherited

Definition at line 93 of file AODHandleBase.cxx.

{
  return std::as_const(m_collhandle)->common();
}

currentMaterial()

SoMaterial * AODHandleBase::currentMaterial ( ) const

inlineinherited

Returns the current material of the handle.

Definition at line 76 of file AODHandleBase.h.

{ return m_currentmaterial; }

currentMaterialChanged()

virtual void AODHandleBase::currentMaterialChanged ( )

inlineprotectedvirtualinherited

Definition at line 111 of file AODHandleBase.h.

{};

detach3DObjects()

void AODHandleBase::detach3DObjects ( )

virtualinherited

Remove from the scene graph.

Definition at line 191 of file AODHandleBase.cxx.

{
  VP1Msg::messageVerbose("AODHandleBase::detach3DObjects");
    
  if (!m_currentmaterial)
    return;//Can never have been attached!
  if (has3DObjects() && m_collhandle->sepHelper()) {
    m_collhandle->sepHelper()->removeNodeUnderMaterial(nodes(),m_currentmaterial);
  }
  
  m_collhandle->common()->deregisterHandle(this);
  
  // if (label_sep && theclass->common()->textSep()) 
  //   theclass->common()->textSep()->removeChild(label_sep);
}

determineMaterial()

SoMaterial * VertexHandle::determineMaterial ( )

virtual

Should be implemented by children, in order to change the material depending on the interface etc.

This will (by default) return the collection material.

Implements AODHandleBase.

Definition at line 148 of file VertexHandle.cxx.

                                             {
  // By default we use the collection material.
  // std::cout<<"VertexHandle::determineMaterial() - collHandle()->material()"<<collHandle()->material()<<std::endl;
  return collHandle()->material();
}

dumpToJSON()

virtual void AODHandleBase::dumpToJSON ( std::ofstream & ) const

inlinevirtualinherited

Reimplemented in IParticleHandle_CaloCluster, IParticleHandle_Electron, IParticleHandle_Jet, and IParticleHandle_TrackParticle.

Definition at line 106 of file AODHandleBase.h.

{}; 

fillObjectBrowser()

void AODHandleBase::fillObjectBrowser ( QList< QTreeWidgetItem * > & list )

virtualinherited

Create and fill the object browser QTreeWidgetItem.

Reimplemented in IParticleHandle_CaloCluster, IParticleHandle_Electron, IParticleHandle_Jet, IParticleHandle_Muon, IParticleHandle_TrackParticle, and MissingEtHandle.

Definition at line 288 of file AODHandleBase.cxx.

                                                                            {
 
  VP1Msg::messageDebug("AODHandleBase::fillObjectBrowser()");
 
  if (m_d->m_objBrowseTree){
    VP1Msg::message("ERROR: AODHandleBase::fillObjectBrowser - already have m_objBrowseTree. Aborting.");
    return;
  }
    
  m_d->m_objBrowseTree = new QTreeWidgetItem();
 
  QString l = shortInfo();
 
  m_d->m_objBrowseTree->setText(0, type()+QString(QString::number(listOfItems.size())) );
  m_d->m_objBrowseTree->setText(1, l );    
 
  if (!visible()) {
    m_d->m_objBrowseTree->setFlags(Qt::ItemFlags()); // not selectable, not enabled
  }
  listOfItems << browserTreeItem();
}

getPositionX()

double VertexHandle::getPositionX

(

)

const

Definition at line 189 of file VertexHandle.cxx.

                                        {
    return m_d->vertex->x();
}

getPositionY()

double VertexHandle::getPositionY

(

)

const

Definition at line 193 of file VertexHandle.cxx.

                                        {
    return m_d->vertex->y();
}

getPositionZ()

double VertexHandle::getPositionZ

(

)

const

Definition at line 197 of file VertexHandle.cxx.

                                        {
    return m_d->vertex->z();
}

has3DObjects()

bool VertexHandle::has3DObjects ( )

virtual

Returns true if the 3D objects have been created.

Reimplemented from AODHandleBase.

Definition at line 91 of file VertexHandle.cxx.

{
  return 0!=m_d->sep;
}

nodes()

SoNode * VertexHandle::nodes ( )

virtual

Returns the 3Dobjects.

Implements AODHandleBase.

Definition at line 112 of file VertexHandle.cxx.

                           {
 
  VP1Msg::messageVerbose("VertexHandle::nodes()");
 
  if (m_d->sep) {
    VP1Msg::messageVerbose("d->sep already defined (" + VP1Msg::str(m_d->sep) + "). Returning d->sep.");
    return m_d->sep; // FIXME - do we need to check if anything need to be redrawn?
  }
  if (!m_d->sep) {
    VP1Msg::messageVerbose("d->sep not defined. Creating shapes and a new d->sep.");
    m_d->sep = new SoSeparator();
    m_d->sep->ref();
  }
 
  // SbVec3f origin(0.,0.,0.);
  /* TODO: ask if origin info is present in xAOD, like in the old Jet class
  if ( m_d->m_jet->origin() ) {
  origin.setValue(m_d->m_jet->origin()->position().x(),
  m_d->m_jet->origin()->position().y(),
  m_d->m_jet->origin()->position().z());
  }
  */
 
  VP1Msg::messageVerbose("creating the shapes");
 
  SoTranslation * translation = new SoTranslation;
  translation->translation.setValue ( m_d->vertex->x(), m_d->vertex->y(), m_d->vertex->z() );
  m_d->sep->addChild ( translation );
  m_d->sphere = new SoSphere;
  m_d->sphere->radius = m_d->collHandle->collSettingsButton().vertexSize();
  m_d->sep->addChild ( m_d->sphere );
 
  return m_d->sep;
}

numberOfInstances()

int VertexHandle::numberOfInstances ( )

static

Definition at line 84 of file VertexHandle.cxx.

{
  return Imp::nvtxhandles;
}

operator=()

VertexHandle & VertexHandle::operator= ( const VertexHandle & )

private

rebuild3DObjects()

void AODHandleBase::rebuild3DObjects ( )

virtualinherited

Definition at line 137 of file AODHandleBase.cxx.

{  
  QString tmp2 = (m_visible==true)?"True":"False";
  VP1Msg::messageDebug("AODHandleBase::rebuild3DObjects() - with m_visible="+tmp2 );
  
  //Ensure we are always detached while updating.
  if (m_visible) {
    detach3DObjects();
  }
 
  clear3DObjects();
  nodes(); // rebuilds the 3D shapes
 
  //Attach if visible:
  if (m_visible) {
    attach3DObjects();
  }
}

setVisible()

void AODHandleBase::setVisible ( bool vis )

inherited

use by the collection handle.

Definition at line 99 of file AODHandleBase.cxx.

{
  QString tmp = (vis==true)?"True":"False";
  QString tmp2 = (m_visible==true)?"True":"False";
  VP1Msg::messageDebug(QString("AODHandleBase calling setVisible with vis=")+tmp+QString(", and m_visible=")+tmp2 );
  if (vis==m_visible)
    return;
 
  m_visible=vis;
  if (vis) {
    m_collhandle->incrementNShownHandles();
 
    if (!has3DObjects())
      rebuild3DObjects();//The call to rebuild also fixes attached state.
    else
      attach3DObjects();
  } else {
    m_collhandle->decrementNShownHandles();
    detach3DObjects();
  }
 
  visibleStateChanged();
}

shortInfo()

QString VertexHandle::shortInfo ( ) const

virtual

returns position & type information about vertex

Reimplemented from AODHandleBase.

Definition at line 203 of file VertexHandle.cxx.

                                      {
  QString l = vertexType();  
  return l;
}

type()

virtual QString VertexHandle::type ( ) const

inlinevirtual

return very short word with type (maybe link with collection type?)

Reimplemented from AODHandleBase.

Definition at line 68 of file VertexHandle.h.

unknown()

double AODHandleBase::unknown ( )

inlinestaticinherited

Definition at line 93 of file AODHandleBase.h.

{ return -999.0; }

update3DObjects()

void AODHandleBase::update3DObjects ( )

virtualinherited

Called after some configuration changes, or when the object is first created. Must be overloaded by children.

Definition at line 125 of file AODHandleBase.cxx.

{
  if (m_visible) {
    rebuild3DObjects();
  } else {    
    //Simply clear the present 3D objects. They will only be recreated if/when the track/jet becomes visible again.
    clear3DObjects();
  }
}

updateMaterial()

void VertexHandle::updateMaterial

(

)

Called after some configuration related to material changes.

updateObjectBrowser()

void AODHandleBase::updateObjectBrowser ( )

inlineinherited

Update object browser QTreeWidgetItem.

Definition at line 102 of file AODHandleBase.h.

{};

vertexType()

QString VertexHandle::vertexType

(

)

const

Definition at line 165 of file VertexHandle.cxx.

                                       {
  using namespace xAOD;
 
  switch (m_d->vertex->vertexType()){
    case xAOD::VxType::NoVtx:
      return QString("Type: Dummy");
    case xAOD::VxType::PriVtx:
      return QString("Type: Primary");
    case xAOD::VxType::SecVtx:
      return QString("Type: Secondary");
    case xAOD::VxType::PileUp:
      return QString("Type: Pileup");
    case xAOD::VxType::ConvVtx:
      return QString("Type: Conversion");
    case xAOD::VxType::KinkVtx:
      return QString("Type: Kink");
    case xAOD::VxType::NotSpecified:
      return QString("Type: Not specified (default)");
    default:
      return QString("Unknown vertex type - probably VP1 needs updating!");
    }
}

visible()

bool AODHandleBase::visible ( ) const

inlineinherited

Definition at line 54 of file AODHandleBase.h.

{ return m_visible; }

visibleStateChanged()

void AODHandleBase::visibleStateChanged ( )

protectedvirtualinherited

Dummy implementation does nothing.

override if need to take action in this case.

Definition at line 316 of file AODHandleBase.cxx.

{  
  if ( !browserTreeItem()) {
    VP1Msg::messageVerbose("visibleStateChanged: No m_objBrowseTree!");
    return;
  }
    
  if (!visible()) {
    browserTreeItem()->setFlags(Qt::ItemFlags()); // not selectable, not enabled
  } else {
    browserTreeItem()->setFlags(Qt::ItemIsSelectable | Qt::ItemIsEnabled); //  selectable,  enabled
  }  
  QFont itemFont = browserTreeItem()->font(0);
  itemFont.setStrikeOut(!visible());
  browserTreeItem()->setFont(0, itemFont);
  browserTreeItem()->setFont(1, itemFont);
}

Friends And Related Symbol Documentation

AssocObjAttachmentHandle

friend class AssocObjAttachmentHandle

friend

Definition at line 81 of file VertexHandle.h.

Member Data Documentation

m_collhandle

AODCollHandleBase* AODHandleBase::m_collhandle

privateinherited

Definition at line 126 of file AODHandleBase.h.

m_currentmaterial

SoMaterial* AODHandleBase::m_currentmaterial

privateinherited

Definition at line 127 of file AODHandleBase.h.

m_d

Imp* VertexHandle::m_d

private

Definition at line 83 of file VertexHandle.h.

m_visible

bool AODHandleBase::m_visible

privateinherited

Definition at line 125 of file AODHandleBase.h.

---

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

• VertexHandle.h
• VertexHandle.cxx