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));
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::EnablePreMultipliedAlpha(bool preMultipled)
177 Toolkit::GetImplementation(mVisual).EnablePreMultipliedAlpha(preMultipled);
181 bool ImageView::IsPreMultipliedAlphaEnabled() const
185 return Toolkit::GetImplementation(mVisual).IsPreMultipliedAlphaEnabled();
190 void ImageView::SetDepthIndex(int depthIndex)
194 mVisual.SetDepthIndex(depthIndex);
198 Vector3 ImageView::GetNaturalSize()
202 Vector2 rendererNaturalSize;
203 mVisual.GetNaturalSize(rendererNaturalSize);
206 padding = Self().GetProperty<Extents>(Toolkit::Control::Property::PADDING);
208 rendererNaturalSize.width += (padding.start + padding.end);
209 rendererNaturalSize.height += (padding.top + padding.bottom);
210 return Vector3(rendererNaturalSize);
213 // if no visual then use Control's natural size
214 return Control::GetNaturalSize();
217 float ImageView::GetHeightForWidth(float width)
220 padding = Self().GetProperty<Extents>(Toolkit::Control::Property::PADDING);
224 return mVisual.GetHeightForWidth(width) + padding.top + padding.bottom;
228 return Control::GetHeightForWidth(width) + padding.top + padding.bottom;
232 float ImageView::GetWidthForHeight(float height)
235 padding = Self().GetProperty<Extents>(Toolkit::Control::Property::PADDING);
239 return mVisual.GetWidthForHeight(height) + padding.start + padding.end;
243 return Control::GetWidthForHeight(height) + padding.start + padding.end;
247 void ImageView::OnRelayout(const Vector2& size, RelayoutContainer& container)
249 Control::OnRelayout(size, container);
252 Property::Map transformMap = Property::Map();
254 Extents padding = Self().GetProperty<Extents>(Toolkit::Control::Property::PADDING);
256 bool zeroPadding = (padding == Extents());
259 mVisual.GetNaturalSize(naturalSize);
261 Dali::LayoutDirection::Type layoutDirection = static_cast<Dali::LayoutDirection::Type>(
262 Self().GetProperty(Dali::Actor::Property::LAYOUT_DIRECTION).Get<int>());
263 if(Dali::LayoutDirection::RIGHT_TO_LEFT == layoutDirection)
265 std::swap(padding.start, padding.end);
268 // remove padding from the size to know how much is left for the visual
269 Vector2 finalSize = size - Vector2(padding.start + padding.end, padding.top + padding.bottom);
270 Vector2 finalOffset = Vector2(padding.start, padding.top);
272 ApplyFittingMode(finalSize, naturalSize, finalOffset, zeroPadding, transformMap);
274 mVisual.SetTransformAndSize(transformMap, size);
276 // mVisual is not updated util the resource is ready in the case of visual replacement.
277 // in this case, the Property Map must be initialized so that the previous value is not reused.
278 // after mVisual is updated, the correct value will be reset.
279 Toolkit::Visual::Base visual = DevelControl::GetVisual(*this, Toolkit::ImageView::Property::IMAGE);
280 if(visual && visual != mVisual)
282 visual.SetTransformAndSize(Property::Map(), size);
287 void ImageView::OnCreateTransitions(Dali::Animation& animation, Dali::Toolkit::Control source, AlphaFunction alphaFunction, TimePeriod timePeriod)
289 Dali::Toolkit::ImageView destinationHandle = Toolkit::ImageView(GetOwner());
290 Toolkit::Visual::Base destinationVisual = DevelControl::GetVisual(GetImplementation(destinationHandle), Toolkit::ImageView::Property::IMAGE);
291 Property::Map destinationMap;
293 if(!destinationVisual)
298 destinationVisual.CreatePropertyMap(destinationMap);
300 static auto findValueVector4 = [](const Property::Map& map, Property::Index index, const Vector4& defaultValue = Vector4()) -> Vector4 {
301 Property::Value* propertyValue = map.Find(index);
304 return propertyValue->Get<Vector4>();
309 static auto findValueFloat = [](const Property::Map& map, Property::Index index, const float& defaultValue = 0.0f) -> float {
310 Property::Value* propertyValue = map.Find(index);
313 return propertyValue->Get<float>();
318 Vector4 sourceMixColor(0.0f, 0.0f, 0.0f, 0.0f);
319 Vector4 sourceCornerRadius(0.0f, 0.0f, 0.0f, 0.0f);
320 float sourceBorderlineWidth(0.0f);
321 Vector4 sourceBorderlineColor(0.0f, 0.0f, 0.0f, 1.0f);
322 float sourceBorderlineOffset(0.0f);
323 Vector4 destinationMixColor = findValueVector4(destinationMap, Dali::Toolkit::Visual::Property::MIX_COLOR, sourceMixColor);
324 Vector4 destinationCornerRadius = findValueVector4(destinationMap, Toolkit::DevelVisual::Property::CORNER_RADIUS, sourceCornerRadius);
325 float destinationBorderlineWidth = findValueFloat(destinationMap, Toolkit::DevelVisual::Property::BORDERLINE_WIDTH, sourceBorderlineWidth);
326 Vector4 destinationBorderlineColor = findValueVector4(destinationMap, Toolkit::DevelVisual::Property::BORDERLINE_COLOR, sourceBorderlineColor);
327 float destinationBorderlineOffset = findValueFloat(destinationMap, Toolkit::DevelVisual::Property::BORDERLINE_OFFSET, sourceBorderlineOffset);
329 Dali::Toolkit::ImageView sourceHandle = Dali::Toolkit::ImageView::DownCast(source);
330 Toolkit::Visual::Base sourceVisual;
331 Property::Map sourceMap;
335 sourceVisual = DevelControl::GetVisual(GetImplementation(sourceHandle), Toolkit::ImageView::Property::IMAGE);
340 sourceVisual.CreatePropertyMap(sourceMap);
341 sourceMixColor = findValueVector4(sourceMap, Dali::Toolkit::Visual::Property::MIX_COLOR, sourceMixColor);
342 sourceCornerRadius = findValueVector4(sourceMap, Toolkit::DevelVisual::Property::CORNER_RADIUS, sourceCornerRadius);
343 sourceBorderlineWidth = findValueFloat(sourceMap, Toolkit::DevelVisual::Property::BORDERLINE_WIDTH, sourceBorderlineWidth);
344 sourceBorderlineColor = findValueVector4(sourceMap, Toolkit::DevelVisual::Property::BORDERLINE_COLOR, sourceBorderlineColor);
345 sourceBorderlineOffset = findValueFloat(sourceMap, Toolkit::DevelVisual::Property::BORDERLINE_OFFSET, sourceBorderlineOffset);
348 std::vector<Dali::Property> properties;
349 std::vector<std::pair<Property::Value, Property::Value>> values;
351 if(Vector3(sourceMixColor) != Vector3(destinationMixColor))
353 properties.push_back(DevelControl::GetVisualProperty(destinationHandle, Toolkit::ImageView::Property::IMAGE, Toolkit::Visual::Property::MIX_COLOR));
354 values.push_back(std::make_pair(Vector3(sourceMixColor), Vector3(destinationMixColor)));
356 if(std::abs(sourceMixColor.a - destinationMixColor.a) > Math::MACHINE_EPSILON_1)
358 properties.push_back(DevelControl::GetVisualProperty(destinationHandle, Toolkit::ImageView::Property::IMAGE, Toolkit::Visual::Property::OPACITY));
359 values.push_back(std::make_pair(sourceMixColor.a, destinationMixColor.a));
361 if(sourceCornerRadius != destinationCornerRadius)
363 properties.push_back(DevelControl::GetVisualProperty(destinationHandle, Toolkit::ImageView::Property::IMAGE, Toolkit::DevelVisual::Property::CORNER_RADIUS));
364 values.push_back(std::make_pair(sourceCornerRadius, destinationCornerRadius));
366 if(sourceBorderlineWidth != destinationBorderlineWidth)
368 properties.push_back(DevelControl::GetVisualProperty(destinationHandle, Toolkit::ImageView::Property::IMAGE, Toolkit::DevelVisual::Property::BORDERLINE_WIDTH));
369 values.push_back(std::make_pair(sourceBorderlineWidth, destinationBorderlineWidth));
371 if(sourceBorderlineColor != destinationBorderlineColor)
373 properties.push_back(DevelControl::GetVisualProperty(destinationHandle, Toolkit::ImageView::Property::IMAGE, Toolkit::DevelVisual::Property::BORDERLINE_COLOR));
374 values.push_back(std::make_pair(sourceBorderlineColor, destinationBorderlineColor));
376 if(sourceBorderlineOffset != destinationBorderlineOffset)
378 properties.push_back(DevelControl::GetVisualProperty(destinationHandle, Toolkit::ImageView::Property::IMAGE, Toolkit::DevelVisual::Property::BORDERLINE_OFFSET));
379 values.push_back(std::make_pair(sourceBorderlineOffset, destinationBorderlineOffset));
382 for(uint32_t i = 0; i < properties.size(); ++i)
384 if(timePeriod.delaySeconds > 0.0f)
386 Dali::KeyFrames initialKeyframes = Dali::KeyFrames::New();
387 initialKeyframes.Add(0.0f, values[i].first);
388 initialKeyframes.Add(1.0f, values[i].first);
389 animation.AnimateBetween(properties[i], initialKeyframes, TimePeriod(timePeriod.delaySeconds));
391 Dali::KeyFrames keyframes = Dali::KeyFrames::New();
392 keyframes.Add(0.0f, values[i].first);
393 keyframes.Add(1.0f, values[i].second);
394 animation.AnimateBetween(properties[i], keyframes, alphaFunction, timePeriod);
398 void ImageView::OnResourceReady(Toolkit::Control control)
400 // Visual ready so update visual attached to this ImageView, following call to RelayoutRequest will use this visual.
401 mVisual = DevelControl::GetVisual(*this, Toolkit::ImageView::Property::IMAGE);
402 // Signal that a Relayout may be needed
405 void ImageView::SetTransformMapForFittingMode(Vector2 finalSize, Vector2 naturalSize, Vector2 finalOffset, Visual::FittingMode fittingMode, Property::Map& transformMap)
409 case Visual::FittingMode::FIT_KEEP_ASPECT_RATIO:
411 auto availableVisualSize = finalSize;
413 // scale to fit the padded area
414 finalSize = naturalSize * std::min((naturalSize.width ? (availableVisualSize.width / naturalSize.width) : 0),
415 (naturalSize.height ? (availableVisualSize.height / naturalSize.height) : 0));
417 // calculate final offset within the padded area
418 finalOffset += (availableVisualSize - finalSize) * .5f;
420 // populate the transform map
421 transformMap.Add(Toolkit::Visual::Transform::Property::OFFSET, finalOffset)
422 .Add(Toolkit::Visual::Transform::Property::SIZE, finalSize);
425 case Visual::FittingMode::OVER_FIT_KEEP_ASPECT_RATIO:
427 mImageViewPixelAreaSetByFittingMode = true;
428 auto availableVisualSize = finalSize;
429 finalSize = naturalSize * std::max((naturalSize.width ? (availableVisualSize.width / naturalSize.width) : 0),
430 (naturalSize.height ? (availableVisualSize.height / naturalSize.height) : 0));
432 auto originalOffset = finalOffset;
433 finalOffset += (availableVisualSize - finalSize) * .5f;
435 float x = abs((availableVisualSize.width - finalSize.width) / finalSize.width) * .5f;
436 float y = abs((availableVisualSize.height - finalSize.height) / finalSize.height) * .5f;
437 float widthRatio = 1.f - abs((availableVisualSize.width - finalSize.width) / finalSize.width);
438 float heightRatio = 1.f - abs((availableVisualSize.height - finalSize.height) / finalSize.height);
439 Vector4 pixelArea = Vector4(x, y, widthRatio, heightRatio);
440 Self().SetProperty(Toolkit::ImageView::Property::PIXEL_AREA, pixelArea);
442 // populate the transform map
443 transformMap.Add(Toolkit::Visual::Transform::Property::OFFSET, originalOffset)
444 .Add(Toolkit::Visual::Transform::Property::SIZE, availableVisualSize);
447 case Visual::FittingMode::CENTER:
449 auto availableVisualSize = finalSize;
450 if(availableVisualSize.width > naturalSize.width && availableVisualSize.height > naturalSize.height)
452 finalSize = naturalSize;
456 finalSize = naturalSize * std::min((naturalSize.width ? (availableVisualSize.width / naturalSize.width) : 0),
457 (naturalSize.height ? (availableVisualSize.height / naturalSize.height) : 0));
460 finalOffset += (availableVisualSize - finalSize) * .5f;
462 // populate the transform map
463 transformMap.Add(Toolkit::Visual::Transform::Property::OFFSET, finalOffset)
464 .Add(Toolkit::Visual::Transform::Property::SIZE, finalSize);
467 case Visual::FittingMode::FILL:
469 transformMap.Add(Toolkit::Visual::Transform::Property::OFFSET, finalOffset)
470 .Add(Toolkit::Visual::Transform::Property::SIZE, finalSize);
473 case Visual::FittingMode::FIT_WIDTH:
474 case Visual::FittingMode::FIT_HEIGHT:
476 // This FittingMode already converted
482 void ImageView::ApplyFittingMode(Vector2 finalSize, Vector2 naturalSize, Vector2 finalOffset, bool zeroPadding, Property::Map& transformMap)
484 Visual::FittingMode fittingMode = Toolkit::GetImplementation(mVisual).GetFittingMode();
486 // Reset PIXEL_AREA after using OVER_FIT_KEEP_ASPECT_RATIO
487 if(mImageViewPixelAreaSetByFittingMode)
489 Self().SetProperty(Toolkit::ImageView::Property::PIXEL_AREA, FULL_TEXTURE_RECT);
490 mImageViewPixelAreaSetByFittingMode = false;
493 if((!zeroPadding) || // If padding is not zero
494 (fittingMode != Visual::FittingMode::FILL))
496 mImageVisualPaddingSetByTransform = true;
498 // If FittingMode use FIT_WIDTH or FIT_HEIGTH, it need to change proper fittingMode
499 if(fittingMode == Visual::FittingMode::FIT_WIDTH)
501 fittingMode = (finalSize.height / naturalSize.height) < (finalSize.width / naturalSize.width) ? Visual::FittingMode::OVER_FIT_KEEP_ASPECT_RATIO : Visual::FittingMode::FIT_KEEP_ASPECT_RATIO;
503 else if(fittingMode == Visual::FittingMode::FIT_HEIGHT)
505 fittingMode = (finalSize.height / naturalSize.height) < (finalSize.width / naturalSize.width) ? Visual::FittingMode::FIT_KEEP_ASPECT_RATIO : Visual::FittingMode::OVER_FIT_KEEP_ASPECT_RATIO;
508 SetTransformMapForFittingMode(finalSize, naturalSize, finalOffset, fittingMode, transformMap);
510 // Set extra value for applying transformMap
511 transformMap.Add(Toolkit::Visual::Transform::Property::OFFSET_POLICY,
512 Vector2(Toolkit::Visual::Transform::Policy::ABSOLUTE, Toolkit::Visual::Transform::Policy::ABSOLUTE))
513 .Add(Toolkit::Visual::Transform::Property::ORIGIN, Toolkit::Align::TOP_BEGIN)
514 .Add(Toolkit::Visual::Transform::Property::ANCHOR_POINT, Toolkit::Align::TOP_BEGIN)
515 .Add(Toolkit::Visual::Transform::Property::SIZE_POLICY,
516 Vector2(Toolkit::Visual::Transform::Policy::ABSOLUTE, Toolkit::Visual::Transform::Policy::ABSOLUTE));
518 else if(mImageVisualPaddingSetByTransform && zeroPadding) // Reset offset to zero only if padding applied previously
520 mImageVisualPaddingSetByTransform = false;
521 // Reset the transform map
522 transformMap.Add(Toolkit::Visual::Transform::Property::OFFSET, Vector2::ZERO)
523 .Add(Toolkit::Visual::Transform::Property::OFFSET_POLICY,
524 Vector2(Toolkit::Visual::Transform::Policy::RELATIVE, Toolkit::Visual::Transform::Policy::RELATIVE))
525 .Add(Toolkit::Visual::Transform::Property::SIZE, Vector2::ONE)
526 .Add(Toolkit::Visual::Transform::Property::SIZE_POLICY,
527 Vector2(Toolkit::Visual::Transform::Policy::RELATIVE, Toolkit::Visual::Transform::Policy::RELATIVE));
531 ///////////////////////////////////////////////////////////
536 void ImageView::SetProperty(BaseObject* object, Property::Index index, const Property::Value& value)
538 Toolkit::ImageView imageView = Toolkit::ImageView::DownCast(Dali::BaseHandle(object));
542 ImageView& impl = GetImpl(imageView);
545 case Toolkit::ImageView::Property::IMAGE:
547 std::string imageUrl;
548 const Property::Map* map;
549 if(value.Get(imageUrl))
551 impl.SetImage(imageUrl, ImageDimensions());
553 // if its not a string then get a Property::Map from the property if possible.
556 map = value.GetMap();
559 Property::Value* shaderValue = map->Find(Toolkit::Visual::Property::SHADER, CUSTOM_SHADER);
560 // set image only if property map contains image information other than custom shader
561 if(map->Count() > 1u || !shaderValue)
565 // the property map contains only the custom shader
566 else if((map->Count() == 1u) && (shaderValue))
568 Property::Map* shaderMap = shaderValue->GetMap();
571 impl.mShaderMap = *shaderMap;
573 if(!impl.mUrl.empty())
575 impl.SetImage(impl.mUrl, impl.mImageSize);
577 else if(!impl.mPropertyMap.Empty())
579 impl.SetImage(impl.mPropertyMap);
588 case Toolkit::ImageView::Property::PRE_MULTIPLIED_ALPHA:
593 impl.EnablePreMultipliedAlpha(isPre);
601 Property::Value ImageView::GetProperty(BaseObject* object, Property::Index propertyIndex)
603 Property::Value value;
605 Toolkit::ImageView imageview = Toolkit::ImageView::DownCast(Dali::BaseHandle(object));
609 ImageView& impl = GetImpl(imageview);
610 switch(propertyIndex)
612 case Toolkit::ImageView::Property::IMAGE:
614 if(!impl.mUrl.empty())
621 Toolkit::Visual::Base visual = DevelControl::GetVisual(impl, Toolkit::ImageView::Property::IMAGE);
624 visual.CreatePropertyMap(map);
631 case Toolkit::ImageView::Property::PRE_MULTIPLIED_ALPHA:
633 value = impl.IsPreMultipliedAlphaEnabled();
642 } // namespace Internal
643 } // namespace Toolkit