| Geant4 Cross Reference |
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 (G4Visible&&);
56 G4Visible (const G4VisAttributes*);
57
58 virtual ~G4Visible ();
59
60 G4Visible& operator= (const G4Visible&);
61 G4Visible& operator= (G4Visible&&);
62
63 G4bool operator != (const G4Visible& right) const;
64
65 const G4VisAttributes* GetVisAttributes () const;
66
67 void SetVisAttributes (const G4VisAttributes*);
68 // The G4VisAttributes object is not stored in a G4Visible; only a
69 // reference, a const pointer, is kept. Therefore the
70 // G4VisAttributes object to which it refers must have a life long
71 // enough to satisfy all uses of the G4Visible object. E.g., if the
72 // G4Visible object is created on the heap (using `new') then the
73 // associated G4VisAttributes object would normally also be created
74 // on the heap and managed in the same way.
75
76 void SetVisAttributes (const G4VisAttributes&);
77 // A copy of the G4VisAttributes object is created on the heap to
78 // ensure a long life.
79
80 // Access functions to the string for user customizable information
81 virtual const G4String& GetInfo() const;
82 virtual void SetInfo(const G4String& info);
83
84 protected:
85
86 G4String fInfo; // String for user customizable information
87 const G4VisAttributes* fpVisAttributes;
88 G4bool fAllocatedVisAttributes;
89 };
90
91 #include "G4Visible.icc"
92
93 #endif
94