This commit is contained in:
Sonaion
2019-12-18 17:49:09 +01:00
parent 1d65078df0
commit 30c6d0badd
2 changed files with 17 additions and 14 deletions

View File

@@ -33,8 +33,8 @@ protected:
public:
/*!
* \brief The Construcor of the Shaped Image. Given the Image dimensions.
* \param weight The weight of the Image.
* \param height The height of the Image.
* \param weight - The weight of the Image.
* \param height - The height of the Image.
*/
IntelliImage(int weight, int height);
@@ -46,37 +46,37 @@ public:
/*!
* \brief A funtcion used to draw a pixel on the Image with the given Color.
* \param p1 The coordinates of the pixel, which should be drawn. [Top-Left-System]
* \param color The color of the pixel.
* \param p1 - The coordinates of the pixel, which should be drawn. [Top-Left-System]
* \param color - The color of the pixel.
*/
virtual void drawPixel(const QPoint &p1, const QColor& color);
/*!
* \brief A function that draws A Line between two given Points in a given color.
* \param p1 The coordinates of the first Point.
* \param p2 The coordinates of the second Point.
* \param color The color of the line.
* \param penWidth The width of the line.
* \param p1 - The coordinates of the first Point.
* \param p2 - The coordinates of the second Point.
* \param color - The color of the line.
* \param penWidth - The width of the line.
*/
virtual void drawLine(const QPoint &p1, const QPoint& p2, const QColor& color, const int& penWidth);
/*!
* \brief A function that clears the whole image in a given Color.
* \param color The color, in which the image will be filled.
* \param color - The color, in which the image will be filled.
*/
virtual void drawPlain(const QColor& color);
/*!
* \brief A function returning the displayable ImageData in a requested transparence and size.
* \param displaySize The size, in whcih the Image should be displayed.
* \param alpha The maximum alpha value, a pixel can have.
* \param displaySize - The size, in whcih the Image should be displayed.
* \param alpha - The maximum alpha value, a pixel can have.
* \return A QImage which is ready to be displayed.
*/
virtual QImage getDisplayable(const QSize& displaySize, int alpha)=0;
/**
* @brief A function returning the displayable ImageData in a requested transparence and it's standart size.
* @param alpha The maximum alpha value, a pixel can have.
* @param alpha - The maximum alpha value, a pixel can have.
* @return A QImage which is ready to be displayed.
*/
virtual QImage getDisplayable(int alpha=255)=0;
@@ -94,7 +94,7 @@ public:
/*!
* \brief An abstract function that sets the data of the visible Polygon, if needed.
* \param polygonData The Vertices of the Polygon. Just Planar Polygons are allowed.
* \param polygonData - The Vertices of the Polygon. Just Planar Polygons are allowed.
*/
virtual void setPolygon(const std::vector<QPoint>& polygonData)=0;
@@ -106,7 +106,7 @@ public:
/*!
* \brief Loads and Sclaes an Image to the fitting dimensions.
* \param fileName The path+name of the image which to loaded.
* \param fileName - The path+name of the image which to loaded.
* \return True if the image could be loaded, false otherwise.
*/
virtual bool loadImage(const QString &fileName);

View File

@@ -3,6 +3,9 @@
#include"Image/IntelliImage.h"
/*!
* \brief The IntelliRasterImage manages a simple Rasterimage
*/
class IntelliRasterImage : public IntelliImage{
friend IntelliTool;
protected: