dali-toolkit/internal/visuals/gradient/gradient-visual.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 "gradient-visual.h"
  20
  21 // EXTERNAL INCLUDES
  22 #include <typeinfo>
  23 #include <dali/integration-api/debug.h>
  24 #include <dali/public-api/common/dali-vector.h>
  25 #include <dali/public-api/images/buffer-image.h>
  26 #include <dali/public-api/object/property-array.h>
  27 #include <dali/devel-api/scripting/enum-helper.h>
  28 #include <dali/devel-api/scripting/scripting.h>
  29
  30 // INTERNAL INCLUDES
  31 #include <dali-toolkit/public-api/visuals/gradient-visual-properties.h>
  32 #include <dali-toolkit/public-api/visuals/visual-properties.h>
  33 #include <dali-toolkit/internal/visuals/visual-factory-impl.h>
  34 #include <dali-toolkit/internal/visuals/visual-factory-cache.h>
  35 #include <dali-toolkit/internal/visuals/visual-string-constants.h>
  36 #include <dali-toolkit/internal/visuals/gradient/linear-gradient.h>
  37 #include <dali-toolkit/internal/visuals/gradient/radial-gradient.h>
  38 #include <dali-toolkit/internal/visuals/visual-base-data-impl.h>
  39
  40 namespace Dali
  41 {
  42
  43 namespace Toolkit
  44 {
  45
  46 namespace Internal
  47 {
  48
  49 namespace
  50 {
  51 // properties: linear gradient
  52 const char * const START_POSITION_NAME("startPosition"); // Property::VECTOR2
  53 const char * const END_POSITION_NAME("endPosition"); // Property::VECTOR2
  54
  55 // properties: radial gradient
  56 const char * const CENTER_NAME("center"); // Property::VECTOR2
  57 const char * const RADIUS_NAME("radius"); // Property::FLOAT
  58
  59 // properties: linear&radial gradient
  60 const char * const STOP_OFFSET_NAME("stopOffset"); // Property::Array FLOAT
  61 const char * const STOP_COLOR_NAME("stopColor"); // Property::Array VECTOR4
  62 const char * const UNITS_NAME("units"); // Property::String  "userSpaceOnUse | objectBoundingBox"
  63 const char * const SPREAD_METHOD_NAME("spreadMethod"); // Property::String  "pad | reflect | repeat"
  64
  65 DALI_ENUM_TO_STRING_TABLE_BEGIN( UNITS )
  66 DALI_ENUM_TO_STRING_WITH_SCOPE( Toolkit::GradientVisual::Units, OBJECT_BOUNDING_BOX )
  67 DALI_ENUM_TO_STRING_WITH_SCOPE( Toolkit::GradientVisual::Units, USER_SPACE )
  68 DALI_ENUM_TO_STRING_TABLE_END( UNITS )
  69
  70 DALI_ENUM_TO_STRING_TABLE_BEGIN( SPREAD_METHOD )
  71 DALI_ENUM_TO_STRING_WITH_SCOPE( Toolkit::GradientVisual::SpreadMethod, PAD )
  72 DALI_ENUM_TO_STRING_WITH_SCOPE( Toolkit::GradientVisual::SpreadMethod, REFLECT )
  73 DALI_ENUM_TO_STRING_WITH_SCOPE( Toolkit::GradientVisual::SpreadMethod, REPEAT )
  74 DALI_ENUM_TO_STRING_TABLE_END( SPREAD_METHOD )
  75
  76 // uniform names
  77 const char * const UNIFORM_ALIGNMENT_MATRIX_NAME( "uAlignmentMatrix" );
  78
  79 // default offset value
  80 const unsigned int DEFAULT_OFFSET_MINIMUM = 0.0f;
  81 const unsigned int DEFAULT_OFFSET_MAXIMUM = 1.0f;
  82
  83 VisualFactoryCache::ShaderType GetShaderType( GradientVisual::Type type, Toolkit::GradientVisual::Units::Type units )
  84 {
  85   if( type == GradientVisual::LINEAR )
  86   {
  87    if( units == Toolkit::GradientVisual::Units::USER_SPACE )
  88    {
  89      return VisualFactoryCache::GRADIENT_SHADER_LINEAR_USER_SPACE;
  90    }
  91    return VisualFactoryCache::GRADIENT_SHADER_LINEAR_BOUNDING_BOX;
  92   }
  93   else if( units == Toolkit::GradientVisual::Units::USER_SPACE )
  94   {
  95     return VisualFactoryCache::GRADIENT_SHADER_RADIAL_USER_SPACE;
  96   }
  97
  98   return VisualFactoryCache::GRADIENT_SHADER_RADIAL_BOUNDING_BOX;
  99 }
 100
 101 const char* VERTEX_SHADER[] =
 102 {
 103 // vertex shader for gradient units as OBJECT_BOUNDING_BOX
 104  DALI_COMPOSE_SHADER(
 105   attribute mediump vec2 aPosition;\n
 106   uniform highp   mat4 uMvpMatrix;\n
 107   uniform mediump vec3 uSize;\n
 108   uniform mediump mat3 uAlignmentMatrix;\n
 109   varying mediump vec2 vTexCoord;\n
 110   \n
 111
 112   //Visual size and offset
 113   uniform mediump vec2 offset;\n
 114   uniform mediump vec2 size;\n
 115   uniform mediump vec4 offsetSizeMode;\n
 116   uniform mediump vec2 origin;\n
 117   uniform mediump vec2 anchorPoint;\n
 118
 119   vec4 ComputeVertexPosition()\n
 120   {\n
 121     vec2 visualSize = mix(uSize.xy*size, size, offsetSizeMode.zw );\n
 122     vec2 visualOffset = mix( offset, offset/uSize.xy, offsetSizeMode.xy);\n
 123     return vec4( (aPosition + anchorPoint)*visualSize + (visualOffset + origin)*uSize.xy, 0.0, 1.0 );\n
 124   }\n
 125
 126   void main()\n
 127   {\n
 128     mediump vec4 vertexPosition = vec4(aPosition, 0.0, 1.0);\n
 129     vTexCoord = (uAlignmentMatrix*vertexPosition.xyw).xy;\n
 130     \n
 131     gl_Position = uMvpMatrix * ComputeVertexPosition();\n
 132   }\n
 133 ),
 134
 135 // vertex shader for gradient units as USER_SPACE
 136 DALI_COMPOSE_SHADER(
 137   attribute mediump vec2 aPosition;\n
 138   uniform highp   mat4 uMvpMatrix;\n
 139   uniform mediump vec3 uSize;\n
 140   uniform mediump mat3 uAlignmentMatrix;\n
 141   varying mediump vec2 vTexCoord;\n
 142   \n
 143
 144   //Visual size and offset
 145   uniform mediump vec2 offset;\n
 146   uniform mediump vec2 size;\n
 147   uniform mediump vec4 offsetSizeMode;\n
 148   uniform mediump vec2 origin;\n
 149   uniform mediump vec2 anchorPoint;\n
 150
 151   vec4 ComputeVertexPosition()\n
 152   {\n
 153     vec2 visualSize = mix(uSize.xy*size, size, offsetSizeMode.zw );\n
 154     vec2 visualOffset = mix( offset, offset/uSize.xy, offsetSizeMode.xy);\n
 155     return vec4( (aPosition + anchorPoint)*visualSize + (visualOffset + origin)*uSize.xy, 0.0, 1.0 );\n
 156   }\n
 157
 158   void main()\n
 159   {\n
 160     mediump vec4 vertexPosition = vec4(aPosition, 0.0, 1.0);\n
 161     vertexPosition.xyz *= uSize;\n
 162     gl_Position = uMvpMatrix * ComputeVertexPosition();\n
 163     \n
 164     vTexCoord = (uAlignmentMatrix*vertexPosition.xyw).xy;\n
 165   }\n
 166 )
 167 };
 168
 169 const char* FRAGMENT_SHADER[] =
 170 {
 171 // fragment shader for linear gradient
 172 DALI_COMPOSE_SHADER(
 173   uniform sampler2D sTexture;\n // sampler1D?
 174   uniform lowp vec4 uColor;\n
 175   uniform lowp vec3 mixColor;\n
 176   varying mediump vec2 vTexCoord;\n
 177   \n
 178   void main()\n
 179   {\n
 180     gl_FragColor = texture2D( sTexture, vec2( vTexCoord.y, 0.5 ) ) * vec4(mixColor, 1.0) * uColor;\n
 181   }\n
 182 ),
 183
 184 // fragment shader for radial gradient
 185 DALI_COMPOSE_SHADER(
 186   uniform sampler2D sTexture;\n // sampler1D?
 187   uniform lowp vec4 uColor;\n
 188   uniform lowp vec3 mixColor;\n
 189   varying mediump vec2 vTexCoord;\n
 190   \n
 191   void main()\n
 192   {\n
 193     gl_FragColor = texture2D( sTexture, vec2( length(vTexCoord), 0.5 ) ) * vec4(mixColor, 1.0) * uColor;\n
 194   }\n
 195 )
 196 };
 197
 198 Dali::WrapMode::Type GetWrapMode( Toolkit::GradientVisual::SpreadMethod::Type spread )
 199 {
 200   switch(spread)
 201   {
 202     case Toolkit::GradientVisual::SpreadMethod::REPEAT:
 203     {
 204       return Dali::WrapMode::REPEAT;
 205     }
 206     case Toolkit::GradientVisual::SpreadMethod::REFLECT:
 207     {
 208       return Dali::WrapMode::MIRRORED_REPEAT;
 209     }
 210     case Toolkit::GradientVisual::SpreadMethod::PAD:
 211     default:
 212     {
 213       return Dali::WrapMode::CLAMP_TO_EDGE;
 214     }
 215   }
 216 }
 217
 218 } // unnamed namespace
 219
 220 GradientVisualPtr GradientVisual::New( VisualFactoryCache& factoryCache, const Property::Map& properties )
 221 {
 222   GradientVisualPtr gradientVisualPtr( new GradientVisual( factoryCache ) );
 223   gradientVisualPtr->SetProperties( properties );
 224   return gradientVisualPtr;
 225 }
 226
 227 GradientVisual::GradientVisual( VisualFactoryCache& factoryCache )
 228 : Visual::Base( factoryCache, Visual::FittingMode::FILL ),
 229   mGradientType( LINEAR ),
 230   mIsOpaque( true )
 231 {
 232   mImpl->mFlags |= Impl::IS_PREMULTIPLIED_ALPHA;
 233 }
 234
 235 GradientVisual::~GradientVisual()
 236 {
 237 }
 238
 239 void GradientVisual::DoSetProperties( const Property::Map& propertyMap )
 240 {
 241   Toolkit::GradientVisual::Units::Type gradientUnits = Toolkit::GradientVisual::Units::OBJECT_BOUNDING_BOX;
 242
 243   Property::Value* unitsValue = propertyMap.Find( Toolkit::GradientVisual::Property::UNITS, UNITS_NAME );
 244   if( unitsValue )
 245   {
 246     Scripting::GetEnumerationProperty( *unitsValue, UNITS_TABLE, UNITS_TABLE_COUNT, gradientUnits );
 247   }
 248
 249   mGradientType = LINEAR;
 250   if( propertyMap.Find( Toolkit::GradientVisual::Property::RADIUS, RADIUS_NAME ) )
 251   {
 252     mGradientType = RADIAL;
 253   }
 254
 255   if( NewGradient( mGradientType, propertyMap ) )
 256   {
 257     mGradient->SetGradientUnits( gradientUnits );
 258     mGradientTransform = mGradient->GetAlignmentTransform();
 259   }
 260   else
 261   {
 262     DALI_LOG_ERROR( "Fail to provide valid properties to create a GradientVisual object\n" );
 263   }
 264 }
 265
 266 void GradientVisual::OnSetTransform()
 267 {
 268   if( mImpl->mRenderer )
 269   {
 270     mImpl->mTransform.RegisterUniforms( mImpl->mRenderer, Direction::LEFT_TO_RIGHT );
 271   }
 272 }
 273
 274 void GradientVisual::DoSetOnStage( Actor& actor )
 275 {
 276   InitializeRenderer();
 277
 278   actor.AddRenderer( mImpl->mRenderer );
 279
 280   // Gradient Visual generated and ready to display
 281   ResourceReady( Toolkit::Visual::ResourceStatus::READY );
 282 }
 283
 284 void GradientVisual::DoCreatePropertyMap( Property::Map& map ) const
 285 {
 286   map.Clear();
 287   map.Insert( Toolkit::Visual::Property::TYPE, Toolkit::Visual::GRADIENT );
 288   map.Insert( Toolkit::GradientVisual::Property::UNITS, mGradient->GetGradientUnits() );
 289   map.Insert( Toolkit::GradientVisual::Property::SPREAD_METHOD, mGradient->GetSpreadMethod() );
 290
 291   const Vector<Gradient::GradientStop>& stops( mGradient->GetStops() );
 292   Property::Array offsets;
 293   Property::Array colors;
 294   for( unsigned int i=0; i<stops.Count(); i++ )
 295   {
 296     offsets.PushBack( stops[i].mOffset );
 297     if( EqualsZero(stops[i].mStopColor.a) )
 298     {
 299       colors.PushBack( Vector4::ZERO );
 300     }
 301     else
 302     {
 303       colors.PushBack( Vector4( stops[i].mStopColor.r / stops[i].mStopColor.a,
 304                                 stops[i].mStopColor.g / stops[i].mStopColor.a,
 305                                 stops[i].mStopColor.b / stops[i].mStopColor.a,
 306                                 stops[i].mStopColor.a));
 307     }
 308   }
 309
 310   map.Insert( Toolkit::GradientVisual::Property::STOP_OFFSET, offsets );
 311   map.Insert( Toolkit::GradientVisual::Property::STOP_COLOR, colors );
 312
 313   if( &typeid( *mGradient ) == &typeid(LinearGradient) )
 314   {
 315     LinearGradient* gradient = static_cast<LinearGradient*>( mGradient.Get() );
 316     map.Insert( Toolkit::GradientVisual::Property::START_POSITION, gradient->GetStartPosition() );
 317     map.Insert( Toolkit::GradientVisual::Property::END_POSITION, gradient->GetEndPosition() );
 318   }
 319   else // if( &typeid( *mGradient ) == &typeid(RadialGradient) )
 320   {
 321     RadialGradient* gradient = static_cast<RadialGradient*>( mGradient.Get() );
 322     map.Insert( Toolkit::GradientVisual::Property::CENTER, gradient->GetCenter() );
 323     map.Insert( Toolkit::GradientVisual::Property::RADIUS, gradient->GetRadius() );
 324   }
 325 }
 326
 327 void GradientVisual::DoCreateInstancePropertyMap( Property::Map& map ) const
 328 {
 329   // Do nothing
 330 }
 331
 332 void GradientVisual::InitializeRenderer()
 333 {
 334   Geometry geometry = mFactoryCache.GetGeometry( VisualFactoryCache::QUAD_GEOMETRY );
 335
 336   Toolkit::GradientVisual::Units::Type gradientUnits = mGradient->GetGradientUnits();
 337   VisualFactoryCache::ShaderType shaderType = GetShaderType( mGradientType, gradientUnits );
 338   Shader shader = mFactoryCache.GetShader( shaderType );
 339   if( !shader )
 340   {
 341     shader = Shader::New( VERTEX_SHADER[gradientUnits], FRAGMENT_SHADER[ mGradientType ] );
 342     mFactoryCache.SaveShader( shaderType, shader );
 343   }
 344
 345   //Set up the texture set
 346   TextureSet textureSet = TextureSet::New();
 347   Dali::Texture lookupTexture = mGradient->GenerateLookupTexture();
 348   textureSet.SetTexture( 0u, lookupTexture );
 349   Dali::WrapMode::Type wrap = GetWrapMode( mGradient->GetSpreadMethod() );
 350   Sampler sampler = Sampler::New();
 351   sampler.SetWrapMode(  wrap, wrap  );
 352   textureSet.SetSampler( 0u, sampler );
 353
 354   mImpl->mRenderer = Renderer::New( geometry, shader );
 355   mImpl->mRenderer.SetTextures( textureSet );
 356
 357   // If opaque then no need to have blending
 358   if( mIsOpaque )
 359   {
 360     mImpl->mRenderer.SetProperty( Renderer::Property::BLEND_MODE, BlendMode::OFF );
 361   }
 362
 363   mImpl->mRenderer.RegisterProperty( UNIFORM_ALIGNMENT_MATRIX_NAME, mGradientTransform );
 364
 365   //Register transform properties
 366   mImpl->mTransform.RegisterUniforms( mImpl->mRenderer, Direction::LEFT_TO_RIGHT );
 367 }
 368
 369 bool GradientVisual::NewGradient(Type gradientType, const Property::Map& propertyMap)
 370 {
 371   if( gradientType == LINEAR )
 372   {
 373     Property::Value* startPositionValue = propertyMap.Find( Toolkit::GradientVisual::Property::START_POSITION, START_POSITION_NAME );
 374     Property::Value* endPositionValue = propertyMap.Find( Toolkit::GradientVisual::Property::END_POSITION, END_POSITION_NAME );
 375     Vector2 startPosition;
 376     Vector2 endPosition;
 377
 378     if( startPositionValue && startPositionValue->Get(startPosition)
 379      && endPositionValue && endPositionValue->Get( endPosition ) )
 380     {
 381       mGradient = new LinearGradient( startPosition, endPosition );
 382     }
 383     else
 384     {
 385       return false;
 386     }
 387   }
 388   else // type==RADIAL
 389   {
 390     Property::Value* centerValue = propertyMap.Find( Toolkit::GradientVisual::Property::CENTER, CENTER_NAME );
 391     Property::Value* radiusValue = propertyMap.Find( Toolkit::GradientVisual::Property::RADIUS, RADIUS_NAME );
 392     Vector2 center;
 393     float radius;
 394     if( centerValue && centerValue->Get(center)
 395         && radiusValue && radiusValue->Get(radius) )
 396     {
 397       mGradient = new RadialGradient( center, radius );
 398     }
 399     else
 400     {
 401       return false;
 402     }
 403   }
 404
 405   unsigned int numValidStop = 0u;
 406   Property::Value* stopOffsetValue = propertyMap.Find( Toolkit::GradientVisual::Property::STOP_OFFSET, STOP_OFFSET_NAME );
 407   Property::Value* stopColorValue = propertyMap.Find( Toolkit::GradientVisual::Property::STOP_COLOR, STOP_COLOR_NAME );
 408   if( stopColorValue )
 409   {
 410     Vector<float> offsetArray;
 411     Property::Array* colorArray = stopColorValue->GetArray();
 412     if( colorArray )
 413     {
 414       GetStopOffsets( stopOffsetValue, offsetArray );
 415       unsigned int numStop = offsetArray.Count() < colorArray->Count() ?
 416                              offsetArray.Count() : colorArray->Count();
 417       Vector4 color;
 418       for( unsigned int i=0; i<numStop; i++ )
 419       {
 420         if( (colorArray->GetElementAt(i)).Get(color) )
 421         {
 422           mGradient->AddStop( offsetArray[i], Vector4(color.r*color.a, color.g*color.a, color.b*color.a, color.a));
 423           numValidStop++;
 424           if( ! Equals( color.a, 1.0f, Math::MACHINE_EPSILON_1 ) )
 425           {
 426             mIsOpaque = false;
 427           }
 428         }
 429       }
 430     }
 431   }
 432
 433   if( numValidStop < 1u ) // no valid stop
 434   {
 435     return false;
 436   }
 437
 438   Property::Value* spread = propertyMap.Find( Toolkit::GradientVisual::Property::SPREAD_METHOD, SPREAD_METHOD_NAME );
 439   // The default spread method is PAD. Only need to set new spread if it's anything else.
 440   if( spread )
 441   {
 442     Toolkit::GradientVisual::SpreadMethod::Type spreadMethod = Toolkit::GradientVisual::SpreadMethod::PAD;
 443     if( Scripting::GetEnumerationProperty( *spread, SPREAD_METHOD_TABLE, SPREAD_METHOD_TABLE_COUNT, spreadMethod ) )
 444     {
 445       mGradient->SetSpreadMethod( spreadMethod );
 446     }
 447   }
 448
 449   return true;
 450 }
 451
 452 void GradientVisual::GetStopOffsets(const Property::Value* value, Vector<float>& stopOffsets)
 453 {
 454
 455   if ( value ) // Only check valve type if a valid Property has been passed in
 456   {
 457     switch ( value->GetType() )
 458     {
 459       case Property::VECTOR2:
 460       {
 461         Vector2 offset2;
 462         value->Get( offset2 );
 463         stopOffsets.PushBack( offset2.x );
 464         stopOffsets.PushBack( offset2.y );
 465         break;
 466       }
 467       case Property::VECTOR3:
 468       {
 469         Vector3 offset3;
 470         value->Get( offset3 );
 471         stopOffsets.PushBack( offset3.x );
 472         stopOffsets.PushBack( offset3.y );
 473         stopOffsets.PushBack( offset3.z );
 474         break;
 475       }
 476       case Property::VECTOR4:
 477       {
 478         Vector4 offset4;
 479         value->Get( offset4 );
 480         stopOffsets.PushBack( offset4.x );
 481         stopOffsets.PushBack( offset4.y );
 482         stopOffsets.PushBack( offset4.z );
 483         stopOffsets.PushBack( offset4.w );
 484         break;
 485       }
 486       case Property::ARRAY:
 487       {
 488         Property::Array* offsetArray = value->GetArray();
 489         if( offsetArray )
 490         {
 491           unsigned int numStop = offsetArray->Count();
 492           float offset;
 493           for( unsigned int i=0; i<numStop; i++ )
 494           {
 495             if( offsetArray->GetElementAt(i).Get(offset) )
 496             {
 497               stopOffsets.PushBack( offset );
 498             }
 499           }
 500         }
 501         break;
 502       }
 503       default:
 504       {
 505         DALI_LOG_WARNING("GetStopOffsets passed unsupported Property Map\n");
 506         // Unsupported Type
 507       }
 508     }
 509   }
 510
 511   if ( stopOffsets.Empty() )
 512   {
 513     // Set default offset if none set by Property system, need a minimum and maximum
 514     stopOffsets.PushBack( DEFAULT_OFFSET_MINIMUM );
 515     stopOffsets.PushBack( DEFAULT_OFFSET_MAXIMUM );
 516   }
 517 }
 518
 519 } // namespace Internal
 520
 521 } // namespace Toolkit
 522
 523 } // namespace Dali