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 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
11 * http://www.apache.org/licenses/LICENSE-2.0
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.
25 #include <dali/public-api/animation/active-constraint.h>
26 #include <dali/public-api/animation/constraint.h>
27 #include <dali/public-api/common/dali-vector.h>
28 #include <dali/public-api/common/vector-wrapper.h>
29 #include <dali/public-api/object/constrainable.h>
30 #include <dali/public-api/object/property-index.h>
31 #include <dali/public-api/object/property-input.h>
32 #include <dali/public-api/object/property-notification.h>
33 #include <dali/internal/common/owner-container.h>
34 #include <dali/internal/event/common/object-impl.h>
35 #include <dali/internal/event/common/custom-property.h>
36 #include <dali/internal/event/common/property-input-impl.h>
37 #include <dali/internal/update/common/property-base.h>
46 class PropertyInputImpl;
52 * @brief Structure for setting up default properties and their details.
54 struct PropertyDetails
56 const char* name; ///< The name of the property.
57 Property::Type type; ///< The property type.
58 bool writable:1; ///< Whether the property is writable
59 bool animatable:1; ///< Whether the property is animatable.
60 bool constraintInput:1; ///< Whether the property can be used as an input to a constraint.
69 typedef std::vector< Dali::ActiveConstraint > ActiveConstraintContainer;
70 typedef ActiveConstraintContainer::iterator ActiveConstraintIter;
71 typedef ActiveConstraintContainer::const_iterator ActiveConstraintConstIter;
74 * A proxy for a property-owning object in the scene-graph.
75 * This provides an interface for observing the addition/removal of scene-objects.
77 * The concrete derived class is responsible for:
78 * 1) Adding & removing an object from the scene-graph. The OnSceneObjectAdd() and OnSceneObjectRemove()
79 * methods should be called by the derived class, to trigger observer callbacks.
80 * 3) Implementing the GetSceneObject() methods, used to access the scene-object.
81 * 4) Providing access to properties stored by the scene-graph object. These should match the properties
82 * reported by the base Dali::Internal::Object methods.
84 class ProxyObject : public Object
93 * Called immediately after the proxy has created & passed ownership of a scene-graph object.
94 * @param[in] proxy The proxy object.
96 virtual void SceneObjectAdded(ProxyObject& proxy) = 0;
99 * Called shortly before the proxy sends a message to remove its scene object.
100 * @param[in] proxy The proxy object.
102 virtual void SceneObjectRemoved(ProxyObject& proxy) = 0;
105 * Called shortly before the proxy itself is destroyed; no further callbacks will be received.
106 * @param[in] proxy The proxy object.
108 virtual void ProxyDestroyed(ProxyObject& proxy) = 0;
114 virtual ~Observer(){}
123 * Add an observer to the proxy.
124 * @param[in] observer The observer to add.
126 virtual void AddObserver( Observer& observer );
129 * Remove an observer from the proxy
130 * @pre The observer has already been added.
131 * @param[in] observer The observer to remove.
133 virtual void RemoveObserver( Observer& observer );
136 * Retrieve the scene-graph object added by this proxy.
137 * @return A pointer to the object, or NULL if no object has been added to the scene-graph.
139 virtual const SceneGraph::PropertyOwner* GetSceneObject() const = 0;
142 * Retrieve an animatable property owned by the scene-graph object.
143 * @pre -1 < index < GetPropertyCount().
144 * @param[in] index The index of the property.
145 * @return A dereferenceable pointer to a property, or NULL if a scene-object does not exist with this property.
147 virtual const SceneGraph::PropertyBase* GetSceneObjectAnimatableProperty( Property::Index index ) const = 0;
150 * Retrieve an constraint input-property owned by the scene-graph object.
151 * @pre -1 < index < GetPropertyCount().
152 * @param[in] index The index of the property.
153 * @return A dereferenceable pointer to an input property, or NULL if a scene-object does not exist with this property.
155 virtual const PropertyInputImpl* GetSceneObjectInputProperty( Property::Index index ) const = 0;
158 * Query whether the property is a component of a scene-graph property.
159 * @pre -1 < index < GetPropertyCount().
160 * @param[in] index The index of the property.
161 * @return The index or Property::INVALID_COMPONENT_INDEX.
163 virtual int GetPropertyComponentIndex( Property::Index index ) const;
165 public: // Property system interface from Internal::Object
168 * @copydoc Dali::Internal::Object::Supports()
170 virtual bool Supports( Object::Capability capability ) const;
173 * @copydoc Dali::Internal::Object::GetPropertyCount()
175 virtual unsigned int GetPropertyCount() const;
178 * @copydoc Dali::Internal::Object::GetPropertyName()
180 virtual std::string GetPropertyName( Property::Index index ) const;
183 * @copydoc Dali::Internal::Object::GetPropertyIndex()
185 virtual Property::Index GetPropertyIndex( const std::string& name ) const;
188 * @copydoc Dali::Internal::Object::IsPropertyWritable()
190 virtual bool IsPropertyWritable( Property::Index index ) const;
193 * @copydoc Dali::Internal::Object::IsPropertyAnimatable()
195 virtual bool IsPropertyAnimatable( Property::Index index ) const;
198 * @copydoc Dali::Internal::Object::IsPropertyAConstraintInput()
200 virtual bool IsPropertyAConstraintInput( Property::Index index ) const;
203 * @copydoc Dali::Internal::Object::GetPropertyType()
205 virtual Property::Type GetPropertyType( Property::Index index ) const;
208 * @copydoc Dali::Internal::Object::SetProperty()
210 virtual void SetProperty( Property::Index index, const Property::Value& propertyValue );
213 * @copydoc Dali::Internal::Object::GetProperty()
215 virtual Property::Value GetProperty( Property::Index index ) const;
218 * @copydoc Dali::Handle::GetPropertyIndices()
220 virtual void GetPropertyIndices( Property::IndexContainer& indices ) const;
223 * @copydoc Dali::Internal::Object::RegisterProperty()
225 virtual Property::Index RegisterProperty( const std::string& name, const Property::Value& propertyValue );
228 * @copydoc Dali::Internal::Object::RegisterProperty(std::string name, Property::Value propertyValue, Property::AccessMode accessMode)
230 virtual Property::Index RegisterProperty( const std::string& name, const Property::Value& propertyValue, Property::AccessMode accessMode );
233 * @copydoc Dali::Internal::Object::AddPropertyNotification()
235 virtual Dali::PropertyNotification AddPropertyNotification( Property::Index index,
237 const Dali::PropertyCondition& condition );
240 * @copydoc Dali::Internal::Object::RemovePropertyNotification()
242 virtual void RemovePropertyNotification( Dali::PropertyNotification propertyNotification );
245 * @copydoc Dali::Internal::Object::RemovePropertyNotifications()
247 void RemovePropertyNotifications();
252 * Enable property notifications in scene graph
254 void EnablePropertyNotifications();
257 * Enable property notifications in scene graph
259 void DisablePropertyNotifications();
261 public: // Constraints
264 * Apply a constraint to a ProxyObject.
265 * @param[in] constraint The constraint to apply.
267 Dali::ActiveConstraint ApplyConstraint( Constraint& constraint );
270 * Apply a constraint to a ProxyObject.
271 * @param[in] constraint The constraint to apply.
272 * @param[in] weightObject An object with a "weight" float property.
274 Dali::ActiveConstraint ApplyConstraint( Constraint& constraint, Dali::Constrainable weightObject );
277 * Remove one constraint from a ProxyObject.
278 * @param[in] activeConstraint The active constraint to remove.
280 void RemoveConstraint( Dali::ActiveConstraint activeConstraint );
283 * Remove all constraints from a ProxyObject.
285 void RemoveConstraints();
288 * Remove all constraints from a ProxyObject with a matching tag
290 void RemoveConstraints( unsigned int tag );
295 * Called by TypeInfo to set the type-info that this proxy-object is created by.
296 * @param[in] typeInfo The TypeInfo that creates this proxy-object.
298 void SetTypeInfo( const TypeInfo* typeInfo );
301 * @return the index from which custom properties start
303 unsigned int CustomPropertyStartIndex()
305 return PROPERTY_CUSTOM_START_INDEX;
311 * Called immediately by derived classes, after the scene-object has been created & passed to the scene-graph.
313 void OnSceneObjectAdd();
316 * Called by derived classes, shortly before send a message to remove the scene-object.
318 void OnSceneObjectRemove();
321 * A reference counted object may only be deleted by calling Unreference()
323 virtual ~ProxyObject();
328 ProxyObject( const ProxyObject& );
331 ProxyObject& operator=( const ProxyObject& rhs );
334 * Helper for ApplyConstraint overloads.
335 * @param[in] constraint The constraint to apply.
336 * @param[in] weightObject An object with a "weight" float property, or an empty handle.
337 * @return The new active-constraint which is owned by ProxyObject.
339 ActiveConstraintBase* DoApplyConstraint( Constraint& constraint, Dali::Constrainable weightObject );
342 * Helper to remove active constraints
344 void RemoveConstraint( ActiveConstraint& constraint, bool isInScenegraph );
347 * Set the value of scene graph property.
348 * @param [in] index The index of the property.
349 * @param [in] entry An entry from the CustomPropertyLookup.
350 * @param [in] value The new value of the property.
352 virtual void SetSceneGraphProperty( Property::Index index, const CustomProperty& entry, const Property::Value& value );
354 private: // Default property extensions for derived classes
357 * Query how many default properties the derived class supports.
358 * @return The number of default properties.
360 virtual unsigned int GetDefaultPropertyCount() const = 0;
363 * Retrieve all the indices that are associated with the default properties supported by the derived class.
364 * @return A container of default property indices.
365 * @note The deriving class must not modify the existing elements in the container.
367 virtual void GetDefaultPropertyIndices( Property::IndexContainer& indices ) const = 0;
370 * Query how many default properties the derived class supports.
371 * @return The number of default properties.
373 virtual const char* GetDefaultPropertyName( Property::Index index ) const = 0;
376 * Query the index of a default property.
377 * @param [in] name The name of the property.
378 * @return The index of the property, or Property::INVALID_INDEX if no default property exists with the given name.
380 virtual Property::Index GetDefaultPropertyIndex( const std::string& name ) const = 0;
383 * Query whether a default property is writable.
384 * @param [in] index The index of the property.
385 * @return True if the property is animatable.
387 virtual bool IsDefaultPropertyWritable( Property::Index index ) const = 0;
390 * Query whether a default property is animatable.
391 * This determines whether the property can be the target of an animation or constraint.
392 * @param [in] index The index of the property.
393 * @return True if the property is animatable.
395 virtual bool IsDefaultPropertyAnimatable( Property::Index index ) const = 0;
398 * @brief Query whether a default property can be used as an input to a constraint.
400 * @param [in] index The index of the property.
401 * @return True if the property can be used as an input to a constraint.
403 virtual bool IsDefaultPropertyAConstraintInput( Property::Index index ) const = 0;
406 * Query the type of a default property.
407 * @param [in] index The index of the property.
408 * @return The type of the property.
410 virtual Property::Type GetDefaultPropertyType( Property::Index index ) const = 0;
413 * Set the value of a default property.
414 * @pre The property types match i.e. propertyValue.GetType() is equal to GetPropertyType(index).
415 * @param [in] index The index of the property.
416 * @param [in] propertyValue The new value of the property.
418 virtual void SetDefaultProperty( Property::Index index, const Property::Value& propertyValue ) = 0;
421 * Retrieve a default property value.
422 * @param [in] index The index of the property.
423 * @return The property value.
425 virtual Property::Value GetDefaultProperty( Property::Index index ) const = 0;
428 * @todo this is virtual so that for now actor can override it,
429 * it needs to be removed and only have GetSceneObject but that requires changing actor and constraint logic
430 * Retrieve the scene-graph object added by this proxy.
431 * @return A pointer to the object, or NULL if no object has been added to the scene-graph.
433 virtual const SceneGraph::PropertyOwner* GetPropertyOwner() const
435 return GetSceneObject();
439 * Notify derived class of installation of a new scene-object property.
440 * This method is called after the message is to sent to install the property
441 * @param [in] newProperty A newly allocated scene-object property. Ownership is obviously not passed.
442 * @param [in] name The name allocated to this custom property.
443 * @param [in] index The index allocated to this custom property.
445 virtual void NotifyScenePropertyInstalled( const SceneGraph::PropertyBase& newProperty, const std::string& name, unsigned int index )
451 * For use in derived classes.
452 * This is called after a non animatable custom property is set.
453 * @param [in] index The index of the property.
454 * @param [in] propertyValue The value of the property.
456 virtual void OnPropertySet( Property::Index index, Property::Value propertyValue ) {}
459 * Retrieves the TypeInfo for this object. Only retrieves it from the type-registry once and then stores a pointer
460 * to it locally there-after. The type info will not change during the life-time of the application.
461 * @return The type-info for this object (Can be NULL)
463 const TypeInfo* GetTypeInfo() const;
466 * Helper to find custom property
468 * @return pointer to the property
470 CustomProperty* FindCustomProperty( Property::Index index ) const;
474 typedef OwnerContainer<CustomProperty*> CustomPropertyLookup;
475 CustomPropertyLookup mCustomProperties; ///< Used for accessing custom Node properties
476 mutable TypeInfo const * mTypeInfo; ///< The type-info for this object, mutable so it can be lazy initialized from const method if it is required
478 Dali::Vector<Observer*> mObservers;
480 ActiveConstraintContainer* mConstraints; ///< Container of owned active-constraints.
482 typedef std::vector< Dali::PropertyNotification > PropertyNotificationContainer;
483 typedef PropertyNotificationContainer::iterator PropertyNotificationContainerIter;
484 typedef PropertyNotificationContainer::const_iterator PropertyNotificationContainerConstIter;
485 PropertyNotificationContainer* mPropertyNotifications; ///< Container of owned property notifications.
488 } // namespace Internal
490 inline Internal::ProxyObject& GetImplementation(Dali::Constrainable& object)
492 DALI_ASSERT_ALWAYS( object && "ProxyObject handle is empty" );
493 BaseObject& handle = object.GetBaseObject();
494 return static_cast<Internal::ProxyObject&>(handle);
497 inline const Internal::ProxyObject& GetImplementation(const Dali::Constrainable& object)
499 DALI_ASSERT_ALWAYS( object && "ProxyObject handle is empty" );
500 const BaseObject& handle = object.GetBaseObject();
501 return static_cast<const Internal::ProxyObject&>(handle);
507 #endif // __DALI_INTERNAL_PROXY_OBJECT_H__