include/Geant4/G4AuxiliaryNavServices.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 // G4AuxiliaryNavServices
0027 //
0028 // Class description:
0029 //
0030 // Utility class for navigation.
0031
0032 // Author: Paul Kent (CERN), August 1996
0033 // --------------------------------------------------------------------
0034 #ifndef G4AuxiliaryNavServices_hh
0035 #define G4AuxiliaryNavServices_hh 1
0036
0037 #include "G4Types.hh"
0038 #include "G4ThreeVector.hh"
0039 #include "G4VSolid.hh"
0040 #include "G4AffineTransform.hh"
0041
0042 /**
0043  * @brief G4AuxiliaryNavServices a utility class for navigation.
0044  */
0045
0046 class G4AuxiliaryNavServices
0047 {
0048   public:
0049
0050     /**
0051      * Is the track (point, direction) inside the solid 'sampleSolid' ?
0052      *  @param[in] sampleSolid Pointer to the shape to check.
0053      *  @param[in,out] localPoint Point in local coordinates system.
0054      *  @param[in,out] globalDirection Pointer to global direction or null.
0055      *  @param[in] sampleTransform Affine transformation in space.
0056      *  @param[in] pLocatedOnEdge Flag specifying if point is located on edge.
0057      * @returns True if we are going to enter the volume, which is the case
0058      *          if the point is inside, or the point is on the surface and
0059      *          the direction points inside or along it. Else returns false.
0060      */
0061     static G4bool CheckPointOnSurface( const G4VSolid* sampleSolid,
0062                                        const G4ThreeVector& localPoint,
0063                                        const G4ThreeVector* globalDirection,
0064                                        const G4AffineTransform& sampleTransform,
0065                                        const G4bool locatedOnEdge);
0066
0067     /**
0068      * Is the track (point, direction) exiting the solid 'sampleSolid' ?
0069      *  @returns True if we are going to exit the volume.
0070      *  @param[in] sampleSolid Pointer to the shape to check.
0071      *  @param[in,out] localPoint Point in local coordinates system.
0072      *  @param[in,out] globalDirection Pointer to global direction or null.
0073      *  @param[in] sampleTransform Affine transformation in space.
0074      */
0075     static G4bool CheckPointExiting( const G4VSolid* sampleSolid,
0076                                      const G4ThreeVector& localPoint,
0077                                      const G4ThreeVector* globalDirection,
0078                                      const G4AffineTransform& sampleTransform );
0079
0080     /**
0081      * Prints global values of Cartesian, Radial and Angle Tolerances.
0082      */
0083     static void ReportTolerances();
0084 };
0085
0086 #include "G4AuxiliaryNavServices.icc"
0087
0088 #endif