2 * Copyright (c) 2022 Samsung Electronics Co., Ltd.
4 * Licensed under the Apache License, Version 2.0 (the "License");
5 * you may not use this file except in compliance with the License.
6 * You may obtain a copy of the License at
8 * http://www.apache.org/licenses/LICENSE-2.0
10 * Unless required by applicable law or agreed to in writing, software
11 * distributed under the License is distributed on an "AS IS" BASIS,
12 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13 * See the License for the specific language governing permissions and
14 * limitations under the License.
19 #include "image-view-impl.h"
22 #include <dali/devel-api/scripting/scripting.h>
23 #include <dali/public-api/object/type-registry-helper.h>
24 #include <dali/public-api/object/type-registry.h>
27 #include <dali-toolkit/devel-api/visuals/visual-actions-devel.h>
28 #include <dali-toolkit/devel-api/controls/control-devel.h>
29 #include <dali-toolkit/devel-api/visual-factory/visual-factory.h>
30 #include <dali-toolkit/internal/controls/control/control-data-impl.h>
31 #include <dali-toolkit/internal/visuals/visual-base-data-impl.h>
32 #include <dali-toolkit/internal/visuals/visual-base-impl.h>
33 #include <dali-toolkit/internal/visuals/visual-string-constants.h>
34 #include <dali-toolkit/public-api/controls/image-view/image-view.h>
35 #include <dali-toolkit/public-api/visuals/visual-properties.h>
45 const Vector4 FULL_TEXTURE_RECT(0.f, 0.f, 1.f, 1.f);
49 return Toolkit::ImageView::New();
52 // Setup properties, signals and actions using the type-registry.
53 DALI_TYPE_REGISTRATION_BEGIN(Toolkit::ImageView, Toolkit::Control, Create);
54 DALI_PROPERTY_REGISTRATION(Toolkit, ImageView, "image", MAP, IMAGE)
55 DALI_PROPERTY_REGISTRATION(Toolkit, ImageView, "preMultipliedAlpha", BOOLEAN, PRE_MULTIPLIED_ALPHA)
57 DALI_ANIMATABLE_PROPERTY_REGISTRATION_WITH_DEFAULT(Toolkit, ImageView, "pixelArea", Vector4(0.f, 0.f, 1.f, 1.f), PIXEL_AREA)
58 DALI_TYPE_REGISTRATION_END()
60 } // anonymous namespace
64 ImageView::ImageView()
65 : Control(ControlBehaviour(CONTROL_BEHAVIOUR_DEFAULT)),
67 mImageVisualPaddingSetByTransform(false),
68 mImageViewPixelAreaSetByFittingMode(false)
72 ImageView::~ImageView()
76 Toolkit::ImageView ImageView::New()
78 ImageView* impl = new ImageView();
80 Toolkit::ImageView handle = Toolkit::ImageView(*impl);
82 // Second-phase init of the implementation
83 // This can only be done after the CustomActor connection has been made...
89 /////////////////////////////////////////////////////////////
91 void ImageView::OnInitialize()
93 // ImageView can relayout in the OnImageReady, alternative to a signal would be to have a upcall from the Control to ImageView
94 Dali::Toolkit::Control handle(GetOwner());
95 handle.ResourceReadySignal().Connect(this, &ImageView::OnResourceReady);
97 DevelControl::SetAccessibilityConstructor(Self(), [](Dali::Actor actor) {
98 return std::unique_ptr<Dali::Accessibility::Accessible>(
99 new DevelControl::ControlAccessible(actor, Dali::Accessibility::Role::IMAGE));
103 void ImageView::SetImage(const Property::Map& map)
105 // Comparing a property map is too expensive so just creating a new visual
109 Toolkit::Visual::Base visual = Toolkit::VisualFactory::Get().CreateVisual(mPropertyMap);
112 // Don't set mVisual until it is ready and shown. Getters will still use current visual.
118 if(!mShaderMap.Empty())
120 Internal::Visual::Base& visualImpl = Toolkit::GetImplementation(visual);
121 visualImpl.SetCustomShader(mShaderMap);
124 DevelControl::RegisterVisual(*this, Toolkit::ImageView::Property::IMAGE, visual);
128 // Unregister the exsiting visual
129 DevelControl::UnregisterVisual(*this, Toolkit::ImageView::Property::IMAGE);
131 // Trigger a size negotiation request that may be needed when unregistering a visual.
135 // Signal that a Relayout may be needed
138 void ImageView::SetImage(const std::string& url, ImageDimensions size)
140 // Don't bother comparing if we had a visual previously, just drop old visual and create new one
143 mPropertyMap.Clear();
145 // Don't set mVisual until it is ready and shown. Getters will still use current visual.
146 Toolkit::Visual::Base visual = Toolkit::VisualFactory::Get().CreateVisual(url, size);
154 if(!mShaderMap.Empty())
156 Internal::Visual::Base& visualImpl = Toolkit::GetImplementation(visual);
157 visualImpl.SetCustomShader(mShaderMap);
160 DevelControl::RegisterVisual(*this, Toolkit::ImageView::Property::IMAGE, visual);
164 // Unregister the exsiting visual
165 DevelControl::UnregisterVisual(*this, Toolkit::ImageView::Property::IMAGE);
167 // Trigger a size negotiation request that may be needed when unregistering a visual.
171 // Signal that a Relayout may be needed
174 void ImageView::ClearImageVisual()
176 // Clear cached properties
177 mPropertyMap.Clear();
180 // Unregister the exsiting visual
181 DevelControl::UnregisterVisual(*this, Toolkit::ImageView::Property::IMAGE);
183 // Trigger a size negotiation request that may be needed when unregistering a visual.
187 void ImageView::EnablePreMultipliedAlpha(bool preMultipled)
191 Toolkit::GetImplementation(mVisual).EnablePreMultipliedAlpha(preMultipled);
195 bool ImageView::IsPreMultipliedAlphaEnabled() const
199 return Toolkit::GetImplementation(mVisual).IsPreMultipliedAlphaEnabled();
204 void ImageView::SetDepthIndex(int depthIndex)
208 mVisual.SetDepthIndex(depthIndex);
212 Vector3 ImageView::GetNaturalSize()
216 Vector2 rendererNaturalSize;
217 mVisual.GetNaturalSize(rendererNaturalSize);
220 padding = Self().GetProperty<Extents>(Toolkit::Control::Property::PADDING);
222 rendererNaturalSize.width += (padding.start + padding.end);
223 rendererNaturalSize.height += (padding.top + padding.bottom);
224 return Vector3(rendererNaturalSize);
227 // if no visual then use Control's natural size
228 return Control::GetNaturalSize();
231 float ImageView::GetHeightForWidth(float width)
234 padding = Self().GetProperty<Extents>(Toolkit::Control::Property::PADDING);
238 return mVisual.GetHeightForWidth(width) + padding.top + padding.bottom;
242 return Control::GetHeightForWidth(width) + padding.top + padding.bottom;
246 float ImageView::GetWidthForHeight(float height)
249 padding = Self().GetProperty<Extents>(Toolkit::Control::Property::PADDING);
253 return mVisual.GetWidthForHeight(height) + padding.start + padding.end;
257 return Control::GetWidthForHeight(height) + padding.start + padding.end;
261 void ImageView::OnRelayout(const Vector2& size, RelayoutContainer& container)
263 Control::OnRelayout(size, container);
266 Property::Map transformMap = Property::Map();
268 Extents padding = Self().GetProperty<Extents>(Toolkit::Control::Property::PADDING);
270 bool zeroPadding = (padding == Extents());
273 mVisual.GetNaturalSize(naturalSize);
275 Dali::LayoutDirection::Type layoutDirection = static_cast<Dali::LayoutDirection::Type>(
276 Self().GetProperty(Dali::Actor::Property::LAYOUT_DIRECTION).Get<int>());
277 if(Dali::LayoutDirection::RIGHT_TO_LEFT == layoutDirection)
279 std::swap(padding.start, padding.end);
282 // remove padding from the size to know how much is left for the visual
283 Vector2 finalSize = size - Vector2(padding.start + padding.end, padding.top + padding.bottom);
284 Vector2 finalOffset = Vector2(padding.start, padding.top);
286 ApplyFittingMode(finalSize, naturalSize, finalOffset, zeroPadding, transformMap);
288 mVisual.SetTransformAndSize(transformMap, size);
290 // mVisual is not updated util the resource is ready in the case of visual replacement.
291 // in this case, the Property Map must be initialized so that the previous value is not reused.
292 // after mVisual is updated, the correct value will be reset.
293 Toolkit::Visual::Base visual = DevelControl::GetVisual(*this, Toolkit::ImageView::Property::IMAGE);
294 if(visual && visual != mVisual)
296 visual.SetTransformAndSize(Property::Map(), size);
301 void ImageView::OnCreateTransitions(std::vector<std::pair<Dali::Property::Index, Dali::Property::Map>>& sourceProperties,
302 std::vector<std::pair<Dali::Property::Index, Dali::Property::Map>>& destinationProperties,
303 Dali::Toolkit::Control source,
304 Dali::Toolkit::Control destination)
306 // Retrieves image properties to be transitioned.
307 Dali::Property::Map imageSourcePropertyMap, imageDestinationPropertyMap;
308 MakeVisualTransition(imageSourcePropertyMap, imageDestinationPropertyMap, source, destination, Toolkit::ImageView::Property::IMAGE);
309 if(imageSourcePropertyMap.Count() > 0)
311 sourceProperties.push_back(std::pair<Dali::Property::Index, Dali::Property::Map>(Toolkit::ImageView::Property::IMAGE, imageSourcePropertyMap));
312 destinationProperties.push_back(std::pair<Dali::Property::Index, Dali::Property::Map>(Toolkit::ImageView::Property::IMAGE, imageDestinationPropertyMap));
316 void ImageView::OnUpdateVisualProperties(const std::vector<std::pair<Dali::Property::Index, Dali::Property::Map>>& properties)
318 Toolkit::Visual::Base visual = DevelControl::GetVisual(*this, Toolkit::ImageView::Property::IMAGE);
321 Dali::Toolkit::Control handle(GetOwner());
323 for(auto&& data : properties)
325 if(data.first == Toolkit::ImageView::Property::IMAGE)
327 DevelControl::DoAction(handle, Toolkit::ImageView::Property::IMAGE, DevelVisual::Action::UPDATE_PROPERTY, data.second);
334 void ImageView::OnResourceReady(Toolkit::Control control)
336 // Visual ready so update visual attached to this ImageView, following call to RelayoutRequest will use this visual.
337 mVisual = DevelControl::GetVisual(*this, Toolkit::ImageView::Property::IMAGE);
338 // Signal that a Relayout may be needed
341 void ImageView::SetTransformMapForFittingMode(Vector2 finalSize, Vector2 naturalSize, Vector2 finalOffset, Visual::FittingMode fittingMode, Property::Map& transformMap)
345 case Visual::FittingMode::FIT_KEEP_ASPECT_RATIO:
347 auto availableVisualSize = finalSize;
349 // scale to fit the padded area
350 finalSize = naturalSize * std::min((naturalSize.width ? (availableVisualSize.width / naturalSize.width) : 0),
351 (naturalSize.height ? (availableVisualSize.height / naturalSize.height) : 0));
353 // calculate final offset within the padded area
354 finalOffset += (availableVisualSize - finalSize) * .5f;
356 // populate the transform map
357 transformMap.Add(Toolkit::Visual::Transform::Property::OFFSET, finalOffset)
358 .Add(Toolkit::Visual::Transform::Property::SIZE, finalSize);
361 case Visual::FittingMode::OVER_FIT_KEEP_ASPECT_RATIO:
363 mImageViewPixelAreaSetByFittingMode = true;
364 auto availableVisualSize = finalSize;
365 finalSize = naturalSize * std::max((naturalSize.width ? (availableVisualSize.width / naturalSize.width) : 0),
366 (naturalSize.height ? (availableVisualSize.height / naturalSize.height) : 0));
368 auto originalOffset = finalOffset;
369 finalOffset += (availableVisualSize - finalSize) * .5f;
371 float x = abs((availableVisualSize.width - finalSize.width) / finalSize.width) * .5f;
372 float y = abs((availableVisualSize.height - finalSize.height) / finalSize.height) * .5f;
373 float widthRatio = 1.f - abs((availableVisualSize.width - finalSize.width) / finalSize.width);
374 float heightRatio = 1.f - abs((availableVisualSize.height - finalSize.height) / finalSize.height);
375 Vector4 pixelArea = Vector4(x, y, widthRatio, heightRatio);
376 Self().SetProperty(Toolkit::ImageView::Property::PIXEL_AREA, pixelArea);
378 // populate the transform map
379 transformMap.Add(Toolkit::Visual::Transform::Property::OFFSET, originalOffset)
380 .Add(Toolkit::Visual::Transform::Property::SIZE, availableVisualSize);
383 case Visual::FittingMode::CENTER:
385 auto availableVisualSize = finalSize;
386 if(availableVisualSize.width > naturalSize.width && availableVisualSize.height > naturalSize.height)
388 finalSize = naturalSize;
392 finalSize = naturalSize * std::min((naturalSize.width ? (availableVisualSize.width / naturalSize.width) : 0),
393 (naturalSize.height ? (availableVisualSize.height / naturalSize.height) : 0));
396 finalOffset += (availableVisualSize - finalSize) * .5f;
398 // populate the transform map
399 transformMap.Add(Toolkit::Visual::Transform::Property::OFFSET, finalOffset)
400 .Add(Toolkit::Visual::Transform::Property::SIZE, finalSize);
403 case Visual::FittingMode::FILL:
405 transformMap.Add(Toolkit::Visual::Transform::Property::OFFSET, finalOffset)
406 .Add(Toolkit::Visual::Transform::Property::SIZE, finalSize);
409 case Visual::FittingMode::FIT_WIDTH:
410 case Visual::FittingMode::FIT_HEIGHT:
412 // This FittingMode already converted
418 void ImageView::ApplyFittingMode(Vector2 finalSize, Vector2 naturalSize, Vector2 finalOffset, bool zeroPadding, Property::Map& transformMap)
420 Visual::FittingMode fittingMode = Toolkit::GetImplementation(mVisual).GetFittingMode();
422 // Reset PIXEL_AREA after using OVER_FIT_KEEP_ASPECT_RATIO
423 if(mImageViewPixelAreaSetByFittingMode)
425 Self().SetProperty(Toolkit::ImageView::Property::PIXEL_AREA, FULL_TEXTURE_RECT);
426 mImageViewPixelAreaSetByFittingMode = false;
429 if((!zeroPadding) || // If padding is not zero
430 (fittingMode != Visual::FittingMode::FILL))
432 mImageVisualPaddingSetByTransform = true;
434 // If FittingMode use FIT_WIDTH or FIT_HEIGTH, it need to change proper fittingMode
435 if(fittingMode == Visual::FittingMode::FIT_WIDTH)
437 fittingMode = (finalSize.height / naturalSize.height) < (finalSize.width / naturalSize.width) ? Visual::FittingMode::OVER_FIT_KEEP_ASPECT_RATIO : Visual::FittingMode::FIT_KEEP_ASPECT_RATIO;
439 else if(fittingMode == Visual::FittingMode::FIT_HEIGHT)
441 fittingMode = (finalSize.height / naturalSize.height) < (finalSize.width / naturalSize.width) ? Visual::FittingMode::FIT_KEEP_ASPECT_RATIO : Visual::FittingMode::OVER_FIT_KEEP_ASPECT_RATIO;
444 SetTransformMapForFittingMode(finalSize, naturalSize, finalOffset, fittingMode, transformMap);
446 // Set extra value for applying transformMap
447 transformMap.Add(Toolkit::Visual::Transform::Property::OFFSET_POLICY,
448 Vector2(Toolkit::Visual::Transform::Policy::ABSOLUTE, Toolkit::Visual::Transform::Policy::ABSOLUTE))
449 .Add(Toolkit::Visual::Transform::Property::ORIGIN, Toolkit::Align::TOP_BEGIN)
450 .Add(Toolkit::Visual::Transform::Property::ANCHOR_POINT, Toolkit::Align::TOP_BEGIN)
451 .Add(Toolkit::Visual::Transform::Property::SIZE_POLICY,
452 Vector2(Toolkit::Visual::Transform::Policy::ABSOLUTE, Toolkit::Visual::Transform::Policy::ABSOLUTE));
454 else if(mImageVisualPaddingSetByTransform && zeroPadding) // Reset offset to zero only if padding applied previously
456 mImageVisualPaddingSetByTransform = false;
457 // Reset the transform map
458 transformMap.Add(Toolkit::Visual::Transform::Property::OFFSET, Vector2::ZERO)
459 .Add(Toolkit::Visual::Transform::Property::OFFSET_POLICY,
460 Vector2(Toolkit::Visual::Transform::Policy::RELATIVE, Toolkit::Visual::Transform::Policy::RELATIVE))
461 .Add(Toolkit::Visual::Transform::Property::SIZE, Vector2::ONE)
462 .Add(Toolkit::Visual::Transform::Property::SIZE_POLICY,
463 Vector2(Toolkit::Visual::Transform::Policy::RELATIVE, Toolkit::Visual::Transform::Policy::RELATIVE));
467 ///////////////////////////////////////////////////////////
472 void ImageView::SetProperty(BaseObject* object, Property::Index index, const Property::Value& value)
474 Toolkit::ImageView imageView = Toolkit::ImageView::DownCast(Dali::BaseHandle(object));
478 ImageView& impl = GetImpl(imageView);
481 case Toolkit::ImageView::Property::IMAGE:
483 std::string imageUrl;
484 const Property::Map* map;
485 if(value.Get(imageUrl))
487 impl.SetImage(imageUrl, ImageDimensions());
489 // if its not a string then get a Property::Map from the property if possible.
492 map = value.GetMap();
495 // the property map is emtpy map. Unregister visual.
496 if(DALI_UNLIKELY(map->Count() == 0u))
498 impl.ClearImageVisual();
502 Property::Value* shaderValue = map->Find(Toolkit::Visual::Property::SHADER, CUSTOM_SHADER);
503 // set image only if property map contains image information other than custom shader
504 if(map->Count() > 1u || !shaderValue)
508 // the property map contains only the custom shader
509 else if((map->Count() == 1u) && (shaderValue))
511 Property::Map* shaderMap = shaderValue->GetMap();
514 impl.mShaderMap = *shaderMap;
516 if(!impl.mUrl.empty())
518 impl.SetImage(impl.mUrl, impl.mImageSize);
520 else if(!impl.mPropertyMap.Empty())
522 impl.SetImage(impl.mPropertyMap);
530 // invalid property value comes. Unregister visual.
531 impl.ClearImageVisual();
537 case Toolkit::ImageView::Property::PRE_MULTIPLIED_ALPHA:
542 impl.EnablePreMultipliedAlpha(isPre);
550 Property::Value ImageView::GetProperty(BaseObject* object, Property::Index propertyIndex)
552 Property::Value value;
554 Toolkit::ImageView imageview = Toolkit::ImageView::DownCast(Dali::BaseHandle(object));
558 ImageView& impl = GetImpl(imageview);
559 switch(propertyIndex)
561 case Toolkit::ImageView::Property::IMAGE:
563 if(!impl.mUrl.empty())
570 Toolkit::Visual::Base visual = DevelControl::GetVisual(impl, Toolkit::ImageView::Property::IMAGE);
573 visual.CreatePropertyMap(map);
580 case Toolkit::ImageView::Property::PRE_MULTIPLIED_ALPHA:
582 value = impl.IsPreMultipliedAlphaEnabled();
591 } // namespace Internal
592 } // namespace Toolkit