f1bb8c38b752f1afe2b4cd755e275a041cc158a5
[platform/core/uifw/dali-toolkit.git] / dali-toolkit / devel-api / controls / control-depth-index-ranges.h
1 #ifndef DALI_TOOLKIT_DEVEL_CONTROL_DEPTH_INDEX_RANGES_H
2 #define DALI_TOOLKIT_DEVEL_CONTROL_DEPTH_INDEX_RANGES_H
3
4 /*
5  * Copyright (c) 2020 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/devel-api/actors/layer-devel.h>
23
24 namespace Dali
25 {
26
27 namespace Toolkit
28 {
29
30 namespace DepthIndex
31 {
32
33 // The negative value for background effect and background has been
34 // chosen so that newer controls can have content without setting
35 // depth index, and go in front of native controls with a background.
36 // This backround negative value means that the highest possible value
37 // is SIBLING_ORDER_MULTIPLIER-BACKGROUND_EFFECT-1.  The divisor of
38 // 100 ensures the range fits within the sibling order range, and has
39 // enough gaps to allow Control Authors to use other intermediate depths.
40
41 enum Ranges
42 {
43   BACKGROUND_EFFECT = -2 * DevelLayer::SIBLING_ORDER_MULTIPLIER/100,
44   BACKGROUND    =     -1 * DevelLayer::SIBLING_ORDER_MULTIPLIER/100,
45   CONTENT       =      0,
46   DECORATION    =      1 * DevelLayer::SIBLING_ORDER_MULTIPLIER/100,
47   FOREGROUND_EFFECT =  2 * DevelLayer::SIBLING_ORDER_MULTIPLIER/100
48 };
49
50 static_assert( (unsigned int)DevelLayer::ACTOR_DEPTH_MULTIPLIER > (unsigned int)DevelLayer::SIBLING_ORDER_MULTIPLIER );
51 static_assert( BACKGROUND_EFFECT < BACKGROUND );
52 static_assert( BACKGROUND < CONTENT );
53 static_assert( CONTENT < DECORATION );
54 static_assert( DECORATION < FOREGROUND_EFFECT );
55
56 } // namespace DepthIndex
57
58 } // namespace Toolkit
59
60 } // namespace Dali
61
62 #endif // DALI_TOOLKIT_DEVEL_CONTROL_DEPTH_INDEX_RANGES_H