//
// ********************************************************************
// * 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.          *
// ********************************************************************
//
// G4TwistedBox
//
// Class description:
//
// A G4TwistedBox is a twisted cuboid of given half lengths pDx,pDy,pDz
// and twist angle pPhiTwist.
// The Box is centred on the origin with sides parallel to the x/y/z axes.
//
// Member Data:
//
//   pDx    Half-length along x axis
//   pDy    Half-length along y asis
//   pDz    Half-length along z axis
//   pPhiTwist Twist angle

// Author: Oliver Link (CERN), 27.10.2004 - Created
// --------------------------------------------------------------------
#ifndef G4TWISTEDBOX_HH
#define G4TWISTEDBOX_HH

#include "G4VTwistedFaceted.hh"

/**
 * @brief G4TwistedBox is a twisted cuboid of given half lengths and twist
 * angle. The box is centred on the origin with sides parallel to the
 * Cartesian axes.
 */

class G4TwistedBox : public G4VTwistedFaceted
{
  public:

    /**
     * Constructs a twisted box, given its parameters.
     *  @param[in] pName The solid name.
     *  @param[in] pPhiTwist Twist angle.
     *  @param[in] pDx Half-length along X axis.
     *  @param[in] pDy Half-length along Y axis.
     *  @param[in] pDz Half-length along Z axis.
     */
    G4TwistedBox(const G4String& pName,
                       G4double  pPhiTwist,
                       G4double  pDx,
                       G4double  pDy,
                       G4double  pDz );

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

    /**
     * Accessors.
     */
    inline G4double GetXHalfLength() const { return GetDx1() ; }
    inline G4double GetYHalfLength() const { return GetDy1() ; }
    inline G4double GetZHalfLength() const { return GetDz()  ; }
    inline G4double GetPhiTwist()    const { return GetTwistAngle() ; }

    /**
     * Returns the type ID, "G4TwistedBox" of the solid.
     */
    G4GeometryType GetEntityType() const override;

    /**
     * Returning an estimation of the solid volume (capacity) and
     * surface area, in internal units.
     */
    G4double GetCubicVolume() override;
    G4double GetSurfaceArea() 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;

    /**
     * Streams the object contents to an output stream.
     */
    std::ostream& StreamInfo(std::ostream& os) const override;

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

    /**
     * Copy constructor and assignment operator.
     */
    G4TwistedBox(const G4TwistedBox& rhs);
    G4TwistedBox& operator=(const G4TwistedBox& rhs);
};

#endif