Tool COmments update

This commit is contained in:
Sonaion
2019-12-19 12:29:58 +01:00
parent f24dfe5d33
commit e965162379
5 changed files with 273 additions and 18 deletions

View File

@@ -5,7 +5,7 @@
#include "QColor"
#include "QPoint"
/*!
* \brief The IntelliToolCircle class representing a tool to draw a circle.
* \brief The IntelliToolCircle class represents a tool to draw a circle.
*/
class IntelliToolCircle : public IntelliTool{
/*!
@@ -30,8 +30,8 @@ class IntelliToolCircle : public IntelliTool{
int edgeWidth;
public:
/*!
* \brief A constructor setting the general Painting Area and colorPicker. And reading in the The inner alpha and edgeWIdth.
* \param Area - The general PaintingArea used by the project.
* \brief A constructor setting the general paintingArea and colorPicker. And reading in the inner alpha and edgeWidth.
* \param Area - The general paintingArea used by the project.
* \param colorPicker - The general colorPicker used by the project.
*/
IntelliToolCircle(PaintingArea* Area, IntelliColorPicker* colorPicker);
@@ -42,30 +42,30 @@ public:
virtual ~IntelliToolCircle() override;
/*!
* \brief A function managing the right click Pressed of a Mouse. Sets the middle point of the cricle.
* \param x - The x coordinate relative to the Active/Canvas Layer.
* \param y - The y coordinate relative to the Active/Canvas Layer.
* \brief A function managing the right click pressed of a mouse. Clearing the canvas layer.
* \param x - The x coordinate relative to the active/canvas layer.
* \param y - The y coordinate relative to the active/canvas layer.
*/
virtual void onMouseRightPressed(int x, int y) override;
/*!
* \brief A function managing the right click Released of a Mouse.
* \param x - The x coordinate relative to the Active/Canvas Layer.
* \param y - The y coordinate relative to the Active/Canvas Layer.
* \brief A function managing the right click released of a mouse.
* \param x - The x coordinate relative to the active/canvas layer.
* \param y - The y coordinate relative to the active/canvas layer.
*/
virtual void onMouseRightReleased(int x, int y) override;
/*!
* \brief A function managing the left click Pressed of a Mouse. Clearing the canvas layer.
* \param x - The x coordinate relative to the Active/Canvas Layer.
* \param y - The y coordinate relative to the Active/Canvas Layer.
* \brief A function managing the left click pressed of a mouse. Sets the middle point of the cricle.
* \param x - The x coordinate relative to the active/canvas layer.
* \param y - The y coordinate relative to the active/canvas layer.
*/
virtual void onMouseLeftPressed(int x, int y) override;
/*!
* \brief A function managing the left click Released of a Mouse.
* \param x - The x coordinate relative to the Active/Canvas Layer.
* \param y - The y coordinate relative to the Active/Canvas Layer.
* \brief A function managing the left click released of a mouse.
* \param x - The x coordinate relative to the active/canvas layer.
* \param y - The y coordinate relative to the active/canvas layer.
*/
virtual void onMouseLeftReleased(int x, int y) override;
@@ -77,8 +77,8 @@ public:
/*!
* \brief A function managing the mouse moved event. Draws a circle with radius of eulerian norm of mouse position and the middle point.
* \param x - The x coordinate of the new Mouse Position.
* \param y - The y coordinate of the new Mouse Position.
* \param x - The x coordinate of the new mouse position.
* \param y - The y coordinate of the new mouse position.
*/
virtual void onMouseMoved(int x, int y) override;
};