2 * Copyright (c) 2021 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/controls/control-devel.h>
28 #include <dali-toolkit/devel-api/visual-factory/visual-factory.h>
29 #include <dali-toolkit/internal/controls/control/control-data-impl.h>
30 #include <dali-toolkit/internal/visuals/visual-base-data-impl.h>
31 #include <dali-toolkit/internal/visuals/visual-base-impl.h>
32 #include <dali-toolkit/internal/visuals/visual-string-constants.h>
33 #include <dali-toolkit/public-api/controls/image-view/image-view.h>
34 #include <dali-toolkit/public-api/visuals/visual-properties.h>
44 const Vector4 FULL_TEXTURE_RECT(0.f, 0.f, 1.f, 1.f);
48 return Toolkit::ImageView::New();
51 // Setup properties, signals and actions using the type-registry.
52 DALI_TYPE_REGISTRATION_BEGIN(Toolkit::ImageView, Toolkit::Control, Create);
53 DALI_PROPERTY_REGISTRATION(Toolkit, ImageView, "image", MAP, IMAGE)
54 DALI_PROPERTY_REGISTRATION(Toolkit, ImageView, "preMultipliedAlpha", BOOLEAN, PRE_MULTIPLIED_ALPHA)
56 DALI_ANIMATABLE_PROPERTY_REGISTRATION_WITH_DEFAULT(Toolkit, ImageView, "pixelArea", Vector4(0.f, 0.f, 1.f, 1.f), PIXEL_AREA)
57 DALI_TYPE_REGISTRATION_END()
59 } // anonymous namespace
63 ImageView::ImageView()
64 : Control(ControlBehaviour(CONTROL_BEHAVIOUR_DEFAULT)),
66 mImageVisualPaddingSetByTransform(false),
67 mImageViewPixelAreaSetByFittingMode(false)
71 ImageView::~ImageView()
75 Toolkit::ImageView ImageView::New()
77 ImageView* impl = new ImageView();
79 Toolkit::ImageView handle = Toolkit::ImageView(*impl);
81 // Second-phase init of the implementation
82 // This can only be done after the CustomActor connection has been made...
88 /////////////////////////////////////////////////////////////
90 void ImageView::OnInitialize()
92 // ImageView can relayout in the OnImageReady, alternative to a signal would be to have a upcall from the Control to ImageView
93 Dali::Toolkit::Control handle(GetOwner());
94 handle.ResourceReadySignal().Connect(this, &ImageView::OnResourceReady);
96 DevelControl::SetAccessibilityConstructor(Self(), [](Dali::Actor actor) {
97 return std::unique_ptr<Dali::Accessibility::Accessible>(
98 new DevelControl::AccessibleImpl(actor, Dali::Accessibility::Role::IMAGE));
101 //Enable highightability
102 Self().SetProperty(Toolkit::DevelControl::Property::ACCESSIBILITY_HIGHLIGHTABLE, true);
105 void ImageView::SetImage(const Property::Map& map)
107 // Comparing a property map is too expensive so just creating a new visual
111 Toolkit::Visual::Base visual = Toolkit::VisualFactory::Get().CreateVisual(mPropertyMap);
114 // Don't set mVisual until it is ready and shown. Getters will still use current visual.
120 if(!mShaderMap.Empty())
122 Internal::Visual::Base& visualImpl = Toolkit::GetImplementation(visual);
123 visualImpl.SetCustomShader(mShaderMap);
126 DevelControl::RegisterVisual(*this, Toolkit::ImageView::Property::IMAGE, visual);
130 // Unregister the exsiting visual
131 DevelControl::UnregisterVisual(*this, Toolkit::ImageView::Property::IMAGE);
133 // Trigger a size negotiation request that may be needed when unregistering a visual.
137 // Signal that a Relayout may be needed
140 void ImageView::SetImage(const std::string& url, ImageDimensions size)
142 // Don't bother comparing if we had a visual previously, just drop old visual and create new one
145 mPropertyMap.Clear();
147 // Don't set mVisual until it is ready and shown. Getters will still use current visual.
148 Toolkit::Visual::Base visual = Toolkit::VisualFactory::Get().CreateVisual(url, size);
156 if(!mShaderMap.Empty())
158 Internal::Visual::Base& visualImpl = Toolkit::GetImplementation(visual);
159 visualImpl.SetCustomShader(mShaderMap);
162 DevelControl::RegisterVisual(*this, Toolkit::ImageView::Property::IMAGE, visual);
166 // Unregister the exsiting visual
167 DevelControl::UnregisterVisual(*this, Toolkit::ImageView::Property::IMAGE);
169 // Trigger a size negotiation request that may be needed when unregistering a visual.
173 // Signal that a Relayout may be needed
176 void ImageView::EnablePreMultipliedAlpha(bool preMultipled)
180 Toolkit::GetImplementation(mVisual).EnablePreMultipliedAlpha(preMultipled);
184 bool ImageView::IsPreMultipliedAlphaEnabled() const
188 return Toolkit::GetImplementation(mVisual).IsPreMultipliedAlphaEnabled();
193 void ImageView::SetDepthIndex(int depthIndex)
197 mVisual.SetDepthIndex(depthIndex);
201 Vector3 ImageView::GetNaturalSize()
205 Vector2 rendererNaturalSize;
206 mVisual.GetNaturalSize(rendererNaturalSize);
209 padding = Self().GetProperty<Extents>(Toolkit::Control::Property::PADDING);
211 rendererNaturalSize.width += (padding.start + padding.end);
212 rendererNaturalSize.height += (padding.top + padding.bottom);
213 return Vector3(rendererNaturalSize);
216 // if no visual then use Control's natural size
217 return Control::GetNaturalSize();
220 float ImageView::GetHeightForWidth(float width)
223 padding = Self().GetProperty<Extents>(Toolkit::Control::Property::PADDING);
227 return mVisual.GetHeightForWidth(width) + padding.top + padding.bottom;
231 return Control::GetHeightForWidth(width) + padding.top + padding.bottom;
235 float ImageView::GetWidthForHeight(float height)
238 padding = Self().GetProperty<Extents>(Toolkit::Control::Property::PADDING);
242 return mVisual.GetWidthForHeight(height) + padding.start + padding.end;
246 return Control::GetWidthForHeight(height) + padding.start + padding.end;
250 void ImageView::OnRelayout(const Vector2& size, RelayoutContainer& container)
252 Control::OnRelayout(size, container);
255 Property::Map transformMap = Property::Map();
257 Extents padding = Self().GetProperty<Extents>(Toolkit::Control::Property::PADDING);
259 bool zeroPadding = (padding == Extents());
262 mVisual.GetNaturalSize(naturalSize);
264 Dali::LayoutDirection::Type layoutDirection = static_cast<Dali::LayoutDirection::Type>(
265 Self().GetProperty(Dali::Actor::Property::LAYOUT_DIRECTION).Get<int>());
266 if(Dali::LayoutDirection::RIGHT_TO_LEFT == layoutDirection)
268 std::swap(padding.start, padding.end);
271 // remove padding from the size to know how much is left for the visual
272 Vector2 finalSize = size - Vector2(padding.start + padding.end, padding.top + padding.bottom);
273 Vector2 finalOffset = Vector2(padding.start, padding.top);
275 ApplyFittingMode(finalSize, naturalSize, finalOffset, zeroPadding, transformMap);
277 mVisual.SetTransformAndSize(transformMap, size);
279 // mVisual is not updated util the resource is ready in the case of visual replacement.
280 // in this case, the Property Map must be initialized so that the previous value is not reused.
281 // after mVisual is updated, the correct value will be reset.
282 Toolkit::Visual::Base visual = DevelControl::GetVisual(*this, Toolkit::ImageView::Property::IMAGE);
283 if(visual && visual != mVisual)
285 visual.SetTransformAndSize(Property::Map(), size);
290 void ImageView::OnCreateTransitions(Dali::Animation& animation, Dali::Toolkit::Control source, AlphaFunction alphaFunction, TimePeriod timePeriod)
292 Dali::Toolkit::ImageView destinationHandle = Toolkit::ImageView(GetOwner());
293 Toolkit::Visual::Base destinationVisual = DevelControl::GetVisual(GetImplementation(destinationHandle), Toolkit::ImageView::Property::IMAGE);
294 Property::Map destinationMap;
296 if(!destinationVisual)
301 destinationVisual.CreatePropertyMap(destinationMap);
303 static auto findValue = [](const Property::Map& map, Property::Index index) -> Vector4 {
304 Property::Value* propertyValue = map.Find(index);
307 return propertyValue->Get<Vector4>();
312 Vector4 sourceMixColor(0.0f, 0.0f, 0.0f, 0.0f);
313 Vector4 sourceCornerRadius(0.0f, 0.0f, 0.0f, 0.0f);
314 Vector4 destinationMixColor = findValue(destinationMap, Dali::Toolkit::Visual::Property::MIX_COLOR);
315 Vector4 destinationCornerRadius = findValue(destinationMap, Toolkit::DevelVisual::Property::CORNER_RADIUS);
317 Dali::Toolkit::ImageView sourceHandle = Dali::Toolkit::ImageView::DownCast(source);
318 Toolkit::Visual::Base sourceVisual;
319 Property::Map sourceMap;
323 sourceVisual = DevelControl::GetVisual(GetImplementation(sourceHandle), Toolkit::ImageView::Property::IMAGE);
328 sourceVisual.CreatePropertyMap(sourceMap);
329 sourceMixColor = findValue(sourceMap, Dali::Toolkit::Visual::Property::MIX_COLOR);
330 sourceCornerRadius = findValue(sourceMap, Toolkit::DevelVisual::Property::CORNER_RADIUS);
333 std::vector<Dali::Property> properties;
334 std::vector<std::pair<Property::Value, Property::Value>> values;
336 if(Vector3(sourceMixColor) != Vector3(destinationMixColor))
338 properties.push_back(DevelControl::GetVisualProperty(destinationHandle, Toolkit::ImageView::Property::IMAGE, Toolkit::Visual::Property::MIX_COLOR));
339 values.push_back(std::make_pair(Vector3(sourceMixColor), Vector3(destinationMixColor)));
341 if(std::abs(sourceMixColor.a - destinationMixColor.a) > Math::MACHINE_EPSILON_1)
343 properties.push_back(DevelControl::GetVisualProperty(destinationHandle, Toolkit::ImageView::Property::IMAGE, Toolkit::Visual::Property::OPACITY));
344 values.push_back(std::make_pair(sourceMixColor.a, destinationMixColor.a));
346 if(sourceCornerRadius != destinationCornerRadius)
348 properties.push_back(DevelControl::GetVisualProperty(destinationHandle, Toolkit::ImageView::Property::IMAGE, Toolkit::DevelVisual::Property::CORNER_RADIUS));
349 values.push_back(std::make_pair(sourceCornerRadius, destinationCornerRadius));
352 for(uint32_t i = 0; i < properties.size(); ++i)
354 if(timePeriod.delaySeconds > 0.0f)
356 Dali::KeyFrames initialKeyframes = Dali::KeyFrames::New();
357 initialKeyframes.Add(0.0f, values[i].first);
358 initialKeyframes.Add(1.0f, values[i].first);
359 animation.AnimateBetween(properties[i], initialKeyframes, TimePeriod(timePeriod.delaySeconds));
361 Dali::KeyFrames keyframes = Dali::KeyFrames::New();
362 keyframes.Add(0.0f, values[i].first);
363 keyframes.Add(1.0f, values[i].second);
364 animation.AnimateBetween(properties[i], keyframes, alphaFunction, timePeriod);
368 void ImageView::OnResourceReady(Toolkit::Control control)
370 // Visual ready so update visual attached to this ImageView, following call to RelayoutRequest will use this visual.
371 mVisual = DevelControl::GetVisual(*this, Toolkit::ImageView::Property::IMAGE);
372 // Signal that a Relayout may be needed
375 void ImageView::SetTransformMapForFittingMode(Vector2 finalSize, Vector2 naturalSize, Vector2 finalOffset, Visual::FittingMode fittingMode, Property::Map& transformMap)
379 case Visual::FittingMode::FIT_KEEP_ASPECT_RATIO:
381 auto availableVisualSize = finalSize;
383 // scale to fit the padded area
384 finalSize = naturalSize * std::min((naturalSize.width ? (availableVisualSize.width / naturalSize.width) : 0),
385 (naturalSize.height ? (availableVisualSize.height / naturalSize.height) : 0));
387 // calculate final offset within the padded area
388 finalOffset += (availableVisualSize - finalSize) * .5f;
390 // populate the transform map
391 transformMap.Add(Toolkit::Visual::Transform::Property::OFFSET, finalOffset)
392 .Add(Toolkit::Visual::Transform::Property::SIZE, finalSize);
395 case Visual::FittingMode::OVER_FIT_KEEP_ASPECT_RATIO:
397 mImageViewPixelAreaSetByFittingMode = true;
398 auto availableVisualSize = finalSize;
399 finalSize = naturalSize * std::max((naturalSize.width ? (availableVisualSize.width / naturalSize.width) : 0),
400 (naturalSize.height ? (availableVisualSize.height / naturalSize.height) : 0));
402 auto originalOffset = finalOffset;
403 finalOffset += (availableVisualSize - finalSize) * .5f;
405 float x = abs((availableVisualSize.width - finalSize.width) / finalSize.width) * .5f;
406 float y = abs((availableVisualSize.height - finalSize.height) / finalSize.height) * .5f;
407 float widthRatio = 1.f - abs((availableVisualSize.width - finalSize.width) / finalSize.width);
408 float heightRatio = 1.f - abs((availableVisualSize.height - finalSize.height) / finalSize.height);
409 Vector4 pixelArea = Vector4(x, y, widthRatio, heightRatio);
410 Self().SetProperty(Toolkit::ImageView::Property::PIXEL_AREA, pixelArea);
412 // populate the transform map
413 transformMap.Add(Toolkit::Visual::Transform::Property::OFFSET, originalOffset)
414 .Add(Toolkit::Visual::Transform::Property::SIZE, availableVisualSize);
417 case Visual::FittingMode::CENTER:
419 auto availableVisualSize = finalSize;
420 if(availableVisualSize.width > naturalSize.width && availableVisualSize.height > naturalSize.height)
422 finalSize = naturalSize;
426 finalSize = naturalSize * std::min((naturalSize.width ? (availableVisualSize.width / naturalSize.width) : 0),
427 (naturalSize.height ? (availableVisualSize.height / naturalSize.height) : 0));
430 finalOffset += (availableVisualSize - finalSize) * .5f;
432 // populate the transform map
433 transformMap.Add(Toolkit::Visual::Transform::Property::OFFSET, finalOffset)
434 .Add(Toolkit::Visual::Transform::Property::SIZE, finalSize);
437 case Visual::FittingMode::FILL:
439 transformMap.Add(Toolkit::Visual::Transform::Property::OFFSET, finalOffset)
440 .Add(Toolkit::Visual::Transform::Property::SIZE, finalSize);
443 case Visual::FittingMode::FIT_WIDTH:
444 case Visual::FittingMode::FIT_HEIGHT:
446 // This FittingMode already converted
452 void ImageView::ApplyFittingMode(Vector2 finalSize, Vector2 naturalSize, Vector2 finalOffset, bool zeroPadding, Property::Map& transformMap)
454 Visual::FittingMode fittingMode = Toolkit::GetImplementation(mVisual).GetFittingMode();
456 // Reset PIXEL_AREA after using OVER_FIT_KEEP_ASPECT_RATIO
457 if(mImageViewPixelAreaSetByFittingMode)
459 Self().SetProperty(Toolkit::ImageView::Property::PIXEL_AREA, FULL_TEXTURE_RECT);
460 mImageViewPixelAreaSetByFittingMode = false;
463 if((!zeroPadding) || // If padding is not zero
464 (fittingMode != Visual::FittingMode::FILL))
466 mImageVisualPaddingSetByTransform = true;
468 // If FittingMode use FIT_WIDTH or FIT_HEIGTH, it need to change proper fittingMode
469 if(fittingMode == Visual::FittingMode::FIT_WIDTH)
471 fittingMode = (finalSize.height / naturalSize.height) < (finalSize.width / naturalSize.width) ? Visual::FittingMode::OVER_FIT_KEEP_ASPECT_RATIO : Visual::FittingMode::FIT_KEEP_ASPECT_RATIO;
473 else if(fittingMode == Visual::FittingMode::FIT_HEIGHT)
475 fittingMode = (finalSize.height / naturalSize.height) < (finalSize.width / naturalSize.width) ? Visual::FittingMode::FIT_KEEP_ASPECT_RATIO : Visual::FittingMode::OVER_FIT_KEEP_ASPECT_RATIO;
478 SetTransformMapForFittingMode(finalSize, naturalSize, finalOffset, fittingMode, transformMap);
480 // Set extra value for applying transformMap
481 transformMap.Add(Toolkit::Visual::Transform::Property::OFFSET_POLICY,
482 Vector2(Toolkit::Visual::Transform::Policy::ABSOLUTE, Toolkit::Visual::Transform::Policy::ABSOLUTE))
483 .Add(Toolkit::Visual::Transform::Property::ORIGIN, Toolkit::Align::TOP_BEGIN)
484 .Add(Toolkit::Visual::Transform::Property::ANCHOR_POINT, Toolkit::Align::TOP_BEGIN)
485 .Add(Toolkit::Visual::Transform::Property::SIZE_POLICY,
486 Vector2(Toolkit::Visual::Transform::Policy::ABSOLUTE, Toolkit::Visual::Transform::Policy::ABSOLUTE));
488 else if(mImageVisualPaddingSetByTransform && zeroPadding) // Reset offset to zero only if padding applied previously
490 mImageVisualPaddingSetByTransform = false;
491 // Reset the transform map
492 transformMap.Add(Toolkit::Visual::Transform::Property::OFFSET, Vector2::ZERO)
493 .Add(Toolkit::Visual::Transform::Property::OFFSET_POLICY,
494 Vector2(Toolkit::Visual::Transform::Policy::RELATIVE, Toolkit::Visual::Transform::Policy::RELATIVE))
495 .Add(Toolkit::Visual::Transform::Property::SIZE, Vector2::ONE)
496 .Add(Toolkit::Visual::Transform::Property::SIZE_POLICY,
497 Vector2(Toolkit::Visual::Transform::Policy::RELATIVE, Toolkit::Visual::Transform::Policy::RELATIVE));
501 ///////////////////////////////////////////////////////////
506 void ImageView::SetProperty(BaseObject* object, Property::Index index, const Property::Value& value)
508 Toolkit::ImageView imageView = Toolkit::ImageView::DownCast(Dali::BaseHandle(object));
512 ImageView& impl = GetImpl(imageView);
515 case Toolkit::ImageView::Property::IMAGE:
517 std::string imageUrl;
518 const Property::Map* map;
519 if(value.Get(imageUrl))
521 impl.SetImage(imageUrl, ImageDimensions());
523 // if its not a string then get a Property::Map from the property if possible.
526 map = value.GetMap();
529 Property::Value* shaderValue = map->Find(Toolkit::Visual::Property::SHADER, CUSTOM_SHADER);
530 // set image only if property map contains image information other than custom shader
531 if(map->Count() > 1u || !shaderValue)
535 // the property map contains only the custom shader
536 else if((map->Count() == 1u) && (shaderValue))
538 Property::Map* shaderMap = shaderValue->GetMap();
541 impl.mShaderMap = *shaderMap;
543 if(!impl.mUrl.empty())
545 impl.SetImage(impl.mUrl, impl.mImageSize);
547 else if(!impl.mPropertyMap.Empty())
549 impl.SetImage(impl.mPropertyMap);
558 case Toolkit::ImageView::Property::PRE_MULTIPLIED_ALPHA:
563 impl.EnablePreMultipliedAlpha(isPre);
571 Property::Value ImageView::GetProperty(BaseObject* object, Property::Index propertyIndex)
573 Property::Value value;
575 Toolkit::ImageView imageview = Toolkit::ImageView::DownCast(Dali::BaseHandle(object));
579 ImageView& impl = GetImpl(imageview);
580 switch(propertyIndex)
582 case Toolkit::ImageView::Property::IMAGE:
584 if(!impl.mUrl.empty())
591 Toolkit::Visual::Base visual = DevelControl::GetVisual(impl, Toolkit::ImageView::Property::IMAGE);
594 visual.CreatePropertyMap(map);
601 case Toolkit::ImageView::Property::PRE_MULTIPLIED_ALPHA:
603 value = impl.IsPreMultipliedAlphaEnabled();
612 } // namespace Internal
613 } // namespace Toolkit