include/Geant4/G4SolidExtentList.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 // G4SolidExtentList
0027 //
0028 // Class description:
0029 //
0030 // Defines a list of (voxel) extents along one axis.
0031 //
0032 // This utility class is designed for one specific purpose:
0033 // to calculate the extent of a CSG-like solid for a voxel
0034 // (G4VSolid::CalculateExtent).
0035
0036 // Author: David C. Williams (UCSC), 1998
0037 // --------------------------------------------------------------------
0038 #ifndef G4SOLIDEXTENTLIST_HH
0039 #define G4SOLIDEXTENTLIST_HH
0040
0041 #include "G4Types.hh"
0042
0043 #include "G4ClippablePolygon.hh"
0044
0045 /**
0046  * @brief G4SolidExtentList is utility class designed for calculating
0047  * the extent of a CSG-like solid for a voxel.
0048  */
0049
0050 class G4SolidExtentList
0051 {
0052   public:
0053
0054     /**
0055      * Default Constructor.
0056      */
0057     G4SolidExtentList();
0058
0059     /**
0060      * Constructor provided axis and limits.
0061      *  @param[in] targetAxis Axis along which compute the extent.
0062      *  @param[in] voxelLimits The limiting space dictated by voxels.
0063      */
0064     G4SolidExtentList( const EAxis targetAxis,
0065                        const G4VoxelLimits& voxelLimits );
0066
0067     /**
0068      * Default Destructor.
0069      */
0070     ~G4SolidExtentList() = default;
0071
0072     /**
0073      * Categorises polygon surfaces.
0074      */
0075     void AddSurface( const G4ClippablePolygon& surface );
0076
0077     /**
0078      * Returns extent after processing all surfaces.
0079      *  @param[out] min The minimum extent
0080      *  @param[out] max The maximum extent
0081      *  @returns false if no surfaces within limits or facing inwards.
0082      */
0083     G4bool GetExtent( G4double& min, G4double& max ) const;
0084
0085   private:
0086
0087     /** Axis and limits... */
0088     EAxis axis;     // Target axis
0089     G4bool limited = false;  // True if limited
0090     G4double minLimit; // ... min limit
0091     G4double maxLimit; // ... max limit
0092
0093     /** Surfaces within the limits... */
0094     G4ClippablePolygon minSurface,  // Minimum surface within limits
0095                        maxSurface,  // Maximum surface within limits
0096                        minAbove,    // Minimum surface totally above max limit
0097                        maxBelow;    // Maximum surface totally below min limit
0098 };
0099
0100 #endif