1 /*
2  * Copyright (c) 2024 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 META_API_ANIMATION_MODIFIERS_SPEED_H
17 #define META_API_ANIMATION_MODIFIERS_SPEED_H
18 
19 #include <meta/api/internal/animation_modifier_api.h>
20 #include <meta/interface/animation/builtin_animations.h>
21 #include <meta/interface/animation/modifiers/intf_speed.h>
22 
23 META_BEGIN_NAMESPACE()
24 
25 namespace AnimationModifiers {
26 
27 /**
28  * @brief Modifier for animations to set a playback speed factor for the animation.
29  * Example:
30  *     animation.Attach(AnimationModifiers::Speed().Speed(0.5f));
31  *   will run the original animation at half speed.
32  * Default value for speed is 1 (i.e. not altering behaviour).
33  */
34 class Speed final : public Internal::AnimationModifierInterfaceAPI<Speed, META_NS::ClassId::SpeedAnimationModifier> {
35     META_API(Speed)
36     META_API_OBJECT_CONVERTIBLE(META_NS::AnimationModifiers::ISpeed)
37     META_API_CACHE_INTERFACE(META_NS::AnimationModifiers::ISpeed, Speed)
38 public:
39     /**
40      * @brief Set the speed factor.
41      */
42     META_API_INTERFACE_PROPERTY_CACHED(Speed, SpeedFactor, float)
43 };
44 
45 } // namespace AnimationModifiers
46 
47 META_END_NAMESPACE()
48 
49 #endif // META_API_ANIMATION_MODIFIERS_SPEED_H
50