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

   1 #ifndef __DALI_TOOLKIT_CUBE_TRANSITION_CROSS_EFFECT_H__
   2 #define __DALI_TOOLKIT_CUBE_TRANSITION_CROSS_EFFECT_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 // INTERNAL INCLUDES
  21 #include <dali-toolkit/public-api/transition-effects/cube-transition-effect.h>
  22
  23 namespace Dali
  24 {
  25
  26 namespace Toolkit
  27 {
  28
  29 namespace Internal DALI_INTERNAL
  30 {
  31   /**
  32    * CubeTransitionCrossEffect implementation class
  33    */
  34   class CubeTransitionCrossEffect;
  35
  36 } // namespace Internal
  37
  38 /**
  39  * SubClass of CubeTransitionEffect
  40  * Rotate the neighboring cubes in perpendicular directions to transite from one image to another
  41  */
  42 class DALI_IMPORT_API CubeTransitionCrossEffect : public CubeTransitionEffect
  43 {
  44
  45 public:
  46
  47   /**
  48    * Create an initialized CubeTransitionCrossEffect
  49    * @param[in] numRows How many rows of cubes
  50    * @param[in] numColumns How many columns of cubes
  51    * @param[in] viewAreaSize The size of view area for this transition effect
  52    * @return The initialized CubeTransitionCrossEffect object
  53    */
  54   static CubeTransitionCrossEffect New( unsigned int numRows, unsigned int numColumns, Size viewAreaSize );
  55
  56
  57 public: // Not intended for developer use
  58
  59   /**
  60    * This constructor is used by Dali New() methods.
  61    * @param [in] impl A pointer to a newly allocated Dali resource
  62    */
  63   explicit DALI_INTERNAL CubeTransitionCrossEffect( Internal::CubeTransitionCrossEffect* impl );
  64
  65 }; // class CubeTransitionCrossEffect
  66
  67 } // namespace Toolkit
  68
  69 } // namespace Dali
  70
  71 #endif /* __DALI_TOOLKIT_CUBE_TRANSITION_CROSS_EFFECT_H__ */