Merge "Allow multiple renderers per Actor and sharing renderers between actors" into...
[platform/core/uifw/dali-core.git] / dali / internal / event / actors / actor-impl.h
1 #ifndef __DALI_INTERNAL_ACTOR_H__
2 #define __DALI_INTERNAL_ACTOR_H__
3
4 /*
5  * Copyright (c) 2014 Samsung Electronics Co., Ltd.
6  *
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
10  *
11  * http://www.apache.org/licenses/LICENSE-2.0
12  *
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.
18  *
19  */
20
21 // EXTERNAL INCLUDES
22 #include <string>
23
24 // INTERNAL INCLUDES
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>
38
39 namespace Dali
40 {
41
42 struct KeyEvent;
43 struct TouchEvent;
44 struct HoverEvent;
45 struct WheelEvent;
46
47 namespace Internal
48 {
49
50 class Actor;
51 class ActorGestureData;
52 class Animation;
53 class RenderTask;
54 class Renderer;
55
56 typedef std::vector< ActorPtr > ActorContainer;
57 typedef ActorContainer::iterator ActorIter;
58 typedef ActorContainer::const_iterator ActorConstIter;
59
60 typedef std::vector< RendererPtr > RendererContainer;
61 typedef RendererContainer::iterator RendererIter;
62
63 /**
64  * Actor is the primary object which Dali applications interact with.
65  * UI controls can be built by combining multiple actors.
66  * Multi-Touch events are received through signals emitted by the actor tree.
67  *
68  * An Actor is a proxy for a Node in the scene graph.
69  * When an Actor is added to the Stage, it creates a node and attaches it to the scene graph.
70  * The scene-graph can be updated in a separate thread, so the attachment is done using an asynchronous message.
71  * When a tree of Actors is detached from the Stage, a message is sent to destroy the associated nodes.
72  */
73 class Actor : public Object
74 {
75 public:
76
77   /**
78    * @brief Struct to hold an actor and a dimension
79    */
80   struct ActorDimensionPair
81   {
82     /**
83      * @brief Constructor
84      *
85      * @param[in] newActor The actor to assign
86      * @param[in] newDimension The dimension to assign
87      */
88     ActorDimensionPair( Actor* newActor, Dimension::Type newDimension )
89     : actor( newActor ),
90       dimension( newDimension )
91     {
92     }
93
94     /**
95      * @brief Equality operator
96      *
97      * @param[in] lhs The left hand side argument
98      * @param[in] rhs The right hand side argument
99      */
100     bool operator== ( const ActorDimensionPair& rhs )
101     {
102       return ( actor == rhs.actor ) && ( dimension == rhs.dimension );
103     }
104
105     Actor* actor;           ///< The actor to hold
106     Dimension::Type dimension;    ///< The dimension to hold
107   };
108
109   typedef std::vector< ActorDimensionPair > ActorDimensionStack;
110
111 public:
112
113   /**
114    * Create a new actor.
115    * @return A smart-pointer to the newly allocated Actor.
116    */
117   static ActorPtr New();
118
119   /**
120    * Retrieve the name of the actor.
121    * @return The name.
122    */
123   const std::string& GetName() const;
124
125   /**
126    * Set the name of the actor.
127    * @param[in] name The new name.
128    */
129   void SetName( const std::string& name );
130
131   /**
132    * @copydoc Dali::Actor::GetId
133    */
134   unsigned int GetId() const;
135
136   // Attachments
137
138   /**
139    * Attach an object to an actor.
140    * @pre The actor does not already have an attachment.
141    * @param[in] attachment The object to attach.
142    */
143   void Attach( ActorAttachment& attachment );
144
145   /**
146    * Retreive the object attached to an actor.
147    * @return The attachment.
148    */
149   ActorAttachmentPtr GetAttachment();
150
151   // Containment
152
153   /**
154    * Query whether an actor is the root actor, which is owned by the Stage.
155    * @return True if the actor is a root actor.
156    */
157   bool IsRoot() const
158   {
159     return mIsRoot;
160   }
161
162   /**
163    * Query whether the actor is connected to the Stage.
164    */
165   bool OnStage() const;
166
167   /**
168    * Query whether the actor is a RenderableActor derived type.
169    * @return True if the actor is renderable.
170    */
171   bool IsRenderable() const
172   {
173     // inlined as this is called a lot in hit testing
174     return mIsRenderable;
175   }
176
177   /**
178    * Query whether the actor is of class Dali::Layer
179    * @return True if the actor is a layer.
180    */
181   bool IsLayer() const
182   {
183     // inlined as this is called a lot in hit testing
184     return mIsLayer;
185   }
186
187   /**
188    * Gets the layer in which the actor is present
189    * @return The layer, which will be uninitialized if the actor is off-stage.
190    */
191   Dali::Layer GetLayer();
192
193   /**
194    * Adds a child Actor to this Actor.
195    * @pre The child actor is not the same as the parent actor.
196    * @pre The child actor does not already have a parent.
197    * @param [in] child The child.
198    * @post The child will be referenced by its parent.
199    */
200   void Add( Actor& child );
201
202   /**
203    * Removes a child Actor from this Actor.
204    * @param [in] child The child.
205    * @post The child will be unreferenced.
206    */
207   void Remove( Actor& child );
208
209   /**
210    * @copydoc Dali::Actor::Unparent
211    */
212   void Unparent();
213
214   /**
215    * Retrieve the number of children held by the actor.
216    * @return The number of children
217    */
218   unsigned int GetChildCount() const;
219
220   /**
221    * @copydoc Dali::Actor::GetChildAt
222    */
223   ActorPtr GetChildAt( unsigned int index ) const;
224
225   /**
226    * Retrieve a reference to Actor's children.
227    * @note Not for public use.
228    * @return A reference to the container of children.
229    */
230   ActorContainer& GetChildrenInternal()
231   {
232     return *mChildren;
233   }
234
235   /**
236    * @copydoc Dali::Actor::FindChildByName
237    */
238   ActorPtr FindChildByName( const std::string& actorName );
239
240   /**
241    * @copydoc Dali::Actor::FindChildById
242    */
243   ActorPtr FindChildById( const unsigned int id );
244
245   /**
246    * Retrieve the parent of an Actor.
247    * @return The parent actor, or NULL if the Actor does not have a parent.
248    */
249   Actor* GetParent() const
250   {
251     return mParent;
252   }
253
254   /**
255    * Sets the size of an actor.
256    * ActorAttachments attached to the actor, can be scaled to fit within this area.
257    * This does not interfere with the actors scale factor.
258    * @param [in] width  The new width.
259    * @param [in] height The new height.
260    */
261   void SetSize( float width, float height );
262
263   /**
264    * Sets the size of an actor.
265    * ActorAttachments attached to the actor, can be scaled to fit within this area.
266    * This does not interfere with the actors scale factor.
267    * @param [in] width The size of the actor along the x-axis.
268    * @param [in] height The size of the actor along the y-axis.
269    * @param [in] depth The size of the actor along the z-axis.
270    */
271   void SetSize( float width, float height, float depth );
272
273   /**
274    * Sets the size of an actor.
275    * ActorAttachments attached to the actor, can be scaled to fit within this area.
276    * This does not interfere with the actors scale factor.
277    * @param [in] size The new size.
278    */
279   void SetSize( const Vector2& size );
280
281   /**
282    * Sets the update size for an actor.
283    *
284    * @param[in] size The size to set.
285    */
286   void SetSizeInternal( const Vector2& size );
287
288   /**
289    * Sets the size of an actor.
290    * ActorAttachments attached to the actor, can be scaled to fit within this area.
291    * This does not interfere with the actors scale factor.
292    * @param [in] size The new size.
293    */
294   void SetSize( const Vector3& size );
295
296   /**
297    * Sets the update size for an actor.
298    *
299    * @param[in] size The size to set.
300    */
301   void SetSizeInternal( const Vector3& size );
302
303   /**
304    * Set the width component of the Actor's size.
305    * @param [in] width The new width component.
306    */
307   void SetWidth( float width );
308
309   /**
310    * Set the height component of the Actor's size.
311    * @param [in] height The new height component.
312    */
313   void SetHeight( float height );
314
315   /**
316    * Set the depth component of the Actor's size.
317    * @param [in] depth The new depth component.
318    */
319   void SetDepth( float depth );
320
321   /**
322    * Retrieve the Actor's size from event side.
323    * This size will be the size set or if animating then the target size.
324    * @return The Actor's size.
325    */
326   const Vector3& GetTargetSize() const;
327
328   /**
329    * Retrieve the Actor's size from update side.
330    * This size will be the size set or animating but will be a frame behind.
331    * @return The Actor's size.
332    */
333   const Vector3& GetCurrentSize() const;
334
335   /**
336    * Return the natural size of the actor
337    *
338    * @return The actor's natural size
339    */
340   virtual Vector3 GetNaturalSize() const;
341
342   /**
343    * Set the origin of an actor, within its parent's area.
344    * This is expressed in 2D unit coordinates, such that (0.0, 0.0, 0.5) is the top-left corner of the parent,
345    * and (1.0, 1.0, 0.5) is the bottom-right corner.
346    * The default parent-origin is top-left (0.0, 0.0, 0.5).
347    * An actor position is the distance between this origin, and the actors anchor-point.
348    * @param [in] origin The new parent-origin.
349    */
350   void SetParentOrigin( const Vector3& origin );
351
352   /**
353    * Set the x component of the parent-origin
354    * @param [in] x The new x value.
355    */
356   void SetParentOriginX( float x );
357
358   /**
359    * Set the y component of the parent-origin
360    * @param [in] y The new y value.
361    */
362   void SetParentOriginY( float y );
363
364   /**
365    * Set the z component of the parent-origin
366    * @param [in] z The new z value.
367    */
368   void SetParentOriginZ( float z );
369
370   /**
371    * Retrieve the parent-origin of an actor.
372    * @return The parent-origin.
373    */
374   const Vector3& GetCurrentParentOrigin() const;
375
376   /**
377    * Set the anchor-point of an actor. This is expressed in 2D unit coordinates, such that
378    * (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.
379    * The default anchor point is top-left (0.0, 0.0, 0.5).
380    * An actor position is the distance between its parent-origin, and this anchor-point.
381    * An actor's rotation is centered around its anchor-point.
382    * @param [in] anchorPoint The new anchor-point.
383    */
384   void SetAnchorPoint( const Vector3& anchorPoint );
385
386   /**
387    * Set the x component of the anchor-point.
388    * @param [in] x The new x value.
389    */
390   void SetAnchorPointX( float x );
391
392   /**
393    * Set the y component of the anchor-point.
394    * @param [in] y The new y value.
395    */
396   void SetAnchorPointY( float y );
397
398   /**
399    * Set the z component of the anchor-point.
400    * @param [in] z The new z value.
401    */
402   void SetAnchorPointZ( float z );
403
404   /**
405    * Retrieve the anchor-point of an actor.
406    * @return The anchor-point.
407    */
408   const Vector3& GetCurrentAnchorPoint() const;
409
410   /**
411    * Sets the position of the Actor.
412    * The coordinates are relative to the Actor's parent.
413    * The Actor's z position will be set to 0.0f.
414    * @param [in] x The new x position
415    * @param [in] y The new y position
416    */
417   void SetPosition( float x, float y );
418
419   /**
420    * Sets the position of the Actor.
421    * The coordinates are relative to the Actor's parent.
422    * @param [in] x The new x position
423    * @param [in] y The new y position
424    * @param [in] z The new z position
425    */
426   void SetPosition( float x, float y, float z );
427
428   /**
429    * Sets the position of the Actor.
430    * The coordinates are relative to the Actor's parent.
431    * @param [in] position The new position.
432    */
433   void SetPosition( const Vector3& position );
434
435   /**
436    * Set the position of an actor along the X-axis.
437    * @param [in] x The new x position
438    */
439   void SetX( float x );
440
441   /**
442    * Set the position of an actor along the Y-axis.
443    * @param [in] y The new y position.
444    */
445   void SetY( float y );
446
447   /**
448    * Set the position of an actor along the Z-axis.
449    * @param [in] z The new z position
450    */
451   void SetZ( float z );
452
453   /**
454    * Translate an actor relative to its existing position.
455    * @param[in] distance The actor will move by this distance.
456    */
457   void TranslateBy( const Vector3& distance );
458
459   /**
460    * Retrieve the position of the Actor.
461    * The coordinates are relative to the Actor's parent.
462    * @return the Actor's position.
463    */
464   const Vector3& GetCurrentPosition() const;
465
466   /**
467    * Retrieve the target position of the Actor.
468    * The coordinates are relative to the Actor's parent.
469    * @return the Actor's position.
470    */
471   const Vector3& GetTargetPosition() const;
472
473   /**
474    * @copydoc Dali::Actor::GetCurrentWorldPosition()
475    */
476   const Vector3& GetCurrentWorldPosition() const;
477
478   /**
479    * @copydoc Dali::Actor::SetPositionInheritanceMode()
480    */
481   void SetPositionInheritanceMode( PositionInheritanceMode mode );
482
483   /**
484    * @copydoc Dali::Actor::GetPositionInheritanceMode()
485    */
486   PositionInheritanceMode GetPositionInheritanceMode() const;
487
488   /**
489    * Sets the orientation of the Actor.
490    * @param [in] angleRadians The new orientation angle in radians.
491    * @param [in] axis The new axis of orientation.
492    */
493   void SetOrientation( const Radian& angleRadians, const Vector3& axis );
494
495   /**
496    * Sets the orientation of the Actor.
497    * @param [in] orientation The new orientation.
498    */
499   void SetOrientation( const Quaternion& orientation );
500
501   /**
502    * Rotate an actor around its existing rotation axis.
503    * @param[in] angleRadians The angle to the rotation to combine with the existing rotation.
504    * @param[in] axis The axis of the rotation to combine with the existing rotation.
505    */
506   void RotateBy( const Radian& angleRadians, const Vector3& axis );
507
508   /**
509    * Apply a relative rotation to an actor.
510    * @param[in] relativeRotation The rotation to combine with the actors existing rotation.
511    */
512   void RotateBy( const Quaternion& relativeRotation );
513
514   /**
515    * Retreive the Actor's orientation.
516    * @return the orientation.
517    */
518   const Quaternion& GetCurrentOrientation() const;
519
520   /**
521    * Set whether a child actor inherits it's parent's orientation. Default is to inherit.
522    * Switching this off means that using SetOrientation() sets the actor's world orientation.
523    * @param[in] inherit - true if the actor should inherit orientation, false otherwise.
524    */
525   void SetInheritOrientation( bool inherit );
526
527   /**
528    * Returns whether the actor inherit's it's parent's orientation.
529    * @return true if the actor inherit's it's parent orientation, false if it uses world orientation.
530    */
531   bool IsOrientationInherited() const;
532
533   /**
534    * Sets the factor of the parents size used for the child actor.
535    * Note: Only used if ResizePolicy is ResizePolicy::SIZE_RELATIVE_TO_PARENT or ResizePolicy::SIZE_FIXED_OFFSET_FROM_PARENT.
536    * @param[in] factor The vector to multiply the parents size by to get the childs size.
537    */
538   void SetSizeModeFactor( const Vector3& factor );
539
540   /**
541    * Gets the factor of the parents size used for the child actor.
542    * Note: Only used if ResizePolicy is ResizePolicy::SIZE_RELATIVE_TO_PARENT or ResizePolicy::SIZE_FIXED_OFFSET_FROM_PARENT.
543    * @return The vector being used to multiply the parents size by to get the childs size.
544    */
545   const Vector3& GetSizeModeFactor() const;
546
547   /**
548    * @copydoc Dali::Actor::GetCurrentWorldOrientation()
549    */
550   const Quaternion& GetCurrentWorldOrientation() const;
551
552   /**
553    * Sets a scale factor applied to an actor.
554    * @param [in] scale The scale factor applied on all axes.
555    */
556   void SetScale( float scale );
557
558   /**
559    * Sets a scale factor applied to an actor.
560    * @param [in] scaleX The scale factor applied along the x-axis.
561    * @param [in] scaleY The scale factor applied along the y-axis.
562    * @param [in] scaleZ The scale factor applied along the z-axis.
563    */
564   void SetScale( float scaleX, float scaleY, float scaleZ );
565
566   /**
567    * Sets a scale factor applied to an actor.
568    * @param [in] scale A vector representing the scale factor for each axis.
569    */
570   void SetScale( const Vector3& scale );
571
572   /**
573    * Set the x component of the scale factor.
574    * @param [in] x The new x value.
575    */
576   void SetScaleX( float x );
577
578   /**
579    * Set the y component of the scale factor.
580    * @param [in] y The new y value.
581    */
582   void SetScaleY( float y );
583
584   /**
585    * Set the z component of the scale factor.
586    * @param [in] z The new z value.
587    */
588   void SetScaleZ( float z );
589
590   /**
591    * Apply a relative scale to an actor.
592    * @param[in] relativeScale The scale to combine with the actors existing scale.
593    */
594   void ScaleBy( const Vector3& relativeScale );
595
596   /**
597    * Retrieve the scale factor applied to an actor.
598    * @return A vector representing the scale factor for each axis.
599    */
600   const Vector3& GetCurrentScale() const;
601
602   /**
603    * @copydoc Dali::Actor::GetCurrentWorldScale()
604    */
605   const Vector3& GetCurrentWorldScale() const;
606
607   /**
608    * @copydoc Dali::Actor::SetInheritScale()
609    */
610   void SetInheritScale( bool inherit );
611
612   /**
613    * @copydoc Dali::Actor::IsScaleInherited()
614    */
615   bool IsScaleInherited() const;
616
617   /**
618    * @copydoc Dali::Actor::GetCurrentWorldMatrix()
619    */
620   Matrix GetCurrentWorldMatrix() const;
621
622   // Visibility
623
624   /**
625    * Sets the visibility flag of an actor.
626    * @param [in] visible The new visibility flag.
627    */
628   void SetVisible( bool visible );
629
630   /**
631    * Retrieve the visibility flag of an actor.
632    * @return The visibility flag.
633    */
634   bool IsVisible() const;
635
636   /**
637    * Sets the opacity of an actor.
638    * @param [in] opacity The new opacity.
639    */
640   void SetOpacity( float opacity );
641
642   /**
643    * Retrieve the actor's opacity.
644    * @return The actor's opacity.
645    */
646   float GetCurrentOpacity() const;
647
648   /**
649    * Sets whether an actor should emit touch or hover signals; see SignalTouch() and SignalHover().
650    * An actor is sensitive by default, which means that as soon as an application connects to the SignalTouch(),
651    * the touch event signal will be emitted, and as soon as an application connects to the SignalHover(), the
652    * hover event signal will be emitted.
653    *
654    * If the application wishes to temporarily disable the touch or hover event signal emission, then they can do so by calling:
655    * @code
656    * actor.SetSensitive(false);
657    * @endcode
658    *
659    * Then, to re-enable the touch or hover event signal emission, the application should call:
660    * @code
661    * actor.SetSensitive(true);
662    * @endcode
663    *
664    * @see SignalTouch() and SignalHover().
665    * @note If an actor's sensitivity is set to false, then it's children will not emit a touch or hover event signal either.
666    * @param[in]  sensitive  true to enable emission of the touch or hover event signals, false otherwise.
667    */
668   void SetSensitive( bool sensitive )
669   {
670     mSensitive = sensitive;
671   }
672
673   /**
674    * Query whether an actor emits touch or hover event signals.
675    * @see SetSensitive(bool)
676    * @return true, if emission of touch or hover event signals is enabled, false otherwise.
677    */
678   bool IsSensitive() const
679   {
680     return mSensitive;
681   }
682
683   /**
684    * @copydoc Dali::Actor::SetDrawMode
685    */
686   void SetDrawMode( DrawMode::Type drawMode );
687
688   /**
689    * @copydoc Dali::Actor::GetDrawMode
690    */
691   DrawMode::Type GetDrawMode() const;
692
693   /**
694    * @copydoc Dali::Actor::SetOverlay
695    */
696   void SetOverlay( bool enable );
697
698   /**
699    * @copydoc Dali::Actor::IsOverlay
700    */
701   bool IsOverlay() const;
702
703   /**
704    * Sets the actor's color.  The final color of actor depends on its color mode.
705    * This final color is applied to the drawable elements of an actor.
706    * @param [in] color The new color.
707    */
708   void SetColor( const Vector4& color );
709
710   /**
711    * Set the red component of the color.
712    * @param [in] red The new red component.
713    */
714   void SetColorRed( float red );
715
716   /**
717    * Set the green component of the color.
718    * @param [in] green The new green component.
719    */
720   void SetColorGreen( float green );
721
722   /**
723    * Set the blue component of the scale factor.
724    * @param [in] blue The new blue value.
725    */
726   void SetColorBlue( float blue );
727
728   /**
729    * Retrieve the actor's color.
730    * @return The color.
731    */
732   const Vector4& GetCurrentColor() const;
733
734   /**
735    * Sets the actor's color mode.
736    * Color mode specifies whether Actor uses its own color or inherits its parent color
737    * @param [in] colorMode to use.
738    */
739   void SetColorMode( ColorMode colorMode );
740
741   /**
742    * Returns the actor's color mode.
743    * @return currently used colorMode.
744    */
745   ColorMode GetColorMode() const;
746
747   /**
748    * @copydoc Dali::Actor::GetCurrentWorldColor()
749    */
750   const Vector4& GetCurrentWorldColor() const;
751
752   /**
753    * @copydoc Dali::Actor::GetHierarchyDepth()
754    */
755   int GetHierarchyDepth() const
756   {
757     if( mIsOnStage )
758     {
759       return static_cast<int>(mDepth);
760     }
761
762     return -1;
763   }
764
765 public:
766
767   // Size negotiation virtual functions
768
769   /**
770    * @brief Called after the size negotiation has been finished for this control.
771    *
772    * The control is expected to assign this given size to itself/its children.
773    *
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.
777    *
778    * Note! As this function is called from inside the size negotiation algorithm, you cannot
779    * call RequestRelayout (the call would just be ignored)
780    *
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.
784    */
785   virtual void OnRelayout( const Vector2& size, RelayoutContainer& container )
786   {
787   }
788
789   /**
790    * @brief Notification for deriving classes when the resize policy is set
791    *
792    * @param[in] policy The policy being set
793    * @param[in] dimension The dimension the policy is being set for
794    */
795   virtual void OnSetResizePolicy( ResizePolicy::Type policy, Dimension::Type dimension ) {}
796
797   /**
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
800    *
801    * @param dimension The dimension that is about to be calculated
802    */
803   virtual void OnCalculateRelayoutSize( Dimension::Type dimension );
804
805   /**
806    * @brief Virtual method to notify deriving classes that the size for a dimension
807    * has just been negotiated
808    *
809    * @param[in] size The new size for the given dimension
810    * @param[in] dimension The dimension that was just negotiated
811    */
812   virtual void OnLayoutNegotiated( float size, Dimension::Type dimension );
813
814   /**
815    * @brief Determine if this actor is dependent on it's children for relayout
816    *
817    * @param dimension The dimension(s) to check for
818    * @return Return if the actor is dependent on it's children
819    */
820   virtual bool RelayoutDependentOnChildren( Dimension::Type dimension = Dimension::ALL_DIMENSIONS );
821
822   /**
823    * @brief Determine if this actor is dependent on it's children for relayout.
824    *
825    * Called from deriving classes
826    *
827    * @param dimension The dimension(s) to check for
828    * @return Return if the actor is dependent on it's children
829    */
830   virtual bool RelayoutDependentOnChildrenBase( Dimension::Type dimension = Dimension::ALL_DIMENSIONS );
831
832   /**
833    * @brief Calculate the size for a child
834    *
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
838    */
839   virtual float CalculateChildSize( const Dali::Actor& child, Dimension::Type dimension );
840
841   /**
842    * @brief This method is called during size negotiation when a height is required for a given width.
843    *
844    * Derived classes should override this if they wish to customize the height returned.
845    *
846    * @param width to use.
847    * @return the height based on the width.
848    */
849   virtual float GetHeightForWidth( float width );
850
851   /**
852    * @brief This method is called during size negotiation when a width is required for a given height.
853    *
854    * Derived classes should override this if they wish to customize the width returned.
855    *
856    * @param height to use.
857    * @return the width based on the width.
858    */
859   virtual float GetWidthForHeight( float height );
860
861 public:
862
863   // Size negotiation
864
865   /**
866    * @brief Called by the RelayoutController to negotiate the size of an actor.
867    *
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.
872    *
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.
876    */
877   void NegotiateSize( const Vector2& size, RelayoutContainer& container );
878
879   /**
880    * @copydoc Dali::Actor::SetResizePolicy()
881    */
882   void SetResizePolicy( ResizePolicy::Type policy, Dimension::Type dimension = Dimension::ALL_DIMENSIONS );
883
884   /**
885    * @copydoc Dali::Actor::GetResizePolicy()
886    */
887   ResizePolicy::Type GetResizePolicy( Dimension::Type dimension ) const;
888
889   /**
890    * @copydoc Dali::Actor::SetSizeScalePolicy()
891    */
892   void SetSizeScalePolicy( SizeScalePolicy::Type policy );
893
894   /**
895    * @copydoc Dali::Actor::GetSizeScalePolicy()
896    */
897   SizeScalePolicy::Type GetSizeScalePolicy() const;
898
899   /**
900    * @copydoc Dali::Actor::SetDimensionDependency()
901    */
902   void SetDimensionDependency( Dimension::Type dimension, Dimension::Type dependency );
903
904   /**
905    * @copydoc Dali::Actor::GetDimensionDependency()
906    */
907   Dimension::Type GetDimensionDependency( Dimension::Type dimension ) const;
908
909   /**
910    * @brief Set the size negotiation relayout enabled on this actor
911    *
912    * @param[in] relayoutEnabled Boolean to enable or disable relayout
913    */
914   void SetRelayoutEnabled( bool relayoutEnabled );
915
916   /**
917    * @brief Return if relayout is enabled
918    *
919    * @return Return if relayout is enabled or not for this actor
920    */
921   bool IsRelayoutEnabled() const;
922
923   /**
924    * @brief Mark an actor as having it's layout dirty
925    *
926    * @param dirty Whether to mark actor as dirty or not
927    * @param dimension The dimension(s) to mark as dirty
928    */
929   void SetLayoutDirty( bool dirty, Dimension::Type dimension = Dimension::ALL_DIMENSIONS );
930
931   /**
932    * @brief Return if any of an actor's dimensions are marked as dirty
933    *
934    * @param dimension The dimension(s) to check
935    * @return Return if any of the requested dimensions are dirty
936    */
937   bool IsLayoutDirty( Dimension::Type dimension = Dimension::ALL_DIMENSIONS ) const;
938
939   /**
940    * @brief Returns if relayout is enabled and the actor is not dirty
941    *
942    * @return Return if it is possible to relayout the actor
943    */
944   bool RelayoutPossible( Dimension::Type dimension = Dimension::ALL_DIMENSIONS ) const;
945
946   /**
947    * @brief Returns if relayout is enabled and the actor is dirty
948    *
949    * @return Return if it is required to relayout the actor
950    */
951   bool RelayoutRequired( Dimension::Type dimension = Dimension::ALL_DIMENSIONS ) const;
952
953   /**
954    * @brief Request a relayout, which means performing a size negotiation on this actor, its parent and children (and potentially whole scene)
955    *
956    * This method is automatically called from OnStageConnection(), OnChildAdd(),
957    * OnChildRemove(), SetSizePolicy(), SetMinimumSize() and SetMaximumSize().
958    *
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.
962    *
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.
965    */
966   void RelayoutRequest( Dimension::Type dimension = Dimension::ALL_DIMENSIONS );
967
968   /**
969    * @brief Determine if this actor is dependent on it's parent for relayout
970    *
971    * @param dimension The dimension(s) to check for
972    * @return Return if the actor is dependent on it's parent
973    */
974   bool RelayoutDependentOnParent( Dimension::Type dimension = Dimension::ALL_DIMENSIONS );
975
976   /**
977    * @brief Determine if this actor has another dimension depedent on the specified one
978    *
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
982    */
983   bool RelayoutDependentOnDimension( Dimension::Type dimension, Dimension::Type dependentDimension );
984
985   /**
986    * Negotiate sizes for a control in all dimensions
987    *
988    * @param[in] allocatedSize The size constraint that the control must respect
989    */
990   void NegotiateDimensions( const Vector2& allocatedSize );
991
992   /**
993    * Negotiate size for a specific dimension
994    *
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.
998    *
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.
1001    *
1002    * @param[in] dimension The dimension to negotiate on
1003    * @param[in] allocatedSize The size constraint that the actor must respect
1004    */
1005   void NegotiateDimension( Dimension::Type dimension, const Vector2& allocatedSize, ActorDimensionStack& recursionStack );
1006
1007   /**
1008    * @brief Calculate the size of a dimension
1009    *
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
1013    */
1014   float CalculateSize( Dimension::Type dimension, const Vector2& maximumSize );
1015
1016   /**
1017    * @brief Clamp a dimension given the relayout constraints on this actor
1018    *
1019    * @param[in] size The size to constrain
1020    * @param[in] dimension The dimension the size exists in
1021    * @return Return the clamped size
1022    */
1023   float ClampDimension( float size, Dimension::Type dimension );
1024
1025   /**
1026    * Negotiate a dimension based on the size of the parent
1027    *
1028    * @param[in] dimension The dimension to negotiate on
1029    * @return Return the negotiated size
1030    */
1031   float NegotiateFromParent( Dimension::Type dimension );
1032
1033   /**
1034    * Negotiate a dimension based on the size of the parent. Fitting inside.
1035    *
1036    * @param[in] dimension The dimension to negotiate on
1037    * @return Return the negotiated size
1038    */
1039   float NegotiateFromParentFit( Dimension::Type dimension );
1040
1041   /**
1042    * Negotiate a dimension based on the size of the parent. Flooding the whole space.
1043    *
1044    * @param[in] dimension The dimension to negotiate on
1045    * @return Return the negotiated size
1046    */
1047   float NegotiateFromParentFlood( Dimension::Type dimension );
1048
1049   /**
1050    * @brief Negotiate a dimension based on the size of the children
1051    *
1052    * @param[in] dimension The dimension to negotiate on
1053    * @return Return the negotiated size
1054    */
1055   float NegotiateFromChildren( Dimension::Type dimension );
1056
1057   /**
1058    * Set the negotiated dimension value for the given dimension(s)
1059    *
1060    * @param negotiatedDimension The value to set
1061    * @param dimension The dimension(s) to set the value for
1062    */
1063   void SetNegotiatedDimension( float negotiatedDimension, Dimension::Type dimension = Dimension::ALL_DIMENSIONS );
1064
1065   /**
1066    * Return the value of negotiated dimension for the given dimension
1067    *
1068    * @param dimension The dimension to retrieve
1069    * @return Return the value of the negotiated dimension
1070    */
1071   float GetNegotiatedDimension( Dimension::Type dimension ) const;
1072
1073   /**
1074    * @brief Set the padding for a dimension
1075    *
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
1078    */
1079   void SetPadding( const Vector2& padding, Dimension::Type dimension );
1080
1081   /**
1082    * Return the value of padding for the given dimension
1083    *
1084    * @param dimension The dimension to retrieve
1085    * @return Return the value of padding for the dimension
1086    */
1087   Vector2 GetPadding( Dimension::Type dimension ) const;
1088
1089   /**
1090    * Return the actor size for a given dimension
1091    *
1092    * @param[in] dimension The dimension to retrieve the size for
1093    * @return Return the size for the given dimension
1094    */
1095   float GetSize( Dimension::Type dimension ) const;
1096
1097   /**
1098    * Return the natural size of the actor for a given dimension
1099    *
1100    * @param[in] dimension The dimension to retrieve the size for
1101    * @return Return the natural size for the given dimension
1102    */
1103   float GetNaturalSize( Dimension::Type dimension ) const;
1104
1105   /**
1106    * @brief Return the amount of size allocated for relayout
1107    *
1108    * May include padding
1109    *
1110    * @param[in] dimension The dimension to retrieve
1111    * @return Return the size
1112    */
1113   float GetRelayoutSize( Dimension::Type dimension ) const;
1114
1115   /**
1116    * @brief If the size has been negotiated return that else return normal size
1117    *
1118    * @param[in] dimension The dimension to retrieve
1119    * @return Return the size
1120    */
1121   float GetLatestSize( Dimension::Type dimension ) const;
1122
1123   /**
1124    * Apply the negotiated size to the actor
1125    *
1126    * @param[in] container The container to fill with actors that require further relayout
1127    */
1128   void SetNegotiatedSize( RelayoutContainer& container );
1129
1130   /**
1131    * @brief Flag the actor as having it's layout dimension negotiated.
1132    *
1133    * @param[in] negotiated The status of the flag to set.
1134    * @param[in] dimension The dimension to set the flag for
1135    */
1136   void SetLayoutNegotiated( bool negotiated, Dimension::Type dimension = Dimension::ALL_DIMENSIONS );
1137
1138   /**
1139    * @brief Test whether the layout dimension for this actor has been negotiated or not.
1140    *
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.
1143    */
1144   bool IsLayoutNegotiated( Dimension::Type dimension = Dimension::ALL_DIMENSIONS ) const;
1145
1146   /**
1147    * @brief provides the Actor implementation of GetHeightForWidth
1148    * @param width to use.
1149    * @return the height based on the width.
1150    */
1151   float GetHeightForWidthBase( float width );
1152
1153   /**
1154    * @brief provides the Actor implementation of GetWidthForHeight
1155    * @param height to use.
1156    * @return the width based on the height.
1157    */
1158   float GetWidthForHeightBase( float height );
1159
1160   /**
1161    * @brief Calculate the size for a child
1162    *
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
1166    */
1167   float CalculateChildSizeBase( const Dali::Actor& child, Dimension::Type dimension );
1168
1169   /**
1170    * @brief Set the preferred size for size negotiation
1171    *
1172    * @param[in] size The preferred size to set
1173    */
1174   void SetPreferredSize( const Vector2& size );
1175
1176   /**
1177    * @brief Return the preferred size used for size negotiation
1178    *
1179    * @return Return the preferred size
1180    */
1181   Vector2 GetPreferredSize() const;
1182
1183   /**
1184    * @copydoc Dali::Actor::SetMinimumSize
1185    */
1186   void SetMinimumSize( float size, Dimension::Type dimension = Dimension::ALL_DIMENSIONS );
1187
1188   /**
1189    * @copydoc Dali::Actor::GetMinimumSize
1190    */
1191   float GetMinimumSize( Dimension::Type dimension ) const;
1192
1193   /**
1194    * @copydoc Dali::Actor::SetMaximumSize
1195    */
1196   void SetMaximumSize( float size, Dimension::Type dimension = Dimension::ALL_DIMENSIONS );
1197
1198   /**
1199    * @copydoc Dali::Actor::GetMaximumSize
1200    */
1201   float GetMaximumSize( Dimension::Type dimension ) const;
1202   
1203   /**
1204    * @copydoc Dali::Actor::AddRenderer()
1205    */
1206   unsigned int AddRenderer( Renderer& renderer );
1207
1208   /**
1209    * @copydoc Dali::Actor::GetRendererCount()
1210    */
1211   unsigned int GetRendererCount() const;
1212
1213   /**
1214    * @copydoc Dali::Actor::GetRendererAt()
1215    */
1216   RendererPtr GetRendererAt( unsigned int index );
1217
1218   /**
1219    * @copydoc Dali::Actor::RemoveRenderer()
1220    */
1221   void RemoveRenderer( Renderer& renderer );
1222
1223   /**
1224    * @copydoc Dali::Actor::RemoveRenderer()
1225    */
1226   void RemoveRenderer( unsigned int index );
1227
1228 public:
1229
1230   /**
1231    * Converts screen coordinates into the actor's coordinate system.
1232    * @note The actor coordinates are relative to the top-left (0.0, 0.0, 0.5)
1233    * @param[out] localX On return, the X-coordinate relative to the actor.
1234    * @param[out] localY On return, the Y-coordinate relative to the actor.
1235    * @param[in] screenX The screen X-coordinate.
1236    * @param[in] screenY The screen Y-coordinate.
1237    * @return True if the conversion succeeded.
1238    */
1239   bool ScreenToLocal( float& localX, float& localY, float screenX, float screenY ) const;
1240
1241   /**
1242    * Converts screen coordinates into the actor's coordinate system.
1243    * @note The actor coordinates are relative to the top-left (0.0, 0.0, 0.5)
1244    * @param[in] renderTask The render-task used to display the actor.
1245    * @param[out] localX On return, the X-coordinate relative to the actor.
1246    * @param[out] localY On return, the Y-coordinate relative to the actor.
1247    * @param[in] screenX The screen X-coordinate.
1248    * @param[in] screenY The screen Y-coordinate.
1249    * @return True if the conversion succeeded.
1250    */
1251   bool ScreenToLocal( RenderTask& renderTask, float& localX, float& localY, float screenX, float screenY ) const;
1252
1253   /**
1254    * Converts from the actor's coordinate system to screen coordinates.
1255    * @note The actor coordinates are relative to the top-left (0.0, 0.0, 0.5)
1256    * @param[in] viewMatrix The view-matrix
1257    * @param[in] projectionMatrix The projection-matrix
1258    * @param[in] viewport The view-port
1259    * @param[out] localX On return, the X-coordinate relative to the actor.
1260    * @param[out] localY On return, the Y-coordinate relative to the actor.
1261    * @param[in] screenX The screen X-coordinate.
1262    * @param[in] screenY The screen Y-coordinate.
1263    * @return True if the conversion succeeded.
1264    */
1265   bool ScreenToLocal( const Matrix& viewMatrix,
1266                       const Matrix& projectionMatrix,
1267                       const Viewport& viewport,
1268                       float& localX,
1269                       float& localY,
1270                       float screenX,
1271                       float screenY ) const;
1272
1273   /**
1274    * Performs a ray-sphere test with the given pick-ray and the actor's bounding sphere.
1275    * @note The actor coordinates are relative to the top-left (0.0, 0.0, 0.5)
1276    * @param[in] rayOrigin The ray origin in the world's reference system.
1277    * @param[in] rayDir The ray director vector in the world's reference system.
1278    * @return True if the ray intersects the actor's bounding sphere.
1279    */
1280   bool RaySphereTest( const Vector4& rayOrigin, const Vector4& rayDir ) const;
1281
1282   /**
1283    * Performs a ray-actor test with the given pick-ray and the actor's geometry.
1284    * @note The actor coordinates are relative to the top-left (0.0, 0.0, 0.5)
1285    * @param[in] rayOrigin The ray origin in the world's reference system.
1286    * @param[in] rayDir The ray director vector in the world's reference system.
1287    * @param[out] hitPointLocal The hit point in the Actor's local reference system.
1288    * @param[out] distance The distance from the hit point to the camera.
1289    * @return True if the ray intersects the actor's geometry.
1290    */
1291   bool RayActorTest( const Vector4& rayOrigin,
1292                      const Vector4& rayDir,
1293                      Vector4& hitPointLocal,
1294                      float& distance ) const;
1295
1296   /**
1297    * Sets whether the actor should receive a notification when touch or hover motion events leave
1298    * the boundary of the actor.
1299    *
1300    * @note By default, this is set to false as most actors do not require this.
1301    * @note Need to connect to the SignalTouch or SignalHover to actually receive this event.
1302    *
1303    * @param[in]  required  Should be set to true if a Leave event is required
1304    */
1305   void SetLeaveRequired( bool required );
1306
1307   /**
1308    * This returns whether the actor requires touch or hover events whenever touch or hover motion events leave
1309    * the boundary of the actor.
1310    * @return true if a Leave event is required, false otherwise.
1311    */
1312   bool GetLeaveRequired() const;
1313
1314   /**
1315    * @copydoc Dali::Actor::SetKeyboardFocusable()
1316    */
1317   void SetKeyboardFocusable( bool focusable );
1318
1319   /**
1320    * @copydoc Dali::Actor::IsKeyboardFocusable()
1321    */
1322   bool IsKeyboardFocusable() const;
1323
1324   /**
1325    * Query whether the application or derived actor type requires touch events.
1326    * @return True if touch events are required.
1327    */
1328   bool GetTouchRequired() const;
1329
1330   /**
1331    * Query whether the application or derived actor type requires hover events.
1332    * @return True if hover events are required.
1333    */
1334   bool GetHoverRequired() const;
1335
1336   /**
1337    * Query whether the application or derived actor type requires wheel events.
1338    * @return True if wheel events are required.
1339    */
1340   bool GetWheelEventRequired() const;
1341
1342   /**
1343    * Query whether the actor is actually hittable.  This method checks whether the actor is
1344    * sensitive, has the visibility flag set to true and is not fully transparent.
1345    * @return true, if it can be hit, false otherwise.
1346    */
1347   bool IsHittable() const;
1348
1349   // Gestures
1350
1351   /**
1352    * Retrieve the gesture data associated with this actor. The first call to this method will
1353    * allocate space for the ActorGestureData so this should only be called if an actor really does
1354    * require gestures.
1355    * @return Reference to the ActorGestureData for this actor.
1356    * @note Once the gesture-data is created for an actor it is likely that gestures are required
1357    * throughout the actor's lifetime so it will only be deleted when the actor is destroyed.
1358    */
1359   ActorGestureData& GetGestureData();
1360
1361   /**
1362    * Queries whether the actor requires the gesture type.
1363    * @param[in] type The gesture type.
1364    */
1365   bool IsGestureRequred( Gesture::Type type ) const;
1366
1367   // Signals
1368
1369   /**
1370    * Used by the EventProcessor to emit touch event signals.
1371    * @param[in] event The touch event.
1372    * @return True if the event was consumed.
1373    */
1374   bool EmitTouchEventSignal( const TouchEvent& event );
1375
1376   /**
1377    * Used by the EventProcessor to emit hover event signals.
1378    * @param[in] event The hover event.
1379    * @return True if the event was consumed.
1380    */
1381   bool EmitHoverEventSignal( const HoverEvent& event );
1382
1383   /**
1384    * Used by the EventProcessor to emit wheel event signals.
1385    * @param[in] event The wheel event.
1386    * @return True if the event was consumed.
1387    */
1388   bool EmitWheelEventSignal( const WheelEvent& event );
1389
1390   /**
1391    * @copydoc Dali::Actor::TouchedSignal()
1392    */
1393   Dali::Actor::TouchSignalType& TouchedSignal();
1394
1395   /**
1396    * @copydoc Dali::Actor::HoveredSignal()
1397    */
1398   Dali::Actor::HoverSignalType& HoveredSignal();
1399
1400   /**
1401    * @copydoc Dali::Actor::WheelEventSignal()
1402    */
1403   Dali::Actor::WheelEventSignalType& WheelEventSignal();
1404
1405   /**
1406    * @copydoc Dali::Actor::OnStageSignal()
1407    */
1408   Dali::Actor::OnStageSignalType& OnStageSignal();
1409
1410   /**
1411    * @copydoc Dali::Actor::OffStageSignal()
1412    */
1413   Dali::Actor::OffStageSignalType& OffStageSignal();
1414
1415   /**
1416    * @copydoc Dali::Actor::OnRelayoutSignal()
1417    */
1418   Dali::Actor::OnRelayoutSignalType& OnRelayoutSignal();
1419
1420   /**
1421    * Connects a callback function with the object's signals.
1422    * @param[in] object The object providing the signal.
1423    * @param[in] tracker Used to disconnect the signal.
1424    * @param[in] signalName The signal to connect to.
1425    * @param[in] functor A newly allocated FunctorDelegate.
1426    * @return True if the signal was connected.
1427    * @post If a signal was connected, ownership of functor was passed to CallbackBase. Otherwise the caller is responsible for deleting the unused functor.
1428    */
1429   static bool DoConnectSignal( BaseObject* object,
1430                                ConnectionTrackerInterface* tracker,
1431                                const std::string& signalName,
1432                                FunctorDelegate* functor );
1433
1434   /**
1435    * Performs actions as requested using the action name.
1436    * @param[in] object The object on which to perform the action.
1437    * @param[in] actionName The action to perform.
1438    * @param[in] attributes The attributes with which to perfrom this action.
1439    * @return true if the action was done.
1440    */
1441   static bool DoAction( BaseObject* object,
1442                         const std::string& actionName,
1443                         const Property::Map& attributes );
1444
1445 public:
1446   // For Animation
1447
1448   /**
1449    * This should only be called by Animation, when the actors SIZE property is animated.
1450    *
1451    * @param[in] animation The animation that resized the actor
1452    * @param[in] targetSize The new target size of the actor
1453    */
1454   void NotifySizeAnimation( Animation& animation, const Vector3& targetSize );
1455
1456   /**
1457    * This should only be called by Animation, when the actors SIZE_WIDTH or SIZE_HEIGHT property is animated.
1458    *
1459    * @param[in] animation The animation that resized the actor
1460    * @param[in] targetSize The new target size of the actor
1461    */
1462   void NotifySizeAnimation( Animation& animation, float targetSize, Property::Index property );
1463
1464   /**
1465    * For use in derived classes.
1466    * This should only be called by Animation, when the actor is resized using Animation::Resize().
1467    */
1468   virtual void OnSizeAnimation( Animation& animation, const Vector3& targetSize )
1469   {
1470   }
1471
1472 protected:
1473
1474   enum DerivedType
1475   {
1476     BASIC, RENDERABLE, LAYER, ROOT_LAYER
1477   };
1478
1479   /**
1480    * Protected Constructor.  See Actor::New().
1481    * The second-phase construction Initialize() member should be called immediately after this.
1482    * @param[in] derivedType The derived type of actor (if any).
1483    */
1484   Actor( DerivedType derivedType );
1485
1486   /**
1487    * Second-phase constructor. Must be called immediately after creating a new Actor;
1488    */
1489   void Initialize( void );
1490
1491   /**
1492    * A reference counted object may only be deleted by calling Unreference()
1493    */
1494   virtual ~Actor();
1495
1496   /**
1497    * Called on a child during Add() when the parent actor is connected to the Stage.
1498    * @param[in] parentDepth The depth of the parent in the hierarchy.
1499    */
1500   void ConnectToStage( unsigned int parentDepth );
1501
1502   /**
1503    * Helper for ConnectToStage, to recursively connect a tree of actors.
1504    * This is atomic i.e. not interrupted by user callbacks.
1505    * @param[in]  depth The depth in the hierarchy of the actor
1506    * @param[out] connectionList On return, the list of connected actors which require notification.
1507    */
1508   void RecursiveConnectToStage( ActorContainer& connectionList, unsigned int depth );
1509
1510   /**
1511    * Connect the Node associated with this Actor to the scene-graph.
1512    */
1513   void ConnectToSceneGraph();
1514
1515   /**
1516    * Helper for ConnectToStage, to notify a connected actor through the public API.
1517    */
1518   void NotifyStageConnection();
1519
1520   /**
1521    * Called on a child during Remove() when the actor was previously on the Stage.
1522    */
1523   void DisconnectFromStage();
1524
1525   /**
1526    * Helper for DisconnectFromStage, to recursively disconnect a tree of actors.
1527    * This is atomic i.e. not interrupted by user callbacks.
1528    * @param[out] disconnectionList On return, the list of disconnected actors which require notification.
1529    */
1530   void RecursiveDisconnectFromStage( ActorContainer& disconnectionList );
1531
1532   /**
1533    * Disconnect the Node associated with this Actor from the scene-graph.
1534    */
1535   void DisconnectFromSceneGraph();
1536
1537   /**
1538    * Helper for DisconnectFromStage, to notify a disconnected actor through the public API.
1539    */
1540   void NotifyStageDisconnection();
1541
1542   /**
1543    * When the Actor is OnStage, checks whether the corresponding Node is connected to the scene graph.
1544    * @return True if the Actor is OnStage & has a Node connected to the scene graph.
1545    */
1546   bool IsNodeConnected() const;
1547
1548 public:
1549
1550   // Default property extensions from Object
1551
1552   /**
1553    * @copydoc Dali::Internal::Object::GetDefaultPropertyCount()
1554    */
1555   virtual unsigned int GetDefaultPropertyCount() const;
1556
1557   /**
1558    * @copydoc Dali::Internal::Object::GetDefaultPropertyIndices()
1559    */
1560   virtual void GetDefaultPropertyIndices( Property::IndexContainer& indices ) const;
1561
1562   /**
1563    * @copydoc Dali::Internal::Object::GetDefaultPropertyName()
1564    */
1565   virtual const char* GetDefaultPropertyName( Property::Index index ) const;
1566
1567   /**
1568    * @copydoc Dali::Internal::Object::GetDefaultPropertyIndex()
1569    */
1570   virtual Property::Index GetDefaultPropertyIndex( const std::string& name ) const;
1571
1572   /**
1573    * @copydoc Dali::Internal::Object::IsDefaultPropertyWritable()
1574    */
1575   virtual bool IsDefaultPropertyWritable( Property::Index index ) const;
1576
1577   /**
1578    * @copydoc Dali::Internal::Object::IsDefaultPropertyAnimatable()
1579    */
1580   virtual bool IsDefaultPropertyAnimatable( Property::Index index ) const;
1581
1582   /**
1583    * @copydoc Dali::Internal::Object::IsDefaultPropertyAConstraintInput()
1584    */
1585   virtual bool IsDefaultPropertyAConstraintInput( Property::Index index ) const;
1586
1587   /**
1588    * @copydoc Dali::Internal::Object::GetDefaultPropertyType()
1589    */
1590   virtual Property::Type GetDefaultPropertyType( Property::Index index ) const;
1591
1592   /**
1593    * @copydoc Dali::Internal::Object::SetDefaultProperty()
1594    */
1595   virtual void SetDefaultProperty( Property::Index index, const Property::Value& propertyValue );
1596
1597   /**
1598    * @copydoc Dali::Internal::Object::SetSceneGraphProperty()
1599    */
1600   virtual void SetSceneGraphProperty( Property::Index index, const PropertyMetadata& entry, const Property::Value& value );
1601
1602   /**
1603    * @copydoc Dali::Internal::Object::GetDefaultProperty()
1604    */
1605   virtual Property::Value GetDefaultProperty( Property::Index index ) const;
1606
1607   /**
1608    * @copydoc Dali::Internal::Object::GetPropertyOwner()
1609    */
1610   virtual const SceneGraph::PropertyOwner* GetPropertyOwner() const;
1611
1612   /**
1613    * @copydoc Dali::Internal::Object::GetSceneObject()
1614    */
1615   virtual const SceneGraph::PropertyOwner* GetSceneObject() const;
1616
1617   /**
1618    * @copydoc Dali::Internal::Object::GetSceneObjectAnimatableProperty()
1619    */
1620   virtual const SceneGraph::PropertyBase* GetSceneObjectAnimatableProperty( Property::Index index ) const;
1621
1622   /**
1623    * @copydoc Dali::Internal::Object::GetSceneObjectInputProperty()
1624    */
1625   virtual const PropertyInputImpl* GetSceneObjectInputProperty( Property::Index index ) const;
1626
1627   /**
1628    * @copydoc Dali::Internal::Object::GetPropertyComponentIndex()
1629    */
1630   virtual int GetPropertyComponentIndex( Property::Index index ) const;
1631
1632 private:
1633
1634   // Undefined
1635   Actor();
1636
1637   // Undefined
1638   Actor( const Actor& );
1639
1640   // Undefined
1641   Actor& operator=( const Actor& rhs );
1642
1643   /**
1644    * Set the actors parent.
1645    * @param[in] parent The new parent.
1646    */
1647   void SetParent( Actor* parent );
1648
1649   /**
1650    * Helper to create a Node for this Actor.
1651    * To be overriden in derived classes.
1652    * @return A newly allocated node.
1653    */
1654   virtual SceneGraph::Node* CreateNode() const;
1655
1656   /**
1657    * For use in derived classes, called after Initialize()
1658    */
1659   virtual void OnInitialize()
1660   {
1661   }
1662
1663   /**
1664    * For use in internal derived classes.
1665    * This is called during ConnectToStage(), after the actor has finished adding its node to the scene-graph.
1666    * The derived class must not modify the actor hierachy (Add/Remove children) during this callback.
1667    */
1668   virtual void OnStageConnectionInternal()
1669   {
1670   }
1671
1672   /**
1673    * For use in internal derived classes.
1674    * This is called during DisconnectFromStage(), before the actor removes its node from the scene-graph.
1675    * The derived class must not modify the actor hierachy (Add/Remove children) during this callback.
1676    */
1677   virtual void OnStageDisconnectionInternal()
1678   {
1679   }
1680
1681   /**
1682    * For use in external (CustomActor) derived classes.
1683    * This is called after the atomic ConnectToStage() traversal has been completed.
1684    */
1685   virtual void OnStageConnectionExternal( int depth )
1686   {
1687   }
1688
1689   /**
1690    * For use in external (CustomActor) derived classes.
1691    * This is called after the atomic DisconnectFromStage() traversal has been completed.
1692    */
1693   virtual void OnStageDisconnectionExternal()
1694   {
1695   }
1696
1697   /**
1698    * For use in derived classes; this is called after Add() has added a child.
1699    * @param[in] child The child that was added.
1700    */
1701   virtual void OnChildAdd( Actor& child )
1702   {
1703   }
1704
1705   /**
1706    * For use in derived classes; this is called after Remove() has removed a child.
1707    * @param[in] child The child that was removed.
1708    */
1709   virtual void OnChildRemove( Actor& child )
1710   {
1711   }
1712
1713   /**
1714    * For use in derived classes.
1715    * This is called after SizeSet() has been called.
1716    */
1717   virtual void OnSizeSet( const Vector3& targetSize )
1718   {
1719   }
1720
1721   /**
1722    * For use in derived classes.
1723    * This is only called if mDerivedRequiresTouch is true, and the touch-signal was not consumed.
1724    * @param[in] event The touch event.
1725    * @return True if the event should be consumed.
1726    */
1727   virtual bool OnTouchEvent( const TouchEvent& event )
1728   {
1729     return false;
1730   }
1731
1732   /**
1733    * For use in derived classes.
1734    * This is only called if mDerivedRequiresHover is true, and the hover-signal was not consumed.
1735    * @param[in] event The hover event.
1736    * @return True if the event should be consumed.
1737    */
1738   virtual bool OnHoverEvent( const HoverEvent& event )
1739   {
1740     return false;
1741   }
1742
1743   /**
1744    * For use in derived classes.
1745    * This is only called if the wheel signal was not consumed.
1746    * @param[in] event The wheel event.
1747    * @return True if the event should be consumed.
1748    */
1749   virtual bool OnWheelEvent( const WheelEvent& event )
1750   {
1751     return false;
1752   }
1753
1754   /**
1755    * @brief Ensure the relayout data is allocated
1756    */
1757   void EnsureRelayoutData();
1758
1759   /**
1760    * @brief Apply the size set policy to the input size
1761    *
1762    * @param[in] size The size to apply the policy to
1763    * @return Return the adjusted size
1764    */
1765   Vector2 ApplySizeSetPolicy( const Vector2 size );
1766
1767 protected:
1768
1769   Actor* mParent;                 ///< Each actor (except the root) can have one parent
1770   ActorContainer* mChildren;      ///< Container of referenced actors
1771   RendererContainer* mRenderers;   ///< Renderer container
1772
1773   const SceneGraph::Node* mNode;  ///< Not owned
1774   Vector3* mParentOrigin;         ///< NULL means ParentOrigin::DEFAULT. ParentOrigin is non-animatable
1775   Vector3* mAnchorPoint;          ///< NULL means AnchorPoint::DEFAULT. AnchorPoint is non-animatable
1776
1777   struct RelayoutData;
1778   RelayoutData* mRelayoutData; ///< Struct to hold optional collection of relayout variables
1779
1780   ActorGestureData* mGestureData;   ///< Optional Gesture data. Only created when actor requires gestures
1781
1782   ActorAttachmentPtr mAttachment;   ///< Optional referenced attachment
1783
1784   // Signals
1785   Dali::Actor::TouchSignalType             mTouchedSignal;
1786   Dali::Actor::HoverSignalType             mHoveredSignal;
1787   Dali::Actor::WheelEventSignalType        mWheelEventSignal;
1788   Dali::Actor::OnStageSignalType           mOnStageSignal;
1789   Dali::Actor::OffStageSignalType          mOffStageSignal;
1790   Dali::Actor::OnRelayoutSignalType        mOnRelayoutSignal;
1791
1792   Vector3         mTargetSize;       ///< Event-side storage for size (not a pointer as most actors will have a size)
1793   Vector3         mTargetPosition;   ///< Event-side storage for position (not a pointer as most actors will have a position)
1794
1795   std::string     mName;      ///< Name of the actor
1796   unsigned int    mId;        ///< A unique ID to identify the actor starting from 1, and 0 is reserved
1797
1798   unsigned short mDepth                            :12; ///< Cached: The depth in the hierarchy of the actor. Only 4096 levels of depth are supported
1799   const bool mIsRoot                               : 1; ///< Flag to identify the root actor
1800   const bool mIsRenderable                         : 1; ///< Flag to identify that this is a renderable actor
1801   const bool mIsLayer                              : 1; ///< Flag to identify that this is a layer
1802   bool mIsOnStage                                  : 1; ///< Flag to identify whether the actor is on-stage
1803   bool mSensitive                                  : 1; ///< Whether the actor emits touch event signals
1804   bool mLeaveRequired                              : 1; ///< Whether a touch event signal is emitted when the a touch leaves the actor's bounds
1805   bool mKeyboardFocusable                          : 1; ///< Whether the actor should be focusable by keyboard navigation
1806   bool mDerivedRequiresTouch                       : 1; ///< Whether the derived actor type requires touch event signals
1807   bool mDerivedRequiresHover                       : 1; ///< Whether the derived actor type requires hover event signals
1808   bool mDerivedRequiresWheelEvent                  : 1; ///< Whether the derived actor type requires wheel event signals
1809   bool mOnStageSignalled                           : 1; ///< Set to true before OnStageConnection signal is emitted, and false before OnStageDisconnection
1810   bool mInsideOnSizeSet                            : 1; ///< Whether we are inside OnSizeSet
1811   bool mInheritOrientation                         : 1; ///< Cached: Whether the parent's orientation should be inherited.
1812   bool mInheritScale                               : 1; ///< Cached: Whether the parent's scale should be inherited.
1813   DrawMode::Type mDrawMode                         : 2; ///< Cached: How the actor and its children should be drawn
1814   PositionInheritanceMode mPositionInheritanceMode : 2; ///< Cached: Determines how position is inherited
1815   ColorMode mColorMode                             : 2; ///< Cached: Determines whether mWorldColor is inherited
1816
1817 private:
1818
1819   static ActorContainer mNullChildren;  ///< Empty container (shared by all actors, returned by GetChildren() const)
1820   static unsigned int mActorCounter;    ///< A counter to track the actor instance creation
1821
1822 };
1823
1824 } // namespace Internal
1825
1826 // Helpers for public-api forwarding methods
1827
1828 inline Internal::Actor& GetImplementation( Dali::Actor& actor )
1829 {
1830   DALI_ASSERT_ALWAYS( actor && "Actor handle is empty" );
1831
1832   BaseObject& handle = actor.GetBaseObject();
1833
1834   return static_cast< Internal::Actor& >( handle );
1835 }
1836
1837 inline const Internal::Actor& GetImplementation( const Dali::Actor& actor )
1838 {
1839   DALI_ASSERT_ALWAYS( actor && "Actor handle is empty" );
1840
1841   const BaseObject& handle = actor.GetBaseObject();
1842
1843   return static_cast< const Internal::Actor& >( handle );
1844 }
1845
1846 } // namespace Dali
1847
1848 #endif // __DALI_INTERNAL_ACTOR_H__