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 {
  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   Toolkit::DevelControl::ResourceReadySignal( handle ).Connect( this, &ImageView::OnResourceReady );
  95 }
  96
  97 void ImageView::SetImage( Image image )
  98 {
  99   // Don't bother comparing if we had a visual previously, just drop old visual and create new one
 100   mImage = image;
 101   mUrl.clear();
 102   mPropertyMap.Clear();
 103
 104   Toolkit::Visual::Base visual =  Toolkit::VisualFactory::Get().CreateVisual( image );
 105   if (!mVisual)
 106   {
 107     mVisual = visual;
 108   }
 109
 110   DevelControl::RegisterVisual( *this, Toolkit::ImageView::Property::IMAGE, visual  );
 111 }
 112
 113 void ImageView::SetImage( const Property::Map& map )
 114 {
 115   // Comparing a property map is too expensive so just creating a new visual
 116   mPropertyMap = map;
 117   mUrl.clear();
 118   mImage.Reset();
 119
 120   Toolkit::Visual::Base visual =  Toolkit::VisualFactory::Get().CreateVisual( mPropertyMap );
 121   // Don't set mVisual until it is ready and shown. Getters will still use current visual.
 122   if (!mVisual)
 123   {
 124     mVisual = visual;
 125   }
 126
 127   DevelControl::RegisterVisual( *this, Toolkit::ImageView::Property::IMAGE, visual  );
 128 }
 129
 130 void ImageView::SetImage( const std::string& url, ImageDimensions size )
 131 {
 132   // Don't bother comparing if we had a visual previously, just drop old visual and create new one
 133   mUrl = url;
 134   mImage.Reset();
 135   mPropertyMap.Clear();
 136
 137   // Don't set mVisual until it is ready and shown. Getters will still use current visual.
 138   Toolkit::Visual::Base visual =  Toolkit::VisualFactory::Get().CreateVisual( url, size );
 139   if (!mVisual)
 140   {
 141     mVisual = visual;
 142   }
 143
 144   DevelControl::RegisterVisual( *this, Toolkit::ImageView::Property::IMAGE, visual );
 145 }
 146
 147 Image ImageView::GetImage() const
 148 {
 149   return mImage;
 150 }
 151
 152 void ImageView::EnablePreMultipliedAlpha( bool preMultipled )
 153 {
 154   if( mVisual )
 155   {
 156     Toolkit::GetImplementation( mVisual ).EnablePreMultipliedAlpha( preMultipled );
 157   }
 158 }
 159
 160 bool ImageView::IsPreMultipliedAlphaEnabled() const
 161 {
 162   if( mVisual )
 163   {
 164     return Toolkit::GetImplementation( mVisual ).IsPreMultipliedAlphaEnabled();
 165   }
 166   return false;
 167 }
 168
 169 void ImageView::SetDepthIndex( int depthIndex )
 170 {
 171   if( mVisual )
 172   {
 173     mVisual.SetDepthIndex( depthIndex );
 174   }
 175 }
 176
 177 Vector3 ImageView::GetNaturalSize()
 178 {
 179   if( mVisual )
 180   {
 181     Vector2 rendererNaturalSize;
 182     mVisual.GetNaturalSize( rendererNaturalSize );
 183     return Vector3( rendererNaturalSize );
 184   }
 185
 186   // if no visual then use Control's natural size
 187   return Control::GetNaturalSize();
 188 }
 189
 190 float ImageView::GetHeightForWidth( float width )
 191 {
 192   if( mVisual )
 193   {
 194     return mVisual.GetHeightForWidth( width );
 195   }
 196   else
 197   {
 198     return Control::GetHeightForWidth( width );
 199   }
 200 }
 201
 202 float ImageView::GetWidthForHeight( float height )
 203 {
 204   if( mVisual )
 205   {
 206     return mVisual.GetWidthForHeight( height );
 207   }
 208   else
 209   {
 210     return Control::GetWidthForHeight( height );
 211   }
 212 }
 213
 214 void ImageView::OnRelayout( const Vector2& size, RelayoutContainer& container )
 215 {
 216   Control::OnRelayout( size, container );
 217
 218   if( mVisual )
 219   {
 220     // Pass in an empty map which uses default transform values meaning our visual fills the control
 221     // Should provide a transform that handles aspect ratio according to image size
 222     mVisual.SetTransformAndSize( Property::Map(), size );
 223   }
 224 }
 225
 226 void ImageView::OnResourceReady( Toolkit::Control control )
 227 {
 228   // Visual ready so update visual attached to this ImageView, following call to RelayoutRequest will use this visual.
 229   mVisual = DevelControl::GetVisual( *this, Toolkit::ImageView::Property::IMAGE );
 230 }
 231
 232 ///////////////////////////////////////////////////////////
 233 //
 234 // Properties
 235 //
 236
 237 void ImageView::SetProperty( BaseObject* object, Property::Index index, const Property::Value& value )
 238 {
 239   Toolkit::ImageView imageView = Toolkit::ImageView::DownCast( Dali::BaseHandle( object ) );
 240
 241   if ( imageView )
 242   {
 243     ImageView& impl = GetImpl( imageView );
 244     switch ( index )
 245     {
 246       case Toolkit::ImageView::Property::RESOURCE_URL:
 247       {
 248         std::string imageUrl;
 249         if( value.Get( imageUrl ) )
 250         {
 251           impl.SetImage( imageUrl, ImageDimensions() );
 252         }
 253         break;
 254       }
 255
 256       case Toolkit::ImageView::Property::IMAGE:
 257       {
 258         std::string imageUrl;
 259         Property::Map* map;
 260         if( value.Get( imageUrl ) )
 261         {
 262           impl.SetImage( imageUrl, ImageDimensions() );
 263         }
 264         // if its not a string then get a Property::Map from the property if possible.
 265         else
 266         {
 267           map = value.GetMap();
 268           if( map )
 269           {
 270             Property::Value* shaderValue = map->Find( Toolkit::DevelVisual::Property::SHADER, CUSTOM_SHADER );
 271             // set image only if property map contains image information other than custom shader
 272             if( map->Count() > 1u ||  !shaderValue )
 273             {
 274               impl.SetImage( *map );
 275             }
 276             // the property map contains only the custom shader
 277             else if( ( impl.mVisual )&&( map->Count() == 1u )&&( shaderValue ) )
 278             {
 279               Property::Map* shaderMap = shaderValue->GetMap();
 280               if( shaderMap )
 281               {
 282                 Internal::Visual::Base& visual = Toolkit::GetImplementation( impl.mVisual );
 283                 visual.SetCustomShader( *shaderMap );
 284                 if( imageView.OnStage() )
 285                 {
 286                   // force to create new core renderer to use the newly set shader
 287                   visual.SetOffStage( imageView );
 288                   visual.SetOnStage( imageView );
 289                 }
 290               }
 291             }
 292           }
 293         }
 294         break;
 295       }
 296
 297       case Toolkit::ImageView::Property::PRE_MULTIPLIED_ALPHA:
 298       {
 299         bool isPre;
 300         if( value.Get( isPre ) )
 301         {
 302           impl.EnablePreMultipliedAlpha( isPre );
 303         }
 304         break;
 305       }
 306     }
 307   }
 308 }
 309
 310 Property::Value ImageView::GetProperty( BaseObject* object, Property::Index propertyIndex )
 311 {
 312   Property::Value value;
 313
 314   Toolkit::ImageView imageview = Toolkit::ImageView::DownCast( Dali::BaseHandle( object ) );
 315
 316   if ( imageview )
 317   {
 318     ImageView& impl = GetImpl( imageview );
 319     switch ( propertyIndex )
 320     {
 321       case Toolkit::ImageView::Property::RESOURCE_URL:
 322       {
 323         if ( !impl.mUrl.empty() )
 324         {
 325           value = impl.mUrl;
 326         }
 327         break;
 328       }
 329
 330       case Toolkit::ImageView::Property::IMAGE:
 331       {
 332         if ( !impl.mUrl.empty() )
 333         {
 334           value = impl.mUrl;
 335         }
 336         else if( impl.mImage )
 337         {
 338           Property::Map map;
 339           Scripting::CreatePropertyMap( impl.mImage, map );
 340           value = map;
 341         }
 342         else if( !impl.mPropertyMap.Empty() )
 343         {
 344           value = impl.mPropertyMap;
 345         }
 346         break;
 347       }
 348
 349       case Toolkit::ImageView::Property::PRE_MULTIPLIED_ALPHA:
 350       {
 351         value = impl.IsPreMultipliedAlphaEnabled();
 352         break;
 353       }
 354     }
 355   }
 356
 357   return value;
 358 }
 359
 360 } // namespace Internal
 361 } // namespace Toolkit
 362 } // namespace Dali