include/Geant4/G4VisTrajContext.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 // Jane Tinslay May 2006
0028 //
0029 #ifndef G4VISTRAJCONTEXT_HH
0030 #define G4VISTRAJCONTEXT_HH
0031
0032 #include "G4Colour.hh"
0033 #include "G4Polymarker.hh"
0034
0035 class G4VisTrajContext {
0036
0037 public:
0038
0039   // Default configuration
0040   G4VisTrajContext(const G4String& name = "Unspecified");
0041
0042   // Destructor
0043   virtual ~G4VisTrajContext();
0044
0045   G4String Name() const;
0046
0047   void SetVisible(const G4bool& visible);
0048
0049   // Print configuration
0050   void Print(std::ostream& ostr) const;
0051
0052   // Line
0053   void SetLineColour(const G4Colour& colour);
0054   G4Colour GetLineColour() const;
0055
0056   void SetLineWidth(const G4double& width);
0057   G4double GetLineWidth() const;
0058
0059   void SetDrawLine(const G4bool& draw);
0060   G4bool GetDrawLine() const;
0061
0062   void SetLineVisible(const G4bool& visible);
0063   G4bool GetLineVisible() const;
0064
0065   // Auxiliary points
0066   void SetDrawAuxPts(const G4bool& draw);
0067   G4bool GetDrawAuxPts() const;
0068
0069   void SetAuxPtsType(const G4Polymarker::MarkerType& marker);
0070   G4Polymarker::MarkerType GetAuxPtsType() const;
0071
0072   void SetAuxPtsSize(const G4double& size);
0073   G4double GetAuxPtsSize() const;
0074
0075   void SetAuxPtsSizeType(const G4VMarker::SizeType& sizeType);
0076   G4VMarker::SizeType GetAuxPtsSizeType() const;
0077
0078   void SetAuxPtsFillStyle(const G4VMarker::FillStyle& style);
0079   G4VMarker::FillStyle GetAuxPtsFillStyle() const;
0080
0081   void SetAuxPtsColour(const G4Colour& colour);
0082   G4Colour GetAuxPtsColour() const;
0083
0084   void SetAuxPtsVisible(const G4bool& visible);
0085   G4bool GetAuxPtsVisible() const;
0086
0087   // Step points
0088   void SetDrawStepPts(const G4bool& draw);
0089   G4bool GetDrawStepPts() const;
0090
0091   void SetStepPtsType(const G4Polymarker::MarkerType& marker);
0092   G4Polymarker::MarkerType GetStepPtsType() const;
0093
0094   void SetStepPtsSize(const G4double& size);
0095   G4double GetStepPtsSize() const;
0096
0097   void SetStepPtsSizeType(const G4VMarker::SizeType& sizeType);
0098   G4VMarker::SizeType GetStepPtsSizeType() const;
0099
0100   void SetStepPtsFillStyle(const G4VMarker::FillStyle& style);
0101   G4VMarker::FillStyle GetStepPtsFillStyle() const;
0102
0103   void SetStepPtsColour(const G4Colour& colour);
0104   G4Colour GetStepPtsColour() const;
0105
0106   void SetStepPtsVisible(const G4bool& visible);
0107   G4bool GetStepPtsVisible() const;
0108
0109   void SetTimeSliceInterval(const G4double& interval);
0110   G4double GetTimeSliceInterval() const;
0111
0112 private:
0113
0114   // Data members
0115   G4String fName;
0116
0117   // Line data
0118   G4double fLineWidth;
0119   G4Colour fLineColour;
0120   G4bool fLineVisible;
0121   G4bool fDrawLine;
0122
0123   // Auxiliary point data
0124   G4bool fDrawAuxPts;
0125   G4Polymarker::MarkerType fAuxPtsType;
0126   G4double fAuxPtsSize;
0127   G4VMarker::SizeType fAuxPtsSizeType;
0128   G4VMarker::FillStyle fAuxPtsFillStyle;
0129   G4Colour fAuxPtsColour;
0130   G4bool fAuxPtsVisible;
0131
0132   // Step point data
0133   G4bool fDrawStepPts;
0134   G4Polymarker::MarkerType fStepPtsType;
0135   G4double fStepPtsSize;
0136   G4VMarker::SizeType fStepPtsSizeType;
0137   G4VMarker::FillStyle fStepPtsFillStyle;
0138   G4Colour fStepPtsColour;
0139   G4bool fStepPtsVisible;
0140
0141   // Time slicing
0142   G4double fTimeSliceInterval;
0143
0144 };
0145
0146 #include "G4VisTrajContext.icc"
0147
0148 #endif
0149