dali-toolkit/public-api/transition/transition.h

   1 #ifndef DALI_TOOLKIT_TRANSITION_H
   2 #define DALI_TOOLKIT_TRANSITION_H
   3
   4 /*
   5  * Copyright (c) 2021 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-toolkit/public-api/controls/control.h>
  23 #include <dali-toolkit/public-api/transition/transition-base.h>
  24
  25 namespace Dali
  26 {
  27 namespace Toolkit
  28 {
  29 namespace Internal DALI_INTERNAL
  30 {
  31 class Transition;
  32 }
  33
  34 /**
  35  * @brief
  36  *
  37  * Transition provides continuous and seamless motions between two Controls.
  38  * This Transition generates property animation for transforms(position, scale, orientation), size, color, and opacity.
  39  * And, if there are common renderer properties of source and destination Control, they also animated.
  40  */
  41 class DALI_TOOLKIT_API Transition : public TransitionBase
  42 {
  43 public:
  44   /**
  45    * @brief Creates an uninitialized Transition; this can be initialized with Transition::New().
  46    *
  47    * Calling member functions with an uninitialized Transition handle is not allowed.
  48    */
  49   Transition();
  50
  51   /**
  52    * @brief Creates an initialized Transition.
  53    *
  54    * @param[in] source Source
  55    * @param[in] destination Destination
  56    * @param[in] timePeriod The duration in seconds
  57    * @return A handle to a newly allocated Dali resource
  58    * @note durationSeconds can not be negative.
  59    */
  60   static Transition New(Dali::Toolkit::Control source, Dali::Toolkit::Control destination, TimePeriod timePeriod);
  61
  62   /**
  63    * @brief Downcasts a handle to Transition handle.
  64    *
  65    * If handle points to an Transition object, the downcast produces valid handle.
  66    * If not, the returned handle is left uninitialized.
  67    *
  68    * @param[in] handle Handle to an object
  69    * @return Handle to an Transition object or an uninitialized handle
  70    */
  71   static Transition DownCast(BaseHandle handle);
  72
  73   /**
  74    * @brief Destructor.
  75    *
  76    * This is non-virtual since derived Handle types must not contain data or virtual methods.
  77    */
  78   ~Transition();
  79
  80   /**
  81    * @brief This copy constructor is required for (smart) pointer semantics.
  82    *
  83    * @param[in] handle A reference to the copied handle
  84    */
  85   Transition(const Transition& handle);
  86
  87   /**
  88    * @brief This assignment operator is required for (smart) pointer semantics.
  89    *
  90    * @param[in] rhs A reference to the copied handle
  91    * @return A reference to this
  92    */
  93   Transition& operator=(const Transition& rhs);
  94
  95   /**
  96    * @brief Move constructor.
  97    *
  98    * @param[in] rhs A reference to the moved handle
  99    */
 100   Transition(Transition&& rhs);
 101
 102   /**
 103    * @brief Move assignment operator.
 104    *
 105    * @param[in] rhs A reference to the moved handle
 106    * @return A reference to this handle
 107    */
 108   Transition& operator=(Transition&& rhs);
 109
 110 public: // Not intended for use by Application developers
 111   /// @cond internal
 112   /**
 113    * @brief This constructor is used by Transition::New() methods.
 114    * @param[in] transition A pointer to a newly allocated Dali resource
 115    */
 116   explicit DALI_INTERNAL Transition(Internal::Transition* transition);
 117   /// @endcond
 118 };
 119
 120 } // namespace Toolkit
 121
 122 } // namespace Dali
 123
 124 #endif // DALI_TOOLKIT_TRANSITION_H