include/Geant4/G4CSGSolid.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 // G4CSGSolid
0027 //
0028 // Class description:
0029 //
0030 // An abstract class inherited from G4VSolid for Constructed Solids.
0031 // Used primarily to structure inheritance tree.
0032
0033 // Author: John Apostolakis (CERN), 27.03.1998 - Created first version
0034 // --------------------------------------------------------------------
0035
0036 #ifndef G4CSGSOLID_HH
0037 #define G4CSGSOLID_HH 1
0038
0039 #include "G4VSolid.hh"
0040
0041 /**
0042  * @brief G4CSGSolid is an abstract class inherited from G4VSolid for
0043  * Constructed Solids. Used primarily to structure inheritance tree.
0044  */
0045
0046 class G4CSGSolid : public G4VSolid
0047 {
0048   public:
0049
0050     /**
0051      * Constructor with a name.
0052      */
0053     G4CSGSolid(const G4String& pName);
0054
0055     /**
0056      * Destructor.
0057      */
0058     ~G4CSGSolid() override;
0059
0060     /**
0061      * Streams the object contents to an output stream.
0062      */
0063     std::ostream& StreamInfo(std::ostream& os) const override;
0064
0065     /**
0066      * Returns a pointer to the generated polyhedron for visualisation.
0067      */
0068     G4Polyhedron* GetPolyhedron () const override;
0069
0070     /**
0071      * Fake default constructor for usage restricted to direct object
0072      * persistency for clients requiring preallocation of memory for
0073      * persistifiable objects.
0074      */
0075     G4CSGSolid(__void__&);
0076
0077     /**
0078      * Copy constructor and assignment operator.
0079      */
0080     G4CSGSolid(const G4CSGSolid& rhs);
0081     G4CSGSolid& operator=(const G4CSGSolid& rhs);
0082
0083   protected:
0084
0085     /**
0086      * Utility function for subclasses to generate proper circular areas.
0087      */
0088     G4double GetRadiusInRing(G4double rmin, G4double rmax) const;
0089
0090   protected:
0091
0092     G4double fCubicVolume = 0.0;
0093     G4double fSurfaceArea = 0.0;
0094     mutable G4bool fRebuildPolyhedron = false;
0095     mutable G4Polyhedron* fpPolyhedron = nullptr;
0096 };
0097
0098 #endif