1 #ifndef __DALI_INTERNAL_ANIMATION_H__
2 #define __DALI_INTERNAL_ANIMATION_H__
5 * Copyright (c) 2014 Samsung Electronics Co., Ltd.
7 * Licensed under the Apache License, Version 2.0 (the "License");
8 * you may not use this file except in compliance with the License.
9 * You may obtain a copy of the License at
11 * http://www.apache.org/licenses/LICENSE-2.0
13 * Unless required by applicable law or agreed to in writing, software
14 * distributed under the License is distributed on an "AS IS" BASIS,
15 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
16 * See the License for the specific language governing permissions and
17 * limitations under the License.
22 #include <dali/public-api/common/vector-wrapper.h>
23 #include <dali/public-api/object/ref-object.h>
24 #include <dali/public-api/animation/animation.h>
25 #include <dali/public-api/object/base-object.h>
26 #include <dali/internal/event/animation/animator-connector-base.h>
27 #include <dali/internal/event/animation/key-frames-impl.h>
28 #include <dali/internal/event/animation/path-impl.h>
44 class AnimationPlaylist;
48 typedef IntrusivePtr<Animation> AnimationPtr;
49 typedef std::vector<AnimationPtr> AnimationContainer;
51 typedef AnimationContainer::iterator AnimationIter;
52 typedef AnimationContainer::const_iterator AnimationConstIter;
55 * Animation is a proxy for a SceneGraph::Animation object.
56 * The UpdateManager owns the Animation object, but the lifetime of the animation is
57 * indirectly controlled by the Animation.
59 class Animation : public BaseObject
63 typedef Dali::Animation::EndAction EndAction;
64 typedef Dali::Animation::Interpolation Interpolation;
66 typedef void (*FinishedCallback)(Object* object);
69 * Create a new Animation object.
70 * @param[in] durationSeconds The duration of the animation.
71 * @return A smart-pointer to the newly allocated Animation.
73 static AnimationPtr New(float durationSeconds);
76 * @copydoc Dali::Animation::SetDuration()
78 void SetDuration(float seconds);
81 * @copydoc Dali::Animation::GetDuration()
83 float GetDuration() const;
86 * @copydoc Dali::Animation::SetLooping()
88 void SetLooping(bool looping);
91 * @copydoc Dali::Animation::IsLooping()
93 bool IsLooping() const;
96 * @copydoc Dali::Animation::SetEndAction()
98 void SetEndAction(EndAction action);
101 * @copydoc Dali::Animation::GetEndAction()
103 EndAction GetEndAction() const;
106 * @copydoc Dali::Animation::SetDisconnectAction()
108 void SetDisconnectAction(EndAction action);
111 * @copydoc Dali::Animation::GetDisconnectAction()
113 EndAction GetDisconnectAction() const;
116 * @copydoc Dali::Animation::SetDefaultAlphaFunction()
118 void SetDefaultAlphaFunction(AlphaFunction alpha)
120 mDefaultAlpha = alpha;
124 * @copydoc Dali::Animation::GetDefaultAlphaFunction()
126 AlphaFunction GetDefaultAlphaFunction() const
128 return mDefaultAlpha;
132 * @copydoc Dali::Animation::Play()
137 * @copydoc Dali::Animation::PlayFrom()
139 void PlayFrom( float progress );
142 * @copydoc Dali::Animation::Pause()
147 * @copydoc Dali::Animation::Stop()
152 * @copydoc Dali::Animation::Clear()
157 * Query whether a Finished signal should be emitted for this animation.
158 * This should only be called by NotificationManager, before signals are emitted.
159 * @post HasFinished() will return false on subsequent calls, until the animation is replayed to completion.
164 * @copydoc Dali::Animation::FinishedSignal()
166 Dali::Animation::AnimationSignalType& FinishedSignal();
169 * Emit the Finished signal
171 void EmitSignalFinish();
174 * Connects a callback function with the object's signals.
175 * @param[in] object The object providing the signal.
176 * @param[in] tracker Used to disconnect the signal.
177 * @param[in] signalName The signal to connect to.
178 * @param[in] functor A newly allocated FunctorDelegate.
179 * @return True if the signal was connected.
180 * @post If a signal was connected, ownership of functor was passed to CallbackBase. Otherwise the caller is responsible for deleting the unused functor.
182 static bool DoConnectSignal( BaseObject* object, ConnectionTrackerInterface* tracker, const std::string& signalName, FunctorDelegate* functor );
185 * Performs actions as requested using the action name.
186 * @param[in] object The object on which to perform the action.
187 * @param[in] actionName The action to perform.
188 * @param[in] attributes The attributes with which to perfrom this action.
189 * @return true if action was done
191 static bool DoAction(BaseObject* object, const std::string& actionName, const std::vector<Property::Value>& attributes);
194 * This callback is intended for internal use only, to avoid the overhead of using a signal.
195 * @param[in] callback The callback function to connect.
196 * @param[in] object The internal object requesting the callback, or NULL.
198 void SetFinishedCallback( FinishedCallback callback, Object* object );
201 * @copydoc Dali::Animation::AnimateBy(Property target, Property::Value relativeValue)
203 void AnimateBy(Property& target, Property::Value& relativeValue);
206 * @copydoc Dali::Animation::AnimateBy(Property target, Property::Value relativeValue, AlphaFunction alpha)
208 void AnimateBy(Property& target, Property::Value& relativeValue, AlphaFunction alpha);
211 * @copydoc Dali::Animation::AnimateBy(Property target, Property::Value relativeValue, TimePeriod period)
213 void AnimateBy(Property& target, Property::Value& relativeValue, TimePeriod period);
216 * @copydoc Dali::Animation::AnimateBy(Property target, Property::Value relativeValue, AlphaFunction alpha, TimePeriod period)
218 void AnimateBy(Property& target, Property::Value& relativeValue, AlphaFunction alpha, TimePeriod period);
221 * @copydoc Dali::Animation::AnimateTo(Property target, Property::Value destinationValue)
223 void AnimateTo(Property& target, Property::Value& destinationValue);
226 * @copydoc Dali::Animation::AnimateTo(Property target, Property::Value destinationValue, AlphaFunction alpha)
228 void AnimateTo(Property& target, Property::Value& destinationValue, AlphaFunction alpha);
231 * @copydoc Dali::Animation::AnimateTo(Property target, Property::Value destinationValue, TimePeriod period)
233 void AnimateTo(Property& target, Property::Value& destinationValue, TimePeriod period);
236 * @copydoc Dali::Animation::AnimateTo(Property target, Property::Value destinationValue, AlphaFunction alpha, TimePeriod period)
238 void AnimateTo(Property& target, Property::Value& destinationValue, AlphaFunction alpha, TimePeriod period);
241 * Animate a property to a destination value.
242 * @param [in] targetObject The target object to animate.
243 * @param [in] targetPropertyIndex The index of the target property.
244 * @param [in] componentIndex Index to a sub component of a property, for use with Vector2, Vector3 and Vector4
245 * @param [in] destinationValue The destination value.
246 * @param [in] alpha The alpha function to apply.
247 * @param [in] period The effect will occur during this time period.
249 void AnimateTo(Object& targetObject, Property::Index targetPropertyIndex, int componentIndex, Property::Value& destinationValue, AlphaFunction alpha, TimePeriod period);
252 * @copydoc Dali::Animation::AnimateBetween(Property target, KeyFrames& keyFrames)
254 void AnimateBetween(Property target, const KeyFrames& keyFrames);
257 * @copydoc Dali::Animation::AnimateBetween(Property target, KeyFrames& keyFrames, Interpolation interpolation)
259 void AnimateBetween(Property target, const KeyFrames& keyFrames, Interpolation interpolation );
262 * @copydoc Dali::Animation::AnimateBetween(Property target, KeyFrames& keyFrames, TimePeriod period)
264 void AnimateBetween(Property target, const KeyFrames& keyFrames, TimePeriod period);
267 * @copydoc Dali::Animation::AnimateBetween(Property target, KeyFrames& keyFrames, TimePeriod period, Interpolation interpolation)
269 void AnimateBetween(Property target, const KeyFrames& keyFrames, TimePeriod period, Interpolation interpolation);
272 * @copydoc Dali::Animation::AnimateBetween(Property target, KeyFrames& keyFrames, AlphaFunction alpha)
274 void AnimateBetween(Property target, const KeyFrames& keyFrames, AlphaFunction alpha);
277 * @copydoc Dali::Animation::AnimateBetween(Property target, KeyFrames& keyFrames, AlphaFunction alpha, Interpolation interpolation)
279 void AnimateBetween(Property target, const KeyFrames& keyFrames, AlphaFunction alpha, Interpolation interpolation);
282 * @copydoc Dali::Animation::AnimateBetween(Property target, KeyFrames& keyFrames, AlphaFunction alpha, TimePeriod period)
284 void AnimateBetween(Property target, const KeyFrames& keyFrames, AlphaFunction alpha, TimePeriod period);
287 * @copydoc Dali::Animation::AnimateBetween(Property target, KeyFrames& keyFrames, AlphaFunction alpha, TimePeriod period, Interpolation interpolation )
289 void AnimateBetween(Property target, const KeyFrames& keyFrames, AlphaFunction alpha, TimePeriod period, Interpolation interpolation );
291 // Actor-specific convenience functions
294 * @copydoc Dali::Animation::Animate( Actor actor, Path path, const Vector3& forward )
296 void Animate( Actor& actor, const Path& path, const Vector3& forward );
299 * @copydoc Dali::Animation::Animate( Actor actor, Path path, const Vector3& forward, AlphaFunction alpha )
301 void Animate( Actor& actor, const Path& path, const Vector3& forward, AlphaFunction alpha );
304 * @copydoc Dali::Animation::Animate( Actor actor, Path path, const Vector3& forward, TimePeriod period )
306 void Animate( Actor& actor, const Path& path, const Vector3& forward, TimePeriod period );
309 * @copydoc Dali::Animation::Animate( Actor actor, Path path, const Vector3& forward, AlphaFunction alpha, TimePeriod period)
311 void Animate( Actor& actor, const Path& path, const Vector3& forward, AlphaFunction alpha, TimePeriod period);
314 * @copydoc Dali::Animation::Show()
316 void Show(Actor& actor, float delaySeconds);
319 * @copydoc Dali::Animation::Hide()
321 void Hide(Actor& actor, float delaySeconds);
324 * @copydoc Dali::Animation::SetCurrentProgress()
326 void SetCurrentProgress(float progress);
329 * @copydoc Dali::Animation::GetCurrentProgress()
331 float GetCurrentProgress();
334 * @copydoc Dali::Animation::SetSpeedFactor()
336 void SetSpeedFactor( float factor );
339 * @copydoc Dali::Animation::GetSpeedFactor()
341 float GetSpeedFactor() const;
344 * @copydoc Dali::Animation::SetPlayRange()
346 void SetPlayRange( const Vector2& range );
349 * @copydoc Dali::Animation::GetPlayRange
351 Vector2 GetPlayRange() const;
353 public: // For connecting animators to animations
356 * Add an animator connector.
357 * @param[in] connector The animator connector.
359 void AddAnimatorConnector( AnimatorConnectorBase* connector );
362 * Retrieve the SceneGraph::Animation object.
363 * @return The animation.
365 const SceneGraph::Animation* GetSceneObject()
371 * Retrieve the event thread services object
372 * @return The interface for sending messages to the scene graph
374 EventThreadServices& GetEventThreadServices()
376 return mEventThreadServices;
382 * Construct a new Animation.
383 * @param[in] eventThreadServices The interface for sending messages to the scene graph
384 * @param[in] playlist The list of currently playing animations.
385 * @param[in] durationSeconds The duration of the animation in seconds.
386 * @param[in] endAction The action to perform when the animation ends.
387 * @param[in] disconnectAction The action to perform when the property owner of an animator is disconnected.
388 * @param[in] defaultAlpha The default alpha function to apply to animators.
390 Animation( EventThreadServices& eventThreadServices,
391 AnimationPlaylist& playlist,
392 float durationSeconds,
394 EndAction disconnectAction,
395 AlphaFunction defaultAlpha);
398 * Second-phase constructor.
403 * Helper to create a scene-graph animation
405 void CreateSceneObject();
408 * Helper to create a scene-graph animation
410 void DestroySceneObject();
413 * A reference counted object may only be deleted by calling Unreference()
415 virtual ~Animation();
420 * Extends the duration when an animator is added with TimePeriod that exceeds current duration.
421 * @param[in] timePeriod The time period for an animator.
423 void ExtendDuration( const TimePeriod& timePeriod );
426 Animation(const Animation&);
429 Animation& operator=(const Animation& rhs);
432 EventThreadServices& mEventThreadServices;
433 AnimationPlaylist& mPlaylist;
435 const SceneGraph::Animation* mAnimation;
437 int mNotificationCount; ///< Keep track of how many Finished signals have been emitted.
439 Dali::Animation::AnimationSignalType mFinishedSignal;
441 FinishedCallback mFinishedCallback;
442 Object* mFinishedCallbackObject;
444 AnimatorConnectorContainer mConnectors; ///< Owned by the Animation
446 // Cached for public getters
447 float mDurationSeconds;
451 EndAction mEndAction;
452 EndAction mDisconnectAction;
453 AlphaFunction mDefaultAlpha;
457 } // namespace Internal
459 // Helpers for public-api forwarding methods
461 inline Internal::Animation& GetImplementation(Dali::Animation& animation)
463 DALI_ASSERT_ALWAYS( animation && "Animation handle is empty" );
465 BaseObject& handle = animation.GetBaseObject();
467 return static_cast<Internal::Animation&>(handle);
470 inline const Internal::Animation& GetImplementation(const Dali::Animation& animation)
472 DALI_ASSERT_ALWAYS( animation && "Animation handle is empty" );
474 const BaseObject& handle = animation.GetBaseObject();
476 return static_cast<const Internal::Animation&>(handle);
481 #endif // __DALI_INTERNAL_ANIMATION_H__