1 #ifndef __DALI_INTERNAL_OBJECT_H__
2 #define __DALI_INTERNAL_OBJECT_H__
5 * Copyright (c) 2017 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.
22 #include <dali/public-api/animation/constraint.h>
23 #include <dali/public-api/common/dali-vector.h>
24 #include <dali/public-api/common/vector-wrapper.h>
25 #include <dali/public-api/object/base-object.h>
26 #include <dali/public-api/object/handle.h>
27 #include <dali/public-api/object/property.h>
28 #include <dali/public-api/object/property-index-ranges.h>
29 #include <dali/public-api/object/property-input.h>
30 #include <dali/public-api/object/property-notification.h>
31 #include <dali/devel-api/common/owner-container.h>
32 #include <dali/internal/event/animation/animation-impl.h>
33 #include <dali/internal/event/common/event-thread-services.h>
34 #include <dali/internal/event/common/property-input-impl.h>
35 #include <dali/internal/event/common/property-metadata.h>
36 #include <dali/internal/update/common/property-base.h>
41 class PropertyNotification;
46 class EventThreadServices;
48 class PropertyCondition;
49 class PropertyInputImpl;
59 typedef std::vector< Dali::Constraint > ConstraintContainer;
60 typedef ConstraintContainer::iterator ConstraintIter;
61 typedef ConstraintContainer::const_iterator ConstraintConstIter;
65 * A base class for objects which optionally provide properties.
66 * The concrete derived class is responsible for implementing the property system methods.
67 * Classes may derive from Dali::BaseObject, until any properties are required.
69 * An object for a property-owning object in the scene-graph.
70 * This provides an interface for observing the addition/removal of scene-objects.
72 * The concrete derived class is responsible for:
73 * 1) Adding & removing an object from the scene-graph. The OnSceneObjectAdd() and OnSceneObjectRemove()
74 * methods should be called by the derived class, to trigger observer callbacks.
75 * 3) Implementing the GetSceneObject() methods, used to access the scene-object.
76 * 4) Providing access to properties stored by the scene-graph object. These should match the properties
77 * reported by the base Dali::Internal::Object methods.
80 class Object : public Dali::BaseObject
84 typedef Dali::Handle::Capability Capability;
91 * Called immediately after the object has created & passed ownership of a scene-graph object.
92 * @param[in] object The object object.
94 virtual void SceneObjectAdded(Object& object) = 0;
97 * Called shortly before the object sends a message to remove its scene object.
98 * @param[in] object The object object.
100 virtual void SceneObjectRemoved(Object& object) = 0;
103 * Called shortly before the object itself is destroyed; no further callbacks will be received.
104 * @param[in] object The object object.
106 virtual void ObjectDestroyed(Object& object) = 0;
113 virtual ~Observer(){}
122 * Add an observer to the object.
123 * @param[in] observer The observer to add.
125 virtual void AddObserver( Observer& observer );
128 * Remove an observer from the object
129 * @pre The observer has already been added.
130 * @param[in] observer The observer to remove.
132 virtual void RemoveObserver( Observer& observer );
135 * @copydoc Dali::Handle::Supports()
137 virtual bool Supports( Capability capability ) const;
140 * @copydoc Dali::Handle::GetPropertyCount()
142 virtual unsigned int GetPropertyCount() const;
145 * @copydoc Dali::Handle::GetPropertyName()
147 virtual std::string GetPropertyName( Property::Index index ) const;
150 * @copydoc Dali::Handle::GetPropertyIndex()
152 virtual Property::Index GetPropertyIndex( const std::string& name ) const;
155 * @copydoc Dali::Handle::GetPropertyIndex()
157 virtual Property::Index GetPropertyIndex( Property::Index key ) const;
160 * @copydoc Dali::Handle::GetPropertyIndex()
162 virtual Property::Index GetPropertyIndex( Property::Key key ) const;
165 * @copydoc Dali::Handle::IsPropertyWritable()
167 virtual bool IsPropertyWritable( Property::Index index ) const;
170 * @copydoc Dali::Handle::IsPropertyAnimatable()
172 virtual bool IsPropertyAnimatable( Property::Index index ) const;
175 * @copydoc Dali::Handle::IsPropertyAConstraintInput()
177 virtual bool IsPropertyAConstraintInput( Property::Index index ) const;
180 * @copydoc Dali::Handle::GetPropertyType()
182 virtual Property::Type GetPropertyType( Property::Index index ) const;
185 * @copydoc Dali::Handle::SetProperty()
187 virtual void SetProperty( Property::Index index, const Property::Value& propertyValue );
190 * @copydoc Dali::Handle::GetProperty()
192 virtual Property::Value GetProperty( Property::Index index ) const;
195 * @brief Retrieves the latest value of the property on the scene-graph.
196 * @param[in] index The index of the property required.
197 * @return The latest value of the property on the scene-graph.
199 virtual Property::Value GetCurrentProperty( Property::Index index ) const;
202 * @copydoc Dali::Handle::GetPropertyIndices()
204 virtual void GetPropertyIndices( Property::IndexContainer& indices ) const;
207 * @copydoc Dali::Handle::RegisterProperty()
209 virtual Property::Index RegisterProperty( const std::string& name, const Property::Value& propertyValue );
212 * @copydoc Dali::Handle::RegisterProperty()
214 virtual Property::Index RegisterProperty( const std::string& name, Property::Index key, const Property::Value& propertyValue );
217 * @copydoc Dali::Handle::RegisterProperty(std::string name, Property::Value propertyValue, Property::AccessMode accessMode)
219 virtual Property::Index RegisterProperty( const std::string& name, const Property::Value& propertyValue, Property::AccessMode accessMode );
222 * @brief Implementing method for this override
224 virtual Property::Index RegisterProperty( const std::string& name, Property::Index key, const Property::Value& propertyValue, Property::AccessMode accessMode );
227 * @copydoc Dali::Handle::AddPropertyNotification()
229 virtual Dali::PropertyNotification AddPropertyNotification( Property::Index index,
231 const Dali::PropertyCondition& condition );
234 * @copydoc Dali::Handle::RemovePropertyNotification()
236 virtual void RemovePropertyNotification( Dali::PropertyNotification propertyNotification );
239 * @copydoc Dali::Handle::RemovePropertyNotifications()
241 virtual void RemovePropertyNotifications();
244 * Notifies that a property is being animated.
245 * @param[in] animation The animation animating the property.
246 * @param[in] index The index of the property.
247 * @param[in] value The value of the property after the animation.
248 * @param[in] animationType Whether the property value given is the target or a relative value.
250 void NotifyPropertyAnimation( Animation& animation, Property::Index index, const Property::Value& value, Animation::Type animationType );
252 /******************************** Uniform Mappings ********************************/
255 * @copydoc Dali::Handle::AddUniformMapping()
257 void AddUniformMapping( Property::Index propertyIndex, const std::string& uniformName ) const;
260 * @copydoc Dali::Handle::RemoveUniformMapping( )
262 void RemoveUniformMapping( const std::string& uniformName );
264 /******************************** Constraints ********************************/
267 * Apply a constraint to an Object.
268 * @param[in] constraint The constraint to apply.
270 void ApplyConstraint( ConstraintBase& constraint );
273 * Remove one constraint from an Object.
274 * @param[in] constraint The constraint to remove.
276 void RemoveConstraint( ConstraintBase& constraint );
279 * Remove all constraints from a Object.
281 void RemoveConstraints();
284 * Remove all constraints from a Object with a matching tag
286 void RemoveConstraints( unsigned int tag );
289 * Called by TypeInfo to set the type-info that this object-impl is created by.
290 * @param[in] typeInfo The TypeInfo that creates this object-impl.
292 void SetTypeInfo( const TypeInfo* typeInfo );
295 * @return the index from which custom properties start
297 unsigned int CustomPropertyStartIndex()
299 return PROPERTY_CUSTOM_START_INDEX;
302 /******************** To be overridden by deriving classes ********************/
305 * Retrieve the scene-graph object added by this object.
306 * @return A pointer to the object, or NULL if no object has been added to the scene-graph.
308 virtual const SceneGraph::PropertyOwner* GetSceneObject() const = 0;
311 * Retrieve an animatable property owned by the scene-graph object.
312 * @pre -1 < index < GetPropertyCount().
313 * @param[in] index The index of the property.
314 * @return A dereferenceable pointer to a property, or NULL if a scene-object does not exist with this property.
316 virtual const SceneGraph::PropertyBase* GetSceneObjectAnimatableProperty( Property::Index index ) const = 0;
319 * Retrieve a constraint input-property owned by the scene-graph object.
320 * @pre -1 < index < GetPropertyCount().
321 * @param[in] index The index of the property.
322 * @return A dereferenceable pointer to an input property, or NULL if a scene-object does not exist with this property.
324 virtual const PropertyInputImpl* GetSceneObjectInputProperty( Property::Index index ) const = 0;
327 * Query whether the property is a component of a scene-graph property.
328 * @pre -1 < index < GetPropertyCount().
329 * @param[in] index The index of the property.
330 * @return The index or Property::INVALID_COMPONENT_INDEX.
332 virtual int GetPropertyComponentIndex( Property::Index index ) const;
337 * A reference counted object may only be deleted by calling Unreference()
342 * Called immediately by derived classes, after the scene-object has been created & passed to the scene-graph.
344 void OnSceneObjectAdd();
347 * Called by derived classes, shortly before send a message to remove the scene-object.
349 void OnSceneObjectRemove();
352 * For overriding by derived classes to return the parent of this object.
354 virtual Object* GetParentObject() const
356 // By default the Object does not have a parent
361 * For use in derived classes.
362 * This is called after a property is set.
363 * @param [in] index The index of the property.
364 * @param [in] propertyValue The value of the property.
366 virtual void OnPropertySet( Property::Index index, Property::Value propertyValue ) {}
369 * Retrieves the TypeInfo for this object. Only retrieves it from the type-registry once and then stores a pointer
370 * to it locally there-after. The type info will not change during the life-time of the application.
371 * @return The type-info for this object (Can be NULL)
373 const TypeInfo* GetTypeInfo() const;
376 * Helper to find custom property
378 * @return pointer to the property
380 CustomPropertyMetadata* FindCustomProperty( Property::Index index ) const;
383 * Helper to find animatable property
385 * @return pointer to the property
387 AnimatablePropertyMetadata* FindAnimatableProperty( Property::Index index ) const;
390 * Helper to register a scene-graph property
391 * @param [in] name The name of the property.
392 * @param [in] key The key of the property
393 * @param [in] index The index of the property
394 * @param [in] value The value of the property.
395 * @return The index of the registered property or Property::INVALID_INDEX if registration failed.
397 Property::Index RegisterSceneGraphProperty(const std::string& name, Property::Index key, Property::Index index, const Property::Value& propertyValue) const;
400 * Check whether the animatable property is registered already, if not then register one.
401 * @param [in] index The index of the property
402 * @return pointer to the property.
404 AnimatablePropertyMetadata* RegisterAnimatableProperty(Property::Index index) const;
407 * Resolve the index and name of child properties if any.
409 void ResolveChildProperties();
411 private: // Default property extensions for derived classes
414 * Query how many default properties the derived class supports.
415 * @return The number of default properties.
417 virtual unsigned int GetDefaultPropertyCount() const = 0;
420 * Retrieve all the indices that are associated with the default properties supported by the derived class.
421 * @return A container of default property indices.
422 * @note The deriving class must not modify the existing elements in the container.
424 virtual void GetDefaultPropertyIndices( Property::IndexContainer& indices ) const = 0;
427 * Query how many default properties the derived class supports.
428 * @return The number of default properties.
430 virtual const char* GetDefaultPropertyName( Property::Index index ) const = 0;
433 * Query the index of a default property.
434 * @param [in] name The name of the property.
435 * @return The index of the property, or Property::INVALID_INDEX if no default property exists with the given name.
437 virtual Property::Index GetDefaultPropertyIndex( const std::string& name ) const = 0;
440 * Query whether a default property is writable.
441 * @param [in] index The index of the property.
442 * @return True if the property is animatable.
444 virtual bool IsDefaultPropertyWritable( Property::Index index ) const = 0;
447 * Query whether a default property is animatable.
448 * This determines whether the property can be the target of an animation or constraint.
449 * @param [in] index The index of the property.
450 * @return True if the property is animatable.
452 virtual bool IsDefaultPropertyAnimatable( Property::Index index ) const = 0;
455 * @brief Query whether a default property can be used as an input to a constraint.
457 * @param [in] index The index of the property.
458 * @return True if the property can be used as an input to a constraint.
460 virtual bool IsDefaultPropertyAConstraintInput( Property::Index index ) const = 0;
463 * Query the type of a default property.
464 * @param [in] index The index of the property.
465 * @return The type of the property.
467 virtual Property::Type GetDefaultPropertyType( Property::Index index ) const = 0;
470 * Set the value of a default property.
471 * @pre The property types match i.e. propertyValue.GetType() is equal to GetPropertyType(index).
472 * @param [in] index The index of the property.
473 * @param [in] propertyValue The new value of the property.
475 virtual void SetDefaultProperty( Property::Index index, const Property::Value& propertyValue ) = 0;
478 * Retrieve a default property value.
479 * @param [in] index The index of the property.
480 * @return The property value.
482 virtual Property::Value GetDefaultProperty( Property::Index index ) const = 0;
485 * Retrieve the latest scene-graph value of a default property.
486 * @param[in] index The index of the property.
487 * @return The latest scene-graph value of a default property.
489 virtual Property::Value GetDefaultPropertyCurrentValue( Property::Index index ) const = 0;
492 * Notifies that a default property is being animated so the deriving class should update the cached value.
493 * @param[in] animation The animation animating the property.
494 * @param[in] index The index of the property.
495 * @param[in] value The value of the property after the animation.
496 * @param[in] animationType Whether the property value given is the target or a relative value.
498 virtual void OnNotifyDefaultPropertyAnimation( Animation& animation, Property::Index index, const Property::Value& value, Animation::Type propertyChangeType )
502 * @todo this is virtual so that for now actor can override it,
503 * it needs to be removed and only have GetSceneObject but that requires changing actor and constraint logic
504 * Retrieve the scene-graph object added by this object.
505 * @return A pointer to the object, or NULL if no object has been added to the scene-graph.
507 virtual const SceneGraph::PropertyOwner* GetPropertyOwner() const
509 return GetSceneObject();
513 * Notify derived class of installation of a new scene-object property.
514 * This method is called after the message is to sent to install the property
515 * @param [in] newProperty A newly allocated scene-object property. Ownership is obviously not passed.
516 * @param [in] name The name allocated to this custom property.
517 * @param [in] index The index allocated to this custom property.
519 virtual void NotifyScenePropertyInstalled( const SceneGraph::PropertyBase& newProperty, const std::string& name, unsigned int index ) const
525 Object(const Object& rhs);
528 Object& operator=(const Object& rhs);
531 * Enable property notifications in scene graph
533 void EnablePropertyNotifications();
536 * Enable property notifications in scene graph
538 void DisablePropertyNotifications();
541 * Get the latest value of the property on the scene-graph.
542 * @param[in] entry An entry from the property lookup container.
543 * @return The latest value of the property.
545 Property::Value GetCurrentPropertyValue( const PropertyMetadata* entry ) const;
548 * Set the value of scene graph property.
549 * @param [in] index The index of the property.
550 * @param [in] entry An entry from the property lookup container.
551 * @param [in] value The new value of the property.
553 virtual void SetSceneGraphProperty( Property::Index index, const PropertyMetadata& entry, const Property::Value& value );
557 * Get the event thread services object - used for sending messages to the scene graph
558 * Assert if called from the wrong thread.
559 * This is intentionally inline for performance reasons.
561 * @return The event thread services object
563 inline EventThreadServices& GetEventThreadServices()
565 DALI_ASSERT_DEBUG( EventThreadServices::IsCoreRunning() );
566 return mEventThreadServices;
570 * Get the event thread services object - used for sending messages to the scene graph
571 * Assert if called from the wrong thread
572 * This is intentionally inline for performance reasons.
574 * @return The event thread services object
576 inline const EventThreadServices& GetEventThreadServices() const
578 DALI_ASSERT_DEBUG( EventThreadServices::IsCoreRunning() );
579 return mEventThreadServices;
583 EventThreadServices& mEventThreadServices;
587 typedef OwnerContainer<PropertyMetadata*> PropertyMetadataLookup;
588 mutable PropertyMetadataLookup mCustomProperties; ///< Used for accessing custom Node properties
589 mutable PropertyMetadataLookup mAnimatableProperties; ///< Used for accessing animatable Node properties
590 mutable TypeInfo const * mTypeInfo; ///< The type-info for this object, mutable so it can be lazy initialized from const method if it is required
592 Dali::Vector<Observer*> mObservers;
594 ConstraintContainer* mConstraints; ///< Container of owned -constraints.
596 typedef std::vector< Dali::PropertyNotification > PropertyNotificationContainer;
597 typedef PropertyNotificationContainer::iterator PropertyNotificationContainerIter;
598 typedef PropertyNotificationContainer::const_iterator PropertyNotificationContainerConstIter;
599 PropertyNotificationContainer* mPropertyNotifications; ///< Container of owned property notifications.
601 } // namespace Internal
603 // Helpers for public-api forwarding methods
605 inline Internal::Object& GetImplementation(Dali::Handle& object)
607 DALI_ASSERT_ALWAYS( object && "Object handle is empty" );
609 BaseObject& handle = object.GetBaseObject();
611 return static_cast<Internal::Object&>(handle);
614 inline const Internal::Object& GetImplementation(const Dali::Handle& object)
616 DALI_ASSERT_ALWAYS( object && "Object handle is empty" );
618 const BaseObject& handle = object.GetBaseObject();
620 return static_cast<const Internal::Object&>(handle);
625 #endif // __DALI_INTERNAL_OBJECT_H__