BlineTracer/include/G4BlineEventAction.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 /// \file G4BlineEventAction.hh
0027 /// \brief Definition of the G4BlineEventAction class
0028
0029 // --------------------------------------------------------------------
0030 //
0031 // G4BlineEventAction
0032 //
0033 // Class description:
0034 //
0035 // Defines the EventAction used during tracing of magnetic field
0036 // lines. During the EndOfEventAction() it stores magneticfield lines
0037 // as polyline and polymarker objects.
0038 // These polyline and polymarker objects can be drawn by using the
0039 // DrawFieldLines() method.
0040
0041 // --------------------------------------------------------------------
0042 // Author: Laurent Desorgher (desorgher@phim.unibe.ch)
0043 //         Created - 2003-10-06
0044 // --------------------------------------------------------------------
0045 #ifndef G4BlineEventAction_h
0046 #define G4BlineEventAction_h 1
0047
0048 #include "G4Colour.hh"
0049 #include "G4UserEventAction.hh"
0050 #include "G4VisAttributes.hh"
0051
0052 class G4Event;
0053 class G4Polyline;
0054 class G4Polymarker;
0055 class G4BlineTracer;
0056
0057 class G4BlineEventAction : public G4UserEventAction
0058 {
0059   public:  // with description
0060     G4BlineEventAction(G4BlineTracer* aBlineTool);
0061     ~G4BlineEventAction() override;
0062
0063     void BeginOfEventAction(const G4Event*) override;
0064     void EndOfEventAction(const G4Event*) override;
0065
0066     void DrawFieldLines(G4double zoom, G4double theta, G4double phi);
0067     void ResetVectorObjectToBeDrawn();
0068
0069   public:  // with description
0070     inline void SetDrawColour(G4Colour aColour) { fDrawColour = aColour; }
0071     inline void SetDrawBline(G4bool aBool) { fDrawBline = aBool; }
0072     inline void SetDrawPoints(G4bool aBool) { fDrawPoints = aBool; }
0073     inline void SetPointSize(G4double aVal) { fPointSize = aVal; }
0074     inline G4bool GetDrawBline() { return fDrawBline; }
0075
0076   public:  // without description
0077            // inline void SetDrawLineWidth(G4double aVal)
0078            //   { fTrajectoryVisAttributes.SetLineWidth(aVal); }
0079            // inline void SetDrawLineStyle(G4VisAttributes::LineStyle aStyle)
0080            //   { fTrajectoryVisAttributes.SetLineStyle(aStyle); }
0081            // Future implementation...
0082   private:
0083     G4BlineTracer* fBlineTool = nullptr;
0084     G4Colour fDrawColour;
0085     G4bool fDrawBline = false;
0086     G4bool fDrawPoints = false;
0087     G4double fPointSize = 1;
0088     std::vector<G4VisAttributes*> fTrajectoryVisAttributes;
0089     std::vector<G4Polyline> fTrajectoryPolyline;
0090     std::vector<G4Polymarker> fTrajectoryPoints;
0091 };
0092
0093 #endif