2 * Copyright (c) 2014 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 <dali/internal/event/render-tasks/render-task-impl.h>
22 #include <dali/public-api/common/dali-common.h>
23 #include <dali/public-api/object/type-registry.h>
24 #include <dali/internal/event/common/event-thread-services.h>
25 #include <dali/internal/event/actors/actor-impl.h>
26 #include <dali/internal/event/actors/camera-actor-impl.h>
27 #include <dali/internal/event/common/property-helper.h>
28 #include <dali/internal/event/common/stage-impl.h>
29 #include <dali/internal/event/images/frame-buffer-image-impl.h>
30 #include <dali/internal/update/nodes/node.h>
31 #include <dali/internal/update/render-tasks/scene-graph-render-task.h>
33 #if defined(DEBUG_ENABLED)
36 Debug::Filter* gLogRender = Debug::Filter::New(Debug::Concise, false, "LOG_RENDER_TASK");
46 namespace // For internal properties
51 // Name Type writable animatable constraint-input enum for index-checking
52 DALI_PROPERTY_TABLE_BEGIN
53 DALI_PROPERTY( "viewport-position", VECTOR2, true, true, true, Dali::RenderTask::Property::VIEWPORT_POSITION )
54 DALI_PROPERTY( "viewport-size", VECTOR2, true, true, true, Dali::RenderTask::Property::VIEWPORT_SIZE )
55 DALI_PROPERTY( "clear-color", VECTOR4, true, true, true, Dali::RenderTask::Property::CLEAR_COLOR )
56 DALI_PROPERTY_TABLE_END( DEFAULT_OBJECT_PROPERTY_START_INDEX )
60 const char* const SIGNAL_FINISHED = "finished";
62 TypeRegistration mType( typeid( Dali::RenderTask ), typeid( Dali::BaseHandle ), NULL );
64 SignalConnectorType signalConnector1( mType, SIGNAL_FINISHED, &RenderTask::DoConnectSignal );
66 } // Unnamed namespace
68 RenderTask* RenderTask::New( bool isSystemLevel )
70 RenderTask* task( new RenderTask( isSystemLevel ) );
75 void RenderTask::SetSourceActor( Actor* actor )
77 mSourceConnector.SetActor( actor );
80 Actor* RenderTask::GetSourceActor() const
82 return mSourceConnector.mActor;
85 void RenderTask::SetExclusive( bool exclusive )
87 if ( mExclusive != exclusive )
89 mExclusive = exclusive;
93 // mSceneObject is being used in a separate thread; queue a message to set the value
94 SetExclusiveMessage( GetEventThreadServices(), *mSceneObject, mExclusive );
99 bool RenderTask::IsExclusive() const
104 void RenderTask::SetInputEnabled( bool enabled )
106 mInputEnabled = enabled;
109 bool RenderTask::GetInputEnabled() const
111 return mInputEnabled;
114 void RenderTask::SetCameraActor( CameraActor* cameraActor )
116 mCameraConnector.SetActor( cameraActor );
119 CameraActor* RenderTask::GetCameraActor() const
121 // camera connector can only point to camera actor
122 return static_cast< CameraActor* >( mCameraConnector.mActor );
125 void RenderTask::SetTargetFrameBuffer( Dali::FrameBufferImage image )
127 if ( mFrameBufferImage != image )
129 // if we have a scene object we need to track connection status and set frame buffer id as well as updating target frame buffer
132 if(mFrameBufferImage)
134 GetImplementation(mFrameBufferImage).Disconnect();
137 // update target frame buffer
138 mFrameBufferImage = image;
140 unsigned int resourceId = 0;
141 if(mFrameBufferImage)
143 GetImplementation(mFrameBufferImage).Connect();
145 resourceId = GetImplementation( mFrameBufferImage ).GetResourceId();
148 // mSceneObject is being used in a separate thread; queue a message to set the value
149 SetFrameBufferIdMessage( GetEventThreadServices(), *mSceneObject, resourceId );
153 // update target frame buffer
154 mFrameBufferImage = image;
159 Dali::FrameBufferImage RenderTask::GetTargetFrameBuffer() const
161 return mFrameBufferImage;
164 void RenderTask::SetScreenToFrameBufferFunction( ScreenToFrameBufferFunction conversionFunction )
166 mScreenToFrameBufferFunction = conversionFunction;
169 RenderTask::ScreenToFrameBufferFunction RenderTask::GetScreenToFrameBufferFunction() const
171 return mScreenToFrameBufferFunction;
174 void RenderTask::SetScreenToFrameBufferMappingActor( Actor* mappingActor )
176 mMappingConnector.SetActor( mappingActor );
179 Actor* RenderTask::GetScreenToFrameBufferMappingActor() const
181 return mMappingConnector.mActor;
184 void RenderTask::SetViewportPosition(const Vector2& value)
186 BakeViewportPositionMessage( GetEventThreadServices(), *mSceneObject, value );
189 Vector2 RenderTask::GetCurrentViewportPosition() const
191 return mSceneObject->GetViewportPosition( GetEventThreadServices().GetEventBufferIndex() );
194 void RenderTask::SetViewportSize(const Vector2& value)
196 BakeViewportSizeMessage( GetEventThreadServices(), *mSceneObject, value );
199 Vector2 RenderTask::GetCurrentViewportSize() const
201 return mSceneObject->GetViewportSize( GetEventThreadServices().GetEventBufferIndex() );
204 void RenderTask::SetViewport( const Viewport& viewport )
206 SetViewportPosition(Vector2(viewport.x, viewport.y));
207 SetViewportSize(Vector2(viewport.width, viewport.height));
210 void RenderTask::GetViewport( Viewport& viewPort ) const
212 BufferIndex bufferIndex = GetEventThreadServices().GetEventBufferIndex();
214 if(!mSceneObject->GetViewportEnabled( bufferIndex ))
216 if ( mFrameBufferImage )
218 viewPort.x = viewPort.y = 0;
219 viewPort.width = mFrameBufferImage.GetWidth();
220 viewPort.height = mFrameBufferImage.GetHeight();
224 Vector2 size( Stage::GetCurrent()->GetSize() );
225 viewPort.x = viewPort.y = 0;
226 viewPort.width = size.width;
227 viewPort.height = size.height;
232 const Vector2& position = mSceneObject->GetViewportPosition(bufferIndex);
233 const Vector2& size = mSceneObject->GetViewportSize(bufferIndex);
234 viewPort.x = position.x;
235 viewPort.y = position.y;
236 viewPort.width = size.width;
237 viewPort.height = size.height;
241 void RenderTask::SetClearColor( const Vector4& color )
243 if ( mClearColor != color )
249 // mSceneObject is being used in a separate thread; queue a message to set the value
250 BakeClearColorMessage( GetEventThreadServices(), *mSceneObject, color );
255 const Vector4& RenderTask::GetClearColor() const
257 return mSceneObject->GetClearColor( GetEventThreadServices().GetEventBufferIndex() );
260 void RenderTask::SetClearEnabled( bool enabled )
262 if ( mClearEnabled != enabled )
264 mClearEnabled = enabled;
268 // mSceneObject is being used in a separate thread; queue a message to set the value
269 SetClearEnabledMessage( GetEventThreadServices(), *mSceneObject, mClearEnabled );
274 bool RenderTask::GetClearEnabled() const
276 return mClearEnabled;
279 void RenderTask::SetCullMode( bool mode )
281 if ( mCullMode != mode )
287 // mSceneObject is being used in a separate thread; queue a message to set the value
288 SetCullModeMessage( GetEventThreadServices(), *mSceneObject, mCullMode );
293 bool RenderTask::GetCullMode() const
298 void RenderTask::SetRefreshRate( unsigned int refreshRate )
300 DALI_LOG_TRACE_METHOD_FMT(gLogRender, "this:%p rate:%d\n", this, refreshRate);
301 DALI_LOG_INFO(gLogRender, Debug::General, "RenderTask::SetRefreshRate(this:%p, %d)\n", this, refreshRate);
303 mRefreshRate = refreshRate; // cached for GetRefreshRate()
305 // Note - even when refreshRate is the same as mRefreshRate, a message should be sent
309 // mSceneObject is being used in a separate thread; queue a message to set the value
310 SetRefreshRateMessage( GetEventThreadServices(), *mSceneObject, refreshRate );
314 unsigned int RenderTask::GetRefreshRate() const
319 bool RenderTask::IsHittable( Vector2& screenCoords ) const
321 // True when input is enabled, source & camera actor are valid
322 bool inputEnabled( false );
324 Actor* sourceActor = GetSourceActor();
325 CameraActor* cameraActor = GetCameraActor();
327 if ( mInputEnabled &&
328 NULL != sourceActor &&
329 sourceActor->OnStage() &&
330 NULL != cameraActor &&
331 cameraActor->OnStage() )
333 // If the actors are rendered off-screen, then the screen coordinates must be converted
334 // and the conversion function will tell us if they are inside or outside
335 if ( TranslateCoordinates( screenCoords ) )
337 // This is a suitable render-task for input handling
345 bool RenderTask::TranslateCoordinates( Vector2& screenCoords ) const
347 // return true for on-screen tasks
349 // If the actors are rendered off-screen, then the screen coordinates must be converted
350 // the function should only be called for offscreen tasks
351 if( mFrameBufferImage && mMappingConnector.mActor )
353 CameraActor* localCamera = GetCameraActor();
354 StagePtr stage = Stage::GetCurrent();
355 CameraActor& defaultCamera = stage->GetDefaultCameraActor();
359 Vector2 size( stage->GetSize() );
360 viewport.x = viewport.y = 0;
361 viewport.width = size.width;
362 viewport.height = size.height;
364 float localX, localY;
365 inside = mMappingConnector.mActor->ScreenToLocal(defaultCamera.GetViewMatrix(), defaultCamera.GetProjectionMatrix(), viewport, localX, localY, screenCoords.x, screenCoords.y);
366 Vector3 actorSize = mMappingConnector.mActor->GetCurrentSize();
367 if( inside && localX >= 0.f && localX <= actorSize.x && localY >= 0.f && localY <= actorSize.y)
369 screenCoords.x = localX;
370 screenCoords.y = localY;
382 else if ( mFrameBufferImage && mScreenToFrameBufferFunction )
384 inside = mScreenToFrameBufferFunction( screenCoords );
389 bool RenderTask::IsSystemLevel() const
391 return mIsSystemLevel;
394 SceneGraph::RenderTask* RenderTask::CreateSceneObject()
396 // This should only be called once, with no existing scene-object
397 DALI_ASSERT_DEBUG( NULL == mSceneObject );
399 // Keep the raw-pointer until DiscardSceneObject is called
400 mSceneObject = SceneGraph::RenderTask::New();
402 // 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
403 unsigned int resourceId = 0;
404 if(mFrameBufferImage)
406 GetImplementation(mFrameBufferImage).Connect();
408 resourceId = GetImplementation( mFrameBufferImage ).GetResourceId();
411 // mSceneObject is being used in a separate thread; queue a message to set the value
412 SetFrameBufferIdMessage( GetEventThreadServices(), *mSceneObject, resourceId );
414 // Send messages to set other properties that may have changed since last time we were on stage
415 SetExclusiveMessage( GetEventThreadServices(), *mSceneObject, mExclusive );
416 SetClearColorMessage( GetEventThreadServices(), *mSceneObject, mClearColor );
417 SetClearEnabledMessage( GetEventThreadServices(), *mSceneObject, mClearEnabled );
418 SetCullModeMessage( GetEventThreadServices(), *mSceneObject, mCullMode );
419 SetRefreshRateMessage( GetEventThreadServices(), *mSceneObject, mRefreshRate );
421 // Caller takes ownership
425 SceneGraph::RenderTask* RenderTask::GetRenderTaskSceneObject()
430 void RenderTask::DiscardSceneObject()
432 // mSceneObject is not owned; throw away the raw-pointer
435 // if we have a frame buffer we need to track connection status
436 if(mFrameBufferImage)
438 GetImplementation(mFrameBufferImage).Disconnect();
442 /********************************************************************************
443 ******************************** PROPERTY METHODS **************************
444 ********************************************************************************/
446 unsigned int RenderTask::GetDefaultPropertyCount() const
448 return DEFAULT_PROPERTY_COUNT;
451 void RenderTask::GetDefaultPropertyIndices( Property::IndexContainer& indices ) const
453 indices.reserve( DEFAULT_PROPERTY_COUNT );
455 for ( int i = 0; i < DEFAULT_PROPERTY_COUNT; ++i )
457 indices.push_back( i );
461 const char* RenderTask::GetDefaultPropertyName( Property::Index index ) const
463 if( index < DEFAULT_PROPERTY_COUNT )
465 return DEFAULT_PROPERTY_DETAILS[index].name;
473 Property::Index RenderTask::GetDefaultPropertyIndex(const std::string& name) const
475 Property::Index index = Property::INVALID_INDEX;
477 // Look for name in default properties
478 for( int i = 0; i < DEFAULT_PROPERTY_COUNT; ++i )
480 if( 0 == strcmp( name.c_str(), DEFAULT_PROPERTY_DETAILS[i].name ) ) // dont want to convert rhs to string
490 bool RenderTask::IsDefaultPropertyWritable(Property::Index index) const
492 return DEFAULT_PROPERTY_DETAILS[ index ].writable;
495 bool RenderTask::IsDefaultPropertyAnimatable(Property::Index index) const
497 return DEFAULT_PROPERTY_DETAILS[ index ].animatable;
500 bool RenderTask::IsDefaultPropertyAConstraintInput( Property::Index index ) const
502 return DEFAULT_PROPERTY_DETAILS[ index ].constraintInput;
505 Property::Type RenderTask::GetDefaultPropertyType(Property::Index index) const
507 if( index < DEFAULT_PROPERTY_COUNT )
509 return DEFAULT_PROPERTY_DETAILS[index].type;
512 // index out of range...return Property::NONE
513 return Property::NONE;
516 void RenderTask::SetDefaultProperty( Property::Index index, const Property::Value& property )
520 case Dali::RenderTask::Property::VIEWPORT_POSITION:
522 SetViewportPosition( property.Get<Vector2>() );
525 case Dali::RenderTask::Property::VIEWPORT_SIZE:
527 SetViewportSize( property.Get<Vector2>() );
530 case Dali::RenderTask::Property::CLEAR_COLOR:
532 SetClearColor( property.Get<Vector4>() );
543 Property::Value RenderTask::GetDefaultProperty(Property::Index index) const
545 Property::Value value;
550 case Dali::RenderTask::Property::VIEWPORT_POSITION:
552 value = GetCurrentViewportPosition();
555 case Dali::RenderTask::Property::VIEWPORT_SIZE:
557 value = GetCurrentViewportSize();
560 case Dali::RenderTask::Property::CLEAR_COLOR:
562 value = GetClearColor();
568 DALI_ASSERT_ALWAYS(false && "RenderTask property index out of range"); // should not come here
576 const SceneGraph::PropertyOwner* RenderTask::GetSceneObject() const
581 const SceneGraph::PropertyBase* RenderTask::GetSceneObjectAnimatableProperty( Property::Index index ) const
583 DALI_ASSERT_ALWAYS( IsPropertyAnimatable(index) && "Property is not animatable" );
585 const SceneGraph::PropertyBase* property( NULL );
587 // This method should only return a property which is part of the scene-graph
588 if( mSceneObject != NULL )
592 case Dali::RenderTask::Property::VIEWPORT_POSITION:
593 property = &mSceneObject->mViewportPosition;
596 case Dali::RenderTask::Property::VIEWPORT_SIZE:
597 property = &mSceneObject->mViewportSize;
600 case Dali::RenderTask::Property::CLEAR_COLOR:
601 property = &mSceneObject->mClearColor;
612 const PropertyInputImpl* RenderTask::GetSceneObjectInputProperty( Property::Index index ) const
614 const PropertyInputImpl* property( NULL );
615 if( mSceneObject != NULL )
619 case Dali::RenderTask::Property::VIEWPORT_POSITION:
620 property = &mSceneObject->mViewportPosition;
623 case Dali::RenderTask::Property::VIEWPORT_SIZE:
624 property = &mSceneObject->mViewportSize;
627 case Dali::RenderTask::Property::CLEAR_COLOR:
628 property = &mSceneObject->mViewportSize;
639 bool RenderTask::HasFinished()
641 bool finished = false;
642 const unsigned int counter = mSceneObject->GetRenderedOnceCounter();
644 if( mRefreshOnceCounter < counter )
647 mRefreshOnceCounter = counter;
650 DALI_LOG_INFO(gLogRender, Debug::General, "RenderTask::HasFinished()=%s SCRT:%p SC\n", finished?"T":"F", mSceneObject);
655 void RenderTask::EmitSignalFinish()
657 DALI_LOG_INFO(gLogRender, Debug::General, "RenderTask::EmitSignalFinish(this:%p)\n", this);
659 if( !mSignalFinished.Empty() )
661 Dali::RenderTask handle( this );
662 mSignalFinished.Emit(handle );
666 Dali::RenderTask::RenderTaskSignalType& RenderTask::FinishedSignal()
668 return mSignalFinished;
671 bool RenderTask::DoConnectSignal( BaseObject* object, ConnectionTrackerInterface* tracker, const std::string& signalName, FunctorDelegate* functor )
673 bool connected( true );
674 RenderTask* renderTask = dynamic_cast<RenderTask*>(object);
676 if ( 0 == strcmp( signalName.c_str(), SIGNAL_FINISHED ) )
678 renderTask->FinishedSignal().Connect( tracker, functor );
682 // signalName does not match any signal
689 RenderTask::RenderTask( bool isSystemLevel )
690 : mSceneObject( NULL ),
691 mSourceConnector( Connector::SOURCE_CONNECTOR, *this ),
692 mCameraConnector( Connector::CAMERA_CONNECTOR, *this ),
693 mMappingConnector( Connector::MAPPING_CONNECTOR, *this ),
694 mClearColor( Dali::RenderTask::DEFAULT_CLEAR_COLOR ),
695 mRefreshRate( Dali::RenderTask::DEFAULT_REFRESH_RATE ),
696 mRefreshOnceCounter( 0u ),
697 mScreenToFrameBufferFunction( Dali::RenderTask::DEFAULT_SCREEN_TO_FRAMEBUFFER_FUNCTION ),
698 mExclusive( Dali::RenderTask::DEFAULT_EXCLUSIVE ),
699 mInputEnabled( Dali::RenderTask::DEFAULT_INPUT_ENABLED ),
700 mClearEnabled( Dali::RenderTask::DEFAULT_CLEAR_ENABLED ),
701 mCullMode( Dali::RenderTask::DEFAULT_CULL_MODE ),
702 mIsSystemLevel( isSystemLevel )
704 DALI_LOG_INFO(gLogRender, Debug::General, "RenderTask::RenderTask(this:%p)\n", this);
707 RenderTask::~RenderTask()
709 DALI_LOG_INFO(gLogRender, Debug::General, "RenderTask::~RenderTask(this:%p)\n", this);
712 // Helper class for connecting Nodes to the scene-graph RenderTask
714 RenderTask::Connector::Connector( Type type, RenderTask& renderTask )
716 mRenderTask( renderTask ),
721 RenderTask::Connector::~Connector()
726 void RenderTask::Connector::SetActor( Actor* actor )
728 if ( mActor != actor )
732 mActor->RemoveObserver( *this );
739 mActor->AddObserver( *this );
746 void RenderTask::Connector::SceneObjectAdded( Object& object )
751 void RenderTask::Connector::SceneObjectRemoved( Object& object )
756 void RenderTask::Connector::ObjectDestroyed( Object& object )
763 void RenderTask::Connector::UpdateRenderTask()
765 // Guard to allow handle destruction after Core has been destroyed
766 if( Internal::Stage::IsInstalled() &&
767 mRenderTask.mSceneObject )
769 const SceneGraph::Node* node( NULL );
771 // Check whether a Node exists in the scene-graph
772 if ( NULL != mActor )
774 const SceneGraph::PropertyOwner* object = mActor->GetSceneObject();
775 if ( NULL != object )
777 // actors only point to nodes as their scene objects
778 node = static_cast< const SceneGraph::Node* >( object );
782 //the mapping node is not used in the scene graph
783 if ( SOURCE_CONNECTOR == mType )
785 SetSourceNodeMessage( mRenderTask.GetEventThreadServices(), *(mRenderTask.mSceneObject), node );
787 else if( CAMERA_CONNECTOR == mType )
789 SetCameraNodeMessage( mRenderTask.GetEventThreadServices(), *(mRenderTask.mSceneObject), node );
794 } // namespace Internal