removed unsecure wxTmpnam() function (patch by Francesco Montorsi)

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

diff --git a/include/wx/image.h b/include/wx/image.h
index a07b2d47d43a03c712db535ede6a75ec36eac88a..afcbaf95c2fd16492ff7b7554cf411ab50101ae6 100644 (file)
--- a/include/wx/image.h
+++ b/include/wx/image.h
@@ -1,5 +1,5 @@
 /////////////////////////////////////////////////////////////////////////////
 /////////////////////////////////////////////////////////////////////////////

-// Name:        image.h
+// Name:        wx/image.h

 // Purpose:     wxImage class
 // Author:      Robert Roebling
 // RCS-ID:      $Id$
 // Purpose:     wxImage class
 // Author:      Robert Roebling
 // RCS-ID:      $Id$


@@ -10,11 +10,10 @@
 #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/defs.h"
 #include "wx/defs.h"

+
+#if wxUSE_IMAGE
+

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


@@ -24,8 +23,6 @@
 #  include "wx/stream.h"
 #endif
 
 #  include "wx/stream.h"
 #endif
 

-#if wxUSE_IMAGE
-

 // on some systems (Unixware 7.x) index is defined as a macro in the headers
 // which breaks the compilation below
 #undef index
 // on some systems (Unixware 7.x) index is defined as a macro in the headers
 // which breaks the compilation below
 #undef index


@@ -40,12 +37,34 @@
 #define wxIMAGE_OPTION_RESOLUTIONUNIT        wxString(_T("ResolutionUnit"))
 
 // constants used with wxIMAGE_OPTION_RESOLUTIONUNIT
 #define wxIMAGE_OPTION_RESOLUTIONUNIT        wxString(_T("ResolutionUnit"))
 
 // constants used with wxIMAGE_OPTION_RESOLUTIONUNIT

-enum
+//
+// NB: don't change these values, they correspond to libjpeg constants
+enum wxImageResolution

 {
 {

+    // Resolution not specified
+    wxIMAGE_RESOLUTION_NONE = 0,
+
+    // Resolution specified in inches

     wxIMAGE_RESOLUTION_INCHES = 1,
     wxIMAGE_RESOLUTION_INCHES = 1,

+
+    // Resolution specified in centimeters

     wxIMAGE_RESOLUTION_CM = 2
 };
 
     wxIMAGE_RESOLUTION_CM = 2
 };
 

+// Constants for wxImage::Scale() for determining the level of quality
+enum
+{
+    wxIMAGE_QUALITY_NORMAL = 0,
+    wxIMAGE_QUALITY_HIGH = 1
+};
+
+// 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
 //-----------------------------------------------------------------------------


@@ -54,6 +73,15 @@ class WXDLLEXPORT wxImageHandler;
 class WXDLLEXPORT wxImage;
 class WXDLLEXPORT wxPalette;
 
 class WXDLLEXPORT wxImage;
 class WXDLLEXPORT wxPalette;
 

+//-----------------------------------------------------------------------------
+// wxVariant support
+//-----------------------------------------------------------------------------
+
+#if wxUSE_VARIANT
+#include "wx/variant.h"
+DECLARE_VARIANT_OBJECT_EXPORTED(wxImage,WXDLLEXPORT)
+#endif
+

 //-----------------------------------------------------------------------------
 // wxImageHandler
 //-----------------------------------------------------------------------------
 //-----------------------------------------------------------------------------
 // wxImageHandler
 //-----------------------------------------------------------------------------


@@ -79,10 +107,10 @@ public:
     void SetExtension(const wxString& ext) { m_extension = ext; }
     void SetType(long type) { m_type = type; }
     void SetMimeType(const wxString& type) { m_mime = type; }
     void SetExtension(const wxString& ext) { m_extension = ext; }
     void SetType(long type) { m_type = type; }
     void SetMimeType(const wxString& type) { m_mime = type; }

-    wxString GetName() const { return m_name; }
-    wxString GetExtension() const { return m_extension; }
+    const wxString& GetName() const { return m_name; }
+    const wxString& GetExtension() const { return m_extension; }

     long GetType() const { return m_type; }
     long GetType() const { return m_type; }

-    wxString GetMimeType() const { return m_mime; }
+    const wxString& GetMimeType() const { return m_mime; }

 
 protected:
 #if wxUSE_STREAMS
 
 protected:
 #if wxUSE_STREAMS


@@ -92,6 +120,13 @@ protected:
     bool CallDoCanRead(wxInputStream& stream);
 #endif // wxUSE_STREAMS
 
     bool CallDoCanRead(wxInputStream& stream);
 #endif // wxUSE_STREAMS
 

+    // helper for the derived classes SaveFile() implementations: returns the
+    // values of x- and y-resolution options specified as the image options if
+    // any
+    static wxImageResolution
+    GetResolutionFromOptions(const wxImage& image, int *x, int *y);
+
+

     wxString  m_name;
     wxString  m_extension;
     wxString  m_mime;
     wxString  m_name;
     wxString  m_extension;
     wxString  m_mime;


@@ -150,27 +185,51 @@ 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( int width, int height, unsigned char* data, unsigned char* alpha, bool static_data = false );
     wxImage( const wxString& name, long type = wxBITMAP_TYPE_ANY, int index = -1 );
     wxImage( const wxString& name, const wxString& mimetype, int index = -1 );
     wxImage(){}
     wxImage( int width, int height, bool clear = true );
     wxImage( int width, int height, unsigned char* data, bool static_data = false );
     wxImage( int width, int height, unsigned char* data, unsigned char* alpha, bool static_data = false );
     wxImage( const wxString& name, long type = wxBITMAP_TYPE_ANY, int index = -1 );
     wxImage( const wxString& name, const wxString& mimetype, int index = -1 );

-    wxImage( const char** xpmData );
-    wxImage( char** xpmData );
+    wxImage( const char* const* xpmData );

 
 #if wxUSE_STREAMS
     wxImage( wxInputStream& stream, long type = wxBITMAP_TYPE_ANY, int index = -1 );
     wxImage( wxInputStream& stream, const wxString& mimetype, int index = -1 );
 #endif // wxUSE_STREAMS
 
 
 #if wxUSE_STREAMS
     wxImage( wxInputStream& stream, long type = wxBITMAP_TYPE_ANY, int index = -1 );
     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 );

-    bool Create( const char** xpmData );
+    bool Create( const char* const* xpmData );
+#ifdef __BORLANDC__
+    // needed for Borland 5.5
+    wxImage( char** xpmData ) { Create(wx_const_cast(const char* const*, xpmData)); }
+    bool Create( char** xpmData ) { return Create(wx_const_cast(const char* const*, xpmData)); }
+#endif

     void Destroy();
 
     // creates an identical copy of the image (the = operator
     void Destroy();
 
     // creates an identical copy of the image (the = operator


@@ -192,12 +251,21 @@ public:
     void Paste( const wxImage &image, int x, int y );
 
     // return the new image with size width*height
     void Paste( const wxImage &image, int x, int y );
 
     // return the new image with size width*height

-    wxImage Scale( int width, int height ) const;
+    wxImage Scale( int width, int height, int quality = wxIMAGE_QUALITY_NORMAL ) const;
+
+    // box averager and bicubic filters for up/down sampling
+    wxImage ResampleBox(int width, int height) const;
+    wxImage ResampleBicubic(int width, int height) const;
+
+    // blur the image according to the specified pixel radius
+    wxImage Blur(int radius);
+    wxImage BlurHorizontal(int radius);
+    wxImage BlurVertical(int radius);

 
     wxImage ShrinkBy( int xFactor , int yFactor ) const ;
 
     // rescales the image in place
 
     wxImage ShrinkBy( int xFactor , int yFactor ) const ;
 
     // rescales the image in place

-    wxImage& Rescale( int width, int height ) { return *this = Scale(width, height); }
+    wxImage& Rescale( int width, int height, int quality = wxIMAGE_QUALITY_NORMAL ) { return *this = Scale(width, height, quality); }

 
     // resizes the image in place
     wxImage& Resize( const wxSize& size, const wxPoint& pos,
 
     // resizes the image in place
     wxImage& Resize( const wxSize& size, const wxPoint& pos,


@@ -215,6 +283,10 @@ 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;
     // 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;


@@ -240,7 +312,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


@@ -275,7 +347,8 @@ public:
     virtual bool SaveFile( wxOutputStream& stream, const wxString& mimetype ) const;
 #endif
 
     virtual bool SaveFile( wxOutputStream& stream, const wxString& mimetype ) const;
 #endif
 

-    bool Ok() const;
+    bool Ok() const { return IsOk(); }
+    bool IsOk() const;

     int GetWidth() const;
     int GetHeight() const;
 
     int GetWidth() const;
     int GetHeight() const;
 


@@ -290,6 +363,11 @@ public:
     void SetAlpha(unsigned char *alpha = NULL, bool static_data=false);
     void InitAlpha();
 
     void SetAlpha(unsigned char *alpha = NULL, bool static_data=false);
     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 );
     // Get the current mask colour or find a suitable colour
     // Mask functions
     void SetMaskColour( unsigned char r, unsigned char g, unsigned char b );
     // Get the current mask colour or find a suitable colour


@@ -325,17 +403,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;
-    }
-
-    bool operator == (const wxImage& image) const
-        { return m_refData == image.m_refData; }
-    bool operator != (const wxImage& image) const
-        { return m_refData != image.m_refData; }
+    // 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);

 
     static wxList& GetHandlers() { return sm_handlers; }
     static void AddHandler( wxImageHandler *handler );
 
     static wxList& GetHandlers() { return sm_handlers; }
     static void AddHandler( wxImageHandler *handler );


@@ -351,9 +421,22 @@ 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;
+
+    virtual wxObjectRefData* CreateRefData() const;
+    virtual wxObjectRefData* CloneRefData(const wxObjectRefData* data) const;
+

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


@@ -374,6 +457,7 @@ extern WXDLLEXPORT_DATA(wxImage)    wxNullImage;
 #include "wx/imaggif.h"
 #include "wx/imagpcx.h"
 #include "wx/imagjpeg.h"
 #include "wx/imaggif.h"
 #include "wx/imagpcx.h"
 #include "wx/imagjpeg.h"

+#include "wx/imagtga.h"

 #include "wx/imagtiff.h"
 #include "wx/imagpnm.h"
 #include "wx/imagxpm.h"
 #include "wx/imagtiff.h"
 #include "wx/imagpnm.h"
 #include "wx/imagxpm.h"


@@ -383,4 +467,3 @@ extern WXDLLEXPORT_DATA(wxImage)    wxNullImage;
 
 #endif
   // _WX_IMAGE_H_
 
 #endif
   // _WX_IMAGE_H_

-