#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.
#include <dali-toolkit/devel-api/visual-factory/visual-base.h>
#include <dali-toolkit/internal/visuals/transition-data-impl.h>
#include <dali-toolkit/internal/visuals/visual-factory-cache.h>
+#include <dali-toolkit/devel-api/direction-enums.h>
+#include <dali-toolkit/public-api/visuals/visual-properties.h>
+#include <dali-toolkit/devel-api/visuals/visual-properties-devel.h>
namespace Dali
{
namespace Visual
{
+class EventObserver;
+
+using FittingMode = DevelVisual::FittingMode;
+
/**
* Base class for all Control rendering logic. A control may have multiple visuals.
*
/**
* @copydoc Toolkit::Visual::Base::GetName
*/
- const std::string& GetName();
+ const std::string& GetName() const;
/**
* @copydoc Toolkit::Visual::Base::SetSize
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 );
/**
* @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
+ * @copydoc Toolkit::Visual::Base::SetOnScene
* @pre Impl->mGeometry must be created before this method is called
*/
- void SetOnStage( Actor& actor );
+ void SetOnScene( Actor& actor );
/**
- * @copydoc Toolkit::Visual::Base::SetOffStage
+ * @copydoc Toolkit::Visual::Base::SetOffScene
*/
- void SetOffStage( Actor& actor );
+ void SetOffScene( Actor& actor );
/**
* @copydoc Toolkit::Visual::Base::CreatePropertyMap
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.
* 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();
+
+ /**
+ * @brief Query whether resources requires to be loaded synchronously.
+ * @return Returns true if synchronous resource loading is required, false otherwise.
+ */
+ bool IsSynchronousLoadingRequired() const;
+
+ /**
+ * @brief Get the type of this visual.
+ *
+ * @return The the type of this visual.
+ */
+ Toolkit::Visual::Type GetType() const;
+
+ protected:
/**
* @brief Constructor.
*
* @param[in] factoryCache A pointer pointing to the VisualFactoryCache object
+ * @param[in] fittingMode The value that determines how the visual should be fit to the view
+ * @param[in] type The type of the this visual
*/
- Base( VisualFactoryCache& factoryCache );
+ Base( VisualFactoryCache& factoryCache, FittingMode fittingMode, Toolkit::Visual::Type type );
/**
* @brief A reference counted object may only be deleted by calling Unreference().
*/
- virtual ~Base();
+ ~Base() override;
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.
virtual void OnSetTransform() = 0;
/**
- * @brief Called by SetOnStage() allowing sub classes to respond to the SetOnStage event
+ * @brief Called by SetOnScene() allowing sub classes to respond to the SetOnScene event
*
* @note The derived class is required to create the renderer, and add it to the actor when all the resources are in place.
*
* @param[in] actor The actor applying this visual.
*/
- virtual void DoSetOnStage( Actor& actor )=0;
+ virtual void DoSetOnScene( Actor& actor ) = 0;
/**
- * @brief Called by SetOffStage() allowing sub classes to respond to the SetOffStage event
+ * @brief Called by SetOffScene() allowing sub classes to respond to the SetOffScene event
*
* @param[in] actor The actor applying this visual.
*/
- virtual void DoSetOffStage( Actor& actor );
+ virtual void DoSetOffScene( 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:
/**
- * @brief Gets the on stage state for this Visual
+ * @brief Gets the on scene state for this Visual
*
- * @return Returns true if this Visual is on stage, false if it is off the stage
+ * @return Returns true if this Visual is on the scene, false if it is off the scene
*/
- bool IsOnStage() const;
+ bool IsOnScene() const;
/**
- * @brief Gets whether the Dali::Renderer is from a shared cache (and therefore any modifications will affect other users of that renderer)
+ * @brief Query whether the corners of the visual requires to be rounded.
*
- * @return Returns true if the renderer is from shared cache, false otherwise
+ * @return Returns true if the rounded corner is required, false otherwise.
*/
- bool IsFromCache() const;
+ bool IsRoundedCornerRequired() const;
private: