5 * Copyright (c) 2016 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>
35 * @addtogroup dali_core_actors
39 namespace Internal DALI_INTERNAL
58 typedef Rect<float> Padding; ///< Padding definition @SINCE_1_0.0
61 * @brief Actor is the primary object with which Dali applications interact.
63 * UI controls can be built by combining multiple actors.
65 * <h3>Multi-Touch Events:</h3>
67 * Touch or hover events are received via signals; see Actor::TouchedSignal() and Actor::HoveredSignal() for more details.
69 * <i>Hit Testing Rules Summary:</i>
71 * - An actor is only hittable if the actor's touch or hover signal has a connection.
72 * - An actor is only hittable when it is between the camera's near and far planes.
73 * - If an actor is made insensitive, then the actor and its children are not hittable; see IsSensitive()
74 * - If an actor's visibility flag is unset, then none of its children are hittable either; see IsVisible()
75 * - To be hittable, an actor must have a non-zero size.
76 * - If an actor's world color is fully transparent, then it is not hittable; see GetCurrentWorldColor()
78 * <i>Hit Test Algorithm:</i>
81 * - Gets the first down and the last up touch events to the screen, regardless of actor touch event consumption.
82 * - Stage's root layer can be used to catch unconsumed touch events.
85 * - Hit testing is dependent on the camera used, which is specific to each RenderTask.
88 * - For each RenderTask, hit testing starts from the top-most layer and we go through all the
89 * layers until we have a hit or there are none left.
90 * - Before we perform a hit test within a layer, we check if all the layer's parents are visible
92 * - If they are not, we skip hit testing the actors in that layer altogether.
93 * - If a layer is set to consume all touch, then we do not check any layers behind this layer.
96 * - The final part of hit testing is performed by walking through the actor tree within a layer.
97 * - The following pseudocode shows the algorithm used:
99 * HIT-TEST-WITHIN-LAYER( ACTOR )
101 * // Only hit-test the actor and its children if it is sensitive and visible
102 * IF ( ACTOR-IS-SENSITIVE &&
103 * ACTOR-IS-VISIBLE &&
104 * ACTOR-IS-ON-STAGE )
106 * // Depth-first traversal within current layer, visiting parent first
108 * // Check whether current actor should be hit-tested.
109 * IF ( ( TOUCH-SIGNAL-NOT-EMPTY || HOVER-SIGNAL-NOT-EMPTY ) &&
110 * ACTOR-HAS-NON-ZERO-SIZE &&
111 * ACTOR-WORLD-COLOR-IS-NOT-TRANSPARENT )
113 * // Hit-test current actor
116 * IF ( ACTOR-IS-OVERLAY || ( DISTANCE-TO-ACTOR < DISTANCE-TO-LAST-HIT-ACTOR ) )
118 * // The current actor is the closest actor that was underneath the touch.
119 * LAST-HIT-ACTOR = CURRENT-ACTOR
124 * // Keep checking children, in case we hit something closer.
125 * FOR-EACH CHILD (in order)
127 * IF ( CHILD-IS-NOT-A-LAYER )
129 * // Continue traversal for this child's sub-tree
130 * HIT-TEST-WITHIN-LAYER ( CHILD )
132 * // else we skip hit-testing the child's sub-tree altogether.
137 * - Overlays always take priority (i.e. they're considered closer) regardless of distance.
138 * The overlay children take priority over their parents, and overlay siblings take priority
139 * over their previous siblings (i.e. reverse of rendering order):
149 * Hit Priority of above Actor tree (all overlays): 1 - Lowest. 6 - Highest.
151 * For more information, see SetDrawMode().
153 * <i>Touch or hover Event Delivery:</i>
156 * - The hit actor's touch or hover signal is emitted first; if it is not consumed by any of the listeners,
157 * the parent's touch or hover signal is emitted, and so on.
158 * - The following pseudocode shows the delivery mechanism:
160 * EMIT-TOUCH-SIGNAL( ACTOR )
162 * IF ( TOUCH-SIGNAL-NOT-EMPTY )
164 * // Only do the emission if touch signal of actor has connections.
165 * CONSUMED = TOUCHED-SIGNAL( TOUCH-EVENT )
168 * IF ( NOT-CONSUMED )
170 * // If event is not consumed then deliver it to the parent unless we reach the root actor
171 * IF ( ACTOR-PARENT )
173 * EMIT-TOUCH-SIGNAL( ACTOR-PARENT )
178 * EMIT-HOVER-SIGNAL( ACTOR )
180 * IF ( HOVER-SIGNAL-NOT-EMPTY )
182 * // Only do the emission if hover signal of actor has connections.
183 * CONSUMED = HOVERED-SIGNAL( HOVER-EVENT )
186 * IF ( NOT-CONSUMED )
188 * // If event is not consumed then deliver it to the parent unless we reach the root actor.
189 * IF ( ACTOR-PARENT )
191 * EMIT-HOVER-SIGNAL( ACTOR-PARENT )
196 * - If there are several touch points, then the delivery is only to the first touch point's hit
197 * actor (and its parents). There will be NO touch or hover signal delivery for the hit actors of the
198 * other touch points.
199 * - The local coordinates are from the top-left (0.0f, 0.0f, 0.5f) of the hit actor.
202 * - A "Leave" state is set when the first point exits the bounds of the previous first point's
203 * hit actor (primary hit actor).
204 * - When this happens, the last primary hit actor's touch or hover signal is emitted with a "Leave" state
205 * (only if it requires leave signals); see SetLeaveRequired().
207 * - Interrupted State
208 * - If a system event occurs which interrupts the touch or hover processing, then the last primary hit
209 * actor's touch or hover signals are emitted with an "Interrupted" state.
210 * - If the last primary hit actor, or one of its parents, is no longer touchable or hoverable, then its
211 * touch or hover signals are also emitted with an "Interrupted" state.
212 * - If the consumed actor on touch-down is not the same as the consumed actor on touch-up, then
213 * touch signals are also emitted from the touch-down actor with an "Interrupted" state.
214 * - If the consumed actor on hover-start is not the same as the consumed actor on hover-finished, then
215 * hover signals are also emitted from the hover-started actor with an "Interrupted" state.
217 * <h3>Key Events:</h3>
219 * Key events are received by an actor once set to grab key events, only one actor can be set as focused.
224 * | %Signal Name | Method |
225 * |-------------------|------------------------------|
226 * | touched | @ref TouchedSignal() |
227 * | hovered | @ref HoveredSignal() |
228 * | wheelEvent | @ref WheelEventSignal() |
229 * | onStage | @ref OnStageSignal() |
230 * | offStage | @ref OffStageSignal() |
231 * | onRelayout | @ref OnRelayoutSignal() |
234 * | %Action Name | %Actor method called |
235 * |-------------------|------------------------------|
236 * | show | %SetVisible( true ) |
237 * | hide | %SetVisible( false ) |
241 class DALI_IMPORT_API Actor : public Handle
246 * @brief An enumeration of properties belonging to the Actor class.
253 PARENT_ORIGIN = DEFAULT_ACTOR_PROPERTY_START_INDEX, ///< name "parentOrigin", type Vector3 (constraint-input) @SINCE_1_0.0
254 PARENT_ORIGIN_X, ///< name "parentOriginX", type float (constraint-input) @SINCE_1_0.0
255 PARENT_ORIGIN_Y, ///< name "parentOriginY", type float (constraint-input) @SINCE_1_0.0
256 PARENT_ORIGIN_Z, ///< name "parentOriginZ", type float (constraint-input) @SINCE_1_0.0
257 ANCHOR_POINT, ///< name "anchorPoint", type Vector3 (constraint-input) @SINCE_1_0.0
258 ANCHOR_POINT_X, ///< name "anchorPointX", type float (constraint-input) @SINCE_1_0.0
259 ANCHOR_POINT_Y, ///< name "anchorPointY", type float (constraint-input) @SINCE_1_0.0
260 ANCHOR_POINT_Z, ///< name "anchorPointZ", type float (constraint-input) @SINCE_1_0.0
261 SIZE, ///< name "size", type Vector3 (animatable / constraint-input) @SINCE_1_0.0
262 SIZE_WIDTH, ///< name "sizeWidth", type float (animatable / constraint-input) @SINCE_1_0.0
263 SIZE_HEIGHT, ///< name "sizeHeight", type float (animatable / constraint-input) @SINCE_1_0.0
264 SIZE_DEPTH, ///< name "sizeDepth", type float (animatable / constraint-input) @SINCE_1_0.0
265 POSITION, ///< name "position", type Vector3 (animatable / constraint-input) @SINCE_1_0.0
266 POSITION_X, ///< name "positionX", type float (animatable / constraint-input) @SINCE_1_0.0
267 POSITION_Y, ///< name "positionY", type float (animatable / constraint-input) @SINCE_1_0.0
268 POSITION_Z, ///< name "positionZ", type float (animatable / constraint-input) @SINCE_1_0.0
269 WORLD_POSITION, ///< name "worldPosition", type Vector3 (read-only / constraint-input) @SINCE_1_0.0
270 WORLD_POSITION_X, ///< name "worldPositionX", type float (read-only / constraint-input) @SINCE_1_0.0
271 WORLD_POSITION_Y, ///< name "worldPositionY", type float (read-only / constraint-input) @SINCE_1_0.0
272 WORLD_POSITION_Z, ///< name "worldPositionZ", type float (read-only / constraint-input) @SINCE_1_0.0
273 ORIENTATION, ///< name "orientation", type Quaternion (animatable / constraint-input) @SINCE_1_0.0
274 WORLD_ORIENTATION, ///< name "worldOrientation", type Quaternion (read-only / constraint-input) @SINCE_1_0.0
275 SCALE, ///< name "scale", type Vector3 (animatable / constraint-input) @SINCE_1_0.0
276 SCALE_X, ///< name "scaleX", type float (animatable / constraint-input) @SINCE_1_0.0
277 SCALE_Y, ///< name "scaleY", type float (animatable / constraint-input) @SINCE_1_0.0
278 SCALE_Z, ///< name "scaleZ", type float (animatable / constraint-input) @SINCE_1_0.0
279 WORLD_SCALE, ///< name "worldScale", type Vector3 (read-only / constraint-input) @SINCE_1_0.0
280 VISIBLE, ///< name "visible", type bool (animatable / constraint-input) @SINCE_1_0.0
281 COLOR, ///< name "color", type Vector4 (animatable / constraint-input) @SINCE_1_0.0
282 COLOR_RED, ///< name "colorRed", type float (animatable / constraint-input) @SINCE_1_0.0
283 COLOR_GREEN, ///< name "colorGreen", type float (animatable / constraint-input) @SINCE_1_0.0
284 COLOR_BLUE, ///< name "colorBlue", type float (animatable / constraint-input) @SINCE_1_0.0
285 COLOR_ALPHA, ///< name "colorAlpha", type float (animatable / constraint-input) @SINCE_1_0.0
286 WORLD_COLOR, ///< name "worldColor", type Vector4 (read-only / constraint-input) @SINCE_1_0.0
287 WORLD_MATRIX, ///< name "worldMatrix", type Matrix (read-only / constraint-input) @SINCE_1_0.0
288 NAME, ///< name "name", type std::string @SINCE_1_0.0
289 SENSITIVE, ///< name "sensitive", type bool @SINCE_1_0.0
290 LEAVE_REQUIRED, ///< name "leaveRequired", type bool @SINCE_1_0.0
291 INHERIT_ORIENTATION, ///< name "inheritOrientation", type bool @SINCE_1_0.0
292 INHERIT_SCALE, ///< name "inheritScale", type bool @SINCE_1_0.0
293 COLOR_MODE, ///< name "colorMode", type std::string @SINCE_1_0.0
294 POSITION_INHERITANCE, ///< name "positionInheritance", type std::string @DEPRECATED_1_1.24 Use INHERIT_POSITION instead
295 DRAW_MODE, ///< name "drawMode", type std::string @SINCE_1_0.0
296 SIZE_MODE_FACTOR, ///< name "sizeModeFactor", type Vector3 @SINCE_1_0.0
297 WIDTH_RESIZE_POLICY, ///< name "widthResizePolicy", type String @SINCE_1_0.0
298 HEIGHT_RESIZE_POLICY, ///< name "heightResizePolicy", type String @SINCE_1_0.0
299 SIZE_SCALE_POLICY, ///< name "sizeScalePolicy", type String @SINCE_1_0.0
300 WIDTH_FOR_HEIGHT, ///< name "widthForHeight", type bool @SINCE_1_0.0
301 HEIGHT_FOR_WIDTH, ///< name "heightForWidth", type bool @SINCE_1_0.0
302 PADDING, ///< name "padding", type Vector4 @SINCE_1_0.0
303 MINIMUM_SIZE, ///< name "minimumSize", type Vector2 @SINCE_1_0.0
304 MAXIMUM_SIZE, ///< name "maximumSize", type Vector2 @SINCE_1_0.0
305 INHERIT_POSITION, ///< name "inheritPosition", type bool @SINCE_1_1.24
306 CLIPPING_MODE, ///< name "clippingMode", type String @SINCE_1_2_5
312 typedef Signal< bool (Actor, const TouchEvent&) > TouchSignalType; ///< @DEPRECATED_1_1.37 @brief Touch signal type @SINCE_1_0.0
313 typedef Signal< bool (Actor, const TouchData&) > TouchDataSignalType; ///< Touch signal type @SINCE_1_1.37
314 typedef Signal< bool (Actor, const HoverEvent&) > HoverSignalType; ///< Hover signal type @SINCE_1_0.0
315 typedef Signal< bool (Actor, const WheelEvent&) > WheelEventSignalType; ///< Wheel signal type @SINCE_1_0.0
316 typedef Signal< void (Actor) > OnStageSignalType; ///< Stage connection signal type @SINCE_1_0.0
317 typedef Signal< void (Actor) > OffStageSignalType; ///< Stage disconnection signal type @SINCE_1_0.0
318 typedef Signal< void (Actor) > OnRelayoutSignalType; ///< Called when the actor is relaid out @SINCE_1_0.0
323 * @brief Create an uninitialized Actor; this can be initialized with Actor::New().
325 * Calling member functions with an uninitialized Actor handle is not allowed.
331 * @brief Create an initialized Actor.
334 * @return A handle to a newly allocated Dali resource.
339 * @brief Downcast a handle to Actor handle.
341 * If handle points to a Actor object the downcast produces valid
342 * handle. If not the returned handle is left uninitialized.
345 * @param[in] handle to An object
346 * @return handle to a Actor object or an uninitialized handle
348 static Actor DownCast( BaseHandle handle );
351 * @brief Dali::Actor is intended as a base class
353 * This is non-virtual since derived Handle types must not contain data or virtual methods.
359 * @brief Copy constructor
362 * @param [in] copy The actor to copy.
364 Actor(const Actor& copy);
367 * @brief Assignment operator
370 * @param [in] rhs The actor to copy.
371 * @return A reference to this
373 Actor& operator=(const Actor& rhs);
376 * @brief Retrieve the Actor's name.
379 * @return The Actor's name.
380 * @pre The Actor has been initialized.
382 const std::string& GetName() const;
385 * @brief Sets the Actor's name.
388 * @param [in] name The new name.
389 * @pre The Actor has been initialized.
391 void SetName(const std::string& name);
394 * @brief Retrieve the unique ID of the actor.
398 * @pre The Actor has been initialized.
400 unsigned int GetId() const;
405 * @brief Query whether an actor is the root actor, which is owned by the Stage.
408 * @return True if the actor is the root actor.
409 * @pre The Actor has been initialized.
414 * @brief Query whether the actor is connected to the Stage.
416 * When an actor is connected, it will be directly or indirectly parented to the root Actor.
418 * @return True if the actor is connected to the Stage.
419 * @pre The Actor has been initialized.
420 * @note The root Actor is provided automatically by Dali::Stage, and is always considered to be connected.
422 bool OnStage() const;
425 * @brief Query whether the actor is of class Dali::Layer.
428 * @return True if the actor is a layer.
429 * @pre The Actor has been initialized.
431 bool IsLayer() const;
434 * @brief Gets the layer in which the actor is present.
437 * @return The layer, which will be uninitialized if the actor is off-stage.
438 * @pre The Actor has been initialized.
443 * @brief Adds a child Actor to this Actor.
446 * @param [in] child The child.
447 * @pre This Actor (the parent) has been initialized.
448 * @pre The child actor has been initialized.
449 * @pre The child actor is not the same as the parent actor.
450 * @pre The actor is not the Root actor.
451 * @post The child will be referenced by its parent. This means that the child will be kept alive,
452 * even if the handle passed into this method is reset or destroyed.
453 * @note if the child already has a parent, it will be removed from old parent
454 * and reparented to this actor. This may change childs position, color,
455 * scale etc as it now inherits them from this actor.
457 void Add(Actor child);
460 * @brief Removes a child Actor from this Actor.
462 * If the actor was not a child of this actor, this is a no-op.
464 * @param [in] child The child.
465 * @pre This Actor (the parent) has been initialized.
466 * @pre The child actor is not the same as the parent actor.
468 void Remove(Actor child);
471 * @brief Removes an actor from its parent.
473 * If the actor has no parent, this method does nothing.
475 * @pre The (child) actor has been initialized.
480 * @brief Retrieve the number of children held by the actor.
483 * @return The number of children
484 * @pre The Actor has been initialized.
486 unsigned int GetChildCount() const;
489 * @brief Retrieve and child actor by index.
492 * @param[in] index The index of the child to retrieve
493 * @return The actor for the given index or empty handle if children not initialised
494 * @pre The Actor has been initialized.
496 Actor GetChildAt(unsigned int index) const;
499 * @brief Search through this actor's hierarchy for an actor with the given name.
501 * The actor itself is also considered in the search.
503 * @param[in] actorName the name of the actor to find
504 * @return A handle to the actor if found, or an empty handle if not.
505 * @pre The Actor has been initialized.
507 Actor FindChildByName(const std::string& actorName);
510 * @brief Search through this actor's hierarchy for an actor with the given unique ID.
512 * The actor itself is also considered in the search.
514 * @param[in] id the ID of the actor to find
515 * @return A handle to the actor if found, or an empty handle if not.
516 * @pre The Actor has been initialized.
518 Actor FindChildById(const unsigned int id);
521 * @brief Retrieve the actor's parent.
524 * @return A handle to the actor's parent. If the actor has no parent, this handle will be invalid.
525 * @pre The actor has been initialized.
527 Actor GetParent() const;
532 * @brief Set the origin of an actor, within its parent's area.
534 * This is expressed in unit coordinates, such that (0.0, 0.0, 0.5) is the top-left corner of the parent,
535 * and (1.0, 1.0, 0.5) is the bottom-right corner.
536 * The default parent-origin is Dali::ParentOrigin::TOP_LEFT (0.0, 0.0, 0.5).
537 * An actor position is the distance between this origin, and the actors anchor-point.
539 * @param [in] origin The new parent-origin.
540 * @pre The Actor has been initialized.
541 * @note This is an asynchronous method; the value written may not match a value subsequently read with GetCurrentParentOrigin().
542 * @see Dali::ParentOrigin for predefined parent origin values
544 void SetParentOrigin(const Vector3& origin);
547 * @brief Retrieve the parent-origin of an actor.
550 * @return The current parent-origin.
551 * @pre The Actor has been initialized.
552 * @note This property can be animated; the return value may not match the value written with SetParentOrigin().
554 Vector3 GetCurrentParentOrigin() const;
557 * @brief Set the anchor-point of an actor.
559 * This is expressed in unit coordinates, such that (0.0, 0.0, 0.5)
560 * is the top-left corner of the actor, and (1.0, 1.0, 0.5) is the
561 * bottom-right corner. The default anchor point is
562 * Dali::AnchorPoint::CENTER (0.5, 0.5, 0.5).
563 * An actor position is the distance between its parent-origin, and this anchor-point.
564 * An actor's orientation is the rotation from its default orientation, the rotation is centered around its anchor-point.
566 * @param [in] anchorPoint The new anchor-point.
567 * @pre The Actor has been initialized.
568 * @note This is an asynchronous method; the value written may not match a value subsequently read with GetCurrentAnchorPoint().
569 * @see Dali::AnchorPoint for predefined anchor point values
571 void SetAnchorPoint(const Vector3& anchorPoint);
574 * @brief Retrieve the anchor-point of an actor.
577 * @return The current anchor-point.
578 * @pre The Actor has been initialized.
579 * @note This property can be animated; the return value may not match the value written with SetAnchorPoint().
581 Vector3 GetCurrentAnchorPoint() const;
584 * @brief Sets the size of an actor.
586 * Geometry can be scaled to fit within this area.
587 * This does not interfere with the actors scale factor.
588 * The actors default depth is the minimum of width & height.
590 * @param [in] width The new width.
591 * @param [in] height The new height.
592 * @pre The actor has been initialized.
593 * @note This is an asynchronous method; the value written may not match a value subsequently read with GetCurrentSize().
595 void SetSize(float width, float height);
598 * @brief Sets the size of an actor.
600 * Geometry can be scaled to fit within this area.
601 * This does not interfere with the actors scale factor.
603 * @param [in] width The size of the actor along the x-axis.
604 * @param [in] height The size of the actor along the y-axis.
605 * @param [in] depth The size of the actor along the z-axis.
606 * @pre The actor has been initialized.
607 * @note This is an asynchronous method; the value written may not match a value subsequently read with GetCurrentSize().
609 void SetSize(float width, float height, float depth);
612 * @brief Sets the size of an actor.
614 * Geometry can be scaled to fit within this area.
615 * This does not interfere with the actors scale factor.
616 * The actors default depth is the minimum of width & height.
618 * @param [in] size The new size.
619 * @pre The actor has been initialized.
620 * @note This is an asynchronous method; the value written may not match a value subsequently read with GetCurrentSize().
622 void SetSize(const Vector2& size);
625 * @brief Sets the size of an actor.
627 * Geometry can be scaled to fit within this area.
628 * This does not interfere with the actors scale factor.
630 * @param [in] size The new size.
631 * @pre The actor has been initialized.
632 * @note This is an asynchronous method; the value written may not match a value subsequently read with GetCurrentSize().
634 void SetSize(const Vector3& size);
637 * @brief Retrieve the actor's size.
640 * @return The actor's target size.
641 * @pre The actor has been initialized.
642 * @note This return is the value that was set using SetSize or the target size of an animation.
644 Vector3 GetTargetSize() const;
647 * @brief Retrieve the actor's size.
650 * @return The actor's current size.
651 * @pre The actor has been initialized.
652 * @note This property can be animated; the return value may not match the value written with SetSize().
654 Vector3 GetCurrentSize() const;
657 * @brief Return the natural size of the actor.
659 * Deriving classes stipulate the natural size and by default an actor has a ZERO natural size.
662 * @return The actor's natural size
664 Vector3 GetNaturalSize() const;
667 * @brief Sets the position of the actor.
669 * The Actor's z position will be set to 0.0f.
671 * @param [in] x The new x position
672 * @param [in] y The new y position
673 * @pre The Actor has been initialized.
674 * @note This is an asynchronous method; the value written may not match a value subsequently read with GetCurrentPosition().
676 void SetPosition(float x, float y);
679 * @brief Sets the position of the Actor.
682 * @param [in] x The new x position
683 * @param [in] y The new y position
684 * @param [in] z The new z position
685 * @pre The Actor has been initialized.
686 * @note This is an asynchronous method; the value written may not match a value subsequently read with GetCurrentPosition().
688 void SetPosition(float x, float y, float z);
691 * @brief Sets the position of the Actor.
694 * @param [in] position The new position
695 * @pre The Actor has been initialized.
696 * @note This is an asynchronous method; the value written may not match a value subsequently read with GetCurrentPosition().
698 void SetPosition(const Vector3& position);
701 * @brief Set the position of an actor along the X-axis.
704 * @param [in] x The new x position
705 * @pre The Actor has been initialized.
706 * @note This is an asynchronous method; the value written may not match a value subsequently read with GetCurrentPosition().
711 * @brief Set the position of an actor along the Y-axis.
714 * @param [in] y The new y position.
715 * @pre The Actor has been initialized.
716 * @note This is an asynchronous method; the value written may not match a value subsequently read with GetCurrentPosition().
721 * @brief Set the position of an actor along the Z-axis.
724 * @param [in] z The new z position
725 * @pre The Actor has been initialized.
726 * @note This is an asynchronous method; the value written may not match a value subsequently read with GetCurrentPosition().
731 * @brief Translate an actor relative to its existing position.
734 * @param[in] distance The actor will move by this distance.
735 * @pre The actor has been initialized.
737 void TranslateBy(const Vector3& distance);
740 * @brief Retrieve the position of the Actor.
743 * @return the Actor's current position.
744 * @pre The Actor has been initialized.
745 * @note This property can be animated; the return value may not match the value written with SetPosition().
747 Vector3 GetCurrentPosition() const;
750 * @brief Retrieve the world-position of the Actor.
753 * @return The Actor's current position in world coordinates.
754 * @pre The Actor has been initialized.
755 * @note The actor will not have a world-position, unless it has previously been added to the stage.
757 Vector3 GetCurrentWorldPosition() const;
760 * @DEPRECATED_1_1.24 Use SetInheritPosition instead
761 * @brief Set the actors position inheritance mode.
763 * The default is to inherit.
764 * Switching this off means that using SetPosition() sets the actor's world position.
766 * @param[in] mode to use
767 * @pre The Actor has been initialized.
768 * @see PositionInheritanceMode
770 void SetPositionInheritanceMode( PositionInheritanceMode mode );
773 * @brief Set whether a child actor inherits it's parent's position.
775 * Default is to inherit.
776 * Switching this off means that using SetPosition() sets the actor's world position3
778 * @param[in] inherit - true if the actor should inherit position, false otherwise.
779 * @pre The Actor has been initialized.
781 inline void SetInheritPosition( bool inherit )
783 SetProperty(Property::INHERIT_POSITION, inherit );
787 * @DEPRECATED_1_1.24 Use IsPositionInherited
788 * @brief Returns the actors position inheritance mode.
791 * @return Return the position inheritance mode.
792 * @pre The Actor has been initialized.
794 PositionInheritanceMode GetPositionInheritanceMode() const;
797 * @brief Returns whether the actor inherits its parent's position.
800 * @return True if the actor inherits its parent position, false if it uses world position.
801 * @pre The Actor has been initialized.
803 inline bool IsPositionInherited() const
805 return GetProperty(Property::INHERIT_POSITION ).Get<bool>();
809 * @brief Sets the orientation of the Actor.
811 * An actor's orientation is the rotation from its default orientation, and the rotation is centered around its anchor-point.
813 * @param [in] angle The new orientation angle in degrees.
814 * @param [in] axis The new axis of orientation.
815 * @pre The Actor has been initialized.
816 * @note This is an asynchronous method; the value written may not match a value subsequently read with GetCurrentOrientation().
818 void SetOrientation( const Degree& angle, const Vector3& axis )
820 SetOrientation( Radian( angle ), axis );
824 * @brief Sets the orientation of the Actor.
826 * An actor's orientation is the rotation from its default orientation, and the rotation is centered around its anchor-point.
828 * @param [in] angle The new orientation angle in radians.
829 * @param [in] axis The new axis of orientation.
830 * @pre The Actor has been initialized.
831 * @note This is an asynchronous method; the value written may not match a value subsequently read with GetCurrentOrientation().
833 void SetOrientation(const Radian& angle, const Vector3& axis);
836 * @brief Sets the orientation of the Actor.
838 * An actor's orientation is the rotation from its default orientation, and the rotation is centered around its anchor-point.
840 * @param [in] orientation The new orientation.
841 * @pre The Actor has been initialized.
842 * @note This is an asynchronous method; the value written may not match a value subsequently read with GetCurrentOrientation().
844 void SetOrientation(const Quaternion& orientation);
847 * @brief Apply a relative rotation to an actor.
850 * @param[in] angle The angle to the rotation to combine with the existing orientation.
851 * @param[in] axis The axis of the rotation to combine with the existing orientation.
852 * @pre The actor has been initialized.
854 void RotateBy( const Degree& angle, const Vector3& axis )
856 RotateBy( Radian( angle ), axis );
860 * @brief Apply a relative rotation to an actor.
863 * @param[in] angle The angle to the rotation to combine with the existing orientation.
864 * @param[in] axis The axis of the rotation to combine with the existing orientation.
865 * @pre The actor has been initialized.
867 void RotateBy(const Radian& angle, const Vector3& axis);
870 * @brief Apply a relative rotation to an actor.
873 * @param[in] relativeRotation The rotation to combine with the existing orientation.
874 * @pre The actor has been initialized.
876 void RotateBy(const Quaternion& relativeRotation);
879 * @brief Retreive the Actor's orientation.
882 * @return The current orientation.
883 * @pre The Actor has been initialized.
884 * @note This property can be animated; the return value may not match the value written with SetOrientation().
886 Quaternion GetCurrentOrientation() const;
889 * @brief Set whether a child actor inherits it's parent's orientation.
891 * Default is to inherit.
892 * Switching this off means that using SetOrientation() sets the actor's world orientation.
894 * @param[in] inherit - true if the actor should inherit orientation, false otherwise.
895 * @pre The Actor has been initialized.
897 void SetInheritOrientation(bool inherit);
900 * @brief Returns whether the actor inherits its parent's orientation.
903 * @return True if the actor inherits its parent orientation, false if it uses world orientation.
904 * @pre The Actor has been initialized.
906 bool IsOrientationInherited() const;
909 * @brief Retrieve the world-orientation of the Actor.
912 * @return The Actor's current orientation in the world.
913 * @pre The Actor has been initialized.
914 * @note The actor will not have a world-orientation, unless it has previously been added to the stage.
916 Quaternion GetCurrentWorldOrientation() const;
919 * @brief Set the scale factor applied to an actor.
922 * @param [in] scale The scale factor applied on all axes.
923 * @pre The Actor has been initialized.
924 * @note This is an asynchronous method; the value written may not match a value subsequently read with GetCurrentScale().
926 void SetScale(float scale);
929 * @brief Set the scale factor applied to an actor.
932 * @param [in] scaleX The scale factor applied along the x-axis.
933 * @param [in] scaleY The scale factor applied along the y-axis.
934 * @param [in] scaleZ The scale factor applied along the z-axis.
935 * @pre The Actor has been initialized.
936 * @note This is an asynchronous method; the value written may not match a value subsequently read with GetCurrentScale().
938 void SetScale(float scaleX, float scaleY, float scaleZ);
941 * @brief Set the scale factor applied to an actor.
944 * @param [in] scale A vector representing the scale factor for each axis.
945 * @pre The Actor has been initialized.
946 * @note This is an asynchronous method; the value written may not match a value subsequently read with GetCurrentScale().
948 void SetScale(const Vector3& scale);
951 * @brief Apply a relative scale to an actor.
954 * @param[in] relativeScale The scale to combine with the actor's existing scale.
955 * @pre The actor has been initialized.
957 void ScaleBy(const Vector3& relativeScale);
960 * @brief Retrieve the scale factor applied to an actor.
963 * @return A vector representing the scale factor for each axis.
964 * @pre The Actor has been initialized.
965 * @note This property can be animated; the return value may not match the value written with SetScale().
967 Vector3 GetCurrentScale() const;
970 * @brief Retrieve the world-scale of the Actor.
973 * @return The Actor's current scale in the world.
974 * @pre The Actor has been initialized.
975 * @note The actor will not have a world-scale, unless it has previously been added to the stage.
977 Vector3 GetCurrentWorldScale() const;
980 * @brief Set whether a child actor inherits it's parent's scale.
982 * Default is to inherit.
983 * Switching this off means that using SetScale() sets the actor's world scale.
985 * @param[in] inherit - true if the actor should inherit scale, false otherwise.
986 * @pre The Actor has been initialized.
988 void SetInheritScale( bool inherit );
991 * @brief Returns whether the actor inherits its parent's scale.
994 * @return True if the actor inherits its parent scale, false if it uses world scale.
995 * @pre The Actor has been initialized.
997 bool IsScaleInherited() const;
1000 * @brief Retrieves the world-matrix of the actor.
1003 * @return The Actor's current world matrix
1004 * @pre The Actor has been initialized.
1005 * @note The actor will not have a world-matrix, unless it has previously been added to the stage.
1007 Matrix GetCurrentWorldMatrix() const;
1009 // Visibility & Color
1012 * @brief Sets the visibility flag of an actor.
1015 * @param [in] visible The new visibility flag.
1016 * @pre The actor has been initialized.
1017 * @note This is an asynchronous method; the value written may not match a value subsequently read with IsVisible().
1018 * @note If an actor's visibility flag is set to false, then the actor and its children will not be rendered.
1019 * This is regardless of the individual visibility values of the children i.e. an actor will only be
1020 * rendered if all of its parents have visibility set to true.
1022 void SetVisible(bool visible);
1025 * @brief Retrieve the visibility flag of an actor.
1028 * @return The visibility flag.
1029 * @pre The actor has been initialized.
1030 * @note This property can be animated; the return value may not match the value written with SetVisible().
1031 * @note If an actor is not visible, then the actor and its children will not be rendered.
1032 * This is regardless of the individual visibility values of the children i.e. an actor will only be
1033 * rendered if all of its parents have visibility set to true.
1035 bool IsVisible() const;
1038 * @brief Sets the opacity of an actor.
1041 * @param [in] opacity The new opacity.
1042 * @pre The actor has been initialized.
1043 * @note This is an asynchronous method; the value written may not match a value subsequently read with GetCurrentOpacity().
1045 void SetOpacity(float opacity);
1048 * @brief Retrieve the actor's opacity.
1051 * @return The actor's opacity.
1052 * @pre The actor has been initialized.
1053 * @note This property can be animated; the return value may not match the value written with SetOpacity().
1055 float GetCurrentOpacity() const;
1058 * @brief Sets the actor's color; this is an RGBA value.
1060 * The final color of the actor depends on its color mode.
1062 * @param [in] color The new color.
1063 * @pre The Actor has been initialized.
1064 * @note This is an asynchronous method; the value written may not match a value subsequently read with GetCurrentColor().
1066 void SetColor(const Vector4& color);
1069 * @brief Retrieve the actor's color.
1071 * Actor's own color is not clamped.
1073 * @return The color.
1074 * @pre The Actor has been initialized.
1075 * @note This property can be animated; the return value may not match the value written with SetColor().
1077 Vector4 GetCurrentColor() const;
1080 * @brief Sets the actor's color mode.
1082 * This specifies whether the Actor uses its own color, or inherits
1083 * its parent color. The default is USE_OWN_MULTIPLY_PARENT_ALPHA.
1085 * @param [in] colorMode to use.
1086 * @pre The Actor has been initialized.
1088 void SetColorMode( ColorMode colorMode );
1091 * @brief Returns the actor's color mode.
1094 * @return currently used colorMode.
1095 * @pre The Actor has been initialized.
1097 ColorMode GetColorMode() const;
1100 * @brief Retrieve the world-color of the Actor, where each component is clamped within the 0->1 range.
1103 * @return The Actor's current color in the world.
1104 * @pre The Actor has been initialized.
1105 * @note The actor will not have a world-color, unless it has previously been added to the stage.
1107 Vector4 GetCurrentWorldColor() const;
1110 * @brief Set how the actor and its children should be drawn.
1112 * Not all actors are renderable, but DrawMode can be inherited from any actor.
1113 * If an object is in a 3D layer, it will be depth-tested against
1114 * other objects in the world i.e. it may be obscured if other objects are in front.
1116 * If DrawMode::OVERLAY_2D is used, the actor and its children will be drawn as a 2D overlay.
1117 * Overlay actors are drawn in a separate pass, after all non-overlay actors within the Layer.
1118 * For overlay actors, the drawing order is with respect to tree levels of Actors,
1119 * and depth-testing will not be used.
1122 * @param[in] drawMode The new draw-mode to use.
1123 * @note Layers do not inherit the DrawMode from their parents.
1125 void SetDrawMode( DrawMode::Type drawMode );
1128 * @brief Query how the actor and its children will be drawn.
1131 * @return Return the draw mode type.
1133 DrawMode::Type GetDrawMode() const;
1138 * @brief Sets whether an actor should emit touch or hover signals.
1140 * An actor is sensitive by default, which means that as soon as an application connects to the SignalTouch(),
1141 * the touch event signal will be emitted, and as soon as an application connects to the SignalHover(), the
1142 * hover event signal will be emitted.
1144 * If the application wishes to temporarily disable the touch or hover event signal emission, then they can do so by calling:
1146 * actor.SetSensitive(false);
1149 * Then, to re-enable the touch or hover event signal emission, the application should call:
1151 * actor.SetSensitive(true);
1155 * @param[in] sensitive true to enable emission of the touch or hover event signals, false otherwise.
1156 * @pre The Actor has been initialized.
1157 * @note If an actor's sensitivity is set to false, then it's children will not be hittable either.
1158 * This is regardless of the individual sensitivity values of the children i.e. an actor will only be
1159 * hittable if all of its parents have sensitivity set to true.
1160 * @see @see TouchedSignal() and HoveredSignal().
1162 void SetSensitive(bool sensitive);
1165 * @brief Query whether an actor emits touch or hover event signals.
1168 * @return True, if emission of touch or hover event signals is enabled, false otherwise.
1169 * @pre The Actor has been initialized.
1170 * @note If an actor is not sensitive, then it's children will not be hittable either.
1171 * This is regardless of the individual sensitivity values of the children i.e. an actor will only be
1172 * hittable if all of its parents have sensitivity set to true.
1174 bool IsSensitive() const;
1177 * @brief Converts screen coordinates into the actor's coordinate system using the default camera.
1180 * @param[out] localX On return, the X-coordinate relative to the actor.
1181 * @param[out] localY On return, the Y-coordinate relative to the actor.
1182 * @param[in] screenX The screen X-coordinate.
1183 * @param[in] screenY The screen Y-coordinate.
1184 * @return True if the conversion succeeded.
1185 * @pre The Actor has been initialized.
1186 * @note The actor coordinates are relative to the top-left (0.0, 0.0, 0.5)
1188 bool ScreenToLocal(float& localX, float& localY, float screenX, float screenY) const;
1191 * @brief Sets whether the actor should receive a notification when touch or hover motion events leave
1192 * the boundary of the actor.
1195 * @param[in] required Should be set to true if a Leave event is required
1196 * @pre The Actor has been initialized.
1197 * @note By default, this is set to false as most actors do not require this.
1198 * @note Need to connect to the TouchedSignal() or HoveredSignal() to actually receive this event.
1201 void SetLeaveRequired(bool required);
1204 * @brief This returns whether the actor requires touch or hover events whenever touch or hover motion events leave
1205 * the boundary of the actor.
1208 * @return True if a Leave event is required, false otherwise.
1209 * @pre The Actor has been initialized.
1211 bool GetLeaveRequired() const;
1214 * @brief Sets whether the actor should be focusable by keyboard navigation.
1216 * The default is false.
1218 * @param[in] focusable - true if the actor should be focusable by keyboard navigation,
1220 * @pre The Actor has been initialized.
1222 void SetKeyboardFocusable( bool focusable );
1225 * @brief Returns whether the actor is focusable by keyboard navigation.
1228 * @return True if the actor is focusable by keyboard navigation, false if not.
1229 * @pre The Actor has been initialized.
1231 bool IsKeyboardFocusable() const;
1236 * @brief Set the resize policy to be used for the given dimension(s).
1239 * @param[in] policy The resize policy to use
1240 * @param[in] dimension The dimension(s) to set policy for. Can be a bitfield of multiple dimensions.
1242 void SetResizePolicy( ResizePolicy::Type policy, Dimension::Type dimension );
1245 * @brief Return the resize policy used for a single dimension.
1248 * @param[in] dimension The dimension to get policy for
1249 * @return Return the dimension resize policy. If more than one dimension is requested, just return the first one found.
1251 ResizePolicy::Type GetResizePolicy( Dimension::Type dimension ) const;
1254 * @brief Set the policy to use when setting size with size negotiation. Defaults to SizeScalePolicy::USE_SIZE_SET.
1257 * @param[in] policy The policy to use for when the size is set
1259 void SetSizeScalePolicy( SizeScalePolicy::Type policy );
1262 * @brief Return the size scale policy in use.
1265 * @return Return the size scale policy.
1267 SizeScalePolicy::Type GetSizeScalePolicy() const;
1270 * @brief Sets the relative to parent size factor of the actor.
1272 * This factor is only used when ResizePolicy is set to either:
1273 * ResizePolicy::SIZE_RELATIVE_TO_PARENT or ResizePolicy::SIZE_FIXED_OFFSET_FROM_PARENT.
1274 * This actor's size is set to the actor's size multipled by or added to this factor,
1275 * depending on ResizePolicy ( See SetResizePolicy() ).
1278 * @param [in] factor A Vector3 representing the relative factor to be applied to each axis.
1279 * @pre The Actor has been initialized.
1281 void SetSizeModeFactor( const Vector3& factor );
1284 * @brief Retrieve the relative to parent size factor of the actor.
1287 * @return The Actor's current relative size factor.
1288 * @pre The Actor has been initialized.
1290 Vector3 GetSizeModeFactor() const;
1293 * @brief Calculate the height of the actor given a width.
1295 * The natural size is used for default calculation.
1296 * size 0 is treated as aspect ratio 1:1.
1299 * @param width Width to use
1300 * @return Return the height based on the width.
1302 float GetHeightForWidth( float width );
1305 * @brief Calculate the width of the actor given a height.
1307 * The natural size is used for default calculation.
1308 * size 0 is treated as aspect ratio 1:1.
1311 * @param height Height to use
1312 * @return Return the width based on the height.
1314 float GetWidthForHeight( float height );
1317 * @brief Return the value of negotiated dimension for the given dimension.
1320 * @param dimension The dimension to retrieve
1321 * @return Return the value of the negotiated dimension. If more than one dimension is requested, just return the first one found.
1323 float GetRelayoutSize( Dimension::Type dimension ) const;
1326 * @brief Set the padding for use in layout.
1329 * @param[in] padding Padding for the actor
1331 void SetPadding( const Padding& padding );
1334 * @brief Return the value of the padding.
1337 * @param paddingOut The returned padding data
1339 void GetPadding( Padding& paddingOut ) const;
1342 * @brief Set the minimum size an actor can be assigned in size negotiation.
1345 * @param[in] size The minimum size
1347 void SetMinimumSize( const Vector2& size );
1350 * @brief Return the minimum relayout size.
1353 * @return Return the mininmum size.
1355 Vector2 GetMinimumSize();
1358 * @brief Set the maximum size an actor can be assigned in size negotiation.
1361 * @param[in] size The maximum size
1363 void SetMaximumSize( const Vector2& size );
1366 * @brief Return the maximum relayout size.
1369 * @return Return the maximum size.
1371 Vector2 GetMaximumSize();
1374 * @brief Get depth in the hierarchy for the actor.
1377 * @return The current depth in the hierarchy of the actor, or -1 if actor is not in the hierarchy
1379 int GetHierarchyDepth();
1384 * @brief Add a renderer to this actor.
1387 * @param[in] renderer Renderer to add to the actor
1388 * @return The index of the Renderer that was added
1389 * @pre The renderer must be initialized.
1392 unsigned int AddRenderer( Renderer& renderer );
1395 * @brief Get the number of renderers on this actor.
1398 * @return the number of renderers on this actor
1400 unsigned int GetRendererCount() const;
1403 * @brief Get a Renderer by index.
1406 * @param[in] index The index of the renderer to fetch
1407 * @return The renderer at the specified index
1408 * @pre The index must be between 0 and GetRendererCount()-1
1411 Renderer GetRendererAt( unsigned int index );
1414 * @brief Remove an renderer from the actor.
1417 * @param[in] renderer Handle to the renderer that is to be removed
1419 void RemoveRenderer( Renderer& renderer );
1422 * @brief Remove an renderer from the actor by index.
1425 * @param[in] index Index of the renderer that is to be removed
1426 * @pre The index must be between 0 and GetRendererCount()-1
1429 void RemoveRenderer( unsigned int index );
1434 * @DEPRECATED_1_1.37 Use TouchSignal() instead.
1435 * @brief This signal is emitted when touch input is received.
1437 * A callback of the following type may be connected:
1439 * bool YourCallbackName(Actor actor, const TouchEvent& event);
1441 * The return value of True, indicates that the touch event should be consumed.
1442 * Otherwise the signal will be emitted on the next sensitive parent of the actor.
1444 * @return The signal to connect to.
1445 * @pre The Actor has been initialized.
1447 TouchSignalType& TouchedSignal();
1450 * @brief This signal is emitted when touch input is received.
1452 * A callback of the following type may be connected:
1454 * bool YourCallbackName( Actor actor, TouchData& touch );
1456 * The return value of True, indicates that the touch event has been consumed.
1457 * Otherwise the signal will be emitted on the next sensitive parent of the actor.
1459 * @return The signal to connect to.
1460 * @pre The Actor has been initialized.
1462 TouchDataSignalType& TouchSignal();
1465 * @brief This signal is emitted when hover input is received.
1467 * A callback of the following type may be connected:
1469 * bool YourCallbackName(Actor actor, const HoverEvent& event);
1471 * The return value of True, indicates that the hover event should be consumed.
1472 * Otherwise the signal will be emitted on the next sensitive parent of the actor.
1474 * @return The signal to connect to.
1475 * @pre The Actor has been initialized.
1477 HoverSignalType& HoveredSignal();
1480 * @brief This signal is emitted when wheel event is received.
1482 * A callback of the following type may be connected:
1484 * bool YourCallbackName(Actor actor, const WheelEvent& event);
1486 * The return value of True, indicates that the wheel event should be consumed.
1487 * Otherwise the signal will be emitted on the next sensitive parent of the actor.
1489 * @return The signal to connect to.
1490 * @pre The Actor has been initialized.
1492 WheelEventSignalType& WheelEventSignal();
1495 * @brief This signal is emitted after the actor has been connected to the stage.
1497 * When an actor is connected, it will be directly or indirectly parented to the root Actor.
1499 * @return The signal to connect to.
1500 * @note The root Actor is provided automatically by Dali::Stage, and is always considered to be connected.
1502 * @note When the parent of a set of actors is connected to the stage, then all of the children
1503 * will received this callback.
1504 * For the following actor tree, the callback order will be A, B, D, E, C, and finally F.
1516 OnStageSignalType& OnStageSignal();
1519 * @brief This signal is emitted after the actor has been disconnected from the stage.
1521 * If an actor is disconnected it either has no parent, or is parented to a disconnected actor.
1524 * @return The signal to connect to.
1525 * @note When the parent of a set of actors is disconnected to the stage, then all of the children
1526 * will received this callback, starting with the leaf actors.
1527 * For the following actor tree, the callback order will be D, E, B, F, C, and finally A.
1540 OffStageSignalType& OffStageSignal();
1543 * @brief This signal is emitted after the size has been set on the actor during relayout
1546 * @return The signal
1548 OnRelayoutSignalType& OnRelayoutSignal();
1550 public: // Not intended for application developers
1554 * @brief This constructor is used by Actor::New() methods.
1557 * @param [in] actor A pointer to a newly allocated Dali resource
1559 explicit DALI_INTERNAL Actor(Internal::Actor* actor);
1564 * @brief Helper for discarding an actor handle.
1566 * If the handle is empty, this method does nothing. Otherwise
1567 * Actor::Unparent() will be called, followed by Actor::Reset().
1569 * @param[in,out] actor A handle to an actor, or an empty handle.
1571 inline void UnparentAndReset( Actor& actor )
1585 #endif // DALI_ACTOR_H