1 #ifndef DALI_ACTOR_DEVEL_H
2 #define DALI_ACTOR_DEVEL_H
5 * Copyright (c) 2017 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/public-api/actors/actor.h>
35 PARENT_ORIGIN = Dali::Actor::Property::PARENT_ORIGIN,
36 PARENT_ORIGIN_X = Dali::Actor::Property::PARENT_ORIGIN_X,
37 PARENT_ORIGIN_Y = Dali::Actor::Property::PARENT_ORIGIN_Y,
38 PARENT_ORIGIN_Z = Dali::Actor::Property::PARENT_ORIGIN_Z,
39 ANCHOR_POINT = Dali::Actor::Property::ANCHOR_POINT,
40 ANCHOR_POINT_X = Dali::Actor::Property::ANCHOR_POINT_X,
41 ANCHOR_POINT_Y = Dali::Actor::Property::ANCHOR_POINT_Y,
42 ANCHOR_POINT_Z = Dali::Actor::Property::ANCHOR_POINT_Z,
43 SIZE = Dali::Actor::Property::SIZE,
44 SIZE_WIDTH = Dali::Actor::Property::SIZE_WIDTH,
45 SIZE_HEIGHT = Dali::Actor::Property::SIZE_HEIGHT,
46 SIZE_DEPTH = Dali::Actor::Property::SIZE_DEPTH,
47 POSITION = Dali::Actor::Property::POSITION,
48 POSITION_X = Dali::Actor::Property::POSITION_X,
49 POSITION_Y = Dali::Actor::Property::POSITION_Y,
50 POSITION_Z = Dali::Actor::Property::POSITION_Z,
51 WORLD_POSITION = Dali::Actor::Property::WORLD_POSITION,
52 WORLD_POSITION_X = Dali::Actor::Property::WORLD_POSITION_X,
53 WORLD_POSITION_Y = Dali::Actor::Property::WORLD_POSITION_Y,
54 WORLD_POSITION_Z = Dali::Actor::Property::WORLD_POSITION_Z,
55 ORIENTATION = Dali::Actor::Property::ORIENTATION,
56 WORLD_ORIENTATION = Dali::Actor::Property::WORLD_ORIENTATION,
57 SCALE = Dali::Actor::Property::SCALE,
58 SCALE_X = Dali::Actor::Property::SCALE_X,
59 SCALE_Y = Dali::Actor::Property::SCALE_Y,
60 SCALE_Z = Dali::Actor::Property::SCALE_Z,
61 WORLD_SCALE = Dali::Actor::Property::WORLD_SCALE,
62 VISIBLE = Dali::Actor::Property::VISIBLE,
63 COLOR = Dali::Actor::Property::COLOR,
64 COLOR_RED = Dali::Actor::Property::COLOR_RED,
65 COLOR_GREEN = Dali::Actor::Property::COLOR_GREEN,
66 COLOR_BLUE = Dali::Actor::Property::COLOR_BLUE,
67 COLOR_ALPHA = Dali::Actor::Property::COLOR_ALPHA,
68 WORLD_COLOR = Dali::Actor::Property::WORLD_COLOR,
69 WORLD_MATRIX = Dali::Actor::Property::WORLD_MATRIX,
70 NAME = Dali::Actor::Property::NAME,
71 SENSITIVE = Dali::Actor::Property::SENSITIVE,
72 LEAVE_REQUIRED = Dali::Actor::Property::LEAVE_REQUIRED,
73 INHERIT_ORIENTATION = Dali::Actor::Property::INHERIT_ORIENTATION,
74 INHERIT_SCALE = Dali::Actor::Property::INHERIT_SCALE,
75 COLOR_MODE = Dali::Actor::Property::COLOR_MODE,
76 POSITION_INHERITANCE = Dali::Actor::Property::POSITION_INHERITANCE,
77 DRAW_MODE = Dali::Actor::Property::DRAW_MODE,
78 SIZE_MODE_FACTOR = Dali::Actor::Property::SIZE_MODE_FACTOR,
79 WIDTH_RESIZE_POLICY = Dali::Actor::Property::WIDTH_RESIZE_POLICY,
80 HEIGHT_RESIZE_POLICY = Dali::Actor::Property::HEIGHT_RESIZE_POLICY,
81 SIZE_SCALE_POLICY = Dali::Actor::Property::SIZE_SCALE_POLICY,
82 WIDTH_FOR_HEIGHT = Dali::Actor::Property::WIDTH_FOR_HEIGHT,
83 HEIGHT_FOR_WIDTH = Dali::Actor::Property::HEIGHT_FOR_WIDTH,
84 PADDING = Dali::Actor::Property::PADDING,
85 MINIMUM_SIZE = Dali::Actor::Property::MINIMUM_SIZE,
86 MAXIMUM_SIZE = Dali::Actor::Property::MAXIMUM_SIZE,
87 INHERIT_POSITION = Dali::Actor::Property::INHERIT_POSITION,
88 CLIPPING_MODE = Dali::Actor::Property::CLIPPING_MODE,
91 * @brief Sets the sibling order of the actor so depth position can be defined within the same parent.
92 * @details Name "siblingOrder", type Property::INTEGER.
93 * @note The initial value is 0.
94 * @note Raise, Lower, RaiseToTop, LowerToBottom, RaiseAbove and LowerBelow will override the
95 * sibling order. The values set by this Property will likely change.
97 SIBLING_ORDER = CLIPPING_MODE + 1,
100 * @brief The opacity of the actor.
101 * @details Name "opacity", type Property::FLOAT.
103 OPACITY = CLIPPING_MODE + 2,
106 * @brief Returns the screen position of the Actor
107 * @details Name "screenPosition", type Property::VECTOR2. Read-only
108 * @note This assumes default camera and default render-task and the Z position is ZERO.
110 SCREEN_POSITION = CLIPPING_MODE + 3,
113 * @brief Determines whether the anchor point should be used to determine the position of the actor.
114 * @details Name "positionUsesAnchorPoint", type Property::BOOLEAN.
115 * @note This is true by default.
116 * @note If false, then the top-left of the actor is used for the position.
117 * @note Setting this to false will allow scaling or rotation around the anchor-point without affecting the actor's position.
119 POSITION_USES_ANCHOR_POINT = CLIPPING_MODE + 4,
122 * @brief The direction of layout.
123 * @details Name "layoutDirection", type Property::INTEGER, @see LayoutDirection::Type for supported values.
125 LAYOUT_DIRECTION = CLIPPING_MODE + 5,
128 * @brief Determines whether child actors inherit the layout direction from a parent.
129 * @details Name "layoutDirectionInheritance", type Property::BOOLEAN.
131 INHERIT_LAYOUT_DIRECTION = CLIPPING_MODE + 6
134 } // namespace Property
136 namespace VisibilityChange
141 SELF, ///< The visibility of the actor itself has changed.
142 PARENT ///< The visibility of a parent has changed.
145 } // namespace VisibilityChange
147 namespace LayoutDirection
152 LTR, ///< Layout direction is from Left to Right direction.
153 RTL ///< Layout direction is from Right to Left direction.
158 typedef Signal< void ( Actor, bool, VisibilityChange::Type ) > VisibilityChangedSignalType; ///< Signal type of VisibilityChangedSignalType
160 typedef Signal< void ( Actor, LayoutDirection::Type ) > LayoutDirectionChangedSignalType; ///< Signal type of LayoutDirectionChangedSignal
163 * @brief Raise actor above the next highest level of actor(s).
165 * @param[in] actor The Actor to raise
166 * @note Sibling order of actors within the parent will be updated automatically.
167 * Using this API means a limit of DevelLayer::SIBLING_ORDER_MULTIPLIER Actors.
168 * Initially actors added to a parent will have the same sibling order and shown in relation to insertion order.
169 * Raising this actor above actors with the same sibling order as each other will raise this actor above them.
170 * Once a raise or lower API is used that actor will then have an exclusive sibling order independent of insertion.
173 DALI_IMPORT_API void Raise( Actor actor );
176 * @brief Lower the actor to underneath the level below actor(s).
178 * @param[in] actor The Actor to lower
179 * @note Sibling order of actors within the parent will be updated automatically.
180 * Using this API means a limit of DevelLayer::SIBLING_ORDER_MULTIPLIER Actors.
181 * Lowering this actor below actors with the same sibling order as each other will lower this actor above them.
182 * Once a raise or lower API is used that actor will then have an exclusive sibling order independent of insertion.
184 DALI_IMPORT_API void Lower( Actor actor );
187 * @brief Raise actor above all other actors.
189 * @param[in] actor The Actor to raise to the top
190 * @note Sibling order of actors within the parent will be updated automatically.
191 * Using this API means a limit of DevelLayer::SIBLING_ORDER_MULTIPLIER Actors.
192 * Once a raise or lower API is used that actor will then have an exclusive sibling order independent of insertion.
194 DALI_IMPORT_API void RaiseToTop( Actor actor );
197 * @brief Lower actor to the bottom of all actors.
199 * @param[in] actor The Actor to lower to the bottom
200 * @note Sibling order of actors within the parent will be updated automatically.
201 * Using this API means a limit of DevelLayer::SIBLING_ORDER_MULTIPLIER Actors.
202 * Once a raise or lower API is used that actor will then have an exclusive sibling order independent of insertion.
204 DALI_IMPORT_API void LowerToBottom( Actor actor );
207 * @brief Raise the actor to above the target actor.
209 * @param[in] actor The actor to raise
210 * @param[in] target Will be raised above this actor
211 * @note Sibling order of actors within the parent will be updated automatically.
212 * Actors on the level above the target actor will still be shown above this actor.
213 * Raising this actor above actors with the same sibling order as each other will raise this actor above them.
214 * Using this API means a limit of DevelLayer::SIBLING_ORDER_MULTIPLIER Actors.
215 * Once a raise or lower API is used that actor will then have an exclusive sibling order independent of insertion.
217 DALI_IMPORT_API void RaiseAbove( Actor actor, Dali::Actor target );
220 * @brief Lower the actor to below the target actor.
222 * @param[in] actor The Actor to lower
223 * @param[in] target Will be lowered below this actor
224 * @note Sibling order of actors within the parent will be updated automatically.
225 * Using this API means a limit of DevelLayer::SIBLING_ORDER_MULTIPLIER Actors.
226 * Lowering this actor below actors with the same sibling order as each other will lower this actor above them.
227 * Once a raise or lower API is used that actor will then have an exclusive sibling order independent of insertion.
229 DALI_IMPORT_API void LowerBelow( Actor actor, Dali::Actor target );
232 * @brief This signal is emitted when the visible property of this or a parent actor is changed.
234 * A callback of the following type may be connected:
236 * void YourCallbackName( Actor actor, bool visible, VisibilityChange::Type& type );
238 * actor: The actor, or child of actor, whose visibility has changed
239 * visible: Whether the actor is now visible or not
240 * type: Whether the actor's visible property has changed or a parent's.
241 * @return The signal to connect to
242 * @pre The Actor has been initialized.
243 * @note This signal is NOT emitted if the actor becomes transparent (or the reverse), it's only linked with Actor::Property::VISIBLE.
245 DALI_IMPORT_API VisibilityChangedSignalType& VisibilityChangedSignal( Actor actor );
248 * @brief This signal is emitted when the layout direction property of this or a parent actor is changed.
250 * A callback of the following type may be connected:
252 * void YourCallbackName( Actor actor, LayoutDirection::Type type );
254 * actor: The actor, or child of actor, whose laytou direction has changed
255 * type: Whether the actor's layout direction property has changed or a parent's.
256 * @return The signal to connect to
257 * @pre The Actor has been initialized.
259 DALI_IMPORT_API LayoutDirectionChangedSignalType& LayoutDirectionChangedSignal( Actor actor );
261 } // namespace DevelActor
265 #endif // DALI_ACTOR_DEVEL_H