dali-toolkit/internal/controls/image-view/image-view-impl.h

   1 #ifndef DALI_TOOLKIT_INTERNAL_IMAGE_VIEW_H
   2 #define DALI_TOOLKIT_INTERNAL_IMAGE_VIEW_H
   3
   4 /*
   5  * Copyright (c) 2020 Samsung Electronics Co., Ltd.
   6  *
   7  * Licensed under the Apache License, Version 2.0 (the "License");
   8  * you may not use this file except in compliance with the License.
   9  * You may obtain a copy of the License at
  10  *
  11  * http://www.apache.org/licenses/LICENSE-2.0
  12  *
  13  * Unless required by applicable law or agreed to in writing, software
  14  * distributed under the License is distributed on an "AS IS" BASIS,
  15  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  16  * See the License for the specific language governing permissions and
  17  * limitations under the License.
  18  *
  19  */
  20
  21 // EXTERNAL INCLUDES
  22 #include <dali/public-api/object/property-map.h>
  23
  24 // INTERNAL INCLUDES
  25 #include <dali-toolkit/internal/visuals/image/image-visual.h>
  26 #include <dali-toolkit/public-api/controls/control-impl.h>
  27 #include <dali-toolkit/public-api/controls/image-view/image-view.h>
  28
  29 namespace Dali
  30 {
  31
  32 namespace Toolkit
  33 {
  34
  35 class ImageView;
  36
  37 namespace Internal
  38 {
  39 class ImageView : public Control
  40 {
  41 protected:
  42
  43   /**
  44    * Construct a new ImageView.
  45    */
  46   ImageView();
  47
  48   /**
  49    * A reference counted object may only be deleted by calling Unreference()
  50    */
  51   virtual ~ImageView();
  52
  53 public:
  54   /**
  55    * Create a new ImageView.
  56    * @return A smart-pointer to the newly allocated ImageView.
  57    */
  58   static Toolkit::ImageView New();
  59
  60   /**
  61    * @brief Sets this ImageView from an Dali::Property::Map
  62    *
  63    * If the handle is empty, ImageView will display nothing
  64    * @param[in] map The Dali::Property::Map to use for to display.
  65    */
  66   void SetImage( const Dali::Property::Map& map );
  67
  68   /**
  69    * @copydoc Dali::Toolkit::SetImage
  70    */
  71   void SetImage( const std::string& imageUrl, ImageDimensions size );
  72
  73   /**
  74    * @brief Set whether the Pre-multiplied Alpha Blending is required
  75    *
  76    * @param[in] preMultipled whether alpha is pre-multiplied.
  77    */
  78   void EnablePreMultipliedAlpha( bool preMultipled );
  79
  80   /**
  81    * @brief Query whether alpha is pre-multiplied.
  82    *
  83    * @return True if alpha is pre-multiplied, false otherwise.
  84    */
  85   bool IsPreMultipliedAlphaEnabled() const;
  86
  87   // Properties
  88   /**
  89    * Called when a property of an object of this type is set.
  90    * @param[in] object The object whose property is set.
  91    * @param[in] index The property index.
  92    * @param[in] value The new property value.
  93    */
  94   static void SetProperty( BaseObject* object, Property::Index index, const Property::Value& value );
  95
  96   /**
  97    * Called to retrieve a property of an object of this type.
  98    * @param[in] object The object whose property is to be retrieved.
  99    * @param[in] index The property index.
 100    * @return The current value of the property.
 101    */
 102   static Property::Value GetProperty( BaseObject* object, Property::Index propertyIndex );
 103
 104   /**
 105    * @brief Set the depth index of this image renderer
 106    *
 107    * Renderer with higher depth indices are rendered in front of other visuals with smaller values
 108    *
 109    * @param[in] depthIndex The depth index of this renderer
 110    */
 111   void SetDepthIndex( int depthIndex );
 112
 113 private: // From Control
 114
 115   /**
 116    * @copydoc Toolkit::Control::OnInitialize
 117    */
 118   void OnInitialize();
 119
 120   /**
 121    * @copydoc Toolkit::Control::GetNaturalSize
 122    */
 123   virtual Vector3 GetNaturalSize();
 124
 125   /**
 126    * @copydoc Toolkit::Control::GetHeightForWidth()
 127    */
 128   virtual float GetHeightForWidth( float width );
 129
 130   /**
 131    * @copydoc Toolkit::Control::GetWidthForHeight()
 132    */
 133   virtual float GetWidthForHeight( float height );
 134
 135   /**
 136    * @copydoc Toolkit::Control::OnRelayout()
 137    */
 138   virtual void OnRelayout( const Vector2& size, RelayoutContainer& container );
 139
 140 private:
 141
 142   /**
 143    * @brief Callback for ResourceReadySignal
 144    * param[in] control signal prototype
 145    */
 146   void OnResourceReady( Toolkit::Control control );
 147
 148   /**
 149    * @brief Set TransformMap for fittingMode
 150    * param[in] finalSize The size for fittingMode
 151    * param[in] textureSize The size of texture
 152    * param[in] offset The offset for fittingMode
 153    * param[in] fittingMode The mode for fitting image
 154    * param[in] transformMap  The map for fitting image
 155    */
 156   void SetTransformMapForFittingMode ( Vector2 finalSize, Vector2 textureSize, Vector2 offset, Visual::FittingMode fittingMode, Property::Map& transformMap );
 157
 158   /**
 159    * @brief Apply fittingMode
 160    * param[in] finalSize The size for fittingMode
 161    * param[in] textureSize The size of texture
 162    * param[in] offset The offset for fittingMode
 163    * param[in] zeroPadding whether padding is zero
 164    * param[in] transformMap  The map for fitting image
 165    */
 166   void ApplyFittingMode( Vector2 finalSize, Vector2 textureSize, Vector2 offset, bool zeroPadding , Property::Map& transformMap);
 167
 168 private:
 169   // Undefined
 170   ImageView( const ImageView& );
 171   ImageView& operator=( const ImageView& );
 172
 173 private:
 174   Toolkit::Visual::Base  mVisual;
 175
 176   std::string      mUrl;          ///< the url for the image if the image came from a URL, empty otherwise
 177   Property::Map    mPropertyMap;  ///< the Property::Map if the image came from a Property::Map, empty otherwise
 178   Property::Map    mShaderMap;    ///< the Property::Map if the custom shader is set, empty otherwise
 179   ImageDimensions  mImageSize;    ///< the image size
 180
 181   bool mImageVisualPaddingSetByTransform :1; //< Flag to indicate Padding was set using a transform.
 182   bool mImageViewPixelAreaSetByFittingMode:1; //< Flag to indicate pixel area was set by fitting Mode
 183 };
 184
 185 } // namespace Internal
 186
 187 // Helpers for public-api forwarding methods
 188 inline Toolkit::Internal::ImageView& GetImpl( Toolkit::ImageView& obj )
 189 {
 190   DALI_ASSERT_ALWAYS(obj);
 191   Dali::RefObject& handle = obj.GetImplementation();
 192   return static_cast<Toolkit::Internal::ImageView&>(handle);
 193 }
 194
 195 inline const Toolkit::Internal::ImageView& GetImpl( const Toolkit::ImageView& obj )
 196 {
 197   DALI_ASSERT_ALWAYS(obj);
 198   const Dali::RefObject& handle = obj.GetImplementation();
 199   return static_cast<const Toolkit::Internal::ImageView&>(handle);
 200 }
 201
 202 } // namespace Toolkit
 203
 204 } // namespace Dali
 205
 206 #endif // DALI_TOOLKIT_INTERNAL_IMAGE_VIEW_H