1 #ifndef __DALI_INTERNAL_OBJECT_H__
2 #define __DALI_INTERNAL_OBJECT_H__
5 * Copyright (c) 2018 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/devel-api/object/handle-devel.h>
33 #include <dali/internal/event/animation/animation-impl.h>
34 #include <dali/internal/event/common/event-thread-services.h>
35 #include <dali/internal/event/common/property-input-impl.h>
36 #include <dali/internal/event/common/property-metadata.h>
37 #include <dali/internal/update/common/property-base.h>
42 class PropertyNotification;
47 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 * @brief returns true if the custom property exists on this object.
229 * @note The property may be defined for a type within the type registry, but it isn't explicity
230 * defined in every consequent instantiation. It can be automatically added, e.g. parenting an actor
231 * automatically registers it's parent container's child properties.
233 * @param[in] handle The handle of the object to test
234 * @param[in] index The property index to look for.
235 * @return true if the property exists on the object, false otherwise.
237 bool DoesCustomPropertyExist( Property::Index index );
240 * @copydoc Dali::Handle::AddPropertyNotification()
242 virtual Dali::PropertyNotification AddPropertyNotification( Property::Index index,
244 const Dali::PropertyCondition& condition );
247 * @copydoc Dali::Handle::RemovePropertyNotification()
249 virtual void RemovePropertyNotification( Dali::PropertyNotification propertyNotification );
252 * @copydoc Dali::Handle::RemovePropertyNotifications()
254 virtual void RemovePropertyNotifications();
257 * Notifies that a property is being animated.
258 * @param[in] animation The animation animating the property.
259 * @param[in] index The index of the property.
260 * @param[in] value The value of the property after the animation.
261 * @param[in] animationType Whether the property value given is the target or a relative value.
263 void NotifyPropertyAnimation( Animation& animation, Property::Index index, const Property::Value& value, Animation::Type animationType );
265 /******************************** Uniform Mappings ********************************/
268 * @copydoc Dali::Handle::AddUniformMapping()
270 void AddUniformMapping( Property::Index propertyIndex, const std::string& uniformName ) const;
273 * @copydoc Dali::Handle::RemoveUniformMapping( )
275 void RemoveUniformMapping( const std::string& uniformName );
277 /******************************** Constraints ********************************/
280 * Apply a constraint to an Object.
281 * @param[in] constraint The constraint to apply.
283 void ApplyConstraint( ConstraintBase& constraint );
286 * Remove one constraint from an Object.
287 * @param[in] constraint The constraint to remove.
289 void RemoveConstraint( ConstraintBase& constraint );
292 * Remove all constraints from a Object.
294 void RemoveConstraints();
297 * Remove all constraints from a Object with a matching tag
299 void RemoveConstraints( unsigned int tag );
302 * Called by TypeInfo to set the type-info that this object-impl is created by.
303 * @param[in] typeInfo The TypeInfo that creates this object-impl.
305 void SetTypeInfo( const TypeInfo* typeInfo );
308 * @return the index from which custom properties start
310 unsigned int CustomPropertyStartIndex()
312 return PROPERTY_CUSTOM_START_INDEX;
315 /******************** To be overridden by deriving classes ********************/
318 * Retrieve the scene-graph object added by this object.
319 * @return A pointer to the object, or NULL if no object has been added to the scene-graph.
321 virtual const SceneGraph::PropertyOwner* GetSceneObject() const = 0;
324 * Retrieve an animatable property owned by the scene-graph object.
325 * @pre -1 < index < GetPropertyCount().
326 * @param[in] index The index of the property.
327 * @return A dereferenceable pointer to a property, or NULL if a scene-object does not exist with this property.
329 virtual const SceneGraph::PropertyBase* GetSceneObjectAnimatableProperty( Property::Index index ) const = 0;
332 * Retrieve a constraint input-property owned by the scene-graph object.
333 * @pre -1 < index < GetPropertyCount().
334 * @param[in] index The index of the property.
335 * @return A dereferenceable pointer to an input property, or NULL if a scene-object does not exist with this property.
337 virtual const PropertyInputImpl* GetSceneObjectInputProperty( Property::Index index ) const = 0;
340 * Query whether the property is a component of a scene-graph property.
341 * @pre -1 < index < GetPropertyCount().
342 * @param[in] index The index of the property.
343 * @return The index or Property::INVALID_COMPONENT_INDEX.
345 virtual int GetPropertyComponentIndex( Property::Index index ) const;
348 * @copydoc Dali::Handle::PropertySetSignal()
350 DevelHandle::PropertySetSignalType& PropertySetSignal();
355 * A reference counted object may only be deleted by calling Unreference()
360 * Called immediately by derived classes, after the scene-object has been created & passed to the scene-graph.
362 void OnSceneObjectAdd();
365 * Called by derived classes, shortly before send a message to remove the scene-object.
367 void OnSceneObjectRemove();
370 * For overriding by derived classes to return the parent of this object.
372 virtual Object* GetParentObject() const
374 // By default the Object does not have a parent
379 * For use in derived classes.
380 * This is called after a property is set.
381 * @param [in] index The index of the property.
382 * @param [in] propertyValue The value of the property.
384 virtual void OnPropertySet( Property::Index index, Property::Value propertyValue ) {}
387 * Retrieves the TypeInfo for this object. Only retrieves it from the type-registry once and then stores a pointer
388 * to it locally there-after. The type info will not change during the life-time of the application.
389 * @return The type-info for this object (Can be NULL)
391 const TypeInfo* GetTypeInfo() const;
394 * Helper to find custom property
396 * @return pointer to the property
398 CustomPropertyMetadata* FindCustomProperty( Property::Index index ) const;
401 * Helper to find animatable property
403 * @return pointer to the property
405 AnimatablePropertyMetadata* FindAnimatableProperty( Property::Index index ) const;
408 * Helper to register a scene-graph property
409 * @param [in] name The name of the property.
410 * @param [in] key The key of the property
411 * @param [in] index The index of the property
412 * @param [in] value The value of the property.
413 * @return The index of the registered property or Property::INVALID_INDEX if registration failed.
415 Property::Index RegisterSceneGraphProperty(const std::string& name, Property::Index key, Property::Index index, const Property::Value& propertyValue) const;
418 * Check whether the animatable property is registered already, if not then register one.
419 * @param [in] index The index of the property
420 * @return pointer to the property.
422 AnimatablePropertyMetadata* RegisterAnimatableProperty(Property::Index index) const;
425 * Resolve the index and name of child properties if any.
427 void ResolveChildProperties();
429 private: // Default property extensions for derived classes
432 * Query how many default properties the derived class supports.
433 * @return The number of default properties.
435 virtual unsigned int GetDefaultPropertyCount() const = 0;
438 * Retrieve all the indices that are associated with the default properties supported by the derived class.
439 * @return A container of default property indices.
440 * @note The deriving class must not modify the existing elements in the container.
442 virtual void GetDefaultPropertyIndices( Property::IndexContainer& indices ) const = 0;
445 * Query how many default properties the derived class supports.
446 * @return The number of default properties.
448 virtual const char* GetDefaultPropertyName( Property::Index index ) const = 0;
451 * Query the index of a default property.
452 * @param [in] name The name of the property.
453 * @return The index of the property, or Property::INVALID_INDEX if no default property exists with the given name.
455 virtual Property::Index GetDefaultPropertyIndex( const std::string& name ) const = 0;
458 * Query whether a default property is writable.
459 * @param [in] index The index of the property.
460 * @return True if the property is animatable.
462 virtual bool IsDefaultPropertyWritable( Property::Index index ) const = 0;
465 * Query whether a default property is animatable.
466 * This determines whether the property can be the target of an animation or constraint.
467 * @param [in] index The index of the property.
468 * @return True if the property is animatable.
470 virtual bool IsDefaultPropertyAnimatable( Property::Index index ) const = 0;
473 * @brief Query whether a default property can be used as an input to a constraint.
475 * @param [in] index The index of the property.
476 * @return True if the property can be used as an input to a constraint.
478 virtual bool IsDefaultPropertyAConstraintInput( Property::Index index ) const = 0;
481 * Query the type of a default property.
482 * @param [in] index The index of the property.
483 * @return The type of the property.
485 virtual Property::Type GetDefaultPropertyType( Property::Index index ) const = 0;
488 * Set the value of a default property.
489 * @pre The property types match i.e. propertyValue.GetType() is equal to GetPropertyType(index).
490 * @param [in] index The index of the property.
491 * @param [in] propertyValue The new value of the property.
493 virtual void SetDefaultProperty( Property::Index index, const Property::Value& propertyValue ) = 0;
496 * Retrieve a default property value.
497 * @param [in] index The index of the property.
498 * @return The property value.
500 virtual Property::Value GetDefaultProperty( Property::Index index ) const = 0;
503 * Retrieve the latest scene-graph value of a default property.
504 * @param[in] index The index of the property.
505 * @return The latest scene-graph value of a default property.
507 virtual Property::Value GetDefaultPropertyCurrentValue( Property::Index index ) const = 0;
510 * Notifies that a default property is being animated so the deriving class should update the cached value.
511 * @param[in] animation The animation animating the property.
512 * @param[in] index The index of the property.
513 * @param[in] value The value of the property after the animation.
514 * @param[in] animationType Whether the property value given is the target or a relative value.
516 virtual void OnNotifyDefaultPropertyAnimation( Animation& animation, Property::Index index, const Property::Value& value, Animation::Type propertyChangeType )
520 * @todo this is virtual so that for now actor can override it,
521 * it needs to be removed and only have GetSceneObject but that requires changing actor and constraint logic
522 * Retrieve the scene-graph object added by this object.
523 * @return A pointer to the object, or NULL if no object has been added to the scene-graph.
525 virtual const SceneGraph::PropertyOwner* GetPropertyOwner() const
527 return GetSceneObject();
531 * Notify derived class of installation of a new scene-object property.
532 * This method is called after the message is to sent to install the property
533 * @param [in] newProperty A newly allocated scene-object property. Ownership is obviously not passed.
534 * @param [in] name The name allocated to this custom property.
535 * @param [in] index The index allocated to this custom property.
537 virtual void NotifyScenePropertyInstalled( const SceneGraph::PropertyBase& newProperty, const std::string& name, unsigned int index ) const
543 Object(const Object& rhs);
546 Object& operator=(const Object& rhs);
549 * Enable property notifications in scene graph
551 void EnablePropertyNotifications();
554 * Enable property notifications in scene graph
556 void DisablePropertyNotifications();
559 * Get the latest value of the property on the scene-graph.
560 * @param[in] entry An entry from the property lookup container.
561 * @return The latest value of the property.
563 Property::Value GetCurrentPropertyValue( const PropertyMetadata* entry ) const;
566 * Set the value of scene graph property.
567 * @param [in] index The index of the property.
568 * @param [in] entry An entry from the property lookup container.
569 * @param [in] value The new value of the property.
571 virtual void SetSceneGraphProperty( Property::Index index, const PropertyMetadata& entry, const Property::Value& value );
575 * Get the event thread services object - used for sending messages to the scene graph
576 * Assert if called from the wrong thread.
577 * This is intentionally inline for performance reasons.
579 * @return The event thread services object
581 inline EventThreadServices& GetEventThreadServices()
583 DALI_ASSERT_DEBUG( EventThreadServices::IsCoreRunning() );
584 return mEventThreadServices;
588 * Get the event thread services object - used for sending messages to the scene graph
589 * Assert if called from the wrong thread
590 * This is intentionally inline for performance reasons.
592 * @return The event thread services object
594 inline const EventThreadServices& GetEventThreadServices() const
596 DALI_ASSERT_DEBUG( EventThreadServices::IsCoreRunning() );
597 return mEventThreadServices;
601 EventThreadServices& mEventThreadServices;
605 typedef OwnerContainer<PropertyMetadata*> PropertyMetadataLookup;
606 mutable PropertyMetadataLookup mCustomProperties; ///< Used for accessing custom Node properties
607 mutable PropertyMetadataLookup mAnimatableProperties; ///< Used for accessing animatable Node properties
608 mutable TypeInfo const * mTypeInfo; ///< The type-info for this object, mutable so it can be lazy initialized from const method if it is required
610 Dali::Vector<Observer*> mObservers;
612 ConstraintContainer* mConstraints; ///< Container of owned -constraints.
614 typedef std::vector< Dali::PropertyNotification > PropertyNotificationContainer;
615 typedef PropertyNotificationContainer::iterator PropertyNotificationContainerIter;
616 typedef PropertyNotificationContainer::const_iterator PropertyNotificationContainerConstIter;
617 PropertyNotificationContainer* mPropertyNotifications; ///< Container of owned property notifications.
618 DevelHandle::PropertySetSignalType mPropertySetSignal;
620 } // namespace Internal
622 // Helpers for public-api forwarding methods
624 inline Internal::Object& GetImplementation(Dali::Handle& object)
626 DALI_ASSERT_ALWAYS( object && "Object handle is empty" );
628 BaseObject& handle = object.GetBaseObject();
630 return static_cast<Internal::Object&>(handle);
633 inline const Internal::Object& GetImplementation(const Dali::Handle& object)
635 DALI_ASSERT_ALWAYS( object && "Object handle is empty" );
637 const BaseObject& handle = object.GetBaseObject();
639 return static_cast<const Internal::Object&>(handle);
644 #endif // __DALI_INTERNAL_OBJECT_H__