blob: 0dafc87b92c49832002c680e8fddb6686e9b9255 [file] [log] [blame]
/*
* Copyright (C) 2013 Google 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:
*
* * Redistributions of source code must retain the above copyright
* notice, this list of conditions and the following disclaimer.
* * 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.
* * Neither the name of Google Inc. 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 THE COPYRIGHT HOLDERS AND 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 THE COPYRIGHT
* OWNER OR 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.
*/
#ifndef THIRD_PARTY_BLINK_RENDERER_CORE_ANIMATION_TIMING_H_
#define THIRD_PARTY_BLINK_RENDERER_CORE_ANIMATION_TIMING_H_
#include "base/memory/scoped_refptr.h"
#include "base/optional.h"
#include "third_party/blink/renderer/core/animation/animation_time_delta.h"
#include "third_party/blink/renderer/core/style/data_equivalency.h"
#include "third_party/blink/renderer/platform/animation/compositor_keyframe_model.h"
#include "third_party/blink/renderer/platform/animation/timing_function.h"
#include "third_party/blink/renderer/platform/wtf/allocator/allocator.h"
#include "third_party/blink/renderer/platform/wtf/math_extras.h"
namespace blink {
class EffectTiming;
class ComputedEffectTiming;
static inline bool IsNull(double value) {
return std::isnan(value);
}
static inline double NullValue() {
return std::numeric_limits<double>::quiet_NaN();
}
struct CORE_EXPORT Timing {
USING_FAST_MALLOC(Timing);
public:
// Note that logic in CSSAnimations depends on the order of these values.
enum Phase {
kPhaseBefore,
kPhaseActive,
kPhaseAfter,
kPhaseNone,
};
// Represents the animation direction from the Web Animations spec, see
// https://drafts.csswg.org/web-animations-1/#animation-direction.
enum AnimationDirection {
kForwards,
kBackwards,
};
using FillMode = CompositorKeyframeModel::FillMode;
using PlaybackDirection = CompositorKeyframeModel::Direction;
static String FillModeString(FillMode);
static FillMode StringToFillMode(const String&);
static String PlaybackDirectionString(PlaybackDirection);
Timing()
: start_delay(0),
end_delay(0),
fill_mode(FillMode::AUTO),
iteration_start(0),
iteration_count(1),
iteration_duration(base::nullopt),
direction(PlaybackDirection::NORMAL),
timing_function(LinearTimingFunction::Shared()) {}
void AssertValid() const {
DCHECK(std::isfinite(start_delay));
DCHECK(std::isfinite(end_delay));
DCHECK(std::isfinite(iteration_start));
DCHECK_GE(iteration_start, 0);
DCHECK_GE(iteration_count, 0);
DCHECK(!iteration_duration ||
iteration_duration.value() >= AnimationTimeDelta());
DCHECK(timing_function);
}
// https://drafts.csswg.org/web-animations-1/#iteration-duration
AnimationTimeDelta IterationDuration() const;
// https://drafts.csswg.org/web-animations-1/#active-duration
double ActiveDuration() const;
double EndTimeInternal() const;
Timing::FillMode ResolvedFillMode(bool is_animation) const;
EffectTiming* ConvertToEffectTiming() const;
bool operator==(const Timing& other) const {
return start_delay == other.start_delay && end_delay == other.end_delay &&
fill_mode == other.fill_mode &&
iteration_start == other.iteration_start &&
iteration_count == other.iteration_count &&
iteration_duration == other.iteration_duration &&
direction == other.direction &&
DataEquivalent(timing_function.get(), other.timing_function.get());
}
bool operator!=(const Timing& other) const { return !(*this == other); }
double start_delay;
double end_delay;
FillMode fill_mode;
double iteration_start;
double iteration_count;
// If empty, indicates the 'auto' value.
base::Optional<AnimationTimeDelta> iteration_duration;
PlaybackDirection direction;
scoped_refptr<TimingFunction> timing_function;
struct CalculatedTiming {
DISALLOW_NEW();
Phase phase = Phase::kPhaseNone;
base::Optional<double> current_iteration = 0;
base::Optional<double> progress = 0;
bool is_current = false;
bool is_in_effect = false;
bool is_in_play = false;
double local_time = NullValue();
AnimationTimeDelta time_to_forwards_effect_change =
AnimationTimeDelta::Max();
AnimationTimeDelta time_to_reverse_effect_change =
AnimationTimeDelta::Max();
double time_to_next_iteration = std::numeric_limits<double>::infinity();
};
CalculatedTiming CalculateTimings(double local_time,
AnimationDirection animation_direction,
bool is_keyframe_effect,
base::Optional<double> playback_rate) const;
ComputedEffectTiming* getComputedTiming(const CalculatedTiming& calculated,
bool is_keyframe_effect) const;
};
} // namespace blink
#endif