dali-toolkit/internal/visuals/visual-base-data-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
  18 // CLASS HEADER
  19 #include <dali-toolkit/internal/visuals/visual-base-data-impl.h>
  20
  21 // EXTERNAL INCLUDES
  22 #include <dali-toolkit/public-api/dali-toolkit-common.h>
  23 #include <dali/devel-api/scripting/enum-helper.h>
  24 #include <dali/devel-api/scripting/scripting.h>
  25 #include <dali/integration-api/debug.h>
  26
  27 // INTERNAL INCLUDES
  28 #include <dali-toolkit/public-api/visuals/visual-properties.h>
  29 #include <dali-toolkit/devel-api/visuals/visual-properties-devel.h>
  30 #include <dali-toolkit/internal/helpers/property-helper.h>
  31 #include <dali-toolkit/internal/visuals/visual-string-constants.h>
  32
  33 namespace Dali
  34 {
  35
  36 namespace Toolkit
  37 {
  38
  39 namespace Internal
  40 {
  41
  42 namespace
  43 {
  44
  45 DALI_ENUM_TO_STRING_TABLE_BEGIN( SHADER_HINT )
  46 DALI_ENUM_TO_STRING_WITH_SCOPE( Shader::Hint, NONE )
  47 DALI_ENUM_TO_STRING_WITH_SCOPE( Shader::Hint, OUTPUT_IS_TRANSPARENT )
  48 DALI_ENUM_TO_STRING_WITH_SCOPE( Shader::Hint, MODIFIES_GEOMETRY )
  49 DALI_ENUM_TO_STRING_TABLE_END( SHADER_HINT )
  50
  51 DALI_ENUM_TO_STRING_TABLE_BEGIN( ALIGN )
  52 DALI_ENUM_TO_STRING_WITH_SCOPE( Toolkit::Align, TOP_BEGIN )
  53 DALI_ENUM_TO_STRING_WITH_SCOPE( Toolkit::Align, TOP_CENTER )
  54 DALI_ENUM_TO_STRING_WITH_SCOPE( Toolkit::Align, TOP_END )
  55 DALI_ENUM_TO_STRING_WITH_SCOPE( Toolkit::Align, CENTER_BEGIN )
  56 DALI_ENUM_TO_STRING_WITH_SCOPE( Toolkit::Align, CENTER )
  57 DALI_ENUM_TO_STRING_WITH_SCOPE( Toolkit::Align, CENTER_END )
  58 DALI_ENUM_TO_STRING_WITH_SCOPE( Toolkit::Align, BOTTOM_BEGIN )
  59 DALI_ENUM_TO_STRING_WITH_SCOPE( Toolkit::Align, BOTTOM_CENTER )
  60 DALI_ENUM_TO_STRING_WITH_SCOPE( Toolkit::Align, BOTTOM_END )
  61 DALI_ENUM_TO_STRING_TABLE_END( ALIGN )
  62
  63 DALI_ENUM_TO_STRING_TABLE_BEGIN( POLICY )
  64 DALI_ENUM_TO_STRING_WITH_SCOPE( Toolkit::Visual::Transform::Policy, RELATIVE )
  65 DALI_ENUM_TO_STRING_WITH_SCOPE( Toolkit::Visual::Transform::Policy, ABSOLUTE )
  66 DALI_ENUM_TO_STRING_TABLE_END( POLICY )
  67
  68 Dali::Vector2 PointToVector2( Toolkit::Align::Type point, Toolkit::Direction::Type direction )
  69 {
  70   static const float pointToVector2[] = { 0.0f,0.0f,
  71                                           0.5f,0.0f,
  72                                           1.0f,0.0f,
  73                                           0.0f,0.5f,
  74                                           0.5f,0.5f,
  75                                           1.0f,0.5f,
  76                                           0.0f,1.0f,
  77                                           0.5f,1.0f,
  78                                           1.0f,1.0f };
  79
  80   Vector2 result( &pointToVector2[point*2] );
  81   if( direction == Direction::RIGHT_TO_LEFT )
  82   {
  83     result.x = 1.0f - result.x;
  84   }
  85
  86   return result;
  87 }
  88
  89 bool GetPolicyFromValue( const Property::Value& value, Vector2& policy )
  90 {
  91   bool success = false;
  92   if( value.Get( policy ) )
  93   {
  94     success = true;
  95   }
  96   else
  97   {
  98     Property::Array* array = value.GetArray();
  99     if( array && array->Size() == 2 )
 100     {
 101       Toolkit::Visual::Transform::Policy::Type xPolicy = static_cast< Toolkit::Visual::Transform::Policy::Type >( -1 ); // Assign an invalid value so definitely changes
 102       Toolkit::Visual::Transform::Policy::Type yPolicy = static_cast< Toolkit::Visual::Transform::Policy::Type >( -1 ); // Assign an invalid value so definitely changes
 103
 104       if( Scripting::GetEnumerationProperty< Toolkit::Visual::Transform::Policy::Type >( array->GetElementAt( 0 ), POLICY_TABLE, POLICY_TABLE_COUNT, xPolicy ) &&
 105           Scripting::GetEnumerationProperty< Toolkit::Visual::Transform::Policy::Type >( array->GetElementAt( 1 ), POLICY_TABLE, POLICY_TABLE_COUNT, yPolicy ) )
 106       {
 107         policy.x = xPolicy;
 108         policy.y = yPolicy;
 109         success = true;
 110       }
 111     }
 112   }
 113   return success;
 114 }
 115
 116 } // unnamed namespace
 117
 118 Internal::Visual::Base::Impl::Impl( FittingMode fittingMode, Toolkit::Visual::Type type )
 119 : mCustomShader( NULL ),
 120   mBlendSlotDelegate( NULL ),
 121   mEventObserver( NULL ),
 122   mTransform(),
 123   mMixColor( Color::WHITE ),
 124   mControlSize( Vector2::ZERO ),
 125   mCornerRadius( 0.0f ),
 126   mCornerRadiusPolicy( 1.0f ),
 127   mDepthIndex( 0.0f ),
 128   mMixColorIndex( Property::INVALID_INDEX ),
 129   mCornerRadiusIndex( Property::INVALID_INDEX ),
 130   mFittingMode( fittingMode ),
 131   mFlags( 0 ),
 132   mResourceStatus( Toolkit::Visual::ResourceStatus::PREPARING ),
 133   mType( type )
 134 {
 135 }
 136
 137 Internal::Visual::Base::Impl::~Impl()
 138 {
 139   delete mCustomShader;
 140   delete mBlendSlotDelegate;
 141 }
 142
 143 Internal::Visual::Base::Impl::CustomShader::CustomShader( const Property::Map& map )
 144 : mGridSize( 1, 1 ),
 145   mHints( Shader::Hint::NONE )
 146 {
 147   SetPropertyMap( map );
 148 }
 149
 150 void Internal::Visual::Base::Impl::CustomShader::SetPropertyMap( const Property::Map& shaderMap )
 151 {
 152   mVertexShader.clear();
 153   mFragmentShader.clear();
 154   mGridSize = ImageDimensions( 1, 1 );
 155   mHints = Shader::Hint::NONE;
 156
 157   Property::Value* vertexShaderValue = shaderMap.Find( Toolkit::Visual::Shader::Property::VERTEX_SHADER, CUSTOM_VERTEX_SHADER );
 158   if( vertexShaderValue )
 159   {
 160     if( ! GetStringFromProperty( *vertexShaderValue, mVertexShader ) )
 161     {
 162       DALI_LOG_ERROR( "'%s' parameter does not correctly specify a string\n", CUSTOM_VERTEX_SHADER );
 163     }
 164   }
 165
 166   Property::Value* fragmentShaderValue = shaderMap.Find( Toolkit::Visual::Shader::Property::FRAGMENT_SHADER, CUSTOM_FRAGMENT_SHADER );
 167   if( fragmentShaderValue )
 168   {
 169     if( ! GetStringFromProperty( *fragmentShaderValue, mFragmentShader ) )
 170     {
 171       DALI_LOG_ERROR( "'%s' parameter does not correctly specify a string\n", CUSTOM_FRAGMENT_SHADER );
 172     }
 173   }
 174
 175   Property::Value* subdivideXValue = shaderMap.Find( Toolkit::Visual::Shader::Property::SUBDIVIDE_GRID_X, CUSTOM_SUBDIVIDE_GRID_X );
 176   if( subdivideXValue )
 177   {
 178     int subdivideX;
 179     if( !subdivideXValue->Get( subdivideX ) || subdivideX < 1 )
 180     {
 181       DALI_LOG_ERROR( "'%s' parameter does not correctly specify a value greater than 1\n", CUSTOM_SUBDIVIDE_GRID_X );
 182     }
 183     else
 184     {
 185       mGridSize = ImageDimensions( subdivideX, mGridSize.GetY() );
 186     }
 187   }
 188
 189   Property::Value* subdivideYValue = shaderMap.Find( Toolkit::Visual::Shader::Property::SUBDIVIDE_GRID_Y, CUSTOM_SUBDIVIDE_GRID_Y );
 190   if( subdivideYValue )
 191   {
 192     int subdivideY;
 193     if( !subdivideYValue->Get( subdivideY ) || subdivideY < 1 )
 194     {
 195       DALI_LOG_ERROR( "'%s' parameter does not correctly specify a value greater than 1\n", CUSTOM_SUBDIVIDE_GRID_Y );
 196     }
 197     else
 198     {
 199       mGridSize = ImageDimensions( mGridSize.GetX(), subdivideY );
 200     }
 201   }
 202
 203   Property::Value* hintsValue = shaderMap.Find( Toolkit::Visual::Shader::Property::HINTS, CUSTOM_SHADER_HINTS );
 204   if( hintsValue )
 205   {
 206     if ( ! Scripting::GetBitmaskEnumerationProperty( *hintsValue, SHADER_HINT_TABLE, SHADER_HINT_TABLE_COUNT, mHints ) )
 207     {
 208       DALI_LOG_ERROR( "'%s' parameter does not correctly specify a hint or an array of hint strings\n", CUSTOM_SHADER_HINTS );
 209     }
 210   }
 211 }
 212
 213 void Internal::Visual::Base::Impl::CustomShader::CreatePropertyMap( Property::Map& map ) const
 214 {
 215   if( !mVertexShader.empty() || !mFragmentShader.empty() )
 216   {
 217     Property::Map customShader;
 218     if( !mVertexShader.empty() )
 219     {
 220       customShader.Insert( Toolkit::Visual::Shader::Property::VERTEX_SHADER, mVertexShader );
 221     }
 222     if( !mFragmentShader.empty() )
 223     {
 224       customShader.Insert( Toolkit::Visual::Shader::Property::FRAGMENT_SHADER, mFragmentShader );
 225     }
 226
 227     if( mGridSize.GetWidth() != 1 )
 228     {
 229       customShader.Insert( Toolkit::Visual::Shader::Property::SUBDIVIDE_GRID_X, mGridSize.GetWidth() );
 230     }
 231     if( mGridSize.GetHeight() != 1 )
 232     {
 233       customShader.Insert( Toolkit::Visual::Shader::Property::SUBDIVIDE_GRID_Y, mGridSize.GetHeight() );
 234     }
 235
 236     if( mHints != Dali::Shader::Hint::NONE )
 237     {
 238       customShader.Insert( Toolkit::Visual::Shader::Property::HINTS, static_cast< int >( mHints ) );
 239     }
 240
 241     map.Insert( Toolkit::Visual::Property::SHADER, customShader );
 242   }
 243 }
 244
 245 Internal::Visual::Base::Impl::Transform::Transform()
 246 : mOffset( 0.0f,0.0f ),
 247   mSize( 1.0f,1.0f ),
 248   mExtraSize( 0.0f,0.0f ),
 249   mOffsetSizeMode( 0.0f,0.0f,0.0f,0.0f ),
 250   mOrigin( Toolkit::Align::TOP_BEGIN ),
 251   mAnchorPoint( Toolkit::Align::TOP_BEGIN )
 252 {
 253 }
 254
 255 void Internal::Visual::Base::Impl::Transform::SetPropertyMap( const Property::Map& map )
 256 {
 257   // Set default values
 258   mOffset = Vector2( 0.0f,0.0f );
 259   mSize = Vector2( 1.0f,1.0f );
 260   mExtraSize = Vector2( 0.0f,0.0f );
 261   mOffsetSizeMode = Vector4( 0.0f,0.0f,0.0f,0.0f );
 262   mOrigin = Toolkit::Align::TOP_BEGIN;
 263   mAnchorPoint = Toolkit::Align::TOP_BEGIN;
 264
 265   UpdatePropertyMap( map );
 266 }
 267
 268 void Internal::Visual::Base::Impl::Transform::UpdatePropertyMap( const Property::Map& map )
 269 {
 270   for( Property::Map::SizeType i(0); i<map.Count(); ++i )
 271   {
 272     KeyValuePair keyValue = map.GetKeyValue( i );
 273     if( keyValue.first.type == Property::Key::INDEX )
 274     {
 275       switch( keyValue.first.indexKey )
 276       {
 277         case Toolkit::Visual::Transform::Property::OFFSET:
 278         {
 279           keyValue.second.Get( mOffset );
 280           break;
 281         }
 282         case Toolkit::Visual::Transform::Property::SIZE:
 283         {
 284           keyValue.second.Get( mSize );
 285           break;
 286         }
 287         case Toolkit::Visual::Transform::Property::ORIGIN:
 288         {
 289           Scripting::GetEnumerationProperty< Toolkit::Align::Type >( keyValue.second, ALIGN_TABLE, ALIGN_TABLE_COUNT, mOrigin );
 290           break;
 291         }
 292         case Toolkit::Visual::Transform::Property::ANCHOR_POINT:
 293         {
 294           Scripting::GetEnumerationProperty< Toolkit::Align::Type >( keyValue.second, ALIGN_TABLE, ALIGN_TABLE_COUNT, mAnchorPoint );
 295           break;
 296         }
 297         case Toolkit::Visual::Transform::Property::OFFSET_POLICY:
 298         {
 299           Vector2 policy;
 300           if( GetPolicyFromValue( keyValue.second, policy ) )
 301           {
 302             mOffsetSizeMode.x = policy.x;
 303             mOffsetSizeMode.y = policy.y;
 304           }
 305           break;
 306         }
 307         case Toolkit::Visual::Transform::Property::SIZE_POLICY:
 308         {
 309           Vector2 policy;
 310           if( GetPolicyFromValue( keyValue.second, policy ) )
 311           {
 312             mOffsetSizeMode.z = policy.x;
 313             mOffsetSizeMode.w = policy.y;
 314           }
 315           break;
 316         }
 317         case Toolkit::DevelVisual::Transform::Property::EXTRA_SIZE:
 318         {
 319           keyValue.second.Get( mExtraSize );
 320           break;
 321         }
 322       }
 323     }
 324     else  // Key type is STRING
 325     {
 326       if( keyValue.first == "offset" )
 327       {
 328         keyValue.second.Get( mOffset );
 329       }
 330       else if( keyValue.first == "size" )
 331       {
 332         keyValue.second.Get( mSize );
 333       }
 334       else if( keyValue.first == "origin" )
 335       {
 336         Scripting::GetEnumerationProperty< Toolkit::Align::Type >( keyValue.second, ALIGN_TABLE, ALIGN_TABLE_COUNT, mOrigin );
 337       }
 338       else if( keyValue.first == "anchorPoint" )
 339       {
 340         Scripting::GetEnumerationProperty< Toolkit::Align::Type >( keyValue.second, ALIGN_TABLE, ALIGN_TABLE_COUNT, mAnchorPoint );
 341       }
 342       else if( keyValue.first == "offsetPolicy" )
 343       {
 344         Vector2 policy;
 345         if( GetPolicyFromValue( keyValue.second, policy ) )
 346         {
 347           mOffsetSizeMode.x = policy.x;
 348           mOffsetSizeMode.y = policy.y;
 349         }
 350       }
 351       else if( keyValue.first == "sizePolicy" )
 352       {
 353         Vector2 policy;
 354         if( GetPolicyFromValue( keyValue.second, policy ) )
 355         {
 356           mOffsetSizeMode.z = policy.x;
 357           mOffsetSizeMode.w = policy.y;
 358         }
 359       }
 360       else if( keyValue.first == "extraSize" )
 361       {
 362         keyValue.second.Get( mExtraSize );
 363       }
 364     }
 365   }
 366 }
 367
 368 void Internal::Visual::Base::Impl::Transform::GetPropertyMap( Property::Map& map ) const
 369 {
 370   map.Clear();
 371   map.Add( Toolkit::Visual::Transform::Property::OFFSET, mOffset )
 372      .Add( Toolkit::Visual::Transform::Property::SIZE, mSize )
 373      .Add( Toolkit::Visual::Transform::Property::ORIGIN, mOrigin )
 374      .Add( Toolkit::Visual::Transform::Property::ANCHOR_POINT, mAnchorPoint )
 375      .Add( Toolkit::Visual::Transform::Property::OFFSET_POLICY, Vector2( mOffsetSizeMode.x, mOffsetSizeMode.y ) )
 376      .Add( Toolkit::Visual::Transform::Property::SIZE_POLICY, Vector2( mOffsetSizeMode.z, mOffsetSizeMode.w ) )
 377      .Add( Toolkit::DevelVisual::Transform::Property::EXTRA_SIZE, mExtraSize );
 378 }
 379
 380 void Internal::Visual::Base::Impl::Transform::RegisterUniforms( Dali::Renderer renderer, Toolkit::Direction::Type direction )
 381 {
 382   renderer.RegisterProperty( SIZE, mSize );
 383   renderer.RegisterProperty( OFFSET, direction == Toolkit::Direction::LEFT_TO_RIGHT ? mOffset : mOffset * Vector2(-1.0f,1.0f));
 384   renderer.RegisterProperty( OFFSET_SIZE_MODE, mOffsetSizeMode );
 385   renderer.RegisterProperty( ORIGIN, PointToVector2( mOrigin, direction ) - Vector2(0.5,0.5) );
 386   renderer.RegisterProperty( ANCHOR_POINT, Vector2(0.5,0.5) - PointToVector2( mAnchorPoint, direction ) );
 387   renderer.RegisterProperty( EXTRA_SIZE, mExtraSize );
 388 }
 389
 390 Vector2 Internal::Visual::Base::Impl::Transform::GetVisualSize( const Vector2& controlSize )
 391 {
 392   return Vector2( Lerp( mOffsetSizeMode.z, mSize.x * controlSize.x, mSize.x ) ,
 393                   Lerp( mOffsetSizeMode.w, mSize.y * controlSize.y, mSize.y ) ) + mExtraSize;
 394 }
 395
 396 } // namespace Internal
 397
 398 } // namespace Toolkit
 399
 400 } // namespace Dali