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/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   mEventObserver( NULL ),
 121   mTransform(),
 122   mMixColor( Color::WHITE ),
 123   mControlSize( Vector2::ZERO ),
 124   mCornerRadius( 0.0f ),
 125   mDepthIndex( 0.0f ),
 126   mMixColorIndex( Property::INVALID_INDEX ),
 127   mCornerRadiusIndex( Property::INVALID_INDEX ),
 128   mFittingMode( fittingMode ),
 129   mFlags( 0 ),
 130   mResourceStatus( Toolkit::Visual::ResourceStatus::PREPARING )
 131 {
 132 }
 133
 134 Internal::Visual::Base::Impl::~Impl()
 135 {
 136   delete mCustomShader;
 137   delete mBlendSlotDelegate;
 138 }
 139
 140 Internal::Visual::Base::Impl::CustomShader::CustomShader( const Property::Map& map )
 141 : mGridSize( 1, 1 ),
 142   mHints( Shader::Hint::NONE )
 143 {
 144   SetPropertyMap( map );
 145 }
 146
 147 void Internal::Visual::Base::Impl::CustomShader::SetPropertyMap( const Property::Map& shaderMap )
 148 {
 149   mVertexShader.clear();
 150   mFragmentShader.clear();
 151   mGridSize = ImageDimensions( 1, 1 );
 152   mHints = Shader::Hint::NONE;
 153
 154   Property::Value* vertexShaderValue = shaderMap.Find( Toolkit::Visual::Shader::Property::VERTEX_SHADER, CUSTOM_VERTEX_SHADER );
 155   if( vertexShaderValue )
 156   {
 157     if( ! GetStringFromProperty( *vertexShaderValue, mVertexShader ) )
 158     {
 159       DALI_LOG_ERROR( "'%s' parameter does not correctly specify a string\n", CUSTOM_VERTEX_SHADER );
 160     }
 161   }
 162
 163   Property::Value* fragmentShaderValue = shaderMap.Find( Toolkit::Visual::Shader::Property::FRAGMENT_SHADER, CUSTOM_FRAGMENT_SHADER );
 164   if( fragmentShaderValue )
 165   {
 166     if( ! GetStringFromProperty( *fragmentShaderValue, mFragmentShader ) )
 167     {
 168       DALI_LOG_ERROR( "'%s' parameter does not correctly specify a string\n", CUSTOM_FRAGMENT_SHADER );
 169     }
 170   }
 171
 172   Property::Value* subdivideXValue = shaderMap.Find( Toolkit::Visual::Shader::Property::SUBDIVIDE_GRID_X, CUSTOM_SUBDIVIDE_GRID_X );
 173   if( subdivideXValue )
 174   {
 175     int subdivideX;
 176     if( !subdivideXValue->Get( subdivideX ) || subdivideX < 1 )
 177     {
 178       DALI_LOG_ERROR( "'%s' parameter does not correctly specify a value greater than 1\n", CUSTOM_SUBDIVIDE_GRID_X );
 179     }
 180     else
 181     {
 182       mGridSize = ImageDimensions( subdivideX, mGridSize.GetY() );
 183     }
 184   }
 185
 186   Property::Value* subdivideYValue = shaderMap.Find( Toolkit::Visual::Shader::Property::SUBDIVIDE_GRID_Y, CUSTOM_SUBDIVIDE_GRID_Y );
 187   if( subdivideYValue )
 188   {
 189     int subdivideY;
 190     if( !subdivideYValue->Get( subdivideY ) || subdivideY < 1 )
 191     {
 192       DALI_LOG_ERROR( "'%s' parameter does not correctly specify a value greater than 1\n", CUSTOM_SUBDIVIDE_GRID_Y );
 193     }
 194     else
 195     {
 196       mGridSize = ImageDimensions( mGridSize.GetX(), subdivideY );
 197     }
 198   }
 199
 200   Property::Value* hintsValue = shaderMap.Find( Toolkit::Visual::Shader::Property::HINTS, CUSTOM_SHADER_HINTS );
 201   if( hintsValue )
 202   {
 203     if ( ! Scripting::GetBitmaskEnumerationProperty( *hintsValue, SHADER_HINT_TABLE, SHADER_HINT_TABLE_COUNT, mHints ) )
 204     {
 205       DALI_LOG_ERROR( "'%s' parameter does not correctly specify a hint or an array of hint strings\n", CUSTOM_SHADER_HINTS );
 206     }
 207   }
 208 }
 209
 210 void Internal::Visual::Base::Impl::CustomShader::CreatePropertyMap( Property::Map& map ) const
 211 {
 212   if( !mVertexShader.empty() || !mFragmentShader.empty() )
 213   {
 214     Property::Map customShader;
 215     if( !mVertexShader.empty() )
 216     {
 217       customShader.Insert( Toolkit::Visual::Shader::Property::VERTEX_SHADER, mVertexShader );
 218     }
 219     if( !mFragmentShader.empty() )
 220     {
 221       customShader.Insert( Toolkit::Visual::Shader::Property::FRAGMENT_SHADER, mFragmentShader );
 222     }
 223
 224     if( mGridSize.GetWidth() != 1 )
 225     {
 226       customShader.Insert( Toolkit::Visual::Shader::Property::SUBDIVIDE_GRID_X, mGridSize.GetWidth() );
 227     }
 228     if( mGridSize.GetHeight() != 1 )
 229     {
 230       customShader.Insert( Toolkit::Visual::Shader::Property::SUBDIVIDE_GRID_Y, mGridSize.GetHeight() );
 231     }
 232
 233     if( mHints != Dali::Shader::Hint::NONE )
 234     {
 235       customShader.Insert( Toolkit::Visual::Shader::Property::HINTS, static_cast< int >( mHints ) );
 236     }
 237
 238     map.Insert( Toolkit::Visual::Property::SHADER, customShader );
 239   }
 240 }
 241
 242 Internal::Visual::Base::Impl::Transform::Transform()
 243 : mOffset( 0.0f,0.0f ),
 244   mSize( 1.0f,1.0f ),
 245   mOffsetSizeMode( 0.0f,0.0f,0.0f,0.0f ),
 246   mOrigin( Toolkit::Align::TOP_BEGIN ),
 247   mAnchorPoint( Toolkit::Align::TOP_BEGIN )
 248 {
 249 }
 250
 251 void Internal::Visual::Base::Impl::Transform::SetPropertyMap( const Property::Map& map )
 252 {
 253   // Set default values
 254   mOffset = Vector2( 0.0f,0.0f );
 255   mSize = Vector2( 1.0f,1.0f );
 256   mOffsetSizeMode = Vector4( 0.0f,0.0f,0.0f,0.0f );
 257   mOrigin = Toolkit::Align::TOP_BEGIN;
 258   mAnchorPoint = Toolkit::Align::TOP_BEGIN;
 259
 260   UpdatePropertyMap( map );
 261 }
 262
 263 void Internal::Visual::Base::Impl::Transform::UpdatePropertyMap( const Property::Map& map )
 264 {
 265   for( Property::Map::SizeType i(0); i<map.Count(); ++i )
 266   {
 267     KeyValuePair keyValue = map.GetKeyValue( i );
 268     if( keyValue.first.type == Property::Key::INDEX )
 269     {
 270       switch( keyValue.first.indexKey )
 271       {
 272         case Toolkit::Visual::Transform::Property::OFFSET:
 273         {
 274           keyValue.second.Get( mOffset );
 275           break;
 276         }
 277         case Toolkit::Visual::Transform::Property::SIZE:
 278         {
 279           keyValue.second.Get( mSize );
 280           break;
 281         }
 282         case Toolkit::Visual::Transform::Property::ORIGIN:
 283         {
 284           Scripting::GetEnumerationProperty< Toolkit::Align::Type >( keyValue.second, ALIGN_TABLE, ALIGN_TABLE_COUNT, mOrigin );
 285           break;
 286         }
 287         case Toolkit::Visual::Transform::Property::ANCHOR_POINT:
 288         {
 289           Scripting::GetEnumerationProperty< Toolkit::Align::Type >( keyValue.second, ALIGN_TABLE, ALIGN_TABLE_COUNT, mAnchorPoint );
 290           break;
 291         }
 292         case Toolkit::Visual::Transform::Property::OFFSET_POLICY:
 293         {
 294           Vector2 policy;
 295           if( GetPolicyFromValue( keyValue.second, policy ) )
 296           {
 297             mOffsetSizeMode.x = policy.x;
 298             mOffsetSizeMode.y = policy.y;
 299           }
 300           break;
 301         }
 302         case Toolkit::Visual::Transform::Property::SIZE_POLICY:
 303         {
 304           Vector2 policy;
 305           if( GetPolicyFromValue( keyValue.second, policy ) )
 306           {
 307             mOffsetSizeMode.z = policy.x;
 308             mOffsetSizeMode.w = policy.y;
 309           }
 310           break;
 311         }
 312       }
 313     }
 314     else  // Key type is STRING
 315     {
 316       if( keyValue.first == "offset" )
 317       {
 318         keyValue.second.Get( mOffset );
 319       }
 320       else if( keyValue.first == "size" )
 321       {
 322         keyValue.second.Get( mSize );
 323       }
 324       else if( keyValue.first == "origin" )
 325       {
 326         Scripting::GetEnumerationProperty< Toolkit::Align::Type >( keyValue.second, ALIGN_TABLE, ALIGN_TABLE_COUNT, mOrigin );
 327       }
 328       else if( keyValue.first == "anchorPoint" )
 329       {
 330         Scripting::GetEnumerationProperty< Toolkit::Align::Type >( keyValue.second, ALIGN_TABLE, ALIGN_TABLE_COUNT, mAnchorPoint );
 331       }
 332       else if( keyValue.first == "offsetPolicy" )
 333       {
 334         Vector2 policy;
 335         if( GetPolicyFromValue( keyValue.second, policy ) )
 336         {
 337           mOffsetSizeMode.x = policy.x;
 338           mOffsetSizeMode.y = policy.y;
 339         }
 340       }
 341       else if( keyValue.first == "sizePolicy" )
 342       {
 343         Vector2 policy;
 344         if( GetPolicyFromValue( keyValue.second, policy ) )
 345         {
 346           mOffsetSizeMode.z = policy.x;
 347           mOffsetSizeMode.w = policy.y;
 348         }
 349       }
 350     }
 351   }
 352 }
 353
 354 void Internal::Visual::Base::Impl::Transform::GetPropertyMap( Property::Map& map ) const
 355 {
 356   map.Clear();
 357   map.Add( Toolkit::Visual::Transform::Property::OFFSET, mOffset )
 358      .Add( Toolkit::Visual::Transform::Property::SIZE, mSize )
 359      .Add( Toolkit::Visual::Transform::Property::ORIGIN, mOrigin )
 360      .Add( Toolkit::Visual::Transform::Property::ANCHOR_POINT, mAnchorPoint )
 361      .Add( Toolkit::Visual::Transform::Property::OFFSET_POLICY, Vector2( mOffsetSizeMode.x, mOffsetSizeMode.y ) )
 362      .Add( Toolkit::Visual::Transform::Property::SIZE_POLICY, Vector2( mOffsetSizeMode.z, mOffsetSizeMode.w ) );
 363 }
 364
 365 void Internal::Visual::Base::Impl::Transform::RegisterUniforms( Dali::Renderer renderer, Toolkit::Direction::Type direction )
 366 {
 367   renderer.RegisterProperty( SIZE, mSize );
 368   renderer.RegisterProperty( OFFSET, direction == Toolkit::Direction::LEFT_TO_RIGHT ? mOffset : mOffset * Vector2(-1.0f,1.0f));
 369   renderer.RegisterProperty( OFFSET_SIZE_MODE, mOffsetSizeMode );
 370   renderer.RegisterProperty( ORIGIN, PointToVector2( mOrigin, direction ) - Vector2(0.5,0.5) );
 371   renderer.RegisterProperty( ANCHOR_POINT, Vector2(0.5,0.5) - PointToVector2( mAnchorPoint, direction ) );
 372 }
 373
 374 Vector2 Internal::Visual::Base::Impl::Transform::GetVisualSize( const Vector2& controlSize )
 375 {
 376   return Vector2( Lerp( mOffsetSizeMode.x, mSize.x * controlSize.x, mSize.x ),
 377                   Lerp( mOffsetSizeMode.y, mSize.y * controlSize.y, mSize.y ) );
 378 }
 379
 380
 381 } // namespace Internal
 382
 383 } // namespace Toolkit
 384
 385 } // namespace Dali