Geant4  10.02.p01
G4Visible.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: G4Visible.hh 66376 2012-12-18 09:42:59Z gcosmo $
28 //
29 //
30 // John Allison 30th October 1996
31 
32 // Class Description:
33 // Base class for all things visible, i.e., which have Vis Attributes.
34 //
35 // Note: a null pointer implies no attributes. Under those circumstances
36 // the visualization system is free to choose some.
37 // Class Description - End:
38 
39 
40 #ifndef G4VISIBLE_HH
41 #define G4VISIBLE_HH
42 
43 #include "globals.hh"
44 #include <iostream>
45 
46 class G4VisAttributes;
47 
48 class G4Visible {
49 
50  friend std::ostream& operator << (std::ostream& os, const G4Visible& v);
51 
52 public: // With description
53 
54  G4Visible ();
55  G4Visible (const G4Visible&);
56  G4Visible (const G4VisAttributes*);
57 
58  virtual ~G4Visible ();
59 
61 
62  G4bool operator != (const G4Visible& right) const;
63 
64  const G4VisAttributes* GetVisAttributes () const;
65 
66  void SetVisAttributes (const G4VisAttributes*);
67  // The G4VisAttributes object is not stored in a G4Visible; only a
68  // reference, a const pointer, is kept. Therefore the
69  // G4VisAttributes object to which it refers must have a life long
70  // enough to satisfy all uses of the G4Visible object. E.g., if the
71  // G4Visible object is created on the heap (using `new') then the
72  // associated G4VisAttributes object would normally also be created
73  // on the heap and managed in the same way.
74 
75  void SetVisAttributes (const G4VisAttributes&);
76  // A copy of the G4VisAttributes object is created on the heap to
77  // ensure a long life.
78 
79 protected:
80 
83 };
84 
85 #include "G4Visible.icc"
86 
87 #endif
G4Visible & operator=(const G4Visible &)
Definition: G4Visible.cc:58
const G4VisAttributes * fpVisAttributes
Definition: G4Visible.hh:81
const G4VisAttributes * GetVisAttributes() const
friend std::ostream & operator<<(std::ostream &os, const G4Visible &v)
Definition: G4Visible.cc:94
bool G4bool
Definition: G4Types.hh:79
void SetVisAttributes(const G4VisAttributes *)
Definition: G4Visible.cc:80
virtual ~G4Visible()
Definition: G4Visible.cc:54
G4bool fAllocatedVisAttributes
Definition: G4Visible.hh:82
G4bool operator!=(const G4Visible &right) const
Definition: G4Visible.cc:87