WebCore/page/animation/KeyframeAnimation.cpp - platform/external/webkit - Git at Google

 /*
  * Copyright (C) 2007 Apple Inc. All rights reserved.
  *
  * Redistribution and use in source and binary forms, with or without
  * modification, are permitted provided that the following conditions
  * are met:
  *
  * 1.  Redistributions of source code must retain the above copyright
  *     notice, this list of conditions and the following disclaimer.
  * 2.  Redistributions in binary form must reproduce the above copyright
  *     notice, this list of conditions and the following disclaimer in the
  *     documentation and/or other materials provided with the distribution.
  * 3.  Neither the name of Apple Computer, Inc. ("Apple") nor the names of
  *     its contributors may be used to endorse or promote products derived
  *     from this software without specific prior written permission.
  *
  * THIS SOFTWARE IS PROVIDED BY APPLE AND ITS CONTRIBUTORS "AS IS" AND ANY
  * EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
  * WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
  * DISCLAIMED. IN NO EVENT SHALL APPLE OR ITS CONTRIBUTORS BE LIABLE FOR ANY
  * DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
  * (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
  * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
  * ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
  * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
  */

 #include "config.h"
 #include "KeyframeAnimation.h"

 #include "CSSPropertyNames.h"
 #include "CSSStyleSelector.h"
 #include "CompositeAnimation.h"
 #include "EventNames.h"
 #include "RenderObject.h"
 #include "SystemTime.h"

 namespace WebCore {

 KeyframeAnimation::KeyframeAnimation(const Animation* animation, RenderObject* renderer, int index, CompositeAnimation* compAnim, RenderStyle* unanimatedStyle)
     : AnimationBase(animation, renderer, compAnim)
     , m_keyframes(renderer, animation->name())
     , m_index(index)
     , m_unanimatedStyle(unanimatedStyle)
 {
     // Get the keyframe RenderStyles
     if (m_object && m_object->element() && m_object->element()->isElementNode())
         m_object->document()->styleSelector()->keyframeStylesForAnimation(static_cast<Element*>(m_object->element()), unanimatedStyle, m_keyframes);

     // Update the m_transformFunctionListValid flag based on whether the function lists in the keyframes match.
     validateTransformFunctionList();
 }

 KeyframeAnimation::~KeyframeAnimation()
 {
     // Do the cleanup here instead of in the base class so the specialized methods get called
     if (!postActive())
         updateStateMachine(AnimationStateInputEndAnimation, -1);
 }

 void KeyframeAnimation::animate(CompositeAnimation* animation, RenderObject* renderer, const RenderStyle* currentStyle,
                                     const RenderStyle* targetStyle, RefPtr<RenderStyle>& animatedStyle)
 {
     // If we have not yet started, we will not have a valid start time, so just start the animation if needed.
     if (isNew() && m_animation->playState() == AnimPlayStatePlaying)
         updateStateMachine(AnimationStateInputStartAnimation, -1);

     // If we get this far and the animation is done, it means we are cleaning up a just finished animation.
     // If so, we need to send back the targetStyle.
     if (postActive()) {
         if (!animatedStyle)
             animatedStyle = const_cast<RenderStyle*>(targetStyle);
         return;
     }

     // If we are waiting for the start timer, we don't want to change the style yet.
     // Special case - if the delay time is 0, then we do want to set the first frame of the
     // animation right away. This avoids a flash when the animation starts.
     if (waitingToStart() && m_animation->delay() > 0)
         return;

     // FIXME: we need to be more efficient about determining which keyframes we are animating between.
     // We should cache the last pair or something.

     // Find the first key
     double elapsedTime = (m_startTime > 0) ? ((!paused() ? currentTime() : m_pauseTime) - m_startTime) : 0;
     if (elapsedTime < 0)
         elapsedTime = 0;

     double t = m_animation->duration() ? (elapsedTime / m_animation->duration()) : 1;
     int i = static_cast<int>(t);
     t -= i;
     if (m_animation->direction() && (i & 1))
         t = 1 - t;

     const RenderStyle* fromStyle = 0;
     const RenderStyle* toStyle = 0;
     double scale = 1;
     double offset = 0;
     Vector<KeyframeValue>::const_iterator endKeyframes = m_keyframes.endKeyframes();
     for (Vector<KeyframeValue>::const_iterator it = m_keyframes.beginKeyframes(); it != endKeyframes; ++it) {
         if (t < it->key()) {
             // The first key should always be 0, so we should never succeed on the first key
             if (!fromStyle)
                 break;
             scale = 1.0 / (it->key() - offset);
             toStyle = it->style();
             break;
         }

         offset = it->key();
         fromStyle = it->style();
     }

     // If either style is 0 we have an invalid case, just stop the animation.
     if (!fromStyle || !toStyle) {
         updateStateMachine(AnimationStateInputEndAnimation, -1);
         return;
     }

     // Run a cycle of animation.
     // We know we will need a new render style, so make one if needed.
     if (!animatedStyle)
         animatedStyle = RenderStyle::clone(targetStyle);

     const TimingFunction* timingFunction = 0;
     if (fromStyle->animations() && fromStyle->animations()->size() > 0)
         timingFunction = &(fromStyle->animations()->animation(0)->timingFunction());

     double prog = progress(scale, offset, timingFunction);

     HashSet<int>::const_iterator endProperties = m_keyframes.endProperties();
     for (HashSet<int>::const_iterator it = m_keyframes.beginProperties(); it != endProperties; ++it) {
         if (blendProperties(this, *it, animatedStyle.get(), fromStyle, toStyle, prog))
             setAnimating();
     }
 }

 bool KeyframeAnimation::hasAnimationForProperty(int property) const
 {
     HashSet<int>::const_iterator end = m_keyframes.endProperties();
     for (HashSet<int>::const_iterator it = m_keyframes.beginProperties(); it != end; ++it) {
         if (*it == property)
             return true;
     }

     return false;
 }

 void KeyframeAnimation::endAnimation(bool)
 {
     // Restore the original (unanimated) style
     if (m_object)
         setChanged(m_object->element());
 }

 bool KeyframeAnimation::shouldSendEventForListener(Document::ListenerType listenerType)
 {
     return m_object->document()->hasListenerType(listenerType);
 }

 void KeyframeAnimation::onAnimationStart(double elapsedTime)
 {
     sendAnimationEvent(eventNames().webkitAnimationStartEvent, elapsedTime);
 }

 void KeyframeAnimation::onAnimationIteration(double elapsedTime)
 {
     sendAnimationEvent(eventNames().webkitAnimationIterationEvent, elapsedTime);
 }

 void KeyframeAnimation::onAnimationEnd(double elapsedTime)
 {
     if (!sendAnimationEvent(eventNames().webkitAnimationEndEvent, elapsedTime)) {
         // We didn't dispatch an event, which would call endAnimation(), so we'll just call it here.
         endAnimation(true);
     }
 }

 bool KeyframeAnimation::sendAnimationEvent(const AtomicString& eventType, double elapsedTime)
 {
     Document::ListenerType listenerType;
     if (eventType == eventNames().webkitAnimationIterationEvent)
         listenerType = Document::ANIMATIONITERATION_LISTENER;
     else if (eventType == eventNames().webkitAnimationEndEvent)
         listenerType = Document::ANIMATIONEND_LISTENER;
     else {
         ASSERT(eventType == eventNames().webkitAnimationStartEvent);
         listenerType = Document::ANIMATIONSTART_LISTENER;
     }

     if (shouldSendEventForListener(listenerType)) {
         // Dispatch the event
         RefPtr<Element> element;
         if (m_object->node() && m_object->node()->isElementNode())
             element = static_cast<Element*>(m_object->node());

         ASSERT(!element || element->document() && !element->document()->inPageCache());
         if (!element)
             return false;

         // Keep a reference to this ImplicitAnimation so it doesn't go away in the handler
         RefPtr<KeyframeAnimation> retainer(this);

         // Call the event handler
         element->dispatchWebKitAnimationEvent(eventType, m_keyframes.animationName(), elapsedTime);

         // Restore the original (unanimated) style
         if (eventType == eventNames().webkitAnimationEndEvent && element->renderer())
             setChanged(element.get());

         return true; // Did dispatch an event
     }

     return false; // Did not dispatch an event
 }

 void KeyframeAnimation::overrideAnimations()
 {
     // This will override implicit animations that match the properties in the keyframe animation
     HashSet<int>::const_iterator end = m_keyframes.endProperties();
     for (HashSet<int>::const_iterator it = m_keyframes.beginProperties(); it != end; ++it)
         compositeAnimation()->overrideImplicitAnimations(*it);
 }

 void KeyframeAnimation::resumeOverriddenAnimations()
 {
     // This will resume overridden implicit animations
     HashSet<int>::const_iterator end = m_keyframes.endProperties();
     for (HashSet<int>::const_iterator it = m_keyframes.beginProperties(); it != end; ++it)
         compositeAnimation()->resumeOverriddenImplicitAnimations(*it);
 }

 bool KeyframeAnimation::affectsProperty(int property) const
 {
     HashSet<int>::const_iterator end = m_keyframes.endProperties();
     for (HashSet<int>::const_iterator it = m_keyframes.beginProperties(); it != end; ++it) {
         if (*it == property)
             return true;
     }
     return false;
 }

 void KeyframeAnimation::validateTransformFunctionList()
 {
     m_transformFunctionListValid = false;

     if (m_keyframes.size() < 2 || !m_keyframes.containsProperty(CSSPropertyWebkitTransform))
         return;

     Vector<KeyframeValue>::const_iterator end = m_keyframes.endKeyframes();

     // Empty transforms match anything, so find the first non-empty entry as the reference
     size_t firstIndex = 0;
     Vector<KeyframeValue>::const_iterator firstIt = end;

     for (Vector<KeyframeValue>::const_iterator it = m_keyframes.beginKeyframes(); it != end; ++it, ++firstIndex) {
         if (it->style()->transform().operations().size() > 0) {
             firstIt = it;
             break;
         }
     }

     if (firstIt == end)
         return;

     const TransformOperations* firstVal = &firstIt->style()->transform();

     // See if the keyframes are valid
     for (Vector<KeyframeValue>::const_iterator it = firstIt+1; it != end; ++it) {
         const TransformOperations* val = &it->style()->transform();

         // A null transform matches anything
         if (val->operations().isEmpty())
             continue;

         // If the sizes of the function lists don't match, the lists don't match
         if (firstVal->operations().size() != val->operations().size())
             return;

         // If the types of each function are not the same, the lists don't match
         for (size_t j = 0; j < firstVal->operations().size(); ++j) {
             if (!firstVal->operations()[j]->isSameType(*val->operations()[j]))
                 return;
         }
     }

     // Keyframes are valid
     m_transformFunctionListValid = true;
 }

 } // namespace WebCore
	/*
	* Copyright (C) 2007 Apple Inc. All rights reserved.
	*
	* Redistribution and use in source and binary forms, with or without
	* modification, are permitted provided that the following conditions
	* are met:
	*
	* 1. Redistributions of source code must retain the above copyright
	* notice, this list of conditions and the following disclaimer.
	* 2. Redistributions in binary form must reproduce the above copyright
	* notice, this list of conditions and the following disclaimer in the
	* documentation and/or other materials provided with the distribution.
	* 3. Neither the name of Apple Computer, Inc. ("Apple") nor the names of
	* its contributors may be used to endorse or promote products derived
	* from this software without specific prior written permission.
	*
	* THIS SOFTWARE IS PROVIDED BY APPLE AND ITS CONTRIBUTORS "AS IS" AND ANY
	* EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
	* WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
	* DISCLAIMED. IN NO EVENT SHALL APPLE OR ITS CONTRIBUTORS BE LIABLE FOR ANY
	* DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
	* (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
	* LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
	* ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
	* (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
	* THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
	*/

	#include "config.h"
	#include "KeyframeAnimation.h"

	#include "CSSPropertyNames.h"
	#include "CSSStyleSelector.h"
	#include "CompositeAnimation.h"
	#include "EventNames.h"
	#include "RenderObject.h"
	#include "SystemTime.h"

	namespace WebCore {

	KeyframeAnimation::KeyframeAnimation(const Animation* animation, RenderObject* renderer, int index, CompositeAnimation* compAnim, RenderStyle* unanimatedStyle)
	: AnimationBase(animation, renderer, compAnim)
	, m_keyframes(renderer, animation->name())
	, m_index(index)
	, m_unanimatedStyle(unanimatedStyle)
	{
	// Get the keyframe RenderStyles
	if (m_object && m_object->element() && m_object->element()->isElementNode())
	m_object->document()->styleSelector()->keyframeStylesForAnimation(static_cast<Element*>(m_object->element()), unanimatedStyle, m_keyframes);

	// Update the m_transformFunctionListValid flag based on whether the function lists in the keyframes match.
	validateTransformFunctionList();
	}

	KeyframeAnimation::~KeyframeAnimation()
	{
	// Do the cleanup here instead of in the base class so the specialized methods get called
	if (!postActive())
	updateStateMachine(AnimationStateInputEndAnimation, -1);
	}

	void KeyframeAnimation::animate(CompositeAnimation* animation, RenderObject* renderer, const RenderStyle* currentStyle,
	const RenderStyle* targetStyle, RefPtr<RenderStyle>& animatedStyle)
	{
	// If we have not yet started, we will not have a valid start time, so just start the animation if needed.
	if (isNew() && m_animation->playState() == AnimPlayStatePlaying)
	updateStateMachine(AnimationStateInputStartAnimation, -1);

	// If we get this far and the animation is done, it means we are cleaning up a just finished animation.
	// If so, we need to send back the targetStyle.
	if (postActive()) {
	if (!animatedStyle)
	animatedStyle = const_cast<RenderStyle*>(targetStyle);
	return;
	}

	// If we are waiting for the start timer, we don't want to change the style yet.
	// Special case - if the delay time is 0, then we do want to set the first frame of the
	// animation right away. This avoids a flash when the animation starts.
	if (waitingToStart() && m_animation->delay() > 0)
	return;

	// FIXME: we need to be more efficient about determining which keyframes we are animating between.
	// We should cache the last pair or something.

	// Find the first key
	double elapsedTime = (m_startTime > 0) ? ((!paused() ? currentTime() : m_pauseTime) - m_startTime) : 0;
	if (elapsedTime < 0)
	elapsedTime = 0;

	double t = m_animation->duration() ? (elapsedTime / m_animation->duration()) : 1;
	int i = static_cast<int>(t);
	t -= i;
	if (m_animation->direction() && (i & 1))
	t = 1 - t;

	const RenderStyle* fromStyle = 0;
	const RenderStyle* toStyle = 0;
	double scale = 1;
	double offset = 0;
	Vector<KeyframeValue>::const_iterator endKeyframes = m_keyframes.endKeyframes();
	for (Vector<KeyframeValue>::const_iterator it = m_keyframes.beginKeyframes(); it != endKeyframes; ++it) {
	if (t < it->key()) {
	// The first key should always be 0, so we should never succeed on the first key
	if (!fromStyle)
	break;
	scale = 1.0 / (it->key() - offset);
	toStyle = it->style();
	break;
	}

	offset = it->key();
	fromStyle = it->style();
	}

	// If either style is 0 we have an invalid case, just stop the animation.
	if (!fromStyle \|\| !toStyle) {
	updateStateMachine(AnimationStateInputEndAnimation, -1);
	return;
	}

	// Run a cycle of animation.
	// We know we will need a new render style, so make one if needed.
	if (!animatedStyle)
	animatedStyle = RenderStyle::clone(targetStyle);

	const TimingFunction* timingFunction = 0;
	if (fromStyle->animations() && fromStyle->animations()->size() > 0)
	timingFunction = &(fromStyle->animations()->animation(0)->timingFunction());

	double prog = progress(scale, offset, timingFunction);

	HashSet<int>::const_iterator endProperties = m_keyframes.endProperties();
	for (HashSet<int>::const_iterator it = m_keyframes.beginProperties(); it != endProperties; ++it) {
	if (blendProperties(this, *it, animatedStyle.get(), fromStyle, toStyle, prog))
	setAnimating();
	}
	}

	bool KeyframeAnimation::hasAnimationForProperty(int property) const
	{
	HashSet<int>::const_iterator end = m_keyframes.endProperties();
	for (HashSet<int>::const_iterator it = m_keyframes.beginProperties(); it != end; ++it) {
	if (*it == property)
	return true;
	}

	return false;
	}

	void KeyframeAnimation::endAnimation(bool)
	{
	// Restore the original (unanimated) style
	if (m_object)
	setChanged(m_object->element());
	}

	bool KeyframeAnimation::shouldSendEventForListener(Document::ListenerType listenerType)
	{
	return m_object->document()->hasListenerType(listenerType);
	}

	void KeyframeAnimation::onAnimationStart(double elapsedTime)
	{
	sendAnimationEvent(eventNames().webkitAnimationStartEvent, elapsedTime);
	}

	void KeyframeAnimation::onAnimationIteration(double elapsedTime)
	{
	sendAnimationEvent(eventNames().webkitAnimationIterationEvent, elapsedTime);
	}

	void KeyframeAnimation::onAnimationEnd(double elapsedTime)
	{
	if (!sendAnimationEvent(eventNames().webkitAnimationEndEvent, elapsedTime)) {
	// We didn't dispatch an event, which would call endAnimation(), so we'll just call it here.
	endAnimation(true);
	}
	}

	bool KeyframeAnimation::sendAnimationEvent(const AtomicString& eventType, double elapsedTime)
	{
	Document::ListenerType listenerType;
	if (eventType == eventNames().webkitAnimationIterationEvent)
	listenerType = Document::ANIMATIONITERATION_LISTENER;
	else if (eventType == eventNames().webkitAnimationEndEvent)
	listenerType = Document::ANIMATIONEND_LISTENER;
	else {
	ASSERT(eventType == eventNames().webkitAnimationStartEvent);
	listenerType = Document::ANIMATIONSTART_LISTENER;
	}

	if (shouldSendEventForListener(listenerType)) {
	// Dispatch the event
	RefPtr<Element> element;
	if (m_object->node() && m_object->node()->isElementNode())
	element = static_cast<Element*>(m_object->node());

	ASSERT(!element \|\| element->document() && !element->document()->inPageCache());
	if (!element)
	return false;

	// Keep a reference to this ImplicitAnimation so it doesn't go away in the handler
	RefPtr<KeyframeAnimation> retainer(this);

	// Call the event handler
	element->dispatchWebKitAnimationEvent(eventType, m_keyframes.animationName(), elapsedTime);

	// Restore the original (unanimated) style
	if (eventType == eventNames().webkitAnimationEndEvent && element->renderer())
	setChanged(element.get());

	return true; // Did dispatch an event
	}

	return false; // Did not dispatch an event
	}

	void KeyframeAnimation::overrideAnimations()
	{
	// This will override implicit animations that match the properties in the keyframe animation
	HashSet<int>::const_iterator end = m_keyframes.endProperties();
	for (HashSet<int>::const_iterator it = m_keyframes.beginProperties(); it != end; ++it)
	compositeAnimation()->overrideImplicitAnimations(*it);
	}

	void KeyframeAnimation::resumeOverriddenAnimations()
	{
	// This will resume overridden implicit animations
	HashSet<int>::const_iterator end = m_keyframes.endProperties();
	for (HashSet<int>::const_iterator it = m_keyframes.beginProperties(); it != end; ++it)
	compositeAnimation()->resumeOverriddenImplicitAnimations(*it);
	}

	bool KeyframeAnimation::affectsProperty(int property) const
	{
	HashSet<int>::const_iterator end = m_keyframes.endProperties();
	for (HashSet<int>::const_iterator it = m_keyframes.beginProperties(); it != end; ++it) {
	if (*it == property)
	return true;
	}
	return false;
	}

	void KeyframeAnimation::validateTransformFunctionList()
	{
	m_transformFunctionListValid = false;

	if (m_keyframes.size() < 2 \|\| !m_keyframes.containsProperty(CSSPropertyWebkitTransform))
	return;

	Vector<KeyframeValue>::const_iterator end = m_keyframes.endKeyframes();

	// Empty transforms match anything, so find the first non-empty entry as the reference
	size_t firstIndex = 0;
	Vector<KeyframeValue>::const_iterator firstIt = end;

	for (Vector<KeyframeValue>::const_iterator it = m_keyframes.beginKeyframes(); it != end; ++it, ++firstIndex) {
	if (it->style()->transform().operations().size() > 0) {
	firstIt = it;
	break;
	}
	}

	if (firstIt == end)
	return;

	const TransformOperations* firstVal = &firstIt->style()->transform();

	// See if the keyframes are valid
	for (Vector<KeyframeValue>::const_iterator it = firstIt+1; it != end; ++it) {
	const TransformOperations* val = &it->style()->transform();

	// A null transform matches anything
	if (val->operations().isEmpty())
	continue;

	// If the sizes of the function lists don't match, the lists don't match
	if (firstVal->operations().size() != val->operations().size())
	return;

	// If the types of each function are not the same, the lists don't match
	for (size_t j = 0; j < firstVal->operations().size(); ++j) {
	if (!firstVal->operations()[j]->isSameType(*val->operations()[j]))
	return;
	}
	}

	// Keyframes are valid
	m_transformFunctionListValid = true;
	}

	} // namespace WebCore