include/Geant4/G4UBox.hh

0001 //
0002 // ********************************************************************
0003 // * License and Disclaimer                                           *
0004 // *                                                                  *
0005 // * The  Geant4 software  is  copyright of the Copyright Holders  of *
0006 // * the Geant4 Collaboration.  It is provided  under  the terms  and *
0007 // * conditions of the Geant4 Software License,  included in the file *
0008 // * LICENSE and available at  http://cern.ch/geant4/license .  These *
0009 // * include a list of copyright holders.                             *
0010 // *                                                                  *
0011 // * Neither the authors of this software system, nor their employing *
0012 // * institutes,nor the agencies providing financial support for this *
0013 // * work  make  any representation or  warranty, express or implied, *
0014 // * regarding  this  software system or assume any liability for its *
0015 // * use.  Please see the license in the file  LICENSE  and URL above *
0016 // * for the full disclaimer and the limitation of liability.         *
0017 // *                                                                  *
0018 // * This  code  implementation is the result of  the  scientific and *
0019 // * technical work of the GEANT4 collaboration.                      *
0020 // * By using,  copying,  modifying or  distributing the software (or *
0021 // * any work based  on the software)  you  agree  to acknowledge its *
0022 // * use  in  resulting  scientific  publications,  and indicate your *
0023 // * acceptance of all terms of the Geant4 Software license.          *
0024 // ********************************************************************
0025 //
0026 // G4UBox
0027 //
0028 // Class description:
0029 //
0030 // Wrapper class for G4Box to make use of VecGeom Box.
0031
0032 // Author: G.Cosmo (CERN), 13.09.2013
0033 // --------------------------------------------------------------------
0034 #ifndef G4UBOX_HH
0035 #define G4UBOX_HH
0036
0037 #include "G4UAdapter.hh"
0038
0039 #if ( defined(G4GEOM_USE_USOLIDS) || defined(G4GEOM_USE_PARTIAL_USOLIDS) )
0040
0041 #include <VecGeom/volumes/UnplacedBox.h>
0042
0043 #include "G4Polyhedron.hh"
0044
0045 /**
0046  * @brief G4UBox is a wrapper class for G4Box to make use of VecGeom Box.
0047  */
0048
0049 class G4UBox : public G4UAdapter<vecgeom::UnplacedBox>
0050 {
0051   using Shape_t = vecgeom::UnplacedBox;
0052   using Base_t = G4UAdapter<vecgeom::UnplacedBox>;
0053
0054   public:
0055
0056     /**
0057      * Constructs a box with name, and half lengths pX, pY, pZ.
0058      *  @param[in] pName The name of the solid.
0059      *  @param[in] pX Half length in X.
0060      *  @param[in] pY Half length in Y.
0061      *  @param[in] pZ Half length in Z.
0062      */
0063     G4UBox(const G4String& pName, G4double pX, G4double pY, G4double pZ);
0064
0065     /**
0066      * Default destructor.
0067      */
0068    ~G4UBox() override = default;
0069
0070     /**
0071      * Dispatch method for parameterisation replication mechanism and
0072      * dimension computation.
0073      */
0074     void ComputeDimensions(G4VPVParameterisation* p,
0075                            const G4int n,
0076                            const G4VPhysicalVolume* pRep) override;
0077
0078     /**
0079      * Makes a clone of the object for use in multi-treading.
0080      *  @returns A pointer to the new cloned allocated solid.
0081      */
0082     G4VSolid* Clone() const override;
0083
0084     /**
0085      * Accessors and modifiers.
0086      */
0087     G4double GetXHalfLength() const;
0088     G4double GetYHalfLength() const;
0089     G4double GetZHalfLength() const;
0090     void SetXHalfLength(G4double dx);
0091     void SetYHalfLength(G4double dy);
0092     void SetZHalfLength(G4double dz);
0093
0094     /**
0095      * Returns the type ID, "G4Box" of the solid.
0096      */
0097     inline G4GeometryType GetEntityType() const override;
0098
0099     /**
0100      * Returns true as the solid has only planar faces.
0101      */
0102     inline G4bool IsFaceted() const override;
0103
0104     /**
0105      * Computes the bounding limits of the solid.
0106      *  @param[out] pMin The minimum bounding limit point.
0107      *  @param[out] pMax The maximum bounding limit point.
0108      */
0109     void BoundingLimits(G4ThreeVector& pMin, G4ThreeVector& pMax) const override;
0110
0111     /**
0112      * Calculates the minimum and maximum extent of the solid, when under the
0113      * specified transform, and within the specified limits.
0114      *  @param[in] pAxis The axis along which compute the extent.
0115      *  @param[in] pVoxelLimit The limiting space dictated by voxels.
0116      *  @param[in] pTransform The internal transformation applied to the solid.
0117      *  @param[out] pMin The minimum extent value.
0118      *  @param[out] pMax The maximum extent value.
0119      *  @returns True if the solid is intersected by the extent region.
0120      */
0121     G4bool CalculateExtent(const EAxis pAxis,
0122                            const G4VoxelLimits& pVoxelLimit,
0123                            const G4AffineTransform& pTransform,
0124                            G4double& pMin, G4double& pMax) const override;
0125
0126     /**
0127      * Returns a generated polyhedron as graphical representations.
0128      */
0129     G4Polyhedron* CreatePolyhedron() const override;
0130
0131     /**
0132      * Copy constructor and assignment operator.
0133      */
0134     G4UBox(const G4UBox& rhs);
0135     G4UBox& operator=(const G4UBox& rhs);
0136 };
0137
0138 // --------------------------------------------------------------------
0139 // Inline methods
0140 // --------------------------------------------------------------------
0141
0142 inline G4GeometryType G4UBox::GetEntityType() const
0143 {
0144   return "G4Box";
0145 }
0146
0147 inline G4bool G4UBox::IsFaceted() const
0148 {
0149   return true;
0150 }
0151
0152 #endif  // G4GEOM_USE_USOLIDS
0153
0154 #endif