valentina/src/app/geometry/vdetail.h

353 lines
9.3 KiB
C
Raw Normal View History

/************************************************************************
**
** @file vdetail.h
** @author Roman Telezhynskyi <dismine(at)gmail.com>
** @date November 15, 2013
**
** @brief
** @copyright
** This source code is part of the Valentine project, a pattern making
** program, whose allow create and modeling patterns of clothing.
** Copyright (C) 2013 Valentina project
** <https://bitbucket.org/dismine/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/>.
**
*************************************************************************/
2013-08-28 10:55:11 +02:00
#ifndef VDETAIL_H
#define VDETAIL_H
#include "vnodedetail.h"
#include <QVector>
class QString;
enum class Contour : char { OpenContour, CloseContour };
enum class EquidistantType : char { OpenEquidistant, CloseEquidistant };
/**
* @brief The VDetail class for path of object (points, arcs, splines).
*/
class VDetail
{
2013-08-28 10:55:11 +02:00
public:
/**
* @brief VDetail default contructor. Create empty detail.
*/
VDetail();
/**
* @brief VDetail constructor.
* @param name detail name.
* @param nodes list of nodes.
*/
VDetail(const QString &name, const QVector<VNodeDetail> &nodes);
/**
* @brief VDetail copy constructor.
* @param detail detail.
*/
VDetail(const VDetail &detail);
/**
* @brief operator = assignment operator.
* @param detail detail.
* @return new detail.
*/
VDetail &operator=(const VDetail &detail);
/**
* @brief append append in the end of list node.
* @param node new node.
*/
void append(const VNodeDetail &node);
/**
* @brief Clear detail full clear.
*/
2013-10-26 22:42:54 +02:00
void Clear();
/**
* @brief ClearNodes clear list of nodes.
*/
void ClearNodes();
/**
* @brief CountNode return count nodes.
* @return count.
*/
qint32 CountNode() const;
/**
* @brief Containes check if detail containe this id.
* @param id object id.
* @return true if containe.
*/
bool Containes(const quint32 &id)const;
/**
* @brief operator [] find node by index in list.
* @param indx index node in list.
* @return node
*/
VNodeDetail & operator[](ptrdiff_t indx);
/**
* @brief at find node by index in list.
* @param indx index node in list.
* @return const node.
*/
const VNodeDetail & at ( ptrdiff_t indx ) const;
/**
* @brief getName return detail name.
* @return name.
*/
QString getName() const;
/**
* @brief setName set detail name.
* @param value new name.
*/
void setName(const QString &value);
/**
* @brief getMx return bias for X axis.
* @return x bias.
*/
qreal getMx() const;
/**
* @brief setMx set bias for X axis.
* @param value new x bias.
*/
void setMx(const qreal &value);
/**
* @brief getMy get bias for y axis.
* @return y axis.
*/
qreal getMy() const;
/**
* @brief setMy set bias for y axis.
* @param value new y bias.
*/
void setMy(const qreal &value);
/**
* @brief getSeamAllowance keep status for seam allowance detail.
* @return true - need seam allowance, false - no need seam allowance.
*/
bool getSeamAllowance() const;
/**
* @brief setSeamAllowance set status for seam allowance detail.
* @param value true - need seam allowance, false - no need seam allowance.
*/
void setSeamAllowance(bool value);
/**
* @brief getClosed keep close status for detail equdistant.
* @return true - close equdistant, false - don't close equdistant.
*/
bool getClosed() const;
/**
* @brief setClosed set close status for detail equdistant.
* @param value true - close equdistant, false - don't close equdistant.
*/
void setClosed(bool value);
/**
* @brief getWidth return value detail seam allowance.
* @return value in mm.
*/
qreal getWidth() const;
/**
* @brief setWidth set value detail seam allowance.
* @param value width in mm.
*/
void setWidth(const qreal &value);
/**
* @brief getNodes return list of nodes.
* @return list of nodes.
*/
QVector<VNodeDetail> getNodes() const;
/**
* @brief setNodes set list of nodes
* @param value list of nodes
*/
void setNodes(const QVector<VNodeDetail> &value);
/**
* @brief indexOfNode return index in list node using id object.
* @param id object (arc, point, spline, splinePath) id.
* @return index in list or -1 id can't find.
*/
ptrdiff_t indexOfNode(const quint32 &id) const;
/**
* @brief id return id detail in list data.
* @return id.
*/
quint32 id() const;
/**
* @brief setId set id detail in list data.
* @param id detail id.
*/
void setId(const quint32 &id);
/**
* @brief OnEdge checks if two poins located on the edge. Edge is line between two points. If between two points
* located arcs or splines ignore this.
* @param p1 id first point.
* @param p2 id second point.
* @return true - on edge, false - no.
*/
bool OnEdge(const quint32 &p1, const quint32 &p2)const;
/**
* @brief Edge return edge index in detail. Edge is line between two points. If between two points
* located arcs or splines ignore this.
* @param p1 id first point.
* @param p2 id second point.
* @return edge index or -1 if points don't located on edge
*/
ptrdiff_t Edge(const quint32 &p1, const quint32 &p2)const;
/**
* @brief NodeOnEdge return nodes located on edge with index.
* @param index index of edge.
* @param p1 first node.
* @param p2 second node.
*/
void NodeOnEdge(const quint32 &index, VNodeDetail &p1, VNodeDetail &p2)const;
/**
* @brief RemoveEdge return detail without edge with index.
* @param index idex of edge.
* @return detail without edge with index.
*/
VDetail RemoveEdge(const quint32 &index) const;
/**
* @brief Missing find missing ids in detail. When we deleted object in detail and return this detail need
* understand, what nodes need make invisible.
* @param det changed detail.
* @return list with missing detail.
*/
QList<quint32> Missing(const VDetail &det) const;
2013-08-28 10:55:11 +02:00
private:
/**
* @brief _id id detail.
*/
quint32 _id;
/**
* @brief nodes list detail nodes.
*/
2013-08-28 10:55:11 +02:00
QVector<VNodeDetail> nodes;
/**
* @brief name detail name.
*/
2013-10-26 22:42:54 +02:00
QString name;
/**
* @brief mx bias x axis.
*/
2013-10-26 22:42:54 +02:00
qreal mx;
/**
* @brief my bias y axis.
*/
2013-10-26 22:42:54 +02:00
qreal my;
/**
* @brief seamAllowance status seamAllowance detail.
*/
bool seamAllowance;
/**
* @brief closed status equdistant detail.
*/
2013-10-26 22:42:54 +02:00
bool closed;
/**
* @brief width value seamAllowance in mm.
*/
2013-10-26 22:42:54 +02:00
qreal width;
/**
* @brief listNodePoint return list nodes only with points.
* @return list points node.
*/
QVector<VNodeDetail> listNodePoint()const;
/**
* @brief indexOfNode return index in list node using id object.
* @param list list nodes detail.
* @param id object (arc, point, spline, splinePath) id.
* @return index in list or -1 id can't find.
*/
static ptrdiff_t indexOfNode(const QVector<VNodeDetail> &list, const quint32 &id);
2013-08-28 10:55:11 +02:00
};
inline void VDetail::append(const VNodeDetail &node)
{
nodes.append(node);
}
inline qint32 VDetail::CountNode() const
{
return nodes.size();
}
inline QString VDetail::getName() const
{
return name;
}
inline void VDetail::setName(const QString &value)
{
name = value;
}
inline qreal VDetail::getMx() const
{
return mx;
}
inline void VDetail::setMx(const qreal &value)
{
mx = value;
}
inline qreal VDetail::getMy() const
{
return my;
}
inline void VDetail::setMy(const qreal &value)
{
my = value;
}
inline bool VDetail::getSeamAllowance() const
{
return seamAllowance;
}
inline void VDetail::setSeamAllowance(bool value)
{
seamAllowance = value;
}
inline bool VDetail::getClosed() const
{
return closed;
}
inline void VDetail::setClosed(bool value)
{
closed = value;
}
inline qreal VDetail::getWidth() const
{
return width;
}
inline void VDetail::setWidth(const qreal &value)
{
width = value;
}
inline QVector<VNodeDetail> VDetail::getNodes() const
{
return nodes;
}
inline void VDetail::setNodes(const QVector<VNodeDetail> &value)
{
nodes = value;
}
2013-08-28 10:55:11 +02:00
#endif // VDETAIL_H