another GradientFillLinear fix

[wxWidgets.git] / src / generic / animateg.cpp

diff --git a/src/generic/animateg.cpp b/src/generic/animateg.cpp
index 4a0ac66c9a7206f7adbe2092afe458a89ded83c0..c7e55f4f92e862dbd0d582e85f10f229dcf6fca7 100644 (file)
--- a/src/generic/animateg.cpp
+++ b/src/generic/animateg.cpp
@@ -15,28 +15,28 @@
   #pragma hdrstop
 #endif  //__BORLANDC__
 
   #pragma hdrstop
 #endif  //__BORLANDC__
 

+#if wxUSE_ANIMATIONCTRL && (!defined(__WXGTK20__) || defined(__WXUNIVERSAL__))

 
 

-#if wxUSE_ANIMATIONCTRL
+#include "wx/animate.h"
+
+#ifndef WX_PRECOMP
+    #include "wx/log.h"
+    #include "wx/image.h"
+    #include "wx/dcmemory.h"
+    #include "wx/dcclient.h"
+    #include "wx/module.h"
+#endif

 
 

-#include "wx/log.h"

 #include "wx/wfstream.h"
 #include "wx/wfstream.h"

-#include "wx/image.h"

 #include "wx/gifdecod.h"
 #include "wx/anidecod.h"
 #include "wx/gifdecod.h"
 #include "wx/anidecod.h"

-#include "wx/dcmemory.h"
-#include "wx/dc.h"
-#include "wx/dcclient.h"
-#include "wx/animate.h"
-#include "wx/animdecod.h"

 
 

-
-#include <wx/listimpl.cpp>
-WX_DEFINE_LIST(wxAnimationDecoderList);
+#include "wx/listimpl.cpp"
+WX_DEFINE_LIST(wxAnimationDecoderList)

 
 wxAnimationDecoderList wxAnimation::sm_handlers;
 
 
 
 wxAnimationDecoderList wxAnimation::sm_handlers;
 
 

-

 // ----------------------------------------------------------------------------
 // wxAnimation
 // ----------------------------------------------------------------------------
 // ----------------------------------------------------------------------------
 // wxAnimation
 // ----------------------------------------------------------------------------


@@ -82,6 +82,13 @@ wxPoint wxAnimation::GetFramePosition(size_t frame) const
     return M_ANIMDATA->GetFramePosition(frame);
 }
 
     return M_ANIMDATA->GetFramePosition(frame);
 }
 

+wxSize wxAnimation::GetFrameSize(size_t frame) const
+{
+    wxCHECK_MSG( IsOk(), wxDefaultSize, wxT("invalid animation") );
+
+    return M_ANIMDATA->GetFrameSize(frame);
+}
+

 wxAnimationDisposal wxAnimation::GetDisposalMethod(size_t frame) const
 {
     wxCHECK_MSG( IsOk(), wxANIM_UNSPECIFIED, wxT("invalid animation") );
 wxAnimationDisposal wxAnimation::GetDisposalMethod(size_t frame) const
 {
     wxCHECK_MSG( IsOk(), wxANIM_UNSPECIFIED, wxT("invalid animation") );


@@ -89,6 +96,13 @@ wxAnimationDisposal wxAnimation::GetDisposalMethod(size_t frame) const
     return M_ANIMDATA->GetDisposalMethod(frame);
 }
 
     return M_ANIMDATA->GetDisposalMethod(frame);
 }
 

+wxColour wxAnimation::GetTransparentColour(size_t frame) const
+{
+    wxCHECK_MSG( IsOk(), wxNullColour, wxT("invalid animation") );
+
+    return M_ANIMDATA->GetTransparentColour(frame);
+}
+

 wxColour wxAnimation::GetBackgroundColour() const
 {
     wxCHECK_MSG( IsOk(), wxNullColour, wxT("invalid animation") );
 wxColour wxAnimation::GetBackgroundColour() const
 {
     wxCHECK_MSG( IsOk(), wxNullColour, wxT("invalid animation") );


@@ -99,7 +113,7 @@ wxColour wxAnimation::GetBackgroundColour() const
 bool wxAnimation::LoadFile(const wxString& filename, wxAnimationType type)
 {
     wxFileInputStream stream(filename);
 bool wxAnimation::LoadFile(const wxString& filename, wxAnimationType type)
 {
     wxFileInputStream stream(filename);

-    if (!stream.Ok())
+    if ( !stream.IsOk() )

         return false;
 
     return Load(stream, type);
         return false;
 
     return Load(stream, type);


@@ -112,7 +126,7 @@ bool wxAnimation::Load(wxInputStream &stream, wxAnimationType type)
     const wxAnimationDecoder *handler;
     if ( type == wxANIMATION_TYPE_ANY )
     {
     const wxAnimationDecoder *handler;
     if ( type == wxANIMATION_TYPE_ANY )
     {

-        for ( wxAnimationDecoderList::compatibility_iterator node = sm_handlers.GetFirst(); 
+        for ( wxAnimationDecoderList::compatibility_iterator node = sm_handlers.GetFirst();

               node; node = node->GetNext() )
         {
             handler=(const wxAnimationDecoder*)node->GetData();
               node; node = node->GetNext() )
         {
             handler=(const wxAnimationDecoder*)node->GetData();


@@ -209,8 +223,12 @@ const wxAnimationDecoder *wxAnimation::FindHandler( wxAnimationType animType )
 
 void wxAnimation::InitStandardHandlers()
 {
 
 void wxAnimation::InitStandardHandlers()
 {

+#if wxUSE_GIF

     AddHandler(new wxGIFDecoder);
     AddHandler(new wxGIFDecoder);

+#endif // wxUSE_GIF
+#if wxUSE_ICO_CUR

     AddHandler(new wxANIDecoder);
     AddHandler(new wxANIDecoder);

+#endif // wxUSE_ICO_CUR

 }
 
 void wxAnimation::CleanUpHandlers()
 }
 
 void wxAnimation::CleanUpHandlers()


@@ -244,8 +262,6 @@ public:
 IMPLEMENT_DYNAMIC_CLASS(wxAnimationModule, wxModule)
 
 
 IMPLEMENT_DYNAMIC_CLASS(wxAnimationModule, wxModule)
 
 

-
-

 // ----------------------------------------------------------------------------
 // wxAnimationCtrl
 // ----------------------------------------------------------------------------
 // ----------------------------------------------------------------------------
 // wxAnimationCtrl
 // ----------------------------------------------------------------------------


@@ -257,22 +273,31 @@ BEGIN_EVENT_TABLE(wxAnimationCtrl, wxAnimationCtrlBase)
     EVT_TIMER(wxID_ANY, wxAnimationCtrl::OnTimer)
 END_EVENT_TABLE()
 
     EVT_TIMER(wxID_ANY, wxAnimationCtrl::OnTimer)
 END_EVENT_TABLE()
 

+void wxAnimationCtrl::Init()
+{
+    m_currentFrame = 0;
+    m_looped = false;
+    m_isPlaying = false;
+
+    // use the window background colour by default to be consistent
+    // with the GTK+ native version
+    m_useWinBackgroundColour = true;
+}
+

 bool wxAnimationCtrl::Create(wxWindow *parent, wxWindowID id,
             const wxAnimation& animation, const wxPoint& pos,
             const wxSize& size, long style, const wxString& name)
 {
 bool wxAnimationCtrl::Create(wxWindow *parent, wxWindowID id,
             const wxAnimation& animation, const wxPoint& pos,
             const wxSize& size, long style, const wxString& name)
 {

-    m_animation = animation;
-    m_currentFrame = 0;
-    m_looped = true;
-    m_isPlaying = false;
-    m_useWinBackgroundColour = false;

     m_timer.SetOwner(this);
 
     m_timer.SetOwner(this);
 

-    if (!wxControl::Create(parent, id, pos, size, style, wxDefaultValidator, name))
+    if (!base_type::Create(parent, id, pos, size, style, wxDefaultValidator, name))

         return false;
 
     // by default we get the same background colour of our parent
     SetBackgroundColour(parent->GetBackgroundColour());
         return false;
 
     // by default we get the same background colour of our parent
     SetBackgroundColour(parent->GetBackgroundColour());

+
+    SetAnimation(animation);
+

     return true;
 }
 
     return true;
 }
 


@@ -284,7 +309,7 @@ wxAnimationCtrl::~wxAnimationCtrl()
 bool wxAnimationCtrl::LoadFile(const wxString& filename, wxAnimationType type)
 {
     wxAnimation anim;
 bool wxAnimationCtrl::LoadFile(const wxString& filename, wxAnimationType type)
 {
     wxAnimation anim;

-    if (!anim.LoadFile(filename, type) || 
+    if (!anim.LoadFile(filename, type) ||

         !anim.IsOk())
         return false;
 
         !anim.IsOk())
         return false;
 


@@ -312,21 +337,19 @@ void wxAnimationCtrl::SetAnimation(const wxAnimation& animation)
     if (!this->HasFlag(wxAC_NO_AUTORESIZE))
         FitToAnimation();
 
     if (!this->HasFlag(wxAC_NO_AUTORESIZE))
         FitToAnimation();
 

-    // display first frame
+    // reset frame counter

     m_currentFrame = 0;
     m_currentFrame = 0;

-    if (m_animation.IsOk())
-        RebuildBackingStoreUpToFrame(0);
-    else
-    {
-        // clear to 
-        wxMemoryDC dc;
-        dc.SelectObject(m_backingStore);

 
 

-        // Draw the background
-        DisposeToBackground(dc);
-    }
+    UpdateBackingStoreWithStaticImage();
+}

 
 

-    Refresh();
+void wxAnimationCtrl::SetInactiveBitmap(const wxBitmap &bmp)
+{
+    m_bmpStatic = bmp;
+
+    // if not playing, update the backing store now
+    if (!IsPlaying())
+        UpdateBackingStoreWithStaticImage();

 }
 
 void wxAnimationCtrl::FitToAnimation()
 }
 
 void wxAnimationCtrl::FitToAnimation()


@@ -341,9 +364,10 @@ void wxAnimationCtrl::FitToAnimation()
 
 void wxAnimationCtrl::Stop()
 {
 
 void wxAnimationCtrl::Stop()
 {

-    // leave current frame displayed until Play() is called again

     m_timer.Stop();
     m_isPlaying = false;
     m_timer.Stop();
     m_isPlaying = false;

+
+    UpdateBackingStoreWithStaticImage();

 }
 
 bool wxAnimationCtrl::Play(bool looped)
 }
 
 bool wxAnimationCtrl::Play(bool looped)


@@ -351,15 +375,17 @@ bool wxAnimationCtrl::Play(bool looped)
     if (!m_animation.IsOk())
         return false;
 
     if (!m_animation.IsOk())
         return false;
 

-    int oldframe = m_currentFrame;

     m_looped = looped;
     m_currentFrame = 0;
     m_looped = looped;
     m_currentFrame = 0;

+
+    if (!RebuildBackingStoreUpToFrame(0))
+        return false;
+

     m_isPlaying = true;
 
     m_isPlaying = true;
 

-    // small optimization: if the back store was already updated to the
-    // first frame, don't rebuild it
-    if (oldframe != 0)
-        RebuildBackingStoreUpToFrame(0);
+    // do a ClearBackground() to avoid that e.g. the custom static bitmap which
+    // was eventually shown previously remains partially drawn
+    ClearBackground();

 
     // DrawCurrentFrame() will use our updated backing store
     wxClientDC clientDC(this);
 
     // DrawCurrentFrame() will use our updated backing store
     wxClientDC clientDC(this);


@@ -380,7 +406,7 @@ bool wxAnimationCtrl::Play(bool looped)
 // wxAnimationCtrl - rendering methods
 // ----------------------------------------------------------------------------
 
 // wxAnimationCtrl - rendering methods
 // ----------------------------------------------------------------------------
 

-void wxAnimationCtrl::RebuildBackingStoreUpToFrame(size_t frame)
+bool wxAnimationCtrl::RebuildBackingStoreUpToFrame(size_t frame)

 {
     // if we've not created the backing store yet or it's too
     // small, then recreate it
 {
     // if we've not created the backing store yet or it's too
     // small, then recreate it


@@ -389,10 +415,11 @@ void wxAnimationCtrl::RebuildBackingStoreUpToFrame(size_t frame)
     int w = wxMin(sz.GetWidth(), winsz.GetWidth());
     int h = wxMin(sz.GetHeight(), winsz.GetHeight());
 
     int w = wxMin(sz.GetWidth(), winsz.GetWidth());
     int h = wxMin(sz.GetHeight(), winsz.GetHeight());
 

-    if ( !m_backingStore.Ok() ||
+    if ( !m_backingStore.IsOk() ||

             m_backingStore.GetWidth() < w || m_backingStore.GetHeight() < h )
     {
             m_backingStore.GetWidth() < w || m_backingStore.GetHeight() < h )
     {

-        m_backingStore.Create(w, h);
+        if (!m_backingStore.Create(w, h))
+            return false;

     }
 
     wxMemoryDC dc;
     }
 
     wxMemoryDC dc;


@@ -409,11 +436,16 @@ void wxAnimationCtrl::RebuildBackingStoreUpToFrame(size_t frame)
         {
             DrawFrame(dc, i);
         }
         {
             DrawFrame(dc, i);
         }

+        else if (m_animation.GetDisposalMethod(i) == wxANIM_TOBACKGROUND)
+            DisposeToBackground(dc, m_animation.GetFramePosition(i),
+                                    m_animation.GetFrameSize(i));

     }
 
     // finally draw this frame
     DrawFrame(dc, frame);
     dc.SelectObject(wxNullBitmap);
     }
 
     // finally draw this frame
     DrawFrame(dc, frame);
     dc.SelectObject(wxNullBitmap);

+
+    return true;

 }
 
 void wxAnimationCtrl::IncrementalUpdateBackingStore()
 }
 
 void wxAnimationCtrl::IncrementalUpdateBackingStore()


@@ -437,14 +469,15 @@ void wxAnimationCtrl::IncrementalUpdateBackingStore()
         switch (m_animation.GetDisposalMethod(m_currentFrame-1))
         {
         case wxANIM_TOBACKGROUND:
         switch (m_animation.GetDisposalMethod(m_currentFrame-1))
         {
         case wxANIM_TOBACKGROUND:

-            DisposeToBackground(dc);
+            DisposeToBackground(dc, m_animation.GetFramePosition(m_currentFrame-1),
+                                    m_animation.GetFrameSize(m_currentFrame-1));

             break;
 
         case wxANIM_TOPREVIOUS:
             // this disposal should never be used too often.
             // E.g. GIF specification explicitely say to keep the usage of this
             break;
 
         case wxANIM_TOPREVIOUS:
             // this disposal should never be used too often.
             // E.g. GIF specification explicitely say to keep the usage of this

-            //      disposal limited to the minimum. 
-            // In fact it may require a lot of time to restore 
+            //      disposal limited to the minimum.
+            // In fact it may require a lot of time to restore

             if (m_currentFrame == 1)
             {
                 // if 0-th frame disposal is to restore to previous frame,
             if (m_currentFrame == 1)
             {
                 // if 0-th frame disposal is to restore to previous frame,


@@ -452,7 +485,8 @@ void wxAnimationCtrl::IncrementalUpdateBackingStore()
                 DisposeToBackground(dc);
             }
             else
                 DisposeToBackground(dc);
             }
             else

-                RebuildBackingStoreUpToFrame(m_currentFrame-2);
+                if (!RebuildBackingStoreUpToFrame(m_currentFrame-2))
+                    Stop();

             break;
 
         case wxANIM_DONOTREMOVE:
             break;
 
         case wxANIM_DONOTREMOVE:


@@ -466,6 +500,29 @@ void wxAnimationCtrl::IncrementalUpdateBackingStore()
     dc.SelectObject(wxNullBitmap);
 }
 
     dc.SelectObject(wxNullBitmap);
 }
 

+void wxAnimationCtrl::UpdateBackingStoreWithStaticImage()
+{
+    wxASSERT(!IsPlaying());
+
+    if (m_bmpStatic.IsOk())
+    {
+        // copy the inactive bitmap in the backing store
+        m_backingStore = m_bmpStatic;
+    }
+    else
+    {
+        // put in the backing store the first frame of the animation
+        if (!m_animation.IsOk() ||
+            !RebuildBackingStoreUpToFrame(0))
+        {
+            m_animation = wxNullAnimation;
+            DisposeToBackground();
+        }
+    }
+
+    Refresh();
+}
+

 void wxAnimationCtrl::DrawFrame(wxDC &dc, size_t frame)
 {
     // PERFORMANCE NOTE:
 void wxAnimationCtrl::DrawFrame(wxDC &dc, size_t frame)
 {
     // PERFORMANCE NOTE:


@@ -481,20 +538,41 @@ void wxAnimationCtrl::DrawFrame(wxDC &dc, size_t frame)
 
 void wxAnimationCtrl::DrawCurrentFrame(wxDC& dc)
 {
 
 void wxAnimationCtrl::DrawCurrentFrame(wxDC& dc)
 {

-    wxASSERT(m_backingStore.Ok());
+    wxASSERT( m_backingStore.IsOk() );

 
     // m_backingStore always contains the current frame
 
     // m_backingStore always contains the current frame

-    dc.DrawBitmap(m_backingStore, 0, 0);
+    dc.DrawBitmap(m_backingStore, 0, 0, true /* use mask in case it's present */);

 }
 
 }
 

-void wxAnimationCtrl::DisposeToBackground(wxDC& dc)
+void wxAnimationCtrl::DisposeToBackground()

 {
 {

-    wxBrush brush(IsUsingWindowBackgroundColour() ? 
-                  this->GetBackgroundColour() : m_animation.GetBackgroundColour(), wxSOLID);
+    // clear the backing store
+    wxMemoryDC dc;
+    dc.SelectObject(m_backingStore);
+    DisposeToBackground(dc);
+}
+
+void wxAnimationCtrl::DisposeToBackground(wxDC& dc)
+{ 
+    wxColour col = IsUsingWindowBackgroundColour()
+                    ? GetBackgroundColour()
+                    : m_animation.GetBackgroundColour();
+    wxBrush brush(col);

     dc.SetBackground(brush);
     dc.Clear();
 }
 
     dc.SetBackground(brush);
     dc.Clear();
 }
 

+void wxAnimationCtrl::DisposeToBackground(wxDC& dc, const wxPoint &pos, const wxSize &sz)
+{
+    wxColour col = IsUsingWindowBackgroundColour()
+                    ? GetBackgroundColour()
+                    : m_animation.GetBackgroundColour();
+    wxBrush brush(col);
+    dc.SetBrush(brush);         // SetBrush and not SetBackground !!
+    dc.SetPen(*wxTRANSPARENT_PEN);
+    dc.DrawRectangle(pos, sz);
+}
+

 // ----------------------------------------------------------------------------
 // wxAnimationCtrl - event handlers
 // ----------------------------------------------------------------------------
 // ----------------------------------------------------------------------------
 // wxAnimationCtrl - event handlers
 // ----------------------------------------------------------------------------


@@ -504,10 +582,14 @@ void wxAnimationCtrl::OnPaint(wxPaintEvent& WXUNUSED(event))
     // VERY IMPORTANT: the wxPaintDC *must* be created in any case
     wxPaintDC dc(this);
 
     // VERY IMPORTANT: the wxPaintDC *must* be created in any case
     wxPaintDC dc(this);
 

-    // both if we are playing or not, we need to refresh the current frame
-    if (m_backingStore.Ok())
+    if ( m_backingStore.IsOk() )

         DrawCurrentFrame(dc);
         DrawCurrentFrame(dc);

-    //else: m_animation is not valid and thus we don't have a valid backing store...
+    else
+    {
+        // m_animation is not valid and thus we don't have a valid backing store...
+        // clear then our area to the background colour
+        DisposeToBackground(dc);
+    }

 }
 
 void wxAnimationCtrl::OnTimer(wxTimerEvent &WXUNUSED(event))
 }
 
 void wxAnimationCtrl::OnTimer(wxTimerEvent &WXUNUSED(event))


@@ -518,8 +600,7 @@ void wxAnimationCtrl::OnTimer(wxTimerEvent &WXUNUSED(event))
         // Should a non-looped animation display the last frame?
         if (!m_looped)
         {
         // Should a non-looped animation display the last frame?
         if (!m_looped)
         {

-            m_timer.Stop();
-            m_isPlaying = false;
+            Stop();

             return;
         }
         else
             return;
         }
         else


@@ -547,9 +628,21 @@ void wxAnimationCtrl::OnSize(wxSizeEvent &WXUNUSED(event))
 {
     // NB: resizing an animation control may take a lot of time
     //     for big animations as the backing store must be
 {
     // NB: resizing an animation control may take a lot of time
     //     for big animations as the backing store must be

-    //     extended and rebuilt. Try to avoid it!!
+    //     extended and rebuilt. Try to avoid it e.g. using
+    //     a null proportion value for your wxAnimationCtrls
+    //     when using them inside sizers.

     if (m_animation.IsOk())
     if (m_animation.IsOk())

-        RebuildBackingStoreUpToFrame(m_currentFrame);
+    {
+        // be careful to change the backing store *only* if we are 
+        // playing the animation as otherwise we may be displaying 
+        // the inactive bitmap and overwriting the backing store 
+        // with the last played frame is wrong in this case
+        if (IsPlaying())
+        {
+        if (!RebuildBackingStoreUpToFrame(m_currentFrame))
+            Stop();     // in case we are playing
+        }
+    }

 }
 
 #endif      // wxUSE_ANIMATIONCTRL
 }
 
 #endif      // wxUSE_ANIMATIONCTRL