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_INTERFACE_INTF_INTERPOLATOR_H
17 #define META_INTERFACE_INTF_INTERPOLATOR_H
18 
19 #include <core/plugin/intf_interface.h>
20 
21 #include <meta/base/namespace.h>
22 #include <meta/interface/curves/intf_curve_1d.h>
23 #include <meta/interface/property/intf_property.h>
24 
25 META_BEGIN_NAMESPACE()
26 
27 META_REGISTER_INTERFACE(IInterpolator, "64378ee2-445e-4224-a3b0-f3c5680d0d12")
28 
29 /**
30  * @brief The IInterpolator interface defines an interface for objects which can interpolate
31  *        between two values.
32  *
33  *        In most cases the Interpolate function can be re-entrant, and interpolator
34  *        classes should be registered with META_REGISTER_SINGLETON_CLASS().
35  */
36 class IInterpolator : public CORE_NS::IInterface {
37     META_INTERFACE(CORE_NS::IInterface, IInterpolator, META_NS::InterfaceId::IInterpolator)
38 public:
39     /**
40      * @brief Calculate interpolated value between two values at position t.
41      * @param output The output value.
42      * @param from Start of the interpolation range, corresponding to t = 0.
43      * @param to End of the interpolation range, corresponding to t = 1.
44      * @param t The interpolation position.
45      */
46     virtual AnyReturnValue Interpolate(IAny& output, const IAny& from, const IAny& to, float t) const = 0;
47 
48     virtual bool IsCompatibleWith(TypeId id) const = 0;
49 };
50 
51 META_END_NAMESPACE()
52 
53 META_TYPE(META_NS::IInterpolator::Ptr)
54 META_TYPE(META_NS::IInterpolator::WeakPtr)
55 
56 #endif // META_INTERFACE_INTF_INTERPOLATOR_H
57