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

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