X-Git-Url: http://review.tizen.org/git/?a=blobdiff_plain;f=dali%2Finternal%2Fevent%2Fcommon%2Fobject-impl.h;h=035e7eed1a7f93617de576a70ef54156c525d7be;hb=462cbee2270984cdca45488f3733d664dcf49187;hp=1a487778ee1f599b35365190640640fd34d9e4c8;hpb=2b82e64c69f174f27b440c8996386b7f2576828e;p=platform%2Fcore%2Fuifw%2Fdali-core.git diff --git a/dali/internal/event/common/object-impl.h b/dali/internal/event/common/object-impl.h index 1a48777..035e7ee 100644 --- a/dali/internal/event/common/object-impl.h +++ b/dali/internal/event/common/object-impl.h @@ -2,7 +2,7 @@ #define __DALI_INTERNAL_OBJECT_H__ /* - * Copyright (c) 2015 Samsung Electronics Co., Ltd. + * Copyright (c) 2017 Samsung Electronics Co., Ltd. * * Licensed under the Apache License, Version 2.0 (the "License"); * you may not use this file except in compliance with the License. @@ -28,7 +28,7 @@ #include #include #include -#include +#include #include #include #include @@ -41,6 +41,7 @@ class PropertyNotification; namespace Internal { +class Animation; class ConstraintBase; class EventThreadServices; class Handle; @@ -59,6 +60,7 @@ typedef std::vector< Dali::Constraint > ConstraintContainer; typedef ConstraintContainer::iterator ConstraintIter; typedef ConstraintContainer::const_iterator ConstraintConstIter; + /** * A base class for objects which optionally provide properties. * The concrete derived class is responsible for implementing the property system methods. @@ -150,6 +152,16 @@ public: virtual Property::Index GetPropertyIndex( const std::string& name ) const; /** + * @copydoc Dali::Handle::GetPropertyIndex() + */ + virtual Property::Index GetPropertyIndex( Property::Index key ) const; + + /** + * @copydoc Dali::Handle::GetPropertyIndex() + */ + virtual Property::Index GetPropertyIndex( Property::Key key ) const; + + /** * @copydoc Dali::Handle::IsPropertyWritable() */ virtual bool IsPropertyWritable( Property::Index index ) const; @@ -180,6 +192,13 @@ public: virtual Property::Value GetProperty( Property::Index index ) const; /** + * @brief Retrieves the latest value of the property on the scene-graph. + * @param[in] index The index of the property required. + * @return The latest value of the property on the scene-graph. + */ + virtual Property::Value GetCurrentProperty( Property::Index index ) const; + + /** * @copydoc Dali::Handle::GetPropertyIndices() */ virtual void GetPropertyIndices( Property::IndexContainer& indices ) const; @@ -190,11 +209,21 @@ public: virtual Property::Index RegisterProperty( const std::string& name, const Property::Value& propertyValue ); /** + * @copydoc Dali::Handle::RegisterProperty() + */ + virtual Property::Index RegisterProperty( const std::string& name, Property::Index key, const Property::Value& propertyValue ); + + /** * @copydoc Dali::Handle::RegisterProperty(std::string name, Property::Value propertyValue, Property::AccessMode accessMode) */ virtual Property::Index RegisterProperty( const std::string& name, const Property::Value& propertyValue, Property::AccessMode accessMode ); /** + * @brief Implementing method for this override + */ + virtual Property::Index RegisterProperty( const std::string& name, Property::Index key, const Property::Value& propertyValue, Property::AccessMode accessMode ); + + /** * @copydoc Dali::Handle::AddPropertyNotification() */ virtual Dali::PropertyNotification AddPropertyNotification( Property::Index index, @@ -211,7 +240,27 @@ public: */ virtual void RemovePropertyNotifications(); - // Constraints + /** + * Notifies that a property is being animated. + * @param[in] animation The animation animating the property. + * @param[in] index The index of the property. + * @param[in] value The value of the property after the animation. + */ + void NotifyPropertyAnimation( Animation& animation, Property::Index index, const Property::Value& value ); + + /******************************** Uniform Mappings ********************************/ + + /** + * @copydoc Dali::Handle::AddUniformMapping() + */ + void AddUniformMapping( Property::Index propertyIndex, const std::string& uniformName ) const; + + /** + * @copydoc Dali::Handle::RemoveUniformMapping( ) + */ + void RemoveUniformMapping( const std::string& uniformName ); + + /******************************** Constraints ********************************/ /** * Apply a constraint to an Object. @@ -249,7 +298,7 @@ public: return PROPERTY_CUSTOM_START_INDEX; } - // To be overridden by deriving classes + /******************** To be overridden by deriving classes ********************/ /** * Retrieve the scene-graph object added by this object. @@ -266,7 +315,7 @@ public: virtual const SceneGraph::PropertyBase* GetSceneObjectAnimatableProperty( Property::Index index ) const = 0; /** - * Retrieve an constraint input-property owned by the scene-graph object. + * Retrieve a constraint input-property owned by the scene-graph object. * @pre -1 < index < GetPropertyCount(). * @param[in] index The index of the property. * @return A dereferenceable pointer to an input property, or NULL if a scene-object does not exist with this property. @@ -299,6 +348,15 @@ protected: void OnSceneObjectRemove(); /** + * For overriding by derived classes to return the parent of this object. + */ + virtual Object* GetParentObject() const + { + // By default the Object does not have a parent + return NULL; + }; + + /** * For use in derived classes. * This is called after a property is set. * @param [in] index The index of the property. @@ -330,11 +388,12 @@ protected: /** * Helper to register a scene-graph property * @param [in] name The name of the property. + * @param [in] key The key of the property * @param [in] index The index of the property * @param [in] value The value of the property. * @return The index of the registered property or Property::INVALID_INDEX if registration failed. */ - Property::Index RegisterSceneGraphProperty(const std::string& name, Property::Index index, const Property::Value& propertyValue) const; + Property::Index RegisterSceneGraphProperty(const std::string& name, Property::Index key, Property::Index index, const Property::Value& propertyValue) const; /** * Check whether the animatable property is registered already, if not then register one. @@ -343,6 +402,11 @@ protected: */ AnimatablePropertyMetadata* RegisterAnimatableProperty(Property::Index index) const; + /** + * Resolve the index and name of child properties if any. + */ + void ResolveChildProperties(); + private: // Default property extensions for derived classes /** @@ -417,6 +481,22 @@ private: // Default property extensions for derived classes virtual Property::Value GetDefaultProperty( Property::Index index ) const = 0; /** + * Retrieve the latest scene-graph value of a default property. + * @param[in] index The index of the property. + * @return The latest scene-graph value of a default property. + */ + virtual Property::Value GetDefaultPropertyCurrentValue( Property::Index index ) const = 0; + + /** + * Notifies that a default property is being animated so the deriving class should update the cached value. + * @param[in] animation The animation animating the property. + * @param[in] index The index of the property. + * @param[in] value The value of the property after the animation. + */ + virtual void OnNotifyDefaultPropertyAnimation( Animation& animation, Property::Index index, const Property::Value& value ) + { } + + /** * @todo this is virtual so that for now actor can override it, * it needs to be removed and only have GetSceneObject but that requires changing actor and constraint logic * Retrieve the scene-graph object added by this object. @@ -456,11 +536,11 @@ private: void DisablePropertyNotifications(); /** - * Get the value of the property. - * @param [in] entry An entry from the property lookup container. - * @return The new value of the property. + * Get the latest value of the property on the scene-graph. + * @param[in] entry An entry from the property lookup container. + * @return The latest value of the property. */ - Property::Value GetPropertyValue( const PropertyMetadata* entry ) const; + Property::Value GetCurrentPropertyValue( const PropertyMetadata* entry ) const; /** * Set the value of scene graph property. @@ -516,7 +596,6 @@ private: typedef PropertyNotificationContainer::const_iterator PropertyNotificationContainerConstIter; PropertyNotificationContainer* mPropertyNotifications; ///< Container of owned property notifications. }; - } // namespace Internal // Helpers for public-api forwarding methods