LibrePCB

/*
 * 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_EDITOR_GRAPHICSLAYER_H
#define LIBREPCB_EDITOR_GRAPHICSLAYER_H

/*******************************************************************************
 *  Includes
 ******************************************************************************/
#include <librepcb/core/utils/signalslot.h>

#include <QtCore>
#include <QtWidgets>

#include <memory>

/*******************************************************************************
 *  Namespace / Forward Declarations
 ******************************************************************************/
namespace librepcb {

class ColorRole;
class Layer;

namespace editor {

/*******************************************************************************
 *  Class GraphicsLayer
 ******************************************************************************/

/**
 * @brief The GraphicsLayer class represents a graphical layer used in
 * schematics and boards
 *
 * These layers are used in graphics items (QGraphicsItem) to determine their
 * visibility and colors.
 */
class GraphicsLayer final {
  Q_DECLARE_TR_FUNCTIONS(GraphicsLayer)

public:
  // Types
  enum class DisabledMode {
    Grayscale,  ///< Convert #mColor to grayscale, keep its alpha value
    SemiTransparentGray,  ///< Always use a fixed gray with transparency
  };

  /// Item rendering state
  enum class State {
    // IMPORTANT: The order is relevant as it expresses the priority
    // (higher values have priority over lower values).
    Disabled,
    Enabled,
    Highlighted,
  };

  // Signals
  enum class Event {
    ColorChanged,
    HighlightColorChanged,
    VisibleChanged,
    EnabledChanged,
  };
  Signal<GraphicsLayer, Event> onEdited;
  typedef Slot<GraphicsLayer, Event> OnEditedSlot;

  // Constructors / Destructor
  GraphicsLayer() = delete;
  GraphicsLayer(const GraphicsLayer& other) noexcept;
  explicit GraphicsLayer(
      const ColorRole& role, const QColor& color,
      const QColor& colorHighlighted, bool visible = true, bool enabled = true,
      DisabledMode disabledMode = DisabledMode::SemiTransparentGray) noexcept;
  ~GraphicsLayer() noexcept;

  // Getters
  const ColorRole& getRole() const noexcept { return mRole; }
  const QColor& getColor(State state = State::Enabled) const noexcept;
  bool getVisible() const noexcept { return mIsVisible; }
  bool isEnabled() const noexcept { return mIsEnabled; }
  bool isVisible() const noexcept { return mIsEnabled && mIsVisible; }

  // Setters
  void setColor(const QColor& color) noexcept;
  void setColorHighlighted(const QColor& color) noexcept;
  void setVisible(bool visible) noexcept;
  void setEnabled(bool enable) noexcept;

  // Operator Overloadings
  GraphicsLayer& operator=(const GraphicsLayer& rhs) = delete;

private:
  void updateDisabledColor() noexcept;

protected:  // Data
  const ColorRole& mRole;  ///< Color role (from ::librepcb::ColorRole)
  const DisabledMode mDisabledMode;  ///< Rendering mode for disabled state
  QColor mColor;  ///< Color of graphics items
  QColor mColorHighlighted;  ///< Color of highlighted graphics items
  QColor mColorDisabled;  ///< Color of disabled graphics items (calculated)
  bool mIsVisible;  ///< Visibility of graphics items on that layer
  bool mIsEnabled;  ///< Availability of the layer itself
};

/*******************************************************************************
 *  End of File
 ******************************************************************************/

}  // namespace editor
}  // namespace librepcb

#endif