include/Geant4/G4VBooleanProcessor.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 // G4VBooleanProcessor
0027 //
0028 // Class description:
0029 //
0030 // Virtual base class for Boolean solid processing.
0031
0032 // Author: Stewart Boogert (Manchester University), 20.03.2023 - Created
0033 // --------------------------------------------------------------------
0034 #ifndef G4VBOOLEANPROCESSOR_HH
0035 #define G4VBOOLEANPROCESSOR_HH
0036
0037 class G4Polyhedron;
0038 class G4PolyhedronArbitrary;
0039 class G4BooleanSolid;
0040 class G4VSolid;
0041
0042 /**
0043  * @brief G4VBooleanProcessor is a virtual base class for Boolean solid
0044  * processing.
0045  */
0046
0047 class G4VBooleanProcessor
0048 {
0049   public:
0050
0051     /**
0052      * Default constructor and destructor.
0053      */
0054     G4VBooleanProcessor() = default;
0055     virtual ~G4VBooleanProcessor() = default;
0056
0057     /**
0058      * Boolean operations on polyhedrons of the component solids.
0059      * To be implemented in derived classes.
0060      */
0061     virtual G4PolyhedronArbitrary* Intersection(G4Polyhedron* /*p1*/,
0062                                                 G4Polyhedron* /*p2*/)
0063       { return nullptr; }
0064     virtual G4PolyhedronArbitrary* Union(G4Polyhedron* /*p1*/,
0065                                          G4Polyhedron* /*p2*/)
0066       { return nullptr; }
0067     virtual G4PolyhedronArbitrary* Subtraction(G4Polyhedron* /*p1*/,
0068                                                G4Polyhedron* /*p2*/)
0069       { return nullptr; }
0070
0071     /**
0072      * Processing method of the final solid.
0073      * To be implemented in derived classes.
0074      */
0075     virtual G4PolyhedronArbitrary* Process(const G4VSolid* /*bs*/)
0076       { return nullptr; }
0077 };
0078
0079 #endif