Automatically dis/connect registered visuals to stage
[platform/core/uifw/dali-toolkit.git] / dali-toolkit / internal / visuals / border / border-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 "border-visual.h"
20
21 // EXTERNAL INCLUDES
22 #include <dali/integration-api/debug.h>
23
24 // INTERNAL INCLUDES
25 #include <dali-toolkit/public-api/visuals/border-visual-properties.h>
26 #include <dali-toolkit/internal/visuals/visual-factory-impl.h>
27 #include <dali-toolkit/internal/visuals/visual-factory-cache.h>
28 #include <dali-toolkit/internal/visuals/visual-string-constants.h>
29 #include <dali-toolkit/internal/visuals/visual-base-data-impl.h>
30
31 namespace Dali
32 {
33
34 namespace Toolkit
35 {
36
37 namespace Internal
38 {
39
40 namespace
41 {
42 const char * const COLOR_NAME("borderColor");
43 const char * const SIZE_NAME("borderSize");
44 const char * const ANTI_ALIASING("antiAliasing");
45
46 const char * const POSITION_ATTRIBUTE_NAME("aPosition");
47 const char * const DRIFT_ATTRIBUTE_NAME("aDrift");
48 const char * const INDEX_NAME("indices");
49
50
51 const char* VERTEX_SHADER = DALI_COMPOSE_SHADER(
52   attribute mediump vec2 aPosition;\n
53   attribute mediump vec2 aDrift;\n
54   uniform mediump mat4 uMvpMatrix;\n
55   uniform mediump vec3 uSize;\n
56   uniform mediump float borderSize;\n
57   \n
58   void main()\n
59   {\n
60     vec2 position = aPosition*uSize.xy + aDrift*borderSize;\n
61     gl_Position = uMvpMatrix * vec4(position, 0.0, 1.0);\n
62   }\n
63 );
64
65 const char* FRAGMENT_SHADER = DALI_COMPOSE_SHADER(
66   uniform lowp vec4 uColor;\n
67   uniform lowp vec4 borderColor;\n
68   \n
69   void main()\n
70   {\n
71     gl_FragColor = borderColor*uColor;\n
72   }\n
73 );
74
75 const char* VERTEX_SHADER_ANTI_ALIASING = DALI_COMPOSE_SHADER(
76   attribute mediump vec2 aPosition;\n
77   attribute mediump vec2 aDrift;\n
78   uniform mediump mat4 uMvpMatrix;\n
79   uniform mediump vec3 uSize;\n
80   uniform mediump float borderSize;\n
81   varying mediump float vAlpha;\n
82   \n
83   void main()\n
84   {\n
85     vec2 position = aPosition*(uSize.xy+vec2(0.75)) + aDrift*(borderSize+1.5);\n
86     gl_Position = uMvpMatrix * vec4(position, 0.0, 1.0);\n
87     vAlpha = min( abs(aDrift.x), abs(aDrift.y) )*(borderSize+1.5);
88   }\n
89 );
90
91 const char* FRAGMENT_SHADER_ANTI_ALIASING = DALI_COMPOSE_SHADER(
92   uniform lowp vec4 uColor;\n
93   uniform lowp vec4 borderColor;\n
94   uniform mediump float borderSize;\n
95   varying mediump float vAlpha;\n
96   \n
97   void main()\n
98   {\n
99     gl_FragColor = borderColor*uColor;\n
100     gl_FragColor.a *= smoothstep(0.0, 1.5, vAlpha)*smoothstep( borderSize+1.5, borderSize, vAlpha );\n
101   }\n
102 );
103 }
104
105 BorderVisual::BorderVisual( VisualFactoryCache& factoryCache )
106 : Visual::Base( factoryCache ),
107   mBorderColor( Color::TRANSPARENT ),
108   mBorderSize( 0.f ),
109   mBorderColorIndex( Property::INVALID_INDEX ),
110   mBorderSizeIndex( Property::INVALID_INDEX ),
111   mAntiAliasing( false )
112 {
113 }
114
115 BorderVisual::~BorderVisual()
116 {
117 }
118
119 void BorderVisual::DoInitialize( Actor& actor, const Property::Map& propertyMap )
120 {
121   Property::Value* color = propertyMap.Find( Toolkit::BorderVisual::Property::COLOR, COLOR_NAME );
122   if( !( color && color->Get(mBorderColor) ) )
123   {
124     DALI_LOG_ERROR( "Fail to provide a border color to the BorderVisual object\n" );
125   }
126
127   Property::Value* size = propertyMap.Find( Toolkit::BorderVisual::Property::SIZE, SIZE_NAME );
128   if( !( size && size->Get(mBorderSize) ) )
129   {
130     DALI_LOG_ERROR( "Fail to provide a border size to the BorderVisual object\n" );
131   }
132
133   Property::Value* antiAliasing = propertyMap.Find( Toolkit::BorderVisual::Property::ANTI_ALIASING, ANTI_ALIASING );
134   if( antiAliasing )
135   {
136     antiAliasing->Get( mAntiAliasing );
137   }
138 }
139
140 void BorderVisual::DoSetOnStage( Actor& actor )
141 {
142   InitializeRenderer();
143
144   mBorderColorIndex = (mImpl->mRenderer).RegisterProperty( Toolkit::BorderVisual::Property::COLOR, COLOR_NAME, mBorderColor );
145   if( mBorderColor.a < 1.f || mAntiAliasing)
146   {
147     mImpl->mRenderer.SetProperty( Renderer::Property::BLEND_MODE, BlendMode::ON );
148   }
149   mBorderSizeIndex = (mImpl->mRenderer).RegisterProperty( Toolkit::BorderVisual::Property::SIZE, SIZE_NAME, mBorderSize );
150
151   actor.AddRenderer( mImpl->mRenderer );
152 }
153
154 void BorderVisual::DoCreatePropertyMap( Property::Map& map ) const
155 {
156   map.Clear();
157   map.Insert( Toolkit::Visual::Property::TYPE, Toolkit::Visual::BORDER );
158   map.Insert( Toolkit::BorderVisual::Property::COLOR, mBorderColor );
159   map.Insert( Toolkit::BorderVisual::Property::SIZE, mBorderSize );
160   map.Insert( Toolkit::BorderVisual::Property::ANTI_ALIASING, mAntiAliasing );
161 }
162
163 void BorderVisual::InitializeRenderer()
164 {
165   Geometry geometry = mFactoryCache.GetGeometry( VisualFactoryCache::BORDER_GEOMETRY );
166   if( !geometry )
167   {
168     geometry =  CreateBorderGeometry();
169     mFactoryCache.SaveGeometry( VisualFactoryCache::BORDER_GEOMETRY, geometry );
170   }
171
172
173   Shader shader = GetBorderShader();
174   mImpl->mRenderer = Renderer::New( geometry, shader  );
175
176 }
177
178 void BorderVisual::SetBorderColor(const Vector4& color)
179 {
180   mBorderColor = color;
181
182   if( mImpl->mRenderer )
183   {
184     (mImpl->mRenderer).SetProperty( mBorderColorIndex, color );
185     if( color.a < 1.f )
186     {
187       mImpl->mRenderer.SetProperty( Renderer::Property::BLEND_MODE, BlendMode::ON );
188     }
189   }
190 }
191
192 void BorderVisual::SetBorderSize( float size )
193 {
194   mBorderSize = size;
195
196   if( mImpl->mRenderer )
197   {
198     (mImpl->mRenderer).SetProperty( mBorderSizeIndex, size );
199   }
200 }
201
202 void BorderVisual::RequireAntiAliasing( bool antiAliasing )
203 {
204   if( mAntiAliasing != antiAliasing )
205   {
206     mAntiAliasing = antiAliasing;
207     if( mImpl->mRenderer )
208     {
209       Shader borderShader( GetBorderShader() );
210       mImpl->mRenderer.SetShader( borderShader );
211       if( mAntiAliasing )
212       {
213         mImpl->mRenderer.SetProperty( Renderer::Property::BLEND_MODE, BlendMode::ON );
214       }
215     }
216   }
217 }
218
219 Shader BorderVisual::GetBorderShader()
220 {
221   Shader shader;
222   if( mAntiAliasing )
223   {
224     shader = mFactoryCache.GetShader( VisualFactoryCache::BORDER_SHADER_ANTI_ALIASING );
225     if( !shader )
226     {
227       shader = Shader::New( VERTEX_SHADER_ANTI_ALIASING, FRAGMENT_SHADER_ANTI_ALIASING );
228       mFactoryCache.SaveShader( VisualFactoryCache::BORDER_SHADER_ANTI_ALIASING, shader );
229     }
230   }
231   else
232   {
233     shader = mFactoryCache.GetShader( VisualFactoryCache::BORDER_SHADER );
234     if( !shader )
235     {
236       shader = Shader::New( VERTEX_SHADER, FRAGMENT_SHADER );
237       mFactoryCache.SaveShader( VisualFactoryCache::BORDER_SHADER, shader );
238     }
239   }
240
241   return shader;
242 }
243
244 /**
245  * Vertices and triangles of the border geometry:
246  *
247  * vertex position = aPosition*uSize.xy + aDrift*uBorderSize;
248  *
249  * 0--1--2--3
250  * |\ | /| /|
251  * | \|/ |/ |
252  * 4--5--6--7
253  * |\ |  |\ |
254  * | \|  | \|
255  * 8--9--10-11
256  * | /| /|\ |
257  * |/ |/ | \|
258  * 12-13-14-15
259  */
260 Geometry BorderVisual::CreateBorderGeometry()
261 {
262   const float halfWidth = 0.5f;
263   const float halfHeight = 0.5f;
264   struct BorderVertex { Vector2 position; Vector2 drift;};
265   BorderVertex borderVertexData[16] =
266   {
267       { Vector2(-halfWidth, -halfHeight), Vector2(0.f, 0.f) },
268       { Vector2(-halfWidth, -halfHeight), Vector2(1.f, 0.f) },
269       { Vector2(halfWidth, -halfHeight),  Vector2(-1.f, 0.f) },
270       { Vector2(halfWidth, -halfHeight),  Vector2(0.f, 0.f) },
271
272       { Vector2(-halfWidth, -halfHeight), Vector2(0.f, 1.f) },
273       { Vector2(-halfWidth, -halfHeight), Vector2(1.f, 1.f) },
274       { Vector2(halfWidth, -halfHeight),  Vector2(-1.f, 1.f) },
275       { Vector2(halfWidth, -halfHeight),  Vector2(0.f, 1.f) },
276
277       { Vector2(-halfWidth, halfHeight), Vector2(0.f, -1.f) },
278       { Vector2(-halfWidth, halfHeight), Vector2(1.f, -1.f) },
279       { Vector2(halfWidth, halfHeight),  Vector2(-1.f, -1.f) },
280       { Vector2(halfWidth, halfHeight),  Vector2(0.f, -1.f) },
281
282       { Vector2(-halfWidth, halfHeight), Vector2(0.f, 0.f) },
283       { Vector2(-halfWidth, halfHeight), Vector2(1.f, 0.f) },
284       { Vector2(halfWidth, halfHeight),  Vector2(-1.f, 0.f) },
285       { Vector2(halfWidth, halfHeight),  Vector2(0.f, 0.f) },
286   };
287
288   Property::Map borderVertexFormat;
289   borderVertexFormat[POSITION_ATTRIBUTE_NAME] = Property::VECTOR2;
290   borderVertexFormat[DRIFT_ATTRIBUTE_NAME] = Property::VECTOR2;
291   PropertyBuffer borderVertices = PropertyBuffer::New( borderVertexFormat );
292   borderVertices.SetData( borderVertexData, 16 );
293
294   // Create indices
295   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};
296
297   // Create the geometry object
298   Geometry geometry = Geometry::New();
299   geometry.AddVertexBuffer( borderVertices );
300   geometry.SetIndexBuffer( indexData, sizeof(indexData)/sizeof(indexData[0]) );
301   geometry.SetType( Geometry::TRIANGLE_STRIP );
302
303   return geometry;
304 }
305
306 } // namespace Internal
307
308 } // namespace Toolkit
309
310 } // namespace Dali