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