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/devel-api/visual-factory/devel-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>
51 // properties: linear gradient
52 const char * const START_POSITION_NAME("startPosition"); // Property::VECTOR2
53 const char * const END_POSITION_NAME("endPosition"); // Property::VECTOR2
55 // properties: radial gradient
56 const char * const CENTER_NAME("center"); // Property::VECTOR2
57 const char * const RADIUS_NAME("radius"); // Property::FLOAT
59 // properties: linear&radial gradient
60 const char * const STOP_OFFSET_NAME("stopOffset"); // Property::Array FLOAT
61 const char * const STOP_COLOR_NAME("stopColor"); // Property::Array VECTOR4
62 const char * const UNITS_NAME("units"); // Property::String "userSpaceOnUse | objectBoundingBox"
63 const char * const SPREAD_METHOD_NAME("spreadMethod"); // Property::String "pad | reflect | repeat"
65 DALI_ENUM_TO_STRING_TABLE_BEGIN( UNITS )
66 DALI_ENUM_TO_STRING_WITH_SCOPE( Toolkit::GradientVisual::Units, OBJECT_BOUNDING_BOX )
67 DALI_ENUM_TO_STRING_WITH_SCOPE( Toolkit::GradientVisual::Units, USER_SPACE )
68 DALI_ENUM_TO_STRING_TABLE_END( UNITS )
70 DALI_ENUM_TO_STRING_TABLE_BEGIN( SPREAD_METHOD )
71 DALI_ENUM_TO_STRING_WITH_SCOPE( Toolkit::GradientVisual::SpreadMethod, PAD )
72 DALI_ENUM_TO_STRING_WITH_SCOPE( Toolkit::GradientVisual::SpreadMethod, REFLECT )
73 DALI_ENUM_TO_STRING_WITH_SCOPE( Toolkit::GradientVisual::SpreadMethod, REPEAT )
74 DALI_ENUM_TO_STRING_TABLE_END( SPREAD_METHOD )
77 const char * const UNIFORM_ALIGNMENT_MATRIX_NAME( "uAlignmentMatrix" );
79 // default offset value
80 const unsigned int DEFAULT_OFFSET_MINIMUM = 0.0f;
81 const unsigned int DEFAULT_OFFSET_MAXIMUM = 1.0f;
83 VisualFactoryCache::ShaderType GetShaderType( GradientVisual::Type type, Toolkit::GradientVisual::Units::Type units )
85 if( type == GradientVisual::LINEAR )
87 if( units == Toolkit::GradientVisual::Units::USER_SPACE )
89 return VisualFactoryCache::GRADIENT_SHADER_LINEAR_USER_SPACE;
91 return VisualFactoryCache::GRADIENT_SHADER_LINEAR_BOUNDING_BOX;
93 else if( units == Toolkit::GradientVisual::Units::USER_SPACE )
95 return VisualFactoryCache::GRADIENT_SHADER_RADIAL_USER_SPACE;
98 return VisualFactoryCache::GRADIENT_SHADER_RADIAL_BOUNDING_BOX;
101 const char* VERTEX_SHADER[] =
103 // vertex shader for gradient units as OBJECT_BOUNDING_BOX
105 attribute mediump vec2 aPosition;\n
106 uniform mediump mat4 uMvpMatrix;\n
107 uniform mediump vec3 uSize;\n
108 uniform mediump mat3 uAlignmentMatrix;\n
109 varying mediump vec2 vTexCoord;\n
113 mediump vec4 vertexPosition = vec4(aPosition, 0.0, 1.0);\n
114 vTexCoord = (uAlignmentMatrix*vertexPosition.xyw).xy;\n
116 vertexPosition.xyz *= uSize;\n
117 gl_Position = uMvpMatrix * vertexPosition;\n
121 // vertex shader for gradient units as USER_SPACE
123 attribute mediump vec2 aPosition;\n
124 uniform mediump mat4 uMvpMatrix;\n
125 uniform mediump vec3 uSize;\n
126 uniform mediump mat3 uAlignmentMatrix;\n
127 varying mediump vec2 vTexCoord;\n
131 mediump vec4 vertexPosition = vec4(aPosition, 0.0, 1.0);\n
132 vertexPosition.xyz *= uSize;\n
133 gl_Position = uMvpMatrix * vertexPosition;\n
135 vTexCoord = (uAlignmentMatrix*vertexPosition.xyw).xy;\n
140 const char* FRAGMENT_SHADER[] =
142 // fragment shader for linear gradient
144 uniform sampler2D sTexture;\n // sampler1D?
145 uniform lowp vec4 uColor;\n
146 varying mediump vec2 vTexCoord;\n
150 gl_FragColor = texture2D( sTexture, vec2( vTexCoord.y, 0.5 ) ) * uColor;\n
154 // fragment shader for radial gradient
156 uniform sampler2D sTexture;\n // sampler1D?
157 uniform lowp vec4 uColor;\n
158 varying mediump vec2 vTexCoord;\n
162 gl_FragColor = texture2D( sTexture, vec2( length(vTexCoord), 0.5 ) ) * uColor;\n
167 Dali::WrapMode::Type GetWrapMode( Toolkit::GradientVisual::SpreadMethod::Type spread )
171 case Toolkit::GradientVisual::SpreadMethod::REPEAT:
173 return Dali::WrapMode::REPEAT;
175 case Toolkit::GradientVisual::SpreadMethod::REFLECT:
177 return Dali::WrapMode::MIRRORED_REPEAT;
179 case Toolkit::GradientVisual::SpreadMethod::PAD:
182 return Dali::WrapMode::CLAMP_TO_EDGE;
187 } // unnamed namespace
189 GradientVisualPtr GradientVisual::New( VisualFactoryCache& factoryCache )
191 return new GradientVisual( factoryCache );
194 GradientVisual::GradientVisual( VisualFactoryCache& factoryCache )
195 : Visual::Base( factoryCache ),
196 mGradientType( LINEAR )
198 mImpl->mFlags |= Impl::IS_PREMULTIPLIED_ALPHA;
201 GradientVisual::~GradientVisual()
205 void GradientVisual::DoSetProperties( const Property::Map& propertyMap )
207 Toolkit::GradientVisual::Units::Type gradientUnits = Toolkit::GradientVisual::Units::OBJECT_BOUNDING_BOX;
209 Property::Value* unitsValue = propertyMap.Find( Toolkit::GradientVisual::Property::UNITS, UNITS_NAME );
212 Scripting::GetEnumerationProperty( *unitsValue, UNITS_TABLE, UNITS_TABLE_COUNT, gradientUnits );
215 mGradientType = LINEAR;
216 if( propertyMap.Find( Toolkit::GradientVisual::Property::RADIUS, RADIUS_NAME ) )
218 mGradientType = RADIAL;
221 if( NewGradient( mGradientType, propertyMap ) )
223 mGradient->SetGradientUnits( gradientUnits );
224 mGradientTransform = mGradient->GetAlignmentTransform();
228 DALI_LOG_ERROR( "Fail to provide valid properties to create a GradientVisual object\n" );
232 void GradientVisual::SetSize( const Vector2& size )
234 Visual::Base::SetSize( size );
237 void GradientVisual::DoSetOnStage( Actor& actor )
239 InitializeRenderer();
241 actor.AddRenderer( mImpl->mRenderer );
244 void GradientVisual::DoCreatePropertyMap( Property::Map& map ) const
247 map.Insert( Toolkit::VisualProperty::TYPE, Toolkit::Visual::GRADIENT );
248 map.Insert( Toolkit::GradientVisual::Property::UNITS, mGradient->GetGradientUnits() );
249 map.Insert( Toolkit::GradientVisual::Property::SPREAD_METHOD, mGradient->GetSpreadMethod() );
251 const Vector<Gradient::GradientStop>& stops( mGradient->GetStops() );
252 Property::Array offsets;
253 Property::Array colors;
254 for( unsigned int i=0; i<stops.Count(); i++ )
256 offsets.PushBack( stops[i].mOffset );
257 if( EqualsZero(stops[i].mStopColor.a) )
259 colors.PushBack( Vector4::ZERO );
263 colors.PushBack( Vector4( stops[i].mStopColor.r / stops[i].mStopColor.a,
264 stops[i].mStopColor.g / stops[i].mStopColor.a,
265 stops[i].mStopColor.b / stops[i].mStopColor.a,
266 stops[i].mStopColor.a));
270 map.Insert( Toolkit::GradientVisual::Property::STOP_OFFSET, offsets );
271 map.Insert( Toolkit::GradientVisual::Property::STOP_COLOR, colors );
273 if( &typeid( *mGradient ) == &typeid(LinearGradient) )
275 LinearGradient* gradient = static_cast<LinearGradient*>( mGradient.Get() );
276 map.Insert( Toolkit::GradientVisual::Property::START_POSITION, gradient->GetStartPosition() );
277 map.Insert( Toolkit::GradientVisual::Property::END_POSITION, gradient->GetEndPosition() );
279 else // if( &typeid( *mGradient ) == &typeid(RadialGradient) )
281 RadialGradient* gradient = static_cast<RadialGradient*>( mGradient.Get() );
282 map.Insert( Toolkit::GradientVisual::Property::CENTER, gradient->GetCenter() );
283 map.Insert( Toolkit::GradientVisual::Property::RADIUS, gradient->GetRadius() );
287 void GradientVisual::DoSetProperty( Dali::Property::Index index, const Dali::Property::Value& propertyValue )
292 Dali::Property::Value GradientVisual::DoGetProperty( Dali::Property::Index index )
295 return Dali::Property::Value();
298 void GradientVisual::InitializeRenderer()
300 Geometry geometry = mFactoryCache.GetGeometry( VisualFactoryCache::QUAD_GEOMETRY );
303 geometry = VisualFactoryCache::CreateQuadGeometry();
304 mFactoryCache.SaveGeometry( VisualFactoryCache::QUAD_GEOMETRY, geometry );
307 Toolkit::GradientVisual::Units::Type gradientUnits = mGradient->GetGradientUnits();
308 VisualFactoryCache::ShaderType shaderType = GetShaderType( mGradientType, gradientUnits );
309 Shader shader = mFactoryCache.GetShader( shaderType );
312 shader = Shader::New( VERTEX_SHADER[gradientUnits], FRAGMENT_SHADER[ mGradientType ] );
313 mFactoryCache.SaveShader( shaderType, shader );
316 //Set up the texture set
317 TextureSet textureSet = TextureSet::New();
318 Dali::Texture lookupTexture = mGradient->GenerateLookupTexture();
319 textureSet.SetTexture( 0u, lookupTexture );
320 Dali::WrapMode::Type wrap = GetWrapMode( mGradient->GetSpreadMethod() );
321 Sampler sampler = Sampler::New();
322 sampler.SetWrapMode( wrap, wrap );
323 textureSet.SetSampler( 0u, sampler );
325 mImpl->mRenderer = Renderer::New( geometry, shader );
326 mImpl->mRenderer.SetTextures( textureSet );
328 mImpl->mRenderer.RegisterProperty( UNIFORM_ALIGNMENT_MATRIX_NAME, mGradientTransform );
331 bool GradientVisual::NewGradient(Type gradientType, const Property::Map& propertyMap)
333 if( gradientType == LINEAR )
335 Property::Value* startPositionValue = propertyMap.Find( Toolkit::GradientVisual::Property::START_POSITION, START_POSITION_NAME );
336 Property::Value* endPositionValue = propertyMap.Find( Toolkit::GradientVisual::Property::END_POSITION, END_POSITION_NAME );
337 Vector2 startPosition;
340 if( startPositionValue && startPositionValue->Get(startPosition)
341 && endPositionValue && endPositionValue->Get( endPosition ) )
343 mGradient = new LinearGradient( startPosition, endPosition );
352 Property::Value* centerValue = propertyMap.Find( Toolkit::GradientVisual::Property::CENTER, CENTER_NAME );
353 Property::Value* radiusValue = propertyMap.Find( Toolkit::GradientVisual::Property::RADIUS, RADIUS_NAME );
356 if( centerValue && centerValue->Get(center)
357 && radiusValue && radiusValue->Get(radius) )
359 mGradient = new RadialGradient( center, radius );
367 unsigned int numValidStop = 0u;
368 Property::Value* stopOffsetValue = propertyMap.Find( Toolkit::GradientVisual::Property::STOP_OFFSET, STOP_OFFSET_NAME );
369 Property::Value* stopColorValue = propertyMap.Find( Toolkit::GradientVisual::Property::STOP_COLOR, STOP_COLOR_NAME );
372 Vector<float> offsetArray;
373 Property::Array* colorArray = stopColorValue->GetArray();
376 GetStopOffsets( stopOffsetValue, offsetArray );
377 unsigned int numStop = offsetArray.Count() < colorArray->Count() ?
378 offsetArray.Count() : colorArray->Count();
380 for( unsigned int i=0; i<numStop; i++ )
382 if( (colorArray->GetElementAt(i)).Get(color) )
384 mGradient->AddStop( offsetArray[i], Vector4(color.r*color.a, color.g*color.a, color.b*color.a, color.a));
391 if( numValidStop < 1u ) // no valid stop
396 Property::Value* spread = propertyMap.Find( Toolkit::GradientVisual::Property::SPREAD_METHOD, SPREAD_METHOD_NAME );
397 // The default spread method is PAD. Only need to set new spread if it's anything else.
400 Toolkit::GradientVisual::SpreadMethod::Type spreadMethod = Toolkit::GradientVisual::SpreadMethod::PAD;
401 if( Scripting::GetEnumerationProperty( *spread, SPREAD_METHOD_TABLE, SPREAD_METHOD_TABLE_COUNT, spreadMethod ) );
403 mGradient->SetSpreadMethod( spreadMethod );
410 void GradientVisual::GetStopOffsets(const Property::Value* value, Vector<float>& stopOffsets)
413 if ( value ) // Only check valve type if a valid Property has been passed in
415 switch ( value->GetType() )
417 case Property::VECTOR2:
420 value->Get( offset2 );
421 stopOffsets.PushBack( offset2.x );
422 stopOffsets.PushBack( offset2.y );
425 case Property::VECTOR3:
428 value->Get( offset3 );
429 stopOffsets.PushBack( offset3.x );
430 stopOffsets.PushBack( offset3.y );
431 stopOffsets.PushBack( offset3.z );
434 case Property::VECTOR4:
437 value->Get( offset4 );
438 stopOffsets.PushBack( offset4.x );
439 stopOffsets.PushBack( offset4.y );
440 stopOffsets.PushBack( offset4.z );
441 stopOffsets.PushBack( offset4.w );
444 case Property::ARRAY:
446 Property::Array* offsetArray = value->GetArray();
449 unsigned int numStop = offsetArray->Count();
451 for( unsigned int i=0; i<numStop; i++ )
453 if( offsetArray->GetElementAt(i).Get(offset) )
455 stopOffsets.PushBack( offset );
463 DALI_LOG_WARNING("GetStopOffsets passed unsupported Property Map\n");
469 if ( stopOffsets.Empty() )
471 // Set default offset if none set by Property system, need a minimum and maximum
472 stopOffsets.PushBack( DEFAULT_OFFSET_MINIMUM );
473 stopOffsets.PushBack( DEFAULT_OFFSET_MAXIMUM );
477 } // namespace Internal
479 } // namespace Toolkit