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/scripting/enum-helper.h>
24 #include <dali/devel-api/rendering/renderer-devel.h>
25 #include <dali/integration-api/debug.h>
28 #include <dali-toolkit/public-api/visuals/color-visual-properties.h>
29 #include <dali-toolkit/public-api/visuals/primitive-visual-properties.h>
30 #include <dali-toolkit/public-api/visuals/visual-properties.h>
31 #include <dali-toolkit/devel-api/visuals/visual-properties-devel.h>
32 #include <dali-toolkit/internal/helpers/property-helper.h>
33 #include <dali-toolkit/internal/visuals/visual-base-data-impl.h>
34 #include <dali-toolkit/internal/visuals/visual-string-constants.h>
38 #if defined(DEBUG_ENABLED)
39 Debug::Filter* gVisualBaseLogFilter = Debug::Filter::New( Debug::NoLogging, false, "LOG_VISUAL_BASE" );
42 const char * const PRE_MULTIPLIED_ALPHA_PROPERTY( "preMultipliedAlpha" );
58 DALI_ENUM_TO_STRING_TABLE_BEGIN( VISUAL_FITTING_MODE )
59 DALI_ENUM_TO_STRING_WITH_SCOPE( Visual::FittingMode, FIT_KEEP_ASPECT_RATIO )
60 DALI_ENUM_TO_STRING_WITH_SCOPE( Visual::FittingMode, FILL )
61 DALI_ENUM_TO_STRING_WITH_SCOPE( Visual::FittingMode, OVER_FIT_KEEP_ASPECT_RATIO )
62 DALI_ENUM_TO_STRING_WITH_SCOPE( Visual::FittingMode, CENTER )
63 DALI_ENUM_TO_STRING_WITH_SCOPE( Visual::FittingMode, FIT_WIDTH )
64 DALI_ENUM_TO_STRING_WITH_SCOPE( Visual::FittingMode, FIT_HEIGHT )
65 DALI_ENUM_TO_STRING_TABLE_END( VISUAL_FITTING_MODE )
69 Visual::Base::Base( VisualFactoryCache& factoryCache, FittingMode fittingMode, Toolkit::Visual::Type type )
70 : mImpl( new Impl( fittingMode, type ) ),
71 mFactoryCache( factoryCache )
80 void Visual::Base::SetCustomShader( const Property::Map& shaderMap )
82 if( mImpl->mCustomShader )
84 mImpl->mCustomShader->SetPropertyMap( shaderMap );
88 mImpl->mCustomShader = new Impl::CustomShader( shaderMap );
92 void Visual::Base::SetProperties( const Property::Map& propertyMap )
94 for( size_t i = 0; i < propertyMap.Count(); ++i )
96 const KeyValuePair& pair = propertyMap.GetKeyValue( i );
97 const Property::Key& key = pair.first;
98 const Property::Value& value = pair.second;
100 Property::Key matchKey = key;
101 if( matchKey.type == Property::Key::STRING )
103 if( matchKey == CUSTOM_SHADER )
105 matchKey = Property::Key( Toolkit::Visual::Property::SHADER );
107 else if( matchKey == TRANSFORM )
109 matchKey = Property::Key( Toolkit::Visual::Property::TRANSFORM );
111 else if( matchKey == PREMULTIPLIED_ALPHA )
113 matchKey = Property::Key( Toolkit::Visual::Property::PREMULTIPLIED_ALPHA );
115 else if( matchKey == MIX_COLOR )
117 matchKey = Property::Key( Toolkit::Visual::Property::MIX_COLOR );
119 else if( matchKey == OPACITY )
121 matchKey = Property::Key( Toolkit::Visual::Property::OPACITY );
123 else if( matchKey == VISUAL_FITTING_MODE )
125 matchKey = Property::Key( Toolkit::DevelVisual::Property::VISUAL_FITTING_MODE );
127 else if( matchKey == CORNER_RADIUS )
129 matchKey = Property::Key( Toolkit::DevelVisual::Property::CORNER_RADIUS );
131 else if( matchKey == CORNER_RADIUS_POLICY )
133 matchKey = Property::Key( Toolkit::DevelVisual::Property::CORNER_RADIUS_POLICY );
137 switch( matchKey.indexKey )
139 case Toolkit::Visual::Property::SHADER:
141 Property::Map shaderMap;
142 if( value.Get( shaderMap ) )
144 SetCustomShader( shaderMap );
149 case Toolkit::Visual::Property::TRANSFORM:
152 if( value.Get( map ) )
154 mImpl->mTransform.SetPropertyMap( map );
159 case Toolkit::Visual::Property::PREMULTIPLIED_ALPHA:
161 bool premultipliedAlpha = false;
162 if( value.Get( premultipliedAlpha ) )
164 EnablePreMultipliedAlpha( premultipliedAlpha );
169 case Toolkit::Visual::Property::MIX_COLOR:
172 if( value.Get( mixColor ) )
174 if( value.GetType() == Property::VECTOR4 )
176 SetMixColor( mixColor );
180 Vector3 mixColor3(mixColor);
181 SetMixColor( mixColor3 );
186 case Toolkit::Visual::Property::OPACITY:
189 if( value.Get( opacity ) )
191 mImpl->mMixColor.a = opacity;
192 SetMixColor( mImpl->mMixColor );
196 case Toolkit::DevelVisual::Property::VISUAL_FITTING_MODE:
198 Scripting::GetEnumerationProperty< Visual::FittingMode >(
199 value, VISUAL_FITTING_MODE_TABLE, VISUAL_FITTING_MODE_TABLE_COUNT, mImpl->mFittingMode );
202 case Toolkit::DevelVisual::Property::CORNER_RADIUS:
205 if( value.Get( radius ) )
207 mImpl->mCornerRadius = radius;
211 case Toolkit::DevelVisual::Property::CORNER_RADIUS_POLICY:
214 if( value.Get( policy ) )
218 case Toolkit::Visual::Transform::Policy::RELATIVE:
219 case Toolkit::Visual::Transform::Policy::ABSOLUTE:
221 mImpl->mCornerRadiusPolicy = policy;
226 DALI_LOG_ERROR( "Unsupported policy: %d\n", policy );
236 DoSetProperties( propertyMap );
239 void Visual::Base::SetTransformAndSize( const Property::Map& transform, Size controlSize )
241 mImpl->mControlSize = controlSize;
242 mImpl->mTransform.UpdatePropertyMap( transform );
244 #if defined(DEBUG_ENABLED)
245 std::ostringstream oss;
247 DALI_LOG_INFO( gVisualBaseLogFilter, Debug::General, "Visual::Base::SetTransformAndSize(%s) - [\e[1;32mtransform: %s controlSize: (%3.1f, %3.1f)]\e[0m\n",
248 GetName().c_str(), oss.str().c_str(), controlSize.x, controlSize.y );
254 void Visual::Base::SetName( const std::string& name )
259 const std::string& Visual::Base::GetName() const
264 float Visual::Base::GetHeightForWidth( float width )
266 float aspectCorrectedHeight = 0.f;
268 GetNaturalSize( naturalSize );
269 if( naturalSize.width )
271 aspectCorrectedHeight = naturalSize.height * width / naturalSize.width;
273 return aspectCorrectedHeight;
276 float Visual::Base::GetWidthForHeight( float height )
278 float aspectCorrectedWidth = 0.f;
280 GetNaturalSize( naturalSize );
281 if( naturalSize.height > 0.0f )
283 aspectCorrectedWidth = naturalSize.width * height / naturalSize.height;
285 return aspectCorrectedWidth;
288 void Visual::Base::GetNaturalSize( Vector2& naturalSize )
290 naturalSize = Vector2::ZERO;
293 void Visual::Base::DoAction( const Property::Index actionId, const Property::Value attributes )
295 OnDoAction( actionId, attributes );
298 void Visual::Base::SetDepthIndex( int index )
300 mImpl->mDepthIndex = index;
301 if( mImpl->mRenderer )
303 mImpl->mRenderer.SetProperty( Renderer::Property::DEPTH_INDEX, mImpl->mDepthIndex );
307 int Visual::Base::GetDepthIndex() const
309 return mImpl->mDepthIndex;
312 void Visual::Base::SetOnScene( Actor& actor )
316 // To display the actor correctly, renderer should not be added to actor until all required resources are ready.
317 // Thus the calling of actor.AddRenderer() should happen inside derived class as base class does not know the exact timing.
318 DoSetOnScene( actor );
320 if( mImpl->mRenderer )
324 if( IsRoundedCornerRequired() )
326 mImpl->mCornerRadiusIndex = mImpl->mRenderer.RegisterProperty( CORNER_RADIUS, mImpl->mCornerRadius );
327 mImpl->mRenderer.RegisterProperty( CORNER_RADIUS_POLICY, mImpl->mCornerRadiusPolicy );
329 mImpl->mRenderer.SetProperty( Renderer::Property::BLEND_MODE, BlendMode::ON );
332 mImpl->mRenderer.SetProperty( Renderer::Property::BLEND_PRE_MULTIPLIED_ALPHA, IsPreMultipliedAlphaEnabled());
333 mImpl->mRenderer.SetProperty( Renderer::Property::DEPTH_INDEX, mImpl->mDepthIndex );
334 mImpl->mFlags |= Impl::IS_ON_SCENE; // Only sets the flag if renderer exists
339 void Visual::Base::SetOffScene( Actor& actor )
343 DoSetOffScene( actor );
344 mImpl->mMixColorIndex = Property::INVALID_INDEX;
345 mImpl->mCornerRadiusIndex = Property::INVALID_INDEX;
346 mImpl->mFlags &= ~Impl::IS_ON_SCENE;
350 void Visual::Base::CreatePropertyMap( Property::Map& map ) const
352 DoCreatePropertyMap( map );
354 if( mImpl->mCustomShader )
356 mImpl->mCustomShader->CreatePropertyMap( map );
359 Property::Map transform;
360 mImpl->mTransform.GetPropertyMap( transform );
361 map.Insert( Toolkit::Visual::Property::TRANSFORM, transform );
363 bool premultipliedAlpha( IsPreMultipliedAlphaEnabled() );
364 map.Insert( Toolkit::Visual::Property::PREMULTIPLIED_ALPHA, premultipliedAlpha );
366 // Note, Color and Primitive will also insert their own mix color into the map
367 // which is ok, because they have a different key value range.
368 map.Insert( Toolkit::Visual::Property::MIX_COLOR, mImpl->mMixColor ); // vec4
369 map.Insert( Toolkit::Visual::Property::OPACITY, mImpl->mMixColor.a );
371 auto fittingModeString = Scripting::GetLinearEnumerationName< FittingMode >(
372 mImpl->mFittingMode, VISUAL_FITTING_MODE_TABLE, VISUAL_FITTING_MODE_TABLE_COUNT );
373 map.Insert( Toolkit::DevelVisual::Property::VISUAL_FITTING_MODE, fittingModeString );
375 map.Insert( Toolkit::DevelVisual::Property::CORNER_RADIUS, mImpl->mCornerRadius );
376 map.Insert( Toolkit::DevelVisual::Property::CORNER_RADIUS_POLICY, static_cast< int >( mImpl->mCornerRadiusPolicy ) );
379 void Visual::Base::CreateInstancePropertyMap( Property::Map& map ) const
381 DoCreateInstancePropertyMap( map );
383 if( mImpl->mCustomShader )
385 mImpl->mCustomShader->CreatePropertyMap( map );
388 //map.Insert( Toolkit::Visual::Property::DEPTH_INDEX, mImpl->mDepthIndex );
389 //map.Insert( Toolkit::Visual::Property::ENABLED, (bool) mImpl->mRenderer );
393 void Visual::Base::EnablePreMultipliedAlpha( bool preMultiplied )
397 mImpl->mFlags |= Impl::IS_PREMULTIPLIED_ALPHA;
401 mImpl->mFlags &= ~Impl::IS_PREMULTIPLIED_ALPHA;
404 if( mImpl->mRenderer )
406 mImpl->mRenderer.SetProperty(Renderer::Property::BLEND_PRE_MULTIPLIED_ALPHA, preMultiplied);
407 mImpl->mRenderer.RegisterProperty( PRE_MULTIPLIED_ALPHA_PROPERTY, static_cast<float>( preMultiplied ) );
411 bool Visual::Base::IsPreMultipliedAlphaEnabled() const
413 return mImpl->mFlags & Impl::IS_PREMULTIPLIED_ALPHA;
416 void Visual::Base::DoSetOffScene( Actor& actor )
418 actor.RemoveRenderer( mImpl->mRenderer );
419 mImpl->mRenderer.Reset();
422 bool Visual::Base::IsOnScene() const
424 return mImpl->mFlags & Impl::IS_ON_SCENE;
427 bool Visual::Base::IsRoundedCornerRequired() const
429 return !EqualsZero( mImpl->mCornerRadius );
432 void Visual::Base::OnDoAction( const Property::Index actionId, const Property::Value& attributes )
434 // May be overriden by derived class
437 void Visual::Base::RegisterMixColor()
439 // Only register if not already registered.
440 // (Color and Primitive visuals will register their own and save to this index)
441 if( mImpl->mMixColorIndex == Property::INVALID_INDEX )
443 mImpl->mMixColorIndex = mImpl->mRenderer.RegisterProperty(
444 Toolkit::Visual::Property::MIX_COLOR,
446 Vector3(mImpl->mMixColor) );
449 if( mImpl->mMixColor.a < 1.f )
451 mImpl->mRenderer.SetProperty( Renderer::Property::BLEND_MODE, BlendMode::ON );
454 mImpl->mRenderer.SetProperty( DevelRenderer::Property::OPACITY, mImpl->mMixColor.a );
456 float preMultipliedAlpha = 0.0f;
457 if( IsPreMultipliedAlphaEnabled() )
459 preMultipliedAlpha = 1.0f;
461 mImpl->mRenderer.RegisterProperty( PRE_MULTIPLIED_ALPHA_PROPERTY, preMultipliedAlpha );
464 void Visual::Base::SetMixColor( const Vector4& color )
466 mImpl->mMixColor = color;
468 if( mImpl->mRenderer )
470 mImpl->mRenderer.SetProperty( mImpl->mMixColorIndex, Vector3(color) );
471 mImpl->mRenderer.SetProperty( DevelRenderer::Property::OPACITY, color.a );
474 mImpl->mRenderer.SetProperty( Renderer::Property::BLEND_MODE, BlendMode::ON );
479 void Visual::Base::SetMixColor( const Vector3& color )
481 mImpl->mMixColor.r = color.r;
482 mImpl->mMixColor.g = color.g;
483 mImpl->mMixColor.b = color.b;
485 if( mImpl->mRenderer )
487 mImpl->mRenderer.SetProperty( mImpl->mMixColorIndex, color );
491 const Vector4& Visual::Base::GetMixColor() const
493 return mImpl->mMixColor;
496 void Visual::Base::AddEventObserver( Visual::EventObserver& observer)
498 mImpl->mEventObserver = &observer;
501 void Visual::Base::RemoveEventObserver( Visual::EventObserver& observer )
503 mImpl->mEventObserver = NULL;
506 void Visual::Base::ResourceReady(Toolkit::Visual::ResourceStatus resourceStatus)
508 if( mImpl->mResourceStatus != resourceStatus )
510 mImpl->mResourceStatus = resourceStatus;
512 if( mImpl->mEventObserver )
514 // observer is currently a control impl
515 mImpl->mEventObserver->ResourceReady( *this );
520 bool Visual::Base::IsResourceReady() const
522 return ( mImpl->mResourceStatus == Toolkit::Visual::ResourceStatus::READY );
525 bool Visual::Base::IsSynchronousLoadingRequired() const
527 return ( mImpl->mFlags & Impl::IS_SYNCHRONOUS_RESOURCE_LOADING );
530 Toolkit::Visual::Type Visual::Base::GetType() const
535 Toolkit::Visual::ResourceStatus Visual::Base::GetResourceStatus() const
537 return mImpl->mResourceStatus;
540 Visual::FittingMode Visual::Base::GetFittingMode() const
542 return mImpl->mFittingMode;
545 Visual::Base& Visual::Base::GetVisualObject()
550 Renderer Visual::Base::GetRenderer()
552 return mImpl->mRenderer;
555 Property::Index Visual::Base::GetPropertyIndex( Property::Key key )
557 Property::Index index = mImpl->mRenderer.GetPropertyIndex( key );
559 if( index == Property::INVALID_INDEX )
561 // Is it a shader property?
562 Shader shader = mImpl->mRenderer.GetShader();
563 index = shader.GetPropertyIndex( key );
564 if( index != Property::INVALID_INDEX )
566 // Yes - we should register it in the Renderer so it can be set / animated
567 // independently, as shaders are shared across multiple renderers.
569 Property::Index keyIndex( Property::INVALID_KEY );
570 if( key.type == Property::Key::INDEX )
572 keyName = shader.GetPropertyName( index );
573 keyIndex = key.indexKey;
577 keyName = key.stringKey;
578 // Leave keyIndex as INVALID_KEY - it can still be registered against the string key.
580 Property::Value value = shader.GetProperty( index );
581 index = mImpl->mRenderer.RegisterProperty( keyIndex, keyName, value );
587 void Visual::Base::SetupTransition(
588 Dali::Animation& transition,
589 Internal::TransitionData::Animator& animator,
590 Property::Index index,
591 Property::Value& initialValue,
592 Property::Value& targetValue )
594 if( index != Property::INVALID_INDEX )
596 if( mImpl->mRenderer )
598 if( animator.animate == false )
600 mImpl->mRenderer.SetProperty( index, targetValue );
604 if( animator.initialValue.GetType() != Property::NONE )
606 mImpl->mRenderer.SetProperty( index, initialValue );
611 transition = Dali::Animation::New( 0.1f );
614 transition.AnimateTo( Property( mImpl->mRenderer, index ),
616 animator.alphaFunction,
617 TimePeriod( animator.timePeriodDelay,
618 animator.timePeriodDuration ) );
624 void Visual::Base::AnimateProperty(
625 Dali::Animation& transition,
626 Internal::TransitionData::Animator& animator )
628 #if defined(DEBUG_ENABLED)
630 std::ostringstream oss;
631 oss << "Visual::Base::AnimateProperty(Visual:" << mImpl->mName << " Property:" << animator.propertyKey << " Target: " << animator.targetValue << std::endl;
632 DALI_LOG_INFO( gVisualBaseLogFilter, Debug::General, oss.str().c_str() );
637 DoCreatePropertyMap( map );
638 Property::Value* valuePtr = map.Find( Toolkit::Visual::Property::TYPE );
642 valuePtr->Get( visualType );
645 if( animator.propertyKey == Toolkit::Visual::Property::MIX_COLOR ||
646 animator.propertyKey == MIX_COLOR ||
647 ( visualType == Toolkit::Visual::COLOR &&
648 animator.propertyKey == ColorVisual::Property::MIX_COLOR ) ||
649 ( visualType == Toolkit::Visual::PRIMITIVE &&
650 animator.propertyKey == PrimitiveVisual::Property::MIX_COLOR ) )
652 AnimateMixColorProperty( transition, animator );
654 else if(animator.propertyKey == Toolkit::Visual::Property::OPACITY ||
655 animator.propertyKey == OPACITY )
657 AnimateOpacityProperty( transition, animator );
659 else if( mImpl->mRenderer )
661 AnimateRendererProperty( transition, animator );
665 void Visual::Base::AnimateOpacityProperty(
666 Dali::Animation& transition,
667 Internal::TransitionData::Animator& animator )
669 bool isOpaque = mImpl->mMixColor.a >= 1.0f;
671 float initialOpacity;
672 if( animator.initialValue.Get( initialOpacity ) )
674 isOpaque = (initialOpacity >= 1.0f);
678 if( animator.targetValue.Get( targetOpacity ) )
680 mImpl->mMixColor.a = targetOpacity;
683 SetupTransition( transition, animator, DevelRenderer::Property::OPACITY, animator.initialValue, animator.targetValue );
684 SetupBlendMode( transition, isOpaque, animator.animate );
687 void Visual::Base::AnimateRendererProperty(
688 Dali::Animation& transition,
689 Internal::TransitionData::Animator& animator )
691 Property::Index index = GetPropertyIndex( animator.propertyKey );
692 if( index != Property::INVALID_INDEX )
694 if( animator.targetValue.GetType() != Property::NONE )
696 // Try writing target value into transform property map
697 // if it's not a valid key, then it won't alter mTransform
699 if( animator.propertyKey.type == Property::Key::INDEX )
701 map.Add( animator.propertyKey.indexKey, animator.targetValue );
705 map.Add( animator.propertyKey.stringKey, animator.targetValue );
708 mImpl->mTransform.UpdatePropertyMap( map );
711 SetupTransition( transition, animator, index, animator.initialValue, animator.targetValue );
715 void Visual::Base::AnimateMixColorProperty(
716 Dali::Animation& transition,
717 Internal::TransitionData::Animator& animator )
719 Property::Index index = mImpl->mMixColorIndex;
720 bool animateOpacity = false;
721 bool isOpaque = true;
723 Property::Value initialOpacity;
724 Property::Value targetOpacity;
725 Property::Value initialMixColor;
726 Property::Value targetMixColor;
728 if( index != Property::INVALID_INDEX )
730 Vector4 initialColor;
731 if( animator.initialValue.Get(initialColor) )
733 if( animator.initialValue.GetType() == Property::VECTOR4 )
735 // if there is an initial color specifying alpha, test it
736 isOpaque = initialColor.a >= 1.0f;
737 initialOpacity = initialColor.a;
739 initialMixColor = Vector3( initialColor );
742 // Set target value into data store
743 if( animator.targetValue.GetType() != Property::NONE )
746 animator.targetValue.Get(mixColor);
747 if( animator.targetValue.GetType() == Property::VECTOR4 )
749 mImpl->mMixColor.a = mixColor.a;
750 targetOpacity = mixColor.a;
751 animateOpacity = true;
754 mImpl->mMixColor.r = mixColor.r;
755 mImpl->mMixColor.g = mixColor.g;
756 mImpl->mMixColor.b = mixColor.b;
757 targetMixColor = Vector3(mixColor);
760 SetupTransition( transition, animator, index, initialMixColor, targetMixColor );
763 SetupTransition( transition, animator, DevelRenderer::Property::OPACITY, initialOpacity, targetOpacity );
764 SetupBlendMode( transition, isOpaque, animator.animate );
769 void Visual::Base::SetupBlendMode( Animation& transition, bool isInitialOpaque, bool animating )
771 // Ensure the blend mode is turned on if we are animating opacity, and
772 // turned off after the animation ends if the final value is opaque
773 if( ! isInitialOpaque || mImpl->mMixColor.a < 1.0f )
775 if( mImpl->mRenderer )
777 mImpl->mRenderer.SetProperty( Renderer::Property::BLEND_MODE, BlendMode::ON );
779 if( animating == true && mImpl->mMixColor.a >= 1.0f )
781 // When it becomes opaque, set the blend mode back to automatically
782 if( ! mImpl->mBlendSlotDelegate )
784 mImpl->mBlendSlotDelegate = new SlotDelegate<Visual::Base>(this);
786 transition.FinishedSignal().Connect( *(mImpl->mBlendSlotDelegate),
787 &Visual::Base::OnMixColorFinished );
793 void Visual::Base::OnMixColorFinished( Animation& animation )
795 if( mImpl->mRenderer )
797 DALI_LOG_INFO( gVisualBaseLogFilter, Debug::General, "Visual::Base::OnMixColorFinished()\n");
798 mImpl->mRenderer.SetProperty( Renderer::Property::BLEND_MODE,
799 ( mImpl->mMixColor.a < 1.0 ) ? BlendMode::ON : BlendMode::AUTO );
801 delete mImpl->mBlendSlotDelegate;
802 mImpl->mBlendSlotDelegate = NULL;
805 } // namespace Internal
807 } // namespace Toolkit