Geant4 Cross Reference |
1 // 1 // 2 // ******************************************* 2 // ******************************************************************** 3 // * License and Disclaimer << 3 // * DISCLAIMER * 4 // * 4 // * * 5 // * The Geant4 software is copyright of th << 5 // * The following disclaimer summarizes all the specific disclaimers * 6 // * the Geant4 Collaboration. It is provided << 6 // * of contributors to this software. The specific disclaimers,which * 7 // * conditions of the Geant4 Software License << 7 // * govern, are listed with their locations in: * 8 // * LICENSE and available at http://cern.ch/ << 8 // * http://cern.ch/geant4/license * 9 // * include a list of copyright holders. << 10 // * 9 // * * 11 // * Neither the authors of this software syst 10 // * Neither the authors of this software system, nor their employing * 12 // * institutes,nor the agencies providing fin 11 // * institutes,nor the agencies providing financial support for this * 13 // * work make any representation or warran 12 // * work make any representation or warranty, express or implied, * 14 // * regarding this software system or assum 13 // * regarding this software system or assume any liability for its * 15 // * use. Please see the license in the file << 14 // * use. * 16 // * for the full disclaimer and the limitatio << 17 // * 15 // * * 18 // * This code implementation is the result << 16 // * This code implementation is the intellectual property of the * 19 // * technical work of the GEANT4 collaboratio << 17 // * GEANT4 collaboration. * 20 // * By using, copying, modifying or distri << 18 // * By copying, distributing or modifying the Program (or any work * 21 // * any work based on the software) you ag << 19 // * based on the Program) you indicate your acceptance of this * 22 // * use in resulting scientific publicati << 20 // * statement, and all its terms. * 23 // * acceptance of all terms of the Geant4 Sof << 24 // ******************************************* 21 // ******************************************************************** 25 // 22 // 26 // G4VoxelLimits << 23 // >> 24 // $Id: G4VoxelLimits.hh,v 1.6 2002/04/19 08:20:18 gcosmo Exp $ >> 25 // GEANT4 tag $Name: geant4-04-01 $ >> 26 // >> 27 // class G4VoxelLimits 27 // 28 // 28 // Class description: 29 // Class description: 29 // 30 // 30 // Represents limitation/restrictions of space 31 // Represents limitation/restrictions of space, where restrictions 31 // are only made perpendicular to the cartesia 32 // are only made perpendicular to the cartesian axes. 32 // 33 // >> 34 // 33 // Member data: 35 // Member data: 34 // 36 // 35 // G4double fxAxisMin,fxAxisMax 37 // G4double fxAxisMin,fxAxisMax 36 // G4double fyAxisMin,fyAxisMax 38 // G4double fyAxisMin,fyAxisMax 37 // G4double fzAxisMin,fzAxisMax 39 // G4double fzAxisMin,fzAxisMax 38 // - The min and max values along each axis. + << 40 // - The min and max values along each axis. +-kInfinity if not restricted. >> 41 // >> 42 // >> 43 // Notes: >> 44 // >> 45 // Beware no break statements after returns in switch(pAxis)s. >> 46 >> 47 // History: >> 48 // 13.07.95 P.Kent Initial version. 39 49 40 // 13.07.95, P.Kent - Initial version. << 41 // ------------------------------------------- << 42 #ifndef G4VOXELLIMITS_HH 50 #ifndef G4VOXELLIMITS_HH 43 #define G4VOXELLIMITS_HH 1 << 51 #define G4VOXELLIMITS_HH 44 52 45 #include "G4Types.hh" << 53 #include "globals.hh" 46 #include "geomdefs.hh" 54 #include "geomdefs.hh" 47 55 48 #include "G4ThreeVector.hh" 56 #include "G4ThreeVector.hh" >> 57 #include "g4std/iostream" 49 58 50 #include <assert.h> 59 #include <assert.h> 51 60 52 class G4VoxelLimits 61 class G4VoxelLimits 53 { 62 { 54 public: << 63 public: // with description 55 64 56 G4VoxelLimits() = default; << 65 G4VoxelLimits(); 57 // Constructor - initialise to be unlimi 66 // Constructor - initialise to be unlimited. Volume unrestricted. 58 67 59 ~G4VoxelLimits() = default; << 68 ~G4VoxelLimits(); 60 // Destructor. No actions. 69 // Destructor. No actions. 61 70 62 void AddLimit(const EAxis pAxis, const G4d << 71 void AddLimit(const EAxis pAxis, const G4double pMin,const G4double pMax); 63 // Restrict the volume to between specif 72 // Restrict the volume to between specified min and max along the 64 // given axis. Cartesian axes only, pMin 73 // given axis. Cartesian axes only, pMin<=pMax. 65 74 66 G4double GetMaxXExtent() const; 75 G4double GetMaxXExtent() const; 67 // Return maximum x extent. 76 // Return maximum x extent. 68 G4double GetMaxYExtent() const; 77 G4double GetMaxYExtent() const; 69 // Return maximum y extent. 78 // Return maximum y extent. 70 G4double GetMaxZExtent() const; 79 G4double GetMaxZExtent() const; 71 // Return maximum z extent. 80 // Return maximum z extent. 72 81 73 G4double GetMinXExtent() const; 82 G4double GetMinXExtent() const; 74 // Return minimum x extent. 83 // Return minimum x extent. 75 G4double GetMinYExtent() const; 84 G4double GetMinYExtent() const; 76 // Return minimum y extent. 85 // Return minimum y extent. 77 G4double GetMinZExtent() const; 86 G4double GetMinZExtent() const; 78 // Return minimum z extent. 87 // Return minimum z extent. 79 88 80 G4double GetMaxExtent(const EAxis pAxis) c 89 G4double GetMaxExtent(const EAxis pAxis) const; 81 // Return maximum extent of volume along 90 // Return maximum extent of volume along specified axis. 82 G4double GetMinExtent(const EAxis pAxis) c 91 G4double GetMinExtent(const EAxis pAxis) const; 83 // Return minimum extent of volume along 92 // Return minimum extent of volume along specified axis. 84 93 85 G4bool IsXLimited() const; 94 G4bool IsXLimited() const; 86 // Return true if the x axis is limited. 95 // Return true if the x axis is limited. 87 G4bool IsYLimited() const; 96 G4bool IsYLimited() const; 88 // Return true if the y axis is limited. 97 // Return true if the y axis is limited. 89 G4bool IsZLimited() const; 98 G4bool IsZLimited() const; 90 // Return true if the z axis is limited. 99 // Return true if the z axis is limited. 91 100 92 G4bool IsLimited() const; 101 G4bool IsLimited() const; 93 // Return true if limited along any axis 102 // Return true if limited along any axis 94 G4bool IsLimited(const EAxis pAxis) const; 103 G4bool IsLimited(const EAxis pAxis) const; 95 // Return true if the specified axis is 104 // Return true if the specified axis is restricted/limited. 96 105 97 G4bool ClipToLimits(G4ThreeVector& pStart, << 106 G4bool ClipToLimits(G4ThreeVector& pStart,G4ThreeVector& pEnd) const; 98 // Clip the line segment pStart->pEnd to 107 // Clip the line segment pStart->pEnd to the volume described by the 99 // current limits. Return true if the li 108 // current limits. Return true if the line remains after clipping, 100 // else false, and leave the vectors in 109 // else false, and leave the vectors in an undefined state. 101 110 102 G4bool Inside(const G4ThreeVector& pVec) c 111 G4bool Inside(const G4ThreeVector& pVec) const; 103 // Return true if the specified vector i 112 // Return true if the specified vector is inside/on boundaries of limits. 104 113 105 G4int OutCode(const G4ThreeVector& pVec) c 114 G4int OutCode(const G4ThreeVector& pVec) const; 106 // Calculate the `outcode' for the speci 115 // Calculate the `outcode' for the specified vector. 107 // Intended for use during clipping agai 116 // Intended for use during clipping against the limits 108 // The bits are set given the following 117 // The bits are set given the following conditions: 109 // 0 pVec.x()<fxAxisMin && IsXLim 118 // 0 pVec.x()<fxAxisMin && IsXLimited() 110 // 1 pVec.x()>fxAxisMax && IsXLim 119 // 1 pVec.x()>fxAxisMax && IsXLimited() 111 // 2 pVec.y()<fyAxisMin && IsYLim 120 // 2 pVec.y()<fyAxisMin && IsYLimited() 112 // 3 pVec.y()>fyAxisMax && IsYLim 121 // 3 pVec.y()>fyAxisMax && IsYLimited() 113 // 4 pVec.z()<fzAxisMin && IsZLim 122 // 4 pVec.z()<fzAxisMin && IsZLimited() 114 // 5 pVec.z()>fzAxisMax && IsZLim 123 // 5 pVec.z()>fzAxisMax && IsZLimited() 115 124 116 private: 125 private: 117 126 118 G4double fxAxisMin = -kInfinity, fxAxisMax << 127 G4double fxAxisMin,fxAxisMax; 119 G4double fyAxisMin = -kInfinity, fyAxisMax << 128 G4double fyAxisMin,fyAxisMax; 120 G4double fzAxisMin = -kInfinity, fzAxisMax << 129 G4double fzAxisMin,fzAxisMax; 121 }; 130 }; 122 131 123 #include "G4VoxelLimits.icc" 132 #include "G4VoxelLimits.icc" 124 133 125 std::ostream& operator << (std::ostream& os, c << 134 G4std::ostream& operator << (G4std::ostream& os, const G4VoxelLimits& pLim); 126 // Print the limits to the stream in the for 135 // Print the limits to the stream in the form: 127 // "{(xmin,xmax) (ymin,ymax) (zmin,zmax)}" 136 // "{(xmin,xmax) (ymin,ymax) (zmin,zmax)}" 128 // Replace (xmin,xmax) by (-,-) when not li 137 // Replace (xmin,xmax) by (-,-) when not limited. 129 138 130 #endif 139 #endif 131 140