include/Geant4/G4GPSModel.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 //
0027 //
0028 //
0029 // John Allison  26th April 2017.
0030 //
0031 // Class Description:
0032 //
0033 // Model for a representation of the General Paricle Source.
0034
0035 #ifndef G4GPSMODEL_HH
0036 #define G4GPSMODEL_HH
0037
0038 #include "G4VModel.hh"
0039
0040 #include "G4String.hh"
0041 #include "G4Colour.hh"
0042
0043 class G4VGraphicsScene;
0044
0045 class G4GPSModel: public G4VModel {
0046
0047 public: // With description
0048
0049   G4GPSModel (const G4Colour& colour = G4Colour(1.,0.,0.,0.3));
0050   // Create with colour (default red and transparent).
0051
0052   virtual ~G4GPSModel ();
0053
0054   void DescribeYourselfTo (G4VGraphicsScene&);
0055   // The main task of a model is to describe itself to the graphics scene
0056   // handler (a object which inherits G4VSceneHandler, which inherits
0057   // G4VGraphicsScene).
0058
0059   G4String GetCurrentDescription () const;
0060   // A description which depends on the current state of the model.
0061
0062   G4String GetCurrentTag () const;
0063   // A tag which depends on the current state of the model.
0064
0065 protected:
0066
0067   G4Colour fColour;
0068
0069 private:
0070   // Private copy constructor and assigment operator - copying and
0071   // assignment not allowed.  Keeps CodeWizard happy.
0072   G4GPSModel (const G4GPSModel&);
0073   G4GPSModel& operator = (const G4GPSModel&);
0074 };
0075
0076 #endif