X-Git-Url: http://review.tizen.org/git/?p=platform%2Fcore%2Fuifw%2Fdali-toolkit.git;a=blobdiff_plain;f=dali-toolkit%2Finternal%2Fvisuals%2Fvisual-base-impl.h;h=754c8383ed1698c7ef06346aa70309c248c603a1;hp=e7d8ddd45939c3ef1d17ef3170442450c83afa9f;hb=7c1ca2d9ab3bc63f3dc164c4f5d4ea0d8bf5ba3e;hpb=914231e0f3c8642c4ed57fc46c078ba1dd1fe97a diff --git a/dali-toolkit/internal/visuals/visual-base-impl.h b/dali-toolkit/internal/visuals/visual-base-impl.h index e7d8ddd..754c838 100644 --- a/dali-toolkit/internal/visuals/visual-base-impl.h +++ b/dali-toolkit/internal/visuals/visual-base-impl.h @@ -2,7 +2,7 @@ #define DALI_TOOLKIT_INTERNAL_VISUAL_H /* - * Copyright (c) 2016 Samsung Electronics Co., Ltd. + * Copyright (c) 2018 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. @@ -31,6 +31,9 @@ #include #include #include +#include +#include +#include namespace Dali { @@ -44,6 +47,10 @@ namespace Internal namespace Visual { +class EventObserver; + +using FittingMode = DevelVisual::FittingMode; + /** * Base class for all Control rendering logic. A control may have multiple visuals. * @@ -82,7 +89,7 @@ public: /** * @copydoc Toolkit::Visual::Base::GetName */ - const std::string& GetName(); + const std::string& GetName() const; /** * @copydoc Toolkit::Visual::Base::SetSize @@ -90,6 +97,14 @@ public: void SetTransformAndSize( const Property::Map& transform, Size controlSize ); /** + * @brief Performs an action on the visual with the given action name and attributes. + * + * @param[in] actionName The name of the action to perform this API only takes an Index + * @param[in] attributes The list of attributes for the action. ( optional for this data structure to have content ) + */ + void DoAction( const Dali::Property::Index actionName, const Dali::Property::Value attributes ); + + /** * @copydoc Toolkit::Visual::Base::GetHeightForWidth */ virtual float GetHeightForWidth( float width ); @@ -107,12 +122,12 @@ public: /** * @copydoc Toolkit::Visual::Base::SetDepthIndex */ - void SetDepthIndex( float index ); + void SetDepthIndex( int index ); /** * @copydoc Toolkit::Visual::Base::GetDepthIndex */ - float GetDepthIndex() const; + int GetDepthIndex() const; /** * @copydoc Toolkit::Visual::Base::SetOnStage @@ -131,11 +146,21 @@ public: void CreatePropertyMap( Property::Map& map ) const; /** + * @brief Create a property map containing per-instance visual properties. + * + * This will enable creation of new visuals on control state change with + * any alternative style properties and the relevant instance properties + * (e.g. for image visual, the desired size, and for text visual, the actual text). + * @param[in] map The property map into which to write + */ + void CreateInstancePropertyMap( Property::Map& map ) const; + + /** * @brief Set whether the Pre-multiplied Alpha Blending is required * - * @param[in] preMultipled whether alpha is pre-multiplied. + * @param[in] preMultiplied whether alpha is pre-multiplied. */ - void EnablePreMultipliedAlpha( bool preMultipled ); + void EnablePreMultipliedAlpha( bool preMultiplied ); /** * @brief Query whether alpha is pre-multiplied. @@ -192,20 +217,63 @@ public: * If the visual isn't staged (i.e. it doesn't have a renderer), * then this will not add an animation. * + * If the animator is valid and the transition handle is empty - it will + * be created. + * * @param[in] transition The animation to create or attach to * @param[in] animator The animation parameters of the property. */ void AnimateProperty( Dali::Animation& transition, Internal::TransitionData::Animator& animator ); -protected: + /** + * @brief Add an observer to watch for when the Visuals have events to notify + * Currently only supports a single observer + */ + void AddEventObserver( Visual::EventObserver& observer ); + + /** + * @brief Remove an observer + */ + void RemoveEventObserver( Visual::EventObserver& observer ); + + /** + * @brief Called when the visuals resources are loaded / ready + */ + void ResourceReady( Toolkit::Visual::ResourceStatus resourceStatus ); + + /** + * @brief Called when the visuals resources are loaded / ready + * @return true if ready, false otherwise + */ + virtual bool IsResourceReady() const; + + /** + * @brief Get the loading state of the visual resource + * @return Return the loading status (PREPARING, READY and FAILED) of visual resource + */ + Toolkit::Visual::ResourceStatus GetResourceStatus() const; + + /** + * @brief Get the fitting mode for the visual + */ + FittingMode GetFittingMode() const; + + /** + * @brief Get the actual Visual Object. + * @return The actual visual object + * @note Should be overridden by deriving controls if they are acting as a proxy to other visual objects. + */ + virtual Base& GetVisualObject(); + + protected: /** * @brief Constructor. * * @param[in] factoryCache A pointer pointing to the VisualFactoryCache object */ - Base( VisualFactoryCache& factoryCache ); + Base( VisualFactoryCache& factoryCache, FittingMode fittingMode ); /** * @brief A reference counted object may only be deleted by calling Unreference(). @@ -222,6 +290,15 @@ protected: virtual void DoCreatePropertyMap( Property::Map& map ) const = 0; /** + * @brief Called by CreateInstancePropertyMap() allowing derived + * classes to store instanced data (separate to styled data) that + * needs copying between visuals on state change. + * + * @param[out] map The visual property map + */ + virtual void DoCreateInstancePropertyMap( Property::Map& map ) const = 0; + + /** * @brief Called by SetProperties() allowing sub classes to set their properties * * @param[in] propertyMap The properties for the requested Visual object. @@ -241,7 +318,7 @@ protected: * * @param[in] actor The actor applying this visual. */ - virtual void DoSetOnStage( Actor& actor )=0; + virtual void DoSetOnStage( Actor& actor ) = 0; /** * @brief Called by SetOffStage() allowing sub classes to respond to the SetOffStage event @@ -250,6 +327,14 @@ protected: */ virtual void DoSetOffStage( Actor& actor ); + /** + * @brief Called by DoAction() allowing sub classes to do the given action. + * + * @param[in] actionId The action to perform + * @param[in] attributes The list of attributes for the action. ( optional for this data structure to have content ) + */ + virtual void OnDoAction( const Property::Index actionId, const Property::Value& attributes ); + protected: /** @@ -259,13 +344,6 @@ protected: */ bool IsOnStage() const; - /** - * @brief Gets whether the Dali::Renderer is from a shared cache (and therefore any modifications will affect other users of that renderer) - * - * @return Returns true if the renderer is from shared cache, false otherwise - */ - bool IsFromCache() const; - private: /**