Source/WebCore/animation/AnimationEffectReadOnly.h

/*
 * Copyright (C) 2017-2018 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.
 *
 * THIS SOFTWARE IS PROVIDED BY APPLE INC. ``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 INC. 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.
 */

#pragma once

#include "ComputedTimingProperties.h"
#include "WebAnimation.h"
#include <wtf/Forward.h>
#include <wtf/Ref.h>
#include <wtf/RefCounted.h>
#include <wtf/RefPtr.h>

namespace WebCore {

class AnimationEffectTimingReadOnly;

class AnimationEffectReadOnly : public RefCounted<AnimationEffectReadOnly> {
public:
    virtual ~AnimationEffectReadOnly();

    bool isKeyframeEffect() const { return m_classType == KeyframeEffectClass; }
    bool isKeyframeEffectReadOnly() const { return isKeyframeEffect() || m_classType == KeyframeEffectReadOnlyClass; }
    AnimationEffectTimingReadOnly* timing() const { return m_timing.get(); }
    ComputedTimingProperties getComputedTiming();
    virtual void apply(RenderStyle&) = 0;
    virtual void invalidate() = 0;
    virtual void animationPlayStateDidChange(WebAnimation::PlayState) = 0;
    virtual void animationDidSeek() = 0;

    WebAnimation* animation() const { return m_animation.get(); }
    void setAnimation(RefPtr<WebAnimation>&& animation) { m_animation = animation; }

    std::optional<Seconds> localTime() const;
    std::optional<Seconds> activeTime() const;
    std::optional<double> iterationProgress() const;
    std::optional<double> currentIteration() const;

    enum class Phase { Before, Active, After, Idle };
    Phase phase() const;

    void timingDidChange();

protected:
    enum ClassType {
        KeyframeEffectClass,
        KeyframeEffectReadOnlyClass
    };

    ClassType classType() const { return m_classType; }

    explicit AnimationEffectReadOnly(ClassType, Ref<AnimationEffectTimingReadOnly>&&);

private:
    enum class ComputedDirection { Forwards, Reverse };

    ClassType m_classType;

    std::optional<double> overallProgress() const;
    std::optional<double> simpleIterationProgress() const;
    AnimationEffectReadOnly::ComputedDirection currentDirection() const;
    std::optional<double> directedProgress() const;
    std::optional<double> transformedProgress() const;

    RefPtr<WebAnimation> m_animation;
    RefPtr<AnimationEffectTimingReadOnly> m_timing;
};

} // namespace WebCore

#define SPECIALIZE_TYPE_TRAITS_ANIMATION_EFFECT(ToValueTypeName, predicate) \
SPECIALIZE_TYPE_TRAITS_BEGIN(WebCore::ToValueTypeName) \
static bool isType(const WebCore::AnimationEffectReadOnly& value) { return value.predicate; } \
SPECIALIZE_TYPE_TRAITS_END()