Import Geant4 3.0.0 source tree

source/geometry/solids/specific/include/G4EnclosingCylinder.hh

@@ -5,8 +5,8 @@
 // based on the Program) you indicate your acceptance of this statement,
 // and all its terms.
 //
-// $Id: G4EnclosingCylinder.hh,v 1.1 2000/04/07 10:55:42 gcosmo Exp $
-// GEANT4 tag $Name: geant4-02-00 $
+// $Id: G4EnclosingCylinder.hh,v 1.3 2000/11/02 16:54:48 gcosmo Exp $
+// GEANT4 tag $Name: geant4-03-00 $
 //
 //
 // --------------------------------------------------------------------
@@ -20,6 +20,8 @@
 //   is clearly outside a polyhedra or polycone or deciding if
 //   a trajectory is clearly going to miss those shapes.
 
+// Author: 
+//   David C. Williams (davidw@scipp.ucsc.edu)
 // --------------------------------------------------------------------
 
 #ifndef G4EnclosingCylinder_hh
@@ -31,17 +33,25 @@
 
 class G4ReduciblePolygon;
 
-class G4EnclosingCylinder {
-	public:
+class G4EnclosingCylinder
+{
+  public:  // with description
+
 	G4EnclosingCylinder( const G4ReduciblePolygon *rz,
-			     const G4bool phiIsOpen, 
-			     const G4double startPhi, const G4double totalPhi );
+			     G4bool phiIsOpen, 
+			     G4double startPhi, G4double totalPhi );
 	~G4EnclosingCylinder();
 	
 	G4bool MustBeOutside( const G4ThreeVector &p ) const;
+	  // Decide very rapidly if the point is outside the cylinder.
+	  // If one is not certain, return false.
+
 	G4bool ShouldMiss( const G4ThreeVector &p, const G4ThreeVector &v ) const;
-	
-	protected:
+	  // Decide very rapidly if the trajectory is going to miss the cylinder.
+	  // If one is not sure, return false.
+
+  protected:
+
 	G4double radius; 	// radius of our cylinder
 	G4double zLo, zHi;	// z extent