ECCE @ EIC Software
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Groups Pages
G4Visible.hh
Go to the documentation of this file. Or view the newest version in sPHENIX GitHub for file G4Visible.hh
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 //
28 //
29 // John Allison 30th October 1996
30 
31 // Class Description:
32 // Base class for all things visible, i.e., which have Vis Attributes.
33 //
34 // Note: a null pointer implies no attributes. Under those circumstances
35 // the visualization system is free to choose some.
36 // Class Description - End:
37 
38 
39 #ifndef G4VISIBLE_HH
40 #define G4VISIBLE_HH
41 
42 #include "globals.hh"
43 #include <iostream>
44 
45 class G4VisAttributes;
46 
47 class G4Visible {
48 
49  friend std::ostream& operator << (std::ostream& os, const G4Visible& v);
50 
51 public: // With description
52 
53  G4Visible ();
54  G4Visible (const G4Visible&);
55  G4Visible (const G4VisAttributes*);
56 
57  virtual ~G4Visible ();
58 
60 
61  G4bool operator != (const G4Visible& right) const;
62 
63  const G4VisAttributes* GetVisAttributes () const;
64 
65  void SetVisAttributes (const G4VisAttributes*);
66  // The G4VisAttributes object is not stored in a G4Visible; only a
67  // reference, a const pointer, is kept. Therefore the
68  // G4VisAttributes object to which it refers must have a life long
69  // enough to satisfy all uses of the G4Visible object. E.g., if the
70  // G4Visible object is created on the heap (using `new') then the
71  // associated G4VisAttributes object would normally also be created
72  // on the heap and managed in the same way.
73 
74  void SetVisAttributes (const G4VisAttributes&);
75  // A copy of the G4VisAttributes object is created on the heap to
76  // ensure a long life.
77 
78 protected:
79 
82 };
83 
84 #include "G4Visible.icc"
85 
86 #endif