Support for child properties registration
[platform/core/uifw/dali-core.git] / dali / internal / event / actors / actor-impl.h
index 9e78b79..9eb1690 100644 (file)
@@ -2,7 +2,7 @@
 #define __DALI_INTERNAL_ACTOR_H__
 
 /*
- * Copyright (c) 2014 Samsung Electronics Co., Ltd.
+ * Copyright (c) 2016 Samsung Electronics Co., Ltd.
  *
  * Licensed under the Apache License, Version 2.0 (the "License");
  * you may not use this file except in compliance with the License.
@@ -30,7 +30,6 @@
 #include <dali/public-api/object/ref-object.h>
 #include <dali/public-api/size-negotiation/relayout-container.h>
 #include <dali/internal/event/actors/actor-declarations.h>
-#include <dali/internal/event/actor-attachments/actor-attachment-declarations.h>
 #include <dali/internal/event/common/object-impl.h>
 #include <dali/internal/event/common/stage-def.h>
 #include <dali/internal/event/rendering/renderer-impl.h>
@@ -66,8 +65,8 @@ typedef RendererContainer::iterator RendererIter;
  * Multi-Touch events are received through signals emitted by the actor tree.
  *
  * An Actor is a proxy for a Node in the scene graph.
- * When an Actor is added to the Stage, it creates a node and attaches it to the scene graph.
- * The scene-graph can be updated in a separate thread, so the attachment is done using an asynchronous message.
+ * When an Actor is added to the Stage, it creates a node and connects it to the scene graph.
+ * The scene-graph can be updated in a separate thread, so the connection is done using an asynchronous message.
  * When a tree of Actors is detached from the Stage, a message is sent to destroy the associated nodes.
  */
 class Actor : public Object
@@ -133,21 +132,6 @@ public:
    */
   unsigned int GetId() const;
 
-  // Attachments
-
-  /**
-   * Attach an object to an actor.
-   * @pre The actor does not already have an attachment.
-   * @param[in] attachment The object to attach.
-   */
-  void Attach( ActorAttachment& attachment );
-
-  /**
-   * Retreive the object attached to an actor.
-   * @return The attachment.
-   */
-  ActorAttachmentPtr GetAttachment();
-
   // Containment
 
   /**
@@ -253,7 +237,6 @@ public:
 
   /**
    * Sets the size of an actor.
-   * ActorAttachments attached to the actor, can be scaled to fit within this area.
    * This does not interfere with the actors scale factor.
    * @param [in] width  The new width.
    * @param [in] height The new height.
@@ -262,7 +245,6 @@ public:
 
   /**
    * Sets the size of an actor.
-   * ActorAttachments attached to the actor, can be scaled to fit within this area.
    * This does not interfere with the actors scale factor.
    * @param [in] width The size of the actor along the x-axis.
    * @param [in] height The size of the actor along the y-axis.
@@ -272,7 +254,6 @@ public:
 
   /**
    * Sets the size of an actor.
-   * ActorAttachments attached to the actor, can be scaled to fit within this area.
    * This does not interfere with the actors scale factor.
    * @param [in] size The new size.
    */
@@ -287,7 +268,6 @@ public:
 
   /**
    * Sets the size of an actor.
-   * ActorAttachments attached to the actor, can be scaled to fit within this area.
    * This does not interfere with the actors scale factor.
    * @param [in] size The new size.
    */
@@ -486,6 +466,16 @@ public:
   PositionInheritanceMode GetPositionInheritanceMode() const;
 
   /**
+   * @copydoc Dali::Actor::SetInheritPosition()
+   */
+  void SetInheritPosition( bool inherit );
+
+  /**
+   * @copydoc Dali::Actor::IsPositionInherited()
+   */
+  bool IsPositionInherited() const;
+
+  /**
    * Sets the orientation of the Actor.
    * @param [in] angleRadians The new orientation angle in radians.
    * @param [in] axis The new axis of orientation.
@@ -1454,10 +1444,11 @@ public:
   void NotifySizeAnimation( Animation& animation, const Vector3& targetSize );
 
   /**
-   * This should only be called by Animation, when the actors SIZE_WIDTH or SIZE_HEIGHT property is animated.
+   * This should only be called by Animation, when the actors SIZE_WIDTH or SIZE_HEIGHT or SIZE_DEPTH property is animated.
    *
    * @param[in] animation The animation that resized the actor
    * @param[in] targetSize The new target size of the actor
+   * @param[in] property The index of the property being animated
    */
   void NotifySizeAnimation( Animation& animation, float targetSize, Property::Index property );
 
@@ -1469,6 +1460,23 @@ public:
   {
   }
 
+  /**
+   * This should only be called by Animation, when the actors POSITION property is animated.
+   *
+   * @param[in] animation The animation that repositioned the actor
+   * @param[in] targetPosition The new target position of the actor
+   */
+  void NotifyPositionAnimation( Animation& animation, const Vector3& targetPosition );
+
+  /**
+   * This should only be called by Animation, when the actors POSITION_X or POSITION_Y or POSITION_Z property is animated.
+   *
+   * @param[in] animation The animation that repositioned the actor
+   * @param[in] targetPosition The new target position of the actor
+   * @param[in] property The index of the property being animated
+   */
+  void NotifyPositionAnimation( Animation& animation, float targetPosition, Property::Index property );
+
 protected:
 
   enum DerivedType
@@ -1703,7 +1711,7 @@ private:
   }
 
   /**
-   * For use in derived classes; this is called after Remove() has removed a child.
+   * For use in derived classes; this is called after Remove() has attempted to remove a child( regardless of whether it succeeded or not ).
    * @param[in] child The child that was removed.
    */
   virtual void OnChildRemove( Actor& child )
@@ -1764,6 +1772,12 @@ private:
    */
   Vector2 ApplySizeSetPolicy( const Vector2 size );
 
+  /**
+   * Retrieve the parent object of an Actor.
+   * @return The parent object, or NULL if the Actor does not have a parent.
+   */
+  virtual Object* GetParentObject() const;
+
 protected:
 
   Actor* mParent;                 ///< Each actor (except the root) can have one parent
@@ -1779,8 +1793,6 @@ protected:
 
   ActorGestureData* mGestureData;   ///< Optional Gesture data. Only created when actor requires gestures
 
-  ActorAttachmentPtr mAttachment;   ///< Optional referenced attachment
-
   // Signals
   Dali::Actor::TouchSignalType             mTouchedSignal;
   Dali::Actor::HoverSignalType             mHoveredSignal;
@@ -1807,6 +1819,7 @@ protected:
   bool mDerivedRequiresWheelEvent                  : 1; ///< Whether the derived actor type requires wheel event signals
   bool mOnStageSignalled                           : 1; ///< Set to true before OnStageConnection signal is emitted, and false before OnStageDisconnection
   bool mInsideOnSizeSet                            : 1; ///< Whether we are inside OnSizeSet
+  bool mInheritPosition                            : 1; ///< Cached: Whether the parent's position should be inherited.
   bool mInheritOrientation                         : 1; ///< Cached: Whether the parent's orientation should be inherited.
   bool mInheritScale                               : 1; ///< Cached: Whether the parent's scale should be inherited.
   DrawMode::Type mDrawMode                         : 2; ///< Cached: How the actor and its children should be drawn