dali/public-api/animation/time-period.h

   1 #ifndef __DALI_TIME_PERIOD_H__
   2 #define __DALI_TIME_PERIOD_H__
   3
   4 /*
   5  * Copyright (c) 2015 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/common/dali-common.h>
  23
  24 namespace Dali
  25 {
  26 /**
  27  * @addtogroup dali_core_animation
  28  * @{
  29  */
  30
  31 /**
  32  * @brief A value-type representing a period of time within an animation.
  33  * @SINCE_1_0.0
  34  */
  35 struct DALI_IMPORT_API TimePeriod
  36 {
  37   /**
  38    * @brief Creates a time period.
  39    *
  40    * @SINCE_1_0.0
  41    * @param[in] durationSeconds The duration of the time period in seconds
  42    */
  43   explicit TimePeriod(float durationSeconds);
  44
  45   /**
  46    * @brief Creates a time period.
  47    *
  48    * @SINCE_1_0.0
  49    * @param[in] delaySeconds A delay before the time period in seconds
  50    * @param[in] durationSeconds The duration of the time period in seconds
  51    */
  52   TimePeriod(float delaySeconds, float durationSeconds);
  53
  54   /**
  55    * @brief Non-virtual destructor. TimePeriod is not intended as a base class.
  56    * @SINCE_1_0.0
  57    */
  58   ~TimePeriod();
  59
  60   float delaySeconds;    ///< A delay before the time period in seconds
  61   float durationSeconds; ///< The duration of the time period in seconds
  62 };
  63
  64 /**
  65  * @}
  66  */
  67 } // namespace Dali
  68
  69 #endif // __DALI_TIME_PERIOD_H__