[Tizen] Adds transition effect
[platform/core/uifw/dali-toolkit.git] / dali-toolkit / internal / controls / image-view / image-view-impl.cpp
1 /*
2  * Copyright (c) 2021 Samsung Electronics Co., Ltd.
3  *
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
7  *
8  * http://www.apache.org/licenses/LICENSE-2.0
9  *
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.
15  *
16  */
17
18 // CLASS HEADER
19 #include "image-view-impl.h"
20
21 // EXTERNAL INCLUDES
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>
25
26 // INTERNAL INCLUDES
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>
35
36 namespace Dali
37 {
38 namespace Toolkit
39 {
40 namespace Internal
41 {
42 namespace
43 {
44 const Vector4 FULL_TEXTURE_RECT(0.f, 0.f, 1.f, 1.f);
45
46 BaseHandle Create()
47 {
48   return Toolkit::ImageView::New();
49 }
50
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)
55
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()
58
59 } // anonymous namespace
60
61 using namespace Dali;
62
63 ImageView::ImageView()
64 : Control(ControlBehaviour(CONTROL_BEHAVIOUR_DEFAULT)),
65   mImageSize(),
66   mImageVisualPaddingSetByTransform(false),
67   mImageViewPixelAreaSetByFittingMode(false)
68 {
69 }
70
71 ImageView::~ImageView()
72 {
73 }
74
75 Toolkit::ImageView ImageView::New()
76 {
77   ImageView* impl = new ImageView();
78
79   Toolkit::ImageView handle = Toolkit::ImageView(*impl);
80
81   // Second-phase init of the implementation
82   // This can only be done after the CustomActor connection has been made...
83   impl->Initialize();
84
85   return handle;
86 }
87
88 /////////////////////////////////////////////////////////////
89
90 void ImageView::OnInitialize()
91 {
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);
95
96   DevelControl::SetAccessibilityConstructor(Self(), [](Dali::Actor actor) {
97     return std::unique_ptr<Dali::Accessibility::Accessible>(
98       new DevelControl::AccessibleImpl(actor, Dali::Accessibility::Role::IMAGE));
99   });
100
101   //Enable highightability
102   Self().SetProperty(Toolkit::DevelControl::Property::ACCESSIBILITY_HIGHLIGHTABLE, true);
103 }
104
105 void ImageView::SetImage(const Property::Map& map)
106 {
107   // Comparing a property map is too expensive so just creating a new visual
108   mPropertyMap = map;
109   mUrl.clear();
110
111   Toolkit::Visual::Base visual = Toolkit::VisualFactory::Get().CreateVisual(mPropertyMap);
112   if(visual)
113   {
114     // Don't set mVisual until it is ready and shown. Getters will still use current visual.
115     if(!mVisual)
116     {
117       mVisual = visual;
118     }
119
120     if(!mShaderMap.Empty())
121     {
122       Internal::Visual::Base& visualImpl = Toolkit::GetImplementation(visual);
123       visualImpl.SetCustomShader(mShaderMap);
124     }
125
126     DevelControl::RegisterVisual(*this, Toolkit::ImageView::Property::IMAGE, visual);
127   }
128   else
129   {
130     // Unregister the exsiting visual
131     DevelControl::UnregisterVisual(*this, Toolkit::ImageView::Property::IMAGE);
132
133     // Trigger a size negotiation request that may be needed when unregistering a visual.
134     RelayoutRequest();
135   }
136
137   // Signal that a Relayout may be needed
138 }
139
140 void ImageView::SetImage(const std::string& url, ImageDimensions size)
141 {
142   // Don't bother comparing if we had a visual previously, just drop old visual and create new one
143   mUrl       = url;
144   mImageSize = size;
145   mPropertyMap.Clear();
146
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);
149   if(visual)
150   {
151     if(!mVisual)
152     {
153       mVisual = visual;
154     }
155
156     if(!mShaderMap.Empty())
157     {
158       Internal::Visual::Base& visualImpl = Toolkit::GetImplementation(visual);
159       visualImpl.SetCustomShader(mShaderMap);
160     }
161
162     DevelControl::RegisterVisual(*this, Toolkit::ImageView::Property::IMAGE, visual);
163   }
164   else
165   {
166     // Unregister the exsiting visual
167     DevelControl::UnregisterVisual(*this, Toolkit::ImageView::Property::IMAGE);
168
169     // Trigger a size negotiation request that may be needed when unregistering a visual.
170     RelayoutRequest();
171   }
172
173   // Signal that a Relayout may be needed
174 }
175
176 void ImageView::EnablePreMultipliedAlpha(bool preMultipled)
177 {
178   if(mVisual)
179   {
180     Toolkit::GetImplementation(mVisual).EnablePreMultipliedAlpha(preMultipled);
181   }
182 }
183
184 bool ImageView::IsPreMultipliedAlphaEnabled() const
185 {
186   if(mVisual)
187   {
188     return Toolkit::GetImplementation(mVisual).IsPreMultipliedAlphaEnabled();
189   }
190   return false;
191 }
192
193 void ImageView::SetDepthIndex(int depthIndex)
194 {
195   if(mVisual)
196   {
197     mVisual.SetDepthIndex(depthIndex);
198   }
199 }
200
201 Vector3 ImageView::GetNaturalSize()
202 {
203   if(mVisual)
204   {
205     Vector2 rendererNaturalSize;
206     mVisual.GetNaturalSize(rendererNaturalSize);
207
208     Extents padding;
209     padding = Self().GetProperty<Extents>(Toolkit::Control::Property::PADDING);
210
211     rendererNaturalSize.width += (padding.start + padding.end);
212     rendererNaturalSize.height += (padding.top + padding.bottom);
213     return Vector3(rendererNaturalSize);
214   }
215
216   // if no visual then use Control's natural size
217   return Control::GetNaturalSize();
218 }
219
220 float ImageView::GetHeightForWidth(float width)
221 {
222   Extents padding;
223   padding = Self().GetProperty<Extents>(Toolkit::Control::Property::PADDING);
224
225   if(mVisual)
226   {
227     return mVisual.GetHeightForWidth(width) + padding.top + padding.bottom;
228   }
229   else
230   {
231     return Control::GetHeightForWidth(width) + padding.top + padding.bottom;
232   }
233 }
234
235 float ImageView::GetWidthForHeight(float height)
236 {
237   Extents padding;
238   padding = Self().GetProperty<Extents>(Toolkit::Control::Property::PADDING);
239
240   if(mVisual)
241   {
242     return mVisual.GetWidthForHeight(height) + padding.start + padding.end;
243   }
244   else
245   {
246     return Control::GetWidthForHeight(height) + padding.start + padding.end;
247   }
248 }
249
250 void ImageView::CreateTransitions(Dali::Animation& animation, Dali::Toolkit::Control source, AlphaFunction alphaFunction, TimePeriod period)
251 {
252   Control::CreateTransitions(animation, source, alphaFunction, period);
253
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;
257
258   if(!destinationVisual)
259   {
260     return;
261   }
262
263   destinationVisual.CreatePropertyMap(destinationMap);
264
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>();
269
270   Dali::Toolkit::ImageView sourceHandle = Dali::Toolkit::ImageView::DownCast(source);
271   Toolkit::Visual::Base    sourceVisual;
272   Property::Map            sourceMap;
273
274   if(sourceHandle)
275   {
276     sourceVisual = DevelControl::GetVisual(GetImplementation(sourceHandle), Toolkit::ImageView::Property::IMAGE);
277   }
278
279   if(sourceVisual)
280   {
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>();
284   }
285
286   if(Vector3(sourceMixColor) != Vector3(destinationMixColor))
287   {
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);
292   }
293   if(std::abs(sourceMixColor.a - destinationMixColor.a) > Math::MACHINE_EPSILON_1)
294   {
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);
299   }
300   if(sourceCornerRadius != destinationCornerRadius)
301   {
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);
306   }
307 }
308
309 void ImageView::OnRelayout(const Vector2& size, RelayoutContainer& container)
310 {
311   Control::OnRelayout(size, container);
312   if(mVisual)
313   {
314     Property::Map transformMap = Property::Map();
315
316     Extents padding = Self().GetProperty<Extents>(Toolkit::Control::Property::PADDING);
317
318     bool zeroPadding = (padding == Extents());
319
320     Vector2 naturalSize;
321     mVisual.GetNaturalSize(naturalSize);
322
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)
326     {
327       std::swap(padding.start, padding.end);
328     }
329
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);
333
334     ApplyFittingMode(finalSize, naturalSize, finalOffset, zeroPadding, transformMap);
335
336     mVisual.SetTransformAndSize(transformMap, size);
337
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)
343     {
344       visual.SetTransformAndSize(Property::Map(), size);
345     }
346   }
347 }
348
349 void ImageView::OnResourceReady(Toolkit::Control control)
350 {
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
354 }
355
356 void ImageView::SetTransformMapForFittingMode(Vector2 finalSize, Vector2 naturalSize, Vector2 finalOffset, Visual::FittingMode fittingMode, Property::Map& transformMap)
357 {
358   switch(fittingMode)
359   {
360     case Visual::FittingMode::FIT_KEEP_ASPECT_RATIO:
361     {
362       auto availableVisualSize = finalSize;
363
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));
367
368       // calculate final offset within the padded area
369       finalOffset += (availableVisualSize - finalSize) * .5f;
370
371       // populate the transform map
372       transformMap.Add(Toolkit::Visual::Transform::Property::OFFSET, finalOffset)
373         .Add(Toolkit::Visual::Transform::Property::SIZE, finalSize);
374       break;
375     }
376     case Visual::FittingMode::OVER_FIT_KEEP_ASPECT_RATIO:
377     {
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));
382
383       auto originalOffset = finalOffset;
384       finalOffset += (availableVisualSize - finalSize) * .5f;
385
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);
392
393       // populate the transform map
394       transformMap.Add(Toolkit::Visual::Transform::Property::OFFSET, originalOffset)
395         .Add(Toolkit::Visual::Transform::Property::SIZE, availableVisualSize);
396       break;
397     }
398     case Visual::FittingMode::CENTER:
399     {
400       auto availableVisualSize = finalSize;
401       if(availableVisualSize.width > naturalSize.width && availableVisualSize.height > naturalSize.height)
402       {
403         finalSize = naturalSize;
404       }
405       else
406       {
407         finalSize = naturalSize * std::min((naturalSize.width ? (availableVisualSize.width / naturalSize.width) : 0),
408                                            (naturalSize.height ? (availableVisualSize.height / naturalSize.height) : 0));
409       }
410
411       finalOffset += (availableVisualSize - finalSize) * .5f;
412
413       // populate the transform map
414       transformMap.Add(Toolkit::Visual::Transform::Property::OFFSET, finalOffset)
415         .Add(Toolkit::Visual::Transform::Property::SIZE, finalSize);
416       break;
417     }
418     case Visual::FittingMode::FILL:
419     {
420       transformMap.Add(Toolkit::Visual::Transform::Property::OFFSET, finalOffset)
421         .Add(Toolkit::Visual::Transform::Property::SIZE, finalSize);
422       break;
423     }
424     case Visual::FittingMode::FIT_WIDTH:
425     case Visual::FittingMode::FIT_HEIGHT:
426     {
427       // This FittingMode already converted
428       break;
429     }
430   }
431 }
432
433 void ImageView::ApplyFittingMode(Vector2 finalSize, Vector2 naturalSize, Vector2 finalOffset, bool zeroPadding, Property::Map& transformMap)
434 {
435   Visual::FittingMode fittingMode = Toolkit::GetImplementation(mVisual).GetFittingMode();
436
437   // Reset PIXEL_AREA after using OVER_FIT_KEEP_ASPECT_RATIO
438   if(mImageViewPixelAreaSetByFittingMode)
439   {
440     Self().SetProperty(Toolkit::ImageView::Property::PIXEL_AREA, FULL_TEXTURE_RECT);
441     mImageViewPixelAreaSetByFittingMode = false;
442   }
443
444   if((!zeroPadding) || // If padding is not zero
445      (fittingMode != Visual::FittingMode::FILL))
446   {
447     mImageVisualPaddingSetByTransform = true;
448
449     // If FittingMode use FIT_WIDTH or FIT_HEIGTH, it need to change proper fittingMode
450     if(fittingMode == Visual::FittingMode::FIT_WIDTH)
451     {
452       fittingMode = (finalSize.height / naturalSize.height) < (finalSize.width / naturalSize.width) ? Visual::FittingMode::OVER_FIT_KEEP_ASPECT_RATIO : Visual::FittingMode::FIT_KEEP_ASPECT_RATIO;
453     }
454     else if(fittingMode == Visual::FittingMode::FIT_HEIGHT)
455     {
456       fittingMode = (finalSize.height / naturalSize.height) < (finalSize.width / naturalSize.width) ? Visual::FittingMode::FIT_KEEP_ASPECT_RATIO : Visual::FittingMode::OVER_FIT_KEEP_ASPECT_RATIO;
457     }
458
459     SetTransformMapForFittingMode(finalSize, naturalSize, finalOffset, fittingMode, transformMap);
460
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));
468   }
469   else if(mImageVisualPaddingSetByTransform && zeroPadding) // Reset offset to zero only if padding applied previously
470   {
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));
479   }
480 }
481
482 ///////////////////////////////////////////////////////////
483 //
484 // Properties
485 //
486
487 void ImageView::SetProperty(BaseObject* object, Property::Index index, const Property::Value& value)
488 {
489   Toolkit::ImageView imageView = Toolkit::ImageView::DownCast(Dali::BaseHandle(object));
490
491   if(imageView)
492   {
493     ImageView& impl = GetImpl(imageView);
494     switch(index)
495     {
496       case Toolkit::ImageView::Property::IMAGE:
497       {
498         std::string          imageUrl;
499         const Property::Map* map;
500         if(value.Get(imageUrl))
501         {
502           impl.SetImage(imageUrl, ImageDimensions());
503         }
504         // if its not a string then get a Property::Map from the property if possible.
505         else
506         {
507           map = value.GetMap();
508           if(map)
509           {
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)
513             {
514               impl.SetImage(*map);
515             }
516             // the property map contains only the custom shader
517             else if((map->Count() == 1u) && (shaderValue))
518             {
519               Property::Map* shaderMap = shaderValue->GetMap();
520               if(shaderMap)
521               {
522                 impl.mShaderMap = *shaderMap;
523
524                 if(!impl.mUrl.empty())
525                 {
526                   impl.SetImage(impl.mUrl, impl.mImageSize);
527                 }
528                 else if(!impl.mPropertyMap.Empty())
529                 {
530                   impl.SetImage(impl.mPropertyMap);
531                 }
532               }
533             }
534           }
535         }
536         break;
537       }
538
539       case Toolkit::ImageView::Property::PRE_MULTIPLIED_ALPHA:
540       {
541         bool isPre;
542         if(value.Get(isPre))
543         {
544           impl.EnablePreMultipliedAlpha(isPre);
545         }
546         break;
547       }
548     }
549   }
550 }
551
552 Property::Value ImageView::GetProperty(BaseObject* object, Property::Index propertyIndex)
553 {
554   Property::Value value;
555
556   Toolkit::ImageView imageview = Toolkit::ImageView::DownCast(Dali::BaseHandle(object));
557
558   if(imageview)
559   {
560     ImageView& impl = GetImpl(imageview);
561     switch(propertyIndex)
562     {
563       case Toolkit::ImageView::Property::IMAGE:
564       {
565         if(!impl.mUrl.empty())
566         {
567           value = impl.mUrl;
568         }
569         else
570         {
571           Property::Map         map;
572           Toolkit::Visual::Base visual = DevelControl::GetVisual(impl, Toolkit::ImageView::Property::IMAGE);
573           if(visual)
574           {
575             visual.CreatePropertyMap(map);
576           }
577           value = map;
578         }
579         break;
580       }
581
582       case Toolkit::ImageView::Property::PRE_MULTIPLIED_ALPHA:
583       {
584         value = impl.IsPreMultipliedAlphaEnabled();
585         break;
586       }
587     }
588   }
589
590   return value;
591 }
592
593 } // namespace Internal
594 } // namespace Toolkit
595 } // namespace Dali