aw/valentina
1
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

Documentation for VToolAlongLine class.

Browse Source 
--HG--
branch : develop
This commit is contained in:
dismine 2014-01-24 18:10:53 +02:00
parent e5f58b7a10
commit 9a92096853
28 changed files with 151 additions and 160 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

69
src/tools/drawTools/vtoolalongline.h
View File

@ -33,23 +33,23 @@
#include "../../dialogs/dialogalongline.h" #include "../../dialogs/dialogalongline.h"
/** /**
* @brief The VToolAlongLine class * @brief The VToolAlongLine class tool for creation point along line.
*/ */
class VToolAlongLine : public VToolLinePoint class VToolAlongLine : public VToolLinePoint
{ {
Q_OBJECT Q_OBJECT
public: public:
/** /**
* @brief VToolAlongLine * @brief VToolAlongLine constuctor.
* @param doc dom document container * @param doc dom document container.
* @param data container with variables * @param data container with variables.
* @param id object id in container * @param id object id in container.
* @param formula * @param formula string with length formula.
* @param firstPointId * @param firstPointId id first point of line.
* @param secondPointId * @param secondPointId id second point of line.
* @param typeLine * @param typeLine line type. line type.
* @param typeCreation way we create this tool. * @param typeCreation way we create this tool.
* @param parent parent object * @param parent parent object.
*/ */
VToolAlongLine(VDomDocument *doc, VContainer *data, qint64 id, const QString &formula, VToolAlongLine(VDomDocument *doc, VContainer *data, qint64 id, const QString &formula,
const qint64 &firstPointId, const qint64 &secondPointId, const QString &typeLine, const qint64 &firstPointId, const qint64 &secondPointId, const QString &typeLine,
@ -59,37 +59,34 @@ public:
*/ */
virtual void setDialog(); virtual void setDialog();
/** /**
* @brief Create * @brief Create help create tool form GUI.
* @param dialog * @param dialog dialog options.
* @param scene pointer to scene. * @param scene pointer to scene.
* @param doc dom document container * @param doc dom document container.
* @param data container with variables * @param data container with variables.
*/ */
static void Create(QSharedPointer<DialogAlongLine> &dialog, VMainGraphicsScene *scene, VDomDocument *doc, static void Create(QSharedPointer<DialogAlongLine> &dialog, VMainGraphicsScene *scene, VDomDocument *doc,
VContainer *data); VContainer *data);
/** /**
* @brief Create * @brief Create help create tool.
* @param _id tool id, 0 if tool doesn't exist yet. * @param _id tool id, 0 if tool doesn't exist yet.
* @param pointName * @param pointName point name.
* @param typeLine * @param typeLine line type.
* @param formula * @param formula string with length formula.
* @param firstPointId * @param firstPointId id first point of line.
* @param secondPointId * @param secondPointId id second point of line.
* @param mx * @param mx label bias x axis.
* @param my * @param my label bias y axis.
* @param scene pointer to scene. * @param scene pointer to scene.
* @param doc dom document container * @param doc dom document container.
* @param data container with variables * @param data container with variables.
* @param parse * @param parse parser file mode.
* @param typeCreation way we create this tool. * @param typeCreation way we create this tool.
*/ */
static void Create(const qint64 _id, const QString &pointName, const QString &typeLine, const QString &formula, static void Create(const qint64 _id, const QString &pointName, const QString &typeLine, const QString &formula,
const qint64 &firstPointId, const qint64 &secondPointId, const qreal &mx, const qreal &my, const qint64 &firstPointId, const qint64 &secondPointId, const qreal &mx, const qreal &my,
VMainGraphicsScene *scene, VDomDocument *doc, VContainer *data, VMainGraphicsScene *scene, VDomDocument *doc, VContainer *data,
const Document::Documents &parse, const Tool::Sources &typeCreation); const Document::Documents &parse, const Tool::Sources &typeCreation);
/**
* @brief ToolType
*/
static const QString ToolType; static const QString ToolType;
public slots: public slots:
/** /**
@ -98,19 +95,23 @@ public slots:
virtual void FullUpdateFromFile(); virtual void FullUpdateFromFile();
/** /**
* @brief FullUpdateFromGui refresh tool data from change options. * @brief FullUpdateFromGui refresh tool data from change options.
* @param result * @param result result working dialog.
*/ */
virtual void FullUpdateFromGui(int result); virtual void FullUpdateFromGui(int result);
/** /**
* @brief SetFactor set current scale factor of scene. * @brief SetFactor set current scale factor of scene.
* @param factor * @param factor scene scale factor.
*/ */
virtual void SetFactor(qreal factor); virtual void SetFactor(qreal factor);
/**
* @brief ShowContextMenu handle context menu event.
* @param event context menu event.
*/
virtual void ShowContextMenu(QGraphicsSceneContextMenuEvent *event); virtual void ShowContextMenu(QGraphicsSceneContextMenuEvent *event);
protected: protected:
/** /**
* @brief contextMenuEvent * @brief contextMenuEvent handle context menu event.
* @param event * @param event context menu event.
*/ */
virtual void contextMenuEvent ( QGraphicsSceneContextMenuEvent * event ); virtual void contextMenuEvent ( QGraphicsSceneContextMenuEvent * event );
/** /**
@ -127,11 +128,11 @@ protected:
virtual void RemoveReferens(); virtual void RemoveReferens();
private: private:
/** /**
* @brief secondPointId * @brief secondPointId id second point of line.
*/ */
qint64 secondPointId; qint64 secondPointId;
/** /**
* @brief dialogAlongLine * @brief dialogAlongLine dialog.
*/ */
QSharedPointer<DialogAlongLine> dialogAlongLine; QSharedPointer<DialogAlongLine> dialogAlongLine;
}; };

8
src/tools/drawTools/vtoolarc.h
View File

@ -56,7 +56,7 @@ public:
*/ */
virtual void setDialog(); virtual void setDialog();
/** /**
* @brief Create * @brief Create help create tool
* @param dialog * @param dialog
* @param scene pointer to scene. * @param scene pointer to scene.
* @param doc dom document container * @param doc dom document container
@ -65,7 +65,7 @@ public:
static void Create(QSharedPointer<DialogArc> &dialog, VMainGraphicsScene *scene, VDomDocument *doc, static void Create(QSharedPointer<DialogArc> &dialog, VMainGraphicsScene *scene, VDomDocument *doc,
VContainer *data); VContainer *data);
/** /**
* @brief Create * @brief Create help create tool
* @param _id tool id, 0 if tool doesn't exist yet. * @param _id tool id, 0 if tool doesn't exist yet.
* @param center * @param center
* @param radius * @param radius
@ -74,7 +74,7 @@ public:
* @param scene pointer to scene. * @param scene pointer to scene.
* @param doc dom document container * @param doc dom document container
* @param data container with variables * @param data container with variables
* @param parse * @param parse parser file mode.
* @param typeCreation way we create this tool. * @param typeCreation way we create this tool.
*/ */
static void Create(const qint64 _id, const qint64 &center, const QString &radius, const QString &f1, static void Create(const qint64 _id, const qint64 &center, const QString &radius, const QString &f1,
@ -112,7 +112,7 @@ public slots:
virtual void ShowTool(qint64 id, Qt::GlobalColor color, bool enable); virtual void ShowTool(qint64 id, Qt::GlobalColor color, bool enable);
/** /**
* @brief SetFactor set current scale factor of scene. * @brief SetFactor set current scale factor of scene.
* @param factor * @param factor scene scale factor.
*/ */
virtual void SetFactor(qreal factor); virtual void SetFactor(qreal factor);
protected: protected:

16
src/tools/drawTools/vtoolbisector.h
View File

@ -43,7 +43,7 @@ public:
* @param doc dom document container * @param doc dom document container
* @param data container with variables * @param data container with variables
* @param id object id in container * @param id object id in container
* @param typeLine * @param typeLine line type.
* @param formula * @param formula
* @param firstPointId * @param firstPointId
* @param secondPointId * @param secondPointId
@ -70,7 +70,7 @@ public:
*/ */
virtual void setDialog(); virtual void setDialog();
/** /**
* @brief Create * @brief Create help create tool
* @param dialog * @param dialog
* @param scene pointer to scene. * @param scene pointer to scene.
* @param doc dom document container * @param doc dom document container
@ -79,20 +79,20 @@ public:
static void Create(QSharedPointer<DialogBisector> &dialog, VMainGraphicsScene *scene, static void Create(QSharedPointer<DialogBisector> &dialog, VMainGraphicsScene *scene,
VDomDocument *doc, VContainer *data); VDomDocument *doc, VContainer *data);
/** /**
* @brief Create * @brief Create help create tool
* @param _id tool id, 0 if tool doesn't exist yet. * @param _id tool id, 0 if tool doesn't exist yet.
* @param formula * @param formula
* @param firstPointId * @param firstPointId
* @param secondPointId * @param secondPointId
* @param thirdPointId * @param thirdPointId
* @param typeLine * @param typeLine line type.
* @param pointName * @param pointName
* @param mx * @param mx label bias x axis.
* @param my * @param my label bias y axis.
* @param scene pointer to scene. * @param scene pointer to scene.
* @param doc dom document container * @param doc dom document container
* @param data container with variables * @param data container with variables
* @param parse * @param parse parser file mode.
* @param typeCreation way we create this tool. * @param typeCreation way we create this tool.
*/ */
static void Create(const qint64 _id, const QString &formula, const qint64 &firstPointId, static void Create(const qint64 _id, const QString &formula, const qint64 &firstPointId,
@ -116,7 +116,7 @@ public slots:
virtual void FullUpdateFromGui(int result); virtual void FullUpdateFromGui(int result);
/** /**
* @brief SetFactor set current scale factor of scene. * @brief SetFactor set current scale factor of scene.
* @param factor * @param factor scene scale factor.
*/ */
virtual void SetFactor(qreal factor); virtual void SetFactor(qreal factor);
virtual void ShowContextMenu(QGraphicsSceneContextMenuEvent *event); virtual void ShowContextMenu(QGraphicsSceneContextMenuEvent *event);

10
src/tools/drawTools/vtoolcutspline.h
View File

@ -58,7 +58,7 @@ public:
*/ */
virtual void setDialog(); virtual void setDialog();
/** /**
* @brief Create * @brief Create help create tool
* @param dialog * @param dialog
* @param scene pointer to scene. * @param scene pointer to scene.
* @param doc dom document container * @param doc dom document container
@ -67,17 +67,17 @@ public:
static void Create(QSharedPointer<DialogCutSpline> &dialog, VMainGraphicsScene *scene, VDomDocument *doc, static void Create(QSharedPointer<DialogCutSpline> &dialog, VMainGraphicsScene *scene, VDomDocument *doc,
VContainer *data); VContainer *data);
/** /**
* @brief Create * @brief Create help create tool
* @param _id tool id, 0 if tool doesn't exist yet. * @param _id tool id, 0 if tool doesn't exist yet.
* @param pointName * @param pointName
* @param formula * @param formula
* @param splineId * @param splineId
* @param mx * @param mx label bias x axis.
* @param my * @param my label bias y axis.
* @param scene pointer to scene. * @param scene pointer to scene.
* @param doc dom document container * @param doc dom document container
* @param data container with variables * @param data container with variables
* @param parse * @param parse parser file mode.
* @param typeCreation way we create this tool. * @param typeCreation way we create this tool.
*/ */
static void Create(const qint64 _id, const QString &pointName, static void Create(const qint64 _id, const QString &pointName,

10
src/tools/drawTools/vtoolcutsplinepath.h
View File

@ -48,7 +48,7 @@ public:
*/ */
virtual void setDialog(); virtual void setDialog();
/** /**
* @brief Create * @brief Create help create tool
* @param dialog * @param dialog
* @param scene pointer to scene. * @param scene pointer to scene.
* @param doc dom document container * @param doc dom document container
@ -57,17 +57,17 @@ public:
static void Create(QSharedPointer<DialogCutSplinePath> &dialog, VMainGraphicsScene *scene, static void Create(QSharedPointer<DialogCutSplinePath> &dialog, VMainGraphicsScene *scene,
VDomDocument *doc, VContainer *data); VDomDocument *doc, VContainer *data);
/** /**
* @brief Create * @brief Create help create tool
* @param _id tool id, 0 if tool doesn't exist yet. * @param _id tool id, 0 if tool doesn't exist yet.
* @param pointName * @param pointName
* @param formula * @param formula
* @param splineId * @param splineId
* @param mx * @param mx label bias x axis.
* @param my * @param my label bias y axis.
* @param scene pointer to scene. * @param scene pointer to scene.
* @param doc dom document container * @param doc dom document container
* @param data container with variables * @param data container with variables
* @param parse * @param parse parser file mode.
* @param typeCreation way we create this tool. * @param typeCreation way we create this tool.
*/ */
static void Create(const qint64 _id, const QString &pointName, const QString &formula, static void Create(const qint64 _id, const QString &pointName, const QString &formula,

14
src/tools/drawTools/vtoolendline.h
View File

@ -44,7 +44,7 @@ public:
* @param doc dom document container * @param doc dom document container
* @param data container with variables * @param data container with variables
* @param id object id in container * @param id object id in container
* @param typeLine * @param typeLine line type.
* @param formula * @param formula
* @param angle * @param angle
* @param basePointId * @param basePointId
@ -59,7 +59,7 @@ public:
*/ */
virtual void setDialog(); virtual void setDialog();
/** /**
* @brief Create * @brief Create help create tool
* @param dialog * @param dialog
* @param scene pointer to scene. * @param scene pointer to scene.
* @param doc dom document container * @param doc dom document container
@ -68,19 +68,19 @@ public:
static void Create(QSharedPointer<DialogEndLine> &dialog, VMainGraphicsScene *scene, VDomDocument *doc, static void Create(QSharedPointer<DialogEndLine> &dialog, VMainGraphicsScene *scene, VDomDocument *doc,
VContainer *data); VContainer *data);
/** /**
* @brief Create * @brief Create help create tool
* @param _id tool id, 0 if tool doesn't exist yet. * @param _id tool id, 0 if tool doesn't exist yet.
* @param pointName * @param pointName
* @param typeLine * @param typeLine line type.
* @param formula * @param formula
* @param angle * @param angle
* @param basePointId * @param basePointId
* @param mx * @param mx label bias x axis.
* @param my * @param my label bias y axis.
* @param scene pointer to scene. * @param scene pointer to scene.
* @param doc dom document container * @param doc dom document container
* @param data container with variables * @param data container with variables
* @param parse * @param parse parser file mode.
* @param typeCreation way we create this tool. * @param typeCreation way we create this tool.
*/ */
static void Create(const qint64 _id, const QString &pointName, const QString &typeLine, static void Create(const qint64 _id, const QString &pointName, const QString &typeLine,

14
src/tools/drawTools/vtoolheight.h
View File

@ -44,7 +44,7 @@ public:
* @param doc dom document container * @param doc dom document container
* @param data container with variables * @param data container with variables
* @param id object id in container * @param id object id in container
* @param typeLine * @param typeLine line type.
* @param basePointId * @param basePointId
* @param p1LineId * @param p1LineId
* @param p2LineId * @param p2LineId
@ -59,7 +59,7 @@ public:
*/ */
virtual void setDialog(); virtual void setDialog();
/** /**
* @brief Create * @brief Create help create tool
* @param dialog * @param dialog
* @param scene pointer to scene. * @param scene pointer to scene.
* @param doc dom document container * @param doc dom document container
@ -68,19 +68,19 @@ public:
static void Create(QSharedPointer<DialogHeight> &dialog, VMainGraphicsScene *scene, static void Create(QSharedPointer<DialogHeight> &dialog, VMainGraphicsScene *scene,
VDomDocument *doc, VContainer *data); VDomDocument *doc, VContainer *data);
/** /**
* @brief Create * @brief Create help create tool
* @param _id tool id, 0 if tool doesn't exist yet. * @param _id tool id, 0 if tool doesn't exist yet.
* @param pointName * @param pointName
* @param typeLine * @param typeLine line type.
* @param basePointId * @param basePointId
* @param p1LineId * @param p1LineId
* @param p2LineId * @param p2LineId
* @param mx * @param mx label bias x axis.
* @param my * @param my label bias y axis.
* @param scene pointer to scene. * @param scene pointer to scene.
* @param doc dom document container * @param doc dom document container
* @param data container with variables * @param data container with variables
* @param parse * @param parse parser file mode.
* @param typeCreation way we create this tool. * @param typeCreation way we create this tool.
*/ */
static void Create(const qint64 _id, const QString &pointName, const QString &typeLine, static void Create(const qint64 _id, const QString &pointName, const QString &typeLine,

8
src/tools/drawTools/vtoolline.h
View File

@ -57,7 +57,7 @@ public:
*/ */
virtual void setDialog(); virtual void setDialog();
/** /**
* @brief Create * @brief Create help create tool
* @param dialog * @param dialog
* @param scene pointer to scene. * @param scene pointer to scene.
* @param doc dom document container * @param doc dom document container
@ -66,14 +66,14 @@ public:
static void Create(QSharedPointer<DialogLine> &dialog, VMainGraphicsScene *scene, VDomDocument *doc, static void Create(QSharedPointer<DialogLine> &dialog, VMainGraphicsScene *scene, VDomDocument *doc,
VContainer *data); VContainer *data);
/** /**
* @brief Create * @brief Create help create tool
* @param _id tool id, 0 if tool doesn't exist yet. * @param _id tool id, 0 if tool doesn't exist yet.
* @param firstPoint * @param firstPoint
* @param secondPoint * @param secondPoint
* @param scene pointer to scene. * @param scene pointer to scene.
* @param doc dom document container * @param doc dom document container
* @param data container with variables * @param data container with variables
* @param parse * @param parse parser file mode.
* @param typeCreation way we create this tool. * @param typeCreation way we create this tool.
*/ */
static void Create(const qint64 &_id, const qint64 &firstPoint, const qint64 &secondPoint, static void Create(const qint64 &_id, const qint64 &firstPoint, const qint64 &secondPoint,
@ -107,7 +107,7 @@ public slots:
virtual void ShowTool(qint64 id, Qt::GlobalColor color, bool enable); virtual void ShowTool(qint64 id, Qt::GlobalColor color, bool enable);
/** /**
* @brief SetFactor set current scale factor of scene. * @brief SetFactor set current scale factor of scene.
* @param factor * @param factor scene scale factor.
*/ */
virtual void SetFactor(qreal factor); virtual void SetFactor(qreal factor);
protected: protected:

12
src/tools/drawTools/vtoollineintersect.h
View File

@ -59,7 +59,7 @@ public:
*/ */
virtual void setDialog(); virtual void setDialog();
/** /**
* @brief Create * @brief Create help create tool
* @param dialog * @param dialog
* @param scene pointer to scene. * @param scene pointer to scene.
* @param doc dom document container * @param doc dom document container
@ -68,19 +68,19 @@ public:
static void Create(QSharedPointer<DialogLineIntersect> &dialog, VMainGraphicsScene *scene, VDomDocument *doc, static void Create(QSharedPointer<DialogLineIntersect> &dialog, VMainGraphicsScene *scene, VDomDocument *doc,
VContainer *data); VContainer *data);
/** /**
* @brief Create * @brief Create help create tool
* @param _id tool id, 0 if tool doesn't exist yet. * @param _id tool id, 0 if tool doesn't exist yet.
* @param p1Line1Id * @param p1Line1Id
* @param p2Line1Id * @param p2Line1Id
* @param p1Line2Id * @param p1Line2Id
* @param p2Line2Id * @param p2Line2Id
* @param pointName * @param pointName
* @param mx * @param mx label bias x axis.
* @param my * @param my label bias y axis.
* @param scene pointer to scene. * @param scene pointer to scene.
* @param doc dom document container * @param doc dom document container
* @param data container with variables * @param data container with variables
* @param parse * @param parse parser file mode.
* @param typeCreation way we create this tool. * @param typeCreation way we create this tool.
*/ */
static void Create(const qint64 _id, const qint64 &p1Line1Id, const qint64 &p2Line1Id, const qint64 &p1Line2Id, static void Create(const qint64 _id, const qint64 &p1Line1Id, const qint64 &p2Line1Id, const qint64 &p1Line2Id,
@ -103,7 +103,7 @@ public slots:
virtual void FullUpdateFromGui(int result); virtual void FullUpdateFromGui(int result);
/** /**
* @brief SetFactor set current scale factor of scene. * @brief SetFactor set current scale factor of scene.
* @param factor * @param factor scene scale factor.
*/ */
virtual void SetFactor(qreal factor); virtual void SetFactor(qreal factor);
virtual void ShowContextMenu(QGraphicsSceneContextMenuEvent *event); virtual void ShowContextMenu(QGraphicsSceneContextMenuEvent *event);

4
src/tools/drawTools/vtoollinepoint.h
View File

@ -43,7 +43,7 @@ public:
* @param doc dom document container * @param doc dom document container
* @param data container with variables * @param data container with variables
* @param id object id in container * @param id object id in container
* @param typeLine * @param typeLine line type.
* @param formula * @param formula
* @param basePointId * @param basePointId
* @param angle * @param angle
@ -60,7 +60,7 @@ public slots:
virtual void ChangedActivDraw(const QString &newName); virtual void ChangedActivDraw(const QString &newName);
/** /**
* @brief SetFactor set current scale factor of scene. * @brief SetFactor set current scale factor of scene.
* @param factor * @param factor scene scale factor.
*/ */
virtual void SetFactor(qreal factor); virtual void SetFactor(qreal factor);
protected: protected:

16
src/tools/drawTools/vtoolnormal.h
View File

@ -44,7 +44,7 @@ public:
* @param doc dom document container * @param doc dom document container
* @param data container with variables * @param data container with variables
* @param id object id in container * @param id object id in container
* @param typeLine * @param typeLine line type.
* @param formula * @param formula
* @param angle * @param angle
* @param firstPointId * @param firstPointId
@ -61,7 +61,7 @@ public:
*/ */
virtual void setDialog(); virtual void setDialog();
/** /**
* @brief Create * @brief Create help create tool
* @param dialog * @param dialog
* @param scene pointer to scene. * @param scene pointer to scene.
* @param doc dom document container * @param doc dom document container
@ -70,20 +70,20 @@ public:
static void Create(QSharedPointer<DialogNormal> &dialog, VMainGraphicsScene *scene, VDomDocument *doc, static void Create(QSharedPointer<DialogNormal> &dialog, VMainGraphicsScene *scene, VDomDocument *doc,
VContainer *data); VContainer *data);
/** /**
* @brief Create * @brief Create help create tool
* @param _id tool id, 0 if tool doesn't exist yet. * @param _id tool id, 0 if tool doesn't exist yet.
* @param formula * @param formula
* @param firstPointId * @param firstPointId
* @param secondPointId * @param secondPointId
* @param typeLine * @param typeLine line type.
* @param pointName * @param pointName
* @param angle * @param angle
* @param mx * @param mx label bias x axis.
* @param my * @param my label bias y axis.
* @param scene pointer to scene. * @param scene pointer to scene.
* @param doc dom document container * @param doc dom document container
* @param data container with variables * @param data container with variables
* @param parse * @param parse parser file mode.
* @param typeCreation way we create this tool. * @param typeCreation way we create this tool.
*/ */
static void Create(const qint64 _id, const QString &formula, const qint64 &firstPointId, static void Create(const qint64 _id, const QString &formula, const qint64 &firstPointId,
@ -117,7 +117,7 @@ public slots:
virtual void FullUpdateFromGui(int result); virtual void FullUpdateFromGui(int result);
/** /**
* @brief SetFactor set current scale factor of scene. * @brief SetFactor set current scale factor of scene.
* @param factor * @param factor scene scale factor.
*/ */
virtual void SetFactor(qreal factor); virtual void SetFactor(qreal factor);
virtual void ShowContextMenu(QGraphicsSceneContextMenuEvent *event); virtual void ShowContextMenu(QGraphicsSceneContextMenuEvent *event);

6
src/tools/drawTools/vtoolpoint.h
View File

@ -77,7 +77,7 @@ public slots:
virtual void ShowTool(qint64 id, Qt::GlobalColor color, bool enable); virtual void ShowTool(qint64 id, Qt::GlobalColor color, bool enable);
/** /**
* @brief SetFactor set current scale factor of scene. * @brief SetFactor set current scale factor of scene.
* @param factor * @param factor scene scale factor.
*/ */
virtual void SetFactor(qreal factor); virtual void SetFactor(qreal factor);
virtual void ShowContextMenu(QGraphicsSceneContextMenuEvent *event); virtual void ShowContextMenu(QGraphicsSceneContextMenuEvent *event);
@ -96,8 +96,8 @@ protected:
QGraphicsLineItem *lineName; QGraphicsLineItem *lineName;
/** /**
* @brief UpdateNamePosition * @brief UpdateNamePosition
* @param mx * @param mx label bias x axis.
* @param my * @param my label bias y axis.
*/ */
virtual void UpdateNamePosition(qreal mx, qreal my); virtual void UpdateNamePosition(qreal mx, qreal my);
/** /**

12
src/tools/drawTools/vtoolpointofcontact.h
View File

@ -69,7 +69,7 @@ public:
static QPointF FindPoint(const qreal &radius, const QPointF &center, const QPointF &firstPoint, static QPointF FindPoint(const qreal &radius, const QPointF &center, const QPointF &firstPoint,
const QPointF &secondPoint); const QPointF &secondPoint);
/** /**
* @brief Create * @brief Create help create tool
* @param dialog * @param dialog
* @param scene pointer to scene. * @param scene pointer to scene.
* @param doc dom document container * @param doc dom document container
@ -78,19 +78,19 @@ public:
static void Create(QSharedPointer<DialogPointOfContact> &dialog, VMainGraphicsScene *scene, static void Create(QSharedPointer<DialogPointOfContact> &dialog, VMainGraphicsScene *scene,
VDomDocument *doc, VContainer *data); VDomDocument *doc, VContainer *data);
/** /**
* @brief Create * @brief Create help create tool
* @param _id tool id, 0 if tool doesn't exist yet. * @param _id tool id, 0 if tool doesn't exist yet.
* @param radius * @param radius
* @param center * @param center
* @param firstPointId * @param firstPointId
* @param secondPointId * @param secondPointId
* @param pointName * @param pointName
* @param mx * @param mx label bias x axis.
* @param my * @param my label bias y axis.
* @param scene pointer to scene. * @param scene pointer to scene.
* @param doc dom document container * @param doc dom document container
* @param data container with variables * @param data container with variables
* @param parse * @param parse parser file mode.
* @param typeCreation way we create this tool. * @param typeCreation way we create this tool.
*/ */
static void Create(const qint64 _id, const QString &radius, const qint64 &center, static void Create(const qint64 _id, const QString &radius, const qint64 &center,
@ -113,7 +113,7 @@ public slots:
virtual void FullUpdateFromGui(int result); virtual void FullUpdateFromGui(int result);
/** /**
* @brief SetFactor set current scale factor of scene. * @brief SetFactor set current scale factor of scene.
* @param factor * @param factor scene scale factor.
*/ */
virtual void SetFactor(qreal factor); virtual void SetFactor(qreal factor);
virtual void ShowContextMenu(QGraphicsSceneContextMenuEvent *event); virtual void ShowContextMenu(QGraphicsSceneContextMenuEvent *event);

10
src/tools/drawTools/vtoolpointofintersection.h
View File

@ -57,7 +57,7 @@ public:
*/ */
virtual void setDialog(); virtual void setDialog();
/** /**
* @brief Create * @brief Create help create tool
* @param dialog * @param dialog
* @param scene pointer to scene. * @param scene pointer to scene.
* @param doc dom document container * @param doc dom document container
@ -66,17 +66,17 @@ public:
static void Create(QSharedPointer<DialogPointOfIntersection> &dialog, VMainGraphicsScene *scene, static void Create(QSharedPointer<DialogPointOfIntersection> &dialog, VMainGraphicsScene *scene,
VDomDocument *doc, VContainer *data); VDomDocument *doc, VContainer *data);
/** /**
* @brief Create * @brief Create help create tool
* @param _id tool id, 0 if tool doesn't exist yet. * @param _id tool id, 0 if tool doesn't exist yet.
* @param pointName * @param pointName
* @param firstPointId * @param firstPointId
* @param secondPointId * @param secondPointId
* @param mx * @param mx label bias x axis.
* @param my * @param my label bias y axis.
* @param scene pointer to scene. * @param scene pointer to scene.
* @param doc dom document container * @param doc dom document container
* @param data container with variables * @param data container with variables
* @param parse * @param parse parser file mode.
* @param typeCreation way we create this tool. * @param typeCreation way we create this tool.
*/ */
static void Create(const qint64 _id, const QString &pointName, const qint64 &firstPointId, static void Create(const qint64 _id, const QString &pointName, const qint64 &firstPointId,

16
src/tools/drawTools/vtoolshoulderpoint.h
View File

@ -43,7 +43,7 @@ public:
* @param doc dom document container * @param doc dom document container
* @param data container with variables * @param data container with variables
* @param id object id in container * @param id object id in container
* @param typeLine * @param typeLine line type.
* @param formula * @param formula
* @param p1Line * @param p1Line
* @param p2Line * @param p2Line
@ -70,7 +70,7 @@ public:
static QPointF FindPoint(const QPointF &p1Line, const QPointF &p2Line, const QPointF &pShoulder, static QPointF FindPoint(const QPointF &p1Line, const QPointF &p2Line, const QPointF &pShoulder,
const qreal &length); const qreal &length);
/** /**
* @brief Create * @brief Create help create tool
* @param dialog * @param dialog
* @param scene pointer to scene. * @param scene pointer to scene.
* @param doc dom document container * @param doc dom document container
@ -79,20 +79,20 @@ public:
static void Create(QSharedPointer<DialogShoulderPoint> &dialog, VMainGraphicsScene *scene, VDomDocument *doc, static void Create(QSharedPointer<DialogShoulderPoint> &dialog, VMainGraphicsScene *scene, VDomDocument *doc,
VContainer *data); VContainer *data);
/** /**
* @brief Create * @brief Create help create tool
* @param _id tool id, 0 if tool doesn't exist yet. * @param _id tool id, 0 if tool doesn't exist yet.
* @param formula * @param formula
* @param p1Line * @param p1Line
* @param p2Line * @param p2Line
* @param pShoulder * @param pShoulder
* @param typeLine * @param typeLine line type.
* @param pointName * @param pointName
* @param mx * @param mx label bias x axis.
* @param my * @param my label bias y axis.
* @param scene pointer to scene. * @param scene pointer to scene.
* @param doc dom document container * @param doc dom document container
* @param data container with variables * @param data container with variables
* @param parse * @param parse parser file mode.
* @param typeCreation way we create this tool. * @param typeCreation way we create this tool.
*/ */
static void Create(const qint64 _id, const QString &formula, const qint64 &p1Line, const qint64 &p2Line, static void Create(const qint64 _id, const QString &formula, const qint64 &p1Line, const qint64 &p2Line,
@ -115,7 +115,7 @@ public slots:
virtual void FullUpdateFromGui(int result); virtual void FullUpdateFromGui(int result);
/** /**
* @brief SetFactor set current scale factor of scene. * @brief SetFactor set current scale factor of scene.
* @param factor * @param factor scene scale factor.
*/ */
virtual void SetFactor(qreal factor); virtual void SetFactor(qreal factor);
virtual void ShowContextMenu(QGraphicsSceneContextMenuEvent *event); virtual void ShowContextMenu(QGraphicsSceneContextMenuEvent *event);

2
src/tools/drawTools/vtoolsinglepoint.h
View File

@ -74,7 +74,7 @@ public slots:
virtual void ChangedActivDraw(const QString &newName); virtual void ChangedActivDraw(const QString &newName);
/** /**
* @brief SetFactor set current scale factor of scene. * @brief SetFactor set current scale factor of scene.
* @param factor * @param factor scene scale factor.
*/ */
virtual void SetFactor(qreal factor); virtual void SetFactor(qreal factor);
virtual void ShowContextMenu(QGraphicsSceneContextMenuEvent *event); virtual void ShowContextMenu(QGraphicsSceneContextMenuEvent *event);

8
src/tools/drawTools/vtoolspline.h
View File

@ -57,7 +57,7 @@ public:
*/ */
virtual void setDialog(); virtual void setDialog();
/** /**
* @brief Create * @brief Create help create tool
* @param dialog * @param dialog
* @param scene pointer to scene. * @param scene pointer to scene.
* @param doc dom document container * @param doc dom document container
@ -66,7 +66,7 @@ public:
static void Create(QSharedPointer<DialogSpline> &dialog, VMainGraphicsScene *scene, VDomDocument *doc, static void Create(QSharedPointer<DialogSpline> &dialog, VMainGraphicsScene *scene, VDomDocument *doc,
VContainer *data); VContainer *data);
/** /**
* @brief Create * @brief Create help create tool
* @param _id tool id, 0 if tool doesn't exist yet. * @param _id tool id, 0 if tool doesn't exist yet.
* @param p1 * @param p1
* @param p4 * @param p4
@ -78,7 +78,7 @@ public:
* @param scene pointer to scene. * @param scene pointer to scene.
* @param doc dom document container * @param doc dom document container
* @param data container with variables * @param data container with variables
* @param parse * @param parse parser file mode.
* @param typeCreation way we create this tool. * @param typeCreation way we create this tool.
*/ */
static void Create(const qint64 _id, const qint64 &p1, const qint64 &p4, const qreal &kAsm1, static void Create(const qint64 _id, const qint64 &p1, const qint64 &p4, const qreal &kAsm1,
@ -140,7 +140,7 @@ public slots:
virtual void ShowTool(qint64 id, Qt::GlobalColor color, bool enable); virtual void ShowTool(qint64 id, Qt::GlobalColor color, bool enable);
/** /**
* @brief SetFactor set current scale factor of scene. * @brief SetFactor set current scale factor of scene.
* @param factor * @param factor scene scale factor.
*/ */
virtual void SetFactor(qreal factor); virtual void SetFactor(qreal factor);
protected: protected:

8
src/tools/drawTools/vtoolsplinepath.h
View File

@ -56,7 +56,7 @@ public:
*/ */
virtual void setDialog(); virtual void setDialog();
/** /**
* @brief Create * @brief Create help create tool
* @param dialog * @param dialog
* @param scene pointer to scene. * @param scene pointer to scene.
* @param doc dom document container * @param doc dom document container
@ -65,13 +65,13 @@ public:
static void Create(QSharedPointer<DialogSplinePath> &dialog, VMainGraphicsScene *scene, static void Create(QSharedPointer<DialogSplinePath> &dialog, VMainGraphicsScene *scene,
VDomDocument *doc, VContainer *data); VDomDocument *doc, VContainer *data);
/** /**
* @brief Create * @brief Create help create tool
* @param _id tool id, 0 if tool doesn't exist yet. * @param _id tool id, 0 if tool doesn't exist yet.
* @param path * @param path
* @param scene pointer to scene. * @param scene pointer to scene.
* @param doc dom document container * @param doc dom document container
* @param data container with variables * @param data container with variables
* @param parse * @param parse parser file mode.
* @param typeCreation way we create this tool. * @param typeCreation way we create this tool.
*/ */
static void Create(const qint64 _id, VSplinePath *path, VMainGraphicsScene *scene, static void Create(const qint64 _id, VSplinePath *path, VMainGraphicsScene *scene,
@ -132,7 +132,7 @@ public slots:
virtual void ShowTool(qint64 id, Qt::GlobalColor color, bool enable); virtual void ShowTool(qint64 id, Qt::GlobalColor color, bool enable);
/** /**
* @brief SetFactor set current scale factor of scene. * @brief SetFactor set current scale factor of scene.
* @param factor * @param factor scene scale factor.
*/ */
virtual void SetFactor(qreal factor); virtual void SetFactor(qreal factor);
protected: protected:

10
src/tools/drawTools/vtooltriangle.h
View File

@ -59,7 +59,7 @@ public:
*/ */
virtual void setDialog(); virtual void setDialog();
/** /**
* @brief Create * @brief Create help create tool
* @param dialog * @param dialog
* @param scene pointer to scene. * @param scene pointer to scene.
* @param doc dom document container * @param doc dom document container
@ -68,19 +68,19 @@ public:
static void Create(QSharedPointer<DialogTriangle> &dialog, VMainGraphicsScene *scene, VDomDocument *doc, static void Create(QSharedPointer<DialogTriangle> &dialog, VMainGraphicsScene *scene, VDomDocument *doc,
VContainer *data); VContainer *data);
/** /**
* @brief Create * @brief Create help create tool
* @param _id tool id, 0 if tool doesn't exist yet. * @param _id tool id, 0 if tool doesn't exist yet.
* @param pointName * @param pointName
* @param axisP1Id * @param axisP1Id
* @param axisP2Id * @param axisP2Id
* @param firstPointId * @param firstPointId
* @param secondPointId * @param secondPointId
* @param mx * @param mx label bias x axis.
* @param my * @param my label bias y axis.
* @param scene pointer to scene. * @param scene pointer to scene.
* @param doc dom document container * @param doc dom document container
* @param data container with variables * @param data container with variables
* @param parse * @param parse parser file mode.
* @param typeCreation way we create this tool. * @param typeCreation way we create this tool.
*/ */
static void Create(const qint64 _id, const QString &pointName, const qint64 &axisP1Id, const qint64 &axisP2Id, static void Create(const qint64 _id, const QString &pointName, const qint64 &axisP1Id, const qint64 &axisP2Id,

4
src/tools/nodeDetails/vnodearc.h
View File

@ -52,12 +52,12 @@ public:
const Tool::Sources &typeCreation, const qint64 &idTool = 0, QObject *qoParent = 0, const Tool::Sources &typeCreation, const qint64 &idTool = 0, QObject *qoParent = 0,
QGraphicsItem * parent = 0); QGraphicsItem * parent = 0);
/** /**
* @brief Create * @brief Create help create tool
* @param doc dom document container * @param doc dom document container
* @param data container with variables * @param data container with variables
* @param id object id in container * @param id object id in container
* @param id object id in containerArc * @param id object id in containerArc
* @param parse * @param parse parser file mode.
* @param typeCreation way we create this tool. * @param typeCreation way we create this tool.
*/ */
static void Create(VDomDocument *doc, VContainer *data, qint64 id, qint64 idArc, const Document::Documents &parse, static void Create(VDomDocument *doc, VContainer *data, qint64 id, qint64 idArc, const Document::Documents &parse,

8
src/tools/nodeDetails/vnodepoint.h
View File

@ -52,12 +52,12 @@ public:
const Tool::Sources &typeCreation, const qint64 &idTool = 0, QObject *qoParent = 0, const Tool::Sources &typeCreation, const qint64 &idTool = 0, QObject *qoParent = 0,
QGraphicsItem * parent = 0 ); QGraphicsItem * parent = 0 );
/** /**
* @brief Create * @brief Create help create tool
* @param doc dom document container * @param doc dom document container
* @param data container with variables * @param data container with variables
* @param id object id in container * @param id object id in container
* @param id object id in containerPoint * @param id object id in containerPoint
* @param parse * @param parse parser file mode.
* @param typeCreation way we create this tool. * @param typeCreation way we create this tool.
*/ */
static void Create(VDomDocument *doc, VContainer *data, qint64 id, qint64 idPoint, static void Create(VDomDocument *doc, VContainer *data, qint64 id, qint64 idPoint,
@ -120,8 +120,8 @@ protected:
virtual void hoverLeaveEvent ( QGraphicsSceneHoverEvent * event ); virtual void hoverLeaveEvent ( QGraphicsSceneHoverEvent * event );
/** /**
* @brief UpdateNamePosition * @brief UpdateNamePosition
* @param mx * @param mx label bias x axis.
* @param my * @param my label bias y axis.
*/ */
virtual void UpdateNamePosition(qreal mx, qreal my); virtual void UpdateNamePosition(qreal mx, qreal my);
/** /**

4
src/tools/nodeDetails/vnodespline.h
View File

@ -52,12 +52,12 @@ public:
const Tool::Sources &typeCreation, const qint64 &idTool = 0, QObject *qoParent = 0, const Tool::Sources &typeCreation, const qint64 &idTool = 0, QObject *qoParent = 0,
QGraphicsItem * parent = 0); QGraphicsItem * parent = 0);
/** /**
* @brief Create * @brief Create help create tool
* @param doc dom document container * @param doc dom document container
* @param data container with variables * @param data container with variables
* @param id object id in container * @param id object id in container
* @param id object id in containerSpline * @param id object id in containerSpline
* @param parse * @param parse parser file mode.
* @param typeCreation way we create this tool. * @param typeCreation way we create this tool.
* @return * @return
*/ */

4
src/tools/nodeDetails/vnodesplinepath.h
View File

@ -52,12 +52,12 @@ public:
const Tool::Sources &typeCreation, const qint64 &idTool = 0, QObject *qoParent = 0, const Tool::Sources &typeCreation, const qint64 &idTool = 0, QObject *qoParent = 0,
QGraphicsItem * parent = 0); QGraphicsItem * parent = 0);
/** /**
* @brief Create * @brief Create help create tool
* @param doc dom document container * @param doc dom document container
* @param data container with variables * @param data container with variables
* @param id object id in container * @param id object id in container
* @param id object id in containerSpline * @param id object id in containerSpline
* @param parse * @param parse parser file mode.
* @param typeCreation way we create this tool. * @param typeCreation way we create this tool.
*/ */
static void Create(VDomDocument *doc, VContainer *data, qint64 id, qint64 idSpline, static void Create(VDomDocument *doc, VContainer *data, qint64 id, qint64 idSpline,

10
src/tools/vtooluniondetails.h
View File

@ -66,16 +66,6 @@ public:
*/ */
static void Create(QSharedPointer<DialogUnionDetails> &dialog, VMainGraphicsScene *scene, VDomDocument *doc, static void Create(QSharedPointer<DialogUnionDetails> &dialog, VMainGraphicsScene *scene, VDomDocument *doc,
VContainer *data); VContainer *data);
/**
* @brief Create help create tool.
* @param _id tool id, 0 if tool doesn't exist yet.
* @param newDetail
* @param scene pointer to scene.
* @param doc dom document container
* @param data container with variables
* @param parse parser file mode.
* @param typeCreation way we create this tool.
*/
/** /**
* @brief Create help create tool. * @brief Create help create tool.
* @param _id tool id, 0 if tool doesn't exist yet. * @param _id tool id, 0 if tool doesn't exist yet.

4
src/widgets/vmaingraphicsscene.h
View File

@ -80,7 +80,7 @@ public slots:
void ChoosedItem(qint64 id, const Scene::Scenes &type); void ChoosedItem(qint64 id, const Scene::Scenes &type);
/** /**
* @brief SetFactor set current scale factor of scene. * @brief SetFactor set current scale factor of scene.
* @param factor scene scale factor. * @param factor scene scale factor. scene scale factor.
*/ */
void SetFactor(qreal factor); void SetFactor(qreal factor);
protected: protected:
@ -113,7 +113,7 @@ signals:
void ChoosedObject(qint64 id, Scene::Scenes type); void ChoosedObject(qint64 id, Scene::Scenes type);
/** /**
* @brief NewFactor * @brief NewFactor
* @param factor * @param factor scene scale factor.
*/ */
void NewFactor(qreal factor); void NewFactor(qreal factor);
private: private:

2
src/widgets/vmaingraphicsview.h
View File

@ -46,7 +46,7 @@ public:
signals: signals:
/** /**
* @brief NewFactor * @brief NewFactor
* @param factor * @param factor scene scale factor.
*/ */
void NewFactor(qreal factor); void NewFactor(qreal factor);
public slots: public slots:

2
src/widgets/vsimplespline.h
View File

@ -51,7 +51,7 @@ public:
/** /**
* @brief VSimpleSpline * @brief VSimpleSpline
* @param id * @param id
* @param factor * @param factor scene scale factor.
* @param currentColor * @param currentColor
* @param parent * @param parent
*/ */

20
src/xml/vdomdocument.h
View File

@ -100,7 +100,7 @@ public:
/** /**
* @brief ChangeActivDraw * @brief ChangeActivDraw
* @param name * @param name
* @param parse * @param parse parser file mode.
*/ */
void ChangeActivDraw(const QString& name, const Document::Documents &parse = Document::FullParse); void ChangeActivDraw(const QString& name, const Document::Documents &parse = Document::FullParse);
/** /**
@ -146,7 +146,7 @@ public:
bool SetNameDraw(const QString& name); bool SetNameDraw(const QString& name);
/** /**
* @brief Parse * @brief Parse
* @param parse * @param parse parser file mode.
* @param sceneDraw * @param sceneDraw
* @param sceneDetail * @param sceneDetail
*/ */
@ -338,7 +338,7 @@ private:
* @param sceneDraw * @param sceneDraw
* @param sceneDetail * @param sceneDetail
* @param node * @param node
* @param parse * @param parse parser file mode.
*/ */
void ParseDrawElement(VMainGraphicsScene *sceneDraw, VMainGraphicsScene *sceneDetail, void ParseDrawElement(VMainGraphicsScene *sceneDraw, VMainGraphicsScene *sceneDetail,
const QDomNode& node, const Document::Documents &parse); const QDomNode& node, const Document::Documents &parse);
@ -347,7 +347,7 @@ private:
* @param sceneDraw * @param sceneDraw
* @param sceneDetail * @param sceneDetail
* @param node * @param node
* @param parse * @param parse parser file mode.
* @param mode * @param mode
*/ */
void ParseDrawMode(VMainGraphicsScene *sceneDraw, VMainGraphicsScene *sceneDetail, void ParseDrawMode(VMainGraphicsScene *sceneDraw, VMainGraphicsScene *sceneDetail,
@ -356,7 +356,7 @@ private:
* @brief ParseDetailElement * @brief ParseDetailElement
* @param sceneDetail * @param sceneDetail
* @param domElement * @param domElement
* @param parse * @param parse parser file mode.
*/ */
void ParseDetailElement(VMainGraphicsScene *sceneDetail, const QDomElement &domElement, void ParseDetailElement(VMainGraphicsScene *sceneDetail, const QDomElement &domElement,
const Document::Documents &parse); const Document::Documents &parse);
@ -364,7 +364,7 @@ private:
* @brief ParseDetails * @brief ParseDetails
* @param sceneDetail * @param sceneDetail
* @param domElement * @param domElement
* @param parse * @param parse parser file mode.
*/ */
void ParseDetails(VMainGraphicsScene *sceneDetail, const QDomElement &domElement, void ParseDetails(VMainGraphicsScene *sceneDetail, const QDomElement &domElement,
const Document::Documents &parse); const Document::Documents &parse);
@ -372,7 +372,7 @@ private:
* @brief ParsePointElement * @brief ParsePointElement
* @param scene * @param scene
* @param domElement * @param domElement
* @param parse * @param parse parser file mode.
* @param type * @param type
* @param mode * @param mode
*/ */
@ -382,7 +382,7 @@ private:
* @brief ParseLineElement * @brief ParseLineElement
* @param scene * @param scene
* @param domElement * @param domElement
* @param parse * @param parse parser file mode.
* @param mode * @param mode
*/ */
void ParseLineElement(VMainGraphicsScene *scene, const QDomElement& domElement, void ParseLineElement(VMainGraphicsScene *scene, const QDomElement& domElement,
@ -391,7 +391,7 @@ private:
* @brief ParseSplineElement * @brief ParseSplineElement
* @param scene * @param scene
* @param domElement * @param domElement
* @param parse * @param parse parser file mode.
* @param type * @param type
* @param mode * @param mode
*/ */
@ -401,7 +401,7 @@ private:
* @brief ParseArcElement * @brief ParseArcElement
* @param scene * @param scene
* @param domElement * @param domElement
* @param parse * @param parse parser file mode.
* @param type * @param type
* @param mode * @param mode
*/ */