Ensure cached values of properties animated using AnimateTo are updated
[platform/core/uifw/dali-core.git] / dali / internal / event / render-tasks / render-task-impl.cpp
index eea053c..a97069b 100644 (file)
@@ -1,5 +1,5 @@
 /*
- * Copyright (c) 2014 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.
@@ -18,6 +18,9 @@
 // CLASS HEADER
 #include <dali/internal/event/render-tasks/render-task-impl.h>
 
+// EXTERNAL INCLUDES
+#include <cstring> // for strcmp
+
 // INTERNAL INCLUDES
 #include <dali/public-api/common/dali-common.h>
 #include <dali/public-api/object/type-registry.h>
 #include <dali/internal/event/actors/camera-actor-impl.h>
 #include <dali/internal/event/common/property-helper.h>
 #include <dali/internal/event/common/stage-impl.h>
+#include <dali/internal/event/common/projection.h>
 #include <dali/internal/event/images/frame-buffer-image-impl.h>
 #include <dali/internal/update/nodes/node.h>
+#include <dali/internal/event/render-tasks/render-task-list-impl.h>
 #include <dali/internal/update/render-tasks/scene-graph-render-task.h>
 
 #if defined(DEBUG_ENABLED)
@@ -50,9 +55,10 @@ namespace // For internal properties
 
 //              Name                 Type     writable animatable constraint-input  enum for index-checking
 DALI_PROPERTY_TABLE_BEGIN
-DALI_PROPERTY( "viewport-position",  VECTOR2,    true,    true,    true,    Dali::RenderTask::Property::VIEWPORT_POSITION )
-DALI_PROPERTY( "viewport-size",      VECTOR2,    true,    true,    true,    Dali::RenderTask::Property::VIEWPORT_SIZE     )
-DALI_PROPERTY( "clear-color",        VECTOR4,    true,    true,    true,    Dali::RenderTask::Property::CLEAR_COLOR       )
+DALI_PROPERTY( "viewportPosition",   VECTOR2,    true,    true,    true,    Dali::RenderTask::Property::VIEWPORT_POSITION )
+DALI_PROPERTY( "viewportSize",       VECTOR2,    true,    true,    true,    Dali::RenderTask::Property::VIEWPORT_SIZE     )
+DALI_PROPERTY( "clearColor",         VECTOR4,    true,    true,    true,    Dali::RenderTask::Property::CLEAR_COLOR       )
+DALI_PROPERTY( "requiresSync",       BOOLEAN,    true,    false,   false,   Dali::RenderTask::Property::REQUIRES_SYNC     )
 DALI_PROPERTY_TABLE_END( DEFAULT_OBJECT_PROPERTY_START_INDEX )
 
 // Signals
@@ -74,6 +80,11 @@ RenderTask* RenderTask::New( bool isSystemLevel )
 
 void RenderTask::SetSourceActor( Actor* actor )
 {
+  const Stage* stage = Stage::GetCurrent();
+  if ( stage )
+  {
+    stage->GetRenderTaskList().SetExclusive( this, mExclusive );
+  }
   mSourceConnector.SetActor( actor );
 }
 
@@ -88,6 +99,12 @@ void RenderTask::SetExclusive( bool exclusive )
   {
     mExclusive = exclusive;
 
+    const Stage* stage = Stage::GetCurrent();
+    if ( stage )
+    {
+      stage->GetRenderTaskList().SetExclusive( this, exclusive );
+    }
+
     if ( mSceneObject )
     {
       // mSceneObject is being used in a separate thread; queue a message to set the value
@@ -113,6 +130,14 @@ bool RenderTask::GetInputEnabled() const
 
 void RenderTask::SetCameraActor( CameraActor* cameraActor )
 {
+  if( cameraActor )
+  {
+    mCameraConnector.mCamera = cameraActor->GetCamera();
+  }
+  else
+  {
+    mCameraConnector.mCamera = NULL;
+  }
   mCameraConnector.SetActor( cameraActor );
 }
 
@@ -122,43 +147,38 @@ CameraActor* RenderTask::GetCameraActor() const
   return static_cast< CameraActor* >( mCameraConnector.mActor );
 }
 
-void RenderTask::SetTargetFrameBuffer( Dali::FrameBufferImage image )
+void RenderTask::SetTargetFrameBuffer( FrameBufferImagePtr image )
 {
-  if ( mFrameBufferImage != image )
+  mFrameBufferImage = image;
+  FrameBuffer* frameBufferPtr( NULL );
+  if( image )
   {
-    // if we have a scene object we need to track connection status and set frame buffer id as well as updating target frame buffer
-    if ( mSceneObject )
-    {
-      if(mFrameBufferImage)
-      {
-        GetImplementation(mFrameBufferImage).Disconnect();
-      }
+    frameBufferPtr = image->GetFrameBuffer();
+  }
 
-      // update target frame buffer
-      mFrameBufferImage = image;
+  SetFrameBuffer( frameBufferPtr );
+}
 
-      unsigned int resourceId = 0;
-      if(mFrameBufferImage)
-      {
-        GetImplementation(mFrameBufferImage).Connect();
+void RenderTask::SetFrameBuffer( FrameBufferPtr frameBuffer )
+{
+  mFrameBuffer = frameBuffer;
+  Render::FrameBuffer* renderFrameBufferPtr( NULL );
+  if( frameBuffer )
+  {
+    renderFrameBufferPtr = mFrameBuffer->GetRenderObject();
+  }
 
-        resourceId = GetImplementation( mFrameBufferImage ).GetResourceId();
-      }
+  SetFrameBufferMessage( GetEventThreadServices(), *mSceneObject, renderFrameBufferPtr );
+}
 
-      // mSceneObject is being used in a separate thread; queue a message to set the value
-      SetFrameBufferIdMessage( GetEventThreadServices(), *mSceneObject, resourceId );
-    }
-    else
-    {
-      // update target frame buffer
-      mFrameBufferImage = image;
-    }
-  }
+FrameBuffer* RenderTask::GetFrameBuffer() const
+{
+  return mFrameBuffer.Get();
 }
 
-Dali::FrameBufferImage RenderTask::GetTargetFrameBuffer() const
+FrameBufferImage* RenderTask::GetTargetFrameBuffer() const
 {
-  return mFrameBufferImage;
+  return mFrameBufferImage.Get();
 }
 
 void RenderTask::SetScreenToFrameBufferFunction( ScreenToFrameBufferFunction conversionFunction )
@@ -183,6 +203,8 @@ Actor* RenderTask::GetScreenToFrameBufferMappingActor() const
 
 void RenderTask::SetViewportPosition(const Vector2& value)
 {
+  mViewportPosition = value;
+
   BakeViewportPositionMessage( GetEventThreadServices(), *mSceneObject, value );
 }
 
@@ -193,6 +215,8 @@ Vector2 RenderTask::GetCurrentViewportPosition() const
 
 void RenderTask::SetViewportSize(const Vector2& value)
 {
+  mViewportSize = value;
+
   BakeViewportSizeMessage( GetEventThreadServices(), *mSceneObject, value );
 }
 
@@ -216,15 +240,19 @@ void RenderTask::GetViewport( Viewport& viewPort ) const
     if ( mFrameBufferImage )
     {
       viewPort.x = viewPort.y = 0;
-      viewPort.width = mFrameBufferImage.GetWidth();
-      viewPort.height = mFrameBufferImage.GetHeight();
+      viewPort.width = mFrameBufferImage->GetWidth();
+      viewPort.height = mFrameBufferImage->GetHeight();
     }
     else
     {
-      Vector2 size( Stage::GetCurrent()->GetSize() );
-      viewPort.x = viewPort.y = 0;
-      viewPort.width = size.width;
-      viewPort.height = size.height;
+      Internal::Stage* stage = Internal::Stage::GetCurrent();
+      if ( stage )
+      {
+        Vector2 size( stage->GetSize() );
+        viewPort.x = viewPort.y = 0;
+        viewPort.width = size.width;
+        viewPort.height = size.height;
+      }
     }
   }
   else
@@ -257,6 +285,25 @@ const Vector4& RenderTask::GetClearColor() const
   return mSceneObject->GetClearColor( GetEventThreadServices().GetEventBufferIndex() );
 }
 
+void RenderTask::SetSyncRequired( bool requiresSync )
+{
+  if( mRequiresSync != requiresSync )
+  {
+    mRequiresSync = requiresSync;
+
+    if( mSceneObject )
+    {
+      // mSceneObject is being used in a separate thread; queue a message to set the value
+      SetSyncRequiredMessage( GetEventThreadServices(), *mSceneObject, requiresSync );
+    }
+  }
+}
+
+bool RenderTask::IsSyncRequired() const
+{
+  return mRequiresSync;
+}
+
 void RenderTask::SetClearEnabled( bool enabled )
 {
   if ( mClearEnabled != enabled )
@@ -352,32 +399,35 @@ bool RenderTask::TranslateCoordinates( Vector2& screenCoords ) const
   {
     CameraActor* localCamera = GetCameraActor();
     StagePtr stage = Stage::GetCurrent();
-    CameraActor& defaultCamera = stage->GetDefaultCameraActor();
-    if( localCamera )
-    {
-      Viewport viewport;
-      Vector2 size( stage->GetSize() );
-      viewport.x = viewport.y = 0;
-      viewport.width = size.width;
-      viewport.height = size.height;
-
-      float localX, localY;
-      inside = mMappingConnector.mActor->ScreenToLocal(defaultCamera.GetViewMatrix(), defaultCamera.GetProjectionMatrix(), viewport, localX, localY, screenCoords.x, screenCoords.y);
-      Vector3 actorSize = mMappingConnector.mActor->GetCurrentSize();
-      if( inside && localX >= 0.f && localX <= actorSize.x && localY >= 0.f && localY <= actorSize.y)
+    if( stage )
+    {
+      CameraActor& defaultCamera = stage->GetDefaultCameraActor();
+      if( localCamera )
       {
-        screenCoords.x = localX;
-        screenCoords.y = localY;
+        Viewport viewport;
+        Vector2 size( stage->GetSize() );
+        viewport.x = viewport.y = 0;
+        viewport.width = size.width;
+        viewport.height = size.height;
+
+        float localX, localY;
+        inside = mMappingConnector.mActor->ScreenToLocal(defaultCamera.GetViewMatrix(), defaultCamera.GetProjectionMatrix(), viewport, localX, localY, screenCoords.x, screenCoords.y);
+        Vector3 actorSize = mMappingConnector.mActor->GetCurrentSize();
+        if( inside && localX >= 0.f && localX <= actorSize.x && localY >= 0.f && localY <= actorSize.y)
+        {
+          screenCoords.x = localX;
+          screenCoords.y = localY;
+        }
+        else
+        {
+          inside = false;
+        }
       }
       else
       {
         inside = false;
       }
     }
-    else
-    {
-      inside = false;
-    }
   }
   else if ( mFrameBufferImage && mScreenToFrameBufferFunction )
   {
@@ -391,6 +441,40 @@ bool RenderTask::IsSystemLevel() const
   return mIsSystemLevel;
 }
 
+bool RenderTask::WorldToViewport(const Vector3 &position, float& viewportX, float& viewportY) const
+{
+  CameraActor* cam = GetCameraActor();
+
+  Vector4 pos(position);
+  pos.w = 1.0;
+
+  Vector4 viewportPosition;
+
+  Viewport viewport;
+  GetViewport( viewport );
+
+  bool ok = ProjectFull(pos,
+                        cam->GetViewMatrix(),
+                        cam->GetProjectionMatrix(),
+                        viewport.x,
+                        viewport.y,
+                        viewport.width,
+                        viewport.height,
+                        viewportPosition);
+  if(ok)
+  {
+    viewportX = viewportPosition.x;
+    viewportY = viewportPosition.y;
+  }
+
+  return ok;
+}
+
+bool RenderTask::ViewportToLocal(Actor* actor, float viewportX, float viewportY, float &localX, float &localY) const
+{
+  return actor->ScreenToLocal( *this, localX, localY, viewportX, viewportY );
+}
+
 SceneGraph::RenderTask* RenderTask::CreateSceneObject()
 {
   // This should only be called once, with no existing scene-object
@@ -399,24 +483,14 @@ SceneGraph::RenderTask* RenderTask::CreateSceneObject()
   // Keep the raw-pointer until DiscardSceneObject is called
   mSceneObject = SceneGraph::RenderTask::New();
 
-  // if we have a frame buffer we need to track connection status then send a message to set the frame buffer id in case it has changed since last time we were on stage
-  unsigned int resourceId = 0;
-  if(mFrameBufferImage)
-  {
-    GetImplementation(mFrameBufferImage).Connect();
-
-    resourceId = GetImplementation( mFrameBufferImage ).GetResourceId();
-  }
-
-  // mSceneObject is being used in a separate thread; queue a message to set the value
-  SetFrameBufferIdMessage( GetEventThreadServices(), *mSceneObject, resourceId );
-
   // Send messages to set other properties that may have changed since last time we were on stage
   SetExclusiveMessage( GetEventThreadServices(), *mSceneObject, mExclusive );
   SetClearColorMessage(  GetEventThreadServices(), *mSceneObject, mClearColor );
   SetClearEnabledMessage(  GetEventThreadServices(), *mSceneObject, mClearEnabled );
   SetCullModeMessage(  GetEventThreadServices(), *mSceneObject, mCullMode );
   SetRefreshRateMessage(  GetEventThreadServices(), *mSceneObject, mRefreshRate );
+  SetSyncRequiredMessage( GetEventThreadServices(), *mSceneObject, mRequiresSync );
+  SetFrameBuffer( mFrameBuffer );
 
   // Caller takes ownership
   return mSceneObject;
@@ -431,12 +505,6 @@ void RenderTask::DiscardSceneObject()
 {
   // mSceneObject is not owned; throw away the raw-pointer
   mSceneObject = NULL;
-
-  // if we have a frame buffer we need to track connection status
-  if(mFrameBufferImage)
-  {
-    GetImplementation(mFrameBufferImage).Disconnect();
-  }
 }
 
 /********************************************************************************
@@ -450,11 +518,11 @@ unsigned int RenderTask::GetDefaultPropertyCount() const
 
 void RenderTask::GetDefaultPropertyIndices( Property::IndexContainer& indices ) const
 {
-  indices.reserve( DEFAULT_PROPERTY_COUNT );
+  indices.Reserve( DEFAULT_PROPERTY_COUNT );
 
   for ( int i = 0; i < DEFAULT_PROPERTY_COUNT; ++i )
   {
-    indices.push_back( i );
+    indices.PushBack( i );
   }
 }
 
@@ -532,6 +600,11 @@ void RenderTask::SetDefaultProperty( Property::Index index, const Property::Valu
       SetClearColor( property.Get<Vector4>() );
       break;
     }
+    case Dali::RenderTask::Property::REQUIRES_SYNC:
+    {
+      SetSyncRequired( property.Get<bool>() );
+      break;
+    }
     default:
     {
       // nothing to do
@@ -549,6 +622,44 @@ Property::Value RenderTask::GetDefaultProperty(Property::Index index) const
 
     case Dali::RenderTask::Property::VIEWPORT_POSITION:
     {
+      value = mViewportPosition;
+      break;
+    }
+    case Dali::RenderTask::Property::VIEWPORT_SIZE:
+    {
+      value = mViewportSize;
+      break;
+    }
+    case Dali::RenderTask::Property::CLEAR_COLOR:
+    {
+      value = mClearColor;
+      break;
+    }
+    case Dali::RenderTask::Property::REQUIRES_SYNC:
+    {
+      value = IsSyncRequired();
+      break;
+    }
+
+    default:
+    {
+      DALI_ASSERT_ALWAYS(false && "RenderTask property index out of range"); // should not come here
+      break;
+    }
+  }
+
+  return value;
+}
+
+Property::Value RenderTask::GetDefaultPropertyCurrentValue( Property::Index index ) const
+{
+  Property::Value value;
+
+  switch ( index )
+  {
+
+    case Dali::RenderTask::Property::VIEWPORT_POSITION:
+    {
       value = GetCurrentViewportPosition();
       break;
     }
@@ -562,6 +673,11 @@ Property::Value RenderTask::GetDefaultProperty(Property::Index index) const
       value = GetClearColor();
       break;
     }
+    case Dali::RenderTask::Property::REQUIRES_SYNC:
+    {
+      value = IsSyncRequired();
+      break;
+    }
 
     default:
     {
@@ -573,6 +689,34 @@ Property::Value RenderTask::GetDefaultProperty(Property::Index index) const
   return value;
 }
 
+void RenderTask::OnNotifyDefaultPropertyAnimation( Animation& animation, Property::Index index, const Property::Value& value )
+{
+  switch ( index )
+  {
+    case Dali::RenderTask::Property::VIEWPORT_POSITION:
+    {
+      value.Get( mViewportPosition );
+      break;
+    }
+    case Dali::RenderTask::Property::VIEWPORT_SIZE:
+    {
+      value.Get( mViewportSize );
+      break;
+    }
+    case Dali::RenderTask::Property::CLEAR_COLOR:
+    {
+      value.Get( mClearColor );
+      break;
+    }
+    case Dali::RenderTask::Property::REQUIRES_SYNC:
+    default:
+    {
+      // Nothing to do as not animatable
+      break;
+    }
+  }
+}
+
 const SceneGraph::PropertyOwner* RenderTask::GetSceneObject() const
 {
   return mSceneObject;
@@ -625,7 +769,7 @@ const PropertyInputImpl* RenderTask::GetSceneObjectInputProperty( Property::Inde
         break;
 
       case Dali::RenderTask::Property::CLEAR_COLOR:
-        property = &mSceneObject->mViewportSize;
+        property = &mSceneObject->mClearColor;
         break;
 
       default:
@@ -671,7 +815,7 @@ Dali::RenderTask::RenderTaskSignalType& RenderTask::FinishedSignal()
 bool RenderTask::DoConnectSignal( BaseObject* object, ConnectionTrackerInterface* tracker, const std::string& signalName, FunctorDelegate* functor )
 {
   bool connected( true );
-  RenderTask* renderTask = dynamic_cast<RenderTask*>(object);
+  RenderTask* renderTask = static_cast< RenderTask* >(object); // TypeRegistry guarantees that this is the correct type.
 
   if ( 0 == strcmp( signalName.c_str(), SIGNAL_FINISHED ) )
   {
@@ -692,6 +836,8 @@ RenderTask::RenderTask( bool isSystemLevel )
   mCameraConnector( Connector::CAMERA_CONNECTOR, *this ),
   mMappingConnector( Connector::MAPPING_CONNECTOR, *this  ),
   mClearColor( Dali::RenderTask::DEFAULT_CLEAR_COLOR ),
+  mViewportPosition( Vector2::ZERO ),
+  mViewportSize( Vector2::ZERO ),
   mRefreshRate( Dali::RenderTask::DEFAULT_REFRESH_RATE ),
   mRefreshOnceCounter( 0u ),
   mScreenToFrameBufferFunction( Dali::RenderTask::DEFAULT_SCREEN_TO_FRAMEBUFFER_FUNCTION ),
@@ -699,7 +845,8 @@ RenderTask::RenderTask( bool isSystemLevel )
   mInputEnabled( Dali::RenderTask::DEFAULT_INPUT_ENABLED ),
   mClearEnabled( Dali::RenderTask::DEFAULT_CLEAR_ENABLED ),
   mCullMode( Dali::RenderTask::DEFAULT_CULL_MODE ),
-  mIsSystemLevel( isSystemLevel )
+  mIsSystemLevel( isSystemLevel ),
+  mRequiresSync( false )
 {
   DALI_LOG_INFO(gLogRender, Debug::General, "RenderTask::RenderTask(this:%p)\n", this);
 }
@@ -714,7 +861,8 @@ RenderTask::~RenderTask()
 RenderTask::Connector::Connector( Type type, RenderTask& renderTask )
 : mType( type ),
   mRenderTask( renderTask ),
-  mActor( NULL )
+  mActor( NULL ),
+  mCamera( NULL )
 {
 }
 
@@ -755,7 +903,17 @@ void RenderTask::Connector::SceneObjectRemoved( Object& object )
 
 void RenderTask::Connector::ObjectDestroyed( Object& object )
 {
+  if ( SOURCE_CONNECTOR == mType )
+  {
+    const Stage* stage = Stage::GetCurrent();
+    if ( stage )
+    {
+      stage->GetRenderTaskList().SetExclusive( &mRenderTask, false );
+    }
+  }
+
   mActor = NULL;
+  mCamera = NULL; // only meaningful for the camera connector but no simple way to distinguish
 
   UpdateRenderTask();
 }
@@ -786,7 +944,7 @@ void RenderTask::Connector::UpdateRenderTask()
     }
     else if( CAMERA_CONNECTOR == mType )
     {
-      SetCameraNodeMessage( mRenderTask.GetEventThreadServices(), *(mRenderTask.mSceneObject), node );
+      SetCameraMessage( mRenderTask.GetEventThreadServices(), *(mRenderTask.mSceneObject), node, mCamera );
     }
   }
 }