geometry.h

Go to the documentation of this file.

//  ************************************************************************************************
//
//  BornAgain: simulate and fit reflection and scattering
//
//! @file      GUI/ba3d/model/geometry.h
//! @brief     Defines Geometry class
//!
//! @homepage  http://www.bornagainproject.org
//! @license   GNU General Public License v3 or higher (see COPYING)
//! @copyright Forschungszentrum Jülich GmbH 2018
//! @authors   Scientific Computing Group at MLZ (see CITATION, AUTHORS)
//
//  ************************************************************************************************
 
#ifndef BORNAGAIN_GUI_BA3D_MODEL_GEOMETRY_H
#define BORNAGAIN_GUI_BA3D_MODEL_GEOMETRY_H
 
#include "GUI/ba3d/model/geometry_inc.h"
#include <QObject>
#include <QVector>
#include <unordered_map>
#include <vector>
 
namespace GUI::RealSpace {
 
class Buffer;
class GeometryStore;
 
class Geometry {
    friend class Buffer;
    friend class GeometryStore;
 
public:
    // vertex + normal pair
    struct Vert_Normal {
        Vector3D v, n;
        Vert_Normal() = default;
        Vert_Normal(const Vector3D& v, const Vector3D& n);
    };
 
    // vertex indices (for GL)
    using Indices = std::vector<unsigned>;
 
    // vertices (for GL)
    struct Vertices : private QVector<Vector3D> {
        using QVector::append;
        using QVector::QVector;
        using QVector::reserve;
        using QVector::resize;
        using QVector::operator[];
        using QVector::at;
        using QVector::begin;
        using QVector::count;
        using QVector::end;
 
        void addVertex(const Vector3D&, int n = 1); // add a vertex, possibly multiple copies
        void addTriangle(const Vector3D&, const Vector3D&, const Vector3D&); // triangle
        void addQuad(const Vector3D&, const Vector3D&, const Vector3D&,
                     const Vector3D&); // quad as 2 triangles
        void addQuad(const Vertices&, unsigned, unsigned, unsigned, unsigned); // quad by indices
        void addStrip(const Vertices&, const Indices&);                        // triangle strip
        void addFan(const Vertices&, const Indices&);                          // triangle fan
    };
 
    // vertex/normal mesh
    using Mesh = QVector<Vert_Normal>;
 
    Geometry(GeometricID::Key);
    virtual ~Geometry();
 
private:
    GeometricID::Key m_key;
 
    Mesh m_mesh;
    // make a mesh from vectors of vertices and (optionally) normals
    static Mesh makeMesh(const Vertices& vs, Vertices const* ns = nullptr);
    static Mesh makeMesh(const Vertices& vs, const Vertices& ns);
 
    static Mesh meshPlane();
    static Mesh meshBox();
    static Mesh meshSphere(float cut, float baseShift = 0.0f, float removedTop = 0.0f);
    static Mesh meshColumn(float ratio_Rt_Rb, float numSides);
    static Mesh meshIcosahedron();
    static Mesh meshDodecahedron();
    static Mesh meshTruncBox(float tD);
    static Mesh meshBipyramid4(float rH, float alpha, float H);
    static Mesh meshRipple(float numSides, float ratio_asymmetry_W);
 
    // mesh params for round shapes
    static int const RINGS = 12, SLICES = 24;
};
 
// a single store keeps existing geometries for sharing
 
class GeometryStore : public QObject {
    Q_OBJECT
    friend class Geometry;
 
public:
    GeometryHandle getGeometry(GeometricID::Key);
 
signals:
    void deletingGeometry(Geometry const*); // signal to canvases
 
private:
    std::unordered_map<GeometricID::Key, GeometryRef, GeometricID::KeyHash> m_geometries;
    void geometryDeleted(Geometry const&); // ~Geometry() calls this
};
 
GeometryStore& geometryStore(); // simpleton
 
} // namespace GUI::RealSpace
 
#endif // BORNAGAIN_GUI_BA3D_MODEL_GEOMETRY_H