Files
geant4/source/geometry/management/include/G4VTouchable.hh
T
2016-06-08 15:28:20 +02:00

118 lines
4.1 KiB
C++

// 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.
//
// $Id: G4VTouchable.hh,v 1.1.12.1 1999/12/07 20:48:12 gunter Exp $
// GEANT4 tag $Name: geant4-01-00 $
//
//
// class G4VTouchable Paul Kent August 1996
//
// Modified: John Apostolakis, July 1997: new methods to Retrieve replica
// and history information
// (intention is to hide NavigHistory)
// Motivation:
// ----------
// Base class for `touchable' objects capable of maintaining an
// association between parts of the geometrical hierarchy (volumes
// &/or solids) and their resultant transformation
//
// Utilisation:
// -----------
//
// A touchable is a geometrical volume (solid) which has a unique
// placement in a detector description. It an abstract base class which
// can be implemented in a variety of ways. Each way must provide the
// capabilities of obtaining the transformation and solid that is described by
// the touchable.
//
// All G4VTouchable implementations must respond to the two following
// "requests":
//
// 1) GetTranslation and GetRotation that return the components of the
// volume's transformation
//
// 2) GetSolid that gives the solid of this touchable.
//
//
// Additional capabilities are available from implementations with more
// information. These have a default implementation that causes an exception.
//
// Several capabilities are available from touchables with physical volumes:
//
// 3) GetVolume gives the physical volume
//
// 4) GetReplicaNumber gives the replica number of the physical volume,
// if it is replicated.
//
// Touchables that Store volume hierarchy (history) have the whole stack of
// parent volumes available. Thus it is possible to add a little more state
// in order to extend its functionality. We add a "pointer" to a level and a
// member function to move the level in this stack. Then
// calling the above member functions for another level the information for
// that level can be retrieved.
//
// The top of the history tree is, by convention, the world volume.
//
// 5) GetHistoryDepth gives the depth of the history tree
//
// 6) GetReplicaNumber, GetVolume, GetTranslation and GetRotation call
// each be called with a depth argument. They return the value of the
// respective level of the touchable.
//
// 7) MoveUpHistory( num ) moves the current pointer inside the
// touchable to point "num" levels up the history tree. Thus, eg, calling
// it with num=1 will cause the internal pointer to move to the mother
// of the current volume.
// -------> THIS method MODIFIES the touchable <--------
//
// An update method, with different arguments is available, so
// that the information in a touchable can be updated:
//
// 8) UpdateYourself takes a physical volume pointer and can additionally
// take a NavigationHistory.
#ifndef G4VTOUCHABLE_HH
#define G4VTOUCHABLE_HH
#include "globals.hh"
class G4VPhysicalVolume;
class G4VSolid;
class G4NavigationHistory;
#include "G4RotationMatrix.hh"
#include "G4ThreeVector.hh"
class G4VTouchable
{
public:
G4VTouchable();
virtual ~G4VTouchable();
virtual const G4ThreeVector& GetTranslation(G4int depth=0) const = 0;
virtual const G4RotationMatrix* GetRotation(G4int depth=0) const = 0;
virtual G4VPhysicalVolume* GetVolume(G4int depth=0) const;
virtual G4VSolid* GetSolid(G4int depth=0) const;
// Methods for touchables with history
virtual G4int GetReplicaNumber(G4int depth=0) const;
virtual G4int GetHistoryDepth() const;
virtual G4int MoveUpHistory( G4int num_levels = 1 );
// virtual void ResetLevel();
// Update method
virtual void UpdateYourself( G4VPhysicalVolume* pPhysVol,
const G4NavigationHistory* history=NULL);
// Should this method be depricated ? It is used in G4Navigator!
virtual const G4NavigationHistory* GetHistory() const;
};
#include "G4VTouchable.icc"
#endif