Merge "Fix ImageView OnRelayout and add a commnet in MARGIN property" into devel...
[platform/core/uifw/dali-toolkit.git] / dali-toolkit / internal / controls / image-view / image-view-impl.cpp
index 59a3b33..835bb4e 100644 (file)
@@ -1,4 +1,19 @@
-// Copyright (c) 2014 Samsung Electronics Co., Ltd.
+/*
+ * Copyright (c) 2017 Samsung Electronics Co., Ltd.
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ * http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ *
+ */
 
 // CLASS HEADER
 #include "image-view-impl.h"
 // EXTERNAL INCLUDES
 #include <dali/public-api/images/resource-image.h>
 #include <dali/public-api/object/type-registry.h>
-#include <dali/devel-api/object/type-registry-helper.h>
+#include <dali/public-api/object/type-registry-helper.h>
 #include <dali/devel-api/scripting/scripting.h>
 
 // INTERNAL INCLUDES
 #include <dali-toolkit/public-api/controls/image-view/image-view.h>
-#include <dali-toolkit/devel-api/controls/renderer-factory/renderer-factory.h>
-#include <dali-toolkit/internal/controls/renderers/image/image-renderer.h>
+#include <dali-toolkit/devel-api/controls/control-devel.h>
+#include <dali-toolkit/public-api/visuals/visual-properties.h>
+#include <dali-toolkit/devel-api/visual-factory/visual-factory.h>
+#include <dali-toolkit/internal/visuals/visual-string-constants.h>
+#include <dali-toolkit/internal/visuals/visual-base-impl.h>
+#include <dali-toolkit/internal/visuals/visual-base-data-impl.h>
 
 namespace Dali
 {
@@ -33,7 +52,11 @@ BaseHandle Create()
 
 // Setup properties, signals and actions using the type-registry.
 DALI_TYPE_REGISTRATION_BEGIN( Toolkit::ImageView, Toolkit::Control, Create );
+DALI_PROPERTY_REGISTRATION( Toolkit, ImageView, "resourceUrl", STRING, RESOURCE_URL )
 DALI_PROPERTY_REGISTRATION( Toolkit, ImageView, "image", MAP, IMAGE )
+DALI_PROPERTY_REGISTRATION( Toolkit, ImageView, "preMultipliedAlpha", BOOLEAN, PRE_MULTIPLIED_ALPHA )
+
+DALI_ANIMATABLE_PROPERTY_REGISTRATION_WITH_DEFAULT( Toolkit, ImageView, "pixelArea", Vector4(0.f, 0.f, 1.f, 1.f), PIXEL_AREA )
 DALI_TYPE_REGISTRATION_END()
 
 } // anonymous namespace
@@ -41,7 +64,7 @@ DALI_TYPE_REGISTRATION_END()
 using namespace Dali;
 
 ImageView::ImageView()
-: Control( ControlBehaviour( ACTOR_BEHAVIOUR_NONE ) )
+: Control( ControlBehaviour( CONTROL_BEHAVIOUR_DEFAULT ) )
 {
 }
 
@@ -64,139 +87,205 @@ Toolkit::ImageView ImageView::New()
 
 /////////////////////////////////////////////////////////////
 
+void ImageView::OnInitialize()
+{
+  // ImageView can relayout in the OnImageReady, alternative to a signal would be to have a upcall from the Control to ImageView
+  Dali::Toolkit::Control handle( GetOwner() );
+  handle.ResourceReadySignal().Connect( this, &ImageView::OnResourceReady );
+}
+
 void ImageView::SetImage( Image image )
 {
-  if( mImage != image )
+  // Don't bother comparing if we had a visual previously, just drop old visual and create new one
+  mImage = image;
+  mUrl.clear();
+  mPropertyMap.Clear();
+
+  Toolkit::Visual::Base visual =  Toolkit::VisualFactory::Get().CreateVisual( image );
+  if( visual )
   {
-    mUrl.clear();
-    mPropertyMap.Clear();
+    if( !mVisual )
+    {
+      mVisual = visual;
+    }
 
-    mImage = image;
+    DevelControl::RegisterVisual( *this, Toolkit::ImageView::Property::IMAGE, visual  );
+  }
+  else
+  {
+    // Unregister the exsiting visual
+    DevelControl::UnregisterVisual( *this, Toolkit::ImageView::Property::IMAGE );
 
-    Actor self = Self();
-    Toolkit::RendererFactory::Get().ResetRenderer( mRenderer, self, image );
-    mImageSize = image ? ImageDimensions( image.GetWidth(), image.GetHeight() ) : ImageDimensions( 0, 0 );
+    // Trigger a size negotiation request that may be needed when unregistering a visual.
+    RelayoutRequest();
   }
 }
 
-void ImageView::SetImage( Property::Map map )
+void ImageView::SetImage( const Property::Map& map )
 {
+  // Comparing a property map is too expensive so just creating a new visual
   mPropertyMap = map;
+  mUrl.clear();
+  mImage.Reset();
 
-  Actor self = Self();
-  Toolkit::RendererFactory::Get().ResetRenderer( mRenderer, self, mPropertyMap );
-
-  int width = 0;
-  Property::Value* widthValue = mPropertyMap.Find( "width" );
-  if( widthValue )
+  Toolkit::Visual::Base visual =  Toolkit::VisualFactory::Get().CreateVisual( mPropertyMap );
+  if( visual )
   {
-    widthValue->Get( width );
-  }
+    // Don't set mVisual until it is ready and shown. Getters will still use current visual.
+    if( !mVisual )
+    {
+      mVisual = visual;
+    }
 
-  int height = 0;
-  Property::Value* heightValue = mPropertyMap.Find( "height" );
-  if( heightValue )
-  {
-    heightValue->Get( height );
+    DevelControl::RegisterVisual( *this, Toolkit::ImageView::Property::IMAGE, visual  );
   }
+  else
+  {
+    // Unregister the exsiting visual
+    DevelControl::UnregisterVisual( *this, Toolkit::ImageView::Property::IMAGE );
 
-  mImageSize = ImageDimensions( width, height );
+    // Trigger a size negotiation request that may be needed when unregistering a visual.
+    RelayoutRequest();
+  }
 }
 
 void ImageView::SetImage( const std::string& url, ImageDimensions size )
 {
-  if( mUrl != url )
+  // Don't bother comparing if we had a visual previously, just drop old visual and create new one
+  mUrl = url;
+  mImage.Reset();
+  mPropertyMap.Clear();
+
+  // Don't set mVisual until it is ready and shown. Getters will still use current visual.
+  Toolkit::Visual::Base visual =  Toolkit::VisualFactory::Get().CreateVisual( url, size );
+  if( visual )
   {
-    mImage.Reset();
-    mPropertyMap.Clear();
-
-    mUrl = url;
-
-    if( size.GetWidth() == 0u && size.GetHeight() == 0u )
-    {
-      mImageSize = ResourceImage::GetImageSize( mUrl );
-    }
-    else
+    if( !mVisual )
     {
-      mImageSize = size;
+      mVisual = visual;
     }
 
-    Actor self = Self();
-    Toolkit::RendererFactory::Get().ResetRenderer( mRenderer, self, mUrl, mImageSize );
+    DevelControl::RegisterVisual( *this, Toolkit::ImageView::Property::IMAGE, visual );
+  }
+  else
+  {
+    // Unregister the exsiting visual
+    DevelControl::UnregisterVisual( *this, Toolkit::ImageView::Property::IMAGE );
+
+    // Trigger a size negotiation request that may be needed when unregistering a visual.
+    RelayoutRequest();
   }
 }
 
-Vector3 ImageView::GetNaturalSize()
+Image ImageView::GetImage() const
 {
-  Vector3 size;
+  return mImage;
+}
+
+void ImageView::EnablePreMultipliedAlpha( bool preMultipled )
+{
+  if( mVisual )
+  {
+    Toolkit::GetImplementation( mVisual ).EnablePreMultipliedAlpha( preMultipled );
+  }
+}
 
-  size.x = mImageSize.GetWidth();
-  size.y = mImageSize.GetHeight();
-  size.z = std::min(size.x, size.y);
+bool ImageView::IsPreMultipliedAlphaEnabled() const
+{
+  if( mVisual )
+  {
+    return Toolkit::GetImplementation( mVisual ).IsPreMultipliedAlphaEnabled();
+  }
+  return false;
+}
 
-  if( size.x > 0 && size.y > 0 )
+void ImageView::SetDepthIndex( int depthIndex )
+{
+  if( mVisual )
   {
-    return size;
+    mVisual.SetDepthIndex( depthIndex );
   }
-  else
+}
+
+Vector3 ImageView::GetNaturalSize()
+{
+  if( mVisual )
   {
-    // if no image then use Control's natural size
-    return Control::GetNaturalSize();
+    Vector2 rendererNaturalSize;
+    mVisual.GetNaturalSize( rendererNaturalSize );
+
+    Extents padding;
+    padding = Self().GetProperty<Extents>( Toolkit::Control::Property::PADDING );
+
+    rendererNaturalSize.width += ( padding.start + padding.end );
+    rendererNaturalSize.height += ( padding.top + padding.bottom );
+    return Vector3( rendererNaturalSize );
   }
+
+  // if no visual then use Control's natural size
+  return Control::GetNaturalSize();
 }
 
 float ImageView::GetHeightForWidth( float width )
 {
-  if( mImageSize.GetWidth() > 0 && mImageSize.GetHeight() > 0 )
+  Extents padding;
+  padding = Self().GetProperty<Extents>( Toolkit::Control::Property::PADDING );
+
+  if( mVisual )
   {
-    return GetHeightForWidthBase( width );
+    return mVisual.GetHeightForWidth( width ) + padding.top + padding.bottom;
   }
   else
   {
-    return Control::GetHeightForWidth( width );
+    return Control::GetHeightForWidth( width ) + padding.top + padding.bottom;
   }
 }
 
 float ImageView::GetWidthForHeight( float height )
 {
-  if( mImageSize.GetWidth() > 0 && mImageSize.GetHeight() > 0 )
+  Extents padding;
+  padding = Self().GetProperty<Extents>( Toolkit::Control::Property::PADDING );
+
+  if( mVisual )
   {
-    return GetWidthForHeightBase( height );
+    return mVisual.GetWidthForHeight( height ) + padding.start + padding.end;
   }
   else
   {
-    return Control::GetWidthForHeight( height );
+    return Control::GetWidthForHeight( height ) + padding.start + padding.end;
   }
 }
 
-///////////////////////////////////////////////////////////
-//
-// Private methods
-//
-
-void ImageView::OnStageConnection( int depth )
+void ImageView::OnRelayout( const Vector2& size, RelayoutContainer& container )
 {
-  Control::OnStageConnection( depth );
+  Control::OnRelayout( size, container );
 
-  if( mRenderer )
+  if( mVisual )
   {
-    CustomActor self = Self();
-    mRenderer.SetOnStage( self );
+    Extents padding;
+    padding = Self().GetProperty<Extents>( Toolkit::Control::Property::PADDING );
+
+    Property::Map transformMap = Property::Map();
+
+    if( ( padding.start != 0 ) || ( padding.end != 0 ) || ( padding.top != 0 ) || ( padding.bottom != 0 ) )
+    {
+      transformMap.Add( Toolkit::Visual::Transform::Property::OFFSET, Vector2( padding.start, padding.top ) )
+                  .Add( Toolkit::Visual::Transform::Property::OFFSET_POLICY, Vector2( Toolkit::Visual::Transform::Policy::ABSOLUTE, Toolkit::Visual::Transform::Policy::ABSOLUTE ) )
+                  .Add( Toolkit::Visual::Transform::Property::ORIGIN, Toolkit::Align::TOP_BEGIN )
+                  .Add( Toolkit::Visual::Transform::Property::ANCHOR_POINT, Toolkit::Align::TOP_BEGIN );
+    }
+
+    // Should provide a transform that handles aspect ratio according to image size
+    mVisual.SetTransformAndSize( transformMap, size );
   }
 }
 
-void ImageView::OnStageDisconnection()
+void ImageView::OnResourceReady( Toolkit::Control control )
 {
-  if( mRenderer )
-  {
-    CustomActor self = Self();
-    mRenderer.SetOffStage( self );
-  }
-
-  Control::OnStageDisconnection();
+  // Visual ready so update visual attached to this ImageView, following call to RelayoutRequest will use this visual.
+  mVisual = DevelControl::GetVisual( *this, Toolkit::ImageView::Property::IMAGE );
 }
 
-
 ///////////////////////////////////////////////////////////
 //
 // Properties
@@ -208,25 +297,67 @@ void ImageView::SetProperty( BaseObject* object, Property::Index index, const Pr
 
   if ( imageView )
   {
+    ImageView& impl = GetImpl( imageView );
     switch ( index )
     {
-      case Toolkit::ImageView::Property::IMAGE:
+      case Toolkit::ImageView::Property::RESOURCE_URL:
       {
         std::string imageUrl;
         if( value.Get( imageUrl ) )
         {
-          ImageView& impl = GetImpl( imageView );
           impl.SetImage( imageUrl, ImageDimensions() );
         }
+        break;
+      }
 
+      case Toolkit::ImageView::Property::IMAGE:
+      {
+        std::string imageUrl;
+        Property::Map* map;
+        if( value.Get( imageUrl ) )
+        {
+          impl.SetImage( imageUrl, ImageDimensions() );
+        }
         // if its not a string then get a Property::Map from the property if possible.
-        Property::Map map;
-        if( value.Get( map ) )
+        else
         {
-          ImageView& impl = GetImpl( imageView );
-          impl.SetImage( map );
+          map = value.GetMap();
+          if( map )
+          {
+            Property::Value* shaderValue = map->Find( Toolkit::Visual::Property::SHADER, CUSTOM_SHADER );
+            // set image only if property map contains image information other than custom shader
+            if( map->Count() > 1u ||  !shaderValue )
+            {
+              impl.SetImage( *map );
+            }
+            // the property map contains only the custom shader
+            else if( ( impl.mVisual )&&( map->Count() == 1u )&&( shaderValue ) )
+            {
+              Property::Map* shaderMap = shaderValue->GetMap();
+              if( shaderMap )
+              {
+                Internal::Visual::Base& visual = Toolkit::GetImplementation( impl.mVisual );
+                visual.SetCustomShader( *shaderMap );
+                if( imageView.OnStage() )
+                {
+                  // force to create new core renderer to use the newly set shader
+                  visual.SetOffStage( imageView );
+                  visual.SetOnStage( imageView );
+                }
+              }
+            }
+          }
         }
+        break;
+      }
 
+      case Toolkit::ImageView::Property::PRE_MULTIPLIED_ALPHA:
+      {
+        bool isPre;
+        if( value.Get( isPre ) )
+        {
+          impl.EnablePreMultipliedAlpha( isPre );
+        }
         break;
       }
     }
@@ -241,11 +372,20 @@ Property::Value ImageView::GetProperty( BaseObject* object, Property::Index prop
 
   if ( imageview )
   {
+    ImageView& impl = GetImpl( imageview );
     switch ( propertyIndex )
     {
+      case Toolkit::ImageView::Property::RESOURCE_URL:
+      {
+        if ( !impl.mUrl.empty() )
+        {
+          value = impl.mUrl;
+        }
+        break;
+      }
+
       case Toolkit::ImageView::Property::IMAGE:
       {
-        ImageView& impl = GetImpl( imageview );
         if ( !impl.mUrl.empty() )
         {
           value = impl.mUrl;
@@ -262,6 +402,12 @@ Property::Value ImageView::GetProperty( BaseObject* object, Property::Index prop
         }
         break;
       }
+
+      case Toolkit::ImageView::Property::PRE_MULTIPLIED_ALPHA:
+      {
+        value = impl.IsPreMultipliedAlphaEnabled();
+        break;
+      }
     }
   }