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 "gradient-visual.h"
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>
31 #include <dali-toolkit/public-api/visuals/gradient-visual-properties.h>
32 #include <dali-toolkit/internal/visuals/visual-factory-impl.h>
33 #include <dali-toolkit/internal/visuals/visual-factory-cache.h>
34 #include <dali-toolkit/internal/visuals/visual-string-constants.h>
35 #include <dali-toolkit/internal/visuals/gradient/linear-gradient.h>
36 #include <dali-toolkit/internal/visuals/gradient/radial-gradient.h>
37 #include <dali-toolkit/internal/visuals/visual-base-data-impl.h>
50 // properties: linear gradient
51 const char * const START_POSITION_NAME("startPosition"); // Property::VECTOR2
52 const char * const END_POSITION_NAME("endPosition"); // Property::VECTOR2
54 // properties: radial gradient
55 const char * const CENTER_NAME("center"); // Property::VECTOR2
56 const char * const RADIUS_NAME("radius"); // Property::FLOAT
58 // properties: linear&radial gradient
59 const char * const STOP_OFFSET_NAME("stopOffset"); // Property::Array FLOAT
60 const char * const STOP_COLOR_NAME("stopColor"); // Property::Array VECTOR4
61 const char * const UNITS_NAME("units"); // Property::String "userSpaceOnUse | objectBoundingBox"
62 const char * const SPREAD_METHOD_NAME("spreadMethod"); // Property::String "pad | reflect | repeat"
64 DALI_ENUM_TO_STRING_TABLE_BEGIN( UNITS )
65 DALI_ENUM_TO_STRING_WITH_SCOPE( Toolkit::GradientVisual::Units, OBJECT_BOUNDING_BOX )
66 DALI_ENUM_TO_STRING_WITH_SCOPE( Toolkit::GradientVisual::Units, USER_SPACE )
67 DALI_ENUM_TO_STRING_TABLE_END( UNITS )
69 DALI_ENUM_TO_STRING_TABLE_BEGIN( SPREAD_METHOD )
70 DALI_ENUM_TO_STRING_WITH_SCOPE( Toolkit::GradientVisual::SpreadMethod, PAD )
71 DALI_ENUM_TO_STRING_WITH_SCOPE( Toolkit::GradientVisual::SpreadMethod, REFLECT )
72 DALI_ENUM_TO_STRING_WITH_SCOPE( Toolkit::GradientVisual::SpreadMethod, REPEAT )
73 DALI_ENUM_TO_STRING_TABLE_END( SPREAD_METHOD )
76 const char * const UNIFORM_ALIGNMENT_MATRIX_NAME( "uAlignmentMatrix" );
78 // default offset value
79 const unsigned int DEFAULT_OFFSET_MINIMUM = 0.0f;
80 const unsigned int DEFAULT_OFFSET_MAXIMUM = 1.0f;
82 VisualFactoryCache::ShaderType GetShaderType( GradientVisual::Type type, Toolkit::GradientVisual::Units::Type units )
84 if( type == GradientVisual::LINEAR )
86 if( units == Toolkit::GradientVisual::Units::USER_SPACE )
88 return VisualFactoryCache::GRADIENT_SHADER_LINEAR_USER_SPACE;
90 return VisualFactoryCache::GRADIENT_SHADER_LINEAR_BOUNDING_BOX;
92 else if( units == Toolkit::GradientVisual::Units::USER_SPACE )
94 return VisualFactoryCache::GRADIENT_SHADER_RADIAL_USER_SPACE;
97 return VisualFactoryCache::GRADIENT_SHADER_RADIAL_BOUNDING_BOX;
100 const char* VERTEX_SHADER[] =
102 // vertex shader for gradient units as OBJECT_BOUNDING_BOX
104 attribute mediump vec2 aPosition;\n
105 uniform mediump mat4 uMvpMatrix;\n
106 uniform mediump vec3 uSize;\n
107 uniform mediump mat3 uAlignmentMatrix;\n
108 varying mediump vec2 vTexCoord;\n
112 mediump vec4 vertexPosition = vec4(aPosition, 0.0, 1.0);\n
113 vTexCoord = (uAlignmentMatrix*vertexPosition.xyw).xy;\n
115 vertexPosition.xyz *= uSize;\n
116 gl_Position = uMvpMatrix * vertexPosition;\n
120 // vertex shader for gradient units as USER_SPACE
122 attribute mediump vec2 aPosition;\n
123 uniform mediump mat4 uMvpMatrix;\n
124 uniform mediump vec3 uSize;\n
125 uniform mediump mat3 uAlignmentMatrix;\n
126 varying mediump vec2 vTexCoord;\n
130 mediump vec4 vertexPosition = vec4(aPosition, 0.0, 1.0);\n
131 vertexPosition.xyz *= uSize;\n
132 gl_Position = uMvpMatrix * vertexPosition;\n
134 vTexCoord = (uAlignmentMatrix*vertexPosition.xyw).xy;\n
139 const char* FRAGMENT_SHADER[] =
141 // fragment shader for linear gradient
143 uniform sampler2D sTexture;\n // sampler1D?
144 uniform lowp vec4 uColor;\n
145 varying mediump vec2 vTexCoord;\n
149 gl_FragColor = texture2D( sTexture, vec2( vTexCoord.y, 0.5 ) ) * uColor;\n
153 // fragment shader for radial gradient
155 uniform sampler2D sTexture;\n // sampler1D?
156 uniform lowp vec4 uColor;\n
157 varying mediump vec2 vTexCoord;\n
161 gl_FragColor = texture2D( sTexture, vec2( length(vTexCoord), 0.5 ) ) * uColor;\n
166 Dali::WrapMode::Type GetWrapMode( Toolkit::GradientVisual::SpreadMethod::Type spread )
170 case Toolkit::GradientVisual::SpreadMethod::REPEAT:
172 return Dali::WrapMode::REPEAT;
174 case Toolkit::GradientVisual::SpreadMethod::REFLECT:
176 return Dali::WrapMode::MIRRORED_REPEAT;
178 case Toolkit::GradientVisual::SpreadMethod::PAD:
181 return Dali::WrapMode::CLAMP_TO_EDGE;
186 } // unnamed namespace
189 GradientVisual::GradientVisual( VisualFactoryCache& factoryCache )
190 : Visual::Base( factoryCache ),
191 mGradientType( LINEAR )
193 mImpl->mFlags |= Impl::IS_PREMULTIPLIED_ALPHA;
196 GradientVisual::~GradientVisual()
200 void GradientVisual::DoInitialize( Actor& actor, const Property::Map& propertyMap )
202 Toolkit::GradientVisual::Units::Type gradientUnits = Toolkit::GradientVisual::Units::OBJECT_BOUNDING_BOX;
204 Property::Value* unitsValue = propertyMap.Find( Toolkit::GradientVisual::Property::UNITS, UNITS_NAME );
207 Scripting::GetEnumerationProperty( *unitsValue, UNITS_TABLE, UNITS_TABLE_COUNT, gradientUnits );
210 mGradientType = LINEAR;
211 if( propertyMap.Find( Toolkit::GradientVisual::Property::RADIUS, RADIUS_NAME ) )
213 mGradientType = RADIAL;
216 if( NewGradient( mGradientType, propertyMap ) )
218 mGradient->SetGradientUnits( gradientUnits );
219 mGradientTransform = mGradient->GetAlignmentTransform();
223 DALI_LOG_ERROR( "Fail to provide valid properties to create a GradientVisual object\n" );
227 void GradientVisual::SetSize( const Vector2& size )
229 Visual::Base::SetSize( size );
232 void GradientVisual::SetClipRect( const Rect<int>& clipRect )
234 Visual::Base::SetClipRect( clipRect );
236 //ToDo: renderer responds to the clipRect change
239 void GradientVisual::SetOffset( const Vector2& offset )
241 //ToDo: renderer applies the offset
244 void GradientVisual::DoSetOnStage( Actor& actor )
246 InitializeRenderer();
249 void GradientVisual::DoCreatePropertyMap( Property::Map& map ) const
252 map.Insert( Toolkit::Visual::Property::TYPE, Toolkit::Visual::GRADIENT );
253 map.Insert( Toolkit::GradientVisual::Property::UNITS, mGradient->GetGradientUnits() );
254 map.Insert( Toolkit::GradientVisual::Property::SPREAD_METHOD, mGradient->GetSpreadMethod() );
256 const Vector<Gradient::GradientStop>& stops( mGradient->GetStops() );
257 Property::Array offsets;
258 Property::Array colors;
259 for( unsigned int i=0; i<stops.Count(); i++ )
261 offsets.PushBack( stops[i].mOffset );
262 if( EqualsZero(stops[i].mStopColor.a) )
264 colors.PushBack( Vector4::ZERO );
268 colors.PushBack( Vector4( stops[i].mStopColor.r / stops[i].mStopColor.a,
269 stops[i].mStopColor.g / stops[i].mStopColor.a,
270 stops[i].mStopColor.b / stops[i].mStopColor.a,
271 stops[i].mStopColor.a));
275 map.Insert( Toolkit::GradientVisual::Property::STOP_OFFSET, offsets );
276 map.Insert( Toolkit::GradientVisual::Property::STOP_COLOR, colors );
278 if( &typeid( *mGradient ) == &typeid(LinearGradient) )
280 LinearGradient* gradient = static_cast<LinearGradient*>( mGradient.Get() );
281 map.Insert( Toolkit::GradientVisual::Property::START_POSITION, gradient->GetStartPosition() );
282 map.Insert( Toolkit::GradientVisual::Property::END_POSITION, gradient->GetEndPosition() );
284 else // if( &typeid( *mGradient ) == &typeid(RadialGradient) )
286 RadialGradient* gradient = static_cast<RadialGradient*>( mGradient.Get() );
287 map.Insert( Toolkit::GradientVisual::Property::CENTER, gradient->GetCenter() );
288 map.Insert( Toolkit::GradientVisual::Property::RADIUS, gradient->GetRadius() );
292 void GradientVisual::InitializeRenderer()
294 Geometry geometry = mFactoryCache.GetGeometry( VisualFactoryCache::QUAD_GEOMETRY );
297 geometry = VisualFactoryCache::CreateQuadGeometry();
298 mFactoryCache.SaveGeometry( VisualFactoryCache::QUAD_GEOMETRY, geometry );
301 Toolkit::GradientVisual::Units::Type gradientUnits = mGradient->GetGradientUnits();
302 VisualFactoryCache::ShaderType shaderType = GetShaderType( mGradientType, gradientUnits );
303 Shader shader = mFactoryCache.GetShader( shaderType );
306 shader = Shader::New( VERTEX_SHADER[gradientUnits], FRAGMENT_SHADER[ mGradientType ] );
307 mFactoryCache.SaveShader( shaderType, shader );
310 //Set up the texture set
311 TextureSet textureSet = TextureSet::New();
312 Dali::Texture lookupTexture = mGradient->GenerateLookupTexture();
313 textureSet.SetTexture( 0u, lookupTexture );
314 Dali::WrapMode::Type wrap = GetWrapMode( mGradient->GetSpreadMethod() );
315 Sampler sampler = Sampler::New();
316 sampler.SetWrapMode( wrap, wrap );
317 textureSet.SetSampler( 0u, sampler );
319 mImpl->mRenderer = Renderer::New( geometry, shader );
320 mImpl->mRenderer.SetTextures( textureSet );
322 mImpl->mRenderer.RegisterProperty( UNIFORM_ALIGNMENT_MATRIX_NAME, mGradientTransform );
325 bool GradientVisual::NewGradient(Type gradientType, const Property::Map& propertyMap)
327 if( gradientType == LINEAR )
329 Property::Value* startPositionValue = propertyMap.Find( Toolkit::GradientVisual::Property::START_POSITION, START_POSITION_NAME );
330 Property::Value* endPositionValue = propertyMap.Find( Toolkit::GradientVisual::Property::END_POSITION, END_POSITION_NAME );
331 Vector2 startPosition;
334 if( startPositionValue && startPositionValue->Get(startPosition)
335 && endPositionValue && endPositionValue->Get( endPosition ) )
337 mGradient = new LinearGradient( startPosition, endPosition );
346 Property::Value* centerValue = propertyMap.Find( Toolkit::GradientVisual::Property::CENTER, CENTER_NAME );
347 Property::Value* radiusValue = propertyMap.Find( Toolkit::GradientVisual::Property::RADIUS, RADIUS_NAME );
350 if( centerValue && centerValue->Get(center)
351 && radiusValue && radiusValue->Get(radius) )
353 mGradient = new RadialGradient( center, radius );
361 unsigned int numValidStop = 0u;
362 Property::Value* stopOffsetValue = propertyMap.Find( Toolkit::GradientVisual::Property::STOP_OFFSET, STOP_OFFSET_NAME );
363 Property::Value* stopColorValue = propertyMap.Find( Toolkit::GradientVisual::Property::STOP_COLOR, STOP_COLOR_NAME );
366 Vector<float> offsetArray;
367 Property::Array* colorArray = stopColorValue->GetArray();
370 GetStopOffsets( stopOffsetValue, offsetArray );
371 unsigned int numStop = offsetArray.Count() < colorArray->Count() ?
372 offsetArray.Count() : colorArray->Count();
374 for( unsigned int i=0; i<numStop; i++ )
376 if( (colorArray->GetElementAt(i)).Get(color) )
378 mGradient->AddStop( offsetArray[i], Vector4(color.r*color.a, color.g*color.a, color.b*color.a, color.a));
385 if( numValidStop < 1u ) // no valid stop
390 Property::Value* spread = propertyMap.Find( Toolkit::GradientVisual::Property::SPREAD_METHOD, SPREAD_METHOD_NAME );
391 // The default spread method is PAD. Only need to set new spread if it's anything else.
394 Toolkit::GradientVisual::SpreadMethod::Type spreadMethod = Toolkit::GradientVisual::SpreadMethod::PAD;
395 if( Scripting::GetEnumerationProperty( *spread, SPREAD_METHOD_TABLE, SPREAD_METHOD_TABLE_COUNT, spreadMethod ) );
397 mGradient->SetSpreadMethod( spreadMethod );
404 void GradientVisual::GetStopOffsets(const Property::Value* value, Vector<float>& stopOffsets)
407 if ( value ) // Only check valve type if a valid Property has been passed in
409 switch ( value->GetType() )
411 case Property::VECTOR2:
414 value->Get( offset2 );
415 stopOffsets.PushBack( offset2.x );
416 stopOffsets.PushBack( offset2.y );
419 case Property::VECTOR3:
422 value->Get( offset3 );
423 stopOffsets.PushBack( offset3.x );
424 stopOffsets.PushBack( offset3.y );
425 stopOffsets.PushBack( offset3.z );
428 case Property::VECTOR4:
431 value->Get( offset4 );
432 stopOffsets.PushBack( offset4.x );
433 stopOffsets.PushBack( offset4.y );
434 stopOffsets.PushBack( offset4.z );
435 stopOffsets.PushBack( offset4.w );
438 case Property::ARRAY:
440 Property::Array* offsetArray = value->GetArray();
443 unsigned int numStop = offsetArray->Count();
445 for( unsigned int i=0; i<numStop; i++ )
447 if( offsetArray->GetElementAt(i).Get(offset) )
449 stopOffsets.PushBack( offset );
457 DALI_LOG_WARNING("GetStopOffsets passed unsupported Property Map\n");
463 if ( stopOffsets.Empty() )
465 // Set default offset if none set by Property system, need a minimum and maximum
466 stopOffsets.PushBack( DEFAULT_OFFSET_MINIMUM );
467 stopOffsets.PushBack( DEFAULT_OFFSET_MAXIMUM );
471 } // namespace Internal
473 } // namespace Toolkit