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

   1 /*
   2  * Copyright (c) 2016 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/visuals/visual-string-constants.h>
  30
  31 namespace Dali
  32 {
  33
  34 namespace Toolkit
  35 {
  36
  37 namespace Internal
  38 {
  39
  40 namespace
  41 {
  42
  43 DALI_ENUM_TO_STRING_TABLE_BEGIN( SHADER_HINT )
  44 DALI_ENUM_TO_STRING_WITH_SCOPE( Shader::Hint, NONE )
  45 DALI_ENUM_TO_STRING_WITH_SCOPE( Shader::Hint, OUTPUT_IS_TRANSPARENT )
  46 DALI_ENUM_TO_STRING_WITH_SCOPE( Shader::Hint, MODIFIES_GEOMETRY )
  47 DALI_ENUM_TO_STRING_TABLE_END( SHADER_HINT )
  48
  49 DALI_ENUM_TO_STRING_TABLE_BEGIN( ALIGN )
  50 DALI_ENUM_TO_STRING_WITH_SCOPE( Toolkit::Align, TOP_BEGIN )
  51 DALI_ENUM_TO_STRING_WITH_SCOPE( Toolkit::Align, TOP_CENTER )
  52 DALI_ENUM_TO_STRING_WITH_SCOPE( Toolkit::Align, TOP_END )
  53 DALI_ENUM_TO_STRING_WITH_SCOPE( Toolkit::Align, CENTER_BEGIN )
  54 DALI_ENUM_TO_STRING_WITH_SCOPE( Toolkit::Align, CENTER )
  55 DALI_ENUM_TO_STRING_WITH_SCOPE( Toolkit::Align, CENTER_END )
  56 DALI_ENUM_TO_STRING_WITH_SCOPE( Toolkit::Align, BOTTOM_BEGIN )
  57 DALI_ENUM_TO_STRING_WITH_SCOPE( Toolkit::Align, BOTTOM_CENTER )
  58 DALI_ENUM_TO_STRING_WITH_SCOPE( Toolkit::Align, BOTTOM_END )
  59 DALI_ENUM_TO_STRING_TABLE_END( ALIGN )
  60
  61 Dali::Vector2 PointToVector2( Toolkit::Align::Type point, Toolkit::Direction::Type direction )
  62 {
  63   static const float pointToVector2[] = { 0.0f,0.0f,
  64                                           0.5f,0.0f,
  65                                           1.0f,0.0f,
  66                                           0.0f,0.5f,
  67                                           0.5f,0.5f,
  68                                           1.0f,0.5f,
  69                                           0.0f,1.0f,
  70                                           0.5f,1.0f,
  71                                           1.0f,1.0f };
  72
  73   Vector2 result( &pointToVector2[point*2] );
  74   if( direction == Direction::RIGHT_TO_LEFT )
  75   {
  76     result.x = 1.0f - result.x;
  77   }
  78
  79   return result;
  80 }
  81
  82 } // unnamed namespace
  83
  84 Internal::Visual::Base::Impl::Impl()
  85 : mCustomShader( NULL ),
  86   mTransform(),
  87   mControlSize( Vector2::ZERO ),
  88   mDepthIndex( 0.0f ),
  89   mFlags( 0 )
  90 {
  91 }
  92
  93 Internal::Visual::Base::Impl::~Impl()
  94 {
  95   delete mCustomShader;
  96 }
  97
  98 Internal::Visual::Base::Impl::CustomShader::CustomShader( const Property::Map& map )
  99 : mGridSize( 1, 1 ),
 100   mHints( Shader::Hint::NONE )
 101 {
 102   SetPropertyMap( map );
 103 }
 104
 105 void Internal::Visual::Base::Impl::CustomShader::SetPropertyMap( const Property::Map& shaderMap )
 106 {
 107   mVertexShader.clear();
 108   mFragmentShader.clear();
 109   mGridSize = ImageDimensions( 1, 1 );
 110   mHints = Shader::Hint::NONE;
 111
 112   Property::Value* vertexShaderValue = shaderMap.Find( Toolkit::Visual::Shader::Property::VERTEX_SHADER, CUSTOM_VERTEX_SHADER );
 113   if( vertexShaderValue )
 114   {
 115     if( !vertexShaderValue->Get( mVertexShader ) )
 116     {
 117       DALI_LOG_ERROR( "'%s' parameter does not correctly specify a string\n", CUSTOM_VERTEX_SHADER );
 118     }
 119   }
 120
 121   Property::Value* fragmentShaderValue = shaderMap.Find( Toolkit::Visual::Shader::Property::FRAGMENT_SHADER, CUSTOM_FRAGMENT_SHADER );
 122   if( fragmentShaderValue )
 123   {
 124     if( !fragmentShaderValue->Get( mFragmentShader ) )
 125     {
 126       DALI_LOG_ERROR( "'%s' parameter does not correctly specify a string\n", CUSTOM_FRAGMENT_SHADER );
 127     }
 128   }
 129
 130   Property::Value* subdivideXValue = shaderMap.Find( Toolkit::Visual::Shader::Property::SUBDIVIDE_GRID_X, CUSTOM_SUBDIVIDE_GRID_X );
 131   if( subdivideXValue )
 132   {
 133     int subdivideX;
 134     if( !subdivideXValue->Get( subdivideX ) || subdivideX < 1 )
 135     {
 136       DALI_LOG_ERROR( "'%s' parameter does not correctly specify a value greater than 1\n", CUSTOM_SUBDIVIDE_GRID_X );
 137     }
 138     else
 139     {
 140       mGridSize = ImageDimensions( subdivideX, mGridSize.GetY() );
 141     }
 142   }
 143
 144   Property::Value* subdivideYValue = shaderMap.Find( Toolkit::Visual::Shader::Property::SUBDIVIDE_GRID_Y, CUSTOM_SUBDIVIDE_GRID_Y );
 145   if( subdivideYValue )
 146   {
 147     int subdivideY;
 148     if( !subdivideYValue->Get( subdivideY ) || subdivideY < 1 )
 149     {
 150       DALI_LOG_ERROR( "'%s' parameter does not correctly specify a value greater than 1\n", CUSTOM_SUBDIVIDE_GRID_Y );
 151     }
 152     else
 153     {
 154       mGridSize = ImageDimensions( mGridSize.GetX(), subdivideY );
 155     }
 156   }
 157
 158   Property::Value* hintsValue = shaderMap.Find( Toolkit::Visual::Shader::Property::HINTS, CUSTOM_SHADER_HINTS );
 159   if( hintsValue )
 160   {
 161     if ( ! Scripting::GetBitmaskEnumerationProperty( *hintsValue, SHADER_HINT_TABLE, SHADER_HINT_TABLE_COUNT, mHints ) )
 162     {
 163       DALI_LOG_ERROR( "'%s' parameter does not correctly specify a hint or an array of hint strings\n", CUSTOM_SHADER_HINTS );
 164     }
 165   }
 166 }
 167
 168 void Internal::Visual::Base::Impl::CustomShader::CreatePropertyMap( Property::Map& map ) const
 169 {
 170   if( !mVertexShader.empty() || !mFragmentShader.empty() )
 171   {
 172     Property::Map customShader;
 173     if( !mVertexShader.empty() )
 174     {
 175       customShader.Insert( Toolkit::Visual::Shader::Property::VERTEX_SHADER, mVertexShader );
 176     }
 177     if( !mFragmentShader.empty() )
 178     {
 179       customShader.Insert( Toolkit::Visual::Shader::Property::FRAGMENT_SHADER, mFragmentShader );
 180     }
 181
 182     if( mGridSize.GetWidth() != 1 )
 183     {
 184       customShader.Insert( Toolkit::Visual::Shader::Property::SUBDIVIDE_GRID_X, mGridSize.GetWidth() );
 185     }
 186     if( mGridSize.GetHeight() != 1 )
 187     {
 188       customShader.Insert( Toolkit::Visual::Shader::Property::SUBDIVIDE_GRID_Y, mGridSize.GetHeight() );
 189     }
 190
 191     if( mHints != Dali::Shader::Hint::NONE )
 192     {
 193       customShader.Insert( Toolkit::Visual::Shader::Property::HINTS, static_cast< int >( mHints ) );
 194     }
 195
 196     map.Insert( Toolkit::DevelVisual::Property::SHADER, customShader );
 197   }
 198 }
 199
 200 Internal::Visual::Base::Impl::Transform::Transform()
 201 : mOffset( 0.0f,0.0f ),
 202   mSize( 1.0f,1.0f ),
 203   mOffsetSizeMode( 0.0f,0.0f,0.0f,0.0f ),
 204   mOrigin( Toolkit::Align::CENTER ),
 205   mAnchorPoint( Toolkit::Align::CENTER )
 206 {
 207 }
 208
 209 void Internal::Visual::Base::Impl::Transform::SetPropertyMap( const Property::Map& map )
 210 {
 211   // Set default values
 212   mOffset = Vector2( 0.0f,0.0f );
 213   mSize = Vector2( 1.0f,1.0f );
 214   mOffsetSizeMode = Vector4( 0.0f,0.0f,0.0f,0.0f );
 215   mOrigin = Toolkit::Align::CENTER;
 216   mAnchorPoint = Toolkit::Align::CENTER;
 217
 218   for( Property::Map::SizeType i(0); i<map.Count(); ++i )
 219   {
 220     KeyValuePair keyValue = map.GetKeyValue( i );
 221     if( keyValue.first.type == Property::Key::INDEX )
 222     {
 223       switch( keyValue.first.indexKey )
 224       {
 225         case Toolkit::DevelVisual::Transform::Property::OFFSET:
 226         {
 227           keyValue.second.Get( mOffset );
 228           break;
 229         }
 230         case Toolkit::DevelVisual::Transform::Property::SIZE:
 231         {
 232           keyValue.second.Get( mSize );
 233           break;
 234         }
 235         case Toolkit::DevelVisual::Transform::Property::ORIGIN:
 236         {
 237           Scripting::GetEnumerationProperty< Toolkit::Align::Type >( keyValue.second, ALIGN_TABLE, ALIGN_TABLE_COUNT, mOrigin );
 238           break;
 239         }
 240         case Toolkit::DevelVisual::Transform::Property::ANCHOR_POINT:
 241         {
 242           Scripting::GetEnumerationProperty< Toolkit::Align::Type >( keyValue.second, ALIGN_TABLE, ALIGN_TABLE_COUNT, mAnchorPoint );
 243           break;
 244         }
 245         case Toolkit::DevelVisual::Transform::Property::OFFSET_SIZE_MODE:
 246         {
 247           keyValue.second.Get( mOffsetSizeMode );
 248           break;
 249         }
 250       }
 251     }
 252     else  // Key type is STRING
 253     {
 254       if( keyValue.first == "offset" )
 255       {
 256         keyValue.second.Get( mOffset );
 257       }
 258       else if( keyValue.first == "size" )
 259       {
 260         keyValue.second.Get( mSize );
 261       }
 262       else if( keyValue.first == "origin" )
 263       {
 264         Toolkit::Align::Type align(Toolkit::Align::CENTER);
 265         if( Scripting::GetEnumerationProperty< Toolkit::Align::Type >( keyValue.second, ALIGN_TABLE, ALIGN_TABLE_COUNT, align ) )
 266         {
 267           mOrigin = align;
 268         }
 269       }
 270       else if( keyValue.first == "anchorPoint" )
 271       {
 272         Toolkit::Align::Type align(Toolkit::Align::CENTER);
 273         if( Scripting::GetEnumerationProperty< Toolkit::Align::Type >( keyValue.second, ALIGN_TABLE, ALIGN_TABLE_COUNT, align ) )
 274         {
 275           mAnchorPoint = align;
 276         }
 277       }
 278       else if( keyValue.first == "offsetSizeMode" )
 279       {
 280         keyValue.second.Get( mOffsetSizeMode );
 281       }
 282     }
 283   }
 284 }
 285
 286 void Internal::Visual::Base::Impl::Transform::GetPropertyMap( Property::Map& map ) const
 287 {
 288   map.Clear();
 289   map.Add( Toolkit::DevelVisual::Transform::Property::OFFSET, mOffset )
 290      .Add( Toolkit::DevelVisual::Transform::Property::SIZE, mSize )
 291      .Add( Toolkit::DevelVisual::Transform::Property::ORIGIN, mOrigin )
 292      .Add( Toolkit::DevelVisual::Transform::Property::ANCHOR_POINT, mAnchorPoint )
 293      .Add( Toolkit::DevelVisual::Transform::Property::OFFSET_SIZE_MODE, mOffsetSizeMode );
 294 }
 295
 296 void Internal::Visual::Base::Impl::Transform::RegisterUniforms( Dali::Renderer renderer, Toolkit::Direction::Type direction )
 297 {
 298   renderer.RegisterProperty( SIZE, mSize );
 299   renderer.RegisterProperty( OFFSET, direction == Toolkit::Direction::LEFT_TO_RIGHT ? mOffset : mOffset * Vector2(-1.0f,1.0f));
 300   renderer.RegisterProperty( OFFSET_SIZE_MODE, mOffsetSizeMode );
 301   renderer.RegisterProperty( ORIGIN, PointToVector2( mOrigin, direction ) - Vector2(0.5,0.5) );
 302   renderer.RegisterProperty( ANCHOR_POINT, Vector2(0.5,0.5) - PointToVector2( mAnchorPoint, direction ) );
 303 }
 304
 305 Vector2 Internal::Visual::Base::Impl::Transform::GetVisualSize( const Vector2& controlSize )
 306 {
 307   return Vector2( Lerp( mOffsetSizeMode.x, mSize.x * controlSize.x, mSize.x ),
 308                   Lerp( mOffsetSizeMode.y, mSize.y * controlSize.y, mSize.y ) );
 309 }
 310
 311
 312 } // namespace Internal
 313
 314 } // namespace Toolkit
 315
 316 } // namespace Dali