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