fix bug in Eof() which returned true even if we were only on the last line, not beyond it

[wxWidgets.git] / include / wx / image.h

diff --git a/include/wx/image.h b/include/wx/image.h
index 77a6cb84f36f47647197132c107cd4bbcdd9f7ef..aa801035f6242be29b1565adafaff09ea3230e18 100644 (file)
--- a/include/wx/image.h
+++ b/include/wx/image.h
@@ -10,11 +10,7 @@
 #ifndef _WX_IMAGE_H_
 #define _WX_IMAGE_H_
 
 #ifndef _WX_IMAGE_H_
 #define _WX_IMAGE_H_
 

-#if defined(__GNUG__) && !defined(NO_GCC_PRAGMA)
-#pragma interface "image.h"
-#endif
-
-#include "wx/setup.h"
+#include "wx/defs.h"

 #include "wx/object.h"
 #include "wx/string.h"
 #include "wx/gdicmn.h"
 #include "wx/object.h"
 #include "wx/string.h"
 #include "wx/gdicmn.h"


@@ -46,6 +42,13 @@ enum
     wxIMAGE_RESOLUTION_CM = 2
 };
 
     wxIMAGE_RESOLUTION_CM = 2
 };
 

+// alpha channel values: fully transparent, default threshold separating
+// transparent pixels from opaque for a few functions dealing with alpha and
+// fully opaque
+const unsigned char wxIMAGE_ALPHA_TRANSPARENT = 0;
+const unsigned char wxIMAGE_ALPHA_THRESHOLD = 0x80;
+const unsigned char wxIMAGE_ALPHA_OPAQUE = 0xff;
+

 //-----------------------------------------------------------------------------
 // classes
 //-----------------------------------------------------------------------------
 //-----------------------------------------------------------------------------
 // classes
 //-----------------------------------------------------------------------------


@@ -150,6 +153,29 @@ public:
 class WXDLLEXPORT wxImage: public wxObject
 {
 public:
 class WXDLLEXPORT wxImage: public wxObject
 {
 public:

+    // red, green and blue are 8 bit unsigned integers in the range of 0..255
+    // We use the identifier RGBValue instead of RGB, since RGB is #defined
+    class RGBValue
+    {
+    public:
+      RGBValue(unsigned char r=0, unsigned char g=0, unsigned char b=0)
+        : red(r), green(g), blue(b) {}
+        unsigned char red;
+        unsigned char green;
+        unsigned char blue;
+    };
+
+    // hue, saturation and value are doubles in the range 0.0..1.0
+    class HSVValue
+    {
+    public:
+        HSVValue(double h=0.0, double s=0.0, double v=0.0)
+            : hue(h), saturation(s), value(v) {}
+        double hue;
+        double saturation;
+        double value;
+    };
+

     wxImage(){}
     wxImage( int width, int height, bool clear = true );
     wxImage( int width, int height, unsigned char* data, bool static_data = false );
     wxImage(){}
     wxImage( int width, int height, bool clear = true );
     wxImage( int width, int height, unsigned char* data, bool static_data = false );


@@ -164,9 +190,6 @@ public:
     wxImage( wxInputStream& stream, const wxString& mimetype, int index = -1 );
 #endif // wxUSE_STREAMS
 
     wxImage( wxInputStream& stream, const wxString& mimetype, int index = -1 );
 #endif // wxUSE_STREAMS
 

-    wxImage( const wxImage& image );
-    wxImage( const wxImage* image );
-

     bool Create( int width, int height, bool clear = true );
     bool Create( int width, int height, unsigned char* data, bool static_data = false );
     bool Create( int width, int height, unsigned char* data, unsigned char* alpha, bool static_data = false );
     bool Create( int width, int height, bool clear = true );
     bool Create( int width, int height, unsigned char* data, bool static_data = false );
     bool Create( int width, int height, unsigned char* data, unsigned char* alpha, bool static_data = false );


@@ -178,7 +201,14 @@ public:
     wxImage Copy() const;
 
     // return the new image with size width*height
     wxImage Copy() const;
 
     // return the new image with size width*height

-    wxImage GetSubImage( const wxRect& ) const;
+    wxImage GetSubImage( const wxRect& rect) const;
+
+    // Paste the image or part of this image into an image of the given size at the pos
+    //  any newly exposed areas will be filled with the rgb colour
+    //  by default if r = g = b = -1 then fill with this image's mask colour or find and
+    //  set a suitable mask colour
+    wxImage Size( const wxSize& size, const wxPoint& pos,
+                  int r = -1, int g = -1, int b = -1 ) const;

 
     // pastes image into this instance and takes care of
     // the mask colour and out of bounds problems
 
     // pastes image into this instance and takes care of
     // the mask colour and out of bounds problems


@@ -192,6 +222,10 @@ public:
     // rescales the image in place
     wxImage& Rescale( int width, int height ) { return *this = Scale(width, height); }
 
     // rescales the image in place
     wxImage& Rescale( int width, int height ) { return *this = Scale(width, height); }
 

+    // resizes the image in place
+    wxImage& Resize( const wxSize& size, const wxPoint& pos,
+                     int r = -1, int g = -1, int b = -1 ) { return *this = Size(size, pos, r, g, b); }
+

     // Rotates the image about the given point, 'angle' radians.
     // Returns the rotated image, leaving this image intact.
     wxImage Rotate(double angle, const wxPoint & centre_of_rotation,
     // Rotates the image about the given point, 'angle' radians.
     // Returns the rotated image, leaving this image intact.
     wxImage Rotate(double angle, const wxPoint & centre_of_rotation,


@@ -204,12 +238,17 @@ public:
     void Replace( unsigned char r1, unsigned char g1, unsigned char b1,
                   unsigned char r2, unsigned char g2, unsigned char b2 );
 
     void Replace( unsigned char r1, unsigned char g1, unsigned char b1,
                   unsigned char r2, unsigned char g2, unsigned char b2 );
 

+    // Convert to greyscale image. Uses the luminance component (Y) of the image.
+    // The luma value (YUV) is calculated using (R * lr) + (G * lg) + (B * lb), defaults to ITU-T BT.601
+    wxImage ConvertToGreyscale( double lr = 0.299, double lg = 0.587, double lb = 0.114 ) const;
+

     // convert to monochrome image (<r,g,b> will be replaced by white,
     // everything else by black)
     wxImage ConvertToMono( unsigned char r, unsigned char g, unsigned char b ) const;
 
     // these routines are slow but safe
     void SetRGB( int x, int y, unsigned char r, unsigned char g, unsigned char b );
     // convert to monochrome image (<r,g,b> will be replaced by white,
     // everything else by black)
     wxImage ConvertToMono( unsigned char r, unsigned char g, unsigned char b ) const;
 
     // these routines are slow but safe
     void SetRGB( int x, int y, unsigned char r, unsigned char g, unsigned char b );

+    void SetRGB( const wxRect& rect, unsigned char r, unsigned char g, unsigned char b );

     unsigned char GetRed( int x, int y ) const;
     unsigned char GetGreen( int x, int y ) const;
     unsigned char GetBlue( int x, int y ) const;
     unsigned char GetRed( int x, int y ) const;
     unsigned char GetGreen( int x, int y ) const;
     unsigned char GetBlue( int x, int y ) const;


@@ -228,7 +267,7 @@ public:
 
     // converts image's alpha channel to mask, if it has any, does nothing
     // otherwise:
 
     // converts image's alpha channel to mask, if it has any, does nothing
     // otherwise:

-    bool ConvertAlphaToMask(unsigned char threshold = 128);
+    bool ConvertAlphaToMask(unsigned char threshold = wxIMAGE_ALPHA_THRESHOLD);

 
     // This method converts an image where the original alpha
     // information is only available as a shades of a colour
 
     // This method converts an image where the original alpha
     // information is only available as a shades of a colour


@@ -270,16 +309,24 @@ public:
     // these functions provide fastest access to wxImage data but should be
     // used carefully as no checks are done
     unsigned char *GetData() const;
     // these functions provide fastest access to wxImage data but should be
     // used carefully as no checks are done
     unsigned char *GetData() const;

-    void SetData( unsigned char *data );
-    void SetData( unsigned char *data, int new_width, int new_height );
+    void SetData( unsigned char *data, bool static_data=false );
+    void SetData( unsigned char *data, int new_width, int new_height, bool static_data=false );

 
     unsigned char *GetAlpha() const;    // may return NULL!
     bool HasAlpha() const { return GetAlpha() != NULL; }
 
     unsigned char *GetAlpha() const;    // may return NULL!
     bool HasAlpha() const { return GetAlpha() != NULL; }

-    void SetAlpha(unsigned char *alpha = NULL);
+    void SetAlpha(unsigned char *alpha = NULL, bool static_data=false);

     void InitAlpha();
 
     void InitAlpha();
 

+    // return true if this pixel is masked or has alpha less than specified
+    // threshold
+    bool IsTransparent(int x, int y,
+                       unsigned char threshold = wxIMAGE_ALPHA_THRESHOLD) const;
+

     // Mask functions
     void SetMaskColour( unsigned char r, unsigned char g, unsigned char b );
     // Mask functions
     void SetMaskColour( unsigned char r, unsigned char g, unsigned char b );

+    // Get the current mask colour or find a suitable colour
+    // returns true if using current mask colour
+    bool GetOrFindMaskColour( unsigned char *r, unsigned char *g, unsigned char *b ) const;

     unsigned char GetMaskRed() const;
     unsigned char GetMaskGreen() const;
     unsigned char GetMaskBlue() const;
     unsigned char GetMaskRed() const;
     unsigned char GetMaskGreen() const;
     unsigned char GetMaskBlue() const;


@@ -310,12 +357,9 @@ public:
     // Returned value: # of entries in the histogram
     unsigned long ComputeHistogram( wxImageHistogram &h ) const;
 
     // Returned value: # of entries in the histogram
     unsigned long ComputeHistogram( wxImageHistogram &h ) const;
 

-    wxImage& operator = (const wxImage& image)
-    {
-        if ( (*this) != image )
-            Ref(image);
-        return *this;
-    }
+    // Rotates the hue of each pixel of the image. angle is a double in the range
+    // -1.0..1.0 where -1.0 is -360 degrees and 1.0 is 360 degrees
+    void RotateHue(double angle);

 
     bool operator == (const wxImage& image) const
         { return m_refData == image.m_refData; }
 
     bool operator == (const wxImage& image) const
         { return m_refData == image.m_refData; }


@@ -336,9 +380,19 @@ public:
     static void CleanUpHandlers();
     static void InitStandardHandlers();
 
     static void CleanUpHandlers();
     static void InitStandardHandlers();
 

+    static HSVValue RGBtoHSV(const RGBValue& rgb);
+    static RGBValue HSVtoRGB(const HSVValue& hsv);
+
+

 protected:
     static wxList   sm_handlers;
 
 protected:
     static wxList   sm_handlers;
 

+    // return the index of the point with the given coordinates or -1 if the
+    // image is invalid of the coordinates are out of range
+    //
+    // note that index must be multiplied by 3 when using it with RGB array
+    long XYToIndex(int x, int y) const;
+

 private:
     friend class WXDLLEXPORT wxImageHandler;
 
 private:
     friend class WXDLLEXPORT wxImageHandler;