G4UEllipsoid.hh

Go to the documentation of this file. Or view the newest version in sPHENIX GitHub for file G4UEllipsoid.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.          *
// ********************************************************************
//
// G4UEllipsoid
//
// Class description:
//
// Wrapper class for G4Ellipsoid to make use of VecGeom Ellipsoid.

// 13.09.19 Gabriele Cosmo, CERN
// --------------------------------------------------------------------
#ifndef G4UELLIPSOID_HH
#define G4UELLIPSOID_HH

#include "G4UAdapter.hh"

#if ( defined(G4GEOM_USE_USOLIDS) || defined(G4GEOM_USE_PARTIAL_USOLIDS) )

#include <volumes/UnplacedEllipsoid.h>

#include "G4Polyhedron.hh"

class G4UEllipsoid : public G4UAdapter<vecgeom::UnplacedEllipsoid>
{
  using Shape_t = vecgeom::UnplacedEllipsoid;
  using Base_t  = G4UAdapter<vecgeom::UnplacedEllipsoid>;

  public:  // with description

    G4UEllipsoid(const G4String& name, G4double pxSemiAxis,
                                       G4double pySemiAxis,
                                       G4double pzSemiAxis,
                                       G4double pzBottomCut = 0.0,
                                       G4double pzTopCut = 0.0);
   ~G4UEllipsoid();

    G4VSolid* Clone() const;

    G4double GetDx() const;
    G4double GetDy() const;
    G4double GetDz() const;
    G4double GetSemiAxisMax (G4int i) const;
    G4double GetZBottomCut() const;
    G4double GetZTopCut() const;
    void SetSemiAxis (G4double x, G4double y, G4double z);
    void SetZCuts (G4double newzBottomCut, G4double newzTopCut);

    inline G4GeometryType GetEntityType() const;

  public:  // without description

    G4UEllipsoid(__void__&);
      // Fake default constructor for usage restricted to direct object
      // persistency for clients requiring preallocation of memory for
      // persistifiable objects.

    G4UEllipsoid( const G4UEllipsoid &source );
    G4UEllipsoid &operator=( const G4UEllipsoid &source );
      // Copy constructor and assignment operator.

    void BoundingLimits(G4ThreeVector& pMin, G4ThreeVector& pMax) const;
    G4bool CalculateExtent(const EAxis pAxis,
                           const G4VoxelLimits& pVoxelLimit,
                           const G4AffineTransform& pTransform,
                           G4double& pmin, G4double& pmax) const;
    G4Polyhedron* CreatePolyhedron() const;
};

// --------------------------------------------------------------------
// Inline methods
// --------------------------------------------------------------------

inline G4GeometryType G4UEllipsoid::GetEntityType() const
{
  return "G4Ellipsoid";
}

#endif  // G4GEOM_USE_USOLIDS

#endif