interactivehtmlbom.h

Go to the documentation of this file.

/*
 * LibrePCB - Professional EDA for everyone!
 * Copyright (C) 2013 LibrePCB Developers, see AUTHORS.md for contributors.
 * https://librepcb.org/
 *
 * This program is free software: you can redistribute it and/or modify
 * it under the terms of the GNU General Public License as published by
 * the Free Software Foundation, either version 3 of the License, or
 * (at your option) any later version.
 *
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU General Public License for more details.
 *
 * You should have received a copy of the GNU General Public License
 * along with this program.  If not, see <http://www.gnu.org/licenses/>.
 */
 
#ifndef LIBREPCB_CORE_INTERACTIVEHTMLBOM_H
#define LIBREPCB_CORE_INTERACTIVEHTMLBOM_H
 
/*******************************************************************************
 *  Includes
 ******************************************************************************/
#include "../geometry/padgeometry.h"
#include "../geometry/padhole.h"
#include "../geometry/path.h"
#include "../utils/rusthandle.h"
 
#include <QtCore>
 
#include <optional>
 
/*******************************************************************************
 *  Namespace / Forward Declarations
 ******************************************************************************/
namespace librepcb {
 
class FilePath;
 
namespace rs {
struct InteractiveHtmlBom;
}
namespace rs {…}
 
/*******************************************************************************
 *  Class InteractiveHtmlBom
 ******************************************************************************/
 
class InteractiveHtmlBom final {
public:
  enum class ViewMode { BomOnly, LeftRight, TopBottom };
  enum class HighlightPin1Mode { None, Selected, All };
  enum class Layer { Top, Bottom };
  enum class Sides { Top, Bottom, Both };
  enum class DrawingKind { Polygon, ReferenceText, ValueText };
  enum class DrawingLayer {
    Edge,
    SilkscreenFront,
    SilkscreenBack,
    FabricationFront,
    FabricationBack,
  };
  enum class DrawingLayer {…};
  struct Pad {
    bool onTop;
    bool onBottom;
    Point position;
    Angle rotation;
    bool mirrorGeometry;
    QList<PadGeometry> geometries;
    PadHoleList holes;
    std::optional<QString> netName;
    bool pin1;
  };
  struct Pad {…};
 
  InteractiveHtmlBom() = delete;
  InteractiveHtmlBom(const InteractiveHtmlBom& other) = delete;
  InteractiveHtmlBom& operator=(const InteractiveHtmlBom& rhs) = delete;
 
  InteractiveHtmlBom(const QString& title, const QString& company,
                     const QString& revision, const QString& date,
                     const Point& topLeft, const Point& bottomRight);
 
  void setViewConfig(ViewMode mode, HighlightPin1Mode highlightPin1,
                     bool dark) noexcept;
 
  void setBoardRotation(const Angle& angle, bool offsetBack) noexcept;
 
  void setShowSilkscreen(bool show) noexcept;
 
  void setShowFabrication(bool show) noexcept;
 
  void setShowPads(bool show) noexcept;
 
  void setCheckBoxes(const QStringList& names) noexcept;
 
  void setFields(const QStringList& fields) noexcept;
 
  void addDrawing(DrawingKind kind, DrawingLayer layer, const Path& path,
                  const UnsignedLength& width, bool filled) noexcept;
 
  void addTrack(Layer layer, const Point& start, const Point& end,
                const PositiveLength& width,
                const std::optional<QString>& netName) noexcept;
 
  void addVia(QSet<Layer> layers, const Point& pos,
              const PositiveLength& diameter,
              const PositiveLength& drillDiameter,
              const std::optional<QString>& netName) noexcept;
 
  void addPlaneFragment(Layer layer, const Path& outline,
                        const std::optional<QString>& netName) noexcept;
 
  std::size_t addFootprint(Layer layer, const Point& pos, const Angle& rot,
                           const Point& topLeft, const Point& bottomRight,
                           bool mount, const QStringList& fields,
                           const QList<Pad>& pads) noexcept;
 
  void addBomRow(Sides sides,
                 const QList<std::pair<QString, std::size_t>>& parts) noexcept;
 
  QString generateHtml() const;
 
private:
  RustHandle<rs::InteractiveHtmlBom> mHandle;
};
class InteractiveHtmlBom final {…};
 
/*******************************************************************************
 *  End of File
 ******************************************************************************/
 
}  // namespace librepcb
 
#endif