G4ScaleTransform.hh

Go to the documentation of this file. Or view the newest version in sPHENIX GitHub for file G4ScaleTransform.hh

//
// ********************************************************************
// * License and Disclaimer                                           *
// *                                                                  *
// * 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.  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 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.          *
// ********************************************************************
//
// G4ScaleTransform
//
// Class description:
//
// A class for geometric scaling transformations.
// Supports efficient arbitrary transformation of points, vectors and
// normals and the computation of compound & inverse transformations.
//
// Interfaces to the CLHEP class G4ThreeVector
//
// For member function descriptions, see comments by declarations. For
// additional clarification, also check the `const' declarations for
// functions & their parameters.
//
// Member data:
//
//    G4ThreeVector fScale;  // scale transformation 
//    G4ThreeVector fIScale; // inverse scale (avoid divisions)
//    G4double flFactor;     // factor for conversion to local frame
//    G4double fgFactor;     // factor for conversion to global frame

// E.Tcherniaev, 11 Mar 2016 - added transformations for normal
// G.Cosmo,      18 Feb 2016 - initial version
// --------------------------------------------------------------------
#ifndef G4SCALETRANSFORM_HH
#define G4SCALETRANSFORM_HH

#include "G4Types.hh"
#include "G4ThreeVector.hh"
#include "G4Transform3D.hh"

class G4ScaleTransform
{

  public:

    inline G4ScaleTransform();
      // Default constructor
    
    inline G4ScaleTransform(G4double sx, G4double sy, G4double sz);
      // Constructor with scale parameters on each axis

    inline G4ScaleTransform(const G4ThreeVector& scale);
      // Constructor taking a 3-vector

    inline G4ScaleTransform(const G4Scale3D& scale);
      // Constructor taking a Scale3D
        
    inline G4ScaleTransform(const G4ScaleTransform& right);
      // Copy constructor

    inline G4ScaleTransform& operator=(const G4ScaleTransform& right);
      // Assignment operator

    inline void Init();
      // Update the backed-up inverse scale and special conversion factors
      // based on the values of the scale. Needed at initialisation and
      // whenever the scale has changed value

    inline const G4ThreeVector& GetScale() const;
    inline const G4ThreeVector& GetInvScale() const;
      // Get reference to the inverse scale transformation
 
    inline void SetScale(const G4ThreeVector& scale);
      // Set scale based on vector
    inline void SetScale(const G4Scale3D& scale);
      // Set scale based on a G4Scale3D transformation
    inline void SetScale(G4double sx, G4double sy, G4double sz);
      // Set scale based on values

    inline void Transform(const G4ThreeVector& global,
                                G4ThreeVector& local) const;  
    inline G4ThreeVector Transform(const G4ThreeVector& global) const;
      // Transform point from global to local frame

    inline void InverseTransform(const G4ThreeVector& local, 
                                       G4ThreeVector& global) const;
    inline G4ThreeVector InverseTransform(const G4ThreeVector& local) const;
      // Transform point from local to global frame

    inline void TransformNormal(const G4ThreeVector& global,
                                      G4ThreeVector& local) const;  
    inline G4ThreeVector TransformNormal(const G4ThreeVector& global) const;
      // Transform normal from global to local frame

    inline void InverseTransformNormal(const G4ThreeVector& local, 
                                             G4ThreeVector& global) const;
    inline G4ThreeVector InverseTransformNormal(const G4ThreeVector& local) const;
      // Transform normal from local to global frame

    inline G4double TransformDistance(G4double dist,
                                      const G4ThreeVector& dir) const;
      // Transform distance along given direction from global to local frame

    inline G4double TransformDistance(G4double safety) const;
      // Transform distance from global to local frame (conservative)

    inline G4double InverseTransformDistance(G4double dist,
                                             const G4ThreeVector& dir) const;
      // Transform distance along given direction from local to global frame

    inline G4double InverseTransformDistance(G4double safety) const;
      // Transform distance from local to global frame (conservative)

  private:

    G4ThreeVector fScale;  // scale transformation 
    G4ThreeVector fIScale; // inverse scale (avoid divisions)
    G4double flFactor = 1.0, fgFactor = 1.0;
      // conversion factors to local/global frames

}; // End class G4ScaleTransform

std::ostream& operator<<(std::ostream& os, const G4ScaleTransform& scale);

#include "G4ScaleTransform.icc"

#endif // G4SCALETRANSFORM_HH