optional/dali-toolkit/public-api/controls/cluster/cluster-style.h

   1 #ifndef __DALI_TOOLKIT_CLUSTER_STYLE_H__
   2 #define __DALI_TOOLKIT_CLUSTER_STYLE_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 // EXTERNAL INCLUDES
  22 #include <dali/public-api/actors/actor.h>
  23 #include <dali/public-api/animation/alpha-functions.h>
  24 #include <dali/public-api/animation/time-period.h>
  25 #include <dali/public-api/common/dali-common.h>
  26 #include <dali/public-api/object/base-handle.h>
  27
  28 // INTERNAL INCLUDES
  29 #include <dali-toolkit/public-api/enums.h>
  30
  31 namespace Dali DALI_IMPORT_API
  32 {
  33
  34 class Actor;
  35
  36 namespace Toolkit
  37 {
  38
  39 namespace Internal DALI_INTERNAL
  40 {
  41 class ClusterStyle;
  42 class ClusterStyleRandom;
  43 }
  44
  45 class ClusterStyle;
  46
  47 typedef IntrusivePtr<ClusterStyle> ClusterStylePtr; ///< Pointer to a Dali::Toolkit::ClusterStyle object
  48
  49 /**
  50  * @brief A ClusterStyle describes the constraints which are imposed on the child actors in the cluster.
  51  */
  52 class ClusterStyle : public Dali::BaseHandle
  53 {
  54 public:
  55
  56   static const unsigned int UNLIMITED_CHILDREN; ///< Constant that represents an unlimited number of children.
  57
  58 public:
  59
  60   /**
  61    * @brief Destructor
  62    *
  63    * This is non-virtual since derived Handle types must not contain data or virtual methods.
  64    */
  65   ~ClusterStyle();
  66
  67   /**
  68    * @brief Query the maximum number of children this Style can handle.
  69    *
  70    * If return value is UNLIMITED_CHILDREN, then this style has no
  71    * limit.
  72    * @return The maximum number of children.
  73    */
  74   unsigned int GetMaximumNumberOfChildren() const;
  75
  76   /**
  77    * @brief Applies style (position) to child actor over a specified time duration.
  78    *
  79    * @param[in] child The child actor to apply
  80    * @param[in] index The style position index for the actor to transform to.
  81    * @param[in] alpha The alpha function to use.
  82    * @param[in] durationSeconds The time period to apply this style.
  83    */
  84   void ApplyStyle(Actor child, unsigned int index, AlphaFunction alpha, const TimePeriod& durationSeconds);
  85
  86   /**
  87    * @brief Applies style to background actor over a specified time duration.
  88    *
  89    * @param[in] background The background actor to apply
  90    * @param[in] alpha The alpha function to use.
  91    * @param[in] durationSeconds The time period to apply this style.
  92    */
  93   void ApplyStyleToBackground(Actor background, AlphaFunction alpha, const TimePeriod& durationSeconds);
  94
  95   /**
  96    * @brief Applies style to title actor over a specified time duration.
  97    *
  98    * @param[in] title The title actor to apply
  99    * @param[in] alpha The alpha function to use.
 100    * @param[in] durationSeconds The time period to apply this style.
 101    */
 102   void ApplyStyleToTitle(Actor title, AlphaFunction alpha, const TimePeriod& durationSeconds);
 103
 104 protected:
 105
 106   /**
 107    * @brief Create a new ClusterStyle; Only derived versions are instantiatable.
 108    */
 109   ClusterStyle();
 110
 111 public: // Not intended for application developers
 112
 113   /**
 114    * @brief This constructor is used by Dali New() methods.
 115    *
 116    * @param [in] internal A pointer to a newly allocated Dali resource
 117    */
 118   ClusterStyle(Internal::ClusterStyle* internal);
 119 };
 120
 121 /**
 122  * @brief A ClusterStyle describes the constraints, which are imposed on the child actors in the cluster.
 123  */
 124 class ClusterStyleStandard : public ClusterStyle
 125 {
 126 public:
 127
 128   /**
 129    * @brief Cluster Style type.
 130    */
 131   enum StyleType
 132   {
 133     ClusterStyle1,     ///< Style number 1
 134     ClusterStyle2,     ///< Style number 2
 135     ClusterStyle3,     ///< Style number 3
 136     ClusterStyle4,     ///< Style number 4
 137     TotalClusterStyles ///< The number of styles
 138   };
 139
 140 public:
 141
 142   /**
 143    * @brief Create an initialized style.
 144    */
 145   static ClusterStyleStandard New(StyleType style);
 146
 147 public: // Not intended for application developers
 148
 149   /**
 150    * @brief This constructor is used by Dali New() methods.
 151    *
 152    * @param [in] internal A pointer to a newly allocated Dali resource
 153    */
 154   ClusterStyleStandard(Internal::ClusterStyle* internal);
 155 };
 156
 157 /**
 158  * @brief A ClusterStyle describes the constraints, which are imposed on the child actors in the cluster.
 159  */
 160 class ClusterStyleRandom : public ClusterStyle
 161 {
 162 public:
 163
 164   /**
 165    * @brief Create an initialized style.
 166    */
 167   static ClusterStyleRandom New();
 168
 169 public: // Not intended for application developers
 170
 171   /**
 172    * @brief This constructor is used by Dali New() methods.
 173    *
 174    * @param [in] internal A pointer to a newly allocated Dali resource
 175    */
 176   ClusterStyleRandom(Internal::ClusterStyle* internal);
 177 };
 178
 179 } // namespace Toolkit
 180
 181 } // namespace Dali
 182
 183 #endif // __DALI_TOOLKIT_CLUSTER_STYLE_H__