Documentation for VToolLineIntersect class.

--HG--
branch : develop
This commit is contained in:
dismine 2014-01-25 15:41:03 +02:00
parent 04799d8976
commit 517735a5a6

View File

@ -33,23 +33,23 @@
#include "../../dialogs/dialoglineintersect.h" #include "../../dialogs/dialoglineintersect.h"
/** /**
* @brief The VToolLineIntersect class * @brief The VToolLineIntersect class help find point intersection lines.
*/ */
class VToolLineIntersect:public VToolPoint class VToolLineIntersect:public VToolPoint
{ {
Q_OBJECT Q_OBJECT
public: public:
/** /**
* @brief VToolLineIntersect * @brief VToolLineIntersect constructor.
* @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 p1Line1 * @param p1Line1 id first point first line.
* @param p2Line1 * @param p2Line1 id second point first line.
* @param p1Line2 * @param p1Line2 id first point second line.
* @param p2Line2 * @param p2Line2 id second point second line.
* @param typeCreation way we create this tool. * @param typeCreation way we create this tool.
* @param parent parent object * @param parent parent object.
*/ */
VToolLineIntersect(VDomDocument *doc, VContainer *data, const qint64 &id, const qint64 &p1Line1, VToolLineIntersect(VDomDocument *doc, VContainer *data, const qint64 &id, const qint64 &p1Line1,
const qint64 &p2Line1, const qint64 &p1Line2, const qint64 &p2Line2, const qint64 &p2Line1, const qint64 &p1Line2, const qint64 &p2Line2,
@ -59,27 +59,27 @@ public:
*/ */
virtual void setDialog(); virtual void setDialog();
/** /**
* @brief Create help create tool * @brief Create help create tool from GUI.
* @param dialog * @param dialog dialog.
* @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<DialogLineIntersect> &dialog, VMainGraphicsScene *scene, VDomDocument *doc, static void Create(QSharedPointer<DialogLineIntersect> &dialog, VMainGraphicsScene *scene, VDomDocument *doc,
VContainer *data); VContainer *data);
/** /**
* @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.
* @param p1Line1Id * @param p1Line1Id id first point first line.
* @param p2Line1Id * @param p2Line1Id id second point first line.
* @param p1Line2Id * @param p1Line2Id id first point second line.
* @param p2Line2Id * @param p2Line2Id id second point second line.
* @param pointName point name. * @param pointName point name.
* @param mx label bias x axis. * @param mx label bias x axis.
* @param my label bias y axis. * @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 parser file mode. * @param parse parser file mode.
* @param typeCreation way we create this tool. * @param typeCreation way we create this tool.
*/ */
@ -87,9 +87,6 @@ public:
const qint64 &p2Line2Id, const QString &pointName, const qreal &mx, const qreal &my, const qint64 &p2Line2Id, const QString &pointName, 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,7 +95,7 @@ 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);
/** /**
@ -106,11 +103,15 @@ public slots:
* @param factor scene scale factor. * @param factor scene scale factor.
*/ */
virtual void SetFactor(qreal factor); virtual void SetFactor(qreal factor);
/**
* @brief ShowContextMenu show context menu.
* @param event context menu event.
*/
virtual void ShowContextMenu(QGraphicsSceneContextMenuEvent *event); virtual void ShowContextMenu(QGraphicsSceneContextMenuEvent *event);
protected: protected:
/** /**
* @brief contextMenuEvent handle context menu events. * @brief contextMenuEvent handle context menu events.
* @param event * @param event context menu event.
*/ */
virtual void contextMenuEvent ( QGraphicsSceneContextMenuEvent * event ); virtual void contextMenuEvent ( QGraphicsSceneContextMenuEvent * event );
/** /**
@ -127,23 +128,23 @@ protected:
virtual void RemoveReferens(); virtual void RemoveReferens();
private: private:
/** /**
* @brief p1Line1 * @brief p1Line1 id first point first line.
*/ */
qint64 p1Line1; qint64 p1Line1;
/** /**
* @brief p2Line1 * @brief p2Line1 id second point first line.
*/ */
qint64 p2Line1; qint64 p2Line1;
/** /**
* @brief p1Line2 * @brief p1Line2 id first point second line.
*/ */
qint64 p1Line2; qint64 p1Line2;
/** /**
* @brief p2Line2 * @brief p2Line2 id second point second line.
*/ */
qint64 p2Line2; qint64 p2Line2;
/** /**
* @brief dialogLineIntersect * @brief dialogLineIntersect dialog.
*/ */
QSharedPointer<DialogLineIntersect> dialogLineIntersect; QSharedPointer<DialogLineIntersect> dialogLineIntersect;
}; };