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::CreateTransitions(Dali::Animation& animation, Dali::Toolkit::Control source, AlphaFunction alphaFunction, TimePeriod period)
252 Control::CreateTransitions(animation, source, alphaFunction, period);
254 Dali::Toolkit::ImageView destinationHandle = Toolkit::ImageView(GetOwner());
255 Toolkit::Visual::Base destinationVisual = DevelControl::GetVisual(GetImplementation(destinationHandle), Toolkit::ImageView::Property::IMAGE);
256 Property::Map destinationMap;
258 if(!destinationVisual)
263 destinationVisual.CreatePropertyMap(destinationMap);
265 Vector4 sourceMixColor(0.0f, 0.0f, 0.0f, 0.0f);
266 Vector4 sourceCornerRadius(0.0f, 0.0f, 0.0f, 0.0f);
267 Vector4 destinationMixColor = destinationMap.Find(Dali::Toolkit::Visual::Property::MIX_COLOR)->Get<Vector4>();
268 Vector4 destinationCornerRadius = destinationMap.Find(Toolkit::DevelVisual::Property::CORNER_RADIUS)->Get<Vector4>();
270 Dali::Toolkit::ImageView sourceHandle = Dali::Toolkit::ImageView::DownCast(source);
271 Toolkit::Visual::Base sourceVisual;
272 Property::Map sourceMap;
276 sourceVisual = DevelControl::GetVisual(GetImplementation(sourceHandle), Toolkit::ImageView::Property::IMAGE);
281 sourceVisual.CreatePropertyMap(sourceMap);
282 sourceMixColor = sourceMap.Find(Dali::Toolkit::Visual::Property::MIX_COLOR)->Get<Vector4>();
283 sourceCornerRadius = sourceMap.Find(Toolkit::DevelVisual::Property::CORNER_RADIUS)->Get<Vector4>();
286 if(Vector3(sourceMixColor) != Vector3(destinationMixColor))
288 Dali::KeyFrames keyframes = Dali::KeyFrames::New();
289 keyframes.Add(0.0f, Vector3(sourceMixColor));
290 keyframes.Add(1.0f, Vector3(destinationMixColor));
291 animation.AnimateBetween(DevelControl::GetVisualProperty(destinationHandle, Toolkit::ImageView::Property::IMAGE, Toolkit::Visual::Property::MIX_COLOR), keyframes, alphaFunction, period);
293 if(std::abs(sourceMixColor.a - destinationMixColor.a) > Math::MACHINE_EPSILON_1)
295 Dali::KeyFrames keyframes = Dali::KeyFrames::New();
296 keyframes.Add(0.0f, sourceMixColor.a);
297 keyframes.Add(1.0f, destinationMixColor.a);
298 animation.AnimateBetween(DevelControl::GetVisualProperty(destinationHandle, Toolkit::ImageView::Property::IMAGE, Toolkit::Visual::Property::OPACITY), keyframes, alphaFunction, period);
300 if(sourceCornerRadius != destinationCornerRadius)
302 Dali::KeyFrames keyframes = Dali::KeyFrames::New();
303 keyframes.Add(0.0f, sourceCornerRadius);
304 keyframes.Add(1.0f, destinationCornerRadius);
305 animation.AnimateBetween(DevelControl::GetVisualProperty(destinationHandle, Toolkit::ImageView::Property::IMAGE, Toolkit::DevelVisual::Property::CORNER_RADIUS), keyframes, alphaFunction, period);
309 void ImageView::OnRelayout(const Vector2& size, RelayoutContainer& container)
311 Control::OnRelayout(size, container);
314 Property::Map transformMap = Property::Map();
316 Extents padding = Self().GetProperty<Extents>(Toolkit::Control::Property::PADDING);
318 bool zeroPadding = (padding == Extents());
321 mVisual.GetNaturalSize(naturalSize);
323 Dali::LayoutDirection::Type layoutDirection = static_cast<Dali::LayoutDirection::Type>(
324 Self().GetProperty(Dali::Actor::Property::LAYOUT_DIRECTION).Get<int>());
325 if(Dali::LayoutDirection::RIGHT_TO_LEFT == layoutDirection)
327 std::swap(padding.start, padding.end);
330 // remove padding from the size to know how much is left for the visual
331 Vector2 finalSize = size - Vector2(padding.start + padding.end, padding.top + padding.bottom);
332 Vector2 finalOffset = Vector2(padding.start, padding.top);
334 ApplyFittingMode(finalSize, naturalSize, finalOffset, zeroPadding, transformMap);
336 mVisual.SetTransformAndSize(transformMap, size);
338 // mVisual is not updated util the resource is ready in the case of visual replacement.
339 // in this case, the Property Map must be initialized so that the previous value is not reused.
340 // after mVisual is updated, the correct value will be reset.
341 Toolkit::Visual::Base visual = DevelControl::GetVisual(*this, Toolkit::ImageView::Property::IMAGE);
342 if(visual && visual != mVisual)
344 visual.SetTransformAndSize(Property::Map(), size);
349 void ImageView::OnResourceReady(Toolkit::Control control)
351 // Visual ready so update visual attached to this ImageView, following call to RelayoutRequest will use this visual.
352 mVisual = DevelControl::GetVisual(*this, Toolkit::ImageView::Property::IMAGE);
353 // Signal that a Relayout may be needed
356 void ImageView::SetTransformMapForFittingMode(Vector2 finalSize, Vector2 naturalSize, Vector2 finalOffset, Visual::FittingMode fittingMode, Property::Map& transformMap)
360 case Visual::FittingMode::FIT_KEEP_ASPECT_RATIO:
362 auto availableVisualSize = finalSize;
364 // scale to fit the padded area
365 finalSize = naturalSize * std::min((naturalSize.width ? (availableVisualSize.width / naturalSize.width) : 0),
366 (naturalSize.height ? (availableVisualSize.height / naturalSize.height) : 0));
368 // calculate final offset within the padded area
369 finalOffset += (availableVisualSize - finalSize) * .5f;
371 // populate the transform map
372 transformMap.Add(Toolkit::Visual::Transform::Property::OFFSET, finalOffset)
373 .Add(Toolkit::Visual::Transform::Property::SIZE, finalSize);
376 case Visual::FittingMode::OVER_FIT_KEEP_ASPECT_RATIO:
378 mImageViewPixelAreaSetByFittingMode = true;
379 auto availableVisualSize = finalSize;
380 finalSize = naturalSize * std::max((naturalSize.width ? (availableVisualSize.width / naturalSize.width) : 0),
381 (naturalSize.height ? (availableVisualSize.height / naturalSize.height) : 0));
383 auto originalOffset = finalOffset;
384 finalOffset += (availableVisualSize - finalSize) * .5f;
386 float x = abs((availableVisualSize.width - finalSize.width) / finalSize.width) * .5f;
387 float y = abs((availableVisualSize.height - finalSize.height) / finalSize.height) * .5f;
388 float widthRatio = 1.f - abs((availableVisualSize.width - finalSize.width) / finalSize.width);
389 float heightRatio = 1.f - abs((availableVisualSize.height - finalSize.height) / finalSize.height);
390 Vector4 pixelArea = Vector4(x, y, widthRatio, heightRatio);
391 Self().SetProperty(Toolkit::ImageView::Property::PIXEL_AREA, pixelArea);
393 // populate the transform map
394 transformMap.Add(Toolkit::Visual::Transform::Property::OFFSET, originalOffset)
395 .Add(Toolkit::Visual::Transform::Property::SIZE, availableVisualSize);
398 case Visual::FittingMode::CENTER:
400 auto availableVisualSize = finalSize;
401 if(availableVisualSize.width > naturalSize.width && availableVisualSize.height > naturalSize.height)
403 finalSize = naturalSize;
407 finalSize = naturalSize * std::min((naturalSize.width ? (availableVisualSize.width / naturalSize.width) : 0),
408 (naturalSize.height ? (availableVisualSize.height / naturalSize.height) : 0));
411 finalOffset += (availableVisualSize - finalSize) * .5f;
413 // populate the transform map
414 transformMap.Add(Toolkit::Visual::Transform::Property::OFFSET, finalOffset)
415 .Add(Toolkit::Visual::Transform::Property::SIZE, finalSize);
418 case Visual::FittingMode::FILL:
420 transformMap.Add(Toolkit::Visual::Transform::Property::OFFSET, finalOffset)
421 .Add(Toolkit::Visual::Transform::Property::SIZE, finalSize);
424 case Visual::FittingMode::FIT_WIDTH:
425 case Visual::FittingMode::FIT_HEIGHT:
427 // This FittingMode already converted
433 void ImageView::ApplyFittingMode(Vector2 finalSize, Vector2 naturalSize, Vector2 finalOffset, bool zeroPadding, Property::Map& transformMap)
435 Visual::FittingMode fittingMode = Toolkit::GetImplementation(mVisual).GetFittingMode();
437 // Reset PIXEL_AREA after using OVER_FIT_KEEP_ASPECT_RATIO
438 if(mImageViewPixelAreaSetByFittingMode)
440 Self().SetProperty(Toolkit::ImageView::Property::PIXEL_AREA, FULL_TEXTURE_RECT);
441 mImageViewPixelAreaSetByFittingMode = false;
444 if((!zeroPadding) || // If padding is not zero
445 (fittingMode != Visual::FittingMode::FILL))
447 mImageVisualPaddingSetByTransform = true;
449 // If FittingMode use FIT_WIDTH or FIT_HEIGTH, it need to change proper fittingMode
450 if(fittingMode == Visual::FittingMode::FIT_WIDTH)
452 fittingMode = (finalSize.height / naturalSize.height) < (finalSize.width / naturalSize.width) ? Visual::FittingMode::OVER_FIT_KEEP_ASPECT_RATIO : Visual::FittingMode::FIT_KEEP_ASPECT_RATIO;
454 else if(fittingMode == Visual::FittingMode::FIT_HEIGHT)
456 fittingMode = (finalSize.height / naturalSize.height) < (finalSize.width / naturalSize.width) ? Visual::FittingMode::FIT_KEEP_ASPECT_RATIO : Visual::FittingMode::OVER_FIT_KEEP_ASPECT_RATIO;
459 SetTransformMapForFittingMode(finalSize, naturalSize, finalOffset, fittingMode, transformMap);
461 // Set extra value for applying transformMap
462 transformMap.Add(Toolkit::Visual::Transform::Property::OFFSET_POLICY,
463 Vector2(Toolkit::Visual::Transform::Policy::ABSOLUTE, Toolkit::Visual::Transform::Policy::ABSOLUTE))
464 .Add(Toolkit::Visual::Transform::Property::ORIGIN, Toolkit::Align::TOP_BEGIN)
465 .Add(Toolkit::Visual::Transform::Property::ANCHOR_POINT, Toolkit::Align::TOP_BEGIN)
466 .Add(Toolkit::Visual::Transform::Property::SIZE_POLICY,
467 Vector2(Toolkit::Visual::Transform::Policy::ABSOLUTE, Toolkit::Visual::Transform::Policy::ABSOLUTE));
469 else if(mImageVisualPaddingSetByTransform && zeroPadding) // Reset offset to zero only if padding applied previously
471 mImageVisualPaddingSetByTransform = false;
472 // Reset the transform map
473 transformMap.Add(Toolkit::Visual::Transform::Property::OFFSET, Vector2::ZERO)
474 .Add(Toolkit::Visual::Transform::Property::OFFSET_POLICY,
475 Vector2(Toolkit::Visual::Transform::Policy::RELATIVE, Toolkit::Visual::Transform::Policy::RELATIVE))
476 .Add(Toolkit::Visual::Transform::Property::SIZE, Vector2::ONE)
477 .Add(Toolkit::Visual::Transform::Property::SIZE_POLICY,
478 Vector2(Toolkit::Visual::Transform::Policy::RELATIVE, Toolkit::Visual::Transform::Policy::RELATIVE));
482 ///////////////////////////////////////////////////////////
487 void ImageView::SetProperty(BaseObject* object, Property::Index index, const Property::Value& value)
489 Toolkit::ImageView imageView = Toolkit::ImageView::DownCast(Dali::BaseHandle(object));
493 ImageView& impl = GetImpl(imageView);
496 case Toolkit::ImageView::Property::IMAGE:
498 std::string imageUrl;
499 const Property::Map* map;
500 if(value.Get(imageUrl))
502 impl.SetImage(imageUrl, ImageDimensions());
504 // if its not a string then get a Property::Map from the property if possible.
507 map = value.GetMap();
510 Property::Value* shaderValue = map->Find(Toolkit::Visual::Property::SHADER, CUSTOM_SHADER);
511 // set image only if property map contains image information other than custom shader
512 if(map->Count() > 1u || !shaderValue)
516 // the property map contains only the custom shader
517 else if((map->Count() == 1u) && (shaderValue))
519 Property::Map* shaderMap = shaderValue->GetMap();
522 impl.mShaderMap = *shaderMap;
524 if(!impl.mUrl.empty())
526 impl.SetImage(impl.mUrl, impl.mImageSize);
528 else if(!impl.mPropertyMap.Empty())
530 impl.SetImage(impl.mPropertyMap);
539 case Toolkit::ImageView::Property::PRE_MULTIPLIED_ALPHA:
544 impl.EnablePreMultipliedAlpha(isPre);
552 Property::Value ImageView::GetProperty(BaseObject* object, Property::Index propertyIndex)
554 Property::Value value;
556 Toolkit::ImageView imageview = Toolkit::ImageView::DownCast(Dali::BaseHandle(object));
560 ImageView& impl = GetImpl(imageview);
561 switch(propertyIndex)
563 case Toolkit::ImageView::Property::IMAGE:
565 if(!impl.mUrl.empty())
572 Toolkit::Visual::Base visual = DevelControl::GetVisual(impl, Toolkit::ImageView::Property::IMAGE);
575 visual.CreatePropertyMap(map);
582 case Toolkit::ImageView::Property::PRE_MULTIPLIED_ALPHA:
584 value = impl.IsPreMultipliedAlphaEnabled();
593 } // namespace Internal
594 } // namespace Toolkit