• Home
  • Line#
  • Scopes#
  • Navigate#
  • Raw
  • Download
1 /*
2  * Copyright (c) 2022 Huawei Device Co., Ltd.
3  * Licensed under the Apache License, Version 2.0 (the "License");
4  * you may not use this file except in compliance with the License.
5  * You may obtain a copy of the License at
6  *
7  *     http://www.apache.org/licenses/LICENSE-2.0
8  *
9  * Unless required by applicable law or agreed to in writing, software
10  * distributed under the License is distributed on an "AS IS" BASIS,
11  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
12  * See the License for the specific language governing permissions and
13  * limitations under the License.
14  */
15 
16 #ifndef FOUNDATION_ACE_FRAMEWORKS_CORE_COMPONENTS_NG_RENDER_ANIMATION_UTILS_H
17 #define FOUNDATION_ACE_FRAMEWORKS_CORE_COMPONENTS_NG_RENDER_ANIMATION_UTILS_H
18 
19 #include "base/utils/macros.h"
20 #include "core/components/common/properties/animation_option.h"
21 #include "core/components/common/properties/color.h"
22 #include "core/pipeline/base/render_context.h"
23 
24 namespace OHOS::Ace {
25 
26 namespace NG {
27 class RenderContext;
28 }
29 
30 namespace {
31 
32 using PropertyCallback = std::function<void()>;
33 using FinishCallback = std::function<void()>;
34 using RepeatCallback = std::function<void()>;
35 using InteractiveAnimationCallback = std::function<void()>;
36 } // namespace
37 
38 class ACE_FORCE_EXPORT AnimationUtils {
39 public:
40     class Animation;
41 
42     class InteractiveAnimation;
43 
44     static void OpenImplicitAnimation(
45         const AnimationOption& option, const RefPtr<Curve>& curve, const std::function<void()>& finishCallback);
46     static bool CloseImplicitAnimation();
47     static bool CloseImplicitCancelAnimation();
48     static bool IsImplicitAnimationOpen();
49     static void Animate(const AnimationOption& option, const PropertyCallback& callback,
50         const FinishCallback& finishCallback = nullptr, const RepeatCallback& repeatCallback = nullptr);
51     static void AddKeyFrame(float fraction, const RefPtr<Curve>& curve, const PropertyCallback& callback);
52     static void AddKeyFrame(float fraction, const PropertyCallback& callback);
53     static void AddDurationKeyFrame(int duration, const RefPtr<Curve>& curve, const PropertyCallback& callback);
54 
55     // Similar to Animate, but reuses current options and replaces callback
56     static void AnimateWithCurrentOptions(
57         const PropertyCallback& callback, const FinishCallback& finishCallback, bool timingSensitive = true);
58     // Similar to Animate, but reuses current callback and replaces options
59     static void AnimateWithCurrentCallback(const AnimationOption& option, const PropertyCallback& callback);
60 
61     static std::shared_ptr<AnimationUtils::Animation> StartAnimation(const AnimationOption& option,
62         const PropertyCallback& callback, const FinishCallback& finishCallback = nullptr,
63         const RepeatCallback& repeatCallback = nullptr);
64     static void StopAnimation(const std::shared_ptr<AnimationUtils::Animation>& animation);
65     static void BlendBgColorAnimation(
66         RefPtr<NG::RenderContext>& renderContext, const Color& endColor, int32_t duration, const RefPtr<Curve>& curve);
67     static void PauseAnimation(const std::shared_ptr<AnimationUtils::Animation>& animation);
68     static void ResumeAnimation(const std::shared_ptr<AnimationUtils::Animation>& animation);
69     static void ExecuteWithoutAnimation(const PropertyCallback& callback);
70 
71     static std::shared_ptr<AnimationUtils::InteractiveAnimation> CreateInteractiveAnimation(
72         const InteractiveAnimationCallback& addCallback, const FinishCallback& callback);
73 
74     static void UpdateInteractiveAnimation(
75         const std::shared_ptr<AnimationUtils::InteractiveAnimation>& interactiveAnimation, float progress);
76 
77     static void ContinueInteractiveAnimation(
78         const std::shared_ptr<AnimationUtils::InteractiveAnimation>& interactiveAnimation);
79 
80     static int32_t StartInteractiveAnimation(
81         const std::shared_ptr<AnimationUtils::InteractiveAnimation>& interactiveAnimation);
82 
83     static void ReverseInteractiveAnimation(
84         const std::shared_ptr<AnimationUtils::InteractiveAnimation>& interactiveAnimation);
85 
86     static void AddInteractiveAnimation(
87         const std::shared_ptr<AnimationUtils::InteractiveAnimation>& interactiveAnimation,
88         const std::function<void()>& callback);
89 
90     static void SetNavGroupNodeTransAnimationCallback();
91 };
92 } // namespace OHOS::Ace
93 
94 #endif // FOUNDATION_ACE_FRAMEWORKS_CORE_COMPONENTS_NG_RENDER_ANIMATION_UTILS_H
95