dali-toolkit/internal/visuals/visual-base-data-impl.cpp

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