Updates following publication of devel-handle APIs
[platform/core/uifw/dali-toolkit.git] / dali-toolkit / internal / visuals / visual-base-impl.cpp
old mode 100644 (file)
new mode 100755 (executable)
index f486a0f..885bc72
@@ -1,5 +1,5 @@
 /*
- * Copyright (c) 2017 Samsung Electronics Co., Ltd.
+ * Copyright (c) 2018 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.
 #include "visual-base-impl.h"
 
 // EXTERNAL HEADER
-#include <dali/public-api/common/dali-common.h>
-#include <dali/devel-api/object/handle-devel.h>
+#include <dali-toolkit/public-api/dali-toolkit-common.h>
+#include <dali/devel-api/scripting/enum-helper.h>
+#include <dali/devel-api/rendering/renderer-devel.h>
 #include <dali/integration-api/debug.h>
 
 //INTERNAL HEARDER
 #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/devel-api/visuals/visual-properties-devel.h>
+#include <dali-toolkit/internal/helpers/property-helper.h>
 #include <dali-toolkit/internal/visuals/visual-base-data-impl.h>
 #include <dali-toolkit/internal/visuals/visual-string-constants.h>
 
@@ -37,7 +40,8 @@ Debug::Filter* gVisualBaseLogFilter = Debug::Filter::New( Debug::NoLogging, fals
 #endif
 
 const char * const PRE_MULTIPLIED_ALPHA_PROPERTY( "preMultipliedAlpha" );
-}
+
+} // namespace
 
 namespace Dali
 {
@@ -48,8 +52,22 @@ namespace Toolkit
 namespace Internal
 {
 
-Visual::Base::Base( VisualFactoryCache& factoryCache )
-: mImpl( new Impl() ),
+namespace
+{
+
+DALI_ENUM_TO_STRING_TABLE_BEGIN( VISUAL_FITTING_MODE )
+DALI_ENUM_TO_STRING_WITH_SCOPE( Visual::FittingMode, FIT_KEEP_ASPECT_RATIO  )
+DALI_ENUM_TO_STRING_WITH_SCOPE( Visual::FittingMode, FILL  )
+DALI_ENUM_TO_STRING_WITH_SCOPE( Visual::FittingMode, OVER_FIT_KEEP_ASPECT_RATIO )
+DALI_ENUM_TO_STRING_WITH_SCOPE( Visual::FittingMode, CENTER )
+DALI_ENUM_TO_STRING_WITH_SCOPE( Visual::FittingMode, FIT_WIDTH )
+DALI_ENUM_TO_STRING_WITH_SCOPE( Visual::FittingMode, FIT_HEIGHT )
+DALI_ENUM_TO_STRING_TABLE_END( VISUAL_FITTING_MODE )
+
+} // namespace
+
+Visual::Base::Base( VisualFactoryCache& factoryCache, FittingMode fittingMode, Toolkit::Visual::Type type )
+: mImpl( new Impl( fittingMode, type ) ),
   mFactoryCache( factoryCache )
 {
 }
@@ -102,6 +120,18 @@ void Visual::Base::SetProperties( const Property::Map& propertyMap )
       {
         matchKey = Property::Key( Toolkit::Visual::Property::OPACITY );
       }
+      else if( matchKey == VISUAL_FITTING_MODE )
+      {
+        matchKey = Property::Key( Toolkit::DevelVisual::Property::VISUAL_FITTING_MODE );
+      }
+      else if( matchKey == CORNER_RADIUS )
+      {
+        matchKey = Property::Key( Toolkit::DevelVisual::Property::CORNER_RADIUS );
+      }
+      else if( matchKey == CORNER_RADIUS_POLICY )
+      {
+        matchKey = Property::Key( Toolkit::DevelVisual::Property::CORNER_RADIUS_POLICY );
+      }
     }
 
     switch( matchKey.indexKey )
@@ -163,6 +193,43 @@ void Visual::Base::SetProperties( const Property::Map& propertyMap )
         }
         break;
       }
+      case Toolkit::DevelVisual::Property::VISUAL_FITTING_MODE:
+      {
+        Scripting::GetEnumerationProperty< Visual::FittingMode >(
+          value, VISUAL_FITTING_MODE_TABLE, VISUAL_FITTING_MODE_TABLE_COUNT, mImpl->mFittingMode );
+        break;
+      }
+      case Toolkit::DevelVisual::Property::CORNER_RADIUS:
+      {
+        float radius;
+        if( value.Get( radius ) )
+        {
+          mImpl->mCornerRadius = radius;
+        }
+        break;
+      }
+      case Toolkit::DevelVisual::Property::CORNER_RADIUS_POLICY:
+      {
+        int policy;
+        if( value.Get( policy ) )
+        {
+          switch( policy )
+          {
+            case Toolkit::Visual::Transform::Policy::RELATIVE:
+            case Toolkit::Visual::Transform::Policy::ABSOLUTE:
+            {
+              mImpl->mCornerRadiusPolicy = policy;
+              break;
+            }
+            default:
+            {
+              DALI_LOG_ERROR( "Unsupported policy: %d\n", policy );
+              break;
+            }
+          }
+        }
+        break;
+      }
     }
   }
 
@@ -189,7 +256,7 @@ void Visual::Base::SetName( const std::string& name )
   mImpl->mName = name;
 }
 
-const std::string& Visual::Base::GetName()
+const std::string& Visual::Base::GetName() const
 {
   return mImpl->mName;
 }
@@ -223,6 +290,11 @@ void Visual::Base::GetNaturalSize( Vector2& naturalSize )
   naturalSize = Vector2::ZERO;
 }
 
+void Visual::Base::DoAction( const Property::Index actionId, const Property::Value attributes )
+{
+  OnDoAction( actionId, attributes );
+}
+
 void Visual::Base::SetDepthIndex( int index )
 {
   mImpl->mDepthIndex = index;
@@ -237,33 +309,41 @@ int Visual::Base::GetDepthIndex() const
   return mImpl->mDepthIndex;
 }
 
-void Visual::Base::SetOnStage( Actor& actor )
+void Visual::Base::SetOnScene( Actor& actor )
 {
-  if( !IsOnStage() )
+  if( !IsOnScene() )
   {
     // 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 );
+    DoSetOnScene( actor );
 
     if( mImpl->mRenderer )
     {
       RegisterMixColor();
 
+      if( IsRoundedCornerRequired() )
+      {
+        mImpl->mCornerRadiusIndex = mImpl->mRenderer.RegisterProperty( CORNER_RADIUS, mImpl->mCornerRadius );
+        mImpl->mRenderer.RegisterProperty( CORNER_RADIUS_POLICY, mImpl->mCornerRadiusPolicy );
+
+        mImpl->mRenderer.SetProperty( Renderer::Property::BLEND_MODE, BlendMode::ON );
+      }
+
       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
+      mImpl->mFlags |= Impl::IS_ON_SCENE; // Only sets the flag if renderer exists
     }
   }
 }
 
-void Visual::Base::SetOffStage( Actor& actor )
+void Visual::Base::SetOffScene( Actor& actor )
 {
-  if( IsOnStage() )
+  if( IsOnScene() )
   {
-    DoSetOffStage( actor );
+    DoSetOffScene( actor );
     mImpl->mMixColorIndex = Property::INVALID_INDEX;
-    mImpl->mOpacityIndex = Property::INVALID_INDEX;
-    mImpl->mFlags &= ~Impl::IS_ON_STAGE;
+    mImpl->mCornerRadiusIndex = Property::INVALID_INDEX;
+    mImpl->mFlags &= ~Impl::IS_ON_SCENE;
   }
 }
 
@@ -287,6 +367,13 @@ void Visual::Base::CreatePropertyMap( Property::Map& map ) const
   // 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 );
+
+  auto fittingModeString = Scripting::GetLinearEnumerationName< FittingMode >(
+    mImpl->mFittingMode, VISUAL_FITTING_MODE_TABLE, VISUAL_FITTING_MODE_TABLE_COUNT );
+  map.Insert( Toolkit::DevelVisual::Property::VISUAL_FITTING_MODE, fittingModeString );
+
+  map.Insert( Toolkit::DevelVisual::Property::CORNER_RADIUS, mImpl->mCornerRadius );
+  map.Insert( Toolkit::DevelVisual::Property::CORNER_RADIUS_POLICY, static_cast< int >( mImpl->mCornerRadiusPolicy ) );
 }
 
 void Visual::Base::CreateInstancePropertyMap( Property::Map& map ) const
@@ -326,15 +413,25 @@ bool Visual::Base::IsPreMultipliedAlphaEnabled() const
   return mImpl->mFlags & Impl::IS_PREMULTIPLIED_ALPHA;
 }
 
-void Visual::Base::DoSetOffStage( Actor& actor )
+void Visual::Base::DoSetOffScene( Actor& actor )
 {
   actor.RemoveRenderer( mImpl->mRenderer );
   mImpl->mRenderer.Reset();
 }
 
-bool Visual::Base::IsOnStage() const
+bool Visual::Base::IsOnScene() const
 {
-  return mImpl->mFlags & Impl::IS_ON_STAGE;
+  return mImpl->mFlags & Impl::IS_ON_SCENE;
+}
+
+bool Visual::Base::IsRoundedCornerRequired() const
+{
+  return !EqualsZero( mImpl->mCornerRadius );
+}
+
+void Visual::Base::OnDoAction( const Property::Index actionId, const Property::Value& attributes )
+{
+  // May be overriden by derived class
 }
 
 void Visual::Base::RegisterMixColor()
@@ -343,8 +440,7 @@ void Visual::Base::RegisterMixColor()
   // (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,
+    mImpl->mMixColorIndex = mImpl->mRenderer.RegisterProperty(
       Toolkit::Visual::Property::MIX_COLOR,
       MIX_COLOR,
       Vector3(mImpl->mMixColor) );
@@ -355,14 +451,7 @@ void Visual::Base::RegisterMixColor()
     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 );
-  }
+  mImpl->mRenderer.SetProperty( DevelRenderer::Property::OPACITY, mImpl->mMixColor.a );
 
   float preMultipliedAlpha = 0.0f;
   if( IsPreMultipliedAlphaEnabled() )
@@ -379,7 +468,7 @@ void Visual::Base::SetMixColor( const Vector4& color )
   if( mImpl->mRenderer )
   {
     mImpl->mRenderer.SetProperty( mImpl->mMixColorIndex, Vector3(color) );
-    mImpl->mRenderer.SetProperty( mImpl->mOpacityIndex, color.a );
+    mImpl->mRenderer.SetProperty( DevelRenderer::Property::OPACITY, color.a );
     if( color.a < 1.f )
     {
       mImpl->mRenderer.SetProperty( Renderer::Property::BLEND_MODE, BlendMode::ON );
@@ -404,14 +493,14 @@ const Vector4& Visual::Base::GetMixColor() const
   return mImpl->mMixColor;
 }
 
-void Visual::Base::AddResourceObserver( Visual::ResourceObserver& observer)
+void Visual::Base::AddEventObserver( Visual::EventObserver& observer)
 {
-  mImpl->mResourceObserver = &observer;
+  mImpl->mEventObserver = &observer;
 }
 
-void Visual::Base::RemoveResourceObserver( Visual::ResourceObserver& observer )
+void Visual::Base::RemoveEventObserver( Visual::EventObserver& observer )
 {
-  mImpl->mResourceObserver = NULL;
+  mImpl->mEventObserver = NULL;
 }
 
 void Visual::Base::ResourceReady(Toolkit::Visual::ResourceStatus resourceStatus)
@@ -420,10 +509,10 @@ void Visual::Base::ResourceReady(Toolkit::Visual::ResourceStatus resourceStatus)
   {
     mImpl->mResourceStatus = resourceStatus;
 
-    if( mImpl->mResourceObserver )
+    if( mImpl->mEventObserver )
     {
       // observer is currently a control impl
-      mImpl->mResourceObserver->ResourceReady( *this );
+      mImpl->mEventObserver->ResourceReady( *this );
     }
   }
 }
@@ -433,11 +522,31 @@ bool Visual::Base::IsResourceReady() const
   return ( mImpl->mResourceStatus == Toolkit::Visual::ResourceStatus::READY );
 }
 
+bool Visual::Base::IsSynchronousLoadingRequired() const
+{
+  return ( mImpl->mFlags & Impl::IS_SYNCHRONOUS_RESOURCE_LOADING );
+}
+
+Toolkit::Visual::Type Visual::Base::GetType() const
+{
+  return mImpl->mType;
+}
+
 Toolkit::Visual::ResourceStatus Visual::Base::GetResourceStatus() const
 {
   return mImpl->mResourceStatus;
 }
 
+Visual::FittingMode Visual::Base::GetFittingMode() const
+{
+  return mImpl->mFittingMode;
+}
+
+Visual::Base& Visual::Base::GetVisualObject()
+{
+  return *this;
+}
+
 Renderer Visual::Base::GetRenderer()
 {
   return mImpl->mRenderer;
@@ -445,13 +554,13 @@ Renderer Visual::Base::GetRenderer()
 
 Property::Index Visual::Base::GetPropertyIndex( Property::Key key )
 {
-  Property::Index index = DevelHandle::GetPropertyIndex( mImpl->mRenderer, key );
+  Property::Index index = mImpl->mRenderer.GetPropertyIndex( key );
 
   if( index == Property::INVALID_INDEX )
   {
     // Is it a shader property?
     Shader shader = mImpl->mRenderer.GetShader();
-    index = DevelHandle::GetPropertyIndex( shader, key );
+    index = shader.GetPropertyIndex( key );
     if( index != Property::INVALID_INDEX )
     {
       // Yes - we should register it in the Renderer so it can be set / animated
@@ -469,7 +578,7 @@ Property::Index Visual::Base::GetPropertyIndex( Property::Key key )
         // 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 );
+      index = mImpl->mRenderer.RegisterProperty( keyIndex, keyName, value );
     }
   }
   return index;
@@ -557,27 +666,22 @@ void Visual::Base::AnimateOpacityProperty(
   Dali::Animation& transition,
   Internal::TransitionData::Animator& animator )
 {
-  Property::Index index = mImpl->mOpacityIndex;
-
   bool isOpaque = mImpl->mMixColor.a >= 1.0f;
 
-  if( index != Property::INVALID_INDEX )
+  float initialOpacity;
+  if( animator.initialValue.Get( initialOpacity ) )
   {
-    float initialOpacity;
-    if( animator.initialValue.Get( initialOpacity ) )
-    {
-      isOpaque = (initialOpacity >= 1.0f);
-    }
-
-    float targetOpacity;
-    if( animator.targetValue.Get( targetOpacity ) )
-    {
-      mImpl->mMixColor.a = targetOpacity;
-    }
+    isOpaque = (initialOpacity >= 1.0f);
+  }
 
-    SetupTransition( transition, animator, index, animator.initialValue, animator.targetValue );
-    SetupBlendMode( transition, isOpaque, animator.animate );
+  float targetOpacity;
+  if( animator.targetValue.Get( targetOpacity ) )
+  {
+    mImpl->mMixColor.a = targetOpacity;
   }
+
+  SetupTransition( transition, animator, DevelRenderer::Property::OPACITY, animator.initialValue, animator.targetValue );
+  SetupBlendMode( transition, isOpaque, animator.animate );
 }
 
 void Visual::Base::AnimateRendererProperty(
@@ -656,7 +760,7 @@ void Visual::Base::AnimateMixColorProperty(
     SetupTransition( transition, animator, index, initialMixColor, targetMixColor );
     if( animateOpacity )
     {
-      SetupTransition( transition, animator, mImpl->mOpacityIndex, initialOpacity, targetOpacity );
+      SetupTransition( transition, animator, DevelRenderer::Property::OPACITY, initialOpacity, targetOpacity );
       SetupBlendMode( transition, isOpaque, animator.animate );
     }
   }
@@ -668,17 +772,20 @@ void Visual::Base::SetupBlendMode( Animation& transition, bool isInitialOpaque,
   // 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 );
-
-    if( animating == true && mImpl->mMixColor.a >= 1.0f )
+    if( mImpl->mRenderer )
     {
-      // When it becomes opaque, set the blend mode back to automatically
-      if( ! mImpl->mBlendSlotDelegate )
+      mImpl->mRenderer.SetProperty( Renderer::Property::BLEND_MODE, BlendMode::ON );
+
+      if( animating == true && mImpl->mMixColor.a >= 1.0f )
       {
-        mImpl->mBlendSlotDelegate = new SlotDelegate<Visual::Base>(this);
+        // 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 );
       }
-      transition.FinishedSignal().Connect( *(mImpl->mBlendSlotDelegate),
-                                           &Visual::Base::OnMixColorFinished );
     }
   }
 }