1 #ifndef __DALI_ACTOR_H__
2 #define __DALI_ACTOR_H__
5 * Copyright (c) 2015 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.
25 #include <dali/public-api/actors/actor-enumerations.h>
26 #include <dali/public-api/actors/draw-mode.h>
27 #include <dali/public-api/math/radian.h>
28 #include <dali/public-api/object/handle.h>
29 #include <dali/public-api/object/property-index-ranges.h>
30 #include <dali/public-api/signals/dali-signal.h>
34 * @addtogroup dali_core_actors
38 namespace Internal DALI_INTERNAL
57 typedef Rect<float> Padding; ///< Padding definition @SINCE_1_0.0
60 * @brief Actor is the primary object with which Dali applications interact.
62 * UI controls can be built by combining multiple actors.
64 * <h3>Multi-Touch Events:</h3>
66 * Touch or hover events are received via signals; see Actor::TouchedSignal() and Actor::HoveredSignal() for more details.
68 * <i>Hit Testing Rules Summary:</i>
70 * - An actor is only hittable if the actor's touch or hover signal has a connection.
71 * - An actor is only hittable when it is between the camera's near and far planes.
72 * - If an actor is made insensitive, then the actor and its children are not hittable; see IsSensitive()
73 * - If an actor's visibility flag is unset, then none of its children are hittable either; see IsVisible()
74 * - To be hittable, an actor must have a non-zero size.
75 * - If an actor's world color is fully transparent, then it is not hittable; see GetCurrentWorldColor()
77 * <i>Hit Test Algorithm:</i>
80 * - Gets the first down and the last up touch events to the screen, regardless of actor touch event consumption.
81 * - Stage's root layer can be used to catch unconsumed touch events.
84 * - Hit testing is dependent on the camera used, which is specific to each RenderTask.
87 * - For each RenderTask, hit testing starts from the top-most layer and we go through all the
88 * layers until we have a hit or there are none left.
89 * - Before we perform a hit test within a layer, we check if all the layer's parents are visible
91 * - If they are not, we skip hit testing the actors in that layer altogether.
92 * - If a layer is set to consume all touch, then we do not check any layers behind this layer.
95 * - The final part of hit testing is performed by walking through the actor tree within a layer.
96 * - The following pseudocode shows the algorithm used:
98 * HIT-TEST-WITHIN-LAYER( ACTOR )
100 * // Only hit-test the actor and its children if it is sensitive and visible
101 * IF ( ACTOR-IS-SENSITIVE &&
102 * ACTOR-IS-VISIBLE &&
103 * ACTOR-IS-ON-STAGE )
105 * // Depth-first traversal within current layer, visiting parent first
107 * // Check whether current actor should be hit-tested.
108 * IF ( ( TOUCH-SIGNAL-NOT-EMPTY || HOVER-SIGNAL-NOT-EMPTY ) &&
109 * ACTOR-HAS-NON-ZERO-SIZE &&
110 * ACTOR-WORLD-COLOR-IS-NOT-TRANSPARENT )
112 * // Hit-test current actor
115 * IF ( ACTOR-IS-OVERLAY || ( DISTANCE-TO-ACTOR < DISTANCE-TO-LAST-HIT-ACTOR ) )
117 * // The current actor is the closest actor that was underneath the touch.
118 * LAST-HIT-ACTOR = CURRENT-ACTOR
123 * // Keep checking children, in case we hit something closer.
124 * FOR-EACH CHILD (in order)
126 * IF ( CHILD-IS-NOT-A-LAYER )
128 * // Continue traversal for this child's sub-tree
129 * HIT-TEST-WITHIN-LAYER ( CHILD )
131 * // else we skip hit-testing the child's sub-tree altogether.
136 * - Overlays always take priority (i.e. they're considered closer) regardless of distance.
137 * The overlay children take priority over their parents, and overlay siblings take priority
138 * over their previous siblings (i.e. reverse of rendering order):
148 * Hit Priority of above Actor tree (all overlays): 1 - Lowest. 6 - Highest.
150 * For more information, see SetDrawMode().
152 * <i>Touch or hover Event Delivery:</i>
155 * - The hit actor's touch or hover signal is emitted first; if it is not consumed by any of the listeners,
156 * the parent's touch or hover signal is emitted, and so on.
157 * - The following pseudocode shows the delivery mechanism:
159 * EMIT-TOUCH-SIGNAL( ACTOR )
161 * IF ( TOUCH-SIGNAL-NOT-EMPTY )
163 * // Only do the emission if touch signal of actor has connections.
164 * CONSUMED = TOUCHED-SIGNAL( TOUCH-EVENT )
167 * IF ( NOT-CONSUMED )
169 * // If event is not consumed then deliver it to the parent unless we reach the root actor
170 * IF ( ACTOR-PARENT )
172 * EMIT-TOUCH-SIGNAL( ACTOR-PARENT )
177 * EMIT-HOVER-SIGNAL( ACTOR )
179 * IF ( HOVER-SIGNAL-NOT-EMPTY )
181 * // Only do the emission if hover signal of actor has connections.
182 * CONSUMED = HOVERED-SIGNAL( HOVER-EVENT )
185 * IF ( NOT-CONSUMED )
187 * // If event is not consumed then deliver it to the parent unless we reach the root actor.
188 * IF ( ACTOR-PARENT )
190 * EMIT-HOVER-SIGNAL( ACTOR-PARENT )
195 * - If there are several touch points, then the delivery is only to the first touch point's hit
196 * actor (and its parents). There will be NO touch or hover signal delivery for the hit actors of the
197 * other touch points.
198 * - The local coordinates are from the top-left (0.0f, 0.0f, 0.5f) of the hit actor.
201 * - A "Leave" state is set when the first point exits the bounds of the previous first point's
202 * hit actor (primary hit actor).
203 * - When this happens, the last primary hit actor's touch or hover signal is emitted with a "Leave" state
204 * (only if it requires leave signals); see SetLeaveRequired().
206 * - Interrupted State
207 * - If a system event occurs which interrupts the touch or hover processing, then the last primary hit
208 * actor's touch or hover signals are emitted with an "Interrupted" state.
209 * - If the last primary hit actor, or one of its parents, is no longer touchable or hoverable, then its
210 * touch or hover signals are also emitted with an "Interrupted" state.
211 * - If the consumed actor on touch-down is not the same as the consumed actor on touch-up, then
212 * touch signals are also emitted from the touch-down actor with an "Interrupted" state.
213 * - If the consumed actor on hover-start is not the same as the consumed actor on hover-finished, then
214 * hover signals are also emitted from the hover-started actor with an "Interrupted" state.
216 * <h3>Key Events:</h3>
218 * Key events are received by an actor once set to grab key events, only one actor can be set as focused.
223 * | %Signal Name | Method |
224 * |-------------------|------------------------------|
225 * | touched | @ref TouchedSignal() |
226 * | hovered | @ref HoveredSignal() |
227 * | wheelEvent | @ref WheelEventSignal() |
228 * | onStage | @ref OnStageSignal() |
229 * | offStage | @ref OffStageSignal() |
230 * | onRelayout | @ref OnRelayoutSignal() |
233 * | %Action Name | %Actor method called |
234 * |-------------------|------------------------------|
235 * | show | %SetVisible( true ) |
236 * | hide | %SetVisible( false ) |
240 class DALI_IMPORT_API Actor : public Handle
245 * @brief An enumeration of properties belonging to the Actor class.
252 PARENT_ORIGIN = DEFAULT_ACTOR_PROPERTY_START_INDEX, ///< name "parentOrigin", type Vector3 (constraint-input) @SINCE_1_0.0
253 PARENT_ORIGIN_X, ///< name "parentOriginX", type float (constraint-input) @SINCE_1_0.0
254 PARENT_ORIGIN_Y, ///< name "parentOriginY", type float (constraint-input) @SINCE_1_0.0
255 PARENT_ORIGIN_Z, ///< name "parentOriginZ", type float (constraint-input) @SINCE_1_0.0
256 ANCHOR_POINT, ///< name "anchorPoint", type Vector3 (constraint-input) @SINCE_1_0.0
257 ANCHOR_POINT_X, ///< name "anchorPointX", type float (constraint-input) @SINCE_1_0.0
258 ANCHOR_POINT_Y, ///< name "anchorPointY", type float (constraint-input) @SINCE_1_0.0
259 ANCHOR_POINT_Z, ///< name "anchorPointZ", type float (constraint-input) @SINCE_1_0.0
260 SIZE, ///< name "size", type Vector3 (animatable / constraint-input) @SINCE_1_0.0
261 SIZE_WIDTH, ///< name "sizeWidth", type float (animatable / constraint-input) @SINCE_1_0.0
262 SIZE_HEIGHT, ///< name "sizeHeight", type float (animatable / constraint-input) @SINCE_1_0.0
263 SIZE_DEPTH, ///< name "sizeDepth", type float (animatable / constraint-input) @SINCE_1_0.0
264 POSITION, ///< name "position", type Vector3 (animatable / constraint-input) @SINCE_1_0.0
265 POSITION_X, ///< name "positionX", type float (animatable / constraint-input) @SINCE_1_0.0
266 POSITION_Y, ///< name "positionY", type float (animatable / constraint-input) @SINCE_1_0.0
267 POSITION_Z, ///< name "positionZ", type float (animatable / constraint-input) @SINCE_1_0.0
268 WORLD_POSITION, ///< name "worldPosition", type Vector3 (read-only / constraint-input) @SINCE_1_0.0
269 WORLD_POSITION_X, ///< name "worldPositionX", type float (read-only / constraint-input) @SINCE_1_0.0
270 WORLD_POSITION_Y, ///< name "worldPositionY", type float (read-only / constraint-input) @SINCE_1_0.0
271 WORLD_POSITION_Z, ///< name "worldPositionZ", type float (read-only / constraint-input) @SINCE_1_0.0
272 ORIENTATION, ///< name "orientation", type Quaternion (animatable / constraint-input) @SINCE_1_0.0
273 WORLD_ORIENTATION, ///< name "worldOrientation", type Quaternion (read-only / constraint-input) @SINCE_1_0.0
274 SCALE, ///< name "scale", type Vector3 (animatable / constraint-input) @SINCE_1_0.0
275 SCALE_X, ///< name "scaleX", type float (animatable / constraint-input) @SINCE_1_0.0
276 SCALE_Y, ///< name "scaleY", type float (animatable / constraint-input) @SINCE_1_0.0
277 SCALE_Z, ///< name "scaleZ", type float (animatable / constraint-input) @SINCE_1_0.0
278 WORLD_SCALE, ///< name "worldScale", type Vector3 (read-only / constraint-input) @SINCE_1_0.0
279 VISIBLE, ///< name "visible", type bool (animatable / constraint-input) @SINCE_1_0.0
280 COLOR, ///< name "color", type Vector4 (animatable / constraint-input) @SINCE_1_0.0
281 COLOR_RED, ///< name "colorRed", type float (animatable / constraint-input) @SINCE_1_0.0
282 COLOR_GREEN, ///< name "colorGreen", type float (animatable / constraint-input) @SINCE_1_0.0
283 COLOR_BLUE, ///< name "colorBlue", type float (animatable / constraint-input) @SINCE_1_0.0
284 COLOR_ALPHA, ///< name "colorAlpha", type float (animatable / constraint-input) @SINCE_1_0.0
285 WORLD_COLOR, ///< name "worldColor", type Vector4 (read-only / constraint-input) @SINCE_1_0.0
286 WORLD_MATRIX, ///< name "worldMatrix", type Matrix (read-only / constraint-input) @SINCE_1_0.0
287 NAME, ///< name "name", type std::string @SINCE_1_0.0
288 SENSITIVE, ///< name "sensitive", type bool @SINCE_1_0.0
289 LEAVE_REQUIRED, ///< name "leaveRequired", type bool @SINCE_1_0.0
290 INHERIT_ORIENTATION, ///< name "inheritOrientation", type bool @SINCE_1_0.0
291 INHERIT_SCALE, ///< name "inheritScale", type bool @SINCE_1_0.0
292 COLOR_MODE, ///< name "colorMode", type std::string @SINCE_1_0.0
293 POSITION_INHERITANCE, ///< name "positionInheritance", type std::string @DEPRECATED_1_1.24 Use INHERIT_POSITION instead
294 DRAW_MODE, ///< name "drawMode", type std::string @SINCE_1_0.0
295 SIZE_MODE_FACTOR, ///< name "sizeModeFactor", type Vector3 @SINCE_1_0.0
296 WIDTH_RESIZE_POLICY, ///< name "widthResizePolicy", type String @SINCE_1_0.0
297 HEIGHT_RESIZE_POLICY, ///< name "heightResizePolicy", type String @SINCE_1_0.0
298 SIZE_SCALE_POLICY, ///< name "sizeScalePolicy", type String @SINCE_1_0.0
299 WIDTH_FOR_HEIGHT, ///< name "widthForHeight", type Boolean @SINCE_1_0.0
300 HEIGHT_FOR_WIDTH, ///< name "heightForWidth", type Boolean @SINCE_1_0.0
301 PADDING, ///< name "padding", type Vector4 @SINCE_1_0.0
302 MINIMUM_SIZE, ///< name "minimumSize", type Vector2 @SINCE_1_0.0
303 MAXIMUM_SIZE, ///< name "maximumSize", type Vector2 @SINCE_1_0.0
304 INHERIT_POSITION, ///< name "inheritPosition", type bool @SINCE_1_1.24
305 BATCH_PARENT, ///< name "batchParent", type bool @SINCE_1_2.0
311 typedef Signal< bool (Actor, const TouchEvent&) > TouchSignalType; ///< @DEPRECATED_1_1.37 @brief Touch signal type @SINCE_1_0.0
312 typedef Signal< bool (Actor, const TouchData&) > TouchDataSignalType; ///< Touch signal type @SINCE_1_1.37
313 typedef Signal< bool (Actor, const HoverEvent&) > HoverSignalType; ///< Hover signal type @SINCE_1_0.0
314 typedef Signal< bool (Actor, const WheelEvent&) > WheelEventSignalType; ///< Wheel signal type @SINCE_1_0.0
315 typedef Signal< void (Actor) > OnStageSignalType; ///< Stage connection signal type @SINCE_1_0.0
316 typedef Signal< void (Actor) > OffStageSignalType; ///< Stage disconnection signal type @SINCE_1_0.0
317 typedef Signal< void (Actor) > OnRelayoutSignalType; ///< Called when the actor is relaid out @SINCE_1_0.0
322 * @brief Create an uninitialized Actor; this can be initialized with Actor::New().
324 * Calling member functions with an uninitialized Actor handle is not allowed.
330 * @brief Create an initialized Actor.
333 * @return A handle to a newly allocated Dali resource.
338 * @brief Downcast a handle to Actor handle.
340 * If handle points to a Actor object the downcast produces valid
341 * handle. If not the returned handle is left uninitialized.
344 * @param[in] handle to An object
345 * @return handle to a Actor object or an uninitialized handle
347 static Actor DownCast( BaseHandle handle );
350 * @brief Dali::Actor is intended as a base class
352 * This is non-virtual since derived Handle types must not contain data or virtual methods.
358 * @brief Copy constructor
361 * @param [in] copy The actor to copy.
363 Actor(const Actor& copy);
366 * @brief Assignment operator
369 * @param [in] rhs The actor to copy.
370 * @return A reference to this
372 Actor& operator=(const Actor& rhs);
375 * @brief Retrieve the Actor's name.
378 * @return The Actor's name.
379 * @pre The Actor has been initialized.
381 const std::string& GetName() const;
384 * @brief Sets the Actor's name.
387 * @param [in] name The new name.
388 * @pre The Actor has been initialized.
390 void SetName(const std::string& name);
393 * @brief Retrieve the unique ID of the actor.
397 * @pre The Actor has been initialized.
399 unsigned int GetId() const;
404 * @brief Query whether an actor is the root actor, which is owned by the Stage.
407 * @return True if the actor is the root actor.
408 * @pre The Actor has been initialized.
413 * @brief Query whether the actor is connected to the Stage.
415 * When an actor is connected, it will be directly or indirectly parented to the root Actor.
417 * @return True if the actor is connected to the Stage.
418 * @pre The Actor has been initialized.
419 * @note The root Actor is provided automatically by Dali::Stage, and is always considered to be connected.
421 bool OnStage() const;
424 * @brief Query whether the actor is of class Dali::Layer.
427 * @return True if the actor is a layer.
428 * @pre The Actor has been initialized.
430 bool IsLayer() const;
433 * @brief Gets the layer in which the actor is present.
436 * @return The layer, which will be uninitialized if the actor is off-stage.
437 * @pre The Actor has been initialized.
442 * @brief Adds a child Actor to this Actor.
445 * @param [in] child The child.
446 * @pre This Actor (the parent) has been initialized.
447 * @pre The child actor has been initialized.
448 * @pre The child actor is not the same as the parent actor.
449 * @pre The actor is not the Root actor.
450 * @post The child will be referenced by its parent. This means that the child will be kept alive,
451 * even if the handle passed into this method is reset or destroyed.
452 * @note if the child already has a parent, it will be removed from old parent
453 * and reparented to this actor. This may change childs position, color,
454 * scale etc as it now inherits them from this actor.
456 void Add(Actor child);
459 * @brief Removes a child Actor from this Actor.
461 * If the actor was not a child of this actor, this is a no-op.
463 * @param [in] child The child.
464 * @pre This Actor (the parent) has been initialized.
465 * @pre The child actor is not the same as the parent actor.
467 void Remove(Actor child);
470 * @brief Removes an actor from its parent.
472 * If the actor has no parent, this method does nothing.
474 * @pre The (child) actor has been initialized.
479 * @brief Retrieve the number of children held by the actor.
482 * @return The number of children
483 * @pre The Actor has been initialized.
485 unsigned int GetChildCount() const;
488 * @brief Retrieve and child actor by index.
491 * @param[in] index The index of the child to retrieve
492 * @return The actor for the given index or empty handle if children not initialised
493 * @pre The Actor has been initialized.
495 Actor GetChildAt(unsigned int index) const;
498 * @brief Search through this actor's hierarchy for an actor with the given name.
500 * The actor itself is also considered in the search.
502 * @param[in] actorName the name of the actor to find
503 * @return A handle to the actor if found, or an empty handle if not.
504 * @pre The Actor has been initialized.
506 Actor FindChildByName(const std::string& actorName);
509 * @brief Search through this actor's hierarchy for an actor with the given unique ID.
511 * The actor itself is also considered in the search.
513 * @param[in] id the ID of the actor to find
514 * @return A handle to the actor if found, or an empty handle if not.
515 * @pre The Actor has been initialized.
517 Actor FindChildById(const unsigned int id);
520 * @brief Retrieve the actor's parent.
523 * @return A handle to the actor's parent. If the actor has no parent, this handle will be invalid.
524 * @pre The actor has been initialized.
526 Actor GetParent() const;
531 * @brief Set the origin of an actor, within its parent's area.
533 * This is expressed in unit coordinates, such that (0.0, 0.0, 0.5) is the top-left corner of the parent,
534 * and (1.0, 1.0, 0.5) is the bottom-right corner.
535 * The default parent-origin is Dali::ParentOrigin::TOP_LEFT (0.0, 0.0, 0.5).
536 * An actor position is the distance between this origin, and the actors anchor-point.
538 * @param [in] origin The new parent-origin.
539 * @pre The Actor has been initialized.
540 * @note This is an asynchronous method; the value written may not match a value subsequently read with GetCurrentParentOrigin().
541 * @see Dali::ParentOrigin for predefined parent origin values
543 void SetParentOrigin(const Vector3& origin);
546 * @brief Retrieve the parent-origin of an actor.
549 * @return The current parent-origin.
550 * @pre The Actor has been initialized.
551 * @note This property can be animated; the return value may not match the value written with SetParentOrigin().
553 Vector3 GetCurrentParentOrigin() const;
556 * @brief Set the anchor-point of an actor.
558 * This is expressed in unit coordinates, such that (0.0, 0.0, 0.5)
559 * is the top-left corner of the actor, and (1.0, 1.0, 0.5) is the
560 * bottom-right corner. The default anchor point is
561 * Dali::AnchorPoint::CENTER (0.5, 0.5, 0.5).
562 * An actor position is the distance between its parent-origin, and this anchor-point.
563 * An actor's orientation is the rotation from its default orientation, the rotation is centered around its anchor-point.
565 * @param [in] anchorPoint The new anchor-point.
566 * @pre The Actor has been initialized.
567 * @note This is an asynchronous method; the value written may not match a value subsequently read with GetCurrentAnchorPoint().
568 * @see Dali::AnchorPoint for predefined anchor point values
570 void SetAnchorPoint(const Vector3& anchorPoint);
573 * @brief Retrieve the anchor-point of an actor.
576 * @return The current anchor-point.
577 * @pre The Actor has been initialized.
578 * @note This property can be animated; the return value may not match the value written with SetAnchorPoint().
580 Vector3 GetCurrentAnchorPoint() const;
583 * @brief Sets the size of an actor.
585 * Geometry can be scaled to fit within this area.
586 * This does not interfere with the actors scale factor.
587 * The actors default depth is the minimum of width & height.
589 * @param [in] width The new width.
590 * @param [in] height The new height.
591 * @pre The actor has been initialized.
592 * @note This is an asynchronous method; the value written may not match a value subsequently read with GetCurrentSize().
594 void SetSize(float width, float height);
597 * @brief Sets the size of an actor.
599 * Geometry can be scaled to fit within this area.
600 * This does not interfere with the actors scale factor.
602 * @param [in] width The size of the actor along the x-axis.
603 * @param [in] height The size of the actor along the y-axis.
604 * @param [in] depth The size of the actor along the z-axis.
605 * @pre The actor has been initialized.
606 * @note This is an asynchronous method; the value written may not match a value subsequently read with GetCurrentSize().
608 void SetSize(float width, float height, float depth);
611 * @brief Sets the size of an actor.
613 * Geometry can be scaled to fit within this area.
614 * This does not interfere with the actors scale factor.
615 * The actors default depth is the minimum of width & height.
617 * @param [in] size The new size.
618 * @pre The actor has been initialized.
619 * @note This is an asynchronous method; the value written may not match a value subsequently read with GetCurrentSize().
621 void SetSize(const Vector2& size);
624 * @brief Sets the size of an actor.
626 * Geometry can be scaled to fit within this area.
627 * This does not interfere with the actors scale factor.
629 * @param [in] size The new size.
630 * @pre The actor has been initialized.
631 * @note This is an asynchronous method; the value written may not match a value subsequently read with GetCurrentSize().
633 void SetSize(const Vector3& size);
636 * @brief Retrieve the actor's size.
639 * @return The actor's target size.
640 * @pre The actor has been initialized.
641 * @note This return is the value that was set using SetSize or the target size of an animation.
643 Vector3 GetTargetSize() const;
646 * @brief Retrieve the actor's size.
649 * @return The actor's current size.
650 * @pre The actor has been initialized.
651 * @note This property can be animated; the return value may not match the value written with SetSize().
653 Vector3 GetCurrentSize() const;
656 * @brief Return the natural size of the actor.
658 * Deriving classes stipulate the natural size and by default an actor has a ZERO natural size.
661 * @return The actor's natural size
663 Vector3 GetNaturalSize() const;
666 * @brief Sets the position of the actor.
668 * The Actor's z position will be set to 0.0f.
670 * @param [in] x The new x position
671 * @param [in] y The new y position
672 * @pre The Actor has been initialized.
673 * @note This is an asynchronous method; the value written may not match a value subsequently read with GetCurrentPosition().
675 void SetPosition(float x, float y);
678 * @brief Sets the position of the Actor.
681 * @param [in] x The new x position
682 * @param [in] y The new y position
683 * @param [in] z The new z position
684 * @pre The Actor has been initialized.
685 * @note This is an asynchronous method; the value written may not match a value subsequently read with GetCurrentPosition().
687 void SetPosition(float x, float y, float z);
690 * @brief Sets the position of the Actor.
693 * @param [in] position The new position
694 * @pre The Actor has been initialized.
695 * @note This is an asynchronous method; the value written may not match a value subsequently read with GetCurrentPosition().
697 void SetPosition(const Vector3& position);
700 * @brief Set the position of an actor along the X-axis.
703 * @param [in] x The new x position
704 * @pre The Actor has been initialized.
705 * @note This is an asynchronous method; the value written may not match a value subsequently read with GetCurrentPosition().
710 * @brief Set the position of an actor along the Y-axis.
713 * @param [in] y The new y position.
714 * @pre The Actor has been initialized.
715 * @note This is an asynchronous method; the value written may not match a value subsequently read with GetCurrentPosition().
720 * @brief Set the position of an actor along the Z-axis.
723 * @param [in] z The new z position
724 * @pre The Actor has been initialized.
725 * @note This is an asynchronous method; the value written may not match a value subsequently read with GetCurrentPosition().
730 * @brief Translate an actor relative to its existing position.
733 * @param[in] distance The actor will move by this distance.
734 * @pre The actor has been initialized.
736 void TranslateBy(const Vector3& distance);
739 * @brief Retrieve the position of the Actor.
742 * @return the Actor's current position.
743 * @pre The Actor has been initialized.
744 * @note This property can be animated; the return value may not match the value written with SetPosition().
746 Vector3 GetCurrentPosition() const;
749 * @brief Retrieve the world-position of the Actor.
752 * @return The Actor's current position in world coordinates.
753 * @pre The Actor has been initialized.
754 * @note The actor will not have a world-position, unless it has previously been added to the stage.
756 Vector3 GetCurrentWorldPosition() const;
759 * @DEPRECATED_1_1.24 Use SetInheritPosition instead
760 * @brief Set the actors position inheritance mode.
762 * The default is to inherit.
763 * Switching this off means that using SetPosition() sets the actor's world position.
765 * @param[in] mode to use
766 * @pre The Actor has been initialized.
767 * @see PositionInheritanceMode
769 void SetPositionInheritanceMode( PositionInheritanceMode mode );
772 * @brief Set whether a child actor inherits it's parent's position.
774 * Default is to inherit.
775 * Switching this off means that using SetPosition() sets the actor's world position3
777 * @param[in] inherit - true if the actor should inherit position, false otherwise.
778 * @pre The Actor has been initialized.
780 inline void SetInheritPosition( bool inherit )
782 SetProperty(Property::INHERIT_POSITION, inherit );
786 * @DEPRECATED_1_1.24 Use IsPositionInherited
787 * @brief Returns the actors position inheritance mode.
790 * @return Return the position inheritance mode.
791 * @pre The Actor has been initialized.
793 PositionInheritanceMode GetPositionInheritanceMode() const;
796 * @brief Returns whether the actor inherits its parent's position.
799 * @return True if the actor inherits its parent position, false if it uses world position.
800 * @pre The Actor has been initialized.
802 inline bool IsPositionInherited() const
804 return GetProperty(Property::INHERIT_POSITION ).Get<bool>();
808 * @brief Sets the orientation of the Actor.
810 * An actor's orientation is the rotation from its default orientation, and the rotation is centered around its anchor-point.
812 * @param [in] angle The new orientation angle in degrees.
813 * @param [in] axis The new axis of orientation.
814 * @pre The Actor has been initialized.
815 * @note This is an asynchronous method; the value written may not match a value subsequently read with GetCurrentOrientation().
817 void SetOrientation( const Degree& angle, const Vector3& axis )
819 SetOrientation( Radian( angle ), axis );
823 * @brief Sets the orientation of the Actor.
825 * An actor's orientation is the rotation from its default orientation, and the rotation is centered around its anchor-point.
827 * @param [in] angle The new orientation angle in radians.
828 * @param [in] axis The new axis of orientation.
829 * @pre The Actor has been initialized.
830 * @note This is an asynchronous method; the value written may not match a value subsequently read with GetCurrentOrientation().
832 void SetOrientation(const Radian& angle, const Vector3& axis);
835 * @brief Sets the orientation of the Actor.
837 * An actor's orientation is the rotation from its default orientation, and the rotation is centered around its anchor-point.
839 * @param [in] orientation The new orientation.
840 * @pre The Actor has been initialized.
841 * @note This is an asynchronous method; the value written may not match a value subsequently read with GetCurrentOrientation().
843 void SetOrientation(const Quaternion& orientation);
846 * @brief Apply a relative rotation to an actor.
849 * @param[in] angle The angle to the rotation to combine with the existing orientation.
850 * @param[in] axis The axis of the rotation to combine with the existing orientation.
851 * @pre The actor has been initialized.
853 void RotateBy( const Degree& angle, const Vector3& axis )
855 RotateBy( Radian( angle ), axis );
859 * @brief Apply a relative rotation to an actor.
862 * @param[in] angle The angle to the rotation to combine with the existing orientation.
863 * @param[in] axis The axis of the rotation to combine with the existing orientation.
864 * @pre The actor has been initialized.
866 void RotateBy(const Radian& angle, const Vector3& axis);
869 * @brief Apply a relative rotation to an actor.
872 * @param[in] relativeRotation The rotation to combine with the existing orientation.
873 * @pre The actor has been initialized.
875 void RotateBy(const Quaternion& relativeRotation);
878 * @brief Retreive the Actor's orientation.
881 * @return The current orientation.
882 * @pre The Actor has been initialized.
883 * @note This property can be animated; the return value may not match the value written with SetOrientation().
885 Quaternion GetCurrentOrientation() const;
888 * @brief Set whether a child actor inherits it's parent's orientation.
890 * Default is to inherit.
891 * Switching this off means that using SetOrientation() sets the actor's world orientation.
893 * @param[in] inherit - true if the actor should inherit orientation, false otherwise.
894 * @pre The Actor has been initialized.
896 void SetInheritOrientation(bool inherit);
899 * @brief Returns whether the actor inherits its parent's orientation.
902 * @return True if the actor inherits its parent orientation, false if it uses world orientation.
903 * @pre The Actor has been initialized.
905 bool IsOrientationInherited() const;
908 * @brief Retrieve the world-orientation of the Actor.
911 * @return The Actor's current orientation in the world.
912 * @pre The Actor has been initialized.
913 * @note The actor will not have a world-orientation, unless it has previously been added to the stage.
915 Quaternion GetCurrentWorldOrientation() const;
918 * @brief Set the scale factor applied to an actor.
921 * @param [in] scale The scale factor applied on all axes.
922 * @pre The Actor has been initialized.
923 * @note This is an asynchronous method; the value written may not match a value subsequently read with GetCurrentScale().
925 void SetScale(float scale);
928 * @brief Set the scale factor applied to an actor.
931 * @param [in] scaleX The scale factor applied along the x-axis.
932 * @param [in] scaleY The scale factor applied along the y-axis.
933 * @param [in] scaleZ The scale factor applied along the z-axis.
934 * @pre The Actor has been initialized.
935 * @note This is an asynchronous method; the value written may not match a value subsequently read with GetCurrentScale().
937 void SetScale(float scaleX, float scaleY, float scaleZ);
940 * @brief Set the scale factor applied to an actor.
943 * @param [in] scale A vector representing the scale factor for each axis.
944 * @pre The Actor has been initialized.
945 * @note This is an asynchronous method; the value written may not match a value subsequently read with GetCurrentScale().
947 void SetScale(const Vector3& scale);
950 * @brief Apply a relative scale to an actor.
953 * @param[in] relativeScale The scale to combine with the actor's existing scale.
954 * @pre The actor has been initialized.
956 void ScaleBy(const Vector3& relativeScale);
959 * @brief Retrieve the scale factor applied to an actor.
962 * @return A vector representing the scale factor for each axis.
963 * @pre The Actor has been initialized.
964 * @note This property can be animated; the return value may not match the value written with SetScale().
966 Vector3 GetCurrentScale() const;
969 * @brief Retrieve the world-scale of the Actor.
972 * @return The Actor's current scale in the world.
973 * @pre The Actor has been initialized.
974 * @note The actor will not have a world-scale, unless it has previously been added to the stage.
976 Vector3 GetCurrentWorldScale() const;
979 * @brief Set whether a child actor inherits it's parent's scale.
981 * Default is to inherit.
982 * Switching this off means that using SetScale() sets the actor's world scale.
984 * @param[in] inherit - true if the actor should inherit scale, false otherwise.
985 * @pre The Actor has been initialized.
987 void SetInheritScale( bool inherit );
990 * @brief Returns whether the actor inherits its parent's scale.
993 * @return True if the actor inherits its parent scale, false if it uses world scale.
994 * @pre The Actor has been initialized.
996 bool IsScaleInherited() const;
999 * @brief Retrieves the world-matrix of the actor.
1002 * @return The Actor's current world matrix
1003 * @pre The Actor has been initialized.
1004 * @note The actor will not have a world-matrix, unless it has previously been added to the stage.
1006 Matrix GetCurrentWorldMatrix() const;
1008 // Visibility & Color
1011 * @brief Sets the visibility flag of an actor.
1014 * @param [in] visible The new visibility flag.
1015 * @pre The actor has been initialized.
1016 * @note This is an asynchronous method; the value written may not match a value subsequently read with IsVisible().
1017 * @note If an actor's visibility flag is set to false, then the actor and its children will not be rendered.
1018 * This is regardless of the individual visibility values of the children i.e. an actor will only be
1019 * rendered if all of its parents have visibility set to true.
1021 void SetVisible(bool visible);
1024 * @brief Retrieve the visibility flag of an actor.
1027 * @return The visibility flag.
1028 * @pre The actor has been initialized.
1029 * @note This property can be animated; the return value may not match the value written with SetVisible().
1030 * @note If an actor is not visible, then the actor and its children will not be rendered.
1031 * This is regardless of the individual visibility values of the children i.e. an actor will only be
1032 * rendered if all of its parents have visibility set to true.
1034 bool IsVisible() const;
1037 * @brief Sets the opacity of an actor.
1040 * @param [in] opacity The new opacity.
1041 * @pre The actor has been initialized.
1042 * @note This is an asynchronous method; the value written may not match a value subsequently read with GetCurrentOpacity().
1044 void SetOpacity(float opacity);
1047 * @brief Retrieve the actor's opacity.
1050 * @return The actor's opacity.
1051 * @pre The actor has been initialized.
1052 * @note This property can be animated; the return value may not match the value written with SetOpacity().
1054 float GetCurrentOpacity() const;
1057 * @brief Sets the actor's color; this is an RGBA value.
1059 * The final color of the actor depends on its color mode.
1061 * @param [in] color The new color.
1062 * @pre The Actor has been initialized.
1063 * @note This is an asynchronous method; the value written may not match a value subsequently read with GetCurrentColor().
1065 void SetColor(const Vector4& color);
1068 * @brief Retrieve the actor's color.
1070 * Actor's own color is not clamped.
1072 * @return The color.
1073 * @pre The Actor has been initialized.
1074 * @note This property can be animated; the return value may not match the value written with SetColor().
1076 Vector4 GetCurrentColor() const;
1079 * @brief Sets the actor's color mode.
1081 * This specifies whether the Actor uses its own color, or inherits
1082 * its parent color. The default is USE_OWN_MULTIPLY_PARENT_ALPHA.
1084 * @param [in] colorMode to use.
1085 * @pre The Actor has been initialized.
1087 void SetColorMode( ColorMode colorMode );
1090 * @brief Returns the actor's color mode.
1093 * @return currently used colorMode.
1094 * @pre The Actor has been initialized.
1096 ColorMode GetColorMode() const;
1099 * @brief Retrieve the world-color of the Actor, where each component is clamped within the 0->1 range.
1102 * @return The Actor's current color in the world.
1103 * @pre The Actor has been initialized.
1104 * @note The actor will not have a world-color, unless it has previously been added to the stage.
1106 Vector4 GetCurrentWorldColor() const;
1109 * @brief Set how the actor and its children should be drawn.
1111 * Not all actors are renderable, but DrawMode can be inherited from any actor.
1112 * If an object is in a 3D layer, it will be depth-tested against
1113 * other objects in the world i.e. it may be obscured if other objects are in front.
1115 * If DrawMode::OVERLAY_2D is used, the actor and its children will be drawn as a 2D overlay.
1116 * Overlay actors are drawn in a separate pass, after all non-overlay actors within the Layer.
1117 * For overlay actors, the drawing order is with respect to tree levels of Actors,
1118 * and depth-testing will not be used.
1120 * If DrawMode::STENCIL is used, the actor and its children will be used to stencil-test other actors
1121 * within the Layer. Stencil actors are therefore drawn into the stencil buffer before any other
1122 * actors within the Layer.
1125 * @param[in] drawMode The new draw-mode to use.
1126 * @note Setting STENCIL will override OVERLAY_2D, if that would otherwise have been inherited.
1127 * @note Layers do not inherit the DrawMode from their parents.
1129 void SetDrawMode( DrawMode::Type drawMode );
1132 * @brief Query how the actor and its children will be drawn.
1135 * @return Return the draw mode type.
1137 DrawMode::Type GetDrawMode() const;
1142 * @brief Sets whether an actor should emit touch or hover signals.
1144 * An actor is sensitive by default, which means that as soon as an application connects to the SignalTouch(),
1145 * the touch event signal will be emitted, and as soon as an application connects to the SignalHover(), the
1146 * hover event signal will be emitted.
1148 * If the application wishes to temporarily disable the touch or hover event signal emission, then they can do so by calling:
1150 * actor.SetSensitive(false);
1153 * Then, to re-enable the touch or hover event signal emission, the application should call:
1155 * actor.SetSensitive(true);
1159 * @param[in] sensitive true to enable emission of the touch or hover event signals, false otherwise.
1160 * @pre The Actor has been initialized.
1161 * @note If an actor's sensitivity is set to false, then it's children will not be hittable either.
1162 * This is regardless of the individual sensitivity values of the children i.e. an actor will only be
1163 * hittable if all of its parents have sensitivity set to true.
1164 * @see @see TouchedSignal() and HoveredSignal().
1166 void SetSensitive(bool sensitive);
1169 * @brief Query whether an actor emits touch or hover event signals.
1172 * @return True, if emission of touch or hover event signals is enabled, false otherwise.
1173 * @pre The Actor has been initialized.
1174 * @note If an actor is not sensitive, then it's children will not be hittable either.
1175 * This is regardless of the individual sensitivity values of the children i.e. an actor will only be
1176 * hittable if all of its parents have sensitivity set to true.
1178 bool IsSensitive() const;
1181 * @brief Converts screen coordinates into the actor's coordinate system using the default camera.
1184 * @param[out] localX On return, the X-coordinate relative to the actor.
1185 * @param[out] localY On return, the Y-coordinate relative to the actor.
1186 * @param[in] screenX The screen X-coordinate.
1187 * @param[in] screenY The screen Y-coordinate.
1188 * @return True if the conversion succeeded.
1189 * @pre The Actor has been initialized.
1190 * @note The actor coordinates are relative to the top-left (0.0, 0.0, 0.5)
1192 bool ScreenToLocal(float& localX, float& localY, float screenX, float screenY) const;
1195 * @brief Sets whether the actor should receive a notification when touch or hover motion events leave
1196 * the boundary of the actor.
1199 * @param[in] required Should be set to true if a Leave event is required
1200 * @pre The Actor has been initialized.
1201 * @note By default, this is set to false as most actors do not require this.
1202 * @note Need to connect to the TouchedSignal() or HoveredSignal() to actually receive this event.
1205 void SetLeaveRequired(bool required);
1208 * @brief This returns whether the actor requires touch or hover events whenever touch or hover motion events leave
1209 * the boundary of the actor.
1212 * @return True if a Leave event is required, false otherwise.
1213 * @pre The Actor has been initialized.
1215 bool GetLeaveRequired() const;
1218 * @brief Sets whether the actor should be focusable by keyboard navigation.
1220 * The default is false.
1222 * @param[in] focusable - true if the actor should be focusable by keyboard navigation,
1224 * @pre The Actor has been initialized.
1226 void SetKeyboardFocusable( bool focusable );
1229 * @brief Returns whether the actor is focusable by keyboard navigation.
1232 * @return True if the actor is focusable by keyboard navigation, false if not.
1233 * @pre The Actor has been initialized.
1235 bool IsKeyboardFocusable() const;
1240 * @brief Set the resize policy to be used for the given dimension(s).
1243 * @param[in] policy The resize policy to use
1244 * @param[in] dimension The dimension(s) to set policy for. Can be a bitfield of multiple dimensions.
1246 void SetResizePolicy( ResizePolicy::Type policy, Dimension::Type dimension );
1249 * @brief Return the resize policy used for a single dimension.
1252 * @param[in] dimension The dimension to get policy for
1253 * @return Return the dimension resize policy. If more than one dimension is requested, just return the first one found.
1255 ResizePolicy::Type GetResizePolicy( Dimension::Type dimension ) const;
1258 * @brief Set the policy to use when setting size with size negotiation. Defaults to SizeScalePolicy::USE_SIZE_SET.
1261 * @param[in] policy The policy to use for when the size is set
1263 void SetSizeScalePolicy( SizeScalePolicy::Type policy );
1266 * @brief Return the size scale policy in use.
1269 * @return Return the size scale policy.
1271 SizeScalePolicy::Type GetSizeScalePolicy() const;
1274 * @brief Sets the relative to parent size factor of the actor.
1276 * This factor is only used when ResizePolicy is set to either:
1277 * ResizePolicy::SIZE_RELATIVE_TO_PARENT or ResizePolicy::SIZE_FIXED_OFFSET_FROM_PARENT.
1278 * This actor's size is set to the actor's size multipled by or added to this factor,
1279 * depending on ResizePolicy ( See SetResizePolicy() ).
1282 * @param [in] factor A Vector3 representing the relative factor to be applied to each axis.
1283 * @pre The Actor has been initialized.
1285 void SetSizeModeFactor( const Vector3& factor );
1288 * @brief Retrieve the relative to parent size factor of the actor.
1291 * @return The Actor's current relative size factor.
1292 * @pre The Actor has been initialized.
1294 Vector3 GetSizeModeFactor() const;
1297 * @brief Calculate the height of the actor given a width.
1299 * The natural size is used for default calculation.
1300 * size 0 is treated as aspect ratio 1:1.
1303 * @param width Width to use
1304 * @return Return the height based on the width.
1306 float GetHeightForWidth( float width );
1309 * @brief Calculate the width of the actor given a height.
1311 * The natural size is used for default calculation.
1312 * size 0 is treated as aspect ratio 1:1.
1315 * @param height Height to use
1316 * @return Return the width based on the height.
1318 float GetWidthForHeight( float height );
1321 * @brief Return the value of negotiated dimension for the given dimension.
1324 * @param dimension The dimension to retrieve
1325 * @return Return the value of the negotiated dimension. If more than one dimension is requested, just return the first one found.
1327 float GetRelayoutSize( Dimension::Type dimension ) const;
1330 * @brief Set the padding for use in layout.
1333 * @param[in] padding Padding for the actor
1335 void SetPadding( const Padding& padding );
1338 * @brief Return the value of the padding.
1341 * @param paddingOut The returned padding data
1343 void GetPadding( Padding& paddingOut ) const;
1346 * @brief Set the minimum size an actor can be assigned in size negotiation.
1349 * @param[in] size The minimum size
1351 void SetMinimumSize( const Vector2& size );
1354 * @brief Return the minimum relayout size.
1357 * @return Return the mininmum size.
1359 Vector2 GetMinimumSize();
1362 * @brief Set the maximum size an actor can be assigned in size negotiation.
1365 * @param[in] size The maximum size
1367 void SetMaximumSize( const Vector2& size );
1370 * @brief Return the maximum relayout size.
1373 * @return Return the maximum size.
1375 Vector2 GetMaximumSize();
1378 * @brief Get depth in the hierarchy for the actor.
1381 * @return The current depth in the hierarchy of the actor, or -1 if actor is not in the hierarchy
1383 int GetHierarchyDepth();
1388 * @brief Add a renderer to this actor.
1391 * @param[in] renderer Renderer to add to the actor
1392 * @return The index of the Renderer that was added
1393 * @pre The renderer must be initialized.
1396 unsigned int AddRenderer( Renderer& renderer );
1399 * @brief Get the number of renderers on this actor.
1402 * @return the number of renderers on this actor
1404 unsigned int GetRendererCount() const;
1407 * @brief Get a Renderer by index.
1410 * @param[in] index The index of the renderer to fetch
1411 * @return The renderer at the specified index
1412 * @pre The index must be between 0 and GetRendererCount()-1
1415 Renderer GetRendererAt( unsigned int index );
1418 * @brief Remove an renderer from the actor.
1421 * @param[in] renderer Handle to the renderer that is to be removed
1423 void RemoveRenderer( Renderer& renderer );
1426 * @brief Remove an renderer from the actor by index.
1429 * @param[in] index Index of the renderer that is to be removed
1430 * @pre The index must be between 0 and GetRendererCount()-1
1433 void RemoveRenderer( unsigned int index );
1438 * @DEPRECATED_1_1.37 Use TouchSignal() instead.
1439 * @brief This signal is emitted when touch input is received.
1441 * A callback of the following type may be connected:
1443 * bool YourCallbackName(Actor actor, const TouchEvent& event);
1445 * The return value of True, indicates that the touch event should be consumed.
1446 * Otherwise the signal will be emitted on the next sensitive parent of the actor.
1448 * @return The signal to connect to.
1449 * @pre The Actor has been initialized.
1451 TouchSignalType& TouchedSignal();
1454 * @brief This signal is emitted when touch input is received.
1456 * A callback of the following type may be connected:
1458 * bool YourCallbackName( Actor actor, TouchData& touch );
1460 * The return value of True, indicates that the touch event has been consumed.
1461 * Otherwise the signal will be emitted on the next sensitive parent of the actor.
1463 * @return The signal to connect to.
1464 * @pre The Actor has been initialized.
1466 TouchDataSignalType& TouchSignal();
1469 * @brief This signal is emitted when hover input is received.
1471 * A callback of the following type may be connected:
1473 * bool YourCallbackName(Actor actor, const HoverEvent& event);
1475 * The return value of True, indicates that the hover event should be consumed.
1476 * Otherwise the signal will be emitted on the next sensitive parent of the actor.
1478 * @return The signal to connect to.
1479 * @pre The Actor has been initialized.
1481 HoverSignalType& HoveredSignal();
1484 * @brief This signal is emitted when wheel event is received.
1486 * A callback of the following type may be connected:
1488 * bool YourCallbackName(Actor actor, const WheelEvent& event);
1490 * The return value of True, indicates that the wheel event should be consumed.
1491 * Otherwise the signal will be emitted on the next sensitive parent of the actor.
1493 * @return The signal to connect to.
1494 * @pre The Actor has been initialized.
1496 WheelEventSignalType& WheelEventSignal();
1499 * @brief This signal is emitted after the actor has been connected to the stage.
1501 * When an actor is connected, it will be directly or indirectly parented to the root Actor.
1503 * @return The signal to connect to.
1504 * @note The root Actor is provided automatically by Dali::Stage, and is always considered to be connected.
1506 * @note When the parent of a set of actors is connected to the stage, then all of the children
1507 * will received this callback.
1508 * For the following actor tree, the callback order will be A, B, D, E, C, and finally F.
1520 OnStageSignalType& OnStageSignal();
1523 * @brief This signal is emitted after the actor has been disconnected from the stage.
1525 * If an actor is disconnected it either has no parent, or is parented to a disconnected actor.
1528 * @return The signal to connect to.
1529 * @note When the parent of a set of actors is disconnected to the stage, then all of the children
1530 * will received this callback, starting with the leaf actors.
1531 * For the following actor tree, the callback order will be D, E, B, F, C, and finally A.
1544 OffStageSignalType& OffStageSignal();
1547 * @brief This signal is emitted after the size has been set on the actor during relayout
1550 * @return The signal
1552 OnRelayoutSignalType& OnRelayoutSignal();
1554 public: // Not intended for application developers
1558 * @brief This constructor is used by Actor::New() methods.
1561 * @param [in] actor A pointer to a newly allocated Dali resource
1563 explicit DALI_INTERNAL Actor(Internal::Actor* actor);
1568 * @brief Helper for discarding an actor handle.
1570 * If the handle is empty, this method does nothing. Otherwise
1571 * Actor::Unparent() will be called, followed by Actor::Reset().
1573 * @param[in,out] actor A handle to an actor, or an empty handle.
1575 inline void UnparentAndReset( Actor& actor )
1589 #endif // __DALI_ACTOR_H__