Trk::Volume Class Reference

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

#include <Volume.h>

Inheritance diagram for Trk::Volume:

Collaboration diagram for Trk::Volume:

Public Member Functions
	Volume ()=default
	Defaults copies are special due ot unique ptr data member.
	Volume (Volume &&)=default
Volume &	operator= (Volume &&)=default
virtual	~Volume ()=default
	Volume (std::unique_ptr< Amg::Transform3D > htrans, std::shared_ptr< VolumeBounds > volBounds)
	Constructor with arguments.
	Volume (const Volume &vol)
	Copy Constructor.
	Volume (const Volume &vol, const Amg::Transform3D &shift)
	Copy Constructor.
Volume &	operator= (const Volume &vol)
	Assignment operator.
virtual Volume *	clone () const
	polymorpic deep copy
const Amg::Transform3D &	transform () const
	Return methods for geometry transform.
const Amg::Vector3D &	center () const
	returns the center of the volume
const VolumeBounds &	volumeBounds () const
	returns the volumeBounds()
VolumeBounds &	volumeBounds ()
bool	inside (const Amg::Vector3D &gp, double tol=0.) const
	Inside() method for checks.
ObjectAccessor	boundarySurfaceAccessor (const Amg::Vector3D &gp, const Amg::Vector3D &mom, bool forceInside=false) const
	Provide accessor for BoundarySurfaces.

Protected Attributes
std::unique_ptr< Amg::Transform3D >	m_transform = nullptr
	Transform3D (optional).
Amg::Vector3D	m_center = Trk::s_origin
	center position of the surface
std::shared_ptr< VolumeBounds >	m_volumeBounds = nullptr
	the volumeBounds

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

Christos Anastopoulos (Athena MT modifications)

Definition at line 36 of file Volume.h.

Constructor & Destructor Documentation

Volume() [1/5]

Trk::Volume::Volume ( )

default

Defaults copies are special due ot unique ptr data member.

Volume() [2/5]

Trk::Volume::Volume ( Volume && )

default

~Volume()

virtual Trk::Volume::~Volume ( )

virtualdefault

Volume() [3/5]

Trk::Volume::Volume	(	std::unique_ptr< Amg::Transform3D >	htrans,
		std::shared_ptr< VolumeBounds >	volBounds )

Constructor with arguments.

Definition at line 22 of file Volume.cxx.

  : m_transform(std::move(htrans))
  , m_center(m_transform ? m_transform->translation() : Trk::s_origin)
  , m_volumeBounds(std::move(volbounds))
{}

Volume() [4/5]

Trk::Volume::Volume

(

const Volume &

vol

)

Copy Constructor.

Definition at line 30 of file Volume.cxx.

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

Volume() [5/5]

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

Copy Constructor.

Definition at line 38 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(shift * vol.m_center),
      m_volumeBounds(vol.m_volumeBounds) {}

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 82 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 90 of file Volume.h.

    {
      return m_center;
    }

clone()

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

virtual

polymorpic deep copy

Definition at line 60 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 72 of file Volume.cxx.

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

operator=() [1/2]

Trk::Volume & Trk::Volume::operator=

(

const Volume &

vol

)

Assignment operator.

Definition at line 47 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;
    m_volumeBounds = vol.m_volumeBounds;
  }
  return *this;
}

operator=() [2/2]

Volume & Trk::Volume::operator= ( Volume && )

default

transform()

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

inline

Return methods for geometry transform.

Definition at line 83 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 102 of file Volume.h.

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

volumeBounds() [2/2]

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

inline

returns the volumeBounds()

Definition at line 96 of file Volume.h.

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

Member Data Documentation

m_center

Amg::Vector3D Trk::Volume::m_center = Trk::s_origin

protected

center position of the surface

Definition at line 79 of file Volume.h.

m_transform

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

protected

Transform3D (optional).

Definition at line 78 of file Volume.h.

m_volumeBounds

std::shared_ptr<VolumeBounds> Trk::Volume::m_volumeBounds = nullptr

protected

the volumeBounds

Definition at line 80 of file Volume.h.

---

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

• Volume.h
• Volume.cxx