Merge "stop using double variant of pow" into tizen
[platform/core/uifw/dali-core.git] / dali / public-api / actors / layer.h
1 #ifndef __DALI_LAYER_H__
2 #define __DALI_LAYER_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 // INTERNAL INCLUDES
22 #include <dali/public-api/object/ref-object.h>
23 #include <dali/public-api/actors/actor.h>
24 #include <dali/public-api/math/rect.h>
25 #include <dali/public-api/math/vector3.h>
26 #include <dali/public-api/images/frame-buffer-image.h>
27
28 namespace Dali
29 {
30
31 namespace Internal DALI_INTERNAL
32 {
33 class Layer;
34 }
35
36 /**
37  * @brief Rectangle describing area on screen that a layer can draw to.
38  *
39  * @see Dali::Layer::SetClippingBox()
40  */
41 typedef Rect<int> ClippingBox;
42
43 /**
44  * @brief Layers provide a mechanism for overlaying groups of actors on top of each other.
45  *
46  * When added to the stage, a layer can be ordered relative to other layers. The bottom
47  * layer is at depth zero. The stage provides a default layer for it's children.
48  *
49  * Layered actors inherit position etc. as normal, but are drawn in an order determined
50  * by the layers. The depth buffer is cleared before each layer is rendered unless depth
51  * test is disabled or there's no need for it based on the layers contents;
52  * actors in lower layers cannot obscure actors in higher layers.
53  *
54  * If depth test is disabled, there is no performance overhead from clearing the depth buffer.
55  */
56 class DALI_IMPORT_API Layer : public Actor
57 {
58 public:
59
60   // Default Properties additional to Actor
61   static const Property::Index CLIPPING_ENABLE; ///< name "clipping-enable",  type BOOLEAN
62   static const Property::Index CLIPPING_BOX;    ///< name "clipping-box",     type RECTANGLE
63
64   // Action Names
65   static const char* const ACTION_RAISE;           ///< name "raise"
66   static const char* const ACTION_LOWER;           ///< name "lower"
67   static const char* const ACTION_RAISE_TO_TOP;    ///< name "raise-to-top"
68   static const char* const ACTION_LOWER_TO_BOTTOM; ///< name "lower-to-bottom"
69
70   /**
71    * @brief The sort function type.
72    *
73    * The position value is the actor translation from camera.
74    * The sortModifier is the user value that can be used to sort coplanar actors/nodes. This value is
75    * the one set by calling RenderableActor::SetSortModifier().
76    *
77    * A high return value means that the actor will be positioned further away by the sort algorithm.
78    * @see RenderableActor::SetSortModifier
79    */
80   typedef float (*SortFunctionType)(const Vector3& position, float sortModifier);
81
82   /**
83    * @brief Create an empty Layer handle.
84    *
85    * This can be initialised with Layer::New(...)
86    */
87   Layer();
88
89   /**
90    * @brief Create a Layer object.
91    *
92    * @return A handle to a newly allocated Layer
93    */
94   static Layer New();
95
96   /**
97    * @brief Downcast an Object handle to Layer.
98    *
99    * If handle points to a Layer the downcast produces valid
100    * handle. If not the returned handle is left uninitialized.
101    * @param[in] handle to An object
102    * @return handle to a Layer or an uninitialized handle
103    */
104   static Layer DownCast( BaseHandle handle );
105
106   /**
107    * @brief Destructor
108    *
109    * This is non-virtual since derived Handle types must not contain data or virtual methods.
110    */
111   ~Layer();
112
113   /**
114    * @brief Copy constructor
115    *
116    * @param [in] copy The actor to copy.
117    */
118   Layer(const Layer& copy);
119
120   /**
121    * @brief Assignment operator
122    *
123    * @param [in] rhs The actor to copy.
124    */
125   Layer& operator=(const Layer& rhs);
126
127   /**
128    * @brief This method is defined to allow assignment of the NULL value,
129    * and will throw an exception if passed any other value.
130    *
131    * Assigning to NULL is an alias for Reset().
132    * @param [in] rhs  A NULL pointer
133    * @return A reference to this handle
134    */
135   Layer& operator=(BaseHandle::NullType* rhs);
136
137   /**
138    * @brief Query the depth of the layer
139    *
140    * 0 is bottom most layer, higher number is on top
141    * @pre layer is on the stage
142    * If layer is not added to the stage, returns 0.
143    * @return the current depth of the layer.
144    */
145   unsigned int GetDepth() const;
146
147   /**
148    * @brief Increment the depth of the layer.
149    *
150    * @pre layer is on the stage
151    */
152   void Raise();
153
154   /**
155    * @brief Decrement the depth of the layer.
156    *
157    * @pre layer is on the stage
158    */
159   void Lower();
160
161   /**
162    * @brief Ensures the layers depth is greater than the target layer.
163    *
164    * If the layer already is above target layer its depth is not changed
165    * If the layer was below target, its new depth will be immediately above target
166    * Note! All layers between this layer and target get new depth values
167    * @pre layer is on the stage
168    * @pre target layer is on the stage
169    * @param target layer to get above of
170    */
171   void RaiseAbove( Layer target );
172
173   /**
174    * @brief Ensures the layers depth is less than the target layer.
175    *
176    * If the layer already is below the layer its depth is not changed
177    * If the layer was above target, its new depth will be immediately below target
178    * Note! All layers between this layer and target get new depth values
179    * @pre layer is on the stage
180    * @pre target layer is on the stage
181    * @param target layer to get below of
182    */
183   void LowerBelow( Layer target );
184
185   /**
186    * @brief Raises the layer to the top.
187    * @pre layer is on the stage
188    */
189   void RaiseToTop();
190
191   /**
192    * @brief Lowers the layer to the bottom.
193    * @pre layer is on the stage
194    */
195   void LowerToBottom();
196
197   /**
198    * @brief Moves the layer directly above the given layer.
199    *
200    * After the call this layers depth will be immediately above target
201    * Note! All layers between this layer and target get new depth values
202    * @pre layer is on the stage
203    * @pre target layer is on the stage
204    * @param target layer to get on top of
205    */
206   void MoveAbove( Layer target );
207
208   /**
209    * @brief Moves the layer directly below the given layer.
210    *
211    * After the call this layers depth will be immediately below target
212    * Note! All layers between this layer and target get new depth values
213    * @pre layer is on the stage
214    * @pre target layer is on the stage
215    * @param target layer to get below of
216    */
217   void MoveBelow( Layer target );
218
219   /**
220    * @brief Sets whether clipping is enabled for a layer.
221    *
222    * Clipping is initially disabled; see also SetClippingBox().
223    * @param [in] enabled True if clipping is enabled.
224    *
225    * @note When clipping is enabled, the default clipping box is empty (0,0,0,0) which means everything is clipped.
226    */
227   void SetClipping(bool enabled);
228
229   /**
230    * @brief Query whether clipping is enabled for a layer.
231    * @return True if clipping is enabled.
232    */
233   bool IsClipping() const;
234
235   /**
236    * @brief Sets the clipping box of a layer, in window coordinates.
237    *
238    * The contents of the layer will not be visible outside this box, when clipping is
239    * enabled. The default clipping box is empty (0,0,0,0) which means everything is clipped.
240    * You can only do rectangular clipping using this API in window coordinates.
241    * For other kinds of clipping, @see Dali::Actor::SetDrawMode().
242    * @param [in] x The X-coordinate of the top-left corner of the box.
243    * @param [in] y The Y-coordinate of the top-left corner of the box.
244    * @param [in] width  The width of the box.
245    * @param [in] height The height of the box.
246    */
247   void SetClippingBox(int x, int y, int width, int height);
248
249   /**
250    * @brief Sets the clipping box of a layer, in window coordinates.
251    *
252    * The contents of the layer will not be visible outside this box, when clipping is
253    * enabled. The default clipping box is empty (0,0,0,0).
254    * @param [in] box The clipping box
255    */
256   void SetClippingBox(ClippingBox box);
257
258   /**
259    * @brief Retrieves the clipping box of a layer, in window coordinates.
260    *
261    * @return The clipping box
262    */
263   ClippingBox GetClippingBox() const;
264
265   // Depth test
266
267   /**
268    * @brief Whether to disable the depth test.
269    *
270    * By default a layer enables depth test if there is more than one opaque actor or if there is one opaque actor and one, or more, transparent actors.
271    * However, it's possible to disable the depth test by calling this method.
272    *
273    * @param[in] disable \e true disables depth test. \e false sets the default behaviour.
274    */
275   void SetDepthTestDisabled( bool disable );
276
277   /**
278    * @brief Retrieves whether depth test is disabled.
279    *
280    * @return \e true if depth test is disabled.
281    */
282   bool IsDepthTestDisabled() const;
283
284   // Sorting
285
286   /**
287    * @brief This sort function sorts translucent actors according to the Z-value in view space.
288    *
289    * This is useful for 2D user interfaces.
290    *
291    * This is the default sorting function.
292    *
293    * We return a negative z value as in our translation, a low z means that it should
294    * be sorted further away and a high z means that it should be closer.
295    * @param[in] position     position of actor in view space
296    * @param[in] sortModifier additional sort modifer
297    * @return depth
298    */
299   static float ZValue(const Vector3& position, float sortModifier);
300
301   /**
302    * @brief This allows the user to specify the sort function that the layer should use.
303    *
304    * The sort function is used to determine the order in which the actors are drawn
305    * and input is processed on the actors in the layer.
306    *
307    * A function of the following type should be used:
308    * @code
309    *  float YourSortFunction(const Vector3& position, float sortModifier);
310    * @endcode
311    *
312    * @note If the sort function returns a low number, the actor the data applies to will be
313    * drawn in front of an actor whose data yields a high value from the sort function.
314    *
315    * @note All child layers use the same sort function.  If a child layer is added to this
316    * layer then the sort function used by the child layer will also be the same.
317    *
318    * @param[in]  function  The sort function pointer
319   */
320   void SetSortFunction( SortFunctionType function );
321
322   /**
323    * @brief This allows the user to specify whether this layer should consume touch (including gestures).
324    *
325    * If set, any layers behind this layer will not be hit-test.
326    *
327    * @param[in]  consume  Whether the layer should consume touch (including gestures).
328    */
329   void SetTouchConsumed( bool consume );
330
331   /**
332    * @brief Retrieves whether the layer consumes touch (including gestures).
333    *
334    * @return true if consuming touch, false otherwise.
335    */
336   bool IsTouchConsumed() const;
337
338   /**
339    * @brief This allows the user to specify whether this layer should consume hover.
340    *
341    * If set, any layers behind this layer will not be hit-test.
342    *
343    * @param[in]  consume  Whether the layer should consume hover.
344    */
345   void SetHoverConsumed( bool consume );
346
347   /**
348    * @brief Retrieves whether the layer consumes hover.
349    *
350    * @return true if consuming hover, false otherwise.
351    */
352   bool IsHoverConsumed() const;
353
354 public: // Not intended for application developers
355
356   /**
357    * @brief This constructor is used by Dali New() methods.
358    *
359    * @param [in] Layer A pointer to a newly allocated Dali resource
360    */
361   explicit DALI_INTERNAL Layer(Internal::Layer* Layer);
362 };
363
364 } // namespace Dali
365
366 #endif //__DALI_LAYER_H__