valentina/src/app/puzzle/vpuzzlelayout.h

205 lines
5.7 KiB
C
Raw Normal View History

2020-04-13 18:58:16 +02:00
/************************************************************************
**
** @file vpuzzlelayout.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 VPUZZLELAYOUT_H
#define VPUZZLELAYOUT_H
#include <QSizeF>
#include <QMarginsF>
#include <QList>
2020-04-13 18:58:16 +02:00
#include "def.h"
class VPuzzleLayer;
2020-04-13 18:58:16 +02:00
// is this the right place for the definition?
enum class FollowGrainline : qint8 { No = 0, Follow90 = 1, Follow180 = 2};
class VPuzzleLayout
{
public:
VPuzzleLayout();
virtual ~VPuzzleLayout();
VPuzzleLayer* GetUnplacedPiecesLayer();
VPuzzleLayer* AddLayer();
VPuzzleLayer* AddLayer(VPuzzleLayer *layer);
QList<VPuzzleLayer *> GetLayers();
void SetUnit(Unit unit);
2020-04-23 14:50:20 +02:00
Unit getUnit() const;
2020-04-13 18:58:16 +02:00
2020-04-19 11:58:43 +02:00
/**
* @brief SetLayoutSize sets the size of the layout, the values have to be in Unit::Px
* @param width
* @param height
*/
2020-04-13 18:58:16 +02:00
void SetLayoutSize(qreal width, qreal height);
2020-04-19 11:58:43 +02:00
/**
* @brief SetLayoutSize sets the size of the layout, the values have to be in the layout's unit
* @param width
* @param height
*/
void SetLayoutSizeConverted(qreal width, qreal height);
/**
* @brief SetLayoutSize sets the size of the layout, the values have to be in Unit::Px
* @param size
*/
2020-04-23 14:50:20 +02:00
void SetLayoutSize(const QSizeF &size);
2020-04-19 11:58:43 +02:00
/**
* @brief SetLayoutSizeConverted sets the size of the layout, the values have to be in the layout's unit
* @param size
*/
2020-04-23 14:50:20 +02:00
void SetLayoutSizeConverted(const QSizeF &size);
2020-04-19 11:58:43 +02:00
/**
* @brief GetLayoutSize Returns the size in Unit::Px
* @return
*/
2020-04-23 14:50:20 +02:00
QSizeF GetLayoutSize() const;
2020-04-13 18:58:16 +02:00
2020-04-19 11:58:43 +02:00
/**
* @brief GetLayoutSizeConverted Returns the size in the layout's unit
* @return
*/
2020-04-23 14:50:20 +02:00
QSizeF GetLayoutSizeConverted() const;
2020-04-19 11:58:43 +02:00
/**
* @brief SetLayoutMargins, set the margins of the layout, the values have to be in Unit::Px
* @param left in Unit::Px
* @param top in Unit::Px
* @param right in Unit::Px
* @param bottom in Unit::Px
*/
2020-04-13 18:58:16 +02:00
void SetLayoutMargins(qreal left, qreal top, qreal right, qreal bottom);
2020-04-19 11:58:43 +02:00
/**
* @brief SetLayoutMargins, set the margins of the layout, the values have to be in the unit of the layout
* @param left in Unit::Px
* @param top in Unit::Px
* @param right in Unit::Px
* @param bottom in Unit::Px
*/
void SetLayoutMarginsConverted(qreal left, qreal top, qreal right, qreal bottom);
/**
* @brief SetLayoutMargins set the margins of the layout, the values have to be in Unit::Px
* @param margins
*/
2020-04-23 14:03:14 +02:00
void SetLayoutMargins(const QMarginsF &margins);
2020-04-19 11:58:43 +02:00
/**
* @brief SetLayoutMargins set the margins of the layout, the values have to be in the unit of the layout
* @param margins
*/
2020-04-23 14:03:14 +02:00
void SetLayoutMarginsConverted(const QMarginsF &margins);
2020-04-19 11:58:43 +02:00
/**
* @brief GetLayoutMargins Returns the size in Unit::Px
* @return
*/
2020-04-23 14:50:20 +02:00
QMarginsF GetLayoutMargins() const;
2020-04-13 18:58:16 +02:00
2020-04-19 11:58:43 +02:00
/**
* @brief GetLayoutMarginsConverted Returns the margins in the layout's unit
* @return
*/
2020-04-23 14:50:20 +02:00
QMarginsF GetLayoutMarginsConverted() const;
2020-04-19 11:58:43 +02:00
2020-04-13 18:58:16 +02:00
void SetFollowGrainline(FollowGrainline state);
FollowGrainline SetFollowGrainline();
2020-04-19 11:58:43 +02:00
/**
* @brief SetPiecesGap sets the pieces gap to the given value, the unit has to be in Unit::Px
* @param value
*/
2020-04-13 18:58:16 +02:00
void SetPiecesGap(qreal value);
2020-04-19 11:58:43 +02:00
/**
* @brief SetPiecesGapConverted sets the pieces gap to the given value, the unit has to be in the layout's unit
* @param value
*/
void SetPiecesGapConverted(qreal value);
/**
* @brief GetPiecesGap returns the pieces gap in Unit::Px
* @return
*/
2020-04-23 14:50:20 +02:00
qreal GetPiecesGap() const;
2020-04-13 18:58:16 +02:00
2020-04-19 11:58:43 +02:00
/**
* @brief GetPiecesGapConverted returns the pieces gap in the layout's unit
* @return
*/
2020-04-23 14:50:20 +02:00
qreal GetPiecesGapConverted() const;
2020-04-19 11:58:43 +02:00
2020-04-13 18:58:16 +02:00
void SetWarningSuperpositionOfPieces(bool state);
2020-04-23 14:50:20 +02:00
bool GetWarningSuperpositionOfPieces() const;
2020-04-13 18:58:16 +02:00
void SetWarningPiecesOutOfBound(bool state);
2020-04-23 14:50:20 +02:00
bool GetWarningPiecesOutOfBound() const;
2020-04-13 18:58:16 +02:00
void SetStickyEdges(bool state);
2020-04-23 14:50:20 +02:00
bool GetStickyEdges() const;
2020-04-13 18:58:16 +02:00
private:
2020-04-13 19:03:01 +02:00
Q_DISABLE_COPY(VPuzzleLayout)
2020-04-13 18:58:16 +02:00
VPuzzleLayer *m_unplacedPiecesLayer;
QList<VPuzzleLayer *> m_layers;
// format
2020-04-18 11:31:55 +02:00
Unit m_unit;
2020-04-19 11:58:43 +02:00
/**
* @brief m_size the Size in Unit::Px
*/
2020-04-18 11:31:55 +02:00
QSizeF m_size;
2020-04-13 18:58:16 +02:00
// margins
2020-04-19 11:58:43 +02:00
/**
* @brief m_margins the margins in Unit::Px
*/
2020-04-18 11:31:55 +02:00
QMarginsF m_margins;
2020-04-13 18:58:16 +02:00
// control
FollowGrainline m_followGrainLine;
2020-04-19 11:58:43 +02:00
/**
* @brief m_piecesGap the pieces gap in Unit::Px
*/
2020-04-13 18:58:16 +02:00
qreal m_piecesGap;
bool m_warningSuperpositionOfPieces;
bool m_warningPiecesOutOfBound;
bool m_stickyEdges;
};
#endif // VPUZZLELAYOUT_H