dali-toolkit/internal/controls/image-view/image-view-impl.cpp

   1 /*
   2  * Copyright (c) 2017 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/public-api/images/resource-image.h>
  23 #include <dali/public-api/object/type-registry.h>
  24 #include <dali/public-api/object/type-registry-helper.h>
  25 #include <dali/devel-api/scripting/scripting.h>
  26
  27 // INTERNAL INCLUDES
  28 #include <dali-toolkit/public-api/controls/image-view/image-view.h>
  29 #include <dali-toolkit/devel-api/controls/control-devel.h>
  30 #include <dali-toolkit/devel-api/visuals/visual-properties-devel.h>
  31 #include <dali-toolkit/devel-api/visual-factory/visual-factory.h>
  32 #include <dali-toolkit/internal/visuals/visual-string-constants.h>
  33 #include <dali-toolkit/internal/visuals/visual-base-impl.h>
  34 #include <dali-toolkit/internal/visuals/visual-base-data-impl.h>
  35
  36 namespace Dali
  37 {
  38
  39 namespace Toolkit
  40 {
  41
  42 namespace Internal
  43 {
  44
  45 namespace
  46 {
  47
  48 BaseHandle Create()
  49 {
  50   return Toolkit::ImageView::New();
  51 }
  52
  53 // Setup properties, signals and actions using the type-registry.
  54 DALI_TYPE_REGISTRATION_BEGIN( Toolkit::ImageView, Toolkit::Control, Create );
  55 DALI_PROPERTY_REGISTRATION( Toolkit, ImageView, "resourceUrl", STRING, RESOURCE_URL )
  56 DALI_PROPERTY_REGISTRATION( Toolkit, ImageView, "image", MAP, IMAGE )
  57 DALI_PROPERTY_REGISTRATION( Toolkit, ImageView, "preMultipliedAlpha", BOOLEAN, PRE_MULTIPLIED_ALPHA )
  58
  59 DALI_ANIMATABLE_PROPERTY_REGISTRATION_WITH_DEFAULT( Toolkit, ImageView, "pixelArea", Vector4(0.f, 0.f, 1.f, 1.f), PIXEL_AREA )
  60 DALI_TYPE_REGISTRATION_END()
  61
  62 } // anonymous namespace
  63
  64 using namespace Dali;
  65
  66 ImageView::ImageView()
  67 : Control( ControlBehaviour( CONTROL_BEHAVIOUR_DEFAULT ) ),
  68   mRelayoutRequired(true)
  69 {
  70 }
  71
  72 ImageView::~ImageView()
  73 {
  74 }
  75
  76 Toolkit::ImageView ImageView::New()
  77 {
  78   ImageView* impl = new ImageView();
  79
  80   Toolkit::ImageView handle = Toolkit::ImageView( *impl );
  81
  82   // Second-phase init of the implementation
  83   // This can only be done after the CustomActor connection has been made...
  84   impl->Initialize();
  85
  86   return handle;
  87 }
  88
  89 /////////////////////////////////////////////////////////////
  90
  91 void ImageView::OnInitialize()
  92 {
  93   // ImageView can relayout in the OnImageReady, alternative to a signal would be to have a upcall from the Control to ImageView
  94   Dali::Toolkit::Control handle( GetOwner() );
  95   Toolkit::DevelControl::ResourceReadySignal( handle ).Connect( this, &ImageView::OnResourceReady );
  96 }
  97
  98 void ImageView::SetImage( Image image )
  99 {
 100   // Don't bother comparing if we had a visual previously, just drop old visual and create new one
 101   mImage = image;
 102   mUrl.clear();
 103   mPropertyMap.Clear();
 104
 105   Toolkit::Visual::Base visual =  Toolkit::VisualFactory::Get().CreateVisual( image );
 106   if (!mVisual)
 107   {
 108     mVisual = visual;
 109   }
 110
 111   DevelControl::RegisterVisual( *this, Toolkit::ImageView::Property::IMAGE, visual  );
 112 }
 113
 114 void ImageView::SetImage( const Property::Map& map )
 115 {
 116   // Comparing a property map is too expensive so just creating a new visual
 117   mPropertyMap = map;
 118   mUrl.clear();
 119   mImage.Reset();
 120   mRelayoutRequired = true;
 121
 122   Toolkit::Visual::Base visual =  Toolkit::VisualFactory::Get().CreateVisual( mPropertyMap );
 123   // Don't set mVisual until it is ready and shown. Getters will still use current visual.
 124   if (!mVisual)
 125   {
 126     mVisual = visual;
 127   }
 128
 129   DevelControl::RegisterVisual( *this, Toolkit::ImageView::Property::IMAGE, visual  );
 130 }
 131
 132 void ImageView::SetImage( const std::string& url, ImageDimensions size )
 133 {
 134   // Don't bother comparing if we had a visual previously, just drop old visual and create new one
 135   mUrl = url;
 136   mImage.Reset();
 137   mPropertyMap.Clear();
 138   mRelayoutRequired = true;
 139
 140   // Don't set mVisual until it is ready and shown. Getters will still use current visual.
 141   Toolkit::Visual::Base visual =  Toolkit::VisualFactory::Get().CreateVisual( url, size );
 142   if (!mVisual)
 143   {
 144     mVisual = visual;
 145   }
 146
 147   DevelControl::RegisterVisual( *this, Toolkit::ImageView::Property::IMAGE, visual );
 148 }
 149
 150 Image ImageView::GetImage() const
 151 {
 152   return mImage;
 153 }
 154
 155 void ImageView::EnablePreMultipliedAlpha( bool preMultipled )
 156 {
 157   if( mVisual )
 158   {
 159     Toolkit::GetImplementation( mVisual ).EnablePreMultipliedAlpha( preMultipled );
 160   }
 161 }
 162
 163 bool ImageView::IsPreMultipliedAlphaEnabled() const
 164 {
 165   if( mVisual )
 166   {
 167     return Toolkit::GetImplementation( mVisual ).IsPreMultipliedAlphaEnabled();
 168   }
 169   return false;
 170 }
 171
 172 void ImageView::SetDepthIndex( int depthIndex )
 173 {
 174   if( mVisual )
 175   {
 176     mVisual.SetDepthIndex( depthIndex );
 177   }
 178 }
 179
 180 Vector3 ImageView::GetNaturalSize()
 181 {
 182   if( mVisual )
 183   {
 184     Vector2 rendererNaturalSize;
 185     mVisual.GetNaturalSize( rendererNaturalSize );
 186     return Vector3( rendererNaturalSize );
 187   }
 188
 189   // if no visual then use Control's natural size
 190   return Control::GetNaturalSize();
 191 }
 192
 193 float ImageView::GetHeightForWidth( float width )
 194 {
 195   if( mVisual )
 196   {
 197     return mVisual.GetHeightForWidth( width );
 198   }
 199   else
 200   {
 201     return Control::GetHeightForWidth( width );
 202   }
 203 }
 204
 205 float ImageView::GetWidthForHeight( float height )
 206 {
 207   if( mVisual )
 208   {
 209     return mVisual.GetWidthForHeight( height );
 210   }
 211   else
 212   {
 213     return Control::GetWidthForHeight( height );
 214   }
 215 }
 216
 217 void ImageView::OnRelayout( const Vector2& size, RelayoutContainer& container )
 218 {
 219   Control::OnRelayout( size, container );
 220
 221   // If visual is being replaced then mVisual will be the replacement visual even if not ready.
 222   mVisual = DevelControl::GetVisual( *this, Toolkit::ImageView::Property::IMAGE );
 223
 224   if( mVisual )
 225   {
 226     // Pass in an empty map which uses default transform values meaning our visual fills the control
 227     // Should provide a transform that handles aspect ratio according to image size
 228     mVisual.SetTransformAndSize( Property::Map(), size );
 229   }
 230 }
 231
 232 void ImageView::OnResourceReady( Toolkit::Control control )
 233 {
 234   // Visual ready so update visual attached to this ImageView, following call to RelayoutRequest will use this visual.
 235   mVisual = DevelControl::GetVisual( *this, Toolkit::ImageView::Property::IMAGE );
 236
 237   if( mRelayoutRequired)
 238   {
 239     mRelayoutRequired = false;
 240     RelayoutRequest();
 241   }
 242 }
 243
 244 ///////////////////////////////////////////////////////////
 245 //
 246 // Properties
 247 //
 248
 249 void ImageView::SetProperty( BaseObject* object, Property::Index index, const Property::Value& value )
 250 {
 251   Toolkit::ImageView imageView = Toolkit::ImageView::DownCast( Dali::BaseHandle( object ) );
 252
 253   if ( imageView )
 254   {
 255     ImageView& impl = GetImpl( imageView );
 256     switch ( index )
 257     {
 258       case Toolkit::ImageView::Property::RESOURCE_URL:
 259       {
 260         std::string imageUrl;
 261         if( value.Get( imageUrl ) )
 262         {
 263           impl.SetImage( imageUrl, ImageDimensions() );
 264         }
 265         break;
 266       }
 267
 268       case Toolkit::ImageView::Property::IMAGE:
 269       {
 270         std::string imageUrl;
 271         Property::Map* map;
 272         if( value.Get( imageUrl ) )
 273         {
 274           impl.SetImage( imageUrl, ImageDimensions() );
 275         }
 276         // if its not a string then get a Property::Map from the property if possible.
 277         else
 278         {
 279           map = value.GetMap();
 280           if( map )
 281           {
 282             Property::Value* shaderValue = map->Find( Toolkit::DevelVisual::Property::SHADER, CUSTOM_SHADER );
 283             // set image only if property map contains image information other than custom shader
 284             if( map->Count() > 1u ||  !shaderValue )
 285             {
 286               impl.SetImage( *map );
 287             }
 288             // the property map contains only the custom shader
 289             else if( ( impl.mVisual )&&( map->Count() == 1u )&&( shaderValue ) )
 290             {
 291               Property::Map* shaderMap = shaderValue->GetMap();
 292               if( shaderMap )
 293               {
 294                 Internal::Visual::Base& visual = Toolkit::GetImplementation( impl.mVisual );
 295                 visual.SetCustomShader( *shaderMap );
 296                 if( imageView.OnStage() )
 297                 {
 298                   // force to create new core renderer to use the newly set shader
 299                   visual.SetOffStage( imageView );
 300                   visual.SetOnStage( imageView );
 301                 }
 302               }
 303             }
 304           }
 305         }
 306         break;
 307       }
 308
 309       case Toolkit::ImageView::Property::PRE_MULTIPLIED_ALPHA:
 310       {
 311         bool isPre;
 312         if( value.Get( isPre ) )
 313         {
 314           impl.EnablePreMultipliedAlpha( isPre );
 315         }
 316         break;
 317       }
 318     }
 319   }
 320 }
 321
 322 Property::Value ImageView::GetProperty( BaseObject* object, Property::Index propertyIndex )
 323 {
 324   Property::Value value;
 325
 326   Toolkit::ImageView imageview = Toolkit::ImageView::DownCast( Dali::BaseHandle( object ) );
 327
 328   if ( imageview )
 329   {
 330     ImageView& impl = GetImpl( imageview );
 331     switch ( propertyIndex )
 332     {
 333       case Toolkit::ImageView::Property::RESOURCE_URL:
 334       {
 335         if ( !impl.mUrl.empty() )
 336         {
 337           value = impl.mUrl;
 338         }
 339         break;
 340       }
 341
 342       case Toolkit::ImageView::Property::IMAGE:
 343       {
 344         if ( !impl.mUrl.empty() )
 345         {
 346           value = impl.mUrl;
 347         }
 348         else if( impl.mImage )
 349         {
 350           Property::Map map;
 351           Scripting::CreatePropertyMap( impl.mImage, map );
 352           value = map;
 353         }
 354         else if( !impl.mPropertyMap.Empty() )
 355         {
 356           value = impl.mPropertyMap;
 357         }
 358         break;
 359       }
 360
 361       case Toolkit::ImageView::Property::PRE_MULTIPLIED_ALPHA:
 362       {
 363         value = impl.IsPreMultipliedAlphaEnabled();
 364         break;
 365       }
 366     }
 367   }
 368
 369   return value;
 370 }
 371
 372 } // namespace Internal
 373 } // namespace Toolkit
 374 } // namespace Dali