• 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 "core/components/common/properties/animation_option.h"
20 #include "core/components/common/properties/color.h"
21 #include "core/components_ng/render/render_context.h"
22 
23 #include "foundation/arkui/ace_engine/frameworks/base/utils/macros.h"
24 
25 namespace OHOS::Ace {
26 
27 namespace {
28 
29 using PropertyCallback = std::function<void()>;
30 using FinishCallback = std::function<void()>;
31 using RepeatCallback = std::function<void()>;
32 
33 } // namespace
34 
35 class ACE_FORCE_EXPORT AnimationUtils {
36 public:
37     class Animation;
38 
39     static void OpenImplicitAnimation(
40         const AnimationOption& option, const RefPtr<Curve>& curve, const std::function<void()>& finishCallback);
41     static bool CloseImplicitAnimation();
42     static void Animate(const AnimationOption& option, const PropertyCallback& callback,
43         const FinishCallback& finishCallback = nullptr, const RepeatCallback& repeatCallback = nullptr);
44     static void AddKeyFrame(float fraction, const RefPtr<Curve>& curve, const PropertyCallback& callback);
45     static void AddKeyFrame(float fraction, const PropertyCallback& callback);
46 
47     // Similar to Animate, but reuses current options and replaces callback
48     static void AnimateWithCurrentOptions(
49         const PropertyCallback& callback, const FinishCallback& finishCallback, bool timingSensitive = true);
50     // Similar to Animate, but reuses current callback and replaces options
51     static void AnimateWithCurrentCallback(const AnimationOption& option, const PropertyCallback& callback);
52 
53     static std::shared_ptr<AnimationUtils::Animation> StartAnimation(const AnimationOption& option,
54         const PropertyCallback& callback, const FinishCallback& finishCallback = nullptr,
55         const RepeatCallback& repeatCallback = nullptr);
56     static void StopAnimation(const std::shared_ptr<AnimationUtils::Animation>& animation);
57     static void BlendBgColorAnimation(
58         RefPtr<NG::RenderContext>& renderContext, const Color& endColor, int32_t duration, const RefPtr<Curve>& curve);
59     static void PauseAnimation(const std::shared_ptr<AnimationUtils::Animation>& animation);
60     static void ResumeAnimation(const std::shared_ptr<AnimationUtils::Animation>& animation);
61 };
62 } // namespace OHOS::Ace
63 
64 #endif // FOUNDATION_ACE_FRAMEWORKS_CORE_COMPONENTS_NG_RENDER_ANIMATION_UTILS_H
65