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