BoxBuilder.hh

Go to the documentation of this file.

#pragma once
 
/*
 * BoxBuilder.hh
 *
 *  Created on: Jun 19, 2024
 *      Author: D. S. Leonard
 *
 *
 *
 */
 
#include "VolumeBuilderTypes.hh"
#include "VolumeBuilder.hh"
#include "StructureBuilderReference.hh"
// ReSharper disable once CppUnusedIncludeDirective
#include <memory>
 
namespace DLG4::VolumeBuilders {
    class BoxBuilder;
    template <typename T>
    class VolumeBuilder;
    using BoxBuilderPtr = SharedPtr<BoxBuilder>;
    // See other Derived classes, or better yet the Factories "Topic" in the Doxygen html manual,
    // For Factories for other types of shapes or sources.
 
    BoxBuilderPtr CreateBoxBuilder(const G4String &name);
 
    BoxBuilderPtr CreateBoxBuilder(const G4String &name, G4double unit);
 
    BoxBuilderPtr CreateCenteredBoxBuilder(
        const G4String &name, G4double x_full_size, G4double y_full_size, G4double z_full_size);
 
    BoxBuilderPtr CreateCenteredBoxBuilder
    (G4double unit, const G4String &name, G4double x_full_size, G4double y_full_size,
        G4double z_full_size);
 
    BoxBuilderPtr CreateZDeltaBoxBuilder(
        const G4String &name, G4double x_full_size, G4double y_full_size, G4double edge_z,
        G4double z_delta);
 
    BoxBuilderPtr CreateZDeltaBoxBuilder
    (G4double unit, const G4String &name, G4double x_full_size, G4double y_full_size,
        G4double edge_z, G4double z_delta);
 
 
    BoxBuilderPtr CreateDeltasBoxBuilder(
        const G4String &name, G4double edge_x, G4double x_delta, G4double edge_y, G4double y_delta,
        G4double edge_z, G4double z_delta);
 
    BoxBuilderPtr CreateDeltasBoxBuilder(G4double unit,
        const G4String &name, G4double edge_x, G4double x_delta, G4double edge_y, G4double y_delta,
        G4double edge_z, G4double z_delta);
 
    BoxBuilderPtr CreateEdgesBoxBuilder(const G4String &name, G4double x_edge1, G4double x_edge2,
        G4double y_edge1,
        G4double y_edge2, G4double z_edge1, G4double z_edge2);
 
    BoxBuilderPtr CreateEdgesBoxBuilder(G4double unit, const G4String &name, G4double x_edge1,
        G4double x_edge2,
        G4double y_edge1, G4double y_edge2, G4double z_edge1, G4double z_edge2);
 
    class BoxBuilder final: public VolumeBuilder<BoxBuilder> {
    public:
        friend class VolumeBuilderReference;
        friend class VolumeBuilder<BoxBuilder>; // shouldn't be needed, maybe isn't now.
        template <typename T>
        friend class i_shared_ptr; // needed in principle, but maybe not for this class.
 
        // Friend all the factories.  Keeping them external is easier for users, but more boilerplate.
        friend BoxBuilderPtr CreateBoxBuilder(const G4String &name);
        friend BoxBuilderPtr CreateBoxBuilder(const G4String &name, G4double unit);
        friend BoxBuilderPtr CreateDeltasBoxBuilder(const G4String &name, G4double edge_x,
            G4double x_delta, G4double edge_y, G4double y_delta, G4double edge_z, G4double z_delta);
        friend BoxBuilderPtr CreateDeltasBoxBuilder(G4double unit, const G4String &name,
            G4double edge_x, G4double x_delta, G4double edge_y, G4double y_delta, G4double edge_z,
            G4double z_delta);
        friend BoxBuilderPtr CreateZDeltaBoxBuilder(const G4String &name, G4double x_full_size,
            G4double y_full_size, G4double edge_z, G4double z_delta);
        friend BoxBuilderPtr CreateZDeltaBoxBuilder(G4double unit, const G4String &name,
            G4double x_full_size, G4double y_full_size, G4double edge_z, G4double z_delta);
        friend BoxBuilderPtr CreateCenteredBoxBuilder(const G4String &name, G4double x_full_size,
            G4double y_full_size, G4double z_full_size);
        friend BoxBuilderPtr CreateCenteredBoxBuilder(G4double unit, const G4String &name,
            G4double x_full_size, G4double y_full_size, G4double z_full_size);
        friend BoxBuilderPtr CreateEdgesBoxBuilder(const G4String &name, G4double x_edge1,
            G4double x_edge2, G4double y_edge1, G4double y_edge2, G4double z_edge1,
            G4double z_edge2);
        friend BoxBuilderPtr CreateEdgesBoxBuilder(G4double unit, const G4String &name,
            G4double x_edge1, G4double x_edge2, G4double y_edge1, G4double y_edge2,
            G4double z_edge1, G4double z_edge2);
 
        BoxBuilderPtr SetXSize(G4double x_size);
        BoxBuilderPtr SetYSize(G4double y_size);
        BoxBuilderPtr SetZSize(G4double z_size);
 
        BoxBuilderPtr SetXEdges(G4double x_edge1, G4double x_edge2);
        BoxBuilderPtr SetYEdges(G4double y_edge1, G4double y_edge2);
        BoxBuilderPtr SetZEdges(G4double z_edge1, G4double z_edge2);
 
        BoxBuilderPtr SetXEdgeDelta(G4double x_edge, G4double x_delta);
        BoxBuilderPtr SetYEdgeDelta(G4double y_edge, G4double y_delta);
        BoxBuilderPtr SetZEdgeDelta(G4double z_edge, G4double z_delta);
 
        BoxBuilderPtr SetInternalOffset(G4double x, G4double y, G4double z);
 
        // BoxBuilder method overloads with a leading `unit` parameter.
        // These allow for a per-call unit override.
 
        BoxBuilderPtr SetXSize(G4double unit, G4double x_size);
        BoxBuilderPtr SetYSize(G4double unit, G4double y_size);
        BoxBuilderPtr SetZSize(G4double unit, G4double z_size);
 
        BoxBuilderPtr SetXEdges(G4double unit, G4double x_edge1, G4double x_edge2);
        BoxBuilderPtr SetYEdges(G4double unit, G4double y_edge1, G4double y_edge2);
        BoxBuilderPtr SetZEdges(G4double unit, G4double z_edge1, G4double z_edge2);
 
        BoxBuilderPtr SetXEdgeDelta(G4double unit, G4double x_edge, G4double x_delta);
        BoxBuilderPtr SetYEdgeDelta(G4double unit, G4double y_edge, G4double y_delta);
        BoxBuilderPtr SetZEdgeDelta(G4double unit, G4double z_edge, G4double z_delta);
 
        BoxBuilderPtr SetInternalOffset(G4double unit, G4double x, G4double y, G4double z);
 
    private:
        BoxBuilderPtr SetXSizeDimensioned(G4double x_size);
        BoxBuilderPtr SetYSizeDimensioned(G4double y_size);
        BoxBuilderPtr SetZSizeDimensioned(G4double z_size);
        BoxBuilderPtr SetInternalOffsetDimensioned(G4double x, G4double y, G4double z);
 
    protected:
        G4VSolid *SolidConstructor(const G4String &name) override;
 
    private:
        explicit BoxBuilder(const G4String &name);
 
        BoxBuilder(const BoxBuilder &other);
 
        // offset of box from center.  This effectively redefines the center of the solid
        // as far as the builder behavior.
        G4double z_size_{};
        G4double x_size_{};
        G4double y_size_{};
        G4double unit_{};
 
 
        BoxBuilder() = default;
        BoxBuilder(BoxBuilder &&) noexcept = delete;
 
        // BoxBuilderPtr Clone() const override {
        //     return BoxBuilderPtr(new BoxBuilder(*this));
        // }
    };
}