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