dali-toolkit/internal/visuals/gradient/gradient-visual.cpp

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