mirror of
https://github.com/mozilla/gecko-dev.git
synced 2024-11-06 00:55:37 +00:00
9c7f65de0d
As a result, transitions are now stored using a pointer to the base class, mozilla::ElementAnimation. We downcast to a transition only when necessary. No error-checking of the result of AsTransition is performed since we only ever call it on the mAnimations member of ElementTransitions.
264 lines
10 KiB
C++
264 lines
10 KiB
C++
/* vim: set shiftwidth=2 tabstop=8 autoindent cindent expandtab: */
|
|
/* This Source Code Form is subject to the terms of the Mozilla Public
|
|
* License, v. 2.0. If a copy of the MPL was not distributed with this
|
|
* file, You can obtain one at http://mozilla.org/MPL/2.0/. */
|
|
#ifndef nsAnimationManager_h_
|
|
#define nsAnimationManager_h_
|
|
|
|
#include "mozilla/Attributes.h"
|
|
#include "mozilla/ContentEvents.h"
|
|
#include "AnimationCommon.h"
|
|
#include "nsCSSPseudoElements.h"
|
|
#include "mozilla/MemoryReporting.h"
|
|
#include "mozilla/TimeStamp.h"
|
|
|
|
class nsCSSKeyframesRule;
|
|
class nsStyleContext;
|
|
|
|
namespace mozilla {
|
|
namespace css {
|
|
class Declaration;
|
|
}
|
|
}
|
|
|
|
struct AnimationEventInfo {
|
|
nsRefPtr<mozilla::dom::Element> mElement;
|
|
mozilla::InternalAnimationEvent mEvent;
|
|
|
|
AnimationEventInfo(mozilla::dom::Element *aElement,
|
|
const nsString& aAnimationName,
|
|
uint32_t aMessage, mozilla::TimeDuration aElapsedTime,
|
|
const nsAString& aPseudoElement)
|
|
: mElement(aElement), mEvent(true, aMessage)
|
|
{
|
|
// XXX Looks like nobody initialize WidgetEvent::time
|
|
mEvent.animationName = aAnimationName;
|
|
mEvent.elapsedTime = aElapsedTime.ToSeconds();
|
|
mEvent.pseudoElement = aPseudoElement;
|
|
}
|
|
|
|
// InternalAnimationEvent doesn't support copy-construction, so we need
|
|
// to ourselves in order to work with nsTArray
|
|
AnimationEventInfo(const AnimationEventInfo &aOther)
|
|
: mElement(aOther.mElement), mEvent(true, aOther.mEvent.message)
|
|
{
|
|
mEvent.AssignAnimationEventData(aOther.mEvent, false);
|
|
}
|
|
};
|
|
|
|
typedef InfallibleTArray<AnimationEventInfo> EventArray;
|
|
|
|
/**
|
|
* Data about all of the animations running on an element.
|
|
*/
|
|
struct ElementAnimations MOZ_FINAL
|
|
: public mozilla::css::CommonElementAnimationData
|
|
{
|
|
typedef mozilla::TimeStamp TimeStamp;
|
|
typedef mozilla::TimeDuration TimeDuration;
|
|
|
|
ElementAnimations(mozilla::dom::Element *aElement, nsIAtom *aElementProperty,
|
|
nsAnimationManager *aAnimationManager, TimeStamp aNow);
|
|
|
|
// This function takes as input the start time, duration, and direction of an
|
|
// animation and returns the position in the current iteration. Note that
|
|
// this only works when we know that the animation is currently running.
|
|
// This way of calling the function can be used from the compositor. Note
|
|
// that if the animation has not started yet, has already ended, or is paused,
|
|
// it should not be run from the compositor. When this function is called
|
|
// from the main thread, we need the actual ElementAnimation* in order to
|
|
// get correct animation-fill behavior and to fire animation events.
|
|
// This function returns -1 for the position if the animation should not be
|
|
// run (because it is not currently active and has no fill behavior), but
|
|
// only does so if aAnimation is non-null; with a null aAnimation it is an
|
|
// error to give aElapsedDuration < 0, and fill-forwards is assumed.
|
|
// After calling GetPositionInIteration with non-null aAnimation and aEa, be
|
|
// sure to call CheckNeedsRefresh on the animation manager afterwards.
|
|
static double GetPositionInIteration(TimeDuration aElapsedDuration,
|
|
TimeDuration aIterationDuration,
|
|
double aIterationCount,
|
|
uint32_t aDirection,
|
|
mozilla::ElementAnimation* aAnimation =
|
|
nullptr,
|
|
ElementAnimations* aEa = nullptr,
|
|
EventArray* aEventsToDispatch = nullptr);
|
|
|
|
void EnsureStyleRuleFor(TimeStamp aRefreshTime,
|
|
EventArray &aEventsToDispatch,
|
|
bool aIsThrottled);
|
|
|
|
bool IsForElement() const { // rather than for a pseudo-element
|
|
return mElementProperty == nsGkAtoms::animationsProperty;
|
|
}
|
|
|
|
nsString PseudoElement()
|
|
{
|
|
return mElementProperty == nsGkAtoms::animationsProperty ?
|
|
EmptyString() :
|
|
mElementProperty == nsGkAtoms::animationsOfBeforeProperty ?
|
|
NS_LITERAL_STRING("::before") :
|
|
NS_LITERAL_STRING("::after");
|
|
}
|
|
|
|
void PostRestyleForAnimation(nsPresContext *aPresContext) {
|
|
nsRestyleHint styleHint = IsForElement() ? eRestyle_Self : eRestyle_Subtree;
|
|
aPresContext->PresShell()->RestyleForAnimation(mElement, styleHint);
|
|
}
|
|
|
|
// If aFlags contains CanAnimate_AllowPartial, returns whether the
|
|
// state of this element's animations at the current refresh driver
|
|
// time contains animation data that can be done on the compositor
|
|
// thread. (This is useful for determining whether a layer should be
|
|
// active, or whether to send data to the layer.)
|
|
// If aFlags does not contain CanAnimate_AllowPartial, returns whether
|
|
// the state of this element's animations at the current refresh driver
|
|
// time can be fully represented by data sent to the compositor.
|
|
// (This is useful for determining whether throttle the animation
|
|
// (suppress main-thread style updates).)
|
|
// Note that when CanPerformOnCompositorThread returns true, it also,
|
|
// as a side-effect, notifies the ActiveLayerTracker. FIXME: This
|
|
// should probably move to the relevant callers.
|
|
virtual bool CanPerformOnCompositorThread(CanAnimateFlags aFlags) const MOZ_OVERRIDE;
|
|
|
|
virtual bool HasAnimationOfProperty(nsCSSProperty aProperty) const MOZ_OVERRIDE;
|
|
|
|
// False when we know that our current style rule is valid
|
|
// indefinitely into the future (because all of our animations are
|
|
// either completed or paused). May be invalidated by a style change.
|
|
bool mNeedsRefreshes;
|
|
};
|
|
|
|
class nsAnimationManager MOZ_FINAL
|
|
: public mozilla::css::CommonAnimationManager
|
|
{
|
|
public:
|
|
nsAnimationManager(nsPresContext *aPresContext)
|
|
: mozilla::css::CommonAnimationManager(aPresContext)
|
|
, mObservingRefreshDriver(false)
|
|
{
|
|
}
|
|
|
|
static ElementAnimations* GetAnimationsForCompositor(nsIContent* aContent,
|
|
nsCSSProperty aProperty)
|
|
{
|
|
if (!aContent->MayHaveAnimations())
|
|
return nullptr;
|
|
ElementAnimations* animations = static_cast<ElementAnimations*>(
|
|
aContent->GetProperty(nsGkAtoms::animationsProperty));
|
|
if (!animations)
|
|
return nullptr;
|
|
bool propertyMatches = animations->HasAnimationOfProperty(aProperty);
|
|
return (propertyMatches &&
|
|
animations->CanPerformOnCompositorThread(
|
|
mozilla::css::CommonElementAnimationData::CanAnimate_AllowPartial))
|
|
? animations
|
|
: nullptr;
|
|
}
|
|
|
|
// Returns true if aContent or any of its ancestors has an animation.
|
|
static bool ContentOrAncestorHasAnimation(nsIContent* aContent) {
|
|
do {
|
|
if (aContent->GetProperty(nsGkAtoms::animationsProperty)) {
|
|
return true;
|
|
}
|
|
} while ((aContent = aContent->GetParent()));
|
|
|
|
return false;
|
|
}
|
|
|
|
void EnsureStyleRuleFor(ElementAnimations* aET);
|
|
|
|
// nsIStyleRuleProcessor (parts)
|
|
virtual void RulesMatching(ElementRuleProcessorData* aData) MOZ_OVERRIDE;
|
|
virtual void RulesMatching(PseudoElementRuleProcessorData* aData) MOZ_OVERRIDE;
|
|
virtual void RulesMatching(AnonBoxRuleProcessorData* aData) MOZ_OVERRIDE;
|
|
#ifdef MOZ_XUL
|
|
virtual void RulesMatching(XULTreeRuleProcessorData* aData) MOZ_OVERRIDE;
|
|
#endif
|
|
virtual size_t SizeOfExcludingThis(mozilla::MallocSizeOf aMallocSizeOf)
|
|
const MOZ_MUST_OVERRIDE MOZ_OVERRIDE;
|
|
virtual size_t SizeOfIncludingThis(mozilla::MallocSizeOf aMallocSizeOf)
|
|
const MOZ_MUST_OVERRIDE MOZ_OVERRIDE;
|
|
|
|
// nsARefreshObserver
|
|
virtual void WillRefresh(mozilla::TimeStamp aTime) MOZ_OVERRIDE;
|
|
|
|
void FlushAnimations(FlushFlags aFlags);
|
|
|
|
/**
|
|
* Return the style rule that RulesMatching should add for
|
|
* aStyleContext. This might be different from what RulesMatching
|
|
* actually added during aStyleContext's construction because the
|
|
* element's animation-name may have changed. (However, this does
|
|
* return null during the non-animation restyling phase, as
|
|
* RulesMatching does.)
|
|
*
|
|
* aStyleContext may be a style context for aElement or for its
|
|
* :before or :after pseudo-element.
|
|
*/
|
|
nsIStyleRule* CheckAnimationRule(nsStyleContext* aStyleContext,
|
|
mozilla::dom::Element* aElement);
|
|
|
|
/**
|
|
* Dispatch any pending events. We accumulate animationend and
|
|
* animationiteration events only during refresh driver notifications
|
|
* (and dispatch them at the end of such notifications), but we
|
|
* accumulate animationstart events at other points when style
|
|
* contexts are created.
|
|
*/
|
|
void DispatchEvents() {
|
|
// Fast-path the common case: no events
|
|
if (!mPendingEvents.IsEmpty()) {
|
|
DoDispatchEvents();
|
|
}
|
|
}
|
|
|
|
ElementAnimations* GetElementAnimations(mozilla::dom::Element *aElement,
|
|
nsCSSPseudoElements::Type aPseudoType,
|
|
bool aCreateIfNeeded);
|
|
|
|
// Updates styles on throttled animations. See note on nsTransitionManager
|
|
void UpdateAllThrottledStyles();
|
|
|
|
protected:
|
|
virtual void ElementDataRemoved() MOZ_OVERRIDE
|
|
{
|
|
CheckNeedsRefresh();
|
|
}
|
|
virtual void AddElementData(mozilla::css::CommonElementAnimationData* aData) MOZ_OVERRIDE;
|
|
|
|
/**
|
|
* Check to see if we should stop or start observing the refresh driver
|
|
*/
|
|
void CheckNeedsRefresh();
|
|
|
|
private:
|
|
void BuildAnimations(nsStyleContext* aStyleContext,
|
|
mozilla::ElementAnimationPtrArray& aAnimations);
|
|
bool BuildSegment(InfallibleTArray<mozilla::AnimationPropertySegment>&
|
|
aSegments,
|
|
nsCSSProperty aProperty, const nsAnimation& aAnimation,
|
|
float aFromKey, nsStyleContext* aFromContext,
|
|
mozilla::css::Declaration* aFromDeclaration,
|
|
float aToKey, nsStyleContext* aToContext);
|
|
nsIStyleRule* GetAnimationRule(mozilla::dom::Element* aElement,
|
|
nsCSSPseudoElements::Type aPseudoType);
|
|
|
|
// Update the animated styles of an element and its descendants.
|
|
// If the element has an animation, it is flushed back to its primary frame.
|
|
// If the element does not have an animation, then its style is reparented.
|
|
void UpdateThrottledStylesForSubtree(nsIContent* aContent,
|
|
nsStyleContext* aParentStyle,
|
|
nsStyleChangeList &aChangeList);
|
|
void UpdateAllThrottledStylesInternal();
|
|
|
|
// The guts of DispatchEvents
|
|
void DoDispatchEvents();
|
|
|
|
EventArray mPendingEvents;
|
|
|
|
bool mObservingRefreshDriver;
|
|
};
|
|
|
|
#endif /* !defined(nsAnimationManager_h_) */
|