aabd8e9cf6a9e61435f9637f79dd61b98af78187
[WebKit-https.git] / Source / WebCore / animation / AnimationTimeline.h
1 /*
2  * Copyright (C) Canon Inc. 2016
3  * Copyright (C) 2017 Apple Inc. All rights reserved.
4  *
5  * Redistribution and use in source and binary forms, with or without
6  * modification, are permitted provided that the following conditions
7  * are met:
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  *
14  * THIS SOFTWARE IS PROVIDED BY APPLE INC. ``AS IS'' AND ANY
15  * EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
16  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
17  * PURPOSE ARE DISCLAIMED.  IN NO EVENT SHALL APPLE INC. OR
18  * CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
19  * EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
20  * PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
21  * PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY
22  * OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
23  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
24  * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
25  */
26
27 #pragma once
28
29 #include "WebAnimation.h"
30 #include <wtf/Forward.h>
31 #include <wtf/HashSet.h>
32 #include <wtf/Optional.h>
33 #include <wtf/Ref.h>
34 #include <wtf/RefCounted.h>
35 #include <wtf/Seconds.h>
36
37 namespace WebCore {
38
39 class WebAnimation;
40
41 class AnimationTimeline : public RefCounted<AnimationTimeline> {
42 public:
43     bool isDocumentTimeline() const { return m_classType == DocumentTimelineClass; }
44     void addAnimation(Ref<WebAnimation>&&);
45     void removeAnimation(Ref<WebAnimation>&&);
46     std::optional<double> bindingsCurrentTime() const;
47     std::optional<Seconds> currentTime() const { return m_currentTime; }
48     WEBCORE_EXPORT void setCurrentTime(Seconds);
49     WEBCORE_EXPORT String description();
50
51     virtual ~AnimationTimeline();
52
53 protected:
54     enum ClassType {
55         DocumentTimelineClass
56     };
57
58     ClassType classType() const { return m_classType; }
59
60     explicit AnimationTimeline(ClassType);
61
62 private:
63     ClassType m_classType;
64     std::optional<Seconds> m_currentTime;
65     HashSet<RefPtr<WebAnimation>> m_animations;
66 };
67
68 } // namespace WebCore
69
70 #define SPECIALIZE_TYPE_TRAITS_ANIMATION_TIMELINE(ToValueTypeName, predicate) \
71 SPECIALIZE_TYPE_TRAITS_BEGIN(WebCore::ToValueTypeName) \
72 static bool isType(const WebCore::AnimationTimeline& value) { return value.predicate; } \
73 SPECIALIZE_TYPE_TRAITS_END()