geant4/source/geometry/solids/specific/include/G4UGenericPolycone.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.          *
// ********************************************************************
//
// G4UGenericPolycone
//
// Class description:
//
// Wrapper class for G4GenericPolycone to make use of VecGeom GenericPolycone.

// Author: Gabriele Cosmo (CERN), 30.10.2013
// --------------------------------------------------------------------
#ifndef G4UGENERICPOLYCONE_HH
#define G4UGENERICPOLYCONE_HH

#include "G4UAdapter.hh"

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

#include <VecGeom/volumes/UnplacedGenericPolycone.h>

#include "G4TwoVector.hh"
#include "G4PolyconeSide.hh"

/**
 * @brief G4UGenericPolycone is a wrapper class for G4GenericPolycone
 * to make use of VecGeom GenericPolycone.
 */

class G4UGenericPolycone : public G4UAdapter<vecgeom::UnplacedGenericPolycone>
{
  using Shape_t = vecgeom::UnplacedGenericPolycone;
  using Base_t  = G4UAdapter<vecgeom::UnplacedGenericPolycone>;

  public:

    /**
     * Constructs a generic polycone shape, given its parameters.
     *  @param[in] name The solid name.
     *  @param[in] phiStart The initial Phi starting angle.
     *  @param[in] phiTotal The total Phi angle.
     *  @param[in] numRZ Number of corners in r,Z space.
     *  @param[in] r Vector of r coordinate of corners.
     *  @param[in] z Vector of Z coordinate of corners.
     */
    G4UGenericPolycone(const G4String& name, 
                       G4double phiStart,    // initial phi starting angle
                       G4double phiTotal,    // total phi angle
                       G4int    numRZ,       // number corners in r,z space
                 const G4double r[],         // r coordinate of these corners
                 const G4double z[]       ); // z coordinate of these corners

    /**
     * Default destructor.
     */
    ~G4UGenericPolycone() override = default;

    /**
     * Accessors.
     */
    G4double GetStartPhi()    const;
    G4double GetEndPhi()      const;
    G4double GetSinStartPhi() const;
    G4double GetCosStartPhi() const;
    G4double GetSinEndPhi()   const;
    G4double GetCosEndPhi()   const;
    G4bool IsOpen()           const;
    G4int  GetNumRZCorner()   const;
    G4PolyconeSideRZ GetCorner(G4int index) const;
  
    /**
     * Returns the type ID, "G4GenericPolycone" of the solid.
     */
    inline G4GeometryType GetEntityType() const override;

    /**
     * Makes a clone of the object for use in multi-treading.
     *  @returns A pointer to the new cloned allocated solid.
     */
    G4VSolid* Clone() const override;

    /**
     * Computes the bounding limits of the solid.
     *  @param[out] pMin The minimum bounding limit point.
     *  @param[out] pMax The maximum bounding limit point.
     */
    void BoundingLimits(G4ThreeVector& pMin, G4ThreeVector& pMax) const override;

    /**
     * Calculates the minimum and maximum extent of the solid, when under the
     * specified transform, and within the specified limits.
     *  @param[in] pAxis The axis along which compute the extent.
     *  @param[in] pVoxelLimit The limiting space dictated by voxels.
     *  @param[in] pTransform The internal transformation applied to the solid.
     *  @param[out] pMin The minimum extent value.
     *  @param[out] pMax The maximum extent value.
     *  @returns True if the solid is intersected by the extent region.
     */
    G4bool CalculateExtent(const EAxis pAxis,
                           const G4VoxelLimits& pVoxelLimit,
                           const G4AffineTransform& pTransform,
                           G4double& pMin, G4double& pMax) const override;

    /**
     * Returns a generated polyhedron as graphical representations.
     */
    G4Polyhedron* CreatePolyhedron() const override;

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

  private:

    G4double wrStart;
    G4double wrDelta;
    std::vector<G4TwoVector> rzcorners;
};

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

inline G4GeometryType G4UGenericPolycone::GetEntityType() const
{
  return "G4GenericPolycone";
}
  
#endif  // G4GEOM_USE_USOLIDS

#endif