1 #ifndef DALI_SCENE_LOADER_ANIMATED_PROPERTY_H
2 #define DALI_SCENE_LOADER_ANIMATED_PROPERTY_H
4 * Copyright (c) 2021 Samsung Electronics Co., Ltd.
6 * Licensed under the Apache License, Version 2.0 (the "License");
7 * you may not use this file except in compliance with the License.
8 * You may obtain a copy of the License at
10 * http://www.apache.org/licenses/LICENSE-2.0
12 * Unless required by applicable law or agreed to in writing, software
13 * distributed under the License is distributed on an "AS IS" BASIS,
14 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
15 * See the License for the specific language governing permissions and
16 * limitations under the License.
21 #include "dali-scene-loader/public-api/api.h"
26 #include "dali/public-api/actors/actor.h"
27 #include "dali/public-api/animation/animation.h"
28 #include "dali/public-api/object/property.h"
35 * @brief Intermediate representation for a property that's given to
36 * a Animation to animate. Since there is no getting an
37 * animated property back from the Animation (i.e. past AnimateBetween/By/To()),
38 * changing properties (e.g. from the SDK) requires the whole Animation
39 * object to be recreated with all of its properties (incl. modifications).
41 struct DALI_SCENE_LOADER_API AnimatedProperty
45 * @brief Function to obtain an Actor based on its name. Its processing will
46 * ignore empty handles returned by it.
48 using GetActor = std::function<Actor(const std::string&)>;
51 * @return The Property object (of the given @a actor) whose value is being animated.
53 Property GetProperty(Actor& actor)
55 auto idx = actor.GetPropertyIndex(mPropertyName);
56 return Property(actor, idx);
60 * @brief The type of the Property (of the given @a actor) that is being animated.
62 Property::Type GetPropertyType(Actor& actor)
64 auto idx = actor.GetPropertyIndex(mPropertyName);
65 return actor.GetPropertyType(idx);
69 * @brief Registers the animation of this property against the given @a anim.
70 * @a getActor will be used to obtain the Actor named by this property.
71 * Failing to find the actor purely means that this property will not be
74 void Animate(Animation& anim, GetActor getActor);
79 Property::Value mValue;
83 std::string mNodeName;
84 std::string mPropertyName;
87 std::unique_ptr<Value> mValue;
89 AlphaFunction mAlphaFunction = AlphaFunction::DEFAULT;
90 TimePeriod mTimePeriod = TimePeriod(0.f);
93 } // namespace SceneLoader
96 #endif //DALI_SCENE_LOADER_ANIMATED_PROPERTY_H