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