1 #ifndef DALI_TOOLKIT_INTERNAL_IMAGE_VIEW_H
2 #define DALI_TOOLKIT_INTERNAL_IMAGE_VIEW_H
5 * Copyright (c) 2022 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 Unregister ImageView IMAGE visual
73 * ImageView will display nothing
75 void ClearImageVisual();
78 * @brief Set whether the Pre-multiplied Alpha Blending is required
80 * @param[in] preMultipled whether alpha is pre-multiplied.
82 void EnablePreMultipliedAlpha(bool preMultipled);
85 * @brief Query whether alpha is pre-multiplied.
87 * @return True if alpha is pre-multiplied, false otherwise.
89 bool IsPreMultipliedAlphaEnabled() const;
93 * Called when a property of an object of this type is set.
94 * @param[in] object The object whose property is set.
95 * @param[in] index The property index.
96 * @param[in] value The new property value.
98 static void SetProperty(BaseObject* object, Property::Index index, const Property::Value& value);
101 * Called to retrieve a property of an object of this type.
102 * @param[in] object The object whose property is to be retrieved.
103 * @param[in] index The property index.
104 * @return The current value of the property.
106 static Property::Value GetProperty(BaseObject* object, Property::Index propertyIndex);
109 * @brief Set the depth index of this image renderer
111 * Renderer with higher depth indices are rendered in front of other visuals with smaller values
113 * @param[in] depthIndex The depth index of this renderer
115 void SetDepthIndex(int depthIndex);
117 private: // From Control
119 * @copydoc Toolkit::Control::OnInitialize
124 * @copydoc Toolkit::Control::GetNaturalSize
126 Vector3 GetNaturalSize() override;
129 * @copydoc Toolkit::Control::GetHeightForWidth()
131 float GetHeightForWidth(float width) override;
134 * @copydoc Toolkit::Control::GetWidthForHeight()
136 float GetWidthForHeight(float height) override;
139 * @copydoc Toolkit::Control::OnRelayout()
141 void OnRelayout(const Vector2& size, RelayoutContainer& container) override;
144 * @copydoc Toolkit::Control::OnCreateTransitions()
146 virtual void OnCreateTransitions(std::vector<std::pair<Dali::Property::Index, Dali::Property::Map>>& sourceProperties,
147 std::vector<std::pair<Dali::Property::Index, Dali::Property::Map>>& destinationProperties,
148 Dali::Toolkit::Control source,
149 Dali::Toolkit::Control destination) override;
152 * @copydoc Toolkit::Control::OnUpdateVisualProperties()
154 virtual void OnUpdateVisualProperties(const std::vector<std::pair<Dali::Property::Index, Dali::Property::Map>>& properties) override;
158 * @brief Callback for ResourceReadySignal
159 * param[in] control signal prototype
161 void OnResourceReady(Toolkit::Control control);
164 * @brief Set TransformMap for fittingMode
165 * param[in] finalSize The size for fittingMode
166 * param[in] textureSize The size of texture
167 * param[in] offset The offset for fittingMode
168 * param[in] fittingMode The mode for fitting image
169 * param[in] transformMap The map for fitting image
171 void SetTransformMapForFittingMode(Vector2 finalSize, Vector2 textureSize, Vector2 offset, Visual::FittingMode fittingMode, Property::Map& transformMap);
174 * @brief Apply fittingMode
175 * param[in] finalSize The size for fittingMode
176 * param[in] textureSize The size of texture
177 * param[in] offset The offset for fittingMode
178 * param[in] zeroPadding whether padding is zero
179 * param[in] transformMap The map for fitting image
181 void ApplyFittingMode(Vector2 finalSize, Vector2 textureSize, Vector2 offset, bool zeroPadding, Property::Map& transformMap);
185 ImageView(const ImageView&);
186 ImageView& operator=(const ImageView&);
189 Toolkit::Visual::Base mVisual;
191 std::string mUrl; ///< the url for the image if the image came from a URL, empty otherwise
192 Property::Map mPropertyMap; ///< the Property::Map if the image came from a Property::Map, empty otherwise
193 Property::Map mShaderMap; ///< the Property::Map if the custom shader is set, empty otherwise
194 ImageDimensions mImageSize; ///< the image size
196 bool mImageVisualPaddingSetByTransform : 1; //< Flag to indicate Padding was set using a transform.
197 bool mImageViewPixelAreaSetByFittingMode : 1; //< Flag to indicate pixel area was set by fitting Mode
200 } // namespace Internal
202 // Helpers for public-api forwarding methods
203 inline Toolkit::Internal::ImageView& GetImpl(Toolkit::ImageView& obj)
205 DALI_ASSERT_ALWAYS(obj);
206 Dali::RefObject& handle = obj.GetImplementation();
207 return static_cast<Toolkit::Internal::ImageView&>(handle);
210 inline const Toolkit::Internal::ImageView& GetImpl(const Toolkit::ImageView& obj)
212 DALI_ASSERT_ALWAYS(obj);
213 const Dali::RefObject& handle = obj.GetImplementation();
214 return static_cast<const Toolkit::Internal::ImageView&>(handle);
217 } // namespace Toolkit
221 #endif // DALI_TOOLKIT_INTERNAL_IMAGE_VIEW_H