valentina/src/app/puzzle/layout/vppiece.h

/************************************************************************
 **
 **  @file   vppiece.h
 **  @author Ronan Le Tiec
 **  @date   13 4, 2020
 **
 **  @brief
 **  @copyright
 **  This source code is part of the Valentina project, a pattern making
 **  program, whose allow create and modeling patterns of clothing.
 **  Copyright (C) 2020 Valentina project
 **  <https://gitlab.com/smart-pattern/valentina> All Rights Reserved.
 **
 **  Valentina 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.
 **
 **  Valentina 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 Valentina.  If not, see <http://www.gnu.org/licenses/>.
 **
 *************************************************************************/
#ifndef VPPIECE_H
#define VPPIECE_H

#include <QPoint>
#include <QTransform>
#include <QUuid>
#include <QVector>

#include "../layout/layoutdef.h"
#include "../vlayout/vlayoutpiece.h"
#include "vpiecegrainline.h"

class VPLayout;
class VPSheet;

struct VStickyDistance
{
    QLineF m_closestDistance{};
    qreal m_pieceGap{0};
};

class VPPiece : public VLayoutPiece
{
    Q_DECLARE_TR_FUNCTIONS(VPPiece) // NOLINT

public:
    VPPiece() = default;
    explicit VPPiece(const VLayoutPiece &layoutPiece);
    ~VPPiece() override = default;

    void Update(const VPPiecePtr &piece);

    auto GetUniqueID() const -> QString override;

    void ClearTransformations();

    /**
     * @brief SetPosition Sets the position of the piece, in relation to the origin of the scene
     * @param point the point where to set the piece
     */
    void SetPosition(QPointF point);

    /**
     * @brief GetPosition Returns the position of the piece
     * @return the position of the piece
     */
    auto GetPosition() const -> QPointF;

    /**
     * @brief RotateToGrainline  rotates the piece to follow the grainline
     */
    void RotateToGrainline(const VPTransformationOrigon &origin);

    /**
     * @brief SetSelected Sets wether the piece is selected
     * @param value true if the piece is selected
     */
    void SetSelected(bool value);

    /**
     * @brief IsSelected Returns wether the piece is selected. It emit the signal SelectionChanged
     * @return true if the piece is selected
     */
    auto IsSelected() const -> bool;

    auto Sheet() const -> VPSheetPtr;
    void SetSheet(const VPSheetPtr &newSheet);

    auto Layout() const -> VPLayoutPtr;
    void SetLayout(const VPLayoutPtr &layout);

    void SetVPGrainline(const VPieceGrainline &grainline);

    /**
     * @brief Flip verticvally mirror around center of bounding rect
     */
    void FlipVertically();
    void FlipHorizontally();

    auto OutOfBound() const -> bool;
    void SetOutOfBound(bool newOutOfBound);

    auto HasSuperpositionWithPieces() const -> bool;
    void SetHasSuperpositionWithPieces(bool newHasSuperpositionWithPieces);

    auto StickyPosition(qreal &dx, qreal &dy) const -> bool;

    static auto PathsSuperposition(const QVector<QPointF> &path1, const QVector<QPointF> &path2) -> bool;
    static void CleanPosition(const VPPiecePtr &piece);

    auto IsValid(QString &error) const -> bool;

    auto CopyNumber() const -> quint16;
    void SetCopyNumber(quint16 newCopyNumber);

    auto ZValue() const -> qreal;
    void SetZValue(qreal newZValue);

private:
    // cppcheck-suppress unknownMacro
    Q_DISABLE_COPY_MOVE(VPPiece) // NOLINT

    VPLayoutWeakPtr m_layout{};

    VPSheetWeakPtr m_sheet{};

    bool m_isSelected{false};
    bool m_outOfBound{false};
    bool m_hasSuperpositionWithPieces{false};

    quint16 m_copyNumber{1};

    qreal m_zValue{1.0};

    auto StickySheet(VStickyDistance &match) const -> bool;
    auto StickyPieces(VStickyDistance &match) const -> bool;
};

//---------------------------------------------------------------------------------------------------------------------
inline void VPPiece::SetSelected(bool value)
{
    m_isSelected = value;
}

//---------------------------------------------------------------------------------------------------------------------
inline auto VPPiece::IsSelected() const -> bool
{
    return m_isSelected;
}

//---------------------------------------------------------------------------------------------------------------------
inline auto VPPiece::Sheet() const -> VPSheetPtr
{
    return m_sheet;
}

//---------------------------------------------------------------------------------------------------------------------
inline void VPPiece::SetSheet(const VPSheetPtr &newSheet)
{
    m_sheet = newSheet;
}

//---------------------------------------------------------------------------------------------------------------------
inline auto VPPiece::Layout() const -> VPLayoutPtr
{
    return m_layout;
}

//---------------------------------------------------------------------------------------------------------------------
inline void VPPiece::SetLayout(const VPLayoutPtr &layout)
{
    SCASSERT(layout != nullptr)
    m_layout = layout;
}

//---------------------------------------------------------------------------------------------------------------------
inline auto VPPiece::OutOfBound() const -> bool
{
    return m_outOfBound;
}

//---------------------------------------------------------------------------------------------------------------------
inline void VPPiece::SetOutOfBound(bool newOutOfBound)
{
    m_outOfBound = newOutOfBound;
}

//---------------------------------------------------------------------------------------------------------------------
inline auto VPPiece::HasSuperpositionWithPieces() const -> bool
{
    return m_hasSuperpositionWithPieces;
}

//---------------------------------------------------------------------------------------------------------------------
inline void VPPiece::SetHasSuperpositionWithPieces(bool newHasSuperpositionWithPieces)
{
    m_hasSuperpositionWithPieces = newHasSuperpositionWithPieces;
}

//---------------------------------------------------------------------------------------------------------------------
inline auto VPPiece::ZValue() const -> qreal
{
    return m_zValue;
}

//---------------------------------------------------------------------------------------------------------------------
inline void VPPiece::SetZValue(qreal newZValue)
{
    m_zValue = newZValue;
}

Q_DECLARE_METATYPE(VPPiecePtr) // NOLINT

#endif // VPPIECE_H