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::IsPropertyWritable()
161 virtual bool IsPropertyWritable( Property::Index index ) const;
164 * @copydoc Dali::Handle::IsPropertyAnimatable()
166 virtual bool IsPropertyAnimatable( Property::Index index ) const;
169 * @copydoc Dali::Handle::IsPropertyAConstraintInput()
171 virtual bool IsPropertyAConstraintInput( Property::Index index ) const;
174 * @copydoc Dali::Handle::GetPropertyType()
176 virtual Property::Type GetPropertyType( Property::Index index ) const;
179 * @copydoc Dali::Handle::SetProperty()
181 virtual void SetProperty( Property::Index index, const Property::Value& propertyValue );
184 * @copydoc Dali::Handle::GetProperty()
186 virtual Property::Value GetProperty( Property::Index index ) const;
189 * @copydoc Dali::Handle::GetPropertyIndices()
191 virtual void GetPropertyIndices( Property::IndexContainer& indices ) const;
194 * @copydoc Dali::Handle::RegisterProperty()
196 virtual Property::Index RegisterProperty( const std::string& name, const Property::Value& propertyValue );
199 * @copydoc Dali::Handle::RegisterProperty()
201 virtual Property::Index RegisterProperty( const std::string& name, Property::Index key, const Property::Value& propertyValue );
204 * @copydoc Dali::Handle::RegisterProperty(std::string name, Property::Value propertyValue, Property::AccessMode accessMode)
206 virtual Property::Index RegisterProperty( const std::string& name, const Property::Value& propertyValue, Property::AccessMode accessMode );
209 * @brief Implementing method for this override
211 virtual Property::Index RegisterProperty( const std::string& name, Property::Index key, const Property::Value& propertyValue, Property::AccessMode accessMode );
214 * @copydoc Dali::Handle::AddPropertyNotification()
216 virtual Dali::PropertyNotification AddPropertyNotification( Property::Index index,
218 const Dali::PropertyCondition& condition );
221 * @copydoc Dali::Handle::RemovePropertyNotification()
223 virtual void RemovePropertyNotification( Dali::PropertyNotification propertyNotification );
226 * @copydoc Dali::Handle::RemovePropertyNotifications()
228 virtual void RemovePropertyNotifications();
230 /******************************** Uniform Mappings ********************************/
233 * @copydoc Dali::Handle::AddUniformMapping()
235 void AddUniformMapping( Property::Index propertyIndex, const std::string& uniformName ) const;
238 * @copydoc Dali::Handle::RemoveUniformMapping( )
240 void RemoveUniformMapping( const std::string& uniformName );
242 /******************************** Constraints ********************************/
245 * Apply a constraint to an Object.
246 * @param[in] constraint The constraint to apply.
248 void ApplyConstraint( ConstraintBase& constraint );
251 * Remove one constraint from an Object.
252 * @param[in] constraint The constraint to remove.
254 void RemoveConstraint( ConstraintBase& constraint );
257 * Remove all constraints from a Object.
259 void RemoveConstraints();
262 * Remove all constraints from a Object with a matching tag
264 void RemoveConstraints( unsigned int tag );
267 * Called by TypeInfo to set the type-info that this object-impl is created by.
268 * @param[in] typeInfo The TypeInfo that creates this object-impl.
270 void SetTypeInfo( const TypeInfo* typeInfo );
273 * @return the index from which custom properties start
275 unsigned int CustomPropertyStartIndex()
277 return PROPERTY_CUSTOM_START_INDEX;
280 /******************** To be overridden by deriving classes ********************/
283 * Retrieve the scene-graph object added by this object.
284 * @return A pointer to the object, or NULL if no object has been added to the scene-graph.
286 virtual const SceneGraph::PropertyOwner* GetSceneObject() const = 0;
289 * Retrieve an animatable property owned by the scene-graph object.
290 * @pre -1 < index < GetPropertyCount().
291 * @param[in] index The index of the property.
292 * @return A dereferenceable pointer to a property, or NULL if a scene-object does not exist with this property.
294 virtual const SceneGraph::PropertyBase* GetSceneObjectAnimatableProperty( Property::Index index ) const = 0;
297 * Retrieve a constraint input-property owned by the scene-graph object.
298 * @pre -1 < index < GetPropertyCount().
299 * @param[in] index The index of the property.
300 * @return A dereferenceable pointer to an input property, or NULL if a scene-object does not exist with this property.
302 virtual const PropertyInputImpl* GetSceneObjectInputProperty( Property::Index index ) const = 0;
305 * Query whether the property is a component of a scene-graph property.
306 * @pre -1 < index < GetPropertyCount().
307 * @param[in] index The index of the property.
308 * @return The index or Property::INVALID_COMPONENT_INDEX.
310 virtual int GetPropertyComponentIndex( Property::Index index ) const;
315 * A reference counted object may only be deleted by calling Unreference()
320 * Called immediately by derived classes, after the scene-object has been created & passed to the scene-graph.
322 void OnSceneObjectAdd();
325 * Called by derived classes, shortly before send a message to remove the scene-object.
327 void OnSceneObjectRemove();
330 * For overriding by derived classes to return the parent of this object.
332 virtual Object* GetParentObject() const
334 // By default the Object does not have a parent
339 * For use in derived classes.
340 * This is called after a property is set.
341 * @param [in] index The index of the property.
342 * @param [in] propertyValue The value of the property.
344 virtual void OnPropertySet( Property::Index index, Property::Value propertyValue ) {}
347 * Retrieves the TypeInfo for this object. Only retrieves it from the type-registry once and then stores a pointer
348 * to it locally there-after. The type info will not change during the life-time of the application.
349 * @return The type-info for this object (Can be NULL)
351 const TypeInfo* GetTypeInfo() const;
354 * Helper to find custom property
356 * @return pointer to the property
358 CustomPropertyMetadata* FindCustomProperty( Property::Index index ) const;
361 * Helper to find animatable property
363 * @return pointer to the property
365 AnimatablePropertyMetadata* FindAnimatableProperty( Property::Index index ) const;
368 * Helper to register a scene-graph property
369 * @param [in] name The name of the property.
370 * @param [in] key The key of the property
371 * @param [in] index The index of the property
372 * @param [in] value The value of the property.
373 * @return The index of the registered property or Property::INVALID_INDEX if registration failed.
375 Property::Index RegisterSceneGraphProperty(const std::string& name, Property::Index key, Property::Index index, const Property::Value& propertyValue) const;
378 * Check whether the animatable property is registered already, if not then register one.
379 * @param [in] index The index of the property
380 * @return pointer to the property.
382 AnimatablePropertyMetadata* RegisterAnimatableProperty(Property::Index index) const;
385 * Resolve the index and name of child properties if any.
387 void ResolveChildProperties();
389 private: // Default property extensions for derived classes
392 * Query how many default properties the derived class supports.
393 * @return The number of default properties.
395 virtual unsigned int GetDefaultPropertyCount() const = 0;
398 * Retrieve all the indices that are associated with the default properties supported by the derived class.
399 * @return A container of default property indices.
400 * @note The deriving class must not modify the existing elements in the container.
402 virtual void GetDefaultPropertyIndices( Property::IndexContainer& indices ) const = 0;
405 * Query how many default properties the derived class supports.
406 * @return The number of default properties.
408 virtual const char* GetDefaultPropertyName( Property::Index index ) const = 0;
411 * Query the index of a default property.
412 * @param [in] name The name of the property.
413 * @return The index of the property, or Property::INVALID_INDEX if no default property exists with the given name.
415 virtual Property::Index GetDefaultPropertyIndex( const std::string& name ) const = 0;
418 * Query whether a default property is writable.
419 * @param [in] index The index of the property.
420 * @return True if the property is animatable.
422 virtual bool IsDefaultPropertyWritable( Property::Index index ) const = 0;
425 * Query whether a default property is animatable.
426 * This determines whether the property can be the target of an animation or constraint.
427 * @param [in] index The index of the property.
428 * @return True if the property is animatable.
430 virtual bool IsDefaultPropertyAnimatable( Property::Index index ) const = 0;
433 * @brief Query whether a default property can be used as an input to a constraint.
435 * @param [in] index The index of the property.
436 * @return True if the property can be used as an input to a constraint.
438 virtual bool IsDefaultPropertyAConstraintInput( Property::Index index ) const = 0;
441 * Query the type of a default property.
442 * @param [in] index The index of the property.
443 * @return The type of the property.
445 virtual Property::Type GetDefaultPropertyType( Property::Index index ) const = 0;
448 * Set the value of a default property.
449 * @pre The property types match i.e. propertyValue.GetType() is equal to GetPropertyType(index).
450 * @param [in] index The index of the property.
451 * @param [in] propertyValue The new value of the property.
453 virtual void SetDefaultProperty( Property::Index index, const Property::Value& propertyValue ) = 0;
456 * Retrieve a default property value.
457 * @param [in] index The index of the property.
458 * @return The property value.
460 virtual Property::Value GetDefaultProperty( Property::Index index ) const = 0;
463 * @todo this is virtual so that for now actor can override it,
464 * it needs to be removed and only have GetSceneObject but that requires changing actor and constraint logic
465 * Retrieve the scene-graph object added by this object.
466 * @return A pointer to the object, or NULL if no object has been added to the scene-graph.
468 virtual const SceneGraph::PropertyOwner* GetPropertyOwner() const
470 return GetSceneObject();
474 * Notify derived class of installation of a new scene-object property.
475 * This method is called after the message is to sent to install the property
476 * @param [in] newProperty A newly allocated scene-object property. Ownership is obviously not passed.
477 * @param [in] name The name allocated to this custom property.
478 * @param [in] index The index allocated to this custom property.
480 virtual void NotifyScenePropertyInstalled( const SceneGraph::PropertyBase& newProperty, const std::string& name, unsigned int index ) const
486 Object(const Object& rhs);
489 Object& operator=(const Object& rhs);
492 * Enable property notifications in scene graph
494 void EnablePropertyNotifications();
497 * Enable property notifications in scene graph
499 void DisablePropertyNotifications();
502 * Get the value of the property.
503 * @param [in] entry An entry from the property lookup container.
504 * @return The new value of the property.
506 Property::Value GetPropertyValue( const PropertyMetadata* entry ) const;
509 * Set the value of scene graph property.
510 * @param [in] index The index of the property.
511 * @param [in] entry An entry from the property lookup container.
512 * @param [in] value The new value of the property.
514 virtual void SetSceneGraphProperty( Property::Index index, const PropertyMetadata& entry, const Property::Value& value );
518 * Get the event thread services object - used for sending messages to the scene graph
519 * Assert if called from the wrong thread.
520 * This is intentionally inline for performance reasons.
522 * @return The event thread services object
524 inline EventThreadServices& GetEventThreadServices()
526 DALI_ASSERT_DEBUG( EventThreadServices::IsCoreRunning() );
527 return mEventThreadServices;
531 * Get the event thread services object - used for sending messages to the scene graph
532 * Assert if called from the wrong thread
533 * This is intentionally inline for performance reasons.
535 * @return The event thread services object
537 inline const EventThreadServices& GetEventThreadServices() const
539 DALI_ASSERT_DEBUG( EventThreadServices::IsCoreRunning() );
540 return mEventThreadServices;
544 EventThreadServices& mEventThreadServices;
548 typedef OwnerContainer<PropertyMetadata*> PropertyMetadataLookup;
549 mutable PropertyMetadataLookup mCustomProperties; ///< Used for accessing custom Node properties
550 mutable PropertyMetadataLookup mAnimatableProperties; ///< Used for accessing animatable Node properties
551 mutable TypeInfo const * mTypeInfo; ///< The type-info for this object, mutable so it can be lazy initialized from const method if it is required
553 Dali::Vector<Observer*> mObservers;
555 ConstraintContainer* mConstraints; ///< Container of owned -constraints.
557 typedef std::vector< Dali::PropertyNotification > PropertyNotificationContainer;
558 typedef PropertyNotificationContainer::iterator PropertyNotificationContainerIter;
559 typedef PropertyNotificationContainer::const_iterator PropertyNotificationContainerConstIter;
560 PropertyNotificationContainer* mPropertyNotifications; ///< Container of owned property notifications.
562 } // namespace Internal
564 // Helpers for public-api forwarding methods
566 inline Internal::Object& GetImplementation(Dali::Handle& object)
568 DALI_ASSERT_ALWAYS( object && "Object handle is empty" );
570 BaseObject& handle = object.GetBaseObject();
572 return static_cast<Internal::Object&>(handle);
575 inline const Internal::Object& GetImplementation(const Dali::Handle& object)
577 DALI_ASSERT_ALWAYS( object && "Object handle is empty" );
579 const BaseObject& handle = object.GetBaseObject();
581 return static_cast<const Internal::Object&>(handle);
586 #endif // __DALI_INTERNAL_OBJECT_H__