2 * Copyright (c) 2016 Samsung Electronics Co., Ltd.
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
8 * http://www.apache.org/licenses/LICENSE-2.0
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.
19 #include "npatch-visual.h"
22 #include <dali/integration-api/platform-abstraction.h>
23 #include <dali/public-api/images/buffer-image.h>
24 #include <dali/public-api/images/resource-image.h>
25 #include <dali/devel-api/images/texture-set-image.h>
28 #include <dali-toolkit/public-api/visuals/image-visual-properties.h>
29 #include <dali-toolkit/internal/visuals/visual-factory-impl.h>
30 #include <dali-toolkit/internal/visuals/visual-factory-cache.h>
31 #include <dali-toolkit/internal/visuals/visual-string-constants.h>
32 #include <dali-toolkit/internal/visuals/visual-base-impl.h>
33 #include <dali-toolkit/internal/visuals/visual-base-data-impl.h>
47 const char * const BORDER_ONLY("borderOnly");
49 const char* VERTEX_SHADER = DALI_COMPOSE_SHADER(
50 attribute mediump vec2 aPosition;\n
51 varying mediump vec2 vTexCoord;\n
52 uniform mediump mat4 uMvpMatrix;\n
53 uniform mediump vec3 uSize;\n
54 uniform mediump vec2 uNinePatchFactorsX[ FACTOR_SIZE_X ];\n
55 uniform mediump vec2 uNinePatchFactorsY[ FACTOR_SIZE_Y ];\n
59 mediump vec2 fixedFactor = vec2( uNinePatchFactorsX[ int( ( aPosition.x + 1.0 ) * 0.5 ) ].x, uNinePatchFactorsY[ int( ( aPosition.y + 1.0 ) * 0.5 ) ].x );\n
60 mediump vec2 stretch = vec2( uNinePatchFactorsX[ int( ( aPosition.x ) * 0.5 ) ].y, uNinePatchFactorsY[ int( ( aPosition.y ) * 0.5 ) ].y );\n
62 mediump vec2 fixedTotal = vec2( uNinePatchFactorsX[ FACTOR_SIZE_X - 1 ].x, uNinePatchFactorsY[ FACTOR_SIZE_Y - 1 ].x );\n
63 mediump vec2 stretchTotal = vec2( uNinePatchFactorsX[ FACTOR_SIZE_X - 1 ].y, uNinePatchFactorsY[ FACTOR_SIZE_Y - 1 ].y );\n
65 mediump vec4 vertexPosition = vec4( ( fixedFactor + ( uSize.xy - fixedTotal ) * stretch / stretchTotal ), 0.0, 1.0 );\n
66 vertexPosition.xy -= uSize.xy * vec2( 0.5, 0.5 );\n
67 vertexPosition = uMvpMatrix * vertexPosition;\n
69 vTexCoord = ( fixedFactor + stretch ) / ( fixedTotal + stretchTotal );\n
71 gl_Position = vertexPosition;\n
75 const char* VERTEX_SHADER_3X3 = DALI_COMPOSE_SHADER(
76 attribute mediump vec2 aPosition;\n
77 varying mediump vec2 vTexCoord;\n
78 uniform mediump mat4 uModelMatrix;\n
79 uniform mediump mat4 uMvpMatrix;\n
80 uniform mediump vec3 uSize;\n
81 uniform mediump vec2 uFixed[ 3 ];\n
82 uniform mediump vec2 uStretchTotal;\n
86 mediump vec2 scale = vec2( length( uModelMatrix[ 0 ].xyz ), length( uModelMatrix[ 1 ].xyz ) );\n
87 mediump vec2 size = uSize.xy * scale;\n
89 mediump vec2 fixedFactor = vec2( uFixed[ int( ( aPosition.x + 1.0 ) * 0.5 ) ].x, uFixed[ int( ( aPosition.y + 1.0 ) * 0.5 ) ].y );\n
90 mediump vec2 stretch = floor( aPosition * 0.5 );\n
91 mediump vec2 fixedTotal = uFixed[ 2 ];\n
93 mediump vec4 vertexPosition = vec4( fixedFactor + ( size - fixedTotal ) * stretch, 0.0, 1.0 );\n
94 vertexPosition.xy -= size * vec2( 0.5, 0.5 );\n
95 vertexPosition.xy = vertexPosition.xy / scale;\n
97 vertexPosition = uMvpMatrix * vertexPosition;\n
99 vTexCoord = ( fixedFactor + stretch * uStretchTotal ) / ( fixedTotal + uStretchTotal );\n
101 gl_Position = vertexPosition;\n
105 const char* FRAGMENT_SHADER = DALI_COMPOSE_SHADER(
106 varying mediump vec2 vTexCoord;\n
107 uniform sampler2D sTexture;\n
108 uniform lowp vec4 uColor;\n
112 gl_FragColor = texture2D( sTexture, vTexCoord ) * uColor;\n
117 * @brief Creates the geometry formed from the vertices and indices
119 * @param[in] vertices The vertices to generate the geometry from
120 * @param[in] indices The indices to generate the geometry from
121 * @return The geometry formed from the vertices and indices
123 Geometry GenerateGeometry( const Vector< Vector2 >& vertices, const Vector< unsigned short >& indices )
125 Property::Map vertexFormat;
126 vertexFormat[ "aPosition" ] = Property::VECTOR2;
127 PropertyBuffer vertexPropertyBuffer = PropertyBuffer::New( vertexFormat );
128 if( vertices.Size() > 0 )
130 vertexPropertyBuffer.SetData( &vertices[ 0 ], vertices.Size() );
133 // Create the geometry object
134 Geometry geometry = Geometry::New();
135 geometry.AddVertexBuffer( vertexPropertyBuffer );
136 if( indices.Size() > 0 )
138 geometry.SetIndexBuffer( &indices[ 0 ], indices.Size() );
146 * @brief Adds the indices to form a quad composed off two triangles where the indices are organised in a grid
148 * @param[out] indices The indices to add to
149 * @param[in] rowIdx The row index to start the quad
150 * @param[in] nextRowIdx The index to the next row
152 void AddQuadIndices( Vector< unsigned short >& indices, unsigned int rowIdx, unsigned int nextRowIdx )
154 indices.PushBack( rowIdx );
155 indices.PushBack( nextRowIdx + 1 );
156 indices.PushBack( rowIdx + 1 );
158 indices.PushBack( rowIdx );
159 indices.PushBack( nextRowIdx );
160 indices.PushBack( nextRowIdx + 1 );
163 void AddVertex( Vector< Vector2 >& vertices, unsigned int x, unsigned int y )
165 vertices.PushBack( Vector2( x, y ) );
168 void RegisterStretchProperties( Renderer& renderer, const char * uniformName, const NinePatchImage::StretchRanges& stretchPixels, uint16_t imageExtent)
170 uint16_t prevEnd = 0;
171 uint16_t prevFix = 0;
172 uint16_t prevStretch = 0;
174 for( NinePatchImage::StretchRanges::ConstIterator it = stretchPixels.Begin(); it != stretchPixels.End(); ++it, ++i )
176 uint16_t start = it->GetX();
177 uint16_t end = it->GetY();
179 uint16_t fix = prevFix + start - prevEnd;
180 uint16_t stretch = prevStretch + end - start;
182 std::stringstream uniform;
183 uniform << uniformName << "[" << i << "]";
184 renderer.RegisterProperty( uniform.str(), Vector2( fix, stretch ) );
188 prevStretch = stretch;
192 prevFix += imageExtent - prevEnd;
193 std::stringstream uniform;
194 uniform << uniformName << "[" << i << "]";
195 renderer.RegisterProperty( uniform.str(), Vector2( prevFix, prevStretch ) );
199 } //unnamed namespace
201 /////////////////NPatchVisual////////////////
203 NPatchVisual::NPatchVisual( VisualFactoryCache& factoryCache )
204 : Visual::Base( factoryCache ),
209 NPatchVisual::~NPatchVisual()
213 void NPatchVisual::DoInitialize( Actor& actor, const Property::Map& propertyMap )
215 Property::Value* imageURLValue = propertyMap.Find( Toolkit::ImageVisual::Property::URL, IMAGE_URL_NAME );
218 //Read the borderOnly property first since InitialiseFromImage relies on mBorderOnly to be properly set
219 Property::Value* borderOnlyValue = propertyMap.Find( Toolkit::ImageVisual::Property::BORDER_ONLY, BORDER_ONLY );
220 if( borderOnlyValue )
222 borderOnlyValue->Get( mBorderOnly );
225 if( imageURLValue->Get( mImageUrl ) )
227 NinePatchImage nPatch = NinePatchImage::New( mImageUrl );
228 InitializeFromImage( nPatch );
232 InitializeFromBrokenImage();
233 DALI_LOG_ERROR( "The property '%s' is not a string\n", IMAGE_URL_NAME );
238 void NPatchVisual::GetNaturalSize( Vector2& naturalSize ) const
242 naturalSize.x = mImage.GetWidth();
243 naturalSize.y = mImage.GetHeight();
245 else if( !mImageUrl.empty() )
247 ImageDimensions dimentions = ResourceImage::GetImageSize( mImageUrl );
248 naturalSize.x = dimentions.GetWidth();
249 naturalSize.y = dimentions.GetHeight();
253 naturalSize = Vector2::ZERO;
257 void NPatchVisual::SetClipRect( const Rect<int>& clipRect )
259 Visual::Base::SetClipRect( clipRect );
260 //ToDo: renderer responds to the clipRect change
263 void NPatchVisual::SetOffset( const Vector2& offset )
265 //ToDo: renderer applies the offset
268 Geometry NPatchVisual::CreateGeometry()
271 if( mStretchPixelsX.Size() == 1 && mStretchPixelsY.Size() == 1 )
275 geometry = mFactoryCache.GetGeometry( VisualFactoryCache::NINE_PATCH_GEOMETRY );
278 geometry = CreateGeometry( Uint16Pair( 3, 3 ) );
279 mFactoryCache.SaveGeometry( VisualFactoryCache::NINE_PATCH_GEOMETRY, geometry );
284 geometry = mFactoryCache.GetGeometry( VisualFactoryCache::NINE_PATCH_BORDER_GEOMETRY );
287 geometry = CreateGeometryBorder( Uint16Pair( 3, 3 ) );
288 mFactoryCache.SaveGeometry( VisualFactoryCache::NINE_PATCH_BORDER_GEOMETRY, geometry );
292 else if( mStretchPixelsX.Size() > 0 || mStretchPixelsY.Size() > 0)
294 Uint16Pair gridSize( 2 * mStretchPixelsX.Size() + 1, 2 * mStretchPixelsY.Size() + 1 );
295 geometry = !mBorderOnly ? CreateGeometry( gridSize ) : CreateGeometryBorder( gridSize );
301 Shader NPatchVisual::CreateShader()
304 if( !mImpl->mCustomShader )
306 if( mStretchPixelsX.Size() == 1 && mStretchPixelsY.Size() == 1 )
308 shader = mFactoryCache.GetShader( VisualFactoryCache::NINE_PATCH_SHADER );
311 shader = Shader::New( VERTEX_SHADER_3X3, FRAGMENT_SHADER );
312 mFactoryCache.SaveShader( VisualFactoryCache::NINE_PATCH_SHADER, shader );
315 else if( mStretchPixelsX.Size() > 0 || mStretchPixelsY.Size() > 0)
317 std::stringstream vertexShader;
318 vertexShader << "#define FACTOR_SIZE_X " << mStretchPixelsX.Size() + 2 << "\n"
319 << "#define FACTOR_SIZE_Y " << mStretchPixelsY.Size() + 2 << "\n"
322 shader = Shader::New( vertexShader.str(), FRAGMENT_SHADER );
327 const char* fragmentShader = FRAGMENT_SHADER;
328 Dali::Shader::Hint::Value hints = Dali::Shader::Hint::NONE;
330 if( !mImpl->mCustomShader->mFragmentShader.empty() )
332 fragmentShader = mImpl->mCustomShader->mFragmentShader.c_str();
334 hints = mImpl->mCustomShader->mHints;
336 if( mStretchPixelsX.Size() == 1 && mStretchPixelsY.Size() == 1 )
338 shader = Shader::New( VERTEX_SHADER_3X3, fragmentShader, hints );
340 else if( mStretchPixelsX.Size() > 0 || mStretchPixelsY.Size() > 0)
342 std::stringstream vertexShader;
343 vertexShader << "#define FACTOR_SIZE_X " << mStretchPixelsX.Size() + 2 << "\n"
344 << "#define FACTOR_SIZE_Y " << mStretchPixelsY.Size() + 2 << "\n"
347 shader = Shader::New( vertexShader.str(), fragmentShader, hints );
354 void NPatchVisual::InitializeRenderer()
356 Geometry geometry = CreateGeometry();
357 Shader shader = CreateShader();
359 if( !geometry || !shader )
361 DALI_LOG_ERROR("The 9 patch image '%s' doesn't have any valid stretch borders and so is not a valid 9 patch image\n", mImageUrl.c_str() );
362 InitializeFromBrokenImage();
365 TextureSet textureSet = TextureSet::New();
366 mImpl->mRenderer = Renderer::New( geometry, shader );
367 mImpl->mRenderer.SetTextures( textureSet );
371 void NPatchVisual::DoSetOnStage( Actor& actor )
375 if( !mImageUrl.empty() )
377 NinePatchImage nPatch = NinePatchImage::New( mImageUrl );
378 InitializeFromImage( nPatch );
382 InitializeFromImage( mImage );
386 //initialize the renderer after initializing from the image since we need to know the grid size from the image before creating the geometry
387 InitializeRenderer();
391 ApplyImageToSampler();
395 void NPatchVisual::DoSetOffStage( Actor& actor )
397 mCroppedImage.Reset();
398 actor.RemoveRenderer( mImpl->mRenderer );
399 mImpl->mRenderer.Reset();
402 void NPatchVisual::DoCreatePropertyMap( Property::Map& map ) const
405 map.Insert( Toolkit::Visual::Property::TYPE, Toolkit::Visual::IMAGE );
406 if( !mImageUrl.empty() )
408 map.Insert( Toolkit::ImageVisual::Property::URL, mImageUrl );
412 map.Insert( Toolkit::ImageVisual::Property::URL, mImage.GetUrl() );
414 map.Insert( Toolkit::ImageVisual::Property::BORDER_ONLY, mBorderOnly );
417 void NPatchVisual::ChangeRenderer( bool oldBorderOnly, size_t oldGridX, size_t oldGridY )
419 //check to see if the border style has changed
421 bool borderOnlyChanged = oldBorderOnly != mBorderOnly;
422 bool gridChanged = oldGridX != mStretchPixelsX.Size() || oldGridY != mStretchPixelsY.Size();
424 if( borderOnlyChanged || gridChanged )
426 Geometry geometry = CreateGeometry();
429 mImpl->mRenderer.SetGeometry( geometry );
433 InitializeFromBrokenImage();
439 Shader shader = CreateShader();
440 TextureSet textureSet;
443 textureSet = mImpl->mRenderer.GetTextures();
446 InitializeFromBrokenImage();
448 mImpl->mRenderer.SetShader( shader );
453 void NPatchVisual::SetImage( const std::string& imageUrl, bool borderOnly )
455 bool oldBorderOnly = mBorderOnly;
456 size_t oldGridX = mStretchPixelsX.Size();
457 size_t oldGridY = mStretchPixelsY.Size();
459 mBorderOnly = borderOnly;
461 if( mImageUrl == imageUrl )
466 mImageUrl = imageUrl;
467 if( mImpl->mRenderer )
469 NinePatchImage nPatch = NinePatchImage::New( mImageUrl );
470 InitializeFromImage( nPatch );
472 ChangeRenderer( oldBorderOnly, oldGridX, oldGridY );
476 ApplyImageToSampler();
481 void NPatchVisual::SetImage( NinePatchImage image, bool borderOnly )
483 bool oldBorderOnly = mBorderOnly;
484 size_t oldGridX = mStretchPixelsX.Size();
485 size_t oldGridY = mStretchPixelsY.Size();
487 mBorderOnly = borderOnly;
489 if( mImage == image )
495 if( mImpl->mRenderer )
497 InitializeFromImage( mImage );
498 ChangeRenderer( oldBorderOnly, oldGridX, oldGridY );
502 ApplyImageToSampler();
507 void NPatchVisual::InitializeFromImage( NinePatchImage nPatch )
509 mCroppedImage = nPatch.CreateCroppedBufferImage();
512 DALI_LOG_ERROR("'%s' specify a valid 9 patch image\n", mImageUrl.c_str() );
513 InitializeFromBrokenImage();
517 mImageSize = ImageDimensions( mCroppedImage.GetWidth(), mCroppedImage.GetHeight() );
519 mStretchPixelsX = nPatch.GetStretchPixelsX();
520 mStretchPixelsY = nPatch.GetStretchPixelsY();
523 void NPatchVisual::InitializeFromBrokenImage()
525 mCroppedImage = VisualFactory::GetBrokenVisualImage();
526 mImageSize = ImageDimensions( mCroppedImage.GetWidth(), mCroppedImage.GetHeight() );
528 mStretchPixelsX.Clear();
529 mStretchPixelsX.PushBack( Uint16Pair( 0, mImageSize.GetWidth() ) );
530 mStretchPixelsY.Clear();
531 mStretchPixelsY.PushBack( Uint16Pair( 0, mImageSize.GetHeight() ) );
534 void NPatchVisual::ApplyImageToSampler()
536 TextureSet textureSet = mImpl->mRenderer.GetTextures();
539 TextureSetImage( textureSet, 0u, mCroppedImage );
541 if( mStretchPixelsX.Size() == 1 && mStretchPixelsY.Size() == 1 )
543 //special case for 9 patch
544 Uint16Pair stretchX = mStretchPixelsX[ 0 ];
545 Uint16Pair stretchY = mStretchPixelsY[ 0 ];
547 uint16_t stretchWidth = stretchX.GetY() - stretchX.GetX();
548 uint16_t stretchHeight = stretchY.GetY() - stretchY.GetX();
550 mImpl->mRenderer.RegisterProperty( "uFixed[0]", Vector2::ZERO );
551 mImpl->mRenderer.RegisterProperty( "uFixed[1]", Vector2( stretchX.GetX(), stretchY.GetX()) );
552 mImpl->mRenderer.RegisterProperty( "uFixed[2]", Vector2( mImageSize.GetWidth() - stretchWidth, mImageSize.GetHeight() - stretchHeight ) );
553 mImpl->mRenderer.RegisterProperty( "uStretchTotal", Vector2( stretchWidth, stretchHeight ) );
557 mImpl->mRenderer.RegisterProperty( "uNinePatchFactorsX[0]", Vector2::ZERO );
558 mImpl->mRenderer.RegisterProperty( "uNinePatchFactorsY[0]", Vector2::ZERO );
560 RegisterStretchProperties( mImpl->mRenderer, "uNinePatchFactorsX", mStretchPixelsX, mImageSize.GetWidth() );
561 RegisterStretchProperties( mImpl->mRenderer, "uNinePatchFactorsY", mStretchPixelsY, mImageSize.GetHeight() );
566 Geometry NPatchVisual::CreateGeometry( Uint16Pair gridSize )
568 uint16_t gridWidth = gridSize.GetWidth();
569 uint16_t gridHeight = gridSize.GetHeight();
572 Vector< Vector2 > vertices;
573 vertices.Reserve( ( gridWidth + 1 ) * ( gridHeight + 1 ) );
575 for( int y = 0; y < gridHeight + 1; ++y )
577 for( int x = 0; x < gridWidth + 1; ++x )
579 AddVertex( vertices, x, y );
584 //TODO: compare performance with triangle strip when Geometry supports it
585 Vector< unsigned short > indices;
586 indices.Reserve( gridWidth * gridHeight * 6 );
588 unsigned int rowIdx = 0;
589 unsigned int nextRowIdx = gridWidth + 1;
590 for( int y = 0; y < gridHeight; ++y, ++nextRowIdx, ++rowIdx )
592 for( int x = 0; x < gridWidth; ++x, ++nextRowIdx, ++rowIdx )
594 AddQuadIndices( indices, rowIdx, nextRowIdx );
598 return GenerateGeometry( vertices, indices );
601 Geometry NPatchVisual::CreateGeometryBorder( Uint16Pair gridSize )
603 uint16_t gridWidth = gridSize.GetWidth();
604 uint16_t gridHeight = gridSize.GetHeight();
607 Vector< Vector2 > vertices;
608 vertices.Reserve( ( gridWidth + 1 ) * ( gridHeight + 1 ) );
614 for( int x = 0; x < gridWidth + 1; ++x )
616 AddVertex( vertices, x, y );
620 for(; y < gridHeight - 1; ++y)
623 AddVertex( vertices, 0, y );
624 AddVertex( vertices, 1, y );
627 AddVertex( vertices, gridWidth - 1, y );
628 AddVertex( vertices, gridWidth, y );
632 for(; y < gridHeight + 1; ++y)
634 for( int x = 0; x < gridWidth + 1; ++x )
636 AddVertex( vertices, x, y );
641 //TODO: compare performance with triangle strip when Geometry supports it
642 Vector< unsigned short > indices;
643 indices.Reserve( gridWidth * gridHeight * 6 );
646 unsigned int rowIdx = 0 ;
647 unsigned int nextRowIdx = gridWidth + 1;
648 for( int x = 0; x < gridWidth; ++x, ++nextRowIdx, ++rowIdx )
650 AddQuadIndices( indices, rowIdx, nextRowIdx );
655 rowIdx = gridWidth + 1;
656 nextRowIdx = ( gridWidth + 1 ) * 2;
658 unsigned increment = gridWidth - 1;
663 AddQuadIndices( indices, rowIdx, nextRowIdx );
665 rowIdx = gridWidth * 2;
666 nextRowIdx = ( gridWidth + 1 ) * 2 + 2;
668 AddQuadIndices( indices, rowIdx, nextRowIdx );
671 rowIdx = nextRowIdx - 2;
672 nextRowIdx = rowIdx + 4;
673 for(int y = 2; y < 2*(gridHeight - 3); ++y, rowIdx += 2, nextRowIdx += 2)
675 AddQuadIndices( indices, rowIdx, nextRowIdx );
680 AddQuadIndices( indices, rowIdx, nextRowIdx );
683 nextRowIdx += gridWidth - 1;
685 AddQuadIndices( indices, rowIdx, nextRowIdx );
689 rowIdx = nextRowIdx - gridWidth + 1;
690 nextRowIdx = rowIdx + gridWidth + 1;
691 for( int x = 0; x < gridWidth; ++x, ++nextRowIdx, ++rowIdx )
693 AddQuadIndices( indices, rowIdx, nextRowIdx );
696 return GenerateGeometry( vertices, indices );
699 } // namespace Internal
701 } // namespace Toolkit