5 * Copyright (c) 2020 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.
23 #include <cstdint> // uint32_t
26 #include <dali/public-api/actors/actor-enumerations.h>
27 #include <dali/public-api/actors/draw-mode.h>
28 #include <dali/public-api/math/radian.h>
29 #include <dali/public-api/object/handle.h>
30 #include <dali/public-api/object/property-index-ranges.h>
31 #include <dali/public-api/signals/dali-signal.h>
33 #undef SIZE_WIDTH // Defined in later versions of cstdint but is used in this header
38 * @addtogroup dali_core_actors
42 namespace Internal DALI_INTERNAL
61 typedef Rect<float> Padding; ///< Padding definition @SINCE_1_0.0
64 * @brief Actor is the primary object with which Dali applications interact.
66 * UI controls can be built by combining multiple actors.
68 * <h3>Multi-Touch Events:</h3>
70 * Touch or hover events are received via signals; see Actor::TouchedSignal() and Actor::HoveredSignal() for more details.
72 * <i>Hit Testing Rules Summary:</i>
74 * - An actor is only hittable if the actor's touch or hover signal has a connection.
75 * - An actor is only hittable when it is between the camera's near and far planes.
76 * - If an actor is made insensitive, then the actor and its children are not hittable; see Actor::Property::SENSITIVE.
77 * - If an actor's visibility flag is unset, then none of its children are hittable either; see Actor::Property::VISIBLE.
78 * - To be hittable, an actor must have a non-zero size.
79 * - If an actor's world color is fully transparent, then it is not hittable; see GetCurrentWorldColor().
81 * <i>Hit Test Algorithm:</i>
84 * - Gets the first down and the last up touch events to the screen, regardless of actor touch event consumption.
85 * - Stage's root layer can be used to catch unconsumed touch events.
88 * - Hit testing is dependent on the camera used, which is specific to each RenderTask.
91 * - For each RenderTask, hit testing starts from the top-most layer and we go through all the
92 * layers until we have a hit or there are none left.
93 * - Before we perform a hit test within a layer, we check if all the layer's parents are visible
95 * - If they are not, we skip hit testing the actors in that layer altogether.
96 * - If a layer is set to consume all touch, then we do not check any layers behind this layer.
99 * - The final part of hit testing is performed by walking through the actor tree within a layer.
100 * - The following pseudocode shows the algorithm used:
102 * HIT-TEST-WITHIN-LAYER( ACTOR )
104 * // Only hit-test the actor and its children if it is sensitive and visible
105 * IF ( ACTOR-IS-SENSITIVE &&
106 * ACTOR-IS-VISIBLE &&
107 * ACTOR-IS-ON-STAGE )
109 * // Depth-first traversal within current layer, visiting parent first
111 * // Check whether current actor should be hit-tested.
112 * IF ( ( TOUCH-SIGNAL-NOT-EMPTY || HOVER-SIGNAL-NOT-EMPTY ) &&
113 * ACTOR-HAS-NON-ZERO-SIZE &&
114 * ACTOR-WORLD-COLOR-IS-NOT-TRANSPARENT )
116 * // Hit-test current actor
119 * IF ( ACTOR-IS-OVERLAY || ( DISTANCE-TO-ACTOR < DISTANCE-TO-LAST-HIT-ACTOR ) )
121 * // The current actor is the closest actor that was underneath the touch.
122 * LAST-HIT-ACTOR = CURRENT-ACTOR
127 * // Keep checking children, in case we hit something closer.
128 * FOR-EACH CHILD (in order)
130 * IF ( CHILD-IS-NOT-A-LAYER )
132 * // Continue traversal for this child's sub-tree
133 * HIT-TEST-WITHIN-LAYER ( CHILD )
135 * // else we skip hit-testing the child's sub-tree altogether.
140 * - Overlays always take priority (i.e. they're considered closer) regardless of distance.
141 * The overlay children take priority over their parents, and overlay siblings take priority
142 * over their previous siblings (i.e. reverse of rendering order):
152 * Hit Priority of above Actor tree (all overlays): 1 - Lowest. 6 - Highest.
154 * For more information, see Property::DRAW_MODE.
156 * <i>Touch or hover Event Delivery:</i>
159 * - The hit actor's touch or hover signal is emitted first; if it is not consumed by any of the listeners,
160 * the parent's touch or hover signal is emitted, and so on.
161 * - The following pseudocode shows the delivery mechanism:
163 * EMIT-TOUCH-SIGNAL( ACTOR )
165 * IF ( TOUCH-SIGNAL-NOT-EMPTY )
167 * // Only do the emission if touch signal of actor has connections.
168 * CONSUMED = TOUCHED-SIGNAL( TOUCH-EVENT )
171 * IF ( NOT-CONSUMED )
173 * // If event is not consumed then deliver it to the parent unless we reach the root actor
174 * IF ( ACTOR-PARENT )
176 * EMIT-TOUCH-SIGNAL( ACTOR-PARENT )
181 * EMIT-HOVER-SIGNAL( ACTOR )
183 * IF ( HOVER-SIGNAL-NOT-EMPTY )
185 * // Only do the emission if hover signal of actor has connections.
186 * CONSUMED = HOVERED-SIGNAL( HOVER-EVENT )
189 * IF ( NOT-CONSUMED )
191 * // If event is not consumed then deliver it to the parent unless we reach the root actor.
192 * IF ( ACTOR-PARENT )
194 * EMIT-HOVER-SIGNAL( ACTOR-PARENT )
199 * - If there are several touch points, then the delivery is only to the first touch point's hit
200 * actor (and its parents). There will be NO touch or hover signal delivery for the hit actors of the
201 * other touch points.
202 * - The local coordinates are from the top-left (0.0f, 0.0f, 0.5f) of the hit actor.
205 * - A "Leave" state is set when the first point exits the bounds of the previous first point's
206 * hit actor (primary hit actor).
207 * - When this happens, the last primary hit actor's touch or hover signal is emitted with a "Leave" state
208 * (only if it requires leave signals); see SetLeaveRequired().
210 * - Interrupted State
211 * - If a system event occurs which interrupts the touch or hover processing, then the last primary hit
212 * actor's touch or hover signals are emitted with an "Interrupted" state.
213 * - If the last primary hit actor, or one of its parents, is no longer touchable or hoverable, then its
214 * touch or hover signals are also emitted with an "Interrupted" state.
215 * - If the consumed actor on touch-down is not the same as the consumed actor on touch-up, then
216 * touch signals are also emitted from the touch-down actor with an "Interrupted" state.
217 * - If the consumed actor on hover-start is not the same as the consumed actor on hover-finished, then
218 * hover signals are also emitted from the hover-started actor with an "Interrupted" state.
220 * <h3>Key Events:</h3>
222 * Key events are received by an actor once set to grab key events, only one actor can be set as focused.
227 * | %Signal Name | Method |
228 * |-------------------|------------------------------|
229 * | touched | @ref TouchedSignal() |
230 * | hovered | @ref HoveredSignal() |
231 * | wheelEvent | @ref WheelEventSignal() |
232 * | onStage | @ref OnStageSignal() |
233 * | offStage | @ref OffStageSignal() |
234 * | onRelayout | @ref OnRelayoutSignal() |
237 * | %Action Name | %Actor method called |
238 * |-------------------|------------------------------|
239 * | show | %SetVisible( true ) |
240 * | hide | %SetVisible( false ) |
244 class DALI_CORE_API Actor : public Handle
249 * @brief Enumeration for the instance of properties belonging to the Actor class.
255 * @brief Enumeration for instance of properties belonging to the Actor class.
261 * @brief The origin of an actor, within its parent's area.
262 * @details Name "parentOrigin", type Property::VECTOR3, constraint-input
265 PARENT_ORIGIN = DEFAULT_ACTOR_PROPERTY_START_INDEX,
268 * @brief The x origin of an actor, within its parent's area.
269 * @details Name "parentOriginX", type Property::FLOAT, constraint-input
275 * @brief The y origin of an actor, within its parent's area.
276 * @details Name "parentOriginY", type Property::FLOAT, constraint-input
282 * @brief The z origin of an actor, within its parent's area.
283 * @details Name "parentOriginZ", type Property::FLOAT, constraint-input
289 * @brief The anchor-point of an actor.
290 * @details Name "anchorPoint", type Property::VECTOR3, constraint-input
296 * @brief The x anchor-point of an actor.
297 * @details Name "anchorPointX", type Property::FLOAT, constraint-input
303 * @brief The y anchor-point of an actor.
304 * @details Name "anchorPointY", type Property::FLOAT, constraint-input
310 * @brief The z anchor-point of an actor.
311 * @details Name "anchorPointZ", type Property::FLOAT, constraint-input
317 * @brief The size of an actor.
318 * @details Name "size", type Property::VECTOR3, animatable / constraint-input
320 * @see Actor::SetSize()
325 * @brief The width of an actor.
326 * @details Name "sizeWidth", type Property::FLOAT, animatable / constraint-input
328 * @see Actor::SetSize()
333 * @brief The height of an actor.
334 * @details Name "sizeHeight", type Property::FLOAT, animatable / constraint-input
336 * @see Actor::SetSize()
341 * @brief The depth of an actor.
342 * @details Name "sizeDepth", type Property::FLOAT, animatable / constraint-input
344 * @see Actor::SetSize()
349 * @brief The position of an actor.
350 * @details Name "position", type Property::VECTOR3, animatable / constraint-input
352 * @see Actor::SetPosition()
357 * @brief The x position of an actor.
358 * @details Name "positionX", type Property::FLOAT, animatable / constraint-input
365 * @brief The y position of an actor.
366 * @details Name "positionY", type Property::FLOAT, animatable / constraint-input
373 * @brief The z position of an actor.
374 * @details Name "positionZ", type Property::FLOAT, animatable / constraint-input
381 * @brief The world position of an actor.
382 * @details Name "worldPosition", type Property::VECTOR3, read-only / constraint-input
388 * @brief The x world position of an actor.
389 * @details Name "worldPositionX", type Property::FLOAT, read-only / constraint-input
395 * @brief The y world position of an actor.
396 * @details Name "worldPositionY", type Property::FLOAT, read-only / constraint-input
402 * @brief The z world position of an actor.
403 * @details Name "worldPositionZ", type Property::FLOAT, read-only / constraint-input
409 * @brief The orientation of an actor.
410 * @details Name "orientation", type Property::ROTATION, animatable / constraint-input
416 * @brief The world orientation of an actor.
417 * @details Name "worldOrientation", type Property::ROTATION, read-only / constraint-input
423 * @brief The scale factor applied to an actor.
424 * @details Name "scale", type Property::VECTOR3, animatable / constraint-input
426 * @see Actor::SetScale()
431 * @brief The x scale factor applied to an actor.
432 * @details Name "scaleX", type Property::FLOAT, animatable / constraint-input
434 * @see Actor::SetScale()
439 * @brief The y scale factor applied to an actor.
440 * @details Name "scaleY", type Property::FLOAT, animatable / constraint-input
442 * @see Actor::SetScale()
447 * @brief The x scale factor applied to an actor.
448 * @details Name "scaleZ", type Property::FLOAT, animatable / constraint-input
450 * @see Actor::SetScale()
455 * @brief The world scale factor applied to an actor.
456 * @details Name "worldScale", type Property::VECTOR3, read-only / constraint-input
462 * @brief The visibility flag of an actor.
463 * @details Name "visible", type Property::BOOL, animatable / constraint-input
469 * @brief The color of an actor.
470 * @details Name "color", type Property::VECTOR4 or Property::VECTOR3, animatable / constraint-input
471 * @note The alpha value will be 1.0f if a Vector3 type value is set.
477 * @brief The red component of an actor's color.
478 * @details Name "colorRed", type Property::FLOAT, animatable / constraint-input
484 * @brief The green component of an actor's color.
485 * @details Name "colorGreen", type Property::FLOAT, animatable / constraint-input
491 * @brief The blue component of an actor's color.
492 * @details Name "colorBlue", type Property::FLOAT, animatable / constraint-input
498 * @brief The alpha component of an actor's color.
499 * @details Name "colorAlpha", type Property::FLOAT, animatable / constraint-input
505 * @brief The world color of an actor.
506 * @details Name "worldColor", type Property::VECTOR4, read-only / constraint-input
512 * @brief The world matrix of an actor.
513 * @details Name "worldMatrix", type Property::MATRIX, read-only / constraint-input
519 * @brief The name of an actor.
520 * @details Name "name", type Property::STRING
526 * @brief The flag whether an actor should emit touch or hover signals.
527 * @details Name "sensitive", type Property::BOOLEAN
533 * @brief The flag whether an actor should receive a notification when touch or hover motion events leave.
534 * @details Name "leaveRequired", type Property::BOOLEAN
540 * @brief The flag whether a child actor inherits it's parent's orientation.
541 * @details Name "inheritOrientation", type Property::BOOLEAN
547 * @brief The flag whether a child actor inherits it's parent's scale.
548 * @details Name "inheritScale", type Property::BOOLEAN
554 * @brief The color mode of an actor.
555 * @details Name "colorMode", type ColorMode (Property::INTEGER) or Property::STRING.
561 * @brief This property is removed because it's deprecated.
563 RESERVED_PROPERTY_01,
566 * @brief The draw mode of an actor.
567 * @details Name "drawMode", type DrawMode::Type (Property::INTEGER) or Property::STRING.
573 * @brief The size mode factor of an actor.
574 * @details Name "sizeModeFactor", type Property::VECTOR3.
576 * @see Actor::SetSizeModeFactor()
581 * @brief The resize policy for the width of an actor.
582 * @details Name "widthResizePolicy", type ResizePolicy::Type (Property::INTEGER) or Property::STRING.
584 * @see Actor::SetResizePolicy()
589 * @brief The resize policy for the height of an actor.
590 * @details Name "heightResizePolicy", type ResizePolicy::Type (Property::INTEGER) or Property::STRING.
592 * @see Actor::SetResizePolicy()
594 HEIGHT_RESIZE_POLICY,
597 * @brief The size scale policy of an actor.
598 * @details Name "sizeScalePolicy", type SizeScalePolicy::Type (Property::INTEGER) or Property::STRING.
604 * @brief The flag to determine the width dependent on the height.
605 * @details Name "widthForHeight", type Property::BOOLEAN.
607 * @see Actor::SetResizePolicy()
612 * @brief The flag to determine the height dependent on the width.
613 * @details Name "heightForWidth", type Property::BOOLEAN.
615 * @see Actor::SetResizePolicy()
620 * @brief The padding of an actor for use in layout.
621 * @details Name "padding", type Property::VECTOR4.
627 * @brief The minimum size an actor can be assigned in size negotiation.
628 * @details Name "minimumSize", type Property::VECTOR2.
634 * @brief The maximum size an actor can be assigned in size negotiation.
635 * @details Name "maximumSize", type Property::VECTOR2.
641 * @brief The flag whether a child actor inherits it's parent's position.
642 * @details Name "inheritPosition", type Property::BOOLEAN.
648 * @brief The clipping mode of an actor.
649 * @details Name "clippingMode", type ClippingMode::Type (Property::INTEGER) or Property::STRING.
651 * @see ClippingMode::Type for supported values.
656 * @brief The direction of the layout.
657 * @details Name "layoutDirection", type LayoutDirection::Type (Property::INTEGER) or Property::STRING.
659 * @see LayoutDirection::Type for supported values.
664 * @brief Determines whether child actors inherit the layout direction from a parent.
665 * @details Name "layoutDirectionInheritance", type Property::BOOLEAN.
668 INHERIT_LAYOUT_DIRECTION,
674 typedef Signal< bool (Actor, const TouchEvent&) > TouchSignalType; ///< @DEPRECATED_1_1.37 @brief Touch signal type @SINCE_1_0.0
675 typedef Signal< bool (Actor, const TouchData&) > TouchDataSignalType; ///< Touch signal type @SINCE_1_1.37
676 typedef Signal< bool (Actor, const HoverEvent&) > HoverSignalType; ///< Hover signal type @SINCE_1_0.0
677 typedef Signal< bool (Actor, const WheelEvent&) > WheelEventSignalType; ///< Wheel signal type @SINCE_1_0.0
678 typedef Signal< void (Actor) > OnStageSignalType; ///< Stage connection signal type @SINCE_1_0.0
679 typedef Signal< void (Actor) > OffStageSignalType; ///< Stage disconnection signal type @SINCE_1_0.0
680 typedef Signal< void (Actor) > OnRelayoutSignalType; ///< Called when the actor is relaid out @SINCE_1_0.0
681 typedef Signal< void ( Actor, LayoutDirection::Type ) > LayoutDirectionChangedSignalType; ///< Layout direction changes signal type. @SINCE_1_2.60
686 * @brief Creates an uninitialized Actor; this can be initialized with Actor::New().
688 * Calling member functions with an uninitialized Actor handle is not allowed.
694 * @brief Creates an initialized Actor.
697 * @return A handle to a newly allocated Dali resource
702 * @brief Downcasts a handle to Actor handle.
704 * If handle points to an Actor object, the downcast produces valid handle.
705 * If not, the returned handle is left uninitialized.
708 * @param[in] handle to An object
709 * @return handle to a Actor object or an uninitialized handle
711 static Actor DownCast( BaseHandle handle );
714 * @brief Dali::Actor is intended as a base class.
716 * This is non-virtual since derived Handle types must not contain data or virtual methods.
722 * @brief Copy constructor.
725 * @param[in] copy The actor to copy
727 Actor(const Actor& copy);
730 * @brief Assignment operator
733 * @param[in] rhs The actor to copy
734 * @return A reference to this
736 Actor& operator=(const Actor& rhs);
739 * @brief Retrieves the unique ID of the actor.
743 * @pre The Actor has been initialized.
745 uint32_t GetId() const;
750 * @brief Queries whether an actor is the root actor, which is owned by the Stage.
753 * @return True if the actor is the root actor
754 * @pre The Actor has been initialized.
759 * @brief Queries whether the actor is connected to the Stage.
761 * When an actor is connected, it will be directly or indirectly parented to the root Actor.
763 * @return True if the actor is connected to the Stage
764 * @pre The Actor has been initialized.
765 * @note The root Actor is provided automatically by Dali::Stage, and is always considered to be connected.
767 bool OnStage() const;
770 * @brief Queries whether the actor is of class Dali::Layer.
773 * @return True if the actor is a layer
774 * @pre The Actor has been initialized.
776 bool IsLayer() const;
779 * @brief Gets the layer in which the actor is present.
782 * @return The layer, which will be uninitialized if the actor is off-stage
783 * @pre The Actor has been initialized.
788 * @brief Adds a child Actor to this Actor.
791 * @param[in] child The child
792 * @pre This Actor (the parent) has been initialized.
793 * @pre The child actor has been initialized.
794 * @pre The child actor is not the same as the parent actor.
795 * @pre The actor is not the Root actor.
796 * @post The child will be referenced by its parent. This means that the child will be kept alive,
797 * even if the handle passed into this method is reset or destroyed.
798 * @note If the child already has a parent, it will be removed from old parent
799 * and reparented to this actor. This may change child's position, color,
800 * scale etc as it now inherits them from this actor.
802 void Add(Actor child);
805 * @brief Removes a child Actor from this Actor.
807 * If the actor was not a child of this actor, this is a no-op.
809 * @param[in] child The child
810 * @pre This Actor (the parent) has been initialized.
811 * @pre The child actor is not the same as the parent actor.
813 void Remove(Actor child);
816 * @brief Removes an actor from its parent.
818 * If the actor has no parent, this method does nothing.
820 * @pre The (child) actor has been initialized.
825 * @brief Retrieves the number of children held by the actor.
828 * @return The number of children
829 * @pre The Actor has been initialized.
831 uint32_t GetChildCount() const;
834 * @brief Retrieve and child actor by index.
837 * @param[in] index The index of the child to retrieve
838 * @return The actor for the given index or empty handle if children not initialized
839 * @pre The Actor has been initialized.
841 Actor GetChildAt( uint32_t index ) const;
844 * @brief Search through this actor's hierarchy for an actor with the given name.
846 * The actor itself is also considered in the search.
848 * @param[in] actorName The name of the actor to find
849 * @return A handle to the actor if found, or an empty handle if not
850 * @pre The Actor has been initialized.
852 Actor FindChildByName(const std::string& actorName);
855 * @brief Search through this actor's hierarchy for an actor with the given unique ID.
857 * The actor itself is also considered in the search.
859 * @param[in] id The ID of the actor to find
860 * @return A handle to the actor if found, or an empty handle if not
861 * @pre The Actor has been initialized.
863 Actor FindChildById( const uint32_t id );
866 * @brief Retrieves the actor's parent.
869 * @return A handle to the actor's parent. If the actor has no parent, this handle will be invalid
870 * @pre The actor has been initialized.
872 Actor GetParent() const;
877 * @brief Sets the size of an actor.
879 * Geometry can be scaled to fit within this area.
880 * This does not interfere with the actors scale factor.
881 * The actors default depth is the minimum of width & height.
883 * @param [in] width The new width
884 * @param [in] height The new height
885 * @pre The actor has been initialized.
887 void SetSize(float width, float height);
890 * @brief Sets the size of an actor.
892 * Geometry can be scaled to fit within this area.
893 * This does not interfere with the actors scale factor.
895 * @param[in] width The size of the actor along the x-axis
896 * @param[in] height The size of the actor along the y-axis
897 * @param[in] depth The size of the actor along the z-axis
898 * @pre The actor has been initialized.
900 void SetSize(float width, float height, float depth);
903 * @brief Sets the size of an actor.
905 * Geometry can be scaled to fit within this area.
906 * This does not interfere with the actors scale factor.
907 * The actors default depth is the minimum of width & height.
909 * @param[in] size The new size
910 * @pre The actor has been initialized.
912 void SetSize(const Vector2& size);
915 * @brief Sets the size of an actor.
917 * Geometry can be scaled to fit within this area.
918 * This does not interfere with the actors scale factor.
920 * @param [in] size The new size
921 * @pre The actor has been initialized.
923 void SetSize(const Vector3& size);
926 * @brief Retrieves the actor's size.
929 * @return The actor's target size
930 * @pre The actor has been initialized.
931 * @note This return is the value that was set using SetSize or the target size of an animation.
932 * It may not match the current value in some cases, i.e. when the animation is progressing or the maximum or minimum size is set.
934 Vector3 GetTargetSize() const;
937 * @brief Returns the natural size of the actor.
939 * Deriving classes stipulate the natural size and by default an actor has a ZERO natural size.
942 * @return The actor's natural size
944 Vector3 GetNaturalSize() const;
947 * @brief Sets the position of the Actor.
949 * By default, sets the position vector between the parent origin and anchor point (default).
951 * If Position inheritance if disabled, sets the world position. @see Actor::Property::INHERIT_POSITION
953 * @image html actor-position.png
954 * The Actor's z position will be set to 0.0f.
956 * @param[in] x The new x position
957 * @param[in] y The new y position
958 * @pre The Actor has been initialized.
960 void SetPosition(float x, float y);
963 * @brief Sets the position of the Actor.
965 * By default, sets the position vector between the parent origin and anchor point (default).
967 * If Position inheritance if disabled, sets the world position. @see Actor::Property::INHERIT_POSITION
969 * @image html actor-position.png
971 * @param[in] x The new x position
972 * @param[in] y The new y position
973 * @param[in] z The new z position
974 * @pre The Actor has been initialized.
976 void SetPosition(float x, float y, float z);
979 * @brief Sets the position of the Actor.
981 * By default, sets the position vector between the parent origin and anchor point (default).
983 * If Position inheritance if disabled, sets the world position. @see Actor::Property::INHERIT_POSITION
985 * @image html actor-position.png
987 * @param[in] position The new position
988 * @pre The Actor has been initialized.
990 void SetPosition(const Vector3& position);
993 * @brief Sets the position of an actor along the X-axis.
996 * @param[in] x The new x position
997 * @pre The Actor has been initialized.
1002 * @brief Sets the position of an actor along the Y-axis.
1005 * @param[in] y The new y position
1006 * @pre The Actor has been initialized.
1011 * @brief Sets the position of an actor along the Z-axis.
1014 * @param[in] z The new z position
1015 * @pre The Actor has been initialized.
1020 * @brief Translates an actor relative to its existing position.
1023 * @param[in] distance The actor will move by this distance
1024 * @pre The actor has been initialized.
1026 void TranslateBy(const Vector3& distance);
1029 * @brief Applies a relative rotation to an actor.
1032 * @param[in] angle The angle to the rotation to combine with the existing orientation
1033 * @param[in] axis The axis of the rotation to combine with the existing orientation
1034 * @pre The actor has been initialized.
1036 void RotateBy( const Degree& angle, const Vector3& axis )
1038 RotateBy( Radian( angle ), axis );
1042 * @brief Applies a relative rotation to an actor.
1045 * @param[in] angle The angle to the rotation to combine with the existing orientation
1046 * @param[in] axis The axis of the rotation to combine with the existing orientation
1047 * @pre The actor has been initialized.
1049 void RotateBy(const Radian& angle, const Vector3& axis);
1052 * @brief Applies a relative rotation to an actor.
1055 * @param[in] relativeRotation The rotation to combine with the existing orientation
1056 * @pre The actor has been initialized.
1058 void RotateBy(const Quaternion& relativeRotation);
1061 * @brief Sets the scale factor applied to an actor.
1064 * @param[in] scale The scale factor applied on all axes
1065 * @pre The Actor has been initialized.
1066 * @note This is an asynchronous method; the value written may not match a value subsequently read with GetCurrentScale().
1068 void SetScale(float scale);
1071 * @brief Sets the scale factor applied to an actor.
1074 * @param[in] scaleX The scale factor applied along the x-axis
1075 * @param[in] scaleY The scale factor applied along the y-axis
1076 * @param[in] scaleZ The scale factor applied along the z-axis
1077 * @pre The Actor has been initialized.
1078 * @note This is an asynchronous method; the value written may not match a value subsequently read with GetCurrentScale().
1080 void SetScale(float scaleX, float scaleY, float scaleZ);
1083 * @brief Sets the scale factor applied to an actor.
1086 * @param[in] scale A vector representing the scale factor for each axis
1087 * @pre The Actor has been initialized.
1088 * @note This is an asynchronous method; the value written may not match a value subsequently read with GetCurrentScale().
1090 void SetScale(const Vector3& scale);
1093 * @brief Applies a relative scale to an actor.
1096 * @param[in] relativeScale The scale to combine with the actor's existing scale
1097 * @pre The actor has been initialized.
1099 void ScaleBy(const Vector3& relativeScale);
1104 * @brief Converts screen coordinates into the actor's coordinate system using the default camera.
1107 * @param[out] localX On return, the X-coordinate relative to the actor
1108 * @param[out] localY On return, the Y-coordinate relative to the actor
1109 * @param[in] screenX The screen X-coordinate
1110 * @param[in] screenY The screen Y-coordinate
1111 * @return True if the conversion succeeded
1112 * @pre The Actor has been initialized.
1113 * @note The actor coordinates are relative to the top-left (0.0, 0.0, 0.5)
1115 bool ScreenToLocal(float& localX, float& localY, float screenX, float screenY) const;
1118 * @brief Sets whether the actor should be focusable by keyboard navigation.
1120 * The default is false.
1122 * @param[in] focusable - true if the actor should be focusable by keyboard navigation,
1124 * @pre The Actor has been initialized.
1126 void SetKeyboardFocusable( bool focusable );
1129 * @brief Returns whether the actor is focusable by keyboard navigation.
1132 * @return @c true if the actor is focusable by keyboard navigation, @c false if not
1133 * @pre The Actor has been initialized.
1135 bool IsKeyboardFocusable() const;
1138 * @brief Raise actor above the next sibling actor.
1141 * @pre The Actor has been initialized.
1142 * @pre The Actor has been parented.
1147 * @brief Lower the actor below the previous sibling actor.
1150 * @pre The Actor has been initialized.
1151 * @pre The Actor has been parented.
1156 * @brief Raise actor above all other sibling actors.
1159 * @pre The Actor has been initialized.
1160 * @pre The Actor has been parented.
1165 * @brief Lower actor to the bottom of all other sibling actors.
1168 * @pre The Actor has been initialized.
1169 * @pre The Actor has been parented.
1171 void LowerToBottom();
1174 * @brief Raises the actor above the target actor.
1177 * @param[in] target The target actor
1178 * @pre The Actor has been initialized.
1179 * @pre The Actor has been parented.
1180 * @pre The target actor is a sibling.
1182 void RaiseAbove( Actor target );
1185 * @brief Lower the actor to below the target actor.
1188 * @param[in] target The target actor
1189 * @pre The Actor has been initialized.
1190 * @pre The Actor has been parented.
1191 * @pre The target actor is a sibling.
1193 void LowerBelow( Actor target );
1198 * @brief Sets the resize policy to be used for the given dimension(s).
1201 * @param[in] policy The resize policy to use
1202 * @param[in] dimension The dimension(s) to set policy for. Can be a bitfield of multiple dimensions
1204 void SetResizePolicy( ResizePolicy::Type policy, Dimension::Type dimension );
1207 * @brief Returns the resize policy used for a single dimension.
1210 * @param[in] dimension The dimension to get policy for
1211 * @return Return the dimension resize policy. If more than one dimension is requested, just return the first one found
1213 ResizePolicy::Type GetResizePolicy( Dimension::Type dimension ) const;
1216 * @brief Calculates the height of the actor given a width.
1218 * The natural size is used for default calculation.
1219 * size 0 is treated as aspect ratio 1:1.
1222 * @param[in] width Width to use
1223 * @return Return the height based on the width
1225 float GetHeightForWidth( float width );
1228 * @brief Calculates the width of the actor given a height.
1230 * The natural size is used for default calculation.
1231 * size 0 is treated as aspect ratio 1:1.
1234 * @param[in] height Height to use
1235 * @return Return the width based on the height
1237 float GetWidthForHeight( float height );
1240 * @brief Returns the value of negotiated dimension for the given dimension.
1243 * @param[in] dimension The dimension to retrieve
1244 * @return Return the value of the negotiated dimension. If more than one dimension is requested, just return the first one found
1246 float GetRelayoutSize( Dimension::Type dimension ) const;
1249 * @brief Gets depth in the hierarchy for the actor.
1252 * @return The current depth in the hierarchy of the actor, or @c -1 if actor is not in the hierarchy
1254 int32_t GetHierarchyDepth();
1259 * @brief Adds a renderer to this actor.
1262 * @param[in] renderer Renderer to add to the actor
1263 * @return The index of the Renderer that was added
1264 * @pre The renderer must be initialized.
1267 uint32_t AddRenderer( Renderer& renderer );
1270 * @brief Gets the number of renderers on this actor.
1273 * @return The number of renderers on this actor
1275 uint32_t GetRendererCount() const;
1278 * @brief Gets a Renderer by index.
1281 * @param[in] index The index of the renderer to fetch
1282 * @return The renderer at the specified index
1283 * @pre The index must be between 0 and GetRendererCount()-1
1286 Renderer GetRendererAt( uint32_t index );
1289 * @brief Removes a renderer from the actor.
1292 * @param[in] renderer Handle to the renderer that is to be removed
1294 void RemoveRenderer( Renderer& renderer );
1297 * @brief Removes a renderer from the actor by index.
1300 * @param[in] index Index of the renderer that is to be removed
1301 * @pre The index must be between 0 and GetRendererCount()-1
1304 void RemoveRenderer( uint32_t index );
1309 * @DEPRECATED_1_1.37 Use TouchSignal() instead.
1310 * @brief This signal is emitted when touch input is received.
1312 * A callback of the following type may be connected:
1314 * bool YourCallbackName(Actor actor, const TouchEvent& event);
1316 * The return value of True, indicates that the touch event should be consumed.
1317 * Otherwise the signal will be emitted on the next sensitive parent of the actor.
1319 * @return The signal to connect to
1320 * @pre The Actor has been initialized.
1322 TouchSignalType& TouchedSignal() DALI_DEPRECATED_API;
1325 * @brief This signal is emitted when touch input is received.
1327 * A callback of the following type may be connected:
1329 * bool YourCallbackName( Actor actor, TouchData& touch );
1331 * The return value of True, indicates that the touch event has been consumed.
1332 * Otherwise the signal will be emitted on the next sensitive parent of the actor.
1334 * @return The signal to connect to
1335 * @pre The Actor has been initialized.
1337 TouchDataSignalType& TouchSignal();
1340 * @brief This signal is emitted when hover input is received.
1342 * A callback of the following type may be connected:
1344 * bool YourCallbackName(Actor actor, const HoverEvent& event);
1346 * The return value of True, indicates that the hover event should be consumed.
1347 * Otherwise the signal will be emitted on the next sensitive parent of the actor.
1349 * @return The signal to connect to
1350 * @pre The Actor has been initialized.
1352 HoverSignalType& HoveredSignal();
1355 * @brief This signal is emitted when wheel event is received.
1357 * A callback of the following type may be connected:
1359 * bool YourCallbackName(Actor actor, const WheelEvent& event);
1361 * The return value of True, indicates that the wheel event should be consumed.
1362 * Otherwise the signal will be emitted on the next sensitive parent of the actor.
1364 * @return The signal to connect to
1365 * @pre The Actor has been initialized.
1367 WheelEventSignalType& WheelEventSignal();
1370 * @brief This signal is emitted after the actor has been connected to the stage.
1372 * When an actor is connected, it will be directly or indirectly parented to the root Actor.
1374 * @return The signal to connect to
1375 * @note The root Actor is provided automatically by Dali::Stage, and is always considered to be connected.
1377 * @note When the parent of a set of actors is connected to the stage, then all of the children
1378 * will received this callback.
1379 * For the following actor tree, the callback order will be A, B, D, E, C, and finally F.
1391 OnStageSignalType& OnStageSignal();
1394 * @brief This signal is emitted after the actor has been disconnected from the stage.
1396 * If an actor is disconnected it either has no parent, or is parented to a disconnected actor.
1399 * @return The signal to connect to
1400 * @note When the parent of a set of actors is disconnected to the stage, then all of the children
1401 * will received this callback, starting with the leaf actors.
1402 * For the following actor tree, the callback order will be D, E, B, F, C, and finally A.
1415 OffStageSignalType& OffStageSignal();
1418 * @brief This signal is emitted after the size has been set on the actor during relayout
1421 * @return The signal
1423 OnRelayoutSignalType& OnRelayoutSignal();
1426 * @brief This signal is emitted when the layout direction property of this or a parent actor is changed.
1428 * A callback of the following type may be connected:
1430 * void YourCallbackName( Actor actor, LayoutDirection::Type type );
1432 * actor: The actor, or child of actor, whose layout direction has changed
1433 * type: Whether the actor's layout direction property has changed or a parent's.
1436 * @return The signal to connect to
1437 * @pre The Actor has been initialized.
1439 LayoutDirectionChangedSignalType& LayoutDirectionChangedSignal();
1441 public: // Not intended for application developers
1445 * @brief This constructor is used by Actor::New() methods.
1448 * @param [in] actor A pointer to a newly allocated Dali resource
1450 explicit DALI_INTERNAL Actor(Internal::Actor* actor);
1455 * @brief Helper for discarding an actor handle.
1457 * If the handle is empty, this method does nothing. Otherwise
1458 * Actor::Unparent() will be called, followed by Actor::Reset().
1460 * @param[in,out] actor A handle to an actor, or an empty handle
1462 inline void UnparentAndReset( Actor& actor )
1476 #endif // DALI_ACTOR_H