2 * Copyright (c) 2023 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/math/math-utils.h>
24 #include <dali/public-api/object/type-registry-helper.h>
25 #include <dali/public-api/object/type-registry.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/devel-api/visuals/visual-actions-devel.h>
31 #include <dali-toolkit/internal/controls/control/control-data-impl.h>
32 #include <dali-toolkit/internal/visuals/visual-base-data-impl.h>
33 #include <dali-toolkit/internal/visuals/visual-base-impl.h>
34 #include <dali-toolkit/internal/visuals/visual-string-constants.h>
35 #include <dali-toolkit/public-api/controls/image-view/image-view.h>
36 #include <dali-toolkit/public-api/visuals/visual-properties.h>
46 const Vector4 FULL_TEXTURE_RECT(0.f, 0.f, 1.f, 1.f);
50 return Toolkit::ImageView::New();
53 // Setup properties, signals and actions using the type-registry.
54 DALI_TYPE_REGISTRATION_BEGIN(Toolkit::ImageView, Toolkit::Control, Create);
55 DALI_PROPERTY_REGISTRATION(Toolkit, ImageView, "image", MAP, IMAGE)
56 DALI_PROPERTY_REGISTRATION(Toolkit, ImageView, "preMultipliedAlpha", BOOLEAN, PRE_MULTIPLIED_ALPHA)
58 DALI_ANIMATABLE_PROPERTY_REGISTRATION_WITH_DEFAULT(Toolkit, ImageView, "pixelArea", Vector4(0.f, 0.f, 1.f, 1.f), PIXEL_AREA)
59 DALI_TYPE_REGISTRATION_END()
61 } // anonymous namespace
65 ImageView::ImageView(ControlBehaviour additionalBehaviour)
66 : Control(ControlBehaviour(CONTROL_BEHAVIOUR_DEFAULT | additionalBehaviour)),
68 mImageVisualPaddingSetByTransform(false),
69 mImageViewPixelAreaSetByFittingMode(false)
73 ImageView::~ImageView()
77 Toolkit::ImageView ImageView::New(ControlBehaviour additionalBehaviour)
79 ImageView* impl = new ImageView(additionalBehaviour);
81 Toolkit::ImageView handle = Toolkit::ImageView(*impl);
83 // Second-phase init of the implementation
84 // This can only be done after the CustomActor connection has been made...
90 /////////////////////////////////////////////////////////////
92 void ImageView::OnInitialize()
94 // ImageView can relayout in the OnImageReady, alternative to a signal would be to have a upcall from the Control to ImageView
95 Dali::Toolkit::Control handle(GetOwner());
96 handle.ResourceReadySignal().Connect(this, &ImageView::OnResourceReady);
98 Self().SetProperty(DevelControl::Property::ACCESSIBILITY_ROLE, Dali::Accessibility::Role::IMAGE);
101 void ImageView::SetImage(const Property::Map& map)
103 // Comparing a property map is too expensive so just creating a new visual
107 Toolkit::Visual::Base visual = Toolkit::VisualFactory::Get().CreateVisual(mPropertyMap);
110 // Don't set mVisual until it is ready and shown. Getters will still use current visual.
116 if(!mShaderMap.Empty())
118 Internal::Visual::Base& visualImpl = Toolkit::GetImplementation(visual);
119 visualImpl.SetCustomShader(mShaderMap);
122 DevelControl::RegisterVisual(*this, Toolkit::ImageView::Property::IMAGE, visual);
126 // Unregister the exsiting visual
127 DevelControl::UnregisterVisual(*this, Toolkit::ImageView::Property::IMAGE);
129 // Trigger a size negotiation request that may be needed when unregistering a visual.
133 // Signal that a Relayout may be needed
136 void ImageView::SetImage(const std::string& url, ImageDimensions size)
138 // Don't bother comparing if we had a visual previously, just drop old visual and create new one
141 mPropertyMap.Clear();
143 // Don't set mVisual until it is ready and shown. Getters will still use current visual.
144 Toolkit::Visual::Base visual = Toolkit::VisualFactory::Get().CreateVisual(url, size);
152 if(!mShaderMap.Empty())
154 Internal::Visual::Base& visualImpl = Toolkit::GetImplementation(visual);
155 visualImpl.SetCustomShader(mShaderMap);
158 DevelControl::RegisterVisual(*this, Toolkit::ImageView::Property::IMAGE, visual);
162 // Unregister the exsiting visual
163 DevelControl::UnregisterVisual(*this, Toolkit::ImageView::Property::IMAGE);
165 // Trigger a size negotiation request that may be needed when unregistering a visual.
169 // Signal that a Relayout may be needed
172 void ImageView::ClearImageVisual()
174 // Clear cached properties
175 mPropertyMap.Clear();
178 // Unregister the exsiting visual
179 DevelControl::UnregisterVisual(*this, Toolkit::ImageView::Property::IMAGE);
181 // Trigger a size negotiation request that may be needed when unregistering a visual.
185 void ImageView::EnablePreMultipliedAlpha(bool preMultipled)
189 Toolkit::GetImplementation(mVisual).EnablePreMultipliedAlpha(preMultipled);
193 bool ImageView::IsPreMultipliedAlphaEnabled() const
197 return Toolkit::GetImplementation(mVisual).IsPreMultipliedAlphaEnabled();
202 void ImageView::SetDepthIndex(int depthIndex)
206 mVisual.SetDepthIndex(depthIndex);
210 Vector3 ImageView::GetNaturalSize()
214 Vector2 rendererNaturalSize;
215 mVisual.GetNaturalSize(rendererNaturalSize);
218 padding = Self().GetProperty<Extents>(Toolkit::Control::Property::PADDING);
220 rendererNaturalSize.width += (padding.start + padding.end);
221 rendererNaturalSize.height += (padding.top + padding.bottom);
222 return Vector3(rendererNaturalSize);
225 // if no visual then use Control's natural size
226 return Control::GetNaturalSize();
229 float ImageView::GetHeightForWidth(float width)
232 padding = Self().GetProperty<Extents>(Toolkit::Control::Property::PADDING);
236 return mVisual.GetHeightForWidth(width) + padding.top + padding.bottom;
240 return Control::GetHeightForWidth(width) + padding.top + padding.bottom;
244 float ImageView::GetWidthForHeight(float height)
247 padding = Self().GetProperty<Extents>(Toolkit::Control::Property::PADDING);
251 return mVisual.GetWidthForHeight(height) + padding.start + padding.end;
255 return Control::GetWidthForHeight(height) + padding.start + padding.end;
259 void ImageView::OnRelayout(const Vector2& size, RelayoutContainer& container)
261 Control::OnRelayout(size, container);
264 Property::Map transformMap = Property::Map();
266 Extents padding = Self().GetProperty<Extents>(Toolkit::Control::Property::PADDING);
268 bool zeroPadding = (padding == Extents());
270 Dali::LayoutDirection::Type layoutDirection = static_cast<Dali::LayoutDirection::Type>(
271 Self().GetProperty(Dali::Actor::Property::LAYOUT_DIRECTION).Get<int>());
272 if(Dali::LayoutDirection::RIGHT_TO_LEFT == layoutDirection)
274 std::swap(padding.start, padding.end);
277 // remove padding from the size to know how much is left for the visual
278 Vector2 finalSize = size - Vector2(padding.start + padding.end, padding.top + padding.bottom);
279 Vector2 finalOffset = Vector2(padding.start, padding.top);
281 ApplyFittingMode(finalSize, finalOffset, zeroPadding, transformMap);
283 mVisual.SetTransformAndSize(transformMap, size);
285 // mVisual is not updated util the resource is ready in the case of visual replacement.
286 // in this case, the Property Map must be initialized so that the previous value is not reused.
287 // after mVisual is updated, the correct value will be reset.
288 Toolkit::Visual::Base visual = DevelControl::GetVisual(*this, Toolkit::ImageView::Property::IMAGE);
289 if(visual && visual != mVisual)
291 visual.SetTransformAndSize(Property::Map(), size);
296 void ImageView::OnCreateTransitions(std::vector<std::pair<Dali::Property::Index, Dali::Property::Map>>& sourceProperties,
297 std::vector<std::pair<Dali::Property::Index, Dali::Property::Map>>& destinationProperties,
298 Dali::Toolkit::Control source,
299 Dali::Toolkit::Control destination)
301 // Retrieves image properties to be transitioned.
302 Dali::Property::Map imageSourcePropertyMap, imageDestinationPropertyMap;
303 MakeVisualTransition(imageSourcePropertyMap, imageDestinationPropertyMap, source, destination, Toolkit::ImageView::Property::IMAGE);
304 if(imageSourcePropertyMap.Count() > 0)
306 sourceProperties.push_back(std::pair<Dali::Property::Index, Dali::Property::Map>(Toolkit::ImageView::Property::IMAGE, imageSourcePropertyMap));
307 destinationProperties.push_back(std::pair<Dali::Property::Index, Dali::Property::Map>(Toolkit::ImageView::Property::IMAGE, imageDestinationPropertyMap));
311 void ImageView::OnUpdateVisualProperties(const std::vector<std::pair<Dali::Property::Index, Dali::Property::Map>>& properties)
313 Toolkit::Visual::Base visual = DevelControl::GetVisual(*this, Toolkit::ImageView::Property::IMAGE);
316 Dali::Toolkit::Control handle(GetOwner());
318 for(auto&& data : properties)
320 if(data.first == Toolkit::ImageView::Property::IMAGE)
322 DevelControl::DoAction(handle, Toolkit::ImageView::Property::IMAGE, DevelVisual::Action::UPDATE_PROPERTY, data.second);
329 void ImageView::OnResourceReady(Toolkit::Control control)
331 // Visual ready so update visual attached to this ImageView, following call to RelayoutRequest will use this visual.
332 mVisual = DevelControl::GetVisual(*this, Toolkit::ImageView::Property::IMAGE);
333 // Signal that a Relayout may be needed
336 void ImageView::SetTransformMapForFittingMode(Vector2 finalSize, Vector2 naturalSize, Vector2 finalOffset, Visual::FittingMode fittingMode, Property::Map& transformMap)
340 case Visual::FittingMode::FIT_KEEP_ASPECT_RATIO:
342 auto availableVisualSize = finalSize;
344 // scale to fit the padded area
345 finalSize = naturalSize * std::min((!Dali::EqualsZero(naturalSize.width) ? (availableVisualSize.width / naturalSize.width) : 0),
346 (!Dali::EqualsZero(naturalSize.height) ? (availableVisualSize.height / naturalSize.height) : 0));
348 // calculate final offset within the padded area
349 finalOffset += (availableVisualSize - finalSize) * .5f;
351 // populate the transform map
352 transformMap.Add(Toolkit::Visual::Transform::Property::OFFSET, finalOffset)
353 .Add(Toolkit::Visual::Transform::Property::SIZE, finalSize);
356 case Visual::FittingMode::OVER_FIT_KEEP_ASPECT_RATIO:
358 mImageViewPixelAreaSetByFittingMode = true;
359 auto availableVisualSize = finalSize;
360 finalSize = naturalSize * std::max((!Dali::EqualsZero(naturalSize.width) ? (availableVisualSize.width / naturalSize.width) : 0.0f),
361 (!Dali::EqualsZero(naturalSize.height) ? (availableVisualSize.height / naturalSize.height) : 0.0f));
363 auto originalOffset = finalOffset;
364 finalOffset += (availableVisualSize - finalSize) * .5f;
366 float x = abs((availableVisualSize.width - finalSize.width) / finalSize.width) * .5f;
367 float y = abs((availableVisualSize.height - finalSize.height) / finalSize.height) * .5f;
368 float widthRatio = 1.f - abs((availableVisualSize.width - finalSize.width) / finalSize.width);
369 float heightRatio = 1.f - abs((availableVisualSize.height - finalSize.height) / finalSize.height);
370 Vector4 pixelArea = Vector4(x, y, widthRatio, heightRatio);
371 Self().SetProperty(Toolkit::ImageView::Property::PIXEL_AREA, pixelArea);
373 // populate the transform map
374 transformMap.Add(Toolkit::Visual::Transform::Property::OFFSET, originalOffset)
375 .Add(Toolkit::Visual::Transform::Property::SIZE, availableVisualSize);
378 case Visual::FittingMode::CENTER:
380 auto availableVisualSize = finalSize;
381 if(availableVisualSize.width > naturalSize.width && availableVisualSize.height > naturalSize.height)
383 finalSize = naturalSize;
387 finalSize = naturalSize * std::min((!Dali::EqualsZero(naturalSize.width) ? (availableVisualSize.width / naturalSize.width) : 0.0f),
388 (!Dali::EqualsZero(naturalSize.height) ? (availableVisualSize.height / naturalSize.height) : 0.0f));
391 finalOffset += (availableVisualSize - finalSize) * .5f;
393 // populate the transform map
394 transformMap.Add(Toolkit::Visual::Transform::Property::OFFSET, finalOffset)
395 .Add(Toolkit::Visual::Transform::Property::SIZE, finalSize);
398 case Visual::FittingMode::FILL:
400 transformMap.Add(Toolkit::Visual::Transform::Property::OFFSET, finalOffset)
401 .Add(Toolkit::Visual::Transform::Property::SIZE, finalSize);
404 case Visual::FittingMode::FIT_WIDTH:
405 case Visual::FittingMode::FIT_HEIGHT:
407 // This FittingMode already converted
413 void ImageView::ApplyFittingMode(Vector2 finalSize, Vector2 finalOffset, bool zeroPadding, Property::Map& transformMap)
415 Visual::FittingMode fittingMode = Toolkit::GetImplementation(mVisual).GetFittingMode();
417 // Reset PIXEL_AREA after using OVER_FIT_KEEP_ASPECT_RATIO
418 if(mImageViewPixelAreaSetByFittingMode)
420 Self().SetProperty(Toolkit::ImageView::Property::PIXEL_AREA, FULL_TEXTURE_RECT);
421 mImageViewPixelAreaSetByFittingMode = false;
424 if((!zeroPadding) || // If padding is not zero
425 (fittingMode != Visual::FittingMode::FILL))
427 mImageVisualPaddingSetByTransform = true;
430 // NaturalSize will not be used for FILL fitting mode, which is default.
431 // Skip GetNaturalSize
432 if(fittingMode != Visual::FittingMode::FILL)
434 mVisual.GetNaturalSize(naturalSize);
437 // If FittingMode use FIT_WIDTH or FIT_HEIGTH, it need to change proper fittingMode
438 if(fittingMode == Visual::FittingMode::FIT_WIDTH)
440 fittingMode = (finalSize.height / naturalSize.height) < (finalSize.width / naturalSize.width) ? Visual::FittingMode::OVER_FIT_KEEP_ASPECT_RATIO : Visual::FittingMode::FIT_KEEP_ASPECT_RATIO;
442 else if(fittingMode == Visual::FittingMode::FIT_HEIGHT)
444 fittingMode = (finalSize.height / naturalSize.height) < (finalSize.width / naturalSize.width) ? Visual::FittingMode::FIT_KEEP_ASPECT_RATIO : Visual::FittingMode::OVER_FIT_KEEP_ASPECT_RATIO;
447 SetTransformMapForFittingMode(finalSize, naturalSize, finalOffset, fittingMode, transformMap);
449 // Set extra value for applying transformMap
450 transformMap.Add(Toolkit::Visual::Transform::Property::OFFSET_POLICY,
451 Vector2(Toolkit::Visual::Transform::Policy::ABSOLUTE, Toolkit::Visual::Transform::Policy::ABSOLUTE))
452 .Add(Toolkit::Visual::Transform::Property::ORIGIN, Toolkit::Align::TOP_BEGIN)
453 .Add(Toolkit::Visual::Transform::Property::ANCHOR_POINT, Toolkit::Align::TOP_BEGIN)
454 .Add(Toolkit::Visual::Transform::Property::SIZE_POLICY,
455 Vector2(Toolkit::Visual::Transform::Policy::ABSOLUTE, Toolkit::Visual::Transform::Policy::ABSOLUTE));
457 else if(mImageVisualPaddingSetByTransform && zeroPadding) // Reset offset to zero only if padding applied previously
459 mImageVisualPaddingSetByTransform = false;
460 // Reset the transform map
461 transformMap.Add(Toolkit::Visual::Transform::Property::OFFSET, Vector2::ZERO)
462 .Add(Toolkit::Visual::Transform::Property::OFFSET_POLICY,
463 Vector2(Toolkit::Visual::Transform::Policy::RELATIVE, Toolkit::Visual::Transform::Policy::RELATIVE))
464 .Add(Toolkit::Visual::Transform::Property::SIZE, Vector2::ONE)
465 .Add(Toolkit::Visual::Transform::Property::SIZE_POLICY,
466 Vector2(Toolkit::Visual::Transform::Policy::RELATIVE, Toolkit::Visual::Transform::Policy::RELATIVE));
470 ///////////////////////////////////////////////////////////
475 void ImageView::SetProperty(BaseObject* object, Property::Index index, const Property::Value& value)
477 Toolkit::ImageView imageView = Toolkit::ImageView::DownCast(Dali::BaseHandle(object));
481 ImageView& impl = GetImpl(imageView);
484 case Toolkit::ImageView::Property::IMAGE:
486 std::string imageUrl;
487 const Property::Map* map;
488 if(value.Get(imageUrl))
490 impl.SetImage(imageUrl, ImageDimensions());
492 // if its not a string then get a Property::Map from the property if possible.
495 map = value.GetMap();
498 // the property map is emtpy map. Unregister visual.
499 if(DALI_UNLIKELY(map->Count() == 0u))
501 impl.ClearImageVisual();
505 Property::Value* shaderValue = map->Find(Toolkit::Visual::Property::SHADER, CUSTOM_SHADER);
506 // set image only if property map contains image information other than custom shader
507 if(map->Count() > 1u || !shaderValue)
511 // the property map contains only the custom shader
512 else if((map->Count() == 1u) && (shaderValue))
514 Property::Map* shaderMap = shaderValue->GetMap();
517 impl.mShaderMap = *shaderMap;
519 if(!impl.mUrl.empty())
521 impl.SetImage(impl.mUrl, impl.mImageSize);
523 else if(!impl.mPropertyMap.Empty())
525 impl.SetImage(impl.mPropertyMap);
533 // invalid property value comes. Unregister visual.
534 impl.ClearImageVisual();
540 case Toolkit::ImageView::Property::PRE_MULTIPLIED_ALPHA:
545 impl.EnablePreMultipliedAlpha(isPre);
553 Property::Value ImageView::GetProperty(BaseObject* object, Property::Index propertyIndex)
555 Property::Value value;
557 Toolkit::ImageView imageview = Toolkit::ImageView::DownCast(Dali::BaseHandle(object));
561 ImageView& impl = GetImpl(imageview);
562 switch(propertyIndex)
564 case Toolkit::ImageView::Property::IMAGE:
566 if(!impl.mUrl.empty())
573 Toolkit::Visual::Base visual = DevelControl::GetVisual(impl, Toolkit::ImageView::Property::IMAGE);
576 visual.CreatePropertyMap(map);
583 case Toolkit::ImageView::Property::PRE_MULTIPLIED_ALPHA:
585 value = impl.IsPreMultipliedAlphaEnabled();
594 } // namespace Internal
595 } // namespace Toolkit