dali/internal/update/animation/scene-graph-constraint.h

   1 #ifndef __DALI_INTERNAL_SCENE_GRAPH_CONSTRAINT_H__
   2 #define __DALI_INTERNAL_SCENE_GRAPH_CONSTRAINT_H__
   3
   4 /*
   5  * Copyright (c) 2014 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/common/dali-common.h>
  23 #include <dali/public-api/signals/callback.h>
  24 #include <dali/internal/event/animation/property-constraint-ptr.h>
  25 #include <dali/internal/update/common/animatable-property.h>
  26 #include <dali/internal/update/common/property-owner.h>
  27 #include <dali/internal/update/animation/scene-graph-constraint-base.h>
  28 #include <dali/internal/render/common/performance-monitor.h>
  29
  30 namespace Dali
  31 {
  32
  33 namespace Internal
  34 {
  35
  36 namespace SceneGraph
  37 {
  38
  39 /**
  40  * Used to constrain a property of a scene-object.
  41  * The constraint function takes another scene-object property as an input.
  42  */
  43 template < class PropertyType, typename PropertyAccessorType >
  44 class Constraint : public ConstraintBase
  45 {
  46 public:
  47
  48   typedef typename PropertyConstraintPtr< PropertyType >::Type ConstraintFunctionPtr;
  49
  50   /**
  51    * Create a new scene-graph constraint.
  52    * @param[in] targetProperty The target property.
  53    * @param[in] ownerSet A set of property owners; func is connected to the properties provided by these objects.
  54    * @param[in] func The function to calculate the final constrained value.
  55    * @return A smart-pointer to a newly allocated constraint.
  56    */
  57   static ConstraintBase* New( const PropertyBase& targetProperty,
  58                               PropertyOwnerContainer& ownerContainer,
  59                               ConstraintFunctionPtr func )
  60   {
  61     // Scene-graph thread can edit these objects
  62     PropertyBase& property = const_cast< PropertyBase& >( targetProperty );
  63
  64     return new Constraint< PropertyType, PropertyAccessorType >( property,
  65                                                                  ownerContainer,
  66                                                                  func );
  67   }
  68
  69   /**
  70    * Virtual destructor.
  71    */
  72   virtual ~Constraint()
  73   {
  74   }
  75
  76   /**
  77    * @copydoc Dali::Internal::SceneGraph::ConstraintBase::Apply()
  78    */
  79   virtual void Apply( BufferIndex updateBufferIndex )
  80   {
  81     if ( mDisconnected )
  82     {
  83       return; // Early-out when property owners have been disconnected
  84     }
  85
  86     if ( mFunc->InputsInitialized() )
  87     {
  88       PropertyType current = mTargetProperty.Get( updateBufferIndex );
  89       mFunc->Apply( updateBufferIndex, current );
  90
  91       // Optionally bake the final value
  92       if ( Dali::Constraint::Bake == mRemoveAction )
  93       {
  94         mTargetProperty.Bake( updateBufferIndex, current );
  95       }
  96       else
  97       {
  98         mTargetProperty.Set( updateBufferIndex, current );
  99       }
 100
 101       INCREASE_COUNTER(PerformanceMonitor::CONSTRAINTS_APPLIED);
 102     }
 103     else
 104     {
 105       INCREASE_COUNTER(PerformanceMonitor::CONSTRAINTS_SKIPPED);
 106     }
 107   }
 108
 109 private:
 110
 111   /**
 112    * @copydoc Dali::Internal::SceneGraph::Constraint::New()
 113    */
 114   Constraint( PropertyBase& targetProperty,
 115               PropertyOwnerContainer& ownerContainer,
 116               ConstraintFunctionPtr func )
 117   : ConstraintBase( ownerContainer ),
 118     mTargetProperty( &targetProperty ),
 119     mFunc( func )
 120   {
 121   }
 122
 123   // Undefined
 124   Constraint( const Constraint& constraint );
 125
 126   // Undefined
 127   Constraint& operator=( const Constraint& rhs );
 128
 129   /**
 130    * @copydoc Dali::Internal::SceneGraph::ConstraintBase::OnDisconnect()
 131    */
 132   virtual void OnDisconnect()
 133   {
 134     // Discard target object/property pointers
 135     mTargetProperty.Reset();
 136     mFunc = NULL;
 137   }
 138
 139 protected:
 140
 141   PropertyAccessorType mTargetProperty; ///< Raw-pointer to the target property. Not owned.
 142
 143   ConstraintFunctionPtr mFunc;
 144 };
 145
 146 } // namespace SceneGraph
 147
 148 } // namespace Internal
 149
 150 } // namespace Dali
 151
 152 #endif // __DALI_INTERNAL_SCENE_GRAPH_CONSTRAINT_H__