2 * Copyright (c) 2018 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 "visual-base-impl.h"
22 #include <dali-toolkit/public-api/dali-toolkit-common.h>
23 #include <dali/devel-api/object/handle-devel.h>
24 #include <dali/devel-api/scripting/enum-helper.h>
25 #include <dali/devel-api/rendering/renderer-devel.h>
26 #include <dali/integration-api/debug.h>
29 #include <dali-toolkit/public-api/visuals/color-visual-properties.h>
30 #include <dali-toolkit/public-api/visuals/primitive-visual-properties.h>
31 #include <dali-toolkit/public-api/visuals/visual-properties.h>
32 #include <dali-toolkit/devel-api/visuals/visual-properties-devel.h>
33 #include <dali-toolkit/internal/helpers/property-helper.h>
34 #include <dali-toolkit/internal/visuals/visual-base-data-impl.h>
35 #include <dali-toolkit/internal/visuals/visual-string-constants.h>
39 #if defined(DEBUG_ENABLED)
40 Debug::Filter* gVisualBaseLogFilter = Debug::Filter::New( Debug::NoLogging, false, "LOG_VISUAL_BASE" );
43 const char * const PRE_MULTIPLIED_ALPHA_PROPERTY( "preMultipliedAlpha" );
59 DALI_ENUM_TO_STRING_TABLE_BEGIN( VISUAL_FITTING_MODE )
60 DALI_ENUM_TO_STRING_WITH_SCOPE( Visual::FittingMode, FIT_KEEP_ASPECT_RATIO )
61 DALI_ENUM_TO_STRING_WITH_SCOPE( Visual::FittingMode, FILL )
62 DALI_ENUM_TO_STRING_TABLE_END( VISUAL_FITTING_MODE )
66 Visual::Base::Base( VisualFactoryCache& factoryCache, FittingMode fittingMode )
67 : mImpl( new Impl(fittingMode) ),
68 mFactoryCache( factoryCache )
77 void Visual::Base::SetCustomShader( const Property::Map& shaderMap )
79 if( mImpl->mCustomShader )
81 mImpl->mCustomShader->SetPropertyMap( shaderMap );
85 mImpl->mCustomShader = new Impl::CustomShader( shaderMap );
89 void Visual::Base::SetProperties( const Property::Map& propertyMap )
91 for( size_t i = 0; i < propertyMap.Count(); ++i )
93 const KeyValuePair& pair = propertyMap.GetKeyValue( i );
94 const Property::Key& key = pair.first;
95 const Property::Value& value = pair.second;
97 Property::Key matchKey = key;
98 if( matchKey.type == Property::Key::STRING )
100 if( matchKey == CUSTOM_SHADER )
102 matchKey = Property::Key( Toolkit::Visual::Property::SHADER );
104 else if( matchKey == TRANSFORM )
106 matchKey = Property::Key( Toolkit::Visual::Property::TRANSFORM );
108 else if( matchKey == PREMULTIPLIED_ALPHA )
110 matchKey = Property::Key( Toolkit::Visual::Property::PREMULTIPLIED_ALPHA );
112 else if( matchKey == MIX_COLOR )
114 matchKey = Property::Key( Toolkit::Visual::Property::MIX_COLOR );
116 else if( matchKey == OPACITY )
118 matchKey = Property::Key( Toolkit::Visual::Property::OPACITY );
120 else if( matchKey == VISUAL_FITTING_MODE )
122 matchKey = Property::Key( Toolkit::DevelVisual::Property::VISUAL_FITTING_MODE );
124 else if( matchKey == CORNER_RADIUS )
126 matchKey = Property::Key( Toolkit::DevelVisual::Property::CORNER_RADIUS );
130 switch( matchKey.indexKey )
132 case Toolkit::Visual::Property::SHADER:
134 Property::Map shaderMap;
135 if( value.Get( shaderMap ) )
137 SetCustomShader( shaderMap );
142 case Toolkit::Visual::Property::TRANSFORM:
145 if( value.Get( map ) )
147 mImpl->mTransform.SetPropertyMap( map );
152 case Toolkit::Visual::Property::PREMULTIPLIED_ALPHA:
154 bool premultipliedAlpha = false;
155 if( value.Get( premultipliedAlpha ) )
157 EnablePreMultipliedAlpha( premultipliedAlpha );
162 case Toolkit::Visual::Property::MIX_COLOR:
165 if( value.Get( mixColor ) )
167 if( value.GetType() == Property::VECTOR4 )
169 SetMixColor( mixColor );
173 Vector3 mixColor3(mixColor);
174 SetMixColor( mixColor3 );
179 case Toolkit::Visual::Property::OPACITY:
182 if( value.Get( opacity ) )
184 mImpl->mMixColor.a = opacity;
185 SetMixColor( mImpl->mMixColor );
189 case Toolkit::DevelVisual::Property::VISUAL_FITTING_MODE:
191 Scripting::GetEnumerationProperty< Visual::FittingMode >(
192 value, VISUAL_FITTING_MODE_TABLE, VISUAL_FITTING_MODE_TABLE_COUNT, mImpl->mFittingMode );
195 case Toolkit::DevelVisual::Property::CORNER_RADIUS:
198 if( value.Get( radius ) )
200 mImpl->mCornerRadius = radius;
207 DoSetProperties( propertyMap );
210 void Visual::Base::SetTransformAndSize( const Property::Map& transform, Size controlSize )
212 mImpl->mControlSize = controlSize;
213 mImpl->mTransform.UpdatePropertyMap( transform );
215 #if defined(DEBUG_ENABLED)
216 std::ostringstream oss;
218 DALI_LOG_INFO( gVisualBaseLogFilter, Debug::General, "Visual::Base::SetTransformAndSize(%s) - [\e[1;32mtransform: %s controlSize: (%3.1f, %3.1f)]\e[0m\n",
219 GetName().c_str(), oss.str().c_str(), controlSize.x, controlSize.y );
225 void Visual::Base::SetName( const std::string& name )
230 const std::string& Visual::Base::GetName() const
235 float Visual::Base::GetHeightForWidth( float width )
237 float aspectCorrectedHeight = 0.f;
239 GetNaturalSize( naturalSize );
240 if( naturalSize.width )
242 aspectCorrectedHeight = naturalSize.height * width / naturalSize.width;
244 return aspectCorrectedHeight;
247 float Visual::Base::GetWidthForHeight( float height )
249 float aspectCorrectedWidth = 0.f;
251 GetNaturalSize( naturalSize );
252 if( naturalSize.height > 0.0f )
254 aspectCorrectedWidth = naturalSize.width * height / naturalSize.height;
256 return aspectCorrectedWidth;
259 void Visual::Base::GetNaturalSize( Vector2& naturalSize )
261 naturalSize = Vector2::ZERO;
264 void Visual::Base::DoAction( const Property::Index actionId, const Property::Value attributes )
266 OnDoAction( actionId, attributes );
269 void Visual::Base::SetDepthIndex( int index )
271 mImpl->mDepthIndex = index;
272 if( mImpl->mRenderer )
274 mImpl->mRenderer.SetProperty( Renderer::Property::DEPTH_INDEX, mImpl->mDepthIndex );
278 int Visual::Base::GetDepthIndex() const
280 return mImpl->mDepthIndex;
283 void Visual::Base::SetOnStage( Actor& actor )
287 // To display the actor correctly, renderer should not be added to actor until all required resources are ready.
288 // Thus the calling of actor.AddRenderer() should happen inside derived class as base class does not know the exact timing.
289 DoSetOnStage( actor );
291 if( mImpl->mRenderer )
295 if( IsRoundedCornerRequired() )
297 mImpl->mCornerRadiusIndex = mImpl->mRenderer.RegisterProperty( CORNER_RADIUS, mImpl->mCornerRadius );
299 mImpl->mRenderer.SetProperty( Renderer::Property::BLEND_MODE, BlendMode::ON );
302 mImpl->mRenderer.SetProperty( Renderer::Property::BLEND_PRE_MULTIPLIED_ALPHA, IsPreMultipliedAlphaEnabled());
303 mImpl->mRenderer.SetProperty( Renderer::Property::DEPTH_INDEX, mImpl->mDepthIndex );
304 mImpl->mFlags |= Impl::IS_ON_STAGE; // Only sets the flag if renderer exists
309 void Visual::Base::SetOffStage( Actor& actor )
313 DoSetOffStage( actor );
314 mImpl->mMixColorIndex = Property::INVALID_INDEX;
315 mImpl->mCornerRadiusIndex = Property::INVALID_INDEX;
316 mImpl->mFlags &= ~Impl::IS_ON_STAGE;
320 void Visual::Base::CreatePropertyMap( Property::Map& map ) const
322 DoCreatePropertyMap( map );
324 if( mImpl->mCustomShader )
326 mImpl->mCustomShader->CreatePropertyMap( map );
329 Property::Map transform;
330 mImpl->mTransform.GetPropertyMap( transform );
331 map.Insert( Toolkit::Visual::Property::TRANSFORM, transform );
333 bool premultipliedAlpha( IsPreMultipliedAlphaEnabled() );
334 map.Insert( Toolkit::Visual::Property::PREMULTIPLIED_ALPHA, premultipliedAlpha );
336 // Note, Color and Primitive will also insert their own mix color into the map
337 // which is ok, because they have a different key value range.
338 map.Insert( Toolkit::Visual::Property::MIX_COLOR, mImpl->mMixColor ); // vec4
339 map.Insert( Toolkit::Visual::Property::OPACITY, mImpl->mMixColor.a );
340 map.Insert( Toolkit::ImageVisual::Property::SYNCHRONOUS_LOADING, IsSynchronousLoadingRequired() );
342 auto fittingModeString = Scripting::GetLinearEnumerationName< FittingMode >(
343 mImpl->mFittingMode, VISUAL_FITTING_MODE_TABLE, VISUAL_FITTING_MODE_TABLE_COUNT );
344 map.Insert( Toolkit::DevelVisual::Property::VISUAL_FITTING_MODE, fittingModeString );
346 map.Insert( Toolkit::DevelVisual::Property::CORNER_RADIUS, mImpl->mCornerRadius );
349 void Visual::Base::CreateInstancePropertyMap( Property::Map& map ) const
351 DoCreateInstancePropertyMap( map );
353 if( mImpl->mCustomShader )
355 mImpl->mCustomShader->CreatePropertyMap( map );
358 //map.Insert( Toolkit::Visual::Property::DEPTH_INDEX, mImpl->mDepthIndex );
359 //map.Insert( Toolkit::Visual::Property::ENABLED, (bool) mImpl->mRenderer );
363 void Visual::Base::EnablePreMultipliedAlpha( bool preMultiplied )
367 mImpl->mFlags |= Impl::IS_PREMULTIPLIED_ALPHA;
371 mImpl->mFlags &= ~Impl::IS_PREMULTIPLIED_ALPHA;
374 if( mImpl->mRenderer )
376 mImpl->mRenderer.SetProperty(Renderer::Property::BLEND_PRE_MULTIPLIED_ALPHA, preMultiplied);
377 mImpl->mRenderer.RegisterProperty( PRE_MULTIPLIED_ALPHA_PROPERTY, static_cast<float>( preMultiplied ) );
381 bool Visual::Base::IsPreMultipliedAlphaEnabled() const
383 return mImpl->mFlags & Impl::IS_PREMULTIPLIED_ALPHA;
386 void Visual::Base::DoSetOffStage( Actor& actor )
388 actor.RemoveRenderer( mImpl->mRenderer );
389 mImpl->mRenderer.Reset();
392 bool Visual::Base::IsOnStage() const
394 return mImpl->mFlags & Impl::IS_ON_STAGE;
397 bool Visual::Base::IsRoundedCornerRequired() const
399 return !EqualsZero( mImpl->mCornerRadius );
402 void Visual::Base::OnDoAction( const Property::Index actionId, const Property::Value& attributes )
404 // May be overriden by derived class
407 void Visual::Base::RegisterMixColor()
409 // Only register if not already registered.
410 // (Color and Primitive visuals will register their own and save to this index)
411 if( mImpl->mMixColorIndex == Property::INVALID_INDEX )
413 mImpl->mMixColorIndex = DevelHandle::RegisterProperty(
415 Toolkit::Visual::Property::MIX_COLOR,
417 Vector3(mImpl->mMixColor) );
420 if( mImpl->mMixColor.a < 1.f )
422 mImpl->mRenderer.SetProperty( Renderer::Property::BLEND_MODE, BlendMode::ON );
425 mImpl->mRenderer.SetProperty( DevelRenderer::Property::OPACITY, mImpl->mMixColor.a );
427 float preMultipliedAlpha = 0.0f;
428 if( IsPreMultipliedAlphaEnabled() )
430 preMultipliedAlpha = 1.0f;
432 mImpl->mRenderer.RegisterProperty( PRE_MULTIPLIED_ALPHA_PROPERTY, preMultipliedAlpha );
435 void Visual::Base::SetMixColor( const Vector4& color )
437 mImpl->mMixColor = color;
439 if( mImpl->mRenderer )
441 mImpl->mRenderer.SetProperty( mImpl->mMixColorIndex, Vector3(color) );
442 mImpl->mRenderer.SetProperty( DevelRenderer::Property::OPACITY, color.a );
445 mImpl->mRenderer.SetProperty( Renderer::Property::BLEND_MODE, BlendMode::ON );
450 void Visual::Base::SetMixColor( const Vector3& color )
452 mImpl->mMixColor.r = color.r;
453 mImpl->mMixColor.g = color.g;
454 mImpl->mMixColor.b = color.b;
456 if( mImpl->mRenderer )
458 mImpl->mRenderer.SetProperty( mImpl->mMixColorIndex, color );
462 const Vector4& Visual::Base::GetMixColor() const
464 return mImpl->mMixColor;
467 void Visual::Base::AddEventObserver( Visual::EventObserver& observer)
469 mImpl->mEventObserver = &observer;
472 void Visual::Base::RemoveEventObserver( Visual::EventObserver& observer )
474 mImpl->mEventObserver = NULL;
477 void Visual::Base::ResourceReady(Toolkit::Visual::ResourceStatus resourceStatus)
479 if( mImpl->mResourceStatus != resourceStatus )
481 mImpl->mResourceStatus = resourceStatus;
483 if( mImpl->mEventObserver )
485 // observer is currently a control impl
486 mImpl->mEventObserver->ResourceReady( *this );
491 bool Visual::Base::IsResourceReady() const
493 return ( mImpl->mResourceStatus == Toolkit::Visual::ResourceStatus::READY );
496 bool Visual::Base::IsSynchronousLoadingRequired() const
498 return ( mImpl->mFlags & Impl::IS_SYNCHRONOUS_RESOURCE_LOADING );
501 Toolkit::Visual::ResourceStatus Visual::Base::GetResourceStatus() const
503 return mImpl->mResourceStatus;
506 Visual::FittingMode Visual::Base::GetFittingMode() const
508 return mImpl->mFittingMode;
511 Visual::Base& Visual::Base::GetVisualObject()
516 Renderer Visual::Base::GetRenderer()
518 return mImpl->mRenderer;
521 Property::Index Visual::Base::GetPropertyIndex( Property::Key key )
523 Property::Index index = DevelHandle::GetPropertyIndex( mImpl->mRenderer, key );
525 if( index == Property::INVALID_INDEX )
527 // Is it a shader property?
528 Shader shader = mImpl->mRenderer.GetShader();
529 index = DevelHandle::GetPropertyIndex( shader, key );
530 if( index != Property::INVALID_INDEX )
532 // Yes - we should register it in the Renderer so it can be set / animated
533 // independently, as shaders are shared across multiple renderers.
535 Property::Index keyIndex( Property::INVALID_KEY );
536 if( key.type == Property::Key::INDEX )
538 keyName = shader.GetPropertyName( index );
539 keyIndex = key.indexKey;
543 keyName = key.stringKey;
544 // Leave keyIndex as INVALID_KEY - it can still be registered against the string key.
546 Property::Value value = shader.GetProperty( index );
547 index = DevelHandle::RegisterProperty( mImpl->mRenderer, keyIndex, keyName, value );
553 void Visual::Base::SetupTransition(
554 Dali::Animation& transition,
555 Internal::TransitionData::Animator& animator,
556 Property::Index index,
557 Property::Value& initialValue,
558 Property::Value& targetValue )
560 if( index != Property::INVALID_INDEX )
562 if( mImpl->mRenderer )
564 if( animator.animate == false )
566 mImpl->mRenderer.SetProperty( index, targetValue );
570 if( animator.initialValue.GetType() != Property::NONE )
572 mImpl->mRenderer.SetProperty( index, initialValue );
577 transition = Dali::Animation::New( 0.1f );
580 transition.AnimateTo( Property( mImpl->mRenderer, index ),
582 animator.alphaFunction,
583 TimePeriod( animator.timePeriodDelay,
584 animator.timePeriodDuration ) );
590 void Visual::Base::AnimateProperty(
591 Dali::Animation& transition,
592 Internal::TransitionData::Animator& animator )
594 #if defined(DEBUG_ENABLED)
596 std::ostringstream oss;
597 oss << "Visual::Base::AnimateProperty(Visual:" << mImpl->mName << " Property:" << animator.propertyKey << " Target: " << animator.targetValue << std::endl;
598 DALI_LOG_INFO( gVisualBaseLogFilter, Debug::General, oss.str().c_str() );
603 DoCreatePropertyMap( map );
604 Property::Value* valuePtr = map.Find( Toolkit::Visual::Property::TYPE );
608 valuePtr->Get( visualType );
611 if( animator.propertyKey == Toolkit::Visual::Property::MIX_COLOR ||
612 animator.propertyKey == MIX_COLOR ||
613 ( visualType == Toolkit::Visual::COLOR &&
614 animator.propertyKey == ColorVisual::Property::MIX_COLOR ) ||
615 ( visualType == Toolkit::Visual::PRIMITIVE &&
616 animator.propertyKey == PrimitiveVisual::Property::MIX_COLOR ) )
618 AnimateMixColorProperty( transition, animator );
620 else if(animator.propertyKey == Toolkit::Visual::Property::OPACITY ||
621 animator.propertyKey == OPACITY )
623 AnimateOpacityProperty( transition, animator );
625 else if( mImpl->mRenderer )
627 AnimateRendererProperty( transition, animator );
631 void Visual::Base::AnimateOpacityProperty(
632 Dali::Animation& transition,
633 Internal::TransitionData::Animator& animator )
635 bool isOpaque = mImpl->mMixColor.a >= 1.0f;
637 float initialOpacity;
638 if( animator.initialValue.Get( initialOpacity ) )
640 isOpaque = (initialOpacity >= 1.0f);
644 if( animator.targetValue.Get( targetOpacity ) )
646 mImpl->mMixColor.a = targetOpacity;
649 SetupTransition( transition, animator, DevelRenderer::Property::OPACITY, animator.initialValue, animator.targetValue );
650 SetupBlendMode( transition, isOpaque, animator.animate );
653 void Visual::Base::AnimateRendererProperty(
654 Dali::Animation& transition,
655 Internal::TransitionData::Animator& animator )
657 Property::Index index = GetPropertyIndex( animator.propertyKey );
658 if( index != Property::INVALID_INDEX )
660 if( animator.targetValue.GetType() != Property::NONE )
662 // Try writing target value into transform property map
663 // if it's not a valid key, then it won't alter mTransform
665 if( animator.propertyKey.type == Property::Key::INDEX )
667 map.Add( animator.propertyKey.indexKey, animator.targetValue );
671 map.Add( animator.propertyKey.stringKey, animator.targetValue );
674 mImpl->mTransform.UpdatePropertyMap( map );
677 SetupTransition( transition, animator, index, animator.initialValue, animator.targetValue );
681 void Visual::Base::AnimateMixColorProperty(
682 Dali::Animation& transition,
683 Internal::TransitionData::Animator& animator )
685 Property::Index index = mImpl->mMixColorIndex;
686 bool animateOpacity = false;
687 bool isOpaque = true;
689 Property::Value initialOpacity;
690 Property::Value targetOpacity;
691 Property::Value initialMixColor;
692 Property::Value targetMixColor;
694 if( index != Property::INVALID_INDEX )
696 Vector4 initialColor;
697 if( animator.initialValue.Get(initialColor) )
699 if( animator.initialValue.GetType() == Property::VECTOR4 )
701 // if there is an initial color specifying alpha, test it
702 isOpaque = initialColor.a >= 1.0f;
703 initialOpacity = initialColor.a;
705 initialMixColor = Vector3( initialColor );
708 // Set target value into data store
709 if( animator.targetValue.GetType() != Property::NONE )
712 animator.targetValue.Get(mixColor);
713 if( animator.targetValue.GetType() == Property::VECTOR4 )
715 mImpl->mMixColor.a = mixColor.a;
716 targetOpacity = mixColor.a;
717 animateOpacity = true;
720 mImpl->mMixColor.r = mixColor.r;
721 mImpl->mMixColor.g = mixColor.g;
722 mImpl->mMixColor.b = mixColor.b;
723 targetMixColor = Vector3(mixColor);
726 SetupTransition( transition, animator, index, initialMixColor, targetMixColor );
729 SetupTransition( transition, animator, DevelRenderer::Property::OPACITY, initialOpacity, targetOpacity );
730 SetupBlendMode( transition, isOpaque, animator.animate );
735 void Visual::Base::SetupBlendMode( Animation& transition, bool isInitialOpaque, bool animating )
737 // Ensure the blend mode is turned on if we are animating opacity, and
738 // turned off after the animation ends if the final value is opaque
739 if( ! isInitialOpaque || mImpl->mMixColor.a < 1.0f )
741 if( mImpl->mRenderer )
743 mImpl->mRenderer.SetProperty( Renderer::Property::BLEND_MODE, BlendMode::ON );
745 if( animating == true && mImpl->mMixColor.a >= 1.0f )
747 // When it becomes opaque, set the blend mode back to automatically
748 if( ! mImpl->mBlendSlotDelegate )
750 mImpl->mBlendSlotDelegate = new SlotDelegate<Visual::Base>(this);
752 transition.FinishedSignal().Connect( *(mImpl->mBlendSlotDelegate),
753 &Visual::Base::OnMixColorFinished );
759 void Visual::Base::OnMixColorFinished( Animation& animation )
761 if( mImpl->mRenderer )
763 DALI_LOG_INFO( gVisualBaseLogFilter, Debug::General, "Visual::Base::OnMixColorFinished()\n");
764 mImpl->mRenderer.SetProperty( Renderer::Property::BLEND_MODE,
765 ( mImpl->mMixColor.a < 1.0 ) ? BlendMode::ON : BlendMode::AUTO );
767 delete mImpl->mBlendSlotDelegate;
768 mImpl->mBlendSlotDelegate = NULL;
771 } // namespace Internal
773 } // namespace Toolkit