diff --git a/src/IntelliHelper/IntelliColorPicker.h b/src/IntelliHelper/IntelliColorPicker.h index 64f23e5..f84e54e 100644 --- a/src/IntelliHelper/IntelliColorPicker.h +++ b/src/IntelliHelper/IntelliColorPicker.h @@ -5,21 +5,59 @@ #include"QPoint" #include"QColorDialog" +/*! + * \brief The IntelliColorPicker manages the selected colors for one whole project. + */ class IntelliColorPicker{ public: + /*! + * \brief IntelliColorPicker construktor, setting 2 preset colors, be careful, theese color may change in production. + */ IntelliColorPicker(); + + /*! + * \brief IntelliColorPicker destructor clears up his used memory, if there is some. + */ virtual ~IntelliColorPicker(); + /*! + * \brief A function switching primary and secondary color. + */ void switchColors(); + /*! + * \brief A function to read the primary selected color. + * \return Returns the primary color. + */ QColor getFirstColor(); + + /*! + * \brief A function to read the secondary selected color. + * \return Returns the secondary color. + */ QColor getSecondColor(); + /*! + * \brief A function to set the primary color. + * \param Color - The color to be set as primary. + */ void setFirstColor(QColor Color); + + /*! + * \brief A function to set the secondary color. + * \param Color - The color to be set as secondary. + */ void setSecondColor(QColor Color); private: + /*! + * \brief The primary color. + */ QColor firstColor; + + /*! + * \brief The secondary color. + */ QColor secondColor; }; diff --git a/src/IntelliHelper/IntelliHelper.cpp b/src/IntelliHelper/IntelliHelper.cpp index 42b8aab..d814296 100644 --- a/src/IntelliHelper/IntelliHelper.cpp +++ b/src/IntelliHelper/IntelliHelper.cpp @@ -115,7 +115,7 @@ std::vector IntelliHelper::calculateTriangles(std::vector poly bool IntelliHelper::isInPolygon(std::vector &triangles, QPoint &point){ for(auto triangle : triangles){ - if(IntelliHelper::isInTriangle(triangle.A ,triangle.B, triangle.C, point)){ + if(IntelliHelper::isInTriangle(triangle, point)){ return true; } } diff --git a/src/IntelliHelper/IntelliHelper.h b/src/IntelliHelper/IntelliHelper.h index e01aff9..ca3ec77 100644 --- a/src/IntelliHelper/IntelliHelper.h +++ b/src/IntelliHelper/IntelliHelper.h @@ -4,24 +4,40 @@ #include #include +/*! + * \brief The Triangle struct holds the 3 vertices of a triangle. + */ struct Triangle{ QPoint A,B,C; }; + namespace IntelliHelper { - + /*! + * \brief A function to get the 2*area of a traingle, using its determinat. + * \param p1 - The Point to check its side. + * \param p2 - The first Point of the spanning Line + * \param p3 - The second Point of the spanning line. + * \return Returns the area of the traingle*2 + */ inline float sign(QPoint& p1, QPoint& p2, QPoint& p3){ return (p1.x()-p3.x())*(p2.y()-p3.y())-(p2.x()-p3.x())*(p1.y()-p3.y()); } - inline bool isInTriangle(QPoint& A, QPoint& B, QPoint& C, QPoint& P){ + /*! + * \brief A function to check if a given point is in a triangle. + * \param tri - The triangle to check, if it contains the point. + * \param P - The point to check if it is in the triangle. + * \return Returns true if the point is in the triangle, false otheriwse + */ + inline bool isInTriangle(Triangle& tri, QPoint& P){ float val1, val2, val3; bool neg, pos; - val1 = IntelliHelper::sign(P,A,B); - val2 = IntelliHelper::sign(P,B,C); - val3 = IntelliHelper::sign(P,C,A); + val1 = IntelliHelper::sign(P,tri.A,tri.B); + val2 = IntelliHelper::sign(P,tri.B,tri.C); + val3 = IntelliHelper::sign(P,tri.C,tri.A); neg = (val1<0.f) || (val2<0.f) || (val3<0.f); pos = (val1>0.f) || (val2>0.f) || (val3>0.f); @@ -29,8 +45,19 @@ namespace IntelliHelper { return !(neg && pos); } + /*! + * \brief A function to split a polygon in its spanning traingles by using Meisters Theorem of graph theory by clipping ears of a planar graph. + * \param polyPoints - The Vertices of the polygon. + * \return Returns a Container of disjoint Triangles, which desribe the polygon area. + */ std::vector calculateTriangles(std::vector polyPoints); + /*! + * \brief A function to check if a point lies in a polygon by checking its spanning triangles. + * \param triangles - The spanning triangles of the planar polygon. + * \param point - The point to checl, if it lies in the polygon. + * \return Returns true if the point lies in the üpolygon, otherwise false. + */ bool isInPolygon(std::vector &triangles, QPoint &point); } diff --git a/src/Tool/IntelliTool.h b/src/Tool/IntelliTool.h index 380a90b..5225a7a 100644 --- a/src/Tool/IntelliTool.h +++ b/src/Tool/IntelliTool.h @@ -37,21 +37,73 @@ protected: */ IntelliColorPicker* colorPicker; + /*! + * \brief A pointer to the underlying active Layer, do not work on this. This is used for data grabbing or previews. + */ LayerObject* Active; + + /*! + * \brief A pointer to the drawing canvas of the tool, work on this. + */ LayerObject* Canvas; + + /*! + * \brief A flag checking if the user is currently drawing or not. + */ bool drawing = false; public: + /*! + * \brief A constructor setting the general Painting Area and colorPicker. + * \param Area - The general PaintingArea used by the project. + * \param colorPicker - The general colorPicker used by the project + */ IntelliTool(PaintingArea* Area, IntelliColorPicker* colorPicker); + + /*! + * \brief An abstract Destructor. + */ virtual ~IntelliTool() = 0; + /*! + * \brief A function managing the right click Pressed of a Mouse. Constructing the Canvas to draw on. Call this in child classes! + * \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); + + /*! + * \brief A function managing the right click Released of a Mouse. Merging the Canvas to Active. Call this in child classes! + * \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); + + /*! + * \brief A function managing the left click Pressed of a Mouse. Resetting the current draw. Call this in child classes! + * \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); + + /*! + * \brief A function managing the left click Released of a Mouse. Call this in child classes! + * \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); + /*! + * \brief A function managing the scroll event. A Positive Value means scrolling outwards. Call this in child classes! + * \param value - The absolute the scroll has changed. + */ virtual void onWheelScrolled(int value); + /*! + * \brief A function managing the mouse moved event. Call this in child classes! + * \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);