Trk::Volume Class Reference

#include <Volume.h>

Inheritance diagram for Trk::Volume:

Collaboration diagram for Trk::Volume:

Public Member Functions
	Volume ()
	Default constructor. More...
	Volume (Amg::Transform3D *htrans, VolumeBounds *volBounds)
	Expizit constructor with arguments. More...
	Volume (const Volume &vol)
	Copy Constructor. More...
	Volume (const Volume &vol, const Amg::Transform3D &shift)
	Copy Constructor. More...
virtual	~Volume ()
	Destructor. More...
Volume &	operator= (const Volume &vol)
	Assignment operator. More...
virtual Volume *	clone () const
	Pseudo-constructor. 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...

Detailed Description

Base class for all volumes inside the tracking realm, it defines the interface for inherited Volume classes regarding the geometrical information.

Author

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

Definition at line 35 of file Volume.h.

Constructor & Destructor Documentation

Volume() [1/4]

Trk::Volume::Volume

(

)

Default constructor.

Definition at line 21 of file Volume.cxx.

  : m_transform(nullptr)
  , m_center(nullptr)
  , m_volumeBounds()
{}

Volume() [2/4]

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

Expizit constructor with arguments.

Definition at line 28 of file Volume.cxx.

  : m_transform(htrans)
  , m_center(nullptr)
  , m_volumeBounds(volbounds)
{}

Volume() [3/4]

Trk::Volume::Volume

(

const Volume &

vol

)

Copy Constructor.

Definition at line 35 of file Volume.cxx.

  : m_transform(
      vol.m_transform ? std::make_unique<Amg::Transform3D>(*(vol.m_transform))
                      : nullptr)
  , m_center(
      (vol.m_center) ? std::make_unique<Amg::Vector3D>(*(vol.m_center))
                     : nullptr)
  , m_volumeBounds(vol.m_volumeBounds)
{}

Volume() [4/4]

Trk::Volume::Volume	(	const Volume &	vol,
		const Amg::Transform3D &	shift
	)

Copy Constructor.

Definition at line 46 of file Volume.cxx.

  : m_transform(
      vol.m_transform
        ? std::make_unique<Amg::Transform3D>(shift * (*(vol.m_transform)))
        : std::make_unique<Amg::Transform3D>(shift))
  , m_center(
      (vol.m_center)
        ? std::make_unique<Amg::Vector3D>(shift * (*(vol.m_center)))
        : nullptr)
  , m_volumeBounds(vol.m_volumeBounds)
{}

~Volume()

Trk::Volume::~Volume ( )

virtualdefault

Destructor.

Member Function Documentation

boundarySurfaceAccessor()

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

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

center()

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

inline

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

Trk::Volume * Trk::Volume::clone ( ) const

virtual

Pseudo-constructor.

Reimplemented in Trk::AbstractVolume.

Definition at line 78 of file Volume.cxx.

{
  return new Trk::Volume(*this);
}

inside()

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

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::Volume & Trk::Volume::operator=

(

const Volume &

vol

)

Assignment operator.

Definition at line 63 of file Volume.cxx.

{
  if (this != &vol) {
    m_transform = vol.m_transform
                    ? std::make_unique<Amg::Transform3D>(*vol.m_transform)
                    : nullptr;
    m_center = vol.m_center
                 ? std::make_unique<const Amg::Vector3D>(*(vol.m_center))
                 : nullptr;
    m_volumeBounds = vol.m_volumeBounds;
  }
  return *this;
}

transform()

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

inline

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

inline

Definition at line 103 of file Volume.h.

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

volumeBounds() [2/2]

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

inline

returns the volumeBounds()

Definition at line 97 of file Volume.h.

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

Member Data Documentation

m_center

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

protected

center position of the surface

Definition at line 77 of file Volume.h.

m_transform

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

protected

HepGeom::Transform3D.

Definition at line 76 of file Volume.h.

m_volumeBounds

SharedObject<VolumeBounds> Trk::Volume::m_volumeBounds

protected

the volumeBounds

Definition at line 78 of file Volume.h.

---

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

• Volume.h
• Volume.cxx