dali/public-api/actors/custom-actor-impl.h

   1 #ifndef __DALI_CUSTOM_ACTOR_IMPL_H__
   2 #define __DALI_CUSTOM_ACTOR_IMPL_H__
   3
   4 /*
   5  * Copyright (c) 2016 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 // INTERNAL INCLUDES
  22 #include <dali/public-api/object/property.h>
  23 #include <dali/public-api/object/ref-object.h>
  24 #include <dali/public-api/actors/actor-enumerations.h>
  25 #include <dali/public-api/math/compile-time-math.h>
  26
  27 namespace Dali
  28 {
  29 /**
  30  * @addtogroup dali_core_actors
  31  * @{
  32  */
  33
  34 namespace Internal DALI_INTERNAL
  35 {
  36 class CustomActor;
  37 }
  38
  39 class Actor;
  40 class Animation;
  41 class CustomActor;
  42 class CustomActorImpl;
  43 class RelayoutContainer;
  44 struct KeyEvent;
  45 struct TouchEvent;
  46 struct HoverEvent;
  47 struct WheelEvent;
  48 struct Vector2;
  49 struct Vector3;
  50
  51 /**
  52  * @brief Pointer to Dali::CustomActorImpl object.
  53  * @SINCE_1_0.0
  54  */
  55 typedef IntrusivePtr<CustomActorImpl> CustomActorImplPtr;
  56
  57 /**
  58  * @brief CustomActorImpl is an abstract base class for custom control implementations.
  59  *
  60  * This provides a series of pure virtual methods, which are called when actor-specific events occur.
  61  * And CustomActorImpl is typically owned by a single CustomActor instance; see also CustomActor::CustomActor( CustomActorImpl &implementation ).
  62  * @SINCE_1_0.0
  63  */
  64 class DALI_IMPORT_API CustomActorImpl : public Dali::RefObject
  65 {
  66 public:
  67
  68   class Extension; ///< Forward declare future extension interface
  69
  70   /**
  71    * @brief Used by derived CustomActorImpl instances, to access the public Actor interface.
  72    *
  73    * @SINCE_1_0.0
  74    * @return A pointer to self, or an uninitialized pointer if the CustomActorImpl is not owned.
  75    */
  76   CustomActor Self() const;
  77
  78   /**
  79    * @brief Called after the actor has been connected to the stage.
  80    *
  81    * When an actor is connected, it will be directly or indirectly parented to the root Actor.
  82    * @SINCE_1_0.0
  83    * @param[in] depth The depth in the hierarchy for the actor
  84    *
  85    * @note The root Actor is provided automatically by Dali::Stage, and is always considered to be connected.
  86    * When the parent of a set of actors is connected to the stage, then all of the children
  87    * will received this callback.
  88    * For the following actor tree, the callback order will be A, B, D, E, C, and finally F.
  89    *
  90    * @code
  91    *
  92    *       A (parent)
  93    *      / \
  94    *     B   C
  95    *    / \   \
  96    *   D   E   F
  97    *
  98    * @endcode
  99    * @param[in] depth The depth in the hierarchy for the actor
 100    */
 101   virtual void OnStageConnection( int depth ) = 0;
 102
 103   /**
 104    * @brief Called after the actor has been disconnected from Stage.
 105    *
 106    * If an actor is disconnected it either has no parent, or is parented to a disconnected actor.
 107    *
 108    * @SINCE_1_0.0
 109    * @note When the parent of a set of actors is disconnected to the stage, then all of the children
 110    * will received this callback, starting with the leaf actors.
 111    * For the following actor tree, the callback order will be D, E, B, F, C, and finally A.
 112    *
 113    * @code
 114    *
 115    *       A (parent)
 116    *      / \
 117    *     B   C
 118    *    / \   \
 119    *   D   E   F
 120    *
 121    * @endcode
 122    */
 123   virtual void OnStageDisconnection() = 0;
 124
 125   /**
 126    * @brief Called after a child has been added to the owning actor.
 127    *
 128    * @SINCE_1_0.0
 129    * @param[in] child The child which has been added
 130    */
 131   virtual void OnChildAdd(Actor& child) = 0;
 132
 133   /**
 134    * @brief Called after the owning actor has attempted to remove a child( regardless of whether it succeeded or not ).
 135    *
 136    * @SINCE_1_0.0
 137    * @param[in] child The child being removed
 138    */
 139   virtual void OnChildRemove(Actor& child) = 0;
 140
 141   /**
 142    * @brief Called when the owning actor property is set.
 143    *
 144    * @SINCE_1_0.0
 145    * @param[in] index The Property index that was set
 146    * @param[in] propertyValue The value to set
 147    */
 148   virtual void OnPropertySet( Property::Index index, Property::Value propertyValue );
 149
 150   /**
 151    * @brief Called when the owning actor's size is set e.g. using Actor::SetSize().
 152    *
 153    * @SINCE_1_0.0
 154    * @param[in] targetSize The target size. Note that this target size may not match the size returned via @ref Actor::GetTargetSize.
 155    */
 156   virtual void OnSizeSet(const Vector3& targetSize) = 0;
 157
 158   /**
 159    * @brief Called when the owning actor's size is animated e.g. using Animation::AnimateTo( Property( actor, Actor::Property::SIZE ), ... ).
 160    *
 161    * @SINCE_1_0.0
 162    * @param[in] animation The object which is animating the owning actor.
 163    * @param[in] targetSize The target size. Note that this target size may not match the size returned via @ref Actor::GetTargetSize.
 164    */
 165   virtual void OnSizeAnimation(Animation& animation, const Vector3& targetSize) = 0;
 166
 167   /**
 168    * @DEPRECATED_1_1.37 Connect to TouchSignal() instead.
 169    *
 170    * @brief Called after a touch-event is received by the owning actor.
 171    *
 172    * @SINCE_1_0.0
 173    * @param[in] event The touch event
 174    * @return True if the event should be consumed.
 175    * @note CustomActorImpl::REQUIRES_TOUCH_EVENTS must be enabled during construction. See CustomActorImpl::CustomActorImpl( ActorFlags flags ).
 176    */
 177   virtual bool OnTouchEvent(const TouchEvent& event) DALI_DEPRECATED_API = 0;
 178
 179   /**
 180    * @brief Called after a hover-event is received by the owning actor.
 181    *
 182    * @SINCE_1_0.0
 183    * @param[in] event The hover event
 184    * @return True if the event should be consumed.
 185    * @note CustomActorImpl::REQUIRES_HOVER_EVENTS must be enabled during construction. See CustomActorImpl::CustomActorImpl( ActorFlags flags ).
 186    */
 187   virtual bool OnHoverEvent(const HoverEvent& event) = 0;
 188
 189   /**
 190    * @brief Called after a key-event is received by the actor that has had its focus set.
 191    *
 192    * @SINCE_1_0.0
 193    * @param[in] event the Key Event
 194    * @return True if the event should be consumed.
 195    */
 196   virtual bool OnKeyEvent(const KeyEvent& event) = 0;
 197
 198   /**
 199    * @brief Called after a wheel-event is received by the owning actor.
 200    *
 201    * @SINCE_1_0.0
 202    * @param[in] event The wheel event
 203    * @return True if the event should be consumed.
 204    * @note CustomActorImpl::REQUIRES_WHEEL_EVENTS must be enabled during construction. See CustomActorImpl::CustomActorImpl( ActorFlags flags ).
 205    */
 206   virtual bool OnWheelEvent(const WheelEvent& event) = 0;
 207
 208   /**
 209    * @brief Called after the size negotiation has been finished for this control.
 210    *
 211    * The control is expected to assign this given size to itself/its children.
 212    *
 213    * Should be overridden by derived classes if they need to layout
 214    * actors differently after certain operations like add or remove
 215    * actors, resize or after changing specific properties.
 216    *
 217    * @SINCE_1_0.0
 218    * @param[in]      size       The allocated size.
 219    * @param[in,out]  container  The control should add actors to this container that it is not able
 220    *                            to allocate a size for.
 221    * @note  As this function is called from inside the size negotiation algorithm, you cannot
 222    * call RequestRelayout (the call would just be ignored).
 223    */
 224   virtual void OnRelayout( const Vector2& size, RelayoutContainer& container ) = 0;
 225
 226   /**
 227    * @brief Notification for deriving classes
 228    *
 229    * @SINCE_1_0.0
 230    * @param[in] policy The policy being set
 231    * @param[in] dimension The dimension the policy is being set for
 232    */
 233   virtual void OnSetResizePolicy( ResizePolicy::Type policy, Dimension::Type dimension ) = 0;
 234
 235   /**
 236    * @brief Return the natural size of the actor.
 237    *
 238    * @SINCE_1_0.0
 239    * @return The actor's natural size
 240    */
 241   virtual Vector3 GetNaturalSize() = 0;
 242
 243   /**
 244    * @brief Calculate the size for a child.
 245    *
 246    * @SINCE_1_0.0
 247    * @param[in] child The child actor to calculate the size for
 248    * @param[in] dimension The dimension to calculate the size for. E.g. width or height.
 249    * @return Return the calculated size for the given dimension.
 250    */
 251   virtual float CalculateChildSize( const Dali::Actor& child, Dimension::Type dimension ) = 0;
 252
 253   /**
 254    * @brief This method is called during size negotiation when a height is required for a given width.
 255    *
 256    * Derived classes should override this if they wish to customize the height returned.
 257    *
 258    * @SINCE_1_0.0
 259    * @param width Width to use.
 260    * @return The height based on the width.
 261    */
 262   virtual float GetHeightForWidth( float width ) = 0;
 263
 264   /**
 265    * @brief This method is called during size negotiation when a width is required for a given height.
 266    *
 267    * Derived classes should override this if they wish to customize the width returned.
 268    *
 269    * @SINCE_1_0.0
 270    * @param height Height to use.
 271    * @return The width based on the width.
 272    */
 273   virtual float GetWidthForHeight( float height ) = 0;
 274
 275   /**
 276    * @brief Determine if this actor is dependent on it's children for relayout.
 277    *
 278    * @SINCE_1_0.0
 279    * @param dimension The dimension(s) to check for
 280    * @return Return if the actor is dependent on it's children.
 281    */
 282   virtual bool RelayoutDependentOnChildren( Dimension::Type dimension = Dimension::ALL_DIMENSIONS ) = 0;
 283
 284   /**
 285    * @brief Virtual method to notify deriving classes that relayout dependencies have been
 286    * met and the size for this object is about to be calculated for the given dimension
 287    *
 288    * @SINCE_1_0.0
 289    * @param dimension The dimension that is about to be calculated
 290    */
 291   virtual void OnCalculateRelayoutSize( Dimension::Type dimension ) = 0;
 292
 293   /**
 294    * @brief Virtual method to notify deriving classes that the size for a dimension
 295    * has just been negotiated
 296    *
 297    * @SINCE_1_0.0
 298    * @param[in] size The new size for the given dimension
 299    * @param[in] dimension The dimension that was just negotiated
 300    */
 301   virtual void OnLayoutNegotiated( float size, Dimension::Type dimension ) = 0;
 302
 303   /**
 304    * @brief Retrieve the extension for this control.
 305    *
 306    * @SINCE_1_0.0
 307    * @return The extension if available, NULL otherwise
 308    */
 309   virtual Extension* GetExtension()
 310   {
 311     return NULL;
 312   }
 313
 314 protected: // For derived classes
 315
 316   /**
 317    * @brief Flags for the constructor
 318    * @SINCE_1_0.0
 319    */
 320   enum ActorFlags
 321   {
 322     ACTOR_BEHAVIOUR_NONE          = 0,          ///< Use if no change to default behaviour is needed. @DEPRECATED_1_2_10
 323     ACTOR_BEHAVIOUR_DEFAULT       = 0,          ///< Use to provide default behaviour (size negotiation is on, event callbacks are not called). @SINCE_1_2_10
 324     DISABLE_SIZE_NEGOTIATION      = 1 << 0,     ///< True if control does not need size negotiation, i.e. it can be skipped in the algorithm @SINCE_1_0.0
 325     REQUIRES_TOUCH_EVENTS         = 1 << 1,     ///< True if the OnTouchEvent() callback is required. @SINCE_1_0.0
 326     REQUIRES_HOVER_EVENTS         = 1 << 2,     ///< True if the OnHoverEvent() callback is required. @SINCE_1_0.0
 327     REQUIRES_WHEEL_EVENTS   = 1 << 3,     ///< True if the OnWheelEvent() callback is required. @SINCE_1_0.0
 328
 329     LAST_ACTOR_FLAG                             ///< Special marker for last actor flag @SINCE_1_0.0
 330   };
 331
 332   static const int ACTOR_FLAG_COUNT = Log< LAST_ACTOR_FLAG - 1 >::value + 1;      ///< Value for deriving classes to continue on the flag enum
 333
 334   /**
 335    * @brief Create a CustomActorImpl.
 336    * @SINCE_1_0.0
 337    * @param[in] flags Bitfield of ActorFlags to define behaviour
 338    */
 339   CustomActorImpl( ActorFlags flags );
 340
 341   /**
 342    * @brief Virtual destructor
 343    * @SINCE_1_0.0
 344    */
 345   virtual ~CustomActorImpl();
 346
 347   // Size negotiation helpers
 348
 349   /**
 350    * @brief Request a relayout, which means performing a size negotiation on this actor, its parent and children (and potentially whole scene).
 351    *
 352    * This method can also be called from a derived class every time it needs a different size.
 353    * At the end of event processing, the relayout process starts and
 354    * all controls which requested Relayout will have their sizes (re)negotiated.
 355    *
 356    * @SINCE_1_0.0
 357    * @note RelayoutRequest() can be called multiple times; the size negotiation is still
 358    * only performed once, i.e. there is no need to keep track of this in the calling side.
 359    */
 360   void RelayoutRequest();
 361
 362   /**
 363    * @brief Provides the Actor implementation of GetHeightForWidth.
 364    * @SINCE_1_0.0
 365    * @param width Width to use.
 366    * @return The height based on the width.
 367    */
 368   float GetHeightForWidthBase( float width );
 369
 370   /**
 371    * @brief Provides the Actor implementation of GetWidthForHeight.
 372    * @SINCE_1_0.0
 373    * @param height Height to use.
 374    * @return The width based on the height.
 375    */
 376   float GetWidthForHeightBase( float height );
 377
 378   /**
 379    * @brief Calculate the size for a child using the base actor object.
 380    *
 381    * @SINCE_1_0.0
 382    * @param[in] child The child actor to calculate the size for
 383    * @param[in] dimension The dimension to calculate the size for. E.g. width or height
 384    * @return Return the calculated size for the given dimension. If more than one dimension is requested, just return the first one found.
 385    */
 386   float CalculateChildSizeBase( const Dali::Actor& child, Dimension::Type dimension );
 387
 388   /**
 389    * @brief Determine if this actor is dependent on it's children for relayout from the base class.
 390    *
 391    * @SINCE_1_0.0
 392    * @param dimension The dimension(s) to check for
 393    * @return Return if the actor is dependent on it's children.
 394    */
 395   bool RelayoutDependentOnChildrenBase( Dimension::Type dimension = Dimension::ALL_DIMENSIONS );
 396
 397 public: // Not intended for application developers
 398
 399   /**
 400    * @brief Initialize a CustomActor.
 401    * @SINCE_1_0.0
 402    * @param[in] owner The owning object
 403    * @pre The CustomActorImpl is not already owned.
 404    * @note Called when ownership of the CustomActorImpl is passed to a CustomActor.
 405    */
 406   void Initialize(Internal::CustomActor& owner);
 407
 408   /**
 409    * @brief Get the owner.
 410    *
 411    * This method is needed when creating additional handle objects to existing objects.
 412    * Owner is the Dali::Internal::CustomActor that owns the implementation of the custom actor
 413    * inside core. Creation of a handle to Dali public API Actor requires this pointer.
 414    * @SINCE_1_0.0
 415    * @return A pointer to the Actor implementation that owns this custom actor implementation
 416    */
 417   Internal::CustomActor* GetOwner() const;
 418
 419   /**
 420    * @brief Returns whether the OnTouchEvent() callback is required.
 421    * @SINCE_1_0.0
 422    * @return True if the OnTouchEvent() callback is required.
 423    * @note Called when ownership of the CustomActorImpl is passed to a CustomActor.
 424    */
 425   bool RequiresTouchEvents() const;
 426
 427   /**
 428    * @brief Returns whether the OnHoverEvent() callback is required.
 429    * @SINCE_1_0.0
 430    * @return True if the OnHoverEvent() callback is required.
 431    * @note Called when ownership of the CustomActorImpl is passed to a CustomActor.
 432    */
 433   bool RequiresHoverEvents() const;
 434
 435   /**
 436    * @brief Returns whether the OnWheelEvent() callback is required.
 437    * @SINCE_1_0.0
 438    * @return True if the OnWheelEvent() callback is required.
 439    * @note Called when ownership of the CustomActorImpl is passed to a CustomActor.
 440    */
 441   bool RequiresWheelEvents() const;
 442
 443   /**
 444    * @brief Returns whether relayout is enabled.
 445    * @SINCE_1_0.0
 446    * @return Return true if relayout is enabled on the custom actor.
 447    * @note Called when ownership of the CustomActorImpl is passed to a CustomActor.
 448    */
 449   bool IsRelayoutEnabled() const;
 450
 451 private:
 452
 453   Internal::CustomActor* mOwner;        ///< Internal owner of this custom actor implementation
 454   ActorFlags mFlags :ACTOR_FLAG_COUNT;  ///< ActorFlags flags to determine behaviour
 455 };
 456
 457 /**
 458  * @}
 459  */
 460 } // namespace Dali
 461
 462 #endif // __DALI_CUSTOM_ACTOR_IMPL_H__