Geant4  10.00.p01
G4VRTScanner.hh
Go to the documentation of this file.
1 //
2 // ********************************************************************
3 // * License and Disclaimer *
4 // * *
5 // * The Geant4 software is copyright of the Copyright Holders of *
6 // * the Geant4 Collaboration. It is provided under the terms and *
7 // * conditions of the Geant4 Software License, included in the file *
8 // * LICENSE and available at http://cern.ch/geant4/license . These *
9 // * include a list of copyright holders. *
10 // * *
11 // * Neither the authors of this software system, nor their employing *
12 // * institutes,nor the agencies providing financial support for this *
13 // * work make any representation or warranty, express or implied, *
14 // * regarding this software system or assume any liability for its *
15 // * use. Please see the license in the file LICENSE and URL above *
16 // * for the full disclaimer and the limitation of liability. *
17 // * *
18 // * This code implementation is the result of the scientific and *
19 // * technical work of the GEANT4 collaboration. *
20 // * By using, copying, modifying or distributing the software (or *
21 // * any work based on the software) you agree to acknowledge its *
22 // * use in resulting scientific publications, and indicate your *
23 // * acceptance of all terms of the Geant4 Software license. *
24 // ********************************************************************
25 //
26 //
27 // $Id: G4VRTScanner.hh 66373 2012-12-18 09:41:34Z gcosmo $
28 //
29 //
30 
31 #ifndef G4VRTScanner_H
32 #define G4VRTScanner_H 1
33 
34 // class description:
35 //
36 // G4VRTScanner
37 // Interface class for provider of a sequence of window coordinates.
38 
39 #include "globals.hh"
40 
41 class G4VRTScanner {
42 
43 public: // with description
44 
45  G4VRTScanner();
46  virtual ~G4VRTScanner();
47 
48  virtual const G4String& GetGSName() const = 0;
49  // Get name that acts as graphics system name.
50 
51  virtual const G4String& GetGSNickname() const = 0;
52  // Get name that acts as graphics system nickname. It is this that
53  // the user specifies on the /vis/open and /vis/sceneHandler/create
54  // commands.
55 
56  virtual void Initialize(G4int nRow, G4int nColumn) = 0;
57  // Intialises scanner for window with nRow rows and nColumn columns.
58 
59  virtual G4bool Coords(G4int& iRow, G4int& iColumn) = 0;
60  // Supplies coordinate (iRow,iColumn) and returns false when the
61  // sequence has finished, i.e., on the call *after* suplying the
62  // last valid coordinate.
63 
64  virtual void Draw
65  (unsigned char red, unsigned char green, unsigned char blue);
66  // Draw coloured square at current position.
67 
68 };
69 
70 inline
71 void G4VRTScanner::Draw(unsigned char, unsigned char, unsigned char) {}
72 
73 #endif
Definition: test07.cc:36
virtual G4bool Coords(G4int &iRow, G4int &iColumn)=0
virtual const G4String & GetGSName() const =0
virtual ~G4VRTScanner()
Definition: G4VRTScanner.cc:34
Definition: test07.cc:36
int G4int
Definition: G4Types.hh:78
virtual void Draw(unsigned char red, unsigned char green, unsigned char blue)
Definition: G4VRTScanner.hh:71
virtual void Initialize(G4int nRow, G4int nColumn)=0
bool G4bool
Definition: G4Types.hh:79
virtual const G4String & GetGSNickname() const =0