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     const 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   mEventObserver( NULL ),
 121   mTransform(),
 122   mMixColor( Color::WHITE ),
 123   mControlSize( Vector2::ZERO ),
 124   mCornerRadius( 0.0f ),
 125   mCornerRadiusPolicy( 1.0f ),
 126   mDepthIndex( 0.0f ),
 127   mMixColorIndex( Property::INVALID_INDEX ),
 128   mCornerRadiusIndex( Property::INVALID_INDEX ),
 129   mFittingMode( fittingMode ),
 130   mFlags( 0 ),
 131   mResourceStatus( Toolkit::Visual::ResourceStatus::PREPARING ),
 132   mType( type )
 133 {
 134 }
 135
 136 Internal::Visual::Base::Impl::~Impl()
 137 {
 138   delete mCustomShader;
 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   mExtraSize( 0.0f,0.0f ),
 247   mOffsetSizeMode( 0.0f,0.0f,0.0f,0.0f ),
 248   mOrigin( Toolkit::Align::TOP_BEGIN ),
 249   mAnchorPoint( Toolkit::Align::TOP_BEGIN )
 250 {
 251 }
 252
 253 void Internal::Visual::Base::Impl::Transform::SetPropertyMap( const Property::Map& map )
 254 {
 255   // Set default values
 256   mOffset = Vector2( 0.0f,0.0f );
 257   mSize = Vector2( 1.0f,1.0f );
 258   mExtraSize = Vector2( 0.0f,0.0f );
 259   mOffsetSizeMode = Vector4( 0.0f,0.0f,0.0f,0.0f );
 260   mOrigin = Toolkit::Align::TOP_BEGIN;
 261   mAnchorPoint = Toolkit::Align::TOP_BEGIN;
 262
 263   UpdatePropertyMap( map );
 264 }
 265
 266 void Internal::Visual::Base::Impl::Transform::UpdatePropertyMap( const Property::Map& map )
 267 {
 268   for( Property::Map::SizeType i(0); i<map.Count(); ++i )
 269   {
 270     KeyValuePair keyValue = map.GetKeyValue( i );
 271     if( keyValue.first.type == Property::Key::INDEX )
 272     {
 273       switch( keyValue.first.indexKey )
 274       {
 275         case Toolkit::Visual::Transform::Property::OFFSET:
 276         {
 277           keyValue.second.Get( mOffset );
 278           break;
 279         }
 280         case Toolkit::Visual::Transform::Property::SIZE:
 281         {
 282           keyValue.second.Get( mSize );
 283           break;
 284         }
 285         case Toolkit::Visual::Transform::Property::ORIGIN:
 286         {
 287           Scripting::GetEnumerationProperty< Toolkit::Align::Type >( keyValue.second, ALIGN_TABLE, ALIGN_TABLE_COUNT, mOrigin );
 288           break;
 289         }
 290         case Toolkit::Visual::Transform::Property::ANCHOR_POINT:
 291         {
 292           Scripting::GetEnumerationProperty< Toolkit::Align::Type >( keyValue.second, ALIGN_TABLE, ALIGN_TABLE_COUNT, mAnchorPoint );
 293           break;
 294         }
 295         case Toolkit::Visual::Transform::Property::OFFSET_POLICY:
 296         {
 297           Vector2 policy;
 298           if( GetPolicyFromValue( keyValue.second, policy ) )
 299           {
 300             mOffsetSizeMode.x = policy.x;
 301             mOffsetSizeMode.y = policy.y;
 302           }
 303           break;
 304         }
 305         case Toolkit::Visual::Transform::Property::SIZE_POLICY:
 306         {
 307           Vector2 policy;
 308           if( GetPolicyFromValue( keyValue.second, policy ) )
 309           {
 310             mOffsetSizeMode.z = policy.x;
 311             mOffsetSizeMode.w = policy.y;
 312           }
 313           break;
 314         }
 315         case Toolkit::DevelVisual::Transform::Property::EXTRA_SIZE:
 316         {
 317           keyValue.second.Get( mExtraSize );
 318           break;
 319         }
 320       }
 321     }
 322     else  // Key type is STRING
 323     {
 324       if( keyValue.first == "offset" )
 325       {
 326         keyValue.second.Get( mOffset );
 327       }
 328       else if( keyValue.first == "size" )
 329       {
 330         keyValue.second.Get( mSize );
 331       }
 332       else if( keyValue.first == "origin" )
 333       {
 334         Scripting::GetEnumerationProperty< Toolkit::Align::Type >( keyValue.second, ALIGN_TABLE, ALIGN_TABLE_COUNT, mOrigin );
 335       }
 336       else if( keyValue.first == "anchorPoint" )
 337       {
 338         Scripting::GetEnumerationProperty< Toolkit::Align::Type >( keyValue.second, ALIGN_TABLE, ALIGN_TABLE_COUNT, mAnchorPoint );
 339       }
 340       else if( keyValue.first == "offsetPolicy" )
 341       {
 342         Vector2 policy;
 343         if( GetPolicyFromValue( keyValue.second, policy ) )
 344         {
 345           mOffsetSizeMode.x = policy.x;
 346           mOffsetSizeMode.y = policy.y;
 347         }
 348       }
 349       else if( keyValue.first == "sizePolicy" )
 350       {
 351         Vector2 policy;
 352         if( GetPolicyFromValue( keyValue.second, policy ) )
 353         {
 354           mOffsetSizeMode.z = policy.x;
 355           mOffsetSizeMode.w = policy.y;
 356         }
 357       }
 358       else if( keyValue.first == "extraSize" )
 359       {
 360         keyValue.second.Get( mExtraSize );
 361       }
 362     }
 363   }
 364 }
 365
 366 void Internal::Visual::Base::Impl::Transform::GetPropertyMap( Property::Map& map ) const
 367 {
 368   map.Clear();
 369   map.Add( Toolkit::Visual::Transform::Property::OFFSET, mOffset )
 370      .Add( Toolkit::Visual::Transform::Property::SIZE, mSize )
 371      .Add( Toolkit::Visual::Transform::Property::ORIGIN, mOrigin )
 372      .Add( Toolkit::Visual::Transform::Property::ANCHOR_POINT, mAnchorPoint )
 373      .Add( Toolkit::Visual::Transform::Property::OFFSET_POLICY, Vector2( mOffsetSizeMode.x, mOffsetSizeMode.y ) )
 374      .Add( Toolkit::Visual::Transform::Property::SIZE_POLICY, Vector2( mOffsetSizeMode.z, mOffsetSizeMode.w ) )
 375      .Add( Toolkit::DevelVisual::Transform::Property::EXTRA_SIZE, mExtraSize );
 376 }
 377
 378 void Internal::Visual::Base::Impl::Transform::RegisterUniforms( Dali::Renderer renderer, Toolkit::Direction::Type direction )
 379 {
 380   renderer.RegisterProperty( SIZE, mSize );
 381   renderer.RegisterProperty( OFFSET, direction == Toolkit::Direction::LEFT_TO_RIGHT ? mOffset : mOffset * Vector2(-1.0f,1.0f));
 382   renderer.RegisterProperty( OFFSET_SIZE_MODE, mOffsetSizeMode );
 383   renderer.RegisterProperty( ORIGIN, PointToVector2( mOrigin, direction ) - Vector2(0.5,0.5) );
 384   renderer.RegisterProperty( ANCHOR_POINT, Vector2(0.5,0.5) - PointToVector2( mAnchorPoint, direction ) );
 385   renderer.RegisterProperty( EXTRA_SIZE, mExtraSize );
 386 }
 387
 388 Vector2 Internal::Visual::Base::Impl::Transform::GetVisualSize( const Vector2& controlSize )
 389 {
 390   return Vector2( Lerp( mOffsetSizeMode.z, mSize.x * controlSize.x, mSize.x ) ,
 391                   Lerp( mOffsetSizeMode.w, mSize.y * controlSize.y, mSize.y ) ) + mExtraSize;
 392 }
 393
 394 } // namespace Internal
 395
 396 } // namespace Toolkit
 397
 398 } // namespace Dali