capi/dali/public-api/animation/active-constraint.h

   1 #ifndef __DALI_ACTIVE_CONSTRAINT_H__
   2 #define __DALI_ACTIVE_CONSTRAINT_H__
   3
   4 //
   5 // Copyright (c) 2014 Samsung Electronics Co., Ltd.
   6 //
   7 // Licensed under the Flora License, Version 1.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://floralicense.org/license/
  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  * @addtogroup CAPI_DALI_ANIMATION_MODULE
  22  * @{
  23  */
  24
  25 // INTERNAL INCLUDES
  26 #include <dali/public-api/animation/active-constraint-declarations.h>
  27 #include <dali/public-api/object/handle.h>
  28 #include <dali/public-api/object/property.h>
  29
  30 namespace Dali DALI_IMPORT_API
  31 {
  32
  33 namespace Internal DALI_INTERNAL
  34 {
  35 class ActiveConstraintBase;
  36 }
  37
  38 /**
  39  * @brief A constraint which is being applied to an object.
  40  */
  41 class DALI_IMPORT_API ActiveConstraint : public Handle
  42 {
  43 public:
  44
  45   // Default Properties
  46   static const Property::Index WEIGHT; ///< Property 0, name "weight", type FLOAT
  47
  48   static const float FINAL_WEIGHT;   ///< 1.0f means the constraint is fully-applied, unless weight is still being animated
  49   static const float DEFAULT_WEIGHT; ///< 1.0f
  50
  51   //Signal Names
  52   static const char* const SIGNAL_APPLIED; ///< name "applied"
  53
  54   /**
  55    * @brief Create an uninitialized Constraint; this can be initialized with Constraint::New().
  56    *
  57    * Calling member functions with an uninitialized Dali::Object is not allowed.
  58    */
  59   ActiveConstraint();
  60
  61   /**
  62    * @brief Destructor.
  63    */
  64   virtual ~ActiveConstraint();
  65
  66   /**
  67    * @copydoc Dali::BaseHandle::operator=
  68    */
  69   using BaseHandle::operator=;
  70
  71   /**
  72    * @brief Retrieve the object which this constraint is targeting.
  73    *
  74    * @return The target object.
  75    */
  76   Handle GetTargetObject();
  77
  78   /**
  79    * @brief Retrieve the property which this constraint is targeting.
  80    *
  81    * @return The target property.
  82    */
  83   Property::Index GetTargetProperty();
  84
  85   /**
  86    * @brief Set the weight of the constraint; this is a value clamped between 0.
  87    * 0f and 1.0f.
  88    * The default is 1.0f.
  89    * 0.0f means the constraint has no effect, and 1.0f means the constraint is fully-applied.
  90    * @note This is an asynchronous method; the value written may not match a value subsequently read with GetCurrentWeight().
  91    * @param [in] weight The weight.
  92    */
  93   void SetWeight( float weight );
  94
  95   /**
  96    * @brief Retrieve the current weight of the constraint.
  97    *
  98    * @return The current weight.
  99    */
 100   float GetCurrentWeight() const;
 101
 102   /**
 103    * @brief This signal is emitted after the apply-time of the constraint has expired.
 104    *
 105    * @note A non-zero apply-time must have been set using Constraint::SetApplyTime().
 106    * @return A signal object to Connect() with.
 107    */
 108   ActiveConstraintSignalV2& AppliedSignal();
 109
 110 public: // Not intended for use by Application developers
 111
 112   /**
 113    * @brief This constructor is used by Dali New() methods.
 114    *
 115    * @param [in] constraint A pointer to a newly allocated Dali resource
 116    */
 117   explicit DALI_INTERNAL ActiveConstraint( Internal::ActiveConstraintBase* constraint );
 118 };
 119
 120 } // namespace Dali
 121
 122 /**
 123  * @}
 124  */
 125 #endif // __DALI_ACTIVE_CONSTRAINT_H__