Reducing boilerplate on default property metadata
[platform/core/uifw/dali-core.git] / dali / internal / event / animation / constrainer.h
1 #ifndef __DALI_INTERNAL_CONSTRAINER_H__
2 #define __DALI_INTERNAL_CONSTRAINER_H__
3
4 /*
5  * Copyright (c) 2018 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/internal/event/common/object-impl.h>
23 #include <dali/public-api/common/dali-vector.h>
24
25 namespace Dali
26 {
27
28 namespace Internal
29 {
30
31 typedef Dali::Vector<Object*>         ObjectContainer;
32 typedef ObjectContainer::Iterator     ObjectIter;
33
34 /**
35  * An abstract base class for constrainers.
36  * Constrainer base class is responsible or observing constrained objects and remove all the constraints created
37  * when it is destroyed
38  */
39 class Constrainer : public Object, public Object::Observer
40 {
41 public:
42
43   /**
44    * Constructor.
45    */
46   Constrainer();
47
48   /**
49    * Virtual destructor.
50    */
51   virtual ~Constrainer();
52
53 public: // Object methods
54
55   /**
56    * @copydoc Dali::Internal::Object::SetDefaultProperty()
57    */
58   virtual void SetDefaultProperty( Property::Index index, const Property::Value& propertyValue ){}
59
60   /**
61    * @copydoc Dali::Internal::Object::GetDefaultProperty()
62    */
63   virtual Property::Value GetDefaultProperty( Property::Index index ) const{return Property::Value();}
64
65   /**
66    * @copydoc Dali::Internal::Object::GetDefaultPropertyCurrentValue()
67    */
68   virtual Property::Value GetDefaultPropertyCurrentValue( Property::Index index ) const{return Property::Value();}
69
70   /**
71    * @copydoc Dali::Internal::Object::GetSceneObject()
72    */
73   virtual const SceneGraph::PropertyOwner* GetSceneObject() const{return 0;}
74
75   /**
76    * @copydoc Dali::Internal::Object::GetSceneObjectAnimatableProperty()
77    */
78   virtual const SceneGraph::PropertyBase* GetSceneObjectAnimatableProperty( Property::Index index ) const{return 0;}
79
80   /**
81    * @copydoc Dali::Internal::Object::GetSceneObjectInputProperty()
82    */
83   virtual const PropertyInputImpl* GetSceneObjectInputProperty( Property::Index index ) const{return 0;}
84
85 public: // Object::Observer methods
86
87   /**
88    * @copydoc Object::Observer::SceneObjectAdded()
89    */
90   virtual void SceneObjectAdded( Object& object ){}
91
92   /**
93    * @copydoc Object::Observer::SceneObjectRemoved()
94    */
95   virtual void SceneObjectRemoved( Object& object ){}
96
97   /**
98    * @copydoc Object::Observer::ObjectDestroyed()
99    */
100   virtual void ObjectDestroyed( Object& object );
101
102 public:
103
104   /**
105    * @brief Applies the constraint to the target property
106
107    * @param[in] target Property to be constrained
108    * @param[in] source Property used as parameter for the path
109    * @param[in] range The range of values in the source property which will be mapped to [0,1]
110    * @param[in] wrap Wrapping domain. Source property will be wrapped in the domain [wrap.x,wrap.y] before mapping to [0,1]
111    */
112   virtual void Apply( Property target, Property source, const Vector2& range, const Vector2& wrap) = 0;
113
114   /**
115    * @brief Removes the constraint in the target object
116    *
117    * @param[in] target A handle to an object constrained by the Constrainer
118    */
119   void Remove( Dali::Handle& target );
120
121 protected:
122
123   /**
124    * @brief Adds an object to the list of observed objects
125    *
126    * @param[in] handle A handle to the object to be observed
127    */
128   void Observe( Dali::Handle& handle );
129
130 private:
131
132   ObjectContainer   mObservedObjects;   ///< The list of object which have been constrained by the Constrainer
133 };
134
135 } // namespace Internal
136
137 } // namespace Dali
138
139 #endif // __DALI_INTERNAL_CONSTRAINER_H__