1 #ifndef __DALI_TOOLKIT_CLUSTER_STYLE_H__
2 #define __DALI_TOOLKIT_CLUSTER_STYLE_H__
5 // Copyright (c) 2014 Samsung Electronics Co., Ltd.
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
11 // http://floralicense.org/license/
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.
21 * @addtogroup CAPI_DALI_TOOLKIT_CLUSTER_MODULE
26 #include <dali/dali.h>
27 #include <dali-toolkit/public-api/enums.h>
29 namespace Dali DALI_IMPORT_API
38 namespace Internal DALI_INTERNAL
41 class ClusterStyleRandom;
46 typedef IntrusivePtr<ClusterStyle> ClusterStylePtr; ///< Pointer to a Dali::Toolkit::ClusterStyle object
49 * @brief A ClusterStyle describes the constraints which are imposed on the child actors in the cluster.
51 class ClusterStyle : public Dali::BaseHandle
55 static const unsigned int UNLIMITED_CHILDREN; ///< Constant that represents an unlimited number of children.
60 * @brief Virtual destructor.
62 virtual ~ClusterStyle();
65 * @brief Query the maximum number of children this Style can handle.
67 * If return value is UNLIMITED_CHILDREN, then this style has no
69 * @return The maximum number of children.
71 unsigned int GetMaximumNumberOfChildren() const;
74 * @brief Applies style (position) to child actor over a specified time duration.
76 * @param[in] child The child actor to apply
77 * @param[in] index The style position index for the actor to transform to.
78 * @param[in] alpha The alpha function to use.
79 * @param[in] durationSeconds The time period to apply this style.
81 void ApplyStyle(Actor child, unsigned int index, AlphaFunction alpha, const TimePeriod& durationSeconds);
84 * @brief Applies style to background actor over a specified time duration.
86 * @param[in] background The background actor to apply
87 * @param[in] alpha The alpha function to use.
88 * @param[in] durationSeconds The time period to apply this style.
90 void ApplyStyleToBackground(Actor background, AlphaFunction alpha, const TimePeriod& durationSeconds);
93 * @brief Applies style to title actor over a specified time duration.
95 * @param[in] title The title actor to apply
96 * @param[in] alpha The alpha function to use.
97 * @param[in] durationSeconds The time period to apply this style.
99 void ApplyStyleToTitle(Actor title, AlphaFunction alpha, const TimePeriod& durationSeconds);
104 * @brief Create a new ClusterStyle; Only derived versions are instantiatable.
108 public: // Not intended for application developers
111 * @brief This constructor is used by Dali New() methods.
113 * @param [in] internal A pointer to a newly allocated Dali resource
115 ClusterStyle(Internal::ClusterStyle* internal);
119 * @brief A ClusterStyle describes the constraints, which are imposed on the child actors in the cluster.
121 class ClusterStyleStandard : public ClusterStyle
126 * @brief Cluster Style type.
130 ClusterStyle1, ///< Style number 1
131 ClusterStyle2, ///< Style number 2
132 ClusterStyle3, ///< Style number 3
133 ClusterStyle4, ///< Style number 4
134 TotalClusterStyles ///< The number of styles
140 * @brief Create an initialized style.
142 static ClusterStyleStandard New(StyleType style);
144 public: // Not intended for application developers
147 * @brief This constructor is used by Dali New() methods.
149 * @param [in] internal A pointer to a newly allocated Dali resource
151 ClusterStyleStandard(Internal::ClusterStyle* internal);
155 * @brief A ClusterStyle describes the constraints, which are imposed on the child actors in the cluster.
157 class ClusterStyleRandom : public ClusterStyle
162 * @brief Create an initialized style.
164 static ClusterStyleRandom New();
166 public: // Not intended for application developers
169 * @brief This constructor is used by Dali New() methods.
171 * @param [in] internal A pointer to a newly allocated Dali resource
173 ClusterStyleRandom(Internal::ClusterStyle* internal);
176 } // namespace Toolkit
183 #endif // __DALI_TOOLKIT_CLUSTER_STYLE_H__