Merge "Extending Text Styles - Adding Dashed/Double Underline" into devel/master
[platform/core/uifw/dali-toolkit.git] / dali-toolkit / internal / controls / image-view / image-view-impl.h
index 19d75ac..cf288ab 100644 (file)
@@ -1,8 +1,8 @@
-#ifndef __DALI_TOOLKIT_INTERNAL_IMAGE_VIEW_H__
-#define __DALI_TOOLKIT_INTERNAL_IMAGE_VIEW_H__
+#ifndef DALI_TOOLKIT_INTERNAL_IMAGE_VIEW_H
+#define DALI_TOOLKIT_INTERNAL_IMAGE_VIEW_H
 
 /*
- * Copyright (c) 2014 Samsung Electronics Co., Ltd.
+ * Copyright (c) 2022 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/public-api/object/property-map.h>
 
 // INTERNAL INCLUDES
-#include <dali-toolkit/internal/controls/renderers/image/image-renderer.h>
+#include <dali-toolkit/internal/visuals/image/image-visual.h>
 #include <dali-toolkit/public-api/controls/control-impl.h>
 #include <dali-toolkit/public-api/controls/image-view/image-view.h>
 
 namespace Dali
 {
-
 namespace Toolkit
 {
-
 class ImageView;
 
 namespace Internal
@@ -39,7 +37,6 @@ namespace Internal
 class ImageView : public Control
 {
 protected:
-
   /**
    * Construct a new ImageView.
    */
@@ -58,22 +55,38 @@ public:
   static Toolkit::ImageView New();
 
   /**
-   * @copydoc Dali::Toolkit::SetImage
-   */
-  void SetImage( Image image );
-
-  /**
    * @brief Sets this ImageView from an Dali::Property::Map
    *
    * If the handle is empty, ImageView will display nothing
    * @param[in] map The Dali::Property::Map to use for to display.
    */
-  void SetImage( Dali::Property::Map map );
+  void SetImage(const Dali::Property::Map& map);
 
   /**
    * @copydoc Dali::Toolkit::SetImage
    */
-  void SetImage( const std::string& imageUrl, ImageDimensions size );
+  void SetImage(const std::string& imageUrl, ImageDimensions size);
+
+  /**
+   * @brief Unregister ImageView IMAGE visual
+   *
+   * ImageView will display nothing
+   */
+  void ClearImageVisual();
+
+  /**
+   * @brief Set whether the Pre-multiplied Alpha Blending is required
+   *
+   * @param[in] preMultipled whether alpha is pre-multiplied.
+   */
+  void EnablePreMultipliedAlpha(bool preMultipled);
+
+  /**
+   * @brief Query whether alpha is pre-multiplied.
+   *
+   * @return True if alpha is pre-multiplied, false otherwise.
+   */
+  bool IsPreMultipliedAlphaEnabled() const;
 
   // Properties
   /**
@@ -82,7 +95,7 @@ public:
    * @param[in] index The property index.
    * @param[in] value The new property value.
    */
-  static void SetProperty( BaseObject* object, Property::Index index, const Property::Value& value );
+  static void SetProperty(BaseObject* object, Property::Index index, const Property::Value& value);
 
   /**
    * Called to retrieve a property of an object of this type.
@@ -90,69 +103,111 @@ public:
    * @param[in] index The property index.
    * @return The current value of the property.
    */
-  static Property::Value GetProperty( BaseObject* object, Property::Index propertyIndex );
+  static Property::Value GetProperty(BaseObject* object, Property::Index propertyIndex);
 
   /**
    * @brief Set the depth index of this image renderer
    *
-   * Renderer with higher depth indices are rendered in front of other renderers with smaller values
+   * Renderer with higher depth indices are rendered in front of other visuals with smaller values
    *
    * @param[in] depthIndex The depth index of this renderer
    */
-  void SetDepthIndex( int depthIndex );
+  void SetDepthIndex(int depthIndex);
 
 private: // From Control
+  /**
+   * @copydoc Toolkit::Control::OnInitialize
+   */
+  void OnInitialize();
 
   /**
-   * @copydoc Toolkit::Control::OnStageConnect()
+   * @copydoc Toolkit::Control::GetNaturalSize
    */
-  virtual void OnStageConnection( int depth );
+  Vector3 GetNaturalSize() override;
 
   /**
-   * @copydoc Toolkit::Control::OnStageDisconnection()
+   * @copydoc Toolkit::Control::GetHeightForWidth()
    */
-  virtual void OnStageDisconnection();
+  float GetHeightForWidth(float width) override;
 
   /**
-   * @copydoc Toolkit::Control::GetNaturalSize
+   * @copydoc Toolkit::Control::GetWidthForHeight()
    */
-  virtual Vector3 GetNaturalSize();
+  float GetWidthForHeight(float height) override;
 
   /**
-   * @copydoc Toolkit::Control::GetHeightForWidth()
+   * @copydoc Toolkit::Control::OnRelayout()
    */
-  virtual float GetHeightForWidth( float width );
+  void OnRelayout(const Vector2& size, RelayoutContainer& container) override;
 
   /**
-   * @copydoc Toolkit::Control::GetWidthForHeight()
+   * @copydoc Toolkit::Control::OnCreateTransitions()
+   */
+  virtual void OnCreateTransitions(std::vector<std::pair<Dali::Property::Index, Dali::Property::Map>>& sourceProperties,
+                                   std::vector<std::pair<Dali::Property::Index, Dali::Property::Map>>& destinationProperties,
+                                   Dali::Toolkit::Control                                              source,
+                                   Dali::Toolkit::Control                                              destination) override;
+
+  /**
+   * @copydoc Toolkit::Control::OnUpdateVisualProperties()
+   */
+  virtual void OnUpdateVisualProperties(const std::vector<std::pair<Dali::Property::Index, Dali::Property::Map>>& properties) override;
+
+private:
+  /**
+   * @brief Callback for ResourceReadySignal
+   * param[in] control signal prototype
+   */
+  void OnResourceReady(Toolkit::Control control);
+
+  /**
+   * @brief Set TransformMap for fittingMode
+   * param[in] finalSize The size for fittingMode
+   * param[in] textureSize The size of texture
+   * param[in] offset The offset for fittingMode
+   * param[in] fittingMode The mode for fitting image
+   * param[in] transformMap  The map for fitting image
    */
-  virtual float GetWidthForHeight( float height );
+  void SetTransformMapForFittingMode(Vector2 finalSize, Vector2 textureSize, Vector2 offset, Visual::FittingMode fittingMode, Property::Map& transformMap);
+
+  /**
+   * @brief Apply fittingMode
+   * param[in] finalSize The size for fittingMode
+   * param[in] textureSize The size of texture
+   * param[in] offset The offset for fittingMode
+   * param[in] zeroPadding whether padding is zero
+   * param[in] transformMap  The map for fitting image
+   */
+  void ApplyFittingMode(Vector2 finalSize, Vector2 textureSize, Vector2 offset, bool zeroPadding, Property::Map& transformMap);
 
 private:
   // Undefined
-  ImageView( const ImageView& );
-  ImageView& operator=( const ImageView& );
+  ImageView(const ImageView&);
+  ImageView& operator=(const ImageView&);
 
 private:
-  Toolkit::ControlRenderer  mRenderer;
-  ImageDimensions  mImageSize;
+  Toolkit::Visual::Base mVisual;
+
+  std::string     mUrl;         ///< the url for the image if the image came from a URL, empty otherwise
+  Property::Map   mPropertyMap; ///< the Property::Map if the image came from a Property::Map, empty otherwise
+  Property::Map   mShaderMap;   ///< the Property::Map if the custom shader is set, empty otherwise
+  ImageDimensions mImageSize;   ///< the image size
 
-  std::string      mUrl;          ///< the url for the image if the image came from a URL, empty otherwise
-  Image            mImage;        ///< the Image if the image came from a Image, null otherwise
-  Property::Map    mPropertyMap;  ///< the Property::Map if the image came from a Property::Map, empty otherwise
+  bool mImageVisualPaddingSetByTransform : 1;   //< Flag to indicate Padding was set using a transform.
+  bool mImageViewPixelAreaSetByFittingMode : 1; //< Flag to indicate pixel area was set by fitting Mode
 };
 
 } // namespace Internal
 
 // Helpers for public-api forwarding methods
-inline Toolkit::Internal::ImageView& GetImpl( Toolkit::ImageView& obj )
+inline Toolkit::Internal::ImageView& GetImpl(Toolkit::ImageView& obj)
 {
   DALI_ASSERT_ALWAYS(obj);
   Dali::RefObject& handle = obj.GetImplementation();
   return static_cast<Toolkit::Internal::ImageView&>(handle);
 }
 
-inline const Toolkit::Internal::ImageView& GetImpl( const Toolkit::ImageView& obj )
+inline const Toolkit::Internal::ImageView& GetImpl(const Toolkit::ImageView& obj)
 {
   DALI_ASSERT_ALWAYS(obj);
   const Dali::RefObject& handle = obj.GetImplementation();
@@ -163,4 +218,4 @@ inline const Toolkit::Internal::ImageView& GetImpl( const Toolkit::ImageView& ob
 
 } // namespace Dali
 
-#endif // __DALI_TOOLKIT_INTERNAL_IMAGE_VIEW_H__
+#endif // DALI_TOOLKIT_INTERNAL_IMAGE_VIEW_H