include/Geant4/G4VGraphicsSystem.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  27th March 1996
0030 //
0031 // Class description
0032 //
0033 // Abstract interface class for graphics systems.
0034
0035 #ifndef G4VGRAPHICSSYSTEM_HH
0036 #define G4VGRAPHICSSYSTEM_HH
0037
0038 #include "globals.hh"
0039
0040 #include <vector>
0041
0042 class G4VSceneHandler;
0043 class G4VViewer;
0044
0045 class G4VGraphicsSystem {
0046
0047 public: // With description
0048
0049   enum Functionality {
0050     noFunctionality
0051     ,nonEuclidian       // e.g., tree representation of geometry hierarchy.
0052     ,twoD               // Simple 2D, e.g., X (no stored structures).
0053     ,twoDStore          // 2D with stored structures.
0054     ,threeD             // Passive 3D (with stored structures).
0055     ,threeDInteractive  // 3D with "pick" functionality.
0056     ,virtualReality     // Virtual Reality functionality.
0057     ,fileWriter         // File writer
0058   };
0059
0060   G4VGraphicsSystem (const G4String& name,
0061              Functionality f);
0062
0063   G4VGraphicsSystem (const G4String& name,
0064              const G4String& nickname,
0065              Functionality f);
0066
0067   G4VGraphicsSystem (const G4String& name,
0068              const G4String& nickname,
0069              const G4String& description,
0070              Functionality f);
0071
0072   virtual ~G4VGraphicsSystem ();
0073
0074   virtual G4VSceneHandler* CreateSceneHandler (const G4String& name) = 0;
0075
0076   virtual G4VViewer* CreateViewer (G4VSceneHandler&, const G4String& name) = 0;
0077
0078   // Access functions.
0079   const G4String& GetName                   () const {return fName;}
0080   const G4String& GetNickname               () const {return fNicknames[0];}
0081   const std::vector<G4String>& GetNicknames () const {return fNicknames;}
0082   const G4String& GetDescription            () const {return fDescription;}
0083   Functionality   GetFunctionality          () const {return fFunctionality;}
0084   virtual G4bool  IsUISessionCompatible     () const;
0085   void AddNickname (const G4String& nickname) {fNicknames.push_back(nickname);}
0086
0087 protected:
0088   G4String fName;
0089   std::vector<G4String> fNicknames;
0090   G4String fDescription;
0091   Functionality  fFunctionality;
0092 };
0093
0094 std::ostream& operator << (std::ostream& os, const G4VGraphicsSystem& gs);
0095
0096 #endif