Trk::CuboidVolumeBounds Class Reference

Bounds for a cubical Volume, the decomposeToSurfaces method creates a vector of 6 surfaces: More...

#include <CuboidVolumeBounds.h>

Inheritance diagram for Trk::CuboidVolumeBounds:

Collaboration diagram for Trk::CuboidVolumeBounds:

Public Member Functions
	CuboidVolumeBounds ()
	Default Constructor.
	CuboidVolumeBounds (double hlenghtx, double hlenghty, double hlengthz)
	Constructor - the box boundaries.
	CuboidVolumeBounds (const CuboidVolumeBounds &bobo)
	Copy Constructor.
virtual	~CuboidVolumeBounds ()
	Destructor.
CuboidVolumeBounds &	operator= (const CuboidVolumeBounds &bobo)
	Assignment operator.
CuboidVolumeBounds *	clone () const override final
	Virtual constructor.
bool	inside (const Amg::Vector3D &, double tol=0.) const override final
	This method checks if position in the 3D volume frame is inside the cylinder.
virtual std::vector< std::unique_ptr< Trk::Surface > >	decomposeToSurfaces (const Amg::Transform3D &transform) override final
	Method to decompose the Bounds into boundarySurfaces.
ObjectAccessor	boundarySurfaceAccessor (const Amg::Vector3D &gp, const Amg::Vector3D &dir, bool forceInside=false) const override final
	Provide accessor for BoundarySurfaces.
double	halflengthX () const
	This method returns the halflength in local x.
double	halflengthY () const
	This method returns the halflength in local y.
double	halflengthZ () const
	This method returns the halflength in local z.
MsgStream &	dump (MsgStream &sl) const override final
	Output Method for MsgStream.
std::ostream &	dump (std::ostream &sl) const override final
	Output Method for std::ostream.

Private Member Functions
std::shared_ptr< RectangleBounds >	faceXYRectangleBounds () const
	This method returns the associated RecantleBounds of the face PlaneSurface parallel to local xy plane.
std::shared_ptr< RectangleBounds >	faceYZRectangleBounds () const
	This method returns the associated RecantleBounds of the face PlaneSurface parallel to local yz plane.
std::shared_ptr< RectangleBounds >	faceZXRectangleBounds () const
	This method returns the associated RecantleBounds of the face PlaneSurface parallel to local zx plane.

Private Attributes
double	m_halfX
double	m_halfY
double	m_halfZ
SixObjectsAccessor	m_objectAccessor
	There's only one single object Acessor for the moment has to be implemented if Cuboids are used more widely.

Detailed Description

Bounds for a cubical Volume, the decomposeToSurfaces method creates a vector of 6 surfaces:

BoundarySurfaceFace [index]:

• negativeFaceXY [0] : Rectangular Trk::PlaneSurface, parallel to \( xy \) plane at negative \( z \)
• positiveFaceXY [1] : Rectangular Trk::PlaneSurface, parallel to \( xy \) plane at positive \( z \)
• negativeFaceXY [2] : Rectangular Trk::PlaneSurface, attached to \( yz \) plane at negative \( x \)
• positiveFaceXY [3] : Rectangular Trk::PlaneSurface, attached to \( yz \) plane at negative \( x \)
• negativeFaceXY [4] : Rectangular Trk::PlaneSurface, parallel to \( zx \) plane at negative \( y \)
• positiveFaceXY [5] : Rectangular Trk::PlaneSurface, parallel to \( zx \) plane at positive \( y \)

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 52 of file CuboidVolumeBounds.h.

Constructor & Destructor Documentation

CuboidVolumeBounds() [1/3]

Trk::CuboidVolumeBounds::CuboidVolumeBounds

(

)

Default Constructor.

Definition at line 22 of file CuboidVolumeBounds.cxx.

  : VolumeBounds()
  , m_halfX(0.)
  , m_halfY(0.)
  , m_halfZ(0.)
  , m_objectAccessor()
{}

CuboidVolumeBounds() [2/3]

Trk::CuboidVolumeBounds::CuboidVolumeBounds	(	double	hlenghtx,
		double	hlenghty,
		double	hlengthz )

Constructor - the box boundaries.

Definition at line 30 of file CuboidVolumeBounds.cxx.

  : VolumeBounds()
  , m_halfX(halex)
  , m_halfY(haley)
  , m_halfZ(halez)
  , m_objectAccessor()
{}

CuboidVolumeBounds() [3/3]

Trk::CuboidVolumeBounds::CuboidVolumeBounds

(

const CuboidVolumeBounds &

bobo

)

Copy Constructor.

Definition at line 41 of file CuboidVolumeBounds.cxx.

  : VolumeBounds()
  , m_halfX(bobo.m_halfX)
  , m_halfY(bobo.m_halfY)
  , m_halfZ(bobo.m_halfZ)
  , m_objectAccessor(bobo.m_objectAccessor)
{}

~CuboidVolumeBounds()

Trk::CuboidVolumeBounds::~CuboidVolumeBounds ( )

virtualdefault

Destructor.

Member Function Documentation

boundarySurfaceAccessor()

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

inlinefinaloverridevirtual

Provide accessor for BoundarySurfaces.

Implements Trk::VolumeBounds.

Definition at line 138 of file CuboidVolumeBounds.h.

                                                        {
  return Trk::ObjectAccessor(m_objectAccessor);
}

clone()

CuboidVolumeBounds * Trk::CuboidVolumeBounds::clone ( ) const

inlinefinaloverridevirtual

Virtual constructor.

Implements Trk::VolumeBounds.

Definition at line 122 of file CuboidVolumeBounds.h.

                                                           {
  return new CuboidVolumeBounds(*this);
}

decomposeToSurfaces()

std::vector< std::unique_ptr< Trk::Surface > > Trk::CuboidVolumeBounds::decomposeToSurfaces ( const Amg::Transform3D & transform )

finaloverridevirtual

Method to decompose the Bounds into boundarySurfaces.

Implements Trk::VolumeBounds.

Definition at line 64 of file CuboidVolumeBounds.cxx.

{
 
  auto retsf = std::vector<std::unique_ptr<Trk::Surface>>() ;
  // memory optimisation
  retsf.reserve(6);
  // face surfaces xy
  //   (1) - at negative local z
  retsf.push_back(std::make_unique<Trk::PlaneSurface>(
    Amg::Transform3D(
      transform *
      Amg::AngleAxis3D(180. * Gaudi::Units::deg, Amg::Vector3D(0., 1., 0.)) *
      Amg::Translation3D(Amg::Vector3D(0., 0., this->halflengthZ()))),
    this->faceXYRectangleBounds()));
  //   (2) - at positive local z
  retsf.push_back(std::make_unique<Trk::PlaneSurface>(
    Amg::Transform3D(
      transform *
      Amg::Translation3D(Amg::Vector3D(0., 0., this->halflengthZ()))),
    this->faceXYRectangleBounds()));
  // face surfaces yz
  // transmute cyclical
  //   (3) - at negative local x
  retsf.push_back(std::make_unique<Trk::PlaneSurface>(
    Amg::Transform3D(
      transform *
      Amg::AngleAxis3D(180. * Gaudi::Units::deg, Amg::Vector3D(0., 0., 1.)) *
      Amg::Translation3D(Amg::Vector3D(this->halflengthX(), 0., 0)) *
      Amg::AngleAxis3D(90. * Gaudi::Units::deg, Amg::Vector3D(0., 1., 0)) *
      Amg::AngleAxis3D(90. * Gaudi::Units::deg, Amg::Vector3D(0., 0., 1.))),
    this->faceYZRectangleBounds()));
  //   (4) - at positive local x
  retsf.push_back(std::make_unique<Trk::PlaneSurface>(
    Amg::Transform3D(
      transform *
      Amg::Translation3D(Amg::Vector3D(this->halflengthX(), 0., 0.)) *
      Amg::AngleAxis3D(90. * Gaudi::Units::deg, Amg::Vector3D(0., 1., 0.)) *
      Amg::AngleAxis3D(90. * Gaudi::Units::deg, Amg::Vector3D(0., 0., 1.))),
    this->faceYZRectangleBounds()));
  // face surfaces zx
  //   (5) - at negative local y
  retsf.push_back(std::make_unique<Trk::PlaneSurface>(
    Amg::Transform3D(
      transform *
      Amg::AngleAxis3D(180. * Gaudi::Units::deg, Amg::Vector3D(1., 0., 0.)) *
      Amg::Translation3D(Amg::Vector3D(0., this->halflengthY(), 0.)) *
      Amg::AngleAxis3D(-90 * Gaudi::Units::deg, Amg::Vector3D(0., 1., 0.)) *
      Amg::AngleAxis3D(-90. * Gaudi::Units::deg, Amg::Vector3D(1., 0., 0.))),
    this->faceZXRectangleBounds()));
  //   (6) - at positive local y
  retsf.push_back(std::make_unique<Trk::PlaneSurface>(
    Amg::Transform3D(
      transform *
      Amg::Translation3D(Amg::Vector3D(0., this->halflengthY(), 0.)) *
      Amg::AngleAxis3D(-90 * Gaudi::Units::deg, Amg::Vector3D(0., 1., 0.)) *
      Amg::AngleAxis3D(-90. * Gaudi::Units::deg, Amg::Vector3D(1., 0., 0.))),
    this->faceZXRectangleBounds()));
 
  return retsf;
}

dump() [1/2]

MsgStream & Trk::CuboidVolumeBounds::dump ( MsgStream & sl ) const

finaloverridevirtual

Output Method for MsgStream.

Implements Trk::VolumeBounds.

Definition at line 147 of file CuboidVolumeBounds.cxx.

{
 
  std::stringstream temp_sl;
  temp_sl << std::setiosflags(std::ios::fixed);
  temp_sl << std::setprecision(7);
  temp_sl << "Trk::CuboidVolumeBounds: (halfX, halfY, halfZ) = ";
  temp_sl << "(" << m_halfX << ", " << m_halfY << ", " << m_halfZ << ")";
  sl << temp_sl.str();
  return sl;
}

dump() [2/2]

std::ostream & Trk::CuboidVolumeBounds::dump ( std::ostream & sl ) const

finaloverridevirtual

Output Method for std::ostream.

Implements Trk::VolumeBounds.

Definition at line 160 of file CuboidVolumeBounds.cxx.

{
  std::stringstream temp_sl;
  temp_sl << std::setiosflags(std::ios::fixed);
  temp_sl << std::setprecision(7);
  temp_sl << "Trk::CuboidVolumeBounds: (halfX, halfY, halfZ) = ";
  temp_sl << "(" << m_halfX << ", " << m_halfY << ", " << m_halfZ << ")";
  sl << temp_sl.str();
  return sl;
}

faceXYRectangleBounds()

std::shared_ptr< Trk::RectangleBounds > Trk::CuboidVolumeBounds::faceXYRectangleBounds ( ) const

private

This method returns the associated RecantleBounds of the face PlaneSurface parallel to local xy plane.

Definition at line 127 of file CuboidVolumeBounds.cxx.

{
  return std::make_shared<Trk::RectangleBounds>(m_halfX, m_halfY);
}

faceYZRectangleBounds()

std::shared_ptr< Trk::RectangleBounds > Trk::CuboidVolumeBounds::faceYZRectangleBounds ( ) const

private

This method returns the associated RecantleBounds of the face PlaneSurface parallel to local yz plane.

Definition at line 133 of file CuboidVolumeBounds.cxx.

{
  return std::make_shared<Trk::RectangleBounds>(m_halfY, m_halfZ);
}

faceZXRectangleBounds()

std::shared_ptr< Trk::RectangleBounds > Trk::CuboidVolumeBounds::faceZXRectangleBounds ( ) const

private

This method returns the associated RecantleBounds of the face PlaneSurface parallel to local zx plane.

Definition at line 139 of file CuboidVolumeBounds.cxx.

{
  return std::make_shared<Trk::RectangleBounds>(m_halfZ, m_halfX);
}

halflengthX()

double Trk::CuboidVolumeBounds::halflengthX ( ) const

inline

This method returns the halflength in local x.

Definition at line 132 of file CuboidVolumeBounds.h.

{ return m_halfX; }

halflengthY()

double Trk::CuboidVolumeBounds::halflengthY ( ) const

inline

This method returns the halflength in local y.

Definition at line 134 of file CuboidVolumeBounds.h.

{ return m_halfY; }

halflengthZ()

double Trk::CuboidVolumeBounds::halflengthZ ( ) const

inline

This method returns the halflength in local z.

Definition at line 136 of file CuboidVolumeBounds.h.

{ return m_halfZ; }

inside()

bool Trk::CuboidVolumeBounds::inside ( const Amg::Vector3D & pos, double tol = 0. ) const

inlinefinaloverridevirtual

This method checks if position in the 3D volume frame is inside the cylinder.

Implements Trk::VolumeBounds.

Definition at line 126 of file CuboidVolumeBounds.h.

                                                         {
  return (fabs(pos.x()) <= m_halfX + tol && fabs(pos.y()) <= m_halfY + tol &&
          fabs(pos.z()) <= m_halfZ + tol);
}

operator=()

Trk::CuboidVolumeBounds & Trk::CuboidVolumeBounds::operator=

(

const CuboidVolumeBounds &

bobo

)

Assignment operator.

Definition at line 52 of file CuboidVolumeBounds.cxx.

{
  if (this != &bobo) {
    m_halfX = bobo.m_halfX;
    m_halfY = bobo.m_halfY;
    m_halfZ = bobo.m_halfZ;
    m_objectAccessor = bobo.m_objectAccessor;
  }
  return *this;
}

Member Data Documentation

m_halfX

double Trk::CuboidVolumeBounds::m_halfX

private

Definition at line 113 of file CuboidVolumeBounds.h.

m_halfY

double Trk::CuboidVolumeBounds::m_halfY

private

Definition at line 114 of file CuboidVolumeBounds.h.

m_halfZ

double Trk::CuboidVolumeBounds::m_halfZ

private

Definition at line 115 of file CuboidVolumeBounds.h.

m_objectAccessor

SixObjectsAccessor Trk::CuboidVolumeBounds::m_objectAccessor

private

There's only one single object Acessor for the moment has to be implemented if Cuboids are used more widely.

Definition at line 119 of file CuboidVolumeBounds.h.

---

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

• CuboidVolumeBounds.h
• CuboidVolumeBounds.cxx