1 #ifndef DALI_ACTOR_DEVEL_H
2 #define DALI_ACTOR_DEVEL_H
5 * Copyright (c) 2018 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 DRAW_MODE = Dali::Actor::Property::DRAW_MODE,
77 SIZE_MODE_FACTOR = Dali::Actor::Property::SIZE_MODE_FACTOR,
78 WIDTH_RESIZE_POLICY = Dali::Actor::Property::WIDTH_RESIZE_POLICY,
79 HEIGHT_RESIZE_POLICY = Dali::Actor::Property::HEIGHT_RESIZE_POLICY,
80 SIZE_SCALE_POLICY = Dali::Actor::Property::SIZE_SCALE_POLICY,
81 WIDTH_FOR_HEIGHT = Dali::Actor::Property::WIDTH_FOR_HEIGHT,
82 HEIGHT_FOR_WIDTH = Dali::Actor::Property::HEIGHT_FOR_WIDTH,
83 PADDING = Dali::Actor::Property::PADDING,
84 MINIMUM_SIZE = Dali::Actor::Property::MINIMUM_SIZE,
85 MAXIMUM_SIZE = Dali::Actor::Property::MAXIMUM_SIZE,
86 INHERIT_POSITION = Dali::Actor::Property::INHERIT_POSITION,
87 CLIPPING_MODE = Dali::Actor::Property::CLIPPING_MODE,
88 LAYOUT_DIRECTION = Dali::Actor::Property::LAYOUT_DIRECTION,
89 INHERIT_LAYOUT_DIRECTION = Dali::Actor::Property::INHERIT_LAYOUT_DIRECTION,
92 * @brief Sets the sibling order of the actor so depth position can be defined within the same parent.
93 * @details Name "siblingOrder", type Property::INTEGER.
94 * @note The initial value is 0.
95 * @note Raise, Lower, RaiseToTop, LowerToBottom, RaiseAbove and LowerBelow will override the
96 * sibling order. The values set by this Property will likely change.
98 SIBLING_ORDER = INHERIT_LAYOUT_DIRECTION + 1,
101 * @brief The opacity of the actor.
102 * @details Name "opacity", type Property::FLOAT.
104 OPACITY = INHERIT_LAYOUT_DIRECTION + 2,
107 * @brief Returns the screen position of the Actor
108 * @details Name "screenPosition", type Property::VECTOR2. Read-only
109 * @note This assumes default camera and default render-task and the Z position is ZERO.
111 SCREEN_POSITION = INHERIT_LAYOUT_DIRECTION + 3,
114 * @brief Determines whether the anchor point should be used to determine the position of the actor.
115 * @details Name "positionUsesAnchorPoint", type Property::BOOLEAN.
116 * @note This is true by default.
117 * @note If false, then the top-left of the actor is used for the position.
118 * @note Setting this to false will allow scaling or rotation around the anchor-point without affecting the actor's position.
120 POSITION_USES_ANCHOR_POINT = INHERIT_LAYOUT_DIRECTION + 4,
123 * @brief Returns whether the actor is culled or not.
124 * @details Name "culled", type Property::BOOLEAN. Read-only
125 * @note True means that the actor is out of the view frustum.
127 CULLED = INHERIT_LAYOUT_DIRECTION + 5,
130 } // namespace Property
132 namespace VisibilityChange
137 SELF, ///< The visibility of the actor itself has changed.
138 PARENT ///< The visibility of a parent has changed.
141 } // namespace VisibilityChange
143 typedef Signal< void ( Actor, bool, VisibilityChange::Type ) > VisibilityChangedSignalType; ///< Signal type of VisibilityChangedSignalType
146 * @brief This signal is emitted when the visible property of this or a parent actor is changed.
148 * A callback of the following type may be connected:
150 * void YourCallbackName( Actor actor, bool visible, VisibilityChange::Type& type );
152 * actor: The actor, or child of actor, whose visibility has changed
153 * visible: Whether the actor is now visible or not
154 * type: Whether the actor's visible property has changed or a parent's.
155 * @return The signal to connect to
156 * @pre The Actor has been initialized.
157 * @note This signal is NOT emitted if the actor becomes transparent (or the reverse), it's only linked with Actor::Property::VISIBLE.
159 DALI_CORE_API VisibilityChangedSignalType& VisibilityChangedSignal( Actor actor );
162 typedef Signal< void (Actor) > ChildChangedSignalType; ///< Called when the actor has a child added or removed
165 * @brief This signal is emitted when a child is added to this actor.
167 * A callback of the following type may be connected:
169 * void MyCallbackName( Actor child );
171 * child: The child that has been added.
173 * @note Use this signal with caution. Changing the parent of the actor
174 * within this callback is possible, but DALi will prevent further signals
177 * @return The signal to connect to
178 * @pre The Actor has been initialized
180 DALI_CORE_API ChildChangedSignalType& ChildAddedSignal( Actor actor );
183 * @brief This signal is emitted when a child is removed from this actor.
185 * A callback of the following type may be connected:
187 * void MyCallbackName( Actor child );
189 * child: The child that has been removed.
191 * @note Use this signal with caution. Changing the parent of the actor
192 * within this callback is possible, but DALi will prevent further signals
195 * @note If the child actor is moved from one actor to another, then
196 * this signal will be emitted followed immediately by an
197 * ChildAddedSignal() on the new parent.
199 * @return The signal to connect to
200 * @pre The Actor has been initialized
202 DALI_CORE_API ChildChangedSignalType& ChildRemovedSignal( Actor actor );
205 typedef Signal< void (Actor) > ChildOrderChangedSignalType; ///< Used when the actor's children have changed order
208 * @brief This signal is emitted when an actor's children change their sibling order
210 * A callback of the following type may be connected:
212 * void MyCallbackName( Actor parent );
214 * parent The parent actor of the moved children
216 * @return The signal to connect to
217 * @pre The Actor has been initialized
219 DALI_CORE_API ChildOrderChangedSignalType& ChildOrderChangedSignal( Actor actor );
223 } // namespace DevelActor
227 #endif // DALI_ACTOR_DEVEL_H