1 /*
2  * Copyright (c) 2023 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 RENDER_SERVICE_CLIENT_CORE_ANIMATION_RS_RENDER_INTERPOLATING_SPRING_ANIMATION_H
17 #define RENDER_SERVICE_CLIENT_CORE_ANIMATION_RS_RENDER_INTERPOLATING_SPRING_ANIMATION_H
18 
19 #include "animation/rs_render_property_animation.h"
20 #include "animation/rs_spring_model.h"
21 #include "common/rs_macros.h"
22 
23 namespace OHOS {
24 namespace Rosen {
25 class RSB_EXPORT RSRenderInterpolatingSpringAnimation : public RSRenderPropertyAnimation, public RSSpringModel<float> {
26 public:
27     explicit RSRenderInterpolatingSpringAnimation(AnimationId id, const PropertyId& propertyId,
28         const std::shared_ptr<RSRenderPropertyBase>& originValue,
29         const std::shared_ptr<RSRenderPropertyBase>& startValue, const std::shared_ptr<RSRenderPropertyBase>& endValue);
30 
31     void DumpAnimationType(std::string& out) const override;
32 
33     void SetSpringParameters(
34         float response, float dampingRatio, float normalizedInitialVelocity, float minimumAmplitudeRatio = 0.00025f);
35     void SetZeroThreshold(float zeroThreshold);
36 
37     ~RSRenderInterpolatingSpringAnimation() override = default;
38 
39 #ifdef ROSEN_OHOS
40     bool Marshalling(Parcel& parcel) const override;
41     [[nodiscard]] static RSRenderInterpolatingSpringAnimation* Unmarshalling(Parcel& parcel);
42 #endif
43 protected:
44     void OnSetFraction(float fraction) override;
45     void UpdateFractionAfterContinue() override;
46     void OnAnimate(float fraction) override;
47     void InitValueEstimator() override;
48     void OnInitialize(int64_t time) override;
49 
50 private:
51 #ifdef ROSEN_OHOS
52     bool ParseParam(Parcel& parcel) override;
53 #endif
54     RSRenderInterpolatingSpringAnimation() = default;
55     std::shared_ptr<RSRenderPropertyBase> CalculateVelocity(float time) const;
56     bool GetNeedLogicallyFinishCallback() const;
57     void CallLogicallyFinishCallback() const;
58     float CalculateTimeFraction(float targetFraction);
59 
60     std::shared_ptr<RSRenderPropertyBase> startValue_;
61     std::shared_ptr<RSRenderPropertyBase> endValue_;
62     float normalizedInitialVelocity_ = 0.0;
63     bool needLogicallyFinishCallback_ = false;
64 
65     // used to determine whether the animation is near finish
66     float zeroThreshold_ = 0.0f;
67 
68     friend class RSInterpolatingSpringAnimation;
69 };
70 
71 } // namespace Rosen
72 } // namespace OHOS
73 
74 #endif // RENDER_SERVICE_CLIENT_CORE_ANIMATION_RS_RENDER_INTERPOLATING_SPRING_ANIMATION_H