dali-toolkit/internal/transition/transition-set-impl.h

   1 #ifndef DALI_INTERNAL_TRANSITION_SET_H
   2 #define DALI_INTERNAL_TRANSITION_SET_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/internal/transition/transition-impl.h>
  23 #include <dali-toolkit/public-api/transition/transition-set.h>
  24
  25 // EXTERNAL INCLUDES
  26 #include <dali/integration-api/processor-interface.h>
  27 #include <dali/public-api/object/base-object.h>
  28 #include <dali/public-api/signals/connection-tracker.h>
  29
  30 namespace Dali
  31 {
  32 namespace Toolkit
  33 {
  34 namespace Internal
  35 {
  36 using TransitionSetPtr = IntrusivePtr<TransitionSet>;
  37
  38 class TransitionSet : public BaseObject, public ConnectionTracker, public Integration::Processor
  39 {
  40 public:
  41   /**
  42    * Create a new TransitionSet object.
  43    * @return A smart-pointer to the newly allocated TransitionSet.
  44    */
  45   static TransitionSetPtr New();
  46
  47   /**
  48    * @copydoc Dali::Toolkit::TransitionSet::AddTransition(TransitionPtr transition)
  49    */
  50   void AddTransition(TransitionBasePtr transition);
  51
  52   /**
  53    * @copydoc Dali::Toolkit::TransitionSet::GetTransitionAt(uint32_t index)
  54    */
  55   TransitionBase* GetTransitionAt(uint32_t index) const;
  56
  57   /**
  58    * @copydoc Dali::Toolkit::TransitionSet::GetTransitionCount()
  59    */
  60   uint32_t GetTransitionCount() const;
  61
  62   /**
  63    * @copydoc Dali::Toolkit::TransitionSet::QueueToPlay()
  64    */
  65   void QueueToPlay();
  66
  67   /**
  68    * @brief Set pre process of each transition.
  69    */
  70   void TransitionPreProcess();
  71
  72   /**
  73    * @brief Start to play each of Transition.
  74    * This method called at the end of event thread tick, and this method call OnPlay method of TransitionBase internally.
  75    */
  76   void TransitionStart();
  77
  78   /**
  79    * @brief Remove each finished TransitionBase from play list.
  80    * If all transitions are finished emit Finished signal.
  81    */
  82   void TransitionFinished(Dali::Animation& source);
  83
  84   /**
  85    * @copydoc Dali::Toolkit::TransitionSet::FinishedSignal()
  86    */
  87   Dali::Toolkit::TransitionSet::TransitionSetSignalType& FinishedSignal();
  88
  89   /**
  90    * Emit the Finished signal
  91    */
  92   void EmitSignalFinish();
  93
  94   /**
  95    * Connects a callback function with the object's signals.
  96    * @param[in] object The object providing the signal.
  97    * @param[in] tracker Used to disconnect the signal.
  98    * @param[in] signalName The signal to connect to.
  99    * @param[in] functor A newly allocated FunctorDelegate.
 100    * @return True if the signal was connected.
 101    * @post If a signal was connected, ownership of functor was passed to CallbackBase. Otherwise the caller is responsible for deleting the unused functor.
 102    */
 103   static bool DoConnectSignal(BaseObject* object, ConnectionTrackerInterface* tracker, const std::string& signalName, FunctorDelegate* functor);
 104
 105 protected: // Implementation of Processor
 106   /**
 107    * @copydoc Dali::Integration::Processor::Process()
 108    */
 109   void Process(bool postProcessor) override;
 110
 111 protected:
 112   /**
 113    * Construct a new TransitionSet.
 114    */
 115   TransitionSet();
 116
 117   /**
 118    * A reference counted object may only be deleted by calling Unreference()
 119    */
 120   ~TransitionSet() override;
 121
 122 private:
 123   // Undefined
 124   TransitionSet(const TransitionSet&);
 125
 126   // Undefined
 127   TransitionSet& operator=(const TransitionSet& rhs);
 128
 129 private:
 130   Dali::Toolkit::TransitionSet::TransitionSetSignalType mFinishedSignal{};
 131   std::vector<TransitionBasePtr>                        mTransitions;
 132   std::vector<TransitionBasePtr>                        mPlaylist;
 133   Dali::Animation                                       mAnimation;
 134 };
 135
 136 } // namespace Internal
 137
 138 // Helpers for public-api forwarding methods
 139
 140 inline Internal::TransitionSet& GetImplementation(Dali::Toolkit::TransitionSet& transitionSet)
 141 {
 142   DALI_ASSERT_ALWAYS(transitionSet && "TransitionSet handle is empty");
 143
 144   BaseObject& handle = transitionSet.GetBaseObject();
 145
 146   return static_cast<Internal::TransitionSet&>(handle);
 147 }
 148
 149 inline const Internal::TransitionSet& GetImplementation(const Dali::Toolkit::TransitionSet& transitionSet)
 150 {
 151   DALI_ASSERT_ALWAYS(transitionSet && "TransitionSet handle is empty");
 152
 153   const BaseObject& handle = transitionSet.GetBaseObject();
 154
 155   return static_cast<const Internal::TransitionSet&>(handle);
 156 }
 157
 158 } // namespace Toolkit
 159
 160 } // namespace Dali
 161
 162 #endif // DALI_INTERNAL_TRANSITION_H