-#ifndef __DALI_INTERNAL_OBJECT_H__
-#define __DALI_INTERNAL_OBJECT_H__
+#ifndef DALI_INTERNAL_OBJECT_H
+#define DALI_INTERNAL_OBJECT_H
/*
- * Copyright (c) 2016 Samsung Electronics Co., Ltd.
+ * Copyright (c) 2020 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.
*
*/
+// EXTERNAL INCLUDES
+#include <cstdint> // uint32_t
+
// INTERNAL INCLUDES
#include <dali/public-api/animation/constraint.h>
#include <dali/public-api/common/dali-vector.h>
#include <dali/public-api/object/property.h>
#include <dali/public-api/object/property-index-ranges.h>
#include <dali/public-api/object/property-input.h>
+#include <dali/public-api/object/property-map.h>
#include <dali/public-api/object/property-notification.h>
#include <dali/devel-api/common/owner-container.h>
+#include <dali/devel-api/object/handle-devel.h>
+#include <dali/internal/event/animation/animation-impl.h>
#include <dali/internal/event/common/event-thread-services.h>
#include <dali/internal/event/common/property-input-impl.h>
#include <dali/internal/event/common/property-metadata.h>
{
class ConstraintBase;
class EventThreadServices;
-class Handle;
class PropertyCondition;
class PropertyInputImpl;
class Stage;
class PropertyOwner;
}
-typedef std::vector< Dali::Constraint > ConstraintContainer;
-typedef ConstraintContainer::iterator ConstraintIter;
-typedef ConstraintContainer::const_iterator ConstraintConstIter;
-
+using ConstraintContainer = std::vector< Dali::Constraint >;
+using ConstraintIter = ConstraintContainer::iterator;
+using ConstraintConstIter = ConstraintContainer::const_iterator;
/**
* A base class for objects which optionally provide properties.
* An object for a property-owning object in the scene-graph.
* This provides an interface for observing the addition/removal of scene-objects.
*
- * The concrete derived class is responsible for:
- * 1) Adding & removing an object from the scene-graph. The OnSceneObjectAdd() and OnSceneObjectRemove()
- * methods should be called by the derived class, to trigger observer callbacks.
- * 3) Implementing the GetSceneObject() methods, used to access the scene-object.
- * 4) Providing access to properties stored by the scene-graph object. These should match the properties
- * reported by the base Dali::Internal::Object methods.
- *
+ * The derived class should either:
+ * a) Create their own scene-graph object and pass it to Object constructor.
+ * b) pass nullptr to Object constructor, in this case Object will create default scene object for property handling
*/
class Object : public Dali::BaseObject
{
public:
- typedef Dali::Handle::Capability Capability;
+ using Capability = Dali::Handle::Capability;
class Observer
{
};
/**
- * Constructor.
+ * Creates a new object
+ *
+ * @return an smart pointer to the object
*/
- Object();
+ static IntrusivePtr<Object> New();
/**
* Add an observer to the object.
* @param[in] observer The observer to add.
*/
- virtual void AddObserver( Observer& observer );
+ void AddObserver( Observer& observer );
/**
* Remove an observer from the object
* @pre The observer has already been added.
* @param[in] observer The observer to remove.
*/
- virtual void RemoveObserver( Observer& observer );
+ void RemoveObserver( Observer& observer );
/**
* @copydoc Dali::Handle::Supports()
*/
- virtual bool Supports( Capability capability ) const;
+ bool Supports( Capability capability ) const;
/**
* @copydoc Dali::Handle::GetPropertyCount()
*/
- virtual unsigned int GetPropertyCount() const;
+ uint32_t GetPropertyCount() const;
/**
* @copydoc Dali::Handle::GetPropertyName()
*/
- virtual std::string GetPropertyName( Property::Index index ) const;
+ std::string GetPropertyName( Property::Index index ) const;
/**
* @copydoc Dali::Handle::GetPropertyIndex()
*/
- virtual Property::Index GetPropertyIndex( const std::string& name ) const;
-
- /**
- * @copydoc Dali::Handle::GetPropertyIndex()
- */
- virtual Property::Index GetPropertyIndex( Property::Index key ) const;
+ Property::Index GetPropertyIndex( Property::Key key ) const;
/**
* @copydoc Dali::Handle::IsPropertyWritable()
*/
- virtual bool IsPropertyWritable( Property::Index index ) const;
+ bool IsPropertyWritable( Property::Index index ) const;
/**
* @copydoc Dali::Handle::IsPropertyAnimatable()
*/
- virtual bool IsPropertyAnimatable( Property::Index index ) const;
+ bool IsPropertyAnimatable( Property::Index index ) const;
/**
* @copydoc Dali::Handle::IsPropertyAConstraintInput()
*/
- virtual bool IsPropertyAConstraintInput( Property::Index index ) const;
+ bool IsPropertyAConstraintInput( Property::Index index ) const;
/**
* @copydoc Dali::Handle::GetPropertyType()
*/
- virtual Property::Type GetPropertyType( Property::Index index ) const;
+ Property::Type GetPropertyType( Property::Index index ) const;
/**
* @copydoc Dali::Handle::SetProperty()
*/
- virtual void SetProperty( Property::Index index, const Property::Value& propertyValue );
+ void SetProperty( Property::Index index, const Property::Value& propertyValue );
/**
* @copydoc Dali::Handle::GetProperty()
*/
- virtual Property::Value GetProperty( Property::Index index ) const;
+ 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.
+ */
+ Property::Value GetCurrentProperty( Property::Index index ) const;
/**
* @copydoc Dali::Handle::GetPropertyIndices()
*/
- virtual void GetPropertyIndices( Property::IndexContainer& indices ) const;
+ void GetPropertyIndices( Property::IndexContainer& indices ) const;
/**
* @copydoc Dali::Handle::RegisterProperty()
*/
- virtual Property::Index RegisterProperty( const std::string& name, const Property::Value& propertyValue );
+ 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 );
+ Property::Index RegisterProperty( const std::string& name, Property::Index key, const Property::Value& propertyValue );
+
+ /**
+ * @copydoc Dali::DevelHandle::SetProperties()
+ */
+ void SetProperties( const Property::Map& properties );
+
+ /**
+ * @copydoc Dali::DevelHandle::GetProperties()
+ */
+ void GetProperties( Property::Map& properties );
/**
* @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 );
+ 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 );
+ Property::Index RegisterProperty( const std::string& name, Property::Index key, const Property::Value& propertyValue, Property::AccessMode accessMode );
+
+ /**
+ * @brief returns true if the custom property exists on this object.
+ *
+ * @note The property may be defined for a type within the type registry, but it isn't explicity
+ * defined in every consequent instantiation. It can be automatically added, e.g. parenting an actor
+ * automatically registers it's parent container's child properties.
+ *
+ * @param[in] handle The handle of the object to test
+ * @param[in] index The property index to look for.
+ * @return true if the property exists on the object, false otherwise.
+ */
+ bool DoesCustomPropertyExist( Property::Index index );
/**
* @copydoc Dali::Handle::AddPropertyNotification()
*/
- virtual Dali::PropertyNotification AddPropertyNotification( Property::Index index,
- int componentIndex,
- const Dali::PropertyCondition& condition );
+ Dali::PropertyNotification AddPropertyNotification( Property::Index index,
+ int32_t componentIndex,
+ const Dali::PropertyCondition& condition );
/**
* @copydoc Dali::Handle::RemovePropertyNotification()
*/
- virtual void RemovePropertyNotification( Dali::PropertyNotification propertyNotification );
+ void RemovePropertyNotification( Dali::PropertyNotification propertyNotification );
/**
* @copydoc Dali::Handle::RemovePropertyNotifications()
*/
- virtual void RemovePropertyNotifications();
+ void RemovePropertyNotifications();
+
+ /**
+ * 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.
+ * @param[in] animationType Whether the property value given is the target or a relative value.
+ */
+ void NotifyPropertyAnimation( Animation& animation, Property::Index index, const Property::Value& value, Animation::Type animationType );
/******************************** Uniform Mappings ********************************/
/**
- * @copydoc Dali::Handle::AddUniformMapping()
+ * Adds uniform mapping for given property
+ * @param propertyIndex index of the property
+ * @param uniformName name of the uniform (same as property name)
*/
void AddUniformMapping( Property::Index propertyIndex, const std::string& uniformName ) const;
/**
- * @copydoc Dali::Handle::RemoveUniformMapping( )
+ * Removes uniform mapping for given property
+ * @param uniformName name of the uniform (same as property name)
*/
- void RemoveUniformMapping( const std::string& uniformName );
+ void RemoveUniformMapping( const std::string& uniformName ) const;
/******************************** Constraints ********************************/
void RemoveConstraints();
/**
- * Remove all constraints from a Object with a matching tag
+ * @copydoc Dali::Handle::RemoveConstraints( uint32_t )
*/
- void RemoveConstraints( unsigned int tag );
+ void RemoveConstraints( uint32_t tag );
/**
* Called by TypeInfo to set the type-info that this object-impl is created by.
/**
* @return the index from which custom properties start
*/
- unsigned int CustomPropertyStartIndex()
+ uint32_t CustomPropertyStartIndex()
{
return PROPERTY_CUSTOM_START_INDEX;
}
- /******************** To be overridden by deriving classes ********************/
-
/**
* Retrieve the scene-graph object added by this object.
- * @return A pointer to the object, or NULL if no object has been added to the scene-graph.
+ * @return reference to the scene-graph object, it will always exist
*/
- virtual const SceneGraph::PropertyOwner* GetSceneObject() const = 0;
+ const SceneGraph::PropertyOwner& GetSceneObject() const;
+
+ /******************** Can be overridden by deriving classes ********************/
/**
* Retrieve an animatable property owned by the scene-graph object.
* @param[in] index The index of the property.
* @return A dereferenceable pointer to a property, or NULL if a scene-object does not exist with this property.
*/
- virtual const SceneGraph::PropertyBase* GetSceneObjectAnimatableProperty( Property::Index index ) const = 0;
+ virtual const SceneGraph::PropertyBase* GetSceneObjectAnimatableProperty( Property::Index index ) const;
/**
* Retrieve a constraint input-property owned by the scene-graph object.
* @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.
*/
- virtual const PropertyInputImpl* GetSceneObjectInputProperty( Property::Index index ) const = 0;
+ virtual const PropertyInputImpl* GetSceneObjectInputProperty( Property::Index index ) const;
/**
* Query whether the property is a component of a scene-graph property.
* @param[in] index The index of the property.
* @return The index or Property::INVALID_COMPONENT_INDEX.
*/
- virtual int GetPropertyComponentIndex( Property::Index index ) const;
+ virtual int32_t GetPropertyComponentIndex( Property::Index index ) const;
+
+ /**
+ * Query whether playing an animation is possible or not.
+ * @return true if playing an animation is possible.
+ */
+ virtual bool IsAnimationPossible() const
+ {
+ return true;
+ }
+
+ /**
+ * @copydoc Dali::Handle::PropertySetSignal()
+ */
+ Handle::PropertySetSignalType& PropertySetSignal();
protected:
/**
+ * Constructor. Protected so use New to construct an instance of this class
+ *
+ * @param sceneObject the scene graph property owner
+ */
+ Object( const SceneGraph::PropertyOwner* sceneObject );
+
+ /**
* A reference counted object may only be deleted by calling Unreference()
*/
- virtual ~Object();
+ ~Object() override;
/**
* Called immediately by derived classes, after the scene-object has been created & passed to the scene-graph.
virtual Object* GetParentObject() const
{
// By default the Object does not have a parent
- return NULL;
+ return nullptr;
};
/**
* @param [in] index The index of the property.
* @param [in] propertyValue The value of the property.
*/
- virtual void OnPropertySet( Property::Index index, Property::Value propertyValue ) {}
+ virtual void OnPropertySet( Property::Index index, const Property::Value& propertyValue ) {}
/**
* Retrieves the TypeInfo for this object. Only retrieves it from the type-registry once and then stores a pointer
* @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 key, 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.
+ * Registers animatable scene property
+ * @param typeInfo to check the default value
+ * @param index of the property to register
+ * @param value initial value or nullptr
+ */
+ void RegisterAnimatableProperty( const TypeInfo& typeInfo, Property::Index index, const Property::Value* value ) const;
+
+ /**
+ * Check whether the animatable property is registered already, if not then register on.
* @param [in] index The index of the property
- * @return pointer to the property.
+ * @param [in] value optional value for the property
+ * @return pointer to the property metadata
*/
- AnimatablePropertyMetadata* RegisterAnimatableProperty(Property::Index index) const;
+ AnimatablePropertyMetadata* GetSceneAnimatableProperty( Property::Index index, const Property::Value* value ) const;
/**
* Resolve the index and name of child properties if any.
private: // Default property extensions for derived classes
/**
- * Query how many default properties the derived class supports.
- * @return The number of default properties.
- */
- virtual unsigned int GetDefaultPropertyCount() const = 0;
-
- /**
- * Retrieve all the indices that are associated with the default properties supported by the derived class.
- * @return A container of default property indices.
- * @note The deriving class must not modify the existing elements in the container.
- */
- virtual void GetDefaultPropertyIndices( Property::IndexContainer& indices ) const = 0;
-
- /**
- * Query how many default properties the derived class supports.
- * @return The number of default properties.
- */
- virtual const char* GetDefaultPropertyName( Property::Index index ) const = 0;
-
- /**
- * Query the index of a default property.
- * @param [in] name The name of the property.
- * @return The index of the property, or Property::INVALID_INDEX if no default property exists with the given name.
- */
- virtual Property::Index GetDefaultPropertyIndex( const std::string& name ) const = 0;
-
- /**
- * Query whether a default property is writable.
- * @param [in] index The index of the property.
- * @return True if the property is animatable.
- */
- virtual bool IsDefaultPropertyWritable( Property::Index index ) const = 0;
-
- /**
- * Query whether a default property is animatable.
- * This determines whether the property can be the target of an animation or constraint.
- * @param [in] index The index of the property.
- * @return True if the property is animatable.
- */
- virtual bool IsDefaultPropertyAnimatable( Property::Index index ) const = 0;
-
- /**
- * @brief Query whether a default property can be used as an input to a constraint.
- *
- * @param [in] index The index of the property.
- * @return True if the property can be used as an input to a constraint.
- */
- virtual bool IsDefaultPropertyAConstraintInput( Property::Index index ) const = 0;
-
- /**
- * Query the type of a default property.
- * @param [in] index The index of the property.
- * @return The type of the property.
- */
- virtual Property::Type GetDefaultPropertyType( Property::Index index ) const = 0;
-
- /**
* Set the value of a default property.
* @pre The property types match i.e. propertyValue.GetType() is equal to GetPropertyType(index).
* @param [in] index The index of the property.
* @param [in] propertyValue The new value of the property.
*/
- virtual void SetDefaultProperty( Property::Index index, const Property::Value& propertyValue ) = 0;
+ virtual void SetDefaultProperty( Property::Index index, const Property::Value& propertyValue );
/**
* Retrieve a default property value.
* @param [in] index The index of the property.
* @return The property value.
*/
- virtual Property::Value GetDefaultProperty( Property::Index index ) const = 0;
+ virtual Property::Value GetDefaultProperty( Property::Index index ) const;
/**
- * @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.
- * @return A pointer to the object, or NULL if no object has been added to the scene-graph.
+ * 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 const SceneGraph::PropertyOwner* GetPropertyOwner() const
- {
- return GetSceneObject();
- }
+ virtual Property::Value GetDefaultPropertyCurrentValue( Property::Index index ) const;
/**
- * Notify derived class of installation of a new scene-object property.
- * This method is called after the message is to sent to install the property
- * @param [in] newProperty A newly allocated scene-object property. Ownership is obviously not passed.
- * @param [in] name The name allocated to this custom property.
- * @param [in] index The index allocated to this custom property.
+ * 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.
+ * @param[in] animationType Whether the property value given is the target or a relative value.
*/
- virtual void NotifyScenePropertyInstalled( const SceneGraph::PropertyBase& newProperty, const std::string& name, unsigned int index ) const
+ virtual void OnNotifyDefaultPropertyAnimation( Animation& animation, Property::Index index, const Property::Value& value, Animation::Type propertyChangeType )
{ }
private:
- // Not implemented
- Object(const Object& rhs);
-
- // Not implemented
- Object& operator=(const Object& rhs);
+ // no default, copy or assignment
+ Object() = delete;
+ Object(const Object& rhs) = delete;
+ Object& operator=(const Object& rhs) = delete;
/**
* Enable property notifications in scene graph
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.
*/
inline EventThreadServices& GetEventThreadServices()
{
- DALI_ASSERT_DEBUG( EventThreadServices::IsCoreRunning() );
+ DALI_ASSERT_ALWAYS( EventThreadServices::IsCoreRunning() );
return mEventThreadServices;
}
*/
inline const EventThreadServices& GetEventThreadServices() const
{
- DALI_ASSERT_DEBUG( EventThreadServices::IsCoreRunning() );
+ DALI_ASSERT_ALWAYS( EventThreadServices::IsCoreRunning() );
return mEventThreadServices;
}
private:
+
EventThreadServices& mEventThreadServices;
-private:
+protected:
+
+ // mutable because it's lazy initialised and GetSceneObject has to be const so it can be called from const methods
+ // const to prevent accidentally calling setters directly from event thread
+ // protected to allow fast access from derived classes that have their own scene object (no function call overhead)
+ mutable const SceneGraph::PropertyOwner* mUpdateObject; ///< Reference to object to hold the scene graph properties
- typedef OwnerContainer<PropertyMetadata*> PropertyMetadataLookup;
- mutable PropertyMetadataLookup mCustomProperties; ///< Used for accessing custom Node properties
- mutable PropertyMetadataLookup mAnimatableProperties; ///< Used for accessing animatable Node properties
- mutable TypeInfo const * mTypeInfo; ///< The type-info for this object, mutable so it can be lazy initialized from const method if it is required
+private:
Dali::Vector<Observer*> mObservers;
+ mutable OwnerContainer<PropertyMetadata*> mCustomProperties; ///< Used for accessing custom Node properties
+ mutable OwnerContainer<PropertyMetadata*> mAnimatableProperties; ///< Used for accessing animatable Node properties
+ mutable const TypeInfo* mTypeInfo; ///< The type-info for this object, mutable so it can be lazy initialized from const method if it is required
ConstraintContainer* mConstraints; ///< Container of owned -constraints.
- typedef std::vector< Dali::PropertyNotification > PropertyNotificationContainer;
- typedef PropertyNotificationContainer::iterator PropertyNotificationContainerIter;
- typedef PropertyNotificationContainer::const_iterator PropertyNotificationContainerConstIter;
+ using PropertyNotificationContainer = std::vector< Dali::PropertyNotification >;
PropertyNotificationContainer* mPropertyNotifications; ///< Container of owned property notifications.
+
+ Handle::PropertySetSignalType mPropertySetSignal;
};
+
} // namespace Internal
// Helpers for public-api forwarding methods
} // namespace Dali
-#endif // __DALI_INTERNAL_OBJECT_H__
+#endif // DALI_INTERNAL_OBJECT_H
projects / platform / core / uifw / dali-core.git / blobdiff