mirror of
https://github.com/creyD/intelliphoto.git
synced 2026-04-14 12:20:32 +02:00
Documentation of image
This commit is contained in:
@@ -4,24 +4,53 @@
|
||||
#include"Image/IntelliImage.h"
|
||||
|
||||
/*!
|
||||
* \brief The IntelliRasterImage manages a simple Rasterimage
|
||||
* \brief The IntelliRasterImage manages a Rasterimage.
|
||||
*/
|
||||
class IntelliRasterImage : public IntelliImage{
|
||||
friend IntelliTool;
|
||||
protected:
|
||||
/*!
|
||||
* \brief A function that calculates the visibility of the image if a polygon is given. [does nothing in Rasterimage]
|
||||
*/
|
||||
virtual void calculateVisiblity() override;
|
||||
public:
|
||||
/*!
|
||||
* \brief The Construcor of the IntelliRasterImage. Given the Image dimensions.
|
||||
* \param weight - The weight of the Image.
|
||||
* \param height - The height of the Image.
|
||||
*/
|
||||
IntelliRasterImage(int weight, int height);
|
||||
|
||||
/*!
|
||||
* \brief An Destructor.
|
||||
*/
|
||||
virtual ~IntelliRasterImage() override;
|
||||
|
||||
//returns the filtered output
|
||||
/*!
|
||||
* \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.
|
||||
* \return A QImage which is ready to be displayed.
|
||||
*/
|
||||
virtual QImage getDisplayable(const QSize& displaySize,int alpha) override;
|
||||
|
||||
/**
|
||||
* @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.
|
||||
* @return A QImage which is ready to be displayed.
|
||||
*/
|
||||
virtual QImage getDisplayable(int alpha=255) override;
|
||||
|
||||
//gets a copy of the image !allocated
|
||||
/*!
|
||||
* \brief A function that copys all that returns a [allocated] Image
|
||||
* \return A [allocated] Image with all the properties of the instance.
|
||||
*/
|
||||
virtual IntelliImage* getDeepCopy() override;
|
||||
|
||||
//sets the data for the visible image
|
||||
/*!
|
||||
* \brief An abstract function that sets the data of the visible Polygon, if needed.
|
||||
* \param polygonData - The Vertices of the Polygon. Nothing happens.
|
||||
*/
|
||||
virtual void setPolygon(const std::vector<QPoint>& polygonData) override;
|
||||
};
|
||||
|
||||
|
||||
Reference in New Issue
Block a user