optional/dali-toolkit/public-api/transition-effects/cube-transition-wave-effect.h

   1 #ifndef __DALI_TOOLKIT_CUBE_TRANSITION_WAVE_EFFECT_H__
   2 #define __DALI_TOOLKIT_CUBE_TRANSITION_WAVE_EFFECT_H__
   3
   4 //
   5 // Copyright (c) 2014 Samsung Electronics Co., Ltd.
   6 //
   7 // Licensed under the Flora License, Version 1.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://floralicense.org/license/
  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 // INTERNAL INCLUDES
  20 #include <dali-toolkit/public-api/transition-effects/cube-transition-effect.h>
  21
  22 namespace Dali DALI_IMPORT_API
  23 {
  24
  25 namespace Toolkit
  26 {
  27
  28 namespace Internal DALI_INTERNAL
  29 {
  30   /**
  31    * CubeTransitionWaveEffect implementation class
  32    */
  33   class CubeTransitionWaveEffect;
  34
  35 } // namespace Internal
  36
  37 /**
  38  * SubClass of CubeTransitionEffect
  39  * Rotate the cubes successively according to the finger movement to achieve wave-like transition effect
  40  */
  41 class CubeTransitionWaveEffect : public CubeTransitionEffect
  42 {
  43
  44 public:
  45
  46   /**
  47    * Create an initialized CubeTransitionWaveEffect
  48    * @param[in] numRows How many rows of cubes
  49    * @param[in] numColumns How many columns of cubes
  50    * @param[in] viewAreaSize The size of view area for this transition effect
  51    * @return The initialized CubeTransitionWaveEffect object
  52    */
  53   static CubeTransitionWaveEffect New( unsigned int numRows, unsigned int numColumns, Size viewAreaSize );
  54
  55
  56 public: // Not intended for developer use
  57
  58   /**
  59    * This constructor is used by Dali New() methods.
  60    * @param[in] impl A pointer to a newly allocated Dali resource
  61    */
  62   CubeTransitionWaveEffect( Internal::CubeTransitionWaveEffect* impl );
  63
  64 }; // class CubeTransitionWaveEffect
  65
  66 } // namespace Toolkit
  67
  68 } // namespace Dali
  69 #endif /* __DALI_TOOLKIT_CUBE_TRANSITION_WAVE_EFFECT_H__ */