Import Geant4 8.1.0 source tree

source/visualization/modeling/include/G4PhysicalVolumeModel.hh

@@ -1,28 +1,31 @@
 //
 // ********************************************************************
-// * DISCLAIMER                                                       *
+// * License and Disclaimer                                           *
 // *                                                                  *
-// * The following disclaimer summarizes all the specific disclaimers *
-// * of contributors to this software. The specific disclaimers,which *
-// * govern, are listed with their locations in:                      *
-// *   http://cern.ch/geant4/license                                  *
+// * The  Geant4 software  is  copyright of the Copyright Holders  of *
+// * the Geant4 Collaboration.  It is provided  under  the terms  and *
+// * conditions of the Geant4 Software License,  included in the file *
+// * LICENSE and available at  http://cern.ch/geant4/license .  These *
+// * include a list of copyright holders.                             *
 // *                                                                  *
 // * Neither the authors of this software system, nor their employing *
 // * institutes,nor the agencies providing financial support for this *
 // * work  make  any representation or  warranty, express or implied, *
 // * regarding  this  software system or assume any liability for its *
-// * use.                                                             *
+// * use.  Please see the license in the file  LICENSE  and URL above *
+// * for the full disclaimer and the limitation of liability.         *
 // *                                                                  *
-// * This  code  implementation is the  intellectual property  of the *
-// * GEANT4 collaboration.                                            *
-// * By copying,  distributing  or modifying the Program (or any work *
-// * based  on  the Program)  you indicate  your  acceptance of  this *
-// * statement, and all its terms.                                    *
+// * This  code  implementation is the result of  the  scientific and *
+// * technical work of the GEANT4 collaboration.                      *
+// * By using,  copying,  modifying or  distributing the software (or *
+// * any work based  on the software)  you  agree  to acknowledge its *
+// * use  in  resulting  scientific  publications,  and indicate your *
+// * acceptance of all terms of the Geant4 Software license.          *
 // ********************************************************************
 //
 //
-// $Id: G4PhysicalVolumeModel.hh,v 1.21 2005/11/22 16:29:40 allison Exp $
-// GEANT4 tag $Name: geant4-08-00 $
+// $Id: G4PhysicalVolumeModel.hh,v 1.28 2006/06/29 21:30:34 gunter Exp $
+// GEANT4 tag $Name: geant4-08-01 $
 //
 // 
 // John Allison  31st December 1997.
@@ -36,6 +39,10 @@
 // For access to base class information, e.g., modeling parameters,
 // use GetModelingParameters() inherited from G4VModel.  See Class
 // Description of the base class G4VModel.
+//
+// G4PhysicalVolumeModel assumes the modeling parameters have been set
+// up with meaningful information - default vis attributes and culling
+// policy in particular.
 
 #ifndef G4PHYSICALVOLUMEMODEL_HH
 #define G4PHYSICALVOLUMEMODEL_HH
@@ -43,6 +50,8 @@
 #include "G4VModel.hh"
 
 #include "G4Transform3D.hh"
+#include <iostream>
+#include <vector>
 
 class G4VPhysicalVolume;
 class G4LogicalVolume;
@@ -57,6 +66,20 @@ public: // With description
 
   enum {UNLIMITED = -1};
 
+  class G4PhysicalVolumeNodeID {
+  public:
+    G4PhysicalVolumeNodeID(G4VPhysicalVolume* pPV = 0, G4int iCopyNo = 0):
+      fpPV(pPV), fCopyNo(iCopyNo) {}
+    G4VPhysicalVolume* GetPhysicalVolume() const {return fpPV;}
+    G4int GetCopyNo() const {return fCopyNo;}
+    G4bool operator< (const G4PhysicalVolumeNodeID& right) const;
+    G4bool operator== (const G4PhysicalVolumeNodeID& right) const;
+  private:
+    G4VPhysicalVolume* fpPV;
+    G4int fCopyNo;
+  };
+  // Nested class for identifying physical volume nodes.
+
   G4PhysicalVolumeModel
   (G4VPhysicalVolume*,
    G4int requestedDepth = UNLIMITED,
@@ -86,21 +109,43 @@ public: // With description
   G4String GetCurrentTag () const;
   // A tag which depends on the current state of the model.
 
-  const G4PhysicalVolumeModel* GetG4PhysicalVolumeModel () const {
-    return this;
-  }
+  const G4PhysicalVolumeModel* GetG4PhysicalVolumeModel () const
+  {return this;}
 
-  G4PhysicalVolumeModel* GetG4PhysicalVolumeModel () {
-    return this;
-  }
+  G4PhysicalVolumeModel* GetG4PhysicalVolumeModel ()
+  {return this;}
 
-  const G4VPhysicalVolume* GetTopPhysicalVolume () const {return fpTopPV;}
+  G4VPhysicalVolume* GetTopPhysicalVolume () const {return fpTopPV;}
 
   G4int GetRequestedDepth () const {return fRequestedDepth;}
 
-  const G4Polyhedron* GetClippingVolume () const {
-    return fpClippingPolyhedron;
-  }
+  const G4Polyhedron* GetClippingVolume () const
+  {return fpClippingPolyhedron;}
+
+  G4int GetCurrentDepth() const {return fCurrentDepth;}
+  // Current depth of geom. hierarchy.
+
+  G4VPhysicalVolume* GetCurrentPV() const {return fpCurrentPV;}
+  // Current physical volume.
+
+  G4LogicalVolume* GetCurrentLV() const {return fpCurrentLV;}
+  // Current logical volume.
+
+  G4Material* GetCurrentMaterial() const {return fpCurrentMaterial;}
+  // Current material.
+
+  const std::vector<G4PhysicalVolumeNodeID>& GetDrawnPVPath() const
+  {return fDrawnPVPath;}
+  // Path of the current drawn (non-culled) volume in terms of drawn
+  // (non-culled) ancesters.  It is a vector of physical volume node
+  // identifiers corresponding to the geometry hierarchy actually
+  // selected, i.e., not culled.  It is guaranteed that volumes are
+  // presented to the scene handlers in top-down hierarchy order,
+  // i.e., ancesters first, mothers before daughters, so the scene
+  // handler can be assured that, if it is building its own scene
+  // graph tree, a mother, if any, will have already been encountered
+  // and there will already be a node in place on which to hang the
+  // current volume.
 
   void SetRequestedDepth (G4int requestedDepth) {
     fRequestedDepth = requestedDepth;
@@ -113,13 +158,16 @@ public: // With description
   G4bool Validate (G4bool warn);
   // Validate, but allow internal changes (hence non-const function).
 
-  void DefinePointersToWorkingSpace (G4int*              pCurrentDepth,
-				     G4VPhysicalVolume** ppCurrentPV,
-				     G4LogicalVolume**   ppCurrentLV,
-				     G4Material**        ppCurrentMaterial);
+  void DefinePointersToWorkingSpace
+  (G4int*              pCurrentDepth = 0,
+   G4VPhysicalVolume** ppCurrentPV = 0,
+   G4LogicalVolume**   ppCurrentLV = 0,
+   G4Material**        ppCurrentMaterial = 0,
+   std::vector<G4PhysicalVolumeNodeID>* pDrawnPVPath = 0);
   // For use (optional) by the scene handler if it needs to know about
-  // the current information maintained through these pointers.
-
+  // the current information maintained through these pointers.  For
+  // description of pointers, see below.
+  
   void CurtailDescent() {fCurtailDescent = true;}
 
 protected:
@@ -142,11 +190,6 @@ protected:
 			      const G4VisAttributes* pVisAttribs,
 			      G4VGraphicsScene& sceneHandler);
 
-  G4bool IsThisCulled (const G4LogicalVolume*,
-		       const G4Material*);
-
-  G4bool IsDaughterCulled (const G4LogicalVolume* pMotherLV);
-
   void CalculateExtent ();
 
   /////////////////////////////////////////////////////////
@@ -162,16 +205,18 @@ protected:
   G4VPhysicalVolume* fpCurrentPV;    // Current physical volume.
   G4LogicalVolume*   fpCurrentLV;    // Current logical volume.
   G4Material*    fpCurrentMaterial;  // Current material.
-  G4bool             fCurtailDescent;// Can be set to curtail descent.
+  std::vector<G4PhysicalVolumeNodeID> fDrawnPVPath;
+  G4bool             fCurtailDescent;  // Can be set to curtail descent.
   const G4Polyhedron*fpClippingPolyhedron;
 
   ////////////////////////////////////////////////////////////
-  // Pointers to working space in scene, if required.
+  // Pointers to working space in scene handler, if required.
 
   G4int*              fpCurrentDepth;  // Current depth of geom. hierarchy.
   G4VPhysicalVolume** fppCurrentPV;    // Current physical volume.
   G4LogicalVolume**   fppCurrentLV;    // Current logical volume.
   G4Material**    fppCurrentMaterial;  // Current material.
+  std::vector<G4PhysicalVolumeNodeID>* fpDrawnPVPath;
 
 private:
 
@@ -181,4 +226,7 @@ private:
   G4PhysicalVolumeModel& operator = (const G4PhysicalVolumeModel&);
 };
 
+std::ostream& operator<<
+  (std::ostream& os, const G4PhysicalVolumeModel::G4PhysicalVolumeNodeID);
+
 #endif