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