1 #ifndef DALI_TOOLKIT_INTERNAL_IMAGE_VIEW_H
2 #define DALI_TOOLKIT_INTERNAL_IMAGE_VIEW_H
5 * Copyright (c) 2021 Samsung Electronics Co., Ltd.
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
11 * http://www.apache.org/licenses/LICENSE-2.0
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.
22 #include <dali/public-api/object/property-map.h>
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>
37 class ImageView : public Control
41 * Construct a new ImageView.
46 * A reference counted object may only be deleted by calling Unreference()
52 * Create a new ImageView.
53 * @return A smart-pointer to the newly allocated ImageView.
55 static Toolkit::ImageView New();
58 * @brief Sets this ImageView from an Dali::Property::Map
60 * If the handle is empty, ImageView will display nothing
61 * @param[in] map The Dali::Property::Map to use for to display.
63 void SetImage(const Dali::Property::Map& map);
66 * @copydoc Dali::Toolkit::SetImage
68 void SetImage(const std::string& imageUrl, ImageDimensions size);
71 * @brief Set whether the Pre-multiplied Alpha Blending is required
73 * @param[in] preMultipled whether alpha is pre-multiplied.
75 void EnablePreMultipliedAlpha(bool preMultipled);
78 * @brief Query whether alpha is pre-multiplied.
80 * @return True if alpha is pre-multiplied, false otherwise.
82 bool IsPreMultipliedAlphaEnabled() const;
86 * Called when a property of an object of this type is set.
87 * @param[in] object The object whose property is set.
88 * @param[in] index The property index.
89 * @param[in] value The new property value.
91 static void SetProperty(BaseObject* object, Property::Index index, const Property::Value& value);
94 * Called to retrieve a property of an object of this type.
95 * @param[in] object The object whose property is to be retrieved.
96 * @param[in] index The property index.
97 * @return The current value of the property.
99 static Property::Value GetProperty(BaseObject* object, Property::Index propertyIndex);
102 * @brief Set the depth index of this image renderer
104 * Renderer with higher depth indices are rendered in front of other visuals with smaller values
106 * @param[in] depthIndex The depth index of this renderer
108 void SetDepthIndex(int depthIndex);
110 private: // From Control
112 * @copydoc Toolkit::Control::OnInitialize
117 * @copydoc Toolkit::Control::GetNaturalSize
119 Vector3 GetNaturalSize() override;
122 * @copydoc Toolkit::Control::GetHeightForWidth()
124 float GetHeightForWidth(float width) override;
127 * @copydoc Toolkit::Control::GetWidthForHeight()
129 float GetWidthForHeight(float height) override;
132 * @copydoc Toolkit::Control::OnRelayout()
134 void OnRelayout(const Vector2& size, RelayoutContainer& container) override;
138 * @brief Callback for ResourceReadySignal
139 * param[in] control signal prototype
141 void OnResourceReady(Toolkit::Control control);
144 * @brief Set TransformMap for fittingMode
145 * param[in] finalSize The size for fittingMode
146 * param[in] textureSize The size of texture
147 * param[in] offset The offset for fittingMode
148 * param[in] fittingMode The mode for fitting image
149 * param[in] transformMap The map for fitting image
151 void SetTransformMapForFittingMode(Vector2 finalSize, Vector2 textureSize, Vector2 offset, Visual::FittingMode fittingMode, Property::Map& transformMap);
154 * @brief Apply fittingMode
155 * param[in] finalSize The size for fittingMode
156 * param[in] textureSize The size of texture
157 * param[in] offset The offset for fittingMode
158 * param[in] zeroPadding whether padding is zero
159 * param[in] transformMap The map for fitting image
161 void ApplyFittingMode(Vector2 finalSize, Vector2 textureSize, Vector2 offset, bool zeroPadding, Property::Map& transformMap);
165 ImageView(const ImageView&);
166 ImageView& operator=(const ImageView&);
169 Toolkit::Visual::Base mVisual;
171 std::string mUrl; ///< the url for the image if the image came from a URL, empty otherwise
172 Property::Map mPropertyMap; ///< the Property::Map if the image came from a Property::Map, empty otherwise
173 Property::Map mShaderMap; ///< the Property::Map if the custom shader is set, empty otherwise
174 ImageDimensions mImageSize; ///< the image size
176 bool mImageVisualPaddingSetByTransform : 1; //< Flag to indicate Padding was set using a transform.
177 bool mImageViewPixelAreaSetByFittingMode : 1; //< Flag to indicate pixel area was set by fitting Mode
180 } // namespace Internal
182 // Helpers for public-api forwarding methods
183 inline Toolkit::Internal::ImageView& GetImpl(Toolkit::ImageView& obj)
185 DALI_ASSERT_ALWAYS(obj);
186 Dali::RefObject& handle = obj.GetImplementation();
187 return static_cast<Toolkit::Internal::ImageView&>(handle);
190 inline const Toolkit::Internal::ImageView& GetImpl(const Toolkit::ImageView& obj)
192 DALI_ASSERT_ALWAYS(obj);
193 const Dali::RefObject& handle = obj.GetImplementation();
194 return static_cast<const Toolkit::Internal::ImageView&>(handle);
197 } // namespace Toolkit
201 #endif // DALI_TOOLKIT_INTERNAL_IMAGE_VIEW_H