WebCore/page/animation/AnimationControllerPrivate.h

   1 /*
   2  * Copyright (C) 2009 Apple Inc. All rights reserved.
   3  *
   4  * Redistribution and use in source and binary forms, with or without
   5  * modification, are permitted provided that the following conditions
   6  * are met:
   7  *
   8  * 1.  Redistributions of source code must retain the above copyright
   9  *     notice, this list of conditions and the following disclaimer.
  10  * 2.  Redistributions in binary form must reproduce the above copyright
  11  *     notice, this list of conditions and the following disclaimer in the
  12  *     documentation and/or other materials provided with the distribution.
  13  * 3.  Neither the name of Apple Computer, Inc. ("Apple") nor the names of
  14  *     its contributors may be used to endorse or promote products derived
  15  *     from this software without specific prior written permission.
  16  *
  17  * THIS SOFTWARE IS PROVIDED BY APPLE AND ITS CONTRIBUTORS "AS IS" AND ANY
  18  * EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
  19  * WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
  20  * DISCLAIMED. IN NO EVENT SHALL APPLE OR ITS CONTRIBUTORS BE LIABLE FOR ANY
  21  * DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
  22  * (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
  23  * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
  24  * ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
  25  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
  26  * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
  27  */
  28
  29 #ifndef AnimationControllerPrivate_h
  30 #define AnimationControllerPrivate_h
  31
  32 #include "AtomicString.h"
  33 #include "CSSPropertyNames.h"
  34 #include "PlatformString.h"
  35 #include "Timer.h"
  36 #include <wtf/HashMap.h>
  37 #include <wtf/PassRefPtr.h>
  38 #include <wtf/RefPtr.h>
  39 #include <wtf/Vector.h>
  40
  41 namespace WebCore {
  42
  43 class AnimationBase;
  44 class CompositeAnimation;
  45 class Document;
  46 class Element;
  47 class Frame;
  48 class Node;
  49 class RenderObject;
  50 class RenderStyle;
  51
  52 class AnimationControllerPrivate {
  53 public:
  54     AnimationControllerPrivate(Frame*);
  55     ~AnimationControllerPrivate();
  56
  57     PassRefPtr<CompositeAnimation> accessCompositeAnimation(RenderObject*);
  58     bool clear(RenderObject*);
  59
  60     void animationTimerFired(Timer<AnimationControllerPrivate>*);
  61     void updateAnimationTimer(bool callSetChanged = false);
  62
  63     void updateStyleIfNeededDispatcherFired(Timer<AnimationControllerPrivate>*);
  64     void startUpdateStyleIfNeededDispatcher();
  65     void addEventToDispatch(PassRefPtr<Element> element, const AtomicString& eventType, const String& name, double elapsedTime);
  66     void addNodeChangeToDispatch(PassRefPtr<Node>);
  67
  68     bool hasAnimations() const { return !m_compositeAnimations.isEmpty(); }
  69
  70     void suspendAnimations(Document*);
  71     void resumeAnimations(Document*);
  72
  73     bool isAnimatingPropertyOnRenderer(RenderObject*, CSSPropertyID, bool isRunningNow) const;
  74
  75     bool pauseAnimationAtTime(RenderObject*, const String& name, double t);
  76     bool pauseTransitionAtTime(RenderObject*, const String& property, double t);
  77     unsigned numberOfActiveAnimations() const;
  78
  79     PassRefPtr<RenderStyle> getAnimatedStyleForRenderer(RenderObject* renderer);
  80
  81     double beginAnimationUpdateTime();
  82     void setBeginAnimationUpdateTime(double t) { m_beginAnimationUpdateTime = t; }
  83     void endAnimationUpdate()
  84     {
  85         styleAvailable();
  86         if (!m_waitingForAResponse)
  87             startTimeResponse(beginAnimationUpdateTime());
  88     }
  89
  90     void receivedStartTimeResponse(double t)
  91     {
  92         m_waitingForAResponse = false;
  93         startTimeResponse(t);
  94     }
  95
  96     void addToStyleAvailableWaitList(AnimationBase*);
  97     void removeFromStyleAvailableWaitList(AnimationBase*);
  98
  99     void addToStartTimeResponseWaitList(AnimationBase*, bool willGetResponse);
 100     void removeFromStartTimeResponseWaitList(AnimationBase*);
 101     void startTimeResponse(double t);
 102
 103 private:
 104     void styleAvailable();
 105
 106     typedef HashMap<RenderObject*, RefPtr<CompositeAnimation> > RenderObjectAnimationMap;
 107
 108     RenderObjectAnimationMap m_compositeAnimations;
 109     Timer<AnimationControllerPrivate> m_animationTimer;
 110     Timer<AnimationControllerPrivate> m_updateStyleIfNeededDispatcher;
 111     Frame* m_frame;
 112
 113     class EventToDispatch {
 114     public:
 115         RefPtr<Element> element;
 116         AtomicString eventType;
 117         String name;
 118         double elapsedTime;
 119     };
 120
 121     Vector<EventToDispatch> m_eventsToDispatch;
 122     Vector<RefPtr<Node> > m_nodeChangesToDispatch;
 123
 124     double m_beginAnimationUpdateTime;
 125     AnimationBase* m_styleAvailableWaiters;
 126     AnimationBase* m_lastStyleAvailableWaiter;
 127
 128     AnimationBase* m_responseWaiters;
 129     AnimationBase* m_lastResponseWaiter;
 130     bool m_waitingForAResponse;
 131 };
 132
 133 } // namespace WebCore
 134
 135 #endif // AnimationControllerPrivate_h