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 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
11 * http://www.apache.org/licenses/LICENSE-2.0
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.
22 #include <dali/dali.h>
23 #include <dali-toolkit/public-api/enums.h>
25 namespace Dali DALI_IMPORT_API
34 namespace Internal DALI_INTERNAL
37 class ClusterStyleRandom;
42 typedef IntrusivePtr<ClusterStyle> ClusterStylePtr; ///< Pointer to a Dali::Toolkit::ClusterStyle object
45 * @brief A ClusterStyle describes the constraints which are imposed on the child actors in the cluster.
47 class ClusterStyle : public Dali::BaseHandle
51 static const unsigned int UNLIMITED_CHILDREN; ///< Constant that represents an unlimited number of children.
58 * This is non-virtual since derived Handle types must not contain data or virtual methods.
63 * @brief Query the maximum number of children this Style can handle.
65 * If return value is UNLIMITED_CHILDREN, then this style has no
67 * @return The maximum number of children.
69 unsigned int GetMaximumNumberOfChildren() const;
72 * @brief Applies style (position) to child actor over a specified time duration.
74 * @param[in] child The child actor to apply
75 * @param[in] index The style position index for the actor to transform to.
76 * @param[in] alpha The alpha function to use.
77 * @param[in] durationSeconds The time period to apply this style.
79 void ApplyStyle(Actor child, unsigned int index, AlphaFunction alpha, const TimePeriod& durationSeconds);
82 * @brief Applies style to background actor over a specified time duration.
84 * @param[in] background The background actor to apply
85 * @param[in] alpha The alpha function to use.
86 * @param[in] durationSeconds The time period to apply this style.
88 void ApplyStyleToBackground(Actor background, AlphaFunction alpha, const TimePeriod& durationSeconds);
91 * @brief Applies style to title actor over a specified time duration.
93 * @param[in] title The title actor to apply
94 * @param[in] alpha The alpha function to use.
95 * @param[in] durationSeconds The time period to apply this style.
97 void ApplyStyleToTitle(Actor title, AlphaFunction alpha, const TimePeriod& durationSeconds);
102 * @brief Create a new ClusterStyle; Only derived versions are instantiatable.
106 public: // Not intended for application developers
109 * @brief This constructor is used by Dali New() methods.
111 * @param [in] internal A pointer to a newly allocated Dali resource
113 ClusterStyle(Internal::ClusterStyle* internal);
117 * @brief A ClusterStyle describes the constraints, which are imposed on the child actors in the cluster.
119 class ClusterStyleStandard : public ClusterStyle
124 * @brief Cluster Style type.
128 ClusterStyle1, ///< Style number 1
129 ClusterStyle2, ///< Style number 2
130 ClusterStyle3, ///< Style number 3
131 ClusterStyle4, ///< Style number 4
132 TotalClusterStyles ///< The number of styles
138 * @brief Create an initialized style.
140 static ClusterStyleStandard New(StyleType style);
142 public: // Not intended for application developers
145 * @brief This constructor is used by Dali New() methods.
147 * @param [in] internal A pointer to a newly allocated Dali resource
149 ClusterStyleStandard(Internal::ClusterStyle* internal);
153 * @brief A ClusterStyle describes the constraints, which are imposed on the child actors in the cluster.
155 class ClusterStyleRandom : public ClusterStyle
160 * @brief Create an initialized style.
162 static ClusterStyleRandom New();
164 public: // Not intended for application developers
167 * @brief This constructor is used by Dali New() methods.
169 * @param [in] internal A pointer to a newly allocated Dali resource
171 ClusterStyleRandom(Internal::ClusterStyle* internal);
174 } // namespace Toolkit
178 #endif // __DALI_TOOLKIT_CLUSTER_STYLE_H__