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/common/vector-wrapper.h>
  26 #include <dali/public-api/object/ref-object.h>
  27 #include <dali/public-api/actors/actor.h>
  28 #include <dali/public-api/common/dali-common.h>
  29 #include <dali/public-api/events/gesture.h>
  30 #include <dali/public-api/math/viewport.h>
  31 #include <dali/internal/event/common/proxy-object.h>
  32 #include <dali/internal/event/common/stage-def.h>
  33 #include <dali/internal/event/actors/actor-declarations.h>
  34 #include <dali/internal/event/actor-attachments/actor-attachment-declarations.h>
  35 #include <dali/internal/update/nodes/node-declarations.h>
  36
  37 #ifdef DYNAMICS_SUPPORT
  38 #include <dali/internal/event/dynamics/dynamics-declarations.h>
  39 #endif
  40
  41 namespace Dali
  42 {
  43
  44 struct KeyEvent;
  45 struct TouchEvent;
  46 struct HoverEvent;
  47 struct MouseWheelEvent;
  48
  49 namespace Internal
  50 {
  51
  52 class Actor;
  53 class ActorGestureData;
  54 class Animation;
  55 class RenderTask;
  56 struct DynamicsData;
  57
  58 typedef IntrusivePtr<Actor>                   ActorPtr;
  59 typedef Dali::ActorContainer                  ActorContainer; // Store handles to return via public-api
  60 typedef ActorContainer::iterator              ActorIter;
  61 typedef ActorContainer::const_iterator        ActorConstIter;
  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 ProxyObject
  74 {
  75 public:
  76
  77   /**
  78    * Create a new actor.
  79    * @return A smart-pointer to the newly allocated Actor.
  80    */
  81   static ActorPtr New();
  82
  83   /**
  84    * Retrieve the name of the actor.
  85    * @return The name.
  86    */
  87   const std::string& GetName() const;
  88
  89   /**
  90    * Set the name of the actor.
  91    * @param[in] name The new name.
  92    */
  93   void SetName(const std::string& name);
  94
  95   /**
  96    * @copydoc Dali::Actor::GetId
  97    */
  98   unsigned int GetId() const;
  99
 100   // Attachments
 101
 102   /**
 103    * Attach an object to an actor.
 104    * @pre The actor does not already have an attachment.
 105    * @param[in] attachment The object to attach.
 106    */
 107   void Attach(ActorAttachment& attachment);
 108
 109   /**
 110    * Retreive the object attached to an actor.
 111    * @return The attachment.
 112    */
 113   ActorAttachmentPtr GetAttachment();
 114
 115   // Containment
 116
 117   /**
 118    * Query whether an actor is the root actor, which is owned by the Stage.
 119    * @return True if the actor is a root actor.
 120    */
 121   bool IsRoot() const
 122   {
 123     return mIsRoot;
 124   }
 125
 126   /**
 127    * Query whether the actor is connected to the Stage.
 128    */
 129   bool OnStage() const;
 130
 131   /**
 132    * Query whether the actor is a RenderableActor derived type.
 133    * @return True if the actor is renderable.
 134    */
 135   bool IsRenderable() const
 136   {
 137     // inlined as this is called a lot in hit testing
 138     return mIsRenderable;
 139   }
 140
 141   /**
 142    * Query whether the actor is of class Dali::Layer
 143    * @return True if the actor is a layer.
 144    */
 145   bool IsLayer() const
 146   {
 147     // inlined as this is called a lot in hit testing
 148     return mIsLayer;
 149   }
 150
 151   /**
 152    * Gets the layer in which the actor is present
 153    * @return The layer, which will be uninitialized if the actor is off-stage.
 154    */
 155   Dali::Layer GetLayer();
 156
 157   /**
 158    * Adds a child Actor to this Actor.
 159    * @pre The child actor is not the same as the parent actor.
 160    * @pre The child actor does not already have a parent.
 161    * @param [in] child The child.
 162    * @post The child will be referenced by its parent.
 163    */
 164   void Add(Actor& child);
 165
 166   /**
 167    * Inserts a child Actor to this Actor's child list
 168    * @pre The child actor is not the same as the parent actor.
 169    * @pre The child actor does not already have a parent.
 170    * @param [in] index in childlist to insert child at
 171    * @param [in] child The child.
 172    * @post The child will be referenced by its parent.
 173    */
 174   void Insert(unsigned int index, Actor& child);
 175
 176   /**
 177    * Removes a child Actor from this Actor.
 178    * @param [in] child The child.
 179    * @post The child will be unreferenced.
 180    */
 181   void Remove(Actor& child);
 182
 183   /**
 184    * @copydoc Dali::Actor::Unparent
 185    */
 186   void Unparent();
 187
 188   /**
 189    * Retrieve the number of children held by the actor.
 190    * @return The number of children
 191    */
 192   unsigned int GetChildCount() const;
 193
 194   /**
 195    * @copydoc Dali::Actor::GetChildAt
 196    */
 197   Dali::Actor GetChildAt(unsigned int index) const;
 198
 199   /**
 200    * Retrieve the Actor's children.
 201    * @return A copy of the container of children.
 202    */
 203   ActorContainer GetChildren();
 204
 205   /**
 206    * Retrieve the Actor's children.
 207    * @return A const reference to the container of children.
 208    */
 209   const ActorContainer& GetChildren() const;
 210
 211   /**
 212    * Retrieve a reference to Actor's children.
 213    * @note Not for public use.
 214    * @return A reference to the container of children.
 215    */
 216   ActorContainer& GetChildrenInternal()
 217   {
 218     return *mChildren;
 219   }
 220
 221   /**
 222    * @copydoc Dali::Actor::FindChildByName
 223    */
 224   ActorPtr FindChildByName(const std::string& actorName);
 225
 226   /**
 227    * @copydoc Dali::Actor::FindChildByAlias
 228    */
 229   Dali::Actor FindChildByAlias(const std::string& actorAlias);
 230
 231   /**
 232    * @copydoc Dali::Actor::FindChildById
 233    */
 234   ActorPtr FindChildById(const unsigned int id);
 235
 236   /**
 237    * Retrieve the parent of an Actor.
 238    * @return The parent actor, or NULL if the Actor does not have a parent.
 239    */
 240   Actor* GetParent() const
 241   {
 242     return mParent;
 243   }
 244
 245   /**
 246    * Sets the size of an actor.
 247    * ActorAttachments attached to the actor, can be scaled to fit within this area.
 248    * This does not interfere with the actors scale factor.
 249    * @param [in] width  The new width.
 250    * @param [in] height The new height.
 251    */
 252   void SetSize(float width, float height);
 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 size of the actor along the x-axis.
 259    * @param [in] height The size of the actor along the y-axis.
 260    * @param [in] depth The size of the actor along the z-axis.
 261    */
 262   void SetSize(float width, float height, float depth);
 263
 264   /**
 265    * Sets the size of an actor.
 266    * ActorAttachments attached to the actor, can be scaled to fit within this area.
 267    * This does not interfere with the actors scale factor.
 268    * @param [in] size The new size.
 269    */
 270   void SetSize(const Vector2& size);
 271
 272   /**
 273    * Sets the size of an actor.
 274    * ActorAttachments attached to the actor, can be scaled to fit within this area.
 275    * This does not interfere with the actors scale factor.
 276    * @param [in] size The new size.
 277    */
 278   void SetSize(const Vector3& size);
 279
 280   /**
 281    * Set the width component of the Actor's size.
 282    * @param [in] width The new width component.
 283    */
 284   void SetWidth( float width );
 285
 286   /**
 287    * Set the height component of the Actor's size.
 288    * @param [in] height The new height component.
 289    */
 290   void SetHeight( float height );
 291
 292   /**
 293    * Set the depth component of the Actor's size.
 294    * @param [in] depth The new depth component.
 295    */
 296   void SetDepth( float depth );
 297
 298   /**
 299    * Retrieve the Actor's size from event side.
 300    * This size will be the size set or if animating then the target size.
 301    * @return The Actor's size.
 302    */
 303   const Vector3& GetSize() const;
 304
 305   /**
 306    * Retrieve the Actor's size from update side.
 307    * This size will be the size set or animating but will be a frame behind.
 308    * @return The Actor's size.
 309    */
 310   const Vector3& GetCurrentSize() const;
 311
 312   /**
 313    * Return the natural size of the actor
 314    *
 315    * @return The actor's natural size
 316    */
 317   virtual Vector3 GetNaturalSize() const;
 318
 319   /**
 320    * Set the origin of an actor, within its parent's area.
 321    * This is expressed in 2D unit coordinates, such that (0.0, 0.0, 0.5) is the top-left corner of the parent,
 322    * and (1.0, 1.0, 0.5) is the bottom-right corner.
 323    * The default parent-origin is top-left (0.0, 0.0, 0.5).
 324    * An actor position is the distance between this origin, and the actors anchor-point.
 325    * @param [in] origin The new parent-origin.
 326    */
 327   void SetParentOrigin(const Vector3& origin);
 328
 329   /**
 330    * Set the x component of the parent-origin
 331    * @param [in] x The new x value.
 332    */
 333   void SetParentOriginX( float x );
 334
 335   /**
 336    * Set the y component of the parent-origin
 337    * @param [in] y The new y value.
 338    */
 339   void SetParentOriginY( float y );
 340
 341   /**
 342    * Set the z component of the parent-origin
 343    * @param [in] z The new z value.
 344    */
 345   void SetParentOriginZ( float z );
 346
 347   /**
 348    * Retrieve the parent-origin of an actor.
 349    * @return The parent-origin.
 350    */
 351   const Vector3& GetCurrentParentOrigin() const;
 352
 353   /**
 354    * Set the anchor-point of an actor. This is expressed in 2D unit coordinates, such that
 355    * (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.
 356    * The default anchor point is top-left (0.0, 0.0, 0.5).
 357    * An actor position is the distance between its parent-origin, and this anchor-point.
 358    * An actor's rotation is centered around its anchor-point.
 359    * @param [in] anchorPoint The new anchor-point.
 360    */
 361   void SetAnchorPoint(const Vector3& anchorPoint);
 362
 363   /**
 364    * Set the x component of the anchor-point.
 365    * @param [in] x The new x value.
 366    */
 367   void SetAnchorPointX( float x );
 368
 369   /**
 370    * Set the y component of the anchor-point.
 371    * @param [in] y The new y value.
 372    */
 373   void SetAnchorPointY( float y );
 374
 375   /**
 376    * Set the z component of the anchor-point.
 377    * @param [in] z The new z value.
 378    */
 379   void SetAnchorPointZ( float z );
 380
 381   /**
 382    * Retrieve the anchor-point of an actor.
 383    * @return The anchor-point.
 384    */
 385   const Vector3& GetCurrentAnchorPoint() const;
 386
 387   /**
 388    * Sets the position of the Actor.
 389    * The coordinates are relative to the Actor's parent.
 390    * The Actor's z position will be set to 0.0f.
 391    * @param [in] x The new x position
 392    * @param [in] y The new y position
 393    */
 394   void SetPosition(float x, float y);
 395
 396   /**
 397    * Sets the position of the Actor.
 398    * The coordinates are relative to the Actor's parent.
 399    * @param [in] x The new x position
 400    * @param [in] y The new y position
 401    * @param [in] z The new z position
 402    */
 403   void SetPosition(float x, float y, float z);
 404
 405   /**
 406    * Sets the position of the Actor.
 407    * The coordinates are relative to the Actor's parent.
 408    * @param [in] position The new position.
 409    */
 410   void SetPosition(const Vector3& position);
 411
 412   /**
 413    * Set the position of an actor along the X-axis.
 414    * @param [in] x The new x position
 415    */
 416   void SetX(float x);
 417
 418   /**
 419    * Set the position of an actor along the Y-axis.
 420    * @param [in] y The new y position.
 421    */
 422   void SetY(float y);
 423
 424   /**
 425    * Set the position of an actor along the Z-axis.
 426    * @param [in] z The new z position
 427    */
 428   void SetZ(float z);
 429
 430   /**
 431    * Move an actor relative to its existing position.
 432    * @param[in] distance The actor will move by this distance.
 433    */
 434   void MoveBy(const Vector3& distance);
 435
 436   /**
 437    * Retrieve the position of the Actor.
 438    * The coordinates are relative to the Actor's parent.
 439    * @return the Actor's position.
 440    */
 441   const Vector3& GetCurrentPosition() const;
 442
 443   /**
 444    * @copydoc Dali::Actor::GetCurrentWorldPosition()
 445    */
 446   const Vector3& GetCurrentWorldPosition() const;
 447
 448   /**
 449    * @copydoc Dali::Actor::SetPositionInheritanceMode()
 450    */
 451   void SetPositionInheritanceMode( PositionInheritanceMode mode );
 452
 453   /**
 454    * @copydoc Dali::Actor::GetPositionInheritanceMode()
 455    */
 456   PositionInheritanceMode GetPositionInheritanceMode() const;
 457
 458   /**
 459    * Sets the rotation of the Actor.
 460    * @param [in] angleRadians The new rotation angle in radians.
 461    * @param [in] axis The new axis of rotation.
 462    */
 463   void SetRotation(const Radian& angleRadians, const Vector3& axis);
 464
 465   /**
 466    * Sets the rotation of the Actor.
 467    * @param [in] rotation The new rotation.
 468    */
 469   void SetRotation(const Quaternion& rotation);
 470
 471   /**
 472    * Rotate an actor around its existing rotation axis.
 473    * @param[in] angleRadians The angle to the rotation to combine with the existing rotation.
 474    * @param[in] axis The axis of the rotation to combine with the existing rotation.
 475    */
 476   void RotateBy(const Radian& angleRadians, const Vector3& axis);
 477
 478   /**
 479    * Apply a relative rotation to an actor.
 480    * @param[in] relativeRotation The rotation to combine with the actors existing rotation.
 481    */
 482   void RotateBy(const Quaternion& relativeRotation);
 483
 484   /**
 485    * Retreive the Actor's rotation.
 486    * @return the rotation.
 487    */
 488   const Quaternion& GetCurrentRotation() const;
 489
 490   /**
 491    * Set whether a child actor inherits it's parent's orientation. Default is to inherit.
 492    * Switching this off means that using SetRotation() sets the actor's world orientation.
 493    * @param[in] inherit - true if the actor should inherit orientation, false otherwise.
 494    */
 495   void SetInheritRotation(bool inherit);
 496
 497   /**
 498    * Returns whether the actor inherit's it's parent's orientation.
 499    * @return true if the actor inherit's it's parent orientation, false if it uses world orientation.
 500    */
 501   bool IsRotationInherited() const;
 502
 503   /**
 504    * @copydoc Dali::Actor::GetCurrentWorldRotation()
 505    */
 506   const Quaternion& GetCurrentWorldRotation() const;
 507
 508   /**
 509    * Sets a scale factor applied to an actor.
 510    * @param [in] scale The scale factor applied on all axes.
 511    */
 512   void SetScale(float scale);
 513
 514   /**
 515    * Sets a scale factor applied to an actor.
 516    * @param [in] scaleX The scale factor applied along the x-axis.
 517    * @param [in] scaleY The scale factor applied along the y-axis.
 518    * @param [in] scaleZ The scale factor applied along the z-axis.
 519    */
 520   void SetScale(float scaleX, float scaleY, float scaleZ);
 521
 522   /**
 523    * Sets a scale factor applied to an actor.
 524    * @param [in] scale A vector representing the scale factor for each axis.
 525    */
 526   void SetScale(const Vector3& scale);
 527
 528   /**
 529    * Set the x component of the scale factor.
 530    * @param [in] x The new x value.
 531    */
 532   void SetScaleX( float x );
 533
 534   /**
 535    * Set the y component of the scale factor.
 536    * @param [in] y The new y value.
 537    */
 538   void SetScaleY( float y );
 539
 540   /**
 541    * Set the z component of the scale factor.
 542    * @param [in] z The new z value.
 543    */
 544   void SetScaleZ( float z );
 545
 546   /**
 547    * Apply a relative scale to an actor.
 548    * @param[in] relativeScale The scale to combine with the actors existing scale.
 549    */
 550   void ScaleBy(const Vector3& relativeScale);
 551
 552   /**
 553    * Retrieve the scale factor applied to an actor.
 554    * @return A vector representing the scale factor for each axis.
 555    */
 556   const Vector3& GetCurrentScale() const;
 557
 558   /**
 559    * @copydoc Dali::Actor::GetCurrentWorldScale()
 560    */
 561   const Vector3& GetCurrentWorldScale() const;
 562
 563   /**
 564    * @copydoc Dali::Actor::SetInheritScale()
 565    */
 566   void SetInheritScale( bool inherit );
 567
 568   /**
 569    * @copydoc Dali::Actor::IsScaleInherited()
 570    */
 571   bool IsScaleInherited() const;
 572
 573   /**
 574    * @copydoc Dali::Actor::GetCurrentWorldMatrix()
 575    */
 576   Matrix GetCurrentWorldMatrix() const;
 577
 578   // Visibility
 579
 580   /**
 581    * Sets the visibility flag of an actor.
 582    * @param [in] visible The new visibility flag.
 583    */
 584   void SetVisible(bool visible);
 585
 586   /**
 587    * Retrieve the visibility flag of an actor.
 588    * @return The visibility flag.
 589    */
 590   bool IsVisible() const;
 591
 592   /**
 593    * Sets the opacity of an actor.
 594    * @param [in] opacity The new opacity.
 595    */
 596   void SetOpacity(float opacity);
 597
 598   /**
 599    * Apply a relative opacity change to an actor.
 600    * @param[in] relativeOpacity The opacity to combine with the actors existing opacity.
 601    */
 602   void OpacityBy(float relativeOpacity);
 603
 604   /**
 605    * Retrieve the actor's opacity.
 606    * @return The actor's opacity.
 607    */
 608   float GetCurrentOpacity() const;
 609
 610   /**
 611    * Sets whether an actor should emit touch or hover signals; see SignalTouch() and SignalHover().
 612    * An actor is sensitive by default, which means that as soon as an application connects to the SignalTouch(),
 613    * the touch event signal will be emitted, and as soon as an application connects to the SignalHover(), the
 614    * hover event signal will be emitted.
 615    *
 616    * If the application wishes to temporarily disable the touch or hover event signal emission, then they can do so by calling:
 617    * @code
 618    * actor.SetSensitive(false);
 619    * @endcode
 620    *
 621    * Then, to re-enable the touch or hover event signal emission, the application should call:
 622    * @code
 623    * actor.SetSensitive(true);
 624    * @endcode
 625    *
 626    * @see SignalTouch() and SignalHover().
 627    * @note If an actor's sensitivity is set to false, then it's children will not emit a touch or hover event signal either.
 628    * @param[in]  sensitive  true to enable emission of the touch or hover event signals, false otherwise.
 629    */
 630   void SetSensitive(bool sensitive)
 631   {
 632     mSensitive = sensitive;
 633   }
 634
 635   /**
 636    * Query whether an actor emits touch or hover event signals.
 637    * @see SetSensitive(bool)
 638    * @return true, if emission of touch or hover event signals is enabled, false otherwise.
 639    */
 640   bool IsSensitive() const
 641   {
 642     return mSensitive;
 643   }
 644
 645   /**
 646    * @copydoc Dali::Actor::SetDrawMode
 647    */
 648   void SetDrawMode( DrawMode::Type drawMode );
 649
 650   /**
 651    * @copydoc Dali::Actor::GetDrawMode
 652    */
 653   DrawMode::Type GetDrawMode() const;
 654
 655   /**
 656    * @copydoc Dali::Actor::SetOverlay
 657    */
 658   void SetOverlay(bool enable);
 659
 660   /**
 661    * @copydoc Dali::Actor::IsOverlay
 662    */
 663   bool IsOverlay() const;
 664
 665   /**
 666    * Sets whether an actor transmits geometry scaling to it's children.
 667    * The default value is for it not to transmit scaling.
 668    * @param[in] transmitGeometryScaling True to transmit scaling.
 669    */
 670   void SetTransmitGeometryScaling(bool transmitGeometryScaling);
 671
 672   /**
 673    * Get the TransmitGeometryScaling property for this actor.
 674    * @return True if geometry scaling is applied to the inherited scale.
 675    */
 676   bool GetTransmitGeometryScaling() const;
 677
 678   /**
 679    * Sets the initial volume of the actor. Used for scaling the
 680    * actor appropriately as the actor is sized when transmitGeometryScaling
 681    * is set to true.
 682    *
 683    * @param[in] volume the volume of the model and it's children
 684    */
 685   void SetInitialVolume(const Vector3& volume);
 686
 687   /**
 688    * Sets the actor's color.  The final color of actor depends on its color mode.
 689    * This final color is applied to the drawable elements of an actor.
 690    * @param [in] color The new color.
 691    */
 692   void SetColor(const Vector4& color);
 693
 694   /**
 695    * Set the red component of the color.
 696    * @param [in] red The new red component.
 697    */
 698   void SetColorRed( float red );
 699
 700   /**
 701    * Set the green component of the color.
 702    * @param [in] green The new green component.
 703    */
 704   void SetColorGreen( float green );
 705
 706   /**
 707    * Set the blue component of the scale factor.
 708    * @param [in] blue The new blue value.
 709    */
 710   void SetColorBlue( float blue );
 711
 712   /**
 713    * Apply a relative color change to an actor.
 714    * @param[in] relativeColor The color to combine with the actors existing color.
 715    */
 716   void ColorBy(const Vector4& relativeColor);
 717
 718   /**
 719    * Retrieve the actor's color.
 720    * @return The color.
 721    */
 722   const Vector4& GetCurrentColor() const;
 723
 724   /**
 725    * Sets the actor's color mode.
 726    * Color mode specifies whether Actor uses its own color or inherits its parent color
 727    * @param [in] colorMode to use.
 728    */
 729   void SetColorMode(ColorMode colorMode);
 730
 731   /**
 732    * Returns the actor's color mode.
 733    * @return currently used colorMode.
 734    */
 735   ColorMode GetColorMode() const;
 736
 737   /**
 738    * @copydoc Dali::Actor::GetCurrentWorldColor()
 739    */
 740   const Vector4& GetCurrentWorldColor() const;
 741
 742 #ifdef DYNAMICS_SUPPORT
 743
 744   // Dynamics
 745
 746   /// @copydoc Dali::Actor::DisableDynamics
 747   void DisableDynamics();
 748
 749   /// @copydoc Dali::Actor::EnableDynamics(Dali::DynamicsBodyConfig)
 750   DynamicsBodyPtr  EnableDynamics(DynamicsBodyConfigPtr bodyConfig);
 751
 752   /// @copydoc Dali::Actor::GetDynamicsBody
 753   DynamicsBodyPtr GetDynamicsBody() const;
 754
 755   /// @copydoc Dali::Actor::AddDynamicsJoint(Dali::Actor,const Vector3&)
 756   DynamicsJointPtr AddDynamicsJoint( ActorPtr attachedActor, const Vector3& offset );
 757
 758   /// @copydoc Dali::Actor::AddDynamicsJoint(Dali::Actor,const Vector3&,const Vector3&)
 759   DynamicsJointPtr AddDynamicsJoint( ActorPtr attachedActor, const Vector3& offsetA, const Vector3& offsetB );
 760
 761   /// @copydoc Dali::Actor::GetNumberOfJoints
 762   const int GetNumberOfJoints() const;
 763
 764   /// @copydoc Dali::Actor::GetDynamicsJointByIndex
 765   DynamicsJointPtr GetDynamicsJointByIndex( const int index ) const;
 766
 767   /// @copydoc Dali::Actor::GetDynamicsJoint
 768   DynamicsJointPtr GetDynamicsJoint( ActorPtr attachedActor ) const;
 769
 770   /// @copydoc Dali::Actor::RemoveDynamicsJoint
 771   void RemoveDynamicsJoint( DynamicsJointPtr joint );
 772
 773   /**
 774    * Hold a reference to a DynamicsJoint
 775    * @param[in] joint The joint
 776    */
 777   void ReferenceJoint( DynamicsJointPtr joint );
 778
 779   /**
 780    * Release a reference to a DynamicsJoint
 781    * @param[in] joint The joint
 782    */
 783   void ReleaseJoint( DynamicsJointPtr joint );
 784
 785   /**
 786    * Set this actor to be the root actor in the dynamics simulation
 787    * All children of the actor are added/removed from the simulation.
 788    * @param[in] flag  When true sets this actor to be the simulation world root actor and
 789    *                  if OnStage() all dynamics enabled child actors are added to the simulation,
 790    *                  when false stops this actor being the simulation root and if OnStage() all
 791    *                  dynamics enabled child actors are removed from the simulation.
 792    */
 793   void SetDynamicsRoot(bool flag);
 794
 795 private:
 796   /**
 797    * Check if this actor is the root actor in the dynamics simulation
 798    * @return true if this is the dynamics root actor.
 799    */
 800   bool IsDynamicsRoot() const;
 801
 802   /**
 803    * Add actor to the dynamics simulation
 804    * Invoked when the actor is staged, or it's parent becomes the simulation root
 805    */
 806   void ConnectDynamics();
 807
 808   /**
 809    * Remove actor from the dynamics simulation
 810    * Invoked when the actor is unstaged, or it's parent stops being the the simulation root
 811    */
 812   void DisconnectDynamics();
 813
 814   /**
 815    * An actor in a DynamicsJoint relationship has been staged
 816    * @param[in] actor The actor passed into AddDynamicsJoint()
 817    */
 818   void AttachedActorOnStage( Dali::Actor actor );
 819
 820   /**
 821    * An actor in a DynamicsJoint relationship has been unstaged
 822    * @param[in] actor The actor passed into AddDynamicsJoint()
 823    */
 824   void AttachedActorOffStage( Dali::Actor actor );
 825
 826 #endif // DYNAMICS_SUPPORT
 827
 828 public:
 829   /**
 830    * Converts screen coordinates into the actor's coordinate system.
 831    * @note The actor coordinates are relative to the top-left (0.0, 0.0, 0.5)
 832    * @param[out] localX On return, the X-coordinate relative to the actor.
 833    * @param[out] localY On return, the Y-coordinate relative to the actor.
 834    * @param[in] screenX The screen X-coordinate.
 835    * @param[in] screenY The screen Y-coordinate.
 836    * @return True if the conversion succeeded.
 837    */
 838   bool ScreenToLocal(float& localX, float& localY, float screenX, float screenY) const;
 839
 840   /**
 841    * Converts screen coordinates into the actor's coordinate system.
 842    * @note The actor coordinates are relative to the top-left (0.0, 0.0, 0.5)
 843    * @param[in] renderTask The render-task used to display the actor.
 844    * @param[out] localX On return, the X-coordinate relative to the actor.
 845    * @param[out] localY On return, the Y-coordinate relative to the actor.
 846    * @param[in] screenX The screen X-coordinate.
 847    * @param[in] screenY The screen Y-coordinate.
 848    * @return True if the conversion succeeded.
 849    */
 850   bool ScreenToLocal(RenderTask& renderTask, float& localX, float& localY, float screenX, float screenY) const;
 851
 852   /**
 853    * Converts from the actor's coordinate system to screen coordinates.
 854    * @note The actor coordinates are relative to the top-left (0.0, 0.0, 0.5)
 855    * @param[in] viewMatrix The view-matrix
 856    * @param[in] projectionMatrix The projection-matrix
 857    * @param[in] viewport The view-port
 858    * @param[out] localX On return, the X-coordinate relative to the actor.
 859    * @param[out] localY On return, the Y-coordinate relative to the actor.
 860    * @param[in] screenX The screen X-coordinate.
 861    * @param[in] screenY The screen Y-coordinate.
 862    * @return True if the conversion succeeded.
 863    */
 864   bool ScreenToLocal( const Matrix& viewMatrix,
 865                       const Matrix& projectionMatrix,
 866                       const Viewport& viewport,
 867                       float& localX,
 868                       float& localY,
 869                       float screenX,
 870                       float screenY ) const;
 871
 872   /**
 873    * Performs a ray-sphere test with the given pick-ray and the actor's bounding sphere.
 874    * @note The actor coordinates are relative to the top-left (0.0, 0.0, 0.5)
 875    * @param[in] rayOrigin The ray origin in the world's reference system.
 876    * @param[in] rayDir The ray director vector in the world's reference system.
 877    * @return True if the ray intersects the actor's bounding sphere.
 878    */
 879   bool RaySphereTest( const Vector4& rayOrigin, const Vector4& rayDir ) const;
 880
 881   /**
 882    * Performs a ray-actor test with the given pick-ray and the actor's geometry.
 883    * @note The actor coordinates are relative to the top-left (0.0, 0.0, 0.5)
 884    * @param[in] rayOrigin The ray origin in the world's reference system.
 885    * @param[in] rayDir The ray director vector in the world's reference system.
 886    * @param[out] hitPointLocal The hit point in the Actor's local reference system.
 887    * @param[out] distance The distance from the hit point to the camera.
 888    * @return True if the ray intersects the actor's geometry.
 889    */
 890   bool RayActorTest( const Vector4& rayOrigin, const Vector4& rayDir, Vector4& hitPointLocal, float& distance ) const;
 891
 892   /**
 893    * Sets whether the actor should receive a notification when touch or hover motion events leave
 894    * the boundary of the actor.
 895    *
 896    * @note By default, this is set to false as most actors do not require this.
 897    * @note Need to connect to the SignalTouch or SignalHover to actually receive this event.
 898    *
 899    * @param[in]  required  Should be set to true if a Leave event is required
 900    */
 901   void SetLeaveRequired(bool required);
 902
 903   /**
 904    * This returns whether the actor requires touch or hover events whenever touch or hover motion events leave
 905    * the boundary of the actor.
 906    * @return true if a Leave event is required, false otherwise.
 907    */
 908   bool GetLeaveRequired() const;
 909
 910   /**
 911    * @copydoc Dali::Actor::SetKeyboardFocusable()
 912    */
 913   void SetKeyboardFocusable( bool focusable );
 914
 915   /**
 916    * @copydoc Dali::Actor::IsKeyboardFocusable()
 917    */
 918   bool IsKeyboardFocusable() const;
 919
 920   /**
 921    * Query whether the application or derived actor type requires touch events.
 922    * @return True if touch events are required.
 923    */
 924   bool GetTouchRequired() const;
 925
 926   /**
 927    * Query whether the application or derived actor type requires hover events.
 928    * @return True if hover events are required.
 929    */
 930   bool GetHoverRequired() const;
 931
 932   /**
 933    * Query whether the application or derived actor type requires mouse wheel events.
 934    * @return True if mouse wheel events are required.
 935    */
 936   bool GetMouseWheelEventRequired() const;
 937
 938   /**
 939    * Query whether the actor is actually hittable.  This method checks whether the actor is
 940    * sensitive, has the visibility flag set to true and is not fully transparent.
 941    * @return true, if it can be hit, false otherwise.
 942    */
 943   bool IsHittable() const;
 944
 945   // Gestures
 946
 947   /**
 948    * Retrieve the gesture data associated with this actor. The first call to this method will
 949    * allocate space for the ActorGestureData so this should only be called if an actor really does
 950    * require gestures.
 951    * @return Reference to the ActorGestureData for this actor.
 952    * @note Once the gesture-data is created for an actor it is likely that gestures are required
 953    * throughout the actor's lifetime so it will only be deleted when the actor is destroyed.
 954    */
 955   ActorGestureData& GetGestureData();
 956
 957   /**
 958    * Queries whether the actor requires the gesture type.
 959    * @param[in] type The gesture type.
 960    */
 961   bool IsGestureRequred( Gesture::Type type ) const;
 962
 963   // Signals
 964
 965   /**
 966    * Used by the EventProcessor to emit touch event signals.
 967    * @param[in] event The touch event.
 968    * @return True if the event was consumed.
 969    */
 970   bool EmitTouchEventSignal(const TouchEvent& event);
 971
 972   /**
 973    * Used by the EventProcessor to emit hover event signals.
 974    * @param[in] event The hover event.
 975    * @return True if the event was consumed.
 976    */
 977   bool EmitHoverEventSignal(const HoverEvent& event);
 978
 979   /**
 980    * Used by the EventProcessor to emit mouse wheel event signals.
 981    * @param[in] event The mouse wheel event.
 982    * @return True if the event was consumed.
 983    */
 984   bool EmitMouseWheelEventSignal(const MouseWheelEvent& event);
 985
 986   /**
 987    * @copydoc Dali::Actor::TouchedSignal()
 988    */
 989   Dali::Actor::TouchSignalV2& TouchedSignal();
 990
 991   /**
 992    * @copydoc Dali::Actor::HoveredSignal()
 993    */
 994   Dali::Actor::HoverSignalV2& HoveredSignal();
 995
 996   /**
 997    * @copydoc Dali::Actor::MouseWheelEventSignal()
 998    */
 999   Dali::Actor::MouseWheelEventSignalV2& MouseWheelEventSignal();
1000
1001   /**
1002    * @copydoc Dali::Actor::SetSizeSignal()
1003    */
1004   Dali::Actor::SetSizeSignalV2& SetSizeSignal();
1005
1006   /**
1007    * @copydoc Dali::Actor::OnStageSignal()
1008    */
1009   Dali::Actor::OnStageSignalV2& OnStageSignal();
1010
1011   /**
1012    * @copydoc Dali::Actor::OffStageSignal()
1013    */
1014   Dali::Actor::OffStageSignalV2& OffStageSignal();
1015
1016   /**
1017    * Connects a callback function with the object's signals.
1018    * @param[in] object The object providing the signal.
1019    * @param[in] tracker Used to disconnect the signal.
1020    * @param[in] signalName The signal to connect to.
1021    * @param[in] functor A newly allocated FunctorDelegate.
1022    * @return True if the signal was connected.
1023    * @post If a signal was connected, ownership of functor was passed to CallbackBase. Otherwise the caller is responsible for deleting the unused functor.
1024    */
1025   static bool DoConnectSignal( BaseObject* object, ConnectionTrackerInterface* tracker, const std::string& signalName, FunctorDelegate* functor );
1026
1027   /**
1028    * Performs actions as requested using the action name.
1029    * @param[in] object The object on which to perform the action.
1030    * @param[in] actionName The action to perform.
1031    * @param[in] attributes The attributes with which to perfrom this action.
1032    * @return true if the action was done.
1033    */
1034   static bool DoAction(BaseObject* object, const std::string& actionName, const std::vector<Property::Value>& attributes);
1035
1036 public:  // For Animation
1037
1038   /**
1039    * This should only be called by Animation, when the actor is resized using Animation::Resize().
1040    *
1041    * @param[in] animation The animation that resized the actor
1042    * @param[in] targetSize The new target size of the actor
1043    */
1044   void NotifySizeAnimation( Animation& animation, const Vector3& targetSize);
1045
1046   /**
1047    * For use in derived classes.
1048    * This should only be called by Animation, when the actor is resized using Animation::Resize().
1049    */
1050   virtual void OnSizeAnimation( Animation& animation, const Vector3& targetSize) {}
1051
1052 protected:
1053
1054   enum DerivedType
1055   {
1056     BASIC,
1057     RENDERABLE,
1058     LAYER,
1059     ROOT_LAYER
1060   };
1061
1062   /**
1063    * Protected Constructor.  See Actor::New().
1064    * The second-phase construction Initialize() member should be called immediately after this.
1065    * @param[in] derivedType The derived type of actor (if any).
1066    */
1067   Actor( DerivedType derivedType );
1068
1069   /**
1070    * Second-phase constructor. Must be called immediately after creating a new Actor;
1071    */
1072   void Initialize(void);
1073
1074   /**
1075    * A reference counted object may only be deleted by calling Unreference()
1076    */
1077   virtual ~Actor();
1078
1079   /**
1080    * Called on a child during Add() when the parent actor is connected to the Stage.
1081    * @param[in] stage The stage.
1082    * @param[in] index If set, it is only used for positioning the actor within the parent's child list.
1083    */
1084   void ConnectToStage(Stage& stage, int index = -1);
1085
1086   /**
1087    * Helper for ConnectToStage, to recursively connect a tree of actors.
1088    * This is atomic i.e. not interrupted by user callbacks.
1089    * @param[in] stage The stage.
1090    * @param[in] index If set, it is only used for positioning the actor within the parent's child list.
1091    * @param[out] connectionList On return, the list of connected actors which require notification.
1092    */
1093   void RecursiveConnectToStage( Stage& stage, ActorContainer& connectionList, int index = -1 );
1094
1095   /**
1096    * Connect the Node associated with this Actor to the scene-graph.
1097    * @param[in] index If set, it is only used for positioning the actor within the parent's child list.
1098    */
1099   void ConnectToSceneGraph(int index = -1);
1100
1101   /**
1102    * Helper for ConnectToStage, to notify a connected actor through the public API.
1103    */
1104   void NotifyStageConnection();
1105
1106   /**
1107    * Called on a child during Remove() when the actor was previously on the Stage.
1108    */
1109   void DisconnectFromStage();
1110
1111   /**
1112    * Helper for DisconnectFromStage, to recursively disconnect a tree of actors.
1113    * This is atomic i.e. not interrupted by user callbacks.
1114    * @param[out] disconnectionList On return, the list of disconnected actors which require notification.
1115    */
1116   void RecursiveDisconnectFromStage( ActorContainer& disconnectionList );
1117
1118   /**
1119    * Disconnect the Node associated with this Actor from the scene-graph.
1120    */
1121   void DisconnectFromSceneGraph();
1122
1123   /**
1124    * Helper for DisconnectFromStage, to notify a disconnected actor through the public API.
1125    */
1126   void NotifyStageDisconnection();
1127
1128   /**
1129    * When the Actor is OnStage, checks whether the corresponding Node is connected to the scene graph.
1130    * @return True if the Actor is OnStage & has a Node connected to the scene graph.
1131    */
1132   bool IsNodeConnected() const;
1133
1134   /**
1135    * Calculate the size of the z dimension for a 2D size
1136    *
1137    * @param[in] size The 2D size (X, Y) to calculate Z from
1138    *
1139    * @return Return the Z dimension for this size
1140    */
1141   float CalculateSizeZ( const Vector2& size ) const;
1142
1143 public: // Default property extensions from ProxyObject
1144
1145   /**
1146    * @copydoc Dali::Internal::ProxyObject::IsSceneObjectRemovable()
1147    */
1148   virtual bool IsSceneObjectRemovable() const;
1149
1150   /**
1151    * @copydoc Dali::Internal::ProxyObject::GetDefaultPropertyCount()
1152    */
1153   virtual unsigned int GetDefaultPropertyCount() const;
1154
1155   /**
1156    * @copydoc Dali::Internal::ProxyObject::GetDefaultPropertyIndices()
1157    */
1158   virtual void GetDefaultPropertyIndices( Property::IndexContainer& indices ) const;
1159
1160   /**
1161    * @copydoc Dali::Internal::ProxyObject::GetDefaultPropertyName()
1162    */
1163   virtual const char* GetDefaultPropertyName(Property::Index index) const;
1164
1165   /**
1166    * @copydoc Dali::Internal::ProxyObject::GetDefaultPropertyIndex()
1167    */
1168   virtual Property::Index GetDefaultPropertyIndex(const std::string& name) const;
1169
1170   /**
1171    * @copydoc Dali::Internal::ProxyObject::IsDefaultPropertyWritable()
1172    */
1173   virtual bool IsDefaultPropertyWritable(Property::Index index) const;
1174
1175   /**
1176    * @copydoc Dali::Internal::ProxyObject::IsDefaultPropertyAnimatable()
1177    */
1178   virtual bool IsDefaultPropertyAnimatable(Property::Index index) const;
1179
1180   /**
1181    * @copydoc Dali::Internal::ProxyObject::IsDefaultPropertyAConstraintInput()
1182    */
1183   virtual bool IsDefaultPropertyAConstraintInput( Property::Index index ) const;
1184
1185   /**
1186    * @copydoc Dali::Internal::ProxyObject::GetDefaultPropertyType()
1187    */
1188   virtual Property::Type GetDefaultPropertyType(Property::Index index) const;
1189
1190   /**
1191    * @copydoc Dali::Internal::ProxyObject::SetDefaultProperty()
1192    */
1193   virtual void SetDefaultProperty(Property::Index index, const Property::Value& propertyValue);
1194
1195   /**
1196    * @copydoc Dali::Internal::ProxyObject::SetCustomProperty()
1197    */
1198   virtual void SetCustomProperty( Property::Index index, const CustomProperty& entry, const Property::Value& value );
1199
1200   /**
1201    * @copydoc Dali::Internal::ProxyObject::GetDefaultProperty()
1202    */
1203   virtual Property::Value GetDefaultProperty( Property::Index index ) const;
1204
1205   /**
1206    * @copydoc Dali::Internal::ProxyObject::InstallSceneObjectProperty()
1207    */
1208   virtual void InstallSceneObjectProperty( SceneGraph::PropertyBase& newProperty, const std::string& name, unsigned int index );
1209
1210   /**
1211    * @copydoc Dali::Internal::ProxyObject::GetSceneObject()
1212    */
1213   virtual const SceneGraph::PropertyOwner* GetSceneObject() const;
1214
1215   /**
1216    * @copydoc Dali::Internal::ProxyObject::GetSceneObjectAnimatableProperty()
1217    */
1218   virtual const SceneGraph::PropertyBase* GetSceneObjectAnimatableProperty( Property::Index index ) const;
1219
1220   /**
1221    * @copydoc Dali::Internal::ProxyObject::GetSceneObjectInputProperty()
1222    */
1223   virtual const PropertyInputImpl* GetSceneObjectInputProperty( Property::Index index ) const;
1224
1225   /**
1226    * @copydoc Dali::Internal::ProxyObject::GetPropertyComponentIndex()
1227    */
1228   virtual int GetPropertyComponentIndex( Property::Index index ) const;
1229
1230 private:
1231
1232   // Undefined
1233   Actor();
1234
1235   // Undefined
1236   Actor(const Actor&);
1237
1238   // Undefined
1239   Actor& operator=(const Actor& rhs);
1240
1241   /**
1242    * Set the actors parent.
1243    * @param[in] parent The new parent.
1244    * @param[in] index If set, it is only used for positioning the actor within the parent's child list.
1245    */
1246   void SetParent(Actor* parent, int index = -1);
1247
1248   /**
1249    * Helper to create a Node for this Actor.
1250    * To be overriden in derived classes.
1251    * @return A newly allocated node.
1252    */
1253   virtual SceneGraph::Node* CreateNode() const;
1254
1255   /**
1256    * For use in derived classes, called after Initialize()
1257    */
1258   virtual void OnInitialize() {}
1259
1260   /**
1261    * For use in internal derived classes.
1262    * This is called during ConnectToStage(), after the actor has finished adding its node to the scene-graph.
1263    * The derived class must not modify the actor hierachy (Add/Remove children) during this callback.
1264    */
1265   virtual void OnStageConnectionInternal() {}
1266
1267   /**
1268    * For use in internal derived classes.
1269    * This is called during DisconnectFromStage(), before the actor removes its node from the scene-graph.
1270    * The derived class must not modify the actor hierachy (Add/Remove children) during this callback.
1271    */
1272   virtual void OnStageDisconnectionInternal() {}
1273
1274   /**
1275    * For use in external (CustomActor) derived classes.
1276    * This is called after the atomic ConnectToStage() traversal has been completed.
1277    */
1278   virtual void OnStageConnectionExternal() {}
1279
1280   /**
1281    * For use in external (CustomActor) derived classes.
1282    * This is called after the atomic DisconnectFromStage() traversal has been completed.
1283    */
1284   virtual void OnStageDisconnectionExternal() {}
1285
1286   /**
1287    * For use in derived classes; this is called after Add() has added a child.
1288    * @param[in] child The child that was added.
1289    */
1290   virtual void OnChildAdd( Actor& child ) {}
1291
1292   /**
1293    * For use in derived classes; this is called after Remove() has removed a child.
1294    * @param[in] child The child that was removed.
1295    */
1296   virtual void OnChildRemove( Actor& child ) {}
1297
1298   /**
1299    * For use in derived classes.
1300    * This is called after SizeSet() has been called.
1301    */
1302   virtual void OnSizeSet(const Vector3& targetSize) {}
1303
1304   /**
1305    * For use in derived classes.
1306    * This is called after a non animatable custom property is set.
1307    * @param [in] index The index of the property.
1308    * @param [in] propertyValue The value of the property.
1309    */
1310   virtual void OnPropertySet( Property::Index index, Property::Value propertyValue ) {}
1311
1312   /**
1313    * For use in derived classes.
1314    * This is only called if mDerivedRequiresTouch is true, and the touch-signal was not consumed.
1315    * @param[in] event The touch event.
1316    * @return True if the event should be consumed.
1317    */
1318   virtual bool OnTouchEvent(const TouchEvent& event) { return false; }
1319
1320   /**
1321    * For use in derived classes.
1322    * This is only called if mDerivedRequiresHover is true, and the hover-signal was not consumed.
1323    * @param[in] event The hover event.
1324    * @return True if the event should be consumed.
1325    */
1326   virtual bool OnHoverEvent(const HoverEvent& event) { return false; }
1327
1328   /**
1329    * For use in derived classes.
1330    * This is only called if the mouse wheel signal was not consumed.
1331    * @param[in] event The mouse event.
1332    * @return True if the event should be consumed.
1333    */
1334   virtual bool OnMouseWheelEvent(const MouseWheelEvent& event) { return false; }
1335
1336   /**
1337    * For use in derived class
1338    * If an alias for a child exists, return the child otherwise return an empty handle.
1339    * For example 'previous' could return the last selected child.
1340    * @pre The Actor has been initialized.
1341    * @param[in] actorAlias the name of the actor to find
1342    * @return A handle to the actor if found, or an empty handle if not.
1343    */
1344   virtual Dali::Actor GetChildByAlias(const std::string& actorAlias) { return Dali::Actor(); }
1345
1346   /**
1347    * Support function for FindChildByAlias
1348    * @pre The Actor has been initialized.
1349    * @param[in] actorAlias the name of the aliased actor to find
1350    * @return A handle to the actor if found, or an empty handle if not.
1351    */
1352   Dali::Actor DoGetChildByAlias(const std::string& actorAlias);
1353
1354 protected:
1355
1356   StagePtr                mStage;        ///< Used to send messages to Node; valid until Core destruction
1357   Actor*                  mParent;       ///< Each actor (except the root) can have one parent
1358   ActorContainer*         mChildren;     ///< Container of referenced actors
1359   const SceneGraph::Node* mNode;         ///< Not owned
1360   Vector3*                mParentOrigin; // NULL means ParentOrigin::DEFAULT. ParentOrigin is non-animatable
1361   Vector3*                mAnchorPoint;  // NULL means AnchorPoint::DEFAULT. AnchorPoint is non-animatable
1362
1363 #ifdef DYNAMICS_SUPPORT
1364   DynamicsData*           mDynamicsData; ///< optional physics data
1365 #endif
1366
1367   ActorGestureData*       mGestureData; /// Optional Gesture data. Only created when actor requires gestures
1368
1369   ActorAttachmentPtr      mAttachment;   ///< Optional referenced attachment
1370
1371   // Signals
1372   Dali::Actor::TouchSignalV2             mTouchedSignalV2;
1373   Dali::Actor::HoverSignalV2             mHoveredSignalV2;
1374   Dali::Actor::MouseWheelEventSignalV2   mMouseWheelEventSignalV2;
1375   Dali::Actor::SetSizeSignalV2           mSetSizeSignalV2;
1376   Dali::Actor::OnStageSignalV2           mOnStageSignalV2;
1377   Dali::Actor::OffStageSignalV2          mOffStageSignalV2;
1378
1379   Vector3         mSize;      ///< Event-side storage for size (not a pointer as most actors will have a size)
1380
1381   std::string     mName;      ///< Name of the actor
1382   unsigned int    mId;        ///< A unique ID to identify the actor starting from 1, and 0 is reserved
1383
1384   const bool mIsRoot                               : 1; ///< Flag to identify the root actor
1385   const bool mIsRenderable                         : 1; ///< Flag to identify that this is a renderable actor
1386   const bool mIsLayer                              : 1; ///< Flag to identify that this is a layer
1387   bool mIsOnStage                                  : 1; ///< Flag to identify whether the actor is on-stage
1388   bool mIsDynamicsRoot                             : 1; ///< Flag to identify if this is the dynamics world root
1389   bool mSensitive                                  : 1; ///< Whether the actor emits touch event signals
1390   bool mLeaveRequired                              : 1; ///< Whether a touch event signal is emitted when the a touch leaves the actor's bounds
1391   bool mKeyboardFocusable                          : 1; ///< Whether the actor should be focusable by keyboard navigation
1392   bool mDerivedRequiresTouch                       : 1; ///< Whether the derived actor type requires touch event signals
1393   bool mDerivedRequiresHover                       : 1; ///< Whether the derived actor type requires hover event signals
1394   bool mDerivedRequiresMouseWheelEvent             : 1; ///< Whether the derived actor type requires mouse wheel event signals
1395   bool mOnStageSignalled                           : 1; ///< Set to true before OnStageConnection signal is emitted, and false before OnStageDisconnection
1396   bool mInheritRotation                            : 1; ///< Cached: Whether the parent's rotation should be inherited.
1397   bool mInheritScale                               : 1; ///< Cached: Whether the parent's scale should be inherited.
1398   DrawMode::Type mDrawMode                         : 2; ///< Cached: How the actor and its children should be drawn
1399   PositionInheritanceMode mPositionInheritanceMode : 2; ///< Cached: Determines how position is inherited
1400   ColorMode mColorMode                             : 2; ///< Cached: Determines whether mWorldColor is inherited
1401
1402 private:
1403
1404   static ActorContainer mNullChildren; ///< Empty container (shared by all actors, returned by GetChildren() const)
1405   static unsigned int   mActorCounter; ///< A counter to track the actor instance creation
1406
1407 };
1408
1409 } // namespace Internal
1410
1411 // Helpers for public-api forwarding methods
1412
1413 inline Internal::Actor& GetImplementation(Dali::Actor& actor)
1414 {
1415   DALI_ASSERT_ALWAYS(actor && "Actor handle is empty");
1416
1417   BaseObject& handle = actor.GetBaseObject();
1418
1419   return static_cast<Internal::Actor&>(handle);
1420 }
1421
1422 inline const Internal::Actor& GetImplementation(const Dali::Actor& actor)
1423 {
1424   DALI_ASSERT_ALWAYS(actor && "Actor handle is empty");
1425
1426   const BaseObject& handle = actor.GetBaseObject();
1427
1428   return static_cast<const Internal::Actor&>(handle);
1429 }
1430
1431 } // namespace Dali
1432
1433 #endif // __DALI_INTERNAL_ACTOR_H__