dali/devel-api/animation/animation-devel.h

   1 #ifndef DALI_ANIMATION_DEVEL_H
   2 #define DALI_ANIMATION_DEVEL_H
   3
   4 /*
   5  * Copyright (c) 2018 Samsung Electronics Co., Ltd.
   6  *
   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
  10  *
  11  * http://www.apache.org/licenses/LICENSE-2.0
  12  *
  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.
  18  *
  19  */
  20
  21 // INTERNAL INCLUDES
  22 #include <dali/public-api/animation/animation.h>
  23
  24 namespace Dali
  25 {
  26
  27 namespace DevelAnimation
  28 {
  29
  30 /**
  31  * @brief Set progress percentage marker to trigger ProgressHasBeenReachedSignal
  32  *
  33  * @param[in] animation the animation object to perform this operation on
  34  * @param[in] progress the progress percentage to trigger the signal at, e.g .3 for 30%.
  35  */
  36 DALI_CORE_API void SetProgressNotification( Animation animation, float progress );
  37
  38 /**
  39  * @brief Get progress percentage marker that has been set to trigger ProgressHasBeenReachedSignal
  40  *
  41  * @param[in] animation the animation object to perform this operation on
  42  * @return the percentage to trigger at eg 0.3 for 30%
  43  */
  44 DALI_CORE_API float GetProgressNotification( Animation animation );
  45
  46 /**
  47  * @brief Connects to this signal to be notified when an Animation's animations have reached set progress.
  48  *
  49  * @return A signal object to connect with
  50  *
  51  */
  52 DALI_CORE_API Animation::AnimationSignalType& ProgressReachedSignal( Animation animation );
  53
  54 } // namespace DevelAnimation
  55
  56 } // namespace Dali
  57
  58 #endif // DALI_ANIMATION_DEVEL_H