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