[3.0] Added sibling order property to Actor

[platform/core/uifw/dali-core.git] / dali / internal / event / actors / actor-impl.h

diff --git a/dali/internal/event/actors/actor-impl.h b/dali/internal/event/actors/actor-impl.h
index ccf2644..5e9b6ab 100644 (file)
--- a/dali/internal/event/actors/actor-impl.h
+++ b/dali/internal/event/actors/actor-impl.h
@@ -1,8 +1,8 @@
-#ifndef __DALI_INTERNAL_ACTOR_H__
-#define __DALI_INTERNAL_ACTOR_H__
+#ifndef DALI_INTERNAL_ACTOR_H
+#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>
@@ -40,7 +39,7 @@ namespace Dali
 {
 
 struct KeyEvent;
-struct TouchEvent;
+class TouchData;
 struct HoverEvent;
 struct WheelEvent;
 
@@ -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.
    */
@@ -656,6 +636,12 @@ public:
   float GetCurrentOpacity() const;
 
   /**
+   * Retrieve the actor's clipping mode.
+   * @return The actor's clipping mode (cached)
+   */
+  ClippingMode::Type GetClippingMode() const;
+
+  /**
    * Sets whether an actor should emit touch or hover signals; see SignalTouch() and SignalHover().
    * An actor is sensitive by default, which means that as soon as an application connects to the SignalTouch(),
    * the touch event signal will be emitted, and as soon as an application connects to the SignalHover(), the
@@ -701,11 +687,6 @@ public:
   DrawMode::Type GetDrawMode() const;
 
   /**
-   * @copydoc Dali::Actor::SetOverlay
-   */
-  void SetOverlay( bool enable );
-
-  /**
    * @copydoc Dali::Actor::IsOverlay
    */
   bool IsOverlay() const;
@@ -1300,7 +1281,7 @@ public:
    */
   bool RayActorTest( const Vector4& rayOrigin,
                      const Vector4& rayDir,
-                     Vector4& hitPointLocal,
+                     Vector2& hitPointLocal,
                      float& distance ) const;
 
   /**
@@ -1378,10 +1359,11 @@ public:
 
   /**
    * Used by the EventProcessor to emit touch event signals.
-   * @param[in] event The touch event.
+   * @param[in] event The touch event (Old API).
+   * @param[in] touch The touch data.
    * @return True if the event was consumed.
    */
-  bool EmitTouchEventSignal( const TouchEvent& event );
+  bool EmitTouchEventSignal( const TouchEvent& event, const Dali::TouchData& touch );
 
   /**
    * Used by the EventProcessor to emit hover event signals.
@@ -1403,6 +1385,11 @@ public:
   Dali::Actor::TouchSignalType& TouchedSignal();
 
   /**
+   * @copydoc Dali::Actor::TouchEventSignal()
+   */
+  Dali::Actor::TouchDataSignalType& TouchSignal();
+
+  /**
    * @copydoc Dali::Actor::HoveredSignal()
    */
   Dali::Actor::HoverSignalType& HoveredSignal();
@@ -1792,6 +1779,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
@@ -1807,10 +1800,9 @@ protected:
 
   ActorGestureData* mGestureData;   ///< Optional Gesture data. Only created when actor requires gestures
 
-  ActorAttachmentPtr mAttachment;   ///< Optional referenced attachment
-
   // Signals
   Dali::Actor::TouchSignalType             mTouchedSignal;
+  Dali::Actor::TouchDataSignalType         mTouchSignal;
   Dali::Actor::HoverSignalType             mHoveredSignal;
   Dali::Actor::WheelEventSignalType        mWheelEventSignal;
   Dali::Actor::OnStageSignalType           mOnStageSignal;
@@ -1823,7 +1815,9 @@ protected:
   std::string     mName;      ///< Name of the actor
   unsigned int    mId;        ///< A unique ID to identify the actor starting from 1, and 0 is reserved
 
-  unsigned short mDepth                            :12; ///< Cached: The depth in the hierarchy of the actor. Only 4096 levels of depth are supported
+  uint16_t mDepth;            ///< The depth in the hierarchy of the actor. Only 4096 levels of depth are supported
+  uint16_t mSiblingOrder;     ///< The sibling order of the actor
+
   const bool mIsRoot                               : 1; ///< Flag to identify the root actor
   const bool mIsLayer                              : 1; ///< Flag to identify that this is a layer
   bool mIsOnStage                                  : 1; ///< Flag to identify whether the actor is on-stage
@@ -1841,6 +1835,7 @@ protected:
   DrawMode::Type mDrawMode                         : 2; ///< Cached: How the actor and its children should be drawn
   PositionInheritanceMode mPositionInheritanceMode : 2; ///< Cached: Determines how position is inherited
   ColorMode mColorMode                             : 2; ///< Cached: Determines whether mWorldColor is inherited
+  ClippingMode::Type mClippingMode                 : 2; ///< Cached: Determines which clipping mode (if any) to use.
 
 private:
 
@@ -1873,4 +1868,4 @@ inline const Internal::Actor& GetImplementation( const Dali::Actor& actor )
 
 } // namespace Dali
 
-#endif // __DALI_INTERNAL_ACTOR_H__
+#endif // DALI_INTERNAL_ACTOR_H