1 #ifndef __DALI_INTERNAL_OBJECT_H__
2 #define __DALI_INTERNAL_OBJECT_H__
5 * Copyright (c) 2016 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/common/event-thread-services.h>
33 #include <dali/internal/event/common/property-input-impl.h>
34 #include <dali/internal/event/common/property-metadata.h>
35 #include <dali/internal/update/common/property-base.h>
40 class PropertyNotification;
45 class EventThreadServices;
47 class PropertyCondition;
48 class PropertyInputImpl;
58 typedef std::vector< Dali::Constraint > ConstraintContainer;
59 typedef ConstraintContainer::iterator ConstraintIter;
60 typedef ConstraintContainer::const_iterator ConstraintConstIter;
64 * A base class for objects which optionally provide properties.
65 * The concrete derived class is responsible for implementing the property system methods.
66 * Classes may derive from Dali::BaseObject, until any properties are required.
68 * An object for a property-owning object in the scene-graph.
69 * This provides an interface for observing the addition/removal of scene-objects.
71 * The concrete derived class is responsible for:
72 * 1) Adding & removing an object from the scene-graph. The OnSceneObjectAdd() and OnSceneObjectRemove()
73 * methods should be called by the derived class, to trigger observer callbacks.
74 * 3) Implementing the GetSceneObject() methods, used to access the scene-object.
75 * 4) Providing access to properties stored by the scene-graph object. These should match the properties
76 * reported by the base Dali::Internal::Object methods.
79 class Object : public Dali::BaseObject
83 typedef Dali::Handle::Capability Capability;
90 * Called immediately after the object has created & passed ownership of a scene-graph object.
91 * @param[in] object The object object.
93 virtual void SceneObjectAdded(Object& object) = 0;
96 * Called shortly before the object sends a message to remove its scene object.
97 * @param[in] object The object object.
99 virtual void SceneObjectRemoved(Object& object) = 0;
102 * Called shortly before the object itself is destroyed; no further callbacks will be received.
103 * @param[in] object The object object.
105 virtual void ObjectDestroyed(Object& object) = 0;
112 virtual ~Observer(){}
121 * Add an observer to the object.
122 * @param[in] observer The observer to add.
124 virtual void AddObserver( Observer& observer );
127 * Remove an observer from the object
128 * @pre The observer has already been added.
129 * @param[in] observer The observer to remove.
131 virtual void RemoveObserver( Observer& observer );
134 * @copydoc Dali::Handle::Supports()
136 virtual bool Supports( Capability capability ) const;
139 * @copydoc Dali::Handle::GetPropertyCount()
141 virtual unsigned int GetPropertyCount() const;
144 * @copydoc Dali::Handle::GetPropertyName()
146 virtual std::string GetPropertyName( Property::Index index ) const;
149 * @copydoc Dali::Handle::GetPropertyIndex()
151 virtual Property::Index GetPropertyIndex( const std::string& name ) const;
154 * @copydoc Dali::Handle::GetPropertyIndex()
156 virtual Property::Index GetPropertyIndex( Property::Index key ) const;
159 * @copydoc Dali::Handle::GetPropertyIndex()
161 virtual Property::Index GetPropertyIndex( Property::Key key ) const;
164 * @copydoc Dali::Handle::IsPropertyWritable()
166 virtual bool IsPropertyWritable( Property::Index index ) const;
169 * @copydoc Dali::Handle::IsPropertyAnimatable()
171 virtual bool IsPropertyAnimatable( Property::Index index ) const;
174 * @copydoc Dali::Handle::IsPropertyAConstraintInput()
176 virtual bool IsPropertyAConstraintInput( Property::Index index ) const;
179 * @copydoc Dali::Handle::GetPropertyType()
181 virtual Property::Type GetPropertyType( Property::Index index ) const;
184 * @copydoc Dali::Handle::SetProperty()
186 virtual void SetProperty( Property::Index index, const Property::Value& propertyValue );
189 * @copydoc Dali::Handle::GetProperty()
191 virtual Property::Value GetProperty( Property::Index index ) const;
194 * @copydoc Dali::Handle::GetPropertyIndices()
196 virtual void GetPropertyIndices( Property::IndexContainer& indices ) const;
199 * @copydoc Dali::Handle::RegisterProperty()
201 virtual Property::Index RegisterProperty( const std::string& name, const Property::Value& propertyValue );
204 * @copydoc Dali::Handle::RegisterProperty()
206 virtual Property::Index RegisterProperty( const std::string& name, Property::Index key, const Property::Value& propertyValue );
209 * @copydoc Dali::Handle::RegisterProperty(std::string name, Property::Value propertyValue, Property::AccessMode accessMode)
211 virtual Property::Index RegisterProperty( const std::string& name, const Property::Value& propertyValue, Property::AccessMode accessMode );
214 * @brief Implementing method for this override
216 virtual Property::Index RegisterProperty( const std::string& name, Property::Index key, const Property::Value& propertyValue, Property::AccessMode accessMode );
219 * @copydoc Dali::Handle::AddPropertyNotification()
221 virtual Dali::PropertyNotification AddPropertyNotification( Property::Index index,
223 const Dali::PropertyCondition& condition );
226 * @copydoc Dali::Handle::RemovePropertyNotification()
228 virtual void RemovePropertyNotification( Dali::PropertyNotification propertyNotification );
231 * @copydoc Dali::Handle::RemovePropertyNotifications()
233 virtual void RemovePropertyNotifications();
235 /******************************** Uniform Mappings ********************************/
238 * @copydoc Dali::Handle::AddUniformMapping()
240 void AddUniformMapping( Property::Index propertyIndex, const std::string& uniformName ) const;
243 * @copydoc Dali::Handle::RemoveUniformMapping( )
245 void RemoveUniformMapping( const std::string& uniformName );
247 /******************************** Constraints ********************************/
250 * Apply a constraint to an Object.
251 * @param[in] constraint The constraint to apply.
253 void ApplyConstraint( ConstraintBase& constraint );
256 * Remove one constraint from an Object.
257 * @param[in] constraint The constraint to remove.
259 void RemoveConstraint( ConstraintBase& constraint );
262 * Remove all constraints from a Object.
264 void RemoveConstraints();
267 * Remove all constraints from a Object with a matching tag
269 void RemoveConstraints( unsigned int tag );
272 * Called by TypeInfo to set the type-info that this object-impl is created by.
273 * @param[in] typeInfo The TypeInfo that creates this object-impl.
275 void SetTypeInfo( const TypeInfo* typeInfo );
278 * @return the index from which custom properties start
280 unsigned int CustomPropertyStartIndex()
282 return PROPERTY_CUSTOM_START_INDEX;
285 /******************** To be overridden by deriving classes ********************/
288 * Retrieve the scene-graph object added by this object.
289 * @return A pointer to the object, or NULL if no object has been added to the scene-graph.
291 virtual const SceneGraph::PropertyOwner* GetSceneObject() const = 0;
294 * Retrieve an animatable property owned by the scene-graph object.
295 * @pre -1 < index < GetPropertyCount().
296 * @param[in] index The index of the property.
297 * @return A dereferenceable pointer to a property, or NULL if a scene-object does not exist with this property.
299 virtual const SceneGraph::PropertyBase* GetSceneObjectAnimatableProperty( Property::Index index ) const = 0;
302 * Retrieve a constraint input-property owned by the scene-graph object.
303 * @pre -1 < index < GetPropertyCount().
304 * @param[in] index The index of the property.
305 * @return A dereferenceable pointer to an input property, or NULL if a scene-object does not exist with this property.
307 virtual const PropertyInputImpl* GetSceneObjectInputProperty( Property::Index index ) const = 0;
310 * Query whether the property is a component of a scene-graph property.
311 * @pre -1 < index < GetPropertyCount().
312 * @param[in] index The index of the property.
313 * @return The index or Property::INVALID_COMPONENT_INDEX.
315 virtual int GetPropertyComponentIndex( Property::Index index ) const;
320 * A reference counted object may only be deleted by calling Unreference()
325 * Called immediately by derived classes, after the scene-object has been created & passed to the scene-graph.
327 void OnSceneObjectAdd();
330 * Called by derived classes, shortly before send a message to remove the scene-object.
332 void OnSceneObjectRemove();
335 * For overriding by derived classes to return the parent of this object.
337 virtual Object* GetParentObject() const
339 // By default the Object does not have a parent
344 * For use in derived classes.
345 * This is called after a property is set.
346 * @param [in] index The index of the property.
347 * @param [in] propertyValue The value of the property.
349 virtual void OnPropertySet( Property::Index index, Property::Value propertyValue ) {}
352 * Retrieves the TypeInfo for this object. Only retrieves it from the type-registry once and then stores a pointer
353 * to it locally there-after. The type info will not change during the life-time of the application.
354 * @return The type-info for this object (Can be NULL)
356 const TypeInfo* GetTypeInfo() const;
359 * Helper to find custom property
361 * @return pointer to the property
363 CustomPropertyMetadata* FindCustomProperty( Property::Index index ) const;
366 * Helper to find animatable property
368 * @return pointer to the property
370 AnimatablePropertyMetadata* FindAnimatableProperty( Property::Index index ) const;
373 * Helper to register a scene-graph property
374 * @param [in] name The name of the property.
375 * @param [in] key The key of the property
376 * @param [in] index The index of the property
377 * @param [in] value The value of the property.
378 * @return The index of the registered property or Property::INVALID_INDEX if registration failed.
380 Property::Index RegisterSceneGraphProperty(const std::string& name, Property::Index key, Property::Index index, const Property::Value& propertyValue) const;
383 * Check whether the animatable property is registered already, if not then register one.
384 * @param [in] index The index of the property
385 * @return pointer to the property.
387 AnimatablePropertyMetadata* RegisterAnimatableProperty(Property::Index index) const;
390 * Resolve the index and name of child properties if any.
392 void ResolveChildProperties();
394 private: // Default property extensions for derived classes
397 * Query how many default properties the derived class supports.
398 * @return The number of default properties.
400 virtual unsigned int GetDefaultPropertyCount() const = 0;
403 * Retrieve all the indices that are associated with the default properties supported by the derived class.
404 * @return A container of default property indices.
405 * @note The deriving class must not modify the existing elements in the container.
407 virtual void GetDefaultPropertyIndices( Property::IndexContainer& indices ) const = 0;
410 * Query how many default properties the derived class supports.
411 * @return The number of default properties.
413 virtual const char* GetDefaultPropertyName( Property::Index index ) const = 0;
416 * Query the index of a default property.
417 * @param [in] name The name of the property.
418 * @return The index of the property, or Property::INVALID_INDEX if no default property exists with the given name.
420 virtual Property::Index GetDefaultPropertyIndex( const std::string& name ) const = 0;
423 * Query whether a default property is writable.
424 * @param [in] index The index of the property.
425 * @return True if the property is animatable.
427 virtual bool IsDefaultPropertyWritable( Property::Index index ) const = 0;
430 * Query whether a default property is animatable.
431 * This determines whether the property can be the target of an animation or constraint.
432 * @param [in] index The index of the property.
433 * @return True if the property is animatable.
435 virtual bool IsDefaultPropertyAnimatable( Property::Index index ) const = 0;
438 * @brief Query whether a default property can be used as an input to a constraint.
440 * @param [in] index The index of the property.
441 * @return True if the property can be used as an input to a constraint.
443 virtual bool IsDefaultPropertyAConstraintInput( Property::Index index ) const = 0;
446 * Query the type of a default property.
447 * @param [in] index The index of the property.
448 * @return The type of the property.
450 virtual Property::Type GetDefaultPropertyType( Property::Index index ) const = 0;
453 * Set the value of a default property.
454 * @pre The property types match i.e. propertyValue.GetType() is equal to GetPropertyType(index).
455 * @param [in] index The index of the property.
456 * @param [in] propertyValue The new value of the property.
458 virtual void SetDefaultProperty( Property::Index index, const Property::Value& propertyValue ) = 0;
461 * Retrieve a default property value.
462 * @param [in] index The index of the property.
463 * @return The property value.
465 virtual Property::Value GetDefaultProperty( Property::Index index ) const = 0;
468 * @todo this is virtual so that for now actor can override it,
469 * it needs to be removed and only have GetSceneObject but that requires changing actor and constraint logic
470 * Retrieve the scene-graph object added by this object.
471 * @return A pointer to the object, or NULL if no object has been added to the scene-graph.
473 virtual const SceneGraph::PropertyOwner* GetPropertyOwner() const
475 return GetSceneObject();
479 * Notify derived class of installation of a new scene-object property.
480 * This method is called after the message is to sent to install the property
481 * @param [in] newProperty A newly allocated scene-object property. Ownership is obviously not passed.
482 * @param [in] name The name allocated to this custom property.
483 * @param [in] index The index allocated to this custom property.
485 virtual void NotifyScenePropertyInstalled( const SceneGraph::PropertyBase& newProperty, const std::string& name, unsigned int index ) const
491 Object(const Object& rhs);
494 Object& operator=(const Object& rhs);
497 * Enable property notifications in scene graph
499 void EnablePropertyNotifications();
502 * Enable property notifications in scene graph
504 void DisablePropertyNotifications();
507 * Get the value of the property.
508 * @param [in] entry An entry from the property lookup container.
509 * @return The new value of the property.
511 Property::Value GetPropertyValue( const PropertyMetadata* entry ) const;
514 * Set the value of scene graph property.
515 * @param [in] index The index of the property.
516 * @param [in] entry An entry from the property lookup container.
517 * @param [in] value The new value of the property.
519 virtual void SetSceneGraphProperty( Property::Index index, const PropertyMetadata& entry, const Property::Value& value );
523 * Get the event thread services object - used for sending messages to the scene graph
524 * Assert if called from the wrong thread.
525 * This is intentionally inline for performance reasons.
527 * @return The event thread services object
529 inline EventThreadServices& GetEventThreadServices()
531 DALI_ASSERT_DEBUG( EventThreadServices::IsCoreRunning() );
532 return mEventThreadServices;
536 * Get the event thread services object - used for sending messages to the scene graph
537 * Assert if called from the wrong thread
538 * This is intentionally inline for performance reasons.
540 * @return The event thread services object
542 inline const EventThreadServices& GetEventThreadServices() const
544 DALI_ASSERT_DEBUG( EventThreadServices::IsCoreRunning() );
545 return mEventThreadServices;
549 EventThreadServices& mEventThreadServices;
553 typedef OwnerContainer<PropertyMetadata*> PropertyMetadataLookup;
554 mutable PropertyMetadataLookup mCustomProperties; ///< Used for accessing custom Node properties
555 mutable PropertyMetadataLookup mAnimatableProperties; ///< Used for accessing animatable Node properties
556 mutable TypeInfo const * mTypeInfo; ///< The type-info for this object, mutable so it can be lazy initialized from const method if it is required
558 Dali::Vector<Observer*> mObservers;
560 ConstraintContainer* mConstraints; ///< Container of owned -constraints.
562 typedef std::vector< Dali::PropertyNotification > PropertyNotificationContainer;
563 typedef PropertyNotificationContainer::iterator PropertyNotificationContainerIter;
564 typedef PropertyNotificationContainer::const_iterator PropertyNotificationContainerConstIter;
565 PropertyNotificationContainer* mPropertyNotifications; ///< Container of owned property notifications.
567 } // namespace Internal
569 // Helpers for public-api forwarding methods
571 inline Internal::Object& GetImplementation(Dali::Handle& object)
573 DALI_ASSERT_ALWAYS( object && "Object handle is empty" );
575 BaseObject& handle = object.GetBaseObject();
577 return static_cast<Internal::Object&>(handle);
580 inline const Internal::Object& GetImplementation(const Dali::Handle& object)
582 DALI_ASSERT_ALWAYS( object && "Object handle is empty" );
584 const BaseObject& handle = object.GetBaseObject();
586 return static_cast<const Internal::Object&>(handle);
591 #endif // __DALI_INTERNAL_OBJECT_H__