dali/public-api/animation/constraint.h

   1 #ifndef DALI_CONSTRAINT_H
   2 #define DALI_CONSTRAINT_H
   3
   4 /*
   5  * Copyright (c) 2019 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/animation/constraint-source.h>
  26 #include <dali/public-api/common/dali-vector.h>
  27 #include <dali/public-api/object/base-handle.h>
  28 #include <dali/public-api/object/property.h>
  29 #include <dali/public-api/object/property-input.h>
  30 #include <dali/public-api/signals/callback.h>
  31
  32 namespace Dali
  33 {
  34 /**
  35  * @addtogroup dali_core_animation
  36  * @{
  37  */
  38
  39 class Handle;
  40
  41 namespace Internal DALI_INTERNAL
  42 {
  43 class ConstraintBase;
  44 }
  45
  46 typedef Vector< PropertyInput* > PropertyInputContainer;
  47
  48 /**
  49  * @brief An abstract base class for Constraints.
  50  *
  51  * This can be used to constrain a property of an object, after animations have been applied.
  52  * Constraints are applied in the following order:
  53  *   - Constraints are applied to on-stage actors in a depth-first traversal.
  54  *   - For each actor, the constraints are applied in the same order as the calls to Apply().
  55  *   - Constraints are not applied to off-stage actors.
  56  *
  57  * Create a constraint using one of the New methods depending on the type of callback function used.
  58  * Try to use a C function unless some data needs to be stored, otherwise functors and class methods
  59  * are also supported.
  60  *
  61  * A constraint can be applied to an object in the following manner:
  62  *
  63  * @code
  64  * Handle handle = CreateMyObject();
  65  * Constraint constraint = Constraint::New< Vector3 >( handle, CONSTRAINING_PROPERTY_INDEX, &MyFunction );
  66  * constraint.AddSource( LocalSource( INPUT_PROPERTY_INDEX ) );
  67  * constraint.Apply();
  68  * @endcode
  69  * @SINCE_1_0.0
  70  */
  71 class DALI_CORE_API Constraint : public BaseHandle
  72 {
  73 public:
  74
  75   /**
  76    * @brief Template for the Function that is called by the Constraint system.
  77    *
  78    * Supports:
  79    *  - C style functions
  80    *  - Static member methods of an object
  81    *  - Member functions of a particular class
  82    *  - Functors of a particular class
  83    *  - If a functor or method is provided, then a copy of the object is made.
  84    *
  85    * The expected signature of the callback should be:
  86    * @code
  87    *   void Function( P&, const PropertyInputContainer& );
  88    * @endcode
  89    *
  90    * The P& parameter is an in,out parameter which stores the current value of the property. The callback
  91    * should change this value to the desired one. The PropertyInputContainer is a const reference to the property inputs
  92    * added to the Constraint in the order they were added via AddSource().
  93    *
  94    * @SINCE_1_0.0
  95    * @tparam P The property type to constrain
  96    */
  97   template< typename P >
  98   class DALI_INTERNAL Function : public CallbackBase
  99   {
 100   public:
 101
 102     /**
 103      * @brief Constructor which connects to the provided C function (or a static member function).
 104      *
 105      * The expected signature of the function is:
 106      * @code
 107      *   void MyFunction( P&, const PropertyInputContainer& );
 108      * @endcode
 109      *
 110      * @SINCE_1_0.0
 111      * @param[in] function The function to call
 112      */
 113     Function( void( *function )( P&, const PropertyInputContainer& ) )
 114     : CallbackBase( reinterpret_cast< CallbackBase::Function >( function ) ),
 115       mCopyConstructorDispatcher( NULL )
 116     {
 117     }
 118
 119     /**
 120      * @brief Constructor which copies a function object and connects to the functor of that object.
 121      *
 122      * The function object should have a functor with the following signature:
 123      * @code
 124      *   void operator()( P&, const PropertyInputContainer& );
 125      * @endcode
 126      *
 127      * @SINCE_1_0.0
 128      * @param[in] object The object to copy
 129      * @tparam T The type of the object
 130      */
 131     template< class T >
 132     Function( const T& object )
 133     : CallbackBase( reinterpret_cast< void* >( new T( object ) ), // copy the object
 134                     NULL, // uses operator() instead of member function
 135                     reinterpret_cast< CallbackBase::Dispatcher >( &FunctorDispatcher2< T, P&, const PropertyInputContainer& >::Dispatch ),
 136                     reinterpret_cast< CallbackBase::Destructor >( &Destroyer< T >::Delete ) ),
 137       mCopyConstructorDispatcher( reinterpret_cast< CopyConstructorDispatcher >( &ObjectCopyConstructorDispatcher< T >::Copy ) )
 138     {
 139     }
 140
 141     /**
 142      * @brief Constructor which copies a function object and allows a connection to a member method.
 143      *
 144      * The object should have a method with the signature:
 145      * @code
 146      *   void MyObject::MyMethod( P&, const PropertyInputContainer& );
 147      * @endcode
 148      *
 149      * @SINCE_1_0.0
 150      * @param[in] object The object to copy
 151      * @param[in] memberFunction The member function to call. This has to be a member of the same class
 152      * @tparam T The type of the object
 153      */
 154     template< class T >
 155     Function( const T& object, void ( T::*memberFunction ) ( P&, const PropertyInputContainer& ) )
 156     : CallbackBase( reinterpret_cast< void* >( new T( object ) ), // copy the object
 157                     reinterpret_cast< CallbackBase::MemberFunction >( memberFunction ),
 158                     reinterpret_cast< CallbackBase::Dispatcher >( &Dispatcher2< T, P&, const PropertyInputContainer& >::Dispatch ),
 159                     reinterpret_cast< CallbackBase::Destructor >( &Destroyer< T >::Delete ) ),
 160       mCopyConstructorDispatcher( reinterpret_cast< CopyConstructorDispatcher >( &ObjectCopyConstructorDispatcher< T >::Copy ) )
 161     {
 162     }
 163
 164     /**
 165      * @brief Clones the Function object.
 166      *
 167      * The object, if held by this object, is also copied.
 168      *
 169      * @SINCE_1_0.0
 170      * @return A pointer to a newly-allocated Function
 171      */
 172     CallbackBase* Clone()
 173     {
 174       CallbackBase* callback = NULL;
 175       if ( mImpl && mImpl->mObjectPointer && mCopyConstructorDispatcher )
 176       {
 177         callback = new Function( mCopyConstructorDispatcher( reinterpret_cast< UndefinedClass* >( mImpl->mObjectPointer ) ) /* Copy the object */,
 178                                  mMemberFunction,
 179                                  mImpl->mMemberFunctionDispatcher,
 180                                  mImpl->mDestructorDispatcher,
 181                                  mCopyConstructorDispatcher );
 182       }
 183       else
 184       {
 185         callback = new Function( mFunction );
 186       }
 187       return callback;
 188     }
 189
 190   private:
 191
 192     /**
 193      * @brief Must not be declared.
 194      *
 195      * This is used so that no optimisations are done by the compiler when using void*.
 196      */
 197     class UndefinedClass;
 198
 199     /**
 200      * @brief Used to call the function to copy the stored object.
 201      * @SINCE_1_0.0
 202      */
 203     typedef UndefinedClass* (*CopyConstructorDispatcher) ( UndefinedClass* object );
 204
 205     /**
 206      * @brief Copies the actual object in Constraint::Function.
 207      *
 208      * @SINCE_1_0.0
 209          * @tparam T The type of the object
 210      */
 211     template< class T >
 212     struct ObjectCopyConstructorDispatcher
 213     {
 214       /**
 215        * @brief Copies the object stored in Constraint::Function.
 216        *
 217        * @SINCE_1_0.0
 218        * @param[in] object The object to copy
 219        * @return Newly allocated clone of the object
 220        */
 221       static UndefinedClass* Copy( const UndefinedClass* object )
 222       {
 223         T* copy = new T( *( reinterpret_cast< const T* >( object ) ) );
 224         return reinterpret_cast< UndefinedClass* >( copy );
 225       }
 226     };
 227
 228     /**
 229      * @brief Undefined copy constructor.
 230      * @SINCE_1_0.0
 231      */
 232     Function( const Function& );
 233
 234     /**
 235      * @brief Undefined assignment operator.
 236      * @SINCE_1_0.0
 237      */
 238     Function& operator=( const Function& );
 239
 240     /**
 241      * @brief Constructor used when copying the stored object.
 242      *
 243      * @SINCE_1_0.0
 244      * @param[in]  object                     A newly copied object
 245      * @param[in]  memberFunction             The member function of the object
 246      * @param[in]  dispatcher                 Used to call the actual object
 247      * @param[in]  destructor                 Used to delete the owned object
 248      * @param[in]  copyConstructorDispatcher  Used to create a copy of the owned object
 249      */
 250     Function( void* object,
 251               CallbackBase::MemberFunction memberFunction,
 252               CallbackBase::Dispatcher dispatcher,
 253               CallbackBase::Destructor destructor,
 254               CopyConstructorDispatcher copyConstructorDispatcher )
 255     : CallbackBase( object, memberFunction, dispatcher, destructor ),
 256       mCopyConstructorDispatcher( copyConstructorDispatcher )
 257     {
 258     }
 259
 260     /**
 261      * @brief Constructor used when copying a simple stored function.
 262      *
 263      * @SINCE_1_0.0
 264      * @param[in] function The function to call
 265      */
 266     Function( CallbackBase::Function function )
 267     : CallbackBase( function ),
 268       mCopyConstructorDispatcher( NULL )
 269     {
 270     }
 271
 272     // Data
 273
 274     CopyConstructorDispatcher mCopyConstructorDispatcher; ///< Function to call to copy the stored object
 275   };
 276
 277   /**
 278    * @brief Enumeration for the action that will happen when the constraint is removed.
 279    *
 280    * The final value may be "baked" i.e. saved permanently.
 281    * Alternatively the constrained value may be discarded when the constraint is removed.
 282    * @SINCE_1_0.0
 283    */
 284   enum RemoveAction
 285   {
 286     Bake,   ///< When the constraint is fully-applied, the constrained value is saved. @SINCE_1_0.0
 287     Discard ///< When the constraint is removed, the constrained value is discarded. @SINCE_1_0.0
 288   };
 289
 290   static const RemoveAction  DEFAULT_REMOVE_ACTION;  ///< Bake
 291
 292   /**
 293    * @brief Creates an uninitialized Constraint; this can be initialized with Constraint::New().
 294    *
 295    * Calling member functions with an uninitialized Constraint handle is not allowed.
 296    * @SINCE_1_0.0
 297    */
 298   Constraint();
 299
 300   /**
 301    * @brief Creates a constraint which targets a property using a function or a static class member.
 302    *
 303    * The expected signature, for a Vector3 type for example, of the function is:
 304    * @code
 305    *   void MyFunction( Vector3&, const PropertyInputContainer& );
 306    * @endcode
 307    *
 308    * Create the constraint with this function as follows:
 309    *
 310    * @code
 311    *   Constraint constraint = Constraint::New< Vector3 >( handle, CONSTRAINING_PROPERTY_INDEX, &MyFunction );
 312    * @endcode
 313    *
 314    * @SINCE_1_0.0
 315    * @param[in] handle      The handle to the property-owning object
 316    * @param[in] targetIndex The index of the property to constrain
 317    * @param[in] function    The function to call to set the constrained property value
 318    *
 319    * @tparam P The type of the property to constrain
 320    * @return The new constraint
 321    */
 322   template< class P >
 323   static Constraint New( Handle handle, Property::Index targetIndex, void( *function )( P&, const PropertyInputContainer& ) )
 324   {
 325     CallbackBase* callback = new Constraint::Function< P >( function );
 326     return New( handle, targetIndex, PropertyTypes::Get< P >(), callback );
 327   }
 328
 329   /**
 330    * @brief Creates a constraint which targets a property using a functor object.
 331    *
 332    * The expected structure, for a Vector3 type for example, of the functor object is:
 333    * @code
 334    *   struct MyObject
 335    *   {
 336    *     void operator() ( Vector3&, const PropertyInputContainer& );
 337    *   };
 338    * @endcode
 339    *
 340    * Create the constraint with this object as follows:
 341    *
 342    * @code
 343    *   Constraint constraint = Constraint::New< Vector3 >( handle, CONSTRAINING_PROPERTY_INDEX, MyObject() );
 344    * @endcode
 345    *
 346    * @SINCE_1_0.0
 347    * @param[in] handle      The handle to the property-owning object
 348    * @param[in] targetIndex The index of the property to constraint
 349    * @param[in] object      The functor object whose functor is called to set the constrained property value
 350    *
 351    * @tparam P The type of the property to constrain
 352    * @tparam T The type of the object
 353    * @return The new constraint
 354    */
 355   template< class P, class T >
 356   static Constraint New( Handle handle, Property::Index targetIndex, const T& object )
 357   {
 358     CallbackBase* function = new Constraint::Function< P >( object );
 359     return New( handle, targetIndex, PropertyTypes::Get< P >(), function );
 360   }
 361
 362   /**
 363    * @brief Creates a constraint which targets a property using an object method.
 364    *
 365    * The expected structure, for a Vector3 type for example, of the object is:
 366    * @code
 367    *   struct MyObject
 368    *   {
 369    *     void MyMethod( Vector3&, const PropertyInputContainer& );
 370    *   };
 371    * @endcode
 372    *
 373    * Create the constraint with this object as follows:
 374    *
 375    * @code
 376    *   Constraint constraint = Constraint::New< Vector3 >( handle, CONSTRAINING_PROPERTY_INDEX, MyObject(), &MyObject::MyMethod );
 377    * @endcode
 378    *
 379    * @SINCE_1_0.0
 380    * @param[in] handle         The handle to the property-owning object
 381    * @param[in] targetIndex    The index of the property to constraint
 382    * @param[in] object         The object whose member function is called to set the constrained property value
 383    * @param[in] memberFunction The member function to call to set the constrained property value
 384    * @return The new constraint
 385    *
 386    * @tparam P The type of the property to constrain
 387    * @tparam T The type of the object
 388    */
 389   template< class P, class T >
 390   static Constraint New( Handle handle, Property::Index targetIndex, const T& object, void ( T::*memberFunction ) ( P&, const PropertyInputContainer& ) )
 391   {
 392     CallbackBase* function = new Constraint::Function< P >( object, memberFunction );
 393     return New( handle, targetIndex, PropertyTypes::Get< P >(), function );
 394   }
 395
 396   /**
 397    * @brief Creates a clone of this constraint for another object.
 398    *
 399    * @SINCE_1_0.0
 400    * @param[in] handle The handle to the property-owning object this constraint is to be cloned for
 401    * @return The new constraint
 402    */
 403   Constraint Clone( Handle handle );
 404
 405   /**
 406    * @brief Destructor.
 407    *
 408    * This is non-virtual since derived Handle types must not contain data or virtual methods.
 409    * @SINCE_1_0.0
 410    */
 411   ~Constraint();
 412
 413   /**
 414    * @brief This copy constructor is required for (smart) pointer semantics.
 415    *
 416    * @SINCE_1_0.0
 417    * @param[in] constraint A reference to the copied handle
 418    */
 419   Constraint( const Constraint& constraint );
 420
 421   /**
 422    * @brief This assignment operator is required for (smart) pointer semantics.
 423    *
 424    * @SINCE_1_0.0
 425    * @param[in] rhs A reference to the copied handle
 426    * @return A reference to this
 427    */
 428   Constraint& operator=( const Constraint& rhs );
 429
 430   /**
 431    * @brief Downcasts a handle to Constraint handle.
 432    *
 433    * If handle points to a Constraint object, the downcast produces valid handle.
 434    * If not, the returned handle is left uninitialized.
 435    * @SINCE_1_0.0
 436    * @param[in] baseHandle BaseHandle to an object
 437    * @return Handle to a Constraint object or an uninitialized handle
 438    */
 439   static Constraint DownCast( BaseHandle baseHandle );
 440
 441   /**
 442    * @brief Adds a constraint source to the constraint.
 443    *
 444    * @SINCE_1_0.0
 445    * @param[in] source The constraint source input to add
 446    */
 447   void AddSource( ConstraintSource source );
 448
 449   /**
 450    * @brief Applies this constraint.
 451    *
 452    * @SINCE_1_0.0
 453    * @pre The constraint must be initialized.
 454    * @pre The target object must still be alive.
 455    * @pre The source inputs should not have been destroyed.
 456    */
 457   void Apply();
 458
 459   /**
 460    * @brief Removes this constraint.
 461    * @SINCE_1_0.0
 462    */
 463   void Remove();
 464
 465   /**
 466    * @brief Retrieves the object which this constraint is targeting.
 467    *
 468    * @SINCE_1_0.0
 469    * @return The target object
 470    */
 471   Handle GetTargetObject();
 472
 473   /**
 474    * @brief Retrieves the property which this constraint is targeting.
 475    *
 476    * @SINCE_1_0.0
 477    * @return The target property
 478    */
 479   Dali::Property::Index GetTargetProperty();
 480
 481   /**
 482    * @brief Sets the remove action. Constraint::Bake will "bake" a value when fully-applied.
 483    *
 484    * In case of Constraint::Discard, the constrained value will be discarded, when the constraint is removed.
 485    * The default value is Constraint::Bake.
 486    * @SINCE_1_0.0
 487    * @param[in] action The remove-action
 488    */
 489   void SetRemoveAction( RemoveAction action );
 490
 491   /**
 492    * @brief Retrieves the remove action that will happen when the constraint is removed.
 493    *
 494    * @SINCE_1_0.0
 495    * @return The remove-action
 496    */
 497   RemoveAction GetRemoveAction() const;
 498
 499   /**
 500    * @brief Sets a tag for the constraint so it can be identified later.
 501    *
 502    * @SINCE_1_0.0
 503    * @param[in] tag An integer to identify the constraint
 504    */
 505   void SetTag( const uint32_t tag );
 506
 507   /**
 508    * @brief Gets the tag.
 509    *
 510    * @SINCE_1_0.0
 511    * @return The tag
 512    */
 513   uint32_t GetTag() const;
 514
 515 public: // Not intended for use by Application developers
 516
 517   /// @cond internal
 518   /**
 519    * @brief This constructor is used by Constraint::New() methods.
 520    * @SINCE_1_0.0
 521    * @param[in] constraint A pointer to a newly allocated Dali resource
 522    */
 523   explicit DALI_INTERNAL Constraint( Internal::ConstraintBase* constraint );
 524   /// @endcond
 525
 526 private: // Not intended for use by Application developers
 527
 528   /// @cond internal
 529   /**
 530    * @brief Constructs a new constraint which targets a property.
 531    *
 532    * @SINCE_1_0.0
 533    * @param[in]  handle       The handle to the property-owning object
 534    * @param[in]  targetIndex  The index of the property to constrain
 535    * @param[in]  targetType   Type The type of the constrained property
 536    * @param[in]  function     The constraint function
 537    * @return The new constraint
 538    */
 539   static Constraint New( Handle handle, Property::Index targetIndex, Property::Type targetType, CallbackBase* function );
 540   /// @endcond
 541 };
 542
 543 /**
 544  * @}
 545  */
 546 } // namespace Dali
 547
 548 #endif // DALI_CONSTRAINT_H