dali-toolkit/devel-api/layouting/layout-item-impl.cpp

   1 /*
   2  * Copyright (c) 2018 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 #include <dali/integration-api/debug.h>
  18
  19 #include <dali/public-api/animation/animation.h>
  20 #include <dali/public-api/object/type-registry-helper.h>
  21 #include <dali-toolkit/public-api/controls/control.h>
  22 #include <dali-toolkit/devel-api/layouting/layout-item-impl.h>
  23 #include <dali-toolkit/internal/layouting/layout-item-data-impl.h>
  24
  25 namespace
  26 {
  27
  28 #if defined(DEBUG_ENABLED)
  29 Debug::Filter* gLayoutFilter = Debug::Filter::New( Debug::Verbose, false, "LOG_LAYOUT" );
  30 #endif
  31
  32 const char* WIDTH_SPECIFICATION_NAME( "widthSpecification" );
  33 const char* HEIGHT_SPECIFICATION_NAME( "heightSpecification" );
  34
  35 const float DEFAULT_TRANSITION_DURATION( 0.5f );
  36 }
  37
  38 namespace Dali
  39 {
  40 namespace Toolkit
  41 {
  42 namespace Internal
  43 {
  44
  45 LayoutItem::LayoutItem()
  46 : mImpl( new LayoutItem::Impl() ),
  47   mSlotDelegate( this )
  48 {
  49 }
  50
  51 LayoutItem::~LayoutItem()
  52 {
  53   // An object with a unique_ptr to an opaque structure must define it's destructor in the translation unit
  54   // where the opaque structure is defined. It cannot use the default method in the header file.
  55 }
  56
  57 LayoutItemPtr LayoutItem::New( Handle& owner )
  58 {
  59   LayoutItemPtr layoutPtr = new LayoutItem();
  60   return layoutPtr;
  61 }
  62
  63 void LayoutItem::Initialize( Handle& owner, const std::string& containerType )
  64 {
  65   mImpl->mOwner = &(owner.GetBaseObject());
  66   RegisterChildProperties( containerType );
  67   OnInitialize(); // Ensure direct deriving class gets initialized
  68   RequestLayout();
  69 }
  70
  71 Handle LayoutItem::GetOwner() const
  72 {
  73   return Handle::DownCast(BaseHandle(mImpl->mOwner));
  74 }
  75
  76 void LayoutItem::Unparent()
  77 {
  78   // Enable directly derived types to first remove children
  79   OnUnparent();
  80
  81   // Last, clear owner
  82   mImpl->mOwner = NULL;
  83 }
  84
  85 void LayoutItem::SetAnimateLayout( bool animateLayout )
  86 {
  87   mImpl->mAnimated = animateLayout;
  88 }
  89
  90 bool LayoutItem::IsLayoutAnimated() const
  91 {
  92   return mImpl->mAnimated;
  93 }
  94
  95 void LayoutItem::RegisterChildProperties( const std::string& containerType )
  96 {
  97   // Call on derived types
  98   auto typeInfo = TypeRegistry::Get().GetTypeInfo( containerType );
  99   if( typeInfo )
 100   {
 101     Property::IndexContainer indices;
 102     typeInfo.GetChildPropertyIndices( indices );
 103
 104     if( std::find( indices.Begin(), indices.End(), Toolkit::LayoutItem::ChildProperty::WIDTH_SPECIFICATION ) ==
 105         indices.End() )
 106     {
 107       ChildPropertyRegistration( typeInfo.GetName(), WIDTH_SPECIFICATION_NAME,
 108                                  Toolkit::LayoutItem::ChildProperty::WIDTH_SPECIFICATION, Property::INTEGER );
 109
 110       ChildPropertyRegistration( typeInfo.GetName(), HEIGHT_SPECIFICATION_NAME,
 111                                  Toolkit::LayoutItem::ChildProperty::HEIGHT_SPECIFICATION, Property::INTEGER );
 112     }
 113
 114     OnRegisterChildProperties( containerType );
 115   }
 116 }
 117
 118 void LayoutItem::OnRegisterChildProperties( const std::string& containerType )
 119 {
 120 }
 121
 122
 123 void LayoutItem::Measure( MeasureSpec widthMeasureSpec, MeasureSpec heightMeasureSpec )
 124 {
 125   DALI_LOG_TRACE_METHOD( gLayoutFilter );
 126
 127   const bool forceLayout = mImpl->GetPrivateFlag( Impl::PRIVATE_FLAG_FORCE_LAYOUT );
 128
 129   const bool specChanged =
 130     ( widthMeasureSpec  != mImpl->mOldWidthMeasureSpec ) ||
 131     ( heightMeasureSpec != mImpl->mOldHeightMeasureSpec );
 132
 133   const bool isSpecExactly =
 134     ( widthMeasureSpec.GetMode() == MeasureSpec::Mode::EXACTLY ) &&
 135     ( heightMeasureSpec.GetMode() == MeasureSpec::Mode::EXACTLY );
 136
 137   const bool matchesSpecSize =
 138     ( GetMeasuredWidth() == widthMeasureSpec.GetSize() ) &&
 139     ( GetMeasuredHeight() == heightMeasureSpec.GetSize() );
 140
 141   const bool needsLayout = specChanged && ( !isSpecExactly || !matchesSpecSize );
 142
 143   if( forceLayout || needsLayout )
 144   {
 145     mImpl->ClearPrivateFlag( Impl::PRIVATE_FLAG_MEASURED_DIMENSION_SET );
 146
 147     // measure ourselves, this should set the measured dimension flag back
 148 #if defined(DEBUG_ENABLED)
 149     std::ostringstream o;
 150     o<<widthMeasureSpec<<","<<heightMeasureSpec;
 151     DALI_LOG_INFO( gLayoutFilter, Debug::Concise, "Calling %s OnMeasure( %s )\n", Actor::DownCast(GetOwner()).GetName().c_str(), o.str().c_str());
 152 #endif
 153     OnMeasure( widthMeasureSpec, heightMeasureSpec );
 154     mImpl->ClearPrivateFlag( Impl::PRIVATE_FLAG_MEASURE_NEEDED_BEFORE_LAYOUT );
 155
 156     // flag not set, setMeasuredDimension() was not invoked, we raise an exception to warn the developer
 157     DALI_ASSERT_ALWAYS( mImpl->GetPrivateFlag( Impl::PRIVATE_FLAG_MEASURED_DIMENSION_SET ) &&
 158                         "Layout's OnMeasure() did not set the measured dimension by calling setMeasuredDimension()" );
 159     mImpl->SetPrivateFlag( Impl::PRIVATE_FLAG_LAYOUT_REQUIRED );
 160   }
 161
 162   mImpl->mOldWidthMeasureSpec = widthMeasureSpec;
 163   mImpl->mOldHeightMeasureSpec = heightMeasureSpec;
 164 }
 165
 166 void LayoutItem::Layout( LayoutLength l, LayoutLength t, LayoutLength r, LayoutLength b )
 167 {
 168   if( mImpl->GetPrivateFlag( Impl::PRIVATE_FLAG_MEASURE_NEEDED_BEFORE_LAYOUT ) )
 169   {
 170     OnMeasure( mImpl->mOldWidthMeasureSpec, mImpl->mOldHeightMeasureSpec );
 171     mImpl->ClearPrivateFlag( Impl::PRIVATE_FLAG_MEASURE_NEEDED_BEFORE_LAYOUT );
 172   }
 173
 174   bool changed = SetFrame( l, t, r, b );
 175
 176   if( changed || mImpl->GetPrivateFlag( Impl::PRIVATE_FLAG_LAYOUT_REQUIRED ) )
 177   {
 178     OnLayout( changed, l, t, r, b );
 179     mImpl->ClearPrivateFlag( Impl::PRIVATE_FLAG_LAYOUT_REQUIRED );
 180   }
 181
 182   mImpl->ClearPrivateFlag( Impl::PRIVATE_FLAG_FORCE_LAYOUT );
 183   mImpl->SetPrivateFlag( Impl::PRIVATE_FLAG_IS_LAID_OUT );
 184 }
 185
 186 LayoutLength LayoutItem::GetMinimumWidth() const
 187 {
 188   return mImpl->mMinimumSize.GetWidth();
 189 }
 190
 191 LayoutLength LayoutItem::GetMinimumHeight() const
 192 {
 193   return mImpl->mMinimumSize.GetHeight();
 194 }
 195
 196 void LayoutItem::SetMinimumWidth( LayoutLength minimumWidth )
 197 {
 198   mImpl->mMinimumSize.SetWidth( minimumWidth );
 199   RequestLayout();
 200 }
 201
 202 void LayoutItem::SetMinimumHeight( LayoutLength minimumHeight )
 203 {
 204   mImpl->mMinimumSize.SetHeight( minimumHeight );
 205   RequestLayout();
 206 }
 207
 208 Extents LayoutItem::GetPadding() const
 209 {
 210   Toolkit::Control control = Toolkit::Control::DownCast( mImpl->mOwner );
 211   if( control )
 212   {
 213     Extents padding = control.GetProperty<Extents>( Toolkit::Control::Property::PADDING );
 214
 215     DALI_LOG_INFO( gLayoutFilter, Debug::Verbose, "LayoutBase::Padding for %s : (%d,%d,%d,%d) \n",
 216                    control.GetName().c_str(),
 217                    padding.start, padding.end, padding.top, padding.bottom
 218                  );
 219     return padding;
 220   }
 221   else
 222   {
 223     return Extents();
 224   }
 225 }
 226
 227 Extents LayoutItem::GetMargin() const
 228 {
 229   Toolkit::Control control = Toolkit::Control::DownCast( mImpl->mOwner );
 230   if ( control )
 231   {
 232     return control.GetProperty<Extents>( Toolkit::Control::Property::MARGIN );
 233   }
 234   else
 235   {
 236     return Extents();
 237   }
 238 }
 239
 240 LayoutLength LayoutItem::GetDefaultSize( LayoutLength size, MeasureSpec measureSpec )
 241 {
 242   LayoutLength result = size;
 243   auto specMode = measureSpec.GetMode();
 244   auto specSize = measureSpec.GetSize();
 245
 246   switch (specMode)
 247   {
 248     case MeasureSpec::Mode::UNSPECIFIED:
 249     {
 250       result = size;
 251       break;
 252     }
 253     case MeasureSpec::Mode::AT_MOST:
 254     {
 255       LayoutLength tmp = specSize;
 256       if( size < tmp )
 257       {
 258         result = size;
 259       }
 260       else
 261       {
 262         result = specSize;
 263       }
 264       break;
 265     }
 266     case MeasureSpec::Mode::EXACTLY:
 267     {
 268       result = specSize;
 269       break;
 270     }
 271   }
 272   return result;
 273 }
 274
 275 void LayoutItem::OnMeasure( MeasureSpec widthMeasureSpec, MeasureSpec heightMeasureSpec)
 276 {
 277   SetMeasuredDimensions( GetDefaultSize( GetSuggestedMinimumWidth(), widthMeasureSpec ),
 278                          GetDefaultSize( GetSuggestedMinimumHeight(), heightMeasureSpec ) );
 279 }
 280
 281 void LayoutItem::OnLayout( bool changed, LayoutLength left, LayoutLength top, LayoutLength right, LayoutLength bottom )
 282 {
 283 }
 284
 285 LayoutParent* LayoutItem::GetParent()
 286 {
 287   return mImpl->mLayoutParent;
 288 }
 289
 290 void LayoutItem::RequestLayout()
 291 {
 292   Toolkit::Control control = Toolkit::Control::DownCast( mImpl->mOwner );
 293   if ( control )
 294   {
 295     DALI_LOG_INFO( gLayoutFilter, Debug::Verbose, "LayoutItem::RequestLayout %s\n", control.GetName().c_str());
 296   }
 297   // @todo Enforce failure if called in Measure/Layout passes.
 298   mImpl->SetPrivateFlag( Impl::PRIVATE_FLAG_FORCE_LAYOUT );
 299   Toolkit::LayoutController layoutController = Toolkit::LayoutController::Get();
 300   layoutController.RequestLayout( Toolkit::LayoutItem(this) );
 301 }
 302
 303 bool LayoutItem::IsLayoutRequested() const
 304 {
 305   return mImpl->GetPrivateFlag( Impl::PRIVATE_FLAG_FORCE_LAYOUT );
 306 }
 307
 308 void LayoutItem::SetLayoutRequested()
 309 {
 310   return mImpl->SetPrivateFlag( Impl::PRIVATE_FLAG_FORCE_LAYOUT );
 311 }
 312
 313 void LayoutItem::SetMeasuredDimensions( MeasuredSize measuredWidth, MeasuredSize measuredHeight )
 314 {
 315   DALI_LOG_INFO( gLayoutFilter, Debug::Verbose, "LayoutBase::SetMeasuredDimensions width(%d) height(%d) \n",
 316                                                  MeasureSpec::IntType( measuredWidth.GetSize() ),
 317                                                  MeasureSpec::IntType( measuredHeight.GetSize() )
 318                );
 319
 320   mImpl->SetPrivateFlag( Impl::PRIVATE_FLAG_MEASURED_DIMENSION_SET );
 321   mImpl->mMeasuredWidth = measuredWidth;
 322   mImpl->mMeasuredHeight = measuredHeight;
 323 }
 324
 325 LayoutLength LayoutItem::GetMeasuredWidth() const
 326 {
 327   // Get the size portion of the measured width
 328   return  mImpl->mMeasuredWidth.GetSize();
 329 }
 330
 331 LayoutLength LayoutItem::GetMeasuredHeight() const
 332 {
 333   return  mImpl->mMeasuredHeight.GetSize();
 334 }
 335
 336 MeasuredSize LayoutItem::GetMeasuredWidthAndState() const
 337 {
 338   return mImpl->mMeasuredWidth;
 339 }
 340
 341 MeasuredSize LayoutItem::GetMeasuredHeightAndState() const
 342 {
 343   return mImpl->mMeasuredHeight;
 344 }
 345
 346 LayoutLength LayoutItem::GetSuggestedMinimumWidth() const
 347 {
 348   auto owner = GetOwner();
 349   auto actor = Actor::DownCast(owner);
 350   auto naturalSize = actor ? actor.GetNaturalSize() : Vector3::ZERO;
 351
 352   return std::max( mImpl->mMinimumSize.GetWidth(), LayoutLength::IntType( naturalSize.width ) );
 353 }
 354
 355 LayoutLength LayoutItem::GetSuggestedMinimumHeight() const
 356 {
 357   auto owner = GetOwner();
 358   auto actor = Actor::DownCast(owner);
 359   auto naturalSize = actor ? actor.GetNaturalSize() : Vector3::ZERO;
 360
 361   return std::max( mImpl->mMinimumSize.GetHeight(), LayoutLength::IntType(naturalSize.height) );
 362 }
 363
 364 MeasuredSize LayoutItem::ResolveSizeAndState( LayoutLength size, MeasureSpec measureSpec, MeasuredSize::State childMeasuredState )
 365 {
 366   auto specMode = measureSpec.GetMode();
 367   LayoutLength specSize = measureSpec.GetSize();
 368   MeasuredSize result;
 369
 370   switch( specMode )
 371   {
 372     case MeasureSpec::Mode::AT_MOST:
 373     {
 374       if (specSize < size)
 375       {
 376         result = MeasuredSize( specSize, MeasuredSize::MEASURED_SIZE_TOO_SMALL );
 377       }
 378       else
 379       {
 380         result.SetSize( size );
 381       }
 382       break;
 383     }
 384
 385     case MeasureSpec::Mode::EXACTLY:
 386     {
 387       result.SetSize( specSize );
 388       break;
 389     }
 390
 391     case MeasureSpec::Mode::UNSPECIFIED:
 392     default:
 393     {
 394       result.SetSize( size );
 395       break;
 396     }
 397   }
 398
 399   result.SetState( childMeasuredState );
 400   return result;
 401 }
 402
 403
 404 bool LayoutItem::SetFrame( LayoutLength left, LayoutLength top, LayoutLength right, LayoutLength bottom )
 405 {
 406   bool changed = false;
 407
 408   DALI_LOG_INFO( gLayoutFilter, Debug::Verbose, "LayoutItem::SetFrame(%d, %d, %d, %d)\n", left.mValue, top.mValue, right.mValue, bottom.mValue );
 409
 410   if( mImpl->mLeft != left || mImpl->mRight != right || mImpl->mTop != top || mImpl->mBottom != bottom )
 411   {
 412     changed = true;
 413
 414     auto oldWidth = mImpl->mRight - mImpl->mLeft;
 415     auto oldHeight = mImpl->mBottom - mImpl->mTop;
 416     auto newWidth = right - left;
 417     auto newHeight = bottom - top;
 418     bool sizeChanged = (newWidth != oldWidth) || (newHeight != oldHeight);
 419
 420     mImpl->mLeft = left;
 421     mImpl->mTop = top;
 422     mImpl->mRight = right;
 423     mImpl->mBottom = bottom;
 424
 425     mImpl->SetPrivateFlag( Impl::PRIVATE_FLAG_HAS_BOUNDS );
 426
 427
 428     // Reflect up to parent control
 429     auto owner = GetOwner();
 430     auto actor = Actor::DownCast(owner);
 431     if( actor )
 432     {
 433       if( mImpl->mAnimated )
 434       {
 435         auto animation = Animation::New( 0.5f );
 436         animation.AnimateTo( Property( actor, Actor::Property::POSITION ),
 437                              Vector3( float(left.mValue), float(top.mValue), 0.0f ) );
 438         animation.AnimateTo( Property( actor, Actor::Property::SIZE ),
 439                              Vector3( right-left, bottom-top, 0.0f ) );
 440         animation.FinishedSignal().Connect( mSlotDelegate, &LayoutItem::OnLayoutAnimationFinished );
 441         animation.Play();
 442       }
 443       else
 444       {
 445         // @todo Collate into list of Property & Property::Value pairs.
 446         actor.SetPosition( Vector3( float(left.mValue), float(top.mValue), 0.0f ) );
 447         actor.SetSize( Vector3( right-left, bottom-top, 0.0f ) );
 448       }
 449     }
 450
 451     if( sizeChanged )
 452     {
 453       SizeChange( LayoutSize( newWidth, newHeight ), LayoutSize( oldWidth, oldHeight ) );
 454     }
 455   }
 456   return changed;
 457 }
 458
 459 void LayoutItem::OnLayoutAnimationFinished( Animation& animation )
 460 {
 461   auto owner = GetOwner();
 462   auto actor = Actor::DownCast(owner);
 463   if( actor )
 464   {
 465     actor.SetSize( Vector3( mImpl->mRight-mImpl->mLeft, mImpl->mBottom-mImpl->mTop, 0.0f ) );
 466   }
 467 }
 468
 469 void LayoutItem::SizeChange( LayoutSize newSize, LayoutSize oldSize)
 470 {
 471   OnSizeChanged( newSize, oldSize );
 472 }
 473
 474
 475 void LayoutItem::OnSizeChanged( LayoutSize newSize, LayoutSize oldSize )
 476 {
 477 }
 478
 479 void LayoutItem::OnInitialize()
 480 {
 481 }
 482
 483
 484 } // namespace Internal
 485 } // namespace Toolkit
 486 } // namespace Dali