/*
- * Copyright (c) 2016 Samsung Electronics Co., Ltd.
+ * Copyright (c) 2017 Samsung Electronics Co., Ltd.
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
// EXTERNAL HEADER
#include <dali/public-api/common/dali-common.h>
+#include <dali/devel-api/object/handle-devel.h>
#include <dali/integration-api/debug.h>
//INTERNAL HEARDER
-#include <dali-toolkit/devel-api/visual-factory/devel-visual-properties.h>
+#include <dali-toolkit/public-api/visuals/color-visual-properties.h>
+#include <dali-toolkit/public-api/visuals/primitive-visual-properties.h>
+#include <dali-toolkit/public-api/visuals/visual-properties.h>
#include <dali-toolkit/internal/visuals/visual-base-data-impl.h>
#include <dali-toolkit/internal/visuals/visual-string-constants.h>
+namespace
+{
+#if defined(DEBUG_ENABLED)
+Debug::Filter* gVisualBaseLogFilter = Debug::Filter::New( Debug::NoLogging, false, "LOG_VISUAL_BASE" );
+#endif
+
+const char * const PRE_MULTIPLIED_ALPHA_PROPERTY( "preMultipliedAlpha" );
+}
+
namespace Dali
{
void Visual::Base::SetProperties( const Property::Map& propertyMap )
{
- Property::Value* customShaderValue = propertyMap.Find( VisualProperty::SHADER, CUSTOM_SHADER );
- if( customShaderValue )
+ for( size_t i = 0; i < propertyMap.Count(); ++i )
{
- Property::Map shaderMap;
- if( customShaderValue->Get( shaderMap ) )
+ const KeyValuePair& pair = propertyMap.GetKeyValue( i );
+ const Property::Key& key = pair.first;
+ const Property::Value& value = pair.second;
+
+ Property::Key matchKey = key;
+ if( matchKey.type == Property::Key::STRING )
{
- SetCustomShader( shaderMap );
+ if( matchKey == CUSTOM_SHADER )
+ {
+ matchKey = Property::Key( Toolkit::Visual::Property::SHADER );
+ }
+ else if( matchKey == TRANSFORM )
+ {
+ matchKey = Property::Key( Toolkit::Visual::Property::TRANSFORM );
+ }
+ else if( matchKey == PREMULTIPLIED_ALPHA )
+ {
+ matchKey = Property::Key( Toolkit::Visual::Property::PREMULTIPLIED_ALPHA );
+ }
+ else if( matchKey == MIX_COLOR )
+ {
+ matchKey = Property::Key( Toolkit::Visual::Property::MIX_COLOR );
+ }
+ else if( matchKey == OPACITY )
+ {
+ matchKey = Property::Key( Toolkit::Visual::Property::OPACITY );
+ }
}
- }
- Property::Value* transform = propertyMap.Find( Toolkit::Visual::DevelProperty::TRANSFORM, TRANSFORM );
- if( transform )
- {
- Property::Map map;
- if( transform->Get( map ) )
+ switch( matchKey.indexKey )
{
- mImpl->mTransform.SetPropertyMap( map );
+ case Toolkit::Visual::Property::SHADER:
+ {
+ Property::Map shaderMap;
+ if( value.Get( shaderMap ) )
+ {
+ SetCustomShader( shaderMap );
+ }
+ break;
+ }
+
+ case Toolkit::Visual::Property::TRANSFORM:
+ {
+ Property::Map map;
+ if( value.Get( map ) )
+ {
+ mImpl->mTransform.SetPropertyMap( map );
+ }
+ break;
+ }
+
+ case Toolkit::Visual::Property::PREMULTIPLIED_ALPHA:
+ {
+ bool premultipliedAlpha = false;
+ if( value.Get( premultipliedAlpha ) )
+ {
+ EnablePreMultipliedAlpha( premultipliedAlpha );
+ }
+ break;
+ }
+
+ case Toolkit::Visual::Property::MIX_COLOR:
+ {
+ Vector4 mixColor;
+ if( value.Get( mixColor ) )
+ {
+ if( value.GetType() == Property::VECTOR4 )
+ {
+ SetMixColor( mixColor );
+ }
+ else
+ {
+ Vector3 mixColor3(mixColor);
+ SetMixColor( mixColor3 );
+ }
+ }
+ break;
+ }
+ case Toolkit::Visual::Property::OPACITY:
+ {
+ float opacity;
+ if( value.Get( opacity ) )
+ {
+ mImpl->mMixColor.a = opacity;
+ SetMixColor( mImpl->mMixColor );
+ }
+ break;
+ }
}
}
DoSetProperties( propertyMap );
}
+void Visual::Base::SetTransformAndSize( const Property::Map& transform, Size controlSize )
+{
+ mImpl->mControlSize = controlSize;
+ mImpl->mTransform.UpdatePropertyMap( transform );
+
+#if defined(DEBUG_ENABLED)
+ std::ostringstream oss;
+ oss << transform;
+ DALI_LOG_INFO( gVisualBaseLogFilter, Debug::General, "Visual::Base::SetTransformAndSize(%s) - [\e[1;32mtransform: %s controlSize: (%3.1f, %3.1f)]\e[0m\n",
+ GetName().c_str(), oss.str().c_str(), controlSize.x, controlSize.y );
+#endif
+
+ OnSetTransform();
+}
+
void Visual::Base::SetName( const std::string& name )
{
mImpl->mName = name;
return mImpl->mName;
}
-void Visual::Base::SetSize( const Vector2& size )
-{
- mImpl->mSize = size;
-}
-
-const Vector2& Visual::Base::GetSize() const
+float Visual::Base::GetHeightForWidth( float width )
{
- return mImpl->mSize;
+ float aspectCorrectedHeight = 0.f;
+ Vector2 naturalSize;
+ GetNaturalSize( naturalSize );
+ if( naturalSize.width )
+ {
+ aspectCorrectedHeight = naturalSize.height * width / naturalSize.width;
+ }
+ return aspectCorrectedHeight;
}
-float Visual::Base::GetHeightForWidth( float width ) const
+float Visual::Base::GetWidthForHeight( float height )
{
- return 0.f;
+ float aspectCorrectedWidth = 0.f;
+ Vector2 naturalSize;
+ GetNaturalSize( naturalSize );
+ if( naturalSize.height > 0.0f )
+ {
+ aspectCorrectedWidth = naturalSize.width * height / naturalSize.height;
+ }
+ return aspectCorrectedWidth;
}
-void Visual::Base::GetNaturalSize( Vector2& naturalSize ) const
+void Visual::Base::GetNaturalSize( Vector2& naturalSize )
{
naturalSize = Vector2::ZERO;
}
-void Visual::Base::SetDepthIndex( float index )
+void Visual::Base::SetDepthIndex( int index )
{
mImpl->mDepthIndex = index;
if( mImpl->mRenderer )
}
}
-float Visual::Base::GetDepthIndex() const
+int Visual::Base::GetDepthIndex() const
{
return mImpl->mDepthIndex;
}
void Visual::Base::SetOnStage( Actor& actor )
{
- // To display the actor correctly, renderer should not be added to actor until all required resources are ready.
- // Thus the calling of actor.AddRenderer() should happen inside derived class as base class does not know the exact timing.
- DoSetOnStage( actor );
+ if( !IsOnStage() )
+ {
+ // To display the actor correctly, renderer should not be added to actor until all required resources are ready.
+ // Thus the calling of actor.AddRenderer() should happen inside derived class as base class does not know the exact timing.
+ DoSetOnStage( actor );
+
+ if( mImpl->mRenderer )
+ {
+ RegisterMixColor();
- mImpl->mRenderer.SetProperty(Renderer::Property::BLEND_PRE_MULTIPLIED_ALPHA, IsPreMultipliedAlphaEnabled());
- mImpl->mRenderer.SetProperty( Renderer::Property::DEPTH_INDEX, mImpl->mDepthIndex );
- mImpl->mFlags |= Impl::IS_ON_STAGE;
+ mImpl->mRenderer.SetProperty( Renderer::Property::BLEND_PRE_MULTIPLIED_ALPHA, IsPreMultipliedAlphaEnabled());
+ mImpl->mRenderer.SetProperty( Renderer::Property::DEPTH_INDEX, mImpl->mDepthIndex );
+ mImpl->mFlags |= Impl::IS_ON_STAGE; // Only sets the flag if renderer exists
+ }
+ }
}
void Visual::Base::SetOffStage( Actor& actor )
if( IsOnStage() )
{
DoSetOffStage( actor );
-
+ mImpl->mMixColorIndex = Property::INVALID_INDEX;
+ mImpl->mOpacityIndex = Property::INVALID_INDEX;
mImpl->mFlags &= ~Impl::IS_ON_STAGE;
}
}
Property::Map transform;
mImpl->mTransform.GetPropertyMap( transform );
- map.Insert( Toolkit::Visual::DevelProperty::TRANSFORM, transform );
+ map.Insert( Toolkit::Visual::Property::TRANSFORM, transform );
+
+ bool premultipliedAlpha( IsPreMultipliedAlphaEnabled() );
+ map.Insert( Toolkit::Visual::Property::PREMULTIPLIED_ALPHA, premultipliedAlpha );
+
+ // Note, Color and Primitive will also insert their own mix color into the map
+ // which is ok, because they have a different key value range.
+ map.Insert( Toolkit::Visual::Property::MIX_COLOR, mImpl->mMixColor ); // vec4
+ map.Insert( Toolkit::Visual::Property::OPACITY, mImpl->mMixColor.a );
+}
+
+void Visual::Base::CreateInstancePropertyMap( Property::Map& map ) const
+{
+ DoCreateInstancePropertyMap( map );
+
+ if( mImpl->mCustomShader )
+ {
+ mImpl->mCustomShader->CreatePropertyMap( map );
+ }
+
+ //map.Insert( Toolkit::Visual::Property::DEPTH_INDEX, mImpl->mDepthIndex );
+ //map.Insert( Toolkit::Visual::Property::ENABLED, (bool) mImpl->mRenderer );
}
-void Visual::Base::EnablePreMultipliedAlpha( bool preMultipled )
+
+void Visual::Base::EnablePreMultipliedAlpha( bool preMultiplied )
{
- if(preMultipled)
+ if( preMultiplied )
{
mImpl->mFlags |= Impl::IS_PREMULTIPLIED_ALPHA;
}
if( mImpl->mRenderer )
{
- mImpl->mRenderer.SetProperty(Renderer::Property::BLEND_PRE_MULTIPLIED_ALPHA, preMultipled);
+ mImpl->mRenderer.SetProperty(Renderer::Property::BLEND_PRE_MULTIPLIED_ALPHA, preMultiplied);
+ mImpl->mRenderer.RegisterProperty( PRE_MULTIPLIED_ALPHA_PROPERTY, static_cast<float>( preMultiplied ) );
}
}
return mImpl->mFlags & Impl::IS_ON_STAGE;
}
-bool Visual::Base::IsFromCache() const
+void Visual::Base::RegisterMixColor()
+{
+ // Only register if not already registered.
+ // (Color and Primitive visuals will register their own and save to this index)
+ if( mImpl->mMixColorIndex == Property::INVALID_INDEX )
+ {
+ mImpl->mMixColorIndex = DevelHandle::RegisterProperty(
+ mImpl->mRenderer,
+ Toolkit::Visual::Property::MIX_COLOR,
+ MIX_COLOR,
+ Vector3(mImpl->mMixColor) );
+ }
+
+ if( mImpl->mMixColor.a < 1.f )
+ {
+ mImpl->mRenderer.SetProperty( Renderer::Property::BLEND_MODE, BlendMode::ON );
+ }
+
+ if( mImpl->mOpacityIndex == Property::INVALID_INDEX )
+ {
+ mImpl->mOpacityIndex = DevelHandle::RegisterProperty(
+ mImpl->mRenderer,
+ Toolkit::Visual::Property::OPACITY,
+ OPACITY,
+ mImpl->mMixColor.a );
+ }
+
+ float preMultipliedAlpha = 0.0f;
+ if( IsPreMultipliedAlphaEnabled() )
+ {
+ preMultipliedAlpha = 1.0f;
+ }
+ mImpl->mRenderer.RegisterProperty( PRE_MULTIPLIED_ALPHA_PROPERTY, preMultipliedAlpha );
+}
+
+void Visual::Base::SetMixColor( const Vector4& color )
+{
+ mImpl->mMixColor = color;
+
+ if( mImpl->mRenderer )
+ {
+ mImpl->mRenderer.SetProperty( mImpl->mMixColorIndex, Vector3(color) );
+ mImpl->mRenderer.SetProperty( mImpl->mOpacityIndex, color.a );
+ if( color.a < 1.f )
+ {
+ mImpl->mRenderer.SetProperty( Renderer::Property::BLEND_MODE, BlendMode::ON );
+ }
+ }
+}
+
+void Visual::Base::SetMixColor( const Vector3& color )
+{
+ mImpl->mMixColor.r = color.r;
+ mImpl->mMixColor.g = color.g;
+ mImpl->mMixColor.b = color.b;
+
+ if( mImpl->mRenderer )
+ {
+ mImpl->mRenderer.SetProperty( mImpl->mMixColorIndex, color );
+ }
+}
+
+const Vector4& Visual::Base::GetMixColor() const
{
- return mImpl->mFlags & Impl::IS_FROM_CACHE;
+ return mImpl->mMixColor;
}
-void Visual::Base::SetProperty( Dali::Property::Index index, const Dali::Property::Value& propertyValue )
+void Visual::Base::AddResourceObserver( Visual::ResourceObserver& observer)
{
- DALI_ASSERT_ALWAYS( ( index > Property::INVALID_INDEX ) &&
- ( index > VISUAL_PROPERTY_BASE_START_INDEX ) && // Change the type of visual is not allowed.
- "Property index is out of bounds" );
+ mImpl->mResourceObserver = &observer;
+}
+
+void Visual::Base::RemoveResourceObserver( Visual::ResourceObserver& observer )
+{
+ mImpl->mResourceObserver = NULL;
+}
- if( index < VISUAL_PROPERTY_START_INDEX )
+void Visual::Base::ResourceReady(Toolkit::Visual::ResourceStatus resourceStatus)
+{
+ if( mImpl->mResourceStatus != resourceStatus )
{
- if( index == Dali::Toolkit::Visual::DevelProperty::TRANSFORM )
+ mImpl->mResourceStatus = resourceStatus;
+
+ if( mImpl->mResourceObserver )
{
- Property::Map* map = propertyValue.GetMap();
- if( map )
+ // observer is currently a control impl
+ mImpl->mResourceObserver->ResourceReady( *this );
+ }
+ }
+}
+
+bool Visual::Base::IsResourceReady() const
+{
+ return ( mImpl->mResourceStatus == Toolkit::Visual::ResourceStatus::READY );
+}
+
+Toolkit::Visual::ResourceStatus Visual::Base::GetResourceStatus() const
+{
+ return mImpl->mResourceStatus;
+}
+
+Renderer Visual::Base::GetRenderer()
+{
+ return mImpl->mRenderer;
+}
+
+Property::Index Visual::Base::GetPropertyIndex( Property::Key key )
+{
+ Property::Index index = DevelHandle::GetPropertyIndex( mImpl->mRenderer, key );
+
+ if( index == Property::INVALID_INDEX )
+ {
+ // Is it a shader property?
+ Shader shader = mImpl->mRenderer.GetShader();
+ index = DevelHandle::GetPropertyIndex( shader, key );
+ if( index != Property::INVALID_INDEX )
+ {
+ // Yes - we should register it in the Renderer so it can be set / animated
+ // independently, as shaders are shared across multiple renderers.
+ std::string keyName;
+ Property::Index keyIndex( Property::INVALID_KEY );
+ if( key.type == Property::Key::INDEX )
+ {
+ keyName = shader.GetPropertyName( index );
+ keyIndex = key.indexKey;
+ }
+ else
+ {
+ keyName = key.stringKey;
+ // Leave keyIndex as INVALID_KEY - it can still be registered against the string key.
+ }
+ Property::Value value = shader.GetProperty( index );
+ index = DevelHandle::RegisterProperty( mImpl->mRenderer, keyIndex, keyName, value );
+ }
+ }
+ return index;
+}
+
+void Visual::Base::SetupTransition(
+ Dali::Animation& transition,
+ Internal::TransitionData::Animator& animator,
+ Property::Index index,
+ Property::Value& initialValue,
+ Property::Value& targetValue )
+{
+ if( index != Property::INVALID_INDEX )
+ {
+ if( mImpl->mRenderer )
+ {
+ if( animator.animate == false )
+ {
+ mImpl->mRenderer.SetProperty( index, targetValue );
+ }
+ else
{
- mImpl->mTransform.SetPropertyMap( *map );
- OnSetTransform();
+ if( animator.initialValue.GetType() != Property::NONE )
+ {
+ mImpl->mRenderer.SetProperty( index, initialValue );
+ }
+
+ if( ! transition )
+ {
+ transition = Dali::Animation::New( 0.1f );
+ }
+
+ transition.AnimateTo( Property( mImpl->mRenderer, index ),
+ targetValue,
+ animator.alphaFunction,
+ TimePeriod( animator.timePeriodDelay,
+ animator.timePeriodDuration ) );
}
}
+ }
+}
- // TODO set the properties of the visual base.
+void Visual::Base::AnimateProperty(
+ Dali::Animation& transition,
+ Internal::TransitionData::Animator& animator )
+{
+#if defined(DEBUG_ENABLED)
+ {
+ std::ostringstream oss;
+ oss << "Visual::Base::AnimateProperty(Visual:" << mImpl->mName << " Property:" << animator.propertyKey << " Target: " << animator.targetValue << std::endl;
+ DALI_LOG_INFO( gVisualBaseLogFilter, Debug::General, oss.str().c_str() );
}
- else
+#endif
+
+ Property::Map map;
+ DoCreatePropertyMap( map );
+ Property::Value* valuePtr = map.Find( Toolkit::Visual::Property::TYPE );
+ int visualType = -1;
+ if( valuePtr )
+ {
+ valuePtr->Get( visualType );
+ }
+
+ if( animator.propertyKey == Toolkit::Visual::Property::MIX_COLOR ||
+ animator.propertyKey == MIX_COLOR ||
+ ( visualType == Toolkit::Visual::COLOR &&
+ animator.propertyKey == ColorVisual::Property::MIX_COLOR ) ||
+ ( visualType == Toolkit::Visual::PRIMITIVE &&
+ animator.propertyKey == PrimitiveVisual::Property::MIX_COLOR ) )
+ {
+ AnimateMixColorProperty( transition, animator );
+ }
+ else if(animator.propertyKey == Toolkit::Visual::Property::OPACITY ||
+ animator.propertyKey == OPACITY )
{
- DoSetProperty( index, propertyValue );
+ AnimateOpacityProperty( transition, animator );
+ }
+ else if( mImpl->mRenderer )
+ {
+ AnimateRendererProperty( transition, animator );
}
}
-Dali::Property::Value Visual::Base::GetProperty( Dali::Property::Index index )
+void Visual::Base::AnimateOpacityProperty(
+ Dali::Animation& transition,
+ Internal::TransitionData::Animator& animator )
{
- DALI_ASSERT_ALWAYS( ( index > Property::INVALID_INDEX ) &&
- ( index >= VISUAL_PROPERTY_BASE_START_INDEX ) &&
- "Property index is out of bounds" );
+ Property::Index index = mImpl->mOpacityIndex;
- Dali::Property::Value value;
+ bool isOpaque = mImpl->mMixColor.a >= 1.0f;
- if( index < VISUAL_PROPERTY_START_INDEX )
+ if( index != Property::INVALID_INDEX )
{
- if( index == Dali::Toolkit::Visual::DevelProperty::TRANSFORM )
+ float initialOpacity;
+ if( animator.initialValue.Get( initialOpacity ) )
+ {
+ isOpaque = (initialOpacity >= 1.0f);
+ }
+
+ float targetOpacity;
+ if( animator.targetValue.Get( targetOpacity ) )
{
+ mImpl->mMixColor.a = targetOpacity;
+ }
+
+ SetupTransition( transition, animator, index, animator.initialValue, animator.targetValue );
+ SetupBlendMode( transition, isOpaque, animator.animate );
+ }
+}
+
+void Visual::Base::AnimateRendererProperty(
+ Dali::Animation& transition,
+ Internal::TransitionData::Animator& animator )
+{
+ Property::Index index = GetPropertyIndex( animator.propertyKey );
+ if( index != Property::INVALID_INDEX )
+ {
+ if( animator.targetValue.GetType() != Property::NONE )
+ {
+ // Try writing target value into transform property map
+ // if it's not a valid key, then it won't alter mTransform
Property::Map map;
- mImpl->mTransform.GetPropertyMap( map );
- return map;
+ if( animator.propertyKey.type == Property::Key::INDEX )
+ {
+ map.Add( animator.propertyKey.indexKey, animator.targetValue );
+ }
+ else
+ {
+ map.Add( animator.propertyKey.stringKey, animator.targetValue );
+ }
+
+ mImpl->mTransform.UpdatePropertyMap( map );
}
- // TODO retrieve the properties of the visual base.
+
+ SetupTransition( transition, animator, index, animator.initialValue, animator.targetValue );
}
- else
+}
+
+void Visual::Base::AnimateMixColorProperty(
+ Dali::Animation& transition,
+ Internal::TransitionData::Animator& animator )
+{
+ Property::Index index = mImpl->mMixColorIndex;
+ bool animateOpacity = false;
+ bool isOpaque = true;
+
+ Property::Value initialOpacity;
+ Property::Value targetOpacity;
+ Property::Value initialMixColor;
+ Property::Value targetMixColor;
+
+ if( index != Property::INVALID_INDEX )
{
- value = DoGetProperty( index );
+ Vector4 initialColor;
+ if( animator.initialValue.Get(initialColor) )
+ {
+ if( animator.initialValue.GetType() == Property::VECTOR4 )
+ {
+ // if there is an initial color specifying alpha, test it
+ isOpaque = initialColor.a >= 1.0f;
+ initialOpacity = initialColor.a;
+ }
+ initialMixColor = Vector3( initialColor );
+ }
+
+ // Set target value into data store
+ if( animator.targetValue.GetType() != Property::NONE )
+ {
+ Vector4 mixColor;
+ animator.targetValue.Get(mixColor);
+ if( animator.targetValue.GetType() == Property::VECTOR4 )
+ {
+ mImpl->mMixColor.a = mixColor.a;
+ targetOpacity = mixColor.a;
+ animateOpacity = true;
+ }
+
+ mImpl->mMixColor.r = mixColor.r;
+ mImpl->mMixColor.g = mixColor.g;
+ mImpl->mMixColor.b = mixColor.b;
+ targetMixColor = Vector3(mixColor);
+ }
+
+ SetupTransition( transition, animator, index, initialMixColor, targetMixColor );
+ if( animateOpacity )
+ {
+ SetupTransition( transition, animator, mImpl->mOpacityIndex, initialOpacity, targetOpacity );
+ SetupBlendMode( transition, isOpaque, animator.animate );
+ }
}
+}
+
+void Visual::Base::SetupBlendMode( Animation& transition, bool isInitialOpaque, bool animating )
+{
+ // Ensure the blend mode is turned on if we are animating opacity, and
+ // turned off after the animation ends if the final value is opaque
+ if( ! isInitialOpaque || mImpl->mMixColor.a < 1.0f )
+ {
+ mImpl->mRenderer.SetProperty( Renderer::Property::BLEND_MODE, BlendMode::ON );
- return value;
+ if( animating == true && mImpl->mMixColor.a >= 1.0f )
+ {
+ // When it becomes opaque, set the blend mode back to automatically
+ if( ! mImpl->mBlendSlotDelegate )
+ {
+ mImpl->mBlendSlotDelegate = new SlotDelegate<Visual::Base>(this);
+ }
+ transition.FinishedSignal().Connect( *(mImpl->mBlendSlotDelegate),
+ &Visual::Base::OnMixColorFinished );
+ }
+ }
+}
+
+void Visual::Base::OnMixColorFinished( Animation& animation )
+{
+ if( mImpl->mRenderer )
+ {
+ DALI_LOG_INFO( gVisualBaseLogFilter, Debug::General, "Visual::Base::OnMixColorFinished()\n");
+ mImpl->mRenderer.SetProperty( Renderer::Property::BLEND_MODE,
+ ( mImpl->mMixColor.a < 1.0 ) ? BlendMode::ON : BlendMode::AUTO );
+ }
+ delete mImpl->mBlendSlotDelegate;
+ mImpl->mBlendSlotDelegate = NULL;
}
} // namespace Internal