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