include/private/G4RTSimpleScanner.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
0030 #ifndef G4RTSimpleScanner_H
0031 #define G4RTSimpleScanner_H 1
0032
0033 // class description:
0034 //
0035 // G4RTSimpleScanner
0036 // Provides a simple raster of window coordinates.
0037
0038 #include "G4VRTScanner.hh"
0039
0040 class G4RTSimpleScanner: public G4VRTScanner {
0041
0042 public: // with description
0043
0044   G4RTSimpleScanner();
0045   virtual ~G4RTSimpleScanner();
0046
0047   // Compiler defaults for copy constructor and assignmemt.
0048
0049   virtual const G4String& GetGSName() const;
0050   // Get name that acts as graphics system name.
0051
0052   virtual const G4String& GetGSNickname() const;
0053   // Get name that acts as graphics system nickname.  It is this that
0054   // the user specifies on the /vis/open and /vis/sceneHandler/create
0055   // commands.
0056
0057   virtual void Initialize(G4int nRow, G4int nColumn);
0058   // Intialises scanner for window with nRow rows and nColumn columns.
0059
0060   virtual G4bool Coords(G4int& iRow, G4int& iColumn);
0061   // Supplies coordinate (iRow,iColumn) and returns false when the
0062   // sequence has finished, i.e., on the call *after* suplying the
0063   // last valid coordinate.
0064
0065 protected:
0066   G4String theGSName, theGSNickname;
0067   G4int theNRow, theNColumn, theIRow, theIColumn;
0068 };
0069
0070 #endif