Analysis Software
Documentation for sPHENIX simulation software
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Groups Pages
Acts::AbstractVolume Class Reference

#include <acts/blob/sPHENIX/Core/include/Acts/Geometry/AbstractVolume.hpp>

+ Inheritance diagram for Acts::AbstractVolume:
+ Collaboration diagram for Acts::AbstractVolume:

Public Member Functions

 AbstractVolume (const Transform3 &transform, VolumeBoundsPtr volbounds)
 
 AbstractVolume (const AbstractVolume &vol)=default
 
 AbstractVolume ()=delete
 
 ~AbstractVolume () override=default
 
AbstractVolumeoperator= (const AbstractVolume &vol)=delete
 
const std::vector
< BoundarySurfacePtr > & 
boundarySurfaces () const
 
- Public Member Functions inherited from Acts::Volume
 Volume (const Transform3 &transform, VolumeBoundsPtr volbounds)
 
 Volume (const Volume &vol, const Transform3 &shift=Transform3::Identity())
 
 Volume ()=delete
 
virtual ~Volume ()=default
 
Volumeoperator= (const Volume &vol)
 
const Transform3transform () const
 Return methods for geometry transform.
 
const Transform3itransform () const
 Returns the inverted transform of this volume.
 
const Vector3center () const
 returns the center of the volume
 
const VolumeBoundsvolumeBounds () const
 returns the volumeBounds()
 
BoundingBox boundingBox (const Vector3 &envelope={0, 0, 0}) const
 
const BoundingBoxorientedBoundingBox () const
 
bool inside (const Vector3 &gpos, double tol=0.) const
 
Vector3 binningPosition (const GeometryContext &gctx, BinningValue bValue) const override
 
- Public Member Functions inherited from Acts::GeometryObject
 GeometryObject ()=default
 Defaulted constructor.
 
 GeometryObject (const GeometryObject &)=default
 Defaulted copy constructor.
 
 GeometryObject (const GeometryIdentifier &geometryId)
 
GeometryObjectoperator= (const GeometryObject &geometryId)
 
const GeometryIdentifiergeometryId () const
 
virtual double binningPositionValue (const GeometryContext &gctx, BinningValue bValue) const
 
void assignGeometryId (const GeometryIdentifier &geometryId)
 

Private Member Functions

void createBoundarySurfaces ()
 Private method to create BoundarySurfaces.
 

Private Attributes

std::vector< BoundarySurfacePtrm_boundarySurfaces
 boundary Surfaces for this volume
 

Additional Inherited Members

- Public Types inherited from Acts::Volume
using BoundingBox = AxisAlignedBoundingBox< Volume, ActsScalar, 3 >
 
- Protected Attributes inherited from Acts::Volume
Transform3 m_transform
 
Transform3 m_itransform
 
Vector3 m_center
 
VolumeBoundsPtr m_volumeBounds
 
BoundingBox m_orientedBoundingBox
 

Detailed Description

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

The Acts::AbstractVolume is constructed by giving a pointer to a Transform3 and a pointer to Acts::VolumeBounds, this implies that the ownership of the objects pointed to is passed as well. For memory optimisation, the AbstractVolume can also be constructed with shared_ptr objects.

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

Boundary surfaces can be shared between AbstractVolumes to enhance automatic navigation between AbstractVolumes, therefore they are reference counted by a std::shared_ptr holder class.

Definition at line 49 of file AbstractVolume.hpp.

View newest version in sPHENIX GitHub at line 49 of file AbstractVolume.hpp

Constructor & Destructor Documentation

Acts::AbstractVolume::AbstractVolume ( const Transform3 transform,
VolumeBoundsPtr  volbounds 
)

Constructor with shared Transform3*, VolumeBounds*

Parameters
transformis the global 3d transformation into the volume frame
volboundsis the boundary definition
Acts::AbstractVolume::AbstractVolume ( const AbstractVolume vol)
default
Acts::AbstractVolume::AbstractVolume ( )
delete
Acts::AbstractVolume::~AbstractVolume ( )
overridedefault

Member Function Documentation

const std::vector< Acts::BoundarySurfacePtr > & Acts::AbstractVolume::boundarySurfaces ( ) const

Method to return the BoundarySurfaces

Returns
the vector of boundary surfaces

Definition at line 24 of file AbstractVolume.cpp.

View newest version in sPHENIX GitHub at line 24 of file AbstractVolume.cpp

Referenced by Acts::TrackingVolume::closeGeometry(), Acts::TrackingVolume::compatibleSurfacesFromHierarchy(), and Acts::GeometryView3D::drawVolume().

+ Here is the caller graph for this function:

void Acts::AbstractVolume::createBoundarySurfaces ( )
private

Private method to create BoundarySurfaces.

Definition at line 28 of file AbstractVolume.cpp.

View newest version in sPHENIX GitHub at line 28 of file AbstractVolume.cpp

References m_transform(), testing::internal::move(), Acts::Direction::Negative, Acts::VolumeBounds::orientedSurfaces(), and Acts::Volume::volumeBounds().

+ Here is the call graph for this function:

AbstractVolume& Acts::AbstractVolume::operator= ( const AbstractVolume vol)
delete

Member Data Documentation

std::vector<BoundarySurfacePtr> Acts::AbstractVolume::m_boundarySurfaces
private

boundary Surfaces for this volume

Definition at line 73 of file AbstractVolume.hpp.

View newest version in sPHENIX GitHub at line 73 of file AbstractVolume.hpp


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