1 #ifndef DALI_SCENE_LOADER_ANIMATED_PROPERTY_H
2 #define DALI_SCENE_LOADER_ANIMATED_PROPERTY_H
4 * Copyright (c) 2020 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"
24 #include "dali/public-api/actors/actor.h"
25 #include "dali/public-api/animation/animation.h"
26 #include "dali/public-api/object/property.h"
36 * @brief Intermediate representation for a property that's given to
37 * a Animation to animate. Since there is no getting an
38 * animated property back from the Animation (i.e. past AnimateBetween/By/To()),
39 * changing properties (e.g. from the SDK) requires the whole Animation
40 * object to be recreated with all of its properties (incl. modifications).
42 struct DALI_SCENE_LOADER_API AnimatedProperty
46 * @brief Function to obtain an Actor based on its name. Its processing will
47 * ignore empty handles returned by it.
49 using GetActor = std::function<Actor(const std::string&)>;
52 * @return The Property object (of the given @a actor) whose value is being animated.
54 Property GetProperty(Actor& actor)
56 auto idx = actor.GetPropertyIndex(mPropertyName);
57 return Property(actor, idx);
61 * @brief The type of the Property (of the given @a actor) that is being animated.
63 Property::Type GetPropertyType(Actor& actor)
65 auto idx = actor.GetPropertyIndex(mPropertyName);
66 return actor.GetPropertyType(idx);
70 * @brief Registers the animation of this property against the given @a anim.
71 * @a getActor will be used to obtain the Actor named by this property.
72 * Failing to find the actor purely means that this property will not be
75 void Animate(Animation& anim, GetActor getActor);
80 Property::Value mValue;
84 std::string mNodeName;
85 std::string mPropertyName;
88 std::unique_ptr<Value> mValue;
90 AlphaFunction mAlphaFunction = AlphaFunction::DEFAULT;
91 TimePeriod mTimePeriod = TimePeriod(0.f);
97 #endif //DALI_SCENE_LOADER_ANIMATED_PROPERTY_H