1 #ifndef __DALI_INTERNAL_ACTOR_H__
2 #define __DALI_INTERNAL_ACTOR_H__
5 * Copyright (c) 2014 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.h>
26 #include <dali/public-api/common/vector-wrapper.h>
27 #include <dali/public-api/common/dali-common.h>
28 #include <dali/public-api/events/gesture.h>
29 #include <dali/public-api/math/viewport.h>
30 #include <dali/public-api/object/ref-object.h>
31 #include <dali/public-api/size-negotiation/relayout-container.h>
32 #include <dali/internal/event/actors/actor-declarations.h>
33 #include <dali/internal/event/actor-attachments/actor-attachment-declarations.h>
34 #include <dali/internal/event/common/object-impl.h>
35 #include <dali/internal/event/common/stage-def.h>
36 #include <dali/internal/event/rendering/renderer-impl.h>
37 #include <dali/internal/update/nodes/node-declarations.h>
39 #ifdef DALI_DYNAMICS_SUPPORT
40 #include <dali/internal/event/dynamics/dynamics-declarations.h>
55 class ActorGestureData;
61 typedef IntrusivePtr< Actor > ActorPtr;
62 typedef std::vector< Dali::Actor > ActorContainer; // Store handles to return via public-api
63 typedef ActorContainer::iterator ActorIter;
64 typedef ActorContainer::const_iterator ActorConstIter;
67 * Actor is the primary object which Dali applications interact with.
68 * UI controls can be built by combining multiple actors.
69 * Multi-Touch events are received through signals emitted by the actor tree.
71 * An Actor is a proxy for a Node in the scene graph.
72 * When an Actor is added to the Stage, it creates a node and attaches it to the scene graph.
73 * The scene-graph can be updated in a separate thread, so the attachment is done using an asynchronous message.
74 * When a tree of Actors is detached from the Stage, a message is sent to destroy the associated nodes.
76 class Actor : public Object
81 * @brief Struct to hold an actor and a dimension
83 struct ActorDimensionPair
88 * @param[in] newActor The actor to assign
89 * @param[in] newDimension The dimension to assign
91 ActorDimensionPair( Actor* newActor, Dimension::Type newDimension )
93 dimension( newDimension )
98 * @brief Equality operator
100 * @param[in] lhs The left hand side argument
101 * @param[in] rhs The right hand side argument
103 bool operator== ( const ActorDimensionPair& rhs )
105 return ( actor == rhs.actor ) && ( dimension == rhs.dimension );
108 Actor* actor; ///< The actor to hold
109 Dimension::Type dimension; ///< The dimension to hold
112 typedef std::vector< ActorDimensionPair > ActorDimensionStack;
117 * Create a new actor.
118 * @return A smart-pointer to the newly allocated Actor.
120 static ActorPtr New();
123 * Retrieve the name of the actor.
126 const std::string& GetName() const;
129 * Set the name of the actor.
130 * @param[in] name The new name.
132 void SetName( const std::string& name );
135 * @copydoc Dali::Actor::GetId
137 unsigned int GetId() const;
142 * Attach an object to an actor.
143 * @pre The actor does not already have an attachment.
144 * @param[in] attachment The object to attach.
146 void Attach( ActorAttachment& attachment );
149 * Retreive the object attached to an actor.
150 * @return The attachment.
152 ActorAttachmentPtr GetAttachment();
157 * Query whether an actor is the root actor, which is owned by the Stage.
158 * @return True if the actor is a root actor.
166 * Query whether the actor is connected to the Stage.
168 bool OnStage() const;
171 * Query whether the actor is a RenderableActor derived type.
172 * @return True if the actor is renderable.
174 bool IsRenderable() const
176 // inlined as this is called a lot in hit testing
177 return mIsRenderable;
181 * Query whether the actor is of class Dali::Layer
182 * @return True if the actor is a layer.
186 // inlined as this is called a lot in hit testing
191 * Gets the layer in which the actor is present
192 * @return The layer, which will be uninitialized if the actor is off-stage.
194 Dali::Layer GetLayer();
197 * Adds a child Actor to this Actor.
198 * @pre The child actor is not the same as the parent actor.
199 * @pre The child actor does not already have a parent.
200 * @param [in] child The child.
201 * @post The child will be referenced by its parent.
203 void Add( Actor& child );
206 * Inserts a child Actor to this Actor's child list
207 * @pre The child actor is not the same as the parent actor.
208 * @pre The child actor does not already have a parent.
209 * @param [in] index in childlist to insert child at
210 * @param [in] child The child.
211 * @post The child will be referenced by its parent.
213 void Insert( unsigned int index, Actor& child );
216 * Removes a child Actor from this Actor.
217 * @param [in] child The child.
218 * @post The child will be unreferenced.
220 void Remove( Actor& child );
223 * @copydoc Dali::Actor::Unparent
228 * Retrieve the number of children held by the actor.
229 * @return The number of children
231 unsigned int GetChildCount() const;
234 * @copydoc Dali::Actor::GetChildAt
236 Dali::Actor GetChildAt( unsigned int index ) const;
239 * Retrieve a reference to Actor's children.
240 * @note Not for public use.
241 * @return A reference to the container of children.
243 ActorContainer& GetChildrenInternal()
249 * @copydoc Dali::Actor::FindChildByName
251 ActorPtr FindChildByName( const std::string& actorName );
254 * @copydoc Dali::Actor::FindChildById
256 ActorPtr FindChildById( const unsigned int id );
259 * Retrieve the parent of an Actor.
260 * @return The parent actor, or NULL if the Actor does not have a parent.
262 Actor* GetParent() const
268 * Sets the size of an actor.
269 * ActorAttachments attached to the actor, can be scaled to fit within this area.
270 * This does not interfere with the actors scale factor.
271 * @param [in] width The new width.
272 * @param [in] height The new height.
274 void SetSize( float width, float height );
277 * Sets the size of an actor.
278 * ActorAttachments attached to the actor, can be scaled to fit within this area.
279 * This does not interfere with the actors scale factor.
280 * @param [in] width The size of the actor along the x-axis.
281 * @param [in] height The size of the actor along the y-axis.
282 * @param [in] depth The size of the actor along the z-axis.
284 void SetSize( float width, float height, float depth );
287 * Sets the size of an actor.
288 * ActorAttachments attached to the actor, can be scaled to fit within this area.
289 * This does not interfere with the actors scale factor.
290 * @param [in] size The new size.
292 void SetSize( const Vector2& size );
295 * Sets the update size for an actor.
297 * @param[in] size The size to set.
299 void SetSizeInternal( const Vector2& size );
302 * Sets the size of an actor.
303 * ActorAttachments attached to the actor, can be scaled to fit within this area.
304 * This does not interfere with the actors scale factor.
305 * @param [in] size The new size.
307 void SetSize( const Vector3& size );
310 * Sets the update size for an actor.
312 * @param[in] size The size to set.
314 void SetSizeInternal( const Vector3& size );
317 * Set the width component of the Actor's size.
318 * @param [in] width The new width component.
320 void SetWidth( float width );
323 * Set the height component of the Actor's size.
324 * @param [in] height The new height component.
326 void SetHeight( float height );
329 * Set the depth component of the Actor's size.
330 * @param [in] depth The new depth component.
332 void SetDepth( float depth );
335 * Retrieve the Actor's size from event side.
336 * This size will be the size set or if animating then the target size.
337 * @return The Actor's size.
339 const Vector3& GetTargetSize() const;
342 * Retrieve the Actor's size from update side.
343 * This size will be the size set or animating but will be a frame behind.
344 * @return The Actor's size.
346 const Vector3& GetCurrentSize() const;
349 * Return the natural size of the actor
351 * @return The actor's natural size
353 virtual Vector3 GetNaturalSize() const;
356 * Set the origin of an actor, within its parent's area.
357 * This is expressed in 2D unit coordinates, such that (0.0, 0.0, 0.5) is the top-left corner of the parent,
358 * and (1.0, 1.0, 0.5) is the bottom-right corner.
359 * The default parent-origin is top-left (0.0, 0.0, 0.5).
360 * An actor position is the distance between this origin, and the actors anchor-point.
361 * @param [in] origin The new parent-origin.
363 void SetParentOrigin( const Vector3& origin );
366 * Set the x component of the parent-origin
367 * @param [in] x The new x value.
369 void SetParentOriginX( float x );
372 * Set the y component of the parent-origin
373 * @param [in] y The new y value.
375 void SetParentOriginY( float y );
378 * Set the z component of the parent-origin
379 * @param [in] z The new z value.
381 void SetParentOriginZ( float z );
384 * Retrieve the parent-origin of an actor.
385 * @return The parent-origin.
387 const Vector3& GetCurrentParentOrigin() const;
390 * Set the anchor-point of an actor. This is expressed in 2D unit coordinates, such that
391 * (0.0, 0.0, 0.5) is the top-left corner of the actor, and (1.0, 1.0, 0.5) is the bottom-right corner.
392 * The default anchor point is top-left (0.0, 0.0, 0.5).
393 * An actor position is the distance between its parent-origin, and this anchor-point.
394 * An actor's rotation is centered around its anchor-point.
395 * @param [in] anchorPoint The new anchor-point.
397 void SetAnchorPoint( const Vector3& anchorPoint );
400 * Set the x component of the anchor-point.
401 * @param [in] x The new x value.
403 void SetAnchorPointX( float x );
406 * Set the y component of the anchor-point.
407 * @param [in] y The new y value.
409 void SetAnchorPointY( float y );
412 * Set the z component of the anchor-point.
413 * @param [in] z The new z value.
415 void SetAnchorPointZ( float z );
418 * Retrieve the anchor-point of an actor.
419 * @return The anchor-point.
421 const Vector3& GetCurrentAnchorPoint() const;
424 * Sets the position of the Actor.
425 * The coordinates are relative to the Actor's parent.
426 * The Actor's z position will be set to 0.0f.
427 * @param [in] x The new x position
428 * @param [in] y The new y position
430 void SetPosition( float x, float y );
433 * Sets the position of the Actor.
434 * The coordinates are relative to the Actor's parent.
435 * @param [in] x The new x position
436 * @param [in] y The new y position
437 * @param [in] z The new z position
439 void SetPosition( float x, float y, float z );
442 * Sets the position of the Actor.
443 * The coordinates are relative to the Actor's parent.
444 * @param [in] position The new position.
446 void SetPosition( const Vector3& position );
449 * Set the position of an actor along the X-axis.
450 * @param [in] x The new x position
452 void SetX( float x );
455 * Set the position of an actor along the Y-axis.
456 * @param [in] y The new y position.
458 void SetY( float y );
461 * Set the position of an actor along the Z-axis.
462 * @param [in] z The new z position
464 void SetZ( float z );
467 * Translate an actor relative to its existing position.
468 * @param[in] distance The actor will move by this distance.
470 void TranslateBy( const Vector3& distance );
473 * Retrieve the position of the Actor.
474 * The coordinates are relative to the Actor's parent.
475 * @return the Actor's position.
477 const Vector3& GetCurrentPosition() const;
480 * Retrieve the target position of the Actor.
481 * The coordinates are relative to the Actor's parent.
482 * @return the Actor's position.
484 const Vector3& GetTargetPosition() const;
487 * @copydoc Dali::Actor::GetCurrentWorldPosition()
489 const Vector3& GetCurrentWorldPosition() const;
492 * @copydoc Dali::Actor::SetPositionInheritanceMode()
494 void SetPositionInheritanceMode( PositionInheritanceMode mode );
497 * @copydoc Dali::Actor::GetPositionInheritanceMode()
499 PositionInheritanceMode GetPositionInheritanceMode() const;
502 * Sets the orientation of the Actor.
503 * @param [in] angleRadians The new orientation angle in radians.
504 * @param [in] axis The new axis of orientation.
506 void SetOrientation( const Radian& angleRadians, const Vector3& axis );
509 * Sets the orientation of the Actor.
510 * @param [in] orientation The new orientation.
512 void SetOrientation( const Quaternion& orientation );
515 * Rotate an actor around its existing rotation axis.
516 * @param[in] angleRadians The angle to the rotation to combine with the existing rotation.
517 * @param[in] axis The axis of the rotation to combine with the existing rotation.
519 void RotateBy( const Radian& angleRadians, const Vector3& axis );
522 * Apply a relative rotation to an actor.
523 * @param[in] relativeRotation The rotation to combine with the actors existing rotation.
525 void RotateBy( const Quaternion& relativeRotation );
528 * Retreive the Actor's orientation.
529 * @return the orientation.
531 const Quaternion& GetCurrentOrientation() const;
534 * Set whether a child actor inherits it's parent's orientation. Default is to inherit.
535 * Switching this off means that using SetOrientation() sets the actor's world orientation.
536 * @param[in] inherit - true if the actor should inherit orientation, false otherwise.
538 void SetInheritOrientation( bool inherit );
541 * Returns whether the actor inherit's it's parent's orientation.
542 * @return true if the actor inherit's it's parent orientation, false if it uses world orientation.
544 bool IsOrientationInherited() const;
547 * Sets the factor of the parents size used for the child actor.
548 * Note: Only used if ResizePolicy is ResizePolicy::SIZE_RELATIVE_TO_PARENT or ResizePolicy::SIZE_FIXED_OFFSET_FROM_PARENT.
549 * @param[in] factor The vector to multiply the parents size by to get the childs size.
551 void SetSizeModeFactor( const Vector3& factor );
554 * Gets the factor of the parents size used for the child actor.
555 * Note: Only used if ResizePolicy is ResizePolicy::SIZE_RELATIVE_TO_PARENT or ResizePolicy::SIZE_FIXED_OFFSET_FROM_PARENT.
556 * @return The vector being used to multiply the parents size by to get the childs size.
558 const Vector3& GetSizeModeFactor() const;
561 * @copydoc Dali::Actor::GetCurrentWorldOrientation()
563 const Quaternion& GetCurrentWorldOrientation() const;
566 * Sets a scale factor applied to an actor.
567 * @param [in] scale The scale factor applied on all axes.
569 void SetScale( float scale );
572 * Sets a scale factor applied to an actor.
573 * @param [in] scaleX The scale factor applied along the x-axis.
574 * @param [in] scaleY The scale factor applied along the y-axis.
575 * @param [in] scaleZ The scale factor applied along the z-axis.
577 void SetScale( float scaleX, float scaleY, float scaleZ );
580 * Sets a scale factor applied to an actor.
581 * @param [in] scale A vector representing the scale factor for each axis.
583 void SetScale( const Vector3& scale );
586 * Set the x component of the scale factor.
587 * @param [in] x The new x value.
589 void SetScaleX( float x );
592 * Set the y component of the scale factor.
593 * @param [in] y The new y value.
595 void SetScaleY( float y );
598 * Set the z component of the scale factor.
599 * @param [in] z The new z value.
601 void SetScaleZ( float z );
604 * Apply a relative scale to an actor.
605 * @param[in] relativeScale The scale to combine with the actors existing scale.
607 void ScaleBy( const Vector3& relativeScale );
610 * Retrieve the scale factor applied to an actor.
611 * @return A vector representing the scale factor for each axis.
613 const Vector3& GetCurrentScale() const;
616 * @copydoc Dali::Actor::GetCurrentWorldScale()
618 const Vector3& GetCurrentWorldScale() const;
621 * @copydoc Dali::Actor::SetInheritScale()
623 void SetInheritScale( bool inherit );
626 * @copydoc Dali::Actor::IsScaleInherited()
628 bool IsScaleInherited() const;
631 * @copydoc Dali::Actor::GetCurrentWorldMatrix()
633 Matrix GetCurrentWorldMatrix() const;
638 * Sets the visibility flag of an actor.
639 * @param [in] visible The new visibility flag.
641 void SetVisible( bool visible );
644 * Retrieve the visibility flag of an actor.
645 * @return The visibility flag.
647 bool IsVisible() const;
650 * Sets the opacity of an actor.
651 * @param [in] opacity The new opacity.
653 void SetOpacity( float opacity );
656 * Retrieve the actor's opacity.
657 * @return The actor's opacity.
659 float GetCurrentOpacity() const;
662 * Sets whether an actor should emit touch or hover signals; see SignalTouch() and SignalHover().
663 * An actor is sensitive by default, which means that as soon as an application connects to the SignalTouch(),
664 * the touch event signal will be emitted, and as soon as an application connects to the SignalHover(), the
665 * hover event signal will be emitted.
667 * If the application wishes to temporarily disable the touch or hover event signal emission, then they can do so by calling:
669 * actor.SetSensitive(false);
672 * Then, to re-enable the touch or hover event signal emission, the application should call:
674 * actor.SetSensitive(true);
677 * @see SignalTouch() and SignalHover().
678 * @note If an actor's sensitivity is set to false, then it's children will not emit a touch or hover event signal either.
679 * @param[in] sensitive true to enable emission of the touch or hover event signals, false otherwise.
681 void SetSensitive( bool sensitive )
683 mSensitive = sensitive;
687 * Query whether an actor emits touch or hover event signals.
688 * @see SetSensitive(bool)
689 * @return true, if emission of touch or hover event signals is enabled, false otherwise.
691 bool IsSensitive() const
697 * @copydoc Dali::Actor::SetDrawMode
699 void SetDrawMode( DrawMode::Type drawMode );
702 * @copydoc Dali::Actor::GetDrawMode
704 DrawMode::Type GetDrawMode() const;
707 * @copydoc Dali::Actor::SetOverlay
709 void SetOverlay( bool enable );
712 * @copydoc Dali::Actor::IsOverlay
714 bool IsOverlay() const;
717 * Sets the actor's color. The final color of actor depends on its color mode.
718 * This final color is applied to the drawable elements of an actor.
719 * @param [in] color The new color.
721 void SetColor( const Vector4& color );
724 * Set the red component of the color.
725 * @param [in] red The new red component.
727 void SetColorRed( float red );
730 * Set the green component of the color.
731 * @param [in] green The new green component.
733 void SetColorGreen( float green );
736 * Set the blue component of the scale factor.
737 * @param [in] blue The new blue value.
739 void SetColorBlue( float blue );
742 * Retrieve the actor's color.
745 const Vector4& GetCurrentColor() const;
748 * Sets the actor's color mode.
749 * Color mode specifies whether Actor uses its own color or inherits its parent color
750 * @param [in] colorMode to use.
752 void SetColorMode( ColorMode colorMode );
755 * Returns the actor's color mode.
756 * @return currently used colorMode.
758 ColorMode GetColorMode() const;
761 * @copydoc Dali::Actor::GetCurrentWorldColor()
763 const Vector4& GetCurrentWorldColor() const;
767 // Size negotiation virtual functions
770 * @brief Called after the size negotiation has been finished for this control.
772 * The control is expected to assign this given size to itself/its children.
774 * Should be overridden by derived classes if they need to layout
775 * actors differently after certain operations like add or remove
776 * actors, resize or after changing specific properties.
778 * Note! As this function is called from inside the size negotiation algorithm, you cannot
779 * call RequestRelayout (the call would just be ignored)
781 * @param[in] size The allocated size.
782 * @param[in,out] container The control should add actors to this container that it is not able
783 * to allocate a size for.
785 virtual void OnRelayout( const Vector2& size, RelayoutContainer& container )
790 * @brief Notification for deriving classes when the resize policy is set
792 * @param[in] policy The policy being set
793 * @param[in] dimension The dimension the policy is being set for
795 virtual void OnSetResizePolicy( ResizePolicy::Type policy, Dimension::Type dimension ) {}
798 * @brief Virtual method to notify deriving classes that relayout dependencies have been
799 * met and the size for this object is about to be calculated for the given dimension
801 * @param dimension The dimension that is about to be calculated
803 virtual void OnCalculateRelayoutSize( Dimension::Type dimension );
806 * @brief Virtual method to notify deriving classes that the size for a dimension
807 * has just been negotiated
809 * @param[in] size The new size for the given dimension
810 * @param[in] dimension The dimension that was just negotiated
812 virtual void OnLayoutNegotiated( float size, Dimension::Type dimension );
815 * @brief Determine if this actor is dependent on it's children for relayout
817 * @param dimension The dimension(s) to check for
818 * @return Return if the actor is dependent on it's children
820 virtual bool RelayoutDependentOnChildren( Dimension::Type dimension = Dimension::ALL_DIMENSIONS );
823 * @brief Determine if this actor is dependent on it's children for relayout.
825 * Called from deriving classes
827 * @param dimension The dimension(s) to check for
828 * @return Return if the actor is dependent on it's children
830 virtual bool RelayoutDependentOnChildrenBase( Dimension::Type dimension = Dimension::ALL_DIMENSIONS );
833 * @brief Calculate the size for a child
835 * @param[in] child The child actor to calculate the size for
836 * @param[in] dimension The dimension to calculate the size for. E.g. width or height.
837 * @return Return the calculated size for the given dimension
839 virtual float CalculateChildSize( const Dali::Actor& child, Dimension::Type dimension );
842 * @brief This method is called during size negotiation when a height is required for a given width.
844 * Derived classes should override this if they wish to customize the height returned.
846 * @param width to use.
847 * @return the height based on the width.
849 virtual float GetHeightForWidth( float width );
852 * @brief This method is called during size negotiation when a width is required for a given height.
854 * Derived classes should override this if they wish to customize the width returned.
856 * @param height to use.
857 * @return the width based on the width.
859 virtual float GetWidthForHeight( float height );
866 * @brief Called by the RelayoutController to negotiate the size of an actor.
868 * The size allocated by the the algorithm is passed in which the
869 * actor must adhere to. A container is passed in as well which
870 * the actor should populate with actors it has not / or does not
871 * need to handle in its size negotiation.
873 * @param[in] size The allocated size.
874 * @param[in,out] container The container that holds actors that are fed back into the
875 * RelayoutController algorithm.
877 void NegotiateSize( const Vector2& size, RelayoutContainer& container );
880 * @copydoc Dali::Actor::SetResizePolicy()
882 void SetResizePolicy( ResizePolicy::Type policy, Dimension::Type dimension = Dimension::ALL_DIMENSIONS );
885 * @copydoc Dali::Actor::GetResizePolicy()
887 ResizePolicy::Type GetResizePolicy( Dimension::Type dimension ) const;
890 * @copydoc Dali::Actor::SetSizeScalePolicy()
892 void SetSizeScalePolicy( SizeScalePolicy::Type policy );
895 * @copydoc Dali::Actor::GetSizeScalePolicy()
897 SizeScalePolicy::Type GetSizeScalePolicy() const;
900 * @copydoc Dali::Actor::SetDimensionDependency()
902 void SetDimensionDependency( Dimension::Type dimension, Dimension::Type dependency );
905 * @copydoc Dali::Actor::GetDimensionDependency()
907 Dimension::Type GetDimensionDependency( Dimension::Type dimension ) const;
910 * @brief Set the size negotiation relayout enabled on this actor
912 * @param[in] relayoutEnabled Boolean to enable or disable relayout
914 void SetRelayoutEnabled( bool relayoutEnabled );
917 * @brief Return if relayout is enabled
919 * @return Return if relayout is enabled or not for this actor
921 bool IsRelayoutEnabled() const;
924 * @brief Mark an actor as having it's layout dirty
926 * @param dirty Whether to mark actor as dirty or not
927 * @param dimension The dimension(s) to mark as dirty
929 void SetLayoutDirty( bool dirty, Dimension::Type dimension = Dimension::ALL_DIMENSIONS );
932 * @brief Return if any of an actor's dimensions are marked as dirty
934 * @param dimension The dimension(s) to check
935 * @return Return if any of the requested dimensions are dirty
937 bool IsLayoutDirty( Dimension::Type dimension = Dimension::ALL_DIMENSIONS ) const;
940 * @brief Returns if relayout is enabled and the actor is not dirty
942 * @return Return if it is possible to relayout the actor
944 bool RelayoutPossible( Dimension::Type dimension = Dimension::ALL_DIMENSIONS ) const;
947 * @brief Returns if relayout is enabled and the actor is dirty
949 * @return Return if it is required to relayout the actor
951 bool RelayoutRequired( Dimension::Type dimension = Dimension::ALL_DIMENSIONS ) const;
954 * @brief Request a relayout, which means performing a size negotiation on this actor, its parent and children (and potentially whole scene)
956 * This method is automatically called from OnStageConnection(), OnChildAdd(),
957 * OnChildRemove(), SetSizePolicy(), SetMinimumSize() and SetMaximumSize().
959 * This method can also be called from a derived class every time it needs a different size.
960 * At the end of event processing, the relayout process starts and
961 * all controls which requested Relayout will have their sizes (re)negotiated.
963 * @note RelayoutRequest() can be called multiple times; the size negotiation is still
964 * only performed once, i.e. there is no need to keep track of this in the calling side.
966 void RelayoutRequest( Dimension::Type dimension = Dimension::ALL_DIMENSIONS );
969 * @brief Determine if this actor is dependent on it's parent for relayout
971 * @param dimension The dimension(s) to check for
972 * @return Return if the actor is dependent on it's parent
974 bool RelayoutDependentOnParent( Dimension::Type dimension = Dimension::ALL_DIMENSIONS );
977 * @brief Determine if this actor has another dimension depedent on the specified one
979 * @param dimension The dimension to check for
980 * @param dependentDimension The dimension to check for dependency with
981 * @return Return if the actor is dependent on this dimension
983 bool RelayoutDependentOnDimension( Dimension::Type dimension, Dimension::Type dependentDimension );
986 * Negotiate sizes for a control in all dimensions
988 * @param[in] allocatedSize The size constraint that the control must respect
990 void NegotiateDimensions( const Vector2& allocatedSize );
993 * Negotiate size for a specific dimension
995 * The algorithm adopts a recursive dependency checking approach. Meaning, that wherever dependencies
996 * are found, e.g. an actor dependent on its parent, the dependency will be calculated first with NegotiatedDimension and
997 * LayoutDimensionNegotiated flags being filled in on the actor.
999 * @post All actors that exist in the dependency chain connected to the given actor will have had their NegotiatedDimensions
1000 * calculated and set as well as the LayoutDimensionNegotiated flags.
1002 * @param[in] dimension The dimension to negotiate on
1003 * @param[in] allocatedSize The size constraint that the actor must respect
1005 void NegotiateDimension( Dimension::Type dimension, const Vector2& allocatedSize, ActorDimensionStack& recursionStack );
1008 * @brief Calculate the size of a dimension
1010 * @param[in] dimension The dimension to calculate the size for
1011 * @param[in] maximumSize The upper bounds on the size
1012 * @return Return the calculated size for the dimension
1014 float CalculateSize( Dimension::Type dimension, const Vector2& maximumSize );
1017 * @brief Clamp a dimension given the relayout constraints on this actor
1019 * @param[in] size The size to constrain
1020 * @param[in] dimension The dimension the size exists in
1021 * @return Return the clamped size
1023 float ClampDimension( float size, Dimension::Type dimension );
1026 * Negotiate a dimension based on the size of the parent
1028 * @param[in] dimension The dimension to negotiate on
1029 * @return Return the negotiated size
1031 float NegotiateFromParent( Dimension::Type dimension );
1034 * Negotiate a dimension based on the size of the parent. Fitting inside.
1036 * @param[in] dimension The dimension to negotiate on
1037 * @return Return the negotiated size
1039 float NegotiateFromParentFit( Dimension::Type dimension );
1042 * Negotiate a dimension based on the size of the parent. Flooding the whole space.
1044 * @param[in] dimension The dimension to negotiate on
1045 * @return Return the negotiated size
1047 float NegotiateFromParentFlood( Dimension::Type dimension );
1050 * @brief Negotiate a dimension based on the size of the children
1052 * @param[in] dimension The dimension to negotiate on
1053 * @return Return the negotiated size
1055 float NegotiateFromChildren( Dimension::Type dimension );
1058 * Set the negotiated dimension value for the given dimension(s)
1060 * @param negotiatedDimension The value to set
1061 * @param dimension The dimension(s) to set the value for
1063 void SetNegotiatedDimension( float negotiatedDimension, Dimension::Type dimension = Dimension::ALL_DIMENSIONS );
1066 * Return the value of negotiated dimension for the given dimension
1068 * @param dimension The dimension to retrieve
1069 * @return Return the value of the negotiated dimension
1071 float GetNegotiatedDimension( Dimension::Type dimension ) const;
1074 * @brief Set the padding for a dimension
1076 * @param[in] padding Padding for the dimension. X = start (e.g. left, bottom), y = end (e.g. right, top)
1077 * @param[in] dimension The dimension to set
1079 void SetPadding( const Vector2& padding, Dimension::Type dimension );
1082 * Return the value of padding for the given dimension
1084 * @param dimension The dimension to retrieve
1085 * @return Return the value of padding for the dimension
1087 Vector2 GetPadding( Dimension::Type dimension ) const;
1090 * Return the actor size for a given dimension
1092 * @param[in] dimension The dimension to retrieve the size for
1093 * @return Return the size for the given dimension
1095 float GetSize( Dimension::Type dimension ) const;
1098 * Return the natural size of the actor for a given dimension
1100 * @param[in] dimension The dimension to retrieve the size for
1101 * @return Return the natural size for the given dimension
1103 float GetNaturalSize( Dimension::Type dimension ) const;
1106 * @brief Return the amount of size allocated for relayout
1108 * May include padding
1110 * @param[in] dimension The dimension to retrieve
1111 * @return Return the size
1113 float GetRelayoutSize( Dimension::Type dimension ) const;
1116 * @brief If the size has been negotiated return that else return normal size
1118 * @param[in] dimension The dimension to retrieve
1119 * @return Return the size
1121 float GetLatestSize( Dimension::Type dimension ) const;
1124 * Apply the negotiated size to the actor
1126 * @param[in] container The container to fill with actors that require further relayout
1128 void SetNegotiatedSize( RelayoutContainer& container );
1131 * @brief Flag the actor as having it's layout dimension negotiated.
1133 * @param[in] negotiated The status of the flag to set.
1134 * @param[in] dimension The dimension to set the flag for
1136 void SetLayoutNegotiated( bool negotiated, Dimension::Type dimension = Dimension::ALL_DIMENSIONS );
1139 * @brief Test whether the layout dimension for this actor has been negotiated or not.
1141 * @param[in] dimension The dimension to determine the value of the flag for
1142 * @return Return if the layout dimension is negotiated or not.
1144 bool IsLayoutNegotiated( Dimension::Type dimension = Dimension::ALL_DIMENSIONS ) const;
1147 * @brief provides the Actor implementation of GetHeightForWidth
1148 * @param width to use.
1149 * @return the height based on the width.
1151 float GetHeightForWidthBase( float width );
1154 * @brief provides the Actor implementation of GetWidthForHeight
1155 * @param height to use.
1156 * @return the width based on the height.
1158 float GetWidthForHeightBase( float height );
1161 * @brief Calculate the size for a child
1163 * @param[in] child The child actor to calculate the size for
1164 * @param[in] dimension The dimension to calculate the size for. E.g. width or height.
1165 * @return Return the calculated size for the given dimension
1167 float CalculateChildSizeBase( const Dali::Actor& child, Dimension::Type dimension );
1170 * @brief Set the preferred size for size negotiation
1172 * @param[in] size The preferred size to set
1174 void SetPreferredSize( const Vector2& size );
1177 * @brief Return the preferred size used for size negotiation
1179 * @return Return the preferred size
1181 Vector2 GetPreferredSize() const;
1184 * @copydoc Dali::Actor::SetMinimumSize
1186 void SetMinimumSize( float size, Dimension::Type dimension = Dimension::ALL_DIMENSIONS );
1189 * @copydoc Dali::Actor::GetMinimumSize
1191 float GetMinimumSize( Dimension::Type dimension ) const;
1194 * @copydoc Dali::Actor::SetMaximumSize
1196 void SetMaximumSize( float size, Dimension::Type dimension = Dimension::ALL_DIMENSIONS );
1199 * @copydoc Dali::Actor::GetMaximumSize
1201 float GetMaximumSize( Dimension::Type dimension ) const;
1204 * @copydoc Dali::Actor::AddRenderer()
1206 unsigned int AddRenderer( Renderer& renderer );
1209 * @copydoc Dali::Actor::GetRendererCount()
1211 unsigned int GetRendererCount() const;
1214 * @copydoc Dali::Actor::GetRendererAt()
1216 Renderer& GetRendererAt( unsigned int index );
1219 * @copydoc Dali::Actor::RemoveRenderer()
1221 void RemoveRenderer( Renderer& renderer );
1224 * @copydoc Dali::Actor::RemoveRenderer()
1226 void RemoveRenderer( unsigned int index );
1228 #ifdef DALI_DYNAMICS_SUPPORT
1232 /// @copydoc Dali::Actor::DisableDynamics
1233 void DisableDynamics();
1235 /// @copydoc Dali::Actor::EnableDynamics(Dali::DynamicsBodyConfig)
1236 DynamicsBodyPtr EnableDynamics(DynamicsBodyConfigPtr bodyConfig);
1238 /// @copydoc Dali::Actor::GetDynamicsBody
1239 DynamicsBodyPtr GetDynamicsBody() const;
1241 /// @copydoc Dali::Actor::AddDynamicsJoint(Dali::Actor,const Vector3&)
1242 DynamicsJointPtr AddDynamicsJoint( ActorPtr attachedActor, const Vector3& offset );
1244 /// @copydoc Dali::Actor::AddDynamicsJoint(Dali::Actor,const Vector3&,const Vector3&)
1245 DynamicsJointPtr AddDynamicsJoint( ActorPtr attachedActor, const Vector3& offsetA, const Vector3& offsetB );
1247 /// @copydoc Dali::Actor::GetNumberOfJoints
1248 const int GetNumberOfJoints() const;
1250 /// @copydoc Dali::Actor::GetDynamicsJointByIndex
1251 DynamicsJointPtr GetDynamicsJointByIndex( const int index ) const;
1253 /// @copydoc Dali::Actor::GetDynamicsJoint
1254 DynamicsJointPtr GetDynamicsJoint( ActorPtr attachedActor ) const;
1256 /// @copydoc Dali::Actor::RemoveDynamicsJoint
1257 void RemoveDynamicsJoint( DynamicsJointPtr joint );
1260 * Hold a reference to a DynamicsJoint
1261 * @param[in] joint The joint
1263 void ReferenceJoint( DynamicsJointPtr joint );
1266 * Release a reference to a DynamicsJoint
1267 * @param[in] joint The joint
1269 void ReleaseJoint( DynamicsJointPtr joint );
1272 * Set this actor to be the root actor in the dynamics simulation
1273 * All children of the actor are added/removed from the simulation.
1274 * @param[in] flag When true sets this actor to be the simulation world root actor and
1275 * if OnStage() all dynamics enabled child actors are added to the simulation,
1276 * when false stops this actor being the simulation root and if OnStage() all
1277 * dynamics enabled child actors are removed from the simulation.
1279 void SetDynamicsRoot(bool flag);
1283 * Check if this actor is the root actor in the dynamics simulation
1284 * @return true if this is the dynamics root actor.
1286 bool IsDynamicsRoot() const;
1289 * Add actor to the dynamics simulation
1290 * Invoked when the actor is staged, or it's parent becomes the simulation root
1292 void ConnectDynamics();
1295 * Remove actor from the dynamics simulation
1296 * Invoked when the actor is unstaged, or it's parent stops being the the simulation root
1298 void DisconnectDynamics();
1301 * An actor in a DynamicsJoint relationship has been staged
1302 * @param[in] actor The actor passed into AddDynamicsJoint()
1304 void AttachedActorOnStage( Dali::Actor actor );
1307 * An actor in a DynamicsJoint relationship has been unstaged
1308 * @param[in] actor The actor passed into AddDynamicsJoint()
1310 void AttachedActorOffStage( Dali::Actor actor );
1312 #endif // DALI_DYNAMICS_SUPPORT
1316 * Converts screen coordinates into the actor's coordinate system.
1317 * @note The actor coordinates are relative to the top-left (0.0, 0.0, 0.5)
1318 * @param[out] localX On return, the X-coordinate relative to the actor.
1319 * @param[out] localY On return, the Y-coordinate relative to the actor.
1320 * @param[in] screenX The screen X-coordinate.
1321 * @param[in] screenY The screen Y-coordinate.
1322 * @return True if the conversion succeeded.
1324 bool ScreenToLocal( float& localX, float& localY, float screenX, float screenY ) const;
1327 * Converts screen coordinates into the actor's coordinate system.
1328 * @note The actor coordinates are relative to the top-left (0.0, 0.0, 0.5)
1329 * @param[in] renderTask The render-task used to display the actor.
1330 * @param[out] localX On return, the X-coordinate relative to the actor.
1331 * @param[out] localY On return, the Y-coordinate relative to the actor.
1332 * @param[in] screenX The screen X-coordinate.
1333 * @param[in] screenY The screen Y-coordinate.
1334 * @return True if the conversion succeeded.
1336 bool ScreenToLocal( RenderTask& renderTask, float& localX, float& localY, float screenX, float screenY ) const;
1339 * Converts from the actor's coordinate system to screen coordinates.
1340 * @note The actor coordinates are relative to the top-left (0.0, 0.0, 0.5)
1341 * @param[in] viewMatrix The view-matrix
1342 * @param[in] projectionMatrix The projection-matrix
1343 * @param[in] viewport The view-port
1344 * @param[out] localX On return, the X-coordinate relative to the actor.
1345 * @param[out] localY On return, the Y-coordinate relative to the actor.
1346 * @param[in] screenX The screen X-coordinate.
1347 * @param[in] screenY The screen Y-coordinate.
1348 * @return True if the conversion succeeded.
1350 bool ScreenToLocal( const Matrix& viewMatrix,
1351 const Matrix& projectionMatrix,
1352 const Viewport& viewport,
1356 float screenY ) const;
1359 * Performs a ray-sphere test with the given pick-ray and the actor's bounding sphere.
1360 * @note The actor coordinates are relative to the top-left (0.0, 0.0, 0.5)
1361 * @param[in] rayOrigin The ray origin in the world's reference system.
1362 * @param[in] rayDir The ray director vector in the world's reference system.
1363 * @return True if the ray intersects the actor's bounding sphere.
1365 bool RaySphereTest( const Vector4& rayOrigin, const Vector4& rayDir ) const;
1368 * Performs a ray-actor test with the given pick-ray and the actor's geometry.
1369 * @note The actor coordinates are relative to the top-left (0.0, 0.0, 0.5)
1370 * @param[in] rayOrigin The ray origin in the world's reference system.
1371 * @param[in] rayDir The ray director vector in the world's reference system.
1372 * @param[out] hitPointLocal The hit point in the Actor's local reference system.
1373 * @param[out] distance The distance from the hit point to the camera.
1374 * @return True if the ray intersects the actor's geometry.
1376 bool RayActorTest( const Vector4& rayOrigin,
1377 const Vector4& rayDir,
1378 Vector4& hitPointLocal,
1379 float& distance ) const;
1382 * Sets whether the actor should receive a notification when touch or hover motion events leave
1383 * the boundary of the actor.
1385 * @note By default, this is set to false as most actors do not require this.
1386 * @note Need to connect to the SignalTouch or SignalHover to actually receive this event.
1388 * @param[in] required Should be set to true if a Leave event is required
1390 void SetLeaveRequired( bool required );
1393 * This returns whether the actor requires touch or hover events whenever touch or hover motion events leave
1394 * the boundary of the actor.
1395 * @return true if a Leave event is required, false otherwise.
1397 bool GetLeaveRequired() const;
1400 * @copydoc Dali::Actor::SetKeyboardFocusable()
1402 void SetKeyboardFocusable( bool focusable );
1405 * @copydoc Dali::Actor::IsKeyboardFocusable()
1407 bool IsKeyboardFocusable() const;
1410 * Query whether the application or derived actor type requires touch events.
1411 * @return True if touch events are required.
1413 bool GetTouchRequired() const;
1416 * Query whether the application or derived actor type requires hover events.
1417 * @return True if hover events are required.
1419 bool GetHoverRequired() const;
1422 * Query whether the application or derived actor type requires wheel events.
1423 * @return True if wheel events are required.
1425 bool GetWheelEventRequired() const;
1428 * Query whether the actor is actually hittable. This method checks whether the actor is
1429 * sensitive, has the visibility flag set to true and is not fully transparent.
1430 * @return true, if it can be hit, false otherwise.
1432 bool IsHittable() const;
1437 * Retrieve the gesture data associated with this actor. The first call to this method will
1438 * allocate space for the ActorGestureData so this should only be called if an actor really does
1440 * @return Reference to the ActorGestureData for this actor.
1441 * @note Once the gesture-data is created for an actor it is likely that gestures are required
1442 * throughout the actor's lifetime so it will only be deleted when the actor is destroyed.
1444 ActorGestureData& GetGestureData();
1447 * Queries whether the actor requires the gesture type.
1448 * @param[in] type The gesture type.
1450 bool IsGestureRequred( Gesture::Type type ) const;
1455 * Used by the EventProcessor to emit touch event signals.
1456 * @param[in] event The touch event.
1457 * @return True if the event was consumed.
1459 bool EmitTouchEventSignal( const TouchEvent& event );
1462 * Used by the EventProcessor to emit hover event signals.
1463 * @param[in] event The hover event.
1464 * @return True if the event was consumed.
1466 bool EmitHoverEventSignal( const HoverEvent& event );
1469 * Used by the EventProcessor to emit wheel event signals.
1470 * @param[in] event The wheel event.
1471 * @return True if the event was consumed.
1473 bool EmitWheelEventSignal( const WheelEvent& event );
1476 * @copydoc Dali::Actor::TouchedSignal()
1478 Dali::Actor::TouchSignalType& TouchedSignal();
1481 * @copydoc Dali::Actor::HoveredSignal()
1483 Dali::Actor::HoverSignalType& HoveredSignal();
1486 * @copydoc Dali::Actor::WheelEventSignal()
1488 Dali::Actor::WheelEventSignalType& WheelEventSignal();
1491 * @copydoc Dali::Actor::OnStageSignal()
1493 Dali::Actor::OnStageSignalType& OnStageSignal();
1496 * @copydoc Dali::Actor::OffStageSignal()
1498 Dali::Actor::OffStageSignalType& OffStageSignal();
1501 * @copydoc Dali::Actor::OnRelayoutSignal()
1503 Dali::Actor::OnRelayoutSignalType& OnRelayoutSignal();
1506 * Connects a callback function with the object's signals.
1507 * @param[in] object The object providing the signal.
1508 * @param[in] tracker Used to disconnect the signal.
1509 * @param[in] signalName The signal to connect to.
1510 * @param[in] functor A newly allocated FunctorDelegate.
1511 * @return True if the signal was connected.
1512 * @post If a signal was connected, ownership of functor was passed to CallbackBase. Otherwise the caller is responsible for deleting the unused functor.
1514 static bool DoConnectSignal( BaseObject* object,
1515 ConnectionTrackerInterface* tracker,
1516 const std::string& signalName,
1517 FunctorDelegate* functor );
1520 * Performs actions as requested using the action name.
1521 * @param[in] object The object on which to perform the action.
1522 * @param[in] actionName The action to perform.
1523 * @param[in] attributes The attributes with which to perfrom this action.
1524 * @return true if the action was done.
1526 static bool DoAction( BaseObject* object,
1527 const std::string& actionName,
1528 const Property::Map& attributes );
1534 * This should only be called by Animation, when the actors SIZE property is animated.
1536 * @param[in] animation The animation that resized the actor
1537 * @param[in] targetSize The new target size of the actor
1539 void NotifySizeAnimation( Animation& animation, const Vector3& targetSize );
1542 * This should only be called by Animation, when the actors SIZE_WIDTH or SIZE_HEIGHT property is animated.
1544 * @param[in] animation The animation that resized the actor
1545 * @param[in] targetSize The new target size of the actor
1547 void NotifySizeAnimation( Animation& animation, float targetSize, Property::Index property );
1550 * For use in derived classes.
1551 * This should only be called by Animation, when the actor is resized using Animation::Resize().
1553 virtual void OnSizeAnimation( Animation& animation, const Vector3& targetSize )
1561 BASIC, RENDERABLE, LAYER, ROOT_LAYER
1565 * Protected Constructor. See Actor::New().
1566 * The second-phase construction Initialize() member should be called immediately after this.
1567 * @param[in] derivedType The derived type of actor (if any).
1569 Actor( DerivedType derivedType );
1572 * Second-phase constructor. Must be called immediately after creating a new Actor;
1574 void Initialize( void );
1577 * A reference counted object may only be deleted by calling Unreference()
1582 * Called on a child during Add() when the parent actor is connected to the Stage.
1583 * @param[in] stage The stage.
1584 * @param[in] parentDepth The depth of the parent in the hierarchy
1585 * @param[in] index If set, it is only used for positioning the actor within the parent's child list.
1587 void ConnectToStage( unsigned int parentDepth, int index = -1 );
1590 * Helper for ConnectToStage, to recursively connect a tree of actors.
1591 * This is atomic i.e. not interrupted by user callbacks.
1592 * @param[in] index If set, it is only used for positioning the actor within the parent's child list.
1593 * @param[in] depth The depth in the hierarchy of the actor
1594 * @param[out] connectionList On return, the list of connected actors which require notification.
1596 void RecursiveConnectToStage( ActorContainer& connectionList, unsigned int depth, int index = -1 );
1599 * Connect the Node associated with this Actor to the scene-graph.
1600 * @param[in] index If set, it is only used for positioning the actor within the parent's child list.
1602 void ConnectToSceneGraph( int index = -1 );
1605 * Helper for ConnectToStage, to notify a connected actor through the public API.
1607 void NotifyStageConnection();
1610 * Called on a child during Remove() when the actor was previously on the Stage.
1612 void DisconnectFromStage();
1615 * Helper for DisconnectFromStage, to recursively disconnect a tree of actors.
1616 * This is atomic i.e. not interrupted by user callbacks.
1617 * @param[out] disconnectionList On return, the list of disconnected actors which require notification.
1619 void RecursiveDisconnectFromStage( ActorContainer& disconnectionList );
1622 * Disconnect the Node associated with this Actor from the scene-graph.
1624 void DisconnectFromSceneGraph();
1627 * Helper for DisconnectFromStage, to notify a disconnected actor through the public API.
1629 void NotifyStageDisconnection();
1632 * When the Actor is OnStage, checks whether the corresponding Node is connected to the scene graph.
1633 * @return True if the Actor is OnStage & has a Node connected to the scene graph.
1635 bool IsNodeConnected() const;
1638 * Calculate the size of the z dimension for a 2D size
1640 * @param[in] size The 2D size (X, Y) to calculate Z from
1642 * @return Return the Z dimension for this size
1644 float CalculateSizeZ( const Vector2& size ) const;
1647 * Return the depth in the hierarchy of the actor.
1648 * The value returned is only valid if the actor is on the stage.
1650 * @return Depth of the actor in the hierarchy
1652 unsigned int GetDepth() const
1658 // Default property extensions from Object
1661 * @copydoc Dali::Internal::Object::GetDefaultPropertyCount()
1663 virtual unsigned int GetDefaultPropertyCount() const;
1666 * @copydoc Dali::Internal::Object::GetDefaultPropertyIndices()
1668 virtual void GetDefaultPropertyIndices( Property::IndexContainer& indices ) const;
1671 * @copydoc Dali::Internal::Object::GetDefaultPropertyName()
1673 virtual const char* GetDefaultPropertyName( Property::Index index ) const;
1676 * @copydoc Dali::Internal::Object::GetDefaultPropertyIndex()
1678 virtual Property::Index GetDefaultPropertyIndex( const std::string& name ) const;
1681 * @copydoc Dali::Internal::Object::IsDefaultPropertyWritable()
1683 virtual bool IsDefaultPropertyWritable( Property::Index index ) const;
1686 * @copydoc Dali::Internal::Object::IsDefaultPropertyAnimatable()
1688 virtual bool IsDefaultPropertyAnimatable( Property::Index index ) const;
1691 * @copydoc Dali::Internal::Object::IsDefaultPropertyAConstraintInput()
1693 virtual bool IsDefaultPropertyAConstraintInput( Property::Index index ) const;
1696 * @copydoc Dali::Internal::Object::GetDefaultPropertyType()
1698 virtual Property::Type GetDefaultPropertyType( Property::Index index ) const;
1701 * @copydoc Dali::Internal::Object::SetDefaultProperty()
1703 virtual void SetDefaultProperty( Property::Index index, const Property::Value& propertyValue );
1706 * @copydoc Dali::Internal::Object::SetSceneGraphProperty()
1708 virtual void SetSceneGraphProperty( Property::Index index, const PropertyMetadata& entry, const Property::Value& value );
1711 * @copydoc Dali::Internal::Object::GetDefaultProperty()
1713 virtual Property::Value GetDefaultProperty( Property::Index index ) const;
1716 * @copydoc Dali::Internal::Object::GetPropertyOwner()
1718 virtual const SceneGraph::PropertyOwner* GetPropertyOwner() const;
1721 * @copydoc Dali::Internal::Object::GetSceneObject()
1723 virtual const SceneGraph::PropertyOwner* GetSceneObject() const;
1726 * @copydoc Dali::Internal::Object::GetSceneObjectAnimatableProperty()
1728 virtual const SceneGraph::PropertyBase* GetSceneObjectAnimatableProperty( Property::Index index ) const;
1731 * @copydoc Dali::Internal::Object::GetSceneObjectInputProperty()
1733 virtual const PropertyInputImpl* GetSceneObjectInputProperty( Property::Index index ) const;
1736 * @copydoc Dali::Internal::Object::GetPropertyComponentIndex()
1738 virtual int GetPropertyComponentIndex( Property::Index index ) const;
1746 Actor( const Actor& );
1749 Actor& operator=( const Actor& rhs );
1752 * Set the actors parent.
1753 * @param[in] parent The new parent.
1754 * @param[in] index If set, it is only used for positioning the actor within the parent's child list.
1756 void SetParent( Actor* parent, int index = -1 );
1759 * Helper to create a Node for this Actor.
1760 * To be overriden in derived classes.
1761 * @return A newly allocated node.
1763 virtual SceneGraph::Node* CreateNode() const;
1766 * For use in derived classes, called after Initialize()
1768 virtual void OnInitialize()
1773 * For use in internal derived classes.
1774 * This is called during ConnectToStage(), after the actor has finished adding its node to the scene-graph.
1775 * The derived class must not modify the actor hierachy (Add/Remove children) during this callback.
1777 virtual void OnStageConnectionInternal()
1782 * For use in internal derived classes.
1783 * This is called during DisconnectFromStage(), before the actor removes its node from the scene-graph.
1784 * The derived class must not modify the actor hierachy (Add/Remove children) during this callback.
1786 virtual void OnStageDisconnectionInternal()
1791 * For use in external (CustomActor) derived classes.
1792 * This is called after the atomic ConnectToStage() traversal has been completed.
1794 virtual void OnStageConnectionExternal( unsigned int depth )
1799 * For use in external (CustomActor) derived classes.
1800 * This is called after the atomic DisconnectFromStage() traversal has been completed.
1802 virtual void OnStageDisconnectionExternal()
1807 * For use in derived classes; this is called after Add() has added a child.
1808 * @param[in] child The child that was added.
1810 virtual void OnChildAdd( Actor& child )
1815 * For use in derived classes; this is called after Remove() has removed a child.
1816 * @param[in] child The child that was removed.
1818 virtual void OnChildRemove( Actor& child )
1823 * For use in derived classes.
1824 * This is called after SizeSet() has been called.
1826 virtual void OnSizeSet( const Vector3& targetSize )
1831 * For use in derived classes.
1832 * This is only called if mDerivedRequiresTouch is true, and the touch-signal was not consumed.
1833 * @param[in] event The touch event.
1834 * @return True if the event should be consumed.
1836 virtual bool OnTouchEvent( const TouchEvent& event )
1842 * For use in derived classes.
1843 * This is only called if mDerivedRequiresHover is true, and the hover-signal was not consumed.
1844 * @param[in] event The hover event.
1845 * @return True if the event should be consumed.
1847 virtual bool OnHoverEvent( const HoverEvent& event )
1853 * For use in derived classes.
1854 * This is only called if the wheel signal was not consumed.
1855 * @param[in] event The wheel event.
1856 * @return True if the event should be consumed.
1858 virtual bool OnWheelEvent( const WheelEvent& event )
1864 * @brief Ensure the relayout data is allocated
1866 void EnsureRelayoutData() const;
1869 * @brief Apply the size set policy to the input size
1871 * @param[in] size The size to apply the policy to
1872 * @return Return the adjusted size
1874 Vector2 ApplySizeSetPolicy( const Vector2 size );
1878 Actor* mParent; ///< Each actor (except the root) can have one parent
1879 ActorContainer* mChildren; ///< Container of referenced actors
1880 const SceneGraph::Node* mNode; ///< Not owned
1881 Vector3* mParentOrigin; ///< NULL means ParentOrigin::DEFAULT. ParentOrigin is non-animatable
1882 Vector3* mAnchorPoint; ///< NULL means AnchorPoint::DEFAULT. AnchorPoint is non-animatable
1884 struct RelayoutData;
1885 mutable RelayoutData* mRelayoutData; ///< Struct to hold optional collection of relayout variables
1887 #ifdef DALI_DYNAMICS_SUPPORT
1888 DynamicsData* mDynamicsData; ///< optional physics data
1891 ActorGestureData* mGestureData; ///< Optional Gesture data. Only created when actor requires gestures
1893 ActorAttachmentPtr mAttachment; ///< Optional referenced attachment
1896 Dali::Actor::TouchSignalType mTouchedSignal;
1897 Dali::Actor::HoverSignalType mHoveredSignal;
1898 Dali::Actor::WheelEventSignalType mWheelEventSignal;
1899 Dali::Actor::OnStageSignalType mOnStageSignal;
1900 Dali::Actor::OffStageSignalType mOffStageSignal;
1901 Dali::Actor::OnRelayoutSignalType mOnRelayoutSignal;
1903 Vector3 mTargetSize; ///< Event-side storage for size (not a pointer as most actors will have a size)
1904 Vector3 mTargetPosition; ///< Event-side storage for position (not a pointer as most actors will have a position)
1906 std::string mName; ///< Name of the actor
1907 unsigned int mId; ///< A unique ID to identify the actor starting from 1, and 0 is reserved
1909 unsigned int mDepth :12; ///< The depth in the hierarchy of the actor. Only 4096 levels of depth are supported
1910 const bool mIsRoot : 1; ///< Flag to identify the root actor
1911 const bool mIsRenderable : 1; ///< Flag to identify that this is a renderable actor
1912 const bool mIsLayer : 1; ///< Flag to identify that this is a layer
1913 bool mIsOnStage : 1; ///< Flag to identify whether the actor is on-stage
1914 bool mIsDynamicsRoot : 1; ///< Flag to identify if this is the dynamics world root
1915 bool mSensitive : 1; ///< Whether the actor emits touch event signals
1916 bool mLeaveRequired : 1; ///< Whether a touch event signal is emitted when the a touch leaves the actor's bounds
1917 bool mKeyboardFocusable : 1; ///< Whether the actor should be focusable by keyboard navigation
1918 bool mDerivedRequiresTouch : 1; ///< Whether the derived actor type requires touch event signals
1919 bool mDerivedRequiresHover : 1; ///< Whether the derived actor type requires hover event signals
1920 bool mDerivedRequiresWheelEvent : 1; ///< Whether the derived actor type requires wheel event signals
1921 bool mOnStageSignalled : 1; ///< Set to true before OnStageConnection signal is emitted, and false before OnStageDisconnection
1922 bool mInsideOnSizeSet : 1; ///< Whether we are inside OnSizeSet
1923 bool mInheritOrientation : 1; ///< Cached: Whether the parent's orientation should be inherited.
1924 bool mInheritScale : 1; ///< Cached: Whether the parent's scale should be inherited.
1925 DrawMode::Type mDrawMode : 2; ///< Cached: How the actor and its children should be drawn
1926 PositionInheritanceMode mPositionInheritanceMode : 2; ///< Cached: Determines how position is inherited
1927 ColorMode mColorMode : 2; ///< Cached: Determines whether mWorldColor is inherited
1931 static ActorContainer mNullChildren; ///< Empty container (shared by all actors, returned by GetChildren() const)
1932 static unsigned int mActorCounter; ///< A counter to track the actor instance creation
1936 } // namespace Internal
1938 // Helpers for public-api forwarding methods
1940 inline Internal::Actor& GetImplementation( Dali::Actor& actor )
1942 DALI_ASSERT_ALWAYS( actor && "Actor handle is empty" );
1944 BaseObject& handle = actor.GetBaseObject();
1946 return static_cast< Internal::Actor& >( handle );
1949 inline const Internal::Actor& GetImplementation( const Dali::Actor& actor )
1951 DALI_ASSERT_ALWAYS( actor && "Actor handle is empty" );
1953 const BaseObject& handle = actor.GetBaseObject();
1955 return static_cast< const Internal::Actor& >( handle );
1960 #endif // __DALI_INTERNAL_ACTOR_H__