Trk::AbstractVolume Class Reference

#include <AbstractVolume.h>

Inheritance diagram for Trk::AbstractVolume:

Collaboration diagram for Trk::AbstractVolume:

Public Member Functions
	AbstractVolume ()
	Default Constructor - needed for pool and inherited classes. More...
	AbstractVolume (const AbstractVolume &vol)
	Copy constructor. More...
	AbstractVolume (Amg::Transform3D *htrans, VolumeBounds *volbounds)
	Constructor with Amg::Transform3D*, VolumeBounds*, passing ownership. More...
virtual	~AbstractVolume ()
	Virtual Destructor. More...
AbstractVolume &	operator= (const AbstractVolume &vol)
	Assignment operator. More...
AbstractVolume *	clone () const
	Implicit constructor. More...
const std::vector< SharedObject< const BoundarySurface< AbstractVolume > > > &	boundarySurfaces () const
	Method to return the BoundarySurfaces. More...
const Amg::Transform3D &	transform () const
	Return methods for geometry transform. More...
const Amg::Vector3D &	center () const
	returns the center of the volume More...
const VolumeBounds &	volumeBounds () const
	returns the volumeBounds() More...
VolumeBounds &	volumeBounds ()
bool	inside (const Amg::Vector3D &gp, double tol=0.) const
	Inside() method for checks. More...
ObjectAccessor	boundarySurfaceAccessor (const Amg::Vector3D &gp, const Amg::Vector3D &mom, bool forceInside=false) const
	Provide accessor for BoundarySurfaces. More...

Protected Attributes
std::unique_ptr< Amg::Transform3D >	m_transform
	HepGeom::Transform3D. More...
CxxUtils::CachedUniquePtr< Amg::Vector3D >	m_center
	center position of the surface More...
SharedObject< VolumeBounds >	m_volumeBounds
	the volumeBounds More...

Private Member Functions
void	createBoundarySurfaces ()
	Private method to create BoundarySurfaces. More...

Private Attributes
std::vector< SharedObject< const BoundarySurface< AbstractVolume > > > *	m_boundarySurfaces
	boundary Surfaces More...

Detailed Description

AbstractVolume description inside the tracking realm. This is the purely geometrical object volume.

The Trk::AbstractVolume is constructed by giving a pointer to a HepGeom::Transform3D and a pointer to Trk::VolumeBounds, this implies that the ownership of the objects pointed to is passed as well.

A Trk::AbstractVolume is in first place a collection class of Trk::BoundarySurface, the vector of Trk::BoundarySurface is returned by the Trk::VolumeBounds that carry a decompose method.

Boundary surfaces can be shared between AbstractVolumes to enhance automatic navigation between AbstractVolumes, therefor they are reference counted by a Trk::SharedObject holder class.

Author

Andre.nosp@m.as.S.nosp@m.alzbu.nosp@m.rger.nosp@m.@cern.nosp@m..ch

Definition at line 51 of file AbstractVolume.h.

Constructor & Destructor Documentation

AbstractVolume() [1/3]

Trk::AbstractVolume::AbstractVolume

(

)

Default Constructor - needed for pool and inherited classes.

Definition at line 30 of file AbstractVolume.cxx.

  : Volume()
  , m_boundarySurfaces(nullptr)
{}

AbstractVolume() [2/3]

Trk::AbstractVolume::AbstractVolume

(

const AbstractVolume &

vol

)

Copy constructor.

Definition at line 46 of file AbstractVolume.cxx.

  : Volume(vol)
  , m_boundarySurfaces(nullptr)
{}

AbstractVolume() [3/3]

Trk::AbstractVolume::AbstractVolume	(	Amg::Transform3D *	htrans,
		Trk::VolumeBounds *	volbounds
	)

Constructor with Amg::Transform3D*, VolumeBounds*, passing ownership.

Definition at line 36 of file AbstractVolume.cxx.

  : Volume(htrans, volbounds)
  , m_boundarySurfaces(nullptr)
{
  createBoundarySurfaces();
}

~AbstractVolume()

Trk::AbstractVolume::~AbstractVolume ( )

virtual

Virtual Destructor.

Definition at line 52 of file AbstractVolume.cxx.

{
  delete m_boundarySurfaces;
}

Member Function Documentation

boundarySurfaceAccessor()

Trk::ObjectAccessor Trk::Volume::boundarySurfaceAccessor ( const Amg::Vector3D &  gp, const Amg::Vector3D &  mom, bool  forceInside = false  ) const

inherited

Provide accessor for BoundarySurfaces.

Definition at line 100 of file Volume.cxx.

{
  if (!m_transform) {
    return Trk::ObjectAccessor(
      volumeBounds().boundarySurfaceAccessor(gp, dir, forceInside));
  }
  return Trk::ObjectAccessor(volumeBounds().boundarySurfaceAccessor(
    transform().inverse() * gp, dir, forceInside));
}

boundarySurfaces()

const std::vector< Trk::SharedObject< const Trk::BoundarySurface< Trk::AbstractVolume > > > & Trk::AbstractVolume::boundarySurfaces

(

)

const

Method to return the BoundarySurfaces.

Definition at line 73 of file AbstractVolume.cxx.

{
  return (*m_boundarySurfaces);
}

center()

const Amg::Vector3D & Trk::Volume::center ( ) const

inlineinherited

returns the center of the volume

Definition at line 86 of file Volume.h.

    {
     if (m_center) return (*m_center);
     if (!m_center && m_transform){
        m_center.set(std::make_unique<Amg::Vector3D>(std::as_const(*m_transform).translation()));
        return(*m_center);
      }
     return Trk::s_origin;
    }

clone()

AbstractVolume * Trk::AbstractVolume::clone ( ) const

inlinevirtual

Implicit constructor.

Reimplemented from Trk::Volume.

Definition at line 84 of file AbstractVolume.h.

                                                   {
  return new AbstractVolume(*this);
}

createBoundarySurfaces()

void Trk::AbstractVolume::createBoundarySurfaces ( )

private

Private method to create BoundarySurfaces.

Definition at line 78 of file AbstractVolume.cxx.

{
  // prepare the BoundarySurfaces
  m_boundarySurfaces = new std::vector<
    Trk::SharedObject<const Trk::BoundarySurface<Trk::AbstractVolume>>>;
  // transform Surfaces To BoundarySurfaces
  const std::vector<const Trk::Surface*>* surfaces =
    Trk::Volume::volumeBounds().decomposeToSurfaces(this->transform());
  std::vector<const Trk::Surface*>::const_iterator surfIter = surfaces->begin();
 
  // counter to flip the inner/outer position for Cylinders
  int sfCounter = 0;
  int sfNumber = surfaces->size();
 
  for (; surfIter != surfaces->end(); ++surfIter) {
    sfCounter++;
    const Trk::PlaneSurface* psf =
      dynamic_cast<const Trk::PlaneSurface*>(*surfIter);
    if (psf) {
      m_boundarySurfaces->push_back(
        Trk::SharedObject<const Trk::BoundarySurface<Trk::AbstractVolume>>(
          new Trk::BoundaryPlaneSurface<Trk::AbstractVolume>(
            this, nullptr, *psf)));
      delete psf;
      continue;
    }
    const Trk::DiscSurface* dsf =
      dynamic_cast<const Trk::DiscSurface*>(*surfIter);
    if (dsf) {
      m_boundarySurfaces->push_back(
        Trk::SharedObject<const Trk::BoundarySurface<Trk::AbstractVolume>>(
          new Trk::BoundaryDiscSurface<Trk::AbstractVolume>(
            this, nullptr, *dsf)));
      delete dsf;
      continue;
    }
    const Trk::CylinderSurface* csf =
      dynamic_cast<const Trk::CylinderSurface*>(*surfIter);
    if (csf) {
      Trk::AbstractVolume* inner =
        (sfCounter == 3 && sfNumber > 3) ? nullptr : this;
      Trk::AbstractVolume* outer = (inner) ? nullptr : this;
      m_boundarySurfaces->push_back(
        Trk::SharedObject<const Trk::BoundarySurface<Trk::AbstractVolume>>(
          new Trk::BoundaryCylinderSurface<Trk::AbstractVolume>(
            inner, outer, *csf)));
      delete csf;
      continue;
    }
  }
 
  delete surfaces;
}

inside()

ATH_FLATTEN bool Trk::Volume::inside ( const Amg::Vector3D &  gp, double  tol = 0.  ) const

inherited

Inside() method for checks.

Definition at line 90 of file Volume.cxx.

{
  if (!m_transform) {
    return (volumeBounds()).inside(gp, tol);
  }
  Amg::Vector3D posInVolFrame((transform().inverse()) * gp);
  return (volumeBounds()).inside(posInVolFrame, tol);
}

operator=()

Trk::AbstractVolume & Trk::AbstractVolume::operator=

(

const AbstractVolume &

vol

)

Assignment operator.

Definition at line 59 of file AbstractVolume.cxx.

{
  if (this != &vol) {
    Volume::operator=(vol);
    delete m_boundarySurfaces;
    m_boundarySurfaces = new std::vector<
      Trk::SharedObject<const Trk::BoundarySurface<Trk::AbstractVolume>>>(
      *vol.m_boundarySurfaces);
  }
  return *this;
}

transform()

const Amg::Transform3D & Trk::Volume::transform ( ) const

inlineinherited

Return methods for geometry transform.

Definition at line 81 of file Volume.h.

    {  if (m_transform) return(*m_transform);
       return Trk::s_idTransform;
    }

volumeBounds() [1/2]

VolumeBounds & Trk::Volume::volumeBounds ( )

inlineinherited

Definition at line 103 of file Volume.h.

    {
      return *(m_volumeBounds.get());
    }

volumeBounds() [2/2]

const VolumeBounds & Trk::Volume::volumeBounds ( ) const

inlineinherited

returns the volumeBounds()

Definition at line 97 of file Volume.h.

    {
      return *(m_volumeBounds.get());
    }

Member Data Documentation

m_boundarySurfaces

std::vector<SharedObject<const BoundarySurface<AbstractVolume> > >* Trk::AbstractVolume::m_boundarySurfaces

private

boundary Surfaces

Definition at line 81 of file AbstractVolume.h.

m_center

CxxUtils::CachedUniquePtr<Amg::Vector3D> Trk::Volume::m_center

protectedinherited

center position of the surface

Definition at line 77 of file Volume.h.

m_transform

std::unique_ptr<Amg::Transform3D> Trk::Volume::m_transform

protectedinherited

HepGeom::Transform3D.

Definition at line 76 of file Volume.h.

m_volumeBounds

SharedObject<VolumeBounds> Trk::Volume::m_volumeBounds

protectedinherited

the volumeBounds

Definition at line 78 of file Volume.h.

---

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

• AbstractVolume.h
• AbstractVolume.cxx