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(ControlBehaviour additionalBehaviour)
65 : Control(ControlBehaviour(CONTROL_BEHAVIOUR_DEFAULT | additionalBehaviour)),
67 mImageVisualPaddingSetByTransform(false),
68 mImageViewPixelAreaSetByFittingMode(false)
72 ImageView::~ImageView()
76 Toolkit::ImageView ImageView::New(ControlBehaviour additionalBehaviour)
78 ImageView* impl = new ImageView(additionalBehaviour);
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::make_unique<DevelControl::ControlAccessible>(actor, Dali::Accessibility::Role::IMAGE);
102 void ImageView::SetImage(const Property::Map& map)
104 // Comparing a property map is too expensive so just creating a new visual
108 Toolkit::Visual::Base visual = Toolkit::VisualFactory::Get().CreateVisual(mPropertyMap);
111 // Don't set mVisual until it is ready and shown. Getters will still use current visual.
117 if(!mShaderMap.Empty())
119 Internal::Visual::Base& visualImpl = Toolkit::GetImplementation(visual);
120 visualImpl.SetCustomShader(mShaderMap);
123 DevelControl::RegisterVisual(*this, Toolkit::ImageView::Property::IMAGE, visual);
127 // Unregister the exsiting visual
128 DevelControl::UnregisterVisual(*this, Toolkit::ImageView::Property::IMAGE);
130 // Trigger a size negotiation request that may be needed when unregistering a visual.
134 // Signal that a Relayout may be needed
137 void ImageView::SetImage(const std::string& url, ImageDimensions size)
139 // Don't bother comparing if we had a visual previously, just drop old visual and create new one
142 mPropertyMap.Clear();
144 // Don't set mVisual until it is ready and shown. Getters will still use current visual.
145 Toolkit::Visual::Base visual = Toolkit::VisualFactory::Get().CreateVisual(url, size);
153 if(!mShaderMap.Empty())
155 Internal::Visual::Base& visualImpl = Toolkit::GetImplementation(visual);
156 visualImpl.SetCustomShader(mShaderMap);
159 DevelControl::RegisterVisual(*this, Toolkit::ImageView::Property::IMAGE, visual);
163 // Unregister the exsiting visual
164 DevelControl::UnregisterVisual(*this, Toolkit::ImageView::Property::IMAGE);
166 // Trigger a size negotiation request that may be needed when unregistering a visual.
170 // Signal that a Relayout may be needed
173 void ImageView::ClearImageVisual()
175 // Clear cached properties
176 mPropertyMap.Clear();
179 // Unregister the exsiting visual
180 DevelControl::UnregisterVisual(*this, Toolkit::ImageView::Property::IMAGE);
182 // Trigger a size negotiation request that may be needed when unregistering a visual.
186 void ImageView::EnablePreMultipliedAlpha(bool preMultipled)
190 Toolkit::GetImplementation(mVisual).EnablePreMultipliedAlpha(preMultipled);
194 bool ImageView::IsPreMultipliedAlphaEnabled() const
198 return Toolkit::GetImplementation(mVisual).IsPreMultipliedAlphaEnabled();
203 void ImageView::SetDepthIndex(int depthIndex)
207 mVisual.SetDepthIndex(depthIndex);
211 Vector3 ImageView::GetNaturalSize()
215 Vector2 rendererNaturalSize;
216 mVisual.GetNaturalSize(rendererNaturalSize);
219 padding = Self().GetProperty<Extents>(Toolkit::Control::Property::PADDING);
221 rendererNaturalSize.width += (padding.start + padding.end);
222 rendererNaturalSize.height += (padding.top + padding.bottom);
223 return Vector3(rendererNaturalSize);
226 // if no visual then use Control's natural size
227 return Control::GetNaturalSize();
230 float ImageView::GetHeightForWidth(float width)
233 padding = Self().GetProperty<Extents>(Toolkit::Control::Property::PADDING);
237 return mVisual.GetHeightForWidth(width) + padding.top + padding.bottom;
241 return Control::GetHeightForWidth(width) + padding.top + padding.bottom;
245 float ImageView::GetWidthForHeight(float height)
248 padding = Self().GetProperty<Extents>(Toolkit::Control::Property::PADDING);
252 return mVisual.GetWidthForHeight(height) + padding.start + padding.end;
256 return Control::GetWidthForHeight(height) + padding.start + padding.end;
260 void ImageView::OnRelayout(const Vector2& size, RelayoutContainer& container)
262 Control::OnRelayout(size, container);
265 Property::Map transformMap = Property::Map();
267 Extents padding = Self().GetProperty<Extents>(Toolkit::Control::Property::PADDING);
269 bool zeroPadding = (padding == Extents());
272 mVisual.GetNaturalSize(naturalSize);
274 Dali::LayoutDirection::Type layoutDirection = static_cast<Dali::LayoutDirection::Type>(
275 Self().GetProperty(Dali::Actor::Property::LAYOUT_DIRECTION).Get<int>());
276 if(Dali::LayoutDirection::RIGHT_TO_LEFT == layoutDirection)
278 std::swap(padding.start, padding.end);
281 // remove padding from the size to know how much is left for the visual
282 Vector2 finalSize = size - Vector2(padding.start + padding.end, padding.top + padding.bottom);
283 Vector2 finalOffset = Vector2(padding.start, padding.top);
285 ApplyFittingMode(finalSize, naturalSize, finalOffset, zeroPadding, transformMap);
287 mVisual.SetTransformAndSize(transformMap, size);
289 // mVisual is not updated util the resource is ready in the case of visual replacement.
290 // in this case, the Property Map must be initialized so that the previous value is not reused.
291 // after mVisual is updated, the correct value will be reset.
292 Toolkit::Visual::Base visual = DevelControl::GetVisual(*this, Toolkit::ImageView::Property::IMAGE);
293 if(visual && visual != mVisual)
295 visual.SetTransformAndSize(Property::Map(), size);
300 void ImageView::OnCreateTransitions(std::vector<std::pair<Dali::Property::Index, Dali::Property::Map>>& sourceProperties,
301 std::vector<std::pair<Dali::Property::Index, Dali::Property::Map>>& destinationProperties,
302 Dali::Toolkit::Control source,
303 Dali::Toolkit::Control destination)
305 // Retrieves image properties to be transitioned.
306 Dali::Property::Map imageSourcePropertyMap, imageDestinationPropertyMap;
307 MakeVisualTransition(imageSourcePropertyMap, imageDestinationPropertyMap, source, destination, Toolkit::ImageView::Property::IMAGE);
308 if(imageSourcePropertyMap.Count() > 0)
310 sourceProperties.push_back(std::pair<Dali::Property::Index, Dali::Property::Map>(Toolkit::ImageView::Property::IMAGE, imageSourcePropertyMap));
311 destinationProperties.push_back(std::pair<Dali::Property::Index, Dali::Property::Map>(Toolkit::ImageView::Property::IMAGE, imageDestinationPropertyMap));
315 void ImageView::OnUpdateVisualProperties(const std::vector<std::pair<Dali::Property::Index, Dali::Property::Map>>& properties)
317 Toolkit::Visual::Base visual = DevelControl::GetVisual(*this, Toolkit::ImageView::Property::IMAGE);
320 Dali::Toolkit::Control handle(GetOwner());
322 for(auto&& data : properties)
324 if(data.first == Toolkit::ImageView::Property::IMAGE)
326 DevelControl::DoAction(handle, Toolkit::ImageView::Property::IMAGE, DevelVisual::Action::UPDATE_PROPERTY, data.second);
333 void ImageView::OnResourceReady(Toolkit::Control control)
335 // Visual ready so update visual attached to this ImageView, following call to RelayoutRequest will use this visual.
336 mVisual = DevelControl::GetVisual(*this, Toolkit::ImageView::Property::IMAGE);
337 // Signal that a Relayout may be needed
340 void ImageView::SetTransformMapForFittingMode(Vector2 finalSize, Vector2 naturalSize, Vector2 finalOffset, Visual::FittingMode fittingMode, Property::Map& transformMap)
344 case Visual::FittingMode::FIT_KEEP_ASPECT_RATIO:
346 auto availableVisualSize = finalSize;
348 // scale to fit the padded area
349 finalSize = naturalSize * std::min((naturalSize.width ? (availableVisualSize.width / naturalSize.width) : 0),
350 (naturalSize.height ? (availableVisualSize.height / naturalSize.height) : 0));
352 // calculate final offset within the padded area
353 finalOffset += (availableVisualSize - finalSize) * .5f;
355 // populate the transform map
356 transformMap.Add(Toolkit::Visual::Transform::Property::OFFSET, finalOffset)
357 .Add(Toolkit::Visual::Transform::Property::SIZE, finalSize);
360 case Visual::FittingMode::OVER_FIT_KEEP_ASPECT_RATIO:
362 mImageViewPixelAreaSetByFittingMode = true;
363 auto availableVisualSize = finalSize;
364 finalSize = naturalSize * std::max((naturalSize.width ? (availableVisualSize.width / naturalSize.width) : 0),
365 (naturalSize.height ? (availableVisualSize.height / naturalSize.height) : 0));
367 auto originalOffset = finalOffset;
368 finalOffset += (availableVisualSize - finalSize) * .5f;
370 float x = abs((availableVisualSize.width - finalSize.width) / finalSize.width) * .5f;
371 float y = abs((availableVisualSize.height - finalSize.height) / finalSize.height) * .5f;
372 float widthRatio = 1.f - abs((availableVisualSize.width - finalSize.width) / finalSize.width);
373 float heightRatio = 1.f - abs((availableVisualSize.height - finalSize.height) / finalSize.height);
374 Vector4 pixelArea = Vector4(x, y, widthRatio, heightRatio);
375 Self().SetProperty(Toolkit::ImageView::Property::PIXEL_AREA, pixelArea);
377 // populate the transform map
378 transformMap.Add(Toolkit::Visual::Transform::Property::OFFSET, originalOffset)
379 .Add(Toolkit::Visual::Transform::Property::SIZE, availableVisualSize);
382 case Visual::FittingMode::CENTER:
384 auto availableVisualSize = finalSize;
385 if(availableVisualSize.width > naturalSize.width && availableVisualSize.height > naturalSize.height)
387 finalSize = naturalSize;
391 finalSize = naturalSize * std::min((naturalSize.width ? (availableVisualSize.width / naturalSize.width) : 0),
392 (naturalSize.height ? (availableVisualSize.height / naturalSize.height) : 0));
395 finalOffset += (availableVisualSize - finalSize) * .5f;
397 // populate the transform map
398 transformMap.Add(Toolkit::Visual::Transform::Property::OFFSET, finalOffset)
399 .Add(Toolkit::Visual::Transform::Property::SIZE, finalSize);
402 case Visual::FittingMode::FILL:
404 transformMap.Add(Toolkit::Visual::Transform::Property::OFFSET, finalOffset)
405 .Add(Toolkit::Visual::Transform::Property::SIZE, finalSize);
408 case Visual::FittingMode::FIT_WIDTH:
409 case Visual::FittingMode::FIT_HEIGHT:
411 // This FittingMode already converted
417 void ImageView::ApplyFittingMode(Vector2 finalSize, Vector2 naturalSize, Vector2 finalOffset, bool zeroPadding, Property::Map& transformMap)
419 Visual::FittingMode fittingMode = Toolkit::GetImplementation(mVisual).GetFittingMode();
421 // Reset PIXEL_AREA after using OVER_FIT_KEEP_ASPECT_RATIO
422 if(mImageViewPixelAreaSetByFittingMode)
424 Self().SetProperty(Toolkit::ImageView::Property::PIXEL_AREA, FULL_TEXTURE_RECT);
425 mImageViewPixelAreaSetByFittingMode = false;
428 if((!zeroPadding) || // If padding is not zero
429 (fittingMode != Visual::FittingMode::FILL))
431 mImageVisualPaddingSetByTransform = true;
433 // If FittingMode use FIT_WIDTH or FIT_HEIGTH, it need to change proper fittingMode
434 if(fittingMode == Visual::FittingMode::FIT_WIDTH)
436 fittingMode = (finalSize.height / naturalSize.height) < (finalSize.width / naturalSize.width) ? Visual::FittingMode::OVER_FIT_KEEP_ASPECT_RATIO : Visual::FittingMode::FIT_KEEP_ASPECT_RATIO;
438 else if(fittingMode == Visual::FittingMode::FIT_HEIGHT)
440 fittingMode = (finalSize.height / naturalSize.height) < (finalSize.width / naturalSize.width) ? Visual::FittingMode::FIT_KEEP_ASPECT_RATIO : Visual::FittingMode::OVER_FIT_KEEP_ASPECT_RATIO;
443 SetTransformMapForFittingMode(finalSize, naturalSize, finalOffset, fittingMode, transformMap);
445 // Set extra value for applying transformMap
446 transformMap.Add(Toolkit::Visual::Transform::Property::OFFSET_POLICY,
447 Vector2(Toolkit::Visual::Transform::Policy::ABSOLUTE, Toolkit::Visual::Transform::Policy::ABSOLUTE))
448 .Add(Toolkit::Visual::Transform::Property::ORIGIN, Toolkit::Align::TOP_BEGIN)
449 .Add(Toolkit::Visual::Transform::Property::ANCHOR_POINT, Toolkit::Align::TOP_BEGIN)
450 .Add(Toolkit::Visual::Transform::Property::SIZE_POLICY,
451 Vector2(Toolkit::Visual::Transform::Policy::ABSOLUTE, Toolkit::Visual::Transform::Policy::ABSOLUTE));
453 else if(mImageVisualPaddingSetByTransform && zeroPadding) // Reset offset to zero only if padding applied previously
455 mImageVisualPaddingSetByTransform = false;
456 // Reset the transform map
457 transformMap.Add(Toolkit::Visual::Transform::Property::OFFSET, Vector2::ZERO)
458 .Add(Toolkit::Visual::Transform::Property::OFFSET_POLICY,
459 Vector2(Toolkit::Visual::Transform::Policy::RELATIVE, Toolkit::Visual::Transform::Policy::RELATIVE))
460 .Add(Toolkit::Visual::Transform::Property::SIZE, Vector2::ONE)
461 .Add(Toolkit::Visual::Transform::Property::SIZE_POLICY,
462 Vector2(Toolkit::Visual::Transform::Policy::RELATIVE, Toolkit::Visual::Transform::Policy::RELATIVE));
466 ///////////////////////////////////////////////////////////
471 void ImageView::SetProperty(BaseObject* object, Property::Index index, const Property::Value& value)
473 Toolkit::ImageView imageView = Toolkit::ImageView::DownCast(Dali::BaseHandle(object));
477 ImageView& impl = GetImpl(imageView);
480 case Toolkit::ImageView::Property::IMAGE:
482 std::string imageUrl;
483 const Property::Map* map;
484 if(value.Get(imageUrl))
486 impl.SetImage(imageUrl, ImageDimensions());
488 // if its not a string then get a Property::Map from the property if possible.
491 map = value.GetMap();
494 // the property map is emtpy map. Unregister visual.
495 if(DALI_UNLIKELY(map->Count() == 0u))
497 impl.ClearImageVisual();
501 Property::Value* shaderValue = map->Find(Toolkit::Visual::Property::SHADER, CUSTOM_SHADER);
502 // set image only if property map contains image information other than custom shader
503 if(map->Count() > 1u || !shaderValue)
507 // the property map contains only the custom shader
508 else if((map->Count() == 1u) && (shaderValue))
510 Property::Map* shaderMap = shaderValue->GetMap();
513 impl.mShaderMap = *shaderMap;
515 if(!impl.mUrl.empty())
517 impl.SetImage(impl.mUrl, impl.mImageSize);
519 else if(!impl.mPropertyMap.Empty())
521 impl.SetImage(impl.mPropertyMap);
529 // invalid property value comes. Unregister visual.
530 impl.ClearImageVisual();
536 case Toolkit::ImageView::Property::PRE_MULTIPLIED_ALPHA:
541 impl.EnablePreMultipliedAlpha(isPre);
549 Property::Value ImageView::GetProperty(BaseObject* object, Property::Index propertyIndex)
551 Property::Value value;
553 Toolkit::ImageView imageview = Toolkit::ImageView::DownCast(Dali::BaseHandle(object));
557 ImageView& impl = GetImpl(imageview);
558 switch(propertyIndex)
560 case Toolkit::ImageView::Property::IMAGE:
562 if(!impl.mUrl.empty())
569 Toolkit::Visual::Base visual = DevelControl::GetVisual(impl, Toolkit::ImageView::Property::IMAGE);
572 visual.CreatePropertyMap(map);
579 case Toolkit::ImageView::Property::PRE_MULTIPLIED_ALPHA:
581 value = impl.IsPreMultipliedAlphaEnabled();
590 } // namespace Internal
591 } // namespace Toolkit