Volume.hpp

Go to the documentation of this file. Or view the newest version in sPHENIX GitHub for file Volume.hpp

// This file is part of the Acts project.
//
// Copyright (C) 2016-2018 CERN for the benefit of the Acts project
//
// This Source Code Form is subject to the terms of the Mozilla Public
// License, v. 2.0. If a copy of the MPL was not distributed with this
// file, You can obtain one at http://mozilla.org/MPL/2.0/.

#pragma once

#include "Acts/Definitions/Algebra.hpp"
#include "Acts/Geometry/GeometryContext.hpp"
#include "Acts/Geometry/GeometryObject.hpp"
#include "Acts/Utilities/BinningType.hpp"
#include "Acts/Utilities/BoundingBox.hpp"

#include <iosfwd>
#include <memory>

namespace Acts {

class VolumeBounds;
using VolumeBoundsPtr = std::shared_ptr<const VolumeBounds>;


class Volume : public virtual GeometryObject {
 public:
  using BoundingBox = AxisAlignedBoundingBox<Volume, ActsScalar, 3>;

  Volume(const Transform3& transform, VolumeBoundsPtr volbounds);

  Volume(const Volume& vol, const Transform3& shift = Transform3::Identity());

  Volume() = delete;
  virtual ~Volume() = default;

  Volume& operator=(const Volume& vol);

  const Transform3& transform() const;

  const Transform3& itransform() const;

  const Vector3& center() const;

  const VolumeBounds& volumeBounds() const;

  BoundingBox boundingBox(const Vector3& envelope = {0, 0, 0}) const;

  const BoundingBox& orientedBoundingBox() const;

  bool inside(const Vector3& gpos, double tol = 0.) const;

  Vector3 binningPosition(const GeometryContext& gctx,
                          BinningValue bValue) const override;

 protected:
  Transform3 m_transform;
  Transform3 m_itransform;
  Vector3 m_center;
  VolumeBoundsPtr m_volumeBounds;
  BoundingBox m_orientedBoundingBox;
};

inline const Transform3& Volume::transform() const {
  return m_transform;
}

inline const Transform3& Volume::itransform() const {
  return m_itransform;
}

inline const Vector3& Volume::center() const {
  return m_center;
}

inline const VolumeBounds& Volume::volumeBounds() const {
  return (*(m_volumeBounds.get()));
}

std::ostream& operator<<(std::ostream& sl, const Volume& vol);

}  // namespace Acts