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

   1 /*
   2  * Copyright (c) 2017 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 "border-visual.h"
  20
  21 // EXTERNAL INCLUDES
  22 #include <dali/integration-api/debug.h>
  23 #include <dali/devel-api/object/handle-devel.h>
  24
  25 // INTERNAL INCLUDES
  26 #include <dali-toolkit/public-api/visuals/border-visual-properties.h>
  27 #include <dali-toolkit/public-api/visuals/visual-properties.h>
  28 #include <dali-toolkit/internal/visuals/visual-factory-impl.h>
  29 #include <dali-toolkit/internal/visuals/visual-factory-cache.h>
  30 #include <dali-toolkit/internal/visuals/visual-string-constants.h>
  31 #include <dali-toolkit/internal/visuals/visual-base-data-impl.h>
  32
  33 namespace Dali
  34 {
  35
  36 namespace Toolkit
  37 {
  38
  39 namespace Internal
  40 {
  41
  42 namespace
  43 {
  44 const char * const COLOR_NAME("borderColor");
  45 const char * const SIZE_NAME("borderSize");
  46 const char * const ANTI_ALIASING("antiAliasing");
  47
  48 const char * const POSITION_ATTRIBUTE_NAME("aPosition");
  49 const char * const DRIFT_ATTRIBUTE_NAME("aDrift");
  50 const char * const INDEX_NAME("indices");
  51
  52
  53 const char* VERTEX_SHADER = DALI_COMPOSE_SHADER(
  54   attribute mediump vec2 aPosition;\n
  55   attribute mediump vec2 aDrift;\n
  56   uniform mediump mat4 uMvpMatrix;\n
  57   uniform mediump vec3 uSize;\n
  58   uniform mediump float borderSize;\n
  59   \n
  60
  61   //Visual size and offset
  62   uniform mediump vec2 offset;\n
  63   uniform mediump vec2 size;\n
  64   uniform mediump vec4 offsetSizeMode;\n
  65   uniform mediump vec2 origin;\n
  66   uniform mediump vec2 anchorPoint;\n
  67
  68   vec2 ComputeVertexPosition()\n
  69   {\n
  70     vec2 visualSize = mix(uSize.xy*size, size, offsetSizeMode.zw );\n
  71     vec2 visualOffset = mix( offset, offset/uSize.xy, offsetSizeMode.xy);\n
  72     return (aPosition + anchorPoint)*visualSize + (visualOffset + origin)*uSize.xy;\n
  73   }\n
  74
  75   void main()\n
  76   {\n
  77     vec2 position = ComputeVertexPosition() + aDrift*borderSize;\n
  78     gl_Position = uMvpMatrix * vec4(position, 0.0, 1.0);\n
  79   }\n
  80 );
  81
  82 const char* FRAGMENT_SHADER = DALI_COMPOSE_SHADER(
  83   uniform lowp vec4 uColor;\n
  84   uniform lowp vec4 borderColor;\n
  85   uniform lowp vec3 mixColor;\n
  86   uniform lowp float opacity;\n
  87   \n
  88   void main()\n
  89   {\n
  90     gl_FragColor = vec4(mixColor, opacity)*borderColor*uColor;\n
  91   }\n
  92 );
  93
  94 const char* VERTEX_SHADER_ANTI_ALIASING = DALI_COMPOSE_SHADER(
  95   attribute mediump vec2 aPosition;\n
  96   attribute mediump vec2 aDrift;\n
  97   uniform mediump mat4 uMvpMatrix;\n
  98   uniform mediump vec3 uSize;\n
  99   uniform mediump float borderSize;\n
 100   varying mediump float vAlpha;\n
 101   \n
 102   void main()\n
 103   {\n
 104     vec2 position = aPosition*(uSize.xy+vec2(0.75)) + aDrift*(borderSize+1.5);\n
 105     gl_Position = uMvpMatrix * vec4(position, 0.0, 1.0);\n
 106     vAlpha = min( abs(aDrift.x), abs(aDrift.y) )*(borderSize+1.5);
 107   }\n
 108 );
 109
 110 const char* FRAGMENT_SHADER_ANTI_ALIASING = DALI_COMPOSE_SHADER(
 111   uniform lowp vec4 uColor;\n
 112   uniform lowp vec4 borderColor;\n
 113   uniform lowp vec3 mixColor;\n
 114   uniform lowp float opacity;\n
 115   uniform mediump float borderSize;\n
 116   varying mediump float vAlpha;\n
 117   \n
 118   void main()\n
 119   {\n
 120     gl_FragColor = vec4(mixColor, opacity)*borderColor*uColor;\n
 121     gl_FragColor.a *= smoothstep(0.0, 1.5, vAlpha)*smoothstep( borderSize+1.5, borderSize, vAlpha );\n
 122   }\n
 123 );
 124 }
 125
 126 BorderVisualPtr BorderVisual::New( VisualFactoryCache& factoryCache, const Property::Map& properties )
 127 {
 128   BorderVisualPtr borderVisualPtr( new BorderVisual( factoryCache ) );
 129   borderVisualPtr->SetProperties( properties );
 130   return borderVisualPtr;
 131 }
 132
 133 BorderVisual::BorderVisual( VisualFactoryCache& factoryCache )
 134 : Visual::Base( factoryCache ),
 135   mBorderColor( Color::TRANSPARENT ),
 136   mBorderSize( 0.f ),
 137   mBorderColorIndex( Property::INVALID_INDEX ),
 138   mBorderSizeIndex( Property::INVALID_INDEX ),
 139   mAntiAliasing( false )
 140 {
 141 }
 142
 143 BorderVisual::~BorderVisual()
 144 {
 145 }
 146
 147 void BorderVisual::DoSetProperties( const Property::Map& propertyMap )
 148 {
 149   for( Property::Map::SizeType iter = 0; iter < propertyMap.Count(); ++iter )
 150   {
 151     KeyValuePair keyValue = propertyMap.GetKeyValue( iter );
 152     if( keyValue.first.type == Property::Key::INDEX )
 153     {
 154       DoSetProperty( keyValue.first.indexKey, keyValue.second );
 155     }
 156     else
 157     {
 158       if( keyValue.first == COLOR_NAME )
 159       {
 160         DoSetProperty( Toolkit::BorderVisual::Property::COLOR, keyValue.second );
 161       }
 162       else if( keyValue.first == SIZE_NAME )
 163       {
 164         DoSetProperty( Toolkit::BorderVisual::Property::SIZE, keyValue.second );
 165       }
 166       else if( keyValue.first == ANTI_ALIASING )
 167       {
 168         DoSetProperty( Toolkit::BorderVisual::Property::ANTI_ALIASING, keyValue.second );
 169       }
 170     }
 171   }
 172 }
 173
 174 void BorderVisual::DoSetProperty( Dali::Property::Index index,
 175                                   const Dali::Property::Value& value )
 176 {
 177   switch( index )
 178   {
 179     case Toolkit::BorderVisual::Property::COLOR:
 180     {
 181       if( !value.Get( mBorderColor ) )
 182       {
 183         DALI_LOG_ERROR("BorderVisual: borderColor property has incorrect type\n");
 184       }
 185       break;
 186     }
 187     case Toolkit::BorderVisual::Property::SIZE:
 188     {
 189       if( !value.Get( mBorderSize ) )
 190       {
 191         DALI_LOG_ERROR("BorderVisual: borderSize property has incorrect type\n");
 192       }
 193       break;
 194     }
 195     case Toolkit::BorderVisual::Property::ANTI_ALIASING:
 196     {
 197       if( !value.Get( mAntiAliasing ) )
 198       {
 199         DALI_LOG_ERROR("BorderVisual: antiAliasing property has incorrect type\n");
 200       }
 201       break;
 202     }
 203   }
 204 }
 205
 206 void BorderVisual::DoSetOnStage( Actor& actor )
 207 {
 208   InitializeRenderer();
 209
 210   mBorderColorIndex = DevelHandle::RegisterProperty( mImpl->mRenderer, Toolkit::BorderVisual::Property::COLOR, COLOR_NAME, mBorderColor );
 211   if( mBorderColor.a < 1.f || mAntiAliasing)
 212   {
 213     mImpl->mRenderer.SetProperty( Renderer::Property::BLEND_MODE, BlendMode::ON );
 214   }
 215   mBorderSizeIndex = DevelHandle::RegisterProperty( mImpl->mRenderer, Toolkit::BorderVisual::Property::SIZE, SIZE_NAME, mBorderSize );
 216
 217   actor.AddRenderer( mImpl->mRenderer );
 218
 219   // Border Visual Generated and ready to display
 220   ResourceReady();
 221 }
 222
 223 void BorderVisual::DoCreatePropertyMap( Property::Map& map ) const
 224 {
 225   map.Clear();
 226   map.Insert( Toolkit::Visual::Property::TYPE, Toolkit::Visual::BORDER );
 227   map.Insert( Toolkit::BorderVisual::Property::COLOR, mBorderColor );
 228   map.Insert( Toolkit::BorderVisual::Property::SIZE, mBorderSize );
 229   map.Insert( Toolkit::BorderVisual::Property::ANTI_ALIASING, mAntiAliasing );
 230 }
 231
 232 void BorderVisual::DoCreateInstancePropertyMap( Property::Map& map ) const
 233 {
 234   // Do nothing
 235 }
 236
 237 void BorderVisual::OnSetTransform()
 238 {
 239   if( mImpl->mRenderer )
 240   {
 241     mImpl->mTransform.RegisterUniforms( mImpl->mRenderer, Direction::LEFT_TO_RIGHT );
 242   }
 243 }
 244
 245 void BorderVisual::InitializeRenderer()
 246 {
 247   Geometry geometry = mFactoryCache.GetGeometry( VisualFactoryCache::BORDER_GEOMETRY );
 248   if( !geometry )
 249   {
 250     geometry =  CreateBorderGeometry();
 251     mFactoryCache.SaveGeometry( VisualFactoryCache::BORDER_GEOMETRY, geometry );
 252   }
 253
 254   Shader shader = GetBorderShader();
 255   mImpl->mRenderer = Renderer::New( geometry, shader  );
 256
 257   //Register transform properties
 258   mImpl->mTransform.RegisterUniforms( mImpl->mRenderer, Direction::LEFT_TO_RIGHT );
 259 }
 260
 261 void BorderVisual::SetBorderColor(const Vector4& color)
 262 {
 263   mBorderColor = color;
 264
 265   if( mImpl->mRenderer )
 266   {
 267     (mImpl->mRenderer).SetProperty( mBorderColorIndex, color );
 268     if( color.a < 1.f )
 269     {
 270       mImpl->mRenderer.SetProperty( Renderer::Property::BLEND_MODE, BlendMode::ON );
 271     }
 272   }
 273 }
 274
 275 void BorderVisual::SetBorderSize( float size )
 276 {
 277   mBorderSize = size;
 278
 279   if( mImpl->mRenderer )
 280   {
 281     (mImpl->mRenderer).SetProperty( mBorderSizeIndex, size );
 282   }
 283 }
 284
 285 void BorderVisual::RequireAntiAliasing( bool antiAliasing )
 286 {
 287   if( mAntiAliasing != antiAliasing )
 288   {
 289     mAntiAliasing = antiAliasing;
 290     if( mImpl->mRenderer )
 291     {
 292       Shader borderShader( GetBorderShader() );
 293       mImpl->mRenderer.SetShader( borderShader );
 294       if( mAntiAliasing )
 295       {
 296         mImpl->mRenderer.SetProperty( Renderer::Property::BLEND_MODE, BlendMode::ON );
 297       }
 298     }
 299   }
 300 }
 301
 302 Shader BorderVisual::GetBorderShader()
 303 {
 304   Shader shader;
 305   if( mAntiAliasing )
 306   {
 307     shader = mFactoryCache.GetShader( VisualFactoryCache::BORDER_SHADER_ANTI_ALIASING );
 308     if( !shader )
 309     {
 310       shader = Shader::New( VERTEX_SHADER_ANTI_ALIASING, FRAGMENT_SHADER_ANTI_ALIASING );
 311       mFactoryCache.SaveShader( VisualFactoryCache::BORDER_SHADER_ANTI_ALIASING, shader );
 312     }
 313   }
 314   else
 315   {
 316     shader = mFactoryCache.GetShader( VisualFactoryCache::BORDER_SHADER );
 317     if( !shader )
 318     {
 319       shader = Shader::New( VERTEX_SHADER, FRAGMENT_SHADER );
 320       mFactoryCache.SaveShader( VisualFactoryCache::BORDER_SHADER, shader );
 321     }
 322   }
 323
 324   return shader;
 325 }
 326
 327 /**
 328  * Vertices and triangles of the border geometry:
 329  *
 330  * vertex position = aPosition*uSize.xy + aDrift*uBorderSize;
 331  *
 332  * 0--1--2--3
 333  * |\ | /| /|
 334  * | \|/ |/ |
 335  * 4--5--6--7
 336  * |\ |  |\ |
 337  * | \|  | \|
 338  * 8--9--10-11
 339  * | /| /|\ |
 340  * |/ |/ | \|
 341  * 12-13-14-15
 342  */
 343 Geometry BorderVisual::CreateBorderGeometry()
 344 {
 345   const float halfWidth = 0.5f;
 346   const float halfHeight = 0.5f;
 347   struct BorderVertex { Vector2 position; Vector2 drift;};
 348   BorderVertex borderVertexData[16] =
 349   {
 350       { Vector2(-halfWidth, -halfHeight), Vector2(0.f, 0.f) },
 351       { Vector2(-halfWidth, -halfHeight), Vector2(1.f, 0.f) },
 352       { Vector2(halfWidth, -halfHeight),  Vector2(-1.f, 0.f) },
 353       { Vector2(halfWidth, -halfHeight),  Vector2(0.f, 0.f) },
 354
 355       { Vector2(-halfWidth, -halfHeight), Vector2(0.f, 1.f) },
 356       { Vector2(-halfWidth, -halfHeight), Vector2(1.f, 1.f) },
 357       { Vector2(halfWidth, -halfHeight),  Vector2(-1.f, 1.f) },
 358       { Vector2(halfWidth, -halfHeight),  Vector2(0.f, 1.f) },
 359
 360       { Vector2(-halfWidth, halfHeight), Vector2(0.f, -1.f) },
 361       { Vector2(-halfWidth, halfHeight), Vector2(1.f, -1.f) },
 362       { Vector2(halfWidth, halfHeight),  Vector2(-1.f, -1.f) },
 363       { Vector2(halfWidth, halfHeight),  Vector2(0.f, -1.f) },
 364
 365       { Vector2(-halfWidth, halfHeight), Vector2(0.f, 0.f) },
 366       { Vector2(-halfWidth, halfHeight), Vector2(1.f, 0.f) },
 367       { Vector2(halfWidth, halfHeight),  Vector2(-1.f, 0.f) },
 368       { Vector2(halfWidth, halfHeight),  Vector2(0.f, 0.f) },
 369   };
 370
 371   Property::Map borderVertexFormat;
 372   borderVertexFormat[POSITION_ATTRIBUTE_NAME] = Property::VECTOR2;
 373   borderVertexFormat[DRIFT_ATTRIBUTE_NAME] = Property::VECTOR2;
 374   PropertyBuffer borderVertices = PropertyBuffer::New( borderVertexFormat );
 375   borderVertices.SetData( borderVertexData, 16 );
 376
 377   // Create indices
 378   unsigned short indexData[24] = { 1,5,2,6,3,7,7,6,11,10,15,14,14,10,13,9,12,8,8,9,4,5,0,1};
 379
 380   // Create the geometry object
 381   Geometry geometry = Geometry::New();
 382   geometry.AddVertexBuffer( borderVertices );
 383   geometry.SetIndexBuffer( indexData, sizeof(indexData)/sizeof(indexData[0]) );
 384   geometry.SetType( Geometry::TRIANGLE_STRIP );
 385
 386   return geometry;
 387 }
 388
 389 } // namespace Internal
 390
 391 } // namespace Toolkit
 392
 393 } // namespace Dali