1 #ifndef __DALI_INTERNAL_PROXY_OBJECT_H__
2 #define __DALI_INTERNAL_PROXY_OBJECT_H__
5 // Copyright (c) 2014 Samsung Electronics Co., Ltd.
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
11 // http://floralicense.org/license/
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.
24 #include <dali/public-api/common/dali-vector.h>
25 #include <dali/public-api/common/vector-wrapper.h>
26 #include <dali/public-api/animation/active-constraint.h>
27 #include <dali/public-api/animation/animation.h>
28 #include <dali/public-api/animation/constraint.h>
29 #include <dali/public-api/object/constrainable.h>
30 #include <dali/public-api/object/property-input.h>
31 #include <dali/public-api/object/property-notification.h>
32 #include <dali/internal/event/common/object-impl.h>
33 #include <dali/internal/event/common/custom-property.h>
34 #include <dali/internal/event/common/property-input-impl.h>
35 #include <dali/internal/update/common/property-base.h>
44 class PropertyInputImpl;
55 typedef std::vector< Dali::ActiveConstraint > ActiveConstraintContainer;
56 typedef ActiveConstraintContainer::iterator ActiveConstraintIter;
57 typedef ActiveConstraintContainer::const_iterator ActiveConstraintConstIter;
60 * A proxy for a property-owning object in the scene-graph.
61 * This provides an interface for observing the addition/removal of scene-objects.
63 * The concrete derived class is responsible for:
64 * 1) Adding & removing an object from the scene-graph. The OnSceneObjectAdd() and OnSceneObjectRemove()
65 * methods should be called by the derived class, to trigger observer callbacks.
66 * 3) Implementing the GetSceneObject() methods, used to access the scene-object.
67 * 4) Providing access to properties stored by the scene-graph object. These should match the properties
68 * reported by the base Dali::Internal::Object methods.
70 class ProxyObject : public Object
79 * Called immediately after the proxy has created & passed ownership of a scene-graph object.
80 * @param[in] proxy The proxy object.
82 virtual void SceneObjectAdded(ProxyObject& proxy) = 0;
85 * Called shortly before the proxy sends a message to remove its scene object.
86 * @param[in] proxy The proxy object.
88 virtual void SceneObjectRemoved(ProxyObject& proxy) = 0;
91 * Called shortly before the proxy itself is destroyed; no further callbacks will be received.
92 * @param[in] proxy The proxy object.
94 virtual void ProxyDestroyed(ProxyObject& proxy) = 0;
100 virtual ~Observer(){}
109 * Query whether the proxy object removes (& re-adds) its associated scene-object.
110 * Otherwise the scene-object lifetime is expected to match that of the proxy.
111 * @return True if scene-objects are removed.
113 virtual bool IsSceneObjectRemovable() const = 0;
116 * Add an observer to the proxy.
117 * @param[in] observer The observer to add.
119 virtual void AddObserver(Observer& observer);
122 * Remove an observer from the proxy
123 * @pre The observer has already been added.
124 * @param[in] observer The observer to remove.
126 virtual void RemoveObserver(Observer& observer);
129 * Retrieve the scene-graph object added by this proxy.
130 * @return A pointer to the object, or NULL if no object has been added to the scene-graph.
132 virtual const SceneGraph::PropertyOwner* GetSceneObject() const = 0;
135 * Retrieve an animatable property owned by the scene-graph object.
136 * @pre -1 < index < GetPropertyCount().
137 * @param[in] index The index of the property.
138 * @return A dereferenceable pointer to a property, or NULL if a scene-object does not exist with this property.
140 virtual const SceneGraph::PropertyBase* GetSceneObjectAnimatableProperty( Property::Index index ) const = 0;
143 * Retrieve an constraint input-property owned by the scene-graph object.
144 * @pre -1 < index < GetPropertyCount().
145 * @param[in] index The index of the property.
146 * @return A dereferenceable pointer to an input property, or NULL if a scene-object does not exist with this property.
148 virtual const PropertyInputImpl* GetSceneObjectInputProperty( Property::Index index ) const = 0;
151 * Query whether the property is a component of a scene-graph property.
152 * @pre -1 < index < GetPropertyCount().
153 * @param[in] index The index of the property.
154 * @return The index or Property::INVALID_COMPONENT_INDEX.
156 virtual int GetPropertyComponentIndex( Property::Index index ) const;
158 public: // Property system interface from Internal::Object
161 * @copydoc Dali::Internal::Object::Supports()
163 virtual bool Supports( Object::Capability capability ) const;
166 * @copydoc Dali::Internal::Object::GetPropertyCount()
168 virtual unsigned int GetPropertyCount() const;
171 * @copydoc Dali::Internal::Object::GetPropertyName()
173 virtual const std::string& GetPropertyName( Property::Index index ) const;
176 * @copydoc Dali::Internal::Object::GetPropertyIndex()
178 virtual Property::Index GetPropertyIndex(const std::string& name) const;
181 * @copydoc Dali::Internal::Object::IsPropertyWritable()
183 virtual bool IsPropertyWritable(Property::Index index) const;
186 * @copydoc Dali::Internal::Object::IsPropertyAnimatable()
188 virtual bool IsPropertyAnimatable(Property::Index index) const;
191 * @copydoc Dali::Internal::Object::IsPropertyAConstraintInput()
193 virtual bool IsPropertyAConstraintInput(Property::Index index) const;
196 * @copydoc Dali::Internal::Object::GetPropertyType()
198 virtual Property::Type GetPropertyType(Property::Index index) const;
201 * @copydoc Dali::Internal::Object::SetProperty()
203 virtual void SetProperty(Property::Index index, const Property::Value& propertyValue);
206 * @copydoc Dali::Internal::Object::GetProperty()
208 virtual Property::Value GetProperty(Property::Index index) const;
211 * @copydoc Dali::Handle::GetPropertyIndices()
213 virtual void GetPropertyIndices( Property::IndexContainer& indices ) const;
216 * @copydoc Dali::Internal::Object::RegisterProperty()
218 virtual Property::Index RegisterProperty(std::string name, const Property::Value& propertyValue);
221 * @copydoc Dali::Handle::RegisterProperty(std::string name, Property::Value propertyValue, Property::AccessMode accessMode)
223 virtual Property::Index RegisterProperty(std::string name, const Property::Value& propertyValue, Property::AccessMode accessMode);
226 * @copydoc Dali::Handle::AddPropertyNotification()
228 virtual Dali::PropertyNotification AddPropertyNotification(Property::Index index,
230 const Dali::PropertyCondition& condition);
233 * @copydoc Dali::Handle::RemovePropertyNotification()
235 virtual void RemovePropertyNotification(Dali::PropertyNotification propertyNotification);
238 * @copydoc Dali::Handle::RemovePropertyNotifications()
240 void RemovePropertyNotifications();
244 * Enable property notifications in scene graph
246 void EnablePropertyNotifications();
249 * Enable property notifications in scene graph
251 void DisablePropertyNotifications();
253 public: // Constraints
256 * Apply a constraint to a ProxyObject.
257 * @param[in] constraint The constraint to apply.
259 Dali::ActiveConstraint ApplyConstraint( Constraint& constraint );
262 * Apply a constraint to a ProxyObject.
263 * @param[in] constraint The constraint to apply.
264 * @param[in] weightObject An object with a "weight" float property.
266 Dali::ActiveConstraint ApplyConstraint( Constraint& constraint, Dali::Constrainable weightObject );
269 * Remove one constraint from a ProxyObject.
270 * @param[in] activeConstraint The active constraint to remove.
272 void RemoveConstraint( Dali::ActiveConstraint activeConstraint );
275 * Remove all constraints from a ProxyObject.
277 void RemoveConstraints();
280 * Remove all constraints from a ProxyObject with a matching tag
282 void RemoveConstraints( unsigned int tag );
287 * Called immediately by derived classes, after the scene-object has been created & passed to the scene-graph.
289 void OnSceneObjectAdd();
292 * Called by derived classes, shortly before send a message to remove the scene-object.
294 void OnSceneObjectRemove();
297 * A reference counted object may only be deleted by calling Unreference()
299 virtual ~ProxyObject();
304 ProxyObject(const ProxyObject&);
307 ProxyObject& operator=(const ProxyObject& rhs);
310 * Helper for ApplyConstraint overloads.
311 * @param[in] constraint The constraint to apply.
312 * @param[in] weightObject An object with a "weight" float property, or an empty handle.
313 * @return The new active-constraint which is owned by ProxyObject.
315 ActiveConstraintBase* DoApplyConstraint( Constraint& constraint, Dali::Constrainable weightObject );
318 * Helper to delete removed constraints
320 void DeleteRemovedConstraints();
323 * Helper to remove active constraints
325 void RemoveConstraint( ActiveConstraint& constraint, bool isInScenegraph );
328 private: // Default property extensions for derived classes
331 * Query how many default properties the derived class supports.
332 * @return The number of default properties.
334 virtual unsigned int GetDefaultPropertyCount() const = 0;
337 * Retrieve all the indices that are associated with the default properties supported by the derived class.
338 * @return A container of default property indices.
339 * @note The deriving class must not modify the existing elements in the container.
341 virtual void GetDefaultPropertyIndices( Property::IndexContainer& indices ) const = 0;
344 * Query how many default properties the derived class supports.
345 * @return The number of default properties.
347 virtual const std::string& GetDefaultPropertyName( Property::Index index ) const = 0;
350 * Query the index of a default property.
351 * @param [in] name The name of the property.
352 * @return The index of the property, or Property::INVALID_INDEX if no default property exists with the given name.
354 virtual Property::Index GetDefaultPropertyIndex( const std::string& name ) const = 0;
357 * Query whether a default property is writable.
358 * @param [in] index The index of the property.
359 * @return True if the property is animatable.
361 virtual bool IsDefaultPropertyWritable( Property::Index index ) const = 0;
364 * Query whether a default property is animatable.
365 * This determines whether the property can be the target of an animation or constraint.
366 * @param [in] index The index of the property.
367 * @return True if the property is animatable.
369 virtual bool IsDefaultPropertyAnimatable( Property::Index index ) const = 0;
372 * @brief Query whether a default property can be used as an input to a constraint.
374 * @param [in] index The index of the property.
375 * @return True if the property can be used as an input to a constraint.
377 virtual bool IsDefaultPropertyAConstraintInput( Property::Index index ) const = 0;
380 * Query the type of a default property.
381 * @param [in] index The index of the property.
382 * @return The type of the property.
384 virtual Property::Type GetDefaultPropertyType( Property::Index index ) const = 0;
387 * Set the value of a default property.
388 * @pre The property types match i.e. propertyValue.GetType() is equal to GetPropertyType(index).
389 * @param [in] index The index of the property.
390 * @param [in] propertyValue The new value of the property.
392 virtual void SetDefaultProperty( Property::Index index, const Property::Value& propertyValue ) = 0;
395 * Set the value of custom property.
396 * @param [in] index The index of the property.
397 * @param [in] entry An entry from the CustomPropertyLookup.
398 * @param [in] value The new value of the property.
400 virtual void SetCustomProperty( Property::Index index, const CustomProperty& entry, const Property::Value& value );
403 * Retrieve a default property value.
404 * @param [in] index The index of the property.
405 * @return The property value.
407 virtual Property::Value GetDefaultProperty( Property::Index index ) const = 0;
410 * Install a newly allocated scene-object property.
411 * The derived class is responsible for this, since the type of scene-object is not known to this base class.
412 * @param [in] newProperty A newly allocated scene-object property.
413 * @param [in] name The name allocated to this custom property.
414 * @param [in] index The index allocated to this custom property.
416 virtual void InstallSceneObjectProperty( SceneGraph::PropertyBase& newProperty, const std::string& name, unsigned int index ) = 0;
421 * Not all proxy objects will have custom properties so we want to only create the lookup when its actually needed
422 * @return the custom property lookup
424 CustomPropertyLookup& GetCustomPropertyLookup() const;
427 * Retrieves the TypeInfo for this object. Only retrieves it from the type-registry once and then stores a pointer
428 * to it locally there-after. The type info will not change during the life-time of the application.
429 * @return The type-info for this object (Can be NULL)
431 TypeInfo* GetTypeInfo() const;
435 Property::Index mNextCustomPropertyIndex; ///< The ID of the next custom property to be registered
437 mutable CustomPropertyLookup* mCustomProperties; ///< Used for accessing custom Node properties, mutable so it can be lazy initialized from const function
438 mutable TypeInfo* mTypeInfo; ///< The type-info for this object, mutable so it can be lazy initialized from const method if it is required
440 Dali::Vector<Observer*> mObservers;
442 ActiveConstraintContainer* mConstraints; ///< Container of owned active-constraints.
443 ActiveConstraintContainer* mRemovedConstraints; ///< Container of owned active-constraints, which are being removed.
445 typedef std::vector< Dali::PropertyNotification > PropertyNotificationContainer;
446 typedef PropertyNotificationContainer::iterator PropertyNotificationContainerIter;
447 typedef PropertyNotificationContainer::const_iterator PropertyNotificationContainerConstIter;
448 PropertyNotificationContainer* mPropertyNotifications; ///< Container of owned property notifications.
451 } // namespace Internal
453 inline Internal::ProxyObject& GetImplementation(Dali::Constrainable& object)
455 DALI_ASSERT_ALWAYS( object && "ProxyObject handle is empty" );
456 BaseObject& handle = object.GetBaseObject();
457 return static_cast<Internal::ProxyObject&>(handle);
460 inline const Internal::ProxyObject& GetImplementation(const Dali::Constrainable& object)
462 DALI_ASSERT_ALWAYS( object && "ProxyObject handle is empty" );
463 const BaseObject& handle = object.GetBaseObject();
464 return static_cast<const Internal::ProxyObject&>(handle);
470 #endif // __DALI_INTERNAL_PROXY_OBJECT_H__