dali-toolkit/internal/visuals/gradient/gradient-visual.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 "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/devel-api/visuals/visual-properties-devel.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 mediump 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 mediump 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   uniform lowp float opacity;\n
 177   varying mediump vec2 vTexCoord;\n
 178   \n
 179   void main()\n
 180   {\n
 181     gl_FragColor = texture2D( sTexture, vec2( vTexCoord.y, 0.5 ) ) * vec4(mixColor*opacity, opacity) * uColor;\n
 182   }\n
 183 ),
 184
 185 // fragment shader for radial gradient
 186 DALI_COMPOSE_SHADER(
 187   uniform sampler2D sTexture;\n // sampler1D?
 188   uniform lowp vec4 uColor;\n
 189   uniform lowp vec3 mixColor;\n
 190   uniform lowp float opacity;\n
 191   varying mediump vec2 vTexCoord;\n
 192   \n
 193   void main()\n
 194   {\n
 195     gl_FragColor = texture2D( sTexture, vec2( length(vTexCoord), 0.5 ) ) * vec4(mixColor*opacity, opacity) * uColor;\n
 196   }\n
 197 )
 198 };
 199
 200 Dali::WrapMode::Type GetWrapMode( Toolkit::GradientVisual::SpreadMethod::Type spread )
 201 {
 202   switch(spread)
 203   {
 204     case Toolkit::GradientVisual::SpreadMethod::REPEAT:
 205     {
 206       return Dali::WrapMode::REPEAT;
 207     }
 208     case Toolkit::GradientVisual::SpreadMethod::REFLECT:
 209     {
 210       return Dali::WrapMode::MIRRORED_REPEAT;
 211     }
 212     case Toolkit::GradientVisual::SpreadMethod::PAD:
 213     default:
 214     {
 215       return Dali::WrapMode::CLAMP_TO_EDGE;
 216     }
 217   }
 218 }
 219
 220 } // unnamed namespace
 221
 222 GradientVisualPtr GradientVisual::New( VisualFactoryCache& factoryCache, const Property::Map& properties )
 223 {
 224   GradientVisualPtr gradientVisualPtr( new GradientVisual( factoryCache ) );
 225   gradientVisualPtr->SetProperties( properties );
 226   return gradientVisualPtr;
 227 }
 228
 229 GradientVisual::GradientVisual( VisualFactoryCache& factoryCache )
 230 : Visual::Base( factoryCache ),
 231   mGradientType( LINEAR ),
 232   mIsOpaque( true )
 233 {
 234   mImpl->mFlags |= Impl::IS_PREMULTIPLIED_ALPHA;
 235 }
 236
 237 GradientVisual::~GradientVisual()
 238 {
 239 }
 240
 241 void GradientVisual::DoSetProperties( const Property::Map& propertyMap )
 242 {
 243   Toolkit::GradientVisual::Units::Type gradientUnits = Toolkit::GradientVisual::Units::OBJECT_BOUNDING_BOX;
 244
 245   Property::Value* unitsValue = propertyMap.Find( Toolkit::GradientVisual::Property::UNITS, UNITS_NAME );
 246   if( unitsValue )
 247   {
 248     Scripting::GetEnumerationProperty( *unitsValue, UNITS_TABLE, UNITS_TABLE_COUNT, gradientUnits );
 249   }
 250
 251   mGradientType = LINEAR;
 252   if( propertyMap.Find( Toolkit::GradientVisual::Property::RADIUS, RADIUS_NAME ) )
 253   {
 254     mGradientType = RADIAL;
 255   }
 256
 257   if( NewGradient( mGradientType, propertyMap ) )
 258   {
 259     mGradient->SetGradientUnits( gradientUnits );
 260     mGradientTransform = mGradient->GetAlignmentTransform();
 261   }
 262   else
 263   {
 264     DALI_LOG_ERROR( "Fail to provide valid properties to create a GradientVisual object\n" );
 265   }
 266 }
 267
 268 void GradientVisual::OnSetTransform()
 269 {
 270   if( mImpl->mRenderer )
 271   {
 272     mImpl->mTransform.RegisterUniforms( mImpl->mRenderer, Direction::LEFT_TO_RIGHT );
 273   }
 274 }
 275
 276 void GradientVisual::DoSetOnStage( Actor& actor )
 277 {
 278   InitializeRenderer();
 279
 280   actor.AddRenderer( mImpl->mRenderer );
 281 }
 282
 283 void GradientVisual::DoCreatePropertyMap( Property::Map& map ) const
 284 {
 285   map.Clear();
 286   map.Insert( Toolkit::DevelVisual::Property::TYPE, Toolkit::Visual::GRADIENT );
 287   map.Insert( Toolkit::GradientVisual::Property::UNITS, mGradient->GetGradientUnits() );
 288   map.Insert( Toolkit::GradientVisual::Property::SPREAD_METHOD, mGradient->GetSpreadMethod() );
 289
 290   const Vector<Gradient::GradientStop>& stops( mGradient->GetStops() );
 291   Property::Array offsets;
 292   Property::Array colors;
 293   for( unsigned int i=0; i<stops.Count(); i++ )
 294   {
 295     offsets.PushBack( stops[i].mOffset );
 296     if( EqualsZero(stops[i].mStopColor.a) )
 297     {
 298       colors.PushBack( Vector4::ZERO );
 299     }
 300     else
 301     {
 302       colors.PushBack( Vector4( stops[i].mStopColor.r / stops[i].mStopColor.a,
 303                                 stops[i].mStopColor.g / stops[i].mStopColor.a,
 304                                 stops[i].mStopColor.b / stops[i].mStopColor.a,
 305                                 stops[i].mStopColor.a));
 306     }
 307   }
 308
 309   map.Insert( Toolkit::GradientVisual::Property::STOP_OFFSET, offsets );
 310   map.Insert( Toolkit::GradientVisual::Property::STOP_COLOR, colors );
 311
 312   if( &typeid( *mGradient ) == &typeid(LinearGradient) )
 313   {
 314     LinearGradient* gradient = static_cast<LinearGradient*>( mGradient.Get() );
 315     map.Insert( Toolkit::GradientVisual::Property::START_POSITION, gradient->GetStartPosition() );
 316     map.Insert( Toolkit::GradientVisual::Property::END_POSITION, gradient->GetEndPosition() );
 317   }
 318   else // if( &typeid( *mGradient ) == &typeid(RadialGradient) )
 319   {
 320     RadialGradient* gradient = static_cast<RadialGradient*>( mGradient.Get() );
 321     map.Insert( Toolkit::GradientVisual::Property::CENTER, gradient->GetCenter() );
 322     map.Insert( Toolkit::GradientVisual::Property::RADIUS, gradient->GetRadius() );
 323   }
 324 }
 325
 326 void GradientVisual::InitializeRenderer()
 327 {
 328   Geometry geometry = mFactoryCache.GetGeometry( VisualFactoryCache::QUAD_GEOMETRY );
 329
 330   Toolkit::GradientVisual::Units::Type gradientUnits = mGradient->GetGradientUnits();
 331   VisualFactoryCache::ShaderType shaderType = GetShaderType( mGradientType, gradientUnits );
 332   Shader shader = mFactoryCache.GetShader( shaderType );
 333   if( !shader )
 334   {
 335     shader = Shader::New( VERTEX_SHADER[gradientUnits], FRAGMENT_SHADER[ mGradientType ] );
 336     mFactoryCache.SaveShader( shaderType, shader );
 337   }
 338
 339   //Set up the texture set
 340   TextureSet textureSet = TextureSet::New();
 341   Dali::Texture lookupTexture = mGradient->GenerateLookupTexture();
 342   textureSet.SetTexture( 0u, lookupTexture );
 343   Dali::WrapMode::Type wrap = GetWrapMode( mGradient->GetSpreadMethod() );
 344   Sampler sampler = Sampler::New();
 345   sampler.SetWrapMode(  wrap, wrap  );
 346   textureSet.SetSampler( 0u, sampler );
 347
 348   mImpl->mRenderer = Renderer::New( geometry, shader );
 349   mImpl->mRenderer.SetTextures( textureSet );
 350
 351   // If opaque then no need to have blending
 352   if( mIsOpaque )
 353   {
 354     mImpl->mRenderer.SetProperty( Renderer::Property::BLEND_MODE, BlendMode::OFF );
 355   }
 356
 357   mImpl->mRenderer.RegisterProperty( UNIFORM_ALIGNMENT_MATRIX_NAME, mGradientTransform );
 358
 359   //Register transform properties
 360   mImpl->mTransform.RegisterUniforms( mImpl->mRenderer, Direction::LEFT_TO_RIGHT );
 361 }
 362
 363 bool GradientVisual::NewGradient(Type gradientType, const Property::Map& propertyMap)
 364 {
 365   if( gradientType == LINEAR )
 366   {
 367     Property::Value* startPositionValue = propertyMap.Find( Toolkit::GradientVisual::Property::START_POSITION, START_POSITION_NAME );
 368     Property::Value* endPositionValue = propertyMap.Find( Toolkit::GradientVisual::Property::END_POSITION, END_POSITION_NAME );
 369     Vector2 startPosition;
 370     Vector2 endPosition;
 371
 372     if( startPositionValue && startPositionValue->Get(startPosition)
 373      && endPositionValue && endPositionValue->Get( endPosition ) )
 374     {
 375       mGradient = new LinearGradient( startPosition, endPosition );
 376     }
 377     else
 378     {
 379       return false;
 380     }
 381   }
 382   else // type==RADIAL
 383   {
 384     Property::Value* centerValue = propertyMap.Find( Toolkit::GradientVisual::Property::CENTER, CENTER_NAME );
 385     Property::Value* radiusValue = propertyMap.Find( Toolkit::GradientVisual::Property::RADIUS, RADIUS_NAME );
 386     Vector2 center;
 387     float radius;
 388     if( centerValue && centerValue->Get(center)
 389         && radiusValue && radiusValue->Get(radius) )
 390     {
 391       mGradient = new RadialGradient( center, radius );
 392     }
 393     else
 394     {
 395       return false;
 396     }
 397   }
 398
 399   unsigned int numValidStop = 0u;
 400   Property::Value* stopOffsetValue = propertyMap.Find( Toolkit::GradientVisual::Property::STOP_OFFSET, STOP_OFFSET_NAME );
 401   Property::Value* stopColorValue = propertyMap.Find( Toolkit::GradientVisual::Property::STOP_COLOR, STOP_COLOR_NAME );
 402   if( stopColorValue )
 403   {
 404     Vector<float> offsetArray;
 405     Property::Array* colorArray = stopColorValue->GetArray();
 406     if( colorArray )
 407     {
 408       GetStopOffsets( stopOffsetValue, offsetArray );
 409       unsigned int numStop = offsetArray.Count() < colorArray->Count() ?
 410                              offsetArray.Count() : colorArray->Count();
 411       Vector4 color;
 412       for( unsigned int i=0; i<numStop; i++ )
 413       {
 414         if( (colorArray->GetElementAt(i)).Get(color) )
 415         {
 416           mGradient->AddStop( offsetArray[i], Vector4(color.r*color.a, color.g*color.a, color.b*color.a, color.a));
 417           numValidStop++;
 418           if( ! Equals( color.a, 1.0f, Math::MACHINE_EPSILON_1 ) )
 419           {
 420             mIsOpaque = false;
 421           }
 422         }
 423       }
 424     }
 425   }
 426
 427   if( numValidStop < 1u ) // no valid stop
 428   {
 429     return false;
 430   }
 431
 432   Property::Value* spread = propertyMap.Find( Toolkit::GradientVisual::Property::SPREAD_METHOD, SPREAD_METHOD_NAME );
 433   // The default spread method is PAD. Only need to set new spread if it's anything else.
 434   if( spread )
 435   {
 436     Toolkit::GradientVisual::SpreadMethod::Type spreadMethod = Toolkit::GradientVisual::SpreadMethod::PAD;
 437     if( Scripting::GetEnumerationProperty( *spread, SPREAD_METHOD_TABLE, SPREAD_METHOD_TABLE_COUNT, spreadMethod ) )
 438     {
 439       mGradient->SetSpreadMethod( spreadMethod );
 440     }
 441   }
 442
 443   return true;
 444 }
 445
 446 void GradientVisual::GetStopOffsets(const Property::Value* value, Vector<float>& stopOffsets)
 447 {
 448
 449   if ( value ) // Only check valve type if a valid Property has been passed in
 450   {
 451     switch ( value->GetType() )
 452     {
 453       case Property::VECTOR2:
 454       {
 455         Vector2 offset2;
 456         value->Get( offset2 );
 457         stopOffsets.PushBack( offset2.x );
 458         stopOffsets.PushBack( offset2.y );
 459         break;
 460       }
 461       case Property::VECTOR3:
 462       {
 463         Vector3 offset3;
 464         value->Get( offset3 );
 465         stopOffsets.PushBack( offset3.x );
 466         stopOffsets.PushBack( offset3.y );
 467         stopOffsets.PushBack( offset3.z );
 468         break;
 469       }
 470       case Property::VECTOR4:
 471       {
 472         Vector4 offset4;
 473         value->Get( offset4 );
 474         stopOffsets.PushBack( offset4.x );
 475         stopOffsets.PushBack( offset4.y );
 476         stopOffsets.PushBack( offset4.z );
 477         stopOffsets.PushBack( offset4.w );
 478         break;
 479       }
 480       case Property::ARRAY:
 481       {
 482         Property::Array* offsetArray = value->GetArray();
 483         if( offsetArray )
 484         {
 485           unsigned int numStop = offsetArray->Count();
 486           float offset;
 487           for( unsigned int i=0; i<numStop; i++ )
 488           {
 489             if( offsetArray->GetElementAt(i).Get(offset) )
 490             {
 491               stopOffsets.PushBack( offset );
 492             }
 493           }
 494         }
 495         break;
 496       }
 497       default:
 498       {
 499         DALI_LOG_WARNING("GetStopOffsets passed unsupported Property Map\n");
 500         // Unsupported Type
 501       }
 502     }
 503   }
 504
 505   if ( stopOffsets.Empty() )
 506   {
 507     // Set default offset if none set by Property system, need a minimum and maximum
 508     stopOffsets.PushBack( DEFAULT_OFFSET_MINIMUM );
 509     stopOffsets.PushBack( DEFAULT_OFFSET_MAXIMUM );
 510   }
 511 }
 512
 513 } // namespace Internal
 514
 515 } // namespace Toolkit
 516
 517 } // namespace Dali