//
// ********************************************************************
// * 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.          *
// ********************************************************************
//
// G4Hype
//
// Class description:
//
//   This class implements a tube with hyperbolic profile.
//
//   It describes an hyperbolic volume with curved sides parallel to
//   the z-axis. The solid has a specified half-length along the z axis,
//   about which it is centered, and a given minimum and maximum radius.
//   A minimum radius of 0 signifies a filled Hype (with hyperbolical
//   inner surface). To have a filled Hype the user must specify
//   inner radius = 0 AND inner stereo angle = 0.
//
//   The inner and outer hyperbolical surfaces can have different
//   stereo angles. A stereo angle of 0 gives a cylindrical surface.

// Authors:
//      Ernesto Lamanna (Ernesto.Lamanna@roma1.infn.it) &
//      Francesco Safai Tehrani (Francesco.SafaiTehrani@roma1.infn.it)
//      Rome, INFN & University of Rome "La Sapienza",  9 June 1998.
// --------------------------------------------------------------------
#ifndef G4HYPE_HH
#define G4HYPE_HH

#include "G4GeomTypes.hh"

#if defined(G4GEOM_USE_USOLIDS)
#define G4GEOM_USE_UHYPE 1
#endif

#if (defined(G4GEOM_USE_UHYPE) && defined(G4GEOM_USE_SYS_USOLIDS))
  #define G4UHype G4Hype
  #include "G4UHype.hh"
#else

#include "G4VSolid.hh"
#include "G4ThreeVector.hh"
#include "G4Polyhedron.hh"

class G4SolidExtentList;
class G4ClippablePolygon;

class G4Hype : public G4VSolid
{
  public:

    G4Hype(const G4String& pName,
                 G4double  newInnerRadius,
                 G4double  newOuterRadius,
                 G4double  newInnerStereo,
                 G4double  newOuterStereo,
                 G4double  newHalfLenZ);

    ~G4Hype() override;

    void ComputeDimensions(      G4VPVParameterisation* p,
                           const G4int n,
                           const G4VPhysicalVolume* pRep) override;

    void BoundingLimits(G4ThreeVector& pMin, G4ThreeVector& pMax) const override;

    G4bool CalculateExtent(const EAxis pAxis,
                           const G4VoxelLimits& pVoxelLimit,
                           const G4AffineTransform& pTransform,
                                 G4double& pMin, G4double& pMax) const override;

    inline G4double GetInnerRadius () const;
    inline G4double GetOuterRadius () const;
    inline G4double GetZHalfLength () const;
    inline G4double GetInnerStereo () const;
    inline G4double GetOuterStereo () const;

    inline void SetInnerRadius (G4double newIRad);
    inline void SetOuterRadius (G4double newORad);
    inline void SetZHalfLength (G4double newHLZ);
    inline void SetInnerStereo (G4double newISte);
    inline void SetOuterStereo (G4double newOSte);

    EInside Inside(const G4ThreeVector& p) const override;

    G4ThreeVector SurfaceNormal(const G4ThreeVector& p) const override;

    G4double DistanceToIn(const G4ThreeVector& p,
                          const G4ThreeVector& v) const override;
    G4double DistanceToIn(const G4ThreeVector& p) const override;
    G4double DistanceToOut(const G4ThreeVector& p, const G4ThreeVector& v,
                           const G4bool calcNorm = false,
                                 G4bool* validNorm = nullptr,
                                 G4ThreeVector* n = nullptr) const override;
    G4double DistanceToOut(const G4ThreeVector& p) const override;

    G4GeometryType  GetEntityType() const override;

    G4VSolid* Clone() const override;

    std::ostream& StreamInfo(std::ostream& os) const override;

    G4double GetCubicVolume() override;
    G4double GetSurfaceArea() override;

    G4ThreeVector GetPointOnSurface() const override;

    void          DescribeYourselfTo (G4VGraphicsScene& scene) const override;
    G4VisExtent   GetExtent          () const override;
    G4Polyhedron* CreatePolyhedron   () const override;
    G4Polyhedron* GetPolyhedron      () const override;

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

    G4Hype(const G4Hype& rhs);
    G4Hype& operator=(const G4Hype& rhs);
      // Copy constructor and assignment operator.

  protected:

    inline G4bool InnerSurfaceExists() const;
      // whether we have an inner surface or not

    static G4double ApproxDistOutside( G4double pr, G4double pz,
                                       G4double r0, G4double tanPhi );
    static G4double ApproxDistInside( G4double pr, G4double pz,
                                      G4double r0, G4double tan2Phi );
      // approximate isotropic distance to hyperbolic surface

    inline G4double HypeInnerRadius2(G4double zVal) const;
    inline G4double HypeOuterRadius2(G4double zVal) const;
      // values of hype radius at a given Z

    static G4int IntersectHype( const G4ThreeVector &p, const G4ThreeVector &v,
                                G4double r2, G4double tan2Phi, G4double s[2] );
      // intersection with hyperbolic surface

   private:

    G4double asinh(G4double arg);

  protected:

    G4double innerRadius;
    G4double outerRadius;
    G4double halfLenZ;
    G4double innerStereo;
    G4double outerStereo;

    // precalculated parameters, squared quantities

    G4double tanInnerStereo;
    G4double tanOuterStereo;
    G4double tanInnerStereo2; // squared tan of Inner Stereo angle
    G4double tanOuterStereo2; // squared tan of Outer Stereo angle
    G4double innerRadius2;    // squared Inner Radius
    G4double outerRadius2;    // squared Outer Radius
    G4double endInnerRadius2; // squared endcap Inner Radius
    G4double endOuterRadius2; // squared endcap Outer Radius
    G4double endInnerRadius; // endcap Inner Radius
    G4double endOuterRadius; // endcap Outer Radius

    // Used by distanceToOut

    enum ESide {outerFace,innerFace,leftCap, rightCap};

  private:

    G4double fCubicVolume = 0.0;
    G4double fSurfaceArea = 0.0;

    G4double fHalfTol;

    mutable G4bool fRebuildPolyhedron = false;
    mutable G4Polyhedron* fpPolyhedron = nullptr;
};

#include "G4Hype.icc"

#endif  // defined(G4GEOM_USE_UHYPE) && defined(G4GEOM_USE_SYS_USOLIDS)

#endif // G4HYPE_HH